Skip to content

feat: capture page_url in events #1276

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
khushi1033 wants to merge 2 commits into
base: development
Choose a base branch
from
Open

feat: capture page_url in events #1276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b174545
feat: capture page url
khushi1033 Jun 1, 2026
8f5a180
feat: capture page_url in background AST events
khushi1033 Jun 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions dist/types/src/kitBlocking.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ export default class KitBlocker {
LaunchReferral?: string;
ExpandedEventCount: number;
ActiveTimeOnSite: number;
PageUrl?: string;
IsBackgroundAST?: boolean;
AlreadySentToForwarders?: boolean;
};
Expand Down Expand Up @@ -110,6 +111,7 @@ export default class KitBlocker {
LaunchReferral?: string;
ExpandedEventCount: number;
ActiveTimeOnSite: number;
PageUrl?: string;
IsBackgroundAST?: boolean;
AlreadySentToForwarders?: boolean;
};
Expand Down
1 change: 1 addition & 0 deletions dist/types/src/sdkRuntimeModels.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ export interface SDKEvent {
LaunchReferral?: string;
ExpandedEventCount: number;
ActiveTimeOnSite: number;
PageUrl?: string;
IsBackgroundAST?: boolean;
AlreadySentToForwarders?: boolean;
}
Expand Down
8 changes: 5 additions & 3 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Copy link
Copy Markdown
Collaborator

@alexs-mparticle alexs-mparticle Jun 5, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see you're bumping event-models but they don't look like nothing new is being used.

Copy link
Copy Markdown
Contributor Author

@khushi1033 khushi1033 Jun 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The bump is needed convertBaseEventData in sdkToEventsApiConverter.ts builds an EventsApi.CommonEventData typed literal that now includes page_url, so without it the converter would fail to typecheck.

"@rollup/plugin-babel": "6.0.3",
"@rollup/plugin-commonjs": "25.0.4",
"@rollup/plugin-json": "^5.0.2",
Expand Down Expand Up @@ -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"
Expand Down
1 change: 1 addition & 0 deletions src/batchUploader.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@
SessionStartDate: sessionStartDate?.getTime() || now,
Debug: SDKConfig.isDevelopmentMode,
ActiveTimeOnSite: _timeOnSiteTimer?.getTimeInForeground() || 0,
PageUrl: window.location.href || null,

Check warning on line 196 in src/batchUploader.ts

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Prefer `globalThis` over `window`. 


See more on https://sonarcloud.io/project/issues?id=mParticle_mparticle-web-sdk&issues=AZ6Dj1Brl84WNu_sDXew&open=AZ6Dj1Brl84WNu_sDXew&pullRequest=1276
IsBackgroundAST: true
} as SDKEvent;

Expand Down
1 change: 1 addition & 0 deletions src/sdkRuntimeModels.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ export interface SDKEvent {
LaunchReferral?: string;
ExpandedEventCount: number;
ActiveTimeOnSite: number;
PageUrl?: string;
IsBackgroundAST?: boolean;
AlreadySentToForwarders?: boolean;
}
Expand Down
3 changes: 2 additions & 1 deletion src/sdkToEventsApiConverter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
1 change: 1 addition & 0 deletions src/serverModel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,7 @@
event.name
),
ActiveTimeOnSite: mpInstance._timeOnSiteTimer?.getTimeInForeground(),
PageUrl: window.location.href || null,

Check warning on line 313 in src/serverModel.ts

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Prefer `globalThis` over `window`. 


See more on https://sonarcloud.io/project/issues?id=mParticle_mparticle-web-sdk&issues=AZ6DW7K49ids8AwLfwuO&open=AZ6DW7K49ids8AwLfwuO&pullRequest=1276
Comment thread
cursor[bot] marked this conversation as resolved.
Comment thread
khushi1033 marked this conversation as resolved.
SourceMessageId:
event.sourceMessageId ||
mpInstance._Helpers.generateUniqueId(),
Expand Down
2 changes: 2 additions & 0 deletions test/src/tests-batchUploader.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,7 @@

expect(astEvent.event_type).to.equal('application_state_transition');
expect(astEvent.data.active_time_on_site_ms).to.be.a('number');
expect(astEvent.data.page_url).to.equal(window.location.href);

Check warning on line 244 in test/src/tests-batchUploader.ts

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Prefer `globalThis` over `window`. 


See more on https://sonarcloud.io/project/issues?id=mParticle_mparticle-web-sdk&issues=AZ6Dj1H7l84WNu_sDXex&open=AZ6Dj1H7l84WNu_sDXex&pullRequest=1276
expect(astEvent.data.application_transition_type).to.equal('application_background');
expect(astEvent.data.custom_attributes).to.exist;
expect(astEvent.data.is_first_run).to.be.a('boolean');
Expand Down Expand Up @@ -335,6 +336,7 @@

expect(astEvent.event_type).to.equal('application_state_transition');
expect(astEvent.data.active_time_on_site_ms).to.be.a('number');
expect(astEvent.data.page_url).to.equal(window.location.href);

Check warning on line 339 in test/src/tests-batchUploader.ts

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Prefer `globalThis` over `window`. 


See more on https://sonarcloud.io/project/issues?id=mParticle_mparticle-web-sdk&issues=AZ6Dj1H7l84WNu_sDXey&open=AZ6Dj1H7l84WNu_sDXey&pullRequest=1276
expect(astEvent.data.application_transition_type).to.equal('application_background');
expect(astEvent.data.custom_attributes).to.exist;
expect(astEvent.data.is_first_run).to.be.a('boolean');
Expand Down
80 changes: 80 additions & 0 deletions test/src/tests-runtimeToBatchEventsDTO.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -510,4 +510,84 @@
// 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()

Check warning on line 545 in test/src/tests-runtimeToBatchEventsDTO.ts

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Prefer `globalThis` over `window`. 


See more on https://sonarcloud.io/project/issues?id=mParticle_mparticle-web-sdk&issues=AZ6DW7Xm9ids8AwLfwuQ&open=AZ6DW7Xm9ids8AwLfwuQ&pullRequest=1276
);

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()

Check warning on line 586 in test/src/tests-runtimeToBatchEventsDTO.ts

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Prefer `globalThis` over `window`. 


See more on https://sonarcloud.io/project/issues?id=mParticle_mparticle-web-sdk&issues=AZ6DW7Xm9ids8AwLfwuR&open=AZ6DW7Xm9ids8AwLfwuR&pullRequest=1276
);

expect(batch).to.be.ok;
const event = batch.events[0] as EventsApi.CustomEvent;
expect(event.data.page_url).to.equal(undefined);
});
});
19 changes: 19 additions & 0 deletions test/src/tests-serverModel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,25 @@
);
});

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

Check warning on line 315 in test/src/tests-serverModel.ts

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Prefer `globalThis` over `window`. 


See more on https://sonarcloud.io/project/issues?id=mParticle_mparticle-web-sdk&issues=AZ6DW7V_9ids8AwLfwuP&open=AZ6DW7V_9ids8AwLfwuP&pullRequest=1276
);
});

it('should create an event object with a user', () => {
const event: BaseEvent = {
name: 'Test Event',
Expand Down
Loading