Skip to content

fix: allow sorting for get audits for site #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
solaris007 merged 1 commit into from
Dec 10, 2023
Merged

fix: allow sorting for get audits for site #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/spacecat-shared-data-access/src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,15 @@ export interface Site {
isLive: () => boolean;
setAudits: (audits: Audit[]) => Site;
toggleLive: () => Site;
updateGitHubURL: (gitHubURL: string) => Site;
updateImsOrgId: (imsOrgId: string) => Site;
}

export interface DataAccess {
getAuditsForSite: (
siteId: string,
auditType?: string
auditType?: string,
ascending?: boolean,
) => Promise<Audit[]>;
getLatestAuditForSite: (
siteId: string,
Expand Down
16 changes: 13 additions & 3 deletions packages/spacecat-shared-data-access/src/service/audits/accessPatterns.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
* governing permissions and limitations under the License.
*/

import { isObject } from '@adobe/spacecat-shared-utils';
import { hasText, isObject } from '@adobe/spacecat-shared-utils';

import { AuditDto } from '../../dto/audit.js';
import { createAudit } from '../../models/audit.js';
Expand All @@ -24,19 +24,29 @@ import { createAudit } from '../../models/audit.js';
* @param {Logger} log - The logger.
* @param {string} siteId - The ID of the site for which audits are being retrieved.
* @param {string} [auditType] - Optional. The type of audits to retrieve.
* @param {boolean} [ascending] - Optional. Determines if the audits should be sorted
* ascending. Default is true.
* @returns {Promise<Readonly<Audit>[]>} A promise that resolves to an array of audits
* for the specified site.
*/
export const getAuditsForSite = async (dynamoClient, config, log, siteId, auditType) => {
export const getAuditsForSite = async (
dynamoClient,
config,
log,
siteId,
auditType,
ascending = true,
) => {
const queryParams = {
TableName: config.tableNameAudits,
KeyConditionExpression: 'siteId = :siteId',
ExpressionAttributeValues: {
':siteId': siteId,
},
ScanIndexForward: ascending, // Sorts ascending if true, descending if false
};

if (auditType !== undefined) {
if (hasText(auditType)) {
queryParams.KeyConditionExpression += ' AND begins_with(SK, :auditType)';
queryParams.ExpressionAttributeValues[':auditType'] = `${auditType}#`;
}
Expand Down