Update to use new signals specification

.changeset/thick-cars-compete.md

@@ -0,0 +1,5 @@
+---
+'@segment/analytics-signals': major
+---
+
+Update package to use new spec

meta-tests/check-dts.ts

@@ -2,6 +2,7 @@ import { exec } from 'child_process'
 import { promisify } from 'util'
 import path from 'path'
 import fs from 'fs'
+import getPackages from 'get-monorepo-packages'
 
 /**
  * This script is for extra typechecking of the built .d.ts files in {package_name}/dist/types/*.
@@ -11,13 +12,19 @@ import fs from 'fs'
  */
 const execa = promisify(exec)
 
-const allPublicPackageDirNames = [
-  'browser',
-  'core',
-  'node',
-  'signals/signals',
-  'signals/signals-runtime',
-] as const
+// Get public packages programmatically
+const packages = getPackages(path.join(__dirname, '..'))
+const publicPackageNames = [
+  '@segment/analytics-next',
+  '@segment/analytics-core',
+  '@segment/analytics-node',
+  '@segment/analytics-signals',
+]
+
+const allPublicPackageDirNames = packages
+  .filter((pkg) => publicPackageNames.includes(pkg.package.name))
+  .map((pkg) => path.relative('packages', pkg.location))
+  .sort() as readonly string[]
 
 type PackageDirName = typeof allPublicPackageDirNames[number]
 

packages/signals/signals-integration-tests/src/tests/signals-vanilla/all-segment-events.test.ts

@@ -66,7 +66,7 @@ test('Should dispatch events from signals that occurred before analytics was ins
 }) => {
   const edgeFn = `
     globalThis.processSignal = (signal) => {
-       if (signal.type === 'navigation' && signal.data.action === 'pageLoad') {
+       if (signal.type === 'navigation') {
           analytics.page('dispatched from signals - navigation')
       }
       if (signal.type === 'userDefined') {

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

@@ -29,13 +29,13 @@ test('network signals fetch', async () => {
     (el) => el.properties!.data.action === 'request'
   )
   expect(requests).toHaveLength(1)
-  expect(requests[0].properties!.data.data).toEqual({ foo: 'bar' })
+  expect(requests[0].properties!.data.body).toEqual({ foo: 'bar' })
 
   const responses = networkEvents.filter(
     (el) => el.properties!.data.action === 'response'
   )
   expect(responses).toHaveLength(1)
-  expect(responses[0].properties!.data.data).toEqual({ someResponse: 'yep' })
+  expect(responses[0].properties!.data.body).toEqual({ someResponse: 'yep' })
 })
 
 test('network signals xhr', async () => {
@@ -51,13 +51,13 @@ test('network signals xhr', async () => {
     (el) => el.properties!.data.action === 'request'
   )
   expect(requests).toHaveLength(1)
-  expect(requests[0].properties!.data.data).toEqual({ foo: 'bar' })
+  expect(requests[0].properties!.data.body).toEqual({ foo: 'bar' })
 
   const responses = networkEvents.filter(
     (el) => el.properties!.data.action === 'response'
   )
   expect(responses).toHaveLength(1)
-  expect(responses[0].properties!.data.data).toEqual({ someResponse: 'yep' })
+  expect(responses[0].properties!.data.body).toEqual({ someResponse: 'yep' })
   expect(responses[0].properties!.data.page).toEqual(commonSignalData.page)
 })
 
@@ -155,8 +155,7 @@ test('navigation signals', async ({ page }) => {
     expect(ev.properties).toMatchObject({
       type: 'navigation',
       data: {
-        action: 'pageLoad',
-        url: indexPage.url,
+        currentUrl: indexPage.url,
         path: expect.any(String),
         hash: '',
         search: '',
@@ -178,9 +177,8 @@ test('navigation signals', async ({ page }) => {
       index: expect.any(Number),
       type: 'navigation',
       data: {
-        action: 'urlChange',
-        url: indexPage.url + '#foo',
-        prevUrl: indexPage.url,
+        currentUrl: indexPage.url + '#foo',
+        previousUrl: indexPage.url,
         path: expect.any(String),
         hash: '#foo',
         search: '',

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

@@ -25,10 +25,10 @@ test('network signals allow and disallow list', async ({ page }) => {
   )
   expect(allowedRequestsAndResponses).toHaveLength(2)
   const [request, response] = allowedRequestsAndResponses
-  expect(request.properties!.data.data).toEqual({
+  expect(request.properties!.data.body).toEqual({
     foo: 'bar',
   })
-  expect(response.properties!.data.data).toEqual({
+  expect(response.properties!.data.body).toEqual({
     someResponse: 'yep',
   })
 

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

@@ -4,6 +4,8 @@ import { IndexPage } from './index-page'
 
 const basicEdgeFn = `globalThis.processSignal = (signal) => {}`
 
+const NON_EMPTY_STRING = expect.stringMatching(/.+/)
+
 test.describe('network signals - fetch', () => {
   let indexPage: IndexPage
 
@@ -30,7 +32,6 @@ test.describe('network signals - fetch', () => {
     expect(requests[0].properties!.data).toMatchObject({
       action: 'request',
       contentType: 'multipart/form-data',
-      data: null,
       method: 'POST',
       url: 'http://localhost/upload',
       ...commonSignalData,
@@ -62,7 +63,7 @@ test.describe('network signals - fetch', () => {
     expect(requests[0].properties!.data).toMatchObject({
       action: 'request',
       url: 'http://localhost/test',
-      data: { key: 'value' },
+      body: { key: 'value' },
       ...commonSignalData,
     })
   })
@@ -92,7 +93,7 @@ test.describe('network signals - fetch', () => {
     expect(requests[0].properties!.data).toMatchObject({
       action: 'request',
       url: 'http://localhost/test',
-      data: 'hello world',
+      body: 'hello world',
       ...commonSignalData,
     })
   })
@@ -123,28 +124,34 @@ test.describe('network signals - fetch', () => {
       (el) => el.properties!.data.action === 'request'
     )
     expect(requests).toHaveLength(1)
-    expect(requests[0].properties!.data).toEqual({
+    const requestData = requests[0].properties!.data
+    expect(requestData).toMatchObject({
       action: 'request',
       contentType: 'application/json',
       url: 'http://localhost/test',
       method: 'POST',
-      data: { key: 'value' },
+      body: { key: 'value' },
+      requestId: NON_EMPTY_STRING,
       ...commonSignalData,
     })
+    const requestId = requestData.requestId
 
     const responses = networkEvents.filter(
       (el) => el.properties!.data.action === 'response'
     )
     expect(responses).toHaveLength(1)
-    expect(responses[0].properties!.data).toEqual({
+    const responseData = responses[0].properties!.data
+    expect(responseData).toMatchObject({
       action: 'response',
       contentType: 'application/json',
       url: 'http://localhost/test',
-      data: { foo: 'test' },
+      body: { foo: 'test' },
       status: 200,
       ok: true,
+      requestId: NON_EMPTY_STRING,
       ...commonSignalData,
     })
+    expect(responseData.requestId).toEqual(requestId)
   })
 
   test('can handle relative url paths', async () => {
@@ -171,7 +178,7 @@ test.describe('network signals - fetch', () => {
     expect(requests[0].properties!.data).toMatchObject({
       action: 'request',
       url: `${indexPage.origin()}/test`,
-      data: { key: 'value' },
+      body: { key: 'value' },
       ...commonSignalData,
     })
 
@@ -182,7 +189,7 @@ test.describe('network signals - fetch', () => {
     expect(responses[0].properties!.data).toMatchObject({
       action: 'response',
       url: `${indexPage.origin()}/test`,
-      data: { foo: 'test' },
+      body: { foo: 'test' },
       ...commonSignalData,
     })
   })
@@ -220,7 +227,7 @@ test.describe('network signals - fetch', () => {
       expect(responses[0].properties!.data).toMatchObject({
         action: 'response',
         url: 'http://localhost/test',
-        data: { errorMsg: 'foo' },
+        body: { errorMsg: 'foo' },
         status: 400,
         ok: false,
         page: expect.any(Object),
@@ -260,7 +267,7 @@ test.describe('network signals - fetch', () => {
       expect(responses[0].properties!.data).toMatchObject({
         action: 'response',
         url: 'http://localhost/test',
-        data: 'foo',
+        body: 'foo',
         status: 400,
         ok: false,
         ...commonSignalData,

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

@@ -34,7 +34,7 @@ test.describe('network signals - XHR', () => {
     expect(requests[0].properties!.data).toMatchObject({
       action: 'request',
       url: 'http://localhost/test',
-      data: { key: 'value' },
+      body: { key: 'value' },
     })
 
     // Check the response
@@ -45,7 +45,7 @@ test.describe('network signals - XHR', () => {
     expect(responses[0].properties!.data).toMatchObject({
       action: 'response',
       url: 'http://localhost/test',
-      data: { foo: 'test' },
+      body: { foo: 'test' },
     })
   })
 
@@ -74,7 +74,7 @@ test.describe('network signals - XHR', () => {
     expect(requests[0].properties!.data).toMatchObject({
       action: 'request',
       url: `${indexPage.origin()}/test`,
-      data: { key: 'value' },
+      body: { key: 'value' },
     })
 
     // Check the response
@@ -85,7 +85,7 @@ test.describe('network signals - XHR', () => {
     expect(responses[0].properties!.data).toMatchObject({
       action: 'response',
       url: `${indexPage.origin()}/test`,
-      data: { foo: 'test' },
+      body: { foo: 'test' },
     })
   })
 
@@ -114,7 +114,7 @@ test.describe('network signals - XHR', () => {
     expect(requests[0].properties!.data).toMatchObject({
       action: 'request',
       url: 'http://localhost/test',
-      data: 'hello world',
+      body: 'hello world',
     })
 
     // Check the response
@@ -125,7 +125,7 @@ test.describe('network signals - XHR', () => {
     expect(responses[0].properties!.data).toMatchObject({
       action: 'response',
       url: 'http://localhost/test',
-      data: { foo: 'test' },
+      body: { foo: 'test' },
     })
   })
 
@@ -153,7 +153,7 @@ test.describe('network signals - XHR', () => {
     expect(responses[0].properties!.data).toMatchObject({
       action: 'response',
       url: 'http://localhost/test',
-      data: { hello: 'world' },
+      body: { hello: 'world' },
     })
   })
 
@@ -200,15 +200,15 @@ test.describe('network signals - XHR', () => {
     expect(request1.properties!.data).toMatchObject({
       action: 'request',
       url: req1URL,
-      data: { req1: 'value' },
+      body: { req1: 'value' },
     })
 
     const request2 = requests.find((u) => u.properties!.data.url === req2URL)!
     expect(request2).toBeDefined()
     expect(request2.properties!.data).toMatchObject({
       action: 'request',
       url: req2URL,
-      data: { req2: 'value' },
+      body: { req2: 'value' },
     })
   })
 
@@ -246,7 +246,7 @@ test.describe('network signals - XHR', () => {
       expect(responses[0].properties!.data).toMatchObject({
         action: 'response',
         url: 'http://localhost/test',
-        data: { errorMsg: 'foo' },
+        body: { errorMsg: 'foo' },
       })
       expect(responses).toHaveLength(1)
     })
@@ -284,7 +284,7 @@ test.describe('network signals - XHR', () => {
       expect(responses[0].properties!.data).toMatchObject({
         action: 'response',
         url: 'http://localhost/test',
-        data: 'foo',
+        body: 'foo',
       })
       expect(responses).toHaveLength(1)
     })
@@ -325,7 +325,7 @@ test.describe('network signals - XHR', () => {
       expect(responses[0].properties!.data).toMatchObject({
         action: 'response',
         url: 'http://localhost/test',
-        data: null,
+        body: null,
       })
       expect(responses).toHaveLength(1)
     })