feat(integrations): Deprecate pluggable integration classes (#10211)

Instead, users should import & use the integration functions.

Author: mydea

packages/integrations/src/captureconsole.ts

@@ -1,4 +1,11 @@
-import { captureException, captureMessage, convertIntegrationFnToClass, getClient, withScope } from '@sentry/core';
+import {
+  captureException,
+  captureMessage,
+  convertIntegrationFnToClass,
+  defineIntegration,
+  getClient,
+  withScope,
+} from '@sentry/core';
 import type { CaptureContext, Client, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';
 import {
   CONSOLE_LEVELS,
@@ -15,7 +22,7 @@ interface CaptureConsoleOptions {
 
 const INTEGRATION_NAME = 'CaptureConsole';
 
-const captureConsoleIntegration = ((options: CaptureConsoleOptions = {}) => {
+const _captureConsoleIntegration = ((options: CaptureConsoleOptions = {}) => {
   const levels = options.levels || CONSOLE_LEVELS;
 
   return {
@@ -38,7 +45,12 @@ const captureConsoleIntegration = ((options: CaptureConsoleOptions = {}) => {
   };
 }) satisfies IntegrationFn;
 
-/** Send Console API calls as Sentry Events */
+export const captureConsoleIntegration = defineIntegration(_captureConsoleIntegration);
+
+/**
+ * Send Console API calls as Sentry Events.
+ * @deprecated Use `captureConsoleIntegration()` instead.
+ */
 // eslint-disable-next-line deprecation/deprecation
 export const CaptureConsole = convertIntegrationFnToClass(
   INTEGRATION_NAME,

packages/integrations/src/contextlines.ts

@@ -1,4 +1,4 @@
-import { convertIntegrationFnToClass } from '@sentry/core';
+import { convertIntegrationFnToClass, defineIntegration } from '@sentry/core';
 import type { Event, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
 import { GLOBAL_OBJ, addContextToFrame, stripUrlQueryAndFragment } from '@sentry/utils';
 
@@ -18,7 +18,7 @@ interface ContextLinesOptions {
   frameContextLines?: number;
 }
 
-const contextLinesIntegration = ((options: ContextLinesOptions = {}) => {
+const _contextLinesIntegration = ((options: ContextLinesOptions = {}) => {
   const contextLines = options.frameContextLines != null ? options.frameContextLines : DEFAULT_LINES_OF_CONTEXT;
 
   return {
@@ -31,6 +31,8 @@ const contextLinesIntegration = ((options: ContextLinesOptions = {}) => {
   };
 }) satisfies IntegrationFn;
 
+export const contextLinesIntegration = defineIntegration(_contextLinesIntegration);
+
 /**
  * Collects source context lines around the lines of stackframes pointing to JS embedded in
  * the current page's HTML.
@@ -41,6 +43,8 @@ const contextLinesIntegration = ((options: ContextLinesOptions = {}) => {
  *
  * Use this integration if you have inline JS code in HTML pages that can't be accessed
  * by our backend (e.g. due to a login-protected page).
+ *
+ * @deprecated Use `contextLinesIntegration()` instead.
  */
 // eslint-disable-next-line deprecation/deprecation
 export const ContextLines = convertIntegrationFnToClass(INTEGRATION_NAME, contextLinesIntegration) as IntegrationClass<

packages/integrations/src/debug.ts

@@ -1,4 +1,4 @@
-import { convertIntegrationFnToClass } from '@sentry/core';
+import { convertIntegrationFnToClass, defineIntegration } from '@sentry/core';
 import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';
 import { consoleSandbox } from '@sentry/utils';
 
@@ -11,7 +11,7 @@ interface DebugOptions {
   debugger?: boolean;
 }
 
-const debugIntegration = ((options: DebugOptions = {}) => {
+const _debugIntegration = ((options: DebugOptions = {}) => {
   const _options = {
     debugger: false,
     stringify: false,
@@ -53,9 +53,13 @@ const debugIntegration = ((options: DebugOptions = {}) => {
   };
 }) satisfies IntegrationFn;
 
+export const debugIntegration = defineIntegration(_debugIntegration);
+
 /**
  * Integration to debug sent Sentry events.
- * This integration should not be used in production
+ * This integration should not be used in production.
+ *
+ * @deprecated Use `debugIntegration()` instead.
  */
 // eslint-disable-next-line deprecation/deprecation
 export const Debug = convertIntegrationFnToClass(INTEGRATION_NAME, debugIntegration) as IntegrationClass<

packages/integrations/src/dedupe.ts

@@ -1,12 +1,12 @@
-import { convertIntegrationFnToClass } from '@sentry/core';
+import { convertIntegrationFnToClass, defineIntegration } from '@sentry/core';
 import type { Event, Exception, Integration, IntegrationClass, IntegrationFn, StackFrame } from '@sentry/types';
 import { logger } from '@sentry/utils';
 
 import { DEBUG_BUILD } from './debug-build';
 
 const INTEGRATION_NAME = 'Dedupe';
 
-const dedupeIntegration = (() => {
+const _dedupeIntegration = (() => {
   let previousEvent: Event | undefined;
 
   return {
@@ -33,7 +33,12 @@ const dedupeIntegration = (() => {
   };
 }) satisfies IntegrationFn;
 
-/** Deduplication filter */
+export const dedupeIntegration = defineIntegration(_dedupeIntegration);
+
+/**
+ * Deduplication filter.
+ * @deprecated Use `dedupeIntegration()` instead.
+ */
 // eslint-disable-next-line deprecation/deprecation
 export const Dedupe = convertIntegrationFnToClass(INTEGRATION_NAME, dedupeIntegration) as IntegrationClass<
   Integration & { processEvent: (event: Event) => Event }

packages/integrations/src/extraerrordata.ts

@@ -1,4 +1,4 @@
-import { convertIntegrationFnToClass } from '@sentry/core';
+import { convertIntegrationFnToClass, defineIntegration } from '@sentry/core';
 import type {
   Contexts,
   Event,
@@ -28,7 +28,7 @@ interface ExtraErrorDataOptions {
   captureErrorCause: boolean;
 }
 
-const extraErrorDataIntegration = ((options: Partial<ExtraErrorDataOptions> = {}) => {
+const _extraErrorDataIntegration = ((options: Partial<ExtraErrorDataOptions> = {}) => {
   const depth = options.depth || 3;
 
   // TODO(v8): Flip the default for this option to true
@@ -44,7 +44,12 @@ const extraErrorDataIntegration = ((options: Partial<ExtraErrorDataOptions> = {}
   };
 }) satisfies IntegrationFn;
 
-/** Extract additional data for from original exceptions. */
+export const extraErrorDataIntegration = defineIntegration(_extraErrorDataIntegration);
+
+/**
+ * Extract additional data for from original exceptions.
+ * @deprecated Use `extraErrorDataIntegration()` instead.
+ */
 // eslint-disable-next-line deprecation/deprecation
 export const ExtraErrorData = convertIntegrationFnToClass(
   INTEGRATION_NAME,

packages/integrations/src/httpclient.ts

@@ -1,4 +1,10 @@
-import { captureEvent, convertIntegrationFnToClass, getClient, isSentryRequestUrl } from '@sentry/core';
+import {
+  captureEvent,
+  convertIntegrationFnToClass,
+  defineIntegration,
+  getClient,
+  isSentryRequestUrl,
+} from '@sentry/core';
 import type {
   Client,
   Event as SentryEvent,
@@ -45,7 +51,7 @@ interface HttpClientOptions {
   failedRequestTargets: HttpRequestTarget[];
 }
 
-const httpClientIntegration = ((options: Partial<HttpClientOptions> = {}) => {
+const _httpClientIntegration = ((options: Partial<HttpClientOptions> = {}) => {
   const _options: HttpClientOptions = {
     failedRequestStatusCodes: [[500, 599]],
     failedRequestTargets: [/.*/],
@@ -63,7 +69,12 @@ const httpClientIntegration = ((options: Partial<HttpClientOptions> = {}) => {
   };
 }) satisfies IntegrationFn;
 
-/** HTTPClient integration creates events for failed client side HTTP requests. */
+export const httpClientIntegration = defineIntegration(_httpClientIntegration);
+
+/**
+ * Create events for failed client side HTTP requests.
+ * @deprecated Use `httpClientIntegration()` instead.
+ */
 // eslint-disable-next-line deprecation/deprecation
 export const HttpClient = convertIntegrationFnToClass(INTEGRATION_NAME, httpClientIntegration) as IntegrationClass<
   Integration & { setup: (client: Client) => void }

packages/integrations/src/index.ts

@@ -1,13 +1,12 @@
-export { CaptureConsole } from './captureconsole';
-export { Debug } from './debug';
-export { Dedupe } from './dedupe';
-export { ExtraErrorData } from './extraerrordata';
-// eslint-disable-next-line deprecation/deprecation
+/* eslint-disable deprecation/deprecation */
+export { CaptureConsole, captureConsoleIntegration } from './captureconsole';
+export { Debug, debugIntegration } from './debug';
+export { Dedupe, dedupeIntegration } from './dedupe';
+export { ExtraErrorData, extraErrorDataIntegration } from './extraerrordata';
 export { Offline } from './offline';
-export { ReportingObserver } from './reportingobserver';
-export { RewriteFrames } from './rewriteframes';
-export { SessionTiming } from './sessiontiming';
-// eslint-disable-next-line deprecation/deprecation
+export { ReportingObserver, reportingObserverIntegration } from './reportingobserver';
+export { RewriteFrames, rewriteFramesIntegration } from './rewriteframes';
+export { SessionTiming, sessionTimingIntegration } from './sessiontiming';
 export { Transaction } from './transaction';
-export { HttpClient } from './httpclient';
-export { ContextLines } from './contextlines';
+export { HttpClient, httpClientIntegration } from './httpclient';
+export { ContextLines, contextLinesIntegration } from './contextlines';

packages/integrations/src/reportingobserver.ts

@@ -1,4 +1,4 @@
-import { captureMessage, convertIntegrationFnToClass, getClient, withScope } from '@sentry/core';
+import { captureMessage, convertIntegrationFnToClass, defineIntegration, getClient, withScope } from '@sentry/core';
 import type { Client, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';
 import { GLOBAL_OBJ, supportsReportingObserver } from '@sentry/utils';
 
@@ -48,7 +48,7 @@ interface ReportingObserverOptions {
 
 const SETUP_CLIENTS = new WeakMap<Client, boolean>();
 
-const reportingObserverIntegration = ((options: ReportingObserverOptions = {}) => {
+const _reportingObserverIntegration = ((options: ReportingObserverOptions = {}) => {
   const types = options.types || ['crash', 'deprecation', 'intervention'];
 
   /** Handler for the reporting observer. */
@@ -115,7 +115,12 @@ const reportingObserverIntegration = ((options: ReportingObserverOptions = {}) =
   };
 }) satisfies IntegrationFn;
 
-/** Reporting API integration - https://w3c.github.io/reporting/ */
+export const reportingObserverIntegration = defineIntegration(_reportingObserverIntegration);
+
+/**
+ * Reporting API integration - https://w3c.github.io/reporting/
+ * @deprecated Use `reportingObserverIntegration()` instead.
+ */
 // eslint-disable-next-line deprecation/deprecation
 export const ReportingObserver = convertIntegrationFnToClass(
   INTEGRATION_NAME,

packages/integrations/src/rewriteframes.ts

@@ -1,4 +1,4 @@
-import { convertIntegrationFnToClass } from '@sentry/core';
+import { convertIntegrationFnToClass, defineIntegration } from '@sentry/core';
 import type { Event, Integration, IntegrationClass, IntegrationFn, StackFrame, Stacktrace } from '@sentry/types';
 import { basename, relative } from '@sentry/utils';
 
@@ -12,7 +12,7 @@ interface RewriteFramesOptions {
   iteratee?: StackFrameIteratee;
 }
 
-const rewriteFramesIntegration = ((options: RewriteFramesOptions = {}) => {
+const _rewriteFramesIntegration = ((options: RewriteFramesOptions = {}) => {
   const root = options.root;
   const prefix = options.prefix || 'app:///';
 
@@ -85,7 +85,12 @@ const rewriteFramesIntegration = ((options: RewriteFramesOptions = {}) => {
   };
 }) satisfies IntegrationFn;
 
-/** Rewrite event frames paths */
+export const rewriteFramesIntegration = defineIntegration(_rewriteFramesIntegration);
+
+/**
+ * Rewrite event frames paths.
+ * @deprecated Use `rewriteFramesIntegration()` instead.
+ */
 // eslint-disable-next-line deprecation/deprecation
 export const RewriteFrames = convertIntegrationFnToClass(
   INTEGRATION_NAME,

packages/integrations/src/sessiontiming.ts

@@ -1,9 +1,9 @@
-import { convertIntegrationFnToClass } from '@sentry/core';
+import { convertIntegrationFnToClass, defineIntegration } from '@sentry/core';
 import type { Event, Integration, IntegrationClass, IntegrationFn } from '@sentry/types';
 
 const INTEGRATION_NAME = 'SessionTiming';
 
-const sessionTimingIntegration = (() => {
+const _sessionTimingIntegration = (() => {
   const startTime = Date.now();
 
   return {
@@ -26,7 +26,12 @@ const sessionTimingIntegration = (() => {
   };
 }) satisfies IntegrationFn;
 
-/** This function adds duration since Sentry was initialized till the time event was sent */
+export const sessionTimingIntegration = defineIntegration(_sessionTimingIntegration);
+
+/**
+ * This function adds duration since Sentry was initialized till the time event was sent.
+ * @deprecated Use `sessionTimingIntegration()` instead.
+ */
 // eslint-disable-next-line deprecation/deprecation
 export const SessionTiming = convertIntegrationFnToClass(
   INTEGRATION_NAME,