feat(core): Allow to pass mechanism as event hint#9590

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 3 commits into from
Nov 22, 2023
Merged

feat(core): Allow to pass mechanism as event hint #9590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
14cd0a1
feat(core): Allow to pass `mechanism` as event hint
mydea Nov 15, 2023
286d1fb
ref: make type exlusive
mydea Nov 17, 2023
cafd258
small wording fix
mydea Nov 22, 2023
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
17 changes: 4 additions & 13 deletions packages/angular/src/errorhandler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import { HttpErrorResponse } from '@angular/common/http';
import type { ErrorHandler as AngularErrorHandler } from '@angular/core';
import { Inject, Injectable } from '@angular/core';
import * as Sentry from '@sentry/browser';
import type { Event, Scope } from '@sentry/types';
import { addExceptionMechanism, isString } from '@sentry/utils';
import type { Event } from '@sentry/types';
import { isString } from '@sentry/utils';

import { runOutsideAngular } from './zone';

Expand DownExpand Up@@ -102,17 +102,8 @@ class SentryErrorHandler implements AngularErrorHandler {

// Capture handled exception and send it to Sentry.
const eventId = runOutsideAngular(() =>
Sentry.captureException(extractedError, (scope: Scope) => {
scope.addEventProcessor(event => {
addExceptionMechanism(event, {
type: 'angular',
handled: false,
});

return event;
});

return scope;
Sentry.captureException(extractedError, {
mechanism: { type: 'angular', handled: false },
}),
);

Expand Down
113 changes: 43 additions & 70 deletions packages/angular/test/errorhandler.test.ts
View file
Open in desktop

Large diffs are not rendered by default.

23 changes: 9 additions & 14 deletions packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, configureScope, getCurrentHub, startSpan } from '@sentry/node';
import type { Hub, Span } from '@sentry/types';
import { addExceptionMechanism, objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import { objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import type { APIContext, MiddlewareResponseHandler } from 'astro';

import { getTracingMetaTags } from './meta';
Expand DownExpand Up@@ -34,19 +34,14 @@ function sendErrorToSentry(e: unknown): unknown {
// store a seen flag on it.
const objectifiedErr = objectify(e);

captureException(objectifiedErr, scope => {
scope.addEventProcessor(event => {
addExceptionMechanism(event, {
type: 'astro',
handled: false,
data: {
function: 'astroMiddleware',
},
});
return event;
});

return scope;
captureException(objectifiedErr, {
mechanism: {
type: 'astro',
handled: false,
data: {
function: 'astroMiddleware',
},
},
});

return objectifiedErr;
Expand Down
21 changes: 4 additions & 17 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import * as SentryNode from '@sentry/node';
import * as SentryUtils from '@sentry/utils';
import { vi } from 'vitest';

import { handleRequest, interpolateRouteFromUrlAndParams } from '../../src/server/middleware';
Expand DownExpand Up@@ -59,12 +58,7 @@ describe('sentryMiddleware', () => {
});

it('throws and sends an error to sentry if `next()` throws', async () => {
const scope = {
addEventProcessor: vi.fn().mockImplementation(cb => cb({})),
};
// @ts-expect-error, just testing the callback, this is okay for this test
const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException').mockImplementation((ex, cb) => cb(scope));
const addExMechanismSpy = vi.spyOn(SentryUtils, 'addExceptionMechanism');
const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException');

const middleware = handleRequest();
const ctx = {
Expand All@@ -86,16 +80,9 @@ describe('sentryMiddleware', () => {
// @ts-expect-error, a partial ctx object is fine here
await expect(async () => middleware(ctx, next)).rejects.toThrowError();

expect(captureExceptionSpy).toHaveBeenCalledWith(error, expect.any(Function));
expect(scope.addEventProcessor).toHaveBeenCalledTimes(1);
expect(addExMechanismSpy).toHaveBeenCalledWith(
{}, // the mocked event
{
handled: false,
type: 'astro',
data: { function: 'astroMiddleware' },
},
);
expect(captureExceptionSpy).toHaveBeenCalledWith(error, {
mechanism: { handled: false, type: 'astro', data: { function: 'astroMiddleware' } },
});
});

it('attaches tracing headers', async () => {
Expand Down
6 changes: 3 additions & 3 deletions packages/browser/src/helpers.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { captureException, withScope } from '@sentry/core';
import type { DsnLike, Event as SentryEvent, Mechanism, Scope, WrappedFunction } from '@sentry/types';
import type { DsnLike, Mechanism, WrappedFunction } from '@sentry/types';
import {
addExceptionMechanism,
addExceptionTypeValue,
Expand DownExpand Up@@ -99,8 +99,8 @@ export function wrap(
} catch (ex) {
ignoreNextOnError();

withScope((scope: Scope) => {
scope.addEventProcessor((event: SentryEvent) => {
withScope(scope => {
scope.addEventProcessor(event => {
if (options.mechanism) {
addExceptionTypeValue(event, undefined, undefined);
addExceptionMechanism(event, options.mechanism);
Expand Down
39 changes: 17 additions & 22 deletions packages/browser/src/integrations/globalhandlers.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { getCurrentHub } from '@sentry/core';
import type { Event, EventHint, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import {
addExceptionMechanism,
addInstrumentationHandler,
getLocationHref,
isErrorEvent,
isPrimitive,
isString,
logger,
} from '@sentry/utils';
import type { Event, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import { addInstrumentationHandler, getLocationHref, isErrorEvent, isPrimitive, isString, logger } from '@sentry/utils';

import type { BrowserClient } from '../client';
import { eventFromUnknownInput } from '../eventbuilder';
Expand DownExpand Up@@ -103,7 +95,13 @@ function _installGlobalOnErrorHandler(): void {

event.level = 'error';

addMechanismAndCapture(hub, error, event, 'onerror');
hub.captureEvent(event, {
originalException: error,
mechanism: {
handled: false,
type: 'onerror',
},
});
},
);
}
Expand DownExpand Up@@ -149,7 +147,14 @@ function _installGlobalOnUnhandledRejectionHandler(): void {

event.level = 'error';

addMechanismAndCapture(hub, error, event, 'onunhandledrejection');
hub.captureEvent(event, {
originalException: error,
mechanism: {
handled: false,
type: 'onunhandledrejection',
},
});

return;
},
);
Expand DownExpand Up@@ -243,16 +248,6 @@ function globalHandlerLog(type: string): void {
__DEBUG_BUILD__ && logger.log(`Global Handler attached: ${type}`);
}

function addMechanismAndCapture(hub: Hub, error: EventHint['originalException'], event: Event, type: string): void {
addExceptionMechanism(event, {
handled: false,
type,
});
hub.captureEvent(event, {
originalException: error,
});
}

function getHubAndOptions(): [Hub, StackParser, boolean | undefined] {
const hub = getCurrentHub();
const client = hub.getClient<BrowserClient>();
Expand Down
31 changes: 10 additions & 21 deletions packages/bun/src/integrations/bunserver.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,6 @@
import { captureException, continueTrace, runWithAsyncContext, startSpan, Transaction } from '@sentry/core';
import type { Integration } from '@sentry/types';
import { addExceptionMechanism, getSanitizedUrlString, parseUrl } from '@sentry/utils';

function sendErrorToSentry(e: unknown): unknown {
captureException(e, scope => {
scope.addEventProcessor(event => {
addExceptionMechanism(event, {
type: 'bun',
handled: false,
data: {
function: 'serve',
},
});
return event;
});

return scope;
});

return e;
}
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

/**
* Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand DownExpand Up@@ -115,7 +96,15 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
}
return response;
} catch (e) {
sendErrorToSentry(e);
captureException(e, {
mechanism: {
type: 'bun',
handled: false,
data: {
function: 'serve',
},
},
});
throw e;
}
},
Expand Down
17 changes: 10 additions & 7 deletions packages/core/src/exports.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ import { isThenable, logger, timestampInSeconds, uuid4 } from '@sentry/utils';
import type { Hub } from './hub';
import { getCurrentHub } from './hub';
import type { Scope } from './scope';
import type { ExclusiveEventHintOrCaptureContext } from './utils/prepareEvent';
import { parseEventHintOrCaptureContext } from './utils/prepareEvent';

// Note: All functions in this file are typed with a return value of `ReturnType<Hub[HUB_FUNCTION]>`,
// where HUB_FUNCTION is some method on the Hub class.
Expand All@@ -30,14 +32,15 @@ import type { Scope } from './scope';

/**
* Captures an exception event and sends it to Sentry.
*
* @param exception An exception-like object.
* @param captureContext Additional scope data to apply to exception event.
* @returns The generated eventId.
* This accepts an event hint as optional second parameter.
* Alternatively, you can also pass a CaptureContext directly as second parameter.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
export function captureException(exception: any, captureContext?: CaptureContext): ReturnType<Hub['captureException']> {
return getCurrentHub().captureException(exception, { captureContext });
export function captureException(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
exception: any,
hint?: ExclusiveEventHintOrCaptureContext,
): ReturnType<Hub['captureException']> {
return getCurrentHub().captureException(exception, parseEventHintOrCaptureContext(hint));
}

/**
Expand Down
82 changes: 80 additions & 2 deletions packages/core/src/utils/prepareEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,37 @@
import type { Client, ClientOptions, Event, EventHint, StackFrame, StackParser } from '@sentry/types';
import { dateTimestampInSeconds, GLOBAL_OBJ, normalize, resolvedSyncPromise, truncate, uuid4 } from '@sentry/utils';
import type {
CaptureContext,
Client,
ClientOptions,
Event,
EventHint,
Scope as ScopeInterface,
ScopeContext,
StackFrame,
StackParser,
} from '@sentry/types';
import {
addExceptionMechanism,
dateTimestampInSeconds,
GLOBAL_OBJ,
normalize,
resolvedSyncPromise,
truncate,
uuid4,
} from '@sentry/utils';

import { DEFAULT_ENVIRONMENT } from '../constants';
import { getGlobalEventProcessors, notifyEventProcessors } from '../eventProcessors';
import { Scope } from '../scope';

/**
* This type makes sure that we get either a CaptureContext, OR an EventHint.
* It does not allow mixing them, which could lead to unexpected outcomes, e.g. this is disallowed:
* { user: { id: '123' }, mechanism: { handled: false } }
*/
export type ExclusiveEventHintOrCaptureContext =
| (CaptureContext & Partial<{ [key in keyof EventHint]: never }>)
| (EventHint & Partial<{ [key in keyof ScopeContext]: never }>);

/**
* Adds common information to events.
*
Expand DownExpand Up@@ -52,6 +79,10 @@ export function prepareEvent(
finalScope = Scope.clone(finalScope).update(hint.captureContext);
}

if (hint.mechanism) {
addExceptionMechanism(prepared, hint.mechanism);
}

// We prepare the result here with a resolved Event.
let result = resolvedSyncPromise<Event | null>(prepared);

Expand DownExpand Up@@ -309,3 +340,50 @@ function normalizeEvent(event: Event | null, depth: number, maxBreadth: number):

return normalized;
}

/**
* Parse either an `EventHint` directly, or convert a `CaptureContext` to an `EventHint`.
* This is used to allow to update method signatures that used to accept a `CaptureContext` but should now accept an `EventHint`.
*/
export function parseEventHintOrCaptureContext(
hint: ExclusiveEventHintOrCaptureContext | undefined,
): EventHint | undefined {
if (!hint) {
return undefined;
}

// If you pass a Scope or `() => Scope` as CaptureContext, we just return this as captureContext
if (hintIsScopeOrFunction(hint)) {
return { captureContext: hint };
}

if (hintIsScopeContext(hint)) {
return {
captureContext: hint,
};
}

return hint;
}

function hintIsScopeOrFunction(
hint: CaptureContext | EventHint,
): hint is ScopeInterface | ((scope: ScopeInterface) => ScopeInterface) {
return hint instanceof Scope || typeof hint === 'function';
}

type ScopeContextProperty = keyof ScopeContext;
const captureContextKeys: readonly ScopeContextProperty[] = [
'user',
'level',
'extra',
'contexts',
'tags',
'fingerprint',
'requestSession',
'propagationContext',
] as const;

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

Skip to content
feat(core): Allow to pass mechanism as event hint#9590

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 3 commits into

from

Nov 22, 2023
 Merged


feat(core): Allow to pass mechanism as event hint
#9590
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
14cd0a1

feat(core): Allow to pass `mechanism` as event hint


mydea Nov 15, 2023
286d1fb

ref: make type exlusive


mydea Nov 17, 2023
cafd258

small wording fix


mydea Nov 22, 2023

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


17 changes: 4 additions & 13 deletions
packages/angular/src/errorhandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import { HttpErrorResponse } from '@angular/common/http';
import type { ErrorHandler as AngularErrorHandler } from '@angular/core';
import { Inject, Injectable } from '@angular/core';
import * as Sentry from '@sentry/browser';
import type { Event, Scope } from '@sentry/types';
import { addExceptionMechanism, isString } from '@sentry/utils';
import type { Event } from '@sentry/types';
import { isString } from '@sentry/utils';

import { runOutsideAngular } from './zone';

Expand DownExpand Up@@ -102,17 +102,8 @@ class SentryErrorHandler implements AngularErrorHandler {

 // Capture handled exception and send it to Sentry.
 const eventId = runOutsideAngular(() =>
 Sentry.captureException(extractedError, (scope: Scope) => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'angular',
 handled: false,
 });

 return event;
 });

 return scope;
 Sentry.captureException(extractedError, {
 mechanism: { type: 'angular', handled: false },
 }),
 );

Expand Down

113 changes: 43 additions & 70 deletions
packages/angular/test/errorhandler.test.ts

View file


Open in desktop


Large diffs are not rendered by default.


23 changes: 9 additions & 14 deletions
packages/astro/src/server/middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, configureScope, getCurrentHub, startSpan } from '@sentry/node';
import type { Hub, Span } from '@sentry/types';
import { addExceptionMechanism, objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import { objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import type { APIContext, MiddlewareResponseHandler } from 'astro';

import { getTracingMetaTags } from './meta';
Expand DownExpand Up@@ -34,19 +34,14 @@ function sendErrorToSentry(e: unknown): unknown {
 // store a seen flag on it.
 const objectifiedErr = objectify(e);

 captureException(objectifiedErr, scope => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'astro',
 handled: false,
 data: {
 function: 'astroMiddleware',
 },
 });
 return event;
 });

 return scope;
 captureException(objectifiedErr, {
 mechanism: {
 type: 'astro',
 handled: false,
 data: {
 function: 'astroMiddleware',
 },
 },
 });

 return objectifiedErr;
Expand Down

21 changes: 4 additions & 17 deletions
packages/astro/test/server/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import * as SentryNode from '@sentry/node';
import * as SentryUtils from '@sentry/utils';
import { vi } from 'vitest';

import { handleRequest, interpolateRouteFromUrlAndParams } from '../../src/server/middleware';
Expand DownExpand Up@@ -59,12 +58,7 @@ describe('sentryMiddleware', () => {
 });

 it('throws and sends an error to sentry if `next()` throws', async () => {
 const scope = {
 addEventProcessor: vi.fn().mockImplementation(cb => cb({})),
 };
 // @ts-expect-error, just testing the callback, this is okay for this test
 const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException').mockImplementation((ex, cb) => cb(scope));
 const addExMechanismSpy = vi.spyOn(SentryUtils, 'addExceptionMechanism');
 const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException');

 const middleware = handleRequest();
 const ctx = {
Expand All@@ -86,16 +80,9 @@ describe('sentryMiddleware', () => {
 // @ts-expect-error, a partial ctx object is fine here
 await expect(async () => middleware(ctx, next)).rejects.toThrowError();

 expect(captureExceptionSpy).toHaveBeenCalledWith(error, expect.any(Function));
 expect(scope.addEventProcessor).toHaveBeenCalledTimes(1);
 expect(addExMechanismSpy).toHaveBeenCalledWith(
 {}, // the mocked event
 {
 handled: false,
 type: 'astro',
 data: { function: 'astroMiddleware' },
 },
 );
 expect(captureExceptionSpy).toHaveBeenCalledWith(error, {
 mechanism: { handled: false, type: 'astro', data: { function: 'astroMiddleware' } },
 });
 });

 it('attaches tracing headers', async () => {
Expand Down

6 changes: 3 additions & 3 deletions
packages/browser/src/helpers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { captureException, withScope } from '@sentry/core';
import type { DsnLike, Event as SentryEvent, Mechanism, Scope, WrappedFunction } from '@sentry/types';
import type { DsnLike, Mechanism, WrappedFunction } from '@sentry/types';
import {
 addExceptionMechanism,
 addExceptionTypeValue,
Expand DownExpand Up@@ -99,8 +99,8 @@ export function wrap(
 } catch (ex) {
 ignoreNextOnError();

 withScope((scope: Scope) => {
 scope.addEventProcessor((event: SentryEvent) => {
 withScope(scope => {
 scope.addEventProcessor(event => {
 if (options.mechanism) {
 addExceptionTypeValue(event, undefined, undefined);
 addExceptionMechanism(event, options.mechanism);
Expand Down

39 changes: 17 additions & 22 deletions
packages/browser/src/integrations/globalhandlers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { getCurrentHub } from '@sentry/core';
import type { Event, EventHint, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import {
 addExceptionMechanism,
 addInstrumentationHandler,
 getLocationHref,
 isErrorEvent,
 isPrimitive,
 isString,
 logger,
} from '@sentry/utils';
import type { Event, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import { addInstrumentationHandler, getLocationHref, isErrorEvent, isPrimitive, isString, logger } from '@sentry/utils';

import type { BrowserClient } from '../client';
import { eventFromUnknownInput } from '../eventbuilder';
Expand DownExpand Up@@ -103,7 +95,13 @@ function _installGlobalOnErrorHandler(): void {

 event.level = 'error';

 addMechanismAndCapture(hub, error, event, 'onerror');
 hub.captureEvent(event, {
 originalException: error,
 mechanism: {
 handled: false,
 type: 'onerror',
 },
 });
 },
 );
}
Expand DownExpand Up@@ -149,7 +147,14 @@ function _installGlobalOnUnhandledRejectionHandler(): void {

 event.level = 'error';

 addMechanismAndCapture(hub, error, event, 'onunhandledrejection');
 hub.captureEvent(event, {
 originalException: error,
 mechanism: {
 handled: false,
 type: 'onunhandledrejection',
 },
 });

 return;
 },
 );
Expand DownExpand Up@@ -243,16 +248,6 @@ function globalHandlerLog(type: string): void {
 __DEBUG_BUILD__ && logger.log(`Global Handler attached: ${type}`);
}

function addMechanismAndCapture(hub: Hub, error: EventHint['originalException'], event: Event, type: string): void {
 addExceptionMechanism(event, {
 handled: false,
 type,
 });
 hub.captureEvent(event, {
 originalException: error,
 });
}

function getHubAndOptions(): [Hub, StackParser, boolean | undefined] {
 const hub = getCurrentHub();
 const client = hub.getClient<BrowserClient>();
Expand Down

31 changes: 10 additions & 21 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,25 +1,6 @@
import { captureException, continueTrace, runWithAsyncContext, startSpan, Transaction } from '@sentry/core';
import type { Integration } from '@sentry/types';
import { addExceptionMechanism, getSanitizedUrlString, parseUrl } from '@sentry/utils';

function sendErrorToSentry(e: unknown): unknown {
 captureException(e, scope => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 });
 return event;
 });

 return scope;
 });

 return e;
}
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand DownExpand Up@@ -115,7 +96,15 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
 }
 return response;
 } catch (e) {
 sendErrorToSentry(e);
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
Expand Down

17 changes: 10 additions & 7 deletions
packages/core/src/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ import { isThenable, logger, timestampInSeconds, uuid4 } from '@sentry/utils';
import type { Hub } from './hub';
import { getCurrentHub } from './hub';
import type { Scope } from './scope';
import type { ExclusiveEventHintOrCaptureContext } from './utils/prepareEvent';
import { parseEventHintOrCaptureContext } from './utils/prepareEvent';

// Note: All functions in this file are typed with a return value of `ReturnType<Hub[HUB_FUNCTION]>`,
// where HUB_FUNCTION is some method on the Hub class.
Expand All@@ -30,14 +32,15 @@ import type { Scope } from './scope';

/**
 * Captures an exception event and sends it to Sentry.
 *
 * @param exception An exception-like object.
 * @param captureContext Additional scope data to apply to exception event.
 * @returns The generated eventId.
 * This accepts an event hint as optional second parameter.
 * Alternatively, you can also pass a CaptureContext directly as second parameter.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
export function captureException(exception: any, captureContext?: CaptureContext): ReturnType<Hub['captureException']> {
 return getCurrentHub().captureException(exception, { captureContext });
export function captureException(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exception: any,
 hint?: ExclusiveEventHintOrCaptureContext,
): ReturnType<Hub['captureException']> {
 return getCurrentHub().captureException(exception, parseEventHintOrCaptureContext(hint));
}

/**
Expand Down

82 changes: 80 additions & 2 deletions
packages/core/src/utils/prepareEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,37 @@
import type { Client, ClientOptions, Event, EventHint, StackFrame, StackParser } from '@sentry/types';
import { dateTimestampInSeconds, GLOBAL_OBJ, normalize, resolvedSyncPromise, truncate, uuid4 } from '@sentry/utils';
import type {
 CaptureContext,
 Client,
 ClientOptions,
 Event,
 EventHint,
 Scope as ScopeInterface,
 ScopeContext,
 StackFrame,
 StackParser,
} from '@sentry/types';
import {
 addExceptionMechanism,
 dateTimestampInSeconds,
 GLOBAL_OBJ,
 normalize,
 resolvedSyncPromise,
 truncate,
 uuid4,
} from '@sentry/utils';

import { DEFAULT_ENVIRONMENT } from '../constants';
import { getGlobalEventProcessors, notifyEventProcessors } from '../eventProcessors';
import { Scope } from '../scope';

/**
 * This type makes sure that we get either a CaptureContext, OR an EventHint.
 * It does not allow mixing them, which could lead to unexpected outcomes, e.g. this is disallowed:
 * { user: { id: '123' }, mechanism: { handled: false } }
 */
export type ExclusiveEventHintOrCaptureContext =
 | (CaptureContext & Partial<{ [key in keyof EventHint]: never }>)
 | (EventHint & Partial<{ [key in keyof ScopeContext]: never }>);

/**
 * Adds common information to events.
 *
Expand DownExpand Up@@ -52,6 +79,10 @@ export function prepareEvent(
 finalScope = Scope.clone(finalScope).update(hint.captureContext);
 }

 if (hint.mechanism) {
 addExceptionMechanism(prepared, hint.mechanism);
 }

 // We prepare the result here with a resolved Event.
 let result = resolvedSyncPromise<Event | null>(prepared);

Expand DownExpand Up@@ -309,3 +340,50 @@ function normalizeEvent(event: Event | null, depth: number, maxBreadth: number):

 return normalized;
}

/**
 * Parse either an `EventHint` directly, or convert a `CaptureContext` to an `EventHint`.
 * This is used to allow to update method signatures that used to accept a `CaptureContext` but should now accept an `EventHint`.
 */
export function parseEventHintOrCaptureContext(
 hint: ExclusiveEventHintOrCaptureContext | undefined,
): EventHint | undefined {
 if (!hint) {
 return undefined;
 }

 // If you pass a Scope or `() => Scope` as CaptureContext, we just return this as captureContext
 if (hintIsScopeOrFunction(hint)) {
 return { captureContext: hint };
 }

 if (hintIsScopeContext(hint)) {
 return {
 captureContext: hint,
 };
 }

 return hint;
}

function hintIsScopeOrFunction(
 hint: CaptureContext | EventHint,
): hint is ScopeInterface | ((scope: ScopeInterface) => ScopeInterface) {
 return hint instanceof Scope || typeof hint === 'function';
}

type ScopeContextProperty = keyof ScopeContext;
const captureContextKeys: readonly ScopeContextProperty[] = [
 'user',
 'level',
 'extra',
 'contexts',
 'tags',
 'fingerprint',
 'requestSession',
 'propagationContext',
] as const;

function hintIsScopeContext(hint: Partial<ScopeContext> | EventHint): hint is Partial<ScopeContext> {
 return Object.keys(hint).some(key => captureContextKeys.includes(key as ScopeContextProperty));
}
Loading

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

Skip to content
feat(core): Allow to pass mechanism as event hint#9590

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 3 commits into

from

Nov 22, 2023
 Merged


feat(core): Allow to pass mechanism as event hint
#9590
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
14cd0a1

feat(core): Allow to pass `mechanism` as event hint


mydea Nov 15, 2023
286d1fb

ref: make type exlusive


mydea Nov 17, 2023
cafd258

small wording fix


mydea Nov 22, 2023

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


17 changes: 4 additions & 13 deletions
packages/angular/src/errorhandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import { HttpErrorResponse } from '@angular/common/http';
import type { ErrorHandler as AngularErrorHandler } from '@angular/core';
import { Inject, Injectable } from '@angular/core';
import * as Sentry from '@sentry/browser';
import type { Event, Scope } from '@sentry/types';
import { addExceptionMechanism, isString } from '@sentry/utils';
import type { Event } from '@sentry/types';
import { isString } from '@sentry/utils';

import { runOutsideAngular } from './zone';

Expand DownExpand Up@@ -102,17 +102,8 @@ class SentryErrorHandler implements AngularErrorHandler {

 // Capture handled exception and send it to Sentry.
 const eventId = runOutsideAngular(() =>
 Sentry.captureException(extractedError, (scope: Scope) => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'angular',
 handled: false,
 });

 return event;
 });

 return scope;
 Sentry.captureException(extractedError, {
 mechanism: { type: 'angular', handled: false },
 }),
 );

Expand Down

113 changes: 43 additions & 70 deletions
packages/angular/test/errorhandler.test.ts

View file


Open in desktop


Large diffs are not rendered by default.


23 changes: 9 additions & 14 deletions
packages/astro/src/server/middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, configureScope, getCurrentHub, startSpan } from '@sentry/node';
import type { Hub, Span } from '@sentry/types';
import { addExceptionMechanism, objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import { objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import type { APIContext, MiddlewareResponseHandler } from 'astro';

import { getTracingMetaTags } from './meta';
Expand DownExpand Up@@ -34,19 +34,14 @@ function sendErrorToSentry(e: unknown): unknown {
 // store a seen flag on it.
 const objectifiedErr = objectify(e);

 captureException(objectifiedErr, scope => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'astro',
 handled: false,
 data: {
 function: 'astroMiddleware',
 },
 });
 return event;
 });

 return scope;
 captureException(objectifiedErr, {
 mechanism: {
 type: 'astro',
 handled: false,
 data: {
 function: 'astroMiddleware',
 },
 },
 });

 return objectifiedErr;
Expand Down

21 changes: 4 additions & 17 deletions
packages/astro/test/server/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import * as SentryNode from '@sentry/node';
import * as SentryUtils from '@sentry/utils';
import { vi } from 'vitest';

import { handleRequest, interpolateRouteFromUrlAndParams } from '../../src/server/middleware';
Expand DownExpand Up@@ -59,12 +58,7 @@ describe('sentryMiddleware', () => {
 });

 it('throws and sends an error to sentry if `next()` throws', async () => {
 const scope = {
 addEventProcessor: vi.fn().mockImplementation(cb => cb({})),
 };
 // @ts-expect-error, just testing the callback, this is okay for this test
 const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException').mockImplementation((ex, cb) => cb(scope));
 const addExMechanismSpy = vi.spyOn(SentryUtils, 'addExceptionMechanism');
 const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException');

 const middleware = handleRequest();
 const ctx = {
Expand All@@ -86,16 +80,9 @@ describe('sentryMiddleware', () => {
 // @ts-expect-error, a partial ctx object is fine here
 await expect(async () => middleware(ctx, next)).rejects.toThrowError();

 expect(captureExceptionSpy).toHaveBeenCalledWith(error, expect.any(Function));
 expect(scope.addEventProcessor).toHaveBeenCalledTimes(1);
 expect(addExMechanismSpy).toHaveBeenCalledWith(
 {}, // the mocked event
 {
 handled: false,
 type: 'astro',
 data: { function: 'astroMiddleware' },
 },
 );
 expect(captureExceptionSpy).toHaveBeenCalledWith(error, {
 mechanism: { handled: false, type: 'astro', data: { function: 'astroMiddleware' } },
 });
 });

 it('attaches tracing headers', async () => {
Expand Down

6 changes: 3 additions & 3 deletions
packages/browser/src/helpers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { captureException, withScope } from '@sentry/core';
import type { DsnLike, Event as SentryEvent, Mechanism, Scope, WrappedFunction } from '@sentry/types';
import type { DsnLike, Mechanism, WrappedFunction } from '@sentry/types';
import {
 addExceptionMechanism,
 addExceptionTypeValue,
Expand DownExpand Up@@ -99,8 +99,8 @@ export function wrap(
 } catch (ex) {
 ignoreNextOnError();

 withScope((scope: Scope) => {
 scope.addEventProcessor((event: SentryEvent) => {
 withScope(scope => {
 scope.addEventProcessor(event => {
 if (options.mechanism) {
 addExceptionTypeValue(event, undefined, undefined);
 addExceptionMechanism(event, options.mechanism);
Expand Down

39 changes: 17 additions & 22 deletions
packages/browser/src/integrations/globalhandlers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { getCurrentHub } from '@sentry/core';
import type { Event, EventHint, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import {
 addExceptionMechanism,
 addInstrumentationHandler,
 getLocationHref,
 isErrorEvent,
 isPrimitive,
 isString,
 logger,
} from '@sentry/utils';
import type { Event, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import { addInstrumentationHandler, getLocationHref, isErrorEvent, isPrimitive, isString, logger } from '@sentry/utils';

import type { BrowserClient } from '../client';
import { eventFromUnknownInput } from '../eventbuilder';
Expand DownExpand Up@@ -103,7 +95,13 @@ function _installGlobalOnErrorHandler(): void {

 event.level = 'error';

 addMechanismAndCapture(hub, error, event, 'onerror');
 hub.captureEvent(event, {
 originalException: error,
 mechanism: {
 handled: false,
 type: 'onerror',
 },
 });
 },
 );
}
Expand DownExpand Up@@ -149,7 +147,14 @@ function _installGlobalOnUnhandledRejectionHandler(): void {

 event.level = 'error';

 addMechanismAndCapture(hub, error, event, 'onunhandledrejection');
 hub.captureEvent(event, {
 originalException: error,
 mechanism: {
 handled: false,
 type: 'onunhandledrejection',
 },
 });

 return;
 },
 );
Expand DownExpand Up@@ -243,16 +248,6 @@ function globalHandlerLog(type: string): void {
 __DEBUG_BUILD__ && logger.log(`Global Handler attached: ${type}`);
}

function addMechanismAndCapture(hub: Hub, error: EventHint['originalException'], event: Event, type: string): void {
 addExceptionMechanism(event, {
 handled: false,
 type,
 });
 hub.captureEvent(event, {
 originalException: error,
 });
}

function getHubAndOptions(): [Hub, StackParser, boolean | undefined] {
 const hub = getCurrentHub();
 const client = hub.getClient<BrowserClient>();
Expand Down

31 changes: 10 additions & 21 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,25 +1,6 @@
import { captureException, continueTrace, runWithAsyncContext, startSpan, Transaction } from '@sentry/core';
import type { Integration } from '@sentry/types';
import { addExceptionMechanism, getSanitizedUrlString, parseUrl } from '@sentry/utils';

function sendErrorToSentry(e: unknown): unknown {
 captureException(e, scope => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 });
 return event;
 });

 return scope;
 });

 return e;
}
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand DownExpand Up@@ -115,7 +96,15 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
 }
 return response;
 } catch (e) {
 sendErrorToSentry(e);
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
Expand Down

17 changes: 10 additions & 7 deletions
packages/core/src/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ import { isThenable, logger, timestampInSeconds, uuid4 } from '@sentry/utils';
import type { Hub } from './hub';
import { getCurrentHub } from './hub';
import type { Scope } from './scope';
import type { ExclusiveEventHintOrCaptureContext } from './utils/prepareEvent';
import { parseEventHintOrCaptureContext } from './utils/prepareEvent';

// Note: All functions in this file are typed with a return value of `ReturnType<Hub[HUB_FUNCTION]>`,
// where HUB_FUNCTION is some method on the Hub class.
Expand All@@ -30,14 +32,15 @@ import type { Scope } from './scope';

/**
 * Captures an exception event and sends it to Sentry.
 *
 * @param exception An exception-like object.
 * @param captureContext Additional scope data to apply to exception event.
 * @returns The generated eventId.
 * This accepts an event hint as optional second parameter.
 * Alternatively, you can also pass a CaptureContext directly as second parameter.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
export function captureException(exception: any, captureContext?: CaptureContext): ReturnType<Hub['captureException']> {
 return getCurrentHub().captureException(exception, { captureContext });
export function captureException(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exception: any,
 hint?: ExclusiveEventHintOrCaptureContext,
): ReturnType<Hub['captureException']> {
 return getCurrentHub().captureException(exception, parseEventHintOrCaptureContext(hint));
}

/**
Expand Down

82 changes: 80 additions & 2 deletions
packages/core/src/utils/prepareEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,37 @@
import type { Client, ClientOptions, Event, EventHint, StackFrame, StackParser } from '@sentry/types';
import { dateTimestampInSeconds, GLOBAL_OBJ, normalize, resolvedSyncPromise, truncate, uuid4 } from '@sentry/utils';
import type {
 CaptureContext,
 Client,
 ClientOptions,
 Event,
 EventHint,
 Scope as ScopeInterface,
 ScopeContext,
 StackFrame,
 StackParser,
} from '@sentry/types';
import {
 addExceptionMechanism,
 dateTimestampInSeconds,
 GLOBAL_OBJ,
 normalize,
 resolvedSyncPromise,
 truncate,
 uuid4,
} from '@sentry/utils';

import { DEFAULT_ENVIRONMENT } from '../constants';
import { getGlobalEventProcessors, notifyEventProcessors } from '../eventProcessors';
import { Scope } from '../scope';

/**
 * This type makes sure that we get either a CaptureContext, OR an EventHint.
 * It does not allow mixing them, which could lead to unexpected outcomes, e.g. this is disallowed:
 * { user: { id: '123' }, mechanism: { handled: false } }
 */
export type ExclusiveEventHintOrCaptureContext =
 | (CaptureContext & Partial<{ [key in keyof EventHint]: never }>)
 | (EventHint & Partial<{ [key in keyof ScopeContext]: never }>);

/**
 * Adds common information to events.
 *
Expand DownExpand Up@@ -52,6 +79,10 @@ export function prepareEvent(
 finalScope = Scope.clone(finalScope).update(hint.captureContext);
 }

 if (hint.mechanism) {
 addExceptionMechanism(prepared, hint.mechanism);
 }

 // We prepare the result here with a resolved Event.
 let result = resolvedSyncPromise<Event | null>(prepared);

Expand DownExpand Up@@ -309,3 +340,50 @@ function normalizeEvent(event: Event | null, depth: number, maxBreadth: number):

 return normalized;
}

/**
 * Parse either an `EventHint` directly, or convert a `CaptureContext` to an `EventHint`.
 * This is used to allow to update method signatures that used to accept a `CaptureContext` but should now accept an `EventHint`.
 */
export function parseEventHintOrCaptureContext(
 hint: ExclusiveEventHintOrCaptureContext | undefined,
): EventHint | undefined {
 if (!hint) {
 return undefined;
 }

 // If you pass a Scope or `() => Scope` as CaptureContext, we just return this as captureContext
 if (hintIsScopeOrFunction(hint)) {
 return { captureContext: hint };
 }

 if (hintIsScopeContext(hint)) {
 return {
 captureContext: hint,
 };
 }

 return hint;
}

function hintIsScopeOrFunction(
 hint: CaptureContext | EventHint,
): hint is ScopeInterface | ((scope: ScopeInterface) => ScopeInterface) {
 return hint instanceof Scope || typeof hint === 'function';
}

type ScopeContextProperty = keyof ScopeContext;
const captureContextKeys: readonly ScopeContextProperty[] = [
 'user',
 'level',
 'extra',
 'contexts',
 'tags',
 'fingerprint',
 'requestSession',
 'propagationContext',
] as const;

function hintIsScopeContext(hint: Partial<ScopeContext> | EventHint): hint is Partial<ScopeContext> {
 return Object.keys(hint).some(key => captureContextKeys.includes(key as ScopeContextProperty));
}
Loading

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

Skip to content
feat(core): Allow to pass mechanism as event hint#9590

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 3 commits into

from

Nov 22, 2023
 Merged


feat(core): Allow to pass mechanism as event hint
#9590
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
14cd0a1

feat(core): Allow to pass `mechanism` as event hint


mydea Nov 15, 2023
286d1fb

ref: make type exlusive


mydea Nov 17, 2023
cafd258

small wording fix


mydea Nov 22, 2023

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


17 changes: 4 additions & 13 deletions
packages/angular/src/errorhandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import { HttpErrorResponse } from '@angular/common/http';
import type { ErrorHandler as AngularErrorHandler } from '@angular/core';
import { Inject, Injectable } from '@angular/core';
import * as Sentry from '@sentry/browser';
import type { Event, Scope } from '@sentry/types';
import { addExceptionMechanism, isString } from '@sentry/utils';
import type { Event } from '@sentry/types';
import { isString } from '@sentry/utils';

import { runOutsideAngular } from './zone';

Expand DownExpand Up@@ -102,17 +102,8 @@ class SentryErrorHandler implements AngularErrorHandler {

 // Capture handled exception and send it to Sentry.
 const eventId = runOutsideAngular(() =>
 Sentry.captureException(extractedError, (scope: Scope) => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'angular',
 handled: false,
 });

 return event;
 });

 return scope;
 Sentry.captureException(extractedError, {
 mechanism: { type: 'angular', handled: false },
 }),
 );

Expand Down

113 changes: 43 additions & 70 deletions
packages/angular/test/errorhandler.test.ts

View file


Open in desktop


Large diffs are not rendered by default.


23 changes: 9 additions & 14 deletions
packages/astro/src/server/middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, configureScope, getCurrentHub, startSpan } from '@sentry/node';
import type { Hub, Span } from '@sentry/types';
import { addExceptionMechanism, objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import { objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import type { APIContext, MiddlewareResponseHandler } from 'astro';

import { getTracingMetaTags } from './meta';
Expand DownExpand Up@@ -34,19 +34,14 @@ function sendErrorToSentry(e: unknown): unknown {
 // store a seen flag on it.
 const objectifiedErr = objectify(e);

 captureException(objectifiedErr, scope => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'astro',
 handled: false,
 data: {
 function: 'astroMiddleware',
 },
 });
 return event;
 });

 return scope;
 captureException(objectifiedErr, {
 mechanism: {
 type: 'astro',
 handled: false,
 data: {
 function: 'astroMiddleware',
 },
 },
 });

 return objectifiedErr;
Expand Down

21 changes: 4 additions & 17 deletions
packages/astro/test/server/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import * as SentryNode from '@sentry/node';
import * as SentryUtils from '@sentry/utils';
import { vi } from 'vitest';

import { handleRequest, interpolateRouteFromUrlAndParams } from '../../src/server/middleware';
Expand DownExpand Up@@ -59,12 +58,7 @@ describe('sentryMiddleware', () => {
 });

 it('throws and sends an error to sentry if `next()` throws', async () => {
 const scope = {
 addEventProcessor: vi.fn().mockImplementation(cb => cb({})),
 };
 // @ts-expect-error, just testing the callback, this is okay for this test
 const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException').mockImplementation((ex, cb) => cb(scope));
 const addExMechanismSpy = vi.spyOn(SentryUtils, 'addExceptionMechanism');
 const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException');

 const middleware = handleRequest();
 const ctx = {
Expand All@@ -86,16 +80,9 @@ describe('sentryMiddleware', () => {
 // @ts-expect-error, a partial ctx object is fine here
 await expect(async () => middleware(ctx, next)).rejects.toThrowError();

 expect(captureExceptionSpy).toHaveBeenCalledWith(error, expect.any(Function));
 expect(scope.addEventProcessor).toHaveBeenCalledTimes(1);
 expect(addExMechanismSpy).toHaveBeenCalledWith(
 {}, // the mocked event
 {
 handled: false,
 type: 'astro',
 data: { function: 'astroMiddleware' },
 },
 );
 expect(captureExceptionSpy).toHaveBeenCalledWith(error, {
 mechanism: { handled: false, type: 'astro', data: { function: 'astroMiddleware' } },
 });
 });

 it('attaches tracing headers', async () => {
Expand Down

6 changes: 3 additions & 3 deletions
packages/browser/src/helpers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { captureException, withScope } from '@sentry/core';
import type { DsnLike, Event as SentryEvent, Mechanism, Scope, WrappedFunction } from '@sentry/types';
import type { DsnLike, Mechanism, WrappedFunction } from '@sentry/types';
import {
 addExceptionMechanism,
 addExceptionTypeValue,
Expand DownExpand Up@@ -99,8 +99,8 @@ export function wrap(
 } catch (ex) {
 ignoreNextOnError();

 withScope((scope: Scope) => {
 scope.addEventProcessor((event: SentryEvent) => {
 withScope(scope => {
 scope.addEventProcessor(event => {
 if (options.mechanism) {
 addExceptionTypeValue(event, undefined, undefined);
 addExceptionMechanism(event, options.mechanism);
Expand Down

39 changes: 17 additions & 22 deletions
packages/browser/src/integrations/globalhandlers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { getCurrentHub } from '@sentry/core';
import type { Event, EventHint, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import {
 addExceptionMechanism,
 addInstrumentationHandler,
 getLocationHref,
 isErrorEvent,
 isPrimitive,
 isString,
 logger,
} from '@sentry/utils';
import type { Event, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import { addInstrumentationHandler, getLocationHref, isErrorEvent, isPrimitive, isString, logger } from '@sentry/utils';

import type { BrowserClient } from '../client';
import { eventFromUnknownInput } from '../eventbuilder';
Expand DownExpand Up@@ -103,7 +95,13 @@ function _installGlobalOnErrorHandler(): void {

 event.level = 'error';

 addMechanismAndCapture(hub, error, event, 'onerror');
 hub.captureEvent(event, {
 originalException: error,
 mechanism: {
 handled: false,
 type: 'onerror',
 },
 });
 },
 );
}
Expand DownExpand Up@@ -149,7 +147,14 @@ function _installGlobalOnUnhandledRejectionHandler(): void {

 event.level = 'error';

 addMechanismAndCapture(hub, error, event, 'onunhandledrejection');
 hub.captureEvent(event, {
 originalException: error,
 mechanism: {
 handled: false,
 type: 'onunhandledrejection',
 },
 });

 return;
 },
 );
Expand DownExpand Up@@ -243,16 +248,6 @@ function globalHandlerLog(type: string): void {
 __DEBUG_BUILD__ && logger.log(`Global Handler attached: ${type}`);
}

function addMechanismAndCapture(hub: Hub, error: EventHint['originalException'], event: Event, type: string): void {
 addExceptionMechanism(event, {
 handled: false,
 type,
 });
 hub.captureEvent(event, {
 originalException: error,
 });
}

function getHubAndOptions(): [Hub, StackParser, boolean | undefined] {
 const hub = getCurrentHub();
 const client = hub.getClient<BrowserClient>();
Expand Down

31 changes: 10 additions & 21 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,25 +1,6 @@
import { captureException, continueTrace, runWithAsyncContext, startSpan, Transaction } from '@sentry/core';
import type { Integration } from '@sentry/types';
import { addExceptionMechanism, getSanitizedUrlString, parseUrl } from '@sentry/utils';

function sendErrorToSentry(e: unknown): unknown {
 captureException(e, scope => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 });
 return event;
 });

 return scope;
 });

 return e;
}
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand DownExpand Up@@ -115,7 +96,15 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
 }
 return response;
 } catch (e) {
 sendErrorToSentry(e);
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
Expand Down

17 changes: 10 additions & 7 deletions
packages/core/src/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ import { isThenable, logger, timestampInSeconds, uuid4 } from '@sentry/utils';
import type { Hub } from './hub';
import { getCurrentHub } from './hub';
import type { Scope } from './scope';
import type { ExclusiveEventHintOrCaptureContext } from './utils/prepareEvent';
import { parseEventHintOrCaptureContext } from './utils/prepareEvent';

// Note: All functions in this file are typed with a return value of `ReturnType<Hub[HUB_FUNCTION]>`,
// where HUB_FUNCTION is some method on the Hub class.
Expand All@@ -30,14 +32,15 @@ import type { Scope } from './scope';

/**
 * Captures an exception event and sends it to Sentry.
 *
 * @param exception An exception-like object.
 * @param captureContext Additional scope data to apply to exception event.
 * @returns The generated eventId.
 * This accepts an event hint as optional second parameter.
 * Alternatively, you can also pass a CaptureContext directly as second parameter.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
export function captureException(exception: any, captureContext?: CaptureContext): ReturnType<Hub['captureException']> {
 return getCurrentHub().captureException(exception, { captureContext });
export function captureException(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exception: any,
 hint?: ExclusiveEventHintOrCaptureContext,
): ReturnType<Hub['captureException']> {
 return getCurrentHub().captureException(exception, parseEventHintOrCaptureContext(hint));
}

/**
Expand Down

82 changes: 80 additions & 2 deletions
packages/core/src/utils/prepareEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,37 @@
import type { Client, ClientOptions, Event, EventHint, StackFrame, StackParser } from '@sentry/types';
import { dateTimestampInSeconds, GLOBAL_OBJ, normalize, resolvedSyncPromise, truncate, uuid4 } from '@sentry/utils';
import type {
 CaptureContext,
 Client,
 ClientOptions,
 Event,
 EventHint,
 Scope as ScopeInterface,
 ScopeContext,
 StackFrame,
 StackParser,
} from '@sentry/types';
import {
 addExceptionMechanism,
 dateTimestampInSeconds,
 GLOBAL_OBJ,
 normalize,
 resolvedSyncPromise,
 truncate,
 uuid4,
} from '@sentry/utils';

import { DEFAULT_ENVIRONMENT } from '../constants';
import { getGlobalEventProcessors, notifyEventProcessors } from '../eventProcessors';
import { Scope } from '../scope';

/**
 * This type makes sure that we get either a CaptureContext, OR an EventHint.
 * It does not allow mixing them, which could lead to unexpected outcomes, e.g. this is disallowed:
 * { user: { id: '123' }, mechanism: { handled: false } }
 */
export type ExclusiveEventHintOrCaptureContext =
 | (CaptureContext & Partial<{ [key in keyof EventHint]: never }>)
 | (EventHint & Partial<{ [key in keyof ScopeContext]: never }>);

/**
 * Adds common information to events.
 *
Expand DownExpand Up@@ -52,6 +79,10 @@ export function prepareEvent(
 finalScope = Scope.clone(finalScope).update(hint.captureContext);
 }

 if (hint.mechanism) {
 addExceptionMechanism(prepared, hint.mechanism);
 }

 // We prepare the result here with a resolved Event.
 let result = resolvedSyncPromise<Event | null>(prepared);

Expand DownExpand Up@@ -309,3 +340,50 @@ function normalizeEvent(event: Event | null, depth: number, maxBreadth: number):

 return normalized;
}

/**
 * Parse either an `EventHint` directly, or convert a `CaptureContext` to an `EventHint`.
 * This is used to allow to update method signatures that used to accept a `CaptureContext` but should now accept an `EventHint`.
 */
export function parseEventHintOrCaptureContext(
 hint: ExclusiveEventHintOrCaptureContext | undefined,
): EventHint | undefined {
 if (!hint) {
 return undefined;
 }

 // If you pass a Scope or `() => Scope` as CaptureContext, we just return this as captureContext
 if (hintIsScopeOrFunction(hint)) {
 return { captureContext: hint };
 }

 if (hintIsScopeContext(hint)) {
 return {
 captureContext: hint,
 };
 }

 return hint;
}

function hintIsScopeOrFunction(
 hint: CaptureContext | EventHint,
): hint is ScopeInterface | ((scope: ScopeInterface) => ScopeInterface) {
 return hint instanceof Scope || typeof hint === 'function';
}

type ScopeContextProperty = keyof ScopeContext;
const captureContextKeys: readonly ScopeContextProperty[] = [
 'user',
 'level',
 'extra',
 'contexts',
 'tags',
 'fingerprint',
 'requestSession',
 'propagationContext',
] as const;

function hintIsScopeContext(hint: Partial<ScopeContext> | EventHint): hint is Partial<ScopeContext> {
 return Object.keys(hint).some(key => captureContextKeys.includes(key as ScopeContextProperty));
}
Loading

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

Skip to content
feat(core): Allow to pass mechanism as event hint#9590

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 3 commits into

from

Nov 22, 2023
 Merged


feat(core): Allow to pass mechanism as event hint
#9590
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
14cd0a1

feat(core): Allow to pass `mechanism` as event hint


mydea Nov 15, 2023
286d1fb

ref: make type exlusive


mydea Nov 17, 2023
cafd258

small wording fix


mydea Nov 22, 2023

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


17 changes: 4 additions & 13 deletions
packages/angular/src/errorhandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import { HttpErrorResponse } from '@angular/common/http';
import type { ErrorHandler as AngularErrorHandler } from '@angular/core';
import { Inject, Injectable } from '@angular/core';
import * as Sentry from '@sentry/browser';
import type { Event, Scope } from '@sentry/types';
import { addExceptionMechanism, isString } from '@sentry/utils';
import type { Event } from '@sentry/types';
import { isString } from '@sentry/utils';

import { runOutsideAngular } from './zone';

Expand DownExpand Up@@ -102,17 +102,8 @@ class SentryErrorHandler implements AngularErrorHandler {

 // Capture handled exception and send it to Sentry.
 const eventId = runOutsideAngular(() =>
 Sentry.captureException(extractedError, (scope: Scope) => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'angular',
 handled: false,
 });

 return event;
 });

 return scope;
 Sentry.captureException(extractedError, {
 mechanism: { type: 'angular', handled: false },
 }),
 );

Expand Down

113 changes: 43 additions & 70 deletions
packages/angular/test/errorhandler.test.ts

View file


Open in desktop


Large diffs are not rendered by default.


23 changes: 9 additions & 14 deletions
packages/astro/src/server/middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, configureScope, getCurrentHub, startSpan } from '@sentry/node';
import type { Hub, Span } from '@sentry/types';
import { addExceptionMechanism, objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import { objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import type { APIContext, MiddlewareResponseHandler } from 'astro';

import { getTracingMetaTags } from './meta';
Expand DownExpand Up@@ -34,19 +34,14 @@ function sendErrorToSentry(e: unknown): unknown {
 // store a seen flag on it.
 const objectifiedErr = objectify(e);

 captureException(objectifiedErr, scope => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'astro',
 handled: false,
 data: {
 function: 'astroMiddleware',
 },
 });
 return event;
 });

 return scope;
 captureException(objectifiedErr, {
 mechanism: {
 type: 'astro',
 handled: false,
 data: {
 function: 'astroMiddleware',
 },
 },
 });

 return objectifiedErr;
Expand Down

21 changes: 4 additions & 17 deletions
packages/astro/test/server/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import * as SentryNode from '@sentry/node';
import * as SentryUtils from '@sentry/utils';
import { vi } from 'vitest';

import { handleRequest, interpolateRouteFromUrlAndParams } from '../../src/server/middleware';
Expand DownExpand Up@@ -59,12 +58,7 @@ describe('sentryMiddleware', () => {
 });

 it('throws and sends an error to sentry if `next()` throws', async () => {
 const scope = {
 addEventProcessor: vi.fn().mockImplementation(cb => cb({})),
 };
 // @ts-expect-error, just testing the callback, this is okay for this test
 const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException').mockImplementation((ex, cb) => cb(scope));
 const addExMechanismSpy = vi.spyOn(SentryUtils, 'addExceptionMechanism');
 const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException');

 const middleware = handleRequest();
 const ctx = {
Expand All@@ -86,16 +80,9 @@ describe('sentryMiddleware', () => {
 // @ts-expect-error, a partial ctx object is fine here
 await expect(async () => middleware(ctx, next)).rejects.toThrowError();

 expect(captureExceptionSpy).toHaveBeenCalledWith(error, expect.any(Function));
 expect(scope.addEventProcessor).toHaveBeenCalledTimes(1);
 expect(addExMechanismSpy).toHaveBeenCalledWith(
 {}, // the mocked event
 {
 handled: false,
 type: 'astro',
 data: { function: 'astroMiddleware' },
 },
 );
 expect(captureExceptionSpy).toHaveBeenCalledWith(error, {
 mechanism: { handled: false, type: 'astro', data: { function: 'astroMiddleware' } },
 });
 });

 it('attaches tracing headers', async () => {
Expand Down

6 changes: 3 additions & 3 deletions
packages/browser/src/helpers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { captureException, withScope } from '@sentry/core';
import type { DsnLike, Event as SentryEvent, Mechanism, Scope, WrappedFunction } from '@sentry/types';
import type { DsnLike, Mechanism, WrappedFunction } from '@sentry/types';
import {
 addExceptionMechanism,
 addExceptionTypeValue,
Expand DownExpand Up@@ -99,8 +99,8 @@ export function wrap(
 } catch (ex) {
 ignoreNextOnError();

 withScope((scope: Scope) => {
 scope.addEventProcessor((event: SentryEvent) => {
 withScope(scope => {
 scope.addEventProcessor(event => {
 if (options.mechanism) {
 addExceptionTypeValue(event, undefined, undefined);
 addExceptionMechanism(event, options.mechanism);
Expand Down

39 changes: 17 additions & 22 deletions
packages/browser/src/integrations/globalhandlers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { getCurrentHub } from '@sentry/core';
import type { Event, EventHint, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import {
 addExceptionMechanism,
 addInstrumentationHandler,
 getLocationHref,
 isErrorEvent,
 isPrimitive,
 isString,
 logger,
} from '@sentry/utils';
import type { Event, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import { addInstrumentationHandler, getLocationHref, isErrorEvent, isPrimitive, isString, logger } from '@sentry/utils';

import type { BrowserClient } from '../client';
import { eventFromUnknownInput } from '../eventbuilder';
Expand DownExpand Up@@ -103,7 +95,13 @@ function _installGlobalOnErrorHandler(): void {

 event.level = 'error';

 addMechanismAndCapture(hub, error, event, 'onerror');
 hub.captureEvent(event, {
 originalException: error,
 mechanism: {
 handled: false,
 type: 'onerror',
 },
 });
 },
 );
}
Expand DownExpand Up@@ -149,7 +147,14 @@ function _installGlobalOnUnhandledRejectionHandler(): void {

 event.level = 'error';

 addMechanismAndCapture(hub, error, event, 'onunhandledrejection');
 hub.captureEvent(event, {
 originalException: error,
 mechanism: {
 handled: false,
 type: 'onunhandledrejection',
 },
 });

 return;
 },
 );
Expand DownExpand Up@@ -243,16 +248,6 @@ function globalHandlerLog(type: string): void {
 __DEBUG_BUILD__ && logger.log(`Global Handler attached: ${type}`);
}

function addMechanismAndCapture(hub: Hub, error: EventHint['originalException'], event: Event, type: string): void {
 addExceptionMechanism(event, {
 handled: false,
 type,
 });
 hub.captureEvent(event, {
 originalException: error,
 });
}

function getHubAndOptions(): [Hub, StackParser, boolean | undefined] {
 const hub = getCurrentHub();
 const client = hub.getClient<BrowserClient>();
Expand Down

31 changes: 10 additions & 21 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,25 +1,6 @@
import { captureException, continueTrace, runWithAsyncContext, startSpan, Transaction } from '@sentry/core';
import type { Integration } from '@sentry/types';
import { addExceptionMechanism, getSanitizedUrlString, parseUrl } from '@sentry/utils';

function sendErrorToSentry(e: unknown): unknown {
 captureException(e, scope => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 });
 return event;
 });

 return scope;
 });

 return e;
}
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand DownExpand Up@@ -115,7 +96,15 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
 }
 return response;
 } catch (e) {
 sendErrorToSentry(e);
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
Expand Down

17 changes: 10 additions & 7 deletions
packages/core/src/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ import { isThenable, logger, timestampInSeconds, uuid4 } from '@sentry/utils';
import type { Hub } from './hub';
import { getCurrentHub } from './hub';
import type { Scope } from './scope';
import type { ExclusiveEventHintOrCaptureContext } from './utils/prepareEvent';
import { parseEventHintOrCaptureContext } from './utils/prepareEvent';

// Note: All functions in this file are typed with a return value of `ReturnType<Hub[HUB_FUNCTION]>`,
// where HUB_FUNCTION is some method on the Hub class.
Expand All@@ -30,14 +32,15 @@ import type { Scope } from './scope';

/**
 * Captures an exception event and sends it to Sentry.
 *
 * @param exception An exception-like object.
 * @param captureContext Additional scope data to apply to exception event.
 * @returns The generated eventId.
 * This accepts an event hint as optional second parameter.
 * Alternatively, you can also pass a CaptureContext directly as second parameter.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
export function captureException(exception: any, captureContext?: CaptureContext): ReturnType<Hub['captureException']> {
 return getCurrentHub().captureException(exception, { captureContext });
export function captureException(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exception: any,
 hint?: ExclusiveEventHintOrCaptureContext,
): ReturnType<Hub['captureException']> {
 return getCurrentHub().captureException(exception, parseEventHintOrCaptureContext(hint));
}

/**
Expand Down

82 changes: 80 additions & 2 deletions
packages/core/src/utils/prepareEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,37 @@
import type { Client, ClientOptions, Event, EventHint, StackFrame, StackParser } from '@sentry/types';
import { dateTimestampInSeconds, GLOBAL_OBJ, normalize, resolvedSyncPromise, truncate, uuid4 } from '@sentry/utils';
import type {
 CaptureContext,
 Client,
 ClientOptions,
 Event,
 EventHint,
 Scope as ScopeInterface,
 ScopeContext,
 StackFrame,
 StackParser,
} from '@sentry/types';
import {
 addExceptionMechanism,
 dateTimestampInSeconds,
 GLOBAL_OBJ,
 normalize,
 resolvedSyncPromise,
 truncate,
 uuid4,
} from '@sentry/utils';

import { DEFAULT_ENVIRONMENT } from '../constants';
import { getGlobalEventProcessors, notifyEventProcessors } from '../eventProcessors';
import { Scope } from '../scope';

/**
 * This type makes sure that we get either a CaptureContext, OR an EventHint.
 * It does not allow mixing them, which could lead to unexpected outcomes, e.g. this is disallowed:
 * { user: { id: '123' }, mechanism: { handled: false } }
 */
export type ExclusiveEventHintOrCaptureContext =
 | (CaptureContext & Partial<{ [key in keyof EventHint]: never }>)
 | (EventHint & Partial<{ [key in keyof ScopeContext]: never }>);

/**
 * Adds common information to events.
 *
Expand DownExpand Up@@ -52,6 +79,10 @@ export function prepareEvent(
 finalScope = Scope.clone(finalScope).update(hint.captureContext);
 }

 if (hint.mechanism) {
 addExceptionMechanism(prepared, hint.mechanism);
 }

 // We prepare the result here with a resolved Event.
 let result = resolvedSyncPromise<Event | null>(prepared);

Expand DownExpand Up@@ -309,3 +340,50 @@ function normalizeEvent(event: Event | null, depth: number, maxBreadth: number):

 return normalized;
}

/**
 * Parse either an `EventHint` directly, or convert a `CaptureContext` to an `EventHint`.
 * This is used to allow to update method signatures that used to accept a `CaptureContext` but should now accept an `EventHint`.
 */
export function parseEventHintOrCaptureContext(
 hint: ExclusiveEventHintOrCaptureContext | undefined,
): EventHint | undefined {
 if (!hint) {
 return undefined;
 }

 // If you pass a Scope or `() => Scope` as CaptureContext, we just return this as captureContext
 if (hintIsScopeOrFunction(hint)) {
 return { captureContext: hint };
 }

 if (hintIsScopeContext(hint)) {
 return {
 captureContext: hint,
 };
 }

 return hint;
}

function hintIsScopeOrFunction(
 hint: CaptureContext | EventHint,
): hint is ScopeInterface | ((scope: ScopeInterface) => ScopeInterface) {
 return hint instanceof Scope || typeof hint === 'function';
}

type ScopeContextProperty = keyof ScopeContext;
const captureContextKeys: readonly ScopeContextProperty[] = [
 'user',
 'level',
 'extra',
 'contexts',
 'tags',
 'fingerprint',
 'requestSession',
 'propagationContext',
] as const;

function hintIsScopeContext(hint: Partial<ScopeContext> | EventHint): hint is Partial<ScopeContext> {
 return Object.keys(hint).some(key => captureContextKeys.includes(key as ScopeContextProperty));
}
Loading

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

Skip to content
feat(core): Allow to pass mechanism as event hint#9590

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 3 commits into

from

Nov 22, 2023
 Merged


feat(core): Allow to pass mechanism as event hint
#9590
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
14cd0a1

feat(core): Allow to pass `mechanism` as event hint


mydea Nov 15, 2023
286d1fb

ref: make type exlusive


mydea Nov 17, 2023
cafd258

small wording fix


mydea Nov 22, 2023

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


17 changes: 4 additions & 13 deletions
packages/angular/src/errorhandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import { HttpErrorResponse } from '@angular/common/http';
import type { ErrorHandler as AngularErrorHandler } from '@angular/core';
import { Inject, Injectable } from '@angular/core';
import * as Sentry from '@sentry/browser';
import type { Event, Scope } from '@sentry/types';
import { addExceptionMechanism, isString } from '@sentry/utils';
import type { Event } from '@sentry/types';
import { isString } from '@sentry/utils';

import { runOutsideAngular } from './zone';

Expand DownExpand Up@@ -102,17 +102,8 @@ class SentryErrorHandler implements AngularErrorHandler {

 // Capture handled exception and send it to Sentry.
 const eventId = runOutsideAngular(() =>
 Sentry.captureException(extractedError, (scope: Scope) => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'angular',
 handled: false,
 });

 return event;
 });

 return scope;
 Sentry.captureException(extractedError, {
 mechanism: { type: 'angular', handled: false },
 }),
 );

Expand Down

113 changes: 43 additions & 70 deletions
packages/angular/test/errorhandler.test.ts

View file


Open in desktop


Large diffs are not rendered by default.


23 changes: 9 additions & 14 deletions
packages/astro/src/server/middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, configureScope, getCurrentHub, startSpan } from '@sentry/node';
import type { Hub, Span } from '@sentry/types';
import { addExceptionMechanism, objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import { objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import type { APIContext, MiddlewareResponseHandler } from 'astro';

import { getTracingMetaTags } from './meta';
Expand DownExpand Up@@ -34,19 +34,14 @@ function sendErrorToSentry(e: unknown): unknown {
 // store a seen flag on it.
 const objectifiedErr = objectify(e);

 captureException(objectifiedErr, scope => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'astro',
 handled: false,
 data: {
 function: 'astroMiddleware',
 },
 });
 return event;
 });

 return scope;
 captureException(objectifiedErr, {
 mechanism: {
 type: 'astro',
 handled: false,
 data: {
 function: 'astroMiddleware',
 },
 },
 });

 return objectifiedErr;
Expand Down

21 changes: 4 additions & 17 deletions
packages/astro/test/server/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import * as SentryNode from '@sentry/node';
import * as SentryUtils from '@sentry/utils';
import { vi } from 'vitest';

import { handleRequest, interpolateRouteFromUrlAndParams } from '../../src/server/middleware';
Expand DownExpand Up@@ -59,12 +58,7 @@ describe('sentryMiddleware', () => {
 });

 it('throws and sends an error to sentry if `next()` throws', async () => {
 const scope = {
 addEventProcessor: vi.fn().mockImplementation(cb => cb({})),
 };
 // @ts-expect-error, just testing the callback, this is okay for this test
 const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException').mockImplementation((ex, cb) => cb(scope));
 const addExMechanismSpy = vi.spyOn(SentryUtils, 'addExceptionMechanism');
 const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException');

 const middleware = handleRequest();
 const ctx = {
Expand All@@ -86,16 +80,9 @@ describe('sentryMiddleware', () => {
 // @ts-expect-error, a partial ctx object is fine here
 await expect(async () => middleware(ctx, next)).rejects.toThrowError();

 expect(captureExceptionSpy).toHaveBeenCalledWith(error, expect.any(Function));
 expect(scope.addEventProcessor).toHaveBeenCalledTimes(1);
 expect(addExMechanismSpy).toHaveBeenCalledWith(
 {}, // the mocked event
 {
 handled: false,
 type: 'astro',
 data: { function: 'astroMiddleware' },
 },
 );
 expect(captureExceptionSpy).toHaveBeenCalledWith(error, {
 mechanism: { handled: false, type: 'astro', data: { function: 'astroMiddleware' } },
 });
 });

 it('attaches tracing headers', async () => {
Expand Down

6 changes: 3 additions & 3 deletions
packages/browser/src/helpers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { captureException, withScope } from '@sentry/core';
import type { DsnLike, Event as SentryEvent, Mechanism, Scope, WrappedFunction } from '@sentry/types';
import type { DsnLike, Mechanism, WrappedFunction } from '@sentry/types';
import {
 addExceptionMechanism,
 addExceptionTypeValue,
Expand DownExpand Up@@ -99,8 +99,8 @@ export function wrap(
 } catch (ex) {
 ignoreNextOnError();

 withScope((scope: Scope) => {
 scope.addEventProcessor((event: SentryEvent) => {
 withScope(scope => {
 scope.addEventProcessor(event => {
 if (options.mechanism) {
 addExceptionTypeValue(event, undefined, undefined);
 addExceptionMechanism(event, options.mechanism);
Expand Down

39 changes: 17 additions & 22 deletions
packages/browser/src/integrations/globalhandlers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { getCurrentHub } from '@sentry/core';
import type { Event, EventHint, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import {
 addExceptionMechanism,
 addInstrumentationHandler,
 getLocationHref,
 isErrorEvent,
 isPrimitive,
 isString,
 logger,
} from '@sentry/utils';
import type { Event, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import { addInstrumentationHandler, getLocationHref, isErrorEvent, isPrimitive, isString, logger } from '@sentry/utils';

import type { BrowserClient } from '../client';
import { eventFromUnknownInput } from '../eventbuilder';
Expand DownExpand Up@@ -103,7 +95,13 @@ function _installGlobalOnErrorHandler(): void {

 event.level = 'error';

 addMechanismAndCapture(hub, error, event, 'onerror');
 hub.captureEvent(event, {
 originalException: error,
 mechanism: {
 handled: false,
 type: 'onerror',
 },
 });
 },
 );
}
Expand DownExpand Up@@ -149,7 +147,14 @@ function _installGlobalOnUnhandledRejectionHandler(): void {

 event.level = 'error';

 addMechanismAndCapture(hub, error, event, 'onunhandledrejection');
 hub.captureEvent(event, {
 originalException: error,
 mechanism: {
 handled: false,
 type: 'onunhandledrejection',
 },
 });

 return;
 },
 );
Expand DownExpand Up@@ -243,16 +248,6 @@ function globalHandlerLog(type: string): void {
 __DEBUG_BUILD__ && logger.log(`Global Handler attached: ${type}`);
}

function addMechanismAndCapture(hub: Hub, error: EventHint['originalException'], event: Event, type: string): void {
 addExceptionMechanism(event, {
 handled: false,
 type,
 });
 hub.captureEvent(event, {
 originalException: error,
 });
}

function getHubAndOptions(): [Hub, StackParser, boolean | undefined] {
 const hub = getCurrentHub();
 const client = hub.getClient<BrowserClient>();
Expand Down

31 changes: 10 additions & 21 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,25 +1,6 @@
import { captureException, continueTrace, runWithAsyncContext, startSpan, Transaction } from '@sentry/core';
import type { Integration } from '@sentry/types';
import { addExceptionMechanism, getSanitizedUrlString, parseUrl } from '@sentry/utils';

function sendErrorToSentry(e: unknown): unknown {
 captureException(e, scope => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 });
 return event;
 });

 return scope;
 });

 return e;
}
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand DownExpand Up@@ -115,7 +96,15 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
 }
 return response;
 } catch (e) {
 sendErrorToSentry(e);
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
Expand Down

17 changes: 10 additions & 7 deletions
packages/core/src/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ import { isThenable, logger, timestampInSeconds, uuid4 } from '@sentry/utils';
import type { Hub } from './hub';
import { getCurrentHub } from './hub';
import type { Scope } from './scope';
import type { ExclusiveEventHintOrCaptureContext } from './utils/prepareEvent';
import { parseEventHintOrCaptureContext } from './utils/prepareEvent';

// Note: All functions in this file are typed with a return value of `ReturnType<Hub[HUB_FUNCTION]>`,
// where HUB_FUNCTION is some method on the Hub class.
Expand All@@ -30,14 +32,15 @@ import type { Scope } from './scope';

/**
 * Captures an exception event and sends it to Sentry.
 *
 * @param exception An exception-like object.
 * @param captureContext Additional scope data to apply to exception event.
 * @returns The generated eventId.
 * This accepts an event hint as optional second parameter.
 * Alternatively, you can also pass a CaptureContext directly as second parameter.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
export function captureException(exception: any, captureContext?: CaptureContext): ReturnType<Hub['captureException']> {
 return getCurrentHub().captureException(exception, { captureContext });
export function captureException(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exception: any,
 hint?: ExclusiveEventHintOrCaptureContext,
): ReturnType<Hub['captureException']> {
 return getCurrentHub().captureException(exception, parseEventHintOrCaptureContext(hint));
}

/**
Expand Down

82 changes: 80 additions & 2 deletions
packages/core/src/utils/prepareEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,37 @@
import type { Client, ClientOptions, Event, EventHint, StackFrame, StackParser } from '@sentry/types';
import { dateTimestampInSeconds, GLOBAL_OBJ, normalize, resolvedSyncPromise, truncate, uuid4 } from '@sentry/utils';
import type {
 CaptureContext,
 Client,
 ClientOptions,
 Event,
 EventHint,
 Scope as ScopeInterface,
 ScopeContext,
 StackFrame,
 StackParser,
} from '@sentry/types';
import {
 addExceptionMechanism,
 dateTimestampInSeconds,
 GLOBAL_OBJ,
 normalize,
 resolvedSyncPromise,
 truncate,
 uuid4,
} from '@sentry/utils';

import { DEFAULT_ENVIRONMENT } from '../constants';
import { getGlobalEventProcessors, notifyEventProcessors } from '../eventProcessors';
import { Scope } from '../scope';

/**
 * This type makes sure that we get either a CaptureContext, OR an EventHint.
 * It does not allow mixing them, which could lead to unexpected outcomes, e.g. this is disallowed:
 * { user: { id: '123' }, mechanism: { handled: false } }
 */
export type ExclusiveEventHintOrCaptureContext =
 | (CaptureContext & Partial<{ [key in keyof EventHint]: never }>)
 | (EventHint & Partial<{ [key in keyof ScopeContext]: never }>);

/**
 * Adds common information to events.
 *
Expand DownExpand Up@@ -52,6 +79,10 @@ export function prepareEvent(
 finalScope = Scope.clone(finalScope).update(hint.captureContext);
 }

 if (hint.mechanism) {
 addExceptionMechanism(prepared, hint.mechanism);
 }

 // We prepare the result here with a resolved Event.
 let result = resolvedSyncPromise<Event | null>(prepared);

Expand DownExpand Up@@ -309,3 +340,50 @@ function normalizeEvent(event: Event | null, depth: number, maxBreadth: number):

 return normalized;
}

/**
 * Parse either an `EventHint` directly, or convert a `CaptureContext` to an `EventHint`.
 * This is used to allow to update method signatures that used to accept a `CaptureContext` but should now accept an `EventHint`.
 */
export function parseEventHintOrCaptureContext(
 hint: ExclusiveEventHintOrCaptureContext | undefined,
): EventHint | undefined {
 if (!hint) {
 return undefined;
 }

 // If you pass a Scope or `() => Scope` as CaptureContext, we just return this as captureContext
 if (hintIsScopeOrFunction(hint)) {
 return { captureContext: hint };
 }

 if (hintIsScopeContext(hint)) {
 return {
 captureContext: hint,
 };
 }

 return hint;
}

function hintIsScopeOrFunction(
 hint: CaptureContext | EventHint,
): hint is ScopeInterface | ((scope: ScopeInterface) => ScopeInterface) {
 return hint instanceof Scope || typeof hint === 'function';
}

type ScopeContextProperty = keyof ScopeContext;
const captureContextKeys: readonly ScopeContextProperty[] = [
 'user',
 'level',
 'extra',
 'contexts',
 'tags',
 'fingerprint',
 'requestSession',
 'propagationContext',
] as const;

function hintIsScopeContext(hint: Partial<ScopeContext> | EventHint): hint is Partial<ScopeContext> {
 return Object.keys(hint).some(key => captureContextKeys.includes(key as ScopeContextProperty));
}
Loading

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

Skip to content
feat(core): Allow to pass mechanism as event hint#9590

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 3 commits into

from

Nov 22, 2023
 Merged


feat(core): Allow to pass mechanism as event hint
#9590
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
14cd0a1

feat(core): Allow to pass `mechanism` as event hint


mydea Nov 15, 2023
286d1fb

ref: make type exlusive


mydea Nov 17, 2023
cafd258

small wording fix


mydea Nov 22, 2023

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


17 changes: 4 additions & 13 deletions
packages/angular/src/errorhandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import { HttpErrorResponse } from '@angular/common/http';
import type { ErrorHandler as AngularErrorHandler } from '@angular/core';
import { Inject, Injectable } from '@angular/core';
import * as Sentry from '@sentry/browser';
import type { Event, Scope } from '@sentry/types';
import { addExceptionMechanism, isString } from '@sentry/utils';
import type { Event } from '@sentry/types';
import { isString } from '@sentry/utils';

import { runOutsideAngular } from './zone';

Expand DownExpand Up@@ -102,17 +102,8 @@ class SentryErrorHandler implements AngularErrorHandler {

 // Capture handled exception and send it to Sentry.
 const eventId = runOutsideAngular(() =>
 Sentry.captureException(extractedError, (scope: Scope) => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'angular',
 handled: false,
 });

 return event;
 });

 return scope;
 Sentry.captureException(extractedError, {
 mechanism: { type: 'angular', handled: false },
 }),
 );

Expand Down

113 changes: 43 additions & 70 deletions
packages/angular/test/errorhandler.test.ts

View file


Open in desktop


Large diffs are not rendered by default.


23 changes: 9 additions & 14 deletions
packages/astro/src/server/middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, configureScope, getCurrentHub, startSpan } from '@sentry/node';
import type { Hub, Span } from '@sentry/types';
import { addExceptionMechanism, objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import { objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import type { APIContext, MiddlewareResponseHandler } from 'astro';

import { getTracingMetaTags } from './meta';
Expand DownExpand Up@@ -34,19 +34,14 @@ function sendErrorToSentry(e: unknown): unknown {
 // store a seen flag on it.
 const objectifiedErr = objectify(e);

 captureException(objectifiedErr, scope => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'astro',
 handled: false,
 data: {
 function: 'astroMiddleware',
 },
 });
 return event;
 });

 return scope;
 captureException(objectifiedErr, {
 mechanism: {
 type: 'astro',
 handled: false,
 data: {
 function: 'astroMiddleware',
 },
 },
 });

 return objectifiedErr;
Expand Down

21 changes: 4 additions & 17 deletions
packages/astro/test/server/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import * as SentryNode from '@sentry/node';
import * as SentryUtils from '@sentry/utils';
import { vi } from 'vitest';

import { handleRequest, interpolateRouteFromUrlAndParams } from '../../src/server/middleware';
Expand DownExpand Up@@ -59,12 +58,7 @@ describe('sentryMiddleware', () => {
 });

 it('throws and sends an error to sentry if `next()` throws', async () => {
 const scope = {
 addEventProcessor: vi.fn().mockImplementation(cb => cb({})),
 };
 // @ts-expect-error, just testing the callback, this is okay for this test
 const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException').mockImplementation((ex, cb) => cb(scope));
 const addExMechanismSpy = vi.spyOn(SentryUtils, 'addExceptionMechanism');
 const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException');

 const middleware = handleRequest();
 const ctx = {
Expand All@@ -86,16 +80,9 @@ describe('sentryMiddleware', () => {
 // @ts-expect-error, a partial ctx object is fine here
 await expect(async () => middleware(ctx, next)).rejects.toThrowError();

 expect(captureExceptionSpy).toHaveBeenCalledWith(error, expect.any(Function));
 expect(scope.addEventProcessor).toHaveBeenCalledTimes(1);
 expect(addExMechanismSpy).toHaveBeenCalledWith(
 {}, // the mocked event
 {
 handled: false,
 type: 'astro',
 data: { function: 'astroMiddleware' },
 },
 );
 expect(captureExceptionSpy).toHaveBeenCalledWith(error, {
 mechanism: { handled: false, type: 'astro', data: { function: 'astroMiddleware' } },
 });
 });

 it('attaches tracing headers', async () => {
Expand Down

6 changes: 3 additions & 3 deletions
packages/browser/src/helpers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { captureException, withScope } from '@sentry/core';
import type { DsnLike, Event as SentryEvent, Mechanism, Scope, WrappedFunction } from '@sentry/types';
import type { DsnLike, Mechanism, WrappedFunction } from '@sentry/types';
import {
 addExceptionMechanism,
 addExceptionTypeValue,
Expand DownExpand Up@@ -99,8 +99,8 @@ export function wrap(
 } catch (ex) {
 ignoreNextOnError();

 withScope((scope: Scope) => {
 scope.addEventProcessor((event: SentryEvent) => {
 withScope(scope => {
 scope.addEventProcessor(event => {
 if (options.mechanism) {
 addExceptionTypeValue(event, undefined, undefined);
 addExceptionMechanism(event, options.mechanism);
Expand Down

39 changes: 17 additions & 22 deletions
packages/browser/src/integrations/globalhandlers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { getCurrentHub } from '@sentry/core';
import type { Event, EventHint, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import {
 addExceptionMechanism,
 addInstrumentationHandler,
 getLocationHref,
 isErrorEvent,
 isPrimitive,
 isString,
 logger,
} from '@sentry/utils';
import type { Event, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import { addInstrumentationHandler, getLocationHref, isErrorEvent, isPrimitive, isString, logger } from '@sentry/utils';

import type { BrowserClient } from '../client';
import { eventFromUnknownInput } from '../eventbuilder';
Expand DownExpand Up@@ -103,7 +95,13 @@ function _installGlobalOnErrorHandler(): void {

 event.level = 'error';

 addMechanismAndCapture(hub, error, event, 'onerror');
 hub.captureEvent(event, {
 originalException: error,
 mechanism: {
 handled: false,
 type: 'onerror',
 },
 });
 },
 );
}
Expand DownExpand Up@@ -149,7 +147,14 @@ function _installGlobalOnUnhandledRejectionHandler(): void {

 event.level = 'error';

 addMechanismAndCapture(hub, error, event, 'onunhandledrejection');
 hub.captureEvent(event, {
 originalException: error,
 mechanism: {
 handled: false,
 type: 'onunhandledrejection',
 },
 });

 return;
 },
 );
Expand DownExpand Up@@ -243,16 +248,6 @@ function globalHandlerLog(type: string): void {
 __DEBUG_BUILD__ && logger.log(`Global Handler attached: ${type}`);
}

function addMechanismAndCapture(hub: Hub, error: EventHint['originalException'], event: Event, type: string): void {
 addExceptionMechanism(event, {
 handled: false,
 type,
 });
 hub.captureEvent(event, {
 originalException: error,
 });
}

function getHubAndOptions(): [Hub, StackParser, boolean | undefined] {
 const hub = getCurrentHub();
 const client = hub.getClient<BrowserClient>();
Expand Down

31 changes: 10 additions & 21 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,25 +1,6 @@
import { captureException, continueTrace, runWithAsyncContext, startSpan, Transaction } from '@sentry/core';
import type { Integration } from '@sentry/types';
import { addExceptionMechanism, getSanitizedUrlString, parseUrl } from '@sentry/utils';

function sendErrorToSentry(e: unknown): unknown {
 captureException(e, scope => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 });
 return event;
 });

 return scope;
 });

 return e;
}
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand DownExpand Up@@ -115,7 +96,15 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
 }
 return response;
 } catch (e) {
 sendErrorToSentry(e);
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
Expand Down

17 changes: 10 additions & 7 deletions
packages/core/src/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ import { isThenable, logger, timestampInSeconds, uuid4 } from '@sentry/utils';
import type { Hub } from './hub';
import { getCurrentHub } from './hub';
import type { Scope } from './scope';
import type { ExclusiveEventHintOrCaptureContext } from './utils/prepareEvent';
import { parseEventHintOrCaptureContext } from './utils/prepareEvent';

// Note: All functions in this file are typed with a return value of `ReturnType<Hub[HUB_FUNCTION]>`,
// where HUB_FUNCTION is some method on the Hub class.
Expand All@@ -30,14 +32,15 @@ import type { Scope } from './scope';

/**
 * Captures an exception event and sends it to Sentry.
 *
 * @param exception An exception-like object.
 * @param captureContext Additional scope data to apply to exception event.
 * @returns The generated eventId.
 * This accepts an event hint as optional second parameter.
 * Alternatively, you can also pass a CaptureContext directly as second parameter.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
export function captureException(exception: any, captureContext?: CaptureContext): ReturnType<Hub['captureException']> {
 return getCurrentHub().captureException(exception, { captureContext });
export function captureException(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exception: any,
 hint?: ExclusiveEventHintOrCaptureContext,
): ReturnType<Hub['captureException']> {
 return getCurrentHub().captureException(exception, parseEventHintOrCaptureContext(hint));
}

/**
Expand Down

82 changes: 80 additions & 2 deletions
packages/core/src/utils/prepareEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,37 @@
import type { Client, ClientOptions, Event, EventHint, StackFrame, StackParser } from '@sentry/types';
import { dateTimestampInSeconds, GLOBAL_OBJ, normalize, resolvedSyncPromise, truncate, uuid4 } from '@sentry/utils';
import type {
 CaptureContext,
 Client,
 ClientOptions,
 Event,
 EventHint,
 Scope as ScopeInterface,
 ScopeContext,
 StackFrame,
 StackParser,
} from '@sentry/types';
import {
 addExceptionMechanism,
 dateTimestampInSeconds,
 GLOBAL_OBJ,
 normalize,
 resolvedSyncPromise,
 truncate,
 uuid4,
} from '@sentry/utils';

import { DEFAULT_ENVIRONMENT } from '../constants';
import { getGlobalEventProcessors, notifyEventProcessors } from '../eventProcessors';
import { Scope } from '../scope';

/**
 * This type makes sure that we get either a CaptureContext, OR an EventHint.
 * It does not allow mixing them, which could lead to unexpected outcomes, e.g. this is disallowed:
 * { user: { id: '123' }, mechanism: { handled: false } }
 */
export type ExclusiveEventHintOrCaptureContext =
 | (CaptureContext & Partial<{ [key in keyof EventHint]: never }>)
 | (EventHint & Partial<{ [key in keyof ScopeContext]: never }>);

/**
 * Adds common information to events.
 *
Expand DownExpand Up@@ -52,6 +79,10 @@ export function prepareEvent(
 finalScope = Scope.clone(finalScope).update(hint.captureContext);
 }

 if (hint.mechanism) {
 addExceptionMechanism(prepared, hint.mechanism);
 }

 // We prepare the result here with a resolved Event.
 let result = resolvedSyncPromise<Event | null>(prepared);

Expand DownExpand Up@@ -309,3 +340,50 @@ function normalizeEvent(event: Event | null, depth: number, maxBreadth: number):

 return normalized;
}

/**
 * Parse either an `EventHint` directly, or convert a `CaptureContext` to an `EventHint`.
 * This is used to allow to update method signatures that used to accept a `CaptureContext` but should now accept an `EventHint`.
 */
export function parseEventHintOrCaptureContext(
 hint: ExclusiveEventHintOrCaptureContext | undefined,
): EventHint | undefined {
 if (!hint) {
 return undefined;
 }

 // If you pass a Scope or `() => Scope` as CaptureContext, we just return this as captureContext
 if (hintIsScopeOrFunction(hint)) {
 return { captureContext: hint };
 }

 if (hintIsScopeContext(hint)) {
 return {
 captureContext: hint,
 };
 }

 return hint;
}

function hintIsScopeOrFunction(
 hint: CaptureContext | EventHint,
): hint is ScopeInterface | ((scope: ScopeInterface) => ScopeInterface) {
 return hint instanceof Scope || typeof hint === 'function';
}

type ScopeContextProperty = keyof ScopeContext;
const captureContextKeys: readonly ScopeContextProperty[] = [
 'user',
 'level',
 'extra',
 'contexts',
 'tags',
 'fingerprint',
 'requestSession',
 'propagationContext',
] as const;

function hintIsScopeContext(hint: Partial<ScopeContext> | EventHint): hint is Partial<ScopeContext> {
 return Object.keys(hint).some(key => captureContextKeys.includes(key as ScopeContextProperty));
}
Loading

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

Skip to content
feat(core): Allow to pass mechanism as event hint#9590

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 3 commits into

from

Nov 22, 2023
 Merged


feat(core): Allow to pass mechanism as event hint
#9590
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
14cd0a1

feat(core): Allow to pass `mechanism` as event hint


mydea Nov 15, 2023
286d1fb

ref: make type exlusive


mydea Nov 17, 2023
cafd258

small wording fix


mydea Nov 22, 2023

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


17 changes: 4 additions & 13 deletions
packages/angular/src/errorhandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@ import { HttpErrorResponse } from '@angular/common/http';
import type { ErrorHandler as AngularErrorHandler } from '@angular/core';
import { Inject, Injectable } from '@angular/core';
import * as Sentry from '@sentry/browser';
import type { Event, Scope } from '@sentry/types';
import { addExceptionMechanism, isString } from '@sentry/utils';
import type { Event } from '@sentry/types';
import { isString } from '@sentry/utils';

import { runOutsideAngular } from './zone';

Expand DownExpand Up@@ -102,17 +102,8 @@ class SentryErrorHandler implements AngularErrorHandler {

 // Capture handled exception and send it to Sentry.
 const eventId = runOutsideAngular(() =>
 Sentry.captureException(extractedError, (scope: Scope) => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'angular',
 handled: false,
 });

 return event;
 });

 return scope;
 Sentry.captureException(extractedError, {
 mechanism: { type: 'angular', handled: false },
 }),
 );

Expand Down

113 changes: 43 additions & 70 deletions
packages/angular/test/errorhandler.test.ts

View file


Open in desktop


Large diffs are not rendered by default.


23 changes: 9 additions & 14 deletions
packages/astro/src/server/middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, configureScope, getCurrentHub, startSpan } from '@sentry/node';
import type { Hub, Span } from '@sentry/types';
import { addExceptionMechanism, objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import { objectify, stripUrlQueryAndFragment, tracingContextFromHeaders } from '@sentry/utils';
import type { APIContext, MiddlewareResponseHandler } from 'astro';

import { getTracingMetaTags } from './meta';
Expand DownExpand Up@@ -34,19 +34,14 @@ function sendErrorToSentry(e: unknown): unknown {
 // store a seen flag on it.
 const objectifiedErr = objectify(e);

 captureException(objectifiedErr, scope => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'astro',
 handled: false,
 data: {
 function: 'astroMiddleware',
 },
 });
 return event;
 });

 return scope;
 captureException(objectifiedErr, {
 mechanism: {
 type: 'astro',
 handled: false,
 data: {
 function: 'astroMiddleware',
 },
 },
 });

 return objectifiedErr;
Expand Down

21 changes: 4 additions & 17 deletions
packages/astro/test/server/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import * as SentryNode from '@sentry/node';
import * as SentryUtils from '@sentry/utils';
import { vi } from 'vitest';

import { handleRequest, interpolateRouteFromUrlAndParams } from '../../src/server/middleware';
Expand DownExpand Up@@ -59,12 +58,7 @@ describe('sentryMiddleware', () => {
 });

 it('throws and sends an error to sentry if `next()` throws', async () => {
 const scope = {
 addEventProcessor: vi.fn().mockImplementation(cb => cb({})),
 };
 // @ts-expect-error, just testing the callback, this is okay for this test
 const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException').mockImplementation((ex, cb) => cb(scope));
 const addExMechanismSpy = vi.spyOn(SentryUtils, 'addExceptionMechanism');
 const captureExceptionSpy = vi.spyOn(SentryNode, 'captureException');

 const middleware = handleRequest();
 const ctx = {
Expand All@@ -86,16 +80,9 @@ describe('sentryMiddleware', () => {
 // @ts-expect-error, a partial ctx object is fine here
 await expect(async () => middleware(ctx, next)).rejects.toThrowError();

 expect(captureExceptionSpy).toHaveBeenCalledWith(error, expect.any(Function));
 expect(scope.addEventProcessor).toHaveBeenCalledTimes(1);
 expect(addExMechanismSpy).toHaveBeenCalledWith(
 {}, // the mocked event
 {
 handled: false,
 type: 'astro',
 data: { function: 'astroMiddleware' },
 },
 );
 expect(captureExceptionSpy).toHaveBeenCalledWith(error, {
 mechanism: { handled: false, type: 'astro', data: { function: 'astroMiddleware' } },
 });
 });

 it('attaches tracing headers', async () => {
Expand Down

6 changes: 3 additions & 3 deletions
packages/browser/src/helpers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { captureException, withScope } from '@sentry/core';
import type { DsnLike, Event as SentryEvent, Mechanism, Scope, WrappedFunction } from '@sentry/types';
import type { DsnLike, Mechanism, WrappedFunction } from '@sentry/types';
import {
 addExceptionMechanism,
 addExceptionTypeValue,
Expand DownExpand Up@@ -99,8 +99,8 @@ export function wrap(
 } catch (ex) {
 ignoreNextOnError();

 withScope((scope: Scope) => {
 scope.addEventProcessor((event: SentryEvent) => {
 withScope(scope => {
 scope.addEventProcessor(event => {
 if (options.mechanism) {
 addExceptionTypeValue(event, undefined, undefined);
 addExceptionMechanism(event, options.mechanism);
Expand Down

39 changes: 17 additions & 22 deletions
packages/browser/src/integrations/globalhandlers.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { getCurrentHub } from '@sentry/core';
import type { Event, EventHint, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import {
 addExceptionMechanism,
 addInstrumentationHandler,
 getLocationHref,
 isErrorEvent,
 isPrimitive,
 isString,
 logger,
} from '@sentry/utils';
import type { Event, Hub, Integration, Primitive, StackParser } from '@sentry/types';
import { addInstrumentationHandler, getLocationHref, isErrorEvent, isPrimitive, isString, logger } from '@sentry/utils';

import type { BrowserClient } from '../client';
import { eventFromUnknownInput } from '../eventbuilder';
Expand DownExpand Up@@ -103,7 +95,13 @@ function _installGlobalOnErrorHandler(): void {

 event.level = 'error';

 addMechanismAndCapture(hub, error, event, 'onerror');
 hub.captureEvent(event, {
 originalException: error,
 mechanism: {
 handled: false,
 type: 'onerror',
 },
 });
 },
 );
}
Expand DownExpand Up@@ -149,7 +147,14 @@ function _installGlobalOnUnhandledRejectionHandler(): void {

 event.level = 'error';

 addMechanismAndCapture(hub, error, event, 'onunhandledrejection');
 hub.captureEvent(event, {
 originalException: error,
 mechanism: {
 handled: false,
 type: 'onunhandledrejection',
 },
 });

 return;
 },
 );
Expand DownExpand Up@@ -243,16 +248,6 @@ function globalHandlerLog(type: string): void {
 __DEBUG_BUILD__ && logger.log(`Global Handler attached: ${type}`);
}

function addMechanismAndCapture(hub: Hub, error: EventHint['originalException'], event: Event, type: string): void {
 addExceptionMechanism(event, {
 handled: false,
 type,
 });
 hub.captureEvent(event, {
 originalException: error,
 });
}

function getHubAndOptions(): [Hub, StackParser, boolean | undefined] {
 const hub = getCurrentHub();
 const client = hub.getClient<BrowserClient>();
Expand Down

31 changes: 10 additions & 21 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,25 +1,6 @@
import { captureException, continueTrace, runWithAsyncContext, startSpan, Transaction } from '@sentry/core';
import type { Integration } from '@sentry/types';
import { addExceptionMechanism, getSanitizedUrlString, parseUrl } from '@sentry/utils';

function sendErrorToSentry(e: unknown): unknown {
 captureException(e, scope => {
 scope.addEventProcessor(event => {
 addExceptionMechanism(event, {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 });
 return event;
 });

 return scope;
 });

 return e;
}
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';

/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
Expand DownExpand Up@@ -115,7 +96,15 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
 }
 return response;
 } catch (e) {
 sendErrorToSentry(e);
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
Expand Down

17 changes: 10 additions & 7 deletions
packages/core/src/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ import { isThenable, logger, timestampInSeconds, uuid4 } from '@sentry/utils';
import type { Hub } from './hub';
import { getCurrentHub } from './hub';
import type { Scope } from './scope';
import type { ExclusiveEventHintOrCaptureContext } from './utils/prepareEvent';
import { parseEventHintOrCaptureContext } from './utils/prepareEvent';

// Note: All functions in this file are typed with a return value of `ReturnType<Hub[HUB_FUNCTION]>`,
// where HUB_FUNCTION is some method on the Hub class.
Expand All@@ -30,14 +32,15 @@ import type { Scope } from './scope';

/**
 * Captures an exception event and sends it to Sentry.
 *
 * @param exception An exception-like object.
 * @param captureContext Additional scope data to apply to exception event.
 * @returns The generated eventId.
 * This accepts an event hint as optional second parameter.
 * Alternatively, you can also pass a CaptureContext directly as second parameter.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
export function captureException(exception: any, captureContext?: CaptureContext): ReturnType<Hub['captureException']> {
 return getCurrentHub().captureException(exception, { captureContext });
export function captureException(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exception: any,
 hint?: ExclusiveEventHintOrCaptureContext,
): ReturnType<Hub['captureException']> {
 return getCurrentHub().captureException(exception, parseEventHintOrCaptureContext(hint));
}

/**
Expand Down

82 changes: 80 additions & 2 deletions
packages/core/src/utils/prepareEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,37 @@
import type { Client, ClientOptions, Event, EventHint, StackFrame, StackParser } from '@sentry/types';
import { dateTimestampInSeconds, GLOBAL_OBJ, normalize, resolvedSyncPromise, truncate, uuid4 } from '@sentry/utils';
import type {
 CaptureContext,
 Client,
 ClientOptions,
 Event,
 EventHint,
 Scope as ScopeInterface,
 ScopeContext,
 StackFrame,
 StackParser,
} from '@sentry/types';
import {
 addExceptionMechanism,
 dateTimestampInSeconds,
 GLOBAL_OBJ,
 normalize,
 resolvedSyncPromise,
 truncate,
 uuid4,
} from '@sentry/utils';

import { DEFAULT_ENVIRONMENT } from '../constants';
import { getGlobalEventProcessors, notifyEventProcessors } from '../eventProcessors';
import { Scope } from '../scope';

/**
 * This type makes sure that we get either a CaptureContext, OR an EventHint.
 * It does not allow mixing them, which could lead to unexpected outcomes, e.g. this is disallowed:
 * { user: { id: '123' }, mechanism: { handled: false } }
 */
export type ExclusiveEventHintOrCaptureContext =
 | (CaptureContext & Partial<{ [key in keyof EventHint]: never }>)
 | (EventHint & Partial<{ [key in keyof ScopeContext]: never }>);

/**
 * Adds common information to events.
 *
Expand DownExpand Up@@ -52,6 +79,10 @@ export function prepareEvent(
 finalScope = Scope.clone(finalScope).update(hint.captureContext);
 }

 if (hint.mechanism) {
 addExceptionMechanism(prepared, hint.mechanism);
 }

 // We prepare the result here with a resolved Event.
 let result = resolvedSyncPromise<Event | null>(prepared);

Expand DownExpand Up@@ -309,3 +340,50 @@ function normalizeEvent(event: Event | null, depth: number, maxBreadth: number):

 return normalized;
}

/**
 * Parse either an `EventHint` directly, or convert a `CaptureContext` to an `EventHint`.
 * This is used to allow to update method signatures that used to accept a `CaptureContext` but should now accept an `EventHint`.
 */
export function parseEventHintOrCaptureContext(
 hint: ExclusiveEventHintOrCaptureContext | undefined,
): EventHint | undefined {
 if (!hint) {
 return undefined;
 }

 // If you pass a Scope or `() => Scope` as CaptureContext, we just return this as captureContext
 if (hintIsScopeOrFunction(hint)) {
 return { captureContext: hint };
 }

 if (hintIsScopeContext(hint)) {
 return {
 captureContext: hint,
 };
 }

 return hint;
}

function hintIsScopeOrFunction(
 hint: CaptureContext | EventHint,
): hint is ScopeInterface | ((scope: ScopeInterface) => ScopeInterface) {
 return hint instanceof Scope || typeof hint === 'function';
}

type ScopeContextProperty = keyof ScopeContext;
const captureContextKeys: readonly ScopeContextProperty[] = [
 'user',
 'level',
 'extra',
 'contexts',
 'tags',
 'fingerprint',
 'requestSession',
 'propagationContext',
] as const;

function hintIsScopeContext(hint: Partial<ScopeContext> | EventHint): hint is Partial<ScopeContext> {
 return Object.keys(hint).some(key => captureContextKeys.includes(key as ScopeContextProperty));
}
Loading