Update and move sampling logic

Author: danieljackins

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

@@ -8,17 +8,15 @@ export class SignalsIngestSettings {
   flushInterval: number
   apiHost: string
   shouldDisableSignalRedaction: () => boolean
-  signalIngestion: () => boolean
+  shouldIngestSignals: () => boolean
   writeKey?: string
-  sampleRate: number
   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)
-    this.sampleRate = settings.sampleRate ?? 0
+    this.shouldIngestSignals = settings.shouldIngestSignals ?? (() => false)
   }
 }
 
@@ -27,8 +25,7 @@ export interface SignalsIngestSettingsConfig {
   flushAt?: number
   flushInterval?: number
   shouldDisableSignalRedaction?: () => boolean
-  signalIngestion?: () => boolean
-  sampleRate?: number
+  shouldIngestSignals?: () => boolean
 }
 /**
  * This currently just uses the Segment analytics-next library to send signals.
@@ -75,23 +72,11 @@ export class SignalsIngestClient {
     return analytics
   }
 
-  private shouldIngestSignals(): boolean {
-    let shouldIngest = false
-    if (Math.random() > this.settings.sampleRate) {
-      // currently a no-op, but will be used once signals are sent outside of debug mode
-      shouldIngest = false
-    }
-    if (this.settings.signalIngestion()) {
-      shouldIngest = true
-    }
-    return shouldIngest
-  }
-
   private sendTrackCall(signal: Signal) {
     if (!this.analytics) {
       throw new Error('Please initialize before calling this method.')
     }
-    if (!this.shouldIngestSignals()) {
+    if (!this.settings.shouldIngestSignals()) {
       return
     }
     const disableRedaction = this.settings.shouldDisableSignalRedaction()

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

@@ -34,6 +34,7 @@ export class SignalGlobalSettings {
   signalBuffer: SignalBufferSettingsConfig
   ingestClient: SignalsIngestSettingsConfig
   network: NetworkSettingsConfig
+  private sampleRate = 0
 
   private redaction = new SignalRedactionSettings()
   private ingestion = new SignalIngestionSettings()
@@ -58,8 +59,15 @@ export class SignalGlobalSettings {
       flushAt: settings.flushAt,
       flushInterval: settings.flushInterval,
       shouldDisableSignalRedaction: this.redaction.getDisableSignalRedaction,
-      signalIngestion: this.ingestion.getSignalIngestion,
-      sampleRate: settings.sampleRate,
+      shouldIngestSignals: () => {
+        if (this.ingestion.getSignalIngestion()) {
+          return true
+        }
+        if (Math.random() > this.sampleRate) {
+          return false
+        }
+        return false
+      },
     }
     this.sandbox = {
       functionHost: settings.functionHost,
@@ -86,7 +94,7 @@ export class SignalGlobalSettings {
      */
     disallowListURLs: (string | undefined)[]
     /**
-     * The sample rate pulled from CDN settings
+     * Sample rate to determine sending signals
      */
     sampleRate: number
   }): void {
@@ -96,7 +104,7 @@ export class SignalGlobalSettings {
         Boolean(val)
       )
     )
-    this.ingestClient.sampleRate = sampleRate
+    this.sampleRate = sampleRate
   }
 }
 

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

@@ -93,7 +93,7 @@ export class Signals implements ISignals {
       ],
       sampleRate:
         analyticsService.instance.settings.cdnSettings
-          .autoInstrumentationSettings?.sampleRate || 0,
+          .autoInstrumentationSettings?.sampleRate ?? 0,
     })
 
     const sandbox = new Sandbox(