add signal debug bool

Author: silesky

packages/signals/signals/package.json

@@ -25,6 +25,7 @@
   ],
   "scripts": {
     ".": "yarn run -T turbo run --filter=@segment/analytics-signals...",
+    "..": "yarn run -T turbo run --filter=...@segment/analytics-signals...",
     "test": "yarn jest",
     "lint": "yarn concurrently 'yarn:eslint .' 'yarn:tsc --noEmit'",
     "build": "rm -rf dist && yarn concurrently 'yarn:build:*'",

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

@@ -27,6 +27,7 @@ export type SignalsSettingsConfig = Pick<
   | 'mutationGenObservedTags'
   | 'mutationGenPollInterval'
   | 'mutationGenObservedAttributes'
+  | 'debug'
 > & {
   signalStorage?: SignalPersistentStorage
   processSignal?: string

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

@@ -39,6 +39,9 @@ export class Signals implements ISignals {
     this.globalSettings = new SignalGlobalSettings(settingsConfig)
     this.buffer = getSignalBuffer(this.globalSettings.signalBuffer)
     this.signalEmitter = this.getSignalEmitter(settingsConfig.middleware)
+    if (settingsConfig.debug) {
+      this.debug()
+    }
 
     // We register the generators (along with the signal emitter) so they start collecting signals before the plugin is started.
     // Otherwise, we would wait until analytics is loaded, which would skip things like page network URL changes.

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

@@ -41,6 +41,7 @@ export class SignalsPlugin implements Plugin, SignalsAugmentedFunctionality {
     })
 
     this.signals = new Signals({
+      debug: settings.debug,
       disableSignalsRedaction: settings.disableSignalsRedaction,
       enableSignalsIngestion: settings.enableSignalsIngestion,
       flushAt: settings.flushAt,

packages/signals/signals/src/types/settings.ts

@@ -12,6 +12,13 @@ export interface SignalsPluginSettingsConfig {
    */
   processSignal?: string | ProcessSignal
 
+  /**
+   * Enable debug mode. Same as ?debug=true in the URL or SignalsPlugin.debug(true)
+   * This sets the log level to 'info', disables redaction, and enables signals ingestion
+   * @default false
+   */
+  debug?: boolean
+
   /**
    * Add console debug logging
    * @default false