add signal ingestion settings

Author: danieljackins

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

@@ -8,13 +8,15 @@ export class SignalsIngestSettings {
   flushInterval: number
   apiHost: string
   shouldDisableSignalRedaction: () => boolean
+  signalIngestion: () => 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.signalIngestion = settings.signalIngestion ?? (() => false)
   }
 }
 
@@ -23,6 +25,7 @@ export interface SignalsIngestSettingsConfig {
   flushAt?: number
   flushInterval?: number
   shouldDisableSignalRedaction?: () => boolean
+  signalIngestion?: () => boolean
 }
 /**
  * This currently just uses the Segment analytics-next library to send signals.
@@ -73,6 +76,9 @@ export class SignalsIngestClient {
     if (!this.analytics) {
       throw new Error('Please initialize before calling this method.')
     }
+    if (!this.settings.signalIngestion) {
+      return
+    }
     const disableRedaction = this.settings.shouldDisableSignalRedaction()
     const data = disableRedaction
       ? signal.data

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

@@ -14,6 +14,7 @@ export type SignalsSettingsConfig = Pick<
   | 'flushAt'
   | 'flushInterval'
   | 'disableSignalsRedaction'
+  | 'signalsIngestion'
   | 'networkSignalsAllowList'
   | 'networkSignalsDisallowList'
   | 'networkSignalsAllowSameDomain'
@@ -34,6 +35,7 @@ export class SignalGlobalSettings {
   network: NetworkSettingsConfig
 
   private redaction = new SignalRedactionSettings()
+  private ingestion = new SignalIngestionSettings()
 
   constructor(settings: SignalsSettingsConfig) {
     if (settings.maxBufferSize && settings.signalStorage) {
@@ -55,6 +57,7 @@ export class SignalGlobalSettings {
       flushAt: settings.flushAt,
       flushInterval: settings.flushInterval,
       shouldDisableSignalRedaction: this.redaction.getDisableSignalRedaction,
+      signalIngestion: this.ingestion.getSignalIngestion,
     }
     this.sandbox = {
       functionHost: settings.functionHost,
@@ -139,3 +142,54 @@ class SignalRedactionSettings {
     return false
   }
 }
+
+class SignalIngestionSettings {
+  private static ingestionKey = 'segment_signals_debug_ingestion_enabled'
+  constructor(initialValue?: boolean) {
+    if (typeof initialValue === 'boolean') {
+      this.setSignalIngestion(initialValue)
+    }
+
+    // setting ?segment_signals_debug=true will disable redaction, and set a key 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.setSignalIngestion(debugModeInQs)
+    }
+  }
+
+  setSignalIngestion(shouldEnable: boolean) {
+    try {
+      if (shouldEnable) {
+        window.sessionStorage.setItem(
+          SignalIngestionSettings.ingestionKey,
+          'true'
+        )
+      } else {
+        logger.debug('Removing ingestion key from storage')
+        window.sessionStorage.removeItem(SignalIngestionSettings.ingestionKey)
+      }
+    } catch (e) {
+      logger.debug('Storage error', e)
+    }
+  }
+
+  getSignalIngestion() {
+    try {
+      const isEnabled = Boolean(
+        window.sessionStorage.getItem(SignalIngestionSettings.ingestionKey)
+      )
+      if (isEnabled) {
+        logger.debug(
+          `${SignalIngestionSettings.ingestionKey}=true (app. storage)`
+        )
+        return true
+      }
+    } catch (e) {
+      logger.debug('Storage error', e)
+    }
+    return false
+  }
+}

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

@@ -23,6 +23,11 @@ export interface SignalsPluginSettingsConfig {
    */
   disableSignalsRedaction?: boolean
 
+  /**
+   * If signals ingestion is enabled/disabled
+   */
+  signalsIngestion?: boolean
+
   /**
    * Override signals API host
    * @default signals.segment.io/v1