fix: add logic to escape campaign tracking for direct traffic in session (#726)

Author: yuhao900914

packages/analytics-client-common/src/attribution/web-attribution.ts

@@ -4,6 +4,7 @@ import { Options, getDefaultExcludedReferrers, createCampaignEvent, isNewCampaig
 import { getStorageKey } from '../storage/helpers';
 import { CampaignParser } from './campaign-parser';
 import { BASE_CAMPAIGN } from './constants';
+import { isNewSession } from '../session';
 
 export class WebAttribution {
   options: Options;
@@ -12,6 +13,8 @@ export class WebAttribution {
   previousCampaign?: Campaign;
   currentCampaign: Campaign;
   shouldTrackNewCampaign = false;
+  sessionTimeout: number;
+  lastEventTime?: number;
 
   constructor(options: Options, config: BrowserConfig) {
     this.options = {
@@ -23,13 +26,16 @@ export class WebAttribution {
     this.storage = config.cookieStorage as unknown as Storage<Campaign>;
     this.storageKey = getStorageKey(config.apiKey, 'MKTG');
     this.currentCampaign = BASE_CAMPAIGN;
+    this.sessionTimeout = config.sessionTimeout;
+    this.lastEventTime = config.lastEventTime;
     config.loggerProvider.log('Installing web attribution tracking.');
   }
 
   async init() {
     [this.currentCampaign, this.previousCampaign] = await this.fetchCampaign();
+    const isEventInNewSession = !this.lastEventTime ? true : isNewSession(this.sessionTimeout, this.lastEventTime);
 
-    if (isNewCampaign(this.currentCampaign, this.previousCampaign, this.options)) {
+    if (isNewCampaign(this.currentCampaign, this.previousCampaign, this.options, isEventInNewSession)) {
       this.shouldTrackNewCampaign = true;
       await this.storage.set(this.storageKey, this.currentCampaign);
     }

packages/analytics-client-common/test/attribution/web-attribution.test.ts

@@ -97,4 +97,49 @@ describe('shouldTrackNewCampaign', () => {
     webAttribution.generateCampaignEvent();
     expect(webAttribution.shouldSetSessionIdOnNewCampaign()).toBe(false);
   });
+
+  test('should ignore the campaign for direct traffic in session', async () => {
+    const lastEventTime = Date.now();
+
+    const overrideMockConfig = {
+      ...mockConfig,
+      // In session event
+      lastEventTime,
+    };
+    const webAttribution = new WebAttribution({}, overrideMockConfig);
+    const previousCampaign = {
+      ...BASE_CAMPAIGN,
+      referrer: 'https://www.google.com',
+      referring_domain: 'www.google.com',
+    };
+
+    jest.spyOn(CampaignParser.prototype, 'parse').mockResolvedValue(BASE_CAMPAIGN); // Direct Traffic
+    jest.spyOn(webAttribution.storage, 'get').mockResolvedValue(previousCampaign);
+
+    await webAttribution.init();
+    expect(webAttribution.shouldTrackNewCampaign).toBe(false);
+  });
+
+  test('should not ignore the campaign for direct traffic in new session', async () => {
+    const lastEventTime = Date.now() - 2 * 30 * 60 * 1000;
+
+    const overrideMockConfig = {
+      ...mockConfig,
+      // Out of session event
+      lastEventTime,
+    };
+
+    const webAttribution = new WebAttribution({}, overrideMockConfig);
+    const previousCampaign = {
+      ...BASE_CAMPAIGN,
+      referrer: 'https://www.google.com',
+      referring_domain: 'www.google.com',
+    };
+
+    jest.spyOn(CampaignParser.prototype, 'parse').mockResolvedValue(BASE_CAMPAIGN); // Direct Traffic
+    jest.spyOn(webAttribution.storage, 'get').mockResolvedValue(previousCampaign);
+
+    await webAttribution.init();
+    expect(webAttribution.shouldTrackNewCampaign).toBe(true);
+  });
 });