feat: Allow providing discoveredIntegrations through internal options

Author: kamilogorek

packages/browser/src/sdk.ts

@@ -74,9 +74,16 @@ export const defaultIntegrations = [
  * @see {@link BrowserOptions} for documentation on configuration options.
  */
 export function init(options: BrowserOptions = {}): void {
-  if (options.defaultIntegrations === undefined) {
-    options.defaultIntegrations = defaultIntegrations;
+  options._internal = options._internal || {};
+
+  // Both `defaultIntegrations` and `discoverIntegrations` should be `boolean`, but we are stuck with this type
+  // for backwards compatibility at the momement.
+  if (options.defaultIntegrations !== false) {
+    options._internal.defaultIntegrations = Array.isArray(options.defaultIntegrations)
+      ? options.defaultIntegrations
+      : defaultIntegrations;
   }
+
   if (options.release === undefined) {
     const window = getGlobalObject<Window>();
     // This supports the variable that sentry-webpack-plugin injects

packages/core/src/baseclient.ts

@@ -202,7 +202,7 @@ export abstract class BaseClient<B extends Backend, O extends Options> implement
    */
   public setupIntegrations(): void {
     if (this._isEnabled()) {
-      this._integrations = setupIntegrations(this._options);
+      this._integrations = setupIntegrations(this.getOptions());
     }
   }
 

packages/core/src/integration.ts

@@ -11,43 +11,35 @@ export interface IntegrationIndex {
 
 /** Gets integration to install */
 export function getIntegrationsToSetup(options: Options): Integration[] {
-  const defaultIntegrations = (options.defaultIntegrations && [...options.defaultIntegrations]) || [];
-  const userIntegrations = options.integrations;
-  let integrations: Integration[] = [];
-  if (Array.isArray(userIntegrations)) {
-    const userIntegrationsNames = userIntegrations.map(i => i.name);
-    const pickedIntegrationsNames: string[] = [];
+  const defaultIntegrations = options._internal?.defaultIntegrations || [];
+  const discoveredIntegrations = options._internal?.discoveredIntegrations || [];
+  const userIntegrations = options.integrations || [];
 
-    // Leave only unique default integrations, that were not overridden with provided user integrations
-    defaultIntegrations.forEach(defaultIntegration => {
-      if (
-        userIntegrationsNames.indexOf(defaultIntegration.name) === -1 &&
-        pickedIntegrationsNames.indexOf(defaultIntegration.name) === -1
-      ) {
-        integrations.push(defaultIntegration);
-        pickedIntegrationsNames.push(defaultIntegration.name);
-      }
-    });
+  // Filter out default integrations that are also discovered
+  let integrations: Integration[] = [
+    ...defaultIntegrations.filter(defaultIntegration =>
+      discoveredIntegrations.every(discoveredIntegration => discoveredIntegration.name !== defaultIntegration.name),
+    ),
+    ...discoveredIntegrations,
+  ];
 
-    // Don't add same user integration twice
-    userIntegrations.forEach(userIntegration => {
-      if (pickedIntegrationsNames.indexOf(userIntegration.name) === -1) {
-        integrations.push(userIntegration);
-        pickedIntegrationsNames.push(userIntegration.name);
-      }
-    });
+  if (Array.isArray(userIntegrations)) {
+    // Filter out integrations that are also included in user options
+    integrations = [
+      ...integrations.filter(integrations =>
+        userIntegrations.every(userIntegration => userIntegration.name !== integrations.name),
+      ),
+      // And filter out duplicated user options integrations
+      ...userIntegrations.reduce((acc, userIntegration) => {
+        if (acc.every(accIntegration => userIntegration.name !== accIntegration.name)) {
+          acc.push(userIntegration);
+        }
+        return acc;
+      }, [] as Integration[]),
+    ];
   } else if (typeof userIntegrations === 'function') {
-    integrations = userIntegrations(defaultIntegrations);
+    integrations = userIntegrations(integrations);
     integrations = Array.isArray(integrations) ? integrations : [integrations];
-  } else {
-    integrations = [...defaultIntegrations];
-  }
-
-  // Make sure that if present, `Debug` integration will always run last
-  const integrationsNames = integrations.map(i => i.name);
-  const alwaysLastToRun = 'Debug';
-  if (integrationsNames.indexOf(alwaysLastToRun) !== -1) {
-    integrations.push(...integrations.splice(integrationsNames.indexOf(alwaysLastToRun), 1));
   }
 
   return integrations;
@@ -69,7 +61,7 @@ export function setupIntegration(integration: Integration): void {
  * @param integrations array of integration instances
  * @param withDefault should enable default integrations
  */
-export function setupIntegrations<O extends Options>(options: O): IntegrationIndex {
+export function setupIntegrations(options: Options): IntegrationIndex {
   const integrations: IntegrationIndex = {};
   getIntegrationsToSetup(options).forEach(integration => {
     integrations[integration.name] = integration;

packages/node/src/sdk.ts

@@ -1,5 +1,6 @@
 import { getCurrentHub, initAndBind, Integrations as CoreIntegrations } from '@sentry/core';
 import { getMainCarrier, setHubOnCarrier } from '@sentry/hub';
+import { Integration } from '@sentry/types';
 import { getGlobalObject } from '@sentry/utils';
 import * as domain from 'domain';
 
@@ -77,8 +78,14 @@ export const defaultIntegrations = [
  * @see {@link NodeOptions} for documentation on configuration options.
  */
 export function init(options: NodeOptions = {}): void {
-  if (options.defaultIntegrations === undefined) {
-    options.defaultIntegrations = defaultIntegrations;
+  options._internal = options._internal || {};
+
+  // Both `defaultIntegrations` and `discoverIntegrations` should be `boolean`, but we are stuck with this type
+  // for backwards compatibility at the momement.
+  if (options.defaultIntegrations !== false) {
+    options._internal.defaultIntegrations = Array.isArray(options.defaultIntegrations)
+      ? options.defaultIntegrations
+      : defaultIntegrations;
   }
 
   if (options.dsn === undefined && process.env.SENTRY_DSN) {

packages/tracing/src/hubextensions.ts

@@ -117,7 +117,7 @@ function sample<T extends Transaction>(transaction: T, options: Options, samplin
     return transaction;
   }
 
-  logger.log(`[Tracing] starting ${transaction.op} transaction - ${transaction.name}`);
+  logger.log(`[Tracing] Starting ${transaction.op} transaction: ${transaction.name}.`);
   return transaction;
 }
 

packages/types/src/options.ts

@@ -33,6 +33,11 @@ export interface Options {
    */
   defaultIntegrations?: false | Integration[];
 
+  /**
+   * If this is set to false, will not try to auto-discover installed integrations.
+   */
+  discoverIntegrations?: boolean;
+
   /**
    * List of integrations that should be installed after SDK was initialized.
    * Accepts either a list of integrations or a function that receives
@@ -124,6 +129,8 @@ export interface Options {
      * and provide additional data about every request.
      * */
     sdk?: SdkInfo;
+    defaultIntegrations?: Integration[];
+    discoveredIntegrations?: Integration[];
   };
 
   /**