delete setupTransport(), cleanup TODOs, add doc

Author: Lms24

packages/browser/src/client.ts

@@ -1,19 +1,11 @@
-import {
-  BaseClient,
-  getEnvelopeEndpointWithUrlEncodedAuth,
-  initAPIDetails,
-  NewTransport,
-  Scope,
-  SDK_VERSION,
-} from '@sentry/core';
-import { Event, EventHint, Options, Severity, SeverityLevel, Transport, TransportOptions } from '@sentry/types';
-import { getGlobalObject, logger, stackParserFromOptions, supportsFetch } from '@sentry/utils';
+import { BaseClient, NewTransport, Scope, SDK_VERSION } from '@sentry/core';
+import { Event, EventHint, Options, Severity, SeverityLevel, Transport } from '@sentry/types';
+import { getGlobalObject, logger, stackParserFromOptions } from '@sentry/utils';
 
 import { eventFromException, eventFromMessage } from './eventbuilder';
 import { IS_DEBUG_BUILD } from './flags';
 import { injectReportDialog, ReportDialogOptions } from './helpers';
 import { Breadcrumbs } from './integrations';
-import { FetchTransport, makeNewFetchTransport, makeNewXHRTransport, XHRTransport } from './transports';
 
 /**
  * Configuration options for the Sentry Browser SDK.
@@ -129,40 +121,4 @@ export class BrowserClient extends BaseClient<BrowserOptions> {
     }
     super._sendEvent(event);
   }
-
-  /**
-   * @inheritDoc
-   */
-  protected _setupTransport(): Transport {
-    if (!this._options.dsn) {
-      // We return the noop transport here in case there is no Dsn.
-      return super._setupTransport();
-    }
-
-    const transportOptions: TransportOptions = {
-      ...this._options.transportOptions,
-      dsn: this._options.dsn,
-      tunnel: this._options.tunnel,
-      sendClientReports: this._options.sendClientReports,
-      _metadata: this._options._metadata,
-    };
-
-    const api = initAPIDetails(transportOptions.dsn, transportOptions._metadata, transportOptions.tunnel);
-    const url = getEnvelopeEndpointWithUrlEncodedAuth(api.dsn, api.tunnel);
-
-    if (this._options.transport) {
-      return new this._options.transport(transportOptions);
-    }
-    if (supportsFetch()) {
-      const requestOptions: RequestInit = { ...transportOptions.fetchParameters };
-      this._newTransport = makeNewFetchTransport({ requestOptions, url });
-      return new FetchTransport(transportOptions);
-    }
-
-    this._newTransport = makeNewXHRTransport({
-      url,
-      headers: transportOptions.headers,
-    });
-    return new XHRTransport(transportOptions);
-  }
 }

packages/browser/src/transports/setup.ts

@@ -22,10 +22,15 @@ export interface BrowserTransportOptions extends BaseTransportOptions {
 }
 
 /**
- * TODO: additional doc (since this is not part of Client anymore)
- * @inheritDoc
+ * Sets up Browser transports based on the passed `options`. If available, the returned
+ * transport will use the fetch API. In case fetch is not supported, an XMLHttpRequest
+ * based transport is created.
+ *
+ * @returns an object currently still containing both, the old `Transport` and
+ * `NewTransport` which will eventually replace `Transport`. Once this is replaced,
+ * this function will return a ready to use `NewTransport`.
  */
-// TODO(v7): refactor to only return newTransport
+// TODO(v7): Adjust return value when NewTransport is the default
 export function setupBrowserTransport(options: BrowserOptions): { transport: Transport; newTransport?: NewTransport } {
   if (!options.dsn) {
     // We return the noop transport here in case there is no Dsn.

packages/core/src/baseclient.ts

@@ -34,7 +34,6 @@ import { IS_DEBUG_BUILD } from './flags';
 import { IntegrationIndex, setupIntegrations } from './integration';
 import { createEventEnvelope, createSessionEnvelope } from './request';
 import { NewTransport } from './transports/base';
-import { NoopTransport } from './transports/noop';
 
 const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
 
@@ -687,13 +686,6 @@ export abstract class BaseClient<O extends Options> implements Client<O> {
     );
   }
 
-  /**
-   * Sets up the transport so it can be used later to send requests.
-   */
-  protected _setupTransport(): Transport {
-    return new NoopTransport();
-  }
-
   /**
    * @inheritDoc
    */

packages/core/src/transports/base.ts

@@ -58,14 +58,6 @@ export interface BaseTransportOptions extends InternalBaseTransportOptions {
   url: string;
 }
 
-// TODO(v7): Delete
-export interface BrowserTransportOptions extends BaseTransportOptions {
-  // options to pass into fetch request
-  fetchParams: Record<string, string>;
-  headers?: Record<string, string>;
-  sendClientReports?: boolean;
-}
-
 export interface NewTransport {
   send(request: Envelope): PromiseLike<TransportResponse>;
   flush(timeout?: number): PromiseLike<boolean>;

packages/node/src/client.ts

@@ -1,18 +1,10 @@
-import {
-  BaseClient,
-  getEnvelopeEndpointWithUrlEncodedAuth,
-  initAPIDetails,
-  NewTransport,
-  Scope,
-  SDK_VERSION,
-} from '@sentry/core';
+import { BaseClient, NewTransport, Scope, SDK_VERSION } from '@sentry/core';
 import { SessionFlusher } from '@sentry/hub';
-import { Event, EventHint, Severity, SeverityLevel, Transport, TransportOptions } from '@sentry/types';
-import { logger, makeDsn, resolvedSyncPromise, stackParserFromOptions } from '@sentry/utils';
+import { Event, EventHint, Severity, SeverityLevel, Transport } from '@sentry/types';
+import { logger, resolvedSyncPromise, stackParserFromOptions } from '@sentry/utils';
 
 import { eventFromMessage, eventFromUnknownInput } from './eventbuilder';
 import { IS_DEBUG_BUILD } from './flags';
-import { HTTPSTransport, HTTPTransport, makeNodeTransport } from './transports';
 import { NodeOptions } from './types';
 
 /**
@@ -158,46 +150,4 @@ export class NodeClient extends BaseClient<NodeOptions> {
       this._sessionFlusher.incrementSessionStatusCount();
     }
   }
-
-  /**
-   * @inheritDoc
-   * TODO(v7): delete
-   */
-  protected _setupTransport(): Transport {
-    if (!this._options.dsn) {
-      // We return the noop transport here in case there is no Dsn.
-      return super._setupTransport();
-    }
-
-    const dsn = makeDsn(this._options.dsn);
-
-    const transportOptions: TransportOptions = {
-      ...this._options.transportOptions,
-      ...(this._options.httpProxy && { httpProxy: this._options.httpProxy }),
-      ...(this._options.httpsProxy && { httpsProxy: this._options.httpsProxy }),
-      ...(this._options.caCerts && { caCerts: this._options.caCerts }),
-      dsn: this._options.dsn,
-      tunnel: this._options.tunnel,
-      _metadata: this._options._metadata,
-    };
-
-    if (this._options.transport) {
-      return new this._options.transport(transportOptions);
-    }
-
-    const api = initAPIDetails(transportOptions.dsn, transportOptions._metadata, transportOptions.tunnel);
-    const url = getEnvelopeEndpointWithUrlEncodedAuth(api.dsn, api.tunnel);
-
-    this._newTransport = makeNodeTransport({
-      url,
-      headers: transportOptions.headers,
-      proxy: transportOptions.httpProxy,
-      caCerts: transportOptions.caCerts,
-    });
-
-    if (dsn.protocol === 'http') {
-      return new HTTPTransport(transportOptions);
-    }
-    return new HTTPSTransport(transportOptions);
-  }
 }

packages/node/src/sdk.ts

@@ -131,7 +131,6 @@ export function init(options: NodeOptions = {}): void {
     setHubOnCarrier(carrier, getCurrentHub());
   }
 
-  // TODO(v7): Init transport here and pass it to initAndBind
   const { transport, newTransport } = setupNodeTransport(options);
   initAndBind(NodeClient, options, transport, newTransport);
 

packages/node/src/transports/setup.ts

@@ -6,10 +6,13 @@ import { NodeOptions } from '../types';
 import { HTTPSTransport, HTTPTransport, makeNodeTransport } from '.';
 
 /**
- * TODO(v7): Add documentation
- * @inheritDoc
+ * Sets up Node transport based on the passed `options`.
+ *
+ * @returns an object currently still containing both, the old `Transport` and
+ * `NewTransport` which will eventually replace `Transport`. Once this is replaced,
+ * this function will return a ready to use `NewTransport`.
  */
-// TODO(v7): Adjust when NewTransport is the default
+// TODO(v7): Adjust return value when NewTransport is the default
 export function setupNodeTransport(options: NodeOptions): { transport: Transport; newTransport?: NewTransport } {
   if (!options.dsn) {
     // We return the noop transport here in case there is no Dsn.