ref: Make setupOnce optional in integrations

mydea · mydea · commit 108688ce10a4 · 2024-02-19T17:00:28.000+01:00
diff --git a/packages/browser/src/integrations/breadcrumbs.ts b/packages/browser/src/integrations/breadcrumbs.ts
@@ -71,7 +71,6 @@ const _breadcrumbsIntegration = ((options: Partial<BreadcrumbsOptions> = {}) =>
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client) {
       if (_options.console) {
         addConsoleInstrumentationHandler(_getConsoleBreadcrumbHandler(client));
diff --git a/packages/browser/src/integrations/dedupe.ts b/packages/browser/src/integrations/dedupe.ts
@@ -12,7 +12,6 @@ const _dedupeIntegration = (() => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(currentEvent) {
       // We want to ignore any non-error type events, e.g. transactions or replays
       // These should never be deduped, and also not be compared against as _previousEvent.
diff --git a/packages/browser/src/integrations/httpcontext.ts b/packages/browser/src/integrations/httpcontext.ts
@@ -9,7 +9,6 @@ const _httpContextIntegration = (() => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     preprocessEvent(event) {
       // if none of the information we want exists, don't bother
       if (!WINDOW.navigator && !WINDOW.location && !WINDOW.document) {
diff --git a/packages/browser/src/integrations/linkederrors.ts b/packages/browser/src/integrations/linkederrors.ts
@@ -20,7 +20,6 @@ const _linkedErrorsIntegration = ((options: LinkedErrorsOptions = {}) => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     preprocessEvent(event, hint, client) {
       const options = client.getOptions();
 
diff --git a/packages/browser/src/profiling/integration.ts b/packages/browser/src/profiling/integration.ts
@@ -22,7 +22,6 @@ const _browserProfilingIntegration = (() => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client) {
       const scope = getCurrentScope();
 
diff --git a/packages/core/src/integration.ts b/packages/core/src/integration.ts
@@ -129,7 +129,7 @@ export function setupIntegration(client: Client, integration: Integration, integ
   integrationIndex[integration.name] = integration;
 
   // `setupOnce` is only called the first time
-  if (installedIntegrations.indexOf(integration.name) === -1) {
+  if (installedIntegrations.indexOf(integration.name) === -1 && typeof integration.setupOnce === 'function') {
     // eslint-disable-next-line deprecation/deprecation
     integration.setupOnce(addGlobalEventProcessor, getCurrentHub);
     installedIntegrations.push(integration.name);
diff --git a/packages/core/src/integrations/inboundfilters.ts b/packages/core/src/integrations/inboundfilters.ts
@@ -34,7 +34,6 @@ const _inboundFiltersIntegration = ((options: Partial<InboundFiltersOptions> = {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(event, _hint, client) {
       const clientOptions = client.getOptions();
       const mergedOptions = _mergeOptions(options, clientOptions);
diff --git a/packages/core/src/integrations/linkederrors.ts b/packages/core/src/integrations/linkederrors.ts
@@ -19,7 +19,6 @@ const _linkedErrorsIntegration = ((options: LinkedErrorsOptions = {}) => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     preprocessEvent(event, hint, client) {
       const options = client.getOptions();
 
diff --git a/packages/core/src/integrations/metadata.ts b/packages/core/src/integrations/metadata.ts
@@ -10,7 +10,6 @@ const _moduleMetadataIntegration = (() => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client) {
       // We need to strip metadata from stack frames before sending them to Sentry since these are client side only.
       client.on('beforeEnvelope', envelope => {
diff --git a/packages/core/src/integrations/requestdata.ts b/packages/core/src/integrations/requestdata.ts
@@ -76,7 +76,6 @@ const _requestDataIntegration = ((options: RequestDataIntegrationOptions = {}) =
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(event, _hint, client) {
       // Note: In the long run, most of the logic here should probably move into the request data utility functions. For
       // the moment it lives here, though, until https://github.com/getsentry/sentry-javascript/issues/5718 is addressed.
diff --git a/packages/deno/src/integrations/context.ts b/packages/deno/src/integrations/context.ts
@@ -56,7 +56,6 @@ const _denoContextIntegration = (() => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(event) {
       return addDenoRuntimeContext(event);
     },
diff --git a/packages/deno/src/integrations/contextlines.ts b/packages/deno/src/integrations/contextlines.ts
@@ -53,7 +53,6 @@ const _contextLinesIntegration = ((options: ContextLinesOptions = {}) => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(event) {
       return addSourceContext(event, contextLines);
     },
diff --git a/packages/deno/src/integrations/globalhandlers.ts b/packages/deno/src/integrations/globalhandlers.ts
@@ -32,7 +32,6 @@ const _globalHandlersIntegration = ((options?: GlobalHandlersIntegrations) => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client) {
       if (_options.error) {
         installGlobalErrorHandler(client);
diff --git a/packages/deno/src/integrations/normalizepaths.ts b/packages/deno/src/integrations/normalizepaths.ts
@@ -71,7 +71,6 @@ const _normalizePathsIntegration = (() => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(event) {
       // This error.stack hopefully contains paths that traverse the app cwd
       const error = new Error();
diff --git a/packages/integrations/src/captureconsole.ts b/packages/integrations/src/captureconsole.ts
@@ -21,7 +21,6 @@ const _captureConsoleIntegration = ((options: CaptureConsoleOptions = {}) => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client) {
       if (!('console' in GLOBAL_OBJ)) {
         return;
diff --git a/packages/integrations/src/contextlines.ts b/packages/integrations/src/contextlines.ts
@@ -24,7 +24,6 @@ const _contextLinesIntegration = ((options: ContextLinesOptions = {}) => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(event) {
       return addSourceContext(event, contextLines);
     },
diff --git a/packages/integrations/src/debug.ts b/packages/integrations/src/debug.ts
@@ -25,7 +25,6 @@ const _debugIntegration = ((options: DebugOptions = {}) => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client) {
       client.on('beforeSendEvent', (event: Event, hint?: EventHint) => {
         if (_options.debugger) {
diff --git a/packages/integrations/src/dedupe.ts b/packages/integrations/src/dedupe.ts
@@ -12,7 +12,6 @@ const _dedupeIntegration = (() => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(currentEvent) {
       // We want to ignore any non-error type events, e.g. transactions or replays
       // These should never be deduped, and also not be compared against as _previousEvent.
diff --git a/packages/integrations/src/extraerrordata.ts b/packages/integrations/src/extraerrordata.ts
@@ -28,7 +28,6 @@ const _extraErrorDataIntegration = ((options: Partial<ExtraErrorDataOptions> = {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(event, hint) {
       return _enhanceEventWithErrorData(event, hint, depth, captureErrorCause);
     },
diff --git a/packages/integrations/src/httpclient.ts b/packages/integrations/src/httpclient.ts
@@ -48,7 +48,6 @@ const _httpClientIntegration = ((options: Partial<HttpClientOptions> = {}) => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client): void {
       _wrapFetch(client, _options);
       _wrapXHR(client, _options);
diff --git a/packages/integrations/src/rewriteframes.ts b/packages/integrations/src/rewriteframes.ts
@@ -72,7 +72,6 @@ const _rewriteFramesIntegration = ((options: RewriteFramesOptions = {}) => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(originalEvent) {
       let processedEvent = originalEvent;
 
diff --git a/packages/integrations/src/sessiontiming.ts b/packages/integrations/src/sessiontiming.ts
@@ -9,7 +9,6 @@ const _sessionTimingIntegration = (() => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(event) {
       const now = Date.now();
 
diff --git a/packages/node/src/integrations/anr/index.ts b/packages/node/src/integrations/anr/index.ts
@@ -56,7 +56,6 @@ const _anrIntegration = ((options: Partial<AnrIntegrationOptions> = {}) => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client: NodeClient) {
       if (NODE_VERSION.major < 16 || (NODE_VERSION.major === 16 && NODE_VERSION.minor < 17)) {
         throw new Error('ANR detection requires Node 16.17.0 or later');
diff --git a/packages/node/src/integrations/console.ts b/packages/node/src/integrations/console.ts
@@ -9,7 +9,6 @@ const _consoleIntegration = (() => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client) {
       addConsoleInstrumentationHandler(({ args, level }) => {
         if (getClient() !== client) {
diff --git a/packages/node/src/integrations/context.ts b/packages/node/src/integrations/context.ts
@@ -103,7 +103,6 @@ const _nodeContextIntegration = ((options: ContextOptions = {}) => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(event) {
       return addContext(event);
     },
diff --git a/packages/node/src/integrations/contextlines.ts b/packages/node/src/integrations/contextlines.ts
@@ -41,7 +41,6 @@ const _contextLinesIntegration = ((options: ContextLinesOptions = {}) => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(event) {
       return addSourceContext(event, contextLines);
     },
diff --git a/packages/node/src/integrations/local-variables/local-variables-async.ts b/packages/node/src/integrations/local-variables/local-variables-async.ts
@@ -221,7 +221,6 @@ const _localVariablesAsyncIntegration = ((options: LocalVariablesIntegrationOpti
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client: NodeClient) {
       const clientOptions = client.getOptions();
 
diff --git a/packages/node/src/integrations/modules.ts b/packages/node/src/integrations/modules.ts
@@ -80,7 +80,6 @@ const _modulesIntegration = (() => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     processEvent(event) {
       event.modules = {
         ...event.modules,
diff --git a/packages/node/src/integrations/onuncaughtexception.ts b/packages/node/src/integrations/onuncaughtexception.ts
@@ -49,7 +49,6 @@ const _onUncaughtExceptionIntegration = ((options: Partial<OnUncaughtExceptionOp
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client: NodeClient) {
       global.process.on('uncaughtException', makeErrorHandler(client, _options));
     },
diff --git a/packages/node/src/integrations/onunhandledrejection.ts b/packages/node/src/integrations/onunhandledrejection.ts
@@ -22,7 +22,6 @@ const _onUnhandledRejectionIntegration = ((options: Partial<OnUnhandledRejection
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client) {
       global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, { mode }));
     },
diff --git a/packages/node/src/integrations/spotlight.ts b/packages/node/src/integrations/spotlight.ts
@@ -22,7 +22,6 @@ const _spotlightIntegration = ((options: Partial<SpotlightConnectionOptions> = {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client) {
       if (typeof process === 'object' && process.env && process.env.NODE_ENV !== 'development') {
         logger.warn("[Spotlight] It seems you're not in dev mode. Do you really want to have Spotlight enabled?");
diff --git a/packages/replay-canvas/src/canvas.ts b/packages/replay-canvas/src/canvas.ts
@@ -66,8 +66,6 @@ export const _replayCanvasIntegration = ((options: Partial<ReplayCanvasOptions>
 
   return {
     name: INTEGRATION_NAME,
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    setupOnce() {},
     getOptions(): ReplayCanvasIntegrationOptions {
       const { quality, enableManualSnapshot } = _canvasOptions;
 
diff --git a/packages/types/src/integration.ts b/packages/types/src/integration.ts
@@ -24,10 +24,8 @@ export interface IntegrationFnResult {
   /**
    * This hook is only called once, even if multiple clients are created.
    * It does not receives any arguments, and should only use for e.g. global monkey patching and similar things.
-   *
-   * NOTE: In v8, this will become optional.
    */
-  setupOnce(): void;
+  setupOnce?(): void;
 
   /**
    * Set up an integration for the given client.
@@ -74,10 +72,8 @@ export interface Integration {
   /**
    * This hook is only called once, even if multiple clients are created.
    * It does not receives any arguments, and should only use for e.g. global monkey patching and similar things.
-   *
-   * NOTE: In v8, this will become optional, and not receive any arguments anymore.
    */
-  setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void;
+  setupOnce?(addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void;
 
   /**
    * Set up an integration for the given client.
diff --git a/packages/vercel-edge/src/integrations/wintercg-fetch.ts b/packages/vercel-edge/src/integrations/wintercg-fetch.ts
@@ -87,8 +87,6 @@ const _winterCGFetch = ((options: Partial<Options> = {}) => {
 
   return {
     name: INTEGRATION_NAME,
-    // TODO v8: Remove this again
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
     setupOnce() {
       addFetchInstrumentationHandler(handlerData => {
         const client = getClient();
diff --git a/packages/vue/src/integration.ts b/packages/vue/src/integration.ts
@@ -25,7 +25,6 @@ const _vueIntegration = ((integrationOptions: Partial<VueOptions> = {}) => {
   return {
     name: INTEGRATION_NAME,
     // TODO v8: Remove this
-    setupOnce() {}, // eslint-disable-line @typescript-eslint/no-empty-function
     setup(client) {
       _setupIntegration(client, integrationOptions);
     },
