fix(browser): Ensure pageload & navigation spans have correct data#16279

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

Merged
mydea merged 7 commits into from
May 14, 2025
Merged

fix(browser): Ensure pageload & navigation spans have correct data #16279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8102ffc
fix(browser): Ensure pageload & navigation spans have correct data
mydea May 13, 2025
5cd662a
fix tests
mydea May 14, 2025
694883d
reset it afterwards
mydea May 14, 2025
cee11ea
fix by using `to` from history instrumentation
mydea May 14, 2025
dcd9311
fix tests & add test for absolute url handling
mydea May 14, 2025
d12215d
Revert "fix tests"
mydea May 14, 2025
6139d08
fix replay test
mydea May 14, 2025
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
4 changes: 2 additions & 2 deletions ...ages/browser-integration-tests/suites/integrations/Breadcrumbs/history/navigation/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,14 +29,14 @@ sentryTest('should record history changes as navigation breadcrumbs', async ({ g
category: 'navigation',
data: {
from: '/bar?a=1#fragment',
to: '[object Object]',
to: '/[object%20Object]',
},
timestamp: expect.any(Number),
},
{
category: 'navigation',
data: {
from: '[object Object]',
from: '/[object%20Object]',
to: '/bar?a=1#fragment',
},
timestamp: expect.any(Number),
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/browser-integration-tests/suites/replay/multiple-pages/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -210,7 +210,7 @@ sentryTest(
expect(replayEvent6).toEqual(
getExpectedReplayEvent({
segment_id: 6,
urls: ['/spa'],
urls: [`${TEST_HOST}/spa`],
request: {
url: `${TEST_HOST}/spa`,
headers: {
Expand Down
2 changes: 1 addition & 1 deletion ...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,4 +9,4 @@ Sentry.init({
});

// Immediately navigate to a new page to abort the pageload
window.location.href = '#foo';
window.history.pushState({}, '', '/sub-page');
15 changes: 15 additions & 0 deletions ...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,9 @@ sentryTest(
expect(navigationTraceId).toBeDefined();
expect(pageloadTraceId).not.toEqual(navigationTraceId);

expect(pageloadRequest.transaction).toEqual('/index.html');
expect(navigationRequest.transaction).toEqual('/sub-page');

expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -54,5 +57,17 @@ sentryTest(
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
['sentry.idle_span_finish_reason']: 'idleTimeout',
});
expect(pageloadRequest.request).toEqual({
headers: {
'User-Agent': expect.any(String),
},
url: 'http://sentry-test.io/index.html',
});
expect(navigationRequest.request).toEqual({
headers: {
'User-Agent': expect.any(String),
},
url: 'http://sentry-test.io/sub-page',
});
},
);
85 changes: 84 additions & 1 deletion ...ges/browser-integration-tests/suites/tracing/browserTracingIntegration/navigation/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,12 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';
import {
envelopeRequestParser,
getFirstSentryEnvelopeRequest,
shouldSkipTracingTest,
waitForTransactionRequest,
} from '../../../../utils/helpers';

sentryTest('should create a navigation transaction on page navigation', async ({ getLocalTestUrl, page }) => {
if (shouldSkipTracingTest()) {
Expand All@@ -31,6 +36,10 @@ sentryTest('should create a navigation transaction on page navigation', async ({
expect(navigationTraceId).toBeDefined();
expect(pageloadTraceId).not.toEqual(navigationTraceId);

expect(pageloadRequest.transaction).toEqual('/index.html');
// Fragment is not in transaction name
expect(navigationRequest.transaction).toEqual('/index.html');

expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -45,6 +54,18 @@ sentryTest('should create a navigation transaction on page navigation', async ({
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
['sentry.idle_span_finish_reason']: 'idleTimeout',
});
expect(pageloadRequest.request).toEqual({
headers: {
'User-Agent': expect.any(String),
},
url: 'http://sentry-test.io/index.html',
});
expect(navigationRequest.request).toEqual({
headers: {
'User-Agent': expect.any(String),
},
url: 'http://sentry-test.io/index.html#foo',
});

const pageloadSpans = pageloadRequest.spans;
const navigationSpans = navigationRequest.spans;
Expand All@@ -69,3 +90,65 @@ sentryTest('should create a navigation transaction on page navigation', async ({

expect(pageloadSpanId).not.toEqual(navigationSpanId);
});

//
sentryTest('should handle pushState with full URL', async ({ getLocalTestUrl, page }) => {
if (shouldSkipTracingTest()) {
sentryTest.skip();
}

const url = await getLocalTestUrl({ testDir: __dirname });

const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');
const navigationRequestPromise = waitForTransactionRequest(
page,
event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page',
);
const navigationRequestPromise2 = waitForTransactionRequest(
page,
event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page-2',
);

await page.goto(url);
await pageloadRequestPromise;

await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page`);");

const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

expect(navigationRequest.transaction).toEqual('/sub-page');

expect(navigationRequest.contexts?.trace?.data).toMatchObject({
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
['sentry.idle_span_finish_reason']: 'idleTimeout',
});
expect(navigationRequest.request).toEqual({
headers: {
'User-Agent': expect.any(String),
},
url: 'http://sentry-test.io/sub-page',
});

await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page-2`);");

const navigationRequest2 = envelopeRequestParser(await navigationRequestPromise2);

expect(navigationRequest2.transaction).toEqual('/sub-page-2');

expect(navigationRequest2.contexts?.trace?.data).toMatchObject({
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
['sentry.idle_span_finish_reason']: 'idleTimeout',
});
expect(navigationRequest2.request).toEqual({
headers: {
'User-Agent': expect.any(String),
},
url: 'http://sentry-test.io/sub-page-2',
});
});
20 changes: 18 additions & 2 deletions packages/browser-utils/src/instrument/history.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,15 @@ export function instrumentHistory(): void {
return function (this: History, ...args: unknown[]): void {
const url = args.length > 2 ? args[2] : undefined;
if (url) {
// coerce to string (this is what pushState does)
const from = lastHref;
const to = String(url);

// Ensure the URL is absolute
// this can be either a path, then it is relative to the current origin
// or a full URL of the current origin - other origins are not allowed
// See: https://developer.mozilla.org/en-US/docs/Web/API/History/pushState#url
// coerce to string (this is what pushState does)
const to = getAbsoluteUrl(String(url));

// keep track of the current URL state, as we always receive only the updated state
lastHref = to;

Expand All@@ -67,3 +73,13 @@ export function instrumentHistory(): void {
fill(WINDOW.history, 'pushState', historyReplacementFunction);
fill(WINDOW.history, 'replaceState', historyReplacementFunction);
}

function getAbsoluteUrl(urlOrPath: string): string {
try {
const url = new URL(urlOrPath, WINDOW.location.origin);
return url.toString();
} catch {
// fallback, just do nothing
return urlOrPath;
}
}
22 changes: 22 additions & 0 deletions packages/browser/src/helpers.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
addExceptionTypeValue,
addNonEnumerableProperty,
captureException,
getLocationHref,
getOriginalFunction,
GLOBAL_OBJ,
markFunctionWrapped,
Expand DownExpand Up@@ -175,3 +176,24 @@ export function wrap<T extends WrappableFunction, NonFunction>(

return sentryWrapped;
}

/**
* Get HTTP request data from the current page.
*/
export function getHttpRequestData(): { url: string; headers: Record<string, string> } {
// grab as much info as exists and add it to the event
const url = getLocationHref();
const { referrer } = WINDOW.document || {};
const { userAgent } = WINDOW.navigator || {};

const headers = {
...(referrer && { Referer: referrer }),
...(userAgent && { 'User-Agent': userAgent }),
};
const request = {
url,
headers,
};

return request;
}
20 changes: 7 additions & 13 deletions packages/browser/src/integrations/httpcontext.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { defineIntegration, getLocationHref } from '@sentry/core';
import { WINDOW } from '../helpers';
import { defineIntegration } from '@sentry/core';
import { getHttpRequestData, WINDOW } from '../helpers';

/**
* Collects information about HTTP request headers and
Expand All@@ -14,23 +14,17 @@ export const httpContextIntegration = defineIntegration(() => {
return;
}

// grab as much info as exists and add it to the event
const url = event.request?.url || getLocationHref();
const { referrer } = WINDOW.document || {};
const { userAgent } = WINDOW.navigator || {};

const reqData = getHttpRequestData();
const headers = {
...reqData.headers,
...event.request?.headers,
...(referrer && { Referer: referrer }),
...(userAgent && { 'User-Agent': userAgent }),
};
const request = {

event.request = {
...reqData,
...event.request,
...(url && { url }),
headers,
};

event.request = request;
},
};
});
51 changes: 38 additions & 13 deletions packages/browser/src/tracing/browserTracingIntegration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
getLocationHref,
GLOBAL_OBJ,
logger,
parseStringToURLObject,
propagationContextFromHeaders,
registerSpanErrorInstrumentation,
SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON,
Expand All@@ -33,7 +34,7 @@ import {
startTrackingWebVitals,
} from '@sentry-internal/browser-utils';
import { DEBUG_BUILD } from '../debug-build';
import { WINDOW } from '../helpers';
import { getHttpRequestData, WINDOW } from '../helpers';
import { registerBackgroundTabDetection } from './backgroundtab';
import { linkTraces } from './linkedTraces';
import { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from './request';
Expand DownExpand Up@@ -399,7 +400,14 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
maybeEndActiveSpan();

getIsolationScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
getCurrentScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });

const scope = getCurrentScope();
scope.setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
// We reset this to ensure we do not have lingering incorrect data here
// places that call this hook may set this where appropriate - else, the URL at span sending time is used
scope.setSDKProcessingMetadata({
normalizedRequest: undefined,
});

_createRouteSpan(client, {
op: 'navigation',
Expand All@@ -417,7 +425,15 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
const baggage = traceOptions.baggage || getMetaContent('baggage');

const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
getCurrentScope().setPropagationContext(propagationContext);

const scope = getCurrentScope();
scope.setPropagationContext(propagationContext);

// We store the normalized request data on the scope, so we get the request data at time of span creation
// otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
scope.setSDKProcessingMetadata({
normalizedRequest: getHttpRequestData(),
});

_createRouteSpan(client, {
op: 'pageload',
Expand DownExpand Up@@ -459,16 +475,25 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
return;
}

if (from !== to) {
startingUrl = undefined;
startBrowserTracingNavigationSpan(client, {
name: WINDOW.location.pathname,
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
},
});
}
startingUrl = undefined;

@Lms24Lms24May 14, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

m/q: why did we remove the from !== to check?

@mydeamydeaMay 14, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

sorry, forgot to mention this - we actually have the same check in the history handler code, where we do not even trigger the handler in this case!

@Lms24Lms24May 14, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nice, good catch!

const parsed = parseStringToURLObject(to);
startBrowserTracingNavigationSpan(client, {
name: parsed?.pathname || WINDOW.location.pathname,
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
},
});

// We store the normalized request data on the scope, so we get the request data at time of span creation
// otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
getCurrentScope().setSDKProcessingMetadata({
normalizedRequest: {
...getHttpRequestData(),
// Ensure to set this, so this matches the target route even if the URL has not yet been updated
url: to,
},
});
});
}
}
Expand Down
3 changes: 3 additions & 0 deletions packages/core/src/tracing/sentrySpan.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -336,6 +336,8 @@ export class SentrySpan implements Span {

const { scope: capturedSpanScope, isolationScope: capturedSpanIsolationScope } = getCapturedScopesOnSpan(this);

const normalizedRequest = capturedSpanScope?.getScopeData().sdkProcessingMetadata?.normalizedRequest;

if (this._sampled !== true) {
return undefined;
}
Expand DownExpand Up@@ -374,6 +376,7 @@ export class SentrySpan implements Span {
capturedSpanIsolationScope,
dynamicSamplingContext: getDynamicSamplingContextFromSpan(this),
},
request: normalizedRequest,
...(source && {
transaction_info: {
source,
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/types-hoist/instrument.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,9 @@ export interface HandlerDataConsole {
}

export interface HandlerDataHistory {
/** The full URL of the previous page */
from: string | undefined;
/** The full URL of the new page */
to: string;
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(browser): Ensure pageload & navigation spans have correct data#16279

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

 Merged

mydea
merged 7 commits into

from

May 14, 2025
 Merged


fix(browser): Ensure pageload & navigation spans have correct data
#16279
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
8102ffc

fix(browser): Ensure pageload & navigation spans have correct data


mydea May 13, 2025
5cd662a

fix tests


mydea May 14, 2025
694883d

reset it afterwards


mydea May 14, 2025
cee11ea

fix by using `to` from history instrumentation


mydea May 14, 2025
dcd9311

fix tests & add test for absolute url handling


mydea May 14, 2025
d12215d

Revert "fix tests"


mydea May 14, 2025
6139d08

fix replay test


mydea May 14, 2025

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


4 changes: 2 additions & 2 deletions
...ages/browser-integration-tests/suites/integrations/Breadcrumbs/history/navigation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,14 +29,14 @@ sentryTest('should record history changes as navigation breadcrumbs', async ({ g
 category: 'navigation',
 data: {
 from: '/bar?a=1#fragment',
 to: '[object Object]',
 to: '/[object%20Object]',
 },
 timestamp: expect.any(Number),
 },
 {
 category: 'navigation',
 data: {
 from: '[object Object]',
 from: '/[object%20Object]',
 to: '/bar?a=1#fragment',
 },
 timestamp: expect.any(Number),
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/browser-integration-tests/suites/replay/multiple-pages/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -210,7 +210,7 @@ sentryTest(
 expect(replayEvent6).toEqual(
 getExpectedReplayEvent({
 segment_id: 6,
 urls: ['/spa'],
 urls: [`${TEST_HOST}/spa`],
 request: {
 url: `${TEST_HOST}/spa`,
 headers: {
Expand Down

2 changes: 1 addition & 1 deletion
...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,4 +9,4 @@ Sentry.init({
});

// Immediately navigate to a new page to abort the pageload
window.location.href = '#foo';
window.history.pushState({}, '', '/sub-page');

15 changes: 15 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,9 @@ sentryTest(
 expect(navigationTraceId).toBeDefined();
 expect(pageloadTraceId).not.toEqual(navigationTraceId);

 expect(pageloadRequest.transaction).toEqual('/index.html');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -54,5 +57,17 @@ sentryTest(
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page',
 });
 },
);

85 changes: 84 additions & 1 deletion
...ges/browser-integration-tests/suites/tracing/browserTracingIntegration/navigation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,12 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';
import {
 envelopeRequestParser,
 getFirstSentryEnvelopeRequest,
 shouldSkipTracingTest,
 waitForTransactionRequest,
} from '../../../../utils/helpers';

sentryTest('should create a navigation transaction on page navigation', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
Expand All@@ -31,6 +36,10 @@ sentryTest('should create a navigation transaction on page navigation', async ({
 expect(navigationTraceId).toBeDefined();
 expect(pageloadTraceId).not.toEqual(navigationTraceId);

 expect(pageloadRequest.transaction).toEqual('/index.html');
 // Fragment is not in transaction name
 expect(navigationRequest.transaction).toEqual('/index.html');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -45,6 +54,18 @@ sentryTest('should create a navigation transaction on page navigation', async ({
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html#foo',
 });

 const pageloadSpans = pageloadRequest.spans;
 const navigationSpans = navigationRequest.spans;
Expand All@@ -69,3 +90,65 @@ sentryTest('should create a navigation transaction on page navigation', async ({

 expect(pageloadSpanId).not.toEqual(navigationSpanId);
});

//
sentryTest('should handle pushState with full URL', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

 const url = await getLocalTestUrl({ testDir: __dirname });

 const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');
 const navigationRequestPromise = waitForTransactionRequest(
 page,
 event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page',
 );
 const navigationRequestPromise2 = waitForTransactionRequest(
 page,
 event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page-2',
 );

 await page.goto(url);
 await pageloadRequestPromise;

 await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page`);");

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.transaction).toEqual('/sub-page');

 expect(navigationRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page',
 });

 await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page-2`);");

 const navigationRequest2 = envelopeRequestParser(await navigationRequestPromise2);

 expect(navigationRequest2.transaction).toEqual('/sub-page-2');

 expect(navigationRequest2.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(navigationRequest2.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page-2',
 });
});

20 changes: 18 additions & 2 deletions
packages/browser-utils/src/instrument/history.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,15 @@ export function instrumentHistory(): void {
 return function (this: History, ...args: unknown[]): void {
 const url = args.length > 2 ? args[2] : undefined;
 if (url) {
 // coerce to string (this is what pushState does)
 const from = lastHref;
 const to = String(url);

 // Ensure the URL is absolute
 // this can be either a path, then it is relative to the current origin
 // or a full URL of the current origin - other origins are not allowed
 // See: https://developer.mozilla.org/en-US/docs/Web/API/History/pushState#url
 // coerce to string (this is what pushState does)
 const to = getAbsoluteUrl(String(url));

 // keep track of the current URL state, as we always receive only the updated state
 lastHref = to;

Expand All@@ -67,3 +73,13 @@ export function instrumentHistory(): void {
 fill(WINDOW.history, 'pushState', historyReplacementFunction);
 fill(WINDOW.history, 'replaceState', historyReplacementFunction);
}

function getAbsoluteUrl(urlOrPath: string): string {
 try {
 const url = new URL(urlOrPath, WINDOW.location.origin);
 return url.toString();
 } catch {
 // fallback, just do nothing
 return urlOrPath;
 }
}

22 changes: 22 additions & 0 deletions
packages/browser/src/helpers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 addExceptionTypeValue,
 addNonEnumerableProperty,
 captureException,
 getLocationHref,
 getOriginalFunction,
 GLOBAL_OBJ,
 markFunctionWrapped,
Expand DownExpand Up@@ -175,3 +176,24 @@ export function wrap<T extends WrappableFunction, NonFunction>(

 return sentryWrapped;
}

/**
 * Get HTTP request data from the current page.
 */
export function getHttpRequestData(): { url: string; headers: Record<string, string> } {
 // grab as much info as exists and add it to the event
 const url = getLocationHref();
 const { referrer } = WINDOW.document || {};
 const { userAgent } = WINDOW.navigator || {};

 const headers = {
 ...(referrer && { Referer: referrer }),
 ...(userAgent && { 'User-Agent': userAgent }),
 };
 const request = {
 url,
 headers,
 };

 return request;
}

20 changes: 7 additions & 13 deletions
packages/browser/src/integrations/httpcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { defineIntegration, getLocationHref } from '@sentry/core';
import { WINDOW } from '../helpers';
import { defineIntegration } from '@sentry/core';
import { getHttpRequestData, WINDOW } from '../helpers';

/**
 * Collects information about HTTP request headers and
Expand All@@ -14,23 +14,17 @@ export const httpContextIntegration = defineIntegration(() => {
 return;
 }

 // grab as much info as exists and add it to the event
 const url = event.request?.url || getLocationHref();
 const { referrer } = WINDOW.document || {};
 const { userAgent } = WINDOW.navigator || {};

 const reqData = getHttpRequestData();
 const headers = {
 ...reqData.headers,
 ...event.request?.headers,
 ...(referrer && { Referer: referrer }),
 ...(userAgent && { 'User-Agent': userAgent }),
 };
 const request = {

 event.request = {
 ...reqData,
 ...event.request,
 ...(url && { url }),
 headers,
 };

 event.request = request;
 },
 };
});

51 changes: 38 additions & 13 deletions
packages/browser/src/tracing/browserTracingIntegration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
 getLocationHref,
 GLOBAL_OBJ,
 logger,
 parseStringToURLObject,
 propagationContextFromHeaders,
 registerSpanErrorInstrumentation,
 SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON,
Expand All@@ -33,7 +34,7 @@ import {
 startTrackingWebVitals,
} from '@sentry-internal/browser-utils';
import { DEBUG_BUILD } from '../debug-build';
import { WINDOW } from '../helpers';
import { getHttpRequestData, WINDOW } from '../helpers';
import { registerBackgroundTabDetection } from './backgroundtab';
import { linkTraces } from './linkedTraces';
import { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from './request';
Expand DownExpand Up@@ -399,7 +400,14 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 maybeEndActiveSpan();

 getIsolationScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
 getCurrentScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });

 const scope = getCurrentScope();
 scope.setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
 // We reset this to ensure we do not have lingering incorrect data here
 // places that call this hook may set this where appropriate - else, the URL at span sending time is used
 scope.setSDKProcessingMetadata({
 normalizedRequest: undefined,
 });

 _createRouteSpan(client, {
 op: 'navigation',
Expand All@@ -417,7 +425,15 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 const baggage = traceOptions.baggage || getMetaContent('baggage');

 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 getCurrentScope().setPropagationContext(propagationContext);

 const scope = getCurrentScope();
 scope.setPropagationContext(propagationContext);

 // We store the normalized request data on the scope, so we get the request data at time of span creation
 // otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
 scope.setSDKProcessingMetadata({
 normalizedRequest: getHttpRequestData(),
 });

 _createRouteSpan(client, {
 op: 'pageload',
Expand DownExpand Up@@ -459,16 +475,25 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 return;
 }

 if (from !== to) {
 startingUrl = undefined;
 startBrowserTracingNavigationSpan(client, {
 name: WINDOW.location.pathname,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 },
 });
 }
 startingUrl = undefined;
@Lms24Lms24May 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

m/q: why did we remove the from !== to check?
@mydeamydeaMay 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

sorry, forgot to mention this - we actually have the same check in the history handler code, where we do not even trigger the handler in this case!
@Lms24Lms24May 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

nice, good catch!
 const parsed = parseStringToURLObject(to);
 startBrowserTracingNavigationSpan(client, {
 name: parsed?.pathname || WINDOW.location.pathname,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 },
 });

 // We store the normalized request data on the scope, so we get the request data at time of span creation
 // otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
 getCurrentScope().setSDKProcessingMetadata({
 normalizedRequest: {
 ...getHttpRequestData(),
 // Ensure to set this, so this matches the target route even if the URL has not yet been updated
 url: to,
 },
 });
 });
 }
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/tracing/sentrySpan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -336,6 +336,8 @@ export class SentrySpan implements Span {

 const { scope: capturedSpanScope, isolationScope: capturedSpanIsolationScope } = getCapturedScopesOnSpan(this);

 const normalizedRequest = capturedSpanScope?.getScopeData().sdkProcessingMetadata?.normalizedRequest;

 if (this._sampled !== true) {
 return undefined;
 }
Expand DownExpand Up@@ -374,6 +376,7 @@ export class SentrySpan implements Span {
 capturedSpanIsolationScope,
 dynamicSamplingContext: getDynamicSamplingContextFromSpan(this),
 },
 request: normalizedRequest,
 ...(source && {
 transaction_info: {
 source,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/types-hoist/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,9 @@ export interface HandlerDataConsole {
}

export interface HandlerDataHistory {
 /** The full URL of the previous page */
 from: string | undefined;
 /** The full URL of the new page */
 to: string;
}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(browser): Ensure pageload & navigation spans have correct data#16279

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

 Merged

mydea
merged 7 commits into

from

May 14, 2025
 Merged


fix(browser): Ensure pageload & navigation spans have correct data
#16279
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
8102ffc

fix(browser): Ensure pageload & navigation spans have correct data


mydea May 13, 2025
5cd662a

fix tests


mydea May 14, 2025
694883d

reset it afterwards


mydea May 14, 2025
cee11ea

fix by using `to` from history instrumentation


mydea May 14, 2025
dcd9311

fix tests & add test for absolute url handling


mydea May 14, 2025
d12215d

Revert "fix tests"


mydea May 14, 2025
6139d08

fix replay test


mydea May 14, 2025

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


4 changes: 2 additions & 2 deletions
...ages/browser-integration-tests/suites/integrations/Breadcrumbs/history/navigation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,14 +29,14 @@ sentryTest('should record history changes as navigation breadcrumbs', async ({ g
 category: 'navigation',
 data: {
 from: '/bar?a=1#fragment',
 to: '[object Object]',
 to: '/[object%20Object]',
 },
 timestamp: expect.any(Number),
 },
 {
 category: 'navigation',
 data: {
 from: '[object Object]',
 from: '/[object%20Object]',
 to: '/bar?a=1#fragment',
 },
 timestamp: expect.any(Number),
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/browser-integration-tests/suites/replay/multiple-pages/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -210,7 +210,7 @@ sentryTest(
 expect(replayEvent6).toEqual(
 getExpectedReplayEvent({
 segment_id: 6,
 urls: ['/spa'],
 urls: [`${TEST_HOST}/spa`],
 request: {
 url: `${TEST_HOST}/spa`,
 headers: {
Expand Down

2 changes: 1 addition & 1 deletion
...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,4 +9,4 @@ Sentry.init({
});

// Immediately navigate to a new page to abort the pageload
window.location.href = '#foo';
window.history.pushState({}, '', '/sub-page');

15 changes: 15 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,9 @@ sentryTest(
 expect(navigationTraceId).toBeDefined();
 expect(pageloadTraceId).not.toEqual(navigationTraceId);

 expect(pageloadRequest.transaction).toEqual('/index.html');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -54,5 +57,17 @@ sentryTest(
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page',
 });
 },
);

85 changes: 84 additions & 1 deletion
...ges/browser-integration-tests/suites/tracing/browserTracingIntegration/navigation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,12 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';
import {
 envelopeRequestParser,
 getFirstSentryEnvelopeRequest,
 shouldSkipTracingTest,
 waitForTransactionRequest,
} from '../../../../utils/helpers';

sentryTest('should create a navigation transaction on page navigation', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
Expand All@@ -31,6 +36,10 @@ sentryTest('should create a navigation transaction on page navigation', async ({
 expect(navigationTraceId).toBeDefined();
 expect(pageloadTraceId).not.toEqual(navigationTraceId);

 expect(pageloadRequest.transaction).toEqual('/index.html');
 // Fragment is not in transaction name
 expect(navigationRequest.transaction).toEqual('/index.html');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -45,6 +54,18 @@ sentryTest('should create a navigation transaction on page navigation', async ({
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html#foo',
 });

 const pageloadSpans = pageloadRequest.spans;
 const navigationSpans = navigationRequest.spans;
Expand All@@ -69,3 +90,65 @@ sentryTest('should create a navigation transaction on page navigation', async ({

 expect(pageloadSpanId).not.toEqual(navigationSpanId);
});

//
sentryTest('should handle pushState with full URL', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

 const url = await getLocalTestUrl({ testDir: __dirname });

 const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');
 const navigationRequestPromise = waitForTransactionRequest(
 page,
 event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page',
 );
 const navigationRequestPromise2 = waitForTransactionRequest(
 page,
 event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page-2',
 );

 await page.goto(url);
 await pageloadRequestPromise;

 await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page`);");

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.transaction).toEqual('/sub-page');

 expect(navigationRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page',
 });

 await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page-2`);");

 const navigationRequest2 = envelopeRequestParser(await navigationRequestPromise2);

 expect(navigationRequest2.transaction).toEqual('/sub-page-2');

 expect(navigationRequest2.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(navigationRequest2.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page-2',
 });
});

20 changes: 18 additions & 2 deletions
packages/browser-utils/src/instrument/history.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,15 @@ export function instrumentHistory(): void {
 return function (this: History, ...args: unknown[]): void {
 const url = args.length > 2 ? args[2] : undefined;
 if (url) {
 // coerce to string (this is what pushState does)
 const from = lastHref;
 const to = String(url);

 // Ensure the URL is absolute
 // this can be either a path, then it is relative to the current origin
 // or a full URL of the current origin - other origins are not allowed
 // See: https://developer.mozilla.org/en-US/docs/Web/API/History/pushState#url
 // coerce to string (this is what pushState does)
 const to = getAbsoluteUrl(String(url));

 // keep track of the current URL state, as we always receive only the updated state
 lastHref = to;

Expand All@@ -67,3 +73,13 @@ export function instrumentHistory(): void {
 fill(WINDOW.history, 'pushState', historyReplacementFunction);
 fill(WINDOW.history, 'replaceState', historyReplacementFunction);
}

function getAbsoluteUrl(urlOrPath: string): string {
 try {
 const url = new URL(urlOrPath, WINDOW.location.origin);
 return url.toString();
 } catch {
 // fallback, just do nothing
 return urlOrPath;
 }
}

22 changes: 22 additions & 0 deletions
packages/browser/src/helpers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 addExceptionTypeValue,
 addNonEnumerableProperty,
 captureException,
 getLocationHref,
 getOriginalFunction,
 GLOBAL_OBJ,
 markFunctionWrapped,
Expand DownExpand Up@@ -175,3 +176,24 @@ export function wrap<T extends WrappableFunction, NonFunction>(

 return sentryWrapped;
}

/**
 * Get HTTP request data from the current page.
 */
export function getHttpRequestData(): { url: string; headers: Record<string, string> } {
 // grab as much info as exists and add it to the event
 const url = getLocationHref();
 const { referrer } = WINDOW.document || {};
 const { userAgent } = WINDOW.navigator || {};

 const headers = {
 ...(referrer && { Referer: referrer }),
 ...(userAgent && { 'User-Agent': userAgent }),
 };
 const request = {
 url,
 headers,
 };

 return request;
}

20 changes: 7 additions & 13 deletions
packages/browser/src/integrations/httpcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { defineIntegration, getLocationHref } from '@sentry/core';
import { WINDOW } from '../helpers';
import { defineIntegration } from '@sentry/core';
import { getHttpRequestData, WINDOW } from '../helpers';

/**
 * Collects information about HTTP request headers and
Expand All@@ -14,23 +14,17 @@ export const httpContextIntegration = defineIntegration(() => {
 return;
 }

 // grab as much info as exists and add it to the event
 const url = event.request?.url || getLocationHref();
 const { referrer } = WINDOW.document || {};
 const { userAgent } = WINDOW.navigator || {};

 const reqData = getHttpRequestData();
 const headers = {
 ...reqData.headers,
 ...event.request?.headers,
 ...(referrer && { Referer: referrer }),
 ...(userAgent && { 'User-Agent': userAgent }),
 };
 const request = {

 event.request = {
 ...reqData,
 ...event.request,
 ...(url && { url }),
 headers,
 };

 event.request = request;
 },
 };
});

51 changes: 38 additions & 13 deletions
packages/browser/src/tracing/browserTracingIntegration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
 getLocationHref,
 GLOBAL_OBJ,
 logger,
 parseStringToURLObject,
 propagationContextFromHeaders,
 registerSpanErrorInstrumentation,
 SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON,
Expand All@@ -33,7 +34,7 @@ import {
 startTrackingWebVitals,
} from '@sentry-internal/browser-utils';
import { DEBUG_BUILD } from '../debug-build';
import { WINDOW } from '../helpers';
import { getHttpRequestData, WINDOW } from '../helpers';
import { registerBackgroundTabDetection } from './backgroundtab';
import { linkTraces } from './linkedTraces';
import { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from './request';
Expand DownExpand Up@@ -399,7 +400,14 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 maybeEndActiveSpan();

 getIsolationScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
 getCurrentScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });

 const scope = getCurrentScope();
 scope.setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
 // We reset this to ensure we do not have lingering incorrect data here
 // places that call this hook may set this where appropriate - else, the URL at span sending time is used
 scope.setSDKProcessingMetadata({
 normalizedRequest: undefined,
 });

 _createRouteSpan(client, {
 op: 'navigation',
Expand All@@ -417,7 +425,15 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 const baggage = traceOptions.baggage || getMetaContent('baggage');

 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 getCurrentScope().setPropagationContext(propagationContext);

 const scope = getCurrentScope();
 scope.setPropagationContext(propagationContext);

 // We store the normalized request data on the scope, so we get the request data at time of span creation
 // otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
 scope.setSDKProcessingMetadata({
 normalizedRequest: getHttpRequestData(),
 });

 _createRouteSpan(client, {
 op: 'pageload',
Expand DownExpand Up@@ -459,16 +475,25 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 return;
 }

 if (from !== to) {
 startingUrl = undefined;
 startBrowserTracingNavigationSpan(client, {
 name: WINDOW.location.pathname,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 },
 });
 }
 startingUrl = undefined;
@Lms24Lms24May 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

m/q: why did we remove the from !== to check?
@mydeamydeaMay 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

sorry, forgot to mention this - we actually have the same check in the history handler code, where we do not even trigger the handler in this case!
@Lms24Lms24May 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

nice, good catch!
 const parsed = parseStringToURLObject(to);
 startBrowserTracingNavigationSpan(client, {
 name: parsed?.pathname || WINDOW.location.pathname,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 },
 });

 // We store the normalized request data on the scope, so we get the request data at time of span creation
 // otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
 getCurrentScope().setSDKProcessingMetadata({
 normalizedRequest: {
 ...getHttpRequestData(),
 // Ensure to set this, so this matches the target route even if the URL has not yet been updated
 url: to,
 },
 });
 });
 }
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/tracing/sentrySpan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -336,6 +336,8 @@ export class SentrySpan implements Span {

 const { scope: capturedSpanScope, isolationScope: capturedSpanIsolationScope } = getCapturedScopesOnSpan(this);

 const normalizedRequest = capturedSpanScope?.getScopeData().sdkProcessingMetadata?.normalizedRequest;

 if (this._sampled !== true) {
 return undefined;
 }
Expand DownExpand Up@@ -374,6 +376,7 @@ export class SentrySpan implements Span {
 capturedSpanIsolationScope,
 dynamicSamplingContext: getDynamicSamplingContextFromSpan(this),
 },
 request: normalizedRequest,
 ...(source && {
 transaction_info: {
 source,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/types-hoist/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,9 @@ export interface HandlerDataConsole {
}

export interface HandlerDataHistory {
 /** The full URL of the previous page */
 from: string | undefined;
 /** The full URL of the new page */
 to: string;
}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(browser): Ensure pageload & navigation spans have correct data#16279

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

 Merged

mydea
merged 7 commits into

from

May 14, 2025
 Merged


fix(browser): Ensure pageload & navigation spans have correct data
#16279
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
8102ffc

fix(browser): Ensure pageload & navigation spans have correct data


mydea May 13, 2025
5cd662a

fix tests


mydea May 14, 2025
694883d

reset it afterwards


mydea May 14, 2025
cee11ea

fix by using `to` from history instrumentation


mydea May 14, 2025
dcd9311

fix tests & add test for absolute url handling


mydea May 14, 2025
d12215d

Revert "fix tests"


mydea May 14, 2025
6139d08

fix replay test


mydea May 14, 2025

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


4 changes: 2 additions & 2 deletions
...ages/browser-integration-tests/suites/integrations/Breadcrumbs/history/navigation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,14 +29,14 @@ sentryTest('should record history changes as navigation breadcrumbs', async ({ g
 category: 'navigation',
 data: {
 from: '/bar?a=1#fragment',
 to: '[object Object]',
 to: '/[object%20Object]',
 },
 timestamp: expect.any(Number),
 },
 {
 category: 'navigation',
 data: {
 from: '[object Object]',
 from: '/[object%20Object]',
 to: '/bar?a=1#fragment',
 },
 timestamp: expect.any(Number),
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/browser-integration-tests/suites/replay/multiple-pages/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -210,7 +210,7 @@ sentryTest(
 expect(replayEvent6).toEqual(
 getExpectedReplayEvent({
 segment_id: 6,
 urls: ['/spa'],
 urls: [`${TEST_HOST}/spa`],
 request: {
 url: `${TEST_HOST}/spa`,
 headers: {
Expand Down

2 changes: 1 addition & 1 deletion
...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,4 +9,4 @@ Sentry.init({
});

// Immediately navigate to a new page to abort the pageload
window.location.href = '#foo';
window.history.pushState({}, '', '/sub-page');

15 changes: 15 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,9 @@ sentryTest(
 expect(navigationTraceId).toBeDefined();
 expect(pageloadTraceId).not.toEqual(navigationTraceId);

 expect(pageloadRequest.transaction).toEqual('/index.html');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -54,5 +57,17 @@ sentryTest(
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page',
 });
 },
);

85 changes: 84 additions & 1 deletion
...ges/browser-integration-tests/suites/tracing/browserTracingIntegration/navigation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,12 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';
import {
 envelopeRequestParser,
 getFirstSentryEnvelopeRequest,
 shouldSkipTracingTest,
 waitForTransactionRequest,
} from '../../../../utils/helpers';

sentryTest('should create a navigation transaction on page navigation', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
Expand All@@ -31,6 +36,10 @@ sentryTest('should create a navigation transaction on page navigation', async ({
 expect(navigationTraceId).toBeDefined();
 expect(pageloadTraceId).not.toEqual(navigationTraceId);

 expect(pageloadRequest.transaction).toEqual('/index.html');
 // Fragment is not in transaction name
 expect(navigationRequest.transaction).toEqual('/index.html');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -45,6 +54,18 @@ sentryTest('should create a navigation transaction on page navigation', async ({
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html#foo',
 });

 const pageloadSpans = pageloadRequest.spans;
 const navigationSpans = navigationRequest.spans;
Expand All@@ -69,3 +90,65 @@ sentryTest('should create a navigation transaction on page navigation', async ({

 expect(pageloadSpanId).not.toEqual(navigationSpanId);
});

//
sentryTest('should handle pushState with full URL', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

 const url = await getLocalTestUrl({ testDir: __dirname });

 const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');
 const navigationRequestPromise = waitForTransactionRequest(
 page,
 event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page',
 );
 const navigationRequestPromise2 = waitForTransactionRequest(
 page,
 event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page-2',
 );

 await page.goto(url);
 await pageloadRequestPromise;

 await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page`);");

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.transaction).toEqual('/sub-page');

 expect(navigationRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page',
 });

 await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page-2`);");

 const navigationRequest2 = envelopeRequestParser(await navigationRequestPromise2);

 expect(navigationRequest2.transaction).toEqual('/sub-page-2');

 expect(navigationRequest2.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(navigationRequest2.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page-2',
 });
});

20 changes: 18 additions & 2 deletions
packages/browser-utils/src/instrument/history.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,15 @@ export function instrumentHistory(): void {
 return function (this: History, ...args: unknown[]): void {
 const url = args.length > 2 ? args[2] : undefined;
 if (url) {
 // coerce to string (this is what pushState does)
 const from = lastHref;
 const to = String(url);

 // Ensure the URL is absolute
 // this can be either a path, then it is relative to the current origin
 // or a full URL of the current origin - other origins are not allowed
 // See: https://developer.mozilla.org/en-US/docs/Web/API/History/pushState#url
 // coerce to string (this is what pushState does)
 const to = getAbsoluteUrl(String(url));

 // keep track of the current URL state, as we always receive only the updated state
 lastHref = to;

Expand All@@ -67,3 +73,13 @@ export function instrumentHistory(): void {
 fill(WINDOW.history, 'pushState', historyReplacementFunction);
 fill(WINDOW.history, 'replaceState', historyReplacementFunction);
}

function getAbsoluteUrl(urlOrPath: string): string {
 try {
 const url = new URL(urlOrPath, WINDOW.location.origin);
 return url.toString();
 } catch {
 // fallback, just do nothing
 return urlOrPath;
 }
}

22 changes: 22 additions & 0 deletions
packages/browser/src/helpers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 addExceptionTypeValue,
 addNonEnumerableProperty,
 captureException,
 getLocationHref,
 getOriginalFunction,
 GLOBAL_OBJ,
 markFunctionWrapped,
Expand DownExpand Up@@ -175,3 +176,24 @@ export function wrap<T extends WrappableFunction, NonFunction>(

 return sentryWrapped;
}

/**
 * Get HTTP request data from the current page.
 */
export function getHttpRequestData(): { url: string; headers: Record<string, string> } {
 // grab as much info as exists and add it to the event
 const url = getLocationHref();
 const { referrer } = WINDOW.document || {};
 const { userAgent } = WINDOW.navigator || {};

 const headers = {
 ...(referrer && { Referer: referrer }),
 ...(userAgent && { 'User-Agent': userAgent }),
 };
 const request = {
 url,
 headers,
 };

 return request;
}

20 changes: 7 additions & 13 deletions
packages/browser/src/integrations/httpcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { defineIntegration, getLocationHref } from '@sentry/core';
import { WINDOW } from '../helpers';
import { defineIntegration } from '@sentry/core';
import { getHttpRequestData, WINDOW } from '../helpers';

/**
 * Collects information about HTTP request headers and
Expand All@@ -14,23 +14,17 @@ export const httpContextIntegration = defineIntegration(() => {
 return;
 }

 // grab as much info as exists and add it to the event
 const url = event.request?.url || getLocationHref();
 const { referrer } = WINDOW.document || {};
 const { userAgent } = WINDOW.navigator || {};

 const reqData = getHttpRequestData();
 const headers = {
 ...reqData.headers,
 ...event.request?.headers,
 ...(referrer && { Referer: referrer }),
 ...(userAgent && { 'User-Agent': userAgent }),
 };
 const request = {

 event.request = {
 ...reqData,
 ...event.request,
 ...(url && { url }),
 headers,
 };

 event.request = request;
 },
 };
});

51 changes: 38 additions & 13 deletions
packages/browser/src/tracing/browserTracingIntegration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
 getLocationHref,
 GLOBAL_OBJ,
 logger,
 parseStringToURLObject,
 propagationContextFromHeaders,
 registerSpanErrorInstrumentation,
 SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON,
Expand All@@ -33,7 +34,7 @@ import {
 startTrackingWebVitals,
} from '@sentry-internal/browser-utils';
import { DEBUG_BUILD } from '../debug-build';
import { WINDOW } from '../helpers';
import { getHttpRequestData, WINDOW } from '../helpers';
import { registerBackgroundTabDetection } from './backgroundtab';
import { linkTraces } from './linkedTraces';
import { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from './request';
Expand DownExpand Up@@ -399,7 +400,14 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 maybeEndActiveSpan();

 getIsolationScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
 getCurrentScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });

 const scope = getCurrentScope();
 scope.setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
 // We reset this to ensure we do not have lingering incorrect data here
 // places that call this hook may set this where appropriate - else, the URL at span sending time is used
 scope.setSDKProcessingMetadata({
 normalizedRequest: undefined,
 });

 _createRouteSpan(client, {
 op: 'navigation',
Expand All@@ -417,7 +425,15 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 const baggage = traceOptions.baggage || getMetaContent('baggage');

 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 getCurrentScope().setPropagationContext(propagationContext);

 const scope = getCurrentScope();
 scope.setPropagationContext(propagationContext);

 // We store the normalized request data on the scope, so we get the request data at time of span creation
 // otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
 scope.setSDKProcessingMetadata({
 normalizedRequest: getHttpRequestData(),
 });

 _createRouteSpan(client, {
 op: 'pageload',
Expand DownExpand Up@@ -459,16 +475,25 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 return;
 }

 if (from !== to) {
 startingUrl = undefined;
 startBrowserTracingNavigationSpan(client, {
 name: WINDOW.location.pathname,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 },
 });
 }
 startingUrl = undefined;
@Lms24Lms24May 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

m/q: why did we remove the from !== to check?
@mydeamydeaMay 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

sorry, forgot to mention this - we actually have the same check in the history handler code, where we do not even trigger the handler in this case!
@Lms24Lms24May 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

nice, good catch!
 const parsed = parseStringToURLObject(to);
 startBrowserTracingNavigationSpan(client, {
 name: parsed?.pathname || WINDOW.location.pathname,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 },
 });

 // We store the normalized request data on the scope, so we get the request data at time of span creation
 // otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
 getCurrentScope().setSDKProcessingMetadata({
 normalizedRequest: {
 ...getHttpRequestData(),
 // Ensure to set this, so this matches the target route even if the URL has not yet been updated
 url: to,
 },
 });
 });
 }
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/tracing/sentrySpan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -336,6 +336,8 @@ export class SentrySpan implements Span {

 const { scope: capturedSpanScope, isolationScope: capturedSpanIsolationScope } = getCapturedScopesOnSpan(this);

 const normalizedRequest = capturedSpanScope?.getScopeData().sdkProcessingMetadata?.normalizedRequest;

 if (this._sampled !== true) {
 return undefined;
 }
Expand DownExpand Up@@ -374,6 +376,7 @@ export class SentrySpan implements Span {
 capturedSpanIsolationScope,
 dynamicSamplingContext: getDynamicSamplingContextFromSpan(this),
 },
 request: normalizedRequest,
 ...(source && {
 transaction_info: {
 source,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/types-hoist/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,9 @@ export interface HandlerDataConsole {
}

export interface HandlerDataHistory {
 /** The full URL of the previous page */
 from: string | undefined;
 /** The full URL of the new page */
 to: string;
}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix(browser): Ensure pageload & navigation spans have correct data#16279

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

 Merged

mydea
merged 7 commits into

from

May 14, 2025
 Merged


fix(browser): Ensure pageload & navigation spans have correct data
#16279
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
8102ffc

fix(browser): Ensure pageload & navigation spans have correct data


mydea May 13, 2025
5cd662a

fix tests


mydea May 14, 2025
694883d

reset it afterwards


mydea May 14, 2025
cee11ea

fix by using `to` from history instrumentation


mydea May 14, 2025
dcd9311

fix tests & add test for absolute url handling


mydea May 14, 2025
d12215d

Revert "fix tests"


mydea May 14, 2025
6139d08

fix replay test


mydea May 14, 2025

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


4 changes: 2 additions & 2 deletions
...ages/browser-integration-tests/suites/integrations/Breadcrumbs/history/navigation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,14 +29,14 @@ sentryTest('should record history changes as navigation breadcrumbs', async ({ g
 category: 'navigation',
 data: {
 from: '/bar?a=1#fragment',
 to: '[object Object]',
 to: '/[object%20Object]',
 },
 timestamp: expect.any(Number),
 },
 {
 category: 'navigation',
 data: {
 from: '[object Object]',
 from: '/[object%20Object]',
 to: '/bar?a=1#fragment',
 },
 timestamp: expect.any(Number),
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/browser-integration-tests/suites/replay/multiple-pages/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -210,7 +210,7 @@ sentryTest(
 expect(replayEvent6).toEqual(
 getExpectedReplayEvent({
 segment_id: 6,
 urls: ['/spa'],
 urls: [`${TEST_HOST}/spa`],
 request: {
 url: `${TEST_HOST}/spa`,
 headers: {
Expand Down

2 changes: 1 addition & 1 deletion
...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,4 +9,4 @@ Sentry.init({
});

// Immediately navigate to a new page to abort the pageload
window.location.href = '#foo';
window.history.pushState({}, '', '/sub-page');

15 changes: 15 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,9 @@ sentryTest(
 expect(navigationTraceId).toBeDefined();
 expect(pageloadTraceId).not.toEqual(navigationTraceId);

 expect(pageloadRequest.transaction).toEqual('/index.html');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -54,5 +57,17 @@ sentryTest(
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page',
 });
 },
);

85 changes: 84 additions & 1 deletion
...ges/browser-integration-tests/suites/tracing/browserTracingIntegration/navigation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,12 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';
import {
 envelopeRequestParser,
 getFirstSentryEnvelopeRequest,
 shouldSkipTracingTest,
 waitForTransactionRequest,
} from '../../../../utils/helpers';

sentryTest('should create a navigation transaction on page navigation', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
Expand All@@ -31,6 +36,10 @@ sentryTest('should create a navigation transaction on page navigation', async ({
 expect(navigationTraceId).toBeDefined();
 expect(pageloadTraceId).not.toEqual(navigationTraceId);

 expect(pageloadRequest.transaction).toEqual('/index.html');
 // Fragment is not in transaction name
 expect(navigationRequest.transaction).toEqual('/index.html');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -45,6 +54,18 @@ sentryTest('should create a navigation transaction on page navigation', async ({
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html#foo',
 });

 const pageloadSpans = pageloadRequest.spans;
 const navigationSpans = navigationRequest.spans;
Expand All@@ -69,3 +90,65 @@ sentryTest('should create a navigation transaction on page navigation', async ({

 expect(pageloadSpanId).not.toEqual(navigationSpanId);
});

//
sentryTest('should handle pushState with full URL', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

 const url = await getLocalTestUrl({ testDir: __dirname });

 const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');
 const navigationRequestPromise = waitForTransactionRequest(
 page,
 event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page',
 );
 const navigationRequestPromise2 = waitForTransactionRequest(
 page,
 event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page-2',
 );

 await page.goto(url);
 await pageloadRequestPromise;

 await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page`);");

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.transaction).toEqual('/sub-page');

 expect(navigationRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page',
 });

 await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page-2`);");

 const navigationRequest2 = envelopeRequestParser(await navigationRequestPromise2);

 expect(navigationRequest2.transaction).toEqual('/sub-page-2');

 expect(navigationRequest2.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(navigationRequest2.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page-2',
 });
});

20 changes: 18 additions & 2 deletions
packages/browser-utils/src/instrument/history.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,15 @@ export function instrumentHistory(): void {
 return function (this: History, ...args: unknown[]): void {
 const url = args.length > 2 ? args[2] : undefined;
 if (url) {
 // coerce to string (this is what pushState does)
 const from = lastHref;
 const to = String(url);

 // Ensure the URL is absolute
 // this can be either a path, then it is relative to the current origin
 // or a full URL of the current origin - other origins are not allowed
 // See: https://developer.mozilla.org/en-US/docs/Web/API/History/pushState#url
 // coerce to string (this is what pushState does)
 const to = getAbsoluteUrl(String(url));

 // keep track of the current URL state, as we always receive only the updated state
 lastHref = to;

Expand All@@ -67,3 +73,13 @@ export function instrumentHistory(): void {
 fill(WINDOW.history, 'pushState', historyReplacementFunction);
 fill(WINDOW.history, 'replaceState', historyReplacementFunction);
}

function getAbsoluteUrl(urlOrPath: string): string {
 try {
 const url = new URL(urlOrPath, WINDOW.location.origin);
 return url.toString();
 } catch {
 // fallback, just do nothing
 return urlOrPath;
 }
}

22 changes: 22 additions & 0 deletions
packages/browser/src/helpers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 addExceptionTypeValue,
 addNonEnumerableProperty,
 captureException,
 getLocationHref,
 getOriginalFunction,
 GLOBAL_OBJ,
 markFunctionWrapped,
Expand DownExpand Up@@ -175,3 +176,24 @@ export function wrap<T extends WrappableFunction, NonFunction>(

 return sentryWrapped;
}

/**
 * Get HTTP request data from the current page.
 */
export function getHttpRequestData(): { url: string; headers: Record<string, string> } {
 // grab as much info as exists and add it to the event
 const url = getLocationHref();
 const { referrer } = WINDOW.document || {};
 const { userAgent } = WINDOW.navigator || {};

 const headers = {
 ...(referrer && { Referer: referrer }),
 ...(userAgent && { 'User-Agent': userAgent }),
 };
 const request = {
 url,
 headers,
 };

 return request;
}

20 changes: 7 additions & 13 deletions
packages/browser/src/integrations/httpcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { defineIntegration, getLocationHref } from '@sentry/core';
import { WINDOW } from '../helpers';
import { defineIntegration } from '@sentry/core';
import { getHttpRequestData, WINDOW } from '../helpers';

/**
 * Collects information about HTTP request headers and
Expand All@@ -14,23 +14,17 @@ export const httpContextIntegration = defineIntegration(() => {
 return;
 }

 // grab as much info as exists and add it to the event
 const url = event.request?.url || getLocationHref();
 const { referrer } = WINDOW.document || {};
 const { userAgent } = WINDOW.navigator || {};

 const reqData = getHttpRequestData();
 const headers = {
 ...reqData.headers,
 ...event.request?.headers,
 ...(referrer && { Referer: referrer }),
 ...(userAgent && { 'User-Agent': userAgent }),
 };
 const request = {

 event.request = {
 ...reqData,
 ...event.request,
 ...(url && { url }),
 headers,
 };

 event.request = request;
 },
 };
});

51 changes: 38 additions & 13 deletions
packages/browser/src/tracing/browserTracingIntegration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
 getLocationHref,
 GLOBAL_OBJ,
 logger,
 parseStringToURLObject,
 propagationContextFromHeaders,
 registerSpanErrorInstrumentation,
 SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON,
Expand All@@ -33,7 +34,7 @@ import {
 startTrackingWebVitals,
} from '@sentry-internal/browser-utils';
import { DEBUG_BUILD } from '../debug-build';
import { WINDOW } from '../helpers';
import { getHttpRequestData, WINDOW } from '../helpers';
import { registerBackgroundTabDetection } from './backgroundtab';
import { linkTraces } from './linkedTraces';
import { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from './request';
Expand DownExpand Up@@ -399,7 +400,14 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 maybeEndActiveSpan();

 getIsolationScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
 getCurrentScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });

 const scope = getCurrentScope();
 scope.setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
 // We reset this to ensure we do not have lingering incorrect data here
 // places that call this hook may set this where appropriate - else, the URL at span sending time is used
 scope.setSDKProcessingMetadata({
 normalizedRequest: undefined,
 });

 _createRouteSpan(client, {
 op: 'navigation',
Expand All@@ -417,7 +425,15 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 const baggage = traceOptions.baggage || getMetaContent('baggage');

 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 getCurrentScope().setPropagationContext(propagationContext);

 const scope = getCurrentScope();
 scope.setPropagationContext(propagationContext);

 // We store the normalized request data on the scope, so we get the request data at time of span creation
 // otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
 scope.setSDKProcessingMetadata({
 normalizedRequest: getHttpRequestData(),
 });

 _createRouteSpan(client, {
 op: 'pageload',
Expand DownExpand Up@@ -459,16 +475,25 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 return;
 }

 if (from !== to) {
 startingUrl = undefined;
 startBrowserTracingNavigationSpan(client, {
 name: WINDOW.location.pathname,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 },
 });
 }
 startingUrl = undefined;
@Lms24Lms24May 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

m/q: why did we remove the from !== to check?
@mydeamydeaMay 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

sorry, forgot to mention this - we actually have the same check in the history handler code, where we do not even trigger the handler in this case!
@Lms24Lms24May 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

nice, good catch!
 const parsed = parseStringToURLObject(to);
 startBrowserTracingNavigationSpan(client, {
 name: parsed?.pathname || WINDOW.location.pathname,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 },
 });

 // We store the normalized request data on the scope, so we get the request data at time of span creation
 // otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
 getCurrentScope().setSDKProcessingMetadata({
 normalizedRequest: {
 ...getHttpRequestData(),
 // Ensure to set this, so this matches the target route even if the URL has not yet been updated
 url: to,
 },
 });
 });
 }
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/tracing/sentrySpan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -336,6 +336,8 @@ export class SentrySpan implements Span {

 const { scope: capturedSpanScope, isolationScope: capturedSpanIsolationScope } = getCapturedScopesOnSpan(this);

 const normalizedRequest = capturedSpanScope?.getScopeData().sdkProcessingMetadata?.normalizedRequest;

 if (this._sampled !== true) {
 return undefined;
 }
Expand DownExpand Up@@ -374,6 +376,7 @@ export class SentrySpan implements Span {
 capturedSpanIsolationScope,
 dynamicSamplingContext: getDynamicSamplingContextFromSpan(this),
 },
 request: normalizedRequest,
 ...(source && {
 transaction_info: {
 source,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/types-hoist/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,9 @@ export interface HandlerDataConsole {
}

export interface HandlerDataHistory {
 /** The full URL of the previous page */
 from: string | undefined;
 /** The full URL of the new page */
 to: string;
}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(browser): Ensure pageload & navigation spans have correct data#16279

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

 Merged

mydea
merged 7 commits into

from

May 14, 2025
 Merged


fix(browser): Ensure pageload & navigation spans have correct data
#16279
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
8102ffc

fix(browser): Ensure pageload & navigation spans have correct data


mydea May 13, 2025
5cd662a

fix tests


mydea May 14, 2025
694883d

reset it afterwards


mydea May 14, 2025
cee11ea

fix by using `to` from history instrumentation


mydea May 14, 2025
dcd9311

fix tests & add test for absolute url handling


mydea May 14, 2025
d12215d

Revert "fix tests"


mydea May 14, 2025
6139d08

fix replay test


mydea May 14, 2025

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


4 changes: 2 additions & 2 deletions
...ages/browser-integration-tests/suites/integrations/Breadcrumbs/history/navigation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,14 +29,14 @@ sentryTest('should record history changes as navigation breadcrumbs', async ({ g
 category: 'navigation',
 data: {
 from: '/bar?a=1#fragment',
 to: '[object Object]',
 to: '/[object%20Object]',
 },
 timestamp: expect.any(Number),
 },
 {
 category: 'navigation',
 data: {
 from: '[object Object]',
 from: '/[object%20Object]',
 to: '/bar?a=1#fragment',
 },
 timestamp: expect.any(Number),
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/browser-integration-tests/suites/replay/multiple-pages/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -210,7 +210,7 @@ sentryTest(
 expect(replayEvent6).toEqual(
 getExpectedReplayEvent({
 segment_id: 6,
 urls: ['/spa'],
 urls: [`${TEST_HOST}/spa`],
 request: {
 url: `${TEST_HOST}/spa`,
 headers: {
Expand Down

2 changes: 1 addition & 1 deletion
...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,4 +9,4 @@ Sentry.init({
});

// Immediately navigate to a new page to abort the pageload
window.location.href = '#foo';
window.history.pushState({}, '', '/sub-page');

15 changes: 15 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,9 @@ sentryTest(
 expect(navigationTraceId).toBeDefined();
 expect(pageloadTraceId).not.toEqual(navigationTraceId);

 expect(pageloadRequest.transaction).toEqual('/index.html');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -54,5 +57,17 @@ sentryTest(
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page',
 });
 },
);

85 changes: 84 additions & 1 deletion
...ges/browser-integration-tests/suites/tracing/browserTracingIntegration/navigation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,12 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';
import {
 envelopeRequestParser,
 getFirstSentryEnvelopeRequest,
 shouldSkipTracingTest,
 waitForTransactionRequest,
} from '../../../../utils/helpers';

sentryTest('should create a navigation transaction on page navigation', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
Expand All@@ -31,6 +36,10 @@ sentryTest('should create a navigation transaction on page navigation', async ({
 expect(navigationTraceId).toBeDefined();
 expect(pageloadTraceId).not.toEqual(navigationTraceId);

 expect(pageloadRequest.transaction).toEqual('/index.html');
 // Fragment is not in transaction name
 expect(navigationRequest.transaction).toEqual('/index.html');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -45,6 +54,18 @@ sentryTest('should create a navigation transaction on page navigation', async ({
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html#foo',
 });

 const pageloadSpans = pageloadRequest.spans;
 const navigationSpans = navigationRequest.spans;
Expand All@@ -69,3 +90,65 @@ sentryTest('should create a navigation transaction on page navigation', async ({

 expect(pageloadSpanId).not.toEqual(navigationSpanId);
});

//
sentryTest('should handle pushState with full URL', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

 const url = await getLocalTestUrl({ testDir: __dirname });

 const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');
 const navigationRequestPromise = waitForTransactionRequest(
 page,
 event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page',
 );
 const navigationRequestPromise2 = waitForTransactionRequest(
 page,
 event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page-2',
 );

 await page.goto(url);
 await pageloadRequestPromise;

 await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page`);");

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.transaction).toEqual('/sub-page');

 expect(navigationRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page',
 });

 await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page-2`);");

 const navigationRequest2 = envelopeRequestParser(await navigationRequestPromise2);

 expect(navigationRequest2.transaction).toEqual('/sub-page-2');

 expect(navigationRequest2.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(navigationRequest2.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page-2',
 });
});

20 changes: 18 additions & 2 deletions
packages/browser-utils/src/instrument/history.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,15 @@ export function instrumentHistory(): void {
 return function (this: History, ...args: unknown[]): void {
 const url = args.length > 2 ? args[2] : undefined;
 if (url) {
 // coerce to string (this is what pushState does)
 const from = lastHref;
 const to = String(url);

 // Ensure the URL is absolute
 // this can be either a path, then it is relative to the current origin
 // or a full URL of the current origin - other origins are not allowed
 // See: https://developer.mozilla.org/en-US/docs/Web/API/History/pushState#url
 // coerce to string (this is what pushState does)
 const to = getAbsoluteUrl(String(url));

 // keep track of the current URL state, as we always receive only the updated state
 lastHref = to;

Expand All@@ -67,3 +73,13 @@ export function instrumentHistory(): void {
 fill(WINDOW.history, 'pushState', historyReplacementFunction);
 fill(WINDOW.history, 'replaceState', historyReplacementFunction);
}

function getAbsoluteUrl(urlOrPath: string): string {
 try {
 const url = new URL(urlOrPath, WINDOW.location.origin);
 return url.toString();
 } catch {
 // fallback, just do nothing
 return urlOrPath;
 }
}

22 changes: 22 additions & 0 deletions
packages/browser/src/helpers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 addExceptionTypeValue,
 addNonEnumerableProperty,
 captureException,
 getLocationHref,
 getOriginalFunction,
 GLOBAL_OBJ,
 markFunctionWrapped,
Expand DownExpand Up@@ -175,3 +176,24 @@ export function wrap<T extends WrappableFunction, NonFunction>(

 return sentryWrapped;
}

/**
 * Get HTTP request data from the current page.
 */
export function getHttpRequestData(): { url: string; headers: Record<string, string> } {
 // grab as much info as exists and add it to the event
 const url = getLocationHref();
 const { referrer } = WINDOW.document || {};
 const { userAgent } = WINDOW.navigator || {};

 const headers = {
 ...(referrer && { Referer: referrer }),
 ...(userAgent && { 'User-Agent': userAgent }),
 };
 const request = {
 url,
 headers,
 };

 return request;
}

20 changes: 7 additions & 13 deletions
packages/browser/src/integrations/httpcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { defineIntegration, getLocationHref } from '@sentry/core';
import { WINDOW } from '../helpers';
import { defineIntegration } from '@sentry/core';
import { getHttpRequestData, WINDOW } from '../helpers';

/**
 * Collects information about HTTP request headers and
Expand All@@ -14,23 +14,17 @@ export const httpContextIntegration = defineIntegration(() => {
 return;
 }

 // grab as much info as exists and add it to the event
 const url = event.request?.url || getLocationHref();
 const { referrer } = WINDOW.document || {};
 const { userAgent } = WINDOW.navigator || {};

 const reqData = getHttpRequestData();
 const headers = {
 ...reqData.headers,
 ...event.request?.headers,
 ...(referrer && { Referer: referrer }),
 ...(userAgent && { 'User-Agent': userAgent }),
 };
 const request = {

 event.request = {
 ...reqData,
 ...event.request,
 ...(url && { url }),
 headers,
 };

 event.request = request;
 },
 };
});

51 changes: 38 additions & 13 deletions
packages/browser/src/tracing/browserTracingIntegration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
 getLocationHref,
 GLOBAL_OBJ,
 logger,
 parseStringToURLObject,
 propagationContextFromHeaders,
 registerSpanErrorInstrumentation,
 SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON,
Expand All@@ -33,7 +34,7 @@ import {
 startTrackingWebVitals,
} from '@sentry-internal/browser-utils';
import { DEBUG_BUILD } from '../debug-build';
import { WINDOW } from '../helpers';
import { getHttpRequestData, WINDOW } from '../helpers';
import { registerBackgroundTabDetection } from './backgroundtab';
import { linkTraces } from './linkedTraces';
import { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from './request';
Expand DownExpand Up@@ -399,7 +400,14 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 maybeEndActiveSpan();

 getIsolationScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
 getCurrentScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });

 const scope = getCurrentScope();
 scope.setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
 // We reset this to ensure we do not have lingering incorrect data here
 // places that call this hook may set this where appropriate - else, the URL at span sending time is used
 scope.setSDKProcessingMetadata({
 normalizedRequest: undefined,
 });

 _createRouteSpan(client, {
 op: 'navigation',
Expand All@@ -417,7 +425,15 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 const baggage = traceOptions.baggage || getMetaContent('baggage');

 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 getCurrentScope().setPropagationContext(propagationContext);

 const scope = getCurrentScope();
 scope.setPropagationContext(propagationContext);

 // We store the normalized request data on the scope, so we get the request data at time of span creation
 // otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
 scope.setSDKProcessingMetadata({
 normalizedRequest: getHttpRequestData(),
 });

 _createRouteSpan(client, {
 op: 'pageload',
Expand DownExpand Up@@ -459,16 +475,25 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 return;
 }

 if (from !== to) {
 startingUrl = undefined;
 startBrowserTracingNavigationSpan(client, {
 name: WINDOW.location.pathname,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 },
 });
 }
 startingUrl = undefined;
@Lms24Lms24May 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

m/q: why did we remove the from !== to check?
@mydeamydeaMay 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

sorry, forgot to mention this - we actually have the same check in the history handler code, where we do not even trigger the handler in this case!
@Lms24Lms24May 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

nice, good catch!
 const parsed = parseStringToURLObject(to);
 startBrowserTracingNavigationSpan(client, {
 name: parsed?.pathname || WINDOW.location.pathname,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 },
 });

 // We store the normalized request data on the scope, so we get the request data at time of span creation
 // otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
 getCurrentScope().setSDKProcessingMetadata({
 normalizedRequest: {
 ...getHttpRequestData(),
 // Ensure to set this, so this matches the target route even if the URL has not yet been updated
 url: to,
 },
 });
 });
 }
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/tracing/sentrySpan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -336,6 +336,8 @@ export class SentrySpan implements Span {

 const { scope: capturedSpanScope, isolationScope: capturedSpanIsolationScope } = getCapturedScopesOnSpan(this);

 const normalizedRequest = capturedSpanScope?.getScopeData().sdkProcessingMetadata?.normalizedRequest;

 if (this._sampled !== true) {
 return undefined;
 }
Expand DownExpand Up@@ -374,6 +376,7 @@ export class SentrySpan implements Span {
 capturedSpanIsolationScope,
 dynamicSamplingContext: getDynamicSamplingContextFromSpan(this),
 },
 request: normalizedRequest,
 ...(source && {
 transaction_info: {
 source,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/types-hoist/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,9 @@ export interface HandlerDataConsole {
}

export interface HandlerDataHistory {
 /** The full URL of the previous page */
 from: string | undefined;
 /** The full URL of the new page */
 to: string;
}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(browser): Ensure pageload & navigation spans have correct data#16279

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

 Merged

mydea
merged 7 commits into

from

May 14, 2025
 Merged


fix(browser): Ensure pageload & navigation spans have correct data
#16279
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
8102ffc

fix(browser): Ensure pageload & navigation spans have correct data


mydea May 13, 2025
5cd662a

fix tests


mydea May 14, 2025
694883d

reset it afterwards


mydea May 14, 2025
cee11ea

fix by using `to` from history instrumentation


mydea May 14, 2025
dcd9311

fix tests & add test for absolute url handling


mydea May 14, 2025
d12215d

Revert "fix tests"


mydea May 14, 2025
6139d08

fix replay test


mydea May 14, 2025

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


4 changes: 2 additions & 2 deletions
...ages/browser-integration-tests/suites/integrations/Breadcrumbs/history/navigation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,14 +29,14 @@ sentryTest('should record history changes as navigation breadcrumbs', async ({ g
 category: 'navigation',
 data: {
 from: '/bar?a=1#fragment',
 to: '[object Object]',
 to: '/[object%20Object]',
 },
 timestamp: expect.any(Number),
 },
 {
 category: 'navigation',
 data: {
 from: '[object Object]',
 from: '/[object%20Object]',
 to: '/bar?a=1#fragment',
 },
 timestamp: expect.any(Number),
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/browser-integration-tests/suites/replay/multiple-pages/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -210,7 +210,7 @@ sentryTest(
 expect(replayEvent6).toEqual(
 getExpectedReplayEvent({
 segment_id: 6,
 urls: ['/spa'],
 urls: [`${TEST_HOST}/spa`],
 request: {
 url: `${TEST_HOST}/spa`,
 headers: {
Expand Down

2 changes: 1 addition & 1 deletion
...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,4 +9,4 @@ Sentry.init({
});

// Immediately navigate to a new page to abort the pageload
window.location.href = '#foo';
window.history.pushState({}, '', '/sub-page');

15 changes: 15 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,9 @@ sentryTest(
 expect(navigationTraceId).toBeDefined();
 expect(pageloadTraceId).not.toEqual(navigationTraceId);

 expect(pageloadRequest.transaction).toEqual('/index.html');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -54,5 +57,17 @@ sentryTest(
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page',
 });
 },
);

85 changes: 84 additions & 1 deletion
...ges/browser-integration-tests/suites/tracing/browserTracingIntegration/navigation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,12 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';
import {
 envelopeRequestParser,
 getFirstSentryEnvelopeRequest,
 shouldSkipTracingTest,
 waitForTransactionRequest,
} from '../../../../utils/helpers';

sentryTest('should create a navigation transaction on page navigation', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
Expand All@@ -31,6 +36,10 @@ sentryTest('should create a navigation transaction on page navigation', async ({
 expect(navigationTraceId).toBeDefined();
 expect(pageloadTraceId).not.toEqual(navigationTraceId);

 expect(pageloadRequest.transaction).toEqual('/index.html');
 // Fragment is not in transaction name
 expect(navigationRequest.transaction).toEqual('/index.html');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -45,6 +54,18 @@ sentryTest('should create a navigation transaction on page navigation', async ({
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html#foo',
 });

 const pageloadSpans = pageloadRequest.spans;
 const navigationSpans = navigationRequest.spans;
Expand All@@ -69,3 +90,65 @@ sentryTest('should create a navigation transaction on page navigation', async ({

 expect(pageloadSpanId).not.toEqual(navigationSpanId);
});

//
sentryTest('should handle pushState with full URL', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

 const url = await getLocalTestUrl({ testDir: __dirname });

 const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');
 const navigationRequestPromise = waitForTransactionRequest(
 page,
 event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page',
 );
 const navigationRequestPromise2 = waitForTransactionRequest(
 page,
 event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page-2',
 );

 await page.goto(url);
 await pageloadRequestPromise;

 await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page`);");

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.transaction).toEqual('/sub-page');

 expect(navigationRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page',
 });

 await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page-2`);");

 const navigationRequest2 = envelopeRequestParser(await navigationRequestPromise2);

 expect(navigationRequest2.transaction).toEqual('/sub-page-2');

 expect(navigationRequest2.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(navigationRequest2.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page-2',
 });
});

20 changes: 18 additions & 2 deletions
packages/browser-utils/src/instrument/history.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,15 @@ export function instrumentHistory(): void {
 return function (this: History, ...args: unknown[]): void {
 const url = args.length > 2 ? args[2] : undefined;
 if (url) {
 // coerce to string (this is what pushState does)
 const from = lastHref;
 const to = String(url);

 // Ensure the URL is absolute
 // this can be either a path, then it is relative to the current origin
 // or a full URL of the current origin - other origins are not allowed
 // See: https://developer.mozilla.org/en-US/docs/Web/API/History/pushState#url
 // coerce to string (this is what pushState does)
 const to = getAbsoluteUrl(String(url));

 // keep track of the current URL state, as we always receive only the updated state
 lastHref = to;

Expand All@@ -67,3 +73,13 @@ export function instrumentHistory(): void {
 fill(WINDOW.history, 'pushState', historyReplacementFunction);
 fill(WINDOW.history, 'replaceState', historyReplacementFunction);
}

function getAbsoluteUrl(urlOrPath: string): string {
 try {
 const url = new URL(urlOrPath, WINDOW.location.origin);
 return url.toString();
 } catch {
 // fallback, just do nothing
 return urlOrPath;
 }
}

22 changes: 22 additions & 0 deletions
packages/browser/src/helpers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 addExceptionTypeValue,
 addNonEnumerableProperty,
 captureException,
 getLocationHref,
 getOriginalFunction,
 GLOBAL_OBJ,
 markFunctionWrapped,
Expand DownExpand Up@@ -175,3 +176,24 @@ export function wrap<T extends WrappableFunction, NonFunction>(

 return sentryWrapped;
}

/**
 * Get HTTP request data from the current page.
 */
export function getHttpRequestData(): { url: string; headers: Record<string, string> } {
 // grab as much info as exists and add it to the event
 const url = getLocationHref();
 const { referrer } = WINDOW.document || {};
 const { userAgent } = WINDOW.navigator || {};

 const headers = {
 ...(referrer && { Referer: referrer }),
 ...(userAgent && { 'User-Agent': userAgent }),
 };
 const request = {
 url,
 headers,
 };

 return request;
}

20 changes: 7 additions & 13 deletions
packages/browser/src/integrations/httpcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { defineIntegration, getLocationHref } from '@sentry/core';
import { WINDOW } from '../helpers';
import { defineIntegration } from '@sentry/core';
import { getHttpRequestData, WINDOW } from '../helpers';

/**
 * Collects information about HTTP request headers and
Expand All@@ -14,23 +14,17 @@ export const httpContextIntegration = defineIntegration(() => {
 return;
 }

 // grab as much info as exists and add it to the event
 const url = event.request?.url || getLocationHref();
 const { referrer } = WINDOW.document || {};
 const { userAgent } = WINDOW.navigator || {};

 const reqData = getHttpRequestData();
 const headers = {
 ...reqData.headers,
 ...event.request?.headers,
 ...(referrer && { Referer: referrer }),
 ...(userAgent && { 'User-Agent': userAgent }),
 };
 const request = {

 event.request = {
 ...reqData,
 ...event.request,
 ...(url && { url }),
 headers,
 };

 event.request = request;
 },
 };
});

51 changes: 38 additions & 13 deletions
packages/browser/src/tracing/browserTracingIntegration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
 getLocationHref,
 GLOBAL_OBJ,
 logger,
 parseStringToURLObject,
 propagationContextFromHeaders,
 registerSpanErrorInstrumentation,
 SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON,
Expand All@@ -33,7 +34,7 @@ import {
 startTrackingWebVitals,
} from '@sentry-internal/browser-utils';
import { DEBUG_BUILD } from '../debug-build';
import { WINDOW } from '../helpers';
import { getHttpRequestData, WINDOW } from '../helpers';
import { registerBackgroundTabDetection } from './backgroundtab';
import { linkTraces } from './linkedTraces';
import { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from './request';
Expand DownExpand Up@@ -399,7 +400,14 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 maybeEndActiveSpan();

 getIsolationScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
 getCurrentScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });

 const scope = getCurrentScope();
 scope.setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
 // We reset this to ensure we do not have lingering incorrect data here
 // places that call this hook may set this where appropriate - else, the URL at span sending time is used
 scope.setSDKProcessingMetadata({
 normalizedRequest: undefined,
 });

 _createRouteSpan(client, {
 op: 'navigation',
Expand All@@ -417,7 +425,15 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 const baggage = traceOptions.baggage || getMetaContent('baggage');

 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 getCurrentScope().setPropagationContext(propagationContext);

 const scope = getCurrentScope();
 scope.setPropagationContext(propagationContext);

 // We store the normalized request data on the scope, so we get the request data at time of span creation
 // otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
 scope.setSDKProcessingMetadata({
 normalizedRequest: getHttpRequestData(),
 });

 _createRouteSpan(client, {
 op: 'pageload',
Expand DownExpand Up@@ -459,16 +475,25 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 return;
 }

 if (from !== to) {
 startingUrl = undefined;
 startBrowserTracingNavigationSpan(client, {
 name: WINDOW.location.pathname,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 },
 });
 }
 startingUrl = undefined;
@Lms24Lms24May 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

m/q: why did we remove the from !== to check?
@mydeamydeaMay 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

sorry, forgot to mention this - we actually have the same check in the history handler code, where we do not even trigger the handler in this case!
@Lms24Lms24May 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

nice, good catch!
 const parsed = parseStringToURLObject(to);
 startBrowserTracingNavigationSpan(client, {
 name: parsed?.pathname || WINDOW.location.pathname,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 },
 });

 // We store the normalized request data on the scope, so we get the request data at time of span creation
 // otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
 getCurrentScope().setSDKProcessingMetadata({
 normalizedRequest: {
 ...getHttpRequestData(),
 // Ensure to set this, so this matches the target route even if the URL has not yet been updated
 url: to,
 },
 });
 });
 }
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/tracing/sentrySpan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -336,6 +336,8 @@ export class SentrySpan implements Span {

 const { scope: capturedSpanScope, isolationScope: capturedSpanIsolationScope } = getCapturedScopesOnSpan(this);

 const normalizedRequest = capturedSpanScope?.getScopeData().sdkProcessingMetadata?.normalizedRequest;

 if (this._sampled !== true) {
 return undefined;
 }
Expand DownExpand Up@@ -374,6 +376,7 @@ export class SentrySpan implements Span {
 capturedSpanIsolationScope,
 dynamicSamplingContext: getDynamicSamplingContextFromSpan(this),
 },
 request: normalizedRequest,
 ...(source && {
 transaction_info: {
 source,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/types-hoist/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,9 @@ export interface HandlerDataConsole {
}

export interface HandlerDataHistory {
 /** The full URL of the previous page */
 from: string | undefined;
 /** The full URL of the new page */
 to: string;
}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix(browser): Ensure pageload & navigation spans have correct data#16279

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

 Merged

mydea
merged 7 commits into

from

May 14, 2025
 Merged


fix(browser): Ensure pageload & navigation spans have correct data
#16279
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
8102ffc

fix(browser): Ensure pageload & navigation spans have correct data


mydea May 13, 2025
5cd662a

fix tests


mydea May 14, 2025
694883d

reset it afterwards


mydea May 14, 2025
cee11ea

fix by using `to` from history instrumentation


mydea May 14, 2025
dcd9311

fix tests & add test for absolute url handling


mydea May 14, 2025
d12215d

Revert "fix tests"


mydea May 14, 2025
6139d08

fix replay test


mydea May 14, 2025

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


4 changes: 2 additions & 2 deletions
...ages/browser-integration-tests/suites/integrations/Breadcrumbs/history/navigation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,14 +29,14 @@ sentryTest('should record history changes as navigation breadcrumbs', async ({ g
 category: 'navigation',
 data: {
 from: '/bar?a=1#fragment',
 to: '[object Object]',
 to: '/[object%20Object]',
 },
 timestamp: expect.any(Number),
 },
 {
 category: 'navigation',
 data: {
 from: '[object Object]',
 from: '/[object%20Object]',
 to: '/bar?a=1#fragment',
 },
 timestamp: expect.any(Number),
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/browser-integration-tests/suites/replay/multiple-pages/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -210,7 +210,7 @@ sentryTest(
 expect(replayEvent6).toEqual(
 getExpectedReplayEvent({
 segment_id: 6,
 urls: ['/spa'],
 urls: [`${TEST_HOST}/spa`],
 request: {
 url: `${TEST_HOST}/spa`,
 headers: {
Expand Down

2 changes: 1 addition & 1 deletion
...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,4 +9,4 @@ Sentry.init({
});

// Immediately navigate to a new page to abort the pageload
window.location.href = '#foo';
window.history.pushState({}, '', '/sub-page');

15 changes: 15 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-aborting-pageload/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,9 @@ sentryTest(
 expect(navigationTraceId).toBeDefined();
 expect(pageloadTraceId).not.toEqual(navigationTraceId);

 expect(pageloadRequest.transaction).toEqual('/index.html');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -54,5 +57,17 @@ sentryTest(
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page',
 });
 },
);

85 changes: 84 additions & 1 deletion
...ges/browser-integration-tests/suites/tracing/browserTracingIntegration/navigation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,12 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';
import {
 envelopeRequestParser,
 getFirstSentryEnvelopeRequest,
 shouldSkipTracingTest,
 waitForTransactionRequest,
} from '../../../../utils/helpers';

sentryTest('should create a navigation transaction on page navigation', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
Expand All@@ -31,6 +36,10 @@ sentryTest('should create a navigation transaction on page navigation', async ({
 expect(navigationTraceId).toBeDefined();
 expect(pageloadTraceId).not.toEqual(navigationTraceId);

 expect(pageloadRequest.transaction).toEqual('/index.html');
 // Fragment is not in transaction name
 expect(navigationRequest.transaction).toEqual('/index.html');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
Expand All@@ -45,6 +54,18 @@ sentryTest('should create a navigation transaction on page navigation', async ({
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html#foo',
 });

 const pageloadSpans = pageloadRequest.spans;
 const navigationSpans = navigationRequest.spans;
Expand All@@ -69,3 +90,65 @@ sentryTest('should create a navigation transaction on page navigation', async ({

 expect(pageloadSpanId).not.toEqual(navigationSpanId);
});

//
sentryTest('should handle pushState with full URL', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

 const url = await getLocalTestUrl({ testDir: __dirname });

 const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');
 const navigationRequestPromise = waitForTransactionRequest(
 page,
 event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page',
 );
 const navigationRequestPromise2 = waitForTransactionRequest(
 page,
 event => event.contexts?.trace?.op === 'navigation' && event.transaction === '/sub-page-2',
 );

 await page.goto(url);
 await pageloadRequestPromise;

 await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page`);");

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.transaction).toEqual('/sub-page');

 expect(navigationRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(navigationRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page',
 });

 await page.evaluate("window.history.pushState({}, '', `${window.location.origin}/sub-page-2`);");

 const navigationRequest2 = envelopeRequestParser(await navigationRequestPromise2);

 expect(navigationRequest2.transaction).toEqual('/sub-page-2');

 expect(navigationRequest2.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });
 expect(navigationRequest2.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/sub-page-2',
 });
});

20 changes: 18 additions & 2 deletions
packages/browser-utils/src/instrument/history.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,9 +47,15 @@ export function instrumentHistory(): void {
 return function (this: History, ...args: unknown[]): void {
 const url = args.length > 2 ? args[2] : undefined;
 if (url) {
 // coerce to string (this is what pushState does)
 const from = lastHref;
 const to = String(url);

 // Ensure the URL is absolute
 // this can be either a path, then it is relative to the current origin
 // or a full URL of the current origin - other origins are not allowed
 // See: https://developer.mozilla.org/en-US/docs/Web/API/History/pushState#url
 // coerce to string (this is what pushState does)
 const to = getAbsoluteUrl(String(url));

 // keep track of the current URL state, as we always receive only the updated state
 lastHref = to;

Expand All@@ -67,3 +73,13 @@ export function instrumentHistory(): void {
 fill(WINDOW.history, 'pushState', historyReplacementFunction);
 fill(WINDOW.history, 'replaceState', historyReplacementFunction);
}

function getAbsoluteUrl(urlOrPath: string): string {
 try {
 const url = new URL(urlOrPath, WINDOW.location.origin);
 return url.toString();
 } catch {
 // fallback, just do nothing
 return urlOrPath;
 }
}

22 changes: 22 additions & 0 deletions
packages/browser/src/helpers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 addExceptionTypeValue,
 addNonEnumerableProperty,
 captureException,
 getLocationHref,
 getOriginalFunction,
 GLOBAL_OBJ,
 markFunctionWrapped,
Expand DownExpand Up@@ -175,3 +176,24 @@ export function wrap<T extends WrappableFunction, NonFunction>(

 return sentryWrapped;
}

/**
 * Get HTTP request data from the current page.
 */
export function getHttpRequestData(): { url: string; headers: Record<string, string> } {
 // grab as much info as exists and add it to the event
 const url = getLocationHref();
 const { referrer } = WINDOW.document || {};
 const { userAgent } = WINDOW.navigator || {};

 const headers = {
 ...(referrer && { Referer: referrer }),
 ...(userAgent && { 'User-Agent': userAgent }),
 };
 const request = {
 url,
 headers,
 };

 return request;
}

20 changes: 7 additions & 13 deletions
packages/browser/src/integrations/httpcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { defineIntegration, getLocationHref } from '@sentry/core';
import { WINDOW } from '../helpers';
import { defineIntegration } from '@sentry/core';
import { getHttpRequestData, WINDOW } from '../helpers';

/**
 * Collects information about HTTP request headers and
Expand All@@ -14,23 +14,17 @@ export const httpContextIntegration = defineIntegration(() => {
 return;
 }

 // grab as much info as exists and add it to the event
 const url = event.request?.url || getLocationHref();
 const { referrer } = WINDOW.document || {};
 const { userAgent } = WINDOW.navigator || {};

 const reqData = getHttpRequestData();
 const headers = {
 ...reqData.headers,
 ...event.request?.headers,
 ...(referrer && { Referer: referrer }),
 ...(userAgent && { 'User-Agent': userAgent }),
 };
 const request = {

 event.request = {
 ...reqData,
 ...event.request,
 ...(url && { url }),
 headers,
 };

 event.request = request;
 },
 };
});

51 changes: 38 additions & 13 deletions
packages/browser/src/tracing/browserTracingIntegration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
 getLocationHref,
 GLOBAL_OBJ,
 logger,
 parseStringToURLObject,
 propagationContextFromHeaders,
 registerSpanErrorInstrumentation,
 SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON,
Expand All@@ -33,7 +34,7 @@ import {
 startTrackingWebVitals,
} from '@sentry-internal/browser-utils';
import { DEBUG_BUILD } from '../debug-build';
import { WINDOW } from '../helpers';
import { getHttpRequestData, WINDOW } from '../helpers';
import { registerBackgroundTabDetection } from './backgroundtab';
import { linkTraces } from './linkedTraces';
import { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from './request';
Expand DownExpand Up@@ -399,7 +400,14 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 maybeEndActiveSpan();

 getIsolationScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
 getCurrentScope().setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });

 const scope = getCurrentScope();
 scope.setPropagationContext({ traceId: generateTraceId(), sampleRand: Math.random() });
 // We reset this to ensure we do not have lingering incorrect data here
 // places that call this hook may set this where appropriate - else, the URL at span sending time is used
 scope.setSDKProcessingMetadata({
 normalizedRequest: undefined,
 });

 _createRouteSpan(client, {
 op: 'navigation',
Expand All@@ -417,7 +425,15 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 const baggage = traceOptions.baggage || getMetaContent('baggage');

 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 getCurrentScope().setPropagationContext(propagationContext);

 const scope = getCurrentScope();
 scope.setPropagationContext(propagationContext);

 // We store the normalized request data on the scope, so we get the request data at time of span creation
 // otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
 scope.setSDKProcessingMetadata({
 normalizedRequest: getHttpRequestData(),
 });

 _createRouteSpan(client, {
 op: 'pageload',
Expand DownExpand Up@@ -459,16 +475,25 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
 return;
 }

 if (from !== to) {
 startingUrl = undefined;
 startBrowserTracingNavigationSpan(client, {
 name: WINDOW.location.pathname,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 },
 });
 }
 startingUrl = undefined;
@Lms24Lms24May 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

m/q: why did we remove the from !== to check?
@mydeamydeaMay 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

sorry, forgot to mention this - we actually have the same check in the history handler code, where we do not even trigger the handler in this case!
@Lms24Lms24May 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

nice, good catch!
 const parsed = parseStringToURLObject(to);
 startBrowserTracingNavigationSpan(client, {
 name: parsed?.pathname || WINDOW.location.pathname,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.browser',
 },
 });

 // We store the normalized request data on the scope, so we get the request data at time of span creation
 // otherwise, the URL etc. may already be of the following navigation, and we'd report the wrong URL
 getCurrentScope().setSDKProcessingMetadata({
 normalizedRequest: {
 ...getHttpRequestData(),
 // Ensure to set this, so this matches the target route even if the URL has not yet been updated
 url: to,
 },
 });
 });
 }
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/core/src/tracing/sentrySpan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -336,6 +336,8 @@ export class SentrySpan implements Span {

 const { scope: capturedSpanScope, isolationScope: capturedSpanIsolationScope } = getCapturedScopesOnSpan(this);

 const normalizedRequest = capturedSpanScope?.getScopeData().sdkProcessingMetadata?.normalizedRequest;

 if (this._sampled !== true) {
 return undefined;
 }
Expand DownExpand Up@@ -374,6 +376,7 @@ export class SentrySpan implements Span {
 capturedSpanIsolationScope,
 dynamicSamplingContext: getDynamicSamplingContextFromSpan(this),
 },
 request: normalizedRequest,
 ...(source && {
 transaction_info: {
 source,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/types-hoist/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,9 @@ export interface HandlerDataConsole {
}

export interface HandlerDataHistory {
 /** The full URL of the previous page */
 from: string | undefined;
 /** The full URL of the new page */
 to: string;
}

Expand Down