Merge branch 'master' of https://github.com/getsentry/sentry-javascript into onur/public-api-tests-capture-message

Author: onurtemizkan

packages/browser/src/helpers.ts

@@ -6,6 +6,7 @@ import {
   addNonEnumerableProperty,
   getGlobalObject,
   getOriginalFunction,
+  isDebugBuild,
   logger,
   markFunctionWrapped,
 } from '@sentry/utils';
@@ -191,12 +192,16 @@ export function injectReportDialog(options: ReportDialogOptions = {}): void {
   }
 
   if (!options.eventId) {
-    logger.error(`Missing eventId option in showReportDialog call`);
+    if (isDebugBuild()) {
+      logger.error(`Missing eventId option in showReportDialog call`);
+    }
     return;
   }
 
   if (!options.dsn) {
-    logger.error(`Missing dsn option in showReportDialog call`);
+    if (isDebugBuild()) {
+      logger.error(`Missing dsn option in showReportDialog call`);
+    }
     return;
   }
 

packages/browser/src/integrations/globalhandlers.ts

@@ -5,6 +5,7 @@ import {
   addExceptionMechanism,
   addInstrumentationHandler,
   getLocationHref,
+  isDebugBuild,
   isErrorEvent,
   isPrimitive,
   isString,
@@ -239,7 +240,9 @@ function _enhanceEventWithInitialFrame(event: Event, url: any, line: any, column
 }
 
 function globalHandlerLog(type: string): void {
-  logger.log(`Global Handler attached: ${type}`);
+  if (isDebugBuild()) {
+    logger.log(`Global Handler attached: ${type}`);
+  }
 }
 
 function addMechanismAndCapture(hub: Hub, error: EventHint['originalException'], event: Event, type: string): void {

packages/browser/src/sdk.ts

@@ -1,5 +1,6 @@
 import { getCurrentHub, initAndBind, Integrations as CoreIntegrations } from '@sentry/core';
-import { addInstrumentationHandler, getGlobalObject, logger, resolvedSyncPromise } from '@sentry/utils';
+import { Hub } from '@sentry/types';
+import { addInstrumentationHandler, getGlobalObject, isDebugBuild, logger, resolvedSyncPromise } from '@sentry/utils';
 
 import { BrowserOptions } from './backend';
 import { BrowserClient } from './client';
@@ -161,7 +162,9 @@ export function flush(timeout?: number): PromiseLike<boolean> {
   if (client) {
     return client.flush(timeout);
   }
-  logger.warn('Cannot flush events. No client defined.');
+  if (isDebugBuild()) {
+    logger.warn('Cannot flush events. No client defined.');
+  }
   return resolvedSyncPromise(false);
 }
 
@@ -178,7 +181,9 @@ export function close(timeout?: number): PromiseLike<boolean> {
   if (client) {
     return client.close(timeout);
   }
-  logger.warn('Cannot flush events and disable SDK. No client defined.');
+  if (isDebugBuild()) {
+    logger.warn('Cannot flush events and disable SDK. No client defined.');
+  }
   return resolvedSyncPromise(false);
 }
 
@@ -194,6 +199,11 @@ export function wrap(fn: (...args: any) => any): any {
   return internalWrap(fn)();
 }
 
+function startSessionOnHub(hub: Hub): void {
+  hub.startSession({ ignoreDuration: true });
+  hub.captureSession();
+}
+
 /**
  * Enable automatic Session Tracking for the initial page load.
  */
@@ -202,7 +212,9 @@ function startSessionTracking(): void {
   const document = window.document;
 
   if (typeof document === 'undefined') {
-    logger.warn('Session tracking in non-browser environment with @sentry/browser is not supported.');
+    if (isDebugBuild()) {
+      logger.warn('Session tracking in non-browser environment with @sentry/browser is not supported.');
+    }
     return;
   }
 
@@ -214,24 +226,21 @@ function startSessionTracking(): void {
   // https://github.com/getsentry/sentry-javascript/issues/3207 and
   // https://github.com/getsentry/sentry-javascript/issues/3234 and
   // https://github.com/getsentry/sentry-javascript/issues/3278.
-  if (typeof hub.startSession !== 'function' || typeof hub.captureSession !== 'function') {
+  if (!hub.captureSession) {
     return;
   }
 
   // The session duration for browser sessions does not track a meaningful
   // concept that can be used as a metric.
   // Automatically captured sessions are akin to page views, and thus we
   // discard their duration.
-  hub.startSession({ ignoreDuration: true });
-  hub.captureSession();
+  startSessionOnHub(hub);
 
   // We want to create a session for every navigation as well
   addInstrumentationHandler('history', ({ from, to }) => {
     // Don't create an additional session for the initial route or if the location did not change
-    if (from === undefined || from === to) {
-      return;
+    if (!(from === undefined || from === to)) {
+      startSessionOnHub(getCurrentHub());
     }
-    hub.startSession({ ignoreDuration: true });
-    hub.captureSession();
   });
 }

packages/browser/src/transports/base.ts

@@ -1,26 +1,31 @@
 import {
   APIDetails,
+  eventToSentryRequest,
   getEnvelopeEndpointWithUrlEncodedAuth,
   getStoreEndpointWithUrlEncodedAuth,
   initAPIDetails,
+  sessionToSentryRequest,
 } from '@sentry/core';
 import {
   Event,
   Outcome,
   Response as SentryResponse,
+  SentryRequest,
   SentryRequestType,
+  Session,
   Transport,
   TransportOptions,
 } from '@sentry/types';
 import {
   dateTimestampInSeconds,
+  dsnToString,
   eventStatusFromHttpCode,
   getGlobalObject,
+  isDebugBuild,
   logger,
   makePromiseBuffer,
   parseRetryAfterHeader,
   PromiseBuffer,
-  SentryError,
 } from '@sentry/utils';
 
 import { sendReport } from './utils';
@@ -67,8 +72,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);
   }
 
   /**
@@ -116,7 +128,7 @@ export abstract class BaseTransport implements Transport {
 
     const url = getEnvelopeEndpointWithUrlEncodedAuth(this._api.dsn, this._api.tunnel);
     // Envelope header is required to be at least an empty object
-    const envelopeHeader = JSON.stringify({ ...(this._api.tunnel && { dsn: this._api.dsn.toString() }) });
+    const envelopeHeader = JSON.stringify({ ...(this._api.tunnel && { dsn: dsnToString(this._api.dsn) }) });
     const itemHeaders = JSON.stringify({
       type: 'client_report',
     });
@@ -162,8 +174,9 @@ export abstract class BaseTransport implements Transport {
      * https://developer.mozilla.org/en-US/docs/Web/API/Headers/get
      */
     const limited = this._handleRateLimit(headers);
-    if (limited)
+    if (limited && isDebugBuild()) {
       logger.warn(`Too many ${requestType} requests, backing off until: ${this._disabledUntil(requestType)}`);
+    }
 
     if (status === 'success') {
       resolve({ status });
@@ -222,4 +235,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/utils.ts

@@ -1,4 +1,4 @@
-import { forget, getGlobalObject, isNativeFetch, logger, supportsFetch } from '@sentry/utils';
+import { forget, getGlobalObject, isDebugBuild, isNativeFetch, logger, supportsFetch } from '@sentry/utils';
 
 const global = getGlobalObject<Window>();
 let cachedFetchImpl: FetchImpl;
@@ -69,7 +69,9 @@ export function getNativeFetchImplementation(): FetchImpl {
       }
       document.head.removeChild(sandbox);
     } catch (e) {
-      logger.warn('Could not create sandbox iframe for pure fetch check, bailing to window.fetch: ', e);
+      if (isDebugBuild()) {
+        logger.warn('Could not create sandbox iframe for pure fetch check, bailing to window.fetch: ', e);
+      }
     }
   }
 

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();
     }
   });