add sample rate option, clean up tests

Author: danieljackins

packages/signals/signals-integration-tests/src/helpers/base-page-object.ts

@@ -7,7 +7,6 @@ import {
   SignalAPIRequestBuffer,
   TrackingAPIRequestBuffer,
 } from './network-utils'
-import { CDNSettings } from '@segment/analytics-next'
 
 export class BasePage {
   protected page!: Page
@@ -42,14 +41,13 @@ export class BasePage {
     page: Page,
     edgeFn: string,
     signalSettings: Partial<SignalsPluginSettingsConfig> = {},
-    options: { updateURL?: (url: string) => string } = {},
-    cdnSettings?: Partial<CDNSettings>
+    options: { updateURL?: (url: string) => string; sampleRate?: number } = {}
   ) {
     logConsole(page)
     this.page = page
     this.network = new PageNetworkUtils(page)
     this.edgeFn = edgeFn
-    await this.setupMockedRoutes(cdnSettings)
+    await this.setupMockedRoutes(options.sampleRate)
     const url = options.updateURL ? options.updateURL(this.url) : this.url
     await this.page.goto(url, { waitUntil: 'domcontentloaded' })
     void this.invokeAnalyticsLoad({
@@ -94,15 +92,15 @@ export class BasePage {
     return this
   }
 
-  private async setupMockedRoutes(settings?: Partial<CDNSettings>) {
+  private async setupMockedRoutes(sampleRate?: number) {
     // clear any existing saved requests
     this.trackingAPI.clear()
     this.signalsAPI.clear()
 
     await Promise.all([
       this.mockSignalsApi(),
       this.mockTrackingApi(),
-      this.mockCDNSettings(settings),
+      this.mockCDNSettings(sampleRate),
     ])
   }
 
@@ -205,7 +203,7 @@ export class BasePage {
     })
   }
 
-  async mockCDNSettings(settings?: Partial<CDNSettings>) {
+  async mockCDNSettings(sampleRate?: number) {
     await this.page.route(
       'https://cdn.segment.com/v1/projects/*/settings',
       (route, request) => {
@@ -215,11 +213,14 @@ export class BasePage {
 
         const cdnSettings = new CDNSettingsBuilder({
           writeKey: '<SOME_WRITE_KEY>',
-          baseCDNSettings: settings ?? {
+          baseCDNSettings: {
             edgeFunction: {
               downloadURL: this.edgeFnDownloadURL,
               version: 1,
             },
+            autoInstrumentationSettings: {
+              sampleRate: sampleRate ?? 1,
+            },
           },
         }).build()
 

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

@@ -36,15 +36,8 @@ test('never sends signal when sample rate is 0', async ({ page }) => {
       flushAt: 1,
       enableSignalsIngestion: false,
     },
-    undefined,
     {
-      edgeFunction: {
-        downloadURL: 'https://cdn.edgefn.segment.com/MY-WRITEKEY/foo.js',
-        version: 1,
-      },
-      autoInstrumentationSettings: {
-        sampleRate: 0,
-      },
+      sampleRate: 0,
     }
   )
   await indexPage.fillNameInput('John Doe')
@@ -60,15 +53,8 @@ test('always sends signal when sample rate is 1', async ({ page }) => {
       flushAt: 1,
       enableSignalsIngestion: false,
     },
-    undefined,
     {
-      edgeFunction: {
-        downloadURL: 'https://cdn.edgefn.segment.com/MY-WRITEKEY/foo.js',
-        version: 1,
-      },
-      autoInstrumentationSettings: {
-        sampleRate: 1,
-      },
+      sampleRate: 1,
     }
   )
   await indexPage.fillNameInput('John Doe')