Create consoleSandbox util and make logger use it

Author: kamilogorek

packages/browser/src/backend.ts

@@ -1,6 +1,7 @@
-import { BaseBackend, logger, Options, SentryError } from '@sentry/core';
+import { BaseBackend, Options, SentryError } from '@sentry/core';
 import { SentryEvent, SentryEventHint, SentryResponse, Severity, Status } from '@sentry/types';
 import { isDOMError, isDOMException, isError, isErrorEvent, isPlainObject } from '@sentry/utils/is';
+import { logger } from '@sentry/utils/logger';
 import { supportsBeacon, supportsFetch } from '@sentry/utils/supports';
 import { eventFromPlainObject, eventFromStacktrace, prepareFramesForEvent } from './parsers';
 import { computeStackTrace } from './tracekit';

packages/browser/src/integrations/breadcrumbs.ts

@@ -1,6 +1,7 @@
-import { API, getCurrentHub, logger } from '@sentry/core';
+import { API, getCurrentHub } from '@sentry/core';
 import { Breadcrumb, Integration, SentryBreadcrumbHint, Severity } from '@sentry/types';
 import { isFunction, isString } from '@sentry/utils/is';
+import { logger } from '@sentry/utils/logger';
 import { getEventDescription, getGlobalObject, parseUrl } from '@sentry/utils/misc';
 import { deserialize, fill } from '@sentry/utils/object';
 import { includes, safeJoin } from '@sentry/utils/string';

packages/browser/src/integrations/globalhandlers.ts

@@ -1,5 +1,6 @@
-import { getCurrentHub, logger } from '@sentry/core';
+import { getCurrentHub } from '@sentry/core';
 import { Integration, SentryEvent } from '@sentry/types';
+import { logger } from '@sentry/utils/logger';
 import { eventFromStacktrace } from '../parsers';
 import {
   installGlobalHandler,

packages/core/src/basebackend.ts

@@ -1,8 +1,8 @@
 import { Scope } from '@sentry/hub';
 import { Breadcrumb, SentryEvent, SentryEventHint, SentryResponse, Severity, Transport } from '@sentry/types';
+import { logger } from '@sentry/utils/logger';
 import { SentryError } from './error';
 import { Backend, Options } from './interfaces';
-import { logger } from './logger';
 import { RequestBuffer } from './requestbuffer';
 
 /** A class object that can instanciate Backend objects. */

packages/core/src/baseclient.ts

@@ -7,18 +7,17 @@ import {
   SentryEvent,
   SentryEventHint,
   SentryResponse,
-  SentryWrappedFunction,
   Severity,
   Status,
 } from '@sentry/types';
 import { forget } from '@sentry/utils/async';
-import { getGlobalObject, uuid4 } from '@sentry/utils/misc';
+import { logger } from '@sentry/utils/logger';
+import { consoleSandbox, uuid4 } from '@sentry/utils/misc';
 import { truncate } from '@sentry/utils/string';
 import { BackendClass } from './basebackend';
 import { Dsn } from './dsn';
 import { IntegrationIndex, setupIntegrations } from './integrations';
 import { Backend, Client, Options } from './interfaces';
-import { logger } from './logger';
 
 /**
  * Default maximum number of breadcrumbs added to an event. Can be overwritten
@@ -37,39 +36,6 @@ const MAX_BREADCRUMBS = 100;
  */
 const MAX_URL_LENGTH = 250;
 
-/** JSDoc */
-interface ExtensibleConsole extends Console {
-  [key: string]: any;
-}
-/** JSDoc */
-function beforeBreadcrumbConsoleLoopGuard(callback: () => Breadcrumb | null): Breadcrumb | null {
-  const global = getGlobalObject() as Window;
-  const levels = ['debug', 'info', 'warn', 'error', 'log'];
-  if (!('console' in global)) {
-    return callback();
-  }
-  const originalConsole = global.console as ExtensibleConsole;
-  const wrappedLevels: { [key: string]: any } = {};
-
-  // Restore all wrapped console methods
-  levels.forEach(level => {
-    if (level in global.console && (originalConsole[level] as SentryWrappedFunction).__sentry__) {
-      wrappedLevels[level] = (originalConsole[level] as SentryWrappedFunction).__sentry_wrapped__;
-      originalConsole[level] = (originalConsole[level] as SentryWrappedFunction).__sentry_original__;
-    }
-  });
-
-  // Perform callback manipulations
-  const result = callback();
-
-  // Revert restoration to wrapped state
-  Object.keys(wrappedLevels).forEach(level => {
-    originalConsole[level] = wrappedLevels[level];
-  });
-
-  return result;
-}
-
 /**
  * Base implementation for all JavaScript SDK clients.
  *
@@ -228,7 +194,7 @@ export abstract class BaseClient<B extends Backend, O extends Options> implement
     const timestamp = new Date().getTime() / 1000;
     const mergedBreadcrumb = { timestamp, ...breadcrumb };
     const finalBreadcrumb = beforeBreadcrumb
-      ? beforeBreadcrumbConsoleLoopGuard(() => beforeBreadcrumb(mergedBreadcrumb, hint))
+      ? (consoleSandbox(() => beforeBreadcrumb(mergedBreadcrumb, hint)) as Breadcrumb | null)
       : mergedBreadcrumb;
 
     if (finalBreadcrumb === null) {
@@ -431,6 +397,11 @@ export abstract class BaseClient<B extends Backend, O extends Options> implement
    * @inheritDoc
    */
   public getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null {
-    return (this.integrations[integration.id] as T) || null;
+    try {
+      return (this.integrations[integration.id] as T) || null;
+    } catch (_oO) {
+      logger.warn(`Cannot retrieve integration ${integration.id} from the current Client`);
+      return null;
+    }
   }
 }

packages/core/src/index.ts

@@ -1,4 +1,3 @@
-export { logger } from './logger';
 export {
   addBreadcrumb,
   captureException,

packages/core/src/integrations/inboundfilters.ts

@@ -1,9 +1,9 @@
 import { addGlobalEventProcessor, getCurrentHub } from '@sentry/hub';
 import { Integration, SentryEvent } from '@sentry/types';
 import { isRegExp } from '@sentry/utils/is';
+import { logger } from '@sentry/utils/logger';
 import { getEventDescription } from '@sentry/utils/misc';
 import { includes } from '@sentry/utils/string';
-import { logger } from '../logger';
 
 // "Script error." is hard coded into browsers for errors that it can't read.
 // this is the result of a script being pulled in from an external domain and CORS.

packages/core/src/integrations/index.ts

@@ -1,7 +1,7 @@
 // tslint:disable:deprecation
 import { Integration } from '@sentry/types';
+import { logger } from '@sentry/utils/logger';
 import { Options } from '../interfaces';
-import { logger } from '../logger';
 
 export { Dedupe } from './dedupe';
 export { FunctionToString } from './functiontostring';

packages/core/src/integrations/sdkinformation.ts

@@ -1,5 +1,5 @@
 import { Integration } from '@sentry/types';
-import { logger } from '../logger';
+import { logger } from '@sentry/utils/logger';
 
 /**
  * @deprecated

packages/core/src/logger.ts

@@ -1,4 +1,4 @@
-import { getGlobalObject } from '@sentry/utils/misc';
+import { consoleSandbox, getGlobalObject } from '@sentry/utils/misc';
 
 // TODO: Implement different loggers for different environments
 const global = getGlobalObject() as Window;
@@ -28,21 +28,27 @@ class Logger {
     if (this.disabled) {
       return;
     }
-    this.console.log(`Sentry Logger [Log]: ${message}`); // tslint:disable-line:no-console
+    consoleSandbox(() => {
+      this.console.log(`Sentry Logger [Log]: ${message}`); // tslint:disable-line:no-console
+    });
   }
   /** JSDoc */
   public warn(message: any): void {
     if (this.disabled) {
       return;
     }
-    this.console.warn(`Sentry Logger [Warn]: ${message}`); // tslint:disable-line:no-console
+    consoleSandbox(() => {
+      this.console.warn(`Sentry Logger [Warn]: ${message}`); // tslint:disable-line:no-console
+    });
   }
   /** JSDoc */
   public error(message: any): void {
     if (this.disabled) {
       return;
     }
-    this.console.error(`Sentry Logger [Error]: ${message}`); // tslint:disable-line:no-console
+    consoleSandbox(() => {
+      this.console.error(`Sentry Logger [Error]: ${message}`); // tslint:disable-line:no-console
+    });
   }
 }