update signals runtime package

Author: silesky

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

@@ -7,6 +7,7 @@ import {
   SignalAPIRequestBuffer,
   TrackingAPIRequestBuffer,
 } from './network-utils'
+import { SegmentEvent } from '@segment/analytics-next'
 
 export class BasePage {
   protected page!: Page
@@ -82,6 +83,17 @@ export class BasePage {
           enableSignalsIngestion: true,
           ...signalSettings,
         })
+
+        window.signalsEmitted = []
+        window.signalsPlugin.onSignal((signal) => {
+          window.signalsEmitted.push(signal)
+        })
+        window.segmentEvents = []
+        window.analytics.on('track', (event) => {
+          if (event !== 'Segment Signal Generated') {
+            window.segmentEvents.push(event)
+          }
+        })
         window.analytics.load({
           writeKey: '<SOME_WRITE_KEY>',
           plugins: [window.signalsPlugin],
@@ -92,6 +104,14 @@ export class BasePage {
     return this
   }
 
+  getEmittedSignals(): Promise<Signal[]> {
+    return this.page.evaluate(() => window.signalsEmitted)
+  }
+
+  getSegmentEvents(): Promise<SegmentEvent[]> {
+    return this.page.evaluate(() => window.segmentEvents)
+  }
+
   private async setupMockedRoutes() {
     // clear any existing saved requests
     this.trackingAPI.clear()

packages/signals/signals-integration-tests/src/shims.d.ts

@@ -1,9 +1,11 @@
-import type { AnalyticsBrowser } from '@segment/analytics-next'
-import type { SignalsPlugin } from '@segment/analytics-signals'
+import type { AnalyticsBrowser, SegmentEvent } from '@segment/analytics-next'
+import type { Signal, SignalsPlugin } from '@segment/analytics-signals'
 
 declare global {
   interface Window {
     analytics: AnalyticsBrowser
     signalsPlugin: SignalsPlugin
+    signalsEmitted: Signal[]
+    segmentEvents: SegmentEvent[]
   }
 }

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

@@ -14,11 +14,29 @@ test('should find the most recent signal', async ({ page }) => {
 }`
 
   await indexPage.loadAndWait(page, basicEdgeFn)
-  const tapiFlush = indexPage.waitForTrackingApiFlush()
   await indexPage.addUserDefinedSignal({ num: 1 })
   await indexPage.addUserDefinedSignal({ num: 2 })
   await indexPage.clickComplexButton()
-  await tapiFlush
-  const lastEvent = indexPage.trackingAPI.lastEvent()
-  expect(lastEvent.event).toEqual('correct signal found')
+  await page.waitForFunction(() => window.segmentEvents.length === 1)
+  const events = await page.evaluate(() => window.segmentEvents)
+  expect(events[0]).toEqual('correct signal found')
+})
+
+test('should work with other signals', async ({ page }) => {
+  const basicEdgeFn = `const processSignal = (signal) => {
+    if (signal.type === 'interaction' && signal.data.eventType === 'click') {
+        const oldSignal = signals.find(signal, 'userDefined', (s) => s.data.order === 'old')
+        const oldestSignal = signals.find(oldSignal, 'userDefined')
+        analytics.track('order: ' + oldestSignal.data.order)
+    }
+}`
+
+  await indexPage.loadAndWait(page, basicEdgeFn)
+  await indexPage.addUserDefinedSignal({ order: 'oldest' })
+  await indexPage.addUserDefinedSignal({ order: 'old' })
+  await indexPage.addUserDefinedSignal({ order: 'young' })
+  await indexPage.clickButton()
+  await page.waitForFunction(() => window.segmentEvents.length === 1)
+  const events = await page.evaluate(() => window.segmentEvents)
+  expect(events[0]).toEqual('order: oldest')
 })

packages/signals/signals-runtime/src/mobile/get-runtime-code.generated.ts

@@ -1,8 +1,8 @@
 /* eslint-disable */
 // GENERATED, DO NOT EDIT
-// @segment/analytics-signals-runtime@0.0.0
+// @segment/analytics-signals-runtime@1.0.0
 // Entry point: src/mobile/index.signals-runtime.ts
 export const getRuntimeCode = (): string => `
-"use strict";(()=>{var g=Object.defineProperty;var f=(r,n)=>{for(var e in n)g(r,e,{get:n[e],enumerable:!0})};var l={};f(l,{EventType:()=>d,LocalDataAction:()=>c,NavigationAction:()=>S,NetworkAction:()=>u,SignalType:()=>p});var p=Object.freeze({Interaction:"interaction",Navigation:"navigation",Network:"network",LocalData:"localData",Instrumentation:"instrumentation",UserDefined:"userDefined"}),d=Object.freeze({Track:"track",Page:"page",Screen:"screen",Identify:"identify",Group:"group",Alias:"alias"}),S=Object.freeze({Forward:"forward",Backward:"backward",Modal:"modal",Entering:"entering",Leaving:"leaving",Page:"page",Popup:"popup"}),u=Object.freeze({Request:"request",Response:"response"}),c=Object.freeze({Loaded:"loaded",Updated:"updated",Saved:"saved",Deleted:"deleted",Undefined:"undefined"});var a=class{constructor(n=[]){this.find=(n,e,i)=>this.filter(n,e,i)[0];this.filter=(n,e,i)=>{let o=s=>s.type===e;return this.signalBuffer.slice(this.signalBuffer.indexOf(n)+1).filter(o).filter(s=>i?i(s):()=>!0)};this.signalBuffer=n}};var t=class extends a{constructor(e=[]){super(e);this.add=e=>{this.signalCounter<0&&(this.signalCounter=0),"index"in e&&e.index==-1&&(e.index=this.getNextIndex()),this.signalBuffer.unshift(e),this.signalBuffer.length>this.maxBufferSize&&this.signalBuffer.pop()};this.getNextIndex=()=>{let e=this.signalCounter;return this.signalCounter+=1,e};this.signalCounter=0,this.maxBufferSize=1e3}};Object.assign(globalThis,{signals:new t},l);})();
+"use strict";(()=>{var o=Object.defineProperty;var f=(l,n)=>{for(var e in n)o(l,e,{get:n[e],enumerable:!0})};var g={};f(g,{EventType:()=>d,LocalDataAction:()=>c,NavigationAction:()=>S,NetworkAction:()=>u,SignalType:()=>p});var p=Object.freeze({Interaction:"interaction",Navigation:"navigation",Network:"network",LocalData:"localData",Instrumentation:"instrumentation",UserDefined:"userDefined"}),d=Object.freeze({Track:"track",Page:"page",Screen:"screen",Identify:"identify",Group:"group",Alias:"alias"}),S=Object.freeze({Forward:"forward",Backward:"backward",Modal:"modal",Entering:"entering",Leaving:"leaving",Page:"page",Popup:"popup"}),u=Object.freeze({Request:"request",Response:"response"}),c=Object.freeze({Loaded:"loaded",Updated:"updated",Saved:"saved",Deleted:"deleted",Undefined:"undefined"});var r=class{constructor(n=[]){this.find=(n,e,t)=>this.filter(n,e,t)[0];this.filter=(n,e,t)=>{let a=this.signalBuffer.findIndex(i=>i===n?!0:"id"in i&&"id"in n?i.id===n.id:"index"in i&&"index"in n?i.index===n.index:JSON.stringify(i)===JSON.stringify(n));return a===-1&&console.warn("Invariant: the fromSignal was not found in the signalBuffer"),this.filterBuffer(this.signalBuffer.slice(a+1),e,t)};this.filterBuffer=(n,e,t)=>{let a=i=>i.type===e;return n.filter(a).filter(i=>t?t(i):()=>!0)};this.signalBuffer=n}};var s=class extends r{constructor(e=[]){super(e);this.add=e=>{this.signalCounter<0&&(this.signalCounter=0),"index"in e&&e.index==-1&&(e.index=this.getNextIndex()),this.signalBuffer.unshift(e),this.signalBuffer.length>this.maxBufferSize&&this.signalBuffer.pop()};this.getNextIndex=()=>{let e=this.signalCounter;return this.signalCounter+=1,e};this.signalCounter=0,this.maxBufferSize=1e3}};Object.assign(globalThis,{signals:new s},g);})();
 `
 

packages/signals/signals-runtime/src/shared/signals-runtime.ts

@@ -40,12 +40,44 @@ export abstract class SignalsRuntime<Signal extends BaseSignal = BaseSignal> {
     fromSignal: Signal,
     signalType: SignalType,
     predicate?: (signal: SignalOfType<Signal, SignalType>) => boolean
+  ): SignalOfType<Signal, SignalType>[] => {
+    const foundIndex = this.signalBuffer.findIndex((el) => {
+      // if can use referential comparison, use that. Or if has ID, use that to compare
+      // or else, use JSON.stringify to do a deep comparison
+      if (el === fromSignal) {
+        return true
+      } else if ('id' in el && 'id' in fromSignal) {
+        return el.id === fromSignal.id
+      } else if ('index' in el && 'index' in fromSignal) {
+        return el.index === fromSignal.index
+      } else {
+        return JSON.stringify(el) === JSON.stringify(fromSignal)
+      }
+    })
+
+    if (foundIndex === -1) {
+      console.warn(
+        'Invariant: the fromSignal was not found in the signalBuffer'
+      )
+    }
+
+    return this.filterBuffer(
+      this.signalBuffer.slice(foundIndex + 1),
+      signalType,
+      predicate
+    )
+  }
+
+  private filterBuffer = <SignalType extends Signal['type']>(
+    buffer: Signal[],
+    signalType: SignalType,
+    predicate?: (signal: SignalOfType<Signal, SignalType>) => boolean
   ): SignalOfType<Signal, SignalType>[] => {
     const _isSignalOfType = (
       signal: Signal
     ): signal is SignalOfType<Signal, SignalType> => signal.type === signalType
-    return this.signalBuffer
-      .slice(this.signalBuffer.indexOf(fromSignal) + 1)
+
+    return buffer
       .filter(_isSignalOfType)
       .filter((signal) => (predicate ? predicate(signal) : () => true))
   }

packages/signals/signals-runtime/src/web/get-runtime-code.generated.ts

@@ -1,8 +1,8 @@
 /* eslint-disable */
 // GENERATED, DO NOT EDIT
-// @segment/analytics-signals-runtime@0.0.0
+// @segment/analytics-signals-runtime@1.0.0
 // Entry point: src/web/index.signals-runtime.ts
 export const getRuntimeCode = (): string => `
-"use strict";(()=>{var o=Object.defineProperty;var S=(l,e)=>{for(var n in e)o(l,n,{get:e[n],enumerable:!0})};var i=class{constructor(e=[]){this.find=(e,n,a)=>this.filter(e,n,a)[0];this.filter=(e,n,a)=>{let s=g=>g.type===n;return this.signalBuffer.slice(this.signalBuffer.indexOf(e)+1).filter(s).filter(g=>a?a(g):()=>!0)};this.signalBuffer=e}};var t=class extends i{};var r={};S(r,{EventType:()=>f,NavigationAction:()=>p,SignalType:()=>y});var f=Object.freeze({Track:"track",Page:"page",Screen:"screen",Identify:"identify",Group:"group",Alias:"alias"}),p=Object.freeze({URLChange:"urlChange",PageLoad:"pageLoad"}),y=Object.freeze({Interaction:"interaction",Navigation:"navigation",Network:"network",LocalData:"localData",Instrumentation:"instrumentation",UserDefined:"userDefined"});Object.assign(globalThis,{signals:new t},r);})();
+"use strict";(()=>{var f=Object.defineProperty;var o=(r,n)=>{for(var i in n)f(r,i,{get:n[i],enumerable:!0})};var l=class{constructor(n=[]){this.find=(n,i,a)=>this.filter(n,i,a)[0];this.filter=(n,i,a)=>{let t=this.signalBuffer.findIndex(e=>e===n?!0:"id"in e&&"id"in n?e.id===n.id:"index"in e&&"index"in n?e.index===n.index:JSON.stringify(e)===JSON.stringify(n));return t===-1&&console.warn("Invariant: the fromSignal was not found in the signalBuffer"),this.filterBuffer(this.signalBuffer.slice(t+1),i,a)};this.filterBuffer=(n,i,a)=>{let t=e=>e.type===i;return n.filter(t).filter(e=>a?a(e):()=>!0)};this.signalBuffer=n}};var g=class extends l{};var s={};o(s,{EventType:()=>S,NavigationAction:()=>p,SignalType:()=>y});var S=Object.freeze({Track:"track",Page:"page",Screen:"screen",Identify:"identify",Group:"group",Alias:"alias"}),p=Object.freeze({URLChange:"urlChange",PageLoad:"pageLoad"}),y=Object.freeze({Interaction:"interaction",Navigation:"navigation",Network:"network",LocalData:"localData",Instrumentation:"instrumentation",UserDefined:"userDefined"});Object.assign(globalThis,{signals:new g},s);})();
 `