ref: Abstract transports to use BaseTransport class

Author: kamilogorek

packages/browser/src/backend.ts

@@ -1,7 +1,7 @@
 import { Backend, DSN, Options, SentryError } from '@sentry/core';
 import { addBreadcrumb, captureEvent } from '@sentry/minimal';
 import { SentryEvent } from '@sentry/types';
-import { supportsFetch, urlEncode } from '@sentry/utils';
+import { supportsFetch } from '@sentry/utils';
 import { Raven } from './raven';
 import { FetchTransport, XHRTransport } from './transports';
 
@@ -116,51 +116,19 @@ export class BrowserBackend implements Backend {
    * @inheritDoc
    */
   public async sendEvent(event: SentryEvent): Promise<number> {
-    let dsn;
+    let dsn: DSN;
 
     if (!this.options.dsn) {
       throw new SentryError('Cannot sendEvent without a valid DSN');
     } else {
       dsn = new DSN(this.options.dsn);
     }
 
-    const auth = {
-      sentry_client: `raven-js/${Raven.VERSION}`,
-      sentry_key: dsn.user,
-      sentry_secret: '',
-      sentry_version: '7',
-    };
-
-    if (dsn.pass) {
-      auth.sentry_secret = dsn.pass;
-    } else {
-      delete auth.sentry_secret;
-    }
-
-    const lastSlash = dsn.path.lastIndexOf('/');
-    const path = dsn.path.substr(1, lastSlash);
-
-    const _globalProject = dsn.path.substr(lastSlash + 1);
-    let globalServer = `//${dsn.host}${dsn.port ? `:${dsn.port}` : ''}`;
-
-    if (dsn.protocol) {
-      globalServer = `${dsn.protocol}':'${globalServer}`;
-    }
-
-    const _globalEndpoint = `${globalServer}/${path}api/${_globalProject}/store/`;
-
-    // Auth is intentionally sent as part of query string (NOT as custom HTTP header)
-    // to avoid preflight CORS requests
-    const url = `${_globalEndpoint}?${urlEncode(auth)}`;
-
     const transport = this.options.transport
-      ? this.options.transport
+      ? new this.options.transport({ dsn })
       : supportsFetch()
-        ? new FetchTransport({ url })
-        : new XHRTransport({ url });
-
-    // tslint:disable-next-line
-    debugger;
+        ? new FetchTransport({ dsn })
+        : new XHRTransport({ dsn });
 
     return transport
       .send(event)

packages/browser/src/transports/base.ts

@@ -0,0 +1,52 @@
+import { SentryError } from '@sentry/core';
+import {
+  DSNComponents,
+  SentryEvent,
+  Transport,
+  TransportOptions,
+} from '@sentry/types';
+import { urlEncode } from '@sentry/utils';
+
+/** Base Transport class implementation */
+export abstract class BaseTransport implements Transport {
+  /**
+   * @inheritDoc
+   */
+  public endpointUrl: string;
+
+  public constructor(public options: TransportOptions) {
+    this.endpointUrl = this.composeEndpointUrl(options.dsn);
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public composeEndpointUrl(dsn: DSNComponents): string {
+    const auth = {
+      sentry_key: dsn.user,
+      sentry_secret: '',
+      sentry_version: '7',
+    };
+
+    if (dsn.pass) {
+      auth.sentry_secret = dsn.pass;
+    } else {
+      delete auth.sentry_secret;
+    }
+
+    const protocol = dsn.protocol ? `${dsn.protocol}:` : '';
+    const port = dsn.port ? `:${dsn.port}` : '';
+    const endpoint = `${protocol}//${dsn.host}${port}/api/${dsn.path}/store/`;
+
+    // Auth is intentionally sent as part of query string (NOT as custom HTTP header)
+    // to avoid preflight CORS requests
+    return `${endpoint}?${urlEncode(auth)}`;
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public async send(_: SentryEvent): Promise<Response | XMLHttpRequest> {
+    throw new SentryError('Transport Class has to implement `send` method');
+  }
+}

packages/browser/src/transports/fetch.ts

@@ -1,10 +1,9 @@
-import { SentryEvent, Transport } from '@sentry/types';
+import { SentryEvent } from '@sentry/types';
 import { serialize, supportsReferrerPolicy } from '@sentry/utils';
+import { BaseTransport } from './base';
 
 /** `fetch` based transport */
-export class FetchTransport implements Transport {
-  public constructor(public config: { url: string }) {}
-
+export class FetchTransport extends BaseTransport {
   /**
    * @inheritDoc
    */
@@ -23,6 +22,6 @@ export class FetchTransport implements Transport {
     };
 
     // TODO: Safe _window access
-    return window.fetch(this.config.url, defaultOptions);
+    return window.fetch(this.endpointUrl, defaultOptions);
   }
 }

packages/browser/src/transports/index.ts

@@ -1,2 +1,3 @@
+export { BaseTransport } from './base';
 export { FetchTransport } from './fetch';
 export { XHRTransport } from './xhr';

packages/browser/src/transports/xhr.ts

@@ -1,10 +1,9 @@
-import { SentryEvent, Transport } from '@sentry/types';
+import { SentryEvent } from '@sentry/types';
 import { serialize } from '@sentry/utils';
+import { BaseTransport } from './base';
 
 /** `XHR` based transport */
-export class XHRTransport implements Transport {
-  public constructor(public config: { url: string }) {}
-
+export class XHRTransport extends BaseTransport {
   /**
    * @inheritDoc
    */
@@ -24,7 +23,7 @@ export class XHRTransport implements Transport {
         reject(request);
       };
 
-      request.open('POST', this.config.url);
+      request.open('POST', this.endpointUrl);
       request.send(serialize(event));
     });
   }

packages/core/src/interfaces.ts

@@ -1,5 +1,11 @@
 import { Scope } from '@sentry/hub';
-import { Breadcrumb, Integration, SentryEvent, Transport } from '@sentry/types';
+import {
+  Breadcrumb,
+  Integration,
+  SentryEvent,
+  Transport,
+  TransportClass,
+} from '@sentry/types';
 import { DSN } from './dsn';
 import { SendStatus } from './status';
 
@@ -42,7 +48,7 @@ export interface Options {
   /**
    * Transport object that should be used to send events to Sentry
    */
-  transport?: Transport;
+  transport?: TransportClass<Transport>;
 
   /**
    * The release identifier used when uploading respective source maps. Specify

packages/types/src/index.ts

@@ -150,10 +150,18 @@ export interface Integration {
   install(): void;
 }
 
+export interface TransportOptions {
+  dsn: DSNComponents;
+}
+
 /** TODO */
 export interface Transport {
-  config: {
-    url: string;
-  };
+  endpointUrl: string;
+  composeEndpointUrl(dsn: DSNComponents): string;
   send(event: SentryEvent): Promise<Response | XMLHttpRequest>;
 }
+
+/** TODO */
+export interface TransportClass<T extends Transport> {
+  new (options: TransportOptions): T;
+}