wip

Author: silesky

packages/signals/signals-integration-tests/src/tests/signals-vanilla/runtime-constants.test.ts

@@ -0,0 +1,44 @@
+import { test, expect } from '@playwright/test'
+import { IndexPage } from './index-page'
+
+const basicEdgeFn = `
+    const processSignal = (signal) => {
+      // test that constants are properly injected
+      if (typeof EventType !== 'object') {
+        throw new Error('EventType is missing?')
+      }
+       if (typeof SignalType !== 'object') {
+         throw new Error('SignalType is missing?')
+      }
+      if (typeof NavigationAction !== 'object') {
+        throw new Error('NavigationAction is missing?')
+       }
+
+      if (signal.type === SignalType.Interaction) { 
+        const eventName = signal.data.eventType + ' ' + '[' + signal.type + ']'
+        analytics.track(eventName, signal.data)
+      }
+  }`
+
+let indexPage: IndexPage
+
+test.beforeEach(async ({ page }) => {
+  indexPage = await new IndexPage().loadAndWait(page, basicEdgeFn)
+})
+
+test('constants should be accessible in the runtime', async () => {
+  /**
+   * Make a button click, see if it:
+   * - creates an interaction signal that sends to the signals endpoint
+   * - creates an analytics event that sends to the tracking endpoint
+   */
+  await Promise.all([
+    indexPage.clickButton(),
+    indexPage.waitForTrackingApiFlush(),
+  ])
+
+  const analyticsReqJSON = indexPage.trackingAPI.lastEvent()
+  expect(analyticsReqJSON).toMatchObject({
+    event: 'click [interaction]',
+  })
+})

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

@@ -4,8 +4,8 @@ export { SignalsRuntime } from './shared/signals-runtime'
 // web
 export * from './web/web-signals-types'
 export * from './shared/shared-types'
-export * as WebConstants from './web/web-constants'
+export * as WebRuntimeConstants from './web/web-constants'
 
 // mobile
 export * as Mobile from './mobile/mobile-signals-types'
-export * as MobileConstants from './mobile/mobile-constants'
+export * as MobileRuntimeConstants from './mobile/mobile-constants'

packages/signals/signals/src/core/processor/sandbox.ts

@@ -6,7 +6,7 @@ import { replaceBaseUrl } from '../../lib/replace-base-url'
 import {
   SignalsRuntime,
   Signal,
-  WebConstants,
+  WebRuntimeConstants,
 } from '@segment/analytics-signals-runtime'
 
 export type MethodName =
@@ -211,7 +211,7 @@ export class Sandbox {
     const analytics = new AnalyticsRuntime()
     const scope = {
       analytics,
-      ...WebConstants,
+      ...WebRuntimeConstants,
     }
     logger.debug('processing signal', { signal, scope, signals })
     const code = [

packages/signals/signals/src/types/process-signal.ts

@@ -1,7 +1,7 @@
 import {
   ISignalsRuntime,
   Signal,
-  WebConstants,
+  WebRuntimeConstants,
 } from '@segment/analytics-signals-runtime'
 
 /**
@@ -19,7 +19,7 @@ export interface AnalyticsRuntimePublicApi {
 export type ProcessSignalScope = {
   analytics: AnalyticsRuntimePublicApi
   signals: ISignalsRuntime<Signal>
-} & typeof WebConstants
+} & typeof WebRuntimeConstants
 
 export interface ProcessSignal {
   (signal: Signal, ctx: ProcessSignalScope): void