ref(integrations): Refactor pluggable integrations to avoid setupOnce (#9899)

Slowly getting rid of `getCurrentHub()`...

Author: mydea

packages/integrations/src/captureconsole.ts

@@ -1,4 +1,5 @@
-import type { EventProcessor, Hub, Integration } from '@sentry/types';
+import { captureException, captureMessage, getClient, withScope } from '@sentry/core';
+import type { CaptureContext, Client, EventProcessor, Hub, Integration } from '@sentry/types';
 import {
   CONSOLE_LEVELS,
   GLOBAL_OBJ,
@@ -36,33 +37,37 @@ export class CaptureConsole implements Integration {
   /**
    * @inheritDoc
    */
-  public setupOnce(_: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
+  public setupOnce(_: (callback: EventProcessor) => void, _getCurrentHub: () => Hub): void {
+    // noop
+  }
+
+  /** @inheritdoc */
+  public setup(client: Client): void {
     if (!('console' in GLOBAL_OBJ)) {
       return;
     }
 
     const levels = this._levels;
 
     addConsoleInstrumentationHandler(({ args, level }) => {
-      if (!levels.includes(level)) {
+      if (getClient() !== client || !levels.includes(level)) {
         return;
       }
 
-      const hub = getCurrentHub();
-
-      if (!hub.getIntegration(CaptureConsole)) {
-        return;
-      }
-
-      consoleHandler(hub, args, level);
+      consoleHandler(args, level);
     });
   }
 }
 
-function consoleHandler(hub: Hub, args: unknown[], level: string): void {
-  hub.withScope(scope => {
-    scope.setLevel(severityLevelFromString(level));
-    scope.setExtra('arguments', args);
+function consoleHandler(args: unknown[], level: string): void {
+  const captureContext: CaptureContext = {
+    level: severityLevelFromString(level),
+    extra: {
+      arguments: args,
+    },
+  };
+
+  withScope(scope => {
     scope.addEventProcessor(event => {
       event.logger = 'console';
 
@@ -74,18 +79,20 @@ function consoleHandler(hub: Hub, args: unknown[], level: string): void {
       return event;
     });
 
-    let message = safeJoin(args, ' ');
+    if (level === 'assert' && args[0] === false) {
+      const message = `Assertion failed: ${safeJoin(args.slice(1), ' ') || 'console.assert'}`;
+      scope.setExtra('arguments', args.slice(1));
+      captureMessage(message, captureContext);
+      return;
+    }
+
     const error = args.find(arg => arg instanceof Error);
-    if (level === 'assert') {
-      if (args[0] === false) {
-        message = `Assertion failed: ${safeJoin(args.slice(1), ' ') || 'console.assert'}`;
-        scope.setExtra('arguments', args.slice(1));
-        hub.captureMessage(message);
-      }
-    } else if (level === 'error' && error) {
-      hub.captureException(error);
-    } else {
-      hub.captureMessage(message);
+    if (level === 'error' && error) {
+      captureException(error, captureContext);
+      return;
     }
+
+    const message = safeJoin(args, ' ');
+    captureMessage(message, captureContext);
   });
 }

packages/integrations/src/debug.ts

@@ -1,4 +1,4 @@
-import type { Event, EventHint, EventProcessor, Hub, Integration } from '@sentry/types';
+import type { Client, Event, EventHint, EventProcessor, Hub, Integration } from '@sentry/types';
 import { consoleSandbox } from '@sentry/utils';
 
 interface DebugOptions {
@@ -38,32 +38,40 @@ export class Debug implements Integration {
   /**
    * @inheritDoc
    */
-  public setupOnce(_addGlobalEventProcessor: (eventProcessor: EventProcessor) => void, getCurrentHub: () => Hub): void {
-    const client = getCurrentHub().getClient();
+  public setupOnce(
+    _addGlobalEventProcessor: (eventProcessor: EventProcessor) => void,
+    _getCurrentHub: () => Hub,
+  ): void {
+    // noop
+  }
 
-    if (client && client.on) {
-      client.on('beforeSendEvent', (event: Event, hint?: EventHint) => {
-        if (this._options.debugger) {
-          // eslint-disable-next-line no-debugger
-          debugger;
-        }
+  /** @inheritdoc */
+  public setup(client: Client): void {
+    if (!client.on) {
+      return;
+    }
+
+    client.on('beforeSendEvent', (event: Event, hint?: EventHint) => {
+      if (this._options.debugger) {
+        // eslint-disable-next-line no-debugger
+        debugger;
+      }
 
-        /* eslint-disable no-console */
-        consoleSandbox(() => {
-          if (this._options.stringify) {
-            console.log(JSON.stringify(event, null, 2));
-            if (hint && Object.keys(hint).length) {
-              console.log(JSON.stringify(hint, null, 2));
-            }
-          } else {
-            console.log(event);
-            if (hint && Object.keys(hint).length) {
-              console.log(hint);
-            }
+      /* eslint-disable no-console */
+      consoleSandbox(() => {
+        if (this._options.stringify) {
+          console.log(JSON.stringify(event, null, 2));
+          if (hint && Object.keys(hint).length) {
+            console.log(JSON.stringify(hint, null, 2));
           }
-        });
-        /* eslint-enable no-console */
+        } else {
+          console.log(event);
+          if (hint && Object.keys(hint).length) {
+            console.log(hint);
+          }
+        }
       });
-    }
+      /* eslint-enable no-console */
+    });
   }
 }

packages/integrations/src/httpclient.ts

@@ -1,5 +1,6 @@
-import { getClient, isSentryRequestUrl } from '@sentry/core';
+import { captureEvent, getClient, isSentryRequestUrl } from '@sentry/core';
 import type {
+  Client,
   Event as SentryEvent,
   EventProcessor,
   Hub,
@@ -20,6 +21,7 @@ import { DEBUG_BUILD } from './debug-build';
 
 export type HttpStatusCodeRange = [number, number] | number;
 export type HttpRequestTarget = string | RegExp;
+
 interface HttpClientOptions {
   /**
    * HTTP status codes that should be considered failed.
@@ -55,11 +57,6 @@ export class HttpClient implements Integration {
 
   private readonly _options: HttpClientOptions;
 
-  /**
-   * Returns current hub.
-   */
-  private _getCurrentHub?: () => Hub;
-
   /**
    * @inheritDoc
    *
@@ -79,10 +76,14 @@ export class HttpClient implements Integration {
    *
    * @param options
    */
-  public setupOnce(_: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
-    this._getCurrentHub = getCurrentHub;
-    this._wrapFetch();
-    this._wrapXHR();
+  public setupOnce(_: (callback: EventProcessor) => void, _getCurrentHub: () => Hub): void {
+    // noop
+  }
+
+  /** @inheritdoc */
+  public setup(client: Client): void {
+    this._wrapFetch(client);
+    this._wrapXHR(client);
   }
 
   /**
@@ -93,13 +94,12 @@ export class HttpClient implements Integration {
    * @param requestInit The request init object
    */
   private _fetchResponseHandler(requestInfo: RequestInfo, response: Response, requestInit?: RequestInit): void {
-    if (this._getCurrentHub && this._shouldCaptureResponse(response.status, response.url)) {
+    if (this._shouldCaptureResponse(response.status, response.url)) {
       const request = _getRequest(requestInfo, requestInit);
-      const hub = this._getCurrentHub();
 
       let requestHeaders, responseHeaders, requestCookies, responseCookies;
 
-      if (hub.shouldSendDefaultPii()) {
+      if (_shouldSendDefaultPii()) {
         [{ headers: requestHeaders, cookies: requestCookies }, { headers: responseHeaders, cookies: responseCookies }] =
           [
             { cookieHeader: 'Cookie', obj: request },
@@ -135,7 +135,7 @@ export class HttpClient implements Integration {
         responseCookies,
       });
 
-      hub.captureEvent(event);
+      captureEvent(event);
     }
   }
 
@@ -147,11 +147,10 @@ export class HttpClient implements Integration {
    * @param headers The HTTP headers
    */
   private _xhrResponseHandler(xhr: XMLHttpRequest, method: string, headers: Record<string, string>): void {
-    if (this._getCurrentHub && this._shouldCaptureResponse(xhr.status, xhr.responseURL)) {
+    if (this._shouldCaptureResponse(xhr.status, xhr.responseURL)) {
       let requestHeaders, responseCookies, responseHeaders;
-      const hub = this._getCurrentHub();
 
-      if (hub.shouldSendDefaultPii()) {
+      if (_shouldSendDefaultPii()) {
         try {
           const cookieString = xhr.getResponseHeader('Set-Cookie') || xhr.getResponseHeader('set-cookie') || undefined;
 
@@ -181,7 +180,7 @@ export class HttpClient implements Integration {
         responseCookies,
       });
 
-      hub.captureEvent(event);
+      captureEvent(event);
     }
   }
 
@@ -296,12 +295,16 @@ export class HttpClient implements Integration {
   /**
    * Wraps `fetch` function to capture request and response data
    */
-  private _wrapFetch(): void {
+  private _wrapFetch(client: Client): void {
     if (!supportsNativeFetch()) {
       return;
     }
 
     addFetchInstrumentationHandler(handlerData => {
+      if (getClient() !== client) {
+        return;
+      }
+
       const { response, args } = handlerData;
       const [requestInfo, requestInit] = args as [RequestInfo, RequestInit | undefined];
 
@@ -316,12 +319,16 @@ export class HttpClient implements Integration {
   /**
    * Wraps XMLHttpRequest to capture request and response data
    */
-  private _wrapXHR(): void {
+  private _wrapXHR(client: Client): void {
     if (!('XMLHttpRequest' in GLOBAL_OBJ)) {
       return;
     }
 
     addXhrInstrumentationHandler(handlerData => {
+      if (getClient() !== client) {
+        return;
+      }
+
       const xhr = handlerData.xhr as SentryWrappedXMLHttpRequest & XMLHttpRequest;
 
       const sentryXhrData = xhr[SENTRY_XHR_DATA_KEY];
@@ -418,3 +425,8 @@ function _getRequest(requestInfo: RequestInfo, requestInit?: RequestInit): Reque
 
   return new Request(requestInfo, requestInit);
 }
+
+function _shouldSendDefaultPii(): boolean {
+  const client = getClient();
+  return client ? Boolean(client.getOptions().sendDefaultPii) : false;
+}

packages/integrations/src/reportingobserver.ts

@@ -1,4 +1,5 @@
-import type { EventProcessor, Hub, Integration } from '@sentry/types';
+import { captureMessage, getClient, withScope } from '@sentry/core';
+import type { Client, EventProcessor, Hub, Integration } from '@sentry/types';
 import { GLOBAL_OBJ, supportsReportingObserver } from '@sentry/utils';
 
 const WINDOW = GLOBAL_OBJ as typeof GLOBAL_OBJ & Window;
@@ -39,6 +40,8 @@ interface InterventionReportBody {
   columnNumber?: number;
 }
 
+const SETUP_CLIENTS: Client[] = [];
+
 /** Reporting API integration - https://w3c.github.io/reporting/ */
 export class ReportingObserver implements Integration {
   /**
@@ -51,11 +54,6 @@ export class ReportingObserver implements Integration {
    */
   public readonly name: string;
 
-  /**
-   * Returns current hub.
-   */
-  private _getCurrentHub?: () => Hub;
-
   private readonly _types: ReportTypes[];
 
   /**
@@ -74,13 +72,11 @@ export class ReportingObserver implements Integration {
   /**
    * @inheritDoc
    */
-  public setupOnce(_: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
+  public setupOnce(_: (callback: EventProcessor) => void, _getCurrentHub: () => Hub): void {
     if (!supportsReportingObserver()) {
       return;
     }
 
-    this._getCurrentHub = getCurrentHub;
-
     // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
     const observer = new (WINDOW as any).ReportingObserver(this.handler.bind(this), {
       buffered: true,
@@ -91,16 +87,25 @@ export class ReportingObserver implements Integration {
     observer.observe();
   }
 
+  /** @inheritdoc */
+  public setup(client: Client): void {
+    if (!supportsReportingObserver()) {
+      return;
+    }
+
+    SETUP_CLIENTS.push(client);
+  }
+
   /**
    * @inheritDoc
    */
   public handler(reports: Report[]): void {
-    const hub = this._getCurrentHub && this._getCurrentHub();
-    if (!hub || !hub.getIntegration(ReportingObserver)) {
+    if (!SETUP_CLIENTS.includes(getClient() as Client)) {
       return;
     }
+
     for (const report of reports) {
-      hub.withScope(scope => {
+      withScope(scope => {
         scope.setExtra('url', report.url);
 
         const label = `ReportingObserver [${report.type}]`;
@@ -129,7 +134,7 @@ export class ReportingObserver implements Integration {
           }
         }
 
-        hub.captureMessage(`${label}: ${details}`);
+        captureMessage(`${label}: ${details}`);
       });
     }
   }