[v7] Make logger a property of client so it can be enabled/disabled independently

Author: kamilogorek

packages/angular/src/errorhandler.ts

@@ -43,8 +43,7 @@ class SentryErrorHandler implements AngularErrorHandler {
 
     // When in development mode, log the error to console for immediate feedback.
     if (this._options.logErrors) {
-      // eslint-disable-next-line no-console
-      console.error(extractedError);
+      console.error(extractedError); // eslint-disable-line no-console
     }
 
     // Optionally show user dialog to provide details on what happened.

packages/angular/src/tracing.ts

@@ -1,8 +1,8 @@
 import { AfterViewInit, Directive, Injectable, Input, OnInit } from '@angular/core';
 import { Event, NavigationEnd, NavigationStart, Router } from '@angular/router';
-import { getTransaction } from '@sentry/minimal';
+import { getCurrentClient, getTransaction } from '@sentry/minimal';
 import { Span, Transaction, TransactionContext } from '@sentry/types';
-import { logger, stripUrlQueryAndFragment, timestampWithMs } from '@sentry/utils';
+import { stripUrlQueryAndFragment, timestampWithMs } from '@sentry/utils';
 import { Observable } from 'rxjs';
 import { filter, tap } from 'rxjs/operators';
 
@@ -39,14 +39,15 @@ export class TraceService {
   public navStart$: Observable<Event> = this._router.events.pipe(
     filter(event => event instanceof NavigationStart),
     tap(event => {
+      const client = getCurrentClient();
       if (!instrumentationInitialized) {
-        logger.error('Angular integration has tracing enabled, but Tracing integration is not configured');
+        client?.logger.error('Angular integration has tracing enabled, but Tracing integration is not configured');
         return;
       }
 
       const navigationEvent = event as NavigationStart;
       const strippedUrl = stripUrlQueryAndFragment(navigationEvent.url);
-      let activeTransaction = getTransaction();
+      let activeTransaction = client?.getScope().getTransaction();
 
       if (!activeTransaction && stashedStartTransactionOnLocationChange) {
         activeTransaction = stashedStartTransaction({

packages/browser/src/sdk.ts

@@ -1,6 +1,6 @@
 import { ClientLike, Integration } from '@sentry/types';
 import { captureException, getCarrier, getCurrentClient } from '@sentry/minimal';
-import { addInstrumentationHandler, getGlobalObject, logger, supportsFetch } from '@sentry/utils';
+import { addInstrumentationHandler, getGlobalObject, supportsFetch } from '@sentry/utils';
 import { Dsn, getReportDialogEndpoint, ReportDialogOptions } from '@sentry/transport-base';
 import { InboundFilters } from '@sentry/integration-common-inboundfilters';
 import { UserAgent } from '@sentry/integration-browser-useragent';
@@ -99,17 +99,17 @@ export function showReportDialog(
   options.dsn = options.dsn ?? client.options.dsn;
 
   if (client.options.enabled === false) {
-    logger.error(`${errPrefix} disabled client`);
+    client.logger.error(`${errPrefix} disabled client`);
     return;
   }
 
   if (!options.eventId) {
-    logger.error(`${errPrefix} missing EventID`);
+    client.logger.error(`${errPrefix} missing EventID`);
     return;
   }
 
   if (!options.dsn) {
-    logger.error(`${errPrefix} missing DSN`);
+    client.logger.error(`${errPrefix} missing DSN`);
     return;
   }
 
@@ -161,12 +161,12 @@ export function wrap(fn: (...args: unknown[]) => unknown): unknown {
 /**
  * Enable automatic Session Tracking for the initial page load.
  */
-function startSessionTracking(_client: ClientLike): void {
+function startSessionTracking(client: ClientLike): void {
   const window = getGlobalObject<Window>();
   const document = window.document;
 
   if (typeof document === 'undefined') {
-    logger.warn('Session tracking in non-browser environment with @sentry/browser is not supported.');
+    client.logger.warn('Session tracking in non-browser environment with @sentry/browser is not supported.');
     return;
   }
 

packages/core/src/baseclient.ts

@@ -12,9 +12,9 @@ import {
 import {
   dateTimestampInSeconds,
   getEventDescription,
+  Logger,
   isPlainObject,
   isPrimitive,
-  logger,
   normalize,
   truncate,
   uuid4,
@@ -67,6 +67,9 @@ export abstract class BaseClient<O extends Options> implements ClientLike<O> {
   /** Options passed to the SDK. */
   public readonly options: O;
 
+  /** Logger used for debug mode */
+  public readonly logger = new Logger('Client');
+
   /** The client Dsn, if specified in options. Without this Dsn, the SDK will be disabled. */
   public readonly dsn?: Dsn;
 
@@ -88,10 +91,14 @@ export abstract class BaseClient<O extends Options> implements ClientLike<O> {
    * @param options Options for the client.
    */
   protected constructor(options: O) {
-    this.options = options;
+    this.options = options ?? {};
+
+    if (this.options.dsn) {
+      this.dsn = new Dsn(this.options.dsn);
+    }
 
-    if (options.dsn) {
-      this.dsn = new Dsn(options.dsn);
+    if (this.options.debug) {
+      this.logger.enabled = true;
     }
 
     this._transport = this._setupTransport();
@@ -155,7 +162,7 @@ export abstract class BaseClient<O extends Options> implements ClientLike<O> {
    */
   public captureSession(session: Session): void {
     if (!session.release) {
-      logger.warn('Discarded session because of missing release');
+      this.logger.warn('Discarded session because of missing release');
     } else {
       this._sendSession(session);
       // After sending, we set init false to inidcate it's not the first occurence
@@ -206,7 +213,7 @@ export abstract class BaseClient<O extends Options> implements ClientLike<O> {
     return integrations.reduce((integrationsIndex: Record<string, Integration>, integration) => {
       integrationsIndex[integration.name] = integration;
       integration.install(this);
-      logger.log(`Integration installed: ${integration.name}`);
+      this.logger.log(`Integration installed: ${integration.name}`);
       return integrationsIndex;
     }, {});
   }
@@ -217,7 +224,7 @@ export abstract class BaseClient<O extends Options> implements ClientLike<O> {
   // TODO: Do we need generic here?
   protected _sendRequest<T>(request: TransportRequest<T>): void {
     this._transport.sendRequest(request).then(null, reason => {
-      logger.error(`Failed sending request: ${reason}`);
+      this.logger.error(`Failed sending request: ${reason}`);
     });
   }
 
@@ -431,7 +438,7 @@ export abstract class BaseClient<O extends Options> implements ClientLike<O> {
   // eslint-disable-next-line complexity
   protected _processEvent(event: SentryEvent, captureContext: CaptureContext): SentryEvent | null {
     if (this.options.enabled === false) {
-      logger.error('SDK not enabled, will not send event.');
+      this.logger.error('SDK not enabled, will not send event.');
       return null;
     }
 
@@ -440,7 +447,7 @@ export abstract class BaseClient<O extends Options> implements ClientLike<O> {
     // 0.0 === 0% events are sent
     // Sampling for transaction happens somewhere else
     if (!isTransaction && typeof this.options.sampleRate === 'number' && Math.random() > this.options.sampleRate) {
-      logger.error(
+      this.logger.error(
         `Discarding event because it's not included in the random sample (sampling rate = ${this.options.sampleRate})`,
       );
       return null;
@@ -466,23 +473,23 @@ export abstract class BaseClient<O extends Options> implements ClientLike<O> {
 
       processedEvent = scope.applyToEvent(processedEvent, captureContext.hint);
       if (processedEvent === null) {
-        logger.error('A scope event processor returned null, will not send event.');
+        this.logger.error('A scope event processor returned null, will not send event.');
         return null;
       }
 
       for (const processor of this._eventProcessors) {
         if (typeof processor === 'function') {
           const nextEvent = processor(processedEvent, captureContext.hint);
           if (nextEvent === null) {
-            logger.error('A client event processor returned null, will not send event.');
+            this.logger.error('A client event processor returned null, will not send event.');
             return null;
           }
           processedEvent = nextEvent;
         }
       }
 
       if (processedEvent === null) {
-        logger.error('A scope event processor returned null, will not send event.');
+        this.logger.error('A scope event processor returned null, will not send event.');
         return null;
       }
 
@@ -499,12 +506,12 @@ export abstract class BaseClient<O extends Options> implements ClientLike<O> {
       processedEvent = this.options.beforeSend(processedEvent as SentryEvent, captureContext?.hint);
 
       if (!(isPlainObject(processedEvent) || processedEvent === null)) {
-        logger.error('`beforeSend` method has to return `null` or a valid event.');
+        this.logger.error('`beforeSend` method has to return `null` or a valid event.');
         return null;
       }
 
       if (processedEvent === null) {
-        logger.error('`beforeSend` returned `null`, will not send event.');
+        this.logger.error('`beforeSend` returned `null`, will not send event.');
         return null;
       }
 
@@ -525,7 +532,7 @@ export abstract class BaseClient<O extends Options> implements ClientLike<O> {
           originalException: e,
         },
       });
-      logger.error(
+      this.logger.error(
         `Event processing pipeline threw an error, original event will not be sent. Details have been sent as a new event.\nReason: ${e}`,
       );
       return null;

packages/integration-browser-globalhandlers/src/onerror.ts

@@ -7,7 +7,6 @@ import {
   isErrorEvent,
   isPrimitive,
   isString,
-  logger,
 } from '@sentry/utils';
 import { eventFromUnknownInput } from '@sentry/eventbuilder-browser';
 
@@ -45,7 +44,7 @@ export class OnError implements Integration {
       type: 'error',
     });
 
-    logger.log('Global Handler attached: onerror');
+    client.logger.log('Global Handler attached: onerror');
   }
 
   /**

packages/integration-browser-globalhandlers/src/onunhandledrejection.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 import { ClientLike, SentryEvent, Integration, Primitive, Severity } from '@sentry/types';
-import { addExceptionMechanism, addInstrumentationHandler, isPrimitive, logger } from '@sentry/utils';
+import { addExceptionMechanism, addInstrumentationHandler, isPrimitive } from '@sentry/utils';
 import { eventFromUnknownInput } from '@sentry/eventbuilder-browser';
 
 export class OnUnhandledRejection implements Integration {
@@ -60,7 +60,7 @@ export class OnUnhandledRejection implements Integration {
       type: 'unhandledrejection',
     });
 
-    logger.log('Global Handler attached: onunhandledrejection');
+    client.logger.log('Global Handler attached: onunhandledrejection');
   }
 
   /**

packages/integration-browser-offline/src/index.ts

@@ -1,6 +1,5 @@
 import { SentryEvent, ClientLike, Integration } from '@sentry/types';
-import { getGlobalObject, logger, normalize, uuid4 } from '@sentry/utils';
-
+import { getGlobalObject, normalize, uuid4 } from '@sentry/utils';
 import * as localForageType from 'localforage';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
@@ -16,8 +15,7 @@ export class Offline implements Integration {
   /**
    * the global instance
    */
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  public global: any;
+  public global = getGlobalObject<Window>();
 
   /**
    * maximum number of events to store while offline
@@ -35,8 +33,6 @@ export class Offline implements Integration {
    * @inheritDoc
    */
   public constructor(options: OfflineOptions = {}) {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    this.global = getGlobalObject<any>();
     this.maxStoredEvents = options.maxStoredEvents ?? 30; // set a reasonable default
     // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
     this.offlineEventStore = localForage.createInstance({
@@ -53,7 +49,7 @@ export class Offline implements Integration {
     if ('addEventListener' in this.global) {
       this.global.addEventListener('online', () => {
         this._sendEvents().catch(() => {
-          logger.warn('could not send cached events');
+          this._client.logger.warn('could not send cached events');
         });
       });
     }
@@ -64,7 +60,7 @@ export class Offline implements Integration {
         this._cacheEvent(event)
           .then((_event: SentryEvent): Promise<void> => this._enforceMaxEvents())
           .catch((_error): void => {
-            logger.warn('could not cache event while offline');
+            this._client.logger.warn('could not cache event while offline');
           });
 
         // return null on success or failure, because being offline will still result in an error
@@ -77,7 +73,7 @@ export class Offline implements Integration {
     // if online now, send any events stored in a previous offline session
     if ('navigator' in this.global && 'onLine' in this.global.navigator && this.global.navigator.onLine) {
       this._sendEvents().catch(() => {
-        logger.warn('could not send cached events');
+        this._client.logger.warn('could not send cached events');
       });
     }
   }
@@ -113,7 +109,7 @@ export class Offline implements Integration {
           ),
       )
       .catch((_error): void => {
-        logger.warn('could not enforce max events');
+        this._client.logger.warn('could not enforce max events');
       });
   }
 
@@ -141,7 +137,7 @@ export class Offline implements Integration {
         this._client.captureEvent(event);
 
         this._purgeEvent(cacheKey).catch((_error): void => {
-          logger.warn('could not purge event from cache');
+          this._client.logger.warn('could not purge event from cache');
         });
       },
     );

packages/integration-common-extraerrordata/src/index.ts

@@ -1,5 +1,5 @@
 import { SentryEvent, EventHint, ExtendedError, ClientLike, Integration } from '@sentry/types';
-import { isError, isPlainObject, logger, normalize } from '@sentry/utils';
+import { isError, isPlainObject, normalize } from '@sentry/utils';
 
 interface ExtraErrorDataOptions {
   depth?: number;
@@ -8,12 +8,15 @@ interface ExtraErrorDataOptions {
 export class ExtraErrorData implements Integration {
   public name = this.constructor.name;
 
+  private _client!: ClientLike;
+
   public constructor(private readonly _options: ExtraErrorDataOptions = { depth: 3 }) {}
 
   /**
    * @inheritDoc
    */
   public install(client: ClientLike): void {
+    this._client = client;
     client.addEventProcessor((event: SentryEvent, hint?: EventHint) => this.enhanceEventWithErrorData(event, hint));
   }
 
@@ -75,7 +78,7 @@ export class ExtraErrorData implements Integration {
         result = extraErrorInfo;
       }
     } catch (oO) {
-      logger.error('Unable to extract extra data from the Error object:', oO);
+      this._client.logger.error('Unable to extract extra data from the Error object:', oO);
     }
 
     return result;