[v7] Auto-discover node integrations and cleanup default client options

Author: kamilogorek

packages/browser/src/client.ts

@@ -1,7 +1,6 @@
 import { BaseClient, SDK_VERSION } from '@sentry/core';
 import { CaptureContext, SentryEvent, Options } from '@sentry/types';
 import { eventFromException, eventFromMessage } from '@sentry/eventbuilder-browser';
-import { getGlobalObject } from '@sentry/utils';
 
 /**
  * Configuration options for the Sentry Browser SDK.

packages/browser/src/sdk.ts

@@ -30,18 +30,26 @@ export function init(options: BrowserOptions = {}): ClientLike {
 }
 
 export function initClient(options: BrowserOptions = {}): ClientLike {
-  // Injected by sentry-webpack-plugin
-  options.release = options.release ?? getGlobalObject<Window>().SENTRY_RELEASE?.id;
-  options.autoSessionTracking = options.autoSessionTracking ?? true;
-  options.transport = options.transport ?? (supportsFetch() ? FetchTransport : XHRTransport);
-
-  options._internal = options._internal || {};
-  options._internal.defaultIntegrations = options.defaultIntegrations
-    ? options._internal.defaultIntegrations || getDefaultIntegrations()
-    : [];
-  options._internal.discoveredIntegrations = options.discoverIntegrations ? discoverIntegrations() : [];
-
-  return new BrowserClient(options);
+  const opts: BrowserOptions = {
+    // Injected by sentry-webpack-plugin
+    release: getGlobalObject<Window>().SENTRY_RELEASE?.id,
+    transport: supportsFetch() ? FetchTransport : XHRTransport,
+    autoSessionTracking: true,
+    defaultIntegrations: true,
+    discoverIntegrations: true,
+    ...options,
+    _internal: {
+      defaultIntegrations:
+        options.defaultIntegrations === false ? [] : options._internal?.defaultIntegrations || getDefaultIntegrations(),
+      discoveredIntegrations:
+        options.discoverIntegrations === false
+          ? []
+          : options._internal?.discoveredIntegrations || discoverIntegrations(),
+      ...options._internal,
+    },
+  };
+
+  return new BrowserClient(opts);
 }
 
 export const getDefaultIntegrations = (): Integration[] => [
@@ -61,6 +69,7 @@ export const getDefaultIntegrations = (): Integration[] => [
 ];
 
 function discoverIntegrations(): Integration[] {
+  // TODO: Discover integrations from window.__SENTRY_V7_INTEGRATIONS__?
   return [];
 }
 

packages/node/package.json

@@ -31,7 +31,8 @@
     "@sentry/types": "6.2.3",
     "@sentry/utils": "6.2.3",
     "cookie": "^0.4.1",
-    "https-proxy-agent": "^5.0.0"
+    "https-proxy-agent": "^5.0.0",
+    "read-pkg-up": "^7.0.1"
   },
   "devDependencies": {
     "@types/cookie": "0.3.2",

packages/node/src/sdk.ts

@@ -8,6 +8,7 @@ import { OnUncaughtException, OnUnhandledRejection } from '@sentry/integration-n
 import { ConsoleBreadcrumbs, HTTPBreadcrumbs } from '@sentry/integration-node-breadcrumbs';
 import { HTTPTransport } from '@sentry/transport-http';
 import { ClientLike, Integration } from '@sentry/types';
+import { sync as readPkgUp } from 'read-pkg-up';
 
 import { NodeClient, NodeOptions } from './client';
 
@@ -21,26 +22,33 @@ export function init(options: NodeOptions = {}): ClientLike {
 }
 
 export function initClient(options: NodeOptions = {}): ClientLike {
-  options.dsn = options.dsn ?? process.env.SENTRY_DSN;
-  options.release = options.release ?? process.env.SENTRY_RELEASE;
-  options.environment = options.environment ?? process.env.SENTRY_ENVIRONMENT;
+  const opts: NodeOptions = {
+    dsn: process.env.SENTRY_DSN,
+    release: process.env.SENTRY_RELEASE,
+    environment: process.env.SENTRY_ENVIRONMENT,
+    transport: HTTPTransport,
+    defaultIntegrations: true,
+    discoverIntegrations: true,
+    ...options,
+    _internal: {
+      defaultIntegrations:
+        options.defaultIntegrations === false ? [] : options._internal?.defaultIntegrations || getDefaultIntegrations(),
+      discoveredIntegrations:
+        options.discoverIntegrations === false
+          ? []
+          : options._internal?.discoveredIntegrations || discoverIntegrations(),
+      ...options._internal,
+    },
+  };
 
-  if (options.tracesSampleRate === undefined && process.env.SENTRY_TRACES_SAMPLE_RATE) {
+  if (!('tracesSampleRate' in opts) && process.env.SENTRY_TRACES_SAMPLE_RATE) {
     const tracesSampleRate = parseFloat(process.env.SENTRY_TRACES_SAMPLE_RATE);
     if (isFinite(tracesSampleRate)) {
-      options.tracesSampleRate = tracesSampleRate;
+      opts.tracesSampleRate = tracesSampleRate;
     }
   }
 
-  options.transport = options.transport ?? HTTPTransport;
-
-  options._internal = options._internal || {};
-  options._internal.defaultIntegrations = options.defaultIntegrations
-    ? options._internal.defaultIntegrations || getDefaultIntegrations()
-    : [];
-  options._internal.discoveredIntegrations = options.discoverIntegrations ? discoverIntegrations() : [];
-
-  return new NodeClient(options);
+  return new NodeClient(opts);
 }
 
 export const getDefaultIntegrations = (): Integration[] => [
@@ -54,5 +62,25 @@ export const getDefaultIntegrations = (): Integration[] => [
 ];
 
 function discoverIntegrations(): Integration[] {
-  return [];
+  const pkg = readPkgUp();
+
+  if (!pkg) {
+    return [];
+  }
+
+  return Object.keys({
+    ...pkg.packageJson.dependencies,
+    ...pkg.packageJson.devDependencies,
+  })
+    .filter(name => {
+      return /^@sentry\/integration-(common|node)-[a-z]/.test(name);
+    })
+    .map(name => {
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      const mod = require(name);
+      return Object.values(mod) as { new (): Integration }[];
+    })
+    .reduce((acc, integrations) => {
+      return acc.concat(integrations.map(Integration => new Integration()));
+    }, [] as Integration[]);
 }