refactor log levels

Author: silesky

.changeset/shiny-boats-warn.md

@@ -0,0 +1,5 @@
+---
+'@segment/analytics-signals': patch
+---
+
+Add signals logging for events

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

@@ -17,16 +17,20 @@ export const parseDebugModeQueryString = (): boolean | undefined => {
 /**
  * This turns on advanced logging for signals!
  */
-export const parseSignalsLoggingAdvancedQueryString = ():
-  | boolean
-  | undefined => {
+export type LogLevelOptions = 'info' | 'debug' | 'off' | undefined
+export const parseSignalsLogLevel = (): LogLevelOptions => {
   const queryParams = new URLSearchParams(window.location.search)
 
   const val =
-    queryParams.get('segment_signals_logging_advanced') ||
-    queryParams.get('seg_signals_logging_advanced')
-  if (val === 'true' || val === 'false') {
-    return val === 'true'
+    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 {
+    console.error(
+      `Invalid signals_log_level: "${val}". Valid options are: info, debug, off`
+    )
   }
-  return undefined
 }

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

@@ -6,21 +6,12 @@ export interface EmitSignal {
   emit: (signal: Signal) => void
 }
 
-interface SignalEmitterSettings {
-  shouldLogSignals: () => boolean
-}
-
 export class SignalEmitter implements EmitSignal {
   private emitter = new Emitter<{ add: [Signal] }>()
   private listeners = new Set<(signal: Signal) => void>()
-  private settings?: SignalEmitterSettings
-  constructor(settings?: SignalEmitterSettings) {
-    this.settings = settings
-  }
+
   emit(signal: Signal) {
-    if (this.settings?.shouldLogSignals()) {
-      logger.log('New signal:', signal.type, signal.data)
-    }
+    logger.info('New signal:', signal.type, signal.data)
     this.emitter.emit('add', signal)
   }
 

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

@@ -18,7 +18,8 @@ export class SignalEventProcessor {
       const name = methodName as MethodName
       const eventsCollection = analyticsMethodCalls[name]
       eventsCollection.forEach((args) => {
-        logger.debug(`analytics.${name}(...) called with args`, args)
+        logger.info('New signals-originated event:', name, { args })
+
         // @ts-ignore
         this.analytics[name](...args)
       })

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

@@ -114,7 +114,6 @@ export class SignalGlobalSettings {
 export class SignalsDebugSettings {
   private static redactionKey = 'segment_signals_debug_redaction_disabled'
   private static ingestionKey = 'segment_signals_debug_ingestion_enabled'
-  private static logSignals = 'segment_signals_log_signals_enabled'
   storage: DebugStorage
 
   constructor(disableRedaction?: boolean, enableIngestion?: boolean) {
@@ -142,7 +141,6 @@ export class SignalsDebugSettings {
   setAllDebugging = (boolean: boolean) => {
     this.storage.setDebugKey(SignalsDebugSettings.redactionKey, boolean)
     this.storage.setDebugKey(SignalsDebugSettings.ingestionKey, boolean)
-    this.storage.setDebugKey(SignalsDebugSettings.logSignals, boolean)
   }
 
   getDisableSignalsRedaction = (): boolean => {
@@ -152,8 +150,4 @@ export class SignalsDebugSettings {
   getEnableSignalsIngestion = (): boolean => {
     return this.storage.getDebugKey(SignalsDebugSettings.ingestionKey)
   }
-
-  getEnableLogSignals = (): boolean => {
-    return this.storage.getDebugKey(SignalsDebugSettings.logSignals)
-  }
 }

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

@@ -38,10 +38,7 @@ export class Signals implements ISignals {
   private globalSettings: SignalGlobalSettings
   constructor(settingsConfig: SignalsSettingsConfig = {}) {
     this.globalSettings = new SignalGlobalSettings(settingsConfig)
-    this.signalEmitter = new SignalEmitter({
-      shouldLogSignals: () =>
-        this.globalSettings.signalsDebug.getEnableLogSignals(),
-    })
+    this.signalEmitter = new SignalEmitter()
     this.signalsClient = new SignalsIngestClient(
       this.globalSettings.ingestClient
     )
@@ -136,10 +133,11 @@ export class Signals implements ISignals {
   }
 
   /**
-   * Disable redaction, ingestion of signals, and other debug logging.
+   * Disable redaction, ingestion of signals, and other logging.
    */
   debug(boolean = true): void {
     this.globalSettings.signalsDebug.setAllDebugging(boolean)
+    logger.enableLogging('info')
   }
 
   /**

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

@@ -1,27 +1,61 @@
-import { parseSignalsLoggingAdvancedQueryString } from '../../core/debug-mode'
+import {
+  parseDebugModeQueryString,
+  parseSignalsLogLevel,
+} from '../../core/debug-mode'
 import { DebugStorage } from '../storage/debug-storage'
 
 class Logger {
-  private static advancedLogging = 'segment_signals_logging_advanced'
+  private static infoLogging = 'segment_signals_log_level_info'
+  private static debugLogging = 'segment_signals_log_level_debug'
 
   storage = new DebugStorage('sessionStorage')
+
   constructor() {
-    const val = parseSignalsLoggingAdvancedQueryString()
-    if (typeof val === 'boolean') {
-      this.storage.setDebugKey(Logger.advancedLogging, val)
+    // if debug mode is in the query string, we want simple logging
+    const debugMode = parseDebugModeQueryString()
+    if (typeof debugMode === 'boolean') {
+      this.enableLogging('info')
+    }
+
+    // if log level is set to 'off' / 'log' / 'debug' in the query string, we want to set the write key
+    const logLevel = parseSignalsLogLevel()
+    if (logLevel !== undefined) {
+      logLevel === 'off' ? this.disableLogging() : this.enableLogging(logLevel)
     }
   }
 
+  private loggingEnabled = (): boolean => {
+    return this.storage.getDebugKey(Logger.infoLogging)
+  }
+
   private debugLoggingEnabled = (): boolean => {
-    return this.storage.getDebugKey(Logger.advancedLogging)
+    return this.storage.getDebugKey(Logger.debugLogging)
   }
 
   enableDebugLogging = (bool = true) => {
-    this.storage.setDebugKey(Logger.advancedLogging, bool)
+    this.storage.setDebugKey(Logger.debugLogging, bool)
   }
 
-  log = (...args: any[]): void => {
-    console.log('[signals log]', ...args)
+  // 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)
+    }
+  }
+
+  disableLogging = () => {
+    this.storage.setDebugKey(Logger.infoLogging, false)
+    this.storage.setDebugKey(Logger.debugLogging, false)
+  }
+
+  info = (...args: any[]): void => {
+    if (this.loggingEnabled() || this.debugLoggingEnabled()) {
+      console.log('[signals log]', ...args)
+    }
   }
 
   debug = (...args: any[]): void => {