feat: Add setupIntegrations, Update Scope & Hub

HazAT · HazAT · commit 6de1805a1ba1 · 2018-10-11T08:45:33.000+02:00
diff --git a/packages/browser/src/integrations/breadcrumbs.ts b/packages/browser/src/integrations/breadcrumbs.ts
@@ -455,7 +455,7 @@ export class Breadcrumbs implements Integration {
    *  - Fetch API
    *  - History API
    */
-  public install(options: BrowserOptions = {}): void {
+  public setupOnce(options: BrowserOptions = {}): void {
     const filterUrl = options.dsn && new API(options.dsn).getStoreEndpoint();
 
     if (this.options.console) {
diff --git a/packages/browser/src/integrations/globalhandlers.ts b/packages/browser/src/integrations/globalhandlers.ts
@@ -36,7 +36,7 @@ export class GlobalHandlers implements Integration {
   /**
    * @inheritDoc
    */
-  public install(): void {
+  public setupOnce(): void {
     subscribe((stack: TraceKitStackTrace, _: boolean, error: Error) => {
       // TODO: use stack.context to get a valuable information from TraceKit, eg.
       // [
@@ -55,7 +55,9 @@ export class GlobalHandlers implements Integration {
       if (shouldIgnoreOnError()) {
         return;
       }
-      getCurrentHub().captureEvent(this.eventFromGlobalHandler(stack), { originalException: error, data: { stack } });
+      if (getCurrentHub().getIntegration(this.name)) {
+        getCurrentHub().captureEvent(this.eventFromGlobalHandler(stack), { originalException: error, data: { stack } });
+      }
     });
 
     if (this.options.onerror) {
diff --git a/packages/browser/src/integrations/linkederrors.ts b/packages/browser/src/integrations/linkederrors.ts
@@ -1,4 +1,4 @@
-import { configureScope } from '@sentry/core';
+import { configureScope, getCurrentHub } from '@sentry/core';
 import { Integration, SentryEvent, SentryEventHint, SentryException } from '@sentry/types';
 import { exceptionFromStacktrace } from '../parsers';
 import { computeStackTrace } from '../tracekit';
@@ -41,8 +41,10 @@ export class LinkedErrors implements Integration {
   /**
    * @inheritDoc
    */
-  public install(): void {
-    configureScope(scope => scope.addEventProcessor(this.handler.bind(this)));
+  public setupOnce(): void {
+    if (getCurrentHub().getIntegration(this.name)) {
+      configureScope(scope => scope.addEventProcessor(this.handler.bind(this)));
+    }
   }
 
   /**
diff --git a/packages/browser/src/integrations/trycatch.ts b/packages/browser/src/integrations/trycatch.ts
@@ -162,7 +162,7 @@ export class TryCatch implements Integration {
    * Wrap timer functions and event targets to catch errors
    * and provide better metadata.
    */
-  public install(): void {
+  public setupOnce(): void {
     this.ignoreOnError = this.ignoreOnError;
 
     const global = getGlobalObject();
diff --git a/packages/browser/src/integrations/useragent.ts b/packages/browser/src/integrations/useragent.ts
@@ -1,4 +1,4 @@
-import { configureScope } from '@sentry/core';
+import { configureScope, getCurrentHub } from '@sentry/core';
 import { Integration, SentryEvent } from '@sentry/types';
 import { getGlobalObject } from '@sentry/utils/misc';
 
@@ -14,24 +14,26 @@ export class UserAgent implements Integration {
   /**
    * @inheritDoc
    */
-  public install(): void {
-    configureScope(scope => {
-      scope.addEventProcessor(async (event: SentryEvent) => {
-        if (!global.navigator || !global.location) {
-          return event;
-        }
+  public setupOnce(): void {
+    if (getCurrentHub().getIntegration(this.name)) {
+      configureScope(scope => {
+        scope.addEventProcessor(async (event: SentryEvent) => {
+          if (!global.navigator || !global.location) {
+            return event;
+          }
 
-        // HTTP Interface: https://docs.sentry.io/clientdev/interfaces/http/?platform=javascript
-        const request = event.request || {};
-        request.url = request.url || global.location.href;
-        request.headers = request.headers || {};
-        request.headers['User-Agent'] = global.navigator.userAgent;
+          // HTTP Interface: https://docs.sentry.io/clientdev/interfaces/http/?platform=javascript
+          const request = event.request || {};
+          request.url = request.url || global.location.href;
+          request.headers = request.headers || {};
+          request.headers['User-Agent'] = global.navigator.userAgent;
 
-        return {
-          ...event,
-          request,
-        };
+          return {
+            ...event,
+            request,
+          };
+        });
       });
-    });
+    }
   }
 }
diff --git a/packages/browser/src/sdk.ts b/packages/browser/src/sdk.ts
@@ -62,8 +62,11 @@ export const defaultIntegrations = [
  *
  * @see BrowserOptions for documentation on configuration options.
  */
-export function init(options: BrowserOptions): void {
-  initAndBind(BrowserClient, options, defaultIntegrations);
+export function init(options: BrowserOptions = {}): void {
+  if (options.defaultIntegrations === undefined) {
+    options.defaultIntegrations = defaultIntegrations;
+  }
+  initAndBind(BrowserClient, options);
 }
 
 /**
diff --git a/packages/core/src/baseclient.ts b/packages/core/src/baseclient.ts
@@ -1,6 +1,7 @@
 import { Scope } from '@sentry/hub';
 import {
   Breadcrumb,
+  Integration,
   SentryBreadcrumbHint,
   SentryEvent,
   SentryEventHint,
@@ -14,6 +15,7 @@ import { getGlobalObject, uuid4 } from '@sentry/utils/misc';
 import { truncate } from '@sentry/utils/string';
 import { BackendClass } from './basebackend';
 import { Dsn } from './dsn';
+import { IntegrationIndex, setupIntegrations } from './integrations';
 import { Backend, Client, Options } from './interfaces';
 import { logger } from './logger';
 
@@ -127,6 +129,9 @@ export abstract class BaseClient<B extends Backend, O extends Options> implement
    */
   private installed?: boolean;
 
+  /** Array of used integrations. */
+  private integrations?: IntegrationIndex;
+
   /**
    * Initializes this client instance.
    *
@@ -140,6 +145,8 @@ export abstract class BaseClient<B extends Backend, O extends Options> implement
     if (options.dsn) {
       this.dsn = new Dsn(options.dsn);
     }
+
+    this.integrations = setupIntegrations(options);
   }
 
   /**
@@ -415,4 +422,11 @@ export abstract class BaseClient<B extends Backend, O extends Options> implement
       .getBuffer()
       .drain(timeout);
   }
+
+  /**
+   * @inheritDoc
+   */
+  public getIntegration(name: string): Integration | null {
+    return (this.integrations && this.integrations[name]) || null;
+  }
 }
diff --git a/packages/core/src/integrations/dedupe.ts b/packages/core/src/integrations/dedupe.ts
@@ -1,4 +1,4 @@
-import { configureScope } from '@sentry/minimal';
+import { addGlobalEventProcessor, getCurrentHub } from '@sentry/hub';
 import { Integration, SentryEvent, SentryException, StackFrame } from '@sentry/types';
 import { getEventDescription } from '@sentry/utils/misc';
 import { logger } from '../logger';
@@ -18,9 +18,9 @@ export class Dedupe implements Integration {
   /**
    * @inheritDoc
    */
-  public install(): void {
-    configureScope(scope => {
-      scope.addEventProcessor(async (currentEvent: SentryEvent) => {
+  public setupOnce(): void {
+    addGlobalEventProcessor(async (currentEvent: SentryEvent) => {
+      if (getCurrentHub().getIntegration(this.name)) {
         // Juuust in case something goes wrong
         try {
           if (this.shouldDropEvent(currentEvent, this.previousEvent)) {
@@ -31,7 +31,8 @@ export class Dedupe implements Integration {
         }
 
         return (this.previousEvent = currentEvent);
-      });
+      }
+      return currentEvent;
     });
   }
 
diff --git a/packages/core/src/integrations/functiontostring.ts b/packages/core/src/integrations/functiontostring.ts
@@ -11,7 +11,7 @@ export class FunctionToString implements Integration {
   /**
    * @inheritDoc
    */
-  public install(): void {
+  public setupOnce(): void {
     originalFunctionToString = Function.prototype.toString;
 
     Function.prototype.toString = function(this: SentryWrappedFunction, ...args: any[]): string {
diff --git a/packages/core/src/integrations/inboundfilters.ts b/packages/core/src/integrations/inboundfilters.ts
@@ -1,3 +1,4 @@
+import { getCurrentHub } from '@sentry/hub';
 import { configureScope } from '@sentry/minimal';
 import { Integration, SentryEvent } from '@sentry/types';
 import { isRegExp } from '@sentry/utils/is';
@@ -32,17 +33,19 @@ export class InboundFilters implements Integration {
   /**
    * @inheritDoc
    */
-  public install(options: InboundFiltersOptions = {}): void {
-    this.configureOptions(options);
+  public setupOnce(options: InboundFiltersOptions = {}): void {
+    if (getCurrentHub().getIntegration(this.name)) {
+      this.configureOptions(options);
 
-    configureScope(scope => {
-      scope.addEventProcessor(async (event: SentryEvent) => {
-        if (this.shouldDropEvent(event)) {
-          return null;
-        }
-        return event;
+      configureScope(scope => {
+        scope.addEventProcessor(async (event: SentryEvent) => {
+          if (this.shouldDropEvent(event)) {
+            return null;
+          }
+          return event;
+        });
       });
-    });
+    }
   }
 
   /** JSDoc */
diff --git a/packages/core/src/integrations/index.ts b/packages/core/src/integrations/index.ts
@@ -1,7 +1,63 @@
+import { Integration } from '@sentry/types';
+import { Options } from '../interfaces';
+import { logger } from '../logger';
+
 export { Dedupe } from './dedupe';
 export { FunctionToString } from './functiontostring';
 export { SDKInformation } from './sdkinformation';
 export { InboundFilters } from './inboundfilters';
 
 export { Debug } from './pluggable/debug';
 export { RewriteFrames } from './pluggable/rewriteframes';
+
+const installedIntegrations: string[] = [];
+
+export interface IntegrationIndex {
+  [key: string]: Integration;
+}
+
+/**
+ * Given a list of integration instances this installs them all. When `withDefaults` is set to `true` then all default
+ * integrations are added unless they were already provided before.
+ * @param integrations array of integration instances
+ * @param withDefault should enable default integrations
+ */
+export function setupIntegrations<O extends Options>(options: O): IntegrationIndex {
+  const integrations: IntegrationIndex = {};
+  let integrationsToInstall = options.defaultIntegrations === false ? [] : [...options.defaultIntegrations];
+  if (Array.isArray(integrationsToInstall)) {
+    const providedIntegrationsNames = integrationsToInstall.map(i => i.name);
+    integrationsToInstall = [
+      // Leave only unique integrations, that were not overridden with provided integrations with the same name
+      ...integrationsToInstall.filter(integration => providedIntegrationsNames.indexOf(integration.name) === -1),
+      ...options.integrations,
+    ];
+  } else if (typeof options.integrations === 'function') {
+    integrationsToInstall = options.integrations(integrationsToInstall);
+  }
+
+  // Just in case someone will return non-array from a `itegrations` callback
+  if (Array.isArray(integrationsToInstall)) {
+    integrationsToInstall.forEach(integration => {
+      if (installedIntegrations.indexOf(integration.name) !== -1) {
+        return;
+      }
+      integrations[name] = integration;
+      try {
+        if (integration.setupOnce) {
+          // TODO remove
+          integration.setupOnce(options);
+        }
+      } catch (_Oo) {
+        logger.warn(`Integration ${integration.name}: The install method is deprecated. Use "setupOnce".`);
+        if (integration.install) {
+          // TODO remove if
+          integration.install(options);
+        }
+      }
+      installedIntegrations.push(integration.name);
+      logger.log(`Integration installed: ${integration.name}`);
+    });
+  }
+  return integrations;
+}
diff --git a/packages/core/src/integrations/pluggable/debug.ts b/packages/core/src/integrations/pluggable/debug.ts
@@ -1,3 +1,4 @@
+import { getCurrentHub } from '@sentry/hub';
 import { configureScope } from '@sentry/minimal';
 import { Integration, SentryEvent, SentryEventHint } from '@sentry/types';
 
@@ -32,28 +33,30 @@ export class Debug implements Integration {
    * @inheritDoc
    */
   public install(): void {
-    configureScope(scope => {
-      scope.addEventProcessor(async (event: SentryEvent, hint?: SentryEventHint) => {
-        // tslint:disable:no-console
-        // tslint:disable:no-debugger
+    if (getCurrentHub().getIntegration(this.name)) {
+      configureScope(scope => {
+        scope.addEventProcessor(async (event: SentryEvent, hint?: SentryEventHint) => {
+          // tslint:disable:no-console
+          // tslint:disable:no-debugger
 
-        if (this.options.debugger) {
-          debugger;
-        }
-
-        if (this.options.stringify) {
-          console.log(JSON.stringify(event, null, 2));
-          if (hint) {
-            console.log(JSON.stringify(hint, null, 2));
+          if (this.options.debugger) {
+            debugger;
           }
-        } else {
-          console.log(event);
-          if (hint) {
-            console.log(hint);
+
+          if (this.options.stringify) {
+            console.log(JSON.stringify(event, null, 2));
+            if (hint) {
+              console.log(JSON.stringify(hint, null, 2));
+            }
+          } else {
+            console.log(event);
+            if (hint) {
+              console.log(hint);
+            }
           }
-        }
-        return event;
+          return event;
+        });
       });
-    });
+    }
   }
 }
diff --git a/packages/core/src/integrations/pluggable/rewriteframes.ts b/packages/core/src/integrations/pluggable/rewriteframes.ts
@@ -43,9 +43,11 @@ export class RewriteFrames implements Integration {
    * @inheritDoc
    */
   public install(): void {
-    getCurrentHub().configureScope((scope: Scope) => {
-      scope.addEventProcessor(async event => this.process(event));
-    });
+    if (getCurrentHub().getIntegration(this.name)) {
+      getCurrentHub().configureScope((scope: Scope) => {
+        scope.addEventProcessor(async event => this.process(event));
+      });
+    }
   }
 
   /** JSDoc */
diff --git a/packages/core/src/interfaces.ts b/packages/core/src/interfaces.ts
@@ -47,9 +47,10 @@ export interface Options {
   dsn?: string;
 
   /**
-   * If this is set to false, default integrations will not be added.
+   * If this is set to false, default integrations will not be added, otherwise this will internally be set to the
+   * recommended default integrations.
    */
-  defaultIntegrations?: boolean;
+  defaultIntegrations?: boolean | Integration[];
 
   /**
    * List of integrations that should be installed after SDK was initialized.
@@ -215,6 +216,9 @@ export interface Client<O extends Options = Options> {
    * @param timeout Maximum time in ms the client should wait.
    */
   close(timeout?: number): Promise<boolean>;
+
+  /** Returns an array of installed integrations on the client. */
+  getIntegration(name: string): Integration | null;
 }
 
 /**
diff --git a/packages/core/src/sdk.ts b/packages/core/src/sdk.ts
diff --git a/packages/hub/src/hub.ts b/packages/hub/src/hub.ts
diff --git a/packages/hub/src/index.ts b/packages/hub/src/index.ts
diff --git a/packages/hub/src/scope.ts b/packages/hub/src/scope.ts
diff --git a/packages/node/src/sdk.ts b/packages/node/src/sdk.ts
diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts

Original file line number	Diff line number	Diff line change
`@@ -62,8 +62,11 @@ export const defaultIntegrations = [`
`62`	`62`	`*`
`63`	`63`	`* @see BrowserOptions for documentation on configuration options.`
`64`	`64`	`*/`
`65`		`-export function init(options: BrowserOptions): void {`
`66`		`- initAndBind(BrowserClient, options, defaultIntegrations);`
	`65`	`+export function init(options: BrowserOptions = {}): void {`
	`66`	`+ if (options.defaultIntegrations === undefined) {`
	`67`	`+ options.defaultIntegrations = defaultIntegrations;`
	`68`	`+ }`
	`69`	`+ initAndBind(BrowserClient, options);`
`67`	`70`	`}`
`68`	`71`
`69`	`72`	`/**`