Signals analytics runtime (#1168)

Author: silesky

.changeset/proud-meals-cheat.md

@@ -0,0 +1,4 @@
+---
+'@segment/analytics-signals-runtime': major
+---
+Release analytics-signals-runtime 

.changeset/proud-meals-ox.md

@@ -0,0 +1,4 @@
+---
+'@segment/analytics-signals': minor
+---
+Refactor runtime to use `@segment/analytics-signals-runtime`

meta-tests/check-dts.ts

@@ -11,7 +11,13 @@ import fs from 'fs'
  */
 const execa = promisify(exec)
 
-const allPublicPackageDirNames = ['browser', 'core', 'node'] as const
+const allPublicPackageDirNames = [
+  'browser',
+  'core',
+  'node',
+  'signals/signals',
+  'signals/signals-runtime',
+] as const
 
 type PackageDirName = typeof allPublicPackageDirNames[number]
 

package.json

@@ -36,6 +36,7 @@
   "devDependencies": {
     "@changesets/changelog-github": "^0.4.5",
     "@changesets/cli": "^2.23.2",
+    "@microsoft/api-extractor": "^7.47.9",
     "@npmcli/promise-spawn": "^7.0.0",
     "@types/express": "4",
     "@types/jest": "^29.5.11",

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

@@ -31,6 +31,7 @@ export class BasePage {
    */
   async loadAndWait(...args: Parameters<BasePage['load']>) {
     await Promise.all([this.load(...args), this.waitForSettings()])
+    return this
   }
 
   /**
@@ -48,8 +49,12 @@ export class BasePage {
     this.edgeFn = edgeFn
     await this.setupMockedRoutes()
     const url = options.updateURL ? options.updateURL(this.url) : this.url
-    await this.page.goto(url)
-    void this.invokeAnalyticsLoad(signalSettings)
+    await this.page.goto(url, { waitUntil: 'domcontentloaded' })
+    void this.invokeAnalyticsLoad({
+      flushInterval: 500,
+      ...signalSettings,
+    })
+    return this
   }
 
   /**

packages/signals/signals-integration-tests/src/helpers/network-utils.ts

@@ -1,6 +1,7 @@
 import { Page, Route, Request } from '@playwright/test'
 import { SegmentEvent } from '@segment/analytics-next'
 import { Signal } from '@segment/analytics-signals'
+import { waitForCondition } from './playwright-utils'
 
 type FulfillOptions = Parameters<Route['fulfill']>['0']
 export interface XHRRequestOptions {
@@ -160,6 +161,31 @@ export class TrackingAPIRequestBuffer {
 }
 
 export class SignalAPIRequestBuffer extends TrackingAPIRequestBuffer {
+  async waitForEvents(
+    numberOfSignals: number,
+    signalType?: Signal['type']
+  ): Promise<SegmentEvent[]> {
+    await waitForCondition(
+      () => this.getEvents(signalType).length >= numberOfSignals,
+      {
+        timeout: 5000,
+        errorMessage: `Found ${
+          this.getEvents(signalType).length
+        } signals, expected ${numberOfSignals}`,
+      }
+    )
+    const events = this.getEvents(signalType)
+    if (events.length < numberOfSignals) {
+      throw new Error(
+        `Expected ${numberOfSignals} signals of type ${signalType}, but got ${
+          this.getEvents(signalType).length
+        }`
+      )
+    } else {
+      return events
+    }
+  }
+
   override getEvents(signalType?: Signal['type']): SegmentEvent[] {
     if (signalType) {
       return this.getEvents().filter((e) => e.properties!.type === signalType)

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

@@ -1,8 +1,6 @@
 import { test, expect } from '@playwright/test'
 import { IndexPage } from './index-page'
 
-const indexPage = new IndexPage()
-
 const basicEdgeFn = `
     // this is a process signal function
     const processSignal = (signal) => {
@@ -12,8 +10,10 @@ const basicEdgeFn = `
       }
   }`
 
+let indexPage: IndexPage
+
 test.beforeEach(async ({ page }) => {
-  await indexPage.loadAndWait(page, basicEdgeFn)
+  indexPage = await new IndexPage().loadAndWait(page, basicEdgeFn)
 })
 
 test('network signals fetch', async () => {

packages/signals/signals-integration-tests/src/tests/signals-vanilla/button-click-complex.test.ts

@@ -1,12 +1,10 @@
 import { test, expect } from '@playwright/test'
 import { IndexPage } from './index-page'
 
-const indexPage = new IndexPage()
-
 const basicEdgeFn = `const processSignal = (signal) => {}`
-
+let indexPage: IndexPage
 test.beforeEach(async ({ page }) => {
-  await indexPage.loadAndWait(page, basicEdgeFn)
+  indexPage = await new IndexPage().loadAndWait(page, basicEdgeFn)
 })
 
 const data = {

packages/signals/signals-integration-tests/src/tests/signals-vanilla/change-input.test.ts

@@ -2,8 +2,6 @@ import { test, expect } from '@playwright/test'
 import { waitForCondition } from '../../helpers/playwright-utils'
 import { IndexPage } from './index-page'
 
-const indexPage = new IndexPage()
-
 const basicEdgeFn = `const processSignal = (signal) => {}`
 
 test('Collecting signals whenever a user enters text input', async ({
@@ -12,7 +10,7 @@ test('Collecting signals whenever a user enters text input', async ({
   /**
    * Input some text into the input field, see if the signal is emitted correctly
    */
-  await indexPage.loadAndWait(page, basicEdgeFn, {
+  const indexPage = await new IndexPage().loadAndWait(page, basicEdgeFn, {
     disableSignalsRedaction: true,
     enableSignalsIngestion: true,
   })

packages/signals/signals-integration-tests/src/tests/signals-vanilla/network-signals-allow-list.test.ts

@@ -1,12 +1,10 @@
 import { test, expect } from '@playwright/test'
 import { IndexPage } from './index-page'
 
-const indexPage = new IndexPage()
-
 const basicEdgeFn = `const processSignal = (signal) => {}`
 
 test('network signals allow and disallow list', async ({ page }) => {
-  await indexPage.loadAndWait(page, basicEdgeFn, {
+  const indexPage = await new IndexPage().loadAndWait(page, basicEdgeFn, {
     networkSignalsAllowList: ['allowed-api.com'],
     networkSignalsDisallowList: ['https://disallowed-api.com/api/foo'],
   })