Skip to content

Commit 2356e80

Browse files
mydeamydea
authored
feat(core): Introduce processEvent hook on Integration (#9017)
This adds a new (optional) `processEvent` hook on the `Integration` interface, which allows to register an event processor **for the current client only**. This has actually correct semantics in that the processor will only be registered for the client that the integration is added for. This is done by adding a new `addEventProcessor` method on the client, which for now are called after all global & scope event processors. Previously, all integrations always registered a _global_ event processor, which is not really necessary. With this, we can be much more focused & also skip checking for existence of the integration on the client etc.
1 parent e24d7e0 commit 2356e80

File tree

9 files changed

+370
-80
lines changed

9 files changed

+370
-80
lines changed

‎packages/core/src/baseclient.ts‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import type {
1212
Event,
1313
EventDropReason,
1414
EventHint,
15+
EventProcessor,
1516
Integration,
1617
IntegrationClass,
1718
Outcome,
@@ -107,6 +108,8 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
107108
// eslint-disable-next-line @typescript-eslint/ban-types
108109
private _hooks: Record<string, Function[]>;
109110

111+
private _eventProcessors: EventProcessor[];
112+
110113
/**
111114
* Initializes this client instance.
112115
*
@@ -119,6 +122,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
119122
this._numProcessing = 0;
120123
this._outcomes = {};
121124
this._hooks = {};
125+
this._eventProcessors = [];
122126

123127
if (options.dsn) {
124128
this._dsn = makeDsn(options.dsn);
@@ -280,6 +284,16 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
280284
});
281285
}
282286

287+
/** Get all installed event processors. */
288+
public getEventProcessors(): EventProcessor[] {
289+
return this._eventProcessors;
290+
}
291+
292+
/** @inheritDoc */
293+
public addEventProcessor(eventProcessor: EventProcessor): void {
294+
this._eventProcessors.push(eventProcessor);
295+
}
296+
283297
/**
284298
* Sets up the integrations
285299
*/
@@ -545,7 +559,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
545559

546560
this.emit('preprocessEvent', event, hint);
547561

548-
return prepareEvent(options, event, hint, scope).then(evt => {
562+
return prepareEvent(options, event, hint, scope, this).then(evt => {
549563
if (evt === null) {
550564
return evt;
551565
}

‎packages/core/src/eventProcessors.ts‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
import type { Event, EventHint, EventProcessor } from '@sentry/types';
2+
import { getGlobalSingleton, isThenable, logger, SyncPromise } from '@sentry/utils';
3+
4+
/**
5+
* Returns the global event processors.
6+
*/
7+
export function getGlobalEventProcessors(): EventProcessor[] {
8+
return getGlobalSingleton<EventProcessor[]>('globalEventProcessors', () => []);
9+
}
10+
11+
/**
12+
* Add a EventProcessor to be kept globally.
13+
* @param callback EventProcessor to add
14+
*/
15+
export function addGlobalEventProcessor(callback: EventProcessor): void {
16+
getGlobalEventProcessors().push(callback);
17+
}
18+
19+
/**
20+
* Process an array of event processors, returning the processed event (or `null` if the event was dropped).
21+
*/
22+
export function notifyEventProcessors(
23+
processors: EventProcessor[],
24+
event: Event | null,
25+
hint: EventHint,
26+
index: number = 0,
27+
): PromiseLike<Event | null> {
28+
return new SyncPromise<Event | null>((resolve, reject) => {
29+
const processor = processors[index];
30+
if (event === null || typeof processor !== 'function') {
31+
resolve(event);
32+
} else {
33+
const result = processor({ ...event }, hint) as Event | null;
34+
35+
__DEBUG_BUILD__ &&
36+
processor.id &&
37+
result === null &&
38+
logger.log(`Event processor "${processor.id}" dropped event`);
39+
40+
if (isThenable(result)) {
41+
void result
42+
.then(final => notifyEventProcessors(processors, final, hint, index + 1).then(resolve))
43+
.then(null, reject);
44+
} else {
45+
void notifyEventProcessors(processors, result, hint, index + 1)
46+
.then(resolve)
47+
.then(null, reject);
48+
}
49+
}
50+
});
51+
}

‎packages/core/src/index.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ export {
3636
} from './hub';
3737
export { makeSession, closeSession, updateSession } from './session';
3838
export { SessionFlusher } from './sessionflusher';
39-
export { addGlobalEventProcessor, Scope } from './scope';
39+
export { Scope } from './scope';
40+
export { addGlobalEventProcessor } from './eventProcessors';
4041
export { getEnvelopeEndpointWithUrlEncodedAuth, getReportDialogEndpoint } from './api';
4142
export { BaseClient } from './baseclient';
4243
export { ServerRuntimeClient } from './server-runtime-client';

‎packages/core/src/integration.ts‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import type { Client, Integration, Options } from '@sentry/types';
1+
import type { Client, Event, EventHint, Integration, Options } from '@sentry/types';
22
import { arrayify, logger } from '@sentry/utils';
33

4+
import { addGlobalEventProcessor } from './eventProcessors';
45
import { getCurrentHub } from './hub';
5-
import { addGlobalEventProcessor } from './scope';
66

77
declare module '@sentry/types' {
88
interface Integration {
@@ -107,10 +107,20 @@ export function setupIntegration(client: Client, integration: Integration, integ
107107
}
108108

109109
if (client.on && typeof integration.preprocessEvent === 'function') {
110-
const callback = integration.preprocessEvent.bind(integration);
110+
const callback = integration.preprocessEvent.bind(integration) as typeof integration.preprocessEvent;
111111
client.on('preprocessEvent', (event, hint) => callback(event, hint, client));
112112
}
113113

114+
if (client.addEventProcessor && typeof integration.processEvent === 'function') {
115+
const callback = integration.processEvent.bind(integration) as typeof integration.processEvent;
116+
117+
const processor = Object.assign((event: Event, hint: EventHint) => callback(event, hint, client), {
118+
id: integration.name,
119+
});
120+
121+
client.addEventProcessor(processor);
122+
}
123+
114124
__DEBUG_BUILD__ && logger.log(`Integration installed: ${integration.name}`);
115125
}
116126

‎packages/core/src/scope.ts‎

Lines changed: 3 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,9 @@ import type {
2222
Transaction,
2323
User,
2424
} from '@sentry/types';
25-
import {
26-
arrayify,
27-
dateTimestampInSeconds,
28-
getGlobalSingleton,
29-
isPlainObject,
30-
isThenable,
31-
logger,
32-
SyncPromise,
33-
uuid4,
34-
} from '@sentry/utils';
25+
import { arrayify, dateTimestampInSeconds, isPlainObject, uuid4 } from '@sentry/utils';
3526

27+
import { getGlobalEventProcessors, notifyEventProcessors } from './eventProcessors';
3628
import { updateSession } from './session';
3729

3830
/**
@@ -525,7 +517,7 @@ export class Scope implements ScopeInterface {
525517
propagationContext: this._propagationContext,
526518
};
527519

528-
return this._notifyEventProcessors([...getGlobalEventProcessors(), ...this._eventProcessors], event, hint);
520+
return notifyEventProcessors([...getGlobalEventProcessors(), ...this._eventProcessors], event, hint);
529521
}
530522

531523
/**
@@ -559,40 +551,6 @@ export class Scope implements ScopeInterface {
559551
return this._breadcrumbs;
560552
}
561553

562-
/**
563-
* This will be called after {@link applyToEvent} is finished.
564-
*/
565-
protected _notifyEventProcessors(
566-
processors: EventProcessor[],
567-
event: Event | null,
568-
hint: EventHint,
569-
index: number = 0,
570-
): PromiseLike<Event | null> {
571-
return new SyncPromise<Event | null>((resolve, reject) => {
572-
const processor = processors[index];
573-
if (event === null || typeof processor !== 'function') {
574-
resolve(event);
575-
} else {
576-
const result = processor({ ...event }, hint) as Event | null;
577-
578-
__DEBUG_BUILD__ &&
579-
processor.id &&
580-
result === null &&
581-
logger.log(`Event processor "${processor.id}" dropped event`);
582-
583-
if (isThenable(result)) {
584-
void result
585-
.then(final => this._notifyEventProcessors(processors, final, hint, index + 1).then(resolve))
586-
.then(null, reject);
587-
} else {
588-
void this._notifyEventProcessors(processors, result, hint, index + 1)
589-
.then(resolve)
590-
.then(null, reject);
591-
}
592-
}
593-
});
594-
}
595-
596554
/**
597555
* This will be called on every set call.
598556
*/
@@ -629,21 +587,6 @@ export class Scope implements ScopeInterface {
629587
}
630588
}
631589

632-
/**
633-
* Returns the global event processors.
634-
*/
635-
function getGlobalEventProcessors(): EventProcessor[] {
636-
return getGlobalSingleton<EventProcessor[]>('globalEventProcessors', () => []);
637-
}
638-
639-
/**
640-
* Add a EventProcessor to be kept globally.
641-
* @param callback EventProcessor to add
642-
*/
643-
export function addGlobalEventProcessor(callback: EventProcessor): void {
644-
getGlobalEventProcessors().push(callback);
645-
}
646-
647590
function generatePropagationContext(): PropagationContext {
648591
return {
649592
traceId: uuid4(),

‎packages/core/src/utils/prepareEvent.ts‎

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
import type { ClientOptions, Event, EventHint, StackFrame, StackParser } from '@sentry/types';
1+
import type { Client, ClientOptions, Event, EventHint, StackFrame, StackParser } from '@sentry/types';
22
import { dateTimestampInSeconds, GLOBAL_OBJ, normalize, resolvedSyncPromise, truncate, uuid4 } from '@sentry/utils';
33

44
import { DEFAULT_ENVIRONMENT } from '../constants';
5+
import { notifyEventProcessors } from '../eventProcessors';
56
import { Scope } from '../scope';
67

78
/**
@@ -26,6 +27,7 @@ export function prepareEvent(
2627
event: Event,
2728
hint: EventHint,
2829
scope?: Scope,
30+
client?: Client,
2931
): PromiseLike<Event | null> {
3032
const { normalizeDepth = 3, normalizeMaxBreadth = 1_000 } = options;
3133
const prepared: Event = {
@@ -74,20 +76,25 @@ export function prepareEvent(
7476
result = finalScope.applyToEvent(prepared, hint);
7577
}
7678

77-
return result.then(evt => {
78-
if (evt) {
79-
// We apply the debug_meta field only after all event processors have ran, so that if any event processors modified
80-
// file names (e.g.the RewriteFrames integration) the filename -> debug ID relationship isn't destroyed.
81-
// This should not cause any PII issues, since we're only moving data that is already on the event and not adding
82-
// any new data
83-
applyDebugMeta(evt);
84-
}
79+
return result
80+
.then(evt => {
81+
// Process client-scoped event processors
82+
return client && client.getEventProcessors ? notifyEventProcessors(client.getEventProcessors(), evt, hint) : evt;
83+
})
84+
.then(evt => {
85+
if (evt) {
86+
// We apply the debug_meta field only after all event processors have ran, so that if any event processors modified
87+
// file names (e.g.the RewriteFrames integration) the filename -> debug ID relationship isn't destroyed.
88+
// This should not cause any PII issues, since we're only moving data that is already on the event and not adding
89+
// any new data
90+
applyDebugMeta(evt);
91+
}
8592

86-
if (typeof normalizeDepth === 'number' && normalizeDepth > 0) {
87-
return normalizeEvent(evt, normalizeDepth, normalizeMaxBreadth);
88-
}
89-
return evt;
90-
});
93+
if (typeof normalizeDepth === 'number' && normalizeDepth > 0) {
94+
return normalizeEvent(evt, normalizeDepth, normalizeMaxBreadth);
95+
}
96+
return evt;
97+
});
9198
}
9299

93100
/**

0 commit comments

Comments
 (0)