ref: Clean up new integrations API and pave migration path

Author: Luca Forstner

packages/core/src/integration.ts

@@ -1,4 +1,4 @@
-import type { Client, Event, EventHint, Integration, IntegrationFn, Options } from '@sentry/types';
+import type { Client, Event, EventHint, Integration, IntegrationFn, IntegrfiationClass, Options } from '@sentry/types';
 import { arrayify, logger } from '@sentry/utils';
 
 import { DEBUG_BUILD } from './debug-build';
@@ -184,3 +184,11 @@ export function convertIntegrationFnToClass<Fn extends IntegrationFn>(
     new (...args: Parameters<Fn>): Integration & ReturnType<Fn>;
   };
 }
+
+/**
+ * Utility function to aid with creating Sentry SDK integrations.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function defineSentryIntegration<F extends (...args: any[]) => Integration>(integrationFactory: F): F {
+  return integrationFactory;
+}

packages/core/src/integrations/functiontostring.ts

@@ -1,33 +1,48 @@
-import type { IntegrationFn, WrappedFunction } from '@sentry/types';
+import type { Integration, WrappedFunction } from '@sentry/types';
 import { getOriginalFunction } from '@sentry/utils';
-import { convertIntegrationFnToClass } from '../integration';
+import { defineSentryIntegration } from '../integration';
 
 let originalFunctionToString: () => void;
 
 const INTEGRATION_NAME = 'FunctionToString';
 
-const functionToStringIntegration: IntegrationFn = () => {
-  return {
-    name: INTEGRATION_NAME,
-    setupOnce() {
-      // eslint-disable-next-line @typescript-eslint/unbound-method
-      originalFunctionToString = Function.prototype.toString;
-
-      // intrinsics (like Function.prototype) might be immutable in some environments
-      // e.g. Node with --frozen-intrinsics, XS (an embedded JavaScript engine) or SES (a JavaScript proposal)
-      try {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        Function.prototype.toString = function (this: WrappedFunction, ...args: any[]): string {
-          const context = getOriginalFunction(this) || this;
-          return originalFunctionToString.apply(context, args);
-        };
-      } catch {
-        // ignore errors here, just don't patch this
-      }
-    },
-  };
-};
-
-/** Patch toString calls to return proper name for wrapped functions */
-// eslint-disable-next-line deprecation/deprecation
-export const FunctionToString = convertIntegrationFnToClass(INTEGRATION_NAME, functionToStringIntegration);
+/**
+ * Patch toString calls to return proper name for wrapped functions
+ */
+export const functionToStringIntegration = defineSentryIntegration(() => {
+  // eslint-disable-next-line deprecation/deprecation
+  return new FunctionToString();
+});
+
+/**
+ * Patch toString calls to return proper name for wrapped functions
+ *
+ * @deprecated Use `functionToStringIntegration()` instead.
+ */
+export class FunctionToString implements Integration {
+  public static id = INTEGRATION_NAME;
+
+  public name: typeof INTEGRATION_NAME;
+
+  public constructor() {
+    this.name = INTEGRATION_NAME;
+  }
+
+  // eslint-disable-next-line jsdoc/require-jsdoc
+  public setupOnce(): void {
+    // eslint-disable-next-line @typescript-eslint/unbound-method
+    originalFunctionToString = Function.prototype.toString;
+
+    // intrinsics (like Function.prototype) might be immutable in some environments
+    // e.g. Node with --frozen-intrinsics, XS (an embedded JavaScript engine) or SES (a JavaScript proposal)
+    try {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      Function.prototype.toString = function (this: WrappedFunction, ...args: any[]): string {
+        const context = getOriginalFunction(this) || this;
+        return originalFunctionToString.apply(context, args);
+      };
+    } catch {
+      // ignore errors here, just don't patch this
+    }
+  }
+}

packages/core/src/integrations/inboundfilters.ts

@@ -1,8 +1,9 @@
-import type { Event, IntegrationFn, StackFrame } from '@sentry/types';
+/* eslint-disable jsdoc/require-jsdoc */
+import type { Client, Event, EventHint, Integration, StackFrame } from '@sentry/types';
 import { getEventDescription, logger, stringMatchesSomePattern } from '@sentry/utils';
 
 import { DEBUG_BUILD } from '../debug-build';
-import { convertIntegrationFnToClass } from '../integration';
+import { defineSentryIntegration } from '../integration';
 
 // "Script error." is hard coded into browsers for errors that it can't read.
 // this is the result of a script being pulled in from an external domain and CORS.
@@ -30,22 +31,37 @@ export interface InboundFiltersOptions {
 }
 
 const INTEGRATION_NAME = 'InboundFilters';
-const inboundFiltersIntegration: IntegrationFn = (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);
-      return _shouldDropEvent(event, mergedOptions) ? null : event;
-    },
-  };
-};
 
-/** Inbound filters configurable by the user */
-// eslint-disable-next-line deprecation/deprecation
-export const InboundFilters = convertIntegrationFnToClass(INTEGRATION_NAME, inboundFiltersIntegration);
+export const inboundFiltersIntegration = defineSentryIntegration((options: Partial<InboundFiltersOptions>) => {
+  // eslint-disable-next-line deprecation/deprecation
+  return new InboundFilters(options);
+});
+
+/**
+ * Inbound filters configurable by the user
+ *
+ * @deprecated Use `inboundFiltersIntegration()` instead.
+ */
+export class InboundFilters implements Integration {
+  public static id = INTEGRATION_NAME;
+
+  public name: string;
+
+  public constructor(private _options: Partial<InboundFiltersOptions>) {
+    this.name = INTEGRATION_NAME;
+  }
+
+  // TODO v8: Remove this
+  public setupOnce(): void {
+    // noop
+  }
+
+  public preprocessEvent(event: Event, hint: EventHint | undefined, client: Client): Event | null {
+    const clientOptions = client.getOptions();
+    const mergedOptions = _mergeOptions(this._options, clientOptions);
+    return _shouldDropEvent(event, mergedOptions) ? null : event;
+  }
+}
 
 function _mergeOptions(
   internalOptions: Partial<InboundFiltersOptions> = {},