feat(core): Add addEventProcessor method

And deprecate `addGlobalEventProcessor()` and `getGlobalEventProcessors()`.

In v8, all event processors will be on the client only, streamlining this a bit and preventing global "pollution".

Author: mydea

packages/astro/src/index.server.ts

@@ -7,7 +7,9 @@ import { sentryAstro } from './integration';
 
 // Hence, we export everything from the Node SDK explicitly:
 export {
+  // eslint-disable-next-line deprecation/deprecation
   addGlobalEventProcessor,
+  addEventProcessor,
   addBreadcrumb,
   captureException,
   captureEvent,

packages/browser/src/exports.ts

@@ -21,7 +21,9 @@ export type { BrowserOptions } from './client';
 export type { ReportDialogOptions } from './helpers';
 
 export {
+  // eslint-disable-next-line deprecation/deprecation
   addGlobalEventProcessor,
+  addEventProcessor,
   addBreadcrumb,
   addIntegration,
   captureException,

packages/browser/src/integrations/dedupe.ts

@@ -23,7 +23,7 @@ export class Dedupe implements Integration {
   }
 
   /** @inheritDoc */
-  public setupOnce(_addGlobaleventProcessor: unknown, _getCurrentHub: unknown): void {
+  public setupOnce(_addGlobalEventProcessor: unknown, _getCurrentHub: unknown): void {
     // noop
   }
 

packages/bun/src/index.ts

@@ -24,7 +24,9 @@ export type { TransactionNamingScheme } from '@sentry/node';
 export type { BunOptions } from './types';
 
 export {
+  // eslint-disable-next-line deprecation/deprecation
   addGlobalEventProcessor,
+  addEventProcessor,
   addBreadcrumb,
   addIntegration,
   captureException,

packages/core/src/eventProcessors.ts

@@ -1,21 +1,39 @@
 import type { Event, EventHint, EventProcessor } from '@sentry/types';
 import { getGlobalSingleton, isThenable, logger, SyncPromise } from '@sentry/utils';
 
+import { getCurrentHub } from './hub';
+
 /**
  * Returns the global event processors.
+ * @deprecated Global event processors will be removed in v8.
  */
 export function getGlobalEventProcessors(): EventProcessor[] {
   return getGlobalSingleton<EventProcessor[]>('globalEventProcessors', () => []);
 }
 
 /**
  * Add a EventProcessor to be kept globally.
- * @param callback EventProcessor to add
+ * @deprecated Use `addEventProcessor` instead. Global event processors will be removed in v8.
  */
 export function addGlobalEventProcessor(callback: EventProcessor): void {
+  // eslint-disable-next-line deprecation/deprecation
   getGlobalEventProcessors().push(callback);
 }
 
+/**
+ * Add an event processor to the current client.
+ * This event processor will run for all events processed by this client.
+ */
+export function addEventProcessor(callback: EventProcessor): void {
+  const client = getCurrentHub().getClient();
+
+  if (!client || !client.addEventProcessor) {
+    return;
+  }
+
+  client.addEventProcessor(callback);
+}
+
 /**
  * Process an array of event processors, returning the processed event (or `null` if the event was dropped).
  */

packages/core/src/index.ts

@@ -39,7 +39,11 @@ export {
 export { makeSession, closeSession, updateSession } from './session';
 export { SessionFlusher } from './sessionflusher';
 export { Scope } from './scope';
-export { addGlobalEventProcessor } from './eventProcessors';
+export {
+  // eslint-disable-next-line deprecation/deprecation
+  addGlobalEventProcessor,
+  addEventProcessor,
+} from './eventProcessors';
 export { getEnvelopeEndpointWithUrlEncodedAuth, getReportDialogEndpoint } from './api';
 export { BaseClient } from './baseclient';
 export { ServerRuntimeClient } from './server-runtime-client';

packages/core/src/integration.ts

@@ -103,6 +103,7 @@ export function setupIntegration(client: Client, integration: Integration, integ
 
   // `setupOnce` is only called the first time
   if (installedIntegrations.indexOf(integration.name) === -1) {
+    // eslint-disable-next-line deprecation/deprecation
     integration.setupOnce(addGlobalEventProcessor, getCurrentHub);
     installedIntegrations.push(integration.name);
   }

packages/core/src/integrations/inboundfilters.ts

@@ -48,7 +48,7 @@ export class InboundFilters implements Integration {
   /**
    * @inheritDoc
    */
-  public setupOnce(_addGlobaleventProcessor: unknown, _getCurrentHub: unknown): void {
+  public setupOnce(_addGlobalEventProcessor: unknown, _getCurrentHub: unknown): void {
     // noop
   }
 

packages/core/src/scope.ts

@@ -523,7 +523,12 @@ export class Scope implements ScopeInterface {
 
     // TODO (v8): Update this order to be: Global > Client > Scope
     return notifyEventProcessors(
-      [...(additionalEventProcessors || []), ...getGlobalEventProcessors(), ...this._eventProcessors],
+      [
+        ...(additionalEventProcessors || []),
+        // eslint-disable-next-line deprecation/deprecation
+        ...getGlobalEventProcessors(),
+        ...this._eventProcessors,
+      ],
       event,
       hint,
     );

packages/core/src/utils/prepareEvent.ts

@@ -79,7 +79,15 @@ export function prepareEvent(
   } else {
     // Apply client & global event processors even if there is no scope
     // TODO (v8): Update the order to be Global > Client
-    result = notifyEventProcessors([...clientEventProcessors, ...getGlobalEventProcessors()], prepared, hint);
+    result = notifyEventProcessors(
+      [
+        ...clientEventProcessors,
+        // eslint-disable-next-line deprecation/deprecation
+        ...getGlobalEventProcessors(),
+      ],
+      prepared,
+      hint,
+    );
   }
 
   return result.then(evt => {