refactor debug

Author: silesky

packages/signals/signals/src/core/debug-mode/index.ts

@@ -5,7 +5,21 @@
 export const parseDebugModeQueryString = (): boolean | undefined => {
   const queryParams = new URLSearchParams(window.location.search)
 
-  const val = queryParams.get('segment_signals_debug')
+  const val =
+    queryParams.get('segment_signals_debug') ||
+    queryParams.get('seg_signals_debug')
+  if (val === 'true' || val === 'false') {
+    return val === 'true'
+  }
+  return undefined
+}
+
+export const parseDebugLoggingQueryString = (): boolean | undefined => {
+  const queryParams = new URLSearchParams(window.location.search)
+
+  const val =
+    queryParams.get('segment_signals_logging') ||
+    queryParams.get('seg_signals_logging')
   if (val === 'true' || val === 'false') {
     return val === 'true'
   }

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

@@ -33,9 +33,9 @@ export class SignalGlobalSettings {
   signalBuffer: SignalBufferSettingsConfig
   ingestClient: SignalsIngestSettingsConfig
   network: NetworkSettingsConfig
+  signalsDebug: SignalsDebugSettings
 
   private sampleSuccess = false
-  private signalsDebug = new SignalsDebugSettings()
 
   constructor(settings: SignalsSettingsConfig) {
     if (settings.maxBufferSize && settings.signalStorage) {
@@ -110,9 +110,11 @@ export class SignalGlobalSettings {
   }
 }
 
-class SignalsDebugSettings {
+export class SignalsDebugSettings {
+  private storageType = 'sessionStorage' as const
   private static redactionKey = 'segment_signals_debug_redaction_disabled'
   private static ingestionKey = 'segment_signals_debug_ingestion_enabled'
+
   constructor(disableRedaction?: boolean, enableIngestion?: boolean) {
     if (typeof disableRedaction === 'boolean') {
       this.setDebugKey(SignalsDebugSettings.redactionKey, disableRedaction)
@@ -121,21 +123,22 @@ class SignalsDebugSettings {
       this.setDebugKey(SignalsDebugSettings.ingestionKey, enableIngestion)
     }
 
-    // setting ?segment_signals_debug=true will disable redaction, enable ingestion, and set keys in local storage
-    // this setting will persist across page loads (even if there is no query string)
-    // in order to clear the setting, user must set ?segment_signals_debug=false
     const debugModeInQs = parseDebugModeQueryString()
     logger.debug('debugMode is set to true via query string')
     if (typeof debugModeInQs === 'boolean') {
-      this.setDebugKey(SignalsDebugSettings.redactionKey, debugModeInQs)
-      this.setDebugKey(SignalsDebugSettings.ingestionKey, debugModeInQs)
+      this.setAllDebugging(debugModeInQs)
     }
   }
 
-  setDebugKey(key: string, enable: boolean) {
+  setAllDebugging(boolean: boolean) {
+    this.setDebugKey(SignalsDebugSettings.redactionKey, boolean)
+    this.setDebugKey(SignalsDebugSettings.ingestionKey, boolean)
+  }
+
+  private setDebugKey(key: string, enable: boolean) {
     try {
       if (enable) {
-        window.sessionStorage.setItem(key, 'true')
+        window[this.storageType].setItem(key, 'true')
       } else {
         logger.debug(`Removing debug key ${key} from storage`)
         window.sessionStorage.removeItem(key)
@@ -145,13 +148,11 @@ class SignalsDebugSettings {
     }
   }
 
-  getDisableSignalsRedaction() {
+  private getDebugKey(key: string): boolean {
     try {
-      const isEnabled = Boolean(
-        window.sessionStorage.getItem(SignalsDebugSettings.redactionKey)
-      )
+      const isEnabled = Boolean(window[this.storageType].getItem(key))
       if (isEnabled) {
-        logger.debug(`${SignalsDebugSettings.redactionKey}=true (app. storage)`)
+        logger.debug(`${key}=true (app. storage)`)
         return true
       }
     } catch (e) {
@@ -160,18 +161,11 @@ class SignalsDebugSettings {
     return false
   }
 
-  getEnableSignalsIngestion() {
-    try {
-      const isEnabled = Boolean(
-        window.sessionStorage.getItem(SignalsDebugSettings.ingestionKey)
-      )
-      if (isEnabled) {
-        logger.debug(`${SignalsDebugSettings.ingestionKey}=true (app. storage)`)
-        return true
-      }
-    } catch (e) {
-      logger.debug('Storage error', e)
-    }
-    return false
+  getDisableSignalsRedaction(): boolean {
+    return this.getDebugKey(SignalsDebugSettings.redactionKey)
+  }
+
+  getEnableSignalsIngestion(): boolean {
+    return this.getDebugKey(SignalsDebugSettings.ingestionKey)
   }
 }

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

@@ -129,6 +129,11 @@ export class Signals implements ISignals {
     void this.buffer.clear()
   }
 
+  debug() {
+    this.globalSettings.signalsDebug.setDebugMode(true)
+    logger.enableDebugLogging()
+  }
+
   /**
    * Emit custom signals.
    */

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

@@ -1,15 +1,47 @@
+import { parseDebugLoggingQueryString } from '../../core/debug-mode'
+
 class Logger {
-  globalKey = 'SEGMENT_SIGNALS_DEBUG'
-  get debugLoggingEnabled() {
-    return (window as any)[this.globalKey] === true
+  private static loggingKey = 'segment_signals_debug_logging_enabled'
+  constructor() {
+    const val = parseDebugLoggingQueryString()
+    if (typeof val === 'boolean') {
+      this.setDebugKey(Logger.loggingKey, val)
+    }
+  }
+
+  private debugLoggingEnabled(): boolean {
+    try {
+      const isEnabled = Boolean(
+        window.sessionStorage.getItem(Logger.loggingKey)
+      )
+      if (isEnabled) {
+        return true
+      }
+    } catch (e) {
+      logger.debug('Storage error', e)
+    }
+    return false
+  }
+
+  private setDebugKey(key: string, enable: boolean) {
+    try {
+      if (enable) {
+        window.sessionStorage.setItem(key, 'true')
+      } else {
+        logger.debug(`Removing debug key ${key} from storage`)
+        window.sessionStorage.removeItem(key)
+      }
+    } catch (e) {
+      logger.debug('Storage error', e)
+    }
   }
 
-  enableDebugLogging() {
-    ;(window as any)[this.globalKey] = true
+  enableDebugLogging(bool = true) {
+    this.setDebugKey(Logger.loggingKey, bool)
   }
 
   debug(...args: any[]): void {
-    if (this.debugLoggingEnabled) {
+    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 } from '../core/signals'
+import { Signals, SignalsDebugSettings } from '../core/signals'
 import { logger } from '../lib/logger'
 import { AnyAnalytics, SignalsPluginSettingsConfig } from '../types'
 import { Signal } from '@segment/analytics-signals-runtime'
@@ -26,12 +26,16 @@ export class SignalsPlugin implements Plugin, SignalsAugmentedFunctionality {
   readonly name = 'SignalsPlugin'
   readonly version = version
   public signals: Signals
-
   constructor(settings: SignalsPluginSettingsConfig = {}) {
     assertBrowserEnv()
+
+    // assign to window for debugging purposes
+    Object.assign(window, { SegmentSignalsPlugin: this })
+
     if (settings.enableDebugLogging) {
       logger.enableDebugLogging()
     }
+
     logger.debug('SignalsPlugin initializing', { settings })
 
     this.signals = new Signals({
@@ -79,4 +83,8 @@ export class SignalsPlugin implements Plugin, SignalsAugmentedFunctionality {
     this.signals.signalEmitter.emit(signal)
     return this
   }
+
+  debug(enable = true) {
+    this.signals.debug(enable)
+  }
 }