wip

Author: silesky

packages/signals/signals/jest.setup.ts

@@ -1,5 +1,4 @@
 /* eslint-disable no-undef */
+import './src/test-helpers/jest-extended'
 import 'fake-indexeddb/auto'
 globalThis.structuredClone = (v: any) => JSON.parse(JSON.stringify(v))
-
-import './src/test-helpers/custom-snapshot-serializers'

packages/signals/signals/src/core/middleware/signals-ingest/__tests__/redact.test.ts

@@ -93,7 +93,7 @@ describe(redactSignalData, () => {
       listener: 'onchange',
       target: createMockTarget({ value: 'XXX', formData: { password: 'XXX' } }),
     })
-    expect(redactSignalData(signal)).toEqual(expected)
+    expect(redactSignalData(signal)).toMatchSignal(expected)
   })
 
   it('should redact attributes in change and in target if the listener is "mutation"', () => {
@@ -117,7 +117,7 @@ describe(redactSignalData, () => {
         innerText: 'XXX',
       }),
     })
-    expect(redactSignalData(signal)).toEqual(expected)
+    expect(redactSignalData(signal)).toMatchSignal(expected)
   })
 
   it('should redact the textContent and innerText in the "target" property if the listener is "contenteditable"', () => {
@@ -133,7 +133,7 @@ describe(redactSignalData, () => {
       change: { textContent: 'XXX' },
       target: createMockTarget({ textContent: 'XXX', innerText: 'XXX' }),
     })
-    expect(redactSignalData(signal)).toEqual(expected)
+    expect(redactSignalData(signal)).toMatchSignal(expected)
   })
 
   it('should redact the values in the "data" property if the type is "network"', () => {
@@ -157,7 +157,7 @@ describe(redactSignalData, () => {
       },
       metadataFixture
     )
-    expect(redactSignalData(signal)).toEqual(expected)
+    expect(redactSignalData(signal)).toMatchSignal(expected)
   })
 
   it('should not mutate the original signal object', () => {

packages/signals/signals/src/core/middleware/user-info/index.ts

@@ -3,7 +3,6 @@ import { User } from '../../../types'
 import { SignalsMiddleware, SignalsMiddlewareContext } from '../../emitter'
 
 export class UserInfoMiddleware implements SignalsMiddleware {
-  ctx!: SignalsMiddlewareContext
   user!: User
 
   async load(ctx: SignalsMiddlewareContext) {

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

@@ -16,6 +16,7 @@ import { LogLevelOptions } from '../debug-mode'
 import { SignalsIngestSubscriber } from '../middleware/signals-ingest'
 import { SignalsEventProcessorSubscriber } from '../middleware/event-processor'
 import { NetworkSignalsFilterMiddleware } from '../middleware/network-signals-filter/network-signals-filter'
+import { UserInfoMiddleware } from '../middleware/user-info'
 
 interface ISignals {
   start(analytics: AnyAnalytics): Promise<void>
@@ -126,6 +127,7 @@ export class Signals implements ISignals {
     // we initialize the emitter here so that registerGenerator can be called before start
     return new SignalEmitter()
       .addMiddleware(
+        new UserInfoMiddleware(),
         new NetworkSignalsFilterMiddleware(),
         ...(middleware || [])
       )

packages/signals/signals/src/test-helpers/custom-snapshot-serializers.ts

@@ -0,0 +1,64 @@
+import { Signal } from '@segment/analytics-signals-runtime'
+
+// e.g 2025-03-18T20:27:01.459Z
+const isoTimestampRegex = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/
+
+export const timestampSerializer: jest.SnapshotSerializerPlugin = {
+  test(value: any) {
+    return typeof value === 'string' && isoTimestampRegex.test(value)
+  },
+  print() {
+    return '<ISO Timestamp>'
+  },
+}
+
+/***
+ * Add snapshot serializer so timestamps are not compared in snapshots
+ */
+expect.addSnapshotSerializer(timestampSerializer)
+
+export function toMatchSignal(
+  this: jest.MatcherContext,
+  received: Signal,
+  expected: Signal
+) {
+  const cleanSignal = (signal: Signal) => {
+    const { timestamp, ...rest } = signal
+    return rest
+  }
+
+  const pass = this.equals(cleanSignal(received), cleanSignal(expected))
+  if (pass) {
+    return {
+      message: () =>
+        `expected ${this.utils.printReceived(
+          received
+        )} not to match ${this.utils.printExpected(expected)}`,
+      pass: true,
+    }
+  } else {
+    return {
+      message: () =>
+        `expected ${this.utils.printReceived(
+          received
+        )} to match ${this.utils.printExpected(expected)}`,
+      pass: false,
+    }
+  }
+}
+
+/***
+ * Add special matcher to compare signals
+ * usage:
+ * expect(signal).toMatchSignal(expectedSignal)
+ */
+expect.extend({ toMatchSignal })
+
+declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace jest {
+    interface Matchers<R> {
+      toMatchSignal(expected: Signal): R
+    }
+  }
+}