add first PoC implementation for Transport injection

Author: Lms24

packages/browser/src/client.ts

@@ -1,4 +1,11 @@
-import { BaseClient, getEnvelopeEndpointWithUrlEncodedAuth, initAPIDetails, Scope, SDK_VERSION } from '@sentry/core';
+import {
+  BaseClient,
+  getEnvelopeEndpointWithUrlEncodedAuth,
+  initAPIDetails,
+  NewTransport,
+  Scope,
+  SDK_VERSION,
+} from '@sentry/core';
 import { Event, EventHint, Options, Severity, Transport, TransportOptions } from '@sentry/types';
 import { getGlobalObject, logger, stackParserFromOptions, supportsFetch } from '@sentry/utils';
 
@@ -40,7 +47,7 @@ export class BrowserClient extends BaseClient<BrowserOptions> {
    *
    * @param options Configuration options for this SDK.
    */
-  public constructor(options: BrowserOptions = {}) {
+  public constructor(options: BrowserOptions = {}, transport: Transport, newTransport?: NewTransport) {
     options._metadata = options._metadata || {};
     options._metadata.sdk = options._metadata.sdk || {
       name: 'sentry.javascript.browser',
@@ -53,7 +60,7 @@ export class BrowserClient extends BaseClient<BrowserOptions> {
       version: SDK_VERSION,
     };
 
-    super(options);
+    super(options, transport, newTransport);
   }
 
   /**

packages/browser/src/sdk.ts

@@ -7,6 +7,7 @@ import { IS_DEBUG_BUILD } from './flags';
 import { ReportDialogOptions, wrap as internalWrap } from './helpers';
 import { Breadcrumbs, Dedupe, GlobalHandlers, LinkedErrors, TryCatch, UserAgent } from './integrations';
 import { defaultStackParsers } from './stack-parsers';
+import { setupBrowserTransport } from './transports/setup';
 
 export const defaultIntegrations = [
   new CoreIntegrations.InboundFilters(),
@@ -97,7 +98,8 @@ export function init(options: BrowserOptions = {}): void {
     options.stackParser = defaultStackParsers;
   }
 
-  initAndBind(BrowserClient, options);
+  const { transport, newTransport } = setupBrowserTransport(options);
+  initAndBind(BrowserClient, options, transport, newTransport);
 
   if (options.autoSessionTracking) {
     startSessionTracking();

packages/browser/src/transports/index.ts

@@ -4,3 +4,5 @@ export { XHRTransport } from './xhr';
 
 export { makeNewFetchTransport } from './new-fetch';
 export { makeNewXHRTransport } from './new-xhr';
+
+export { setupBrowserTransport } from './setup';

packages/browser/src/transports/setup.ts

@@ -0,0 +1,62 @@
+import {
+  BaseTransportOptions,
+  getEnvelopeEndpointWithUrlEncodedAuth,
+  initAPIDetails,
+  NewTransport,
+  NoopTransport,
+} from '@sentry/core';
+import { Transport, TransportOptions } from '@sentry/types';
+import { supportsFetch } from '@sentry/utils';
+
+import { BrowserOptions } from '../client';
+import { FetchTransport } from './fetch';
+import { makeNewFetchTransport } from './new-fetch';
+import { makeNewXHRTransport } from './new-xhr';
+import { XHRTransport } from './xhr';
+
+export interface BrowserTransportOptions extends BaseTransportOptions {
+  // options to pass into fetch request
+  fetchParams: Record<string, string>;
+  headers?: Record<string, string>;
+  sendClientReports?: boolean;
+}
+
+/**
+ * TODO: additional doc (since this is not part of Client anymore)
+ * @inheritDoc
+ */
+// TODO(v7): refactor to only return newTransport
+export function setupBrowserTransport(options: BrowserOptions): { transport: Transport; newTransport?: NewTransport } {
+  if (!options.dsn) {
+    // We return the noop transport here in case there is no Dsn.
+    return { transport: new NoopTransport() };
+  }
+
+  const transportOptions: TransportOptions = {
+    ...options.transportOptions,
+    dsn: options.dsn,
+    tunnel: options.tunnel,
+    sendClientReports: options.sendClientReports,
+    _metadata: options._metadata,
+  };
+
+  const api = initAPIDetails(transportOptions.dsn, transportOptions._metadata, transportOptions.tunnel);
+  const url = getEnvelopeEndpointWithUrlEncodedAuth(api.dsn, api.tunnel);
+
+  if (options.transport) {
+    return { transport: new options.transport(transportOptions) };
+  }
+  if (supportsFetch()) {
+    const requestOptions: RequestInit = { ...transportOptions.fetchParameters };
+    const newTransport = makeNewFetchTransport({ requestOptions, url });
+    const fetchTransport = new FetchTransport(transportOptions);
+    return { transport: fetchTransport, newTransport };
+  }
+
+  const newTransport = makeNewXHRTransport({
+    url,
+    headers: transportOptions.headers,
+  });
+  const transport = new XHRTransport(transportOptions);
+  return { transport, newTransport };
+}

packages/core/src/baseclient.ts

@@ -91,8 +91,10 @@ export abstract class BaseClient<O extends Options> implements Client<O> {
    * Initializes this client instance.
    *
    * @param options Options for the client.
+   * @param transport The (old) Transport instance for the client to use (TODO(v7): remove)
+   * @param newTransport The NewTransport instance for the client to use
    */
-  protected constructor(options: O) {
+  protected constructor(options: O, transport: Transport, newTransport?: NewTransport) {
     this._options = options;
 
     if (options.dsn) {
@@ -101,7 +103,9 @@ export abstract class BaseClient<O extends Options> implements Client<O> {
       IS_DEBUG_BUILD && logger.warn('No DSN provided, client will not do anything.');
     }
 
-    this._transport = this._setupTransport();
+    // TODO(v7): remove old transport
+    this._transport = transport;
+    this._newTransport = newTransport;
   }
 
   /**

packages/core/src/sdk.ts

@@ -1,11 +1,16 @@
 import { getCurrentHub } from '@sentry/hub';
-import { Client, Options } from '@sentry/types';
+import { Client, Options, Transport } from '@sentry/types';
 import { logger } from '@sentry/utils';
 
 import { IS_DEBUG_BUILD } from './flags';
+import { NewTransport } from './transports/base';
 
 /** A class object that can instantiate Client objects. */
-export type ClientClass<F extends Client, O extends Options> = new (options: O) => F;
+export type ClientClass<F extends Client, O extends Options> = new (
+  options: O,
+  transport: Transport,
+  newTransport?: NewTransport,
+) => F;
 
 /**
  * Internal function to create a new SDK client instance. The client is
@@ -14,7 +19,12 @@ export type ClientClass<F extends Client, O extends Options> = new (options: O)
  * @param clientClass The client class to instantiate.
  * @param options Options to pass to the client.
  */
-export function initAndBind<F extends Client, O extends Options>(clientClass: ClientClass<F, O>, options: O): void {
+export function initAndBind<F extends Client, O extends Options>(
+  clientClass: ClientClass<F, O>,
+  options: O,
+  transport: Transport,
+  newTransport?: NewTransport,
+): void {
   if (options.debug === true) {
     if (IS_DEBUG_BUILD) {
       logger.enable();
@@ -29,6 +39,7 @@ export function initAndBind<F extends Client, O extends Options>(clientClass: Cl
   if (scope) {
     scope.update(options.initialScope);
   }
-  const client = new clientClass(options);
+
+  const client = new clientClass(options, transport, newTransport);
   hub.bindClient(client);
 }

packages/core/src/transports/base.ts

@@ -51,15 +51,14 @@ export type TransportResponse = {
 interface InternalBaseTransportOptions {
   bufferSize?: number;
 }
-
 export interface BaseTransportOptions extends InternalBaseTransportOptions {
   // url to send the event
   // transport does not care about dsn specific - client should take care of
   // parsing and figuring that out
   url: string;
 }
 
-// TODO: Move into Browser Transport
+// TODO(v7): Delete
 export interface BrowserTransportOptions extends BaseTransportOptions {
   // options to pass into fetch request
   fetchParams: Record<string, string>;

packages/core/test/mocks/client.ts

@@ -74,6 +74,7 @@ export class TestClient extends BaseClient<TestOptions> {
   }
 }
 
+// TODO(v7): wtf?
 export function init(options: TestOptions): void {
   initAndBind(TestClient, options);
 }

packages/node/src/client.ts

@@ -1,4 +1,11 @@
-import { BaseClient, getEnvelopeEndpointWithUrlEncodedAuth, initAPIDetails, Scope, SDK_VERSION } from '@sentry/core';
+import {
+  BaseClient,
+  getEnvelopeEndpointWithUrlEncodedAuth,
+  initAPIDetails,
+  NewTransport,
+  Scope,
+  SDK_VERSION,
+} from '@sentry/core';
 import { SessionFlusher } from '@sentry/hub';
 import { Event, EventHint, Severity, Transport, TransportOptions } from '@sentry/types';
 import { logger, makeDsn, resolvedSyncPromise, stackParserFromOptions } from '@sentry/utils';
@@ -21,7 +28,7 @@ export class NodeClient extends BaseClient<NodeOptions> {
    * Creates a new Node SDK instance.
    * @param options Configuration options for this SDK.
    */
-  public constructor(options: NodeOptions) {
+  public constructor(options: NodeOptions, transport: Transport, newTransport?: NewTransport) {
     options._metadata = options._metadata || {};
     options._metadata.sdk = options._metadata.sdk || {
       name: 'sentry.javascript.node',
@@ -34,7 +41,7 @@ export class NodeClient extends BaseClient<NodeOptions> {
       version: SDK_VERSION,
     };
 
-    super(options);
+    super(options, transport, newTransport);
   }
 
   /**
@@ -149,6 +156,7 @@ export class NodeClient extends BaseClient<NodeOptions> {
 
   /**
    * @inheritDoc
+   * TODO(v7): delete
    */
   protected _setupTransport(): Transport {
     if (!this._options.dsn) {

packages/node/src/sdk.ts

@@ -8,6 +8,7 @@ import { NodeClient } from './client';
 import { IS_DEBUG_BUILD } from './flags';
 import { Console, ContextLines, Http, LinkedErrors, OnUncaughtException, OnUnhandledRejection } from './integrations';
 import { nodeStackParser } from './stack-parser';
+import { setupNodeTransport } from './transports';
 import { NodeOptions } from './types';
 
 export const defaultIntegrations = [
@@ -130,7 +131,9 @@ export function init(options: NodeOptions = {}): void {
     setHubOnCarrier(carrier, getCurrentHub());
   }
 
-  initAndBind(NodeClient, options);
+  // TODO(v7): Init transport here and pass it to initAndBind
+  const { transport, newTransport } = setupNodeTransport(options);
+  initAndBind(NodeClient, options, transport, newTransport);
 
   if (options.autoSessionTracking) {
     startSessionTracking();

packages/node/src/transports/index.ts

@@ -2,3 +2,4 @@ export { BaseTransport } from './base';
 export { HTTPTransport } from './http';
 export { HTTPSTransport } from './https';
 export { makeNodeTransport, NodeTransportOptions } from './new';
+export { setupNodeTransport } from './setup';

packages/node/src/transports/setup.ts

@@ -0,0 +1,49 @@
+import { getEnvelopeEndpointWithUrlEncodedAuth, initAPIDetails, NewTransport, NoopTransport } from '@sentry/core';
+import { Transport, TransportOptions } from '@sentry/types';
+import { makeDsn } from '@sentry/utils';
+
+import { NodeOptions } from '../types';
+import { HTTPSTransport, HTTPTransport, makeNodeTransport } from '.';
+
+/**
+ * TODO(v7): Add documentation
+ * @inheritDoc
+ */
+// TODO(v7): Adjust 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.
+    return { transport: new NoopTransport() };
+  }
+
+  const dsn = makeDsn(options.dsn);
+
+  const transportOptions: TransportOptions = {
+    ...options.transportOptions,
+    ...(options.httpProxy && { httpProxy: options.httpProxy }),
+    ...(options.httpsProxy && { httpsProxy: options.httpsProxy }),
+    ...(options.caCerts && { caCerts: options.caCerts }),
+    dsn: options.dsn,
+    tunnel: options.tunnel,
+    _metadata: options._metadata,
+  };
+
+  if (options.transport) {
+    return { transport: new options.transport(transportOptions) };
+  }
+
+  const api = initAPIDetails(transportOptions.dsn, transportOptions._metadata, transportOptions.tunnel);
+  const url = getEnvelopeEndpointWithUrlEncodedAuth(api.dsn, api.tunnel);
+
+  const newTransport = makeNodeTransport({
+    url,
+    headers: transportOptions.headers,
+    proxy: transportOptions.httpProxy,
+    caCerts: transportOptions.caCerts,
+  });
+
+  if (dsn.protocol === 'http') {
+    return { transport: new HTTPTransport(transportOptions), newTransport };
+  }
+  return { transport: new HTTPSTransport(transportOptions), newTransport };
+}