test(nextjs): Test pages router API routes incoming trace propagation#14818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lforst wants to merge 2 commits into from
Closed

test(nextjs): Test pages router API routes incoming trace propagation #14818

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd14035
fix(core): Use consistent `continueTrace` implementation in core
mydea Dec 20, 2024
6350286
test(nextjs): Test pages router API routes incoming trace propagation
Dec 20, 2024
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
9 changes: 9 additions & 0 deletions dev-packages/e2e-tests/test-applications/nextjs-app-dir/pages/api/trace-propagation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { NextApiRequest, NextApiResponse } from 'next';

type Data = {
name: string;
};

export default function handler(req: NextApiRequest, res: NextApiResponse<Data>) {
res.status(200).json({ name: 'John Doe' });
}
21 changes: 21 additions & 0 deletions ...-tests/test-applications/nextjs-app-dir/tests/pages-api-handler-trace-propagation.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('Should create a transaction that has the same trace ID as the incoming request', async ({ request }) => {
const transactionPromise = waitForTransaction('nextjs-app-dir', async transactionEvent => {
return transactionEvent?.transaction === 'GET /api/trace-propagation';
});

await request.get('/api/trace-propagation', {
headers: {
'sentry-trace': '8ef4a40df2063cb023c93cbeb04d68c3-acf68e4724b58822-1',
},
});

expect((await transactionPromise).contexts?.trace).toBe(
expect.objectContaining({
trace_id: '8ef4a40df2063cb023c93cbeb04d68c3',
parent_span_id: 'acf68e4724b58822',
}),
);
});
1 change: 0 additions & 1 deletion packages/astro/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const Span: clientSdk.Span;

Expand Down
8 changes: 8 additions & 0 deletions packages/core/src/asyncContext/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Scope } from '../scope';
import type { getTraceData } from '../utils/traceData';
import type {
continueTrace,
startInactiveSpan,
startSpan,
startSpanManual,
Expand DownExpand Up@@ -68,4 +69,11 @@ export interface AsyncContextStrategy {

/** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
getTraceData?: typeof getTraceData;

/**
* Continue a trace from `sentry-trace` and `baggage` values.
* These values can be obtained from incoming request headers, or in the browser from `<meta name="sentry-trace">`
* and `<meta name="baggage">` HTML tags.
*/
continueTrace?: typeof continueTrace;
}
13 changes: 9 additions & 4 deletions packages/core/src/tracing/trace.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -192,15 +192,20 @@ export function startInactiveSpan(options: StartSpanOptions): Span {
* be attached to the incoming trace.
*/
export const continueTrace = <V>(
{
sentryTrace,
baggage,
}: {
options: {
sentryTrace: Parameters<typeof propagationContextFromHeaders>[0];
baggage: Parameters<typeof propagationContextFromHeaders>[1];
},
callback: () => V,
): V => {
const carrier = getMainCarrier();
const acs = getAsyncContextStrategy(carrier);
if (acs.continueTrace) {
return acs.continueTrace(options, callback);
}

const { sentryTrace, baggage } = options;

return withScope(scope => {
const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
scope.setPropagationContext(propagationContext);
Expand Down
4 changes: 1 addition & 3 deletions packages/node/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,6 @@ export type { NodeOptions } from './types';
export { addRequestDataToEvent, DEFAULT_USER_INCLUDES, extractRequestData } from '@sentry/core';

export {
// These are custom variants that need to be used instead of the core one
// As they have slightly different implementations
continueTrace,
// This needs exporting so the NodeClient can be used without calling init
setOpenTelemetryContextAsyncContextStrategy as setNodeAsyncContextStrategy,
} from '@sentry/opentelemetry';
Expand DownExpand Up@@ -105,6 +102,7 @@ export {
getIsolationScope,
getTraceData,
getTraceMetaTags,
continueTrace,
withScope,
withIsolationScope,
captureException,
Expand Down
1 change: 0 additions & 1 deletion packages/nuxt/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,4 +14,3 @@ export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsInteg
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;
export declare const continueTrace: typeof clientSdk.continueTrace;
3 changes: 2 additions & 1 deletion packages/opentelemetry/src/asyncContextStrategy.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
SENTRY_FORK_SET_ISOLATION_SCOPE_CONTEXT_KEY,
SENTRY_FORK_SET_SCOPE_CONTEXT_KEY,
} from './constants';
import { startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import { continueTrace, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import type { CurrentScopes } from './types';
import { getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
Expand DownExpand Up@@ -103,6 +103,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
getActiveSpan,
suppressTracing,
getTraceData,
continueTrace,
// The types here don't fully align, because our own `Span` type is narrower
// than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
Expand Down
17 changes: 14 additions & 3 deletions packages/opentelemetry/src/trace.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
import type { Context, Span, SpanContext, SpanOptions, Tracer } from '@opentelemetry/api';
import { SpanStatusCode, TraceFlags, context, trace } from '@opentelemetry/api';
import { suppressTracing } from '@opentelemetry/core';
import type { Client, DynamicSamplingContext, Scope, Span as SentrySpan, TraceContext } from '@sentry/core';
import type {
Client,
DynamicSamplingContext,
Scope,
Span as SentrySpan,
TraceContext,
continueTrace as baseContinueTrace,
} from '@sentry/core';
import {
SDK_VERSION,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
continueTrace as baseContinueTrace,
getClient,
getCurrentScope,
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
getRootSpan,
getTraceContextFromScope,
handleCallbackErrors,
propagationContextFromHeaders,
spanToJSON,
spanToTraceContext,
withScope,
} from '@sentry/core';
import { continueTraceAsRemoteSpan } from './propagator';
import type { OpenTelemetryClient, OpenTelemetrySpanContext } from './types';
Expand DownExpand Up@@ -247,7 +255,10 @@ function getContextForScope(scope?: Scope): Context {
* It propagates the trace as a remote span, in addition to setting it on the propagation context.
*/
export function continueTrace<T>(options: Parameters<typeof baseContinueTrace>[0], callback: () => T): T {
return baseContinueTrace(options, () => {
return withScope(scope => {
const { sentryTrace, baggage } = options;
const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
scope.setPropagationContext(propagationContext);
return continueTraceAsRemoteSpan(context.active(), options, callback);
});
}
Expand Down
1 change: 0 additions & 1 deletion packages/remix/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,6 @@ declare const runtime: 'client' | 'server';
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export const close = runtime === 'client' ? clientSdk.close : serverSdk.close;
export const flush = runtime === 'client' ? clientSdk.flush : serverSdk.flush;
Expand Down
2 changes: 1 addition & 1 deletion packages/remix/src/utils/instrumentServer.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
continueTrace,
fill,
getActiveSpan,
getClient,
Expand All@@ -19,7 +20,6 @@ import {
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/opentelemetry';
import { DEBUG_BUILD } from './debug-build';
import { captureRemixServerException, errorHandleDataFunction, errorHandleDocumentRequestFunction } from './errors';
import { getFutureFlagsServer, getRemixVersionFromBuild } from './futureFlags';
Expand Down
2 changes: 0 additions & 2 deletions packages/solidstart/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,3 @@ export declare const getClient: typeof clientSdk.getClient;
export declare function close(timeout?: number | undefined): PromiseLike<boolean>;
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;
2 changes: 0 additions & 2 deletions packages/sveltekit/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,4 @@ export declare function close(timeout?: number | undefined): PromiseLike<boolean
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

export declare function trackComponent(options: clientSdk.TrackingOptions): ReturnType<typeof clientSdk.trackComponent>;
2 changes: 1 addition & 1 deletion packages/sveltekit/src/server/handle.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Span } from '@sentry/core';
import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
continueTrace,
getActiveSpan,
getCurrentScope,
getDefaultIsolationScope,
Expand All@@ -13,7 +14,6 @@ import {
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/node';
import type { Handle, ResolveOptions } from '@sveltejs/kit';

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

Skip to content
test(nextjs): Test pages router API routes incoming trace propagation#14818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

lforst
wants to merge
2
commits into

from

 Closed


test(nextjs): Test pages router API routes incoming trace propagation
#14818
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
cd14035

fix(core): Use consistent `continueTrace` implementation in core


mydea Dec 20, 2024
6350286

test(nextjs): Test pages router API routes incoming trace propagation

Dec 20, 2024

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


9 changes: 9 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nextjs-app-dir/pages/api/trace-propagation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { NextApiRequest, NextApiResponse } from 'next';

type Data = {
 name: string;
};

export default function handler(req: NextApiRequest, res: NextApiResponse<Data>) {
 res.status(200).json({ name: 'John Doe' });
}

21 changes: 21 additions & 0 deletions
...-tests/test-applications/nextjs-app-dir/tests/pages-api-handler-trace-propagation.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('Should create a transaction that has the same trace ID as the incoming request', async ({ request }) => {
 const transactionPromise = waitForTransaction('nextjs-app-dir', async transactionEvent => {
 return transactionEvent?.transaction === 'GET /api/trace-propagation';
 });

 await request.get('/api/trace-propagation', {
 headers: {
 'sentry-trace': '8ef4a40df2063cb023c93cbeb04d68c3-acf68e4724b58822-1',
 },
 });

 expect((await transactionPromise).contexts?.trace).toBe(
 expect.objectContaining({
 trace_id: '8ef4a40df2063cb023c93cbeb04d68c3',
 parent_span_id: 'acf68e4724b58822',
 }),
 );
});

1 change: 0 additions & 1 deletion
packages/astro/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const Span: clientSdk.Span;

Expand Down

8 changes: 8 additions & 0 deletions
packages/core/src/asyncContext/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Scope } from '../scope';
import type { getTraceData } from '../utils/traceData';
import type {
 continueTrace,
 startInactiveSpan,
 startSpan,
 startSpanManual,
Expand DownExpand Up@@ -68,4 +69,11 @@ export interface AsyncContextStrategy {

 /** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
 getTraceData?: typeof getTraceData;

 /**
 * Continue a trace from `sentry-trace` and `baggage` values.
 * These values can be obtained from incoming request headers, or in the browser from `<meta name="sentry-trace">`
 * and `<meta name="baggage">` HTML tags.
 */
 continueTrace?: typeof continueTrace;
}

13 changes: 9 additions & 4 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,15 +192,20 @@ export function startInactiveSpan(options: StartSpanOptions): Span {
 * be attached to the incoming trace.
 */
export const continueTrace = <V>(
 {
 sentryTrace,
 baggage,
 }: {
 options: {
 sentryTrace: Parameters<typeof propagationContextFromHeaders>[0];
 baggage: Parameters<typeof propagationContextFromHeaders>[1];
 },
 callback: () => V,
): V => {
 const carrier = getMainCarrier();
 const acs = getAsyncContextStrategy(carrier);
 if (acs.continueTrace) {
 return acs.continueTrace(options, callback);
 }

 const { sentryTrace, baggage } = options;

 return withScope(scope => {
 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 scope.setPropagationContext(propagationContext);
Expand Down

4 changes: 1 addition & 3 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,6 @@ export type { NodeOptions } from './types';
export { addRequestDataToEvent, DEFAULT_USER_INCLUDES, extractRequestData } from '@sentry/core';

export {
 // These are custom variants that need to be used instead of the core one
 // As they have slightly different implementations
 continueTrace,
 // This needs exporting so the NodeClient can be used without calling init
 setOpenTelemetryContextAsyncContextStrategy as setNodeAsyncContextStrategy,
} from '@sentry/opentelemetry';
Expand DownExpand Up@@ -105,6 +102,7 @@ export {
 getIsolationScope,
 getTraceData,
 getTraceMetaTags,
 continueTrace,
 withScope,
 withIsolationScope,
 captureException,
Expand Down

1 change: 0 additions & 1 deletion
packages/nuxt/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,4 +14,3 @@ export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsInteg
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;
export declare const continueTrace: typeof clientSdk.continueTrace;

3 changes: 2 additions & 1 deletion
packages/opentelemetry/src/asyncContextStrategy.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
 SENTRY_FORK_SET_ISOLATION_SCOPE_CONTEXT_KEY,
 SENTRY_FORK_SET_SCOPE_CONTEXT_KEY,
} from './constants';
import { startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import { continueTrace, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import type { CurrentScopes } from './types';
import { getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
Expand DownExpand Up@@ -103,6 +103,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
 getActiveSpan,
 suppressTracing,
 getTraceData,
 continueTrace,
 // The types here don't fully align, because our own `Span` type is narrower
 // than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
 withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
Expand Down

17 changes: 14 additions & 3 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
import type { Context, Span, SpanContext, SpanOptions, Tracer } from '@opentelemetry/api';
import { SpanStatusCode, TraceFlags, context, trace } from '@opentelemetry/api';
import { suppressTracing } from '@opentelemetry/core';
import type { Client, DynamicSamplingContext, Scope, Span as SentrySpan, TraceContext } from '@sentry/core';
import type {
 Client,
 DynamicSamplingContext,
 Scope,
 Span as SentrySpan,
 TraceContext,
 continueTrace as baseContinueTrace,
} from '@sentry/core';
import {
 SDK_VERSION,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 continueTrace as baseContinueTrace,
 getClient,
 getCurrentScope,
 getDynamicSamplingContextFromScope,
 getDynamicSamplingContextFromSpan,
 getRootSpan,
 getTraceContextFromScope,
 handleCallbackErrors,
 propagationContextFromHeaders,
 spanToJSON,
 spanToTraceContext,
 withScope,
} from '@sentry/core';
import { continueTraceAsRemoteSpan } from './propagator';
import type { OpenTelemetryClient, OpenTelemetrySpanContext } from './types';
Expand DownExpand Up@@ -247,7 +255,10 @@ function getContextForScope(scope?: Scope): Context {
 * It propagates the trace as a remote span, in addition to setting it on the propagation context.
 */
export function continueTrace<T>(options: Parameters<typeof baseContinueTrace>[0], callback: () => T): T {
 return baseContinueTrace(options, () => {
 return withScope(scope => {
 const { sentryTrace, baggage } = options;
 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 scope.setPropagationContext(propagationContext);
 return continueTraceAsRemoteSpan(context.active(), options, callback);
 });
}
Expand Down

1 change: 0 additions & 1 deletion
packages/remix/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,6 @@ declare const runtime: 'client' | 'server';
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export const close = runtime === 'client' ? clientSdk.close : serverSdk.close;
export const flush = runtime === 'client' ? clientSdk.flush : serverSdk.flush;
Expand Down

2 changes: 1 addition & 1 deletion
packages/remix/src/utils/instrumentServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 continueTrace,
 fill,
 getActiveSpan,
 getClient,
Expand All@@ -19,7 +20,6 @@ import {
 winterCGRequestToRequestData,
 withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/opentelemetry';
import { DEBUG_BUILD } from './debug-build';
import { captureRemixServerException, errorHandleDataFunction, errorHandleDocumentRequestFunction } from './errors';
import { getFutureFlagsServer, getRemixVersionFromBuild } from './futureFlags';
Expand Down

2 changes: 0 additions & 2 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,3 @@ export declare const getClient: typeof clientSdk.getClient;
export declare function close(timeout?: number | undefined): PromiseLike<boolean>;
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

2 changes: 0 additions & 2 deletions
packages/sveltekit/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,4 @@ export declare function close(timeout?: number | undefined): PromiseLike<boolean
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

export declare function trackComponent(options: clientSdk.TrackingOptions): ReturnType<typeof clientSdk.trackComponent>;

2 changes: 1 addition & 1 deletion
packages/sveltekit/src/server/handle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Span } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 continueTrace,
 getActiveSpan,
 getCurrentScope,
 getDefaultIsolationScope,
Expand All@@ -13,7 +14,6 @@ import {
 winterCGRequestToRequestData,
 withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/node';
import type { Handle, ResolveOptions } from '@sveltejs/kit';

import { DEBUG_BUILD } from '../common/debug-build';
Expand Down

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

Skip to content
test(nextjs): Test pages router API routes incoming trace propagation#14818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

lforst
wants to merge
2
commits into

from

 Closed


test(nextjs): Test pages router API routes incoming trace propagation
#14818
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
cd14035

fix(core): Use consistent `continueTrace` implementation in core


mydea Dec 20, 2024
6350286

test(nextjs): Test pages router API routes incoming trace propagation

Dec 20, 2024

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


9 changes: 9 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nextjs-app-dir/pages/api/trace-propagation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { NextApiRequest, NextApiResponse } from 'next';

type Data = {
 name: string;
};

export default function handler(req: NextApiRequest, res: NextApiResponse<Data>) {
 res.status(200).json({ name: 'John Doe' });
}

21 changes: 21 additions & 0 deletions
...-tests/test-applications/nextjs-app-dir/tests/pages-api-handler-trace-propagation.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('Should create a transaction that has the same trace ID as the incoming request', async ({ request }) => {
 const transactionPromise = waitForTransaction('nextjs-app-dir', async transactionEvent => {
 return transactionEvent?.transaction === 'GET /api/trace-propagation';
 });

 await request.get('/api/trace-propagation', {
 headers: {
 'sentry-trace': '8ef4a40df2063cb023c93cbeb04d68c3-acf68e4724b58822-1',
 },
 });

 expect((await transactionPromise).contexts?.trace).toBe(
 expect.objectContaining({
 trace_id: '8ef4a40df2063cb023c93cbeb04d68c3',
 parent_span_id: 'acf68e4724b58822',
 }),
 );
});

1 change: 0 additions & 1 deletion
packages/astro/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const Span: clientSdk.Span;

Expand Down

8 changes: 8 additions & 0 deletions
packages/core/src/asyncContext/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Scope } from '../scope';
import type { getTraceData } from '../utils/traceData';
import type {
 continueTrace,
 startInactiveSpan,
 startSpan,
 startSpanManual,
Expand DownExpand Up@@ -68,4 +69,11 @@ export interface AsyncContextStrategy {

 /** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
 getTraceData?: typeof getTraceData;

 /**
 * Continue a trace from `sentry-trace` and `baggage` values.
 * These values can be obtained from incoming request headers, or in the browser from `<meta name="sentry-trace">`
 * and `<meta name="baggage">` HTML tags.
 */
 continueTrace?: typeof continueTrace;
}

13 changes: 9 additions & 4 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,15 +192,20 @@ export function startInactiveSpan(options: StartSpanOptions): Span {
 * be attached to the incoming trace.
 */
export const continueTrace = <V>(
 {
 sentryTrace,
 baggage,
 }: {
 options: {
 sentryTrace: Parameters<typeof propagationContextFromHeaders>[0];
 baggage: Parameters<typeof propagationContextFromHeaders>[1];
 },
 callback: () => V,
): V => {
 const carrier = getMainCarrier();
 const acs = getAsyncContextStrategy(carrier);
 if (acs.continueTrace) {
 return acs.continueTrace(options, callback);
 }

 const { sentryTrace, baggage } = options;

 return withScope(scope => {
 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 scope.setPropagationContext(propagationContext);
Expand Down

4 changes: 1 addition & 3 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,6 @@ export type { NodeOptions } from './types';
export { addRequestDataToEvent, DEFAULT_USER_INCLUDES, extractRequestData } from '@sentry/core';

export {
 // These are custom variants that need to be used instead of the core one
 // As they have slightly different implementations
 continueTrace,
 // This needs exporting so the NodeClient can be used without calling init
 setOpenTelemetryContextAsyncContextStrategy as setNodeAsyncContextStrategy,
} from '@sentry/opentelemetry';
Expand DownExpand Up@@ -105,6 +102,7 @@ export {
 getIsolationScope,
 getTraceData,
 getTraceMetaTags,
 continueTrace,
 withScope,
 withIsolationScope,
 captureException,
Expand Down

1 change: 0 additions & 1 deletion
packages/nuxt/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,4 +14,3 @@ export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsInteg
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;
export declare const continueTrace: typeof clientSdk.continueTrace;

3 changes: 2 additions & 1 deletion
packages/opentelemetry/src/asyncContextStrategy.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
 SENTRY_FORK_SET_ISOLATION_SCOPE_CONTEXT_KEY,
 SENTRY_FORK_SET_SCOPE_CONTEXT_KEY,
} from './constants';
import { startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import { continueTrace, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import type { CurrentScopes } from './types';
import { getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
Expand DownExpand Up@@ -103,6 +103,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
 getActiveSpan,
 suppressTracing,
 getTraceData,
 continueTrace,
 // The types here don't fully align, because our own `Span` type is narrower
 // than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
 withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
Expand Down

17 changes: 14 additions & 3 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
import type { Context, Span, SpanContext, SpanOptions, Tracer } from '@opentelemetry/api';
import { SpanStatusCode, TraceFlags, context, trace } from '@opentelemetry/api';
import { suppressTracing } from '@opentelemetry/core';
import type { Client, DynamicSamplingContext, Scope, Span as SentrySpan, TraceContext } from '@sentry/core';
import type {
 Client,
 DynamicSamplingContext,
 Scope,
 Span as SentrySpan,
 TraceContext,
 continueTrace as baseContinueTrace,
} from '@sentry/core';
import {
 SDK_VERSION,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 continueTrace as baseContinueTrace,
 getClient,
 getCurrentScope,
 getDynamicSamplingContextFromScope,
 getDynamicSamplingContextFromSpan,
 getRootSpan,
 getTraceContextFromScope,
 handleCallbackErrors,
 propagationContextFromHeaders,
 spanToJSON,
 spanToTraceContext,
 withScope,
} from '@sentry/core';
import { continueTraceAsRemoteSpan } from './propagator';
import type { OpenTelemetryClient, OpenTelemetrySpanContext } from './types';
Expand DownExpand Up@@ -247,7 +255,10 @@ function getContextForScope(scope?: Scope): Context {
 * It propagates the trace as a remote span, in addition to setting it on the propagation context.
 */
export function continueTrace<T>(options: Parameters<typeof baseContinueTrace>[0], callback: () => T): T {
 return baseContinueTrace(options, () => {
 return withScope(scope => {
 const { sentryTrace, baggage } = options;
 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 scope.setPropagationContext(propagationContext);
 return continueTraceAsRemoteSpan(context.active(), options, callback);
 });
}
Expand Down

1 change: 0 additions & 1 deletion
packages/remix/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,6 @@ declare const runtime: 'client' | 'server';
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export const close = runtime === 'client' ? clientSdk.close : serverSdk.close;
export const flush = runtime === 'client' ? clientSdk.flush : serverSdk.flush;
Expand Down

2 changes: 1 addition & 1 deletion
packages/remix/src/utils/instrumentServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 continueTrace,
 fill,
 getActiveSpan,
 getClient,
Expand All@@ -19,7 +20,6 @@ import {
 winterCGRequestToRequestData,
 withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/opentelemetry';
import { DEBUG_BUILD } from './debug-build';
import { captureRemixServerException, errorHandleDataFunction, errorHandleDocumentRequestFunction } from './errors';
import { getFutureFlagsServer, getRemixVersionFromBuild } from './futureFlags';
Expand Down

2 changes: 0 additions & 2 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,3 @@ export declare const getClient: typeof clientSdk.getClient;
export declare function close(timeout?: number | undefined): PromiseLike<boolean>;
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

2 changes: 0 additions & 2 deletions
packages/sveltekit/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,4 @@ export declare function close(timeout?: number | undefined): PromiseLike<boolean
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

export declare function trackComponent(options: clientSdk.TrackingOptions): ReturnType<typeof clientSdk.trackComponent>;

2 changes: 1 addition & 1 deletion
packages/sveltekit/src/server/handle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Span } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 continueTrace,
 getActiveSpan,
 getCurrentScope,
 getDefaultIsolationScope,
Expand All@@ -13,7 +14,6 @@ import {
 winterCGRequestToRequestData,
 withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/node';
import type { Handle, ResolveOptions } from '@sveltejs/kit';

import { DEBUG_BUILD } from '../common/debug-build';
Expand Down

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

Skip to content
test(nextjs): Test pages router API routes incoming trace propagation#14818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

lforst
wants to merge
2
commits into

from

 Closed


test(nextjs): Test pages router API routes incoming trace propagation
#14818
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
cd14035

fix(core): Use consistent `continueTrace` implementation in core


mydea Dec 20, 2024
6350286

test(nextjs): Test pages router API routes incoming trace propagation

Dec 20, 2024

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


9 changes: 9 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nextjs-app-dir/pages/api/trace-propagation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { NextApiRequest, NextApiResponse } from 'next';

type Data = {
 name: string;
};

export default function handler(req: NextApiRequest, res: NextApiResponse<Data>) {
 res.status(200).json({ name: 'John Doe' });
}

21 changes: 21 additions & 0 deletions
...-tests/test-applications/nextjs-app-dir/tests/pages-api-handler-trace-propagation.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('Should create a transaction that has the same trace ID as the incoming request', async ({ request }) => {
 const transactionPromise = waitForTransaction('nextjs-app-dir', async transactionEvent => {
 return transactionEvent?.transaction === 'GET /api/trace-propagation';
 });

 await request.get('/api/trace-propagation', {
 headers: {
 'sentry-trace': '8ef4a40df2063cb023c93cbeb04d68c3-acf68e4724b58822-1',
 },
 });

 expect((await transactionPromise).contexts?.trace).toBe(
 expect.objectContaining({
 trace_id: '8ef4a40df2063cb023c93cbeb04d68c3',
 parent_span_id: 'acf68e4724b58822',
 }),
 );
});

1 change: 0 additions & 1 deletion
packages/astro/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const Span: clientSdk.Span;

Expand Down

8 changes: 8 additions & 0 deletions
packages/core/src/asyncContext/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Scope } from '../scope';
import type { getTraceData } from '../utils/traceData';
import type {
 continueTrace,
 startInactiveSpan,
 startSpan,
 startSpanManual,
Expand DownExpand Up@@ -68,4 +69,11 @@ export interface AsyncContextStrategy {

 /** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
 getTraceData?: typeof getTraceData;

 /**
 * Continue a trace from `sentry-trace` and `baggage` values.
 * These values can be obtained from incoming request headers, or in the browser from `<meta name="sentry-trace">`
 * and `<meta name="baggage">` HTML tags.
 */
 continueTrace?: typeof continueTrace;
}

13 changes: 9 additions & 4 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,15 +192,20 @@ export function startInactiveSpan(options: StartSpanOptions): Span {
 * be attached to the incoming trace.
 */
export const continueTrace = <V>(
 {
 sentryTrace,
 baggage,
 }: {
 options: {
 sentryTrace: Parameters<typeof propagationContextFromHeaders>[0];
 baggage: Parameters<typeof propagationContextFromHeaders>[1];
 },
 callback: () => V,
): V => {
 const carrier = getMainCarrier();
 const acs = getAsyncContextStrategy(carrier);
 if (acs.continueTrace) {
 return acs.continueTrace(options, callback);
 }

 const { sentryTrace, baggage } = options;

 return withScope(scope => {
 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 scope.setPropagationContext(propagationContext);
Expand Down

4 changes: 1 addition & 3 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,6 @@ export type { NodeOptions } from './types';
export { addRequestDataToEvent, DEFAULT_USER_INCLUDES, extractRequestData } from '@sentry/core';

export {
 // These are custom variants that need to be used instead of the core one
 // As they have slightly different implementations
 continueTrace,
 // This needs exporting so the NodeClient can be used without calling init
 setOpenTelemetryContextAsyncContextStrategy as setNodeAsyncContextStrategy,
} from '@sentry/opentelemetry';
Expand DownExpand Up@@ -105,6 +102,7 @@ export {
 getIsolationScope,
 getTraceData,
 getTraceMetaTags,
 continueTrace,
 withScope,
 withIsolationScope,
 captureException,
Expand Down

1 change: 0 additions & 1 deletion
packages/nuxt/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,4 +14,3 @@ export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsInteg
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;
export declare const continueTrace: typeof clientSdk.continueTrace;

3 changes: 2 additions & 1 deletion
packages/opentelemetry/src/asyncContextStrategy.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
 SENTRY_FORK_SET_ISOLATION_SCOPE_CONTEXT_KEY,
 SENTRY_FORK_SET_SCOPE_CONTEXT_KEY,
} from './constants';
import { startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import { continueTrace, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import type { CurrentScopes } from './types';
import { getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
Expand DownExpand Up@@ -103,6 +103,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
 getActiveSpan,
 suppressTracing,
 getTraceData,
 continueTrace,
 // The types here don't fully align, because our own `Span` type is narrower
 // than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
 withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
Expand Down

17 changes: 14 additions & 3 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
import type { Context, Span, SpanContext, SpanOptions, Tracer } from '@opentelemetry/api';
import { SpanStatusCode, TraceFlags, context, trace } from '@opentelemetry/api';
import { suppressTracing } from '@opentelemetry/core';
import type { Client, DynamicSamplingContext, Scope, Span as SentrySpan, TraceContext } from '@sentry/core';
import type {
 Client,
 DynamicSamplingContext,
 Scope,
 Span as SentrySpan,
 TraceContext,
 continueTrace as baseContinueTrace,
} from '@sentry/core';
import {
 SDK_VERSION,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 continueTrace as baseContinueTrace,
 getClient,
 getCurrentScope,
 getDynamicSamplingContextFromScope,
 getDynamicSamplingContextFromSpan,
 getRootSpan,
 getTraceContextFromScope,
 handleCallbackErrors,
 propagationContextFromHeaders,
 spanToJSON,
 spanToTraceContext,
 withScope,
} from '@sentry/core';
import { continueTraceAsRemoteSpan } from './propagator';
import type { OpenTelemetryClient, OpenTelemetrySpanContext } from './types';
Expand DownExpand Up@@ -247,7 +255,10 @@ function getContextForScope(scope?: Scope): Context {
 * It propagates the trace as a remote span, in addition to setting it on the propagation context.
 */
export function continueTrace<T>(options: Parameters<typeof baseContinueTrace>[0], callback: () => T): T {
 return baseContinueTrace(options, () => {
 return withScope(scope => {
 const { sentryTrace, baggage } = options;
 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 scope.setPropagationContext(propagationContext);
 return continueTraceAsRemoteSpan(context.active(), options, callback);
 });
}
Expand Down

1 change: 0 additions & 1 deletion
packages/remix/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,6 @@ declare const runtime: 'client' | 'server';
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export const close = runtime === 'client' ? clientSdk.close : serverSdk.close;
export const flush = runtime === 'client' ? clientSdk.flush : serverSdk.flush;
Expand Down

2 changes: 1 addition & 1 deletion
packages/remix/src/utils/instrumentServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 continueTrace,
 fill,
 getActiveSpan,
 getClient,
Expand All@@ -19,7 +20,6 @@ import {
 winterCGRequestToRequestData,
 withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/opentelemetry';
import { DEBUG_BUILD } from './debug-build';
import { captureRemixServerException, errorHandleDataFunction, errorHandleDocumentRequestFunction } from './errors';
import { getFutureFlagsServer, getRemixVersionFromBuild } from './futureFlags';
Expand Down

2 changes: 0 additions & 2 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,3 @@ export declare const getClient: typeof clientSdk.getClient;
export declare function close(timeout?: number | undefined): PromiseLike<boolean>;
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

2 changes: 0 additions & 2 deletions
packages/sveltekit/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,4 @@ export declare function close(timeout?: number | undefined): PromiseLike<boolean
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

export declare function trackComponent(options: clientSdk.TrackingOptions): ReturnType<typeof clientSdk.trackComponent>;

2 changes: 1 addition & 1 deletion
packages/sveltekit/src/server/handle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Span } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 continueTrace,
 getActiveSpan,
 getCurrentScope,
 getDefaultIsolationScope,
Expand All@@ -13,7 +14,6 @@ import {
 winterCGRequestToRequestData,
 withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/node';
import type { Handle, ResolveOptions } from '@sveltejs/kit';

import { DEBUG_BUILD } from '../common/debug-build';
Expand Down

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

Skip to content
test(nextjs): Test pages router API routes incoming trace propagation#14818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

lforst
wants to merge
2
commits into

from

 Closed


test(nextjs): Test pages router API routes incoming trace propagation
#14818
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
cd14035

fix(core): Use consistent `continueTrace` implementation in core


mydea Dec 20, 2024
6350286

test(nextjs): Test pages router API routes incoming trace propagation

Dec 20, 2024

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


9 changes: 9 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nextjs-app-dir/pages/api/trace-propagation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { NextApiRequest, NextApiResponse } from 'next';

type Data = {
 name: string;
};

export default function handler(req: NextApiRequest, res: NextApiResponse<Data>) {
 res.status(200).json({ name: 'John Doe' });
}

21 changes: 21 additions & 0 deletions
...-tests/test-applications/nextjs-app-dir/tests/pages-api-handler-trace-propagation.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('Should create a transaction that has the same trace ID as the incoming request', async ({ request }) => {
 const transactionPromise = waitForTransaction('nextjs-app-dir', async transactionEvent => {
 return transactionEvent?.transaction === 'GET /api/trace-propagation';
 });

 await request.get('/api/trace-propagation', {
 headers: {
 'sentry-trace': '8ef4a40df2063cb023c93cbeb04d68c3-acf68e4724b58822-1',
 },
 });

 expect((await transactionPromise).contexts?.trace).toBe(
 expect.objectContaining({
 trace_id: '8ef4a40df2063cb023c93cbeb04d68c3',
 parent_span_id: 'acf68e4724b58822',
 }),
 );
});

1 change: 0 additions & 1 deletion
packages/astro/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const Span: clientSdk.Span;

Expand Down

8 changes: 8 additions & 0 deletions
packages/core/src/asyncContext/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Scope } from '../scope';
import type { getTraceData } from '../utils/traceData';
import type {
 continueTrace,
 startInactiveSpan,
 startSpan,
 startSpanManual,
Expand DownExpand Up@@ -68,4 +69,11 @@ export interface AsyncContextStrategy {

 /** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
 getTraceData?: typeof getTraceData;

 /**
 * Continue a trace from `sentry-trace` and `baggage` values.
 * These values can be obtained from incoming request headers, or in the browser from `<meta name="sentry-trace">`
 * and `<meta name="baggage">` HTML tags.
 */
 continueTrace?: typeof continueTrace;
}

13 changes: 9 additions & 4 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,15 +192,20 @@ export function startInactiveSpan(options: StartSpanOptions): Span {
 * be attached to the incoming trace.
 */
export const continueTrace = <V>(
 {
 sentryTrace,
 baggage,
 }: {
 options: {
 sentryTrace: Parameters<typeof propagationContextFromHeaders>[0];
 baggage: Parameters<typeof propagationContextFromHeaders>[1];
 },
 callback: () => V,
): V => {
 const carrier = getMainCarrier();
 const acs = getAsyncContextStrategy(carrier);
 if (acs.continueTrace) {
 return acs.continueTrace(options, callback);
 }

 const { sentryTrace, baggage } = options;

 return withScope(scope => {
 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 scope.setPropagationContext(propagationContext);
Expand Down

4 changes: 1 addition & 3 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,6 @@ export type { NodeOptions } from './types';
export { addRequestDataToEvent, DEFAULT_USER_INCLUDES, extractRequestData } from '@sentry/core';

export {
 // These are custom variants that need to be used instead of the core one
 // As they have slightly different implementations
 continueTrace,
 // This needs exporting so the NodeClient can be used without calling init
 setOpenTelemetryContextAsyncContextStrategy as setNodeAsyncContextStrategy,
} from '@sentry/opentelemetry';
Expand DownExpand Up@@ -105,6 +102,7 @@ export {
 getIsolationScope,
 getTraceData,
 getTraceMetaTags,
 continueTrace,
 withScope,
 withIsolationScope,
 captureException,
Expand Down

1 change: 0 additions & 1 deletion
packages/nuxt/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,4 +14,3 @@ export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsInteg
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;
export declare const continueTrace: typeof clientSdk.continueTrace;

3 changes: 2 additions & 1 deletion
packages/opentelemetry/src/asyncContextStrategy.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
 SENTRY_FORK_SET_ISOLATION_SCOPE_CONTEXT_KEY,
 SENTRY_FORK_SET_SCOPE_CONTEXT_KEY,
} from './constants';
import { startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import { continueTrace, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import type { CurrentScopes } from './types';
import { getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
Expand DownExpand Up@@ -103,6 +103,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
 getActiveSpan,
 suppressTracing,
 getTraceData,
 continueTrace,
 // The types here don't fully align, because our own `Span` type is narrower
 // than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
 withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
Expand Down

17 changes: 14 additions & 3 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
import type { Context, Span, SpanContext, SpanOptions, Tracer } from '@opentelemetry/api';
import { SpanStatusCode, TraceFlags, context, trace } from '@opentelemetry/api';
import { suppressTracing } from '@opentelemetry/core';
import type { Client, DynamicSamplingContext, Scope, Span as SentrySpan, TraceContext } from '@sentry/core';
import type {
 Client,
 DynamicSamplingContext,
 Scope,
 Span as SentrySpan,
 TraceContext,
 continueTrace as baseContinueTrace,
} from '@sentry/core';
import {
 SDK_VERSION,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 continueTrace as baseContinueTrace,
 getClient,
 getCurrentScope,
 getDynamicSamplingContextFromScope,
 getDynamicSamplingContextFromSpan,
 getRootSpan,
 getTraceContextFromScope,
 handleCallbackErrors,
 propagationContextFromHeaders,
 spanToJSON,
 spanToTraceContext,
 withScope,
} from '@sentry/core';
import { continueTraceAsRemoteSpan } from './propagator';
import type { OpenTelemetryClient, OpenTelemetrySpanContext } from './types';
Expand DownExpand Up@@ -247,7 +255,10 @@ function getContextForScope(scope?: Scope): Context {
 * It propagates the trace as a remote span, in addition to setting it on the propagation context.
 */
export function continueTrace<T>(options: Parameters<typeof baseContinueTrace>[0], callback: () => T): T {
 return baseContinueTrace(options, () => {
 return withScope(scope => {
 const { sentryTrace, baggage } = options;
 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 scope.setPropagationContext(propagationContext);
 return continueTraceAsRemoteSpan(context.active(), options, callback);
 });
}
Expand Down

1 change: 0 additions & 1 deletion
packages/remix/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,6 @@ declare const runtime: 'client' | 'server';
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export const close = runtime === 'client' ? clientSdk.close : serverSdk.close;
export const flush = runtime === 'client' ? clientSdk.flush : serverSdk.flush;
Expand Down

2 changes: 1 addition & 1 deletion
packages/remix/src/utils/instrumentServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 continueTrace,
 fill,
 getActiveSpan,
 getClient,
Expand All@@ -19,7 +20,6 @@ import {
 winterCGRequestToRequestData,
 withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/opentelemetry';
import { DEBUG_BUILD } from './debug-build';
import { captureRemixServerException, errorHandleDataFunction, errorHandleDocumentRequestFunction } from './errors';
import { getFutureFlagsServer, getRemixVersionFromBuild } from './futureFlags';
Expand Down

2 changes: 0 additions & 2 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,3 @@ export declare const getClient: typeof clientSdk.getClient;
export declare function close(timeout?: number | undefined): PromiseLike<boolean>;
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

2 changes: 0 additions & 2 deletions
packages/sveltekit/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,4 @@ export declare function close(timeout?: number | undefined): PromiseLike<boolean
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

export declare function trackComponent(options: clientSdk.TrackingOptions): ReturnType<typeof clientSdk.trackComponent>;

2 changes: 1 addition & 1 deletion
packages/sveltekit/src/server/handle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Span } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 continueTrace,
 getActiveSpan,
 getCurrentScope,
 getDefaultIsolationScope,
Expand All@@ -13,7 +14,6 @@ import {
 winterCGRequestToRequestData,
 withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/node';
import type { Handle, ResolveOptions } from '@sveltejs/kit';

import { DEBUG_BUILD } from '../common/debug-build';
Expand Down

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

Skip to content
test(nextjs): Test pages router API routes incoming trace propagation#14818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

lforst
wants to merge
2
commits into

from

 Closed


test(nextjs): Test pages router API routes incoming trace propagation
#14818
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
cd14035

fix(core): Use consistent `continueTrace` implementation in core


mydea Dec 20, 2024
6350286

test(nextjs): Test pages router API routes incoming trace propagation

Dec 20, 2024

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


9 changes: 9 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nextjs-app-dir/pages/api/trace-propagation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { NextApiRequest, NextApiResponse } from 'next';

type Data = {
 name: string;
};

export default function handler(req: NextApiRequest, res: NextApiResponse<Data>) {
 res.status(200).json({ name: 'John Doe' });
}

21 changes: 21 additions & 0 deletions
...-tests/test-applications/nextjs-app-dir/tests/pages-api-handler-trace-propagation.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('Should create a transaction that has the same trace ID as the incoming request', async ({ request }) => {
 const transactionPromise = waitForTransaction('nextjs-app-dir', async transactionEvent => {
 return transactionEvent?.transaction === 'GET /api/trace-propagation';
 });

 await request.get('/api/trace-propagation', {
 headers: {
 'sentry-trace': '8ef4a40df2063cb023c93cbeb04d68c3-acf68e4724b58822-1',
 },
 });

 expect((await transactionPromise).contexts?.trace).toBe(
 expect.objectContaining({
 trace_id: '8ef4a40df2063cb023c93cbeb04d68c3',
 parent_span_id: 'acf68e4724b58822',
 }),
 );
});

1 change: 0 additions & 1 deletion
packages/astro/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const Span: clientSdk.Span;

Expand Down

8 changes: 8 additions & 0 deletions
packages/core/src/asyncContext/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Scope } from '../scope';
import type { getTraceData } from '../utils/traceData';
import type {
 continueTrace,
 startInactiveSpan,
 startSpan,
 startSpanManual,
Expand DownExpand Up@@ -68,4 +69,11 @@ export interface AsyncContextStrategy {

 /** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
 getTraceData?: typeof getTraceData;

 /**
 * Continue a trace from `sentry-trace` and `baggage` values.
 * These values can be obtained from incoming request headers, or in the browser from `<meta name="sentry-trace">`
 * and `<meta name="baggage">` HTML tags.
 */
 continueTrace?: typeof continueTrace;
}

13 changes: 9 additions & 4 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,15 +192,20 @@ export function startInactiveSpan(options: StartSpanOptions): Span {
 * be attached to the incoming trace.
 */
export const continueTrace = <V>(
 {
 sentryTrace,
 baggage,
 }: {
 options: {
 sentryTrace: Parameters<typeof propagationContextFromHeaders>[0];
 baggage: Parameters<typeof propagationContextFromHeaders>[1];
 },
 callback: () => V,
): V => {
 const carrier = getMainCarrier();
 const acs = getAsyncContextStrategy(carrier);
 if (acs.continueTrace) {
 return acs.continueTrace(options, callback);
 }

 const { sentryTrace, baggage } = options;

 return withScope(scope => {
 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 scope.setPropagationContext(propagationContext);
Expand Down

4 changes: 1 addition & 3 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,6 @@ export type { NodeOptions } from './types';
export { addRequestDataToEvent, DEFAULT_USER_INCLUDES, extractRequestData } from '@sentry/core';

export {
 // These are custom variants that need to be used instead of the core one
 // As they have slightly different implementations
 continueTrace,
 // This needs exporting so the NodeClient can be used without calling init
 setOpenTelemetryContextAsyncContextStrategy as setNodeAsyncContextStrategy,
} from '@sentry/opentelemetry';
Expand DownExpand Up@@ -105,6 +102,7 @@ export {
 getIsolationScope,
 getTraceData,
 getTraceMetaTags,
 continueTrace,
 withScope,
 withIsolationScope,
 captureException,
Expand Down

1 change: 0 additions & 1 deletion
packages/nuxt/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,4 +14,3 @@ export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsInteg
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;
export declare const continueTrace: typeof clientSdk.continueTrace;

3 changes: 2 additions & 1 deletion
packages/opentelemetry/src/asyncContextStrategy.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
 SENTRY_FORK_SET_ISOLATION_SCOPE_CONTEXT_KEY,
 SENTRY_FORK_SET_SCOPE_CONTEXT_KEY,
} from './constants';
import { startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import { continueTrace, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import type { CurrentScopes } from './types';
import { getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
Expand DownExpand Up@@ -103,6 +103,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
 getActiveSpan,
 suppressTracing,
 getTraceData,
 continueTrace,
 // The types here don't fully align, because our own `Span` type is narrower
 // than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
 withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
Expand Down

17 changes: 14 additions & 3 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
import type { Context, Span, SpanContext, SpanOptions, Tracer } from '@opentelemetry/api';
import { SpanStatusCode, TraceFlags, context, trace } from '@opentelemetry/api';
import { suppressTracing } from '@opentelemetry/core';
import type { Client, DynamicSamplingContext, Scope, Span as SentrySpan, TraceContext } from '@sentry/core';
import type {
 Client,
 DynamicSamplingContext,
 Scope,
 Span as SentrySpan,
 TraceContext,
 continueTrace as baseContinueTrace,
} from '@sentry/core';
import {
 SDK_VERSION,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 continueTrace as baseContinueTrace,
 getClient,
 getCurrentScope,
 getDynamicSamplingContextFromScope,
 getDynamicSamplingContextFromSpan,
 getRootSpan,
 getTraceContextFromScope,
 handleCallbackErrors,
 propagationContextFromHeaders,
 spanToJSON,
 spanToTraceContext,
 withScope,
} from '@sentry/core';
import { continueTraceAsRemoteSpan } from './propagator';
import type { OpenTelemetryClient, OpenTelemetrySpanContext } from './types';
Expand DownExpand Up@@ -247,7 +255,10 @@ function getContextForScope(scope?: Scope): Context {
 * It propagates the trace as a remote span, in addition to setting it on the propagation context.
 */
export function continueTrace<T>(options: Parameters<typeof baseContinueTrace>[0], callback: () => T): T {
 return baseContinueTrace(options, () => {
 return withScope(scope => {
 const { sentryTrace, baggage } = options;
 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 scope.setPropagationContext(propagationContext);
 return continueTraceAsRemoteSpan(context.active(), options, callback);
 });
}
Expand Down

1 change: 0 additions & 1 deletion
packages/remix/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,6 @@ declare const runtime: 'client' | 'server';
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export const close = runtime === 'client' ? clientSdk.close : serverSdk.close;
export const flush = runtime === 'client' ? clientSdk.flush : serverSdk.flush;
Expand Down

2 changes: 1 addition & 1 deletion
packages/remix/src/utils/instrumentServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 continueTrace,
 fill,
 getActiveSpan,
 getClient,
Expand All@@ -19,7 +20,6 @@ import {
 winterCGRequestToRequestData,
 withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/opentelemetry';
import { DEBUG_BUILD } from './debug-build';
import { captureRemixServerException, errorHandleDataFunction, errorHandleDocumentRequestFunction } from './errors';
import { getFutureFlagsServer, getRemixVersionFromBuild } from './futureFlags';
Expand Down

2 changes: 0 additions & 2 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,3 @@ export declare const getClient: typeof clientSdk.getClient;
export declare function close(timeout?: number | undefined): PromiseLike<boolean>;
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

2 changes: 0 additions & 2 deletions
packages/sveltekit/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,4 @@ export declare function close(timeout?: number | undefined): PromiseLike<boolean
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

export declare function trackComponent(options: clientSdk.TrackingOptions): ReturnType<typeof clientSdk.trackComponent>;

2 changes: 1 addition & 1 deletion
packages/sveltekit/src/server/handle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Span } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 continueTrace,
 getActiveSpan,
 getCurrentScope,
 getDefaultIsolationScope,
Expand All@@ -13,7 +14,6 @@ import {
 winterCGRequestToRequestData,
 withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/node';
import type { Handle, ResolveOptions } from '@sveltejs/kit';

import { DEBUG_BUILD } from '../common/debug-build';
Expand Down

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

Skip to content
test(nextjs): Test pages router API routes incoming trace propagation#14818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

lforst
wants to merge
2
commits into

from

 Closed


test(nextjs): Test pages router API routes incoming trace propagation
#14818
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
cd14035

fix(core): Use consistent `continueTrace` implementation in core


mydea Dec 20, 2024
6350286

test(nextjs): Test pages router API routes incoming trace propagation

Dec 20, 2024

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


9 changes: 9 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nextjs-app-dir/pages/api/trace-propagation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { NextApiRequest, NextApiResponse } from 'next';

type Data = {
 name: string;
};

export default function handler(req: NextApiRequest, res: NextApiResponse<Data>) {
 res.status(200).json({ name: 'John Doe' });
}

21 changes: 21 additions & 0 deletions
...-tests/test-applications/nextjs-app-dir/tests/pages-api-handler-trace-propagation.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('Should create a transaction that has the same trace ID as the incoming request', async ({ request }) => {
 const transactionPromise = waitForTransaction('nextjs-app-dir', async transactionEvent => {
 return transactionEvent?.transaction === 'GET /api/trace-propagation';
 });

 await request.get('/api/trace-propagation', {
 headers: {
 'sentry-trace': '8ef4a40df2063cb023c93cbeb04d68c3-acf68e4724b58822-1',
 },
 });

 expect((await transactionPromise).contexts?.trace).toBe(
 expect.objectContaining({
 trace_id: '8ef4a40df2063cb023c93cbeb04d68c3',
 parent_span_id: 'acf68e4724b58822',
 }),
 );
});

1 change: 0 additions & 1 deletion
packages/astro/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const Span: clientSdk.Span;

Expand Down

8 changes: 8 additions & 0 deletions
packages/core/src/asyncContext/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Scope } from '../scope';
import type { getTraceData } from '../utils/traceData';
import type {
 continueTrace,
 startInactiveSpan,
 startSpan,
 startSpanManual,
Expand DownExpand Up@@ -68,4 +69,11 @@ export interface AsyncContextStrategy {

 /** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
 getTraceData?: typeof getTraceData;

 /**
 * Continue a trace from `sentry-trace` and `baggage` values.
 * These values can be obtained from incoming request headers, or in the browser from `<meta name="sentry-trace">`
 * and `<meta name="baggage">` HTML tags.
 */
 continueTrace?: typeof continueTrace;
}

13 changes: 9 additions & 4 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,15 +192,20 @@ export function startInactiveSpan(options: StartSpanOptions): Span {
 * be attached to the incoming trace.
 */
export const continueTrace = <V>(
 {
 sentryTrace,
 baggage,
 }: {
 options: {
 sentryTrace: Parameters<typeof propagationContextFromHeaders>[0];
 baggage: Parameters<typeof propagationContextFromHeaders>[1];
 },
 callback: () => V,
): V => {
 const carrier = getMainCarrier();
 const acs = getAsyncContextStrategy(carrier);
 if (acs.continueTrace) {
 return acs.continueTrace(options, callback);
 }

 const { sentryTrace, baggage } = options;

 return withScope(scope => {
 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 scope.setPropagationContext(propagationContext);
Expand Down

4 changes: 1 addition & 3 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,6 @@ export type { NodeOptions } from './types';
export { addRequestDataToEvent, DEFAULT_USER_INCLUDES, extractRequestData } from '@sentry/core';

export {
 // These are custom variants that need to be used instead of the core one
 // As they have slightly different implementations
 continueTrace,
 // This needs exporting so the NodeClient can be used without calling init
 setOpenTelemetryContextAsyncContextStrategy as setNodeAsyncContextStrategy,
} from '@sentry/opentelemetry';
Expand DownExpand Up@@ -105,6 +102,7 @@ export {
 getIsolationScope,
 getTraceData,
 getTraceMetaTags,
 continueTrace,
 withScope,
 withIsolationScope,
 captureException,
Expand Down

1 change: 0 additions & 1 deletion
packages/nuxt/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,4 +14,3 @@ export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsInteg
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;
export declare const continueTrace: typeof clientSdk.continueTrace;

3 changes: 2 additions & 1 deletion
packages/opentelemetry/src/asyncContextStrategy.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
 SENTRY_FORK_SET_ISOLATION_SCOPE_CONTEXT_KEY,
 SENTRY_FORK_SET_SCOPE_CONTEXT_KEY,
} from './constants';
import { startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import { continueTrace, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import type { CurrentScopes } from './types';
import { getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
Expand DownExpand Up@@ -103,6 +103,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
 getActiveSpan,
 suppressTracing,
 getTraceData,
 continueTrace,
 // The types here don't fully align, because our own `Span` type is narrower
 // than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
 withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
Expand Down

17 changes: 14 additions & 3 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
import type { Context, Span, SpanContext, SpanOptions, Tracer } from '@opentelemetry/api';
import { SpanStatusCode, TraceFlags, context, trace } from '@opentelemetry/api';
import { suppressTracing } from '@opentelemetry/core';
import type { Client, DynamicSamplingContext, Scope, Span as SentrySpan, TraceContext } from '@sentry/core';
import type {
 Client,
 DynamicSamplingContext,
 Scope,
 Span as SentrySpan,
 TraceContext,
 continueTrace as baseContinueTrace,
} from '@sentry/core';
import {
 SDK_VERSION,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 continueTrace as baseContinueTrace,
 getClient,
 getCurrentScope,
 getDynamicSamplingContextFromScope,
 getDynamicSamplingContextFromSpan,
 getRootSpan,
 getTraceContextFromScope,
 handleCallbackErrors,
 propagationContextFromHeaders,
 spanToJSON,
 spanToTraceContext,
 withScope,
} from '@sentry/core';
import { continueTraceAsRemoteSpan } from './propagator';
import type { OpenTelemetryClient, OpenTelemetrySpanContext } from './types';
Expand DownExpand Up@@ -247,7 +255,10 @@ function getContextForScope(scope?: Scope): Context {
 * It propagates the trace as a remote span, in addition to setting it on the propagation context.
 */
export function continueTrace<T>(options: Parameters<typeof baseContinueTrace>[0], callback: () => T): T {
 return baseContinueTrace(options, () => {
 return withScope(scope => {
 const { sentryTrace, baggage } = options;
 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 scope.setPropagationContext(propagationContext);
 return continueTraceAsRemoteSpan(context.active(), options, callback);
 });
}
Expand Down

1 change: 0 additions & 1 deletion
packages/remix/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,6 @@ declare const runtime: 'client' | 'server';
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export const close = runtime === 'client' ? clientSdk.close : serverSdk.close;
export const flush = runtime === 'client' ? clientSdk.flush : serverSdk.flush;
Expand Down

2 changes: 1 addition & 1 deletion
packages/remix/src/utils/instrumentServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 continueTrace,
 fill,
 getActiveSpan,
 getClient,
Expand All@@ -19,7 +20,6 @@ import {
 winterCGRequestToRequestData,
 withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/opentelemetry';
import { DEBUG_BUILD } from './debug-build';
import { captureRemixServerException, errorHandleDataFunction, errorHandleDocumentRequestFunction } from './errors';
import { getFutureFlagsServer, getRemixVersionFromBuild } from './futureFlags';
Expand Down

2 changes: 0 additions & 2 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,3 @@ export declare const getClient: typeof clientSdk.getClient;
export declare function close(timeout?: number | undefined): PromiseLike<boolean>;
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

2 changes: 0 additions & 2 deletions
packages/sveltekit/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,4 @@ export declare function close(timeout?: number | undefined): PromiseLike<boolean
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

export declare function trackComponent(options: clientSdk.TrackingOptions): ReturnType<typeof clientSdk.trackComponent>;

2 changes: 1 addition & 1 deletion
packages/sveltekit/src/server/handle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Span } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 continueTrace,
 getActiveSpan,
 getCurrentScope,
 getDefaultIsolationScope,
Expand All@@ -13,7 +14,6 @@ import {
 winterCGRequestToRequestData,
 withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/node';
import type { Handle, ResolveOptions } from '@sveltejs/kit';

import { DEBUG_BUILD } from '../common/debug-build';
Expand Down

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

Skip to content
test(nextjs): Test pages router API routes incoming trace propagation#14818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

lforst
wants to merge
2
commits into

from

 Closed


test(nextjs): Test pages router API routes incoming trace propagation
#14818
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
cd14035

fix(core): Use consistent `continueTrace` implementation in core


mydea Dec 20, 2024
6350286

test(nextjs): Test pages router API routes incoming trace propagation

Dec 20, 2024

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


9 changes: 9 additions & 0 deletions
dev-packages/e2e-tests/test-applications/nextjs-app-dir/pages/api/trace-propagation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { NextApiRequest, NextApiResponse } from 'next';

type Data = {
 name: string;
};

export default function handler(req: NextApiRequest, res: NextApiResponse<Data>) {
 res.status(200).json({ name: 'John Doe' });
}

21 changes: 21 additions & 0 deletions
...-tests/test-applications/nextjs-app-dir/tests/pages-api-handler-trace-propagation.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('Should create a transaction that has the same trace ID as the incoming request', async ({ request }) => {
 const transactionPromise = waitForTransaction('nextjs-app-dir', async transactionEvent => {
 return transactionEvent?.transaction === 'GET /api/trace-propagation';
 });

 await request.get('/api/trace-propagation', {
 headers: {
 'sentry-trace': '8ef4a40df2063cb023c93cbeb04d68c3-acf68e4724b58822-1',
 },
 });

 expect((await transactionPromise).contexts?.trace).toBe(
 expect.objectContaining({
 trace_id: '8ef4a40df2063cb023c93cbeb04d68c3',
 parent_span_id: 'acf68e4724b58822',
 }),
 );
});

1 change: 0 additions & 1 deletion
packages/astro/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const Span: clientSdk.Span;

Expand Down

8 changes: 8 additions & 0 deletions
packages/core/src/asyncContext/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Scope } from '../scope';
import type { getTraceData } from '../utils/traceData';
import type {
 continueTrace,
 startInactiveSpan,
 startSpan,
 startSpanManual,
Expand DownExpand Up@@ -68,4 +69,11 @@ export interface AsyncContextStrategy {

 /** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
 getTraceData?: typeof getTraceData;

 /**
 * Continue a trace from `sentry-trace` and `baggage` values.
 * These values can be obtained from incoming request headers, or in the browser from `<meta name="sentry-trace">`
 * and `<meta name="baggage">` HTML tags.
 */
 continueTrace?: typeof continueTrace;
}

13 changes: 9 additions & 4 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,15 +192,20 @@ export function startInactiveSpan(options: StartSpanOptions): Span {
 * be attached to the incoming trace.
 */
export const continueTrace = <V>(
 {
 sentryTrace,
 baggage,
 }: {
 options: {
 sentryTrace: Parameters<typeof propagationContextFromHeaders>[0];
 baggage: Parameters<typeof propagationContextFromHeaders>[1];
 },
 callback: () => V,
): V => {
 const carrier = getMainCarrier();
 const acs = getAsyncContextStrategy(carrier);
 if (acs.continueTrace) {
 return acs.continueTrace(options, callback);
 }

 const { sentryTrace, baggage } = options;

 return withScope(scope => {
 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 scope.setPropagationContext(propagationContext);
Expand Down

4 changes: 1 addition & 3 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,6 @@ export type { NodeOptions } from './types';
export { addRequestDataToEvent, DEFAULT_USER_INCLUDES, extractRequestData } from '@sentry/core';

export {
 // These are custom variants that need to be used instead of the core one
 // As they have slightly different implementations
 continueTrace,
 // This needs exporting so the NodeClient can be used without calling init
 setOpenTelemetryContextAsyncContextStrategy as setNodeAsyncContextStrategy,
} from '@sentry/opentelemetry';
Expand DownExpand Up@@ -105,6 +102,7 @@ export {
 getIsolationScope,
 getTraceData,
 getTraceMetaTags,
 continueTrace,
 withScope,
 withIsolationScope,
 captureException,
Expand Down

1 change: 0 additions & 1 deletion
packages/nuxt/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,4 +14,3 @@ export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsInteg
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;
export declare const continueTrace: typeof clientSdk.continueTrace;

3 changes: 2 additions & 1 deletion
packages/opentelemetry/src/asyncContextStrategy.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
 SENTRY_FORK_SET_ISOLATION_SCOPE_CONTEXT_KEY,
 SENTRY_FORK_SET_SCOPE_CONTEXT_KEY,
} from './constants';
import { startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import { continueTrace, startInactiveSpan, startSpan, startSpanManual, withActiveSpan } from './trace';
import type { CurrentScopes } from './types';
import { getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
Expand DownExpand Up@@ -103,6 +103,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
 getActiveSpan,
 suppressTracing,
 getTraceData,
 continueTrace,
 // The types here don't fully align, because our own `Span` type is narrower
 // than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
 withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
Expand Down

17 changes: 14 additions & 3 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
import type { Context, Span, SpanContext, SpanOptions, Tracer } from '@opentelemetry/api';
import { SpanStatusCode, TraceFlags, context, trace } from '@opentelemetry/api';
import { suppressTracing } from '@opentelemetry/core';
import type { Client, DynamicSamplingContext, Scope, Span as SentrySpan, TraceContext } from '@sentry/core';
import type {
 Client,
 DynamicSamplingContext,
 Scope,
 Span as SentrySpan,
 TraceContext,
 continueTrace as baseContinueTrace,
} from '@sentry/core';
import {
 SDK_VERSION,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 continueTrace as baseContinueTrace,
 getClient,
 getCurrentScope,
 getDynamicSamplingContextFromScope,
 getDynamicSamplingContextFromSpan,
 getRootSpan,
 getTraceContextFromScope,
 handleCallbackErrors,
 propagationContextFromHeaders,
 spanToJSON,
 spanToTraceContext,
 withScope,
} from '@sentry/core';
import { continueTraceAsRemoteSpan } from './propagator';
import type { OpenTelemetryClient, OpenTelemetrySpanContext } from './types';
Expand DownExpand Up@@ -247,7 +255,10 @@ function getContextForScope(scope?: Scope): Context {
 * It propagates the trace as a remote span, in addition to setting it on the propagation context.
 */
export function continueTrace<T>(options: Parameters<typeof baseContinueTrace>[0], callback: () => T): T {
 return baseContinueTrace(options, () => {
 return withScope(scope => {
 const { sentryTrace, baggage } = options;
 const propagationContext = propagationContextFromHeaders(sentryTrace, baggage);
 scope.setPropagationContext(propagationContext);
 return continueTraceAsRemoteSpan(context.active(), options, callback);
 });
}
Expand Down

1 change: 0 additions & 1 deletion
packages/remix/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,6 @@ declare const runtime: 'client' | 'server';
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
export declare const getClient: typeof clientSdk.getClient;
export declare const continueTrace: typeof clientSdk.continueTrace;

export const close = runtime === 'client' ? clientSdk.close : serverSdk.close;
export const flush = runtime === 'client' ? clientSdk.flush : serverSdk.flush;
Expand Down

2 changes: 1 addition & 1 deletion
packages/remix/src/utils/instrumentServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 continueTrace,
 fill,
 getActiveSpan,
 getClient,
Expand All@@ -19,7 +20,6 @@ import {
 winterCGRequestToRequestData,
 withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/opentelemetry';
import { DEBUG_BUILD } from './debug-build';
import { captureRemixServerException, errorHandleDataFunction, errorHandleDocumentRequestFunction } from './errors';
import { getFutureFlagsServer, getRemixVersionFromBuild } from './futureFlags';
Expand Down

2 changes: 0 additions & 2 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,3 @@ export declare const getClient: typeof clientSdk.getClient;
export declare function close(timeout?: number | undefined): PromiseLike<boolean>;
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

2 changes: 0 additions & 2 deletions
packages/sveltekit/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,4 @@ export declare function close(timeout?: number | undefined): PromiseLike<boolean
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
export declare function lastEventId(): string | undefined;

export declare const continueTrace: typeof clientSdk.continueTrace;

export declare function trackComponent(options: clientSdk.TrackingOptions): ReturnType<typeof clientSdk.trackComponent>;

2 changes: 1 addition & 1 deletion
packages/sveltekit/src/server/handle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Span } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 continueTrace,
 getActiveSpan,
 getCurrentScope,
 getDefaultIsolationScope,
Expand All@@ -13,7 +14,6 @@ import {
 winterCGRequestToRequestData,
 withIsolationScope,
} from '@sentry/core';
import { continueTrace } from '@sentry/node';
import type { Handle, ResolveOptions } from '@sveltejs/kit';

import { DEBUG_BUILD } from '../common/debug-build';
Expand Down