ref(browser): Consolidate transport methods (#4340)

Now browser transports only override a protected `_sendRequest`. Removes duplication of `sendEvent`.

Author: AbhiPrasad

packages/browser/src/transports/base.ts

@@ -1,14 +1,18 @@
 import {
   APIDetails,
+  eventToSentryRequest,
   getEnvelopeEndpointWithUrlEncodedAuth,
   getStoreEndpointWithUrlEncodedAuth,
   initAPIDetails,
+  sessionToSentryRequest,
 } from '@sentry/core';
 import {
   Event,
   Outcome,
   Response as SentryResponse,
+  SentryRequest,
   SentryRequestType,
+  Session,
   Transport,
   TransportOptions,
 } from '@sentry/types';
@@ -21,7 +25,6 @@ import {
   makePromiseBuffer,
   parseRetryAfterHeader,
   PromiseBuffer,
-  SentryError,
 } from '@sentry/utils';
 
 import { sendReport } from './utils';
@@ -68,8 +71,15 @@ export abstract class BaseTransport implements Transport {
   /**
    * @inheritDoc
    */
-  public sendEvent(_: Event): PromiseLike<SentryResponse> {
-    throw new SentryError('Transport Class has to implement `sendEvent` method');
+  public sendEvent(event: Event): PromiseLike<SentryResponse> {
+    return this._sendRequest(eventToSentryRequest(event, this._api), event);
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public sendSession(session: Session): PromiseLike<SentryResponse> {
+    return this._sendRequest(sessionToSentryRequest(session, this._api), session);
   }
 
   /**
@@ -223,4 +233,9 @@ export abstract class BaseTransport implements Transport {
     }
     return false;
   }
+
+  protected abstract _sendRequest(
+    sentryRequest: SentryRequest,
+    originalPayload: Event | Session,
+  ): PromiseLike<SentryResponse>;
 }

packages/browser/src/transports/fetch.ts

@@ -1,4 +1,3 @@
-import { eventToSentryRequest, sessionToSentryRequest } from '@sentry/core';
 import { Event, Response, SentryRequest, Session, TransportOptions } from '@sentry/types';
 import { SentryError, supportsReferrerPolicy, SyncPromise } from '@sentry/utils';
 
@@ -17,25 +16,11 @@ export class FetchTransport extends BaseTransport {
     this._fetch = fetchImpl;
   }
 
-  /**
-   * @inheritDoc
-   */
-  public sendEvent(event: Event): PromiseLike<Response> {
-    return this._sendRequest(eventToSentryRequest(event, this._api), event);
-  }
-
-  /**
-   * @inheritDoc
-   */
-  public sendSession(session: Session): PromiseLike<Response> {
-    return this._sendRequest(sessionToSentryRequest(session, this._api), session);
-  }
-
   /**
    * @param sentryRequest Prepared SentryRequest to be delivered
    * @param originalPayload Original payload used to create SentryRequest
    */
-  private _sendRequest(sentryRequest: SentryRequest, originalPayload: Event | Session): PromiseLike<Response> {
+  protected _sendRequest(sentryRequest: SentryRequest, originalPayload: Event | Session): PromiseLike<Response> {
     if (this._isRateLimited(sentryRequest.type)) {
       this.recordLostEvent('ratelimit_backoff', sentryRequest.type);
 

packages/browser/src/transports/xhr.ts

@@ -1,30 +1,15 @@
-import { eventToSentryRequest, sessionToSentryRequest } from '@sentry/core';
 import { Event, Response, SentryRequest, Session } from '@sentry/types';
 import { SentryError, SyncPromise } from '@sentry/utils';
 
 import { BaseTransport } from './base';
 
 /** `XHR` based transport */
 export class XHRTransport extends BaseTransport {
-  /**
-   * @inheritDoc
-   */
-  public sendEvent(event: Event): PromiseLike<Response> {
-    return this._sendRequest(eventToSentryRequest(event, this._api), event);
-  }
-
-  /**
-   * @inheritDoc
-   */
-  public sendSession(session: Session): PromiseLike<Response> {
-    return this._sendRequest(sessionToSentryRequest(session, this._api), session);
-  }
-
   /**
    * @param sentryRequest Prepared SentryRequest to be delivered
    * @param originalPayload Original payload used to create SentryRequest
    */
-  private _sendRequest(sentryRequest: SentryRequest, originalPayload: Event | Session): PromiseLike<Response> {
+  protected _sendRequest(sentryRequest: SentryRequest, originalPayload: Event | Session): PromiseLike<Response> {
     if (this._isRateLimited(sentryRequest.type)) {
       this.recordLostEvent('ratelimit_backoff', sentryRequest.type);
 

packages/browser/test/unit/integrations/helpers.test.ts

@@ -1,5 +1,5 @@
 import { WrappedFunction } from '@sentry/types';
-import { SinonSpy, spy } from 'sinon';
+import { spy } from 'sinon';
 
 import { wrap } from '../../../src/helpers';
 

packages/browser/test/unit/transports/base.test.ts

@@ -112,12 +112,13 @@ describe('BaseTransport', () => {
   });
 
   it('doesnt provide sendEvent() implementation', () => {
+    expect.assertions(1);
     const transport = new SimpleTransport({ dsn: testDsn });
 
     try {
       void transport.sendEvent({});
     } catch (e) {
-      expect(e.message).toBe('Transport Class has to implement `sendEvent` method');
+      expect(e).toBeDefined();
     }
   });