feat: Refactor exposed defaultIntegrations to getDefaultIntegrations() (#10243)

The current implementation has two problems:

1. It is weird that you can accidentally mutate the default integrations
of another package
2. We sometimes have logic-based default integrations - e.g. adding an
integration only if tracing is enabled, or similar. This means that
either we have to add some logic in the _upstream_ SDK to ensure this is
still added even if downstream SDKs overwrite default integrations, or
we need to duplicate the logic in the _downstream_ SDKs. With this new
method, we can instead centralize this, and downstream SDKs simply need
to call upstream `getDefaultIntegrations(options)`.

Author: mydea

packages/angular-ivy/src/sdk.ts

@@ -1,6 +1,7 @@
 import { VERSION } from '@angular/core';
 import type { BrowserOptions } from '@sentry/browser';
-import { SDK_VERSION, defaultIntegrations, init as browserInit, setContext } from '@sentry/browser';
+import { getDefaultIntegrations } from '@sentry/browser';
+import { SDK_VERSION, init as browserInit, setContext } from '@sentry/browser';
 import type { SdkMetadata } from '@sentry/types';
 import { logger } from '@sentry/utils';
 
@@ -18,7 +19,7 @@ export function init(options: BrowserOptions): void {
     // see:
     //  - https://github.com/getsentry/sentry-javascript/issues/5417#issuecomment-1453407097
     //  - https://github.com/getsentry/sentry-javascript/issues/2744
-    defaultIntegrations: defaultIntegrations.filter(integration => {
+    defaultIntegrations: getDefaultIntegrations(options).filter(integration => {
       return integration.name !== 'TryCatch';
     }),
     ...options,

packages/angular/src/sdk.ts

@@ -1,6 +1,7 @@
 import { VERSION } from '@angular/core';
 import type { BrowserOptions } from '@sentry/browser';
-import { SDK_VERSION, defaultIntegrations, init as browserInit, setContext } from '@sentry/browser';
+import { getDefaultIntegrations } from '@sentry/browser';
+import { SDK_VERSION, init as browserInit, setContext } from '@sentry/browser';
 import type { SdkMetadata } from '@sentry/types';
 import { logger } from '@sentry/utils';
 
@@ -18,7 +19,7 @@ export function init(options: BrowserOptions): void {
     // see:
     //  - https://github.com/getsentry/sentry-javascript/issues/5417#issuecomment-1453407097
     //  - https://github.com/getsentry/sentry-javascript/issues/2744
-    defaultIntegrations: defaultIntegrations.filter(integration => {
+    defaultIntegrations: getDefaultIntegrations(options).filter(integration => {
       return integration.name !== 'TryCatch';
     }),
     ...options,

packages/angular/test/sdk.test.ts

@@ -1,6 +1,6 @@
 import * as SentryBrowser from '@sentry/browser';
 
-import { defaultIntegrations, init } from '../src/index';
+import { getDefaultIntegrations, init } from '../src/index';
 
 describe('init', () => {
   it('sets the Angular version (if available) in the global scope', () => {
@@ -30,16 +30,23 @@ describe('init', () => {
       expect(options.defaultIntegrations).not.toContainEqual(expect.objectContaining({ name: 'TryCatch' }));
     });
 
-    it.each([false as const, defaultIntegrations])(
-      "doesn't filter if `defaultIntegrations` is set to %s",
-      defaultIntegrations => {
-        init({ defaultIntegrations });
+    it("doesn't filter if `defaultIntegrations` is set to `false`", () => {
+      init({ defaultIntegrations: false });
 
-        expect(browserInitSpy).toHaveBeenCalledTimes(1);
+      expect(browserInitSpy).toHaveBeenCalledTimes(1);
+
+      const options = browserInitSpy.mock.calls[0][0] || {};
+      expect(options.defaultIntegrations).toEqual(false);
+    });
+
+    it("doesn't filter if `defaultIntegrations` is overwritten", () => {
+      const defaultIntegrations = getDefaultIntegrations({});
+      init({ defaultIntegrations });
 
-        const options = browserInitSpy.mock.calls[0][0] || {};
-        expect(options.defaultIntegrations).toEqual(defaultIntegrations);
-      },
-    );
+      expect(browserInitSpy).toHaveBeenCalledTimes(1);
+
+      const options = browserInitSpy.mock.calls[0][0] || {};
+      expect(options.defaultIntegrations).toEqual(defaultIntegrations);
+    });
   });
 });

packages/astro/src/index.server.ts

@@ -52,7 +52,9 @@ export {
   withIsolationScope,
   autoDiscoverNodePerformanceMonitoringIntegrations,
   makeNodeTransport,
+  // eslint-disable-next-line deprecation/deprecation
   defaultIntegrations,
+  getDefaultIntegrations,
   defaultStackParser,
   // eslint-disable-next-line deprecation/deprecation
   lastEventId,

packages/astro/src/index.types.ts

@@ -17,6 +17,7 @@ export declare function init(options: Options | clientSdk.BrowserOptions | serve
 export declare const Integrations: typeof clientSdk.Integrations & typeof serverSdk.Integrations;
 
 export declare const defaultIntegrations: Integration[];
+export declare const getDefaultIntegrations: (options: Options) => Integration[];
 export declare const defaultStackParser: StackParser;
 
 export declare function close(timeout?: number | undefined): PromiseLike<boolean>;

packages/browser/src/exports.ts

@@ -89,7 +89,9 @@ export {
 export { eventFromException, eventFromMessage, exceptionFromError } from './eventbuilder';
 export { createUserFeedbackEnvelope } from './userfeedback';
 export {
+  // eslint-disable-next-line deprecation/deprecation
   defaultIntegrations,
+  getDefaultIntegrations,
   forceLoad,
   init,
   onLoad,

packages/browser/src/sdk.ts

@@ -10,7 +10,7 @@ import {
   initAndBind,
   startSession,
 } from '@sentry/core';
-import type { UserFeedback } from '@sentry/types';
+import type { Integration, Options, UserFeedback } from '@sentry/types';
 import {
   addHistoryInstrumentationHandler,
   logger,
@@ -27,18 +27,28 @@ import { Breadcrumbs, Dedupe, GlobalHandlers, HttpContext, LinkedErrors, TryCatc
 import { defaultStackParser } from './stack-parsers';
 import { makeFetchTransport, makeXHRTransport } from './transports';
 
-/* eslint-disable deprecation/deprecation */
+/** @deprecated Use `getDefaultIntegrations(options)` instead. */
 export const defaultIntegrations = [
+  /* eslint-disable deprecation/deprecation */
   new InboundFilters(),
   new FunctionToString(),
+  /* eslint-enable deprecation/deprecation */
   new TryCatch(),
   new Breadcrumbs(),
   new GlobalHandlers(),
   new LinkedErrors(),
   new Dedupe(),
   new HttpContext(),
 ];
-/* eslint-enable deprecation/deprecation */
+
+/** Get the default integrations for the browser SDK. */
+export function getDefaultIntegrations(_options: Options): Integration[] {
+  // We return a copy of the defaultIntegrations here to avoid mutating this
+  return [
+    // eslint-disable-next-line deprecation/deprecation
+    ...defaultIntegrations,
+  ];
+}
 
 /**
  * A magic string that build tooling can leverage in order to inject a release value into the SDK.
@@ -104,7 +114,7 @@ declare const __SENTRY_RELEASE__: string | undefined;
  */
 export function init(options: BrowserOptions = {}): void {
   if (options.defaultIntegrations === undefined) {
-    options.defaultIntegrations = defaultIntegrations;
+    options.defaultIntegrations = getDefaultIntegrations(options);
   }
   if (options.release === undefined) {
     // This allows build tooling to find-and-replace __SENTRY_RELEASE__ to inject a release value

packages/bun/src/index.ts

@@ -88,7 +88,12 @@ export type { SpanStatusType } from '@sentry/core';
 export { autoDiscoverNodePerformanceMonitoringIntegrations, cron } from '@sentry/node';
 
 export { BunClient } from './client';
-export { defaultIntegrations, init } from './sdk';
+export {
+  // eslint-disable-next-line deprecation/deprecation
+  defaultIntegrations,
+  getDefaultIntegrations,
+  init,
+} from './sdk';
 
 import { Integrations as CoreIntegrations } from '@sentry/core';
 import { Integrations as NodeIntegrations } from '@sentry/node';

packages/bun/src/sdk.ts

@@ -1,18 +1,21 @@
 /* eslint-disable max-lines */
 import { FunctionToString, InboundFilters, LinkedErrors } from '@sentry/core';
 import { Integrations as NodeIntegrations, init as initNode } from '@sentry/node';
+import type { Integration, Options } from '@sentry/types';
 
 import { BunClient } from './client';
 import { BunServer } from './integrations';
 import { makeFetchTransport } from './transports';
 import type { BunOptions } from './types';
 
-/* eslint-disable deprecation/deprecation */
+/** @deprecated Use `getDefaultIntegrations(options)` instead. */
 export const defaultIntegrations = [
+  /* eslint-disable deprecation/deprecation */
   // Common
   new InboundFilters(),
   new FunctionToString(),
   new LinkedErrors(),
+  /* eslint-enable deprecation/deprecation */
   // Native Wrappers
   new NodeIntegrations.Console(),
   new NodeIntegrations.Http(),
@@ -29,7 +32,15 @@ export const defaultIntegrations = [
   // Bun Specific
   new BunServer(),
 ];
-/* eslint-enable deprecation/deprecation */
+
+/** Get the default integrations for the Bun SDK. */
+export function getDefaultIntegrations(_options: Options): Integration[] {
+  // We return a copy of the defaultIntegrations here to avoid mutating this
+  return [
+    // eslint-disable-next-line deprecation/deprecation
+    ...defaultIntegrations,
+  ];
+}
 
 /**
  * The Sentry Bun SDK Client.
@@ -90,9 +101,9 @@ export function init(options: BunOptions = {}): void {
   options.clientClass = BunClient;
   options.transport = options.transport || makeFetchTransport;
 
-  options.defaultIntegrations =
-    options.defaultIntegrations === false
-      ? []
-      : [...(Array.isArray(options.defaultIntegrations) ? options.defaultIntegrations : defaultIntegrations)];
+  if (options.defaultIntegrations === undefined) {
+    options.defaultIntegrations = getDefaultIntegrations(options);
+  }
+
   initNode(options);
 }

packages/deno/src/index.ts

@@ -86,7 +86,12 @@ export type { SpanStatusType } from '@sentry/core';
 
 export { DenoClient } from './client';
 
-export { defaultIntegrations, init } from './sdk';
+export {
+  // eslint-disable-next-line deprecation/deprecation
+  defaultIntegrations,
+  getDefaultIntegrations,
+  init,
+} from './sdk';
 
 import { Integrations as CoreIntegrations } from '@sentry/core';