amplitude · yuhao900914 · Apr 18, 2024 · Mar 29, 2024 · Mar 29, 2024 · Apr 8, 2024
diff --git a/packages/analytics-browser-test/test/index.test.ts b/packages/analytics-browser-test/test/index.test.ts
@@ -907,22 +907,6 @@ describe('integration', () => {
               {
                 device_id: uuid,
                 event_id: 101,
-                event_type: 'session_start',
-                insert_id: uuid,
-                ip: '$remote',
-                language: 'en-US',
-                library,
-                partner_id: undefined,
-                plan: undefined,
-                platform: 'Web',
-                session_id: number,
-                time: number,
-                user_agent: userAgent,
-                user_id: '[email protected]',
-              },
-              {
-                device_id: uuid,
-                event_id: 102,
                 event_type: '$identify',
                 insert_id: uuid,
                 ip: '$remote',
@@ -980,6 +964,22 @@ describe('integration', () => {
                   },
                 },
               },
+              {
+                device_id: uuid,
+                event_id: 102,
+                event_type: 'session_start',
+                insert_id: uuid,
+                ip: '$remote',
+                language: 'en-US',
+                library,
+                partner_id: undefined,
+                plan: undefined,
+                platform: 'Web',
+                session_id: number,
+                time: number,
+                user_agent: userAgent,
+                user_id: '[email protected]',
+              },
               {
                 device_id: uuid,
                 event_id: 103,
@@ -1115,22 +1115,6 @@ describe('integration', () => {
               {
                 device_id: uuid,
                 event_id: 0,
-                event_type: 'session_start',
-                insert_id: uuid,
-                ip: '$remote',
-                language: 'en-US',
-                library,
-                partner_id: undefined,
-                plan: undefined,
-                platform: 'Web',
-                session_id: number,
-                time: number,
-                user_agent: userAgent,
-                user_id: '[email protected]',
-              },
-              {
-                device_id: uuid,
-                event_id: 1,
                 event_type: '$identify',
                 insert_id: uuid,
                 ip: '$remote',
@@ -1188,6 +1172,22 @@ describe('integration', () => {
                   },
                 },
               },
+              {
+                device_id: uuid,
+                event_id: 1,
+                event_type: 'session_start',
+                insert_id: uuid,
+                ip: '$remote',
+                language: 'en-US',
+                library,
+                partner_id: undefined,
+                plan: undefined,
+                platform: 'Web',
+                session_id: number,
+                time: number,
+                user_agent: userAgent,
+                user_id: '[email protected]',
+              },
               {
                 device_id: uuid,
                 event_id: 2,

diff --git a/packages/analytics-browser/package.json b/packages/analytics-browser/package.json
@@ -48,7 +48,6 @@
     "@amplitude/analytics-core": "^2.2.4",
     "@amplitude/analytics-types": "^2.5.0",
     "@amplitude/plugin-page-view-tracking-browser": "^2.2.6",
-    "@amplitude/plugin-web-attribution-browser": "^2.1.7",
     "tslib": "^2.4.1"
   },
   "devDependencies": {

diff --git a/packages/analytics-browser/playground/amplitude.js b/packages/analytics-browser/playground/amplitude.js
diff --git a/packages/analytics-browser/playground/index.html b/packages/analytics-browser/playground/index.html
@@ -7,7 +7,8 @@
     <title>Amplitude SDK Playground</title>
   </head>
   <script src="./amplitude.js"></script>
-	<script>
+
+  <script>
     amplitude.init('API_KEY', '[email protected]');
   </script>
   <body>

diff --git a/packages/analytics-browser/src/browser-client.ts b/packages/analytics-browser/src/browser-client.ts
@@ -12,6 +12,7 @@ import {
   setConnectorUserId,
   isNewSession,
   isPageViewTrackingEnabled,
+  WebAttribution,
 } from '@amplitude/analytics-client-common';
 import {
   BrowserClient,
@@ -23,11 +24,12 @@ import {
   Revenue as IRevenue,
   TransportType,
   OfflineDisabled,
+  AmplitudeReturn,
+  Result,
 } from '@amplitude/analytics-types';
 import { convertProxyObjectToRealObject, isInstanceProxy } from './utils/snippet-helper';
 import { Context } from './plugins/context';
 import { useBrowserConfig, createTransport } from './config';
-import { webAttributionPlugin } from '@amplitude/plugin-web-attribution-browser';
 import { pageViewTrackingPlugin } from '@amplitude/plugin-page-view-tracking-browser';
 import { formInteractionTracking } from './plugins/form-interaction-tracking';
 import { fileDownloadTracking } from './plugins/file-download-tracking';
@@ -41,6 +43,7 @@ export class AmplitudeBrowser extends AmplitudeCore implements BrowserClient {
   config: BrowserConfig;
   previousSessionDeviceId: string | undefined;
   previousSessionUserId: string | undefined;
+  webAttribution: WebAttribution | undefined;
 
   init(apiKey = '', userIdOrOptions?: string | BrowserOptions, maybeOptions?: BrowserOptions) {
     let userId: string | undefined;
@@ -71,6 +74,14 @@ export class AmplitudeBrowser extends AmplitudeCore implements BrowserClient {
     const browserOptions = await useBrowserConfig(options.apiKey, options, this);
     this.config = browserOptions;
 
+    // Add web attribution plugin
+    if (isAttributionTrackingEnabled(this.config.defaultTracking)) {
+      const attributionTrackingOptions = getAttributionTrackingConfig(this.config);
+      this.webAttribution = new WebAttribution(attributionTrackingOptions, this.config);
+      // Fetch the current campaign, check if need to track web attribution later
+      await this.webAttribution.init();
+    }
+
     // Step 3: Set session ID
     // Priority 1: `options.sessionId`
     // Priority 2: last known sessionId from user identity storage
@@ -109,13 +120,6 @@ export class AmplitudeBrowser extends AmplitudeCore implements BrowserClient {
       await this.add(formInteractionTracking()).promise;
     }
 
-    // Add web attribution plugin
-    if (isAttributionTrackingEnabled(this.config.defaultTracking)) {
-      const attributionTrackingOptions = getAttributionTrackingConfig(this.config);
-      const webAttribution = webAttributionPlugin(attributionTrackingOptions);
-      await this.add(webAttribution).promise;
-    }
-
     // Add page view plugin
     if (isPageViewTrackingEnabled(this.config.defaultTracking)) {
       await this.add(pageViewTrackingPlugin(getPageViewTrackingConfig(this.config))).promise;
@@ -170,14 +174,14 @@ export class AmplitudeBrowser extends AmplitudeCore implements BrowserClient {
   }
 
   setSessionId(sessionId: number) {
+    const promise = [];
     if (!this.config) {
       this.q.push(this.setSessionId.bind(this, sessionId));
-      return;
+      return returnWrapper(Promise.resolve());
     }
-
     // Prevents starting a new session with the same session ID
     if (sessionId === this.config.sessionId) {
-      return;
+      return returnWrapper(Promise.resolve());
     }
 
     const previousSessionId = this.getSessionId();
@@ -190,25 +194,37 @@ export class AmplitudeBrowser extends AmplitudeCore implements BrowserClient {
 
     if (isSessionTrackingEnabled(this.config.defaultTracking)) {
       if (previousSessionId && lastEventTime) {
-        this.track(DEFAULT_SESSION_END_EVENT, undefined, {
-          device_id: this.previousSessionDeviceId,
-          event_id: ++lastEventId,
-          session_id: previousSessionId,
-          time: lastEventTime + 1,
-          user_id: this.previousSessionUserId,
-        });
+        promise.push(
+          this.track(DEFAULT_SESSION_END_EVENT, undefined, {
+            device_id: this.previousSessionDeviceId,
+            event_id: ++lastEventId,
+            session_id: previousSessionId,
+            time: lastEventTime + 1,
+            user_id: this.previousSessionUserId,
+          }),
+        );
       }
-
       this.config.lastEventTime = this.config.sessionId;
-      this.track(DEFAULT_SESSION_START_EVENT, undefined, {
-        event_id: ++lastEventId,
-        session_id: this.config.sessionId,
-        time: this.config.lastEventTime,
-      });
+    }
+
+    // Fire web attribution event when enable webAttribution tracking
+    // 1. has new campaign (call setSessionId from init function)
+    // 2. or shouldTrackNewCampaign (call setSessionId from async process(event) when there has new campaign and resetSessionOnNewCampaign = true )
+    const isCampaignEventTracked = this.trackCampaignEventIfNeeded(++lastEventId, promise);
+
+    if (isSessionTrackingEnabled(this.config.defaultTracking)) {
+      promise.push(
+        this.track(DEFAULT_SESSION_START_EVENT, undefined, {
+          event_id: isCampaignEventTracked ? ++lastEventId : lastEventId,
+          session_id: this.config.sessionId,
+          time: this.config.lastEventTime,
+        }),
+      );
     }
 
     this.previousSessionDeviceId = this.config.deviceId;
     this.previousSessionUserId = this.config.userId;
+    return returnWrapper(Promise.all(promise));
   }
 
   extendSession() {
@@ -260,17 +276,36 @@ export class AmplitudeBrowser extends AmplitudeCore implements BrowserClient {
     return super.revenue(revenue, eventOptions);
   }
 
+  private trackCampaignEventIfNeeded(lastEventId?: number, eventsPromise?: AmplitudeReturn<Result>[]) {
+    if (!this.webAttribution || !this.webAttribution.shouldTrackNewCampaign) {
+      return false;
+    }
+    const campaignEvent = this.webAttribution.generateCampaignEvent(lastEventId);
+    eventsPromise?.push(this.track(campaignEvent));
+    this.config.loggerProvider.log('Tracking attribution.');
+    return true;
+  }
+
   async process(event: Event) {
     const currentTime = Date.now();
     const isEventInNewSession = isNewSession(this.config.sessionTimeout, this.config.lastEventTime);
+    const shouldSetSessionIdOnNewCampaign =
+      this.webAttribution && this.webAttribution.shouldSetSessionIdOnNewCampaign();
 
     if (
       event.event_type !== DEFAULT_SESSION_START_EVENT &&
       event.event_type !== DEFAULT_SESSION_END_EVENT &&
-      (!event.session_id || event.session_id === this.getSessionId()) &&
-      isEventInNewSession
+      (!event.session_id || event.session_id === this.getSessionId())
     ) {
-      this.setSessionId(currentTime);
+      if (isEventInNewSession || shouldSetSessionIdOnNewCampaign) {
+        this.setSessionId(currentTime);
+        if (shouldSetSessionIdOnNewCampaign) {
+          this.config.loggerProvider.log('Created a new session for new campaign.');
+        }
+      } else if (!isEventInNewSession) {
+        // web attribution should be track during the middle of the session if there has any new campaign
+        this.trackCampaignEventIfNeeded();
+      }
     }
 
     return super.process(event);