fix(core): ensure LinkedErrors integration runs before eventProcessors

Author: mydea

packages/browser/src/integrations/linkederrors.ts

@@ -1,4 +1,4 @@
-import type { Event, EventHint, EventProcessor, Hub, Integration } from '@sentry/types';
+import type { EventProcessor, Hub, Integration } from '@sentry/types';
 import { applyAggregateErrorsToEvent } from '@sentry/utils';
 
 import { exceptionFromError } from '../eventbuilder';
@@ -45,28 +45,29 @@ export class LinkedErrors implements Integration {
   /**
    * @inheritDoc
    */
-  public setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
-    addGlobalEventProcessor((event: Event, hint?: EventHint) => {
-      const hub = getCurrentHub();
-      const client = hub.getClient();
-      const self = hub.getIntegration(LinkedErrors);
+  public setupOnce(_addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
+    const client = getCurrentHub().getClient();
+    if (client && client.on) {
+      client.on('preprocessEvent', (event, hint) => {
+        const hub = getCurrentHub();
+        const client = hub.getClient();
+        const self = hub.getIntegration(LinkedErrors);
 
-      if (!client || !self) {
-        return event;
-      }
+        if (!client || !self) {
+          return;
+        }
 
-      const options = client.getOptions();
-      applyAggregateErrorsToEvent(
-        exceptionFromError,
-        options.stackParser,
-        options.maxValueLength,
-        self._key,
-        self._limit,
-        event,
-        hint,
-      );
-
-      return event;
-    });
+        const options = client.getOptions();
+        applyAggregateErrorsToEvent(
+          exceptionFromError,
+          options.stackParser,
+          options.maxValueLength,
+          self._key,
+          self._limit,
+          event,
+          hint,
+        );
+      });
+    }
   }
 }

packages/core/src/baseclient.ts

@@ -384,7 +384,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
   public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 
   /** @inheritdoc */
-  public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): void;
+  public on(hook: 'beforeSendEvent' | 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): void;
 
   /** @inheritdoc */
   public on(
@@ -418,7 +418,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
   public emit(hook: 'beforeEnvelope', envelope: Envelope): void;
 
   /** @inheritdoc */
-  public emit(hook: 'beforeSendEvent', event: Event, hint?: EventHint): void;
+  public emit(hook: 'beforeSendEvent' | 'preprocessEvent', event: Event, hint?: EventHint): void;
 
   /** @inheritdoc */
   public emit(hook: 'afterSendEvent', event: Event, sendResponse: TransportMakeRequestResponse | void): void;
@@ -528,6 +528,9 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
     if (!hint.integrations && integrations.length > 0) {
       hint.integrations = integrations;
     }
+
+    this.emit('preprocessEvent', event, hint);
+
     return prepareEvent(options, event, hint, scope).then(evt => {
       if (evt === null) {
         return evt;

packages/node/src/integrations/linkederrors.ts

@@ -1,8 +1,7 @@
-import type { Event, EventHint, EventProcessor, Hub, Integration } from '@sentry/types';
+import type { EventProcessor, Hub, Integration } from '@sentry/types';
 import { applyAggregateErrorsToEvent } from '@sentry/utils';
 
 import { exceptionFromError } from '../eventbuilder';
-import { ContextLines } from './contextlines';
 
 const DEFAULT_KEY = 'cause';
 const DEFAULT_LIMIT = 5;
@@ -40,36 +39,31 @@ export class LinkedErrors implements Integration {
   /**
    * @inheritDoc
    */
-  public setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
-    addGlobalEventProcessor(async (event: Event, hint?: EventHint) => {
-      const hub = getCurrentHub();
-      const client = hub.getClient();
-      const self = hub.getIntegration(LinkedErrors);
+  public setupOnce(_addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
+    const client = getCurrentHub().getClient();
+    if (client && client.on) {
+      client.on('preprocessEvent', (event, hint) => {
+        const hub = getCurrentHub();
+        const client = hub.getClient();
 
-      if (!client || !self) {
-        return event;
-      }
+        const self = hub.getIntegration(LinkedErrors);
 
-      const options = client.getOptions();
+        if (!client || !self) {
+          return;
+        }
 
-      applyAggregateErrorsToEvent(
-        exceptionFromError,
-        options.stackParser,
-        options.maxValueLength,
-        self._key,
-        self._limit,
-        event,
-        hint,
-      );
+        const options = client.getOptions();
 
-      // If the ContextLines integration is enabled, we add source code context to linked errors
-      // because we can't guarantee the order that integrations are run.
-      const contextLines = getCurrentHub().getIntegration(ContextLines);
-      if (contextLines) {
-        await contextLines.addSourceContext(event);
-      }
-
-      return event;
-    });
+        applyAggregateErrorsToEvent(
+          exceptionFromError,
+          options.stackParser,
+          options.maxValueLength,
+          self._key,
+          self._limit,
+          event,
+          hint,
+        );
+      });
+    }
   }
 }

packages/types/src/client.ts

@@ -177,9 +177,15 @@ export interface Client<O extends ClientOptions = ClientOptions> {
   on?(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 
   /**
-   * Register a callback for before an event is sent.
+   * Register a callback for before sending an event.
+   * `beforeSendEvent` is called right before an event is sent and should not be used to mutate the event.
+   * `preprocessEvent` is called before all global event processors.
+   * Receives an Event & EventHint as arguments.
    */
-  on?(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | void) => void): void;
+  on?(
+    hook: 'beforeSendEvent' | 'preprocessEvent',
+    callback: (event: Event, hint?: EventHint | undefined) => void,
+  ): void;
 
   /**
    * Register a callback for when an event has been sent.
@@ -217,11 +223,13 @@ export interface Client<O extends ClientOptions = ClientOptions> {
    */
   emit?(hook: 'beforeEnvelope', envelope: Envelope): void;
 
-  /*
-   * Fire a hook event before sending an event. Expects to be given an Event & EventHint as the
-   * second/third argument.
+  /**
+   * Fire a hook event before sending an event.
+   * `beforeSendEvent` is called right before an event is sent and should not be used to mutate the event.
+   * `preprocessEvent` is called before all global event processors.
+   * Expects to be given an Event & EventHint as the second/third argument.
    */
-  emit?(hook: 'beforeSendEvent', event: Event, hint?: EventHint): void;
+  emit?(hook: 'beforeSendEvent' | 'preprocessEvent', event: Event, hint?: EventHint): void;
 
   /*
    * Fire a hook event after sending an event. Expects to be given an Event as the