feat: referral traffic enablement and backfill during llmo-onboard (#1147)

Author: ekremney

src/support/slack/commands/llmo-onboard.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
-import { isValidUrl } from '@adobe/spacecat-shared-utils';
+import { getLastNumberOfWeeks, isValidUrl } from '@adobe/spacecat-shared-utils';
 
 import {
   extractURLFromSlackInput,
@@ -19,8 +19,32 @@ import {
 
 import BaseCommand from './base.js';
 
+const REFERRAL_TRAFFIC_AUDIT = 'llmo-referral-traffic';
+const REFERRAL_TRAFFIC_IMPORT = 'traffic-analysis';
+
 const PHRASES = ['onboard-llmo'];
 
+async function triggerReferralTrafficBackfill(context, configuration, siteId) {
+  const { log, sqs } = context;
+
+  const last4Weeks = getLastNumberOfWeeks(4);
+
+  for (const last4Week of last4Weeks) {
+    const { week, year } = last4Week;
+    const message = {
+      type: REFERRAL_TRAFFIC_IMPORT,
+      siteId,
+      auditContext: {
+        auditType: REFERRAL_TRAFFIC_AUDIT,
+        week,
+        year,
+      },
+    };
+    sqs.sendMessage(configuration.getQueues().imports, message);
+    log.info(`Successfully triggered import ${REFERRAL_TRAFFIC_IMPORT} with message: ${JSON.stringify(message)}`);
+  }
+}
+
 /**
  * Factory function to create the LlmoOnboardCommand object.
  *
@@ -40,7 +64,7 @@ function LlmoOnboardCommand(context) {
   const {
     dataAccess, log,
   } = context;
-  const { Site } = dataAccess;
+  const { Site, Configuration } = dataAccess;
 
   /**
    * Handles LLMO onboarding for a single site.
@@ -109,10 +133,20 @@ function LlmoOnboardCommand(context) {
       // Set the config directly as a plain object
       site.setConfig(updatedConfigData);
 
+      // enable the traffic-analysis import for referral-traffic
+      siteConfig.enableImport(REFERRAL_TRAFFIC_IMPORT);
+
+      // enable the llmo-referral-traffic import for referral-traffic
+      const configuration = await Configuration.findLatest();
+      configuration.enableHandlerForSite(REFERRAL_TRAFFIC_AUDIT, site);
+
       try {
+        await configuration.save();
         await site.save();
         log.info(`Successfully updated LLMO config for site ${siteId}`);
 
+        await triggerReferralTrafficBackfill(context, configuration, siteId);
+
         const message = `:white_check_mark: *LLMO onboarding completed successfully!*
         
 :link: *Site:* ${baseURL}

test/support/slack/commands/llmo-onboard.test.js

@@ -27,6 +27,7 @@ describe('LlmoOnboardCommand', () => {
   let mockConfig;
   let mockDataAccess;
   let mockLog;
+  let mockConfiguration;
   let slackContext;
 
   beforeEach(() => {
@@ -40,6 +41,7 @@ describe('LlmoOnboardCommand', () => {
       getContentAiConfig: sinon.stub().returns({}),
       getImports: sinon.stub().returns([]),
       getCdnLogsConfig: sinon.stub().returns({}),
+      enableImport: sinon.stub(),
     };
 
     // Create mock site
@@ -50,11 +52,21 @@ describe('LlmoOnboardCommand', () => {
       save: sinon.stub().resolves(),
     };
 
+    // Mock global Configuration
+    mockConfiguration = {
+      enableHandlerForSite: sinon.stub(),
+      save: sinon.stub().resolves(),
+      getQueues: sinon.stub().returns({ imports: 'queue-imports' }),
+    };
+
     // Create mock data access
     mockDataAccess = {
       Site: {
         findByBaseURL: sinon.stub().resolves(mockSite),
       },
+      Configuration: {
+        findLatest: sinon.stub().resolves(mockConfiguration),
+      },
     };
 
     // Create mock log
@@ -67,6 +79,9 @@ describe('LlmoOnboardCommand', () => {
     mockContext = {
       dataAccess: mockDataAccess,
       log: mockLog,
+      sqs: {
+        sendMessage: sinon.stub(),
+      },
     };
 
     // Create slack context
@@ -130,12 +145,38 @@ describe('LlmoOnboardCommand', () => {
       );
     });
 
-    it('should successfully onboard LLMO for a valid site', async () => {
+    it('should successfully onboard LLMO for a valid site and enable referral traffic processing + backfill', async () => {
       await command.handleExecution(['https://example.com', 'adobe', 'Adobe'], slackContext);
 
+      // site lookup and config update
       expect(mockDataAccess.Site.findByBaseURL).to.have.been.calledWith('https://example.com');
       expect(mockSite.setConfig).to.have.been.called;
-      expect(mockSite.save).to.have.been.called;
+
+      // enable traffic-analysis import on the site config
+      expect(mockConfig.enableImport).to.have.been.calledWith('traffic-analysis');
+
+      // enable handler for site in Configuration and save it
+      expect(mockDataAccess.Configuration.findLatest).to.have.been.calledOnce;
+      expect(mockConfiguration.enableHandlerForSite).to.have.been.calledWith('llmo-referral-traffic', mockSite);
+      expect(mockConfiguration.save).to.have.been.calledOnce;
+
+      // save site config after configuration saved
+      expect(mockSite.save).to.have.been.calledOnce;
+      sinon.assert.callOrder(mockConfiguration.save, mockSite.save);
+
+      // referral-traffic backfill should enqueue 4 messages (last 4 weeks)
+      expect(mockContext.sqs.sendMessage.callCount).to.equal(4);
+      const calls = mockContext.sqs.sendMessage.getCalls();
+      calls.forEach((call) => {
+        const [queue, payload] = call.args;
+        expect(queue).to.equal('queue-imports');
+        expect(payload).to.include({ type: 'traffic-analysis', siteId: 'test-site-id' });
+        expect(payload.auditContext).to.include({ auditType: 'llmo-referral-traffic' });
+        expect(payload.auditContext.week).to.be.a('number');
+        expect(payload.auditContext.year).to.be.a('number');
+      });
+
+      // success message
       expect(slackContext.say).to.have.been.calledWith(
         sinon.match.string.and(sinon.match(/LLMO onboarding completed successfully/)),
       );
@@ -165,7 +206,7 @@ describe('LlmoOnboardCommand', () => {
       expect(mockSite.save).to.have.been.called;
     });
 
-    it('should handle save errors gracefully', async () => {
+    it('should handle site save errors gracefully', async () => {
       const saveError = new Error('Database error');
       mockSite.save.rejects(saveError);
 
@@ -179,6 +220,22 @@ describe('LlmoOnboardCommand', () => {
       );
     });
 
+    it('should handle configuration save errors gracefully', async () => {
+      const saveError = new Error('Conf DB error');
+      mockConfiguration.save.rejects(saveError);
+
+      await command.handleExecution(['https://example.com', 'adobe', 'Adobe'], slackContext);
+
+      expect(mockLog.error).to.have.been.calledWith(
+        sinon.match(/Error saving LLMO config for site test-site-id/),
+      );
+      expect(slackContext.say).to.have.been.calledWith(
+        ':x: Failed to save LLMO configuration: Conf DB error',
+      );
+      // site.save should not be called when configuration.save fails
+      expect(mockSite.save).to.not.have.been.called;
+    });
+
     it('sends a message for all other errors', async () => {
       const error = new Error('Unexpected error');
       mockDataAccess.Site.findByBaseURL.rejects(error);