feat(v9/browser): Detect redirects when emitting navigation spans#16875

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

Closed
mydea wants to merge 1 commit into from
Closed

feat(v9/browser): Detect redirects when emitting navigation spans #16875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion ...n-tests/suites/tracing/browserTracingIntegration/linked-traces/negatively-sampled/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.browserTracingIntegration()],
// We want to ignore redirects for this test
integrations: [Sentry.browserTracingIntegration({ detectRedirects: false })],
tracesSampler: ctx => {
if (ctx.attributes['sentry.origin'] === 'auto.pageload.browser') {
return 0;
Expand Down
9 changes: 6 additions & 3 deletions ...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@@ -4,9 +4,12 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.browserTracingIntegration()],
integrations: [Sentry.browserTracingIntegration({ idleTimeout: 2000 })],
tracesSampleRate: 1,
});

// Immediately navigate to a new page to abort the pageload
window.history.pushState({}, '', '/sub-page');
// Navigate to a new page to abort the pageload
// We have to wait >300ms to avoid the redirect handling
setTimeout(() => {
window.history.pushState({}, '', '/sub-page');
}, 500);
23 changes: 23 additions & 0 deletions ...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.browserTracingIntegration()],
tracesSampleRate: 1,
debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
// Trigger navigation later than click, so the last click is more than 300ms ago
setTimeout(() => {
window.history.pushState({}, '', '/sub-page');

// then trigger redirect inside of this navigation, which should be detected as a redirect
// because the last click was more than 300ms ago
setTimeout(() => {
window.history.pushState({}, '', '/sub-page-redirect');
}, 100);
}, 400);
});
7 changes: 7 additions & 0 deletions ...ts/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/template.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
<head>
<meta charset="utf-8" />
</head>
<button id="btn1">Trigger navigation</button>
</html>
41 changes: 41 additions & 0 deletions ...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
'should create a navigation.redirect span if a click happened more than 300ms before navigation',
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',
);

await page.goto(url);

await pageloadRequestPromise;

// Now trigger navigation, and then a redirect in the navigation, with
await page.click('#btn1');

const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
expect(navigationRequest.transaction).toEqual('/sub-page');

const spans = navigationRequest.spans || [];

expect(spans).toContainEqual(
expect.objectContaining({
op: 'navigation.redirect',
description: '/sub-page-redirect',
}),
);
},
);
10 changes: 10 additions & 0 deletions ...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.browserTracingIntegration()],
tracesSampleRate: 1,
debug: true,
});
7 changes: 7 additions & 0 deletions ...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/subject.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
document.getElementById('btn1').addEventListener('click', () => {
// trigger redirect immediately
window.history.pushState({}, '', '/sub-page');
});

// Now trigger click, which should trigger navigation
document.getElementById('btn1').click();
7 changes: 7 additions & 0 deletions ...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/template.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
<head>
<meta charset="utf-8" />
</head>
<button id="btn1" type="button">Trigger navigation</button>
</html>
34 changes: 34 additions & 0 deletions ...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
'should not create a navigation.redirect span if a click happened before navigation',
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',
);

await page.goto(url);

const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
// Ensure a navigation span is sent, too
await navigationRequestPromise;

const spans = pageloadRequest.spans || [];

expect(spans).not.toContainEqual(
expect.objectContaining({
op: 'navigation.redirect',
}),
);
},
);
12 changes: 12 additions & 0 deletions ...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.browserTracingIntegration()],
tracesSampleRate: 1,
});

// trigger redirect immediately
window.history.pushState({}, '', '/sub-page');
66 changes: 66 additions & 0 deletions ...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { expect } from '@playwright/test';
import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest('should create a pageload transaction with navigation.redirect span', async ({ getLocalTestUrl, page }) => {
if (shouldSkipTracingTest()) {
sentryTest.skip();
}

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

const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');

await page.goto(url);

const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);

expect(pageloadRequest.contexts?.trace?.op).toBe('pageload');

expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'pageload',
['sentry.idle_span_finish_reason']: 'idleTimeout',
});

expect(pageloadRequest.request).toEqual({
headers: {
'User-Agent': expect.any(String),
},
url: 'http://sentry-test.io/index.html',
});

const spans = pageloadRequest.spans || [];

expect(spans).toContainEqual(
expect.objectContaining({
op: 'navigation.redirect',
}),
);

const navigationSpan = spans.find(span => span.op === 'navigation.redirect');
expect(navigationSpan?.timestamp).toEqual(navigationSpan?.start_timestamp);
expect(navigationSpan).toEqual({
data: {
'sentry.op': 'navigation.redirect',
'sentry.origin': 'auto.navigation.browser',
'sentry.source': 'url',
},
description: '/sub-page',
op: 'navigation.redirect',
origin: 'auto.navigation.browser',
parent_span_id: pageloadRequest.contexts!.trace!.span_id,
span_id: expect.any(String),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.any(String),
});
});
23 changes: 23 additions & 0 deletions ...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.browserTracingIntegration()],
tracesSampleRate: 1,
debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
// Trigger navigation later than click, so the last click is more than 300ms ago
setTimeout(() => {
window.history.pushState({}, '', '/sub-page');

// then trigger redirect inside of this navigation, which should be detected as a redirect
// because the last click was more than 300ms ago
setTimeout(() => {
window.history.pushState({}, '', '/sub-page-redirect');
}, 100);
}, 400);
});
7 changes: 7 additions & 0 deletions ...suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/template.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
<head>
<meta charset="utf-8" />
</head>
<button id="btn1">Trigger navigation</button>
</html>
42 changes: 42 additions & 0 deletions ...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
'should create a navigation.redirect span if a keypress happened more than 300ms before navigation',
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',
);

await page.goto(url);

await pageloadRequestPromise;

// Now trigger navigation, and then a redirect in the navigation
await page.focus('#btn1');
await page.keyboard.press('Enter');

const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
expect(navigationRequest.transaction).toEqual('/sub-page');

const spans = navigationRequest.spans || [];

expect(spans).toContainEqual(
expect.objectContaining({
op: 'navigation.redirect',
description: '/sub-page-redirect',
}),
);
},
);
10 changes: 10 additions & 0 deletions ...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.browserTracingIntegration()],
tracesSampleRate: 1,
debug: true,
});
4 changes: 4 additions & 0 deletions ...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/subject.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
document.getElementById('btn1').addEventListener('click', () => {
// trigger redirect immediately
window.history.pushState({}, '', '/sub-page');
});
7 changes: 7 additions & 0 deletions ...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/template.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
<head>
<meta charset="utf-8" />
</head>
<button id="btn1" type="button">Trigger navigation</button>
</html>
36 changes: 36 additions & 0 deletions ...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
'should not create a navigation.redirect span if a keypress happened before navigation',
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',
);

await page.goto(url);
await page.focus('#btn1');
await page.keyboard.press('Enter');

const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
// Ensure a navigation span is sent, too
await navigationRequestPromise;

const spans = pageloadRequest.spans || [];

expect(spans).not.toContainEqual(
expect.objectContaining({
op: 'navigation.redirect',
}),
);
},
);
14 changes: 14 additions & 0 deletions ...tegration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/late/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.browserTracingIntegration()],
tracesSampleRate: 1,
});

// trigger redirect later
setTimeout(() => {
window.history.pushState({}, '', '/sub-page');
}, 400);
Loading
, '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
feat(v9/browser): Detect redirects when emitting navigation spans#16875

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

 Closed

mydea
wants to merge
1
commit into

from

 Closed


feat(v9/browser): Detect redirects when emitting navigation spans
#16875
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


3 changes: 2 additions & 1 deletion
...n-tests/suites/tracing/browserTracingIntegration/linked-traces/negatively-sampled/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 // We want to ignore redirects for this test
 integrations: [Sentry.browserTracingIntegration({ detectRedirects: false })],
 tracesSampler: ctx => {
 if (ctx.attributes['sentry.origin'] === 'auto.pageload.browser') {
 return 0;
Expand Down

9 changes: 6 additions & 3 deletions
...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@@ -4,9 +4,12 @@ window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 integrations: [Sentry.browserTracingIntegration({ idleTimeout: 2000 })],
 tracesSampleRate: 1,
});

// Immediately navigate to a new page to abort the pageload
window.history.pushState({}, '', '/sub-page');
// Navigate to a new page to abort the pageload
// We have to wait >300ms to avoid the redirect handling
setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');
}, 500);

23 changes: 23 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
 // Trigger navigation later than click, so the last click is more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');

 // then trigger redirect inside of this navigation, which should be detected as a redirect
 // because the last click was more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page-redirect');
 }, 100);
 }, 400);
});

7 changes: 7 additions & 0 deletions
...ts/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1">Trigger navigation</button>
</html>

41 changes: 41 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should create a navigation.redirect span if a click happened more than 300ms before navigation',
 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',
 );

 await page.goto(url);

 await pageloadRequestPromise;

 // Now trigger navigation, and then a redirect in the navigation, with
 await page.click('#btn1');

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 const spans = navigationRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 description: '/sub-page-redirect',
 }),
 );
 },
);

10 changes: 10 additions & 0 deletions
...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

7 changes: 7 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
document.getElementById('btn1').addEventListener('click', () => {
 // trigger redirect immediately
 window.history.pushState({}, '', '/sub-page');
});

// Now trigger click, which should trigger navigation
document.getElementById('btn1').click();

7 changes: 7 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1" type="button">Trigger navigation</button>
</html>

34 changes: 34 additions & 0 deletions
...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should not create a navigation.redirect span if a click happened before navigation',
 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',
 );

 await page.goto(url);

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
 // Ensure a navigation span is sent, too
 await navigationRequestPromise;

 const spans = pageloadRequest.spans || [];

 expect(spans).not.toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );
 },
);

12 changes: 12 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
});

// trigger redirect immediately
window.history.pushState({}, '', '/sub-page');

66 changes: 66 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { expect } from '@playwright/test';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest('should create a pageload transaction with navigation.redirect span', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

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

 const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');

 await page.goto(url);

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);

 expect(pageloadRequest.contexts?.trace?.op).toBe('pageload');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'pageload',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });

 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });

 const spans = pageloadRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );

 const navigationSpan = spans.find(span => span.op === 'navigation.redirect');
 expect(navigationSpan?.timestamp).toEqual(navigationSpan?.start_timestamp);
 expect(navigationSpan).toEqual({
 data: {
 'sentry.op': 'navigation.redirect',
 'sentry.origin': 'auto.navigation.browser',
 'sentry.source': 'url',
 },
 description: '/sub-page',
 op: 'navigation.redirect',
 origin: 'auto.navigation.browser',
 parent_span_id: pageloadRequest.contexts!.trace!.span_id,
 span_id: expect.any(String),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: expect.any(String),
 });
});

23 changes: 23 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
 // Trigger navigation later than click, so the last click is more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');

 // then trigger redirect inside of this navigation, which should be detected as a redirect
 // because the last click was more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page-redirect');
 }, 100);
 }, 400);
});

7 changes: 7 additions & 0 deletions
...suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1">Trigger navigation</button>
</html>

42 changes: 42 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should create a navigation.redirect span if a keypress happened more than 300ms before navigation',
 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',
 );

 await page.goto(url);

 await pageloadRequestPromise;

 // Now trigger navigation, and then a redirect in the navigation
 await page.focus('#btn1');
 await page.keyboard.press('Enter');

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 const spans = navigationRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 description: '/sub-page-redirect',
 }),
 );
 },
);

10 changes: 10 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

4 changes: 4 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
document.getElementById('btn1').addEventListener('click', () => {
 // trigger redirect immediately
 window.history.pushState({}, '', '/sub-page');
});

7 changes: 7 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1" type="button">Trigger navigation</button>
</html>

36 changes: 36 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should not create a navigation.redirect span if a keypress happened before navigation',
 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',
 );

 await page.goto(url);
 await page.focus('#btn1');
 await page.keyboard.press('Enter');

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
 // Ensure a navigation span is sent, too
 await navigationRequestPromise;

 const spans = pageloadRequest.spans || [];

 expect(spans).not.toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );
 },
);

14 changes: 14 additions & 0 deletions
...tegration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/late/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
});

// trigger redirect later
setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');
}, 400);
Loading

, '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
feat(v9/browser): Detect redirects when emitting navigation spans#16875

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

 Closed

mydea
wants to merge
1
commit into

from

 Closed


feat(v9/browser): Detect redirects when emitting navigation spans
#16875
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


3 changes: 2 additions & 1 deletion
...n-tests/suites/tracing/browserTracingIntegration/linked-traces/negatively-sampled/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 // We want to ignore redirects for this test
 integrations: [Sentry.browserTracingIntegration({ detectRedirects: false })],
 tracesSampler: ctx => {
 if (ctx.attributes['sentry.origin'] === 'auto.pageload.browser') {
 return 0;
Expand Down

9 changes: 6 additions & 3 deletions
...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@@ -4,9 +4,12 @@ window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 integrations: [Sentry.browserTracingIntegration({ idleTimeout: 2000 })],
 tracesSampleRate: 1,
});

// Immediately navigate to a new page to abort the pageload
window.history.pushState({}, '', '/sub-page');
// Navigate to a new page to abort the pageload
// We have to wait >300ms to avoid the redirect handling
setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');
}, 500);

23 changes: 23 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
 // Trigger navigation later than click, so the last click is more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');

 // then trigger redirect inside of this navigation, which should be detected as a redirect
 // because the last click was more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page-redirect');
 }, 100);
 }, 400);
});

7 changes: 7 additions & 0 deletions
...ts/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1">Trigger navigation</button>
</html>

41 changes: 41 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should create a navigation.redirect span if a click happened more than 300ms before navigation',
 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',
 );

 await page.goto(url);

 await pageloadRequestPromise;

 // Now trigger navigation, and then a redirect in the navigation, with
 await page.click('#btn1');

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 const spans = navigationRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 description: '/sub-page-redirect',
 }),
 );
 },
);

10 changes: 10 additions & 0 deletions
...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

7 changes: 7 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
document.getElementById('btn1').addEventListener('click', () => {
 // trigger redirect immediately
 window.history.pushState({}, '', '/sub-page');
});

// Now trigger click, which should trigger navigation
document.getElementById('btn1').click();

7 changes: 7 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1" type="button">Trigger navigation</button>
</html>

34 changes: 34 additions & 0 deletions
...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should not create a navigation.redirect span if a click happened before navigation',
 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',
 );

 await page.goto(url);

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
 // Ensure a navigation span is sent, too
 await navigationRequestPromise;

 const spans = pageloadRequest.spans || [];

 expect(spans).not.toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );
 },
);

12 changes: 12 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
});

// trigger redirect immediately
window.history.pushState({}, '', '/sub-page');

66 changes: 66 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { expect } from '@playwright/test';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest('should create a pageload transaction with navigation.redirect span', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

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

 const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');

 await page.goto(url);

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);

 expect(pageloadRequest.contexts?.trace?.op).toBe('pageload');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'pageload',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });

 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });

 const spans = pageloadRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );

 const navigationSpan = spans.find(span => span.op === 'navigation.redirect');
 expect(navigationSpan?.timestamp).toEqual(navigationSpan?.start_timestamp);
 expect(navigationSpan).toEqual({
 data: {
 'sentry.op': 'navigation.redirect',
 'sentry.origin': 'auto.navigation.browser',
 'sentry.source': 'url',
 },
 description: '/sub-page',
 op: 'navigation.redirect',
 origin: 'auto.navigation.browser',
 parent_span_id: pageloadRequest.contexts!.trace!.span_id,
 span_id: expect.any(String),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: expect.any(String),
 });
});

23 changes: 23 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
 // Trigger navigation later than click, so the last click is more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');

 // then trigger redirect inside of this navigation, which should be detected as a redirect
 // because the last click was more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page-redirect');
 }, 100);
 }, 400);
});

7 changes: 7 additions & 0 deletions
...suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1">Trigger navigation</button>
</html>

42 changes: 42 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should create a navigation.redirect span if a keypress happened more than 300ms before navigation',
 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',
 );

 await page.goto(url);

 await pageloadRequestPromise;

 // Now trigger navigation, and then a redirect in the navigation
 await page.focus('#btn1');
 await page.keyboard.press('Enter');

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 const spans = navigationRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 description: '/sub-page-redirect',
 }),
 );
 },
);

10 changes: 10 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

4 changes: 4 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
document.getElementById('btn1').addEventListener('click', () => {
 // trigger redirect immediately
 window.history.pushState({}, '', '/sub-page');
});

7 changes: 7 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1" type="button">Trigger navigation</button>
</html>

36 changes: 36 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should not create a navigation.redirect span if a keypress happened before navigation',
 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',
 );

 await page.goto(url);
 await page.focus('#btn1');
 await page.keyboard.press('Enter');

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
 // Ensure a navigation span is sent, too
 await navigationRequestPromise;

 const spans = pageloadRequest.spans || [];

 expect(spans).not.toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );
 },
);

14 changes: 14 additions & 0 deletions
...tegration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/late/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
});

// trigger redirect later
setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');
}, 400);
Loading

, '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
feat(v9/browser): Detect redirects when emitting navigation spans#16875

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

 Closed

mydea
wants to merge
1
commit into

from

 Closed


feat(v9/browser): Detect redirects when emitting navigation spans
#16875
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


3 changes: 2 additions & 1 deletion
...n-tests/suites/tracing/browserTracingIntegration/linked-traces/negatively-sampled/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 // We want to ignore redirects for this test
 integrations: [Sentry.browserTracingIntegration({ detectRedirects: false })],
 tracesSampler: ctx => {
 if (ctx.attributes['sentry.origin'] === 'auto.pageload.browser') {
 return 0;
Expand Down

9 changes: 6 additions & 3 deletions
...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@@ -4,9 +4,12 @@ window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 integrations: [Sentry.browserTracingIntegration({ idleTimeout: 2000 })],
 tracesSampleRate: 1,
});

// Immediately navigate to a new page to abort the pageload
window.history.pushState({}, '', '/sub-page');
// Navigate to a new page to abort the pageload
// We have to wait >300ms to avoid the redirect handling
setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');
}, 500);

23 changes: 23 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
 // Trigger navigation later than click, so the last click is more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');

 // then trigger redirect inside of this navigation, which should be detected as a redirect
 // because the last click was more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page-redirect');
 }, 100);
 }, 400);
});

7 changes: 7 additions & 0 deletions
...ts/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1">Trigger navigation</button>
</html>

41 changes: 41 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should create a navigation.redirect span if a click happened more than 300ms before navigation',
 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',
 );

 await page.goto(url);

 await pageloadRequestPromise;

 // Now trigger navigation, and then a redirect in the navigation, with
 await page.click('#btn1');

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 const spans = navigationRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 description: '/sub-page-redirect',
 }),
 );
 },
);

10 changes: 10 additions & 0 deletions
...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

7 changes: 7 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
document.getElementById('btn1').addEventListener('click', () => {
 // trigger redirect immediately
 window.history.pushState({}, '', '/sub-page');
});

// Now trigger click, which should trigger navigation
document.getElementById('btn1').click();

7 changes: 7 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1" type="button">Trigger navigation</button>
</html>

34 changes: 34 additions & 0 deletions
...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should not create a navigation.redirect span if a click happened before navigation',
 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',
 );

 await page.goto(url);

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
 // Ensure a navigation span is sent, too
 await navigationRequestPromise;

 const spans = pageloadRequest.spans || [];

 expect(spans).not.toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );
 },
);

12 changes: 12 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
});

// trigger redirect immediately
window.history.pushState({}, '', '/sub-page');

66 changes: 66 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { expect } from '@playwright/test';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest('should create a pageload transaction with navigation.redirect span', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

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

 const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');

 await page.goto(url);

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);

 expect(pageloadRequest.contexts?.trace?.op).toBe('pageload');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'pageload',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });

 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });

 const spans = pageloadRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );

 const navigationSpan = spans.find(span => span.op === 'navigation.redirect');
 expect(navigationSpan?.timestamp).toEqual(navigationSpan?.start_timestamp);
 expect(navigationSpan).toEqual({
 data: {
 'sentry.op': 'navigation.redirect',
 'sentry.origin': 'auto.navigation.browser',
 'sentry.source': 'url',
 },
 description: '/sub-page',
 op: 'navigation.redirect',
 origin: 'auto.navigation.browser',
 parent_span_id: pageloadRequest.contexts!.trace!.span_id,
 span_id: expect.any(String),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: expect.any(String),
 });
});

23 changes: 23 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
 // Trigger navigation later than click, so the last click is more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');

 // then trigger redirect inside of this navigation, which should be detected as a redirect
 // because the last click was more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page-redirect');
 }, 100);
 }, 400);
});

7 changes: 7 additions & 0 deletions
...suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1">Trigger navigation</button>
</html>

42 changes: 42 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should create a navigation.redirect span if a keypress happened more than 300ms before navigation',
 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',
 );

 await page.goto(url);

 await pageloadRequestPromise;

 // Now trigger navigation, and then a redirect in the navigation
 await page.focus('#btn1');
 await page.keyboard.press('Enter');

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 const spans = navigationRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 description: '/sub-page-redirect',
 }),
 );
 },
);

10 changes: 10 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

4 changes: 4 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
document.getElementById('btn1').addEventListener('click', () => {
 // trigger redirect immediately
 window.history.pushState({}, '', '/sub-page');
});

7 changes: 7 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1" type="button">Trigger navigation</button>
</html>

36 changes: 36 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should not create a navigation.redirect span if a keypress happened before navigation',
 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',
 );

 await page.goto(url);
 await page.focus('#btn1');
 await page.keyboard.press('Enter');

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
 // Ensure a navigation span is sent, too
 await navigationRequestPromise;

 const spans = pageloadRequest.spans || [];

 expect(spans).not.toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );
 },
);

14 changes: 14 additions & 0 deletions
...tegration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/late/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
});

// trigger redirect later
setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');
}, 400);
Loading

, '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
feat(v9/browser): Detect redirects when emitting navigation spans#16875

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

 Closed

mydea
wants to merge
1
commit into

from

 Closed


feat(v9/browser): Detect redirects when emitting navigation spans
#16875
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


3 changes: 2 additions & 1 deletion
...n-tests/suites/tracing/browserTracingIntegration/linked-traces/negatively-sampled/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 // We want to ignore redirects for this test
 integrations: [Sentry.browserTracingIntegration({ detectRedirects: false })],
 tracesSampler: ctx => {
 if (ctx.attributes['sentry.origin'] === 'auto.pageload.browser') {
 return 0;
Expand Down

9 changes: 6 additions & 3 deletions
...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@@ -4,9 +4,12 @@ window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 integrations: [Sentry.browserTracingIntegration({ idleTimeout: 2000 })],
 tracesSampleRate: 1,
});

// Immediately navigate to a new page to abort the pageload
window.history.pushState({}, '', '/sub-page');
// Navigate to a new page to abort the pageload
// We have to wait >300ms to avoid the redirect handling
setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');
}, 500);

23 changes: 23 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
 // Trigger navigation later than click, so the last click is more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');

 // then trigger redirect inside of this navigation, which should be detected as a redirect
 // because the last click was more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page-redirect');
 }, 100);
 }, 400);
});

7 changes: 7 additions & 0 deletions
...ts/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1">Trigger navigation</button>
</html>

41 changes: 41 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should create a navigation.redirect span if a click happened more than 300ms before navigation',
 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',
 );

 await page.goto(url);

 await pageloadRequestPromise;

 // Now trigger navigation, and then a redirect in the navigation, with
 await page.click('#btn1');

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 const spans = navigationRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 description: '/sub-page-redirect',
 }),
 );
 },
);

10 changes: 10 additions & 0 deletions
...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

7 changes: 7 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
document.getElementById('btn1').addEventListener('click', () => {
 // trigger redirect immediately
 window.history.pushState({}, '', '/sub-page');
});

// Now trigger click, which should trigger navigation
document.getElementById('btn1').click();

7 changes: 7 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1" type="button">Trigger navigation</button>
</html>

34 changes: 34 additions & 0 deletions
...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should not create a navigation.redirect span if a click happened before navigation',
 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',
 );

 await page.goto(url);

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
 // Ensure a navigation span is sent, too
 await navigationRequestPromise;

 const spans = pageloadRequest.spans || [];

 expect(spans).not.toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );
 },
);

12 changes: 12 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
});

// trigger redirect immediately
window.history.pushState({}, '', '/sub-page');

66 changes: 66 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { expect } from '@playwright/test';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest('should create a pageload transaction with navigation.redirect span', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

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

 const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');

 await page.goto(url);

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);

 expect(pageloadRequest.contexts?.trace?.op).toBe('pageload');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'pageload',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });

 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });

 const spans = pageloadRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );

 const navigationSpan = spans.find(span => span.op === 'navigation.redirect');
 expect(navigationSpan?.timestamp).toEqual(navigationSpan?.start_timestamp);
 expect(navigationSpan).toEqual({
 data: {
 'sentry.op': 'navigation.redirect',
 'sentry.origin': 'auto.navigation.browser',
 'sentry.source': 'url',
 },
 description: '/sub-page',
 op: 'navigation.redirect',
 origin: 'auto.navigation.browser',
 parent_span_id: pageloadRequest.contexts!.trace!.span_id,
 span_id: expect.any(String),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: expect.any(String),
 });
});

23 changes: 23 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
 // Trigger navigation later than click, so the last click is more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');

 // then trigger redirect inside of this navigation, which should be detected as a redirect
 // because the last click was more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page-redirect');
 }, 100);
 }, 400);
});

7 changes: 7 additions & 0 deletions
...suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1">Trigger navigation</button>
</html>

42 changes: 42 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should create a navigation.redirect span if a keypress happened more than 300ms before navigation',
 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',
 );

 await page.goto(url);

 await pageloadRequestPromise;

 // Now trigger navigation, and then a redirect in the navigation
 await page.focus('#btn1');
 await page.keyboard.press('Enter');

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 const spans = navigationRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 description: '/sub-page-redirect',
 }),
 );
 },
);

10 changes: 10 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

4 changes: 4 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
document.getElementById('btn1').addEventListener('click', () => {
 // trigger redirect immediately
 window.history.pushState({}, '', '/sub-page');
});

7 changes: 7 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1" type="button">Trigger navigation</button>
</html>

36 changes: 36 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should not create a navigation.redirect span if a keypress happened before navigation',
 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',
 );

 await page.goto(url);
 await page.focus('#btn1');
 await page.keyboard.press('Enter');

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
 // Ensure a navigation span is sent, too
 await navigationRequestPromise;

 const spans = pageloadRequest.spans || [];

 expect(spans).not.toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );
 },
);

14 changes: 14 additions & 0 deletions
...tegration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/late/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
});

// trigger redirect later
setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');
}, 400);
Loading

, '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
feat(v9/browser): Detect redirects when emitting navigation spans#16875

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

 Closed

mydea
wants to merge
1
commit into

from

 Closed


feat(v9/browser): Detect redirects when emitting navigation spans
#16875
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


3 changes: 2 additions & 1 deletion
...n-tests/suites/tracing/browserTracingIntegration/linked-traces/negatively-sampled/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 // We want to ignore redirects for this test
 integrations: [Sentry.browserTracingIntegration({ detectRedirects: false })],
 tracesSampler: ctx => {
 if (ctx.attributes['sentry.origin'] === 'auto.pageload.browser') {
 return 0;
Expand Down

9 changes: 6 additions & 3 deletions
...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@@ -4,9 +4,12 @@ window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 integrations: [Sentry.browserTracingIntegration({ idleTimeout: 2000 })],
 tracesSampleRate: 1,
});

// Immediately navigate to a new page to abort the pageload
window.history.pushState({}, '', '/sub-page');
// Navigate to a new page to abort the pageload
// We have to wait >300ms to avoid the redirect handling
setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');
}, 500);

23 changes: 23 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
 // Trigger navigation later than click, so the last click is more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');

 // then trigger redirect inside of this navigation, which should be detected as a redirect
 // because the last click was more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page-redirect');
 }, 100);
 }, 400);
});

7 changes: 7 additions & 0 deletions
...ts/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1">Trigger navigation</button>
</html>

41 changes: 41 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should create a navigation.redirect span if a click happened more than 300ms before navigation',
 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',
 );

 await page.goto(url);

 await pageloadRequestPromise;

 // Now trigger navigation, and then a redirect in the navigation, with
 await page.click('#btn1');

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 const spans = navigationRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 description: '/sub-page-redirect',
 }),
 );
 },
);

10 changes: 10 additions & 0 deletions
...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

7 changes: 7 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
document.getElementById('btn1').addEventListener('click', () => {
 // trigger redirect immediately
 window.history.pushState({}, '', '/sub-page');
});

// Now trigger click, which should trigger navigation
document.getElementById('btn1').click();

7 changes: 7 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1" type="button">Trigger navigation</button>
</html>

34 changes: 34 additions & 0 deletions
...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should not create a navigation.redirect span if a click happened before navigation',
 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',
 );

 await page.goto(url);

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
 // Ensure a navigation span is sent, too
 await navigationRequestPromise;

 const spans = pageloadRequest.spans || [];

 expect(spans).not.toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );
 },
);

12 changes: 12 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
});

// trigger redirect immediately
window.history.pushState({}, '', '/sub-page');

66 changes: 66 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { expect } from '@playwright/test';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest('should create a pageload transaction with navigation.redirect span', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

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

 const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');

 await page.goto(url);

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);

 expect(pageloadRequest.contexts?.trace?.op).toBe('pageload');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'pageload',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });

 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });

 const spans = pageloadRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );

 const navigationSpan = spans.find(span => span.op === 'navigation.redirect');
 expect(navigationSpan?.timestamp).toEqual(navigationSpan?.start_timestamp);
 expect(navigationSpan).toEqual({
 data: {
 'sentry.op': 'navigation.redirect',
 'sentry.origin': 'auto.navigation.browser',
 'sentry.source': 'url',
 },
 description: '/sub-page',
 op: 'navigation.redirect',
 origin: 'auto.navigation.browser',
 parent_span_id: pageloadRequest.contexts!.trace!.span_id,
 span_id: expect.any(String),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: expect.any(String),
 });
});

23 changes: 23 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
 // Trigger navigation later than click, so the last click is more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');

 // then trigger redirect inside of this navigation, which should be detected as a redirect
 // because the last click was more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page-redirect');
 }, 100);
 }, 400);
});

7 changes: 7 additions & 0 deletions
...suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1">Trigger navigation</button>
</html>

42 changes: 42 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should create a navigation.redirect span if a keypress happened more than 300ms before navigation',
 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',
 );

 await page.goto(url);

 await pageloadRequestPromise;

 // Now trigger navigation, and then a redirect in the navigation
 await page.focus('#btn1');
 await page.keyboard.press('Enter');

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 const spans = navigationRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 description: '/sub-page-redirect',
 }),
 );
 },
);

10 changes: 10 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

4 changes: 4 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
document.getElementById('btn1').addEventListener('click', () => {
 // trigger redirect immediately
 window.history.pushState({}, '', '/sub-page');
});

7 changes: 7 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1" type="button">Trigger navigation</button>
</html>

36 changes: 36 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should not create a navigation.redirect span if a keypress happened before navigation',
 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',
 );

 await page.goto(url);
 await page.focus('#btn1');
 await page.keyboard.press('Enter');

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
 // Ensure a navigation span is sent, too
 await navigationRequestPromise;

 const spans = pageloadRequest.spans || [];

 expect(spans).not.toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );
 },
);

14 changes: 14 additions & 0 deletions
...tegration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/late/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
});

// trigger redirect later
setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');
}, 400);
Loading

, '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
feat(v9/browser): Detect redirects when emitting navigation spans#16875

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

 Closed

mydea
wants to merge
1
commit into

from

 Closed


feat(v9/browser): Detect redirects when emitting navigation spans
#16875
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


3 changes: 2 additions & 1 deletion
...n-tests/suites/tracing/browserTracingIntegration/linked-traces/negatively-sampled/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 // We want to ignore redirects for this test
 integrations: [Sentry.browserTracingIntegration({ detectRedirects: false })],
 tracesSampler: ctx => {
 if (ctx.attributes['sentry.origin'] === 'auto.pageload.browser') {
 return 0;
Expand Down

9 changes: 6 additions & 3 deletions
...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@@ -4,9 +4,12 @@ window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 integrations: [Sentry.browserTracingIntegration({ idleTimeout: 2000 })],
 tracesSampleRate: 1,
});

// Immediately navigate to a new page to abort the pageload
window.history.pushState({}, '', '/sub-page');
// Navigate to a new page to abort the pageload
// We have to wait >300ms to avoid the redirect handling
setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');
}, 500);

23 changes: 23 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
 // Trigger navigation later than click, so the last click is more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');

 // then trigger redirect inside of this navigation, which should be detected as a redirect
 // because the last click was more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page-redirect');
 }, 100);
 }, 400);
});

7 changes: 7 additions & 0 deletions
...ts/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1">Trigger navigation</button>
</html>

41 changes: 41 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should create a navigation.redirect span if a click happened more than 300ms before navigation',
 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',
 );

 await page.goto(url);

 await pageloadRequestPromise;

 // Now trigger navigation, and then a redirect in the navigation, with
 await page.click('#btn1');

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 const spans = navigationRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 description: '/sub-page-redirect',
 }),
 );
 },
);

10 changes: 10 additions & 0 deletions
...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

7 changes: 7 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
document.getElementById('btn1').addEventListener('click', () => {
 // trigger redirect immediately
 window.history.pushState({}, '', '/sub-page');
});

// Now trigger click, which should trigger navigation
document.getElementById('btn1').click();

7 changes: 7 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1" type="button">Trigger navigation</button>
</html>

34 changes: 34 additions & 0 deletions
...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should not create a navigation.redirect span if a click happened before navigation',
 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',
 );

 await page.goto(url);

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
 // Ensure a navigation span is sent, too
 await navigationRequestPromise;

 const spans = pageloadRequest.spans || [];

 expect(spans).not.toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );
 },
);

12 changes: 12 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
});

// trigger redirect immediately
window.history.pushState({}, '', '/sub-page');

66 changes: 66 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { expect } from '@playwright/test';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest('should create a pageload transaction with navigation.redirect span', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

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

 const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');

 await page.goto(url);

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);

 expect(pageloadRequest.contexts?.trace?.op).toBe('pageload');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'pageload',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });

 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });

 const spans = pageloadRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );

 const navigationSpan = spans.find(span => span.op === 'navigation.redirect');
 expect(navigationSpan?.timestamp).toEqual(navigationSpan?.start_timestamp);
 expect(navigationSpan).toEqual({
 data: {
 'sentry.op': 'navigation.redirect',
 'sentry.origin': 'auto.navigation.browser',
 'sentry.source': 'url',
 },
 description: '/sub-page',
 op: 'navigation.redirect',
 origin: 'auto.navigation.browser',
 parent_span_id: pageloadRequest.contexts!.trace!.span_id,
 span_id: expect.any(String),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: expect.any(String),
 });
});

23 changes: 23 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
 // Trigger navigation later than click, so the last click is more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');

 // then trigger redirect inside of this navigation, which should be detected as a redirect
 // because the last click was more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page-redirect');
 }, 100);
 }, 400);
});

7 changes: 7 additions & 0 deletions
...suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1">Trigger navigation</button>
</html>

42 changes: 42 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should create a navigation.redirect span if a keypress happened more than 300ms before navigation',
 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',
 );

 await page.goto(url);

 await pageloadRequestPromise;

 // Now trigger navigation, and then a redirect in the navigation
 await page.focus('#btn1');
 await page.keyboard.press('Enter');

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 const spans = navigationRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 description: '/sub-page-redirect',
 }),
 );
 },
);

10 changes: 10 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

4 changes: 4 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
document.getElementById('btn1').addEventListener('click', () => {
 // trigger redirect immediately
 window.history.pushState({}, '', '/sub-page');
});

7 changes: 7 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1" type="button">Trigger navigation</button>
</html>

36 changes: 36 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should not create a navigation.redirect span if a keypress happened before navigation',
 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',
 );

 await page.goto(url);
 await page.focus('#btn1');
 await page.keyboard.press('Enter');

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
 // Ensure a navigation span is sent, too
 await navigationRequestPromise;

 const spans = pageloadRequest.spans || [];

 expect(spans).not.toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );
 },
);

14 changes: 14 additions & 0 deletions
...tegration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/late/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
});

// trigger redirect later
setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');
}, 400);
Loading

, '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
feat(v9/browser): Detect redirects when emitting navigation spans#16875

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

 Closed

mydea
wants to merge
1
commit into

from

 Closed


feat(v9/browser): Detect redirects when emitting navigation spans
#16875
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


3 changes: 2 additions & 1 deletion
...n-tests/suites/tracing/browserTracingIntegration/linked-traces/negatively-sampled/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 // We want to ignore redirects for this test
 integrations: [Sentry.browserTracingIntegration({ detectRedirects: false })],
 tracesSampler: ctx => {
 if (ctx.attributes['sentry.origin'] === 'auto.pageload.browser') {
 return 0;
Expand Down

9 changes: 6 additions & 3 deletions
...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@@ -4,9 +4,12 @@ window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 integrations: [Sentry.browserTracingIntegration({ idleTimeout: 2000 })],
 tracesSampleRate: 1,
});

// Immediately navigate to a new page to abort the pageload
window.history.pushState({}, '', '/sub-page');
// Navigate to a new page to abort the pageload
// We have to wait >300ms to avoid the redirect handling
setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');
}, 500);

23 changes: 23 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
 // Trigger navigation later than click, so the last click is more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');

 // then trigger redirect inside of this navigation, which should be detected as a redirect
 // because the last click was more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page-redirect');
 }, 100);
 }, 400);
});

7 changes: 7 additions & 0 deletions
...ts/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1">Trigger navigation</button>
</html>

41 changes: 41 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click-early/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should create a navigation.redirect span if a click happened more than 300ms before navigation',
 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',
 );

 await page.goto(url);

 await pageloadRequestPromise;

 // Now trigger navigation, and then a redirect in the navigation, with
 await page.click('#btn1');

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 const spans = navigationRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 description: '/sub-page-redirect',
 }),
 );
 },
);

10 changes: 10 additions & 0 deletions
...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

7 changes: 7 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
document.getElementById('btn1').addEventListener('click', () => {
 // trigger redirect immediately
 window.history.pushState({}, '', '/sub-page');
});

// Now trigger click, which should trigger navigation
document.getElementById('btn1').click();

7 changes: 7 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1" type="button">Trigger navigation</button>
</html>

34 changes: 34 additions & 0 deletions
...egration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/click/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should not create a navigation.redirect span if a click happened before navigation',
 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',
 );

 await page.goto(url);

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
 // Ensure a navigation span is sent, too
 await navigationRequestPromise;

 const spans = pageloadRequest.spans || [];

 expect(spans).not.toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );
 },
);

12 changes: 12 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
});

// trigger redirect immediately
window.history.pushState({}, '', '/sub-page');

66 changes: 66 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/immediately/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { expect } from '@playwright/test';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
} from '@sentry/core';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest('should create a pageload transaction with navigation.redirect span', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipTracingTest()) {
 sentryTest.skip();
 }

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

 const pageloadRequestPromise = waitForTransactionRequest(page, event => event.contexts?.trace?.op === 'pageload');

 await page.goto(url);

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);

 expect(pageloadRequest.contexts?.trace?.op).toBe('pageload');

 expect(pageloadRequest.contexts?.trace?.data).toMatchObject({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
 [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'pageload',
 ['sentry.idle_span_finish_reason']: 'idleTimeout',
 });

 expect(pageloadRequest.request).toEqual({
 headers: {
 'User-Agent': expect.any(String),
 },
 url: 'http://sentry-test.io/index.html',
 });

 const spans = pageloadRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );

 const navigationSpan = spans.find(span => span.op === 'navigation.redirect');
 expect(navigationSpan?.timestamp).toEqual(navigationSpan?.start_timestamp);
 expect(navigationSpan).toEqual({
 data: {
 'sentry.op': 'navigation.redirect',
 'sentry.origin': 'auto.navigation.browser',
 'sentry.source': 'url',
 },
 description: '/sub-page',
 op: 'navigation.redirect',
 origin: 'auto.navigation.browser',
 parent_span_id: pageloadRequest.contexts!.trace!.span_id,
 span_id: expect.any(String),
 start_timestamp: expect.any(Number),
 timestamp: expect.any(Number),
 trace_id: expect.any(String),
 });
});

23 changes: 23 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

document.getElementById('btn1').addEventListener('click', () => {
 // Trigger navigation later than click, so the last click is more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');

 // then trigger redirect inside of this navigation, which should be detected as a redirect
 // because the last click was more than 300ms ago
 setTimeout(() => {
 window.history.pushState({}, '', '/sub-page-redirect');
 }, 100);
 }, 400);
});

7 changes: 7 additions & 0 deletions
...suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1">Trigger navigation</button>
</html>

42 changes: 42 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress-early/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should create a navigation.redirect span if a keypress happened more than 300ms before navigation',
 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',
 );

 await page.goto(url);

 await pageloadRequestPromise;

 // Now trigger navigation, and then a redirect in the navigation
 await page.focus('#btn1');
 await page.keyboard.press('Enter');

 const navigationRequest = envelopeRequestParser(await navigationRequestPromise);

 expect(navigationRequest.contexts?.trace?.op).toBe('navigation');
 expect(navigationRequest.transaction).toEqual('/sub-page');

 const spans = navigationRequest.spans || [];

 expect(spans).toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 description: '/sub-page-redirect',
 }),
 );
 },
);

10 changes: 10 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
 debug: true,
});

4 changes: 4 additions & 0 deletions
...on-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
document.getElementById('btn1').addEventListener('click', () => {
 // trigger redirect immediately
 window.history.pushState({}, '', '/sub-page');
});

7 changes: 7 additions & 0 deletions
...tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <button id="btn1" type="button">Trigger navigation</button>
</html>

36 changes: 36 additions & 0 deletions
...ation-tests/suites/tracing/browserTracingIntegration/navigation-redirect/keypress/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect } from '@playwright/test';
import { sentryTest } from '../../../../../utils/fixtures';
import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';

sentryTest(
 'should not create a navigation.redirect span if a keypress happened before navigation',
 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',
 );

 await page.goto(url);
 await page.focus('#btn1');
 await page.keyboard.press('Enter');

 const pageloadRequest = envelopeRequestParser(await pageloadRequestPromise);
 // Ensure a navigation span is sent, too
 await navigationRequestPromise;

 const spans = pageloadRequest.spans || [];

 expect(spans).not.toContainEqual(
 expect.objectContaining({
 op: 'navigation.redirect',
 }),
 );
 },
);

14 changes: 14 additions & 0 deletions
...tegration-tests/suites/tracing/browserTracingIntegration/navigation-redirect/late/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 integrations: [Sentry.browserTracingIntegration()],
 tracesSampleRate: 1,
});

// trigger redirect later
setTimeout(() => {
 window.history.pushState({}, '', '/sub-page');
}, 400);
Loading