feat: Stop passing defaultIntegrations as client option

Author: mydea

dev-packages/e2e-tests/test-applications/node-exports-test-app/scripts/consistentExports.ts

@@ -18,6 +18,7 @@ const NODE_EXPORTS_IGNORE = [
   'setNodeAsyncContextStrategy',
   'getDefaultIntegrationsWithoutPerformance',
   'initWithoutDefaultIntegrations',
+  'initWithDefaultIntegrations',
   'SentryContextManager',
   'validateOpenTelemetrySetup',
   'preloadOpenTelemetry',

packages/angular/src/sdk.ts

@@ -5,7 +5,7 @@ import {
   browserSessionIntegration,
   globalHandlersIntegration,
   httpContextIntegration,
-  init as browserInit,
+  initWithDefaultIntegrations,
   linkedErrorsIntegration,
   setContext,
 } from '@sentry/browser';
@@ -50,14 +50,14 @@ export function getDefaultIntegrations(_options: BrowserOptions = {}): Integrati
  */
 export function init(options: BrowserOptions): Client | undefined {
   const opts = {
-    defaultIntegrations: getDefaultIntegrations(),
     ...options,
   };
 
   applySdkMetadata(opts, 'angular');
 
   checkAndSetAngularVersion();
-  return browserInit(opts);
+
+  return initWithDefaultIntegrations(opts, getDefaultIntegrations);
 }
 
 function checkAndSetAngularVersion(): void {

packages/astro/src/client/sdk.ts

@@ -2,7 +2,7 @@ import type { BrowserOptions } from '@sentry/browser';
 import {
   browserTracingIntegration,
   getDefaultIntegrations as getBrowserDefaultIntegrations,
-  init as initBrowserSdk,
+  initWithDefaultIntegrations,
 } from '@sentry/browser';
 import type { Client, Integration } from '@sentry/core';
 import { applySdkMetadata } from '@sentry/core';
@@ -17,13 +17,12 @@ declare const __SENTRY_TRACING__: boolean;
  */
 export function init(options: BrowserOptions): Client | undefined {
   const opts = {
-    defaultIntegrations: getDefaultIntegrations(options),
     ...options,
   };
 
   applySdkMetadata(opts, 'astro', ['astro', 'browser']);
 
-  return initBrowserSdk(opts);
+  return initWithDefaultIntegrations(opts, getDefaultIntegrations);
 }
 
 function getDefaultIntegrations(options: BrowserOptions): Integration[] {

packages/astro/src/index.types.ts

@@ -15,6 +15,10 @@ export * from '@sentry/node';
 
 /** Initializes Sentry Astro SDK */
 export declare function init(options: Options | clientSdk.BrowserOptions | NodeOptions): Client | undefined;
+export declare function initWithDefaultIntegrations(
+  options: Options | clientSdk.BrowserOptions | NodeOptions,
+  getDefaultIntegrations: (options: Options) => Integration[],
+): Client | undefined;
 
 export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
 export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

packages/astro/test/client/sdk.test.ts

@@ -1,8 +1,6 @@
-import type { BrowserClient } from '@sentry/browser';
 import {
   browserTracingIntegration,
   getActiveSpan,
-  getClient,
   getCurrentScope,
   getGlobalScope,
   getIsolationScope,
@@ -12,7 +10,7 @@ import * as SentryBrowser from '@sentry/browser';
 import { afterEach, describe, expect, it, vi } from 'vitest';
 import { init } from '../../src/client/sdk';
 
-const browserInit = vi.spyOn(SentryBrowser, 'init');
+const browserInit = vi.spyOn(SentryBrowser, 'initWithDefaultIntegrations');
 
 describe('Sentry client SDK', () => {
   describe('init', () => {
@@ -44,6 +42,7 @@ describe('Sentry client SDK', () => {
             },
           },
         }),
+        expect.any(Function),
       );
     });
 
@@ -53,45 +52,39 @@ describe('Sentry client SDK', () => {
         ['tracesSampler', { tracesSampler: () => 1.0 }],
         ['no tracing option set', {}],
       ])('adds browserTracingIntegration if tracing is enabled via %s', (_, tracingOptions) => {
-        init({
+        const client = init({
           dsn: 'https://[email protected]/1337',
           ...tracingOptions,
         });
 
-        const integrationsToInit = browserInit.mock.calls[0]![0]?.defaultIntegrations;
-        const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');
-
-        expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
+        const browserTracing = client?.getIntegrationByName('BrowserTracing');
         expect(browserTracing).toBeDefined();
       });
 
       it("doesn't add browserTracingIntegration if `__SENTRY_TRACING__` is set to false", () => {
         (globalThis as any).__SENTRY_TRACING__ = false;
 
-        init({
+        const client = init({
           dsn: 'https://[email protected]/1337',
           tracesSampleRate: 1,
         });
 
-        const integrationsToInit = browserInit.mock.calls[0]![0]?.defaultIntegrations || [];
-        const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');
-
-        expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
+        const browserTracing = client?.getIntegrationByName('BrowserTracing');
         expect(browserTracing).toBeUndefined();
 
         delete (globalThis as any).__SENTRY_TRACING__;
       });
 
       it('Overrides the automatically default browserTracingIntegration instance with a a user-provided browserTracingIntegration instance', () => {
-        init({
+        const client = init({
           dsn: 'https://[email protected]/1337',
           integrations: [
             browserTracingIntegration({ finalTimeout: 10, instrumentNavigation: false, instrumentPageLoad: false }),
           ],
           tracesSampleRate: 1,
         });
 
-        const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing');
+        const browserTracing = client?.getIntegrationByName('BrowserTracing');
         expect(browserTracing).toBeDefined();
 
         // no active span means the settings were respected

packages/aws-serverless/src/sdk.ts

@@ -13,7 +13,7 @@ import {
   flush,
   getCurrentScope,
   getDefaultIntegrationsWithoutPerformance,
-  initWithoutDefaultIntegrations,
+  initWithDefaultIntegrations,
   startSpanManual,
   withScope,
 } from '@sentry/node';
@@ -77,13 +77,12 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
  */
 export function init(options: NodeOptions = {}): NodeClient | undefined {
   const opts = {
-    defaultIntegrations: getDefaultIntegrations(options),
     ...options,
   };
 
   applySdkMetadata(opts, 'aws-serverless');
 
-  return initWithoutDefaultIntegrations(opts);
+  return initWithDefaultIntegrations(opts, getDefaultIntegrations);
 }
 
 /** */

packages/aws-serverless/test/sdk.test.ts

@@ -25,7 +25,7 @@ vi.mock('@sentry/node', async () => {
   const original = (await vi.importActual('@sentry/node')) as typeof import('@sentry/node');
   return {
     ...original,
-    initWithoutDefaultIntegrations: (options: unknown) => {
+    initWithDefaultIntegrations: (options: unknown) => {
       mockInit(options);
     },
     startInactiveSpan: (...args: unknown[]) => {

packages/browser/src/index.ts

@@ -6,6 +6,8 @@ export * from './exports';
 
 export { logger };
 
+export { initWithDefaultIntegrations } from './sdk';
+
 export { reportingObserverIntegration } from './integrations/reportingobserver';
 export { httpClientIntegration } from './integrations/httpclient';
 export { contextLinesIntegration } from './integrations/contextlines';

packages/browser/src/sdk.ts

@@ -60,9 +60,8 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
 }
 
 /** Exported only for tests. */
-export function applyDefaultOptions(optionsArg: BrowserOptions = {}): BrowserOptions {
+export function applyDefaultOptions(optionsArg: BrowserOptions): BrowserOptions {
   const defaultOptions: BrowserOptions = {
-    defaultIntegrations: getDefaultIntegrations(optionsArg),
     release:
       typeof __SENTRY_RELEASE__ === 'string' // This allows build tooling to find-and-replace __SENTRY_RELEASE__ to inject a release value
         ? __SENTRY_RELEASE__
@@ -72,27 +71,10 @@ export function applyDefaultOptions(optionsArg: BrowserOptions = {}): BrowserOpt
 
   return {
     ...defaultOptions,
-    ...dropTopLevelUndefinedKeys(optionsArg),
+    ...optionsArg,
   };
 }
 
-/**
- * In contrast to the regular `dropUndefinedKeys` method,
- * this one does not deep-drop keys, but only on the top level.
- */
-function dropTopLevelUndefinedKeys<T extends object>(obj: T): Partial<T> {
-  const mutatetedObj: Partial<T> = {};
-
-  for (const k of Object.getOwnPropertyNames(obj)) {
-    const key = k as keyof T;
-    if (obj[key] !== undefined) {
-      mutatetedObj[key] = obj[key];
-    }
-  }
-
-  return mutatetedObj;
-}
-
 /**
  * The Sentry Browser SDK Client.
  *
@@ -143,15 +125,34 @@ export function init(browserOptions: BrowserOptions = {}): Client | undefined {
   if (!browserOptions.skipBrowserExtensionCheck && _checkForBrowserExtension()) {
     return;
   }
+  return _init(browserOptions, getDefaultIntegrations(browserOptions));
+}
 
-  const options = applyDefaultOptions(browserOptions);
-  const clientOptions: BrowserClientOptions = {
-    ...options,
-    stackParser: stackParserFromStackParserOptions(options.stackParser || defaultStackParser),
-    integrations: getIntegrationsToSetup(options),
-    transport: options.transport || makeFetchTransport,
-  };
+/**
+ * Initialize a browser client with the provided options and default integrations getter function.
+ * This is an internal method the SDK uses under the hood to set up things - you should not use this as a user!
+ * Instead, use `init()` to initialize the SDK.
+ *
+ * @hidden
+ * @internal
+ */
+export function initWithDefaultIntegrations(
+  browserOptions: BrowserOptions = {},
+  getDefaultIntegrationsImpl: (options: BrowserOptions) => Integration[],
+): BrowserClient | undefined {
+  if (!browserOptions.skipBrowserExtensionCheck && _checkForBrowserExtension()) {
+    return;
+  }
 
+  return _init(browserOptions, getDefaultIntegrationsImpl(browserOptions));
+}
+
+/**
+ * Acutal implementation shared by init and initWithDefaultIntegrations.
+ */
+function _init(browserOptions: BrowserOptions = {}, defaultIntegrations: Integration[]): BrowserClient {
+  const options = applyDefaultOptions(browserOptions);
+  const clientOptions = getClientOptions(options, defaultIntegrations);
   return initAndBind(BrowserClient, clientOptions);
 }
 
@@ -215,3 +216,12 @@ function _checkForBrowserExtension(): true | void {
     return true;
   }
 }
+
+function getClientOptions(options: BrowserOptions, defaultIntegrations: Integration[]): BrowserClientOptions {
+  return {
+    ...options,
+    stackParser: stackParserFromStackParserOptions(options.stackParser || defaultStackParser),
+    integrations: getIntegrationsToSetup(options, defaultIntegrations),
+    transport: options.transport || makeFetchTransport,
+  };
+}