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
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'Jane Doe' });
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'John Doe' });
}
17 changes: 17 additions & 0 deletions dev-packages/e2e-tests/test-applications/nextjs-15/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { NextResponse } from 'next/server';
import type { NextRequest } from 'next/server';

export async function middleware(request: NextRequest) {
// Keep this invocation in-flight for a bit so a concurrent request to the other matched endpoint genuinely
// overlaps with it — the concurrency test in tests/middleware.test.ts relies on this overlap.
if (request.nextUrl.pathname === '/api/endpoint-behind-middleware-2') {
await new Promise(resolve => setTimeout(resolve, 300));
}

return NextResponse.next();
}

// See "Matching Paths" below to learn more
export const config = {
matcher: ['/api/endpoint-behind-middleware', '/api/endpoint-behind-middleware-2'],
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,21 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time and belongs to
// the request that is being sampled (guards against concurrent requests leaking into each other's sampling
// context). The middleware e2e tests time out and fail when the transaction is dropped here.
const { normalizedRequest } = samplingContext;
return Boolean(
normalizedRequest?.method &&
normalizedRequest?.url &&
normalizedRequest.url === samplingContext.attributes['http.target'],
);
}

return 1.0;
},
dataCollection: { userInfo: true },
transportOptions: {
// We are doing a lot of events at once in this test
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// The `tracesSampler` in `sentry.edge.config.ts` only samples `Middleware.execute` spans when `normalizedRequest`
// is available at sampling time, so this test times out if the request data does not reach the sampler.
test('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

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

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.contexts?.trace?.op).toBe('http.server.middleware');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// The `tracesSampler` additionally asserts that `normalizedRequest.url` matches the sampled span's own
// `http.target`, so a request leaking into the sampling context of a concurrent one drops that transaction
// and times this test out.
test('does not leak normalizedRequest between concurrent middleware invocations', async ({ request }) => {
const firstTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware'
);
});

const secondTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware-2'
);
});

await Promise.all([request.get('/api/endpoint-behind-middleware'), request.get('/api/endpoint-behind-middleware-2')]);

const [firstTransaction, secondTransaction] = await Promise.all([firstTransactionPromise, secondTransactionPromise]);

expect(firstTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(firstTransaction.request?.url).not.toContain('/api/endpoint-behind-middleware-2');
expect(secondTransaction.request?.url).toContain('/api/endpoint-behind-middleware-2');
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,16 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time.
// Test times out and fails when transaction is dropped
const { normalizedRequest } = samplingContext;
return Boolean(normalizedRequest?.url && normalizedRequest?.method);
}

return 1.0;
},
dataCollection: { userInfo: true },
// debug: true,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,21 @@ import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { isDevMode } from './isDevMode';

// TODO: Skipped until the Cloudflare Workers edge middleware setup emits middleware transactions reliably.
test.skip('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

await request.get('/api/endpoint-behind-middleware');

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('cloudflare');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// TODO: Middleware tests need SDK adjustments for Cloudflare Workers edge runtime
test.skip('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ test('Should create a transaction for middleware', async ({ request }) => {
expect(middlewareTransaction.contexts?.runtime?.name).toBe('node');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

expect(middlewareTransaction.request?.method).toBe('GET');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import { context } from '@opentelemetry/api';
import type { Span, SpanAttributes } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
setCapturedScopesOnSpan,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';

/**
* Forks the isolation scope for `BaseServer.handleRequest` / `Middleware.execute` root spans so that request-scoped
* data (e.g. `normalizedRequest`) stays isolated per request.
*/
export function maybeForkIsolationScopeForRootSpan(span: Span, spanAttributes: SpanAttributes | undefined): void {
const spanType = spanAttributes?.[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'BaseServer.handleRequest' && spanType !== 'Middleware.execute') {
return;
}

if (span !== getRootSpan(span)) {
return;
}

const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import {
HTTP_METHOD,
HTTP_REQUEST_METHOD,
HTTP_TARGET,
HTTP_URL,
URL_FULL,
URL_PATH,
URL_QUERY,
} from '@sentry/conventions/attributes';
import type { RequestEventData, SpanAttributes } from '@sentry/core';

/**
* Builds a partial `normalizedRequest` from OTel HTTP span attributes.
* Only method, URL, and query string can be derived — headers are not available as span attributes.
*/
export function getNormalizedRequestFromAttributes(attributes: SpanAttributes): RequestEventData | undefined {
// eslint-disable-next-line typescript/no-deprecated
const method = attributes[HTTP_REQUEST_METHOD] || attributes[HTTP_METHOD];

// eslint-disable-next-line typescript/no-deprecated
const url = attributes[URL_FULL] || attributes[HTTP_URL] || attributes[URL_PATH] || attributes[HTTP_TARGET];

if (typeof method !== 'string' && typeof url !== 'string') {
return undefined;
}

const normalizedRequest: RequestEventData = {};

if (typeof method === 'string') {
normalizedRequest.method = method;
}

if (typeof url === 'string') {
normalizedRequest.url = url;

const queryFromAttribute = attributes[URL_QUERY];
if (typeof queryFromAttribute === 'string') {
normalizedRequest.query_string = queryFromAttribute;
} else {
const queryIndex = url.indexOf('?');
if (queryIndex !== -1) {
normalizedRequest.query_string = url.slice(queryIndex + 1);
}
}
}

return normalizedRequest;
}
41 changes: 23 additions & 18 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context } from '@opentelemetry/api';
import {
applySdkMetadata,
getCapturedScopesOnSpan,
getCurrentScope,
getGlobalScope,
getIsolationScope,
getRootSpan,
Expand All@@ -14,17 +11,17 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
import { ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attributes-with-logic-attached';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { getNormalizedRequestFromAttributes } from '../common/utils/getNormalizedRequestFromAttributes';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
Expand DownExpand Up@@ -101,6 +98,26 @@ export function init(options: VercelEdgeOptions = {}): void {

const client = vercelEdgeInit(opts);

// Next.js's OTel instrumentation samples root spans before the Sentry middleware wrapper can set
// `normalizedRequest` on the isolation scope. Seed it from span attributes so `tracesSampler` has access.
client?.on('beforeSampling', ({ spanAttributes }) => {
const spanType = spanAttributes[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'Middleware.execute' && spanType !== 'BaseServer.handleRequest') {
return;
}

// Clear the key before writing: `setSDKProcessingMetadata` merges into nested objects, so a partial request
// (or none at all) would otherwise keep stale fields (e.g. `query_string`) left on the (potentially shared)
// isolation scope by a previous request on a warm worker.
const isolationScope = getIsolationScope();
isolationScope.setSDKProcessingMetadata({ normalizedRequest: undefined });

const normalizedRequest = getNormalizedRequestFromAttributes(spanAttributes);
if (normalizedRequest) {
isolationScope.setSDKProcessingMetadata({ normalizedRequest });
}
});

client?.on('spanStart', span => {
const spanAttributes = spanToJSON(span).data;
const rootSpan = getRootSpan(span);
Expand All@@ -120,19 +137,7 @@ export function init(options: VercelEdgeOptions = {}): void {
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

if (isRootSpan) {
// todo: check if we can set request headers for edge on sdkProcessingMetadata
Expand Down
33 changes: 3 additions & 30 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
import { context } from '@opentelemetry/api';
import { HTTP_METHOD, HTTP_REQUEST_METHOD, HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { getIsolationScope, getRootSpan, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, spanToJSON } from '@sentry/core';
import { ATTR_NEXT_ROUTE, ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { maybeEnhanceServerComponentSpanName } from '../common/utils/tracingUtils';
import { maybeStartCronCheckIn } from './vercelCronsMonitoring';
import { maybeEnrichQueueConsumerSpan, maybeEnrichQueueProducerSpan } from './vercelQueuesMonitoring';
Expand DownExpand Up@@ -84,25 +75,7 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests. Root `Middleware.execute` spans need the same
// treatment since Next.js 16.3.0-canary.79
if (
(spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' ||
spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'Middleware.execute') &&
isRootSpan
) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

maybeEnhanceServerComponentSpanName(span, spanAttributes, rootSpanAttributes);

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
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'Jane Doe' });
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'John Doe' });
}
17 changes: 17 additions & 0 deletions dev-packages/e2e-tests/test-applications/nextjs-15/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { NextResponse } from 'next/server';
import type { NextRequest } from 'next/server';

export async function middleware(request: NextRequest) {
// Keep this invocation in-flight for a bit so a concurrent request to the other matched endpoint genuinely
// overlaps with it — the concurrency test in tests/middleware.test.ts relies on this overlap.
if (request.nextUrl.pathname === '/api/endpoint-behind-middleware-2') {
await new Promise(resolve => setTimeout(resolve, 300));
}

return NextResponse.next();
}

// See "Matching Paths" below to learn more
export const config = {
matcher: ['/api/endpoint-behind-middleware', '/api/endpoint-behind-middleware-2'],
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,21 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time and belongs to
// the request that is being sampled (guards against concurrent requests leaking into each other's sampling
// context). The middleware e2e tests time out and fail when the transaction is dropped here.
const { normalizedRequest } = samplingContext;
return Boolean(
normalizedRequest?.method &&
normalizedRequest?.url &&
normalizedRequest.url === samplingContext.attributes['http.target'],
);
}

return 1.0;
},
dataCollection: { userInfo: true },
transportOptions: {
// We are doing a lot of events at once in this test
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// The `tracesSampler` in `sentry.edge.config.ts` only samples `Middleware.execute` spans when `normalizedRequest`
// is available at sampling time, so this test times out if the request data does not reach the sampler.
test('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

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

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.contexts?.trace?.op).toBe('http.server.middleware');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// The `tracesSampler` additionally asserts that `normalizedRequest.url` matches the sampled span's own
// `http.target`, so a request leaking into the sampling context of a concurrent one drops that transaction
// and times this test out.
test('does not leak normalizedRequest between concurrent middleware invocations', async ({ request }) => {
const firstTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware'
);
});

const secondTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware-2'
);
});

await Promise.all([request.get('/api/endpoint-behind-middleware'), request.get('/api/endpoint-behind-middleware-2')]);

const [firstTransaction, secondTransaction] = await Promise.all([firstTransactionPromise, secondTransactionPromise]);

expect(firstTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(firstTransaction.request?.url).not.toContain('/api/endpoint-behind-middleware-2');
expect(secondTransaction.request?.url).toContain('/api/endpoint-behind-middleware-2');
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,16 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time.
// Test times out and fails when transaction is dropped
const { normalizedRequest } = samplingContext;
return Boolean(normalizedRequest?.url && normalizedRequest?.method);
}

return 1.0;
},
dataCollection: { userInfo: true },
// debug: true,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,21 @@ import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { isDevMode } from './isDevMode';

// TODO: Skipped until the Cloudflare Workers edge middleware setup emits middleware transactions reliably.
test.skip('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

await request.get('/api/endpoint-behind-middleware');

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('cloudflare');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// TODO: Middleware tests need SDK adjustments for Cloudflare Workers edge runtime
test.skip('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ test('Should create a transaction for middleware', async ({ request }) => {
expect(middlewareTransaction.contexts?.runtime?.name).toBe('node');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

expect(middlewareTransaction.request?.method).toBe('GET');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import { context } from '@opentelemetry/api';
import type { Span, SpanAttributes } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
setCapturedScopesOnSpan,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';

/**
* Forks the isolation scope for `BaseServer.handleRequest` / `Middleware.execute` root spans so that request-scoped
* data (e.g. `normalizedRequest`) stays isolated per request.
*/
export function maybeForkIsolationScopeForRootSpan(span: Span, spanAttributes: SpanAttributes | undefined): void {
const spanType = spanAttributes?.[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'BaseServer.handleRequest' && spanType !== 'Middleware.execute') {
return;
}

if (span !== getRootSpan(span)) {
return;
}

const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import {
HTTP_METHOD,
HTTP_REQUEST_METHOD,
HTTP_TARGET,
HTTP_URL,
URL_FULL,
URL_PATH,
URL_QUERY,
} from '@sentry/conventions/attributes';
import type { RequestEventData, SpanAttributes } from '@sentry/core';

/**
* Builds a partial `normalizedRequest` from OTel HTTP span attributes.
* Only method, URL, and query string can be derived — headers are not available as span attributes.
*/
export function getNormalizedRequestFromAttributes(attributes: SpanAttributes): RequestEventData | undefined {
// eslint-disable-next-line typescript/no-deprecated
const method = attributes[HTTP_REQUEST_METHOD] || attributes[HTTP_METHOD];

// eslint-disable-next-line typescript/no-deprecated
const url = attributes[URL_FULL] || attributes[HTTP_URL] || attributes[URL_PATH] || attributes[HTTP_TARGET];

if (typeof method !== 'string' && typeof url !== 'string') {
return undefined;
}

const normalizedRequest: RequestEventData = {};

if (typeof method === 'string') {
normalizedRequest.method = method;
}

if (typeof url === 'string') {
normalizedRequest.url = url;

const queryFromAttribute = attributes[URL_QUERY];
if (typeof queryFromAttribute === 'string') {
normalizedRequest.query_string = queryFromAttribute;
} else {
const queryIndex = url.indexOf('?');
if (queryIndex !== -1) {
normalizedRequest.query_string = url.slice(queryIndex + 1);
}
}
}

return normalizedRequest;
}
41 changes: 23 additions & 18 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context } from '@opentelemetry/api';
import {
applySdkMetadata,
getCapturedScopesOnSpan,
getCurrentScope,
getGlobalScope,
getIsolationScope,
getRootSpan,
Expand All@@ -14,17 +11,17 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
import { ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attributes-with-logic-attached';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { getNormalizedRequestFromAttributes } from '../common/utils/getNormalizedRequestFromAttributes';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
Expand DownExpand Up@@ -101,6 +98,26 @@ export function init(options: VercelEdgeOptions = {}): void {

const client = vercelEdgeInit(opts);

// Next.js's OTel instrumentation samples root spans before the Sentry middleware wrapper can set
// `normalizedRequest` on the isolation scope. Seed it from span attributes so `tracesSampler` has access.
client?.on('beforeSampling', ({ spanAttributes }) => {
const spanType = spanAttributes[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'Middleware.execute' && spanType !== 'BaseServer.handleRequest') {
return;
}

// Clear the key before writing: `setSDKProcessingMetadata` merges into nested objects, so a partial request
// (or none at all) would otherwise keep stale fields (e.g. `query_string`) left on the (potentially shared)
// isolation scope by a previous request on a warm worker.
const isolationScope = getIsolationScope();
isolationScope.setSDKProcessingMetadata({ normalizedRequest: undefined });

const normalizedRequest = getNormalizedRequestFromAttributes(spanAttributes);
if (normalizedRequest) {
isolationScope.setSDKProcessingMetadata({ normalizedRequest });
}
});

client?.on('spanStart', span => {
const spanAttributes = spanToJSON(span).data;
const rootSpan = getRootSpan(span);
Expand All@@ -120,19 +137,7 @@ export function init(options: VercelEdgeOptions = {}): void {
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

if (isRootSpan) {
// todo: check if we can set request headers for edge on sdkProcessingMetadata
Expand Down
33 changes: 3 additions & 30 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
import { context } from '@opentelemetry/api';
import { HTTP_METHOD, HTTP_REQUEST_METHOD, HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { getIsolationScope, getRootSpan, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, spanToJSON } from '@sentry/core';
import { ATTR_NEXT_ROUTE, ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { maybeEnhanceServerComponentSpanName } from '../common/utils/tracingUtils';
import { maybeStartCronCheckIn } from './vercelCronsMonitoring';
import { maybeEnrichQueueConsumerSpan, maybeEnrichQueueProducerSpan } from './vercelQueuesMonitoring';
Expand DownExpand Up@@ -84,25 +75,7 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests. Root `Middleware.execute` spans need the same
// treatment since Next.js 16.3.0-canary.79
if (
(spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' ||
spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'Middleware.execute') &&
isRootSpan
) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

maybeEnhanceServerComponentSpanName(span, spanAttributes, rootSpanAttributes);

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
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'Jane Doe' });
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'John Doe' });
}
17 changes: 17 additions & 0 deletions dev-packages/e2e-tests/test-applications/nextjs-15/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { NextResponse } from 'next/server';
import type { NextRequest } from 'next/server';

export async function middleware(request: NextRequest) {
// Keep this invocation in-flight for a bit so a concurrent request to the other matched endpoint genuinely
// overlaps with it — the concurrency test in tests/middleware.test.ts relies on this overlap.
if (request.nextUrl.pathname === '/api/endpoint-behind-middleware-2') {
await new Promise(resolve => setTimeout(resolve, 300));
}

return NextResponse.next();
}

// See "Matching Paths" below to learn more
export const config = {
matcher: ['/api/endpoint-behind-middleware', '/api/endpoint-behind-middleware-2'],
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,21 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time and belongs to
// the request that is being sampled (guards against concurrent requests leaking into each other's sampling
// context). The middleware e2e tests time out and fail when the transaction is dropped here.
const { normalizedRequest } = samplingContext;
return Boolean(
normalizedRequest?.method &&
normalizedRequest?.url &&
normalizedRequest.url === samplingContext.attributes['http.target'],
);
}

return 1.0;
},
dataCollection: { userInfo: true },
transportOptions: {
// We are doing a lot of events at once in this test
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// The `tracesSampler` in `sentry.edge.config.ts` only samples `Middleware.execute` spans when `normalizedRequest`
// is available at sampling time, so this test times out if the request data does not reach the sampler.
test('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

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

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.contexts?.trace?.op).toBe('http.server.middleware');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// The `tracesSampler` additionally asserts that `normalizedRequest.url` matches the sampled span's own
// `http.target`, so a request leaking into the sampling context of a concurrent one drops that transaction
// and times this test out.
test('does not leak normalizedRequest between concurrent middleware invocations', async ({ request }) => {
const firstTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware'
);
});

const secondTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware-2'
);
});

await Promise.all([request.get('/api/endpoint-behind-middleware'), request.get('/api/endpoint-behind-middleware-2')]);

const [firstTransaction, secondTransaction] = await Promise.all([firstTransactionPromise, secondTransactionPromise]);

expect(firstTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(firstTransaction.request?.url).not.toContain('/api/endpoint-behind-middleware-2');
expect(secondTransaction.request?.url).toContain('/api/endpoint-behind-middleware-2');
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,16 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time.
// Test times out and fails when transaction is dropped
const { normalizedRequest } = samplingContext;
return Boolean(normalizedRequest?.url && normalizedRequest?.method);
}

return 1.0;
},
dataCollection: { userInfo: true },
// debug: true,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,21 @@ import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { isDevMode } from './isDevMode';

// TODO: Skipped until the Cloudflare Workers edge middleware setup emits middleware transactions reliably.
test.skip('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

await request.get('/api/endpoint-behind-middleware');

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('cloudflare');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// TODO: Middleware tests need SDK adjustments for Cloudflare Workers edge runtime
test.skip('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ test('Should create a transaction for middleware', async ({ request }) => {
expect(middlewareTransaction.contexts?.runtime?.name).toBe('node');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

expect(middlewareTransaction.request?.method).toBe('GET');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import { context } from '@opentelemetry/api';
import type { Span, SpanAttributes } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
setCapturedScopesOnSpan,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';

/**
* Forks the isolation scope for `BaseServer.handleRequest` / `Middleware.execute` root spans so that request-scoped
* data (e.g. `normalizedRequest`) stays isolated per request.
*/
export function maybeForkIsolationScopeForRootSpan(span: Span, spanAttributes: SpanAttributes | undefined): void {
const spanType = spanAttributes?.[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'BaseServer.handleRequest' && spanType !== 'Middleware.execute') {
return;
}

if (span !== getRootSpan(span)) {
return;
}

const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import {
HTTP_METHOD,
HTTP_REQUEST_METHOD,
HTTP_TARGET,
HTTP_URL,
URL_FULL,
URL_PATH,
URL_QUERY,
} from '@sentry/conventions/attributes';
import type { RequestEventData, SpanAttributes } from '@sentry/core';

/**
* Builds a partial `normalizedRequest` from OTel HTTP span attributes.
* Only method, URL, and query string can be derived — headers are not available as span attributes.
*/
export function getNormalizedRequestFromAttributes(attributes: SpanAttributes): RequestEventData | undefined {
// eslint-disable-next-line typescript/no-deprecated
const method = attributes[HTTP_REQUEST_METHOD] || attributes[HTTP_METHOD];

// eslint-disable-next-line typescript/no-deprecated
const url = attributes[URL_FULL] || attributes[HTTP_URL] || attributes[URL_PATH] || attributes[HTTP_TARGET];

if (typeof method !== 'string' && typeof url !== 'string') {
return undefined;
}

const normalizedRequest: RequestEventData = {};

if (typeof method === 'string') {
normalizedRequest.method = method;
}

if (typeof url === 'string') {
normalizedRequest.url = url;

const queryFromAttribute = attributes[URL_QUERY];
if (typeof queryFromAttribute === 'string') {
normalizedRequest.query_string = queryFromAttribute;
} else {
const queryIndex = url.indexOf('?');
if (queryIndex !== -1) {
normalizedRequest.query_string = url.slice(queryIndex + 1);
}
}
}

return normalizedRequest;
}
41 changes: 23 additions & 18 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context } from '@opentelemetry/api';
import {
applySdkMetadata,
getCapturedScopesOnSpan,
getCurrentScope,
getGlobalScope,
getIsolationScope,
getRootSpan,
Expand All@@ -14,17 +11,17 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
import { ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attributes-with-logic-attached';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { getNormalizedRequestFromAttributes } from '../common/utils/getNormalizedRequestFromAttributes';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
Expand DownExpand Up@@ -101,6 +98,26 @@ export function init(options: VercelEdgeOptions = {}): void {

const client = vercelEdgeInit(opts);

// Next.js's OTel instrumentation samples root spans before the Sentry middleware wrapper can set
// `normalizedRequest` on the isolation scope. Seed it from span attributes so `tracesSampler` has access.
client?.on('beforeSampling', ({ spanAttributes }) => {
const spanType = spanAttributes[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'Middleware.execute' && spanType !== 'BaseServer.handleRequest') {
return;
}

// Clear the key before writing: `setSDKProcessingMetadata` merges into nested objects, so a partial request
// (or none at all) would otherwise keep stale fields (e.g. `query_string`) left on the (potentially shared)
// isolation scope by a previous request on a warm worker.
const isolationScope = getIsolationScope();
isolationScope.setSDKProcessingMetadata({ normalizedRequest: undefined });

const normalizedRequest = getNormalizedRequestFromAttributes(spanAttributes);
if (normalizedRequest) {
isolationScope.setSDKProcessingMetadata({ normalizedRequest });
}
});

client?.on('spanStart', span => {
const spanAttributes = spanToJSON(span).data;
const rootSpan = getRootSpan(span);
Expand All@@ -120,19 +137,7 @@ export function init(options: VercelEdgeOptions = {}): void {
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

if (isRootSpan) {
// todo: check if we can set request headers for edge on sdkProcessingMetadata
Expand Down
33 changes: 3 additions & 30 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
import { context } from '@opentelemetry/api';
import { HTTP_METHOD, HTTP_REQUEST_METHOD, HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { getIsolationScope, getRootSpan, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, spanToJSON } from '@sentry/core';
import { ATTR_NEXT_ROUTE, ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { maybeEnhanceServerComponentSpanName } from '../common/utils/tracingUtils';
import { maybeStartCronCheckIn } from './vercelCronsMonitoring';
import { maybeEnrichQueueConsumerSpan, maybeEnrichQueueProducerSpan } from './vercelQueuesMonitoring';
Expand DownExpand Up@@ -84,25 +75,7 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests. Root `Middleware.execute` spans need the same
// treatment since Next.js 16.3.0-canary.79
if (
(spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' ||
spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'Middleware.execute') &&
isRootSpan
) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

maybeEnhanceServerComponentSpanName(span, spanAttributes, rootSpanAttributes);

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
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'Jane Doe' });
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'John Doe' });
}
17 changes: 17 additions & 0 deletions dev-packages/e2e-tests/test-applications/nextjs-15/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { NextResponse } from 'next/server';
import type { NextRequest } from 'next/server';

export async function middleware(request: NextRequest) {
// Keep this invocation in-flight for a bit so a concurrent request to the other matched endpoint genuinely
// overlaps with it — the concurrency test in tests/middleware.test.ts relies on this overlap.
if (request.nextUrl.pathname === '/api/endpoint-behind-middleware-2') {
await new Promise(resolve => setTimeout(resolve, 300));
}

return NextResponse.next();
}

// See "Matching Paths" below to learn more
export const config = {
matcher: ['/api/endpoint-behind-middleware', '/api/endpoint-behind-middleware-2'],
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,21 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time and belongs to
// the request that is being sampled (guards against concurrent requests leaking into each other's sampling
// context). The middleware e2e tests time out and fail when the transaction is dropped here.
const { normalizedRequest } = samplingContext;
return Boolean(
normalizedRequest?.method &&
normalizedRequest?.url &&
normalizedRequest.url === samplingContext.attributes['http.target'],
);
}

return 1.0;
},
dataCollection: { userInfo: true },
transportOptions: {
// We are doing a lot of events at once in this test
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// The `tracesSampler` in `sentry.edge.config.ts` only samples `Middleware.execute` spans when `normalizedRequest`
// is available at sampling time, so this test times out if the request data does not reach the sampler.
test('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

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

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.contexts?.trace?.op).toBe('http.server.middleware');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// The `tracesSampler` additionally asserts that `normalizedRequest.url` matches the sampled span's own
// `http.target`, so a request leaking into the sampling context of a concurrent one drops that transaction
// and times this test out.
test('does not leak normalizedRequest between concurrent middleware invocations', async ({ request }) => {
const firstTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware'
);
});

const secondTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware-2'
);
});

await Promise.all([request.get('/api/endpoint-behind-middleware'), request.get('/api/endpoint-behind-middleware-2')]);

const [firstTransaction, secondTransaction] = await Promise.all([firstTransactionPromise, secondTransactionPromise]);

expect(firstTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(firstTransaction.request?.url).not.toContain('/api/endpoint-behind-middleware-2');
expect(secondTransaction.request?.url).toContain('/api/endpoint-behind-middleware-2');
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,16 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time.
// Test times out and fails when transaction is dropped
const { normalizedRequest } = samplingContext;
return Boolean(normalizedRequest?.url && normalizedRequest?.method);
}

return 1.0;
},
dataCollection: { userInfo: true },
// debug: true,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,21 @@ import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { isDevMode } from './isDevMode';

// TODO: Skipped until the Cloudflare Workers edge middleware setup emits middleware transactions reliably.
test.skip('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

await request.get('/api/endpoint-behind-middleware');

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('cloudflare');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// TODO: Middleware tests need SDK adjustments for Cloudflare Workers edge runtime
test.skip('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ test('Should create a transaction for middleware', async ({ request }) => {
expect(middlewareTransaction.contexts?.runtime?.name).toBe('node');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

expect(middlewareTransaction.request?.method).toBe('GET');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import { context } from '@opentelemetry/api';
import type { Span, SpanAttributes } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
setCapturedScopesOnSpan,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';

/**
* Forks the isolation scope for `BaseServer.handleRequest` / `Middleware.execute` root spans so that request-scoped
* data (e.g. `normalizedRequest`) stays isolated per request.
*/
export function maybeForkIsolationScopeForRootSpan(span: Span, spanAttributes: SpanAttributes | undefined): void {
const spanType = spanAttributes?.[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'BaseServer.handleRequest' && spanType !== 'Middleware.execute') {
return;
}

if (span !== getRootSpan(span)) {
return;
}

const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import {
HTTP_METHOD,
HTTP_REQUEST_METHOD,
HTTP_TARGET,
HTTP_URL,
URL_FULL,
URL_PATH,
URL_QUERY,
} from '@sentry/conventions/attributes';
import type { RequestEventData, SpanAttributes } from '@sentry/core';

/**
* Builds a partial `normalizedRequest` from OTel HTTP span attributes.
* Only method, URL, and query string can be derived — headers are not available as span attributes.
*/
export function getNormalizedRequestFromAttributes(attributes: SpanAttributes): RequestEventData | undefined {
// eslint-disable-next-line typescript/no-deprecated
const method = attributes[HTTP_REQUEST_METHOD] || attributes[HTTP_METHOD];

// eslint-disable-next-line typescript/no-deprecated
const url = attributes[URL_FULL] || attributes[HTTP_URL] || attributes[URL_PATH] || attributes[HTTP_TARGET];

if (typeof method !== 'string' && typeof url !== 'string') {
return undefined;
}

const normalizedRequest: RequestEventData = {};

if (typeof method === 'string') {
normalizedRequest.method = method;
}

if (typeof url === 'string') {
normalizedRequest.url = url;

const queryFromAttribute = attributes[URL_QUERY];
if (typeof queryFromAttribute === 'string') {
normalizedRequest.query_string = queryFromAttribute;
} else {
const queryIndex = url.indexOf('?');
if (queryIndex !== -1) {
normalizedRequest.query_string = url.slice(queryIndex + 1);
}
}
}

return normalizedRequest;
}
41 changes: 23 additions & 18 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context } from '@opentelemetry/api';
import {
applySdkMetadata,
getCapturedScopesOnSpan,
getCurrentScope,
getGlobalScope,
getIsolationScope,
getRootSpan,
Expand All@@ -14,17 +11,17 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
import { ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attributes-with-logic-attached';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { getNormalizedRequestFromAttributes } from '../common/utils/getNormalizedRequestFromAttributes';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
Expand DownExpand Up@@ -101,6 +98,26 @@ export function init(options: VercelEdgeOptions = {}): void {

const client = vercelEdgeInit(opts);

// Next.js's OTel instrumentation samples root spans before the Sentry middleware wrapper can set
// `normalizedRequest` on the isolation scope. Seed it from span attributes so `tracesSampler` has access.
client?.on('beforeSampling', ({ spanAttributes }) => {
const spanType = spanAttributes[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'Middleware.execute' && spanType !== 'BaseServer.handleRequest') {
return;
}

// Clear the key before writing: `setSDKProcessingMetadata` merges into nested objects, so a partial request
// (or none at all) would otherwise keep stale fields (e.g. `query_string`) left on the (potentially shared)
// isolation scope by a previous request on a warm worker.
const isolationScope = getIsolationScope();
isolationScope.setSDKProcessingMetadata({ normalizedRequest: undefined });

const normalizedRequest = getNormalizedRequestFromAttributes(spanAttributes);
if (normalizedRequest) {
isolationScope.setSDKProcessingMetadata({ normalizedRequest });
}
});

client?.on('spanStart', span => {
const spanAttributes = spanToJSON(span).data;
const rootSpan = getRootSpan(span);
Expand All@@ -120,19 +137,7 @@ export function init(options: VercelEdgeOptions = {}): void {
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

if (isRootSpan) {
// todo: check if we can set request headers for edge on sdkProcessingMetadata
Expand Down
33 changes: 3 additions & 30 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
import { context } from '@opentelemetry/api';
import { HTTP_METHOD, HTTP_REQUEST_METHOD, HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { getIsolationScope, getRootSpan, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, spanToJSON } from '@sentry/core';
import { ATTR_NEXT_ROUTE, ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { maybeEnhanceServerComponentSpanName } from '../common/utils/tracingUtils';
import { maybeStartCronCheckIn } from './vercelCronsMonitoring';
import { maybeEnrichQueueConsumerSpan, maybeEnrichQueueProducerSpan } from './vercelQueuesMonitoring';
Expand DownExpand Up@@ -84,25 +75,7 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests. Root `Middleware.execute` spans need the same
// treatment since Next.js 16.3.0-canary.79
if (
(spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' ||
spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'Middleware.execute') &&
isRootSpan
) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

maybeEnhanceServerComponentSpanName(span, spanAttributes, rootSpanAttributes);

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
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'Jane Doe' });
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'John Doe' });
}
17 changes: 17 additions & 0 deletions dev-packages/e2e-tests/test-applications/nextjs-15/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { NextResponse } from 'next/server';
import type { NextRequest } from 'next/server';

export async function middleware(request: NextRequest) {
// Keep this invocation in-flight for a bit so a concurrent request to the other matched endpoint genuinely
// overlaps with it — the concurrency test in tests/middleware.test.ts relies on this overlap.
if (request.nextUrl.pathname === '/api/endpoint-behind-middleware-2') {
await new Promise(resolve => setTimeout(resolve, 300));
}

return NextResponse.next();
}

// See "Matching Paths" below to learn more
export const config = {
matcher: ['/api/endpoint-behind-middleware', '/api/endpoint-behind-middleware-2'],
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,21 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time and belongs to
// the request that is being sampled (guards against concurrent requests leaking into each other's sampling
// context). The middleware e2e tests time out and fail when the transaction is dropped here.
const { normalizedRequest } = samplingContext;
return Boolean(
normalizedRequest?.method &&
normalizedRequest?.url &&
normalizedRequest.url === samplingContext.attributes['http.target'],
);
}

return 1.0;
},
dataCollection: { userInfo: true },
transportOptions: {
// We are doing a lot of events at once in this test
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// The `tracesSampler` in `sentry.edge.config.ts` only samples `Middleware.execute` spans when `normalizedRequest`
// is available at sampling time, so this test times out if the request data does not reach the sampler.
test('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

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

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.contexts?.trace?.op).toBe('http.server.middleware');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// The `tracesSampler` additionally asserts that `normalizedRequest.url` matches the sampled span's own
// `http.target`, so a request leaking into the sampling context of a concurrent one drops that transaction
// and times this test out.
test('does not leak normalizedRequest between concurrent middleware invocations', async ({ request }) => {
const firstTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware'
);
});

const secondTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware-2'
);
});

await Promise.all([request.get('/api/endpoint-behind-middleware'), request.get('/api/endpoint-behind-middleware-2')]);

const [firstTransaction, secondTransaction] = await Promise.all([firstTransactionPromise, secondTransactionPromise]);

expect(firstTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(firstTransaction.request?.url).not.toContain('/api/endpoint-behind-middleware-2');
expect(secondTransaction.request?.url).toContain('/api/endpoint-behind-middleware-2');
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,16 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time.
// Test times out and fails when transaction is dropped
const { normalizedRequest } = samplingContext;
return Boolean(normalizedRequest?.url && normalizedRequest?.method);
}

return 1.0;
},
dataCollection: { userInfo: true },
// debug: true,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,21 @@ import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { isDevMode } from './isDevMode';

// TODO: Skipped until the Cloudflare Workers edge middleware setup emits middleware transactions reliably.
test.skip('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

await request.get('/api/endpoint-behind-middleware');

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('cloudflare');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// TODO: Middleware tests need SDK adjustments for Cloudflare Workers edge runtime
test.skip('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ test('Should create a transaction for middleware', async ({ request }) => {
expect(middlewareTransaction.contexts?.runtime?.name).toBe('node');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

expect(middlewareTransaction.request?.method).toBe('GET');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import { context } from '@opentelemetry/api';
import type { Span, SpanAttributes } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
setCapturedScopesOnSpan,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';

/**
* Forks the isolation scope for `BaseServer.handleRequest` / `Middleware.execute` root spans so that request-scoped
* data (e.g. `normalizedRequest`) stays isolated per request.
*/
export function maybeForkIsolationScopeForRootSpan(span: Span, spanAttributes: SpanAttributes | undefined): void {
const spanType = spanAttributes?.[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'BaseServer.handleRequest' && spanType !== 'Middleware.execute') {
return;
}

if (span !== getRootSpan(span)) {
return;
}

const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import {
HTTP_METHOD,
HTTP_REQUEST_METHOD,
HTTP_TARGET,
HTTP_URL,
URL_FULL,
URL_PATH,
URL_QUERY,
} from '@sentry/conventions/attributes';
import type { RequestEventData, SpanAttributes } from '@sentry/core';

/**
* Builds a partial `normalizedRequest` from OTel HTTP span attributes.
* Only method, URL, and query string can be derived — headers are not available as span attributes.
*/
export function getNormalizedRequestFromAttributes(attributes: SpanAttributes): RequestEventData | undefined {
// eslint-disable-next-line typescript/no-deprecated
const method = attributes[HTTP_REQUEST_METHOD] || attributes[HTTP_METHOD];

// eslint-disable-next-line typescript/no-deprecated
const url = attributes[URL_FULL] || attributes[HTTP_URL] || attributes[URL_PATH] || attributes[HTTP_TARGET];

if (typeof method !== 'string' && typeof url !== 'string') {
return undefined;
}

const normalizedRequest: RequestEventData = {};

if (typeof method === 'string') {
normalizedRequest.method = method;
}

if (typeof url === 'string') {
normalizedRequest.url = url;

const queryFromAttribute = attributes[URL_QUERY];
if (typeof queryFromAttribute === 'string') {
normalizedRequest.query_string = queryFromAttribute;
} else {
const queryIndex = url.indexOf('?');
if (queryIndex !== -1) {
normalizedRequest.query_string = url.slice(queryIndex + 1);
}
}
}

return normalizedRequest;
}
41 changes: 23 additions & 18 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context } from '@opentelemetry/api';
import {
applySdkMetadata,
getCapturedScopesOnSpan,
getCurrentScope,
getGlobalScope,
getIsolationScope,
getRootSpan,
Expand All@@ -14,17 +11,17 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
import { ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attributes-with-logic-attached';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { getNormalizedRequestFromAttributes } from '../common/utils/getNormalizedRequestFromAttributes';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
Expand DownExpand Up@@ -101,6 +98,26 @@ export function init(options: VercelEdgeOptions = {}): void {

const client = vercelEdgeInit(opts);

// Next.js's OTel instrumentation samples root spans before the Sentry middleware wrapper can set
// `normalizedRequest` on the isolation scope. Seed it from span attributes so `tracesSampler` has access.
client?.on('beforeSampling', ({ spanAttributes }) => {
const spanType = spanAttributes[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'Middleware.execute' && spanType !== 'BaseServer.handleRequest') {
return;
}

// Clear the key before writing: `setSDKProcessingMetadata` merges into nested objects, so a partial request
// (or none at all) would otherwise keep stale fields (e.g. `query_string`) left on the (potentially shared)
// isolation scope by a previous request on a warm worker.
const isolationScope = getIsolationScope();
isolationScope.setSDKProcessingMetadata({ normalizedRequest: undefined });

const normalizedRequest = getNormalizedRequestFromAttributes(spanAttributes);
if (normalizedRequest) {
isolationScope.setSDKProcessingMetadata({ normalizedRequest });
}
});

client?.on('spanStart', span => {
const spanAttributes = spanToJSON(span).data;
const rootSpan = getRootSpan(span);
Expand All@@ -120,19 +137,7 @@ export function init(options: VercelEdgeOptions = {}): void {
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

if (isRootSpan) {
// todo: check if we can set request headers for edge on sdkProcessingMetadata
Expand Down
33 changes: 3 additions & 30 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
import { context } from '@opentelemetry/api';
import { HTTP_METHOD, HTTP_REQUEST_METHOD, HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { getIsolationScope, getRootSpan, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, spanToJSON } from '@sentry/core';
import { ATTR_NEXT_ROUTE, ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { maybeEnhanceServerComponentSpanName } from '../common/utils/tracingUtils';
import { maybeStartCronCheckIn } from './vercelCronsMonitoring';
import { maybeEnrichQueueConsumerSpan, maybeEnrichQueueProducerSpan } from './vercelQueuesMonitoring';
Expand DownExpand Up@@ -84,25 +75,7 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests. Root `Middleware.execute` spans need the same
// treatment since Next.js 16.3.0-canary.79
if (
(spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' ||
spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'Middleware.execute') &&
isRootSpan
) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

maybeEnhanceServerComponentSpanName(span, spanAttributes, rootSpanAttributes);

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
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'Jane Doe' });
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'John Doe' });
}
17 changes: 17 additions & 0 deletions dev-packages/e2e-tests/test-applications/nextjs-15/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { NextResponse } from 'next/server';
import type { NextRequest } from 'next/server';

export async function middleware(request: NextRequest) {
// Keep this invocation in-flight for a bit so a concurrent request to the other matched endpoint genuinely
// overlaps with it — the concurrency test in tests/middleware.test.ts relies on this overlap.
if (request.nextUrl.pathname === '/api/endpoint-behind-middleware-2') {
await new Promise(resolve => setTimeout(resolve, 300));
}

return NextResponse.next();
}

// See "Matching Paths" below to learn more
export const config = {
matcher: ['/api/endpoint-behind-middleware', '/api/endpoint-behind-middleware-2'],
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,21 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time and belongs to
// the request that is being sampled (guards against concurrent requests leaking into each other's sampling
// context). The middleware e2e tests time out and fail when the transaction is dropped here.
const { normalizedRequest } = samplingContext;
return Boolean(
normalizedRequest?.method &&
normalizedRequest?.url &&
normalizedRequest.url === samplingContext.attributes['http.target'],
);
}

return 1.0;
},
dataCollection: { userInfo: true },
transportOptions: {
// We are doing a lot of events at once in this test
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// The `tracesSampler` in `sentry.edge.config.ts` only samples `Middleware.execute` spans when `normalizedRequest`
// is available at sampling time, so this test times out if the request data does not reach the sampler.
test('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

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

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.contexts?.trace?.op).toBe('http.server.middleware');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// The `tracesSampler` additionally asserts that `normalizedRequest.url` matches the sampled span's own
// `http.target`, so a request leaking into the sampling context of a concurrent one drops that transaction
// and times this test out.
test('does not leak normalizedRequest between concurrent middleware invocations', async ({ request }) => {
const firstTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware'
);
});

const secondTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware-2'
);
});

await Promise.all([request.get('/api/endpoint-behind-middleware'), request.get('/api/endpoint-behind-middleware-2')]);

const [firstTransaction, secondTransaction] = await Promise.all([firstTransactionPromise, secondTransactionPromise]);

expect(firstTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(firstTransaction.request?.url).not.toContain('/api/endpoint-behind-middleware-2');
expect(secondTransaction.request?.url).toContain('/api/endpoint-behind-middleware-2');
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,16 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time.
// Test times out and fails when transaction is dropped
const { normalizedRequest } = samplingContext;
return Boolean(normalizedRequest?.url && normalizedRequest?.method);
}

return 1.0;
},
dataCollection: { userInfo: true },
// debug: true,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,21 @@ import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { isDevMode } from './isDevMode';

// TODO: Skipped until the Cloudflare Workers edge middleware setup emits middleware transactions reliably.
test.skip('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

await request.get('/api/endpoint-behind-middleware');

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('cloudflare');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// TODO: Middleware tests need SDK adjustments for Cloudflare Workers edge runtime
test.skip('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ test('Should create a transaction for middleware', async ({ request }) => {
expect(middlewareTransaction.contexts?.runtime?.name).toBe('node');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

expect(middlewareTransaction.request?.method).toBe('GET');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import { context } from '@opentelemetry/api';
import type { Span, SpanAttributes } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
setCapturedScopesOnSpan,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';

/**
* Forks the isolation scope for `BaseServer.handleRequest` / `Middleware.execute` root spans so that request-scoped
* data (e.g. `normalizedRequest`) stays isolated per request.
*/
export function maybeForkIsolationScopeForRootSpan(span: Span, spanAttributes: SpanAttributes | undefined): void {
const spanType = spanAttributes?.[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'BaseServer.handleRequest' && spanType !== 'Middleware.execute') {
return;
}

if (span !== getRootSpan(span)) {
return;
}

const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import {
HTTP_METHOD,
HTTP_REQUEST_METHOD,
HTTP_TARGET,
HTTP_URL,
URL_FULL,
URL_PATH,
URL_QUERY,
} from '@sentry/conventions/attributes';
import type { RequestEventData, SpanAttributes } from '@sentry/core';

/**
* Builds a partial `normalizedRequest` from OTel HTTP span attributes.
* Only method, URL, and query string can be derived — headers are not available as span attributes.
*/
export function getNormalizedRequestFromAttributes(attributes: SpanAttributes): RequestEventData | undefined {
// eslint-disable-next-line typescript/no-deprecated
const method = attributes[HTTP_REQUEST_METHOD] || attributes[HTTP_METHOD];

// eslint-disable-next-line typescript/no-deprecated
const url = attributes[URL_FULL] || attributes[HTTP_URL] || attributes[URL_PATH] || attributes[HTTP_TARGET];

if (typeof method !== 'string' && typeof url !== 'string') {
return undefined;
}

const normalizedRequest: RequestEventData = {};

if (typeof method === 'string') {
normalizedRequest.method = method;
}

if (typeof url === 'string') {
normalizedRequest.url = url;

const queryFromAttribute = attributes[URL_QUERY];
if (typeof queryFromAttribute === 'string') {
normalizedRequest.query_string = queryFromAttribute;
} else {
const queryIndex = url.indexOf('?');
if (queryIndex !== -1) {
normalizedRequest.query_string = url.slice(queryIndex + 1);
}
}
}

return normalizedRequest;
}
41 changes: 23 additions & 18 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context } from '@opentelemetry/api';
import {
applySdkMetadata,
getCapturedScopesOnSpan,
getCurrentScope,
getGlobalScope,
getIsolationScope,
getRootSpan,
Expand All@@ -14,17 +11,17 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
import { ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attributes-with-logic-attached';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { getNormalizedRequestFromAttributes } from '../common/utils/getNormalizedRequestFromAttributes';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
Expand DownExpand Up@@ -101,6 +98,26 @@ export function init(options: VercelEdgeOptions = {}): void {

const client = vercelEdgeInit(opts);

// Next.js's OTel instrumentation samples root spans before the Sentry middleware wrapper can set
// `normalizedRequest` on the isolation scope. Seed it from span attributes so `tracesSampler` has access.
client?.on('beforeSampling', ({ spanAttributes }) => {
const spanType = spanAttributes[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'Middleware.execute' && spanType !== 'BaseServer.handleRequest') {
return;
}

// Clear the key before writing: `setSDKProcessingMetadata` merges into nested objects, so a partial request
// (or none at all) would otherwise keep stale fields (e.g. `query_string`) left on the (potentially shared)
// isolation scope by a previous request on a warm worker.
const isolationScope = getIsolationScope();
isolationScope.setSDKProcessingMetadata({ normalizedRequest: undefined });

const normalizedRequest = getNormalizedRequestFromAttributes(spanAttributes);
if (normalizedRequest) {
isolationScope.setSDKProcessingMetadata({ normalizedRequest });
}
});

client?.on('spanStart', span => {
const spanAttributes = spanToJSON(span).data;
const rootSpan = getRootSpan(span);
Expand All@@ -120,19 +137,7 @@ export function init(options: VercelEdgeOptions = {}): void {
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

if (isRootSpan) {
// todo: check if we can set request headers for edge on sdkProcessingMetadata
Expand Down
33 changes: 3 additions & 30 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
import { context } from '@opentelemetry/api';
import { HTTP_METHOD, HTTP_REQUEST_METHOD, HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { getIsolationScope, getRootSpan, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, spanToJSON } from '@sentry/core';
import { ATTR_NEXT_ROUTE, ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { maybeEnhanceServerComponentSpanName } from '../common/utils/tracingUtils';
import { maybeStartCronCheckIn } from './vercelCronsMonitoring';
import { maybeEnrichQueueConsumerSpan, maybeEnrichQueueProducerSpan } from './vercelQueuesMonitoring';
Expand DownExpand Up@@ -84,25 +75,7 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests. Root `Middleware.execute` spans need the same
// treatment since Next.js 16.3.0-canary.79
if (
(spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' ||
spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'Middleware.execute') &&
isRootSpan
) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

maybeEnhanceServerComponentSpanName(span, spanAttributes, rootSpanAttributes);

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
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'Jane Doe' });
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'John Doe' });
}
17 changes: 17 additions & 0 deletions dev-packages/e2e-tests/test-applications/nextjs-15/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { NextResponse } from 'next/server';
import type { NextRequest } from 'next/server';

export async function middleware(request: NextRequest) {
// Keep this invocation in-flight for a bit so a concurrent request to the other matched endpoint genuinely
// overlaps with it — the concurrency test in tests/middleware.test.ts relies on this overlap.
if (request.nextUrl.pathname === '/api/endpoint-behind-middleware-2') {
await new Promise(resolve => setTimeout(resolve, 300));
}

return NextResponse.next();
}

// See "Matching Paths" below to learn more
export const config = {
matcher: ['/api/endpoint-behind-middleware', '/api/endpoint-behind-middleware-2'],
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,21 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time and belongs to
// the request that is being sampled (guards against concurrent requests leaking into each other's sampling
// context). The middleware e2e tests time out and fail when the transaction is dropped here.
const { normalizedRequest } = samplingContext;
return Boolean(
normalizedRequest?.method &&
normalizedRequest?.url &&
normalizedRequest.url === samplingContext.attributes['http.target'],
);
}

return 1.0;
},
dataCollection: { userInfo: true },
transportOptions: {
// We are doing a lot of events at once in this test
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// The `tracesSampler` in `sentry.edge.config.ts` only samples `Middleware.execute` spans when `normalizedRequest`
// is available at sampling time, so this test times out if the request data does not reach the sampler.
test('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

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

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.contexts?.trace?.op).toBe('http.server.middleware');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// The `tracesSampler` additionally asserts that `normalizedRequest.url` matches the sampled span's own
// `http.target`, so a request leaking into the sampling context of a concurrent one drops that transaction
// and times this test out.
test('does not leak normalizedRequest between concurrent middleware invocations', async ({ request }) => {
const firstTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware'
);
});

const secondTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware-2'
);
});

await Promise.all([request.get('/api/endpoint-behind-middleware'), request.get('/api/endpoint-behind-middleware-2')]);

const [firstTransaction, secondTransaction] = await Promise.all([firstTransactionPromise, secondTransactionPromise]);

expect(firstTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(firstTransaction.request?.url).not.toContain('/api/endpoint-behind-middleware-2');
expect(secondTransaction.request?.url).toContain('/api/endpoint-behind-middleware-2');
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,16 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time.
// Test times out and fails when transaction is dropped
const { normalizedRequest } = samplingContext;
return Boolean(normalizedRequest?.url && normalizedRequest?.method);
}

return 1.0;
},
dataCollection: { userInfo: true },
// debug: true,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,21 @@ import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { isDevMode } from './isDevMode';

// TODO: Skipped until the Cloudflare Workers edge middleware setup emits middleware transactions reliably.
test.skip('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

await request.get('/api/endpoint-behind-middleware');

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('cloudflare');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// TODO: Middleware tests need SDK adjustments for Cloudflare Workers edge runtime
test.skip('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ test('Should create a transaction for middleware', async ({ request }) => {
expect(middlewareTransaction.contexts?.runtime?.name).toBe('node');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

expect(middlewareTransaction.request?.method).toBe('GET');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import { context } from '@opentelemetry/api';
import type { Span, SpanAttributes } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
setCapturedScopesOnSpan,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';

/**
* Forks the isolation scope for `BaseServer.handleRequest` / `Middleware.execute` root spans so that request-scoped
* data (e.g. `normalizedRequest`) stays isolated per request.
*/
export function maybeForkIsolationScopeForRootSpan(span: Span, spanAttributes: SpanAttributes | undefined): void {
const spanType = spanAttributes?.[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'BaseServer.handleRequest' && spanType !== 'Middleware.execute') {
return;
}

if (span !== getRootSpan(span)) {
return;
}

const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import {
HTTP_METHOD,
HTTP_REQUEST_METHOD,
HTTP_TARGET,
HTTP_URL,
URL_FULL,
URL_PATH,
URL_QUERY,
} from '@sentry/conventions/attributes';
import type { RequestEventData, SpanAttributes } from '@sentry/core';

/**
* Builds a partial `normalizedRequest` from OTel HTTP span attributes.
* Only method, URL, and query string can be derived — headers are not available as span attributes.
*/
export function getNormalizedRequestFromAttributes(attributes: SpanAttributes): RequestEventData | undefined {
// eslint-disable-next-line typescript/no-deprecated
const method = attributes[HTTP_REQUEST_METHOD] || attributes[HTTP_METHOD];

// eslint-disable-next-line typescript/no-deprecated
const url = attributes[URL_FULL] || attributes[HTTP_URL] || attributes[URL_PATH] || attributes[HTTP_TARGET];

if (typeof method !== 'string' && typeof url !== 'string') {
return undefined;
}

const normalizedRequest: RequestEventData = {};

if (typeof method === 'string') {
normalizedRequest.method = method;
}

if (typeof url === 'string') {
normalizedRequest.url = url;

const queryFromAttribute = attributes[URL_QUERY];
if (typeof queryFromAttribute === 'string') {
normalizedRequest.query_string = queryFromAttribute;
} else {
const queryIndex = url.indexOf('?');
if (queryIndex !== -1) {
normalizedRequest.query_string = url.slice(queryIndex + 1);
}
}
}

return normalizedRequest;
}
41 changes: 23 additions & 18 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context } from '@opentelemetry/api';
import {
applySdkMetadata,
getCapturedScopesOnSpan,
getCurrentScope,
getGlobalScope,
getIsolationScope,
getRootSpan,
Expand All@@ -14,17 +11,17 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
import { ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attributes-with-logic-attached';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { getNormalizedRequestFromAttributes } from '../common/utils/getNormalizedRequestFromAttributes';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
Expand DownExpand Up@@ -101,6 +98,26 @@ export function init(options: VercelEdgeOptions = {}): void {

const client = vercelEdgeInit(opts);

// Next.js's OTel instrumentation samples root spans before the Sentry middleware wrapper can set
// `normalizedRequest` on the isolation scope. Seed it from span attributes so `tracesSampler` has access.
client?.on('beforeSampling', ({ spanAttributes }) => {
const spanType = spanAttributes[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'Middleware.execute' && spanType !== 'BaseServer.handleRequest') {
return;
}

// Clear the key before writing: `setSDKProcessingMetadata` merges into nested objects, so a partial request
// (or none at all) would otherwise keep stale fields (e.g. `query_string`) left on the (potentially shared)
// isolation scope by a previous request on a warm worker.
const isolationScope = getIsolationScope();
isolationScope.setSDKProcessingMetadata({ normalizedRequest: undefined });

const normalizedRequest = getNormalizedRequestFromAttributes(spanAttributes);
if (normalizedRequest) {
isolationScope.setSDKProcessingMetadata({ normalizedRequest });
}
});

client?.on('spanStart', span => {
const spanAttributes = spanToJSON(span).data;
const rootSpan = getRootSpan(span);
Expand All@@ -120,19 +137,7 @@ export function init(options: VercelEdgeOptions = {}): void {
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

if (isRootSpan) {
// todo: check if we can set request headers for edge on sdkProcessingMetadata
Expand Down
33 changes: 3 additions & 30 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
import { context } from '@opentelemetry/api';
import { HTTP_METHOD, HTTP_REQUEST_METHOD, HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { getIsolationScope, getRootSpan, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, spanToJSON } from '@sentry/core';
import { ATTR_NEXT_ROUTE, ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { maybeEnhanceServerComponentSpanName } from '../common/utils/tracingUtils';
import { maybeStartCronCheckIn } from './vercelCronsMonitoring';
import { maybeEnrichQueueConsumerSpan, maybeEnrichQueueProducerSpan } from './vercelQueuesMonitoring';
Expand DownExpand Up@@ -84,25 +75,7 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests. Root `Middleware.execute` spans need the same
// treatment since Next.js 16.3.0-canary.79
if (
(spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' ||
spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'Middleware.execute') &&
isRootSpan
) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

maybeEnhanceServerComponentSpanName(span, spanAttributes, rootSpanAttributes);

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
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'Jane Doe' });
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { NextResponse } from 'next/server';

export const dynamic = 'force-dynamic';

export function GET() {
return NextResponse.json({ name: 'John Doe' });
}
17 changes: 17 additions & 0 deletions dev-packages/e2e-tests/test-applications/nextjs-15/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { NextResponse } from 'next/server';
import type { NextRequest } from 'next/server';

export async function middleware(request: NextRequest) {
// Keep this invocation in-flight for a bit so a concurrent request to the other matched endpoint genuinely
// overlaps with it — the concurrency test in tests/middleware.test.ts relies on this overlap.
if (request.nextUrl.pathname === '/api/endpoint-behind-middleware-2') {
await new Promise(resolve => setTimeout(resolve, 300));
}

return NextResponse.next();
}

// See "Matching Paths" below to learn more
export const config = {
matcher: ['/api/endpoint-behind-middleware', '/api/endpoint-behind-middleware-2'],
};
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,21 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time and belongs to
// the request that is being sampled (guards against concurrent requests leaking into each other's sampling
// context). The middleware e2e tests time out and fail when the transaction is dropped here.
const { normalizedRequest } = samplingContext;
return Boolean(
normalizedRequest?.method &&
normalizedRequest?.url &&
normalizedRequest.url === samplingContext.attributes['http.target'],
);
}

return 1.0;
},
dataCollection: { userInfo: true },
transportOptions: {
// We are doing a lot of events at once in this test
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// The `tracesSampler` in `sentry.edge.config.ts` only samples `Middleware.execute` spans when `normalizedRequest`
// is available at sampling time, so this test times out if the request data does not reach the sampler.
test('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

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

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('vercel-edge');
expect(middlewareTransaction.contexts?.trace?.op).toBe('http.server.middleware');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// The `tracesSampler` additionally asserts that `normalizedRequest.url` matches the sampled span's own
// `http.target`, so a request leaking into the sampling context of a concurrent one drops that transaction
// and times this test out.
test('does not leak normalizedRequest between concurrent middleware invocations', async ({ request }) => {
const firstTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware'
);
});

const secondTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return (
transactionEvent?.transaction === 'middleware GET' &&
transactionEvent.contexts?.trace?.data?.['http.target'] === '/api/endpoint-behind-middleware-2'
);
});

await Promise.all([request.get('/api/endpoint-behind-middleware'), request.get('/api/endpoint-behind-middleware-2')]);

const [firstTransaction, secondTransaction] = await Promise.all([firstTransactionPromise, secondTransactionPromise]);

expect(firstTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(firstTransaction.request?.url).not.toContain('/api/endpoint-behind-middleware-2');
expect(secondTransaction.request?.url).toContain('/api/endpoint-behind-middleware-2');
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,16 @@ Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.NEXT_PUBLIC_E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
tracesSampler: samplingContext => {
if (samplingContext.attributes?.['next.span_type'] === 'Middleware.execute') {
// Only keep the middleware transaction when `normalizedRequest` was available at sampling time.
// Test times out and fails when transaction is dropped
const { normalizedRequest } = samplingContext;
return Boolean(normalizedRequest?.url && normalizedRequest?.method);
}

return 1.0;
},
dataCollection: { userInfo: true },
// debug: true,
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,21 @@ import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { isDevMode } from './isDevMode';

// TODO: Skipped until the Cloudflare Workers edge middleware setup emits middleware transactions reliably.
test.skip('tracesSampler receives normalizedRequest for edge middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
return transactionEvent?.transaction === 'middleware GET';
});

await request.get('/api/endpoint-behind-middleware');

const middlewareTransaction = await middlewareTransactionPromise;

expect(middlewareTransaction.contexts?.runtime?.name).toBe('cloudflare');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');
expect(middlewareTransaction.request?.method).toBe('GET');
});

// TODO: Middleware tests need SDK adjustments for Cloudflare Workers edge runtime
test.skip('Should create a transaction for middleware', async ({ request }) => {
const middlewareTransactionPromise = waitForTransaction('nextjs-16-cf-workers', async transactionEvent => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ test('Should create a transaction for middleware', async ({ request }) => {
expect(middlewareTransaction.contexts?.runtime?.name).toBe('node');
expect(middlewareTransaction.transaction_info?.source).toBe('route');

expect(middlewareTransaction.request?.method).toBe('GET');
expect(middlewareTransaction.request?.url).toContain('/api/endpoint-behind-middleware');

// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import { context } from '@opentelemetry/api';
import type { Span, SpanAttributes } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
setCapturedScopesOnSpan,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { ATTR_NEXT_SPAN_TYPE } from '../nextSpanAttributes';

/**
* Forks the isolation scope for `BaseServer.handleRequest` / `Middleware.execute` root spans so that request-scoped
* data (e.g. `normalizedRequest`) stays isolated per request.
*/
export function maybeForkIsolationScopeForRootSpan(span: Span, spanAttributes: SpanAttributes | undefined): void {
const spanType = spanAttributes?.[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'BaseServer.handleRequest' && spanType !== 'Middleware.execute') {
return;
}

if (span !== getRootSpan(span)) {
return;
}

const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import {
HTTP_METHOD,
HTTP_REQUEST_METHOD,
HTTP_TARGET,
HTTP_URL,
URL_FULL,
URL_PATH,
URL_QUERY,
} from '@sentry/conventions/attributes';
import type { RequestEventData, SpanAttributes } from '@sentry/core';

/**
* Builds a partial `normalizedRequest` from OTel HTTP span attributes.
* Only method, URL, and query string can be derived — headers are not available as span attributes.
*/
export function getNormalizedRequestFromAttributes(attributes: SpanAttributes): RequestEventData | undefined {
// eslint-disable-next-line typescript/no-deprecated
const method = attributes[HTTP_REQUEST_METHOD] || attributes[HTTP_METHOD];

// eslint-disable-next-line typescript/no-deprecated
const url = attributes[URL_FULL] || attributes[HTTP_URL] || attributes[URL_PATH] || attributes[HTTP_TARGET];

if (typeof method !== 'string' && typeof url !== 'string') {
return undefined;
}

const normalizedRequest: RequestEventData = {};

if (typeof method === 'string') {
normalizedRequest.method = method;
}

if (typeof url === 'string') {
normalizedRequest.url = url;

const queryFromAttribute = attributes[URL_QUERY];
if (typeof queryFromAttribute === 'string') {
normalizedRequest.query_string = queryFromAttribute;
} else {
const queryIndex = url.indexOf('?');
if (queryIndex !== -1) {
normalizedRequest.query_string = url.slice(queryIndex + 1);
}
}
}

return normalizedRequest;
}
41 changes: 23 additions & 18 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
// import/export got a false positive, and affects most of our index barrel files
// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
/* eslint-disable import/export */
import { context } from '@opentelemetry/api';
import {
applySdkMetadata,
getCapturedScopesOnSpan,
getCurrentScope,
getGlobalScope,
getIsolationScope,
getRootSpan,
Expand All@@ -14,17 +11,17 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
import { DEBUG_BUILD } from '../common/debug-build';
import { ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attributes-with-logic-attached';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { getNormalizedRequestFromAttributes } from '../common/utils/getNormalizedRequestFromAttributes';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
Expand DownExpand Up@@ -101,6 +98,26 @@ export function init(options: VercelEdgeOptions = {}): void {

const client = vercelEdgeInit(opts);

// Next.js's OTel instrumentation samples root spans before the Sentry middleware wrapper can set
// `normalizedRequest` on the isolation scope. Seed it from span attributes so `tracesSampler` has access.
client?.on('beforeSampling', ({ spanAttributes }) => {
const spanType = spanAttributes[ATTR_NEXT_SPAN_TYPE];
if (spanType !== 'Middleware.execute' && spanType !== 'BaseServer.handleRequest') {
return;
}

// Clear the key before writing: `setSDKProcessingMetadata` merges into nested objects, so a partial request
// (or none at all) would otherwise keep stale fields (e.g. `query_string`) left on the (potentially shared)
// isolation scope by a previous request on a warm worker.
const isolationScope = getIsolationScope();
isolationScope.setSDKProcessingMetadata({ normalizedRequest: undefined });

const normalizedRequest = getNormalizedRequestFromAttributes(spanAttributes);
if (normalizedRequest) {
isolationScope.setSDKProcessingMetadata({ normalizedRequest });
}
});

client?.on('spanStart', span => {
const spanAttributes = spanToJSON(span).data;
const rootSpan = getRootSpan(span);
Expand All@@ -120,19 +137,7 @@ export function init(options: VercelEdgeOptions = {}): void {
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

if (isRootSpan) {
// todo: check if we can set request headers for edge on sdkProcessingMetadata
Expand Down
33 changes: 3 additions & 30 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
import { context } from '@opentelemetry/api';
import { HTTP_METHOD, HTTP_REQUEST_METHOD, HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
getCapturedScopesOnSpan,
getCurrentScope,
getIsolationScope,
getRootSpan,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
setCapturedScopesOnSpan,
spanToJSON,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import { getIsolationScope, getRootSpan, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, spanToJSON } from '@sentry/core';
import { ATTR_NEXT_ROUTE, ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { maybeForkIsolationScopeForRootSpan } from '../common/utils/forkIsolationScopeForRootSpan';
import { maybeEnhanceServerComponentSpanName } from '../common/utils/tracingUtils';
import { maybeStartCronCheckIn } from './vercelCronsMonitoring';
import { maybeEnrichQueueConsumerSpan, maybeEnrichQueueProducerSpan } from './vercelQueuesMonitoring';
Expand DownExpand Up@@ -84,25 +75,7 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests. Root `Middleware.execute` spans need the same
// treatment since Next.js 16.3.0-canary.79
if (
(spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' ||
spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'Middleware.execute') &&
isRootSpan
) {
const scopes = getCapturedScopesOnSpan(span);

const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
const scope = scopes.scope || getCurrentScope();

const currentScopesPointer = getScopesFromContext(context.active());
if (currentScopesPointer) {
currentScopesPointer.isolationScope = isolationScope;
}

setCapturedScopesOnSpan(span, scope, isolationScope);
}
maybeForkIsolationScopeForRootSpan(span, spanAttributes);

maybeEnhanceServerComponentSpanName(span, spanAttributes, rootSpanAttributes);

Expand Down
Loading
Loading