SITES-31926: feat: added support for smart grouping of CWV recommendations

src/support/slack/commands.js

@@ -27,6 +27,7 @@ import toggleSiteAudit from './commands/toggle-site-audit.js';
 import onboard from './commands/onboard.js';
 import setSiteOrganizationCommand from './commands/set-ims-org.js';
 import toggleSiteImport from './commands/toggle-site-import.js';
+import AssignCwvTemplateGroups from './commands/assign-cwv-template-groups.js';
 
 /**
  * Returns all commands.
@@ -52,4 +53,5 @@ export default (context) => [
   onboard(context),
   setSiteOrganizationCommand(context),
   toggleSiteImport(context),
+  AssignCwvTemplateGroups(context),
 ];

src/support/slack/commands/assign-cwv-template-groups.js

@@ -0,0 +1,87 @@
+/*
+ * 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
+ *
+ * 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 { Audit } from '@adobe/spacecat-shared-data-access';
+import { isString } from '@adobe/spacecat-shared-utils';
+import { Config } from '@adobe/spacecat-shared-data-access/src/models/site/config.js';
+import BaseCommand from './base.js';
+import { extractURLFromSlackInput } from '../../../utils/slack/base.js';
+
+const PHRASE = 'assign cwv template groups';
+const SUCCESS_MESSAGE_PREFIX = ':white_check_mark: ';
+const ERROR_MESSAGE_PREFIX = ':x: ';
+
+export default (context) => {
+  const baseCommand = BaseCommand({
+    id: 'configurations-sites--assign-cwv-template-groups',
+    name: 'Assign Template-Based Page Groups',
+    description: 'Automatically groups pages by URL pattern based on the latest CWV audit. Falls back to manual grouping if needed.',
+    phrases: [PHRASE],
+    usageText: `${PHRASE} {site}`,
+  });
+
+  const { log, dataAccess } = context;
+  const { Site } = dataAccess;
+
+  const handleExecution = async (args, slackContext) => {
+    const { say } = slackContext;
+    const [baseURLInput] = args;
+
+    try {
+      const baseURL = extractURLFromSlackInput(baseURLInput);
+
+      if (isString(baseURL) === false || baseURL.length === 0) {
+        await say(`${ERROR_MESSAGE_PREFIX}The site URL is missing or in the wrong format.`);
+        return;
+      }
+
+      const site = await Site.findByBaseURL(baseURL);
+      if (!site) {
+        await say(`${ERROR_MESSAGE_PREFIX}Site with baseURL "${baseURL}" not found.`);
+        return;
+      }
+
+      const siteConfig = site.getConfig();
+      await say(`${SUCCESS_MESSAGE_PREFIX}${JSON.stringify(siteConfig, null, 2)}`);
+
+      const suggestedGroupedUrls = [{ pattern: 'test' }];
+      const currentGroupedURLs = siteConfig.getGroupedURLs(Audit.AUDIT_TYPES.CWV) || [];
+      let patchedGroupedURLs = [];
+      if (suggestedGroupedUrls.length !== 0) {
+        patchedGroupedURLs = Object.values(
+          [...currentGroupedURLs, ...suggestedGroupedUrls].reduce((acc, item) => {
+            acc[item.pattern] = item;
+            return acc;
+          }, {}),
+        );
+      }
+
+      // if objects are not equal
+      siteConfig.updateGroupedURLs(Audit.AUDIT_TYPES.CWV, patchedGroupedURLs);
+      site.setConfig(Config.toDynamoItem(siteConfig));
+      // await site.save();
+
+      const groupCount = 0;
+      await say(`${SUCCESS_MESSAGE_PREFIX}Found ${groupCount} new group(s) for site "${baseURL}" and added them`
+        + ' to the configuration. Please re-run the CWV audit to see the results.');
+    } catch (error) {
+      log.error(error);
+      await say(`${ERROR_MESSAGE_PREFIX}An error occurred while trying to automatically group pages by URL pattern: ${error.message}.`);
+    }
+  };
+
+  baseCommand.init(context);
+
+  return {
+    ...baseCommand,
+    handleExecution,
+  };
+};

test/support/slack/commands/assign-cwv-template-groups.test.js

@@ -0,0 +1,203 @@
+/*
+ * 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
+ *
+ * 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 sinon from 'sinon';
+import { expect } from 'chai';
+import { Audit } from '@adobe/spacecat-shared-data-access';
+import AssignCwvTemplateGroupsCommand from '../../../../src/support/slack/commands/assign-cwv-template-groups.js';
+
+const SUCCESS_MESSAGE_PREFIX = ':white_check_mark: ';
+const ERROR_MESSAGE_PREFIX = ':x: ';
+
+describe('AssignCwvTemplateGroups', () => {
+  const sandbox = sinon.createSandbox();
+
+  const siteConfigMock = {
+    getGroupedURLs: sandbox.stub(),
+    updateGroupedURLs: sandbox.stub(),
+    getSlackConfig: () => {},
+    getHandlers: () => (({ [Audit.AUDIT_TYPES.CWV]: {} })),
+    getContentAiConfig: () => {},
+    getImports: () => [],
+    getFetchConfig: () => {},
+    getBrandConfig: () => {},
+  };
+
+  const siteMock = {
+    getConfig: sandbox.stub().returns(siteConfigMock),
+    setConfig: sandbox.stub(),
+  };
+
+  let configurationMock;
+  let dataAccessMock;
+  let logMock;
+  let contextMock;
+  let slackContextMock;
+  const exceptsAtBadRequest = () => {
+    expect(
+      configurationMock.save.called,
+      'Expected updateConfiguration to not be called, but it was',
+    ).to.be.false;
+  };
+
+  beforeEach(async () => {
+    configurationMock = {
+      getVersion: sandbox.stub(),
+      getJobs: sandbox.stub(),
+      getHandlers: sandbox.stub().returns(),
+      getQueues: sandbox.stub(),
+      save: sandbox.stub(),
+    };
+
+    dataAccessMock = {
+      Site: {
+        findByBaseURL: sandbox.stub().resolves(),
+      },
+    };
+
+    logMock = {
+      error: sandbox.stub(),
+    };
+
+    contextMock = {
+      log: logMock,
+      dataAccess: dataAccessMock,
+      env: {
+        SLACK_BOT_TOKEN: 'mock-token',
+      },
+    };
+
+    slackContextMock = {
+      say: sinon.stub(),
+    };
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
+  it('Assigns page groups when the configuration has no patterns but suggestions are available', async () => {
+    const baseUrl = 'https://site0.com';
+    const currentGroupedUrls = undefined;
+    const suggestedGroupedUrls = [{ pattern: 'test' }];
+    const groupCount = 0;
+
+    dataAccessMock.Site.findByBaseURL.withArgs(baseUrl).resolves(siteMock);
+    siteConfigMock.getGroupedURLs.withArgs(Audit.AUDIT_TYPES.CWV).returns(currentGroupedUrls);
+
+    const command = AssignCwvTemplateGroupsCommand(contextMock);
+    const args = [baseUrl];
+    await command.handleExecution(args, slackContextMock);
+
+    expect(
+      dataAccessMock.Site.findByBaseURL.calledWith(baseUrl),
+      `Expected dataAccess.getSiteByBaseURL to be called with "${baseUrl}", but it was not`,
+    ).to.be.true;
+    expect(
+      siteConfigMock.getGroupedURLs.calledWith(Audit.AUDIT_TYPES.CWV),
+      `Expected siteConfig.getGroupedURLs to be called with "${Audit.AUDIT_TYPES.CWV}", but it was not`,
+    ).to.be.true;
+    expect(
+      siteConfigMock.updateGroupedURLs.calledWith(Audit.AUDIT_TYPES.CWV, suggestedGroupedUrls),
+      'Expected siteConfig.updateGroupedURLs to be called , but it was not',
+    ).to.be.true;
+    expect(
+      siteMock.setConfig.calledOnce,
+      'Expected site.setConfig to be called once, but it was not',
+    ).to.be.true;
+    const expectedMessage = `${SUCCESS_MESSAGE_PREFIX}Found ${groupCount} new group(s) for site "${baseUrl}"`
+      + ' and added them to the configuration. Please re-run the CWV audit to see the results.';
+    expect(
+      slackContextMock.say.calledWith(expectedMessage),
+      `Expected say method to be called with message: "${expectedMessage}"`,
+    ).to.be.true;
+  });
+
+  it('if site base URL without scheme should be added "https://"', async () => {
+    dataAccessMock.Site.findByBaseURL.withArgs('https://site0.com').resolves(siteMock);
+
+    const command = AssignCwvTemplateGroupsCommand(contextMock);
+    const args = ['site0.com'];
+    await command.handleExecution(args, slackContextMock);
+
+    expect(
+      dataAccessMock.Site.findByBaseURL.calledWith('https://site0.com'),
+      'Expected dataAccess.getSiteByBaseURL to be called with "https://site0.com", but it was not',
+    ).to.be.true;
+  });
+
+  describe('Internal errors', () => {
+    it('error during execution', async () => {
+      const error = new Error('Test error');
+      dataAccessMock.Site.findByBaseURL.rejects(error);
+
+      const command = AssignCwvTemplateGroupsCommand(contextMock);
+      const args = ['http://site0.com'];
+      await command.handleExecution(args, slackContextMock);
+
+      expect(
+        contextMock.log.error.calledWith(error),
+        'Expected log.error to be called with the provided error, but it was not',
+      ).to.be.true;
+      expect(
+        slackContextMock.say.calledWith(`${ERROR_MESSAGE_PREFIX}An error occurred while trying to automatically group pages by URL pattern: Test error.`),
+        `Expected say method to be called with error message "${ERROR_MESSAGE_PREFIX}An error occurred while trying to automatically group pages by URL pattern: Test error."`,
+      ).to.be.true;
+    });
+  });
+
+  describe('Bad Request Errors', () => {
+    it('if "baseURL" is not provided', async () => {
+      const command = AssignCwvTemplateGroupsCommand(contextMock);
+      const args = [''];
+
+      await command.handleExecution(args, slackContextMock);
+
+      exceptsAtBadRequest();
+      expect(
+        slackContextMock.say.calledWith(`${ERROR_MESSAGE_PREFIX}The site URL is missing or in the wrong format.`),
+        `Expected say method to be called with error message "${ERROR_MESSAGE_PREFIX}The site URL is missing or in the wrong format.", but it was not called with that message.`,
+      ).to.be.true;
+    });
+
+    it('if "baseURL" has wrong site format', async () => {
+      const command = AssignCwvTemplateGroupsCommand(contextMock);
+      const args = ['wrong_site_format'];
+
+      await command.handleExecution(args, slackContextMock);
+
+      exceptsAtBadRequest();
+      expect(
+        slackContextMock.say.calledWith(`${ERROR_MESSAGE_PREFIX}The site URL is missing or in the wrong format.`),
+        `Expected say method to be called with error message "${ERROR_MESSAGE_PREFIX}The site URL is missing or in the wrong format.", but it was not called with that message.`,
+      ).to.be.true;
+    });
+
+    it('if a site is not found', async () => {
+      const baseURL = 'https://site0.com';
+      dataAccessMock.Site.findByBaseURL.withArgs('https://site0.com').resolves(null);
+
+      const command = AssignCwvTemplateGroupsCommand(contextMock);
+      const args = [baseURL];
+
+      await command.handleExecution(args, slackContextMock);
+
+      exceptsAtBadRequest();
+      expect(
+        slackContextMock.say.calledWith(`${ERROR_MESSAGE_PREFIX}Site with baseURL "${baseURL}" not found.`),
+        'Expected slackContextMock.say to be called with the specified error message, but it was not.',
+      ).to.be.true;
+    });
+  });
+});