wip

Author: danieljackins

packages/signals/signals-integration-tests/src/tests/signals-vanilla/signals-redaction.test.ts

@@ -10,8 +10,8 @@ test('redaction enabled -> will XXX the value of text input', async ({
   page,
 }) => {
   await indexPage.loadAndWait(page, basicEdgeFn, {
-    enableSignalsDebug: false,
-    signalsIngestion: true,
+    disableSignalsRedaction: false,
+    enableSignalsIngestion: true,
   })
 
   await Promise.all([

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

@@ -7,15 +7,15 @@ export class SignalsIngestSettings {
   flushAt: number
   flushInterval: number
   apiHost: string
-  shouldDisableSignalRedaction: () => boolean
+  shouldDisableSignalsRedaction: () => boolean
   shouldIngestSignals: () => boolean
   writeKey?: string
   constructor(settings: SignalsIngestSettingsConfig) {
     this.flushAt = settings.flushAt ?? 5
     this.apiHost = settings.apiHost ?? 'signals.segment.io/v1'
     this.flushInterval = settings.flushInterval ?? 2000
-    this.shouldDisableSignalRedaction =
-      settings.shouldDisableSignalRedaction ?? (() => false)
+    this.shouldDisableSignalsRedaction =
+      settings.shouldDisableSignalsRedaction ?? (() => false)
     this.shouldIngestSignals = settings.shouldIngestSignals ?? (() => false)
   }
 }
@@ -24,7 +24,7 @@ export interface SignalsIngestSettingsConfig {
   apiHost?: string
   flushAt?: number
   flushInterval?: number
-  shouldDisableSignalRedaction?: () => boolean
+  shouldDisableSignalsRedaction?: () => boolean
   shouldIngestSignals?: () => boolean
 }
 /**
@@ -79,7 +79,7 @@ export class SignalsIngestClient {
     if (!this.settings.shouldIngestSignals()) {
       return
     }
-    const disableRedaction = this.settings.shouldDisableSignalRedaction()
+    const disableRedaction = this.settings.shouldDisableSignalsRedaction()
     const cleanSignal = disableRedaction ? signal : redactSignalData(signal)
 
     if (disableRedaction) {

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

@@ -13,7 +13,8 @@ export type SignalsSettingsConfig = Pick<
   | 'functionHost'
   | 'flushAt'
   | 'flushInterval'
-  | 'enableSignalsDebug'
+  | 'disableSignalsRedaction'
+  | 'enableSignalsIngestion'
   | 'networkSignalsAllowList'
   | 'networkSignalsDisallowList'
   | 'networkSignalsAllowSameDomain'
@@ -43,7 +44,10 @@ export class SignalGlobalSettings {
       )
     }
 
-    this.signalsDebug = new SignalsDebugSettings(settings.enableSignalsDebug)
+    this.signalsDebug = new SignalsDebugSettings(
+      settings.disableSignalsRedaction,
+      settings.enableSignalsIngestion
+    )
 
     this.signalBuffer = {
       signalStorage: settings.signalStorage,
@@ -53,9 +57,10 @@ export class SignalGlobalSettings {
       apiHost: settings.apiHost,
       flushAt: settings.flushAt,
       flushInterval: settings.flushInterval,
-      shouldDisableSignalRedaction: this.signalsDebug.getSignalsDebug,
+      shouldDisableSignalsRedaction:
+        this.signalsDebug.getDisableSignalsRedaction,
       shouldIngestSignals: () => {
-        if (this.signalsDebug.getSignalsDebug()) {
+        if (this.signalsDebug.getEnableSignalsIngestion()) {
           return true
         }
         if (!this.sampleSuccess) {
@@ -106,10 +111,14 @@ export class SignalGlobalSettings {
 }
 
 class SignalsDebugSettings {
-  private static key = 'segment_signals_debug'
-  constructor(initialValue?: boolean) {
-    if (typeof initialValue === 'boolean') {
-      this.setSignalsDebug(initialValue)
+  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)
+    }
+    if (typeof enableIngestion === 'boolean') {
+      this.setDebugKey(SignalsDebugSettings.ingestionKey, enableIngestion)
     }
 
     // setting ?segment_signals_debug=true will disable redaction, enable ingestion, and set keys in local storage
@@ -118,30 +127,46 @@ class SignalsDebugSettings {
     const debugModeInQs = parseDebugModeQueryString()
     logger.debug('debugMode is set to true via query string')
     if (typeof debugModeInQs === 'boolean') {
-      this.setSignalsDebug(debugModeInQs)
+      this.setDebugKey(SignalsDebugSettings.redactionKey, debugModeInQs)
+      this.setDebugKey(SignalsDebugSettings.ingestionKey, debugModeInQs)
     }
   }
 
-  setSignalsDebug(shouldDisable: boolean) {
+  setDebugKey(key: string, enable: boolean) {
     try {
-      if (shouldDisable) {
-        window.sessionStorage.setItem(SignalsDebugSettings.key, 'true')
+      if (enable) {
+        window.sessionStorage.setItem(key, 'true')
       } else {
-        logger.debug('Removing debug key from storage')
-        window.sessionStorage.removeItem(SignalsDebugSettings.key)
+        logger.debug(`Removing debug key ${key} from storage`)
+        window.sessionStorage.removeItem(key)
+      }
+    } catch (e) {
+      logger.debug('Storage error', e)
+    }
+  }
+
+  getDisableSignalsRedaction() {
+    try {
+      const isEnabled = Boolean(
+        window.sessionStorage.getItem(SignalsDebugSettings.redactionKey)
+      )
+      if (isEnabled) {
+        logger.debug(`${SignalsDebugSettings.redactionKey}=true (app. storage)`)
+        return true
       }
     } catch (e) {
       logger.debug('Storage error', e)
     }
+    return false
   }
 
-  getSignalsDebug() {
+  getEnableSignalsIngestion() {
     try {
-      const isDisabled = Boolean(
-        window.sessionStorage.getItem(SignalsDebugSettings.key)
+      const isEnabled = Boolean(
+        window.sessionStorage.getItem(SignalsDebugSettings.ingestionKey)
       )
-      if (isDisabled) {
-        logger.debug(`${SignalsDebugSettings.key}=true (app. storage)`)
+      if (isEnabled) {
+        logger.debug(`${SignalsDebugSettings.ingestionKey}=true (app. storage)`)
         return true
       }
     } catch (e) {

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

@@ -34,7 +34,8 @@ export class SignalsPlugin implements Plugin, SignalsAugmentedFunctionality {
     logger.debug('SignalsPlugin initializing', { settings })
 
     this.signals = new Signals({
-      enableSignalsDebug: settings.enableSignalsDebug,
+      disableSignalsRedaction: settings.disableSignalsRedaction,
+      enableSignalsIngestion: settings.enableSignalsIngestion,
       flushAt: settings.flushAt,
       flushInterval: settings.flushInterval,
       functionHost: settings.functionHost,

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

@@ -18,15 +18,15 @@ export interface SignalsPluginSettingsConfig {
   enableDebugLogging?: boolean
 
   /**
-   * Enables signals debug mode (turns off redaction, enables ingestion)
+   * Disable redaction of signals
    * @default false
    */
-  enableSignalsDebug?: boolean
+  disableSignalsRedaction?: boolean
 
   /**
-   * If signals ingestion is enabled/disabled
+   * Enable ingestion of signals
    */
-  signalsIngestion?: boolean
+  enableSignalsIngestion?: boolean
 
   /**
    * Percentage of sessions that should be ingested