Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
export { safeSetSpanJSONAttributes } from './tracing/spans/captureSpan';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { safeCallback } from './utils/safeCallback';
export { parameterize, fmt } from './utils/parameterize';
export type { HandleTunnelRequestOptions } from './utils/tunnel';
export { handleTunnelRequest } from './utils/tunnel';
Expand Down
43 changes: 22 additions & 21 deletions packages/core/src/tracing/spans/beforeSendSpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,8 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { BeforeSendStaticSpanCallback, BeforeSendStreamedSpanCallback } from '../../types/options';
import type { SpanJSON, StreamedSpanJSON } from '../../types/span';
import { addNonEnumerableProperty } from '../../utils/object';
import { consoleSandbox, debug } from '../../utils/debug-logger';
import { consoleSandbox } from '../../utils/debug-logger';
import { safeCallback } from '../../utils/safeCallback';

/**
* A wrapper to use the static, transaction-based span format in your `beforeSendSpan` callback.
Expand DownExpand Up@@ -64,25 +65,25 @@ export function applyBeforeSendSpanCallback<T extends StreamedSpanJSON | SpanJSO
span: T,
beforeSendSpan: (span: T) => T,
): T {
try {
const modifedSpan = beforeSendSpan(span);
if (!modifedSpan) {
if (!hasShownSpanDropWarning) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
return modifedSpan;
} catch (error) {
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
DEBUG_BUILD && debug.error('The `beforeSendSpan` callback threw an error, sending the span unmodified:', error);
return span;
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
const modifiedSpan = safeCallback(
DEBUG_BUILD ? 'The `beforeSendSpan` callback threw an error, sending the span unmodified:' : '',
() => beforeSendSpan(span),
() => span,
);
if (modifiedSpan) {
return modifiedSpan;
}

if (!hasShownSpanDropWarning) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unrelated to this PR, but we can possibly remove this warning (safe some bytes), this has been this way for some time 🤔 or at least make it a debug.warn gated by the debug flag so you can shake it out?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah i think we can remove it tbh. has been like this since v9 and the type doesn't allow it anyway.

consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
35 changes: 35 additions & 0 deletions packages/core/src/utils/safeCallback.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import { DEBUG_BUILD } from '../debug-build';
import { debug } from './debug-logger';
import { isThenable } from './is';

/**
* Invokes a user-provided callback (e.g. `beforeSend`, `tracesSampler`, an integration hook) so that
* neither a synchronous throw nor a rejected promise escapes into the caller. On failure the error is
* logged and `fallback(error)` supplies the result instead.
*
* Not for `startSpan` bodies: those must re-throw and are handled by `handleCallbackErrors`.
*
* @param message - Logged via `debug.error` together with the error. Pass it as `DEBUG_BUILD ? '...' : ''`
* so the string is tree-shaken from non-debug bundles.
* @param fn - Invokes the callback.
* @param fallback - Produces the result to use when the callback throws or rejects.
*/
export function safeCallback<T>(message: string, fn: () => T, fallback: (error: unknown) => T): T {
let result: T;
try {
result = fn();
} catch (error) {
return recover(message, error, fallback);
}

if (isThenable(result)) {
return result.then(undefined, (error: unknown) => recover(message, error, fallback)) as T;
}

return result;
}

function recover<T>(message: string, error: unknown, fallback: (error: unknown) => T): T {
DEBUG_BUILD && debug.error(message, error);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the flag is correct here but the bot review is right: We no longer tree-shake out the actual string passed to this function if DEBUG_BUILD is false. We can still add a ternary to the call-sitest to enable tree shaking, something like

safeCallback(DEBUG_BUILD ? 'full warning/error message' : '',()=>{},()=>{})

return fallback(error);
Comment thread
cursor[bot] marked this conversation as resolved.
}
70 changes: 70 additions & 0 deletions packages/core/test/lib/utils/safeCallback.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { debug } from '../../../src/utils/debug-logger';
import { safeCallback } from '../../../src/utils/safeCallback';

describe('safeCallback', () => {
const debugErrorSpy = vi.spyOn(debug, 'error').mockImplementation(() => undefined);

afterEach(() => {
debugErrorSpy.mockClear();
});

it('returns the result of a sync callback', () => {
const fallback = vi.fn(() => 'fallback');

expect(safeCallback('callback threw:', () => 'value', fallback)).toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('returns the fallback and logs when a sync callback throws', () => {
const error = new Error('boom');
const fallback = vi.fn(() => 'fallback');

expect(
safeCallback(
'callback threw:',
() => {
throw error;
},
fallback,
),
).toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('resolves to the result of an async callback', async () => {
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', async () => 'value', fallback);

expect(result).toBeInstanceOf(Promise);
await expect(result).resolves.toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('resolves to the fallback and logs when an async callback rejects', async () => {
const error = new Error('boom');
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', () => Promise.reject(error), fallback);

await expect(result).resolves.toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('does not treat non-thenable objects as promises', () => {
const value = { then: 'not a function' };

expect(
safeCallback(
'callback threw:',
() => value,
() => ({ then: 'fallback' }),
),
).toBe(value);
});
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
isTracingSuppressed,
LRUMap,
parseUrl,
safeCallback,
SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -113,16 +114,6 @@ export function instrumentUndici(config: NodeFetchOptions = {}): void {
subscribeToChannel('undici:request:error', message => onError(message as RequestErrorMessage));
}

/** Replaces OTel's `safeExecuteInTheMiddle`: run `fn`, route any error to `onError`, and swallow it. */
function safeExecute<T>(fn: () => T, onError: (error: unknown) => void): T | undefined {
try {
return fn();
} catch (error) {
onError(error);
return undefined;
}
}

function subscribeToChannel(
diagnosticChannel: string,
onMessage: (message: unknown, name: string | symbol) => void,
Expand DownExpand Up@@ -180,9 +171,10 @@ function parseRequestHeaders(request: UndiciRequest): Map<string, string | strin
function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage): void {
const url = getAbsoluteUrl(request.origin, request.path);

const ignoredByCallback = safeExecute(
const ignoredByCallback = safeCallback(
DEBUG_BUILD ? 'The `ignoreOutgoingRequests` callback threw an error, not ignoring the request:' : '',
() => !!config.ignoreOutgoingRequests?.(url),
e => e && DEBUG_BUILD && debug.error('caught ignoreOutgoingRequests error: ', e),
() => false,
);

// Breadcrumbs & span-less trace propagation are additionally skipped when tracing is suppressed.
Expand DownExpand Up@@ -288,9 +280,10 @@ function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage)
});

// Execute the request hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `requestHook` callback threw an error:' : '',
() => config.requestHook?.(span, request),
e => e && DEBUG_BUILD && debug.error('caught requestHook error: ', e),
() => undefined,
);

// Context propagation goes last so no hook can tamper the propagation headers.
Expand DownExpand Up@@ -356,9 +349,10 @@ function onResponseHeaders(config: NodeFetchOptions, { request, response }: Resp
};

// Execute the response hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `responseHook` callback threw an error:' : '',
() => config.responseHook?.(span, { request, response }),
e => e && DEBUG_BUILD && debug.error('caught responseHook error: ', e),
() => undefined,
);

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
export { safeSetSpanJSONAttributes } from './tracing/spans/captureSpan';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { safeCallback } from './utils/safeCallback';
export { parameterize, fmt } from './utils/parameterize';
export type { HandleTunnelRequestOptions } from './utils/tunnel';
export { handleTunnelRequest } from './utils/tunnel';
Expand Down
43 changes: 22 additions & 21 deletions packages/core/src/tracing/spans/beforeSendSpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,8 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { BeforeSendStaticSpanCallback, BeforeSendStreamedSpanCallback } from '../../types/options';
import type { SpanJSON, StreamedSpanJSON } from '../../types/span';
import { addNonEnumerableProperty } from '../../utils/object';
import { consoleSandbox, debug } from '../../utils/debug-logger';
import { consoleSandbox } from '../../utils/debug-logger';
import { safeCallback } from '../../utils/safeCallback';

/**
* A wrapper to use the static, transaction-based span format in your `beforeSendSpan` callback.
Expand DownExpand Up@@ -64,25 +65,25 @@ export function applyBeforeSendSpanCallback<T extends StreamedSpanJSON | SpanJSO
span: T,
beforeSendSpan: (span: T) => T,
): T {
try {
const modifedSpan = beforeSendSpan(span);
if (!modifedSpan) {
if (!hasShownSpanDropWarning) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
return modifedSpan;
} catch (error) {
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
DEBUG_BUILD && debug.error('The `beforeSendSpan` callback threw an error, sending the span unmodified:', error);
return span;
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
const modifiedSpan = safeCallback(
DEBUG_BUILD ? 'The `beforeSendSpan` callback threw an error, sending the span unmodified:' : '',
() => beforeSendSpan(span),
() => span,
);
if (modifiedSpan) {
return modifiedSpan;
}

if (!hasShownSpanDropWarning) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unrelated to this PR, but we can possibly remove this warning (safe some bytes), this has been this way for some time 🤔 or at least make it a debug.warn gated by the debug flag so you can shake it out?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah i think we can remove it tbh. has been like this since v9 and the type doesn't allow it anyway.

consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
35 changes: 35 additions & 0 deletions packages/core/src/utils/safeCallback.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import { DEBUG_BUILD } from '../debug-build';
import { debug } from './debug-logger';
import { isThenable } from './is';

/**
* Invokes a user-provided callback (e.g. `beforeSend`, `tracesSampler`, an integration hook) so that
* neither a synchronous throw nor a rejected promise escapes into the caller. On failure the error is
* logged and `fallback(error)` supplies the result instead.
*
* Not for `startSpan` bodies: those must re-throw and are handled by `handleCallbackErrors`.
*
* @param message - Logged via `debug.error` together with the error. Pass it as `DEBUG_BUILD ? '...' : ''`
* so the string is tree-shaken from non-debug bundles.
* @param fn - Invokes the callback.
* @param fallback - Produces the result to use when the callback throws or rejects.
*/
export function safeCallback<T>(message: string, fn: () => T, fallback: (error: unknown) => T): T {
let result: T;
try {
result = fn();
} catch (error) {
return recover(message, error, fallback);
}

if (isThenable(result)) {
return result.then(undefined, (error: unknown) => recover(message, error, fallback)) as T;
}

return result;
}

function recover<T>(message: string, error: unknown, fallback: (error: unknown) => T): T {
DEBUG_BUILD && debug.error(message, error);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the flag is correct here but the bot review is right: We no longer tree-shake out the actual string passed to this function if DEBUG_BUILD is false. We can still add a ternary to the call-sitest to enable tree shaking, something like

safeCallback(DEBUG_BUILD ? 'full warning/error message' : '',()=>{},()=>{})

return fallback(error);
Comment thread
cursor[bot] marked this conversation as resolved.
}
70 changes: 70 additions & 0 deletions packages/core/test/lib/utils/safeCallback.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { debug } from '../../../src/utils/debug-logger';
import { safeCallback } from '../../../src/utils/safeCallback';

describe('safeCallback', () => {
const debugErrorSpy = vi.spyOn(debug, 'error').mockImplementation(() => undefined);

afterEach(() => {
debugErrorSpy.mockClear();
});

it('returns the result of a sync callback', () => {
const fallback = vi.fn(() => 'fallback');

expect(safeCallback('callback threw:', () => 'value', fallback)).toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('returns the fallback and logs when a sync callback throws', () => {
const error = new Error('boom');
const fallback = vi.fn(() => 'fallback');

expect(
safeCallback(
'callback threw:',
() => {
throw error;
},
fallback,
),
).toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('resolves to the result of an async callback', async () => {
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', async () => 'value', fallback);

expect(result).toBeInstanceOf(Promise);
await expect(result).resolves.toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('resolves to the fallback and logs when an async callback rejects', async () => {
const error = new Error('boom');
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', () => Promise.reject(error), fallback);

await expect(result).resolves.toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('does not treat non-thenable objects as promises', () => {
const value = { then: 'not a function' };

expect(
safeCallback(
'callback threw:',
() => value,
() => ({ then: 'fallback' }),
),
).toBe(value);
});
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
isTracingSuppressed,
LRUMap,
parseUrl,
safeCallback,
SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -113,16 +114,6 @@ export function instrumentUndici(config: NodeFetchOptions = {}): void {
subscribeToChannel('undici:request:error', message => onError(message as RequestErrorMessage));
}

/** Replaces OTel's `safeExecuteInTheMiddle`: run `fn`, route any error to `onError`, and swallow it. */
function safeExecute<T>(fn: () => T, onError: (error: unknown) => void): T | undefined {
try {
return fn();
} catch (error) {
onError(error);
return undefined;
}
}

function subscribeToChannel(
diagnosticChannel: string,
onMessage: (message: unknown, name: string | symbol) => void,
Expand DownExpand Up@@ -180,9 +171,10 @@ function parseRequestHeaders(request: UndiciRequest): Map<string, string | strin
function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage): void {
const url = getAbsoluteUrl(request.origin, request.path);

const ignoredByCallback = safeExecute(
const ignoredByCallback = safeCallback(
DEBUG_BUILD ? 'The `ignoreOutgoingRequests` callback threw an error, not ignoring the request:' : '',
() => !!config.ignoreOutgoingRequests?.(url),
e => e && DEBUG_BUILD && debug.error('caught ignoreOutgoingRequests error: ', e),
() => false,
);

// Breadcrumbs & span-less trace propagation are additionally skipped when tracing is suppressed.
Expand DownExpand Up@@ -288,9 +280,10 @@ function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage)
});

// Execute the request hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `requestHook` callback threw an error:' : '',
() => config.requestHook?.(span, request),
e => e && DEBUG_BUILD && debug.error('caught requestHook error: ', e),
() => undefined,
);

// Context propagation goes last so no hook can tamper the propagation headers.
Expand DownExpand Up@@ -356,9 +349,10 @@ function onResponseHeaders(config: NodeFetchOptions, { request, response }: Resp
};

// Execute the response hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `responseHook` callback threw an error:' : '',
() => config.responseHook?.(span, { request, response }),
e => e && DEBUG_BUILD && debug.error('caught responseHook error: ', e),
() => undefined,
);

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
export { safeSetSpanJSONAttributes } from './tracing/spans/captureSpan';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { safeCallback } from './utils/safeCallback';
export { parameterize, fmt } from './utils/parameterize';
export type { HandleTunnelRequestOptions } from './utils/tunnel';
export { handleTunnelRequest } from './utils/tunnel';
Expand Down
43 changes: 22 additions & 21 deletions packages/core/src/tracing/spans/beforeSendSpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,8 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { BeforeSendStaticSpanCallback, BeforeSendStreamedSpanCallback } from '../../types/options';
import type { SpanJSON, StreamedSpanJSON } from '../../types/span';
import { addNonEnumerableProperty } from '../../utils/object';
import { consoleSandbox, debug } from '../../utils/debug-logger';
import { consoleSandbox } from '../../utils/debug-logger';
import { safeCallback } from '../../utils/safeCallback';

/**
* A wrapper to use the static, transaction-based span format in your `beforeSendSpan` callback.
Expand DownExpand Up@@ -64,25 +65,25 @@ export function applyBeforeSendSpanCallback<T extends StreamedSpanJSON | SpanJSO
span: T,
beforeSendSpan: (span: T) => T,
): T {
try {
const modifedSpan = beforeSendSpan(span);
if (!modifedSpan) {
if (!hasShownSpanDropWarning) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
return modifedSpan;
} catch (error) {
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
DEBUG_BUILD && debug.error('The `beforeSendSpan` callback threw an error, sending the span unmodified:', error);
return span;
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
const modifiedSpan = safeCallback(
DEBUG_BUILD ? 'The `beforeSendSpan` callback threw an error, sending the span unmodified:' : '',
() => beforeSendSpan(span),
() => span,
);
if (modifiedSpan) {
return modifiedSpan;
}

if (!hasShownSpanDropWarning) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unrelated to this PR, but we can possibly remove this warning (safe some bytes), this has been this way for some time 🤔 or at least make it a debug.warn gated by the debug flag so you can shake it out?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah i think we can remove it tbh. has been like this since v9 and the type doesn't allow it anyway.

consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
35 changes: 35 additions & 0 deletions packages/core/src/utils/safeCallback.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import { DEBUG_BUILD } from '../debug-build';
import { debug } from './debug-logger';
import { isThenable } from './is';

/**
* Invokes a user-provided callback (e.g. `beforeSend`, `tracesSampler`, an integration hook) so that
* neither a synchronous throw nor a rejected promise escapes into the caller. On failure the error is
* logged and `fallback(error)` supplies the result instead.
*
* Not for `startSpan` bodies: those must re-throw and are handled by `handleCallbackErrors`.
*
* @param message - Logged via `debug.error` together with the error. Pass it as `DEBUG_BUILD ? '...' : ''`
* so the string is tree-shaken from non-debug bundles.
* @param fn - Invokes the callback.
* @param fallback - Produces the result to use when the callback throws or rejects.
*/
export function safeCallback<T>(message: string, fn: () => T, fallback: (error: unknown) => T): T {
let result: T;
try {
result = fn();
} catch (error) {
return recover(message, error, fallback);
}

if (isThenable(result)) {
return result.then(undefined, (error: unknown) => recover(message, error, fallback)) as T;
}

return result;
}

function recover<T>(message: string, error: unknown, fallback: (error: unknown) => T): T {
DEBUG_BUILD && debug.error(message, error);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the flag is correct here but the bot review is right: We no longer tree-shake out the actual string passed to this function if DEBUG_BUILD is false. We can still add a ternary to the call-sitest to enable tree shaking, something like

safeCallback(DEBUG_BUILD ? 'full warning/error message' : '',()=>{},()=>{})

return fallback(error);
Comment thread
cursor[bot] marked this conversation as resolved.
}
70 changes: 70 additions & 0 deletions packages/core/test/lib/utils/safeCallback.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { debug } from '../../../src/utils/debug-logger';
import { safeCallback } from '../../../src/utils/safeCallback';

describe('safeCallback', () => {
const debugErrorSpy = vi.spyOn(debug, 'error').mockImplementation(() => undefined);

afterEach(() => {
debugErrorSpy.mockClear();
});

it('returns the result of a sync callback', () => {
const fallback = vi.fn(() => 'fallback');

expect(safeCallback('callback threw:', () => 'value', fallback)).toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('returns the fallback and logs when a sync callback throws', () => {
const error = new Error('boom');
const fallback = vi.fn(() => 'fallback');

expect(
safeCallback(
'callback threw:',
() => {
throw error;
},
fallback,
),
).toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('resolves to the result of an async callback', async () => {
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', async () => 'value', fallback);

expect(result).toBeInstanceOf(Promise);
await expect(result).resolves.toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('resolves to the fallback and logs when an async callback rejects', async () => {
const error = new Error('boom');
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', () => Promise.reject(error), fallback);

await expect(result).resolves.toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('does not treat non-thenable objects as promises', () => {
const value = { then: 'not a function' };

expect(
safeCallback(
'callback threw:',
() => value,
() => ({ then: 'fallback' }),
),
).toBe(value);
});
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
isTracingSuppressed,
LRUMap,
parseUrl,
safeCallback,
SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -113,16 +114,6 @@ export function instrumentUndici(config: NodeFetchOptions = {}): void {
subscribeToChannel('undici:request:error', message => onError(message as RequestErrorMessage));
}

/** Replaces OTel's `safeExecuteInTheMiddle`: run `fn`, route any error to `onError`, and swallow it. */
function safeExecute<T>(fn: () => T, onError: (error: unknown) => void): T | undefined {
try {
return fn();
} catch (error) {
onError(error);
return undefined;
}
}

function subscribeToChannel(
diagnosticChannel: string,
onMessage: (message: unknown, name: string | symbol) => void,
Expand DownExpand Up@@ -180,9 +171,10 @@ function parseRequestHeaders(request: UndiciRequest): Map<string, string | strin
function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage): void {
const url = getAbsoluteUrl(request.origin, request.path);

const ignoredByCallback = safeExecute(
const ignoredByCallback = safeCallback(
DEBUG_BUILD ? 'The `ignoreOutgoingRequests` callback threw an error, not ignoring the request:' : '',
() => !!config.ignoreOutgoingRequests?.(url),
e => e && DEBUG_BUILD && debug.error('caught ignoreOutgoingRequests error: ', e),
() => false,
);

// Breadcrumbs & span-less trace propagation are additionally skipped when tracing is suppressed.
Expand DownExpand Up@@ -288,9 +280,10 @@ function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage)
});

// Execute the request hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `requestHook` callback threw an error:' : '',
() => config.requestHook?.(span, request),
e => e && DEBUG_BUILD && debug.error('caught requestHook error: ', e),
() => undefined,
);

// Context propagation goes last so no hook can tamper the propagation headers.
Expand DownExpand Up@@ -356,9 +349,10 @@ function onResponseHeaders(config: NodeFetchOptions, { request, response }: Resp
};

// Execute the response hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `responseHook` callback threw an error:' : '',
() => config.responseHook?.(span, { request, response }),
e => e && DEBUG_BUILD && debug.error('caught responseHook error: ', e),
() => undefined,
);

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
export { safeSetSpanJSONAttributes } from './tracing/spans/captureSpan';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { safeCallback } from './utils/safeCallback';
export { parameterize, fmt } from './utils/parameterize';
export type { HandleTunnelRequestOptions } from './utils/tunnel';
export { handleTunnelRequest } from './utils/tunnel';
Expand Down
43 changes: 22 additions & 21 deletions packages/core/src/tracing/spans/beforeSendSpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,8 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { BeforeSendStaticSpanCallback, BeforeSendStreamedSpanCallback } from '../../types/options';
import type { SpanJSON, StreamedSpanJSON } from '../../types/span';
import { addNonEnumerableProperty } from '../../utils/object';
import { consoleSandbox, debug } from '../../utils/debug-logger';
import { consoleSandbox } from '../../utils/debug-logger';
import { safeCallback } from '../../utils/safeCallback';

/**
* A wrapper to use the static, transaction-based span format in your `beforeSendSpan` callback.
Expand DownExpand Up@@ -64,25 +65,25 @@ export function applyBeforeSendSpanCallback<T extends StreamedSpanJSON | SpanJSO
span: T,
beforeSendSpan: (span: T) => T,
): T {
try {
const modifedSpan = beforeSendSpan(span);
if (!modifedSpan) {
if (!hasShownSpanDropWarning) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
return modifedSpan;
} catch (error) {
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
DEBUG_BUILD && debug.error('The `beforeSendSpan` callback threw an error, sending the span unmodified:', error);
return span;
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
const modifiedSpan = safeCallback(
DEBUG_BUILD ? 'The `beforeSendSpan` callback threw an error, sending the span unmodified:' : '',
() => beforeSendSpan(span),
() => span,
);
if (modifiedSpan) {
return modifiedSpan;
}

if (!hasShownSpanDropWarning) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unrelated to this PR, but we can possibly remove this warning (safe some bytes), this has been this way for some time 🤔 or at least make it a debug.warn gated by the debug flag so you can shake it out?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah i think we can remove it tbh. has been like this since v9 and the type doesn't allow it anyway.

consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
35 changes: 35 additions & 0 deletions packages/core/src/utils/safeCallback.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import { DEBUG_BUILD } from '../debug-build';
import { debug } from './debug-logger';
import { isThenable } from './is';

/**
* Invokes a user-provided callback (e.g. `beforeSend`, `tracesSampler`, an integration hook) so that
* neither a synchronous throw nor a rejected promise escapes into the caller. On failure the error is
* logged and `fallback(error)` supplies the result instead.
*
* Not for `startSpan` bodies: those must re-throw and are handled by `handleCallbackErrors`.
*
* @param message - Logged via `debug.error` together with the error. Pass it as `DEBUG_BUILD ? '...' : ''`
* so the string is tree-shaken from non-debug bundles.
* @param fn - Invokes the callback.
* @param fallback - Produces the result to use when the callback throws or rejects.
*/
export function safeCallback<T>(message: string, fn: () => T, fallback: (error: unknown) => T): T {
let result: T;
try {
result = fn();
} catch (error) {
return recover(message, error, fallback);
}

if (isThenable(result)) {
return result.then(undefined, (error: unknown) => recover(message, error, fallback)) as T;
}

return result;
}

function recover<T>(message: string, error: unknown, fallback: (error: unknown) => T): T {
DEBUG_BUILD && debug.error(message, error);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the flag is correct here but the bot review is right: We no longer tree-shake out the actual string passed to this function if DEBUG_BUILD is false. We can still add a ternary to the call-sitest to enable tree shaking, something like

safeCallback(DEBUG_BUILD ? 'full warning/error message' : '',()=>{},()=>{})

return fallback(error);
Comment thread
cursor[bot] marked this conversation as resolved.
}
70 changes: 70 additions & 0 deletions packages/core/test/lib/utils/safeCallback.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { debug } from '../../../src/utils/debug-logger';
import { safeCallback } from '../../../src/utils/safeCallback';

describe('safeCallback', () => {
const debugErrorSpy = vi.spyOn(debug, 'error').mockImplementation(() => undefined);

afterEach(() => {
debugErrorSpy.mockClear();
});

it('returns the result of a sync callback', () => {
const fallback = vi.fn(() => 'fallback');

expect(safeCallback('callback threw:', () => 'value', fallback)).toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('returns the fallback and logs when a sync callback throws', () => {
const error = new Error('boom');
const fallback = vi.fn(() => 'fallback');

expect(
safeCallback(
'callback threw:',
() => {
throw error;
},
fallback,
),
).toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('resolves to the result of an async callback', async () => {
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', async () => 'value', fallback);

expect(result).toBeInstanceOf(Promise);
await expect(result).resolves.toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('resolves to the fallback and logs when an async callback rejects', async () => {
const error = new Error('boom');
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', () => Promise.reject(error), fallback);

await expect(result).resolves.toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('does not treat non-thenable objects as promises', () => {
const value = { then: 'not a function' };

expect(
safeCallback(
'callback threw:',
() => value,
() => ({ then: 'fallback' }),
),
).toBe(value);
});
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
isTracingSuppressed,
LRUMap,
parseUrl,
safeCallback,
SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -113,16 +114,6 @@ export function instrumentUndici(config: NodeFetchOptions = {}): void {
subscribeToChannel('undici:request:error', message => onError(message as RequestErrorMessage));
}

/** Replaces OTel's `safeExecuteInTheMiddle`: run `fn`, route any error to `onError`, and swallow it. */
function safeExecute<T>(fn: () => T, onError: (error: unknown) => void): T | undefined {
try {
return fn();
} catch (error) {
onError(error);
return undefined;
}
}

function subscribeToChannel(
diagnosticChannel: string,
onMessage: (message: unknown, name: string | symbol) => void,
Expand DownExpand Up@@ -180,9 +171,10 @@ function parseRequestHeaders(request: UndiciRequest): Map<string, string | strin
function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage): void {
const url = getAbsoluteUrl(request.origin, request.path);

const ignoredByCallback = safeExecute(
const ignoredByCallback = safeCallback(
DEBUG_BUILD ? 'The `ignoreOutgoingRequests` callback threw an error, not ignoring the request:' : '',
() => !!config.ignoreOutgoingRequests?.(url),
e => e && DEBUG_BUILD && debug.error('caught ignoreOutgoingRequests error: ', e),
() => false,
);

// Breadcrumbs & span-less trace propagation are additionally skipped when tracing is suppressed.
Expand DownExpand Up@@ -288,9 +280,10 @@ function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage)
});

// Execute the request hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `requestHook` callback threw an error:' : '',
() => config.requestHook?.(span, request),
e => e && DEBUG_BUILD && debug.error('caught requestHook error: ', e),
() => undefined,
);

// Context propagation goes last so no hook can tamper the propagation headers.
Expand DownExpand Up@@ -356,9 +349,10 @@ function onResponseHeaders(config: NodeFetchOptions, { request, response }: Resp
};

// Execute the response hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `responseHook` callback threw an error:' : '',
() => config.responseHook?.(span, { request, response }),
e => e && DEBUG_BUILD && debug.error('caught responseHook error: ', e),
() => undefined,
);

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
export { safeSetSpanJSONAttributes } from './tracing/spans/captureSpan';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { safeCallback } from './utils/safeCallback';
export { parameterize, fmt } from './utils/parameterize';
export type { HandleTunnelRequestOptions } from './utils/tunnel';
export { handleTunnelRequest } from './utils/tunnel';
Expand Down
43 changes: 22 additions & 21 deletions packages/core/src/tracing/spans/beforeSendSpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,8 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { BeforeSendStaticSpanCallback, BeforeSendStreamedSpanCallback } from '../../types/options';
import type { SpanJSON, StreamedSpanJSON } from '../../types/span';
import { addNonEnumerableProperty } from '../../utils/object';
import { consoleSandbox, debug } from '../../utils/debug-logger';
import { consoleSandbox } from '../../utils/debug-logger';
import { safeCallback } from '../../utils/safeCallback';

/**
* A wrapper to use the static, transaction-based span format in your `beforeSendSpan` callback.
Expand DownExpand Up@@ -64,25 +65,25 @@ export function applyBeforeSendSpanCallback<T extends StreamedSpanJSON | SpanJSO
span: T,
beforeSendSpan: (span: T) => T,
): T {
try {
const modifedSpan = beforeSendSpan(span);
if (!modifedSpan) {
if (!hasShownSpanDropWarning) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
return modifedSpan;
} catch (error) {
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
DEBUG_BUILD && debug.error('The `beforeSendSpan` callback threw an error, sending the span unmodified:', error);
return span;
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
const modifiedSpan = safeCallback(
DEBUG_BUILD ? 'The `beforeSendSpan` callback threw an error, sending the span unmodified:' : '',
() => beforeSendSpan(span),
() => span,
);
if (modifiedSpan) {
return modifiedSpan;
}

if (!hasShownSpanDropWarning) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unrelated to this PR, but we can possibly remove this warning (safe some bytes), this has been this way for some time 🤔 or at least make it a debug.warn gated by the debug flag so you can shake it out?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah i think we can remove it tbh. has been like this since v9 and the type doesn't allow it anyway.

consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
35 changes: 35 additions & 0 deletions packages/core/src/utils/safeCallback.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import { DEBUG_BUILD } from '../debug-build';
import { debug } from './debug-logger';
import { isThenable } from './is';

/**
* Invokes a user-provided callback (e.g. `beforeSend`, `tracesSampler`, an integration hook) so that
* neither a synchronous throw nor a rejected promise escapes into the caller. On failure the error is
* logged and `fallback(error)` supplies the result instead.
*
* Not for `startSpan` bodies: those must re-throw and are handled by `handleCallbackErrors`.
*
* @param message - Logged via `debug.error` together with the error. Pass it as `DEBUG_BUILD ? '...' : ''`
* so the string is tree-shaken from non-debug bundles.
* @param fn - Invokes the callback.
* @param fallback - Produces the result to use when the callback throws or rejects.
*/
export function safeCallback<T>(message: string, fn: () => T, fallback: (error: unknown) => T): T {
let result: T;
try {
result = fn();
} catch (error) {
return recover(message, error, fallback);
}

if (isThenable(result)) {
return result.then(undefined, (error: unknown) => recover(message, error, fallback)) as T;
}

return result;
}

function recover<T>(message: string, error: unknown, fallback: (error: unknown) => T): T {
DEBUG_BUILD && debug.error(message, error);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the flag is correct here but the bot review is right: We no longer tree-shake out the actual string passed to this function if DEBUG_BUILD is false. We can still add a ternary to the call-sitest to enable tree shaking, something like

safeCallback(DEBUG_BUILD ? 'full warning/error message' : '',()=>{},()=>{})

return fallback(error);
Comment thread
cursor[bot] marked this conversation as resolved.
}
70 changes: 70 additions & 0 deletions packages/core/test/lib/utils/safeCallback.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { debug } from '../../../src/utils/debug-logger';
import { safeCallback } from '../../../src/utils/safeCallback';

describe('safeCallback', () => {
const debugErrorSpy = vi.spyOn(debug, 'error').mockImplementation(() => undefined);

afterEach(() => {
debugErrorSpy.mockClear();
});

it('returns the result of a sync callback', () => {
const fallback = vi.fn(() => 'fallback');

expect(safeCallback('callback threw:', () => 'value', fallback)).toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('returns the fallback and logs when a sync callback throws', () => {
const error = new Error('boom');
const fallback = vi.fn(() => 'fallback');

expect(
safeCallback(
'callback threw:',
() => {
throw error;
},
fallback,
),
).toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('resolves to the result of an async callback', async () => {
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', async () => 'value', fallback);

expect(result).toBeInstanceOf(Promise);
await expect(result).resolves.toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('resolves to the fallback and logs when an async callback rejects', async () => {
const error = new Error('boom');
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', () => Promise.reject(error), fallback);

await expect(result).resolves.toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('does not treat non-thenable objects as promises', () => {
const value = { then: 'not a function' };

expect(
safeCallback(
'callback threw:',
() => value,
() => ({ then: 'fallback' }),
),
).toBe(value);
});
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
isTracingSuppressed,
LRUMap,
parseUrl,
safeCallback,
SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -113,16 +114,6 @@ export function instrumentUndici(config: NodeFetchOptions = {}): void {
subscribeToChannel('undici:request:error', message => onError(message as RequestErrorMessage));
}

/** Replaces OTel's `safeExecuteInTheMiddle`: run `fn`, route any error to `onError`, and swallow it. */
function safeExecute<T>(fn: () => T, onError: (error: unknown) => void): T | undefined {
try {
return fn();
} catch (error) {
onError(error);
return undefined;
}
}

function subscribeToChannel(
diagnosticChannel: string,
onMessage: (message: unknown, name: string | symbol) => void,
Expand DownExpand Up@@ -180,9 +171,10 @@ function parseRequestHeaders(request: UndiciRequest): Map<string, string | strin
function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage): void {
const url = getAbsoluteUrl(request.origin, request.path);

const ignoredByCallback = safeExecute(
const ignoredByCallback = safeCallback(
DEBUG_BUILD ? 'The `ignoreOutgoingRequests` callback threw an error, not ignoring the request:' : '',
() => !!config.ignoreOutgoingRequests?.(url),
e => e && DEBUG_BUILD && debug.error('caught ignoreOutgoingRequests error: ', e),
() => false,
);

// Breadcrumbs & span-less trace propagation are additionally skipped when tracing is suppressed.
Expand DownExpand Up@@ -288,9 +280,10 @@ function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage)
});

// Execute the request hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `requestHook` callback threw an error:' : '',
() => config.requestHook?.(span, request),
e => e && DEBUG_BUILD && debug.error('caught requestHook error: ', e),
() => undefined,
);

// Context propagation goes last so no hook can tamper the propagation headers.
Expand DownExpand Up@@ -356,9 +349,10 @@ function onResponseHeaders(config: NodeFetchOptions, { request, response }: Resp
};

// Execute the response hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `responseHook` callback threw an error:' : '',
() => config.responseHook?.(span, { request, response }),
e => e && DEBUG_BUILD && debug.error('caught responseHook error: ', e),
() => undefined,
);

if (config.headersToSpanAttributes?.responseHeaders) {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
export { safeSetSpanJSONAttributes } from './tracing/spans/captureSpan';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { safeCallback } from './utils/safeCallback';
export { parameterize, fmt } from './utils/parameterize';
export type { HandleTunnelRequestOptions } from './utils/tunnel';
export { handleTunnelRequest } from './utils/tunnel';
Expand Down
43 changes: 22 additions & 21 deletions packages/core/src/tracing/spans/beforeSendSpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,8 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { BeforeSendStaticSpanCallback, BeforeSendStreamedSpanCallback } from '../../types/options';
import type { SpanJSON, StreamedSpanJSON } from '../../types/span';
import { addNonEnumerableProperty } from '../../utils/object';
import { consoleSandbox, debug } from '../../utils/debug-logger';
import { consoleSandbox } from '../../utils/debug-logger';
import { safeCallback } from '../../utils/safeCallback';

/**
* A wrapper to use the static, transaction-based span format in your `beforeSendSpan` callback.
Expand DownExpand Up@@ -64,25 +65,25 @@ export function applyBeforeSendSpanCallback<T extends StreamedSpanJSON | SpanJSO
span: T,
beforeSendSpan: (span: T) => T,
): T {
try {
const modifedSpan = beforeSendSpan(span);
if (!modifedSpan) {
if (!hasShownSpanDropWarning) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
return modifedSpan;
} catch (error) {
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
DEBUG_BUILD && debug.error('The `beforeSendSpan` callback threw an error, sending the span unmodified:', error);
return span;
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
const modifiedSpan = safeCallback(
DEBUG_BUILD ? 'The `beforeSendSpan` callback threw an error, sending the span unmodified:' : '',
() => beforeSendSpan(span),
() => span,
);
if (modifiedSpan) {
return modifiedSpan;
}

if (!hasShownSpanDropWarning) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unrelated to this PR, but we can possibly remove this warning (safe some bytes), this has been this way for some time 🤔 or at least make it a debug.warn gated by the debug flag so you can shake it out?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah i think we can remove it tbh. has been like this since v9 and the type doesn't allow it anyway.

consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
35 changes: 35 additions & 0 deletions packages/core/src/utils/safeCallback.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import { DEBUG_BUILD } from '../debug-build';
import { debug } from './debug-logger';
import { isThenable } from './is';

/**
* Invokes a user-provided callback (e.g. `beforeSend`, `tracesSampler`, an integration hook) so that
* neither a synchronous throw nor a rejected promise escapes into the caller. On failure the error is
* logged and `fallback(error)` supplies the result instead.
*
* Not for `startSpan` bodies: those must re-throw and are handled by `handleCallbackErrors`.
*
* @param message - Logged via `debug.error` together with the error. Pass it as `DEBUG_BUILD ? '...' : ''`
* so the string is tree-shaken from non-debug bundles.
* @param fn - Invokes the callback.
* @param fallback - Produces the result to use when the callback throws or rejects.
*/
export function safeCallback<T>(message: string, fn: () => T, fallback: (error: unknown) => T): T {
let result: T;
try {
result = fn();
} catch (error) {
return recover(message, error, fallback);
}

if (isThenable(result)) {
return result.then(undefined, (error: unknown) => recover(message, error, fallback)) as T;
}

return result;
}

function recover<T>(message: string, error: unknown, fallback: (error: unknown) => T): T {
DEBUG_BUILD && debug.error(message, error);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the flag is correct here but the bot review is right: We no longer tree-shake out the actual string passed to this function if DEBUG_BUILD is false. We can still add a ternary to the call-sitest to enable tree shaking, something like

safeCallback(DEBUG_BUILD ? 'full warning/error message' : '',()=>{},()=>{})

return fallback(error);
Comment thread
cursor[bot] marked this conversation as resolved.
}
70 changes: 70 additions & 0 deletions packages/core/test/lib/utils/safeCallback.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { debug } from '../../../src/utils/debug-logger';
import { safeCallback } from '../../../src/utils/safeCallback';

describe('safeCallback', () => {
const debugErrorSpy = vi.spyOn(debug, 'error').mockImplementation(() => undefined);

afterEach(() => {
debugErrorSpy.mockClear();
});

it('returns the result of a sync callback', () => {
const fallback = vi.fn(() => 'fallback');

expect(safeCallback('callback threw:', () => 'value', fallback)).toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('returns the fallback and logs when a sync callback throws', () => {
const error = new Error('boom');
const fallback = vi.fn(() => 'fallback');

expect(
safeCallback(
'callback threw:',
() => {
throw error;
},
fallback,
),
).toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('resolves to the result of an async callback', async () => {
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', async () => 'value', fallback);

expect(result).toBeInstanceOf(Promise);
await expect(result).resolves.toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('resolves to the fallback and logs when an async callback rejects', async () => {
const error = new Error('boom');
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', () => Promise.reject(error), fallback);

await expect(result).resolves.toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('does not treat non-thenable objects as promises', () => {
const value = { then: 'not a function' };

expect(
safeCallback(
'callback threw:',
() => value,
() => ({ then: 'fallback' }),
),
).toBe(value);
});
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
isTracingSuppressed,
LRUMap,
parseUrl,
safeCallback,
SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -113,16 +114,6 @@ export function instrumentUndici(config: NodeFetchOptions = {}): void {
subscribeToChannel('undici:request:error', message => onError(message as RequestErrorMessage));
}

/** Replaces OTel's `safeExecuteInTheMiddle`: run `fn`, route any error to `onError`, and swallow it. */
function safeExecute<T>(fn: () => T, onError: (error: unknown) => void): T | undefined {
try {
return fn();
} catch (error) {
onError(error);
return undefined;
}
}

function subscribeToChannel(
diagnosticChannel: string,
onMessage: (message: unknown, name: string | symbol) => void,
Expand DownExpand Up@@ -180,9 +171,10 @@ function parseRequestHeaders(request: UndiciRequest): Map<string, string | strin
function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage): void {
const url = getAbsoluteUrl(request.origin, request.path);

const ignoredByCallback = safeExecute(
const ignoredByCallback = safeCallback(
DEBUG_BUILD ? 'The `ignoreOutgoingRequests` callback threw an error, not ignoring the request:' : '',
() => !!config.ignoreOutgoingRequests?.(url),
e => e && DEBUG_BUILD && debug.error('caught ignoreOutgoingRequests error: ', e),
() => false,
);

// Breadcrumbs & span-less trace propagation are additionally skipped when tracing is suppressed.
Expand DownExpand Up@@ -288,9 +280,10 @@ function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage)
});

// Execute the request hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `requestHook` callback threw an error:' : '',
() => config.requestHook?.(span, request),
e => e && DEBUG_BUILD && debug.error('caught requestHook error: ', e),
() => undefined,
);

// Context propagation goes last so no hook can tamper the propagation headers.
Expand DownExpand Up@@ -356,9 +349,10 @@ function onResponseHeaders(config: NodeFetchOptions, { request, response }: Resp
};

// Execute the response hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `responseHook` callback threw an error:' : '',
() => config.responseHook?.(span, { request, response }),
e => e && DEBUG_BUILD && debug.error('caught responseHook error: ', e),
() => undefined,
);

if (config.headersToSpanAttributes?.responseHeaders) {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
export { safeSetSpanJSONAttributes } from './tracing/spans/captureSpan';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { safeCallback } from './utils/safeCallback';
export { parameterize, fmt } from './utils/parameterize';
export type { HandleTunnelRequestOptions } from './utils/tunnel';
export { handleTunnelRequest } from './utils/tunnel';
Expand Down
43 changes: 22 additions & 21 deletions packages/core/src/tracing/spans/beforeSendSpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,8 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { BeforeSendStaticSpanCallback, BeforeSendStreamedSpanCallback } from '../../types/options';
import type { SpanJSON, StreamedSpanJSON } from '../../types/span';
import { addNonEnumerableProperty } from '../../utils/object';
import { consoleSandbox, debug } from '../../utils/debug-logger';
import { consoleSandbox } from '../../utils/debug-logger';
import { safeCallback } from '../../utils/safeCallback';

/**
* A wrapper to use the static, transaction-based span format in your `beforeSendSpan` callback.
Expand DownExpand Up@@ -64,25 +65,25 @@ export function applyBeforeSendSpanCallback<T extends StreamedSpanJSON | SpanJSO
span: T,
beforeSendSpan: (span: T) => T,
): T {
try {
const modifedSpan = beforeSendSpan(span);
if (!modifedSpan) {
if (!hasShownSpanDropWarning) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
return modifedSpan;
} catch (error) {
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
DEBUG_BUILD && debug.error('The `beforeSendSpan` callback threw an error, sending the span unmodified:', error);
return span;
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
const modifiedSpan = safeCallback(
DEBUG_BUILD ? 'The `beforeSendSpan` callback threw an error, sending the span unmodified:' : '',
() => beforeSendSpan(span),
() => span,
);
if (modifiedSpan) {
return modifiedSpan;
}

if (!hasShownSpanDropWarning) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unrelated to this PR, but we can possibly remove this warning (safe some bytes), this has been this way for some time 🤔 or at least make it a debug.warn gated by the debug flag so you can shake it out?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah i think we can remove it tbh. has been like this since v9 and the type doesn't allow it anyway.

consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
35 changes: 35 additions & 0 deletions packages/core/src/utils/safeCallback.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import { DEBUG_BUILD } from '../debug-build';
import { debug } from './debug-logger';
import { isThenable } from './is';

/**
* Invokes a user-provided callback (e.g. `beforeSend`, `tracesSampler`, an integration hook) so that
* neither a synchronous throw nor a rejected promise escapes into the caller. On failure the error is
* logged and `fallback(error)` supplies the result instead.
*
* Not for `startSpan` bodies: those must re-throw and are handled by `handleCallbackErrors`.
*
* @param message - Logged via `debug.error` together with the error. Pass it as `DEBUG_BUILD ? '...' : ''`
* so the string is tree-shaken from non-debug bundles.
* @param fn - Invokes the callback.
* @param fallback - Produces the result to use when the callback throws or rejects.
*/
export function safeCallback<T>(message: string, fn: () => T, fallback: (error: unknown) => T): T {
let result: T;
try {
result = fn();
} catch (error) {
return recover(message, error, fallback);
}

if (isThenable(result)) {
return result.then(undefined, (error: unknown) => recover(message, error, fallback)) as T;
}

return result;
}

function recover<T>(message: string, error: unknown, fallback: (error: unknown) => T): T {
DEBUG_BUILD && debug.error(message, error);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the flag is correct here but the bot review is right: We no longer tree-shake out the actual string passed to this function if DEBUG_BUILD is false. We can still add a ternary to the call-sitest to enable tree shaking, something like

safeCallback(DEBUG_BUILD ? 'full warning/error message' : '',()=>{},()=>{})

return fallback(error);
Comment thread
cursor[bot] marked this conversation as resolved.
}
70 changes: 70 additions & 0 deletions packages/core/test/lib/utils/safeCallback.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { debug } from '../../../src/utils/debug-logger';
import { safeCallback } from '../../../src/utils/safeCallback';

describe('safeCallback', () => {
const debugErrorSpy = vi.spyOn(debug, 'error').mockImplementation(() => undefined);

afterEach(() => {
debugErrorSpy.mockClear();
});

it('returns the result of a sync callback', () => {
const fallback = vi.fn(() => 'fallback');

expect(safeCallback('callback threw:', () => 'value', fallback)).toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('returns the fallback and logs when a sync callback throws', () => {
const error = new Error('boom');
const fallback = vi.fn(() => 'fallback');

expect(
safeCallback(
'callback threw:',
() => {
throw error;
},
fallback,
),
).toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('resolves to the result of an async callback', async () => {
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', async () => 'value', fallback);

expect(result).toBeInstanceOf(Promise);
await expect(result).resolves.toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('resolves to the fallback and logs when an async callback rejects', async () => {
const error = new Error('boom');
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', () => Promise.reject(error), fallback);

await expect(result).resolves.toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('does not treat non-thenable objects as promises', () => {
const value = { then: 'not a function' };

expect(
safeCallback(
'callback threw:',
() => value,
() => ({ then: 'fallback' }),
),
).toBe(value);
});
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
isTracingSuppressed,
LRUMap,
parseUrl,
safeCallback,
SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -113,16 +114,6 @@ export function instrumentUndici(config: NodeFetchOptions = {}): void {
subscribeToChannel('undici:request:error', message => onError(message as RequestErrorMessage));
}

/** Replaces OTel's `safeExecuteInTheMiddle`: run `fn`, route any error to `onError`, and swallow it. */
function safeExecute<T>(fn: () => T, onError: (error: unknown) => void): T | undefined {
try {
return fn();
} catch (error) {
onError(error);
return undefined;
}
}

function subscribeToChannel(
diagnosticChannel: string,
onMessage: (message: unknown, name: string | symbol) => void,
Expand DownExpand Up@@ -180,9 +171,10 @@ function parseRequestHeaders(request: UndiciRequest): Map<string, string | strin
function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage): void {
const url = getAbsoluteUrl(request.origin, request.path);

const ignoredByCallback = safeExecute(
const ignoredByCallback = safeCallback(
DEBUG_BUILD ? 'The `ignoreOutgoingRequests` callback threw an error, not ignoring the request:' : '',
() => !!config.ignoreOutgoingRequests?.(url),
e => e && DEBUG_BUILD && debug.error('caught ignoreOutgoingRequests error: ', e),
() => false,
);

// Breadcrumbs & span-less trace propagation are additionally skipped when tracing is suppressed.
Expand DownExpand Up@@ -288,9 +280,10 @@ function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage)
});

// Execute the request hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `requestHook` callback threw an error:' : '',
() => config.requestHook?.(span, request),
e => e && DEBUG_BUILD && debug.error('caught requestHook error: ', e),
() => undefined,
);

// Context propagation goes last so no hook can tamper the propagation headers.
Expand DownExpand Up@@ -356,9 +349,10 @@ function onResponseHeaders(config: NodeFetchOptions, { request, response }: Resp
};

// Execute the response hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `responseHook` callback threw an error:' : '',
() => config.responseHook?.(span, { request, response }),
e => e && DEBUG_BUILD && debug.error('caught responseHook error: ', e),
() => undefined,
);

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
export { safeSetSpanJSONAttributes } from './tracing/spans/captureSpan';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { safeCallback } from './utils/safeCallback';
export { parameterize, fmt } from './utils/parameterize';
export type { HandleTunnelRequestOptions } from './utils/tunnel';
export { handleTunnelRequest } from './utils/tunnel';
Expand Down
43 changes: 22 additions & 21 deletions packages/core/src/tracing/spans/beforeSendSpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,8 @@ import { DEBUG_BUILD } from '../../debug-build';
import type { BeforeSendStaticSpanCallback, BeforeSendStreamedSpanCallback } from '../../types/options';
import type { SpanJSON, StreamedSpanJSON } from '../../types/span';
import { addNonEnumerableProperty } from '../../utils/object';
import { consoleSandbox, debug } from '../../utils/debug-logger';
import { consoleSandbox } from '../../utils/debug-logger';
import { safeCallback } from '../../utils/safeCallback';

/**
* A wrapper to use the static, transaction-based span format in your `beforeSendSpan` callback.
Expand DownExpand Up@@ -64,25 +65,25 @@ export function applyBeforeSendSpanCallback<T extends StreamedSpanJSON | SpanJSO
span: T,
beforeSendSpan: (span: T) => T,
): T {
try {
const modifedSpan = beforeSendSpan(span);
if (!modifedSpan) {
if (!hasShownSpanDropWarning) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
return modifedSpan;
} catch (error) {
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
DEBUG_BUILD && debug.error('The `beforeSendSpan` callback threw an error, sending the span unmodified:', error);
return span;
// Spans are captured synchronously when they end, so a throwing callback would otherwise
// propagate into whatever user code ended the span.
const modifiedSpan = safeCallback(
DEBUG_BUILD ? 'The `beforeSendSpan` callback threw an error, sending the span unmodified:' : '',
() => beforeSendSpan(span),
() => span,
);
if (modifiedSpan) {
return modifiedSpan;
}

if (!hasShownSpanDropWarning) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unrelated to this PR, but we can possibly remove this warning (safe some bytes), this has been this way for some time 🤔 or at least make it a debug.warn gated by the debug flag so you can shake it out?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah i think we can remove it tbh. has been like this since v9 and the type doesn't allow it anyway.

consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Returning null from `beforeSendSpan` is disallowed. To drop certain spans, configure the respective integrations directly or use `ignoreSpans`.',
);
});
hasShownSpanDropWarning = true;
}
return span;
}
35 changes: 35 additions & 0 deletions packages/core/src/utils/safeCallback.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import { DEBUG_BUILD } from '../debug-build';
import { debug } from './debug-logger';
import { isThenable } from './is';

/**
* Invokes a user-provided callback (e.g. `beforeSend`, `tracesSampler`, an integration hook) so that
* neither a synchronous throw nor a rejected promise escapes into the caller. On failure the error is
* logged and `fallback(error)` supplies the result instead.
*
* Not for `startSpan` bodies: those must re-throw and are handled by `handleCallbackErrors`.
*
* @param message - Logged via `debug.error` together with the error. Pass it as `DEBUG_BUILD ? '...' : ''`
* so the string is tree-shaken from non-debug bundles.
* @param fn - Invokes the callback.
* @param fallback - Produces the result to use when the callback throws or rejects.
*/
export function safeCallback<T>(message: string, fn: () => T, fallback: (error: unknown) => T): T {
let result: T;
try {
result = fn();
} catch (error) {
return recover(message, error, fallback);
}

if (isThenable(result)) {
return result.then(undefined, (error: unknown) => recover(message, error, fallback)) as T;
}

return result;
}

function recover<T>(message: string, error: unknown, fallback: (error: unknown) => T): T {
DEBUG_BUILD && debug.error(message, error);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the flag is correct here but the bot review is right: We no longer tree-shake out the actual string passed to this function if DEBUG_BUILD is false. We can still add a ternary to the call-sitest to enable tree shaking, something like

safeCallback(DEBUG_BUILD ? 'full warning/error message' : '',()=>{},()=>{})

return fallback(error);
Comment thread
cursor[bot] marked this conversation as resolved.
}
70 changes: 70 additions & 0 deletions packages/core/test/lib/utils/safeCallback.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { debug } from '../../../src/utils/debug-logger';
import { safeCallback } from '../../../src/utils/safeCallback';

describe('safeCallback', () => {
const debugErrorSpy = vi.spyOn(debug, 'error').mockImplementation(() => undefined);

afterEach(() => {
debugErrorSpy.mockClear();
});

it('returns the result of a sync callback', () => {
const fallback = vi.fn(() => 'fallback');

expect(safeCallback('callback threw:', () => 'value', fallback)).toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('returns the fallback and logs when a sync callback throws', () => {
const error = new Error('boom');
const fallback = vi.fn(() => 'fallback');

expect(
safeCallback(
'callback threw:',
() => {
throw error;
},
fallback,
),
).toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('resolves to the result of an async callback', async () => {
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', async () => 'value', fallback);

expect(result).toBeInstanceOf(Promise);
await expect(result).resolves.toBe('value');
expect(fallback).not.toHaveBeenCalled();
expect(debugErrorSpy).not.toHaveBeenCalled();
});

it('resolves to the fallback and logs when an async callback rejects', async () => {
const error = new Error('boom');
const fallback = vi.fn(async () => 'fallback');

const result = safeCallback('callback threw:', () => Promise.reject(error), fallback);

await expect(result).resolves.toBe('fallback');
expect(fallback).toHaveBeenCalledWith(error);
expect(debugErrorSpy).toHaveBeenCalledWith('callback threw:', error);
});

it('does not treat non-thenable objects as promises', () => {
const value = { then: 'not a function' };

expect(
safeCallback(
'callback threw:',
() => value,
() => ({ then: 'fallback' }),
),
).toBe(value);
});
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
isTracingSuppressed,
LRUMap,
parseUrl,
safeCallback,
SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
Expand DownExpand Up@@ -113,16 +114,6 @@ export function instrumentUndici(config: NodeFetchOptions = {}): void {
subscribeToChannel('undici:request:error', message => onError(message as RequestErrorMessage));
}

/** Replaces OTel's `safeExecuteInTheMiddle`: run `fn`, route any error to `onError`, and swallow it. */
function safeExecute<T>(fn: () => T, onError: (error: unknown) => void): T | undefined {
try {
return fn();
} catch (error) {
onError(error);
return undefined;
}
}

function subscribeToChannel(
diagnosticChannel: string,
onMessage: (message: unknown, name: string | symbol) => void,
Expand DownExpand Up@@ -180,9 +171,10 @@ function parseRequestHeaders(request: UndiciRequest): Map<string, string | strin
function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage): void {
const url = getAbsoluteUrl(request.origin, request.path);

const ignoredByCallback = safeExecute(
const ignoredByCallback = safeCallback(
DEBUG_BUILD ? 'The `ignoreOutgoingRequests` callback threw an error, not ignoring the request:' : '',
() => !!config.ignoreOutgoingRequests?.(url),
e => e && DEBUG_BUILD && debug.error('caught ignoreOutgoingRequests error: ', e),
() => false,
);

// Breadcrumbs & span-less trace propagation are additionally skipped when tracing is suppressed.
Expand DownExpand Up@@ -288,9 +280,10 @@ function onRequestCreated(config: NodeFetchOptions, { request }: RequestMessage)
});

// Execute the request hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `requestHook` callback threw an error:' : '',
() => config.requestHook?.(span, request),
e => e && DEBUG_BUILD && debug.error('caught requestHook error: ', e),
() => undefined,
);

// Context propagation goes last so no hook can tamper the propagation headers.
Expand DownExpand Up@@ -356,9 +349,10 @@ function onResponseHeaders(config: NodeFetchOptions, { request, response }: Resp
};

// Execute the response hook if defined
safeExecute(
safeCallback(
DEBUG_BUILD ? 'The `responseHook` callback threw an error:' : '',
() => config.responseHook?.(span, { request, response }),
e => e && DEBUG_BUILD && debug.error('caught responseHook error: ', e),
() => undefined,
);

if (config.headersToSpanAttributes?.responseHeaders) {
Expand Down
Loading