Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import * as Sentry from '@sentry/nextjs';

Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@ import * as Sentry from '@sentry/nextjs';
export function register() {
if (process.env.NEXT_RUNTIME === 'nodejs' || process.env.NEXT_RUNTIME === 'edge') {
Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForStreamedSpan, waitForStreamedSpans } from '@sentry-internal/test-utils';

// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL transaction and the
// transaction created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never
// both. This guards against regressing back to duplicate root transactions for the same API route.
test('Sends exactly one transaction for a pages-router API route', async ({ request }) => {
const apiRouteTransactions: string[] = [];
// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL span and the span
// created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never both.
// This guards against regressing back to duplicate segment spans for the same API route.
test('Sends exactly one segment span for a pages-router API route', async ({ request }) => {
const apiRouteSegmentSpans: string[] = [];

// Accumulate every matching transaction and assert on the total after a grace period. This predicate never
// Accumulate every matching span and assert on the total after a grace period. This predicate never
// returns true, so the promise never resolves; we just let it collect while we wait out the grace period.
void waitForTransaction('nextjs-pages-dir', transactionEvent => {
if (transactionEvent?.transaction === 'GET /api/endpoint') {
apiRouteTransactions.push(transactionEvent.contexts?.trace?.trace_id ?? '<no-trace-id>');
void waitForStreamedSpans('nextjs-pages-dir', spans => {
for (const span of spans) {
if (span.name === 'GET /api/endpoint' && span.is_segment) {
apiRouteSegmentSpans.push(span.trace_id);
}
}
return false;
});
Expand All@@ -21,21 +23,21 @@ test('Sends exactly one transaction for a pages-router API route', async ({ requ

await new Promise(resolve => setTimeout(resolve, 6000));

expect(apiRouteTransactions).toHaveLength(1);
expect(apiRouteSegmentSpans).toHaveLength(1);
});

test('Sends a well-formed transaction for a node-runtime pages-router API route', async ({ request }) => {
const transactionPromise = waitForTransaction('nextjs-pages-dir', transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint' && transactionEvent.contexts?.runtime?.name === 'node';
test('Sends a well-formed span for a node-runtime pages-router API route', async ({ request }) => {
const spanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/endpoint' && span.is_segment;
});

const response = await request.get('/api/endpoint');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const transaction = await transactionPromise;
const span = await spanPromise;

expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.contexts?.trace?.status).toBe('ok');
expect(transaction.transaction_info?.source).toBe('route');
expect(transaction.contexts?.trace?.data?.['http.route']).toBe('/api/endpoint');
expect(getSpanOp(span)).toBe('http.server');
expect(span.status).toBe('ok');
expect(span.attributes['sentry.segment.name.source']?.value).toBe('route');
expect(span.attributes['http.route']?.value).toBe('/api/endpoint');
});
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans } from '@sentry-internal/test-utils';

test('Should allow for async context isolation in the edge SDK', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/async-context-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
});
// The inner and outer spans are children of the segment span, which ends last, so accumulate until
// the segment arrives to be sure both children are in hand.
const spansPromise = collectStreamedSpans('nextjs-pages-dir', spans =>
spans.some(span => span.name === 'GET /api/async-context-edge-endpoint' && span.is_segment),
);

await request.get('/api/async-context-edge-endpoint');

const asyncContextEdgerouteTransaction = await edgerouteTransactionPromise;
const spans = await spansPromise;

const outerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'outer-span');
const innerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'inner-span');
const outerSpan = spans.find(span => span.name === 'outer-span');
const innerSpan = spans.find(span => span.name === 'inner-span');

expect(outerSpan).toBeDefined();
expect(innerSpan).toBeDefined();
expect(outerSpan?.parent_span_id).toStrictEqual(innerSpan?.parent_span_id);
});
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
test('Should create a span for edge routes', async ({ request }) => {
// The route is only served by the edge runtime, so the span name identifies it on its own. The
// transaction-based test additionally matched on `contexts.runtime.name`, which span v2 does not carry.
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/edge-endpoint' && span.is_segment;
});

const response = await request.get('/api/edge-endpoint', {
Expand All@@ -16,19 +15,17 @@ test('Should create a transaction for edge routes', async ({ request }) => {
});
expect(await response.json()).toStrictEqual({ name: 'Jim Halpert' });

const edgerouteTransaction = await edgerouteTransactionPromise;
const edgerouteSpan = await edgerouteSpanPromise;

expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
expect(edgerouteTransaction.request?.headers?.['x-yeet']).toBe('test-value');
expect(edgerouteSpan.status).toBe('ok');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
// The `x-yeet` request header is not asserted here: the edge runtime emits this segment span without
// request headers, and they land on a sibling Node-side span in a separate trace.
});

test('Faulty edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/error-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/error-edge-endpoint' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -42,19 +39,19 @@ test('Faulty edge routes', async ({ request }) => {
// Noop
});

const [edgerouteTransaction, errorEvent] = await Promise.all([
test.step('should create a transaction', () => edgerouteTransactionPromise),
const [edgerouteSpan, errorEvent] = await Promise.all([
test.step('should create a span', () => edgerouteSpanPromise),
test.step('should create an error event', () => errorEventPromise),
]);

test.step('should create transactions with the right fields', () => {
expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
test.step('should create spans with the right fields', () => {
expect(edgerouteSpan.status).toBe('error');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
});

test.step('should have scope isolation', () => {
expect(edgerouteTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(edgerouteTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
// Span v2 carries no scope tags, so isolation is only asserted on the error event; the span-side
// assertions were dropped in the streaming port.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans, getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
test('Should create a span for middleware', async ({ request }) => {
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const response = await request.get('/api/endpoint-behind-middleware');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const middlewareTransaction = await middlewareTransactionPromise;
const middlewareSpan = await middlewareSpanPromise;

expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
expect(middlewareSpan.status).toBe('ok');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

test('Faulty middlewares', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -34,12 +29,11 @@ test('Faulty middlewares', async ({ request }) => {
// Noop
});

await test.step('should record transactions', async () => {
const middlewareTransaction = await middlewareTransactionPromise;
expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');
await test.step('should record spans', async () => {
const middlewareSpan = await middlewareSpanPromise;
expect(middlewareSpan.status).toBe('error');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

await test.step('should record exceptions', async () => {
Expand All@@ -52,54 +46,37 @@ test('Faulty middlewares', async ({ request }) => {
});
});

test('Should trace outgoing fetch requests inside middleware and create breadcrumbs for it', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
!!transactionEvent.spans?.find(span => span.op === 'http.client')
);
});
test('Should trace outgoing fetch requests inside middleware', async ({ request }) => {
// The fetch span is a child of the middleware segment span, which ends last, so accumulate until
// the segment arrives.
const spansPromise = collectStreamedSpans(
'nextjs-pages-dir',
spans =>
spans.some(span => span.name === 'middleware GET' && span.is_segment) &&
spans.some(span => getSpanOp(span) === 'http.client'),
);

request.get('/api/endpoint-behind-middleware', { headers: { 'x-should-make-request': '1' } }).catch(() => {
// Noop
});

const middlewareTransaction = await middlewareTransactionPromise;
const spans = await spansPromise;
const fetchSpan = spans.find(span => getSpanOp(span) === 'http.client')!;

expect(middlewareTransaction.spans).toEqual(
expect.arrayContaining([
{
data: {
'http.request.method': 'GET',
'http.response.status_code': 200,
type: 'fetch',
'url.full': 'http://localhost:3030/',
'url.domain': 'localhost',
'server.address': 'localhost',
'server.port': 3030,
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.wintercg_fetch',
},
description: 'GET http://localhost:3030/',
op: 'http.client',
origin: 'auto.http.wintercg_fetch',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
status: 'ok',
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
},
]),
);
expect(middlewareTransaction.breadcrumbs).toEqual(
expect.arrayContaining([
{
category: 'fetch',
data: { method: 'GET', status_code: 200, url: 'http://localhost:3030/' },
timestamp: expect.any(Number),
type: 'http',
},
]),
);
// `http.client` span names are low cardinality under span streaming, so the name is the method and
// host rather than the full URL. The URL itself is still asserted below via `url.full`.
expect(fetchSpan.name).toBe('GET localhost');
expect(fetchSpan.status).toBe('ok');
expect(fetchSpan.parent_span_id).toEqual(expect.stringMatching(/[a-f0-9]{16}/));
expect(fetchSpan.attributes).toMatchObject({
'http.request.method': { value: 'GET', type: 'string' },
'http.response.status_code': { value: 200, type: 'integer' },
type: { value: 'fetch', type: 'string' },
'url.full': { value: 'http://localhost:3030/', type: 'string' },
'url.domain': { value: 'localhost', type: 'string' },
'server.address': { value: 'localhost', type: 'string' },
'server.port': { value: 3030, type: 'integer' },
'sentry.op': { value: 'http.client', type: 'string' },
'sentry.origin': { value: 'auto.http.wintercg_fetch', type: 'string' },
});
});
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,48 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Will capture error for SSR rendering error with a connected trace (Class Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error Class';
});

const serverComponentTransaction = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const serverComponentSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-class' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-class' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-class');

expect(await errorEventPromise).toBeDefined();
expect(await serverComponentTransaction).toBeDefined();
expect(await serverComponentSpanPromise).toBeDefined();
});

test('Will capture error for SSR rendering error with a connected trace (Functional Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error FC';
});

const ssrTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const ssrSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-fc' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-fc' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-fc');

const errorEvent = await errorEventPromise;
const ssrTransaction = await ssrTransactionPromise;
await ssrSpanPromise;

// Assert that isolation scope works properly
// Assert that isolation scope works properly. Span v2 carries no scope tags, so this is only
// asserted on the error event.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// TODO(lforst): Reuse SSR request span isolation scope to fix the following two assertions
// expect(ssrTransaction.tags?.['my-isolated-tag']).toBe(true);
// expect(ssrTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
handled: false,
type: 'auto.function.nextjs.page_function',
Expand Down
Loading
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import * as Sentry from '@sentry/nextjs';

Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@ import * as Sentry from '@sentry/nextjs';
export function register() {
if (process.env.NEXT_RUNTIME === 'nodejs' || process.env.NEXT_RUNTIME === 'edge') {
Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForStreamedSpan, waitForStreamedSpans } from '@sentry-internal/test-utils';

// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL transaction and the
// transaction created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never
// both. This guards against regressing back to duplicate root transactions for the same API route.
test('Sends exactly one transaction for a pages-router API route', async ({ request }) => {
const apiRouteTransactions: string[] = [];
// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL span and the span
// created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never both.
// This guards against regressing back to duplicate segment spans for the same API route.
test('Sends exactly one segment span for a pages-router API route', async ({ request }) => {
const apiRouteSegmentSpans: string[] = [];

// Accumulate every matching transaction and assert on the total after a grace period. This predicate never
// Accumulate every matching span and assert on the total after a grace period. This predicate never
// returns true, so the promise never resolves; we just let it collect while we wait out the grace period.
void waitForTransaction('nextjs-pages-dir', transactionEvent => {
if (transactionEvent?.transaction === 'GET /api/endpoint') {
apiRouteTransactions.push(transactionEvent.contexts?.trace?.trace_id ?? '<no-trace-id>');
void waitForStreamedSpans('nextjs-pages-dir', spans => {
for (const span of spans) {
if (span.name === 'GET /api/endpoint' && span.is_segment) {
apiRouteSegmentSpans.push(span.trace_id);
}
}
return false;
});
Expand All@@ -21,21 +23,21 @@ test('Sends exactly one transaction for a pages-router API route', async ({ requ

await new Promise(resolve => setTimeout(resolve, 6000));

expect(apiRouteTransactions).toHaveLength(1);
expect(apiRouteSegmentSpans).toHaveLength(1);
});

test('Sends a well-formed transaction for a node-runtime pages-router API route', async ({ request }) => {
const transactionPromise = waitForTransaction('nextjs-pages-dir', transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint' && transactionEvent.contexts?.runtime?.name === 'node';
test('Sends a well-formed span for a node-runtime pages-router API route', async ({ request }) => {
const spanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/endpoint' && span.is_segment;
});

const response = await request.get('/api/endpoint');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const transaction = await transactionPromise;
const span = await spanPromise;

expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.contexts?.trace?.status).toBe('ok');
expect(transaction.transaction_info?.source).toBe('route');
expect(transaction.contexts?.trace?.data?.['http.route']).toBe('/api/endpoint');
expect(getSpanOp(span)).toBe('http.server');
expect(span.status).toBe('ok');
expect(span.attributes['sentry.segment.name.source']?.value).toBe('route');
expect(span.attributes['http.route']?.value).toBe('/api/endpoint');
});
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans } from '@sentry-internal/test-utils';

test('Should allow for async context isolation in the edge SDK', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/async-context-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
});
// The inner and outer spans are children of the segment span, which ends last, so accumulate until
// the segment arrives to be sure both children are in hand.
const spansPromise = collectStreamedSpans('nextjs-pages-dir', spans =>
spans.some(span => span.name === 'GET /api/async-context-edge-endpoint' && span.is_segment),
);

await request.get('/api/async-context-edge-endpoint');

const asyncContextEdgerouteTransaction = await edgerouteTransactionPromise;
const spans = await spansPromise;

const outerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'outer-span');
const innerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'inner-span');
const outerSpan = spans.find(span => span.name === 'outer-span');
const innerSpan = spans.find(span => span.name === 'inner-span');

expect(outerSpan).toBeDefined();
expect(innerSpan).toBeDefined();
expect(outerSpan?.parent_span_id).toStrictEqual(innerSpan?.parent_span_id);
});
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
test('Should create a span for edge routes', async ({ request }) => {
// The route is only served by the edge runtime, so the span name identifies it on its own. The
// transaction-based test additionally matched on `contexts.runtime.name`, which span v2 does not carry.
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/edge-endpoint' && span.is_segment;
});

const response = await request.get('/api/edge-endpoint', {
Expand All@@ -16,19 +15,17 @@ test('Should create a transaction for edge routes', async ({ request }) => {
});
expect(await response.json()).toStrictEqual({ name: 'Jim Halpert' });

const edgerouteTransaction = await edgerouteTransactionPromise;
const edgerouteSpan = await edgerouteSpanPromise;

expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
expect(edgerouteTransaction.request?.headers?.['x-yeet']).toBe('test-value');
expect(edgerouteSpan.status).toBe('ok');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
// The `x-yeet` request header is not asserted here: the edge runtime emits this segment span without
// request headers, and they land on a sibling Node-side span in a separate trace.
});

test('Faulty edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/error-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/error-edge-endpoint' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -42,19 +39,19 @@ test('Faulty edge routes', async ({ request }) => {
// Noop
});

const [edgerouteTransaction, errorEvent] = await Promise.all([
test.step('should create a transaction', () => edgerouteTransactionPromise),
const [edgerouteSpan, errorEvent] = await Promise.all([
test.step('should create a span', () => edgerouteSpanPromise),
test.step('should create an error event', () => errorEventPromise),
]);

test.step('should create transactions with the right fields', () => {
expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
test.step('should create spans with the right fields', () => {
expect(edgerouteSpan.status).toBe('error');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
});

test.step('should have scope isolation', () => {
expect(edgerouteTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(edgerouteTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
// Span v2 carries no scope tags, so isolation is only asserted on the error event; the span-side
// assertions were dropped in the streaming port.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans, getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
test('Should create a span for middleware', async ({ request }) => {
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const response = await request.get('/api/endpoint-behind-middleware');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const middlewareTransaction = await middlewareTransactionPromise;
const middlewareSpan = await middlewareSpanPromise;

expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
expect(middlewareSpan.status).toBe('ok');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

test('Faulty middlewares', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -34,12 +29,11 @@ test('Faulty middlewares', async ({ request }) => {
// Noop
});

await test.step('should record transactions', async () => {
const middlewareTransaction = await middlewareTransactionPromise;
expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');
await test.step('should record spans', async () => {
const middlewareSpan = await middlewareSpanPromise;
expect(middlewareSpan.status).toBe('error');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

await test.step('should record exceptions', async () => {
Expand All@@ -52,54 +46,37 @@ test('Faulty middlewares', async ({ request }) => {
});
});

test('Should trace outgoing fetch requests inside middleware and create breadcrumbs for it', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
!!transactionEvent.spans?.find(span => span.op === 'http.client')
);
});
test('Should trace outgoing fetch requests inside middleware', async ({ request }) => {
// The fetch span is a child of the middleware segment span, which ends last, so accumulate until
// the segment arrives.
const spansPromise = collectStreamedSpans(
'nextjs-pages-dir',
spans =>
spans.some(span => span.name === 'middleware GET' && span.is_segment) &&
spans.some(span => getSpanOp(span) === 'http.client'),
);

request.get('/api/endpoint-behind-middleware', { headers: { 'x-should-make-request': '1' } }).catch(() => {
// Noop
});

const middlewareTransaction = await middlewareTransactionPromise;
const spans = await spansPromise;
const fetchSpan = spans.find(span => getSpanOp(span) === 'http.client')!;

expect(middlewareTransaction.spans).toEqual(
expect.arrayContaining([
{
data: {
'http.request.method': 'GET',
'http.response.status_code': 200,
type: 'fetch',
'url.full': 'http://localhost:3030/',
'url.domain': 'localhost',
'server.address': 'localhost',
'server.port': 3030,
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.wintercg_fetch',
},
description: 'GET http://localhost:3030/',
op: 'http.client',
origin: 'auto.http.wintercg_fetch',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
status: 'ok',
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
},
]),
);
expect(middlewareTransaction.breadcrumbs).toEqual(
expect.arrayContaining([
{
category: 'fetch',
data: { method: 'GET', status_code: 200, url: 'http://localhost:3030/' },
timestamp: expect.any(Number),
type: 'http',
},
]),
);
// `http.client` span names are low cardinality under span streaming, so the name is the method and
// host rather than the full URL. The URL itself is still asserted below via `url.full`.
expect(fetchSpan.name).toBe('GET localhost');
expect(fetchSpan.status).toBe('ok');
expect(fetchSpan.parent_span_id).toEqual(expect.stringMatching(/[a-f0-9]{16}/));
expect(fetchSpan.attributes).toMatchObject({
'http.request.method': { value: 'GET', type: 'string' },
'http.response.status_code': { value: 200, type: 'integer' },
type: { value: 'fetch', type: 'string' },
'url.full': { value: 'http://localhost:3030/', type: 'string' },
'url.domain': { value: 'localhost', type: 'string' },
'server.address': { value: 'localhost', type: 'string' },
'server.port': { value: 3030, type: 'integer' },
'sentry.op': { value: 'http.client', type: 'string' },
'sentry.origin': { value: 'auto.http.wintercg_fetch', type: 'string' },
});
});
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,48 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Will capture error for SSR rendering error with a connected trace (Class Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error Class';
});

const serverComponentTransaction = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const serverComponentSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-class' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-class' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-class');

expect(await errorEventPromise).toBeDefined();
expect(await serverComponentTransaction).toBeDefined();
expect(await serverComponentSpanPromise).toBeDefined();
});

test('Will capture error for SSR rendering error with a connected trace (Functional Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error FC';
});

const ssrTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const ssrSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-fc' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-fc' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-fc');

const errorEvent = await errorEventPromise;
const ssrTransaction = await ssrTransactionPromise;
await ssrSpanPromise;

// Assert that isolation scope works properly
// Assert that isolation scope works properly. Span v2 carries no scope tags, so this is only
// asserted on the error event.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// TODO(lforst): Reuse SSR request span isolation scope to fix the following two assertions
// expect(ssrTransaction.tags?.['my-isolated-tag']).toBe(true);
// expect(ssrTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
handled: false,
type: 'auto.function.nextjs.page_function',
Expand Down
Loading
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import * as Sentry from '@sentry/nextjs';

Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@ import * as Sentry from '@sentry/nextjs';
export function register() {
if (process.env.NEXT_RUNTIME === 'nodejs' || process.env.NEXT_RUNTIME === 'edge') {
Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForStreamedSpan, waitForStreamedSpans } from '@sentry-internal/test-utils';

// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL transaction and the
// transaction created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never
// both. This guards against regressing back to duplicate root transactions for the same API route.
test('Sends exactly one transaction for a pages-router API route', async ({ request }) => {
const apiRouteTransactions: string[] = [];
// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL span and the span
// created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never both.
// This guards against regressing back to duplicate segment spans for the same API route.
test('Sends exactly one segment span for a pages-router API route', async ({ request }) => {
const apiRouteSegmentSpans: string[] = [];

// Accumulate every matching transaction and assert on the total after a grace period. This predicate never
// Accumulate every matching span and assert on the total after a grace period. This predicate never
// returns true, so the promise never resolves; we just let it collect while we wait out the grace period.
void waitForTransaction('nextjs-pages-dir', transactionEvent => {
if (transactionEvent?.transaction === 'GET /api/endpoint') {
apiRouteTransactions.push(transactionEvent.contexts?.trace?.trace_id ?? '<no-trace-id>');
void waitForStreamedSpans('nextjs-pages-dir', spans => {
for (const span of spans) {
if (span.name === 'GET /api/endpoint' && span.is_segment) {
apiRouteSegmentSpans.push(span.trace_id);
}
}
return false;
});
Expand All@@ -21,21 +23,21 @@ test('Sends exactly one transaction for a pages-router API route', async ({ requ

await new Promise(resolve => setTimeout(resolve, 6000));

expect(apiRouteTransactions).toHaveLength(1);
expect(apiRouteSegmentSpans).toHaveLength(1);
});

test('Sends a well-formed transaction for a node-runtime pages-router API route', async ({ request }) => {
const transactionPromise = waitForTransaction('nextjs-pages-dir', transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint' && transactionEvent.contexts?.runtime?.name === 'node';
test('Sends a well-formed span for a node-runtime pages-router API route', async ({ request }) => {
const spanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/endpoint' && span.is_segment;
});

const response = await request.get('/api/endpoint');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const transaction = await transactionPromise;
const span = await spanPromise;

expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.contexts?.trace?.status).toBe('ok');
expect(transaction.transaction_info?.source).toBe('route');
expect(transaction.contexts?.trace?.data?.['http.route']).toBe('/api/endpoint');
expect(getSpanOp(span)).toBe('http.server');
expect(span.status).toBe('ok');
expect(span.attributes['sentry.segment.name.source']?.value).toBe('route');
expect(span.attributes['http.route']?.value).toBe('/api/endpoint');
});
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans } from '@sentry-internal/test-utils';

test('Should allow for async context isolation in the edge SDK', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/async-context-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
});
// The inner and outer spans are children of the segment span, which ends last, so accumulate until
// the segment arrives to be sure both children are in hand.
const spansPromise = collectStreamedSpans('nextjs-pages-dir', spans =>
spans.some(span => span.name === 'GET /api/async-context-edge-endpoint' && span.is_segment),
);

await request.get('/api/async-context-edge-endpoint');

const asyncContextEdgerouteTransaction = await edgerouteTransactionPromise;
const spans = await spansPromise;

const outerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'outer-span');
const innerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'inner-span');
const outerSpan = spans.find(span => span.name === 'outer-span');
const innerSpan = spans.find(span => span.name === 'inner-span');

expect(outerSpan).toBeDefined();
expect(innerSpan).toBeDefined();
expect(outerSpan?.parent_span_id).toStrictEqual(innerSpan?.parent_span_id);
});
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
test('Should create a span for edge routes', async ({ request }) => {
// The route is only served by the edge runtime, so the span name identifies it on its own. The
// transaction-based test additionally matched on `contexts.runtime.name`, which span v2 does not carry.
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/edge-endpoint' && span.is_segment;
});

const response = await request.get('/api/edge-endpoint', {
Expand All@@ -16,19 +15,17 @@ test('Should create a transaction for edge routes', async ({ request }) => {
});
expect(await response.json()).toStrictEqual({ name: 'Jim Halpert' });

const edgerouteTransaction = await edgerouteTransactionPromise;
const edgerouteSpan = await edgerouteSpanPromise;

expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
expect(edgerouteTransaction.request?.headers?.['x-yeet']).toBe('test-value');
expect(edgerouteSpan.status).toBe('ok');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
// The `x-yeet` request header is not asserted here: the edge runtime emits this segment span without
// request headers, and they land on a sibling Node-side span in a separate trace.
});

test('Faulty edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/error-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/error-edge-endpoint' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -42,19 +39,19 @@ test('Faulty edge routes', async ({ request }) => {
// Noop
});

const [edgerouteTransaction, errorEvent] = await Promise.all([
test.step('should create a transaction', () => edgerouteTransactionPromise),
const [edgerouteSpan, errorEvent] = await Promise.all([
test.step('should create a span', () => edgerouteSpanPromise),
test.step('should create an error event', () => errorEventPromise),
]);

test.step('should create transactions with the right fields', () => {
expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
test.step('should create spans with the right fields', () => {
expect(edgerouteSpan.status).toBe('error');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
});

test.step('should have scope isolation', () => {
expect(edgerouteTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(edgerouteTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
// Span v2 carries no scope tags, so isolation is only asserted on the error event; the span-side
// assertions were dropped in the streaming port.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans, getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
test('Should create a span for middleware', async ({ request }) => {
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const response = await request.get('/api/endpoint-behind-middleware');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const middlewareTransaction = await middlewareTransactionPromise;
const middlewareSpan = await middlewareSpanPromise;

expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
expect(middlewareSpan.status).toBe('ok');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

test('Faulty middlewares', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -34,12 +29,11 @@ test('Faulty middlewares', async ({ request }) => {
// Noop
});

await test.step('should record transactions', async () => {
const middlewareTransaction = await middlewareTransactionPromise;
expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');
await test.step('should record spans', async () => {
const middlewareSpan = await middlewareSpanPromise;
expect(middlewareSpan.status).toBe('error');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

await test.step('should record exceptions', async () => {
Expand All@@ -52,54 +46,37 @@ test('Faulty middlewares', async ({ request }) => {
});
});

test('Should trace outgoing fetch requests inside middleware and create breadcrumbs for it', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
!!transactionEvent.spans?.find(span => span.op === 'http.client')
);
});
test('Should trace outgoing fetch requests inside middleware', async ({ request }) => {
// The fetch span is a child of the middleware segment span, which ends last, so accumulate until
// the segment arrives.
const spansPromise = collectStreamedSpans(
'nextjs-pages-dir',
spans =>
spans.some(span => span.name === 'middleware GET' && span.is_segment) &&
spans.some(span => getSpanOp(span) === 'http.client'),
);

request.get('/api/endpoint-behind-middleware', { headers: { 'x-should-make-request': '1' } }).catch(() => {
// Noop
});

const middlewareTransaction = await middlewareTransactionPromise;
const spans = await spansPromise;
const fetchSpan = spans.find(span => getSpanOp(span) === 'http.client')!;

expect(middlewareTransaction.spans).toEqual(
expect.arrayContaining([
{
data: {
'http.request.method': 'GET',
'http.response.status_code': 200,
type: 'fetch',
'url.full': 'http://localhost:3030/',
'url.domain': 'localhost',
'server.address': 'localhost',
'server.port': 3030,
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.wintercg_fetch',
},
description: 'GET http://localhost:3030/',
op: 'http.client',
origin: 'auto.http.wintercg_fetch',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
status: 'ok',
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
},
]),
);
expect(middlewareTransaction.breadcrumbs).toEqual(
expect.arrayContaining([
{
category: 'fetch',
data: { method: 'GET', status_code: 200, url: 'http://localhost:3030/' },
timestamp: expect.any(Number),
type: 'http',
},
]),
);
// `http.client` span names are low cardinality under span streaming, so the name is the method and
// host rather than the full URL. The URL itself is still asserted below via `url.full`.
expect(fetchSpan.name).toBe('GET localhost');
expect(fetchSpan.status).toBe('ok');
expect(fetchSpan.parent_span_id).toEqual(expect.stringMatching(/[a-f0-9]{16}/));
expect(fetchSpan.attributes).toMatchObject({
'http.request.method': { value: 'GET', type: 'string' },
'http.response.status_code': { value: 200, type: 'integer' },
type: { value: 'fetch', type: 'string' },
'url.full': { value: 'http://localhost:3030/', type: 'string' },
'url.domain': { value: 'localhost', type: 'string' },
'server.address': { value: 'localhost', type: 'string' },
'server.port': { value: 3030, type: 'integer' },
'sentry.op': { value: 'http.client', type: 'string' },
'sentry.origin': { value: 'auto.http.wintercg_fetch', type: 'string' },
});
});
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,48 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Will capture error for SSR rendering error with a connected trace (Class Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error Class';
});

const serverComponentTransaction = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const serverComponentSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-class' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-class' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-class');

expect(await errorEventPromise).toBeDefined();
expect(await serverComponentTransaction).toBeDefined();
expect(await serverComponentSpanPromise).toBeDefined();
});

test('Will capture error for SSR rendering error with a connected trace (Functional Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error FC';
});

const ssrTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const ssrSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-fc' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-fc' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-fc');

const errorEvent = await errorEventPromise;
const ssrTransaction = await ssrTransactionPromise;
await ssrSpanPromise;

// Assert that isolation scope works properly
// Assert that isolation scope works properly. Span v2 carries no scope tags, so this is only
// asserted on the error event.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// TODO(lforst): Reuse SSR request span isolation scope to fix the following two assertions
// expect(ssrTransaction.tags?.['my-isolated-tag']).toBe(true);
// expect(ssrTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
handled: false,
type: 'auto.function.nextjs.page_function',
Expand Down
Loading
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import * as Sentry from '@sentry/nextjs';

Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@ import * as Sentry from '@sentry/nextjs';
export function register() {
if (process.env.NEXT_RUNTIME === 'nodejs' || process.env.NEXT_RUNTIME === 'edge') {
Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForStreamedSpan, waitForStreamedSpans } from '@sentry-internal/test-utils';

// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL transaction and the
// transaction created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never
// both. This guards against regressing back to duplicate root transactions for the same API route.
test('Sends exactly one transaction for a pages-router API route', async ({ request }) => {
const apiRouteTransactions: string[] = [];
// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL span and the span
// created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never both.
// This guards against regressing back to duplicate segment spans for the same API route.
test('Sends exactly one segment span for a pages-router API route', async ({ request }) => {
const apiRouteSegmentSpans: string[] = [];

// Accumulate every matching transaction and assert on the total after a grace period. This predicate never
// Accumulate every matching span and assert on the total after a grace period. This predicate never
// returns true, so the promise never resolves; we just let it collect while we wait out the grace period.
void waitForTransaction('nextjs-pages-dir', transactionEvent => {
if (transactionEvent?.transaction === 'GET /api/endpoint') {
apiRouteTransactions.push(transactionEvent.contexts?.trace?.trace_id ?? '<no-trace-id>');
void waitForStreamedSpans('nextjs-pages-dir', spans => {
for (const span of spans) {
if (span.name === 'GET /api/endpoint' && span.is_segment) {
apiRouteSegmentSpans.push(span.trace_id);
}
}
return false;
});
Expand All@@ -21,21 +23,21 @@ test('Sends exactly one transaction for a pages-router API route', async ({ requ

await new Promise(resolve => setTimeout(resolve, 6000));

expect(apiRouteTransactions).toHaveLength(1);
expect(apiRouteSegmentSpans).toHaveLength(1);
});

test('Sends a well-formed transaction for a node-runtime pages-router API route', async ({ request }) => {
const transactionPromise = waitForTransaction('nextjs-pages-dir', transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint' && transactionEvent.contexts?.runtime?.name === 'node';
test('Sends a well-formed span for a node-runtime pages-router API route', async ({ request }) => {
const spanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/endpoint' && span.is_segment;
});

const response = await request.get('/api/endpoint');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const transaction = await transactionPromise;
const span = await spanPromise;

expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.contexts?.trace?.status).toBe('ok');
expect(transaction.transaction_info?.source).toBe('route');
expect(transaction.contexts?.trace?.data?.['http.route']).toBe('/api/endpoint');
expect(getSpanOp(span)).toBe('http.server');
expect(span.status).toBe('ok');
expect(span.attributes['sentry.segment.name.source']?.value).toBe('route');
expect(span.attributes['http.route']?.value).toBe('/api/endpoint');
});
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans } from '@sentry-internal/test-utils';

test('Should allow for async context isolation in the edge SDK', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/async-context-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
});
// The inner and outer spans are children of the segment span, which ends last, so accumulate until
// the segment arrives to be sure both children are in hand.
const spansPromise = collectStreamedSpans('nextjs-pages-dir', spans =>
spans.some(span => span.name === 'GET /api/async-context-edge-endpoint' && span.is_segment),
);

await request.get('/api/async-context-edge-endpoint');

const asyncContextEdgerouteTransaction = await edgerouteTransactionPromise;
const spans = await spansPromise;

const outerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'outer-span');
const innerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'inner-span');
const outerSpan = spans.find(span => span.name === 'outer-span');
const innerSpan = spans.find(span => span.name === 'inner-span');

expect(outerSpan).toBeDefined();
expect(innerSpan).toBeDefined();
expect(outerSpan?.parent_span_id).toStrictEqual(innerSpan?.parent_span_id);
});
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
test('Should create a span for edge routes', async ({ request }) => {
// The route is only served by the edge runtime, so the span name identifies it on its own. The
// transaction-based test additionally matched on `contexts.runtime.name`, which span v2 does not carry.
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/edge-endpoint' && span.is_segment;
});

const response = await request.get('/api/edge-endpoint', {
Expand All@@ -16,19 +15,17 @@ test('Should create a transaction for edge routes', async ({ request }) => {
});
expect(await response.json()).toStrictEqual({ name: 'Jim Halpert' });

const edgerouteTransaction = await edgerouteTransactionPromise;
const edgerouteSpan = await edgerouteSpanPromise;

expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
expect(edgerouteTransaction.request?.headers?.['x-yeet']).toBe('test-value');
expect(edgerouteSpan.status).toBe('ok');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
// The `x-yeet` request header is not asserted here: the edge runtime emits this segment span without
// request headers, and they land on a sibling Node-side span in a separate trace.
});

test('Faulty edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/error-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/error-edge-endpoint' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -42,19 +39,19 @@ test('Faulty edge routes', async ({ request }) => {
// Noop
});

const [edgerouteTransaction, errorEvent] = await Promise.all([
test.step('should create a transaction', () => edgerouteTransactionPromise),
const [edgerouteSpan, errorEvent] = await Promise.all([
test.step('should create a span', () => edgerouteSpanPromise),
test.step('should create an error event', () => errorEventPromise),
]);

test.step('should create transactions with the right fields', () => {
expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
test.step('should create spans with the right fields', () => {
expect(edgerouteSpan.status).toBe('error');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
});

test.step('should have scope isolation', () => {
expect(edgerouteTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(edgerouteTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
// Span v2 carries no scope tags, so isolation is only asserted on the error event; the span-side
// assertions were dropped in the streaming port.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans, getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
test('Should create a span for middleware', async ({ request }) => {
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const response = await request.get('/api/endpoint-behind-middleware');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const middlewareTransaction = await middlewareTransactionPromise;
const middlewareSpan = await middlewareSpanPromise;

expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
expect(middlewareSpan.status).toBe('ok');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

test('Faulty middlewares', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -34,12 +29,11 @@ test('Faulty middlewares', async ({ request }) => {
// Noop
});

await test.step('should record transactions', async () => {
const middlewareTransaction = await middlewareTransactionPromise;
expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');
await test.step('should record spans', async () => {
const middlewareSpan = await middlewareSpanPromise;
expect(middlewareSpan.status).toBe('error');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

await test.step('should record exceptions', async () => {
Expand All@@ -52,54 +46,37 @@ test('Faulty middlewares', async ({ request }) => {
});
});

test('Should trace outgoing fetch requests inside middleware and create breadcrumbs for it', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
!!transactionEvent.spans?.find(span => span.op === 'http.client')
);
});
test('Should trace outgoing fetch requests inside middleware', async ({ request }) => {
// The fetch span is a child of the middleware segment span, which ends last, so accumulate until
// the segment arrives.
const spansPromise = collectStreamedSpans(
'nextjs-pages-dir',
spans =>
spans.some(span => span.name === 'middleware GET' && span.is_segment) &&
spans.some(span => getSpanOp(span) === 'http.client'),
);

request.get('/api/endpoint-behind-middleware', { headers: { 'x-should-make-request': '1' } }).catch(() => {
// Noop
});

const middlewareTransaction = await middlewareTransactionPromise;
const spans = await spansPromise;
const fetchSpan = spans.find(span => getSpanOp(span) === 'http.client')!;

expect(middlewareTransaction.spans).toEqual(
expect.arrayContaining([
{
data: {
'http.request.method': 'GET',
'http.response.status_code': 200,
type: 'fetch',
'url.full': 'http://localhost:3030/',
'url.domain': 'localhost',
'server.address': 'localhost',
'server.port': 3030,
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.wintercg_fetch',
},
description: 'GET http://localhost:3030/',
op: 'http.client',
origin: 'auto.http.wintercg_fetch',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
status: 'ok',
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
},
]),
);
expect(middlewareTransaction.breadcrumbs).toEqual(
expect.arrayContaining([
{
category: 'fetch',
data: { method: 'GET', status_code: 200, url: 'http://localhost:3030/' },
timestamp: expect.any(Number),
type: 'http',
},
]),
);
// `http.client` span names are low cardinality under span streaming, so the name is the method and
// host rather than the full URL. The URL itself is still asserted below via `url.full`.
expect(fetchSpan.name).toBe('GET localhost');
expect(fetchSpan.status).toBe('ok');
expect(fetchSpan.parent_span_id).toEqual(expect.stringMatching(/[a-f0-9]{16}/));
expect(fetchSpan.attributes).toMatchObject({
'http.request.method': { value: 'GET', type: 'string' },
'http.response.status_code': { value: 200, type: 'integer' },
type: { value: 'fetch', type: 'string' },
'url.full': { value: 'http://localhost:3030/', type: 'string' },
'url.domain': { value: 'localhost', type: 'string' },
'server.address': { value: 'localhost', type: 'string' },
'server.port': { value: 3030, type: 'integer' },
'sentry.op': { value: 'http.client', type: 'string' },
'sentry.origin': { value: 'auto.http.wintercg_fetch', type: 'string' },
});
});
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,48 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Will capture error for SSR rendering error with a connected trace (Class Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error Class';
});

const serverComponentTransaction = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const serverComponentSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-class' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-class' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-class');

expect(await errorEventPromise).toBeDefined();
expect(await serverComponentTransaction).toBeDefined();
expect(await serverComponentSpanPromise).toBeDefined();
});

test('Will capture error for SSR rendering error with a connected trace (Functional Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error FC';
});

const ssrTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const ssrSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-fc' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-fc' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-fc');

const errorEvent = await errorEventPromise;
const ssrTransaction = await ssrTransactionPromise;
await ssrSpanPromise;

// Assert that isolation scope works properly
// Assert that isolation scope works properly. Span v2 carries no scope tags, so this is only
// asserted on the error event.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// TODO(lforst): Reuse SSR request span isolation scope to fix the following two assertions
// expect(ssrTransaction.tags?.['my-isolated-tag']).toBe(true);
// expect(ssrTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
handled: false,
type: 'auto.function.nextjs.page_function',
Expand Down
Loading
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import * as Sentry from '@sentry/nextjs';

Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@ import * as Sentry from '@sentry/nextjs';
export function register() {
if (process.env.NEXT_RUNTIME === 'nodejs' || process.env.NEXT_RUNTIME === 'edge') {
Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForStreamedSpan, waitForStreamedSpans } from '@sentry-internal/test-utils';

// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL transaction and the
// transaction created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never
// both. This guards against regressing back to duplicate root transactions for the same API route.
test('Sends exactly one transaction for a pages-router API route', async ({ request }) => {
const apiRouteTransactions: string[] = [];
// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL span and the span
// created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never both.
// This guards against regressing back to duplicate segment spans for the same API route.
test('Sends exactly one segment span for a pages-router API route', async ({ request }) => {
const apiRouteSegmentSpans: string[] = [];

// Accumulate every matching transaction and assert on the total after a grace period. This predicate never
// Accumulate every matching span and assert on the total after a grace period. This predicate never
// returns true, so the promise never resolves; we just let it collect while we wait out the grace period.
void waitForTransaction('nextjs-pages-dir', transactionEvent => {
if (transactionEvent?.transaction === 'GET /api/endpoint') {
apiRouteTransactions.push(transactionEvent.contexts?.trace?.trace_id ?? '<no-trace-id>');
void waitForStreamedSpans('nextjs-pages-dir', spans => {
for (const span of spans) {
if (span.name === 'GET /api/endpoint' && span.is_segment) {
apiRouteSegmentSpans.push(span.trace_id);
}
}
return false;
});
Expand All@@ -21,21 +23,21 @@ test('Sends exactly one transaction for a pages-router API route', async ({ requ

await new Promise(resolve => setTimeout(resolve, 6000));

expect(apiRouteTransactions).toHaveLength(1);
expect(apiRouteSegmentSpans).toHaveLength(1);
});

test('Sends a well-formed transaction for a node-runtime pages-router API route', async ({ request }) => {
const transactionPromise = waitForTransaction('nextjs-pages-dir', transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint' && transactionEvent.contexts?.runtime?.name === 'node';
test('Sends a well-formed span for a node-runtime pages-router API route', async ({ request }) => {
const spanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/endpoint' && span.is_segment;
});

const response = await request.get('/api/endpoint');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const transaction = await transactionPromise;
const span = await spanPromise;

expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.contexts?.trace?.status).toBe('ok');
expect(transaction.transaction_info?.source).toBe('route');
expect(transaction.contexts?.trace?.data?.['http.route']).toBe('/api/endpoint');
expect(getSpanOp(span)).toBe('http.server');
expect(span.status).toBe('ok');
expect(span.attributes['sentry.segment.name.source']?.value).toBe('route');
expect(span.attributes['http.route']?.value).toBe('/api/endpoint');
});
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans } from '@sentry-internal/test-utils';

test('Should allow for async context isolation in the edge SDK', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/async-context-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
});
// The inner and outer spans are children of the segment span, which ends last, so accumulate until
// the segment arrives to be sure both children are in hand.
const spansPromise = collectStreamedSpans('nextjs-pages-dir', spans =>
spans.some(span => span.name === 'GET /api/async-context-edge-endpoint' && span.is_segment),
);

await request.get('/api/async-context-edge-endpoint');

const asyncContextEdgerouteTransaction = await edgerouteTransactionPromise;
const spans = await spansPromise;

const outerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'outer-span');
const innerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'inner-span');
const outerSpan = spans.find(span => span.name === 'outer-span');
const innerSpan = spans.find(span => span.name === 'inner-span');

expect(outerSpan).toBeDefined();
expect(innerSpan).toBeDefined();
expect(outerSpan?.parent_span_id).toStrictEqual(innerSpan?.parent_span_id);
});
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
test('Should create a span for edge routes', async ({ request }) => {
// The route is only served by the edge runtime, so the span name identifies it on its own. The
// transaction-based test additionally matched on `contexts.runtime.name`, which span v2 does not carry.
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/edge-endpoint' && span.is_segment;
});

const response = await request.get('/api/edge-endpoint', {
Expand All@@ -16,19 +15,17 @@ test('Should create a transaction for edge routes', async ({ request }) => {
});
expect(await response.json()).toStrictEqual({ name: 'Jim Halpert' });

const edgerouteTransaction = await edgerouteTransactionPromise;
const edgerouteSpan = await edgerouteSpanPromise;

expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
expect(edgerouteTransaction.request?.headers?.['x-yeet']).toBe('test-value');
expect(edgerouteSpan.status).toBe('ok');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
// The `x-yeet` request header is not asserted here: the edge runtime emits this segment span without
// request headers, and they land on a sibling Node-side span in a separate trace.
});

test('Faulty edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/error-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/error-edge-endpoint' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -42,19 +39,19 @@ test('Faulty edge routes', async ({ request }) => {
// Noop
});

const [edgerouteTransaction, errorEvent] = await Promise.all([
test.step('should create a transaction', () => edgerouteTransactionPromise),
const [edgerouteSpan, errorEvent] = await Promise.all([
test.step('should create a span', () => edgerouteSpanPromise),
test.step('should create an error event', () => errorEventPromise),
]);

test.step('should create transactions with the right fields', () => {
expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
test.step('should create spans with the right fields', () => {
expect(edgerouteSpan.status).toBe('error');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
});

test.step('should have scope isolation', () => {
expect(edgerouteTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(edgerouteTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
// Span v2 carries no scope tags, so isolation is only asserted on the error event; the span-side
// assertions were dropped in the streaming port.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans, getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
test('Should create a span for middleware', async ({ request }) => {
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const response = await request.get('/api/endpoint-behind-middleware');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const middlewareTransaction = await middlewareTransactionPromise;
const middlewareSpan = await middlewareSpanPromise;

expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
expect(middlewareSpan.status).toBe('ok');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

test('Faulty middlewares', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -34,12 +29,11 @@ test('Faulty middlewares', async ({ request }) => {
// Noop
});

await test.step('should record transactions', async () => {
const middlewareTransaction = await middlewareTransactionPromise;
expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');
await test.step('should record spans', async () => {
const middlewareSpan = await middlewareSpanPromise;
expect(middlewareSpan.status).toBe('error');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

await test.step('should record exceptions', async () => {
Expand All@@ -52,54 +46,37 @@ test('Faulty middlewares', async ({ request }) => {
});
});

test('Should trace outgoing fetch requests inside middleware and create breadcrumbs for it', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
!!transactionEvent.spans?.find(span => span.op === 'http.client')
);
});
test('Should trace outgoing fetch requests inside middleware', async ({ request }) => {
// The fetch span is a child of the middleware segment span, which ends last, so accumulate until
// the segment arrives.
const spansPromise = collectStreamedSpans(
'nextjs-pages-dir',
spans =>
spans.some(span => span.name === 'middleware GET' && span.is_segment) &&
spans.some(span => getSpanOp(span) === 'http.client'),
);

request.get('/api/endpoint-behind-middleware', { headers: { 'x-should-make-request': '1' } }).catch(() => {
// Noop
});

const middlewareTransaction = await middlewareTransactionPromise;
const spans = await spansPromise;
const fetchSpan = spans.find(span => getSpanOp(span) === 'http.client')!;

expect(middlewareTransaction.spans).toEqual(
expect.arrayContaining([
{
data: {
'http.request.method': 'GET',
'http.response.status_code': 200,
type: 'fetch',
'url.full': 'http://localhost:3030/',
'url.domain': 'localhost',
'server.address': 'localhost',
'server.port': 3030,
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.wintercg_fetch',
},
description: 'GET http://localhost:3030/',
op: 'http.client',
origin: 'auto.http.wintercg_fetch',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
status: 'ok',
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
},
]),
);
expect(middlewareTransaction.breadcrumbs).toEqual(
expect.arrayContaining([
{
category: 'fetch',
data: { method: 'GET', status_code: 200, url: 'http://localhost:3030/' },
timestamp: expect.any(Number),
type: 'http',
},
]),
);
// `http.client` span names are low cardinality under span streaming, so the name is the method and
// host rather than the full URL. The URL itself is still asserted below via `url.full`.
expect(fetchSpan.name).toBe('GET localhost');
expect(fetchSpan.status).toBe('ok');
expect(fetchSpan.parent_span_id).toEqual(expect.stringMatching(/[a-f0-9]{16}/));
expect(fetchSpan.attributes).toMatchObject({
'http.request.method': { value: 'GET', type: 'string' },
'http.response.status_code': { value: 200, type: 'integer' },
type: { value: 'fetch', type: 'string' },
'url.full': { value: 'http://localhost:3030/', type: 'string' },
'url.domain': { value: 'localhost', type: 'string' },
'server.address': { value: 'localhost', type: 'string' },
'server.port': { value: 3030, type: 'integer' },
'sentry.op': { value: 'http.client', type: 'string' },
'sentry.origin': { value: 'auto.http.wintercg_fetch', type: 'string' },
});
});
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,48 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Will capture error for SSR rendering error with a connected trace (Class Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error Class';
});

const serverComponentTransaction = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const serverComponentSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-class' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-class' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-class');

expect(await errorEventPromise).toBeDefined();
expect(await serverComponentTransaction).toBeDefined();
expect(await serverComponentSpanPromise).toBeDefined();
});

test('Will capture error for SSR rendering error with a connected trace (Functional Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error FC';
});

const ssrTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const ssrSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-fc' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-fc' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-fc');

const errorEvent = await errorEventPromise;
const ssrTransaction = await ssrTransactionPromise;
await ssrSpanPromise;

// Assert that isolation scope works properly
// Assert that isolation scope works properly. Span v2 carries no scope tags, so this is only
// asserted on the error event.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// TODO(lforst): Reuse SSR request span isolation scope to fix the following two assertions
// expect(ssrTransaction.tags?.['my-isolated-tag']).toBe(true);
// expect(ssrTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
handled: false,
type: 'auto.function.nextjs.page_function',
Expand Down
Loading
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import * as Sentry from '@sentry/nextjs';

Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@ import * as Sentry from '@sentry/nextjs';
export function register() {
if (process.env.NEXT_RUNTIME === 'nodejs' || process.env.NEXT_RUNTIME === 'edge') {
Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForStreamedSpan, waitForStreamedSpans } from '@sentry-internal/test-utils';

// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL transaction and the
// transaction created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never
// both. This guards against regressing back to duplicate root transactions for the same API route.
test('Sends exactly one transaction for a pages-router API route', async ({ request }) => {
const apiRouteTransactions: string[] = [];
// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL span and the span
// created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never both.
// This guards against regressing back to duplicate segment spans for the same API route.
test('Sends exactly one segment span for a pages-router API route', async ({ request }) => {
const apiRouteSegmentSpans: string[] = [];

// Accumulate every matching transaction and assert on the total after a grace period. This predicate never
// Accumulate every matching span and assert on the total after a grace period. This predicate never
// returns true, so the promise never resolves; we just let it collect while we wait out the grace period.
void waitForTransaction('nextjs-pages-dir', transactionEvent => {
if (transactionEvent?.transaction === 'GET /api/endpoint') {
apiRouteTransactions.push(transactionEvent.contexts?.trace?.trace_id ?? '<no-trace-id>');
void waitForStreamedSpans('nextjs-pages-dir', spans => {
for (const span of spans) {
if (span.name === 'GET /api/endpoint' && span.is_segment) {
apiRouteSegmentSpans.push(span.trace_id);
}
}
return false;
});
Expand All@@ -21,21 +23,21 @@ test('Sends exactly one transaction for a pages-router API route', async ({ requ

await new Promise(resolve => setTimeout(resolve, 6000));

expect(apiRouteTransactions).toHaveLength(1);
expect(apiRouteSegmentSpans).toHaveLength(1);
});

test('Sends a well-formed transaction for a node-runtime pages-router API route', async ({ request }) => {
const transactionPromise = waitForTransaction('nextjs-pages-dir', transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint' && transactionEvent.contexts?.runtime?.name === 'node';
test('Sends a well-formed span for a node-runtime pages-router API route', async ({ request }) => {
const spanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/endpoint' && span.is_segment;
});

const response = await request.get('/api/endpoint');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const transaction = await transactionPromise;
const span = await spanPromise;

expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.contexts?.trace?.status).toBe('ok');
expect(transaction.transaction_info?.source).toBe('route');
expect(transaction.contexts?.trace?.data?.['http.route']).toBe('/api/endpoint');
expect(getSpanOp(span)).toBe('http.server');
expect(span.status).toBe('ok');
expect(span.attributes['sentry.segment.name.source']?.value).toBe('route');
expect(span.attributes['http.route']?.value).toBe('/api/endpoint');
});
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans } from '@sentry-internal/test-utils';

test('Should allow for async context isolation in the edge SDK', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/async-context-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
});
// The inner and outer spans are children of the segment span, which ends last, so accumulate until
// the segment arrives to be sure both children are in hand.
const spansPromise = collectStreamedSpans('nextjs-pages-dir', spans =>
spans.some(span => span.name === 'GET /api/async-context-edge-endpoint' && span.is_segment),
);

await request.get('/api/async-context-edge-endpoint');

const asyncContextEdgerouteTransaction = await edgerouteTransactionPromise;
const spans = await spansPromise;

const outerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'outer-span');
const innerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'inner-span');
const outerSpan = spans.find(span => span.name === 'outer-span');
const innerSpan = spans.find(span => span.name === 'inner-span');

expect(outerSpan).toBeDefined();
expect(innerSpan).toBeDefined();
expect(outerSpan?.parent_span_id).toStrictEqual(innerSpan?.parent_span_id);
});
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
test('Should create a span for edge routes', async ({ request }) => {
// The route is only served by the edge runtime, so the span name identifies it on its own. The
// transaction-based test additionally matched on `contexts.runtime.name`, which span v2 does not carry.
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/edge-endpoint' && span.is_segment;
});

const response = await request.get('/api/edge-endpoint', {
Expand All@@ -16,19 +15,17 @@ test('Should create a transaction for edge routes', async ({ request }) => {
});
expect(await response.json()).toStrictEqual({ name: 'Jim Halpert' });

const edgerouteTransaction = await edgerouteTransactionPromise;
const edgerouteSpan = await edgerouteSpanPromise;

expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
expect(edgerouteTransaction.request?.headers?.['x-yeet']).toBe('test-value');
expect(edgerouteSpan.status).toBe('ok');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
// The `x-yeet` request header is not asserted here: the edge runtime emits this segment span without
// request headers, and they land on a sibling Node-side span in a separate trace.
});

test('Faulty edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/error-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/error-edge-endpoint' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -42,19 +39,19 @@ test('Faulty edge routes', async ({ request }) => {
// Noop
});

const [edgerouteTransaction, errorEvent] = await Promise.all([
test.step('should create a transaction', () => edgerouteTransactionPromise),
const [edgerouteSpan, errorEvent] = await Promise.all([
test.step('should create a span', () => edgerouteSpanPromise),
test.step('should create an error event', () => errorEventPromise),
]);

test.step('should create transactions with the right fields', () => {
expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
test.step('should create spans with the right fields', () => {
expect(edgerouteSpan.status).toBe('error');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
});

test.step('should have scope isolation', () => {
expect(edgerouteTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(edgerouteTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
// Span v2 carries no scope tags, so isolation is only asserted on the error event; the span-side
// assertions were dropped in the streaming port.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans, getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
test('Should create a span for middleware', async ({ request }) => {
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const response = await request.get('/api/endpoint-behind-middleware');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const middlewareTransaction = await middlewareTransactionPromise;
const middlewareSpan = await middlewareSpanPromise;

expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
expect(middlewareSpan.status).toBe('ok');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

test('Faulty middlewares', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -34,12 +29,11 @@ test('Faulty middlewares', async ({ request }) => {
// Noop
});

await test.step('should record transactions', async () => {
const middlewareTransaction = await middlewareTransactionPromise;
expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');
await test.step('should record spans', async () => {
const middlewareSpan = await middlewareSpanPromise;
expect(middlewareSpan.status).toBe('error');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

await test.step('should record exceptions', async () => {
Expand All@@ -52,54 +46,37 @@ test('Faulty middlewares', async ({ request }) => {
});
});

test('Should trace outgoing fetch requests inside middleware and create breadcrumbs for it', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
!!transactionEvent.spans?.find(span => span.op === 'http.client')
);
});
test('Should trace outgoing fetch requests inside middleware', async ({ request }) => {
// The fetch span is a child of the middleware segment span, which ends last, so accumulate until
// the segment arrives.
const spansPromise = collectStreamedSpans(
'nextjs-pages-dir',
spans =>
spans.some(span => span.name === 'middleware GET' && span.is_segment) &&
spans.some(span => getSpanOp(span) === 'http.client'),
);

request.get('/api/endpoint-behind-middleware', { headers: { 'x-should-make-request': '1' } }).catch(() => {
// Noop
});

const middlewareTransaction = await middlewareTransactionPromise;
const spans = await spansPromise;
const fetchSpan = spans.find(span => getSpanOp(span) === 'http.client')!;

expect(middlewareTransaction.spans).toEqual(
expect.arrayContaining([
{
data: {
'http.request.method': 'GET',
'http.response.status_code': 200,
type: 'fetch',
'url.full': 'http://localhost:3030/',
'url.domain': 'localhost',
'server.address': 'localhost',
'server.port': 3030,
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.wintercg_fetch',
},
description: 'GET http://localhost:3030/',
op: 'http.client',
origin: 'auto.http.wintercg_fetch',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
status: 'ok',
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
},
]),
);
expect(middlewareTransaction.breadcrumbs).toEqual(
expect.arrayContaining([
{
category: 'fetch',
data: { method: 'GET', status_code: 200, url: 'http://localhost:3030/' },
timestamp: expect.any(Number),
type: 'http',
},
]),
);
// `http.client` span names are low cardinality under span streaming, so the name is the method and
// host rather than the full URL. The URL itself is still asserted below via `url.full`.
expect(fetchSpan.name).toBe('GET localhost');
expect(fetchSpan.status).toBe('ok');
expect(fetchSpan.parent_span_id).toEqual(expect.stringMatching(/[a-f0-9]{16}/));
expect(fetchSpan.attributes).toMatchObject({
'http.request.method': { value: 'GET', type: 'string' },
'http.response.status_code': { value: 200, type: 'integer' },
type: { value: 'fetch', type: 'string' },
'url.full': { value: 'http://localhost:3030/', type: 'string' },
'url.domain': { value: 'localhost', type: 'string' },
'server.address': { value: 'localhost', type: 'string' },
'server.port': { value: 3030, type: 'integer' },
'sentry.op': { value: 'http.client', type: 'string' },
'sentry.origin': { value: 'auto.http.wintercg_fetch', type: 'string' },
});
});
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,48 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Will capture error for SSR rendering error with a connected trace (Class Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error Class';
});

const serverComponentTransaction = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const serverComponentSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-class' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-class' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-class');

expect(await errorEventPromise).toBeDefined();
expect(await serverComponentTransaction).toBeDefined();
expect(await serverComponentSpanPromise).toBeDefined();
});

test('Will capture error for SSR rendering error with a connected trace (Functional Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error FC';
});

const ssrTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const ssrSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-fc' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-fc' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-fc');

const errorEvent = await errorEventPromise;
const ssrTransaction = await ssrTransactionPromise;
await ssrSpanPromise;

// Assert that isolation scope works properly
// Assert that isolation scope works properly. Span v2 carries no scope tags, so this is only
// asserted on the error event.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// TODO(lforst): Reuse SSR request span isolation scope to fix the following two assertions
// expect(ssrTransaction.tags?.['my-isolated-tag']).toBe(true);
// expect(ssrTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
handled: false,
type: 'auto.function.nextjs.page_function',
Expand Down
Loading
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import * as Sentry from '@sentry/nextjs';

Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@ import * as Sentry from '@sentry/nextjs';
export function register() {
if (process.env.NEXT_RUNTIME === 'nodejs' || process.env.NEXT_RUNTIME === 'edge') {
Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForStreamedSpan, waitForStreamedSpans } from '@sentry-internal/test-utils';

// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL transaction and the
// transaction created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never
// both. This guards against regressing back to duplicate root transactions for the same API route.
test('Sends exactly one transaction for a pages-router API route', async ({ request }) => {
const apiRouteTransactions: string[] = [];
// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL span and the span
// created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never both.
// This guards against regressing back to duplicate segment spans for the same API route.
test('Sends exactly one segment span for a pages-router API route', async ({ request }) => {
const apiRouteSegmentSpans: string[] = [];

// Accumulate every matching transaction and assert on the total after a grace period. This predicate never
// Accumulate every matching span and assert on the total after a grace period. This predicate never
// returns true, so the promise never resolves; we just let it collect while we wait out the grace period.
void waitForTransaction('nextjs-pages-dir', transactionEvent => {
if (transactionEvent?.transaction === 'GET /api/endpoint') {
apiRouteTransactions.push(transactionEvent.contexts?.trace?.trace_id ?? '<no-trace-id>');
void waitForStreamedSpans('nextjs-pages-dir', spans => {
for (const span of spans) {
if (span.name === 'GET /api/endpoint' && span.is_segment) {
apiRouteSegmentSpans.push(span.trace_id);
}
}
return false;
});
Expand All@@ -21,21 +23,21 @@ test('Sends exactly one transaction for a pages-router API route', async ({ requ

await new Promise(resolve => setTimeout(resolve, 6000));

expect(apiRouteTransactions).toHaveLength(1);
expect(apiRouteSegmentSpans).toHaveLength(1);
});

test('Sends a well-formed transaction for a node-runtime pages-router API route', async ({ request }) => {
const transactionPromise = waitForTransaction('nextjs-pages-dir', transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint' && transactionEvent.contexts?.runtime?.name === 'node';
test('Sends a well-formed span for a node-runtime pages-router API route', async ({ request }) => {
const spanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/endpoint' && span.is_segment;
});

const response = await request.get('/api/endpoint');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const transaction = await transactionPromise;
const span = await spanPromise;

expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.contexts?.trace?.status).toBe('ok');
expect(transaction.transaction_info?.source).toBe('route');
expect(transaction.contexts?.trace?.data?.['http.route']).toBe('/api/endpoint');
expect(getSpanOp(span)).toBe('http.server');
expect(span.status).toBe('ok');
expect(span.attributes['sentry.segment.name.source']?.value).toBe('route');
expect(span.attributes['http.route']?.value).toBe('/api/endpoint');
});
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans } from '@sentry-internal/test-utils';

test('Should allow for async context isolation in the edge SDK', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/async-context-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
});
// The inner and outer spans are children of the segment span, which ends last, so accumulate until
// the segment arrives to be sure both children are in hand.
const spansPromise = collectStreamedSpans('nextjs-pages-dir', spans =>
spans.some(span => span.name === 'GET /api/async-context-edge-endpoint' && span.is_segment),
);

await request.get('/api/async-context-edge-endpoint');

const asyncContextEdgerouteTransaction = await edgerouteTransactionPromise;
const spans = await spansPromise;

const outerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'outer-span');
const innerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'inner-span');
const outerSpan = spans.find(span => span.name === 'outer-span');
const innerSpan = spans.find(span => span.name === 'inner-span');

expect(outerSpan).toBeDefined();
expect(innerSpan).toBeDefined();
expect(outerSpan?.parent_span_id).toStrictEqual(innerSpan?.parent_span_id);
});
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
test('Should create a span for edge routes', async ({ request }) => {
// The route is only served by the edge runtime, so the span name identifies it on its own. The
// transaction-based test additionally matched on `contexts.runtime.name`, which span v2 does not carry.
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/edge-endpoint' && span.is_segment;
});

const response = await request.get('/api/edge-endpoint', {
Expand All@@ -16,19 +15,17 @@ test('Should create a transaction for edge routes', async ({ request }) => {
});
expect(await response.json()).toStrictEqual({ name: 'Jim Halpert' });

const edgerouteTransaction = await edgerouteTransactionPromise;
const edgerouteSpan = await edgerouteSpanPromise;

expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
expect(edgerouteTransaction.request?.headers?.['x-yeet']).toBe('test-value');
expect(edgerouteSpan.status).toBe('ok');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
// The `x-yeet` request header is not asserted here: the edge runtime emits this segment span without
// request headers, and they land on a sibling Node-side span in a separate trace.
});

test('Faulty edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/error-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/error-edge-endpoint' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -42,19 +39,19 @@ test('Faulty edge routes', async ({ request }) => {
// Noop
});

const [edgerouteTransaction, errorEvent] = await Promise.all([
test.step('should create a transaction', () => edgerouteTransactionPromise),
const [edgerouteSpan, errorEvent] = await Promise.all([
test.step('should create a span', () => edgerouteSpanPromise),
test.step('should create an error event', () => errorEventPromise),
]);

test.step('should create transactions with the right fields', () => {
expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
test.step('should create spans with the right fields', () => {
expect(edgerouteSpan.status).toBe('error');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
});

test.step('should have scope isolation', () => {
expect(edgerouteTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(edgerouteTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
// Span v2 carries no scope tags, so isolation is only asserted on the error event; the span-side
// assertions were dropped in the streaming port.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans, getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
test('Should create a span for middleware', async ({ request }) => {
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const response = await request.get('/api/endpoint-behind-middleware');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const middlewareTransaction = await middlewareTransactionPromise;
const middlewareSpan = await middlewareSpanPromise;

expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
expect(middlewareSpan.status).toBe('ok');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

test('Faulty middlewares', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -34,12 +29,11 @@ test('Faulty middlewares', async ({ request }) => {
// Noop
});

await test.step('should record transactions', async () => {
const middlewareTransaction = await middlewareTransactionPromise;
expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');
await test.step('should record spans', async () => {
const middlewareSpan = await middlewareSpanPromise;
expect(middlewareSpan.status).toBe('error');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

await test.step('should record exceptions', async () => {
Expand All@@ -52,54 +46,37 @@ test('Faulty middlewares', async ({ request }) => {
});
});

test('Should trace outgoing fetch requests inside middleware and create breadcrumbs for it', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
!!transactionEvent.spans?.find(span => span.op === 'http.client')
);
});
test('Should trace outgoing fetch requests inside middleware', async ({ request }) => {
// The fetch span is a child of the middleware segment span, which ends last, so accumulate until
// the segment arrives.
const spansPromise = collectStreamedSpans(
'nextjs-pages-dir',
spans =>
spans.some(span => span.name === 'middleware GET' && span.is_segment) &&
spans.some(span => getSpanOp(span) === 'http.client'),
);

request.get('/api/endpoint-behind-middleware', { headers: { 'x-should-make-request': '1' } }).catch(() => {
// Noop
});

const middlewareTransaction = await middlewareTransactionPromise;
const spans = await spansPromise;
const fetchSpan = spans.find(span => getSpanOp(span) === 'http.client')!;

expect(middlewareTransaction.spans).toEqual(
expect.arrayContaining([
{
data: {
'http.request.method': 'GET',
'http.response.status_code': 200,
type: 'fetch',
'url.full': 'http://localhost:3030/',
'url.domain': 'localhost',
'server.address': 'localhost',
'server.port': 3030,
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.wintercg_fetch',
},
description: 'GET http://localhost:3030/',
op: 'http.client',
origin: 'auto.http.wintercg_fetch',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
status: 'ok',
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
},
]),
);
expect(middlewareTransaction.breadcrumbs).toEqual(
expect.arrayContaining([
{
category: 'fetch',
data: { method: 'GET', status_code: 200, url: 'http://localhost:3030/' },
timestamp: expect.any(Number),
type: 'http',
},
]),
);
// `http.client` span names are low cardinality under span streaming, so the name is the method and
// host rather than the full URL. The URL itself is still asserted below via `url.full`.
expect(fetchSpan.name).toBe('GET localhost');
expect(fetchSpan.status).toBe('ok');
expect(fetchSpan.parent_span_id).toEqual(expect.stringMatching(/[a-f0-9]{16}/));
expect(fetchSpan.attributes).toMatchObject({
'http.request.method': { value: 'GET', type: 'string' },
'http.response.status_code': { value: 200, type: 'integer' },
type: { value: 'fetch', type: 'string' },
'url.full': { value: 'http://localhost:3030/', type: 'string' },
'url.domain': { value: 'localhost', type: 'string' },
'server.address': { value: 'localhost', type: 'string' },
'server.port': { value: 3030, type: 'integer' },
'sentry.op': { value: 'http.client', type: 'string' },
'sentry.origin': { value: 'auto.http.wintercg_fetch', type: 'string' },
});
});
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,48 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Will capture error for SSR rendering error with a connected trace (Class Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error Class';
});

const serverComponentTransaction = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const serverComponentSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-class' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-class' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-class');

expect(await errorEventPromise).toBeDefined();
expect(await serverComponentTransaction).toBeDefined();
expect(await serverComponentSpanPromise).toBeDefined();
});

test('Will capture error for SSR rendering error with a connected trace (Functional Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error FC';
});

const ssrTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const ssrSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-fc' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-fc' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-fc');

const errorEvent = await errorEventPromise;
const ssrTransaction = await ssrTransactionPromise;
await ssrSpanPromise;

// Assert that isolation scope works properly
// Assert that isolation scope works properly. Span v2 carries no scope tags, so this is only
// asserted on the error event.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// TODO(lforst): Reuse SSR request span isolation scope to fix the following two assertions
// expect(ssrTransaction.tags?.['my-isolated-tag']).toBe(true);
// expect(ssrTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
handled: false,
type: 'auto.function.nextjs.page_function',
Expand Down
Loading
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import * as Sentry from '@sentry/nextjs';

Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@ import * as Sentry from '@sentry/nextjs';
export function register() {
if (process.env.NEXT_RUNTIME === 'nodejs' || process.env.NEXT_RUNTIME === 'edge') {
Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForStreamedSpan, waitForStreamedSpans } from '@sentry-internal/test-utils';

// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL transaction and the
// transaction created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never
// both. This guards against regressing back to duplicate root transactions for the same API route.
test('Sends exactly one transaction for a pages-router API route', async ({ request }) => {
const apiRouteTransactions: string[] = [];
// A pages-router API route sees both Next.js's own `BaseServer.handleRequest` OTEL span and the span
// created by `wrapApiHandlerWithSentry`. Exactly one of them must be sent for a request, never both.
// This guards against regressing back to duplicate segment spans for the same API route.
test('Sends exactly one segment span for a pages-router API route', async ({ request }) => {
const apiRouteSegmentSpans: string[] = [];

// Accumulate every matching transaction and assert on the total after a grace period. This predicate never
// Accumulate every matching span and assert on the total after a grace period. This predicate never
// returns true, so the promise never resolves; we just let it collect while we wait out the grace period.
void waitForTransaction('nextjs-pages-dir', transactionEvent => {
if (transactionEvent?.transaction === 'GET /api/endpoint') {
apiRouteTransactions.push(transactionEvent.contexts?.trace?.trace_id ?? '<no-trace-id>');
void waitForStreamedSpans('nextjs-pages-dir', spans => {
for (const span of spans) {
if (span.name === 'GET /api/endpoint' && span.is_segment) {
apiRouteSegmentSpans.push(span.trace_id);
}
}
return false;
});
Expand All@@ -21,21 +23,21 @@ test('Sends exactly one transaction for a pages-router API route', async ({ requ

await new Promise(resolve => setTimeout(resolve, 6000));

expect(apiRouteTransactions).toHaveLength(1);
expect(apiRouteSegmentSpans).toHaveLength(1);
});

test('Sends a well-formed transaction for a node-runtime pages-router API route', async ({ request }) => {
const transactionPromise = waitForTransaction('nextjs-pages-dir', transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint' && transactionEvent.contexts?.runtime?.name === 'node';
test('Sends a well-formed span for a node-runtime pages-router API route', async ({ request }) => {
const spanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/endpoint' && span.is_segment;
});

const response = await request.get('/api/endpoint');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const transaction = await transactionPromise;
const span = await spanPromise;

expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.contexts?.trace?.status).toBe('ok');
expect(transaction.transaction_info?.source).toBe('route');
expect(transaction.contexts?.trace?.data?.['http.route']).toBe('/api/endpoint');
expect(getSpanOp(span)).toBe('http.server');
expect(span.status).toBe('ok');
expect(span.attributes['sentry.segment.name.source']?.value).toBe('route');
expect(span.attributes['http.route']?.value).toBe('/api/endpoint');
});
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans } from '@sentry-internal/test-utils';

test('Should allow for async context isolation in the edge SDK', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/async-context-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
});
// The inner and outer spans are children of the segment span, which ends last, so accumulate until
// the segment arrives to be sure both children are in hand.
const spansPromise = collectStreamedSpans('nextjs-pages-dir', spans =>
spans.some(span => span.name === 'GET /api/async-context-edge-endpoint' && span.is_segment),
);

await request.get('/api/async-context-edge-endpoint');

const asyncContextEdgerouteTransaction = await edgerouteTransactionPromise;
const spans = await spansPromise;

const outerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'outer-span');
const innerSpan = asyncContextEdgerouteTransaction.spans?.find(span => span.description === 'inner-span');
const outerSpan = spans.find(span => span.name === 'outer-span');
const innerSpan = spans.find(span => span.name === 'inner-span');

expect(outerSpan).toBeDefined();
expect(innerSpan).toBeDefined();
expect(outerSpan?.parent_span_id).toStrictEqual(innerSpan?.parent_span_id);
});
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
test('Should create a span for edge routes', async ({ request }) => {
// The route is only served by the edge runtime, so the span name identifies it on its own. The
// transaction-based test additionally matched on `contexts.runtime.name`, which span v2 does not carry.
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/edge-endpoint' && span.is_segment;
});

const response = await request.get('/api/edge-endpoint', {
Expand All@@ -16,19 +15,17 @@ test('Should create a transaction for edge routes', async ({ request }) => {
});
expect(await response.json()).toStrictEqual({ name: 'Jim Halpert' });

const edgerouteTransaction = await edgerouteTransactionPromise;
const edgerouteSpan = await edgerouteSpanPromise;

expect(edgerouteTransaction.contexts?.trace?.status).toBe('ok');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
expect(edgerouteTransaction.request?.headers?.['x-yeet']).toBe('test-value');
expect(edgerouteSpan.status).toBe('ok');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
// The `x-yeet` request header is not asserted here: the edge runtime emits this segment span without
// request headers, and they land on a sibling Node-side span in a separate trace.
});

test('Faulty edge routes', async ({ request }) => {
const edgerouteTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'GET /api/error-edge-endpoint' &&
transactionEvent.contexts?.runtime?.name === 'vercel-edge'
);
const edgerouteSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'GET /api/error-edge-endpoint' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -42,19 +39,19 @@ test('Faulty edge routes', async ({ request }) => {
// Noop
});

const [edgerouteTransaction, errorEvent] = await Promise.all([
test.step('should create a transaction', () => edgerouteTransactionPromise),
const [edgerouteSpan, errorEvent] = await Promise.all([
test.step('should create a span', () => edgerouteSpanPromise),
test.step('should create an error event', () => errorEventPromise),
]);

test.step('should create transactions with the right fields', () => {
expect(edgerouteTransaction.contexts?.trace?.status).toBe('internal_error');
expect(edgerouteTransaction.contexts?.trace?.op).toBe('http.server');
test.step('should create spans with the right fields', () => {
expect(edgerouteSpan.status).toBe('error');
expect(getSpanOp(edgerouteSpan)).toBe('http.server');
});

test.step('should have scope isolation', () => {
expect(edgerouteTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(edgerouteTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
// Span v2 carries no scope tags, so isolation is only asserted on the error event; the span-side
// assertions were dropped in the streaming port.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpans, getSpanOp, waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
test('Should create a span for middleware', async ({ request }) => {
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const response = await request.get('/api/endpoint-behind-middleware');
expect(await response.json()).toStrictEqual({ name: 'John Doe' });

const middlewareTransaction = await middlewareTransactionPromise;
const middlewareSpan = await middlewareSpanPromise;

expect(middlewareTransaction.contexts?.trace?.status).toBe('ok');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
expect(middlewareSpan.status).toBe('ok');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

test('Faulty middlewares', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
const middlewareSpanPromise = waitForStreamedSpan('nextjs-pages-dir', span => {
return span.name === 'middleware GET' && span.is_segment;
});

const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
Expand All@@ -34,12 +29,11 @@ test('Faulty middlewares', async ({ request }) => {
// Noop
});

await test.step('should record transactions', async () => {
const middlewareTransaction = await middlewareTransactionPromise;
expect(middlewareTransaction.contexts?.trace?.status).toBe('internal_error');
expect(middlewareTransaction.contexts?.trace?.op).toBe('middleware');
expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.transaction_info?.source).toBe('route');
await test.step('should record spans', async () => {
const middlewareSpan = await middlewareSpanPromise;
expect(middlewareSpan.status).toBe('error');
expect(getSpanOp(middlewareSpan)).toBe('middleware');
expect(middlewareSpan.attributes['sentry.segment.name.source']?.value).toBe('route');
});

await test.step('should record exceptions', async () => {
Expand All@@ -52,54 +46,37 @@ test('Faulty middlewares', async ({ request }) => {
});
});

test('Should trace outgoing fetch requests inside middleware and create breadcrumbs for it', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
!!transactionEvent.spans?.find(span => span.op === 'http.client')
);
});
test('Should trace outgoing fetch requests inside middleware', async ({ request }) => {
// The fetch span is a child of the middleware segment span, which ends last, so accumulate until
// the segment arrives.
const spansPromise = collectStreamedSpans(
'nextjs-pages-dir',
spans =>
spans.some(span => span.name === 'middleware GET' && span.is_segment) &&
spans.some(span => getSpanOp(span) === 'http.client'),
);

request.get('/api/endpoint-behind-middleware', { headers: { 'x-should-make-request': '1' } }).catch(() => {
// Noop
});

const middlewareTransaction = await middlewareTransactionPromise;
const spans = await spansPromise;
const fetchSpan = spans.find(span => getSpanOp(span) === 'http.client')!;

expect(middlewareTransaction.spans).toEqual(
expect.arrayContaining([
{
data: {
'http.request.method': 'GET',
'http.response.status_code': 200,
type: 'fetch',
'url.full': 'http://localhost:3030/',
'url.domain': 'localhost',
'server.address': 'localhost',
'server.port': 3030,
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.wintercg_fetch',
},
description: 'GET http://localhost:3030/',
op: 'http.client',
origin: 'auto.http.wintercg_fetch',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
status: 'ok',
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
},
]),
);
expect(middlewareTransaction.breadcrumbs).toEqual(
expect.arrayContaining([
{
category: 'fetch',
data: { method: 'GET', status_code: 200, url: 'http://localhost:3030/' },
timestamp: expect.any(Number),
type: 'http',
},
]),
);
// `http.client` span names are low cardinality under span streaming, so the name is the method and
// host rather than the full URL. The URL itself is still asserted below via `url.full`.
expect(fetchSpan.name).toBe('GET localhost');
expect(fetchSpan.status).toBe('ok');
expect(fetchSpan.parent_span_id).toEqual(expect.stringMatching(/[a-f0-9]{16}/));
expect(fetchSpan.attributes).toMatchObject({
'http.request.method': { value: 'GET', type: 'string' },
'http.response.status_code': { value: 200, type: 'integer' },
type: { value: 'fetch', type: 'string' },
'url.full': { value: 'http://localhost:3030/', type: 'string' },
'url.domain': { value: 'localhost', type: 'string' },
'server.address': { value: 'localhost', type: 'string' },
'server.port': { value: 3030, type: 'integer' },
'sentry.op': { value: 'http.client', type: 'string' },
'sentry.origin': { value: 'auto.http.wintercg_fetch', type: 'string' },
});
});
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,48 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

test('Will capture error for SSR rendering error with a connected trace (Class Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error Class';
});

const serverComponentTransaction = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const serverComponentSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-class' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-class' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-class');

expect(await errorEventPromise).toBeDefined();
expect(await serverComponentTransaction).toBeDefined();
expect(await serverComponentSpanPromise).toBeDefined();
});

test('Will capture error for SSR rendering error with a connected trace (Functional Component)', async ({ page }) => {
const errorEventPromise = waitForError('nextjs-pages-dir', errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Pages SSR Error FC';
});

const ssrTransactionPromise = waitForTransaction('nextjs-pages-dir', async transactionEvent => {
const ssrSpanPromise = waitForStreamedSpan('nextjs-pages-dir', async span => {
return (
transactionEvent?.transaction === 'GET /pages-router/ssr-error-fc' &&
(await errorEventPromise).contexts?.trace?.trace_id === transactionEvent.contexts?.trace?.trace_id
span.name === 'GET /pages-router/ssr-error-fc' &&
span.is_segment &&
(await errorEventPromise).contexts?.trace?.trace_id === span.trace_id
);
});

await page.goto('/pages-router/ssr-error-fc');

const errorEvent = await errorEventPromise;
const ssrTransaction = await ssrTransactionPromise;
await ssrSpanPromise;

// Assert that isolation scope works properly
// Assert that isolation scope works properly. Span v2 carries no scope tags, so this is only
// asserted on the error event.
expect(errorEvent.tags?.['my-isolated-tag']).toBe(true);
expect(errorEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// TODO(lforst): Reuse SSR request span isolation scope to fix the following two assertions
// expect(ssrTransaction.tags?.['my-isolated-tag']).toBe(true);
// expect(ssrTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
handled: false,
type: 'auto.function.nextjs.page_function',
Expand Down
Loading
Loading