Skip to content

fix(core): Use consistent continueTrace implementation in core#14813

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

Merged
mydea merged 5 commits into from
Dec 20, 2024
Merged

fix(core): Use consistent continueTrace implementation in core #14813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bdf884d
fix(core): Use consistent `continueTrace` implementation in core
mydea Dec 20, 2024
8add20a
kill more types
mydea Dec 20, 2024
8dd5213
fix next continuation
mydea Dec 20, 2024
c74c349
rename
mydea Dec 20, 2024
0b5edbd
fix tests & lint
mydea 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
2 changes: 0 additions & 2 deletions packages/astro/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,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
9 changes: 8 additions & 1 deletion packages/nextjs/src/common/pages-router-instrumentation/wrapApiHandlerWithSentry.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
captureException,
continueTrace,
getActiveSpan,
httpRequestToRequestData,
isString,
logger,
Expand DownExpand Up@@ -59,7 +60,13 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
req.__withSentry_applied__ = true;

return withIsolationScope(isolationScope => {
return continueTrace(
// Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
// Else, we manually continueTrace from the incoming headers
const continueTraceIfNoActiveSpan = getActiveSpan()
? <T>(_opts: unknown, callback: () => T) => callback()
: continueTrace;

return continueTraceIfNoActiveSpan(
{
sentryTrace:
req.headers && isString(req.headers['sentry-trace']) ? req.headers['sentry-trace'] : undefined,
Expand Down
9 changes: 8 additions & 1 deletion packages/nextjs/src/common/withServerActionInstrumentation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { RequestEventData } from '@sentry/core';
import { getActiveSpan } from '@sentry/core';
import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -95,7 +96,13 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
} satisfies RequestEventData,
});

return continueTrace(
// Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
// Else, we manually continueTrace from the incoming headers
const continueTraceIfNoActiveSpan = getActiveSpan()
? <T>(_opts: unknown, callback: () => T) => callback()
: continueTrace;

return continueTraceIfNoActiveSpan(
{
sentryTrace: sentryTraceHeader,
baggage: baggageHeader,
Expand Down
4 changes: 0 additions & 4 deletions packages/nextjs/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare function init(
options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions | edgeSdk.EdgeOptions,
): Client | undefined;

export declare const getClient: typeof clientSdk.getClient;
export declare const getRootSpan: typeof serverSdk.getRootSpan;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

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
14 changes: 9 additions & 5 deletions packages/opentelemetry/src/trace.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
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,
Expand DownExpand Up@@ -247,9 +253,7 @@ 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 continueTraceAsRemoteSpan(context.active(), options, callback);
});
return continueTraceAsRemoteSpan(context.active(), options, callback);
}

/**
Expand Down
22 changes: 3 additions & 19 deletions packages/opentelemetry/test/trace.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1576,11 +1576,8 @@ describe('continueTrace', () => {
);

expect(scope.getPropagationContext()).toEqual({
dsc: {}, // DSC should be an empty object (frozen), because there was an incoming trace
sampled: false,
parentSpanId: '1121201211212012',
spanId: expect.any(String),
traceId: '12312012123120121231201212312012',
traceId: expect.any(String),
});

expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1609,14 +1606,8 @@ describe('continueTrace', () => {
);

expect(scope.getPropagationContext()).toEqual({
dsc: {
environment: 'production',
version: '1.0',
},
sampled: true,
parentSpanId: '1121201211212012',
spanId: expect.any(String),
traceId: '12312012123120121231201212312012',
traceId: expect.any(String),
});

expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1645,16 +1636,9 @@ describe('continueTrace', () => {
);

expect(scope.getPropagationContext()).toEqual({
dsc: {
environment: 'production',
version: '1.0',
},
sampled: true,
parentSpanId: '1121201211212012',
spanId: expect.any(String),
traceId: '12312012123120121231201212312012',
traceId: expect.any(String),
});

expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
});

Expand Down
2 changes: 0 additions & 2 deletions packages/remix/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,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
4 changes: 0 additions & 4 deletions packages/solidstart/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare const contextLinesIntegration: typeof clientSdk.contextLinesInteg
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

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;
3 changes: 0 additions & 3 deletions packages/sveltekit/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,14 +42,11 @@ export declare const contextLinesIntegration: typeof clientSdk.contextLinesInteg
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

export declare const getClient: typeof clientSdk.getClient;
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;

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)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(core): Use consistent `continueTrace` implementation in core by mydea · Pull Request #14813 · getsentry/sentry-javascript · GitHub
Skip to content
fix(core): Use consistent continueTrace implementation in core#14813

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

 Merged

mydea
merged 5 commits into

from

Dec 20, 2024
 Merged


fix(core): Use consistent continueTrace implementation in core
#14813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
bdf884d

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


mydea Dec 20, 2024
8add20a

kill more types


mydea Dec 20, 2024
8dd5213

fix next continuation


mydea Dec 20, 2024
c74c349

rename


mydea Dec 20, 2024
0b5edbd

fix tests & lint


mydea 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


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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,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

9 changes: 8 additions & 1 deletion
packages/nextjs/src/common/pages-router-instrumentation/wrapApiHandlerWithSentry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 getActiveSpan,
 httpRequestToRequestData,
 isString,
 logger,
Expand DownExpand Up@@ -59,7 +60,13 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
 req.__withSentry_applied__ = true;

 return withIsolationScope(isolationScope => {
 return continueTrace(
 // Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
 // Else, we manually continueTrace from the incoming headers
 const continueTraceIfNoActiveSpan = getActiveSpan()
 ? <T>(_opts: unknown, callback: () => T) => callback()
 : continueTrace;

 return continueTraceIfNoActiveSpan(
 {
 sentryTrace:
 req.headers && isString(req.headers['sentry-trace']) ? req.headers['sentry-trace'] : undefined,
Expand Down

9 changes: 8 additions & 1 deletion
packages/nextjs/src/common/withServerActionInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { RequestEventData } from '@sentry/core';
import { getActiveSpan } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -95,7 +96,13 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
 } satisfies RequestEventData,
 });

 return continueTrace(
 // Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
 // Else, we manually continueTrace from the incoming headers
 const continueTraceIfNoActiveSpan = getActiveSpan()
 ? <T>(_opts: unknown, callback: () => T) => callback()
 : continueTrace;

 return continueTraceIfNoActiveSpan(
 {
 sentryTrace: sentryTraceHeader,
 baggage: baggageHeader,
Expand Down

4 changes: 0 additions & 4 deletions
packages/nextjs/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare function init(
 options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions | edgeSdk.EdgeOptions,
): Client | undefined;

export declare const getClient: typeof clientSdk.getClient;
export declare const getRootSpan: typeof serverSdk.getRootSpan;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

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

14 changes: 9 additions & 5 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
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,
Expand DownExpand Up@@ -247,9 +253,7 @@ 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 continueTraceAsRemoteSpan(context.active(), options, callback);
 });
 return continueTraceAsRemoteSpan(context.active(), options, callback);
}

/**
Expand Down

22 changes: 3 additions & 19 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1576,11 +1576,8 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {}, // DSC should be an empty object (frozen), because there was an incoming trace
 sampled: false,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1609,14 +1606,8 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {
 environment: 'production',
 version: '1.0',
 },
 sampled: true,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1645,16 +1636,9 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {
 environment: 'production',
 version: '1.0',
 },
 sampled: true,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
 });

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,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

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare const contextLinesIntegration: typeof clientSdk.contextLinesInteg
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

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;

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

View file


Open in desktop

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

export declare const getClient: typeof clientSdk.getClient;
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;

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)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(core): Use consistent `continueTrace` implementation in core by mydea · Pull Request #14813 · getsentry/sentry-javascript · GitHub
Skip to content
fix(core): Use consistent continueTrace implementation in core#14813

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

 Merged

mydea
merged 5 commits into

from

Dec 20, 2024
 Merged


fix(core): Use consistent continueTrace implementation in core
#14813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
bdf884d

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


mydea Dec 20, 2024
8add20a

kill more types


mydea Dec 20, 2024
8dd5213

fix next continuation


mydea Dec 20, 2024
c74c349

rename


mydea Dec 20, 2024
0b5edbd

fix tests & lint


mydea 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


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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,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

9 changes: 8 additions & 1 deletion
packages/nextjs/src/common/pages-router-instrumentation/wrapApiHandlerWithSentry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 getActiveSpan,
 httpRequestToRequestData,
 isString,
 logger,
Expand DownExpand Up@@ -59,7 +60,13 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
 req.__withSentry_applied__ = true;

 return withIsolationScope(isolationScope => {
 return continueTrace(
 // Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
 // Else, we manually continueTrace from the incoming headers
 const continueTraceIfNoActiveSpan = getActiveSpan()
 ? <T>(_opts: unknown, callback: () => T) => callback()
 : continueTrace;

 return continueTraceIfNoActiveSpan(
 {
 sentryTrace:
 req.headers && isString(req.headers['sentry-trace']) ? req.headers['sentry-trace'] : undefined,
Expand Down

9 changes: 8 additions & 1 deletion
packages/nextjs/src/common/withServerActionInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { RequestEventData } from '@sentry/core';
import { getActiveSpan } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -95,7 +96,13 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
 } satisfies RequestEventData,
 });

 return continueTrace(
 // Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
 // Else, we manually continueTrace from the incoming headers
 const continueTraceIfNoActiveSpan = getActiveSpan()
 ? <T>(_opts: unknown, callback: () => T) => callback()
 : continueTrace;

 return continueTraceIfNoActiveSpan(
 {
 sentryTrace: sentryTraceHeader,
 baggage: baggageHeader,
Expand Down

4 changes: 0 additions & 4 deletions
packages/nextjs/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare function init(
 options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions | edgeSdk.EdgeOptions,
): Client | undefined;

export declare const getClient: typeof clientSdk.getClient;
export declare const getRootSpan: typeof serverSdk.getRootSpan;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

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

14 changes: 9 additions & 5 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
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,
Expand DownExpand Up@@ -247,9 +253,7 @@ 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 continueTraceAsRemoteSpan(context.active(), options, callback);
 });
 return continueTraceAsRemoteSpan(context.active(), options, callback);
}

/**
Expand Down

22 changes: 3 additions & 19 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1576,11 +1576,8 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {}, // DSC should be an empty object (frozen), because there was an incoming trace
 sampled: false,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1609,14 +1606,8 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {
 environment: 'production',
 version: '1.0',
 },
 sampled: true,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1645,16 +1636,9 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {
 environment: 'production',
 version: '1.0',
 },
 sampled: true,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
 });

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,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

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare const contextLinesIntegration: typeof clientSdk.contextLinesInteg
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

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;

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

View file


Open in desktop

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

export declare const getClient: typeof clientSdk.getClient;
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;

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

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

 Merged

mydea
merged 5 commits into

from

Dec 20, 2024
 Merged


fix(core): Use consistent continueTrace implementation in core
#14813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
bdf884d

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


mydea Dec 20, 2024
8add20a

kill more types


mydea Dec 20, 2024
8dd5213

fix next continuation


mydea Dec 20, 2024
c74c349

rename


mydea Dec 20, 2024
0b5edbd

fix tests & lint


mydea 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


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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,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

9 changes: 8 additions & 1 deletion
packages/nextjs/src/common/pages-router-instrumentation/wrapApiHandlerWithSentry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 getActiveSpan,
 httpRequestToRequestData,
 isString,
 logger,
Expand DownExpand Up@@ -59,7 +60,13 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
 req.__withSentry_applied__ = true;

 return withIsolationScope(isolationScope => {
 return continueTrace(
 // Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
 // Else, we manually continueTrace from the incoming headers
 const continueTraceIfNoActiveSpan = getActiveSpan()
 ? <T>(_opts: unknown, callback: () => T) => callback()
 : continueTrace;

 return continueTraceIfNoActiveSpan(
 {
 sentryTrace:
 req.headers && isString(req.headers['sentry-trace']) ? req.headers['sentry-trace'] : undefined,
Expand Down

9 changes: 8 additions & 1 deletion
packages/nextjs/src/common/withServerActionInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { RequestEventData } from '@sentry/core';
import { getActiveSpan } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -95,7 +96,13 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
 } satisfies RequestEventData,
 });

 return continueTrace(
 // Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
 // Else, we manually continueTrace from the incoming headers
 const continueTraceIfNoActiveSpan = getActiveSpan()
 ? <T>(_opts: unknown, callback: () => T) => callback()
 : continueTrace;

 return continueTraceIfNoActiveSpan(
 {
 sentryTrace: sentryTraceHeader,
 baggage: baggageHeader,
Expand Down

4 changes: 0 additions & 4 deletions
packages/nextjs/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare function init(
 options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions | edgeSdk.EdgeOptions,
): Client | undefined;

export declare const getClient: typeof clientSdk.getClient;
export declare const getRootSpan: typeof serverSdk.getRootSpan;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

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

14 changes: 9 additions & 5 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
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,
Expand DownExpand Up@@ -247,9 +253,7 @@ 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 continueTraceAsRemoteSpan(context.active(), options, callback);
 });
 return continueTraceAsRemoteSpan(context.active(), options, callback);
}

/**
Expand Down

22 changes: 3 additions & 19 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1576,11 +1576,8 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {}, // DSC should be an empty object (frozen), because there was an incoming trace
 sampled: false,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1609,14 +1606,8 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {
 environment: 'production',
 version: '1.0',
 },
 sampled: true,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1645,16 +1636,9 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {
 environment: 'production',
 version: '1.0',
 },
 sampled: true,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
 });

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,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

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare const contextLinesIntegration: typeof clientSdk.contextLinesInteg
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

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;

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

View file


Open in desktop

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

export declare const getClient: typeof clientSdk.getClient;
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;

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)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
fix(core): Use consistent `continueTrace` implementation in core by mydea · Pull Request #14813 · getsentry/sentry-javascript · GitHub
Skip to content
fix(core): Use consistent continueTrace implementation in core#14813

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

 Merged

mydea
merged 5 commits into

from

Dec 20, 2024
 Merged


fix(core): Use consistent continueTrace implementation in core
#14813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
bdf884d

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


mydea Dec 20, 2024
8add20a

kill more types


mydea Dec 20, 2024
8dd5213

fix next continuation


mydea Dec 20, 2024
c74c349

rename


mydea Dec 20, 2024
0b5edbd

fix tests & lint


mydea 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


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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,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

9 changes: 8 additions & 1 deletion
packages/nextjs/src/common/pages-router-instrumentation/wrapApiHandlerWithSentry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 getActiveSpan,
 httpRequestToRequestData,
 isString,
 logger,
Expand DownExpand Up@@ -59,7 +60,13 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
 req.__withSentry_applied__ = true;

 return withIsolationScope(isolationScope => {
 return continueTrace(
 // Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
 // Else, we manually continueTrace from the incoming headers
 const continueTraceIfNoActiveSpan = getActiveSpan()
 ? <T>(_opts: unknown, callback: () => T) => callback()
 : continueTrace;

 return continueTraceIfNoActiveSpan(
 {
 sentryTrace:
 req.headers && isString(req.headers['sentry-trace']) ? req.headers['sentry-trace'] : undefined,
Expand Down

9 changes: 8 additions & 1 deletion
packages/nextjs/src/common/withServerActionInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { RequestEventData } from '@sentry/core';
import { getActiveSpan } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -95,7 +96,13 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
 } satisfies RequestEventData,
 });

 return continueTrace(
 // Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
 // Else, we manually continueTrace from the incoming headers
 const continueTraceIfNoActiveSpan = getActiveSpan()
 ? <T>(_opts: unknown, callback: () => T) => callback()
 : continueTrace;

 return continueTraceIfNoActiveSpan(
 {
 sentryTrace: sentryTraceHeader,
 baggage: baggageHeader,
Expand Down

4 changes: 0 additions & 4 deletions
packages/nextjs/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare function init(
 options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions | edgeSdk.EdgeOptions,
): Client | undefined;

export declare const getClient: typeof clientSdk.getClient;
export declare const getRootSpan: typeof serverSdk.getRootSpan;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

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

14 changes: 9 additions & 5 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
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,
Expand DownExpand Up@@ -247,9 +253,7 @@ 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 continueTraceAsRemoteSpan(context.active(), options, callback);
 });
 return continueTraceAsRemoteSpan(context.active(), options, callback);
}

/**
Expand Down

22 changes: 3 additions & 19 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1576,11 +1576,8 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {}, // DSC should be an empty object (frozen), because there was an incoming trace
 sampled: false,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1609,14 +1606,8 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {
 environment: 'production',
 version: '1.0',
 },
 sampled: true,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1645,16 +1636,9 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {
 environment: 'production',
 version: '1.0',
 },
 sampled: true,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
 });

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,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

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare const contextLinesIntegration: typeof clientSdk.contextLinesInteg
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

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;

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

View file


Open in desktop

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

export declare const getClient: typeof clientSdk.getClient;
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;

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)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(core): Use consistent `continueTrace` implementation in core by mydea · Pull Request #14813 · getsentry/sentry-javascript · GitHub
Skip to content
fix(core): Use consistent continueTrace implementation in core#14813

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

 Merged

mydea
merged 5 commits into

from

Dec 20, 2024
 Merged


fix(core): Use consistent continueTrace implementation in core
#14813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
bdf884d

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


mydea Dec 20, 2024
8add20a

kill more types


mydea Dec 20, 2024
8dd5213

fix next continuation


mydea Dec 20, 2024
c74c349

rename


mydea Dec 20, 2024
0b5edbd

fix tests & lint


mydea 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


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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,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

9 changes: 8 additions & 1 deletion
packages/nextjs/src/common/pages-router-instrumentation/wrapApiHandlerWithSentry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 getActiveSpan,
 httpRequestToRequestData,
 isString,
 logger,
Expand DownExpand Up@@ -59,7 +60,13 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
 req.__withSentry_applied__ = true;

 return withIsolationScope(isolationScope => {
 return continueTrace(
 // Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
 // Else, we manually continueTrace from the incoming headers
 const continueTraceIfNoActiveSpan = getActiveSpan()
 ? <T>(_opts: unknown, callback: () => T) => callback()
 : continueTrace;

 return continueTraceIfNoActiveSpan(
 {
 sentryTrace:
 req.headers && isString(req.headers['sentry-trace']) ? req.headers['sentry-trace'] : undefined,
Expand Down

9 changes: 8 additions & 1 deletion
packages/nextjs/src/common/withServerActionInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { RequestEventData } from '@sentry/core';
import { getActiveSpan } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -95,7 +96,13 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
 } satisfies RequestEventData,
 });

 return continueTrace(
 // Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
 // Else, we manually continueTrace from the incoming headers
 const continueTraceIfNoActiveSpan = getActiveSpan()
 ? <T>(_opts: unknown, callback: () => T) => callback()
 : continueTrace;

 return continueTraceIfNoActiveSpan(
 {
 sentryTrace: sentryTraceHeader,
 baggage: baggageHeader,
Expand Down

4 changes: 0 additions & 4 deletions
packages/nextjs/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare function init(
 options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions | edgeSdk.EdgeOptions,
): Client | undefined;

export declare const getClient: typeof clientSdk.getClient;
export declare const getRootSpan: typeof serverSdk.getRootSpan;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

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

14 changes: 9 additions & 5 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
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,
Expand DownExpand Up@@ -247,9 +253,7 @@ 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 continueTraceAsRemoteSpan(context.active(), options, callback);
 });
 return continueTraceAsRemoteSpan(context.active(), options, callback);
}

/**
Expand Down

22 changes: 3 additions & 19 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1576,11 +1576,8 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {}, // DSC should be an empty object (frozen), because there was an incoming trace
 sampled: false,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1609,14 +1606,8 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {
 environment: 'production',
 version: '1.0',
 },
 sampled: true,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1645,16 +1636,9 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {
 environment: 'production',
 version: '1.0',
 },
 sampled: true,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
 });

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,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

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare const contextLinesIntegration: typeof clientSdk.contextLinesInteg
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

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;

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

View file


Open in desktop

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

export declare const getClient: typeof clientSdk.getClient;
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;

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)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(core): Use consistent `continueTrace` implementation in core by mydea · Pull Request #14813 · getsentry/sentry-javascript · GitHub
Skip to content
fix(core): Use consistent continueTrace implementation in core#14813

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

 Merged

mydea
merged 5 commits into

from

Dec 20, 2024
 Merged


fix(core): Use consistent continueTrace implementation in core
#14813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
bdf884d

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


mydea Dec 20, 2024
8add20a

kill more types


mydea Dec 20, 2024
8dd5213

fix next continuation


mydea Dec 20, 2024
c74c349

rename


mydea Dec 20, 2024
0b5edbd

fix tests & lint


mydea 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


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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,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

9 changes: 8 additions & 1 deletion
packages/nextjs/src/common/pages-router-instrumentation/wrapApiHandlerWithSentry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 getActiveSpan,
 httpRequestToRequestData,
 isString,
 logger,
Expand DownExpand Up@@ -59,7 +60,13 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
 req.__withSentry_applied__ = true;

 return withIsolationScope(isolationScope => {
 return continueTrace(
 // Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
 // Else, we manually continueTrace from the incoming headers
 const continueTraceIfNoActiveSpan = getActiveSpan()
 ? <T>(_opts: unknown, callback: () => T) => callback()
 : continueTrace;

 return continueTraceIfNoActiveSpan(
 {
 sentryTrace:
 req.headers && isString(req.headers['sentry-trace']) ? req.headers['sentry-trace'] : undefined,
Expand Down

9 changes: 8 additions & 1 deletion
packages/nextjs/src/common/withServerActionInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { RequestEventData } from '@sentry/core';
import { getActiveSpan } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -95,7 +96,13 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
 } satisfies RequestEventData,
 });

 return continueTrace(
 // Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
 // Else, we manually continueTrace from the incoming headers
 const continueTraceIfNoActiveSpan = getActiveSpan()
 ? <T>(_opts: unknown, callback: () => T) => callback()
 : continueTrace;

 return continueTraceIfNoActiveSpan(
 {
 sentryTrace: sentryTraceHeader,
 baggage: baggageHeader,
Expand Down

4 changes: 0 additions & 4 deletions
packages/nextjs/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare function init(
 options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions | edgeSdk.EdgeOptions,
): Client | undefined;

export declare const getClient: typeof clientSdk.getClient;
export declare const getRootSpan: typeof serverSdk.getRootSpan;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

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

14 changes: 9 additions & 5 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
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,
Expand DownExpand Up@@ -247,9 +253,7 @@ 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 continueTraceAsRemoteSpan(context.active(), options, callback);
 });
 return continueTraceAsRemoteSpan(context.active(), options, callback);
}

/**
Expand Down

22 changes: 3 additions & 19 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1576,11 +1576,8 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {}, // DSC should be an empty object (frozen), because there was an incoming trace
 sampled: false,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1609,14 +1606,8 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {
 environment: 'production',
 version: '1.0',
 },
 sampled: true,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1645,16 +1636,9 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {
 environment: 'production',
 version: '1.0',
 },
 sampled: true,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
 });

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,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

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare const contextLinesIntegration: typeof clientSdk.contextLinesInteg
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

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;

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

View file


Open in desktop

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

export declare const getClient: typeof clientSdk.getClient;
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;

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

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

 Merged

mydea
merged 5 commits into

from

Dec 20, 2024
 Merged


fix(core): Use consistent continueTrace implementation in core
#14813
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
bdf884d

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


mydea Dec 20, 2024
8add20a

kill more types


mydea Dec 20, 2024
8dd5213

fix next continuation


mydea Dec 20, 2024
c74c349

rename


mydea Dec 20, 2024
0b5edbd

fix tests & lint


mydea 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


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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,8 +26,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

9 changes: 8 additions & 1 deletion
packages/nextjs/src/common/pages-router-instrumentation/wrapApiHandlerWithSentry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 getActiveSpan,
 httpRequestToRequestData,
 isString,
 logger,
Expand DownExpand Up@@ -59,7 +60,13 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
 req.__withSentry_applied__ = true;

 return withIsolationScope(isolationScope => {
 return continueTrace(
 // Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
 // Else, we manually continueTrace from the incoming headers
 const continueTraceIfNoActiveSpan = getActiveSpan()
 ? <T>(_opts: unknown, callback: () => T) => callback()
 : continueTrace;

 return continueTraceIfNoActiveSpan(
 {
 sentryTrace:
 req.headers && isString(req.headers['sentry-trace']) ? req.headers['sentry-trace'] : undefined,
Expand Down

9 changes: 8 additions & 1 deletion
packages/nextjs/src/common/withServerActionInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { RequestEventData } from '@sentry/core';
import { getActiveSpan } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -95,7 +96,13 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
 } satisfies RequestEventData,
 });

 return continueTrace(
 // Normally, there is an active span here (from Next.js OTEL) and we just use that as parent
 // Else, we manually continueTrace from the incoming headers
 const continueTraceIfNoActiveSpan = getActiveSpan()
 ? <T>(_opts: unknown, callback: () => T) => callback()
 : continueTrace;

 return continueTraceIfNoActiveSpan(
 {
 sentryTrace: sentryTraceHeader,
 baggage: baggageHeader,
Expand Down

4 changes: 0 additions & 4 deletions
packages/nextjs/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare function init(
 options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions | edgeSdk.EdgeOptions,
): Client | undefined;

export declare const getClient: typeof clientSdk.getClient;
export declare const getRootSpan: typeof serverSdk.getRootSpan;
export declare const continueTrace: typeof clientSdk.continueTrace;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

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

14 changes: 9 additions & 5 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
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,
Expand DownExpand Up@@ -247,9 +253,7 @@ 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 continueTraceAsRemoteSpan(context.active(), options, callback);
 });
 return continueTraceAsRemoteSpan(context.active(), options, callback);
}

/**
Expand Down

22 changes: 3 additions & 19 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1576,11 +1576,8 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {}, // DSC should be an empty object (frozen), because there was an incoming trace
 sampled: false,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1609,14 +1606,8 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {
 environment: 'production',
 version: '1.0',
 },
 sampled: true,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
Expand DownExpand Up@@ -1645,16 +1636,9 @@ describe('continueTrace', () => {
 );

 expect(scope.getPropagationContext()).toEqual({
 dsc: {
 environment: 'production',
 version: '1.0',
 },
 sampled: true,
 parentSpanId: '1121201211212012',
 spanId: expect.any(String),
 traceId: '12312012123120121231201212312012',
 traceId: expect.any(String),
 });

 expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
 });

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,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

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@ export declare const contextLinesIntegration: typeof clientSdk.contextLinesInteg
export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

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;

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

View file


Open in desktop

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

export declare const getClient: typeof clientSdk.getClient;
// eslint-disable-next-line deprecation/deprecation
export declare const getCurrentHub: typeof clientSdk.getCurrentHub;

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