[v7] Remove Backend usage from the whole SDK architecture

Author: kamilogorek

packages/browser/src/backend.ts

@@ -1,19 +1,53 @@
 import { BaseClient, Scope, SDK_VERSION } from '@sentry/core';
-import { Event, EventHint } from '@sentry/types';
-import { getGlobalObject, logger } from '@sentry/utils';
-import { ReportDialogOptions } from '@sentry/transport-base';
+import { Event, EventHint, Options, Severity } from '@sentry/types';
+import { getGlobalObject, logger, supportsFetch } from '@sentry/utils';
+import { NoopTransport, ReportDialogOptions, Transport, TransportOptions } from '@sentry/transport-base';
+import { FetchTransport } from '@sentry/transport-fetch';
+import { XHRTransport } from '@sentry/transport-xhr';
 
-import { BrowserBackend, BrowserOptions } from './backend';
 import { injectReportDialog } from './helpers';
 import { Breadcrumbs } from './integrations';
+import { eventFromException, eventFromMessage } from './eventbuilder';
+
+/**
+ * Configuration options for the Sentry Browser SDK.
+ * @see BrowserClient for more information.
+ */
+export interface BrowserOptions extends Options {
+  /**
+   * A pattern for error URLs which should exclusively be sent to Sentry.
+   * This is the opposite of {@link Options.denyUrls}.
+   * By default, all errors will be sent.
+   */
+  allowUrls?: Array<string | RegExp>;
+
+  /**
+   * A pattern for error URLs which should not be sent to Sentry.
+   * To allow certain errors instead, use {@link Options.allowUrls}.
+   * By default, all errors will be sent.
+   */
+  denyUrls?: Array<string | RegExp>;
+
+  /** @deprecated use {@link Options.allowUrls} instead. */
+  whitelistUrls?: Array<string | RegExp>;
+
+  /** @deprecated use {@link Options.denyUrls} instead. */
+  blacklistUrls?: Array<string | RegExp>;
+
+  /**
+   * A flag enabling Sessions Tracking feature.
+   * By default Sessions Tracking is disabled.
+   */
+  autoSessionTracking?: boolean;
+}
 
 /**
  * The Sentry Browser SDK Client.
  *
  * @see BrowserOptions for documentation on configuration options.
  * @see SentryClient for usage documentation.
  */
-export class BrowserClient extends BaseClient<BrowserBackend, BrowserOptions> {
+export class BrowserClient extends BaseClient<BrowserOptions> {
   /**
    * Creates a new Browser SDK instance.
    *
@@ -32,7 +66,20 @@ export class BrowserClient extends BaseClient<BrowserBackend, BrowserOptions> {
       version: SDK_VERSION,
     };
 
-    super(BrowserBackend, options);
+    super(options);
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public eventFromException(exception: unknown, hint?: EventHint): PromiseLike<Event> {
+    return eventFromException(this._options, exception, hint);
+  }
+  /**
+   * @inheritDoc
+   */
+  public eventFromMessage(message: string, level: Severity = Severity.Info, hint?: EventHint): PromiseLike<Event> {
+    return eventFromMessage(this._options, message, level, hint);
   }
 
   /**
@@ -76,4 +123,26 @@ export class BrowserClient extends BaseClient<BrowserBackend, BrowserOptions> {
     }
     super._sendEvent(event);
   }
+
+  protected _setupTransport(): Transport {
+    // TODO: This whole function should be unnecessary and moved to client construction
+    if (!this._options.dsn) {
+      // We return the noop transport here in case there is no Dsn.
+      return new NoopTransport();
+    }
+
+    const transportOptions: TransportOptions = {
+      ...this._options.transportOptions,
+      dsn: this._options.transportOptions?.dsn ?? this._options.dsn,
+    };
+
+    if (this._options.transport) {
+      return new this._options.transport(transportOptions);
+    }
+
+    if (supportsFetch()) {
+      return new FetchTransport(transportOptions);
+    }
+    return new XHRTransport(transportOptions);
+  }
 }

packages/browser/src/client.ts

@@ -38,8 +38,7 @@ export {
   withScope,
 } from '@sentry/core';
 
-export { BrowserOptions } from './backend';
-export { BrowserClient } from './client';
+export { BrowserClient, BrowserOptions } from './client';
 export { injectReportDialog } from './helpers';
 export { eventFromException, eventFromMessage } from './eventbuilder';
 export { defaultIntegrations, forceLoad, init, lastEventId, onLoad, showReportDialog, flush, close, wrap } from './sdk';

packages/browser/src/exports.ts

@@ -2,8 +2,7 @@ import { getCurrentHub, initAndBind, Integrations as CoreIntegrations } from '@s
 import { addInstrumentationHandler, getGlobalObject, logger, SyncPromise } from '@sentry/utils';
 import { ReportDialogOptions } from '@sentry/transport-base';
 
-import { BrowserOptions } from './backend';
-import { BrowserClient } from './client';
+import { BrowserClient, BrowserOptions } from './client';
 import { wrap as internalWrap } from './helpers';
 import { Breadcrumbs, GlobalHandlers, LinkedErrors, TryCatch, UserAgent } from './integrations';
 

packages/browser/src/sdk.ts

@@ -1,10 +1,13 @@
-import { ExtendedError } from '@sentry/types';
+import { Event, ExtendedError } from '@sentry/types';
 import { expect } from 'chai';
 import { stub } from 'sinon';
 
-import { BrowserBackend } from '../../../src/backend';
 import { LinkedErrors } from '../../../src/integrations/linkederrors';
 
+class BrowserBackend {
+  eventFromException: (ex: unknown) => PromiseLike<Event> = () => Promise.resolve({});
+}
+
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 let linkedErrors: any;
 
@@ -62,7 +65,7 @@ describe('LinkedErrors', () => {
       one.cause = two;
 
       const originalException = one;
-      const backend = new BrowserBackend({});
+      const backend = new BrowserBackend();
       return backend.eventFromException(originalException).then(event => {
         const result = linkedErrors._handler(event, {
           originalException,
@@ -96,7 +99,7 @@ describe('LinkedErrors', () => {
       one.reason = two;
 
       const originalException = one;
-      const backend = new BrowserBackend({});
+      const backend = new BrowserBackend();
       return backend.eventFromException(originalException).then(event => {
         const result = linkedErrors._handler(event, {
           originalException,
@@ -126,7 +129,7 @@ describe('LinkedErrors', () => {
       one.cause = two;
       two.cause = three;
 
-      const backend = new BrowserBackend({});
+      const backend = new BrowserBackend();
       return backend.eventFromException(one).then(event => {
         const result = linkedErrors._handler(event, {
           originalException: one,