wip

Author: silesky

packages/signals/signals/src/core/emitter/index.ts

@@ -10,7 +10,7 @@ export class SignalEmitter implements EmitSignal {
   private emitter = new Emitter<{ add: [Signal] }>()
 
   emit(signal: Signal) {
-    logger.debug('new signal emitted', signal)
+    logger.debug('New signal:', signal.type, signal.data)
     this.emitter.emit('add', signal)
   }
 

packages/signals/signals/src/core/signals/settings.ts

@@ -130,12 +130,12 @@ export class SignalsDebugSettings {
     }
   }
 
-  setAllDebugging(boolean: boolean) {
+  setAllDebugging = (boolean: boolean) => {
     this.setDebugKey(SignalsDebugSettings.redactionKey, boolean)
     this.setDebugKey(SignalsDebugSettings.ingestionKey, boolean)
   }
 
-  private setDebugKey(key: string, enable: boolean) {
+  private setDebugKey = (key: string, enable: boolean): void => {
     try {
       if (enable) {
         window[this.storageType].setItem(key, 'true')
@@ -148,7 +148,7 @@ export class SignalsDebugSettings {
     }
   }
 
-  private getDebugKey(key: string): boolean {
+  private getDebugKey = (key: string): boolean => {
     try {
       const isEnabled = Boolean(window[this.storageType].getItem(key))
       if (isEnabled) {
@@ -161,11 +161,11 @@ export class SignalsDebugSettings {
     return false
   }
 
-  getDisableSignalsRedaction(): boolean {
+  getDisableSignalsRedaction = (): boolean => {
     return this.getDebugKey(SignalsDebugSettings.redactionKey)
   }
 
-  getEnableSignalsIngestion(): boolean {
+  getEnableSignalsIngestion = (): boolean => {
     return this.getDebugKey(SignalsDebugSettings.ingestionKey)
   }
 }

packages/signals/signals/src/core/signals/signals.ts

@@ -129,17 +129,18 @@ export class Signals implements ISignals {
     void this.buffer.clear()
   }
 
-  debug({ logSignalsOnly = false } = {}): void {
+  /**
+   * Disable redaction and enable ingestion of signals.
+   */
+  debug(): void {
     this.globalSettings.signalsDebug.setAllDebugging(true)
-    if (logSignalsOnly) {
-      this.signalEmitter.subscribe((signal) => {
-        console.log('[signals debug]', signal.type, signal.data, {
-          buffer: this.buffer,
-        })
-      })
-    } else {
-      logger.enableDebugLogging()
-    }
+  }
+
+  /**
+   * Log signals to the console.
+   */
+  enableDebugLogging(): void {
+    this.enableDebugLogging()
   }
 
   /**

packages/signals/signals/src/lib/logger/index.ts

@@ -1,46 +1,47 @@
 import { parseDebugLoggingQueryString } from '../../core/debug-mode'
 
 class Logger {
-  private static loggingKey = 'segment_signals_debug_logging_enabled'
+  private storageType = 'sessionStorage' as const
+  private static loggingKey = 'segment_signals_debug_logging'
+  public signalsOnly = false
   constructor() {
     const val = parseDebugLoggingQueryString()
     if (typeof val === 'boolean') {
       this.setDebugKey(Logger.loggingKey, val)
     }
   }
 
-  private debugLoggingEnabled(): boolean {
+  private debugLoggingEnabled = (): boolean => {
     try {
       const isEnabled = Boolean(
-        window.sessionStorage.getItem(Logger.loggingKey)
+        globalThis[this.storageType].getItem(Logger.loggingKey)
       )
       if (isEnabled) {
         return true
       }
     } catch (e) {
-      logger.debug('Storage error', e)
+      console.warn('Storage error', e)
     }
     return false
   }
 
-  private setDebugKey(key: string, enable: boolean) {
+  private setDebugKey = (key: string, enable: boolean) => {
     try {
       if (enable) {
-        window.sessionStorage.setItem(key, 'true')
+        globalThis[this.storageType].setItem(key, 'true')
       } else {
-        logger.debug(`Removing debug key ${key} from storage`)
-        window.sessionStorage.removeItem(key)
+        globalThis[this.storageType].removeItem(key)
       }
     } catch (e) {
-      logger.debug('Storage error', e)
+      console.warn('Storage error', e)
     }
   }
 
-  enableDebugLogging(bool = true) {
+  enableDebugLogging = (bool = true) => {
     this.setDebugKey(Logger.loggingKey, bool)
   }
 
-  debug(...args: any[]): void {
+  debug = (...args: any[]): void => {
     if (this.debugLoggingEnabled()) {
       console.log('[signals debug]', ...args)
     }

packages/signals/signals/src/plugin/signals-plugin.ts

@@ -1,5 +1,5 @@
 import type { Plugin } from '@segment/analytics-next'
-import { Signals, SignalsDebugSettings } from '../core/signals'
+import { Signals } from '../core/signals'
 import { logger } from '../lib/logger'
 import { AnyAnalytics, SignalsPluginSettingsConfig } from '../types'
 import { Signal } from '@segment/analytics-signals-runtime'
@@ -86,7 +86,10 @@ export class SignalsPlugin implements Plugin, SignalsAugmentedFunctionality {
     return this
   }
 
-  debug(enable = true) {
-    this.signals.debug(enable)
+  /**
+   * Turn on debug logging for signals
+   */
+  debug() {
+    this.signals.debug()
   }
 }