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
Expand Up@@ -7,6 +7,10 @@ test('Should create a transaction for middleware', async ({ request }) => {
return transactionEvent?.transaction === 'middleware GET';
});

const routeTransactionPromise = waitForTransaction('nextjs-16', async transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint-behind-middleware';
});

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

Expand All@@ -20,6 +24,12 @@ test('Should create a transaction for middleware', async ({ request }) => {
// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// Tags set in middleware must not leak into other requests' events (e.g. via a shared scope when the middleware
// runs in a detached context - https://github.com/vercel/next.js/pull/95306)
const routeTransaction = await routeTransactionPromise;
expect(routeTransaction.tags?.['my-isolated-tag']).not.toBeDefined();
expect(routeTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});

test('Faulty middlewares', async ({ request }) => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
import { stripUrlQueryAndFragment } from '@sentry/core';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from './nextSpanAttributes';

export interface MutableMiddlewareRootSpan {
attributes: Record<string, unknown>;
getName(): string | undefined;
setName(name: string): void;
setOp(op: string): void;
}

/**
* Normalizes the transaction name for the root span of a Next.js `Middleware.execute` request on the Edge runtime.
* Normalizes the transaction name and op for the root span of a Next.js `Middleware.execute` request.
*
* On the Edge runtime, middleware always runs in a detached sandbox, so `Middleware.execute` is the root span.
* On the Node.js runtime, this is the case since vercel/next.js#95306, where in-process
* middleware runs in a detached OTel context instead of inside the `BaseServer.handleRequest` span.
*
* Older Next.js versions append the full URL to the middleware span name (e.g. `middleware GET /foo?bar=1`),
* producing high-cardinality transaction names. We collapse the name to `middleware {METHOD}` when possible,
* and strip query/fragment otherwise.
*
* Called from two places that operate on different shapes of the same underlying root span:
* - Legacy mode: from `preprocessEvent`, adapted around a transaction `Event` whose `contexts.trace.data`
* holds the root span's attributes and whose `event.transaction` is the root span's name.
* - Streamed mode: from `processSegmentSpan`, adapted around a `StreamedSpanJSON` (the streamed
* counterpart of the legacy transaction root) directly.
*/
export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void {
const { attributes } = span;
Expand All@@ -27,6 +26,8 @@ export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void
return;
}

span.setOp('http.server.middleware');

const spanName = attributes[ATTR_NEXT_SPAN_NAME];
if (typeof spanName !== 'string' || !spanName || !span.getName()) {
return;
Expand Down
8 changes: 7 additions & 1 deletion packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from './enhanceMiddlewareRootSpan';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';

export * from '@sentry/vercel-edge';
export * from '../common';
Expand DownExpand Up@@ -155,6 +155,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
event.transaction = name;
},
setOp: op => {
event.contexts!.trace!.op = op;
},
});
}

Expand All@@ -171,6 +174,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
span.name = name;
},
setOp: op => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
});

Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,8 +84,13 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
// 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();
Expand Down
21 changes: 13 additions & 8 deletions packages/nextjs/src/server/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ import { isBuild } from '../common/utils/isBuild';
import { isCloudflareWaitUntilAvailable } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';
import { enhanceHandleRequestRootSpan } from './enhanceHandleRequestRootSpan';
import { handleOnSpanStart } from './handleOnSpanStart';
import { prepareSafeIdGeneratorContext } from './prepareSafeIdGeneratorContext';
Expand DownExpand Up@@ -249,16 +250,18 @@ export function init(options: NodeOptions): NodeClient | undefined {
// Span streaming bypasses event processors entirely - see the `processSegmentSpan` hook below for that path.
client?.on('preprocessEvent', event => {
if (event.type === 'transaction' && event.contexts?.trace?.data) {
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes: event.contexts.trace.data,
getName: () => event.transaction,
setName: name => {
setName: (name: string) => {
event.transaction = name;
},
setOp: op => {
setOp: (op: string) => {
event.contexts!.trace!.op = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
}

setUrlProcessingMetadata(event);
Expand All@@ -268,18 +271,20 @@ export function init(options: NodeOptions): NodeClient | undefined {
// transaction events, so the same enhancement has to be applied here directly on the span JSON.
client?.on('processSegmentSpan', span => {
const attributes = (span.attributes ??= {});
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes,
getName: () => span.name,
setName: name => {
setName: (name: string) => {
span.name = name;
},
// For streamed spans, op lives in `attributes['sentry.op']` - mirror it there so middleware
// overrides land somewhere readable (the legacy path uses a separate `event.contexts.trace.op`).
setOp: op => {
setOp: (op: string) => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
});

if (process.env.NODE_ENV === 'development') {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,82 @@
import { describe, expect, it } from 'vitest';
import { enhanceMiddlewareRootSpan } from '../../src/common/enhanceMiddlewareRootSpan';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../../src/common/nextSpanAttributes';
import { enhanceMiddlewareRootSpan } from '../../src/edge/enhanceMiddlewareRootSpan';

function makeSpan(attributes: Record<string, unknown>, name?: string) {
let currentName = name;
let currentOp: string | undefined;
return {
span: {
attributes,
getName: () => currentName,
setName: (n: string) => {
currentName = n;
},
setOp: (op: string) => {
currentOp = op;
},
},
getName: () => currentName,
getOp: () => currentOp,
};
}

describe('enhanceMiddlewareRootSpan', () => {
it('does nothing for spans that are not Middleware.execute', () => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'BaseServer.handleRequest', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
'GET /foo',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('GET /foo');
expect(getOp()).toBeUndefined();
});

it('does nothing when next.span_name is missing', () => {
const { span, getName } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');
it('sets the op but keeps the name when next.span_name is missing', () => {
const { span, getName, getOp } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is an empty string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is an empty string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: '' },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is not a string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is not a string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 123 },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when the current name is empty', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when the current name is empty', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
undefined,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBeUndefined();
expect(getOp()).toBe('http.server.middleware');
});

it.each([
Expand All@@ -75,14 +85,29 @@ describe('enhanceMiddlewareRootSpan', () => {
['middleware DELETE /resources/[id]', 'middleware DELETE'],
['middleware HEAD /', 'middleware HEAD'],
])('collapses "%s" to "%s"', (spanName, expected) => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: spanName },
spanName,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe(expected);
expect(getOp()).toBe('http.server.middleware');
});

it('normalizes the plain "middleware {METHOD}" name emitted for Node.js middleware', () => {
// Node.js middleware roots come pre-mangled by HTTP span inference (e.g. `GET middleware GET`),
// while `next.span_name` holds the original `middleware GET`.
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET' },
'GET middleware GET',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware GET');
expect(getOp()).toBe('http.server.middleware');
});

it('strips query and fragment from non-method-prefixed middleware names', () => {
Expand Down
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
Expand Up@@ -7,6 +7,10 @@ test('Should create a transaction for middleware', async ({ request }) => {
return transactionEvent?.transaction === 'middleware GET';
});

const routeTransactionPromise = waitForTransaction('nextjs-16', async transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint-behind-middleware';
});

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

Expand All@@ -20,6 +24,12 @@ test('Should create a transaction for middleware', async ({ request }) => {
// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// Tags set in middleware must not leak into other requests' events (e.g. via a shared scope when the middleware
// runs in a detached context - https://github.com/vercel/next.js/pull/95306)
const routeTransaction = await routeTransactionPromise;
expect(routeTransaction.tags?.['my-isolated-tag']).not.toBeDefined();
expect(routeTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});

test('Faulty middlewares', async ({ request }) => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
import { stripUrlQueryAndFragment } from '@sentry/core';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from './nextSpanAttributes';

export interface MutableMiddlewareRootSpan {
attributes: Record<string, unknown>;
getName(): string | undefined;
setName(name: string): void;
setOp(op: string): void;
}

/**
* Normalizes the transaction name for the root span of a Next.js `Middleware.execute` request on the Edge runtime.
* Normalizes the transaction name and op for the root span of a Next.js `Middleware.execute` request.
*
* On the Edge runtime, middleware always runs in a detached sandbox, so `Middleware.execute` is the root span.
* On the Node.js runtime, this is the case since vercel/next.js#95306, where in-process
* middleware runs in a detached OTel context instead of inside the `BaseServer.handleRequest` span.
*
* Older Next.js versions append the full URL to the middleware span name (e.g. `middleware GET /foo?bar=1`),
* producing high-cardinality transaction names. We collapse the name to `middleware {METHOD}` when possible,
* and strip query/fragment otherwise.
*
* Called from two places that operate on different shapes of the same underlying root span:
* - Legacy mode: from `preprocessEvent`, adapted around a transaction `Event` whose `contexts.trace.data`
* holds the root span's attributes and whose `event.transaction` is the root span's name.
* - Streamed mode: from `processSegmentSpan`, adapted around a `StreamedSpanJSON` (the streamed
* counterpart of the legacy transaction root) directly.
*/
export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void {
const { attributes } = span;
Expand All@@ -27,6 +26,8 @@ export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void
return;
}

span.setOp('http.server.middleware');

const spanName = attributes[ATTR_NEXT_SPAN_NAME];
if (typeof spanName !== 'string' || !spanName || !span.getName()) {
return;
Expand Down
8 changes: 7 additions & 1 deletion packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from './enhanceMiddlewareRootSpan';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';

export * from '@sentry/vercel-edge';
export * from '../common';
Expand DownExpand Up@@ -155,6 +155,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
event.transaction = name;
},
setOp: op => {
event.contexts!.trace!.op = op;
},
});
}

Expand All@@ -171,6 +174,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
span.name = name;
},
setOp: op => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
});

Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,8 +84,13 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
// 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();
Expand Down
21 changes: 13 additions & 8 deletions packages/nextjs/src/server/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ import { isBuild } from '../common/utils/isBuild';
import { isCloudflareWaitUntilAvailable } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';
import { enhanceHandleRequestRootSpan } from './enhanceHandleRequestRootSpan';
import { handleOnSpanStart } from './handleOnSpanStart';
import { prepareSafeIdGeneratorContext } from './prepareSafeIdGeneratorContext';
Expand DownExpand Up@@ -249,16 +250,18 @@ export function init(options: NodeOptions): NodeClient | undefined {
// Span streaming bypasses event processors entirely - see the `processSegmentSpan` hook below for that path.
client?.on('preprocessEvent', event => {
if (event.type === 'transaction' && event.contexts?.trace?.data) {
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes: event.contexts.trace.data,
getName: () => event.transaction,
setName: name => {
setName: (name: string) => {
event.transaction = name;
},
setOp: op => {
setOp: (op: string) => {
event.contexts!.trace!.op = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
}

setUrlProcessingMetadata(event);
Expand All@@ -268,18 +271,20 @@ export function init(options: NodeOptions): NodeClient | undefined {
// transaction events, so the same enhancement has to be applied here directly on the span JSON.
client?.on('processSegmentSpan', span => {
const attributes = (span.attributes ??= {});
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes,
getName: () => span.name,
setName: name => {
setName: (name: string) => {
span.name = name;
},
// For streamed spans, op lives in `attributes['sentry.op']` - mirror it there so middleware
// overrides land somewhere readable (the legacy path uses a separate `event.contexts.trace.op`).
setOp: op => {
setOp: (op: string) => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
});

if (process.env.NODE_ENV === 'development') {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,82 @@
import { describe, expect, it } from 'vitest';
import { enhanceMiddlewareRootSpan } from '../../src/common/enhanceMiddlewareRootSpan';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../../src/common/nextSpanAttributes';
import { enhanceMiddlewareRootSpan } from '../../src/edge/enhanceMiddlewareRootSpan';

function makeSpan(attributes: Record<string, unknown>, name?: string) {
let currentName = name;
let currentOp: string | undefined;
return {
span: {
attributes,
getName: () => currentName,
setName: (n: string) => {
currentName = n;
},
setOp: (op: string) => {
currentOp = op;
},
},
getName: () => currentName,
getOp: () => currentOp,
};
}

describe('enhanceMiddlewareRootSpan', () => {
it('does nothing for spans that are not Middleware.execute', () => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'BaseServer.handleRequest', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
'GET /foo',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('GET /foo');
expect(getOp()).toBeUndefined();
});

it('does nothing when next.span_name is missing', () => {
const { span, getName } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');
it('sets the op but keeps the name when next.span_name is missing', () => {
const { span, getName, getOp } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is an empty string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is an empty string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: '' },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is not a string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is not a string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 123 },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when the current name is empty', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when the current name is empty', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
undefined,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBeUndefined();
expect(getOp()).toBe('http.server.middleware');
});

it.each([
Expand All@@ -75,14 +85,29 @@ describe('enhanceMiddlewareRootSpan', () => {
['middleware DELETE /resources/[id]', 'middleware DELETE'],
['middleware HEAD /', 'middleware HEAD'],
])('collapses "%s" to "%s"', (spanName, expected) => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: spanName },
spanName,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe(expected);
expect(getOp()).toBe('http.server.middleware');
});

it('normalizes the plain "middleware {METHOD}" name emitted for Node.js middleware', () => {
// Node.js middleware roots come pre-mangled by HTTP span inference (e.g. `GET middleware GET`),
// while `next.span_name` holds the original `middleware GET`.
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET' },
'GET middleware GET',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware GET');
expect(getOp()).toBe('http.server.middleware');
});

it('strips query and fragment from non-method-prefixed middleware names', () => {
Expand Down
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
Expand Up@@ -7,6 +7,10 @@ test('Should create a transaction for middleware', async ({ request }) => {
return transactionEvent?.transaction === 'middleware GET';
});

const routeTransactionPromise = waitForTransaction('nextjs-16', async transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint-behind-middleware';
});

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

Expand All@@ -20,6 +24,12 @@ test('Should create a transaction for middleware', async ({ request }) => {
// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// Tags set in middleware must not leak into other requests' events (e.g. via a shared scope when the middleware
// runs in a detached context - https://github.com/vercel/next.js/pull/95306)
const routeTransaction = await routeTransactionPromise;
expect(routeTransaction.tags?.['my-isolated-tag']).not.toBeDefined();
expect(routeTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});

test('Faulty middlewares', async ({ request }) => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
import { stripUrlQueryAndFragment } from '@sentry/core';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from './nextSpanAttributes';

export interface MutableMiddlewareRootSpan {
attributes: Record<string, unknown>;
getName(): string | undefined;
setName(name: string): void;
setOp(op: string): void;
}

/**
* Normalizes the transaction name for the root span of a Next.js `Middleware.execute` request on the Edge runtime.
* Normalizes the transaction name and op for the root span of a Next.js `Middleware.execute` request.
*
* On the Edge runtime, middleware always runs in a detached sandbox, so `Middleware.execute` is the root span.
* On the Node.js runtime, this is the case since vercel/next.js#95306, where in-process
* middleware runs in a detached OTel context instead of inside the `BaseServer.handleRequest` span.
*
* Older Next.js versions append the full URL to the middleware span name (e.g. `middleware GET /foo?bar=1`),
* producing high-cardinality transaction names. We collapse the name to `middleware {METHOD}` when possible,
* and strip query/fragment otherwise.
*
* Called from two places that operate on different shapes of the same underlying root span:
* - Legacy mode: from `preprocessEvent`, adapted around a transaction `Event` whose `contexts.trace.data`
* holds the root span's attributes and whose `event.transaction` is the root span's name.
* - Streamed mode: from `processSegmentSpan`, adapted around a `StreamedSpanJSON` (the streamed
* counterpart of the legacy transaction root) directly.
*/
export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void {
const { attributes } = span;
Expand All@@ -27,6 +26,8 @@ export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void
return;
}

span.setOp('http.server.middleware');

const spanName = attributes[ATTR_NEXT_SPAN_NAME];
if (typeof spanName !== 'string' || !spanName || !span.getName()) {
return;
Expand Down
8 changes: 7 additions & 1 deletion packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from './enhanceMiddlewareRootSpan';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';

export * from '@sentry/vercel-edge';
export * from '../common';
Expand DownExpand Up@@ -155,6 +155,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
event.transaction = name;
},
setOp: op => {
event.contexts!.trace!.op = op;
},
});
}

Expand All@@ -171,6 +174,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
span.name = name;
},
setOp: op => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
});

Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,8 +84,13 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
// 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();
Expand Down
21 changes: 13 additions & 8 deletions packages/nextjs/src/server/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ import { isBuild } from '../common/utils/isBuild';
import { isCloudflareWaitUntilAvailable } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';
import { enhanceHandleRequestRootSpan } from './enhanceHandleRequestRootSpan';
import { handleOnSpanStart } from './handleOnSpanStart';
import { prepareSafeIdGeneratorContext } from './prepareSafeIdGeneratorContext';
Expand DownExpand Up@@ -249,16 +250,18 @@ export function init(options: NodeOptions): NodeClient | undefined {
// Span streaming bypasses event processors entirely - see the `processSegmentSpan` hook below for that path.
client?.on('preprocessEvent', event => {
if (event.type === 'transaction' && event.contexts?.trace?.data) {
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes: event.contexts.trace.data,
getName: () => event.transaction,
setName: name => {
setName: (name: string) => {
event.transaction = name;
},
setOp: op => {
setOp: (op: string) => {
event.contexts!.trace!.op = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
}

setUrlProcessingMetadata(event);
Expand All@@ -268,18 +271,20 @@ export function init(options: NodeOptions): NodeClient | undefined {
// transaction events, so the same enhancement has to be applied here directly on the span JSON.
client?.on('processSegmentSpan', span => {
const attributes = (span.attributes ??= {});
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes,
getName: () => span.name,
setName: name => {
setName: (name: string) => {
span.name = name;
},
// For streamed spans, op lives in `attributes['sentry.op']` - mirror it there so middleware
// overrides land somewhere readable (the legacy path uses a separate `event.contexts.trace.op`).
setOp: op => {
setOp: (op: string) => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
});

if (process.env.NODE_ENV === 'development') {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,82 @@
import { describe, expect, it } from 'vitest';
import { enhanceMiddlewareRootSpan } from '../../src/common/enhanceMiddlewareRootSpan';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../../src/common/nextSpanAttributes';
import { enhanceMiddlewareRootSpan } from '../../src/edge/enhanceMiddlewareRootSpan';

function makeSpan(attributes: Record<string, unknown>, name?: string) {
let currentName = name;
let currentOp: string | undefined;
return {
span: {
attributes,
getName: () => currentName,
setName: (n: string) => {
currentName = n;
},
setOp: (op: string) => {
currentOp = op;
},
},
getName: () => currentName,
getOp: () => currentOp,
};
}

describe('enhanceMiddlewareRootSpan', () => {
it('does nothing for spans that are not Middleware.execute', () => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'BaseServer.handleRequest', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
'GET /foo',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('GET /foo');
expect(getOp()).toBeUndefined();
});

it('does nothing when next.span_name is missing', () => {
const { span, getName } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');
it('sets the op but keeps the name when next.span_name is missing', () => {
const { span, getName, getOp } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is an empty string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is an empty string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: '' },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is not a string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is not a string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 123 },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when the current name is empty', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when the current name is empty', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
undefined,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBeUndefined();
expect(getOp()).toBe('http.server.middleware');
});

it.each([
Expand All@@ -75,14 +85,29 @@ describe('enhanceMiddlewareRootSpan', () => {
['middleware DELETE /resources/[id]', 'middleware DELETE'],
['middleware HEAD /', 'middleware HEAD'],
])('collapses "%s" to "%s"', (spanName, expected) => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: spanName },
spanName,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe(expected);
expect(getOp()).toBe('http.server.middleware');
});

it('normalizes the plain "middleware {METHOD}" name emitted for Node.js middleware', () => {
// Node.js middleware roots come pre-mangled by HTTP span inference (e.g. `GET middleware GET`),
// while `next.span_name` holds the original `middleware GET`.
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET' },
'GET middleware GET',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware GET');
expect(getOp()).toBe('http.server.middleware');
});

it('strips query and fragment from non-method-prefixed middleware names', () => {
Expand Down
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
Expand Up@@ -7,6 +7,10 @@ test('Should create a transaction for middleware', async ({ request }) => {
return transactionEvent?.transaction === 'middleware GET';
});

const routeTransactionPromise = waitForTransaction('nextjs-16', async transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint-behind-middleware';
});

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

Expand All@@ -20,6 +24,12 @@ test('Should create a transaction for middleware', async ({ request }) => {
// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// Tags set in middleware must not leak into other requests' events (e.g. via a shared scope when the middleware
// runs in a detached context - https://github.com/vercel/next.js/pull/95306)
const routeTransaction = await routeTransactionPromise;
expect(routeTransaction.tags?.['my-isolated-tag']).not.toBeDefined();
expect(routeTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});

test('Faulty middlewares', async ({ request }) => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
import { stripUrlQueryAndFragment } from '@sentry/core';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from './nextSpanAttributes';

export interface MutableMiddlewareRootSpan {
attributes: Record<string, unknown>;
getName(): string | undefined;
setName(name: string): void;
setOp(op: string): void;
}

/**
* Normalizes the transaction name for the root span of a Next.js `Middleware.execute` request on the Edge runtime.
* Normalizes the transaction name and op for the root span of a Next.js `Middleware.execute` request.
*
* On the Edge runtime, middleware always runs in a detached sandbox, so `Middleware.execute` is the root span.
* On the Node.js runtime, this is the case since vercel/next.js#95306, where in-process
* middleware runs in a detached OTel context instead of inside the `BaseServer.handleRequest` span.
*
* Older Next.js versions append the full URL to the middleware span name (e.g. `middleware GET /foo?bar=1`),
* producing high-cardinality transaction names. We collapse the name to `middleware {METHOD}` when possible,
* and strip query/fragment otherwise.
*
* Called from two places that operate on different shapes of the same underlying root span:
* - Legacy mode: from `preprocessEvent`, adapted around a transaction `Event` whose `contexts.trace.data`
* holds the root span's attributes and whose `event.transaction` is the root span's name.
* - Streamed mode: from `processSegmentSpan`, adapted around a `StreamedSpanJSON` (the streamed
* counterpart of the legacy transaction root) directly.
*/
export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void {
const { attributes } = span;
Expand All@@ -27,6 +26,8 @@ export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void
return;
}

span.setOp('http.server.middleware');

const spanName = attributes[ATTR_NEXT_SPAN_NAME];
if (typeof spanName !== 'string' || !spanName || !span.getName()) {
return;
Expand Down
8 changes: 7 additions & 1 deletion packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from './enhanceMiddlewareRootSpan';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';

export * from '@sentry/vercel-edge';
export * from '../common';
Expand DownExpand Up@@ -155,6 +155,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
event.transaction = name;
},
setOp: op => {
event.contexts!.trace!.op = op;
},
});
}

Expand All@@ -171,6 +174,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
span.name = name;
},
setOp: op => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
});

Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,8 +84,13 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
// 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();
Expand Down
21 changes: 13 additions & 8 deletions packages/nextjs/src/server/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ import { isBuild } from '../common/utils/isBuild';
import { isCloudflareWaitUntilAvailable } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';
import { enhanceHandleRequestRootSpan } from './enhanceHandleRequestRootSpan';
import { handleOnSpanStart } from './handleOnSpanStart';
import { prepareSafeIdGeneratorContext } from './prepareSafeIdGeneratorContext';
Expand DownExpand Up@@ -249,16 +250,18 @@ export function init(options: NodeOptions): NodeClient | undefined {
// Span streaming bypasses event processors entirely - see the `processSegmentSpan` hook below for that path.
client?.on('preprocessEvent', event => {
if (event.type === 'transaction' && event.contexts?.trace?.data) {
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes: event.contexts.trace.data,
getName: () => event.transaction,
setName: name => {
setName: (name: string) => {
event.transaction = name;
},
setOp: op => {
setOp: (op: string) => {
event.contexts!.trace!.op = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
}

setUrlProcessingMetadata(event);
Expand All@@ -268,18 +271,20 @@ export function init(options: NodeOptions): NodeClient | undefined {
// transaction events, so the same enhancement has to be applied here directly on the span JSON.
client?.on('processSegmentSpan', span => {
const attributes = (span.attributes ??= {});
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes,
getName: () => span.name,
setName: name => {
setName: (name: string) => {
span.name = name;
},
// For streamed spans, op lives in `attributes['sentry.op']` - mirror it there so middleware
// overrides land somewhere readable (the legacy path uses a separate `event.contexts.trace.op`).
setOp: op => {
setOp: (op: string) => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
});

if (process.env.NODE_ENV === 'development') {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,82 @@
import { describe, expect, it } from 'vitest';
import { enhanceMiddlewareRootSpan } from '../../src/common/enhanceMiddlewareRootSpan';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../../src/common/nextSpanAttributes';
import { enhanceMiddlewareRootSpan } from '../../src/edge/enhanceMiddlewareRootSpan';

function makeSpan(attributes: Record<string, unknown>, name?: string) {
let currentName = name;
let currentOp: string | undefined;
return {
span: {
attributes,
getName: () => currentName,
setName: (n: string) => {
currentName = n;
},
setOp: (op: string) => {
currentOp = op;
},
},
getName: () => currentName,
getOp: () => currentOp,
};
}

describe('enhanceMiddlewareRootSpan', () => {
it('does nothing for spans that are not Middleware.execute', () => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'BaseServer.handleRequest', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
'GET /foo',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('GET /foo');
expect(getOp()).toBeUndefined();
});

it('does nothing when next.span_name is missing', () => {
const { span, getName } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');
it('sets the op but keeps the name when next.span_name is missing', () => {
const { span, getName, getOp } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is an empty string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is an empty string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: '' },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is not a string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is not a string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 123 },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when the current name is empty', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when the current name is empty', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
undefined,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBeUndefined();
expect(getOp()).toBe('http.server.middleware');
});

it.each([
Expand All@@ -75,14 +85,29 @@ describe('enhanceMiddlewareRootSpan', () => {
['middleware DELETE /resources/[id]', 'middleware DELETE'],
['middleware HEAD /', 'middleware HEAD'],
])('collapses "%s" to "%s"', (spanName, expected) => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: spanName },
spanName,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe(expected);
expect(getOp()).toBe('http.server.middleware');
});

it('normalizes the plain "middleware {METHOD}" name emitted for Node.js middleware', () => {
// Node.js middleware roots come pre-mangled by HTTP span inference (e.g. `GET middleware GET`),
// while `next.span_name` holds the original `middleware GET`.
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET' },
'GET middleware GET',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware GET');
expect(getOp()).toBe('http.server.middleware');
});

it('strips query and fragment from non-method-prefixed middleware names', () => {
Expand Down
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
Expand Up@@ -7,6 +7,10 @@ test('Should create a transaction for middleware', async ({ request }) => {
return transactionEvent?.transaction === 'middleware GET';
});

const routeTransactionPromise = waitForTransaction('nextjs-16', async transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint-behind-middleware';
});

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

Expand All@@ -20,6 +24,12 @@ test('Should create a transaction for middleware', async ({ request }) => {
// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// Tags set in middleware must not leak into other requests' events (e.g. via a shared scope when the middleware
// runs in a detached context - https://github.com/vercel/next.js/pull/95306)
const routeTransaction = await routeTransactionPromise;
expect(routeTransaction.tags?.['my-isolated-tag']).not.toBeDefined();
expect(routeTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});

test('Faulty middlewares', async ({ request }) => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
import { stripUrlQueryAndFragment } from '@sentry/core';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from './nextSpanAttributes';

export interface MutableMiddlewareRootSpan {
attributes: Record<string, unknown>;
getName(): string | undefined;
setName(name: string): void;
setOp(op: string): void;
}

/**
* Normalizes the transaction name for the root span of a Next.js `Middleware.execute` request on the Edge runtime.
* Normalizes the transaction name and op for the root span of a Next.js `Middleware.execute` request.
*
* On the Edge runtime, middleware always runs in a detached sandbox, so `Middleware.execute` is the root span.
* On the Node.js runtime, this is the case since vercel/next.js#95306, where in-process
* middleware runs in a detached OTel context instead of inside the `BaseServer.handleRequest` span.
*
* Older Next.js versions append the full URL to the middleware span name (e.g. `middleware GET /foo?bar=1`),
* producing high-cardinality transaction names. We collapse the name to `middleware {METHOD}` when possible,
* and strip query/fragment otherwise.
*
* Called from two places that operate on different shapes of the same underlying root span:
* - Legacy mode: from `preprocessEvent`, adapted around a transaction `Event` whose `contexts.trace.data`
* holds the root span's attributes and whose `event.transaction` is the root span's name.
* - Streamed mode: from `processSegmentSpan`, adapted around a `StreamedSpanJSON` (the streamed
* counterpart of the legacy transaction root) directly.
*/
export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void {
const { attributes } = span;
Expand All@@ -27,6 +26,8 @@ export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void
return;
}

span.setOp('http.server.middleware');

const spanName = attributes[ATTR_NEXT_SPAN_NAME];
if (typeof spanName !== 'string' || !spanName || !span.getName()) {
return;
Expand Down
8 changes: 7 additions & 1 deletion packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from './enhanceMiddlewareRootSpan';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';

export * from '@sentry/vercel-edge';
export * from '../common';
Expand DownExpand Up@@ -155,6 +155,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
event.transaction = name;
},
setOp: op => {
event.contexts!.trace!.op = op;
},
});
}

Expand All@@ -171,6 +174,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
span.name = name;
},
setOp: op => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
});

Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,8 +84,13 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
// 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();
Expand Down
21 changes: 13 additions & 8 deletions packages/nextjs/src/server/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ import { isBuild } from '../common/utils/isBuild';
import { isCloudflareWaitUntilAvailable } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';
import { enhanceHandleRequestRootSpan } from './enhanceHandleRequestRootSpan';
import { handleOnSpanStart } from './handleOnSpanStart';
import { prepareSafeIdGeneratorContext } from './prepareSafeIdGeneratorContext';
Expand DownExpand Up@@ -249,16 +250,18 @@ export function init(options: NodeOptions): NodeClient | undefined {
// Span streaming bypasses event processors entirely - see the `processSegmentSpan` hook below for that path.
client?.on('preprocessEvent', event => {
if (event.type === 'transaction' && event.contexts?.trace?.data) {
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes: event.contexts.trace.data,
getName: () => event.transaction,
setName: name => {
setName: (name: string) => {
event.transaction = name;
},
setOp: op => {
setOp: (op: string) => {
event.contexts!.trace!.op = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
}

setUrlProcessingMetadata(event);
Expand All@@ -268,18 +271,20 @@ export function init(options: NodeOptions): NodeClient | undefined {
// transaction events, so the same enhancement has to be applied here directly on the span JSON.
client?.on('processSegmentSpan', span => {
const attributes = (span.attributes ??= {});
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes,
getName: () => span.name,
setName: name => {
setName: (name: string) => {
span.name = name;
},
// For streamed spans, op lives in `attributes['sentry.op']` - mirror it there so middleware
// overrides land somewhere readable (the legacy path uses a separate `event.contexts.trace.op`).
setOp: op => {
setOp: (op: string) => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
});

if (process.env.NODE_ENV === 'development') {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,82 @@
import { describe, expect, it } from 'vitest';
import { enhanceMiddlewareRootSpan } from '../../src/common/enhanceMiddlewareRootSpan';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../../src/common/nextSpanAttributes';
import { enhanceMiddlewareRootSpan } from '../../src/edge/enhanceMiddlewareRootSpan';

function makeSpan(attributes: Record<string, unknown>, name?: string) {
let currentName = name;
let currentOp: string | undefined;
return {
span: {
attributes,
getName: () => currentName,
setName: (n: string) => {
currentName = n;
},
setOp: (op: string) => {
currentOp = op;
},
},
getName: () => currentName,
getOp: () => currentOp,
};
}

describe('enhanceMiddlewareRootSpan', () => {
it('does nothing for spans that are not Middleware.execute', () => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'BaseServer.handleRequest', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
'GET /foo',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('GET /foo');
expect(getOp()).toBeUndefined();
});

it('does nothing when next.span_name is missing', () => {
const { span, getName } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');
it('sets the op but keeps the name when next.span_name is missing', () => {
const { span, getName, getOp } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is an empty string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is an empty string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: '' },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is not a string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is not a string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 123 },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when the current name is empty', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when the current name is empty', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
undefined,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBeUndefined();
expect(getOp()).toBe('http.server.middleware');
});

it.each([
Expand All@@ -75,14 +85,29 @@ describe('enhanceMiddlewareRootSpan', () => {
['middleware DELETE /resources/[id]', 'middleware DELETE'],
['middleware HEAD /', 'middleware HEAD'],
])('collapses "%s" to "%s"', (spanName, expected) => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: spanName },
spanName,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe(expected);
expect(getOp()).toBe('http.server.middleware');
});

it('normalizes the plain "middleware {METHOD}" name emitted for Node.js middleware', () => {
// Node.js middleware roots come pre-mangled by HTTP span inference (e.g. `GET middleware GET`),
// while `next.span_name` holds the original `middleware GET`.
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET' },
'GET middleware GET',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware GET');
expect(getOp()).toBe('http.server.middleware');
});

it('strips query and fragment from non-method-prefixed middleware names', () => {
Expand Down
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
Expand Up@@ -7,6 +7,10 @@ test('Should create a transaction for middleware', async ({ request }) => {
return transactionEvent?.transaction === 'middleware GET';
});

const routeTransactionPromise = waitForTransaction('nextjs-16', async transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint-behind-middleware';
});

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

Expand All@@ -20,6 +24,12 @@ test('Should create a transaction for middleware', async ({ request }) => {
// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// Tags set in middleware must not leak into other requests' events (e.g. via a shared scope when the middleware
// runs in a detached context - https://github.com/vercel/next.js/pull/95306)
const routeTransaction = await routeTransactionPromise;
expect(routeTransaction.tags?.['my-isolated-tag']).not.toBeDefined();
expect(routeTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});

test('Faulty middlewares', async ({ request }) => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
import { stripUrlQueryAndFragment } from '@sentry/core';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from './nextSpanAttributes';

export interface MutableMiddlewareRootSpan {
attributes: Record<string, unknown>;
getName(): string | undefined;
setName(name: string): void;
setOp(op: string): void;
}

/**
* Normalizes the transaction name for the root span of a Next.js `Middleware.execute` request on the Edge runtime.
* Normalizes the transaction name and op for the root span of a Next.js `Middleware.execute` request.
*
* On the Edge runtime, middleware always runs in a detached sandbox, so `Middleware.execute` is the root span.
* On the Node.js runtime, this is the case since vercel/next.js#95306, where in-process
* middleware runs in a detached OTel context instead of inside the `BaseServer.handleRequest` span.
*
* Older Next.js versions append the full URL to the middleware span name (e.g. `middleware GET /foo?bar=1`),
* producing high-cardinality transaction names. We collapse the name to `middleware {METHOD}` when possible,
* and strip query/fragment otherwise.
*
* Called from two places that operate on different shapes of the same underlying root span:
* - Legacy mode: from `preprocessEvent`, adapted around a transaction `Event` whose `contexts.trace.data`
* holds the root span's attributes and whose `event.transaction` is the root span's name.
* - Streamed mode: from `processSegmentSpan`, adapted around a `StreamedSpanJSON` (the streamed
* counterpart of the legacy transaction root) directly.
*/
export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void {
const { attributes } = span;
Expand All@@ -27,6 +26,8 @@ export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void
return;
}

span.setOp('http.server.middleware');

const spanName = attributes[ATTR_NEXT_SPAN_NAME];
if (typeof spanName !== 'string' || !spanName || !span.getName()) {
return;
Expand Down
8 changes: 7 additions & 1 deletion packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from './enhanceMiddlewareRootSpan';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';

export * from '@sentry/vercel-edge';
export * from '../common';
Expand DownExpand Up@@ -155,6 +155,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
event.transaction = name;
},
setOp: op => {
event.contexts!.trace!.op = op;
},
});
}

Expand All@@ -171,6 +174,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
span.name = name;
},
setOp: op => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
});

Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,8 +84,13 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
// 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();
Expand Down
21 changes: 13 additions & 8 deletions packages/nextjs/src/server/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ import { isBuild } from '../common/utils/isBuild';
import { isCloudflareWaitUntilAvailable } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';
import { enhanceHandleRequestRootSpan } from './enhanceHandleRequestRootSpan';
import { handleOnSpanStart } from './handleOnSpanStart';
import { prepareSafeIdGeneratorContext } from './prepareSafeIdGeneratorContext';
Expand DownExpand Up@@ -249,16 +250,18 @@ export function init(options: NodeOptions): NodeClient | undefined {
// Span streaming bypasses event processors entirely - see the `processSegmentSpan` hook below for that path.
client?.on('preprocessEvent', event => {
if (event.type === 'transaction' && event.contexts?.trace?.data) {
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes: event.contexts.trace.data,
getName: () => event.transaction,
setName: name => {
setName: (name: string) => {
event.transaction = name;
},
setOp: op => {
setOp: (op: string) => {
event.contexts!.trace!.op = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
}

setUrlProcessingMetadata(event);
Expand All@@ -268,18 +271,20 @@ export function init(options: NodeOptions): NodeClient | undefined {
// transaction events, so the same enhancement has to be applied here directly on the span JSON.
client?.on('processSegmentSpan', span => {
const attributes = (span.attributes ??= {});
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes,
getName: () => span.name,
setName: name => {
setName: (name: string) => {
span.name = name;
},
// For streamed spans, op lives in `attributes['sentry.op']` - mirror it there so middleware
// overrides land somewhere readable (the legacy path uses a separate `event.contexts.trace.op`).
setOp: op => {
setOp: (op: string) => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
});

if (process.env.NODE_ENV === 'development') {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,82 @@
import { describe, expect, it } from 'vitest';
import { enhanceMiddlewareRootSpan } from '../../src/common/enhanceMiddlewareRootSpan';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../../src/common/nextSpanAttributes';
import { enhanceMiddlewareRootSpan } from '../../src/edge/enhanceMiddlewareRootSpan';

function makeSpan(attributes: Record<string, unknown>, name?: string) {
let currentName = name;
let currentOp: string | undefined;
return {
span: {
attributes,
getName: () => currentName,
setName: (n: string) => {
currentName = n;
},
setOp: (op: string) => {
currentOp = op;
},
},
getName: () => currentName,
getOp: () => currentOp,
};
}

describe('enhanceMiddlewareRootSpan', () => {
it('does nothing for spans that are not Middleware.execute', () => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'BaseServer.handleRequest', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
'GET /foo',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('GET /foo');
expect(getOp()).toBeUndefined();
});

it('does nothing when next.span_name is missing', () => {
const { span, getName } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');
it('sets the op but keeps the name when next.span_name is missing', () => {
const { span, getName, getOp } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is an empty string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is an empty string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: '' },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is not a string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is not a string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 123 },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when the current name is empty', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when the current name is empty', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
undefined,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBeUndefined();
expect(getOp()).toBe('http.server.middleware');
});

it.each([
Expand All@@ -75,14 +85,29 @@ describe('enhanceMiddlewareRootSpan', () => {
['middleware DELETE /resources/[id]', 'middleware DELETE'],
['middleware HEAD /', 'middleware HEAD'],
])('collapses "%s" to "%s"', (spanName, expected) => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: spanName },
spanName,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe(expected);
expect(getOp()).toBe('http.server.middleware');
});

it('normalizes the plain "middleware {METHOD}" name emitted for Node.js middleware', () => {
// Node.js middleware roots come pre-mangled by HTTP span inference (e.g. `GET middleware GET`),
// while `next.span_name` holds the original `middleware GET`.
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET' },
'GET middleware GET',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware GET');
expect(getOp()).toBe('http.server.middleware');
});

it('strips query and fragment from non-method-prefixed middleware names', () => {
Expand Down
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
Expand Up@@ -7,6 +7,10 @@ test('Should create a transaction for middleware', async ({ request }) => {
return transactionEvent?.transaction === 'middleware GET';
});

const routeTransactionPromise = waitForTransaction('nextjs-16', async transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint-behind-middleware';
});

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

Expand All@@ -20,6 +24,12 @@ test('Should create a transaction for middleware', async ({ request }) => {
// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// Tags set in middleware must not leak into other requests' events (e.g. via a shared scope when the middleware
// runs in a detached context - https://github.com/vercel/next.js/pull/95306)
const routeTransaction = await routeTransactionPromise;
expect(routeTransaction.tags?.['my-isolated-tag']).not.toBeDefined();
expect(routeTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});

test('Faulty middlewares', async ({ request }) => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
import { stripUrlQueryAndFragment } from '@sentry/core';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from './nextSpanAttributes';

export interface MutableMiddlewareRootSpan {
attributes: Record<string, unknown>;
getName(): string | undefined;
setName(name: string): void;
setOp(op: string): void;
}

/**
* Normalizes the transaction name for the root span of a Next.js `Middleware.execute` request on the Edge runtime.
* Normalizes the transaction name and op for the root span of a Next.js `Middleware.execute` request.
*
* On the Edge runtime, middleware always runs in a detached sandbox, so `Middleware.execute` is the root span.
* On the Node.js runtime, this is the case since vercel/next.js#95306, where in-process
* middleware runs in a detached OTel context instead of inside the `BaseServer.handleRequest` span.
*
* Older Next.js versions append the full URL to the middleware span name (e.g. `middleware GET /foo?bar=1`),
* producing high-cardinality transaction names. We collapse the name to `middleware {METHOD}` when possible,
* and strip query/fragment otherwise.
*
* Called from two places that operate on different shapes of the same underlying root span:
* - Legacy mode: from `preprocessEvent`, adapted around a transaction `Event` whose `contexts.trace.data`
* holds the root span's attributes and whose `event.transaction` is the root span's name.
* - Streamed mode: from `processSegmentSpan`, adapted around a `StreamedSpanJSON` (the streamed
* counterpart of the legacy transaction root) directly.
*/
export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void {
const { attributes } = span;
Expand All@@ -27,6 +26,8 @@ export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void
return;
}

span.setOp('http.server.middleware');

const spanName = attributes[ATTR_NEXT_SPAN_NAME];
if (typeof spanName !== 'string' || !spanName || !span.getName()) {
return;
Expand Down
8 changes: 7 additions & 1 deletion packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from './enhanceMiddlewareRootSpan';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';

export * from '@sentry/vercel-edge';
export * from '../common';
Expand DownExpand Up@@ -155,6 +155,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
event.transaction = name;
},
setOp: op => {
event.contexts!.trace!.op = op;
},
});
}

Expand All@@ -171,6 +174,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
span.name = name;
},
setOp: op => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
});

Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,8 +84,13 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
// 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();
Expand Down
21 changes: 13 additions & 8 deletions packages/nextjs/src/server/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ import { isBuild } from '../common/utils/isBuild';
import { isCloudflareWaitUntilAvailable } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';
import { enhanceHandleRequestRootSpan } from './enhanceHandleRequestRootSpan';
import { handleOnSpanStart } from './handleOnSpanStart';
import { prepareSafeIdGeneratorContext } from './prepareSafeIdGeneratorContext';
Expand DownExpand Up@@ -249,16 +250,18 @@ export function init(options: NodeOptions): NodeClient | undefined {
// Span streaming bypasses event processors entirely - see the `processSegmentSpan` hook below for that path.
client?.on('preprocessEvent', event => {
if (event.type === 'transaction' && event.contexts?.trace?.data) {
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes: event.contexts.trace.data,
getName: () => event.transaction,
setName: name => {
setName: (name: string) => {
event.transaction = name;
},
setOp: op => {
setOp: (op: string) => {
event.contexts!.trace!.op = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
}

setUrlProcessingMetadata(event);
Expand All@@ -268,18 +271,20 @@ export function init(options: NodeOptions): NodeClient | undefined {
// transaction events, so the same enhancement has to be applied here directly on the span JSON.
client?.on('processSegmentSpan', span => {
const attributes = (span.attributes ??= {});
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes,
getName: () => span.name,
setName: name => {
setName: (name: string) => {
span.name = name;
},
// For streamed spans, op lives in `attributes['sentry.op']` - mirror it there so middleware
// overrides land somewhere readable (the legacy path uses a separate `event.contexts.trace.op`).
setOp: op => {
setOp: (op: string) => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
});

if (process.env.NODE_ENV === 'development') {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,82 @@
import { describe, expect, it } from 'vitest';
import { enhanceMiddlewareRootSpan } from '../../src/common/enhanceMiddlewareRootSpan';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../../src/common/nextSpanAttributes';
import { enhanceMiddlewareRootSpan } from '../../src/edge/enhanceMiddlewareRootSpan';

function makeSpan(attributes: Record<string, unknown>, name?: string) {
let currentName = name;
let currentOp: string | undefined;
return {
span: {
attributes,
getName: () => currentName,
setName: (n: string) => {
currentName = n;
},
setOp: (op: string) => {
currentOp = op;
},
},
getName: () => currentName,
getOp: () => currentOp,
};
}

describe('enhanceMiddlewareRootSpan', () => {
it('does nothing for spans that are not Middleware.execute', () => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'BaseServer.handleRequest', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
'GET /foo',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('GET /foo');
expect(getOp()).toBeUndefined();
});

it('does nothing when next.span_name is missing', () => {
const { span, getName } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');
it('sets the op but keeps the name when next.span_name is missing', () => {
const { span, getName, getOp } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is an empty string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is an empty string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: '' },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is not a string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is not a string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 123 },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when the current name is empty', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when the current name is empty', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
undefined,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBeUndefined();
expect(getOp()).toBe('http.server.middleware');
});

it.each([
Expand All@@ -75,14 +85,29 @@ describe('enhanceMiddlewareRootSpan', () => {
['middleware DELETE /resources/[id]', 'middleware DELETE'],
['middleware HEAD /', 'middleware HEAD'],
])('collapses "%s" to "%s"', (spanName, expected) => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: spanName },
spanName,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe(expected);
expect(getOp()).toBe('http.server.middleware');
});

it('normalizes the plain "middleware {METHOD}" name emitted for Node.js middleware', () => {
// Node.js middleware roots come pre-mangled by HTTP span inference (e.g. `GET middleware GET`),
// while `next.span_name` holds the original `middleware GET`.
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET' },
'GET middleware GET',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware GET');
expect(getOp()).toBe('http.server.middleware');
});

it('strips query and fragment from non-method-prefixed middleware names', () => {
Expand Down
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
Expand Up@@ -7,6 +7,10 @@ test('Should create a transaction for middleware', async ({ request }) => {
return transactionEvent?.transaction === 'middleware GET';
});

const routeTransactionPromise = waitForTransaction('nextjs-16', async transactionEvent => {
return transactionEvent?.transaction === 'GET /api/endpoint-behind-middleware';
});

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

Expand All@@ -20,6 +24,12 @@ test('Should create a transaction for middleware', async ({ request }) => {
// Assert that isolation scope works properly
expect(middlewareTransaction.tags?.['my-isolated-tag']).toBe(true);
expect(middlewareTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();

// Tags set in middleware must not leak into other requests' events (e.g. via a shared scope when the middleware
// runs in a detached context - https://github.com/vercel/next.js/pull/95306)
const routeTransaction = await routeTransactionPromise;
expect(routeTransaction.tags?.['my-isolated-tag']).not.toBeDefined();
expect(routeTransaction.tags?.['my-global-scope-isolated-tag']).not.toBeDefined();
});

test('Faulty middlewares', async ({ request }) => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
import { stripUrlQueryAndFragment } from '@sentry/core';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from './nextSpanAttributes';

export interface MutableMiddlewareRootSpan {
attributes: Record<string, unknown>;
getName(): string | undefined;
setName(name: string): void;
setOp(op: string): void;
}

/**
* Normalizes the transaction name for the root span of a Next.js `Middleware.execute` request on the Edge runtime.
* Normalizes the transaction name and op for the root span of a Next.js `Middleware.execute` request.
*
* On the Edge runtime, middleware always runs in a detached sandbox, so `Middleware.execute` is the root span.
* On the Node.js runtime, this is the case since vercel/next.js#95306, where in-process
* middleware runs in a detached OTel context instead of inside the `BaseServer.handleRequest` span.
*
* Older Next.js versions append the full URL to the middleware span name (e.g. `middleware GET /foo?bar=1`),
* producing high-cardinality transaction names. We collapse the name to `middleware {METHOD}` when possible,
* and strip query/fragment otherwise.
*
* Called from two places that operate on different shapes of the same underlying root span:
* - Legacy mode: from `preprocessEvent`, adapted around a transaction `Event` whose `contexts.trace.data`
* holds the root span's attributes and whose `event.transaction` is the root span's name.
* - Streamed mode: from `processSegmentSpan`, adapted around a `StreamedSpanJSON` (the streamed
* counterpart of the legacy transaction root) directly.
*/
export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void {
const { attributes } = span;
Expand All@@ -27,6 +26,8 @@ export function enhanceMiddlewareRootSpan(span: MutableMiddlewareRootSpan): void
return;
}

span.setOp('http.server.middleware');

const spanName = attributes[ATTR_NEXT_SPAN_NAME];
if (typeof spanName !== 'string' || !spanName || !span.getName()) {
return;
Expand Down
8 changes: 7 additions & 1 deletion packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout, isCloudflareWaitUntilAvailable, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from './enhanceMiddlewareRootSpan';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';

export * from '@sentry/vercel-edge';
export * from '../common';
Expand DownExpand Up@@ -155,6 +155,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
event.transaction = name;
},
setOp: op => {
event.contexts!.trace!.op = op;
},
});
}

Expand All@@ -171,6 +174,9 @@ export function init(options: VercelEdgeOptions = {}): void {
setName: name => {
span.name = name;
},
setOp: op => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
});

Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/handleOnSpanStart.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,8 +84,13 @@ export function handleOnSpanStart(span: Span): void {
addHeadersAsAttributes(headers, rootSpan);
}

// We want to fork the isolation scope for incoming requests
if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' && isRootSpan) {
// 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();
Expand Down
21 changes: 13 additions & 8 deletions packages/nextjs/src/server/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ import { isBuild } from '../common/utils/isBuild';
import { isCloudflareWaitUntilAvailable } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';
import { enhanceMiddlewareRootSpan } from '../common/enhanceMiddlewareRootSpan';
import { enhanceHandleRequestRootSpan } from './enhanceHandleRequestRootSpan';
import { handleOnSpanStart } from './handleOnSpanStart';
import { prepareSafeIdGeneratorContext } from './prepareSafeIdGeneratorContext';
Expand DownExpand Up@@ -249,16 +250,18 @@ export function init(options: NodeOptions): NodeClient | undefined {
// Span streaming bypasses event processors entirely - see the `processSegmentSpan` hook below for that path.
client?.on('preprocessEvent', event => {
if (event.type === 'transaction' && event.contexts?.trace?.data) {
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes: event.contexts.trace.data,
getName: () => event.transaction,
setName: name => {
setName: (name: string) => {
event.transaction = name;
},
setOp: op => {
setOp: (op: string) => {
event.contexts!.trace!.op = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
}

setUrlProcessingMetadata(event);
Expand All@@ -268,18 +271,20 @@ export function init(options: NodeOptions): NodeClient | undefined {
// transaction events, so the same enhancement has to be applied here directly on the span JSON.
client?.on('processSegmentSpan', span => {
const attributes = (span.attributes ??= {});
enhanceHandleRequestRootSpan({
const mutableRootSpan = {
attributes,
getName: () => span.name,
setName: name => {
setName: (name: string) => {
span.name = name;
},
// For streamed spans, op lives in `attributes['sentry.op']` - mirror it there so middleware
// overrides land somewhere readable (the legacy path uses a separate `event.contexts.trace.op`).
setOp: op => {
setOp: (op: string) => {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
},
});
};
enhanceHandleRequestRootSpan(mutableRootSpan);
enhanceMiddlewareRootSpan(mutableRootSpan);
});

if (process.env.NODE_ENV === 'development') {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,82 @@
import { describe, expect, it } from 'vitest';
import { enhanceMiddlewareRootSpan } from '../../src/common/enhanceMiddlewareRootSpan';
import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../../src/common/nextSpanAttributes';
import { enhanceMiddlewareRootSpan } from '../../src/edge/enhanceMiddlewareRootSpan';

function makeSpan(attributes: Record<string, unknown>, name?: string) {
let currentName = name;
let currentOp: string | undefined;
return {
span: {
attributes,
getName: () => currentName,
setName: (n: string) => {
currentName = n;
},
setOp: (op: string) => {
currentOp = op;
},
},
getName: () => currentName,
getOp: () => currentOp,
};
}

describe('enhanceMiddlewareRootSpan', () => {
it('does nothing for spans that are not Middleware.execute', () => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'BaseServer.handleRequest', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
'GET /foo',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('GET /foo');
expect(getOp()).toBeUndefined();
});

it('does nothing when next.span_name is missing', () => {
const { span, getName } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');
it('sets the op but keeps the name when next.span_name is missing', () => {
const { span, getName, getOp } = makeSpan({ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute' }, 'middleware');

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is an empty string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is an empty string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: '' },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when next.span_name is not a string', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when next.span_name is not a string', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 123 },
'middleware',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware');
expect(getOp()).toBe('http.server.middleware');
});

it('does nothing when the current name is empty', () => {
const { span, getName } = makeSpan(
it('sets the op but keeps the name when the current name is empty', () => {
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET /foo' },
undefined,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBeUndefined();
expect(getOp()).toBe('http.server.middleware');
});

it.each([
Expand All@@ -75,14 +85,29 @@ describe('enhanceMiddlewareRootSpan', () => {
['middleware DELETE /resources/[id]', 'middleware DELETE'],
['middleware HEAD /', 'middleware HEAD'],
])('collapses "%s" to "%s"', (spanName, expected) => {
const { span, getName } = makeSpan(
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: spanName },
spanName,
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe(expected);
expect(getOp()).toBe('http.server.middleware');
});

it('normalizes the plain "middleware {METHOD}" name emitted for Node.js middleware', () => {
// Node.js middleware roots come pre-mangled by HTTP span inference (e.g. `GET middleware GET`),
// while `next.span_name` holds the original `middleware GET`.
const { span, getName, getOp } = makeSpan(
{ [ATTR_NEXT_SPAN_TYPE]: 'Middleware.execute', [ATTR_NEXT_SPAN_NAME]: 'middleware GET' },
'GET middleware GET',
);

enhanceMiddlewareRootSpan(span);

expect(getName()).toBe('middleware GET');
expect(getOp()).toBe('http.server.middleware');
});

it('strips query and fragment from non-method-prefixed middleware names', () => {
Expand Down
Loading