ref: Unify integrations options and set proper defaults

Author: kamilogorek

packages/browser/src/integrations/breadcrumbs.ts

@@ -43,35 +43,42 @@ function addSentryBreadcrumb(serializedData: string): void {
   }
 }
 
+/** JSDoc */
+interface BreadcrumbIntegrations {
+  beacon?: boolean;
+  console?: boolean;
+  dom?: boolean;
+  fetch?: boolean;
+  history?: boolean;
+  sentry?: boolean;
+  xhr?: boolean;
+}
+
 /** Default Breadcrumbs instrumentations */
 export class Breadcrumbs implements Integration {
   /**
    * @inheritDoc
    */
   public name: string = 'Breadcrumbs';
 
+  /** JSDoc */
+  private readonly options: BreadcrumbIntegrations;
+
   /**
    * @inheritDoc
    */
-  public constructor(
-    private readonly config: {
-      beacon?: boolean;
-      console?: boolean;
-      dom?: boolean;
-      fetch?: boolean;
-      history?: boolean;
-      sentry?: boolean;
-      xhr?: boolean;
-    } = {
+  public constructor(options?: BreadcrumbIntegrations) {
+    this.options = {
       beacon: true,
       console: true,
       dom: true,
       fetch: true,
       history: true,
       sentry: true,
       xhr: true,
-    },
-  ) {}
+      ...options,
+    };
+  }
 
   /** JSDoc */
   private instrumentBeacon(options: { filterUrl?: string }): void {
@@ -447,28 +454,26 @@ export class Breadcrumbs implements Integration {
    *  - XMLHttpRequest API
    *  - Fetch API
    *  - History API
-   *
-   * Can be disabled or individually configured via the `autoBreadcrumbs` config option
    */
   public install(options: BrowserOptions = {}): void {
     const filterUrl = options.dsn && new API(options.dsn).getStoreEndpoint();
 
-    if (this.config.console) {
+    if (this.options.console) {
       this.instrumentConsole();
     }
-    if (this.config.dom) {
+    if (this.options.dom) {
       this.instrumentDOM();
     }
-    if (this.config.xhr) {
+    if (this.options.xhr) {
       this.instrumentXHR({ filterUrl });
     }
-    if (this.config.fetch) {
+    if (this.options.fetch) {
       this.instrumentFetch({ filterUrl });
     }
-    if (this.config.beacon) {
+    if (this.options.beacon) {
       this.instrumentBeacon({ filterUrl });
     }
-    if (this.config.history) {
+    if (this.options.history) {
       this.instrumentHistory();
     }
   }

packages/browser/src/integrations/globalhandlers.ts

@@ -9,21 +9,30 @@ import {
 } from '../tracekit';
 import { shouldIgnoreOnError } from './helpers';
 
+/** JSDoc */
+interface GlobalHandlersIntegrations {
+  onerror: boolean;
+  onunhandledrejection: boolean;
+}
+
 /** Global handlers */
 export class GlobalHandlers implements Integration {
   /**
    * @inheritDoc
    */
   public name: string = 'GlobalHandlers';
-  public constructor(
-    private readonly options: {
-      onerror: boolean;
-      onunhandledrejection: boolean;
-    } = {
+
+  /** JSDoc */
+  private readonly options: GlobalHandlersIntegrations;
+
+  /** JSDoc */
+  public constructor(options?: GlobalHandlersIntegrations) {
+    this.options = {
       onerror: true,
       onunhandledrejection: true,
-    },
-  ) {}
+      ...options,
+    };
+  }
   /**
    * @inheritDoc
    */

packages/browser/src/integrations/reportingobserver.ts

@@ -63,7 +63,7 @@ export class ReportingObserver implements Integration {
    * @inheritDoc
    */
   public constructor(
-    private readonly config: {
+    private readonly options: {
       types?: ReportTypes[];
     } = {
       types: [ReportTypes.Crash, ReportTypes.Deprecation, ReportTypes.Intervention],
@@ -82,7 +82,7 @@ export class ReportingObserver implements Integration {
       ReportingObserver: any;
     }).ReportingObserver(this.handler.bind(this), {
       buffered: true,
-      types: this.config.types,
+      types: this.options.types,
     });
 
     observer.observe();