wip

Author: silesky

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

@@ -17,20 +17,19 @@ export const parseDebugModeQueryString = (): boolean | undefined => {
 /**
  * This turns on advanced logging for signals!
  */
-export type LogLevelOptions = 'info' | 'debug' | 'off' | undefined
-export const parseSignalsLogLevel = (): LogLevelOptions => {
+export type LogLevelOptions = 'info' | 'debug' | 'off'
+export const parseSignalsLogLevel = (): LogLevelOptions | undefined => {
   const queryParams = new URLSearchParams(window.location.search)
 
   const val =
     queryParams.get('segment_signals_log_level') ||
     queryParams.get('seg_signals_log_level')
   if (val === 'info' || val === 'debug' || val === 'off') {
     return val
-  } else if (typeof val === undefined) {
-    return undefined
-  } else {
+  } else if (typeof val === 'string') {
     console.error(
       `Invalid signals_log_level: "${val}". Valid options are: info, debug, off`
     )
   }
+  return undefined
 }

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

@@ -5,7 +5,7 @@ import { SignalsIngestSettingsConfig } from '../client'
 import { SandboxSettingsConfig } from '../processor/sandbox'
 import { NetworkSettingsConfig } from '../signal-generators/network-gen'
 import { SignalsPluginSettingsConfig } from '../../types'
-import { DebugStorage } from '../../lib/storage/debug-storage'
+import { WebStorage } from '../../lib/storage/web-storage'
 
 export type SignalsSettingsConfig = Pick<
   SignalsPluginSettingsConfig,
@@ -114,21 +114,15 @@ export class SignalGlobalSettings {
 export class SignalsDebugSettings {
   private static redactionKey = 'segment_signals_debug_redaction_disabled'
   private static ingestionKey = 'segment_signals_debug_ingestion_enabled'
-  storage: DebugStorage
+  storage: WebStorage
 
   constructor(disableRedaction?: boolean, enableIngestion?: boolean) {
-    this.storage = new DebugStorage('sessionStorage')
+    this.storage = new WebStorage(window.sessionStorage)
     if (typeof disableRedaction === 'boolean') {
-      this.storage.setDebugKey(
-        SignalsDebugSettings.redactionKey,
-        disableRedaction
-      )
+      this.storage.setItem(SignalsDebugSettings.redactionKey, disableRedaction)
     }
     if (typeof enableIngestion === 'boolean') {
-      this.storage.setDebugKey(
-        SignalsDebugSettings.ingestionKey,
-        enableIngestion
-      )
+      this.storage.setItem(SignalsDebugSettings.ingestionKey, enableIngestion)
     }
 
     const debugModeInQs = parseDebugModeQueryString()
@@ -139,15 +133,15 @@ export class SignalsDebugSettings {
   }
 
   setAllDebugging = (boolean: boolean) => {
-    this.storage.setDebugKey(SignalsDebugSettings.redactionKey, boolean)
-    this.storage.setDebugKey(SignalsDebugSettings.ingestionKey, boolean)
+    this.storage.setItem(SignalsDebugSettings.redactionKey, boolean)
+    this.storage.setItem(SignalsDebugSettings.ingestionKey, boolean)
   }
 
   getDisableSignalsRedaction = (): boolean => {
-    return this.storage.getDebugKey(SignalsDebugSettings.redactionKey)
+    return this.storage.getItem(SignalsDebugSettings.redactionKey) ?? false
   }
 
   getEnableSignalsIngestion = (): boolean => {
-    return this.storage.getDebugKey(SignalsDebugSettings.ingestionKey)
+    return this.storage.getItem(SignalsDebugSettings.ingestionKey) ?? false
   }
 }

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

@@ -15,6 +15,7 @@ import { SignalEventProcessor } from '../processor/processor'
 import { Sandbox, SandboxSettings } from '../processor/sandbox'
 import { SignalGlobalSettings, SignalsSettingsConfig } from './settings'
 import { logger } from '../../lib/logger'
+import { LogLevelOptions } from '../debug-mode'
 
 interface ISignals {
   start(analytics: AnyAnalytics): Promise<void>
@@ -135,9 +136,9 @@ export class Signals implements ISignals {
   /**
    * Disable redaction, ingestion of signals, and other logging.
    */
-  debug(boolean = true): void {
+  debug(boolean = true, logLevel?: LogLevelOptions): void {
     this.globalSettings.signalsDebug.setAllDebugging(boolean)
-    logger.enableLogging('info')
+    logger.enableLogging(logLevel ?? 'info')
   }
 
   /**

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

@@ -1,14 +1,16 @@
 import {
+  LogLevelOptions,
   parseDebugModeQueryString,
   parseSignalsLogLevel,
 } from '../../core/debug-mode'
-import { DebugStorage } from '../storage/debug-storage'
+import { WebStorage } from '../storage/web-storage'
 
 class Logger {
-  private static infoLogging = 'segment_signals_log_level_info'
-  private static debugLogging = 'segment_signals_log_level_debug'
-
-  storage = new DebugStorage('sessionStorage')
+  private logLevelKey = 'segment_signals_log_level'
+  get logLevel(): LogLevelOptions {
+    return this.storage.getItem(this.logLevelKey) ?? 'off'
+  }
+  storage = new WebStorage(window.sessionStorage)
 
   constructor() {
     // if debug mode is in the query string, we want simple logging
@@ -24,42 +26,23 @@ class Logger {
     }
   }
 
-  private loggingEnabled = (): boolean => {
-    return this.storage.getDebugKey(Logger.infoLogging)
-  }
-
-  private debugLoggingEnabled = (): boolean => {
-    return this.storage.getDebugKey(Logger.debugLogging)
-  }
-
-  enableDebugLogging = (bool = true) => {
-    this.storage.setDebugKey(Logger.debugLogging, bool)
-  }
-
   // if debug level is enabled, info level is also enabled
-  enableLogging = (type: 'info' | 'debug') => {
-    if (type === 'info') {
-      this.storage.setDebugKey(Logger.infoLogging, true)
-      this.storage.setDebugKey(Logger.debugLogging, false)
-    } else if (type === 'debug') {
-      this.storage.setDebugKey(Logger.debugLogging, true)
-      this.storage.setDebugKey(Logger.infoLogging, true)
-    }
+  enableLogging = (type: LogLevelOptions) => {
+    this.storage.setItem(this.logLevelKey, type)
   }
 
   disableLogging = () => {
-    this.storage.setDebugKey(Logger.infoLogging, false)
-    this.storage.setDebugKey(Logger.debugLogging, false)
+    this.storage.setItem(this.logLevelKey, 'off')
   }
 
   info = (...args: any[]): void => {
-    if (this.loggingEnabled() || this.debugLoggingEnabled()) {
+    if (this.logLevel === 'info' || this.logLevel === 'debug') {
       console.log('[signals log]', ...args)
     }
   }
 
   debug = (...args: any[]): void => {
-    if (this.debugLoggingEnabled()) {
+    if (this.logLevel === 'debug') {
       console.log('[signals debug]', ...args)
     }
   }

packages/signals/signals/src/lib/storage/debug-storage.ts

@@ -0,0 +1,23 @@
+export class WebStorage {
+  private storage: Storage
+  constructor(storage: Storage) {
+    this.storage = storage
+  }
+
+  public setItem = (key: string, value: string | boolean): void => {
+    try {
+      this.storage.setItem(key, value.toString())
+    } catch (e) {
+      console.warn('Storage error', e)
+    }
+  }
+
+  public getItem = <T>(key: string): T | undefined => {
+    try {
+      return (this.storage.getItem(key) as T) ?? undefined
+    } catch (e) {
+      console.warn('Storage error', e)
+    }
+    return undefined
+  }
+}

packages/signals/signals/src/lib/storage/web-storage.ts

@@ -29,11 +29,8 @@ export class SignalsPlugin implements Plugin, SignalsAugmentedFunctionality {
   constructor(settings: SignalsPluginSettingsConfig = {}) {
     assertBrowserEnv()
 
-    // assign to window for debugging purposes
-    Object.assign(window, { SegmentSignalsPlugin: this })
-
     if (settings.enableDebugLogging) {
-      logger.enableDebugLogging()
+      logger.enableLogging('debug')
     }
 
     logger.debug(`SignalsPlugin v${version} initializing`, {
@@ -57,6 +54,9 @@ export class SignalsPlugin implements Plugin, SignalsAugmentedFunctionality {
       networkSignalsDisallowList: settings.networkSignalsDisallowList,
       signalStorage: settings.signalStorage,
     })
+
+    // assign to window for debugging purposes
+    Object.assign(window, { SegmentSignalsPlugin: this })
   }
 
   isLoaded() {
@@ -89,7 +89,7 @@ export class SignalsPlugin implements Plugin, SignalsAugmentedFunctionality {
   /**
    * Enable redaction and disable ingestion of signals. Also, logs signals to the console.
    */
-  debug(boolean = true): void {
-    this.signals.debug(boolean)
+  debug(...args: Parameters<typeof this.signals['debug']>): void {
+    this.signals.debug(...args)
   }
 }