@adobe/spacecat-shared-data-access 1.47.0 → 1.48.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.48.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.47.1...@adobe/spacecat-shared-data-access-v1.48.0) (2024-10-11)
+
+
+### Features
+
+* Support import job deletion ([#400](https://github.com/adobe/spacecat-shared/issues/400)) ([d5a9df6](https://github.com/adobe/spacecat-shared/commit/d5a9df68f103b34adab87dfc78cc5bca7aa99ebc))
+
+# [@adobe/spacecat-shared-data-access-v1.47.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.47.0...@adobe/spacecat-shared-data-access-v1.47.1) (2024-10-07)
+
+
+### Bug Fixes
+
+* gracefully handle config in case handler is not defined ([#396](https://github.com/adobe/spacecat-shared/issues/396)) ([a4c8abd](https://github.com/adobe/spacecat-shared/commit/a4c8abdf4c99cfc32b1d92233eb8786f439320f1))
+
 # [@adobe/spacecat-shared-data-access-v1.47.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.46.1...@adobe/spacecat-shared-data-access-v1.47.0) (2024-10-07)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.47.0",
+  "version": "1.48.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "engines": {

package/src/index.d.ts

@@ -890,7 +890,7 @@ interface DataAccessConfig {
   indexNameAllOrganizationsByImsOrgId: string,
   indexNameAllImportJobsByStatus: string,
   indexNameAllImportJobsByDateRange: string,
-  indexNameAllImportUrlsByJobIdAndStatus: string,
+  indexNameImportUrlsByJobIdAndStatus: string,
   indexNameApiKeyByHashedApiKey: string,
   pkAllSites: string;
   pkAllLatestAudits: string;

package/src/models/api-key.js

@@ -25,6 +25,7 @@ const scopeNames = [
   'audits.write_all',
   'imports.read',
   'imports.write',
+  'imports.delete',
   'imports.read_all',
   'imports.all_domains',
 ];

package/src/models/site/config.js

@@ -57,14 +57,14 @@ export const Config = (data = {}) => {
   const state = { ...validConfig };
   const self = { state };
   self.getSlackConfig = () => state.slack;
-  self.getSlackMentions = (type) => state?.handlers[type]?.mentions?.slack;
-  self.getHandlerConfig = (type) => state?.handlers[type];
+  self.getSlackMentions = (type) => state?.handlers?.[type]?.mentions?.slack;
+  self.getHandlerConfig = (type) => state?.handlers?.[type];
   self.getHandlers = () => state.handlers;
   self.getImports = () => state.imports;
-  self.getExcludedURLs = (type) => state?.handlers[type]?.excludedURLs;
-  self.getManualOverwrites = (type) => state?.handlers[type]?.manualOverwrites;
-  self.getFixedURLs = (type) => state?.handlers[type]?.fixedURLs;
-  self.getIncludedURLs = (type) => state?.handlers[type]?.includedURLs;
+  self.getExcludedURLs = (type) => state?.handlers?.[type]?.excludedURLs;
+  self.getManualOverwrites = (type) => state?.handlers?.[type]?.manualOverwrites;
+  self.getFixedURLs = (type) => state?.handlers?.[type]?.fixedURLs;
+  self.getIncludedURLs = (type) => state?.handlers?.[type]?.includedURLs;
 
   self.updateSlackConfig = (channel, workspace, invitedUserCount) => {
     state.slack = {

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

@@ -13,6 +13,7 @@
 import { isObject } from '@adobe/spacecat-shared-utils';
 import { ImportJobDto } from '../../dto/import-job.js';
 import { createImportJob } from '../../models/importer/import-job.js';
+import { removeUrlsForImportJob } from '../import-url/accessPatterns.js';
 
 /**
  * Get all Import Jobs within a specific date range
@@ -112,3 +113,22 @@ export const updateImportJob = async (dynamoClient, config, log, importJob) => {
 
   return importJob;
 };
+
+/**
+ * Removes an Import Job and all associated URLs.
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+ * @param {Logger} log - The logger.
+ * @param {ImportJob} importJob - The import job to remove.
+ * @return {Promise<void>} A promise that resolves when the import job has been removed.
+ */
+export const removeImportJob = async (dynamoClient, config, log, importJob) => {
+  try {
+    await removeUrlsForImportJob(dynamoClient, config, log, importJob.getId());
+
+    await dynamoClient.removeItem(config.tableNameImportJobs, { id: importJob.getId() });
+  } catch (error) {
+    log.error(`Error removing import job: ${error.message}`);
+    throw error;
+  }
+};

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

@@ -16,6 +16,7 @@ import {
   getImportJobsByStatus,
   updateImportJob,
   getImportJobsByDateRange,
+  removeImportJob,
 } from './accessPatterns.js';
 
 export const importJobFunctions = (dynamoClient, config, log) => ({
@@ -44,10 +45,16 @@ export const importJobFunctions = (dynamoClient, config, log) => ({
     log,
     importJobData,
   ),
-  updateImportJob: (importJobData) => updateImportJob(
+  updateImportJob: (importJob) => updateImportJob(
     dynamoClient,
     config,
     log,
-    importJobData,
+    importJob,
+  ),
+  removeImportJob: (importJob) => removeImportJob(
+    dynamoClient,
+    config,
+    log,
+    importJob,
   ),
 });

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

@@ -99,11 +99,11 @@ export const getImportUrlsByJobIdAndStatus = async (dynamoClient, config, log, j
 
 /**
  * Get Import Urls by Job ID, if no urls exist an empty array is returned.
- * @param {DynamoClient} dynamoClient
- * @param {Object} config
- * @param {Logger} log
- * @param {string} jobId
- * @returns {Promise<ImportUrlDto[]> | []}
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+ * @param {Logger} log - The logger.
+ * @param {string} jobId - The ID of the import job.
+ * @returns {Promise<ImportUrl[]>}
  */
 export const getImportUrlsByJobId = async (dynamoClient, config, log, jobId) => {
   const items = await dynamoClient.query({
@@ -117,3 +117,37 @@ export const getImportUrlsByJobId = async (dynamoClient, config, log, jobId) =>
 
   return items ? items.map((item) => ImportUrlDto.fromDynamoItem(item)) : [];
 };
+
+/**
+ * Remove all given import URLs.
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+ * @param {ImportUrl[]} urls - The import URLs to remove.
+ * @return {Promise<void>} A promise that resolves when all URLs have been removed.
+ */
+async function removeUrls(dynamoClient, config, urls) {
+  const removeUrlPromises = urls.map((url) => dynamoClient.removeItem(
+    config.tableNameImportUrls,
+    { id: url.getId() },
+  ));
+
+  await Promise.all(removeUrlPromises);
+}
+
+/**
+ * Remove all URLs associated with an import job.
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+ * @param {Logger} log - The logger.
+ * @param {string} jobId - The ID of the import job.
+ * @return {Promise<void>} A promise that resolves when all URLs have been removed.
+ */
+export const removeUrlsForImportJob = async (dynamoClient, config, log, jobId) => {
+  try {
+    const urls = await getImportUrlsByJobId(dynamoClient, config, log, jobId);
+    await removeUrls(dynamoClient, config, urls);
+  } catch (error) {
+    log.error(`Error removing urls for import jobId: ${jobId} : ${error.message}`);
+    throw error;
+  }
+};