refactor

Author: tkotthakota-adobe

README.md

@@ -4,10 +4,10 @@
 
 ## Status
 [![codecov](https://img.shields.io/codecov/c/github/adobe-rnd/spacecat-task-processor.svg)](https://codecov.io/gh/adobe-rnd/spacecat-task-processor)
-[![CircleCI](https://img.shields.io/circleci/project/github/adobe-rnd/spacecat-audit-worker.svg)](https://circleci.com/gh/adobe-rnd/spacecat-audit-worker)
-[![GitHub license](https://img.shields.io/github/license/adobe-rnd/spacecat-audit-worker.svg)](https://github.com/adobe-rnd/spacecat-audit-worker/blob/master/LICENSE.txt)
-[![GitHub issues](https://img.shields.io/github/issues/adobe-rnd/spacecat-audit-worker.svg)](https://github.com/adobe-rnd/spacecat-audit-worker/issues)
-[![LGTM Code Quality Grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/adobe-rnd/spacecat-audit-worker.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/adobe-rnd/spacecat-audit-worker)
+[![CircleCI](https://img.shields.io/circleci/project/github/adobe-rnd/spacecat-audit-worker.svg)](https://circleci.com/gh/adobe-rnd/spacecat-task-processor)
+[![GitHub license](https://img.shields.io/github/license/adobe-rnd/spacecat-task-processor.svg)](https://github.com/adobe-rnd/spacecat-task-processor/blob/master/LICENSE.txt)
+[![GitHub issues](https://img.shields.io/github/issues/adobe-rnd/spacecat-task-processor.svg)](https://github.com/adobe-rnd/spacecat-task-processor/issues)
+[![LGTM Code Quality Grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/adobe-rnd/spacecat-task-processor.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/adobe-rnd/spacecat-task-processor)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
 ## Installation
@@ -52,98 +52,3 @@ Expected message body format in `SPACECAT-TASK-PROCESSOR-JOBS` is:
   "siteId": "string"
 }
 ```
-
-Output message body format sent to `SPACECAT-TASK-PROCESSOR-JOBS` is:
-
-```json
-{
-  "type": "string",
-  "url": "string",
-  "auditContext": "object",
-  "auditResult": "object"
-}
-```
-
-## How to Run Locally
-
-### 1. Using `nodemon` and AWS Credentials
-
-Everyone working on Spacecat should have access to the development environments via [KLAM](https://klam.corp.adobe.com/).  
-If you don’t have access, please refer to the engineering onboarding guide or contact your Spacecat team representative.
-
-After logging into KLAM, you’ll receive the following credentials required to access AWS resources such as DynamoDB and S3 for local development:
-
-- `AWS_ACCESS_KEY_ID`
-- `AWS_SECRET_ACCESS_KEY`
-- `AWS_SESSION_TOKEN`
-
-**IMPORTANT: DO NOT USE THE AWS TOKENS FROM KLAM PRODUCTION PROFILES. USE ONLY DEV TOKENS.**
-
-
-### Steps to use `nodemon`
-
-#### 1. Create an `.env` File
-
-Create a `.env` file in the root directory with the following environment variables, which are required for all audits.  
-Add any additional environment variables specific to the audit you're working on.
-
-```
-AWS_REGION=us-east-1
-DYNAMO_TABLE_NAME_DATA=spacecat-services-data
-AWS_ACCESS_KEY_ID=<acquired from KLAM>
-AWS_SECRET_ACCESS_KEY=<acquired from KLAM>
-AWS_SESSION_TOKEN=<acquired from KLAM>
-# ... other required variables depending on the audit
-```
-
-#### 2. Run/Debug with `npm start`
-
-Once your `.env` file is set up, start the local development server using:
-
-```bash
-npm start
-```
-
-To use breakpoints, make sure to use the debugging tools provided by your IDE (e.g., VSCode, WebStorm, etc.).
-
-#### 3. Trigger a Task
-
-With the server running, you can trigger a task using a `curl` POST request. The request body should include the task type and `siteId`:
-
-```json
-{
-  "type": "<task handler name>",
-  "siteId": "<siteId>"
-}
-```
-
-- A list of task handler names can be found in the [index.js file](https://github.com/adobe/spacecat-task-processor/blob/main/src/index.js#L45).
-- You can retrieve a `siteId` using:
-    - The [Spacecat API](https://opensource.adobe.com/spacecat-api-service/#tag/site/operation/getSiteByBaseUrl)
-    - The Slack command: `@spacecat-dev get site domain.com`
-
-Example `curl` request to trigger the "demo-url" task:
-
-```bash
-curl -X POST http://localhost:3000 \
-     -H "Content-Type: application/json" \
-     -d '{ "type": "demo-url", "siteId": "9ab0575a-c238-4470-ae82-9d37fb2d0e78" }'
-```
-
-### 2. Using AWS SAM and Docker.
-
-1. Ensure you have [Docker](https://docs.docker.com/desktop/setup/install/mac-install/), [AWS SAM](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/install-sam-cli.html) and [jq](https://jqlang.org/) installed.
-2. Login to AWS using [KLAM](https://klam.corp.adobe.com/) and login with your [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html).
-    * KLAM dev project: `SpaceCat Development (AWS3338)`
-3. To provide secrets to the audit, please run `./scripts/populate-env.sh` once. It will fetch all secrets from the AWS Secret Manager.
-4. To run the audit locally, execute the following commands:
-    ```bash
-    source env.sh
-    npm run local-build
-    npm run local-run
-    ```
-5. Starting point of the execution is `src/index-local.js`. Output of the audit can be found in `output.txt`.
-6. To hot reload any changes in the `/src` folder, you can use `npm run local-watch`. Note: This will require to run `npm run local-build` at least once beforehand.
-
-If you need to add additional secrets, make sure to adjust the Lambda `template.yml` accordingly.
-

docs/README.md

@@ -1,2 +0,0 @@
-
-

package.json

@@ -10,8 +10,8 @@
   },
   "scripts": {
     "start": "nodemon",
-    "test": "c8 --exclude=src/support/** --exclude=src/utils/** --exclude=src/audit-status-processor/** --exclude=src/disable-import-audit-processor/** --exclude=src/demo-url/** --exclude=src/index.js --exclude=src/index-local.js --exclude=src/preflight/** mocha 'test/**/*.test.js' --ignore test/index.test.js",
-    "test:index": "mocha test/index.test.js",
+    "test": "NODE_ENV=test mocha 'test/**/*.test.js'",
+    "test:index": "NODE_ENV=test mocha test/index.test.js",
     "test-postdeploy": "mocha -g 'Post-Deploy' --spec=test/**/*.test.js",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",

src/audit-status-processor/handler.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 Adobe. All rights reserved.
+ * Copyright 2025 Adobe. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License. You may obtain a copy
  * of the License at http://www.apache.org/licenses/LICENSE-2.0
@@ -11,7 +11,7 @@
  */
 
 import { Audit } from '@adobe/spacecat-shared-data-access';
-import { sendSlackMessage } from '../support/slack-utils.js';
+import { say } from '../utils/slack-utils.js';
 
 const AUDIT_TYPE = 'audit-status-processor';
 
@@ -36,7 +36,7 @@ export async function runAuditStatusProcessor(auditStatusMessage, context) {
     auditTypes,
   });
 
-  await sendSlackMessage(env, log, slackContext, 'Checking audit status');
+  await say(env, log, slackContext, 'Checking audit status');
   try {
     // Check latest audit status for each audit type in parallel
     const auditStatusPromises = auditTypes.map(async (auditType) => {
@@ -47,11 +47,11 @@ export async function runAuditStatusProcessor(auditStatusMessage, context) {
         if (auditResult.success) {
           log.info(`Latest audit for site ${siteId} was successful for audit type ${auditType}`);
           const slackMessage = `:check_mark: Latest audit for site ${siteId} was successful for audit type ${auditType}`;
-          return sendSlackMessage(env, log, slackContext, slackMessage);
+          return say(env, log, slackContext, slackMessage);
         } else {
           log.warn(`Latest audit for site ${siteId} failed for audit type ${auditType}: ${auditResult.error || 'Unknown error'}`);
           const slackMessage = `:x: Latest audit for site ${siteId} failed for audit type ${auditType}: ${auditResult.error || 'Unknown error'}`;
-          return sendSlackMessage(env, log, slackContext, slackMessage);
+          return say(env, log, slackContext, slackMessage);
         }
       } else {
         log.info(`No previous ${auditType} audit found for site ${siteId}`);
@@ -60,7 +60,7 @@ export async function runAuditStatusProcessor(auditStatusMessage, context) {
     });
     await Promise.all(auditStatusPromises);
     log.info('Audit status checking completed');
-    await sendSlackMessage(env, log, slackContext, 'Audit status checking completed');
+    await say(env, log, slackContext, 'Audit status checking completed');
   } catch (error) {
     log.error('Error in audit status checking:', {
       error: error.message,

src/demo-url/handler.js src/demo-url-processor/handler.jssrc/demo-url/handler.js renamed to src/demo-url-processor/handler.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 Adobe. All rights reserved.
+ * Copyright 2025 Adobe. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License. You may obtain a copy
  * of the License at http://www.apache.org/licenses/LICENSE-2.0
@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
-import { sendSlackMessage } from '../support/slack-utils.js';
+import { say } from '../utils/slack-utils.js';
 
 /** Prepare demo url for the site */
 function prepareDemoUrl(experienceUrl, organizationId, siteId) {
@@ -37,41 +37,19 @@ export async function runDemoUrlProcessor(demoUrlMessage, context) {
     organizationId,
   });
 
-  await sendSlackMessage(env, log, slackContext, 'Preparing demo url');
+  await say(env, log, slackContext, 'Preparing demo url');
   try {
     // prepare demo url
     const demoUrl = prepareDemoUrl(siteUrl, organizationId, siteId);
     log.info(`Setup complete! Access your demo environment here: ${demoUrl}`);
     const slackMessage = `:white_check_mark: Setup complete! Access your demo environment here: ${demoUrl}`;
-    await sendSlackMessage(env, log, slackContext, slackMessage);
-    return {
-      siteId,
-      demoUrlResult: {
-        status: 'Completed',
-        siteId,
-        organizationId,
-        experienceUrl: siteUrl,
-        success: true,
-      },
-      fullAuditRef: siteUrl,
-    };
+    await say(env, log, slackContext, slackMessage);
   } catch (error) {
     log.error('Error in preparing demo url:', {
       error: error.message,
       stack: error.stack,
       errorType: error.name,
     });
-
-    return {
-      siteId,
-      demoUrlResult: {
-        status: 'error',
-        siteId,
-        error: `Preparing demo url failed for ${siteId}: ${error.message}`,
-        success: false,
-      },
-      fullAuditRef: siteUrl,
-    };
   }
 }
 

src/disable-import-audit-processor/handler.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 Adobe. All rights reserved.
+ * Copyright 2025 Adobe. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License. You may obtain a copy
  * of the License at http://www.apache.org/licenses/LICENSE-2.0
@@ -11,7 +11,7 @@
  */
 
 import { Site } from '@adobe/spacecat-shared-data-access';
-import { sendSlackMessage } from '../support/slack-utils.js';
+import { say } from '../utils/slack-utils.js';
 
 const AUDIT_TYPE = 'disable-import-audit-processor';
 
@@ -36,7 +36,7 @@ export async function runDisableImportAuditProcessor(message, context) {
     importTypes,
     auditTypes,
   });
-  await sendSlackMessage(env, log, slackContext, ':broom: Disabling imports and audits...');
+  await say(env, log, slackContext, ':broom: Disabling imports and audits...');
   try {
     // Database operations
     log.info('Starting database operations');
@@ -63,35 +63,13 @@ export async function runDisableImportAuditProcessor(message, context) {
     log.info('Database changes saved successfully');
 
     const slackMessage = `:check_mark: Disabled imports ${JSON.stringify(importTypes)} and audits ${JSON.stringify(auditTypes)} for site ${siteId}`;
-    await sendSlackMessage(env, log, slackContext, slackMessage);
-
-    return {
-      siteId,
-      result: {
-        status: 'Completed',
-        siteId,
-        organizationId,
-        disabledImports: importTypes,
-        disabledAudits: auditTypes,
-        success: true,
-      },
-    };
+    await say(env, log, slackContext, slackMessage);
   } catch (error) {
     log.error('Error in disable import and audit processor:', {
       error: error.message,
       stack: error.stack,
       errorType: error.name,
     });
-
-    return {
-      siteId,
-      result: {
-        status: 'error',
-        siteId,
-        error: `Disable import and audit processing failed for ${siteId}: ${error.message}`,
-        success: false,
-      },
-    };
   }
 }
 

src/index-local.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Adobe. All rights reserved.
+ * Copyright 2025 Adobe. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License. You may obtain a copy
  * of the License at http://www.apache.org/licenses/LICENSE-2.0
@@ -16,8 +16,6 @@ import dataAccess from '@adobe/spacecat-shared-data-access';
 import { resolveSecretsName, sqsEventAdapter } from '@adobe/spacecat-shared-utils';
 import { internalServerError, notFound, ok } from '@adobe/spacecat-shared-http-utils';
 
-import sqs from './support/sqs.js';
-import s3Client from './support/s3-client.js';
 import { runAuditStatusProcessor as auditStatusProcessor } from './audit-status-processor/handler.js';
 import { runDisableImportAuditProcessor as disableImportAuditProcessor } from './disable-import-audit-processor/handler.js';
 
@@ -96,7 +94,5 @@ async function run(message, context) {
 export const main = wrap(run)
   .with(dataAccess)
   .with(sqsEventAdapter)
-  .with(sqs)
-  .with(s3Client)
   .with(secrets, { name: resolveSecretsName })
   .with(helixStatus);