feat: capture page url

Author: khushi1033

dist/types/src/kitBlocking.d.ts

@@ -66,6 +66,7 @@ export default class KitBlocker {
         LaunchReferral?: string;
         ExpandedEventCount: number;
         ActiveTimeOnSite: number;
+        PageUrl?: string;
         IsBackgroundAST?: boolean;
         AlreadySentToForwarders?: boolean;
     };
@@ -110,6 +111,7 @@ export default class KitBlocker {
         LaunchReferral?: string;
         ExpandedEventCount: number;
         ActiveTimeOnSite: number;
+        PageUrl?: string;
         IsBackgroundAST?: boolean;
         AlreadySentToForwarders?: boolean;
     };

dist/types/src/sdkRuntimeModels.d.ts

@@ -60,6 +60,7 @@ export interface SDKEvent {
     LaunchReferral?: string;
     ExpandedEventCount: number;
     ActiveTimeOnSite: number;
+    PageUrl?: string;
     IsBackgroundAST?: boolean;
     AlreadySentToForwarders?: boolean;
 }

package-lock.json

@@ -103,7 +103,7 @@
         "@babel/preset-env": "^7.6.0",
         "@babel/preset-typescript": "^7.6.0",
         "@mparticle/data-planning-models": "^0.1.0",
-        "@mparticle/event-models": "^1.1.9",
+        "@mparticle/event-models": "^1.3.0",
         "@rollup/plugin-babel": "6.0.3",
         "@rollup/plugin-commonjs": "25.0.4",
         "@rollup/plugin-json": "^5.0.2",
@@ -159,7 +159,7 @@
         "webpack-cli": "^5.0.2"
     },
     "peerDependencies": {
-        "@mparticle/event-models": "^1.1.9"
+        "@mparticle/event-models": "^1.3.0"
     },
     "dependencies": {
         "@babel/runtime": "^7.23.2"

package.json

@@ -94,6 +94,7 @@ export interface SDKEvent {
     LaunchReferral?: string;
     ExpandedEventCount: number;
     ActiveTimeOnSite: number;
+    PageUrl?: string;
     IsBackgroundAST?: boolean;
     AlreadySentToForwarders?: boolean;
 }

src/sdkRuntimeModels.ts

@@ -663,7 +663,8 @@ export function convertBaseEventData(
         custom_attributes: sdkEvent.EventAttributes,
         location: convertSDKLocation(sdkEvent.Location),
         source_message_id: sdkEvent.SourceMessageId,
-        active_time_on_site_ms: sdkEvent.ActiveTimeOnSite
+        active_time_on_site_ms: sdkEvent.ActiveTimeOnSite,
+        page_url: sdkEvent.PageUrl,
     };
 
     return commonEventData;

src/sdkToEventsApiConverter.ts

@@ -310,6 +310,7 @@ export default function ServerModel(
                         event.name
                     ),
                     ActiveTimeOnSite: mpInstance._timeOnSiteTimer?.getTimeInForeground(),
+                    PageUrl: window.location.href || null,
                     SourceMessageId:
                         event.sourceMessageId ||
                         mpInstance._Helpers.generateUniqueId(),

src/serverModel.ts

@@ -510,4 +510,84 @@ describe('Old model to batch model conversion', () => {
         // set screen back on
         window.screen = originalScreen;
     });
+
+    it('propagates PageUrl to page_url on the converted event', () => {
+        const sdkEvent: SDKEvent = {
+            EventName: 'Page View',
+            EventCategory: Types.EventType.Navigation,
+            ExpandedEventCount: 0,
+            EventDataType: Types.MessageType.PageEvent,
+            EventAttributes: null,
+            ConsentState: null,
+            CurrencyCode: null,
+            CustomFlags: {},
+            DataPlan: {},
+            Debug: true,
+            DeviceId: '0edd580e-d887-44e4-89ae-cd65aa0ee933',
+            Location: null,
+            MPID: '-8433569646818451201',
+            OptOut: null,
+            SDKVersion: '2.11.15',
+            SourceMessageId: 'testSMID',
+            SessionId: '64102C03-592F-440D-8BCC-1D27AAA6B188',
+            SessionStartDate: 1603211322698,
+            Timestamp: 1603212299414,
+            ActiveTimeOnSite: 10,
+            PageUrl: 'https://example.com/checkout?utm=should-be-stripped-server-side',
+            UserAttributes: {},
+            UserIdentities: [],
+            IsFirstRun: true,
+        };
+
+        const batch = Converter.convertEvents(
+            '-8433569646818451201',
+            [sdkEvent],
+            window.mParticle.getInstance()
+        );
+
+        expect(batch).to.be.ok;
+        expect(batch.events.length).to.equal(1);
+        const event = batch.events[0] as EventsApi.CustomEvent;
+        expect(event.data.page_url).to.equal(
+            'https://example.com/checkout?utm=should-be-stripped-server-side'
+        );
+    });
+
+    it('omits page_url when PageUrl is not set on the SDK event', () => {
+        const sdkEvent: SDKEvent = {
+            EventName: 'Page View',
+            EventCategory: Types.EventType.Navigation,
+            ExpandedEventCount: 0,
+            EventDataType: Types.MessageType.PageEvent,
+            EventAttributes: null,
+            ConsentState: null,
+            CurrencyCode: null,
+            CustomFlags: {},
+            DataPlan: {},
+            Debug: true,
+            DeviceId: '0edd580e-d887-44e4-89ae-cd65aa0ee933',
+            Location: null,
+            MPID: '-8433569646818451201',
+            OptOut: null,
+            SDKVersion: '2.11.15',
+            SourceMessageId: 'testSMID',
+            SessionId: '64102C03-592F-440D-8BCC-1D27AAA6B188',
+            SessionStartDate: 1603211322698,
+            Timestamp: 1603212299414,
+            ActiveTimeOnSite: 10,
+            UserAttributes: {},
+            UserIdentities: [],
+            IsFirstRun: true,
+        };
+
+        const batch = Converter.convertEvents(
+            '-8433569646818451201',
+            [sdkEvent],
+            window.mParticle.getInstance()
+        );
+
+        expect(batch).to.be.ok;
+        const event = batch.events[0] as EventsApi.CustomEvent;
+        expect(event.data.page_url).to.equal(undefined);
+    });
 });

test/src/tests-runtimeToBatchEventsDTO.ts

@@ -297,6 +297,25 @@ describe('ServerModel', () => {
             );
         });
 
+        it('should capture window.location.href as PageUrl', () => {
+            const event: BaseEvent = {
+                name: 'Test Event',
+                messageType: Types.MessageType.PageEvent,
+                eventType: Types.EventType.Navigation,
+                data: { foo: 'bar' },
+                sourceMessageId: 'test-source-message-id',
+                customFlags: {},
+            };
+
+            const actualEventObject = mParticle
+                .getInstance()
+                ._ServerModel.createEventObject(event) as IUploadObject;
+
+            expect(actualEventObject.PageUrl, 'PageUrl').to.equal(
+                window.location.href
+            );
+        });
+
         it('should create an event object with a user', () => {
             const event: BaseEvent = {
                 name: 'Test Event',