Skip to content

ref(core): Avoid using SentryError for event processing control flow#15823

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
mydea merged 4 commits into from
Mar 25, 2025
Merged

ref(core): Avoid using SentryError for event processing control flow #15823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
604ed0d
ref(core): Avoid using `SentryError` for event processing control flow
mydea Mar 25, 2025
7d98cb6
fixes
mydea Mar 25, 2025
08a50f1
cleanup
mydea Mar 25, 2025
e0780f5
fix
mydea Mar 25, 2025
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
59 changes: 46 additions & 13 deletions packages/core/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,6 @@ import {
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
import { SentryError } from './utils-hoist/error';
import { isParameterizedString, isPlainObject, isPrimitive, isThenable } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { checkOrSetAlreadyCaught, uuid4 } from './utils-hoist/misc';
Expand All@@ -69,6 +68,41 @@ import { _getSpanForScope } from './utils/spanOnScope';
const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';

const INTERNAL_ERROR_SYMBOL = Symbol.for('SentryInternalError');
const DO_NOT_SEND_EVENT_SYMBOL = Symbol.for('SentryDoNotSendEventError');

interface InternalError {
message: string;
[INTERNAL_ERROR_SYMBOL]: true;
}

interface DoNotSendEventError {
message: string;
[DO_NOT_SEND_EVENT_SYMBOL]: true;
}

function _makeInternalError(message: string): InternalError {
return {
message,
[INTERNAL_ERROR_SYMBOL]: true,
};
}

function _makeDoNotSendEventError(message: string): DoNotSendEventError {
return {
message,
[DO_NOT_SEND_EVENT_SYMBOL]: true,
};
}

function _isInternalError(error: unknown): error is InternalError {
return !!error && typeof error === 'object' && INTERNAL_ERROR_SYMBOL in error;
}

function _isDoNotSendEventError(error: unknown): error is DoNotSendEventError {
return !!error && typeof error === 'object' && DO_NOT_SEND_EVENT_SYMBOL in error;
}

/**
* Base implementation for all JavaScript SDK clients.
*
Expand DownExpand Up@@ -975,10 +1009,10 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
},
reason => {
if (DEBUG_BUILD) {
// If something's gone wrong, log the error as a warning. If it's just us having used a `SentryError` for
// control flow, log just the message (no stack) as a log-level log.
if (reason instanceof SentryError && reason.logLevel === 'log') {
if (_isDoNotSendEventError(reason)) {
logger.log(reason.message);
} else if (_isInternalError(reason)) {
logger.warn(reason.message);
} else {
logger.warn(reason);
}
Expand DownExpand Up@@ -1022,9 +1056,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
if (isError && typeof parsedSampleRate === 'number' && Math.random() > parsedSampleRate) {
this.recordDroppedEvent('sample_rate', 'error');
return rejectedSyncPromise(
new SentryError(
_makeDoNotSendEventError(
`Discarding event because it's not included in the random sample (sampling rate = ${sampleRate})`,
'log',
),
);
}
Expand All@@ -1035,7 +1068,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
.then(prepared => {
if (prepared === null) {
this.recordDroppedEvent('event_processor', dataCategory);
throw new SentryError('An event processor returned `null`, will not send event.', 'log');
throw _makeDoNotSendEventError('An event processor returned `null`, will not send event.');
}

const isInternalException = hint.data && (hint.data as { __sentry__: boolean }).__sentry__ === true;
Expand All@@ -1055,7 +1088,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
const spanCount = 1 + spans.length;
this.recordDroppedEvent('before_send', 'span', spanCount);
}
throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
throw _makeDoNotSendEventError(`${beforeSendLabel} returned \`null\`, will not send event.`);
}

const session = currentScope.getSession() || isolationScope.getSession();
Expand DownExpand Up@@ -1089,7 +1122,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
return processedEvent;
})
.then(null, reason => {
if (reason instanceof SentryError) {
if (_isDoNotSendEventError(reason) || _isInternalError(reason)) {
throw reason;
}

Expand All@@ -1099,7 +1132,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
},
originalException: reason,
});
throw new SentryError(
throw _makeInternalError(
`Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${reason}`,
);
});
Expand DownExpand Up@@ -1205,16 +1238,16 @@ function _validateBeforeSendResult(
return beforeSendResult.then(
event => {
if (!isPlainObject(event) && event !== null) {
throw new SentryError(invalidValueError);
throw _makeInternalError(invalidValueError);
}
return event;
},
e => {
throw new SentryError(`${beforeSendLabel} rejected with ${e}`);
throw _makeInternalError(`${beforeSendLabel} rejected with ${e}`);
},
);
} else if (!isPlainObject(beforeSendResult) && beforeSendResult !== null) {
throw new SentryError(invalidValueError);
throw _makeInternalError(invalidValueError);
}
return beforeSendResult;
}
Expand Down
17 changes: 0 additions & 17 deletions packages/core/src/integrations/eventFilters.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,19 +102,12 @@ function _mergeOptions(
...(internalOptions.disableErrorDefaults ? [] : DEFAULT_IGNORE_ERRORS),
],
ignoreTransactions: [...(internalOptions.ignoreTransactions || []), ...(clientOptions.ignoreTransactions || [])],
ignoreInternal: internalOptions.ignoreInternal !== undefined ? internalOptions.ignoreInternal : true,
};
}

function _shouldDropEvent(event: Event, options: Partial<EventFiltersOptions>): boolean {
if (!event.type) {
// Filter errors

if (options.ignoreInternal && _isSentryError(event)) {
DEBUG_BUILD &&
logger.warn(`Event dropped due to being internal Sentry Error.\nEvent: ${getEventDescription(event)}`);
return true;
}
if (_isIgnoredError(event, options.ignoreErrors)) {
DEBUG_BUILD &&
logger.warn(
Expand DownExpand Up@@ -196,16 +189,6 @@ function _isAllowedUrl(event: Event, allowUrls?: Array<string | RegExp>): boolea
return !url ? true : stringMatchesSomePattern(url, allowUrls);
}

function _isSentryError(event: Event): boolean {
try {
// @ts-expect-error can't be a sentry error if undefined
return event.exception.values[0].type === 'SentryError';
} catch (e) {
// ignore
}
return false;
}

function _getLastValidUrl(frames: StackFrame[] = []): string | null {
for (let i = frames.length - 1; i >= 0; i--) {
const frame = frames[i];
Expand Down
5 changes: 4 additions & 1 deletion packages/core/src/utils-hoist/error.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { ConsoleLevel } from '../types-hoist';

/** An error emitted by Sentry SDKs and related utilities. */
/**
* An error emitted by Sentry SDKs and related utilities.
* @deprecated This class is no longer used and will be removed in a future version. Use `Error` instead.
*/
export class SentryError extends Error {
public logLevel: ConsoleLevel;

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/utils-hoist/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ export { applyAggregateErrorsToEvent } from './aggregate-errors';
export { getBreadcrumbLogLevelFromHttpStatusCode } from './breadcrumb-log-level';
export { getComponentName, getLocationHref, htmlTreeAsString } from './browser';
export { dsnFromString, dsnToString, makeDsn } from './dsn';
// eslint-disable-next-line deprecation/deprecation
export { SentryError } from './error';
export { GLOBAL_OBJ } from './worldwide';
export type { InternalGlobal } from './worldwide';
Expand Down
23 changes: 8 additions & 15 deletions packages/core/test/lib/client.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { afterEach, beforeEach, describe, expect, it, test, vi } from 'vitest';
import {
Scope,
SentryError,
SyncPromise,
addBreadcrumb,
dsnToString,
Expand DownExpand Up@@ -533,7 +532,7 @@ describe('Client', () => {
);
});

test('it adds a trace context to all events xxx', () => {
test('it adds a trace context to all events', () => {
expect.assertions(1);

const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
Expand DownExpand Up@@ -1206,7 +1205,7 @@ describe('Client', () => {
const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSend });
const client = new TestClient(options);
const captureExceptionSpy = vi.spyOn(client, 'captureException');
const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

client.captureEvent({ message: 'hello' });

Expand All@@ -1215,7 +1214,7 @@ describe('Client', () => {
// This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
// error, but because `beforeSend` returned `null`
expect(captureExceptionSpy).not.toBeCalled();
expect(loggerWarnSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
expect(loggerLogSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
});

test('calls `beforeSendTransaction` and discards the event', () => {
Expand All@@ -1225,7 +1224,7 @@ describe('Client', () => {
const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
const client = new TestClient(options);
const captureExceptionSpy = vi.spyOn(client, 'captureException');
const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

client.captureEvent({ transaction: '/dogs/are/great', type: 'transaction' });

Expand All@@ -1234,7 +1233,7 @@ describe('Client', () => {
// This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
// error, but because `beforeSendTransaction` returned `null`
expect(captureExceptionSpy).not.toBeCalled();
expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
expect(loggerLogSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
});

test('does not discard span and warn when returning null from `beforeSendSpan', () => {
Expand DownExpand Up@@ -1293,9 +1292,7 @@ describe('Client', () => {

expect(beforeSend).toHaveBeenCalled();
expect(TestClient.instance!.event).toBeUndefined();
expect(loggerWarnSpy).toBeCalledWith(
new SentryError('before send for type `error` must return `null` or a valid event.'),
);
expect(loggerWarnSpy).toBeCalledWith('before send for type `error` must return `null` or a valid event.');
}
});

Expand All@@ -1314,9 +1311,7 @@ describe('Client', () => {

expect(beforeSendTransaction).toHaveBeenCalled();
expect(TestClient.instance!.event).toBeUndefined();
expect(loggerWarnSpy).toBeCalledWith(
new SentryError('before send for type `transaction` must return `null` or a valid event.'),
);
expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` must return `null` or a valid event.');
}
});

Expand DownExpand Up@@ -1688,9 +1683,7 @@ describe('Client', () => {
originalException: exception,
});
expect(loggerWarnSpy).toBeCalledWith(
new SentryError(
`Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
),
`Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
);
});

Expand Down
27 changes: 0 additions & 27 deletions packages/core/test/lib/integrations/eventFilters.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -311,17 +311,6 @@ const EVENT_WITH_VALUE: Event = {
},
};

const SENTRY_EVENT: Event = {
exception: {
values: [
{
type: 'SentryError',
value: 'something something server connection',
},
],
},
};

const SCRIPT_ERROR_EVENT: Event = {
exception: {
values: [
Expand DownExpand Up@@ -425,22 +414,6 @@ describe.each([
['InboundFilters', inboundFiltersIntegration],
['EventFilters', eventFiltersIntegration],
])('%s', (_, integrationFn) => {
describe('_isSentryError', () => {
it('should work as expected', () => {
const eventProcessor = createEventFiltersEventProcessor(integrationFn);
expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
expect(eventProcessor(SENTRY_EVENT, {})).toBe(null);
});

it('should be configurable', () => {
const eventProcessor = createEventFiltersEventProcessor(integrationFn, { ignoreInternal: false });
expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
expect(eventProcessor(SENTRY_EVENT, {})).toBe(SENTRY_EVENT);
});
});

describe('ignoreErrors', () => {
it('string filter with partial match', () => {
const eventProcessor = createEventFiltersEventProcessor(integrationFn, {
Expand Down
11 changes: 0 additions & 11 deletions packages/core/test/utils-hoist/is.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,16 +14,6 @@ import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../.
import { resolvedSyncPromise } from '../../src/utils-hoist/syncpromise';
import { testOnlyIfNodeVersionAtLeast } from './testutils';

class SentryError extends Error {
public name: string;

public constructor(public message: string) {
super(message);
this.name = new.target.prototype.constructor.name;
Object.setPrototypeOf(this, new.target.prototype);
}
}

if (supportsDOMError()) {
describe('isDOMError()', () => {
test('should work as advertised', () => {
Expand All@@ -47,7 +37,6 @@ describe('isError()', () => {
test('should work as advertised', () => {
expect(isError(new Error())).toEqual(true);
expect(isError(new ReferenceError())).toEqual(true);
expect(isError(new SentryError('message'))).toEqual(true);
expect(isError({})).toEqual(false);
expect(
isError({
Expand Down
2 changes: 1 addition & 1 deletion packages/opentelemetry/test/utils/mapStatus.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,7 @@ describe('mapStatus', () => {
expect(actual).toEqual(expected);
});

it('works with string SEMATTRS_HTTP_STATUS_CODE xxx', () => {
it('works with string SEMATTRS_HTTP_STATUS_CODE', () => {
const span = createSpan('test-span');

span.setStatus({ code: 0 }); // UNSET
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
ref(core): Avoid using `SentryError` for event processing control flow by mydea · Pull Request #15823 · getsentry/sentry-javascript · GitHub
Skip to content
ref(core): Avoid using SentryError for event processing control flow#15823

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Mar 25, 2025
 Merged


ref(core): Avoid using SentryError for event processing control flow
#15823
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
604ed0d

ref(core): Avoid using `SentryError` for event processing control flow


mydea Mar 25, 2025
7d98cb6

fixes


mydea Mar 25, 2025
08a50f1

cleanup


mydea Mar 25, 2025
e0780f5

fix


mydea Mar 25, 2025

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


59 changes: 46 additions & 13 deletions
packages/core/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,6 @@ import {
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
import { SentryError } from './utils-hoist/error';
import { isParameterizedString, isPlainObject, isPrimitive, isThenable } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { checkOrSetAlreadyCaught, uuid4 } from './utils-hoist/misc';
Expand All@@ -69,6 +68,41 @@ import { _getSpanForScope } from './utils/spanOnScope';
const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';

const INTERNAL_ERROR_SYMBOL = Symbol.for('SentryInternalError');
const DO_NOT_SEND_EVENT_SYMBOL = Symbol.for('SentryDoNotSendEventError');

interface InternalError {
 message: string;
 [INTERNAL_ERROR_SYMBOL]: true;
}

interface DoNotSendEventError {
 message: string;
 [DO_NOT_SEND_EVENT_SYMBOL]: true;
}

function _makeInternalError(message: string): InternalError {
 return {
 message,
 [INTERNAL_ERROR_SYMBOL]: true,
 };
}

function _makeDoNotSendEventError(message: string): DoNotSendEventError {
 return {
 message,
 [DO_NOT_SEND_EVENT_SYMBOL]: true,
 };
}

function _isInternalError(error: unknown): error is InternalError {
 return !!error && typeof error === 'object' && INTERNAL_ERROR_SYMBOL in error;
}

function _isDoNotSendEventError(error: unknown): error is DoNotSendEventError {
 return !!error && typeof error === 'object' && DO_NOT_SEND_EVENT_SYMBOL in error;
}

/**
 * Base implementation for all JavaScript SDK clients.
 *
Expand DownExpand Up@@ -975,10 +1009,10 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 },
 reason => {
 if (DEBUG_BUILD) {
 // If something's gone wrong, log the error as a warning. If it's just us having used a `SentryError` for
 // control flow, log just the message (no stack) as a log-level log.
 if (reason instanceof SentryError && reason.logLevel === 'log') {
 if (_isDoNotSendEventError(reason)) {
 logger.log(reason.message);
 } else if (_isInternalError(reason)) {
 logger.warn(reason.message);
 } else {
 logger.warn(reason);
 }
Expand DownExpand Up@@ -1022,9 +1056,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 if (isError && typeof parsedSampleRate === 'number' && Math.random() > parsedSampleRate) {
 this.recordDroppedEvent('sample_rate', 'error');
 return rejectedSyncPromise(
new SentryError(
_makeDoNotSendEventError(
 `Discarding event because it's not included in the random sample (sampling rate = ${sampleRate})`,
 'log',
 ),
 );
 }
Expand All@@ -1035,7 +1068,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 .then(prepared => {
 if (prepared === null) {
 this.recordDroppedEvent('event_processor', dataCategory);
 throw new SentryError('An event processor returned `null`, will not send event.', 'log');
 throw _makeDoNotSendEventError('An event processor returned `null`, will not send event.');
 }

 const isInternalException = hint.data && (hint.data as { __sentry__: boolean }).__sentry__ === true;
Expand All@@ -1055,7 +1088,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 const spanCount = 1 + spans.length;
 this.recordDroppedEvent('before_send', 'span', spanCount);
 }
 throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
 throw _makeDoNotSendEventError(`${beforeSendLabel} returned \`null\`, will not send event.`);
 }

 const session = currentScope.getSession() || isolationScope.getSession();
Expand DownExpand Up@@ -1089,7 +1122,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 return processedEvent;
 })
 .then(null, reason => {
 if (reason instanceof SentryError) {
 if (_isDoNotSendEventError(reason) || _isInternalError(reason)) {
 throw reason;
 }

Expand All@@ -1099,7 +1132,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 },
 originalException: reason,
 });
 throw new SentryError(
 throw _makeInternalError(
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${reason}`,
 );
 });
Expand DownExpand Up@@ -1205,16 +1238,16 @@ function _validateBeforeSendResult(
 return beforeSendResult.then(
 event => {
 if (!isPlainObject(event) && event !== null) {
 throw new SentryError(invalidValueError);
 throw _makeInternalError(invalidValueError);
 }
 return event;
 },
 e => {
 throw new SentryError(`${beforeSendLabel} rejected with ${e}`);
 throw _makeInternalError(`${beforeSendLabel} rejected with ${e}`);
 },
 );
 } else if (!isPlainObject(beforeSendResult) && beforeSendResult !== null) {
 throw new SentryError(invalidValueError);
 throw _makeInternalError(invalidValueError);
 }
 return beforeSendResult;
}
Expand Down

17 changes: 0 additions & 17 deletions
packages/core/src/integrations/eventFilters.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,19 +102,12 @@ function _mergeOptions(
 ...(internalOptions.disableErrorDefaults ? [] : DEFAULT_IGNORE_ERRORS),
 ],
 ignoreTransactions: [...(internalOptions.ignoreTransactions || []), ...(clientOptions.ignoreTransactions || [])],
 ignoreInternal: internalOptions.ignoreInternal !== undefined ? internalOptions.ignoreInternal : true,
 };
}

function _shouldDropEvent(event: Event, options: Partial<EventFiltersOptions>): boolean {
 if (!event.type) {
 // Filter errors

 if (options.ignoreInternal && _isSentryError(event)) {
 DEBUG_BUILD &&
 logger.warn(`Event dropped due to being internal Sentry Error.\nEvent: ${getEventDescription(event)}`);
 return true;
 }
 if (_isIgnoredError(event, options.ignoreErrors)) {
 DEBUG_BUILD &&
 logger.warn(
Expand DownExpand Up@@ -196,16 +189,6 @@ function _isAllowedUrl(event: Event, allowUrls?: Array<string | RegExp>): boolea
 return !url ? true : stringMatchesSomePattern(url, allowUrls);
}

function _isSentryError(event: Event): boolean {
 try {
 // @ts-expect-error can't be a sentry error if undefined
 return event.exception.values[0].type === 'SentryError';
 } catch (e) {
 // ignore
 }
 return false;
}

function _getLastValidUrl(frames: StackFrame[] = []): string | null {
 for (let i = frames.length - 1; i >= 0; i--) {
 const frame = frames[i];
Expand Down

5 changes: 4 additions & 1 deletion
packages/core/src/utils-hoist/error.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { ConsoleLevel } from '../types-hoist';

/** An error emitted by Sentry SDKs and related utilities. */
/**
 * An error emitted by Sentry SDKs and related utilities.
 * @deprecated This class is no longer used and will be removed in a future version. Use `Error` instead.
 */
export class SentryError extends Error {
 public logLevel: ConsoleLevel;

Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ export { applyAggregateErrorsToEvent } from './aggregate-errors';
export { getBreadcrumbLogLevelFromHttpStatusCode } from './breadcrumb-log-level';
export { getComponentName, getLocationHref, htmlTreeAsString } from './browser';
export { dsnFromString, dsnToString, makeDsn } from './dsn';
// eslint-disable-next-line deprecation/deprecation
export { SentryError } from './error';
export { GLOBAL_OBJ } from './worldwide';
export type { InternalGlobal } from './worldwide';
Expand Down

23 changes: 8 additions & 15 deletions
packages/core/test/lib/client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { afterEach, beforeEach, describe, expect, it, test, vi } from 'vitest';
import {
 Scope,
 SentryError,
 SyncPromise,
 addBreadcrumb,
 dsnToString,
Expand DownExpand Up@@ -533,7 +532,7 @@ describe('Client', () => {
 );
 });

 test('it adds a trace context to all events xxx', () => {
 test('it adds a trace context to all events', () => {
 expect.assertions(1);

 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
Expand DownExpand Up@@ -1206,7 +1205,7 @@ describe('Client', () => {
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSend });
 const client = new TestClient(options);
 const captureExceptionSpy = vi.spyOn(client, 'captureException');
 const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
 const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

 client.captureEvent({ message: 'hello' });

Expand All@@ -1215,7 +1214,7 @@ describe('Client', () => {
 // This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
 // error, but because `beforeSend` returned `null`
 expect(captureExceptionSpy).not.toBeCalled();
 expect(loggerWarnSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
 expect(loggerLogSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
 });

 test('calls `beforeSendTransaction` and discards the event', () => {
Expand All@@ -1225,7 +1224,7 @@ describe('Client', () => {
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
 const client = new TestClient(options);
 const captureExceptionSpy = vi.spyOn(client, 'captureException');
 const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
 const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

 client.captureEvent({ transaction: '/dogs/are/great', type: 'transaction' });

Expand All@@ -1234,7 +1233,7 @@ describe('Client', () => {
 // This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
 // error, but because `beforeSendTransaction` returned `null`
 expect(captureExceptionSpy).not.toBeCalled();
 expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
 expect(loggerLogSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
 });

 test('does not discard span and warn when returning null from `beforeSendSpan', () => {
Expand DownExpand Up@@ -1293,9 +1292,7 @@ describe('Client', () => {

 expect(beforeSend).toHaveBeenCalled();
 expect(TestClient.instance!.event).toBeUndefined();
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError('before send for type `error` must return `null` or a valid event.'),
 );
 expect(loggerWarnSpy).toBeCalledWith('before send for type `error` must return `null` or a valid event.');
 }
 });

Expand All@@ -1314,9 +1311,7 @@ describe('Client', () => {

 expect(beforeSendTransaction).toHaveBeenCalled();
 expect(TestClient.instance!.event).toBeUndefined();
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError('before send for type `transaction` must return `null` or a valid event.'),
 );
 expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` must return `null` or a valid event.');
 }
 });

Expand DownExpand Up@@ -1688,9 +1683,7 @@ describe('Client', () => {
 originalException: exception,
 });
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError(
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
 ),
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
 );
 });

Expand Down

27 changes: 0 additions & 27 deletions
packages/core/test/lib/integrations/eventFilters.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -311,17 +311,6 @@ const EVENT_WITH_VALUE: Event = {
 },
};

const SENTRY_EVENT: Event = {
 exception: {
 values: [
 {
 type: 'SentryError',
 value: 'something something server connection',
 },
 ],
 },
};

const SCRIPT_ERROR_EVENT: Event = {
 exception: {
 values: [
Expand DownExpand Up@@ -425,22 +414,6 @@ describe.each([
 ['InboundFilters', inboundFiltersIntegration],
 ['EventFilters', eventFiltersIntegration],
])('%s', (_, integrationFn) => {
 describe('_isSentryError', () => {
 it('should work as expected', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn);
 expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
 expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
 expect(eventProcessor(SENTRY_EVENT, {})).toBe(null);
 });

 it('should be configurable', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn, { ignoreInternal: false });
 expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
 expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
 expect(eventProcessor(SENTRY_EVENT, {})).toBe(SENTRY_EVENT);
 });
 });

 describe('ignoreErrors', () => {
 it('string filter with partial match', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn, {
Expand Down

11 changes: 0 additions & 11 deletions
packages/core/test/utils-hoist/is.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,16 +14,6 @@ import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../.
import { resolvedSyncPromise } from '../../src/utils-hoist/syncpromise';
import { testOnlyIfNodeVersionAtLeast } from './testutils';

class SentryError extends Error {
 public name: string;

 public constructor(public message: string) {
 super(message);
 this.name = new.target.prototype.constructor.name;
 Object.setPrototypeOf(this, new.target.prototype);
 }
}

if (supportsDOMError()) {
 describe('isDOMError()', () => {
 test('should work as advertised', () => {
Expand All@@ -47,7 +37,6 @@ describe('isError()', () => {
 test('should work as advertised', () => {
 expect(isError(new Error())).toEqual(true);
 expect(isError(new ReferenceError())).toEqual(true);
 expect(isError(new SentryError('message'))).toEqual(true);
 expect(isError({})).toEqual(false);
 expect(
 isError({
Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry/test/utils/mapStatus.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,7 @@ describe('mapStatus', () => {
 expect(actual).toEqual(expected);
 });

 it('works with string SEMATTRS_HTTP_STATUS_CODE xxx', () => {
 it('works with string SEMATTRS_HTTP_STATUS_CODE', () => {
 const span = createSpan('test-span');

 span.setStatus({ code: 0 }); // UNSET
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ref(core): Avoid using `SentryError` for event processing control flow by mydea · Pull Request #15823 · getsentry/sentry-javascript · GitHub
Skip to content
ref(core): Avoid using SentryError for event processing control flow#15823

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Mar 25, 2025
 Merged


ref(core): Avoid using SentryError for event processing control flow
#15823
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
604ed0d

ref(core): Avoid using `SentryError` for event processing control flow


mydea Mar 25, 2025
7d98cb6

fixes


mydea Mar 25, 2025
08a50f1

cleanup


mydea Mar 25, 2025
e0780f5

fix


mydea Mar 25, 2025

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


59 changes: 46 additions & 13 deletions
packages/core/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,6 @@ import {
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
import { SentryError } from './utils-hoist/error';
import { isParameterizedString, isPlainObject, isPrimitive, isThenable } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { checkOrSetAlreadyCaught, uuid4 } from './utils-hoist/misc';
Expand All@@ -69,6 +68,41 @@ import { _getSpanForScope } from './utils/spanOnScope';
const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';

const INTERNAL_ERROR_SYMBOL = Symbol.for('SentryInternalError');
const DO_NOT_SEND_EVENT_SYMBOL = Symbol.for('SentryDoNotSendEventError');

interface InternalError {
 message: string;
 [INTERNAL_ERROR_SYMBOL]: true;
}

interface DoNotSendEventError {
 message: string;
 [DO_NOT_SEND_EVENT_SYMBOL]: true;
}

function _makeInternalError(message: string): InternalError {
 return {
 message,
 [INTERNAL_ERROR_SYMBOL]: true,
 };
}

function _makeDoNotSendEventError(message: string): DoNotSendEventError {
 return {
 message,
 [DO_NOT_SEND_EVENT_SYMBOL]: true,
 };
}

function _isInternalError(error: unknown): error is InternalError {
 return !!error && typeof error === 'object' && INTERNAL_ERROR_SYMBOL in error;
}

function _isDoNotSendEventError(error: unknown): error is DoNotSendEventError {
 return !!error && typeof error === 'object' && DO_NOT_SEND_EVENT_SYMBOL in error;
}

/**
 * Base implementation for all JavaScript SDK clients.
 *
Expand DownExpand Up@@ -975,10 +1009,10 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 },
 reason => {
 if (DEBUG_BUILD) {
 // If something's gone wrong, log the error as a warning. If it's just us having used a `SentryError` for
 // control flow, log just the message (no stack) as a log-level log.
 if (reason instanceof SentryError && reason.logLevel === 'log') {
 if (_isDoNotSendEventError(reason)) {
 logger.log(reason.message);
 } else if (_isInternalError(reason)) {
 logger.warn(reason.message);
 } else {
 logger.warn(reason);
 }
Expand DownExpand Up@@ -1022,9 +1056,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 if (isError && typeof parsedSampleRate === 'number' && Math.random() > parsedSampleRate) {
 this.recordDroppedEvent('sample_rate', 'error');
 return rejectedSyncPromise(
new SentryError(
_makeDoNotSendEventError(
 `Discarding event because it's not included in the random sample (sampling rate = ${sampleRate})`,
 'log',
 ),
 );
 }
Expand All@@ -1035,7 +1068,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 .then(prepared => {
 if (prepared === null) {
 this.recordDroppedEvent('event_processor', dataCategory);
 throw new SentryError('An event processor returned `null`, will not send event.', 'log');
 throw _makeDoNotSendEventError('An event processor returned `null`, will not send event.');
 }

 const isInternalException = hint.data && (hint.data as { __sentry__: boolean }).__sentry__ === true;
Expand All@@ -1055,7 +1088,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 const spanCount = 1 + spans.length;
 this.recordDroppedEvent('before_send', 'span', spanCount);
 }
 throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
 throw _makeDoNotSendEventError(`${beforeSendLabel} returned \`null\`, will not send event.`);
 }

 const session = currentScope.getSession() || isolationScope.getSession();
Expand DownExpand Up@@ -1089,7 +1122,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 return processedEvent;
 })
 .then(null, reason => {
 if (reason instanceof SentryError) {
 if (_isDoNotSendEventError(reason) || _isInternalError(reason)) {
 throw reason;
 }

Expand All@@ -1099,7 +1132,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 },
 originalException: reason,
 });
 throw new SentryError(
 throw _makeInternalError(
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${reason}`,
 );
 });
Expand DownExpand Up@@ -1205,16 +1238,16 @@ function _validateBeforeSendResult(
 return beforeSendResult.then(
 event => {
 if (!isPlainObject(event) && event !== null) {
 throw new SentryError(invalidValueError);
 throw _makeInternalError(invalidValueError);
 }
 return event;
 },
 e => {
 throw new SentryError(`${beforeSendLabel} rejected with ${e}`);
 throw _makeInternalError(`${beforeSendLabel} rejected with ${e}`);
 },
 );
 } else if (!isPlainObject(beforeSendResult) && beforeSendResult !== null) {
 throw new SentryError(invalidValueError);
 throw _makeInternalError(invalidValueError);
 }
 return beforeSendResult;
}
Expand Down

17 changes: 0 additions & 17 deletions
packages/core/src/integrations/eventFilters.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,19 +102,12 @@ function _mergeOptions(
 ...(internalOptions.disableErrorDefaults ? [] : DEFAULT_IGNORE_ERRORS),
 ],
 ignoreTransactions: [...(internalOptions.ignoreTransactions || []), ...(clientOptions.ignoreTransactions || [])],
 ignoreInternal: internalOptions.ignoreInternal !== undefined ? internalOptions.ignoreInternal : true,
 };
}

function _shouldDropEvent(event: Event, options: Partial<EventFiltersOptions>): boolean {
 if (!event.type) {
 // Filter errors

 if (options.ignoreInternal && _isSentryError(event)) {
 DEBUG_BUILD &&
 logger.warn(`Event dropped due to being internal Sentry Error.\nEvent: ${getEventDescription(event)}`);
 return true;
 }
 if (_isIgnoredError(event, options.ignoreErrors)) {
 DEBUG_BUILD &&
 logger.warn(
Expand DownExpand Up@@ -196,16 +189,6 @@ function _isAllowedUrl(event: Event, allowUrls?: Array<string | RegExp>): boolea
 return !url ? true : stringMatchesSomePattern(url, allowUrls);
}

function _isSentryError(event: Event): boolean {
 try {
 // @ts-expect-error can't be a sentry error if undefined
 return event.exception.values[0].type === 'SentryError';
 } catch (e) {
 // ignore
 }
 return false;
}

function _getLastValidUrl(frames: StackFrame[] = []): string | null {
 for (let i = frames.length - 1; i >= 0; i--) {
 const frame = frames[i];
Expand Down

5 changes: 4 additions & 1 deletion
packages/core/src/utils-hoist/error.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { ConsoleLevel } from '../types-hoist';

/** An error emitted by Sentry SDKs and related utilities. */
/**
 * An error emitted by Sentry SDKs and related utilities.
 * @deprecated This class is no longer used and will be removed in a future version. Use `Error` instead.
 */
export class SentryError extends Error {
 public logLevel: ConsoleLevel;

Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ export { applyAggregateErrorsToEvent } from './aggregate-errors';
export { getBreadcrumbLogLevelFromHttpStatusCode } from './breadcrumb-log-level';
export { getComponentName, getLocationHref, htmlTreeAsString } from './browser';
export { dsnFromString, dsnToString, makeDsn } from './dsn';
// eslint-disable-next-line deprecation/deprecation
export { SentryError } from './error';
export { GLOBAL_OBJ } from './worldwide';
export type { InternalGlobal } from './worldwide';
Expand Down

23 changes: 8 additions & 15 deletions
packages/core/test/lib/client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { afterEach, beforeEach, describe, expect, it, test, vi } from 'vitest';
import {
 Scope,
 SentryError,
 SyncPromise,
 addBreadcrumb,
 dsnToString,
Expand DownExpand Up@@ -533,7 +532,7 @@ describe('Client', () => {
 );
 });

 test('it adds a trace context to all events xxx', () => {
 test('it adds a trace context to all events', () => {
 expect.assertions(1);

 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
Expand DownExpand Up@@ -1206,7 +1205,7 @@ describe('Client', () => {
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSend });
 const client = new TestClient(options);
 const captureExceptionSpy = vi.spyOn(client, 'captureException');
 const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
 const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

 client.captureEvent({ message: 'hello' });

Expand All@@ -1215,7 +1214,7 @@ describe('Client', () => {
 // This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
 // error, but because `beforeSend` returned `null`
 expect(captureExceptionSpy).not.toBeCalled();
 expect(loggerWarnSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
 expect(loggerLogSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
 });

 test('calls `beforeSendTransaction` and discards the event', () => {
Expand All@@ -1225,7 +1224,7 @@ describe('Client', () => {
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
 const client = new TestClient(options);
 const captureExceptionSpy = vi.spyOn(client, 'captureException');
 const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
 const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

 client.captureEvent({ transaction: '/dogs/are/great', type: 'transaction' });

Expand All@@ -1234,7 +1233,7 @@ describe('Client', () => {
 // This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
 // error, but because `beforeSendTransaction` returned `null`
 expect(captureExceptionSpy).not.toBeCalled();
 expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
 expect(loggerLogSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
 });

 test('does not discard span and warn when returning null from `beforeSendSpan', () => {
Expand DownExpand Up@@ -1293,9 +1292,7 @@ describe('Client', () => {

 expect(beforeSend).toHaveBeenCalled();
 expect(TestClient.instance!.event).toBeUndefined();
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError('before send for type `error` must return `null` or a valid event.'),
 );
 expect(loggerWarnSpy).toBeCalledWith('before send for type `error` must return `null` or a valid event.');
 }
 });

Expand All@@ -1314,9 +1311,7 @@ describe('Client', () => {

 expect(beforeSendTransaction).toHaveBeenCalled();
 expect(TestClient.instance!.event).toBeUndefined();
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError('before send for type `transaction` must return `null` or a valid event.'),
 );
 expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` must return `null` or a valid event.');
 }
 });

Expand DownExpand Up@@ -1688,9 +1683,7 @@ describe('Client', () => {
 originalException: exception,
 });
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError(
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
 ),
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
 );
 });

Expand Down

27 changes: 0 additions & 27 deletions
packages/core/test/lib/integrations/eventFilters.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -311,17 +311,6 @@ const EVENT_WITH_VALUE: Event = {
 },
};

const SENTRY_EVENT: Event = {
 exception: {
 values: [
 {
 type: 'SentryError',
 value: 'something something server connection',
 },
 ],
 },
};

const SCRIPT_ERROR_EVENT: Event = {
 exception: {
 values: [
Expand DownExpand Up@@ -425,22 +414,6 @@ describe.each([
 ['InboundFilters', inboundFiltersIntegration],
 ['EventFilters', eventFiltersIntegration],
])('%s', (_, integrationFn) => {
 describe('_isSentryError', () => {
 it('should work as expected', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn);
 expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
 expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
 expect(eventProcessor(SENTRY_EVENT, {})).toBe(null);
 });

 it('should be configurable', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn, { ignoreInternal: false });
 expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
 expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
 expect(eventProcessor(SENTRY_EVENT, {})).toBe(SENTRY_EVENT);
 });
 });

 describe('ignoreErrors', () => {
 it('string filter with partial match', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn, {
Expand Down

11 changes: 0 additions & 11 deletions
packages/core/test/utils-hoist/is.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,16 +14,6 @@ import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../.
import { resolvedSyncPromise } from '../../src/utils-hoist/syncpromise';
import { testOnlyIfNodeVersionAtLeast } from './testutils';

class SentryError extends Error {
 public name: string;

 public constructor(public message: string) {
 super(message);
 this.name = new.target.prototype.constructor.name;
 Object.setPrototypeOf(this, new.target.prototype);
 }
}

if (supportsDOMError()) {
 describe('isDOMError()', () => {
 test('should work as advertised', () => {
Expand All@@ -47,7 +37,6 @@ describe('isError()', () => {
 test('should work as advertised', () => {
 expect(isError(new Error())).toEqual(true);
 expect(isError(new ReferenceError())).toEqual(true);
 expect(isError(new SentryError('message'))).toEqual(true);
 expect(isError({})).toEqual(false);
 expect(
 isError({
Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry/test/utils/mapStatus.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,7 @@ describe('mapStatus', () => {
 expect(actual).toEqual(expected);
 });

 it('works with string SEMATTRS_HTTP_STATUS_CODE xxx', () => {
 it('works with string SEMATTRS_HTTP_STATUS_CODE', () => {
 const span = createSpan('test-span');

 span.setStatus({ code: 0 }); // UNSET
Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Mar 25, 2025
 Merged


ref(core): Avoid using SentryError for event processing control flow
#15823
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
604ed0d

ref(core): Avoid using `SentryError` for event processing control flow


mydea Mar 25, 2025
7d98cb6

fixes


mydea Mar 25, 2025
08a50f1

cleanup


mydea Mar 25, 2025
e0780f5

fix


mydea Mar 25, 2025

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


59 changes: 46 additions & 13 deletions
packages/core/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,6 @@ import {
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
import { SentryError } from './utils-hoist/error';
import { isParameterizedString, isPlainObject, isPrimitive, isThenable } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { checkOrSetAlreadyCaught, uuid4 } from './utils-hoist/misc';
Expand All@@ -69,6 +68,41 @@ import { _getSpanForScope } from './utils/spanOnScope';
const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';

const INTERNAL_ERROR_SYMBOL = Symbol.for('SentryInternalError');
const DO_NOT_SEND_EVENT_SYMBOL = Symbol.for('SentryDoNotSendEventError');

interface InternalError {
 message: string;
 [INTERNAL_ERROR_SYMBOL]: true;
}

interface DoNotSendEventError {
 message: string;
 [DO_NOT_SEND_EVENT_SYMBOL]: true;
}

function _makeInternalError(message: string): InternalError {
 return {
 message,
 [INTERNAL_ERROR_SYMBOL]: true,
 };
}

function _makeDoNotSendEventError(message: string): DoNotSendEventError {
 return {
 message,
 [DO_NOT_SEND_EVENT_SYMBOL]: true,
 };
}

function _isInternalError(error: unknown): error is InternalError {
 return !!error && typeof error === 'object' && INTERNAL_ERROR_SYMBOL in error;
}

function _isDoNotSendEventError(error: unknown): error is DoNotSendEventError {
 return !!error && typeof error === 'object' && DO_NOT_SEND_EVENT_SYMBOL in error;
}

/**
 * Base implementation for all JavaScript SDK clients.
 *
Expand DownExpand Up@@ -975,10 +1009,10 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 },
 reason => {
 if (DEBUG_BUILD) {
 // If something's gone wrong, log the error as a warning. If it's just us having used a `SentryError` for
 // control flow, log just the message (no stack) as a log-level log.
 if (reason instanceof SentryError && reason.logLevel === 'log') {
 if (_isDoNotSendEventError(reason)) {
 logger.log(reason.message);
 } else if (_isInternalError(reason)) {
 logger.warn(reason.message);
 } else {
 logger.warn(reason);
 }
Expand DownExpand Up@@ -1022,9 +1056,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 if (isError && typeof parsedSampleRate === 'number' && Math.random() > parsedSampleRate) {
 this.recordDroppedEvent('sample_rate', 'error');
 return rejectedSyncPromise(
new SentryError(
_makeDoNotSendEventError(
 `Discarding event because it's not included in the random sample (sampling rate = ${sampleRate})`,
 'log',
 ),
 );
 }
Expand All@@ -1035,7 +1068,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 .then(prepared => {
 if (prepared === null) {
 this.recordDroppedEvent('event_processor', dataCategory);
 throw new SentryError('An event processor returned `null`, will not send event.', 'log');
 throw _makeDoNotSendEventError('An event processor returned `null`, will not send event.');
 }

 const isInternalException = hint.data && (hint.data as { __sentry__: boolean }).__sentry__ === true;
Expand All@@ -1055,7 +1088,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 const spanCount = 1 + spans.length;
 this.recordDroppedEvent('before_send', 'span', spanCount);
 }
 throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
 throw _makeDoNotSendEventError(`${beforeSendLabel} returned \`null\`, will not send event.`);
 }

 const session = currentScope.getSession() || isolationScope.getSession();
Expand DownExpand Up@@ -1089,7 +1122,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 return processedEvent;
 })
 .then(null, reason => {
 if (reason instanceof SentryError) {
 if (_isDoNotSendEventError(reason) || _isInternalError(reason)) {
 throw reason;
 }

Expand All@@ -1099,7 +1132,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 },
 originalException: reason,
 });
 throw new SentryError(
 throw _makeInternalError(
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${reason}`,
 );
 });
Expand DownExpand Up@@ -1205,16 +1238,16 @@ function _validateBeforeSendResult(
 return beforeSendResult.then(
 event => {
 if (!isPlainObject(event) && event !== null) {
 throw new SentryError(invalidValueError);
 throw _makeInternalError(invalidValueError);
 }
 return event;
 },
 e => {
 throw new SentryError(`${beforeSendLabel} rejected with ${e}`);
 throw _makeInternalError(`${beforeSendLabel} rejected with ${e}`);
 },
 );
 } else if (!isPlainObject(beforeSendResult) && beforeSendResult !== null) {
 throw new SentryError(invalidValueError);
 throw _makeInternalError(invalidValueError);
 }
 return beforeSendResult;
}
Expand Down

17 changes: 0 additions & 17 deletions
packages/core/src/integrations/eventFilters.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,19 +102,12 @@ function _mergeOptions(
 ...(internalOptions.disableErrorDefaults ? [] : DEFAULT_IGNORE_ERRORS),
 ],
 ignoreTransactions: [...(internalOptions.ignoreTransactions || []), ...(clientOptions.ignoreTransactions || [])],
 ignoreInternal: internalOptions.ignoreInternal !== undefined ? internalOptions.ignoreInternal : true,
 };
}

function _shouldDropEvent(event: Event, options: Partial<EventFiltersOptions>): boolean {
 if (!event.type) {
 // Filter errors

 if (options.ignoreInternal && _isSentryError(event)) {
 DEBUG_BUILD &&
 logger.warn(`Event dropped due to being internal Sentry Error.\nEvent: ${getEventDescription(event)}`);
 return true;
 }
 if (_isIgnoredError(event, options.ignoreErrors)) {
 DEBUG_BUILD &&
 logger.warn(
Expand DownExpand Up@@ -196,16 +189,6 @@ function _isAllowedUrl(event: Event, allowUrls?: Array<string | RegExp>): boolea
 return !url ? true : stringMatchesSomePattern(url, allowUrls);
}

function _isSentryError(event: Event): boolean {
 try {
 // @ts-expect-error can't be a sentry error if undefined
 return event.exception.values[0].type === 'SentryError';
 } catch (e) {
 // ignore
 }
 return false;
}

function _getLastValidUrl(frames: StackFrame[] = []): string | null {
 for (let i = frames.length - 1; i >= 0; i--) {
 const frame = frames[i];
Expand Down

5 changes: 4 additions & 1 deletion
packages/core/src/utils-hoist/error.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { ConsoleLevel } from '../types-hoist';

/** An error emitted by Sentry SDKs and related utilities. */
/**
 * An error emitted by Sentry SDKs and related utilities.
 * @deprecated This class is no longer used and will be removed in a future version. Use `Error` instead.
 */
export class SentryError extends Error {
 public logLevel: ConsoleLevel;

Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ export { applyAggregateErrorsToEvent } from './aggregate-errors';
export { getBreadcrumbLogLevelFromHttpStatusCode } from './breadcrumb-log-level';
export { getComponentName, getLocationHref, htmlTreeAsString } from './browser';
export { dsnFromString, dsnToString, makeDsn } from './dsn';
// eslint-disable-next-line deprecation/deprecation
export { SentryError } from './error';
export { GLOBAL_OBJ } from './worldwide';
export type { InternalGlobal } from './worldwide';
Expand Down

23 changes: 8 additions & 15 deletions
packages/core/test/lib/client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { afterEach, beforeEach, describe, expect, it, test, vi } from 'vitest';
import {
 Scope,
 SentryError,
 SyncPromise,
 addBreadcrumb,
 dsnToString,
Expand DownExpand Up@@ -533,7 +532,7 @@ describe('Client', () => {
 );
 });

 test('it adds a trace context to all events xxx', () => {
 test('it adds a trace context to all events', () => {
 expect.assertions(1);

 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
Expand DownExpand Up@@ -1206,7 +1205,7 @@ describe('Client', () => {
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSend });
 const client = new TestClient(options);
 const captureExceptionSpy = vi.spyOn(client, 'captureException');
 const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
 const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

 client.captureEvent({ message: 'hello' });

Expand All@@ -1215,7 +1214,7 @@ describe('Client', () => {
 // This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
 // error, but because `beforeSend` returned `null`
 expect(captureExceptionSpy).not.toBeCalled();
 expect(loggerWarnSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
 expect(loggerLogSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
 });

 test('calls `beforeSendTransaction` and discards the event', () => {
Expand All@@ -1225,7 +1224,7 @@ describe('Client', () => {
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
 const client = new TestClient(options);
 const captureExceptionSpy = vi.spyOn(client, 'captureException');
 const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
 const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

 client.captureEvent({ transaction: '/dogs/are/great', type: 'transaction' });

Expand All@@ -1234,7 +1233,7 @@ describe('Client', () => {
 // This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
 // error, but because `beforeSendTransaction` returned `null`
 expect(captureExceptionSpy).not.toBeCalled();
 expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
 expect(loggerLogSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
 });

 test('does not discard span and warn when returning null from `beforeSendSpan', () => {
Expand DownExpand Up@@ -1293,9 +1292,7 @@ describe('Client', () => {

 expect(beforeSend).toHaveBeenCalled();
 expect(TestClient.instance!.event).toBeUndefined();
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError('before send for type `error` must return `null` or a valid event.'),
 );
 expect(loggerWarnSpy).toBeCalledWith('before send for type `error` must return `null` or a valid event.');
 }
 });

Expand All@@ -1314,9 +1311,7 @@ describe('Client', () => {

 expect(beforeSendTransaction).toHaveBeenCalled();
 expect(TestClient.instance!.event).toBeUndefined();
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError('before send for type `transaction` must return `null` or a valid event.'),
 );
 expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` must return `null` or a valid event.');
 }
 });

Expand DownExpand Up@@ -1688,9 +1683,7 @@ describe('Client', () => {
 originalException: exception,
 });
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError(
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
 ),
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
 );
 });

Expand Down

27 changes: 0 additions & 27 deletions
packages/core/test/lib/integrations/eventFilters.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -311,17 +311,6 @@ const EVENT_WITH_VALUE: Event = {
 },
};

const SENTRY_EVENT: Event = {
 exception: {
 values: [
 {
 type: 'SentryError',
 value: 'something something server connection',
 },
 ],
 },
};

const SCRIPT_ERROR_EVENT: Event = {
 exception: {
 values: [
Expand DownExpand Up@@ -425,22 +414,6 @@ describe.each([
 ['InboundFilters', inboundFiltersIntegration],
 ['EventFilters', eventFiltersIntegration],
])('%s', (_, integrationFn) => {
 describe('_isSentryError', () => {
 it('should work as expected', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn);
 expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
 expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
 expect(eventProcessor(SENTRY_EVENT, {})).toBe(null);
 });

 it('should be configurable', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn, { ignoreInternal: false });
 expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
 expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
 expect(eventProcessor(SENTRY_EVENT, {})).toBe(SENTRY_EVENT);
 });
 });

 describe('ignoreErrors', () => {
 it('string filter with partial match', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn, {
Expand Down

11 changes: 0 additions & 11 deletions
packages/core/test/utils-hoist/is.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,16 +14,6 @@ import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../.
import { resolvedSyncPromise } from '../../src/utils-hoist/syncpromise';
import { testOnlyIfNodeVersionAtLeast } from './testutils';

class SentryError extends Error {
 public name: string;

 public constructor(public message: string) {
 super(message);
 this.name = new.target.prototype.constructor.name;
 Object.setPrototypeOf(this, new.target.prototype);
 }
}

if (supportsDOMError()) {
 describe('isDOMError()', () => {
 test('should work as advertised', () => {
Expand All@@ -47,7 +37,6 @@ describe('isError()', () => {
 test('should work as advertised', () => {
 expect(isError(new Error())).toEqual(true);
 expect(isError(new ReferenceError())).toEqual(true);
 expect(isError(new SentryError('message'))).toEqual(true);
 expect(isError({})).toEqual(false);
 expect(
 isError({
Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry/test/utils/mapStatus.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,7 @@ describe('mapStatus', () => {
 expect(actual).toEqual(expected);
 });

 it('works with string SEMATTRS_HTTP_STATUS_CODE xxx', () => {
 it('works with string SEMATTRS_HTTP_STATUS_CODE', () => {
 const span = createSpan('test-span');

 span.setStatus({ code: 0 }); // UNSET
Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Mar 25, 2025
 Merged


ref(core): Avoid using SentryError for event processing control flow
#15823
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
604ed0d

ref(core): Avoid using `SentryError` for event processing control flow


mydea Mar 25, 2025
7d98cb6

fixes


mydea Mar 25, 2025
08a50f1

cleanup


mydea Mar 25, 2025
e0780f5

fix


mydea Mar 25, 2025

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


59 changes: 46 additions & 13 deletions
packages/core/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,6 @@ import {
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
import { SentryError } from './utils-hoist/error';
import { isParameterizedString, isPlainObject, isPrimitive, isThenable } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { checkOrSetAlreadyCaught, uuid4 } from './utils-hoist/misc';
Expand All@@ -69,6 +68,41 @@ import { _getSpanForScope } from './utils/spanOnScope';
const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';

const INTERNAL_ERROR_SYMBOL = Symbol.for('SentryInternalError');
const DO_NOT_SEND_EVENT_SYMBOL = Symbol.for('SentryDoNotSendEventError');

interface InternalError {
 message: string;
 [INTERNAL_ERROR_SYMBOL]: true;
}

interface DoNotSendEventError {
 message: string;
 [DO_NOT_SEND_EVENT_SYMBOL]: true;
}

function _makeInternalError(message: string): InternalError {
 return {
 message,
 [INTERNAL_ERROR_SYMBOL]: true,
 };
}

function _makeDoNotSendEventError(message: string): DoNotSendEventError {
 return {
 message,
 [DO_NOT_SEND_EVENT_SYMBOL]: true,
 };
}

function _isInternalError(error: unknown): error is InternalError {
 return !!error && typeof error === 'object' && INTERNAL_ERROR_SYMBOL in error;
}

function _isDoNotSendEventError(error: unknown): error is DoNotSendEventError {
 return !!error && typeof error === 'object' && DO_NOT_SEND_EVENT_SYMBOL in error;
}

/**
 * Base implementation for all JavaScript SDK clients.
 *
Expand DownExpand Up@@ -975,10 +1009,10 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 },
 reason => {
 if (DEBUG_BUILD) {
 // If something's gone wrong, log the error as a warning. If it's just us having used a `SentryError` for
 // control flow, log just the message (no stack) as a log-level log.
 if (reason instanceof SentryError && reason.logLevel === 'log') {
 if (_isDoNotSendEventError(reason)) {
 logger.log(reason.message);
 } else if (_isInternalError(reason)) {
 logger.warn(reason.message);
 } else {
 logger.warn(reason);
 }
Expand DownExpand Up@@ -1022,9 +1056,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 if (isError && typeof parsedSampleRate === 'number' && Math.random() > parsedSampleRate) {
 this.recordDroppedEvent('sample_rate', 'error');
 return rejectedSyncPromise(
new SentryError(
_makeDoNotSendEventError(
 `Discarding event because it's not included in the random sample (sampling rate = ${sampleRate})`,
 'log',
 ),
 );
 }
Expand All@@ -1035,7 +1068,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 .then(prepared => {
 if (prepared === null) {
 this.recordDroppedEvent('event_processor', dataCategory);
 throw new SentryError('An event processor returned `null`, will not send event.', 'log');
 throw _makeDoNotSendEventError('An event processor returned `null`, will not send event.');
 }

 const isInternalException = hint.data && (hint.data as { __sentry__: boolean }).__sentry__ === true;
Expand All@@ -1055,7 +1088,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 const spanCount = 1 + spans.length;
 this.recordDroppedEvent('before_send', 'span', spanCount);
 }
 throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
 throw _makeDoNotSendEventError(`${beforeSendLabel} returned \`null\`, will not send event.`);
 }

 const session = currentScope.getSession() || isolationScope.getSession();
Expand DownExpand Up@@ -1089,7 +1122,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 return processedEvent;
 })
 .then(null, reason => {
 if (reason instanceof SentryError) {
 if (_isDoNotSendEventError(reason) || _isInternalError(reason)) {
 throw reason;
 }

Expand All@@ -1099,7 +1132,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 },
 originalException: reason,
 });
 throw new SentryError(
 throw _makeInternalError(
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${reason}`,
 );
 });
Expand DownExpand Up@@ -1205,16 +1238,16 @@ function _validateBeforeSendResult(
 return beforeSendResult.then(
 event => {
 if (!isPlainObject(event) && event !== null) {
 throw new SentryError(invalidValueError);
 throw _makeInternalError(invalidValueError);
 }
 return event;
 },
 e => {
 throw new SentryError(`${beforeSendLabel} rejected with ${e}`);
 throw _makeInternalError(`${beforeSendLabel} rejected with ${e}`);
 },
 );
 } else if (!isPlainObject(beforeSendResult) && beforeSendResult !== null) {
 throw new SentryError(invalidValueError);
 throw _makeInternalError(invalidValueError);
 }
 return beforeSendResult;
}
Expand Down

17 changes: 0 additions & 17 deletions
packages/core/src/integrations/eventFilters.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,19 +102,12 @@ function _mergeOptions(
 ...(internalOptions.disableErrorDefaults ? [] : DEFAULT_IGNORE_ERRORS),
 ],
 ignoreTransactions: [...(internalOptions.ignoreTransactions || []), ...(clientOptions.ignoreTransactions || [])],
 ignoreInternal: internalOptions.ignoreInternal !== undefined ? internalOptions.ignoreInternal : true,
 };
}

function _shouldDropEvent(event: Event, options: Partial<EventFiltersOptions>): boolean {
 if (!event.type) {
 // Filter errors

 if (options.ignoreInternal && _isSentryError(event)) {
 DEBUG_BUILD &&
 logger.warn(`Event dropped due to being internal Sentry Error.\nEvent: ${getEventDescription(event)}`);
 return true;
 }
 if (_isIgnoredError(event, options.ignoreErrors)) {
 DEBUG_BUILD &&
 logger.warn(
Expand DownExpand Up@@ -196,16 +189,6 @@ function _isAllowedUrl(event: Event, allowUrls?: Array<string | RegExp>): boolea
 return !url ? true : stringMatchesSomePattern(url, allowUrls);
}

function _isSentryError(event: Event): boolean {
 try {
 // @ts-expect-error can't be a sentry error if undefined
 return event.exception.values[0].type === 'SentryError';
 } catch (e) {
 // ignore
 }
 return false;
}

function _getLastValidUrl(frames: StackFrame[] = []): string | null {
 for (let i = frames.length - 1; i >= 0; i--) {
 const frame = frames[i];
Expand Down

5 changes: 4 additions & 1 deletion
packages/core/src/utils-hoist/error.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { ConsoleLevel } from '../types-hoist';

/** An error emitted by Sentry SDKs and related utilities. */
/**
 * An error emitted by Sentry SDKs and related utilities.
 * @deprecated This class is no longer used and will be removed in a future version. Use `Error` instead.
 */
export class SentryError extends Error {
 public logLevel: ConsoleLevel;

Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ export { applyAggregateErrorsToEvent } from './aggregate-errors';
export { getBreadcrumbLogLevelFromHttpStatusCode } from './breadcrumb-log-level';
export { getComponentName, getLocationHref, htmlTreeAsString } from './browser';
export { dsnFromString, dsnToString, makeDsn } from './dsn';
// eslint-disable-next-line deprecation/deprecation
export { SentryError } from './error';
export { GLOBAL_OBJ } from './worldwide';
export type { InternalGlobal } from './worldwide';
Expand Down

23 changes: 8 additions & 15 deletions
packages/core/test/lib/client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { afterEach, beforeEach, describe, expect, it, test, vi } from 'vitest';
import {
 Scope,
 SentryError,
 SyncPromise,
 addBreadcrumb,
 dsnToString,
Expand DownExpand Up@@ -533,7 +532,7 @@ describe('Client', () => {
 );
 });

 test('it adds a trace context to all events xxx', () => {
 test('it adds a trace context to all events', () => {
 expect.assertions(1);

 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
Expand DownExpand Up@@ -1206,7 +1205,7 @@ describe('Client', () => {
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSend });
 const client = new TestClient(options);
 const captureExceptionSpy = vi.spyOn(client, 'captureException');
 const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
 const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

 client.captureEvent({ message: 'hello' });

Expand All@@ -1215,7 +1214,7 @@ describe('Client', () => {
 // This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
 // error, but because `beforeSend` returned `null`
 expect(captureExceptionSpy).not.toBeCalled();
 expect(loggerWarnSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
 expect(loggerLogSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
 });

 test('calls `beforeSendTransaction` and discards the event', () => {
Expand All@@ -1225,7 +1224,7 @@ describe('Client', () => {
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
 const client = new TestClient(options);
 const captureExceptionSpy = vi.spyOn(client, 'captureException');
 const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
 const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

 client.captureEvent({ transaction: '/dogs/are/great', type: 'transaction' });

Expand All@@ -1234,7 +1233,7 @@ describe('Client', () => {
 // This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
 // error, but because `beforeSendTransaction` returned `null`
 expect(captureExceptionSpy).not.toBeCalled();
 expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
 expect(loggerLogSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
 });

 test('does not discard span and warn when returning null from `beforeSendSpan', () => {
Expand DownExpand Up@@ -1293,9 +1292,7 @@ describe('Client', () => {

 expect(beforeSend).toHaveBeenCalled();
 expect(TestClient.instance!.event).toBeUndefined();
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError('before send for type `error` must return `null` or a valid event.'),
 );
 expect(loggerWarnSpy).toBeCalledWith('before send for type `error` must return `null` or a valid event.');
 }
 });

Expand All@@ -1314,9 +1311,7 @@ describe('Client', () => {

 expect(beforeSendTransaction).toHaveBeenCalled();
 expect(TestClient.instance!.event).toBeUndefined();
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError('before send for type `transaction` must return `null` or a valid event.'),
 );
 expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` must return `null` or a valid event.');
 }
 });

Expand DownExpand Up@@ -1688,9 +1683,7 @@ describe('Client', () => {
 originalException: exception,
 });
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError(
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
 ),
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
 );
 });

Expand Down

27 changes: 0 additions & 27 deletions
packages/core/test/lib/integrations/eventFilters.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -311,17 +311,6 @@ const EVENT_WITH_VALUE: Event = {
 },
};

const SENTRY_EVENT: Event = {
 exception: {
 values: [
 {
 type: 'SentryError',
 value: 'something something server connection',
 },
 ],
 },
};

const SCRIPT_ERROR_EVENT: Event = {
 exception: {
 values: [
Expand DownExpand Up@@ -425,22 +414,6 @@ describe.each([
 ['InboundFilters', inboundFiltersIntegration],
 ['EventFilters', eventFiltersIntegration],
])('%s', (_, integrationFn) => {
 describe('_isSentryError', () => {
 it('should work as expected', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn);
 expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
 expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
 expect(eventProcessor(SENTRY_EVENT, {})).toBe(null);
 });

 it('should be configurable', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn, { ignoreInternal: false });
 expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
 expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
 expect(eventProcessor(SENTRY_EVENT, {})).toBe(SENTRY_EVENT);
 });
 });

 describe('ignoreErrors', () => {
 it('string filter with partial match', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn, {
Expand Down

11 changes: 0 additions & 11 deletions
packages/core/test/utils-hoist/is.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,16 +14,6 @@ import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../.
import { resolvedSyncPromise } from '../../src/utils-hoist/syncpromise';
import { testOnlyIfNodeVersionAtLeast } from './testutils';

class SentryError extends Error {
 public name: string;

 public constructor(public message: string) {
 super(message);
 this.name = new.target.prototype.constructor.name;
 Object.setPrototypeOf(this, new.target.prototype);
 }
}

if (supportsDOMError()) {
 describe('isDOMError()', () => {
 test('should work as advertised', () => {
Expand All@@ -47,7 +37,6 @@ describe('isError()', () => {
 test('should work as advertised', () => {
 expect(isError(new Error())).toEqual(true);
 expect(isError(new ReferenceError())).toEqual(true);
 expect(isError(new SentryError('message'))).toEqual(true);
 expect(isError({})).toEqual(false);
 expect(
 isError({
Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry/test/utils/mapStatus.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,7 @@ describe('mapStatus', () => {
 expect(actual).toEqual(expected);
 });

 it('works with string SEMATTRS_HTTP_STATUS_CODE xxx', () => {
 it('works with string SEMATTRS_HTTP_STATUS_CODE', () => {
 const span = createSpan('test-span');

 span.setStatus({ code: 0 }); // UNSET
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ref(core): Avoid using `SentryError` for event processing control flow by mydea · Pull Request #15823 · getsentry/sentry-javascript · GitHub
Skip to content
ref(core): Avoid using SentryError for event processing control flow#15823

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Mar 25, 2025
 Merged


ref(core): Avoid using SentryError for event processing control flow
#15823
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
604ed0d

ref(core): Avoid using `SentryError` for event processing control flow


mydea Mar 25, 2025
7d98cb6

fixes


mydea Mar 25, 2025
08a50f1

cleanup


mydea Mar 25, 2025
e0780f5

fix


mydea Mar 25, 2025

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


59 changes: 46 additions & 13 deletions
packages/core/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,6 @@ import {
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
import { SentryError } from './utils-hoist/error';
import { isParameterizedString, isPlainObject, isPrimitive, isThenable } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { checkOrSetAlreadyCaught, uuid4 } from './utils-hoist/misc';
Expand All@@ -69,6 +68,41 @@ import { _getSpanForScope } from './utils/spanOnScope';
const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';

const INTERNAL_ERROR_SYMBOL = Symbol.for('SentryInternalError');
const DO_NOT_SEND_EVENT_SYMBOL = Symbol.for('SentryDoNotSendEventError');

interface InternalError {
 message: string;
 [INTERNAL_ERROR_SYMBOL]: true;
}

interface DoNotSendEventError {
 message: string;
 [DO_NOT_SEND_EVENT_SYMBOL]: true;
}

function _makeInternalError(message: string): InternalError {
 return {
 message,
 [INTERNAL_ERROR_SYMBOL]: true,
 };
}

function _makeDoNotSendEventError(message: string): DoNotSendEventError {
 return {
 message,
 [DO_NOT_SEND_EVENT_SYMBOL]: true,
 };
}

function _isInternalError(error: unknown): error is InternalError {
 return !!error && typeof error === 'object' && INTERNAL_ERROR_SYMBOL in error;
}

function _isDoNotSendEventError(error: unknown): error is DoNotSendEventError {
 return !!error && typeof error === 'object' && DO_NOT_SEND_EVENT_SYMBOL in error;
}

/**
 * Base implementation for all JavaScript SDK clients.
 *
Expand DownExpand Up@@ -975,10 +1009,10 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 },
 reason => {
 if (DEBUG_BUILD) {
 // If something's gone wrong, log the error as a warning. If it's just us having used a `SentryError` for
 // control flow, log just the message (no stack) as a log-level log.
 if (reason instanceof SentryError && reason.logLevel === 'log') {
 if (_isDoNotSendEventError(reason)) {
 logger.log(reason.message);
 } else if (_isInternalError(reason)) {
 logger.warn(reason.message);
 } else {
 logger.warn(reason);
 }
Expand DownExpand Up@@ -1022,9 +1056,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 if (isError && typeof parsedSampleRate === 'number' && Math.random() > parsedSampleRate) {
 this.recordDroppedEvent('sample_rate', 'error');
 return rejectedSyncPromise(
new SentryError(
_makeDoNotSendEventError(
 `Discarding event because it's not included in the random sample (sampling rate = ${sampleRate})`,
 'log',
 ),
 );
 }
Expand All@@ -1035,7 +1068,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 .then(prepared => {
 if (prepared === null) {
 this.recordDroppedEvent('event_processor', dataCategory);
 throw new SentryError('An event processor returned `null`, will not send event.', 'log');
 throw _makeDoNotSendEventError('An event processor returned `null`, will not send event.');
 }

 const isInternalException = hint.data && (hint.data as { __sentry__: boolean }).__sentry__ === true;
Expand All@@ -1055,7 +1088,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 const spanCount = 1 + spans.length;
 this.recordDroppedEvent('before_send', 'span', spanCount);
 }
 throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
 throw _makeDoNotSendEventError(`${beforeSendLabel} returned \`null\`, will not send event.`);
 }

 const session = currentScope.getSession() || isolationScope.getSession();
Expand DownExpand Up@@ -1089,7 +1122,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 return processedEvent;
 })
 .then(null, reason => {
 if (reason instanceof SentryError) {
 if (_isDoNotSendEventError(reason) || _isInternalError(reason)) {
 throw reason;
 }

Expand All@@ -1099,7 +1132,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 },
 originalException: reason,
 });
 throw new SentryError(
 throw _makeInternalError(
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${reason}`,
 );
 });
Expand DownExpand Up@@ -1205,16 +1238,16 @@ function _validateBeforeSendResult(
 return beforeSendResult.then(
 event => {
 if (!isPlainObject(event) && event !== null) {
 throw new SentryError(invalidValueError);
 throw _makeInternalError(invalidValueError);
 }
 return event;
 },
 e => {
 throw new SentryError(`${beforeSendLabel} rejected with ${e}`);
 throw _makeInternalError(`${beforeSendLabel} rejected with ${e}`);
 },
 );
 } else if (!isPlainObject(beforeSendResult) && beforeSendResult !== null) {
 throw new SentryError(invalidValueError);
 throw _makeInternalError(invalidValueError);
 }
 return beforeSendResult;
}
Expand Down

17 changes: 0 additions & 17 deletions
packages/core/src/integrations/eventFilters.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,19 +102,12 @@ function _mergeOptions(
 ...(internalOptions.disableErrorDefaults ? [] : DEFAULT_IGNORE_ERRORS),
 ],
 ignoreTransactions: [...(internalOptions.ignoreTransactions || []), ...(clientOptions.ignoreTransactions || [])],
 ignoreInternal: internalOptions.ignoreInternal !== undefined ? internalOptions.ignoreInternal : true,
 };
}

function _shouldDropEvent(event: Event, options: Partial<EventFiltersOptions>): boolean {
 if (!event.type) {
 // Filter errors

 if (options.ignoreInternal && _isSentryError(event)) {
 DEBUG_BUILD &&
 logger.warn(`Event dropped due to being internal Sentry Error.\nEvent: ${getEventDescription(event)}`);
 return true;
 }
 if (_isIgnoredError(event, options.ignoreErrors)) {
 DEBUG_BUILD &&
 logger.warn(
Expand DownExpand Up@@ -196,16 +189,6 @@ function _isAllowedUrl(event: Event, allowUrls?: Array<string | RegExp>): boolea
 return !url ? true : stringMatchesSomePattern(url, allowUrls);
}

function _isSentryError(event: Event): boolean {
 try {
 // @ts-expect-error can't be a sentry error if undefined
 return event.exception.values[0].type === 'SentryError';
 } catch (e) {
 // ignore
 }
 return false;
}

function _getLastValidUrl(frames: StackFrame[] = []): string | null {
 for (let i = frames.length - 1; i >= 0; i--) {
 const frame = frames[i];
Expand Down

5 changes: 4 additions & 1 deletion
packages/core/src/utils-hoist/error.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { ConsoleLevel } from '../types-hoist';

/** An error emitted by Sentry SDKs and related utilities. */
/**
 * An error emitted by Sentry SDKs and related utilities.
 * @deprecated This class is no longer used and will be removed in a future version. Use `Error` instead.
 */
export class SentryError extends Error {
 public logLevel: ConsoleLevel;

Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ export { applyAggregateErrorsToEvent } from './aggregate-errors';
export { getBreadcrumbLogLevelFromHttpStatusCode } from './breadcrumb-log-level';
export { getComponentName, getLocationHref, htmlTreeAsString } from './browser';
export { dsnFromString, dsnToString, makeDsn } from './dsn';
// eslint-disable-next-line deprecation/deprecation
export { SentryError } from './error';
export { GLOBAL_OBJ } from './worldwide';
export type { InternalGlobal } from './worldwide';
Expand Down

23 changes: 8 additions & 15 deletions
packages/core/test/lib/client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { afterEach, beforeEach, describe, expect, it, test, vi } from 'vitest';
import {
 Scope,
 SentryError,
 SyncPromise,
 addBreadcrumb,
 dsnToString,
Expand DownExpand Up@@ -533,7 +532,7 @@ describe('Client', () => {
 );
 });

 test('it adds a trace context to all events xxx', () => {
 test('it adds a trace context to all events', () => {
 expect.assertions(1);

 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
Expand DownExpand Up@@ -1206,7 +1205,7 @@ describe('Client', () => {
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSend });
 const client = new TestClient(options);
 const captureExceptionSpy = vi.spyOn(client, 'captureException');
 const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
 const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

 client.captureEvent({ message: 'hello' });

Expand All@@ -1215,7 +1214,7 @@ describe('Client', () => {
 // This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
 // error, but because `beforeSend` returned `null`
 expect(captureExceptionSpy).not.toBeCalled();
 expect(loggerWarnSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
 expect(loggerLogSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
 });

 test('calls `beforeSendTransaction` and discards the event', () => {
Expand All@@ -1225,7 +1224,7 @@ describe('Client', () => {
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
 const client = new TestClient(options);
 const captureExceptionSpy = vi.spyOn(client, 'captureException');
 const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
 const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

 client.captureEvent({ transaction: '/dogs/are/great', type: 'transaction' });

Expand All@@ -1234,7 +1233,7 @@ describe('Client', () => {
 // This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
 // error, but because `beforeSendTransaction` returned `null`
 expect(captureExceptionSpy).not.toBeCalled();
 expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
 expect(loggerLogSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
 });

 test('does not discard span and warn when returning null from `beforeSendSpan', () => {
Expand DownExpand Up@@ -1293,9 +1292,7 @@ describe('Client', () => {

 expect(beforeSend).toHaveBeenCalled();
 expect(TestClient.instance!.event).toBeUndefined();
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError('before send for type `error` must return `null` or a valid event.'),
 );
 expect(loggerWarnSpy).toBeCalledWith('before send for type `error` must return `null` or a valid event.');
 }
 });

Expand All@@ -1314,9 +1311,7 @@ describe('Client', () => {

 expect(beforeSendTransaction).toHaveBeenCalled();
 expect(TestClient.instance!.event).toBeUndefined();
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError('before send for type `transaction` must return `null` or a valid event.'),
 );
 expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` must return `null` or a valid event.');
 }
 });

Expand DownExpand Up@@ -1688,9 +1683,7 @@ describe('Client', () => {
 originalException: exception,
 });
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError(
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
 ),
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
 );
 });

Expand Down

27 changes: 0 additions & 27 deletions
packages/core/test/lib/integrations/eventFilters.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -311,17 +311,6 @@ const EVENT_WITH_VALUE: Event = {
 },
};

const SENTRY_EVENT: Event = {
 exception: {
 values: [
 {
 type: 'SentryError',
 value: 'something something server connection',
 },
 ],
 },
};

const SCRIPT_ERROR_EVENT: Event = {
 exception: {
 values: [
Expand DownExpand Up@@ -425,22 +414,6 @@ describe.each([
 ['InboundFilters', inboundFiltersIntegration],
 ['EventFilters', eventFiltersIntegration],
])('%s', (_, integrationFn) => {
 describe('_isSentryError', () => {
 it('should work as expected', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn);
 expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
 expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
 expect(eventProcessor(SENTRY_EVENT, {})).toBe(null);
 });

 it('should be configurable', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn, { ignoreInternal: false });
 expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
 expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
 expect(eventProcessor(SENTRY_EVENT, {})).toBe(SENTRY_EVENT);
 });
 });

 describe('ignoreErrors', () => {
 it('string filter with partial match', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn, {
Expand Down

11 changes: 0 additions & 11 deletions
packages/core/test/utils-hoist/is.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,16 +14,6 @@ import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../.
import { resolvedSyncPromise } from '../../src/utils-hoist/syncpromise';
import { testOnlyIfNodeVersionAtLeast } from './testutils';

class SentryError extends Error {
 public name: string;

 public constructor(public message: string) {
 super(message);
 this.name = new.target.prototype.constructor.name;
 Object.setPrototypeOf(this, new.target.prototype);
 }
}

if (supportsDOMError()) {
 describe('isDOMError()', () => {
 test('should work as advertised', () => {
Expand All@@ -47,7 +37,6 @@ describe('isError()', () => {
 test('should work as advertised', () => {
 expect(isError(new Error())).toEqual(true);
 expect(isError(new ReferenceError())).toEqual(true);
 expect(isError(new SentryError('message'))).toEqual(true);
 expect(isError({})).toEqual(false);
 expect(
 isError({
Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry/test/utils/mapStatus.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,7 @@ describe('mapStatus', () => {
 expect(actual).toEqual(expected);
 });

 it('works with string SEMATTRS_HTTP_STATUS_CODE xxx', () => {
 it('works with string SEMATTRS_HTTP_STATUS_CODE', () => {
 const span = createSpan('test-span');

 span.setStatus({ code: 0 }); // UNSET
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ref(core): Avoid using `SentryError` for event processing control flow by mydea · Pull Request #15823 · getsentry/sentry-javascript · GitHub
Skip to content
ref(core): Avoid using SentryError for event processing control flow#15823

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Mar 25, 2025
 Merged


ref(core): Avoid using SentryError for event processing control flow
#15823
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
604ed0d

ref(core): Avoid using `SentryError` for event processing control flow


mydea Mar 25, 2025
7d98cb6

fixes


mydea Mar 25, 2025
08a50f1

cleanup


mydea Mar 25, 2025
e0780f5

fix


mydea Mar 25, 2025

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


59 changes: 46 additions & 13 deletions
packages/core/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,6 @@ import {
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
import { SentryError } from './utils-hoist/error';
import { isParameterizedString, isPlainObject, isPrimitive, isThenable } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { checkOrSetAlreadyCaught, uuid4 } from './utils-hoist/misc';
Expand All@@ -69,6 +68,41 @@ import { _getSpanForScope } from './utils/spanOnScope';
const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';

const INTERNAL_ERROR_SYMBOL = Symbol.for('SentryInternalError');
const DO_NOT_SEND_EVENT_SYMBOL = Symbol.for('SentryDoNotSendEventError');

interface InternalError {
 message: string;
 [INTERNAL_ERROR_SYMBOL]: true;
}

interface DoNotSendEventError {
 message: string;
 [DO_NOT_SEND_EVENT_SYMBOL]: true;
}

function _makeInternalError(message: string): InternalError {
 return {
 message,
 [INTERNAL_ERROR_SYMBOL]: true,
 };
}

function _makeDoNotSendEventError(message: string): DoNotSendEventError {
 return {
 message,
 [DO_NOT_SEND_EVENT_SYMBOL]: true,
 };
}

function _isInternalError(error: unknown): error is InternalError {
 return !!error && typeof error === 'object' && INTERNAL_ERROR_SYMBOL in error;
}

function _isDoNotSendEventError(error: unknown): error is DoNotSendEventError {
 return !!error && typeof error === 'object' && DO_NOT_SEND_EVENT_SYMBOL in error;
}

/**
 * Base implementation for all JavaScript SDK clients.
 *
Expand DownExpand Up@@ -975,10 +1009,10 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 },
 reason => {
 if (DEBUG_BUILD) {
 // If something's gone wrong, log the error as a warning. If it's just us having used a `SentryError` for
 // control flow, log just the message (no stack) as a log-level log.
 if (reason instanceof SentryError && reason.logLevel === 'log') {
 if (_isDoNotSendEventError(reason)) {
 logger.log(reason.message);
 } else if (_isInternalError(reason)) {
 logger.warn(reason.message);
 } else {
 logger.warn(reason);
 }
Expand DownExpand Up@@ -1022,9 +1056,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 if (isError && typeof parsedSampleRate === 'number' && Math.random() > parsedSampleRate) {
 this.recordDroppedEvent('sample_rate', 'error');
 return rejectedSyncPromise(
new SentryError(
_makeDoNotSendEventError(
 `Discarding event because it's not included in the random sample (sampling rate = ${sampleRate})`,
 'log',
 ),
 );
 }
Expand All@@ -1035,7 +1068,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 .then(prepared => {
 if (prepared === null) {
 this.recordDroppedEvent('event_processor', dataCategory);
 throw new SentryError('An event processor returned `null`, will not send event.', 'log');
 throw _makeDoNotSendEventError('An event processor returned `null`, will not send event.');
 }

 const isInternalException = hint.data && (hint.data as { __sentry__: boolean }).__sentry__ === true;
Expand All@@ -1055,7 +1088,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 const spanCount = 1 + spans.length;
 this.recordDroppedEvent('before_send', 'span', spanCount);
 }
 throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
 throw _makeDoNotSendEventError(`${beforeSendLabel} returned \`null\`, will not send event.`);
 }

 const session = currentScope.getSession() || isolationScope.getSession();
Expand DownExpand Up@@ -1089,7 +1122,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 return processedEvent;
 })
 .then(null, reason => {
 if (reason instanceof SentryError) {
 if (_isDoNotSendEventError(reason) || _isInternalError(reason)) {
 throw reason;
 }

Expand All@@ -1099,7 +1132,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 },
 originalException: reason,
 });
 throw new SentryError(
 throw _makeInternalError(
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${reason}`,
 );
 });
Expand DownExpand Up@@ -1205,16 +1238,16 @@ function _validateBeforeSendResult(
 return beforeSendResult.then(
 event => {
 if (!isPlainObject(event) && event !== null) {
 throw new SentryError(invalidValueError);
 throw _makeInternalError(invalidValueError);
 }
 return event;
 },
 e => {
 throw new SentryError(`${beforeSendLabel} rejected with ${e}`);
 throw _makeInternalError(`${beforeSendLabel} rejected with ${e}`);
 },
 );
 } else if (!isPlainObject(beforeSendResult) && beforeSendResult !== null) {
 throw new SentryError(invalidValueError);
 throw _makeInternalError(invalidValueError);
 }
 return beforeSendResult;
}
Expand Down

17 changes: 0 additions & 17 deletions
packages/core/src/integrations/eventFilters.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,19 +102,12 @@ function _mergeOptions(
 ...(internalOptions.disableErrorDefaults ? [] : DEFAULT_IGNORE_ERRORS),
 ],
 ignoreTransactions: [...(internalOptions.ignoreTransactions || []), ...(clientOptions.ignoreTransactions || [])],
 ignoreInternal: internalOptions.ignoreInternal !== undefined ? internalOptions.ignoreInternal : true,
 };
}

function _shouldDropEvent(event: Event, options: Partial<EventFiltersOptions>): boolean {
 if (!event.type) {
 // Filter errors

 if (options.ignoreInternal && _isSentryError(event)) {
 DEBUG_BUILD &&
 logger.warn(`Event dropped due to being internal Sentry Error.\nEvent: ${getEventDescription(event)}`);
 return true;
 }
 if (_isIgnoredError(event, options.ignoreErrors)) {
 DEBUG_BUILD &&
 logger.warn(
Expand DownExpand Up@@ -196,16 +189,6 @@ function _isAllowedUrl(event: Event, allowUrls?: Array<string | RegExp>): boolea
 return !url ? true : stringMatchesSomePattern(url, allowUrls);
}

function _isSentryError(event: Event): boolean {
 try {
 // @ts-expect-error can't be a sentry error if undefined
 return event.exception.values[0].type === 'SentryError';
 } catch (e) {
 // ignore
 }
 return false;
}

function _getLastValidUrl(frames: StackFrame[] = []): string | null {
 for (let i = frames.length - 1; i >= 0; i--) {
 const frame = frames[i];
Expand Down

5 changes: 4 additions & 1 deletion
packages/core/src/utils-hoist/error.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { ConsoleLevel } from '../types-hoist';

/** An error emitted by Sentry SDKs and related utilities. */
/**
 * An error emitted by Sentry SDKs and related utilities.
 * @deprecated This class is no longer used and will be removed in a future version. Use `Error` instead.
 */
export class SentryError extends Error {
 public logLevel: ConsoleLevel;

Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ export { applyAggregateErrorsToEvent } from './aggregate-errors';
export { getBreadcrumbLogLevelFromHttpStatusCode } from './breadcrumb-log-level';
export { getComponentName, getLocationHref, htmlTreeAsString } from './browser';
export { dsnFromString, dsnToString, makeDsn } from './dsn';
// eslint-disable-next-line deprecation/deprecation
export { SentryError } from './error';
export { GLOBAL_OBJ } from './worldwide';
export type { InternalGlobal } from './worldwide';
Expand Down

23 changes: 8 additions & 15 deletions
packages/core/test/lib/client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { afterEach, beforeEach, describe, expect, it, test, vi } from 'vitest';
import {
 Scope,
 SentryError,
 SyncPromise,
 addBreadcrumb,
 dsnToString,
Expand DownExpand Up@@ -533,7 +532,7 @@ describe('Client', () => {
 );
 });

 test('it adds a trace context to all events xxx', () => {
 test('it adds a trace context to all events', () => {
 expect.assertions(1);

 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
Expand DownExpand Up@@ -1206,7 +1205,7 @@ describe('Client', () => {
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSend });
 const client = new TestClient(options);
 const captureExceptionSpy = vi.spyOn(client, 'captureException');
 const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
 const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

 client.captureEvent({ message: 'hello' });

Expand All@@ -1215,7 +1214,7 @@ describe('Client', () => {
 // This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
 // error, but because `beforeSend` returned `null`
 expect(captureExceptionSpy).not.toBeCalled();
 expect(loggerWarnSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
 expect(loggerLogSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
 });

 test('calls `beforeSendTransaction` and discards the event', () => {
Expand All@@ -1225,7 +1224,7 @@ describe('Client', () => {
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
 const client = new TestClient(options);
 const captureExceptionSpy = vi.spyOn(client, 'captureException');
 const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
 const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

 client.captureEvent({ transaction: '/dogs/are/great', type: 'transaction' });

Expand All@@ -1234,7 +1233,7 @@ describe('Client', () => {
 // This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
 // error, but because `beforeSendTransaction` returned `null`
 expect(captureExceptionSpy).not.toBeCalled();
 expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
 expect(loggerLogSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
 });

 test('does not discard span and warn when returning null from `beforeSendSpan', () => {
Expand DownExpand Up@@ -1293,9 +1292,7 @@ describe('Client', () => {

 expect(beforeSend).toHaveBeenCalled();
 expect(TestClient.instance!.event).toBeUndefined();
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError('before send for type `error` must return `null` or a valid event.'),
 );
 expect(loggerWarnSpy).toBeCalledWith('before send for type `error` must return `null` or a valid event.');
 }
 });

Expand All@@ -1314,9 +1311,7 @@ describe('Client', () => {

 expect(beforeSendTransaction).toHaveBeenCalled();
 expect(TestClient.instance!.event).toBeUndefined();
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError('before send for type `transaction` must return `null` or a valid event.'),
 );
 expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` must return `null` or a valid event.');
 }
 });

Expand DownExpand Up@@ -1688,9 +1683,7 @@ describe('Client', () => {
 originalException: exception,
 });
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError(
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
 ),
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
 );
 });

Expand Down

27 changes: 0 additions & 27 deletions
packages/core/test/lib/integrations/eventFilters.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -311,17 +311,6 @@ const EVENT_WITH_VALUE: Event = {
 },
};

const SENTRY_EVENT: Event = {
 exception: {
 values: [
 {
 type: 'SentryError',
 value: 'something something server connection',
 },
 ],
 },
};

const SCRIPT_ERROR_EVENT: Event = {
 exception: {
 values: [
Expand DownExpand Up@@ -425,22 +414,6 @@ describe.each([
 ['InboundFilters', inboundFiltersIntegration],
 ['EventFilters', eventFiltersIntegration],
])('%s', (_, integrationFn) => {
 describe('_isSentryError', () => {
 it('should work as expected', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn);
 expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
 expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
 expect(eventProcessor(SENTRY_EVENT, {})).toBe(null);
 });

 it('should be configurable', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn, { ignoreInternal: false });
 expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
 expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
 expect(eventProcessor(SENTRY_EVENT, {})).toBe(SENTRY_EVENT);
 });
 });

 describe('ignoreErrors', () => {
 it('string filter with partial match', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn, {
Expand Down

11 changes: 0 additions & 11 deletions
packages/core/test/utils-hoist/is.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,16 +14,6 @@ import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../.
import { resolvedSyncPromise } from '../../src/utils-hoist/syncpromise';
import { testOnlyIfNodeVersionAtLeast } from './testutils';

class SentryError extends Error {
 public name: string;

 public constructor(public message: string) {
 super(message);
 this.name = new.target.prototype.constructor.name;
 Object.setPrototypeOf(this, new.target.prototype);
 }
}

if (supportsDOMError()) {
 describe('isDOMError()', () => {
 test('should work as advertised', () => {
Expand All@@ -47,7 +37,6 @@ describe('isError()', () => {
 test('should work as advertised', () => {
 expect(isError(new Error())).toEqual(true);
 expect(isError(new ReferenceError())).toEqual(true);
 expect(isError(new SentryError('message'))).toEqual(true);
 expect(isError({})).toEqual(false);
 expect(
 isError({
Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry/test/utils/mapStatus.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,7 @@ describe('mapStatus', () => {
 expect(actual).toEqual(expected);
 });

 it('works with string SEMATTRS_HTTP_STATUS_CODE xxx', () => {
 it('works with string SEMATTRS_HTTP_STATUS_CODE', () => {
 const span = createSpan('test-span');

 span.setStatus({ code: 0 }); // UNSET
Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Mar 25, 2025
 Merged


ref(core): Avoid using SentryError for event processing control flow
#15823
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
604ed0d

ref(core): Avoid using `SentryError` for event processing control flow


mydea Mar 25, 2025
7d98cb6

fixes


mydea Mar 25, 2025
08a50f1

cleanup


mydea Mar 25, 2025
e0780f5

fix


mydea Mar 25, 2025

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


59 changes: 46 additions & 13 deletions
packages/core/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,6 @@ import {
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
import { SentryError } from './utils-hoist/error';
import { isParameterizedString, isPlainObject, isPrimitive, isThenable } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { checkOrSetAlreadyCaught, uuid4 } from './utils-hoist/misc';
Expand All@@ -69,6 +68,41 @@ import { _getSpanForScope } from './utils/spanOnScope';
const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';

const INTERNAL_ERROR_SYMBOL = Symbol.for('SentryInternalError');
const DO_NOT_SEND_EVENT_SYMBOL = Symbol.for('SentryDoNotSendEventError');

interface InternalError {
 message: string;
 [INTERNAL_ERROR_SYMBOL]: true;
}

interface DoNotSendEventError {
 message: string;
 [DO_NOT_SEND_EVENT_SYMBOL]: true;
}

function _makeInternalError(message: string): InternalError {
 return {
 message,
 [INTERNAL_ERROR_SYMBOL]: true,
 };
}

function _makeDoNotSendEventError(message: string): DoNotSendEventError {
 return {
 message,
 [DO_NOT_SEND_EVENT_SYMBOL]: true,
 };
}

function _isInternalError(error: unknown): error is InternalError {
 return !!error && typeof error === 'object' && INTERNAL_ERROR_SYMBOL in error;
}

function _isDoNotSendEventError(error: unknown): error is DoNotSendEventError {
 return !!error && typeof error === 'object' && DO_NOT_SEND_EVENT_SYMBOL in error;
}

/**
 * Base implementation for all JavaScript SDK clients.
 *
Expand DownExpand Up@@ -975,10 +1009,10 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 },
 reason => {
 if (DEBUG_BUILD) {
 // If something's gone wrong, log the error as a warning. If it's just us having used a `SentryError` for
 // control flow, log just the message (no stack) as a log-level log.
 if (reason instanceof SentryError && reason.logLevel === 'log') {
 if (_isDoNotSendEventError(reason)) {
 logger.log(reason.message);
 } else if (_isInternalError(reason)) {
 logger.warn(reason.message);
 } else {
 logger.warn(reason);
 }
Expand DownExpand Up@@ -1022,9 +1056,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 if (isError && typeof parsedSampleRate === 'number' && Math.random() > parsedSampleRate) {
 this.recordDroppedEvent('sample_rate', 'error');
 return rejectedSyncPromise(
new SentryError(
_makeDoNotSendEventError(
 `Discarding event because it's not included in the random sample (sampling rate = ${sampleRate})`,
 'log',
 ),
 );
 }
Expand All@@ -1035,7 +1068,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 .then(prepared => {
 if (prepared === null) {
 this.recordDroppedEvent('event_processor', dataCategory);
 throw new SentryError('An event processor returned `null`, will not send event.', 'log');
 throw _makeDoNotSendEventError('An event processor returned `null`, will not send event.');
 }

 const isInternalException = hint.data && (hint.data as { __sentry__: boolean }).__sentry__ === true;
Expand All@@ -1055,7 +1088,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 const spanCount = 1 + spans.length;
 this.recordDroppedEvent('before_send', 'span', spanCount);
 }
 throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
 throw _makeDoNotSendEventError(`${beforeSendLabel} returned \`null\`, will not send event.`);
 }

 const session = currentScope.getSession() || isolationScope.getSession();
Expand DownExpand Up@@ -1089,7 +1122,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 return processedEvent;
 })
 .then(null, reason => {
 if (reason instanceof SentryError) {
 if (_isDoNotSendEventError(reason) || _isInternalError(reason)) {
 throw reason;
 }

Expand All@@ -1099,7 +1132,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 },
 originalException: reason,
 });
 throw new SentryError(
 throw _makeInternalError(
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${reason}`,
 );
 });
Expand DownExpand Up@@ -1205,16 +1238,16 @@ function _validateBeforeSendResult(
 return beforeSendResult.then(
 event => {
 if (!isPlainObject(event) && event !== null) {
 throw new SentryError(invalidValueError);
 throw _makeInternalError(invalidValueError);
 }
 return event;
 },
 e => {
 throw new SentryError(`${beforeSendLabel} rejected with ${e}`);
 throw _makeInternalError(`${beforeSendLabel} rejected with ${e}`);
 },
 );
 } else if (!isPlainObject(beforeSendResult) && beforeSendResult !== null) {
 throw new SentryError(invalidValueError);
 throw _makeInternalError(invalidValueError);
 }
 return beforeSendResult;
}
Expand Down

17 changes: 0 additions & 17 deletions
packages/core/src/integrations/eventFilters.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,19 +102,12 @@ function _mergeOptions(
 ...(internalOptions.disableErrorDefaults ? [] : DEFAULT_IGNORE_ERRORS),
 ],
 ignoreTransactions: [...(internalOptions.ignoreTransactions || []), ...(clientOptions.ignoreTransactions || [])],
 ignoreInternal: internalOptions.ignoreInternal !== undefined ? internalOptions.ignoreInternal : true,
 };
}

function _shouldDropEvent(event: Event, options: Partial<EventFiltersOptions>): boolean {
 if (!event.type) {
 // Filter errors

 if (options.ignoreInternal && _isSentryError(event)) {
 DEBUG_BUILD &&
 logger.warn(`Event dropped due to being internal Sentry Error.\nEvent: ${getEventDescription(event)}`);
 return true;
 }
 if (_isIgnoredError(event, options.ignoreErrors)) {
 DEBUG_BUILD &&
 logger.warn(
Expand DownExpand Up@@ -196,16 +189,6 @@ function _isAllowedUrl(event: Event, allowUrls?: Array<string | RegExp>): boolea
 return !url ? true : stringMatchesSomePattern(url, allowUrls);
}

function _isSentryError(event: Event): boolean {
 try {
 // @ts-expect-error can't be a sentry error if undefined
 return event.exception.values[0].type === 'SentryError';
 } catch (e) {
 // ignore
 }
 return false;
}

function _getLastValidUrl(frames: StackFrame[] = []): string | null {
 for (let i = frames.length - 1; i >= 0; i--) {
 const frame = frames[i];
Expand Down

5 changes: 4 additions & 1 deletion
packages/core/src/utils-hoist/error.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { ConsoleLevel } from '../types-hoist';

/** An error emitted by Sentry SDKs and related utilities. */
/**
 * An error emitted by Sentry SDKs and related utilities.
 * @deprecated This class is no longer used and will be removed in a future version. Use `Error` instead.
 */
export class SentryError extends Error {
 public logLevel: ConsoleLevel;

Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ export { applyAggregateErrorsToEvent } from './aggregate-errors';
export { getBreadcrumbLogLevelFromHttpStatusCode } from './breadcrumb-log-level';
export { getComponentName, getLocationHref, htmlTreeAsString } from './browser';
export { dsnFromString, dsnToString, makeDsn } from './dsn';
// eslint-disable-next-line deprecation/deprecation
export { SentryError } from './error';
export { GLOBAL_OBJ } from './worldwide';
export type { InternalGlobal } from './worldwide';
Expand Down

23 changes: 8 additions & 15 deletions
packages/core/test/lib/client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { afterEach, beforeEach, describe, expect, it, test, vi } from 'vitest';
import {
 Scope,
 SentryError,
 SyncPromise,
 addBreadcrumb,
 dsnToString,
Expand DownExpand Up@@ -533,7 +532,7 @@ describe('Client', () => {
 );
 });

 test('it adds a trace context to all events xxx', () => {
 test('it adds a trace context to all events', () => {
 expect.assertions(1);

 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
Expand DownExpand Up@@ -1206,7 +1205,7 @@ describe('Client', () => {
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSend });
 const client = new TestClient(options);
 const captureExceptionSpy = vi.spyOn(client, 'captureException');
 const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
 const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

 client.captureEvent({ message: 'hello' });

Expand All@@ -1215,7 +1214,7 @@ describe('Client', () => {
 // This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
 // error, but because `beforeSend` returned `null`
 expect(captureExceptionSpy).not.toBeCalled();
 expect(loggerWarnSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
 expect(loggerLogSpy).toBeCalledWith('before send for type `error` returned `null`, will not send event.');
 });

 test('calls `beforeSendTransaction` and discards the event', () => {
Expand All@@ -1225,7 +1224,7 @@ describe('Client', () => {
 const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, beforeSendTransaction });
 const client = new TestClient(options);
 const captureExceptionSpy = vi.spyOn(client, 'captureException');
 const loggerWarnSpy = vi.spyOn(loggerModule.logger, 'log');
 const loggerLogSpy = vi.spyOn(loggerModule.logger, 'log');

 client.captureEvent({ transaction: '/dogs/are/great', type: 'transaction' });

Expand All@@ -1234,7 +1233,7 @@ describe('Client', () => {
 // This proves that the reason the event didn't send/didn't get set on the test client is not because there was an
 // error, but because `beforeSendTransaction` returned `null`
 expect(captureExceptionSpy).not.toBeCalled();
 expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
 expect(loggerLogSpy).toBeCalledWith('before send for type `transaction` returned `null`, will not send event.');
 });

 test('does not discard span and warn when returning null from `beforeSendSpan', () => {
Expand DownExpand Up@@ -1293,9 +1292,7 @@ describe('Client', () => {

 expect(beforeSend).toHaveBeenCalled();
 expect(TestClient.instance!.event).toBeUndefined();
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError('before send for type `error` must return `null` or a valid event.'),
 );
 expect(loggerWarnSpy).toBeCalledWith('before send for type `error` must return `null` or a valid event.');
 }
 });

Expand All@@ -1314,9 +1311,7 @@ describe('Client', () => {

 expect(beforeSendTransaction).toHaveBeenCalled();
 expect(TestClient.instance!.event).toBeUndefined();
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError('before send for type `transaction` must return `null` or a valid event.'),
 );
 expect(loggerWarnSpy).toBeCalledWith('before send for type `transaction` must return `null` or a valid event.');
 }
 });

Expand DownExpand Up@@ -1688,9 +1683,7 @@ describe('Client', () => {
 originalException: exception,
 });
 expect(loggerWarnSpy).toBeCalledWith(
 new SentryError(
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
 ),
 `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${exception}`,
 );
 });

Expand Down

27 changes: 0 additions & 27 deletions
packages/core/test/lib/integrations/eventFilters.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -311,17 +311,6 @@ const EVENT_WITH_VALUE: Event = {
 },
};

const SENTRY_EVENT: Event = {
 exception: {
 values: [
 {
 type: 'SentryError',
 value: 'something something server connection',
 },
 ],
 },
};

const SCRIPT_ERROR_EVENT: Event = {
 exception: {
 values: [
Expand DownExpand Up@@ -425,22 +414,6 @@ describe.each([
 ['InboundFilters', inboundFiltersIntegration],
 ['EventFilters', eventFiltersIntegration],
])('%s', (_, integrationFn) => {
 describe('_isSentryError', () => {
 it('should work as expected', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn);
 expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
 expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
 expect(eventProcessor(SENTRY_EVENT, {})).toBe(null);
 });

 it('should be configurable', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn, { ignoreInternal: false });
 expect(eventProcessor(MESSAGE_EVENT, {})).toBe(MESSAGE_EVENT);
 expect(eventProcessor(EXCEPTION_EVENT, {})).toBe(EXCEPTION_EVENT);
 expect(eventProcessor(SENTRY_EVENT, {})).toBe(SENTRY_EVENT);
 });
 });

 describe('ignoreErrors', () => {
 it('string filter with partial match', () => {
 const eventProcessor = createEventFiltersEventProcessor(integrationFn, {
Expand Down

11 changes: 0 additions & 11 deletions
packages/core/test/utils-hoist/is.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,16 +14,6 @@ import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../.
import { resolvedSyncPromise } from '../../src/utils-hoist/syncpromise';
import { testOnlyIfNodeVersionAtLeast } from './testutils';

class SentryError extends Error {
 public name: string;

 public constructor(public message: string) {
 super(message);
 this.name = new.target.prototype.constructor.name;
 Object.setPrototypeOf(this, new.target.prototype);
 }
}

if (supportsDOMError()) {
 describe('isDOMError()', () => {
 test('should work as advertised', () => {
Expand All@@ -47,7 +37,6 @@ describe('isError()', () => {
 test('should work as advertised', () => {
 expect(isError(new Error())).toEqual(true);
 expect(isError(new ReferenceError())).toEqual(true);
 expect(isError(new SentryError('message'))).toEqual(true);
 expect(isError({})).toEqual(false);
 expect(
 isError({
Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry/test/utils/mapStatus.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,7 @@ describe('mapStatus', () => {
 expect(actual).toEqual(expected);
 });

 it('works with string SEMATTRS_HTTP_STATUS_CODE xxx', () => {
 it('works with string SEMATTRS_HTTP_STATUS_CODE', () => {
 const span = createSpan('test-span');

 span.setStatus({ code: 0 }); // UNSET
Expand Down