fix(replay): Streamline logger usage (#6305)

Author: mydea

packages/replay/jest.config.ts

@@ -13,5 +13,11 @@ export default async (): Promise<Config.InitialOptions> => {
     setupFilesAfterEnv: ['./jest.setup.ts'],
     testEnvironment: 'jsdom',
     testMatch: ['<rootDir>/test/**/*(*.)@(spec|test).ts'],
+    globals: {
+      'ts-jest': {
+        tsconfig: '<rootDir>/tsconfig.json',
+      },
+      __DEBUG_BUILD__: true,
+    },
   };
 };

packages/replay/src/eventBuffer.ts

@@ -2,9 +2,9 @@
 // TODO: figure out member access types and remove the line above
 
 import { captureException } from '@sentry/core';
+import { logger } from '@sentry/utils';
 
 import { RecordingEvent, WorkerRequest, WorkerResponse } from './types';
-import { logger } from './util/logger';
 import workerString from './worker/worker.js';
 
 interface CreateEventBufferParams {
@@ -17,7 +17,7 @@ export function createEventBuffer({ useCompression }: CreateEventBufferParams):
     const workerUrl = URL.createObjectURL(workerBlob);
 
     try {
-      logger.log('Using compression worker');
+      __DEBUG_BUILD__ && logger.log('[Replay] Using compression worker');
       const worker = new Worker(workerUrl);
       if (worker) {
         return new EventBufferCompressionWorker(worker);
@@ -27,10 +27,10 @@ export function createEventBuffer({ useCompression }: CreateEventBufferParams):
     } catch {
       // catch and ignore, fallback to simple event buffer
     }
-    logger.log('Falling back to simple event buffer');
+    __DEBUG_BUILD__ && logger.log('[Replay] Falling back to simple event buffer');
   }
 
-  logger.log('Using simple buffer');
+  __DEBUG_BUILD__ && logger.log('[Replay] Using simple buffer');
   return new EventBufferArray();
 }
 
@@ -116,7 +116,7 @@ export class EventBufferCompressionWorker implements IEventBuffer {
 
         if (!data.success) {
           // TODO: Do some error handling, not sure what
-          logger.error(data.response);
+          __DEBUG_BUILD__ && logger.error('[Replay]', data.response);
 
           reject(new Error('Error in compression worker'));
           return;
@@ -142,11 +142,11 @@ export class EventBufferCompressionWorker implements IEventBuffer {
 
   init(): void {
     this.postMessage({ id: this.id, method: 'init', args: [] });
-    logger.log('Initialized compression worker');
+    __DEBUG_BUILD__ && logger.log('[Replay] Initialized compression worker');
   }
 
   destroy(): void {
-    logger.log('Destroying compression worker');
+    __DEBUG_BUILD__ && logger.log('[Replay] Destroying compression worker');
     this.worker?.terminate();
     this.worker = null;
   }

packages/replay/src/flags.ts

@@ -1,7 +1,7 @@
 /* eslint-disable max-lines */ // TODO: We might want to split this file up
 import { addGlobalEventProcessor, getCurrentHub, Scope, setContext } from '@sentry/core';
 import { Breadcrumb, Client, Event, Integration } from '@sentry/types';
-import { addInstrumentationHandler, createEnvelope } from '@sentry/utils';
+import { addInstrumentationHandler, createEnvelope, logger } from '@sentry/utils';
 import debounce from 'lodash.debounce';
 import { PerformanceObserverEntryList } from 'perf_hooks';
 import { EventType, record } from 'rrweb';
@@ -40,7 +40,6 @@ import { createPayload } from './util/createPayload';
 import { dedupePerformanceEntries } from './util/dedupePerformanceEntries';
 import { isExpired } from './util/isExpired';
 import { isSessionExpired } from './util/isSessionExpired';
-import { logger } from './util/logger';
 
 /**
  * Returns true to return control to calling function, otherwise continue with normal batching
@@ -300,7 +299,7 @@ export class Replay implements Integration {
         emit: this.handleRecordingEmit,
       });
     } catch (err) {
-      logger.error(err);
+      __DEBUG_BUILD__ && logger.error('[Replay]', err);
       captureInternalException(err);
     }
   }
@@ -315,14 +314,14 @@ export class Replay implements Integration {
     }
 
     try {
-      logger.log('Stopping Replays');
+      __DEBUG_BUILD__ && logger.log('[Replay] Stopping Replays');
       this.isEnabled = false;
       this.removeListeners();
       this.stopRecording?.();
       this.eventBuffer?.destroy();
       this.eventBuffer = null;
     } catch (err) {
-      logger.error(err);
+      __DEBUG_BUILD__ && logger.error('[Replay]', err);
       captureInternalException(err);
     }
   }
@@ -340,7 +339,7 @@ export class Replay implements Integration {
         this.stopRecording = undefined;
       }
     } catch (err) {
-      logger.error(err);
+      __DEBUG_BUILD__ && logger.error('[Replay]', err);
       captureInternalException(err);
     }
   }
@@ -361,7 +360,7 @@ export class Replay implements Integration {
       deleteSession();
       this.session = undefined;
     } catch (err) {
-      logger.error(err);
+      __DEBUG_BUILD__ && logger.error('[Replay]', err);
       captureInternalException(err);
     }
   }
@@ -437,7 +436,7 @@ export class Replay implements Integration {
         this.hasInitializedCoreListeners = true;
       }
     } catch (err) {
-      logger.error(err);
+      __DEBUG_BUILD__ && logger.error('[Replay]', err);
       captureInternalException(err);
     }
 
@@ -487,7 +486,7 @@ export class Replay implements Integration {
         this.performanceObserver = null;
       }
     } catch (err) {
-      logger.error(err);
+      __DEBUG_BUILD__ && logger.error('[Replay]', err);
       captureInternalException(err);
     }
   }
@@ -599,7 +598,7 @@ export class Replay implements Integration {
   ) => {
     // If this is false, it means session is expired, create and a new session and wait for checkout
     if (!this.checkAndHandleExpiredSession()) {
-      logger.error(new Error('Received replay event after session expired.'));
+      __DEBUG_BUILD__ && logger.error('[Replay] Received replay event after session expired.');
 
       return;
     }
@@ -827,7 +826,7 @@ export class Replay implements Integration {
       // If the user has come back to the page within VISIBILITY_CHANGE_TIMEOUT
       // ms, we will re-use the existing session, otherwise create a new
       // session
-      logger.log('Document has become active, but session has expired');
+      __DEBUG_BUILD__ && logger.log('[Replay] Document has become active, but session has expired');
       return;
     }
 
@@ -841,7 +840,7 @@ export class Replay implements Integration {
    * create a new Replay event.
    */
   triggerFullSnapshot(): void {
-    logger.log('Taking full rrweb snapshot');
+    __DEBUG_BUILD__ && logger.log('[Replay] Taking full rrweb snapshot');
     record.takeFullSnapshot(true);
   }
 
@@ -1131,12 +1130,12 @@ export class Replay implements Integration {
     }
 
     if (!this.checkAndHandleExpiredSession()) {
-      logger.error(new Error('Attempting to finish replay event after session expired.'));
+      __DEBUG_BUILD__ && logger.error('[Replay] Attempting to finish replay event after session expired.');
       return;
     }
 
     if (!this.session?.id) {
-      console.error(new Error('[Sentry]: No transaction, no replay'));
+      console.error('[Replay]: No transaction, no replay');
       return;
     }
 

packages/replay/src/index.ts

@@ -1,5 +1,6 @@
+import { logger } from '@sentry/utils';
+
 import { SessionOptions } from '../types';
-import { logger } from '../util/logger';
 import { saveSession } from './saveSession';
 import { Session } from './Session';
 
@@ -15,7 +16,7 @@ export function createSession({ sessionSampleRate, errorSampleRate, stickySessio
     sessionSampleRate,
   });
 
-  logger.log(`Creating new session: ${session.id}`);
+  __DEBUG_BUILD__ && logger.log(`[Replay] Creating new session: ${session.id}`);
 
   if (stickySession) {
     saveSession(session);

packages/replay/src/session/createSession.ts

@@ -1,6 +1,7 @@
+import { logger } from '@sentry/utils';
+
 import { SessionOptions } from '../types';
 import { isSessionExpired } from '../util/isSessionExpired';
-import { logger } from '../util/logger';
 import { createSession } from './createSession';
 import { fetchSession } from './fetchSession';
 import { Session } from './Session';
@@ -39,7 +40,7 @@ export function getSession({
     if (!isExpired) {
       return { type: 'saved', session };
     } else {
-      logger.log('Session has expired');
+      __DEBUG_BUILD__ && logger.log('[Replay] Session has expired');
     }
     // Otherwise continue to create a new session
   }