feat: add temporary API to replace enabled/disabled lists

package.json

@@ -77,7 +77,7 @@
     "@adobe/spacecat-shared-ahrefs-client": "1.10.5",
     "@adobe/spacecat-shared-athena-client": "1.9.2",
     "@adobe/spacecat-shared-brand-client": "1.1.35",
-    "@adobe/spacecat-shared-data-access": "2.104.0",
+    "@adobe/spacecat-shared-data-access": "https://gist.github.com/tathagat2241/baa0d24fc1d1b06a50238574767b273d/raw/870d2b8936308897410341aab6f13012372ebc27/adobe-spacecat-shared-data-access-2.104.0.tgz",
     "@adobe/spacecat-shared-gpt-client": "1.6.16",
     "@adobe/spacecat-shared-http-utils": "1.20.0",
     "@adobe/spacecat-shared-ims-client": "1.11.9",

src/controllers/configuration.js

@@ -251,6 +251,92 @@ function ConfigurationController(ctx) {
     }
   };
 
+  /**
+   * Replaces enabled/disabled lists for a handler.
+   * This is a temporary API that replaces (not merges) the provided arrays.
+   *
+   * TEMPORARY API: This endpoint was created to clean up enabled and disabled lists
+   * by removing unnecessary site IDs. Unlike the existing updateHandler endpoint
+   * which merges arrays, this endpoint completely replaces the specified arrays.
+   * This API will be removed once the cleanup task is completed.
+   *
+   * @param {UniversalContext} context - Context of the request.
+   * @return {Promise<Response>} Updated configuration response.
+   */
+  /* c8 ignore start - temporary API, no unit tests needed */
+  const replaceHandlerEnabledDisabled = async (context) => {
+    if (!accessControlUtil.hasAdminAccess()) {
+      return forbidden('Only admins can update handler configuration');
+    }
+
+    const { handlerType } = context.params;
+    const { data } = context;
+
+    if (!hasText(handlerType)) {
+      return badRequest('Handler type is required');
+    }
+
+    if (!isNonEmptyObject(data)) {
+      return badRequest('Request body is required and cannot be empty');
+    }
+
+    // Validate that at least one of enabled or disabled is provided
+    const hasEnabled = data.enabled !== undefined;
+    const hasDisabled = data.disabled !== undefined;
+
+    if (!hasEnabled && !hasDisabled) {
+      return badRequest('At least one of enabled or disabled must be provided');
+    }
+
+    // Validate that at least one array is provided within enabled/disabled
+    // (empty arrays are allowed)
+    if (hasEnabled) {
+      const hasEnabledSites = data.enabled.sites !== undefined;
+      const hasEnabledOrgs = data.enabled.orgs !== undefined;
+      if (!hasEnabledSites && !hasEnabledOrgs) {
+        return badRequest('At least one of enabled.sites or enabled.orgs must be provided');
+      }
+      // Validate that if provided, they must be arrays
+      if (hasEnabledSites && !Array.isArray(data.enabled.sites)) {
+        return badRequest('enabled.sites must be an array');
+      }
+      if (hasEnabledOrgs && !Array.isArray(data.enabled.orgs)) {
+        return badRequest('enabled.orgs must be an array');
+      }
+    }
+
+    if (hasDisabled) {
+      const hasDisabledSites = data.disabled.sites !== undefined;
+      const hasDisabledOrgs = data.disabled.orgs !== undefined;
+      if (!hasDisabledSites && !hasDisabledOrgs) {
+        return badRequest('At least one of disabled.sites or disabled.orgs must be provided');
+      }
+      // Validate that if provided, they must be arrays
+      if (hasDisabledSites && !Array.isArray(data.disabled.sites)) {
+        return badRequest('disabled.sites must be an array');
+      }
+      if (hasDisabledOrgs && !Array.isArray(data.disabled.orgs)) {
+        return badRequest('disabled.orgs must be an array');
+      }
+    }
+
+    try {
+      const configuration = await Configuration.findLatest();
+      if (!configuration) {
+        return notFound('Configuration not found');
+      }
+
+      configuration.replaceHandlerEnabledDisabled(handlerType, data);
+      setUpdatedBy(configuration, context);
+      await configuration.save();
+
+      return ok(ConfigurationDto.toJSON(configuration));
+    } catch (error) {
+      return badRequest(error.message);
+    }
+  };
+  /* c8 ignore stop */
+
   /**
    * Updates the entire configuration or specific sections.
    * Allows updating handlers, jobs, and/or queues in a single request.
@@ -362,6 +448,7 @@ function ConfigurationController(ctx) {
     updateQueues,
     updateJob,
     updateHandler,
+    replaceHandlerEnabledDisabled,
     updateConfiguration,
     restoreVersion,
   };

src/routes/index.js

@@ -141,6 +141,9 @@ export default function getRouteHandlers(
     'PUT /configurations/latest/queues': configurationController.updateQueues,
     'PATCH /configurations/latest/jobs/:jobType': configurationController.updateJob,
     'PATCH /configurations/latest/handlers/:handlerType': configurationController.updateHandler,
+    /* TEMPORARY: This route is for cleanup task and will be removed once cleanup is done */
+    /* c8 ignore next - temporary route, no unit tests needed */
+    'PUT /configurations/latest/handlers/:handlerType/replace-enabled-disabled': configurationController.replaceHandlerEnabledDisabled,
     'PATCH /configurations/sites/audits': sitesAuditsToggleController.execute,
     'POST /event/fulfillment': fulfillmentController.processFulfillmentEvents,
     'POST /event/fulfillment/:eventType': fulfillmentController.processFulfillmentEvents,

test/controllers/configurations.test.js

@@ -117,6 +117,7 @@ describe('Configurations Controller', () => {
     'updateQueues',
     'updateJob',
     'updateHandler',
+    'replaceHandlerEnabledDisabled',
     'updateConfiguration',
     'restoreVersion',
   ];

test/routes/index.test.js

@@ -34,6 +34,9 @@ describe('getRouteHandlers', () => {
     updateQueues: sinon.stub(),
     updateJob: sinon.stub(),
     updateHandler: sinon.stub(),
+    // TEMPORARY: Mock for temporary cleanup API - will be removed once cleanup is done
+    // This is added here to prevent route tests from failing, not for unit testing the endpoint
+    replaceHandlerEnabledDisabled: sinon.stub(),
     restoreVersion: sinon.stub(),
   };
 
@@ -433,6 +436,7 @@ describe('getRouteHandlers', () => {
       'GET /configurations/:version',
       'DELETE /configurations/audits/:auditType',
       'PATCH /configurations/latest/handlers/:handlerType',
+      'PUT /configurations/latest/handlers/:handlerType/replace-enabled-disabled',
       'PATCH /configurations/latest/jobs/:jobType',
       'POST /hooks/site-detection/cdn/:hookSecret',
       'POST /hooks/site-detection/rum/:hookSecret',