feat: add slack for redirects (#1830)

noruiz · noelruiz34 · web-flow · commit 2c3d2a57f2ee · 2026-02-27T13:24:55.000-06:00
Please ensure your pull request adheres to the following guidelines: - [ ] make sure to link the related issues in this description. Or if there's no issue created, make sure you describe here the problem you're solving. - [ ] when merging / squashing, make sure the fixed issue references are visible in the commits, for easy compilation of release notes If the PR is changing the API specification: - [ ] make sure you add a "Not implemented yet" note the endpoint description, if the implementation is not ready yet. Ideally, return a 501 status code with a message explaining the feature is not implemented yet. - [ ] make sure you add at least one example of the request and response. If the PR is changing the API implementation or an entity exposed through the API: - [ ] make sure you update the API specification and the examples to reflect the changes. If the PR is introducing a new audit type: - [ ] make sure you update the API specification with the type, schema of the audit result and an example ## Related Issues - https://jira.corp.adobe.com/browse/SITES-40913 Thanks for contributing! --------- Co-authored-by: noelruiz34 <noelruiz34@gmail.com>
diff --git a/src/support/slack/commands.js b/src/support/slack/commands.js
@@ -46,6 +46,7 @@ import revokeEntitlementImsOrg from './commands/revoke-entitlement-imsorg.js';
 import detectBotBlocker from './commands/detect-bot-blocker.js';
 import runPageCitability from './commands/run-page-citability.js';
 import runA11yCodefix from './commands/run-a11y-codefix.js';
+import identifyRedirects from './commands/identify-redirects.js';
 
 /**
  * Returns all commands.
@@ -90,4 +91,5 @@ export default (context) => [
   detectBotBlocker(context),
   runPageCitability(context),
   runA11yCodefix(context),
+  identifyRedirects(context),
 ];
diff --git a/src/support/slack/commands/identify-redirects.js b/src/support/slack/commands/identify-redirects.js
@@ -0,0 +1,113 @@
+/*
+ * Copyright 2026 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
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import { Site as SiteModel } from '@adobe/spacecat-shared-data-access';
+import { hasText } from '@adobe/spacecat-shared-utils';
+
+import BaseCommand from './base.js';
+import { extractURLFromSlackInput, postErrorMessage } from '../../../utils/slack/base.js';
+
+const PHRASES = ['identify-redirects'];
+const DEFAULT_MINUTES = 60;
+
+export default function IdentifyRedirectsCommand(context) {
+  const baseCommand = BaseCommand({
+    id: 'identify-redirects',
+    name: 'Identify Redirects',
+    description: 'Detects common redirect-manager patterns using Splunk logs (AEM CS/CW only).',
+    phrases: PHRASES,
+    usageText: `${PHRASES[0]} {baseURL}`,
+  });
+
+  const {
+    dataAccess,
+    env,
+    log,
+    sqs,
+  } = context;
+  const { Site } = dataAccess;
+
+  const handleExecution = async (args, slackContext) => {
+    const { say, channelId, threadTs } = slackContext;
+
+    try {
+      const [baseURLInput, minutesInput] = args;
+      const baseURL = extractURLFromSlackInput(baseURLInput);
+      const minutes = Number.isFinite(Number(minutesInput))
+        ? Number(minutesInput)
+        : DEFAULT_MINUTES;
+
+      if (!baseURL) {
+        await say(baseCommand.usage());
+        return;
+      }
+
+      const site = await Site.findByBaseURL(baseURL);
+      if (!site) {
+        await say(`:x: No site found with base URL '${baseURL}'.`);
+        return;
+      }
+
+      const authoringType = site.getAuthoringType();
+      if (![
+        SiteModel.AUTHORING_TYPES.CS,
+        SiteModel.AUTHORING_TYPES.CS_CW,
+      ].includes(authoringType)) {
+        await say(`:warning: identify-redirects currently supports AEM CS/CW only. This site authoringType is \`${authoringType}\`.`);
+        return;
+      }
+
+      const deliveryConfig = site.getDeliveryConfig?.() || {};
+      const { programId, environmentId } = deliveryConfig;
+
+      if (!hasText(programId) || !hasText(environmentId)) {
+        await say(':warning: This site is missing `deliveryConfig.programId` and/or `deliveryConfig.environmentId` required for Splunk queries.');
+        return;
+      }
+
+      if (!hasText(env?.AUDIT_JOBS_QUEUE_URL)) {
+        await say(':x: Server misconfiguration: missing `AUDIT_JOBS_QUEUE_URL`.');
+        return;
+      }
+
+      if (!sqs) {
+        await say(':x: Server misconfiguration: missing SQS client.');
+        return;
+      }
+
+      await say(`:mag: Queued redirect pattern detection for *${baseURL}* (last ${minutes}m). I’ll reply here when it’s ready.`);
+
+      await sqs.sendMessage(env.AUDIT_JOBS_QUEUE_URL, {
+        type: 'identify-redirects',
+        siteId: site.getId(),
+        baseURL,
+        programId: String(programId),
+        environmentId: String(environmentId),
+        minutes,
+        slackContext: {
+          channelId,
+          threadTs,
+        },
+      });
+    } catch (error) {
+      log.error(error);
+      await postErrorMessage(say, error);
+    }
+  };
+
+  baseCommand.init(context);
+
+  return {
+    ...baseCommand,
+    handleExecution,
+  };
+}
diff --git a/test/support/slack/commands/identify-redirects.test.js b/test/support/slack/commands/identify-redirects.test.js
@@ -0,0 +1,255 @@
+/*
+ * Copyright 2026 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
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+/* eslint-env mocha */
+
+import { expect, use } from 'chai';
+import sinonChai from 'sinon-chai';
+import sinon from 'sinon';
+import esmock from 'esmock';
+
+use(sinonChai);
+
+describe('IdentifyRedirectsCommand', () => {
+  const SiteModelStub = {
+    AUTHORING_TYPES: {
+      CS: 'CS',
+      CS_CW: 'CS_CW',
+    },
+  };
+
+  let IdentifyRedirectsCommand;
+  let context;
+  let slackContext;
+  let dataAccessStub;
+  let sqsStub;
+  let extractURLFromSlackInputStub;
+  let postErrorMessageStub;
+
+  beforeEach(async function beforeEachHook() {
+    this.timeout(10000);
+    extractURLFromSlackInputStub = sinon.stub();
+    postErrorMessageStub = sinon.stub().resolves();
+
+    IdentifyRedirectsCommand = (await esmock(
+      '../../../../src/support/slack/commands/identify-redirects.js',
+      {
+        '@adobe/spacecat-shared-data-access': { Site: SiteModelStub },
+        '../../../../src/utils/slack/base.js': {
+          extractURLFromSlackInput: extractURLFromSlackInputStub,
+          postErrorMessage: postErrorMessageStub,
+        },
+      },
+    )).default;
+
+    dataAccessStub = {
+      Site: {
+        findByBaseURL: sinon.stub(),
+      },
+    };
+
+    sqsStub = {
+      sendMessage: sinon.stub().resolves(),
+    };
+
+    context = {
+      dataAccess: dataAccessStub,
+      env: { AUDIT_JOBS_QUEUE_URL: 'testQueueUrl' },
+      log: {
+        error: sinon.spy(),
+      },
+      sqs: sqsStub,
+    };
+
+    slackContext = {
+      say: sinon.stub().resolves(),
+      channelId: 'C123',
+      threadTs: '1712345678.9012',
+    };
+  });
+
+  it('initializes with base command metadata', () => {
+    const command = IdentifyRedirectsCommand(context);
+    expect(command.id).to.equal('identify-redirects');
+    expect(command.name).to.equal('Identify Redirects');
+    expect(command.phrases).to.deep.equal(['identify-redirects']);
+  });
+
+  it('shows usage when baseURL is missing/invalid', async () => {
+    extractURLFromSlackInputStub.returns(null);
+    const command = IdentifyRedirectsCommand(context);
+
+    await command.handleExecution([], slackContext);
+
+    expect(slackContext.say).to.have.been.calledOnceWith(command.usage());
+  });
+
+  it('notifies when site is not found', async () => {
+    extractURLFromSlackInputStub.returns('https://example.com');
+    dataAccessStub.Site.findByBaseURL.resolves(null);
+    const command = IdentifyRedirectsCommand(context);
+
+    await command.handleExecution(['example.com'], slackContext);
+
+    expect(slackContext.say).to.have.been.calledWith(
+      ":x: No site found with base URL 'https://example.com'.",
+    );
+  });
+
+  it('rejects non CS/CW authoring types', async () => {
+    extractURLFromSlackInputStub.returns('https://example.com');
+    dataAccessStub.Site.findByBaseURL.resolves({
+      getAuthoringType: () => 'AMS',
+      getDeliveryConfig: () => ({ programId: 'p', environmentId: 'e' }),
+      getId: () => 'site-1',
+    });
+    const command = IdentifyRedirectsCommand(context);
+
+    await command.handleExecution(['example.com'], slackContext);
+
+    expect(slackContext.say).to.have.been.calledWithMatch(
+      'identify-redirects currently supports AEM CS/CW only',
+    );
+    expect(slackContext.say).to.have.been.calledWithMatch('`AMS`');
+  });
+
+  it('warns when deliveryConfig is missing programId/environmentId', async () => {
+    extractURLFromSlackInputStub.returns('https://example.com');
+    dataAccessStub.Site.findByBaseURL.resolves({
+      getAuthoringType: () => SiteModelStub.AUTHORING_TYPES.CS,
+      getDeliveryConfig: () => ({ programId: '', environmentId: 'e' }),
+      getId: () => 'site-1',
+    });
+    const command = IdentifyRedirectsCommand(context);
+
+    await command.handleExecution(['example.com'], slackContext);
+
+    expect(slackContext.say).to.have.been.calledWithMatch(
+      'missing `deliveryConfig.programId` and/or `deliveryConfig.environmentId`',
+    );
+  });
+
+  it('warns when getDeliveryConfig is not available on the site', async () => {
+    extractURLFromSlackInputStub.returns('https://example.com');
+    dataAccessStub.Site.findByBaseURL.resolves({
+      getAuthoringType: () => SiteModelStub.AUTHORING_TYPES.CS,
+      getId: () => 'site-1',
+    });
+    const command = IdentifyRedirectsCommand(context);
+
+    await command.handleExecution(['example.com'], slackContext);
+
+    expect(slackContext.say).to.have.been.calledWithMatch(
+      'missing `deliveryConfig.programId` and/or `deliveryConfig.environmentId`',
+    );
+  });
+
+  it('fails when AUDIT_JOBS_QUEUE_URL is missing', async () => {
+    extractURLFromSlackInputStub.returns('https://example.com');
+    dataAccessStub.Site.findByBaseURL.resolves({
+      getAuthoringType: () => SiteModelStub.AUTHORING_TYPES.CS_CW,
+      getDeliveryConfig: () => ({ programId: 'p', environmentId: 'e' }),
+      getId: () => 'site-1',
+    });
+
+    const command = IdentifyRedirectsCommand({
+      ...context,
+      env: {},
+    });
+
+    await command.handleExecution(['example.com'], slackContext);
+
+    expect(slackContext.say).to.have.been.calledWithMatch(
+      'missing `AUDIT_JOBS_QUEUE_URL`',
+    );
+  });
+
+  it('fails when SQS client is missing', async () => {
+    extractURLFromSlackInputStub.returns('https://example.com');
+    dataAccessStub.Site.findByBaseURL.resolves({
+      getAuthoringType: () => SiteModelStub.AUTHORING_TYPES.CS_CW,
+      getDeliveryConfig: () => ({ programId: 'p', environmentId: 'e' }),
+      getId: () => 'site-1',
+    });
+
+    const command = IdentifyRedirectsCommand({
+      ...context,
+      sqs: null,
+    });
+
+    await command.handleExecution(['example.com'], slackContext);
+
+    expect(slackContext.say).to.have.been.calledWithMatch(
+      'missing SQS client',
+    );
+  });
+
+  it('enqueues a job with default minutes when minutes is omitted', async () => {
+    extractURLFromSlackInputStub.returns('https://example.com');
+    dataAccessStub.Site.findByBaseURL.resolves({
+      getAuthoringType: () => SiteModelStub.AUTHORING_TYPES.CS,
+      getDeliveryConfig: () => ({ programId: 'p', environmentId: 'e' }),
+      getId: () => 'site-1',
+    });
+    const command = IdentifyRedirectsCommand(context);
+
+    await command.handleExecution(['example.com'], slackContext);
+
+    expect(slackContext.say).to.have.been.calledWithMatch('Queued redirect pattern detection');
+    expect(sqsStub.sendMessage).to.have.been.calledOnce;
+    expect(sqsStub.sendMessage.firstCall.args[0]).to.equal('testQueueUrl');
+    expect(sqsStub.sendMessage.firstCall.args[1]).to.deep.include({
+      type: 'identify-redirects',
+      siteId: 'site-1',
+      baseURL: 'https://example.com',
+      programId: 'p',
+      environmentId: 'e',
+      minutes: 60,
+    });
+    expect(sqsStub.sendMessage.firstCall.args[1]).to.deep.include({
+      slackContext: {
+        channelId: 'C123',
+        threadTs: '1712345678.9012',
+      },
+    });
+  });
+
+  it('parses minutes and enqueues a job', async () => {
+    extractURLFromSlackInputStub.returns('https://example.com');
+    dataAccessStub.Site.findByBaseURL.resolves({
+      getAuthoringType: () => SiteModelStub.AUTHORING_TYPES.CS_CW,
+      getDeliveryConfig: () => ({ programId: 'p', environmentId: 'e' }),
+      getId: () => 'site-1',
+    });
+    const command = IdentifyRedirectsCommand(context);
+
+    await command.handleExecution(['example.com', '15'], slackContext);
+
+    expect(sqsStub.sendMessage).to.have.been.calledOnce;
+    expect(sqsStub.sendMessage.firstCall.args[1]).to.deep.include({
+      minutes: 15,
+    });
+  });
+
+  it('logs and posts an error message when an exception occurs', async () => {
+    extractURLFromSlackInputStub.returns('https://example.com');
+    dataAccessStub.Site.findByBaseURL.rejects(new Error('boom'));
+    const command = IdentifyRedirectsCommand(context);
+
+    await command.handleExecution(['example.com'], slackContext);
+
+    expect(context.log.error).to.have.been.calledOnce;
+    expect(postErrorMessageStub).to.have.been.calledOnce;
+    expect(postErrorMessageStub.firstCall.args[0]).to.equal(slackContext.say);
+    expect(postErrorMessageStub.firstCall.args[1]).to.be.instanceOf(Error);
+  });
+});
