@adobe/spacecat-shared-data-access 1.26.1 → 1.28.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.28.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.27.0...@adobe/spacecat-shared-data-access-v1.28.0) (2024-06-12)
+
+
+### Features
+
+* opt-out broken-backlinks ([#263](https://github.com/adobe/spacecat-shared/issues/263)) ([14402cb](https://github.com/adobe/spacecat-shared/commit/14402cbda51bf54b2928ca1d66afac00ca2444ed))
+
+# [@adobe/spacecat-shared-data-access-v1.27.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.26.1...@adobe/spacecat-shared-data-access-v1.27.0) (2024-06-12)
+
+
+### Features
+
+* query for URLs for a given jobID matching status ([#262](https://github.com/adobe/spacecat-shared/issues/262)) ([a74b629](https://github.com/adobe/spacecat-shared/commit/a74b629b78b100c140515efd072807f628de4a2a))
+
 # [@adobe/spacecat-shared-data-access-v1.26.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.26.0...@adobe/spacecat-shared-data-access-v1.26.1) (2024-06-10)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.26.1",
+  "version": "1.28.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "main": "src/index.js",
@@ -35,13 +35,13 @@
     "@aws-sdk/lib-dynamodb": "3.592.0",
     "@types/joi": "17.2.3",
     "joi": "17.13.1",
-    "uuid": "9.0.1"
+    "uuid": "10.0.0"
   },
   "devDependencies": {
     "chai": "4.4.1",
-    "chai-as-promised": "7.1.2",
+    "chai-as-promised": "8.0.0",
     "dynamo-db-local": "8.0.0",
-    "sinon": "17.0.2",
+    "sinon": "18.0.0",
     "sinon-chai": "3.7.0"
   }
 }

package/src/index.d.ts

@@ -622,6 +622,10 @@ export interface DataAccess {
   updateImportUrl: (
     importUrl: ImportUrl,
     ) => Promise<ImportUrl>;
+  getImportUrlsByJobIdAndStatus: (
+      jobId: string,
+      status: string,
+    ) => Promise<ImportUrl[]>;
 
   // site candidate functions
   getSiteCandidateByBaseURL: (baseURL: string) => Promise<SiteCandidate>;
@@ -666,6 +670,7 @@ interface DataAccessConfig {
   indexNameAllOrganizations: string,
   indexNameAllOrganizationsByImsOrgId: string,
   indexNameAllImportJobsByStatus: string,
+  indexNameAllImportUrlsByJobIdAndStatus: string,
   pkAllSites: string;
   pkAllLatestAudits: string;
   pkAllOrganizations: string;

package/src/index.js

@@ -33,6 +33,7 @@ const INDEX_NAME_ALL_SITES_BY_DELIVERY_TYPE = 'spacecat-services-all-sites-by-de
 const INDEX_NAME_ALL_LATEST_AUDIT_SCORES = 'spacecat-services-all-latest-audit-scores-dev';
 const INDEX_NAME_ALL_SITES_ORGANIZATIONS = 'spacecat-services-all-sites-organizations-dev';
 const INDEX_NAME_ALL_IMPORT_JOBS_BY_STATUS = 'spacecat-services-all-import-jobs-by-status-dev';
+const INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS = 'spacecat-services-all-import-urls-by-job-id-and-status-dev';
 
 const PK_ALL_SITES = 'ALL_SITES';
 const PK_ALL_CONFIGURATIONS = 'ALL_CONFIGURATIONS';
@@ -65,6 +66,8 @@ export default function dataAccessWrapper(fn) {
         DYNAMO_INDEX_NAME_ALL_ORGANIZATIONS_BY_IMS_ORG_ID = INDEX_NAME_ALL_ORGANIZATIONS_BY_IMS_ORG_ID,
         DYNAMO_INDEX_NAME_ALL_SITES_ORGANIZATIONS = INDEX_NAME_ALL_SITES_ORGANIZATIONS,
         DYNAMO_INDEX_NAME_ALL_IMPORT_JOBS_BY_STATUS = INDEX_NAME_ALL_IMPORT_JOBS_BY_STATUS,
+        DYNAMO_INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS =
+        INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS,
       } = context.env;
 
       context.dataAccess = createDataAccess({
@@ -86,6 +89,7 @@ export default function dataAccessWrapper(fn) {
         indexNameAllLatestAuditScores: DYNAMO_INDEX_NAME_ALL_LATEST_AUDIT_SCORES,
         indexNameAllSitesOrganizations: DYNAMO_INDEX_NAME_ALL_SITES_ORGANIZATIONS,
         indexNameAllImportJobsByStatus: DYNAMO_INDEX_NAME_ALL_IMPORT_JOBS_BY_STATUS,
+        indexNameImportUrlsByJobIdAndStatus: DYNAMO_INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS,
         pkAllSites: PK_ALL_SITES,
         pkAllOrganizations: PK_ALL_ORGANIZATIONS,
         pkAllLatestAudits: PK_ALL_LATEST_AUDITS,

package/src/models/site/audit-config-type.js

@@ -13,10 +13,12 @@
 const AuditConfigType = (data = {}) => {
   const state = {
     disabled: data.disabled || false,
+    excludedURLs: data.excludedURLs || [],
   };
 
   const self = {
     disabled: () => state.disabled,
+    excludedURLs: () => state.excludedURLs,
 
     updateDisabled: (newValue) => {
       state.disabled = newValue;
@@ -29,12 +31,14 @@ const AuditConfigType = (data = {}) => {
 AuditConfigType.fromDynamoItem = (dynamoItem) => {
   const auditConfigTypeData = {
     disabled: dynamoItem.disabled,
+    excludedURLs: dynamoItem.excludedURLs,
   };
   return AuditConfigType(auditConfigTypeData);
 };
 
 AuditConfigType.toDynamoItem = (auditConfigType) => ({
   disabled: auditConfigType.disabled(),
+  excludedURLs: auditConfigType.excludedURLs(),
 });
 
 export default AuditConfigType;

package/src/models/site/config.js

@@ -30,6 +30,7 @@ export const configSchema = Joi.object({
       Joi.string(),
       Joi.object({
         disabled: Joi.boolean().optional(),
+        excludedURLs: Joi.array().items(Joi.string()).optional(),
       }).unknown(true),
     ).unknown(true),
   }).unknown(true),

package/src/service/import-url/accessPatterns.js

@@ -71,3 +71,28 @@ export const updateImportUrl = async (dynamoClient, config, log, importUrl) => {
 
   return importUrl;
 };
+
+/**
+ * Get Import Urls by Job ID and Status
+ * @param {DynamoClient} dynamoClient
+ * @param {Object} config
+ * @param {Logger} log
+ * @param {string} jobId
+ * @param {string} status
+ * @returns {Promise<ImportUrlDto[]>}
+ */
+export const getImportUrlsByJobIdAndStatus = async (dynamoClient, config, log, jobId, status) => {
+  const items = await dynamoClient.query({
+    TableName: config.tableNameImportUrls,
+    IndexName: config.indexNameImportUrlsByJobIdAndStatus,
+    KeyConditionExpression: 'jobId = :jobId AND #status = :status',
+    ExpressionAttributeNames: {
+      '#status': 'status',
+    },
+    ExpressionAttributeValues: {
+      ':jobId': jobId,
+      ':status': status,
+    },
+  });
+  return items.map((item) => ImportUrlDto.fromDynamoItem(item));
+};

package/src/service/import-url/index.js

@@ -14,6 +14,7 @@ import {
   getImportUrlById,
   createNewImportUrl,
   updateImportUrl,
+  getImportUrlsByJobIdAndStatus,
 } from './accessPatterns.js';
 
 export const importUrlFunctions = (dynamoClient, config, log) => ({
@@ -35,4 +36,11 @@ export const importUrlFunctions = (dynamoClient, config, log) => ({
     log,
     importUrl,
   ),
+  getImportUrlsByJobIdAndStatus: (jobId, status) => getImportUrlsByJobIdAndStatus(
+    dynamoClient,
+    config,
+    log,
+    jobId,
+    status,
+  ),
 });