update tests

Author: silesky

.buildkite/pipeline.yml

@@ -84,6 +84,7 @@ steps:
       - yarn install --immutable
       - echo "+++ Run Browser integration tests :pray:"
       - yarn turbo run --filter=@internal/browser-integration-tests test:int
+      - yarn turbo run --filter=@internal/browser-integration-tests test:int
     retry:
       automatic:
         - exit_status: '*'

packages/signals/signals-integration-tests/package.json

@@ -8,10 +8,11 @@
   "scripts": {
     ".": "yarn run -T turbo run --filter=@internal/signals-integration-tests...",
     "build": "webpack",
-    "test:int": "playwright test",
+    "test:int": "playwright test && yarn test:global-sandbox",
     "test:vanilla": "playwright test src/tests/signals-vanilla",
     "test:perf": "playwright test src/tests/performance",
     "test:custom": "playwright test src/tests/custom",
+    "test:global-sandbox": "SANDBOX_STRATEGY=global yarn test:vanilla && SANDBOX_STRATEGY=global yarn test:custom",
     "watch": "webpack -w",
     "lint": "yarn concurrently 'yarn:eslint .' 'yarn:tsc --noEmit'",
     "concurrently": "yarn run -T concurrently",

packages/signals/signals-integration-tests/playwright.global-setup.ts

@@ -1,8 +1,10 @@
 import type { FullConfig } from '@playwright/test'
 import { execSync } from 'child_process'
+import { envConfig } from './src/helpers/env-config'
 
 export default function globalSetup(_cfg: FullConfig) {
-  console.log('Executing global setup...')
+  console.log(`Executing playwright.global-setup.ts...\n`)
+  console.log(`Using envConfig: ${JSON.stringify(envConfig, undefined, 2)}\n`)
   execSync('yarn build', { stdio: 'inherit' })
-  console.log('Finished global setup.')
+  console.log('Finished global setup.\n')
 }

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

@@ -7,6 +7,7 @@ import {
   SignalAPIRequestBuffer,
   TrackingAPIRequestBuffer,
 } from './network-utils'
+import { envConfig } from './env-config'
 
 export class BasePage {
   protected page!: Page
@@ -63,6 +64,7 @@ export class BasePage {
     await this.page.goto(url, { waitUntil: 'domcontentloaded' })
     if (!options.skipSignalsPluginInit) {
       void this.invokeAnalyticsLoad({
+        sandboxStrategy: envConfig.SANDBOX_STRATEGY ?? 'iframe',
         flushInterval: 500,
         ...signalSettings,
       })

packages/signals/signals-integration-tests/src/helpers/env-config.ts

@@ -0,0 +1,11 @@
+import { SignalsSettingsConfig } from '@segment/analytics-signals/dist/types/core/signals'
+
+// This is for testing with the global sandbox strategy with an npm script, that executes processSignal in the global scope
+// If we change this to be the default, this can be rejiggered
+const SANDBOX_STRATEGY = process.env.SANDBOX_STRATEGY as
+  | SignalsSettingsConfig['sandboxStrategy']
+  | undefined
+
+export const envConfig = {
+  SANDBOX_STRATEGY,
+}

packages/signals/signals-integration-tests/src/tests/custom-elements/custom-select.test.ts

@@ -3,7 +3,7 @@ import { waitForCondition } from '../../helpers/playwright-utils'
 import { IndexPage } from './index-page'
 import type { SegmentEvent } from '@segment/analytics-next'
 
-const basicEdgeFn = `const processSignal = (signal) => {}`
+const basicEdgeFn = `globalThis.processSignal = (signal) => {}`
 
 test('Collecting signals whenever a user selects an item', async ({ page }) => {
   const indexPage = await new IndexPage().loadAndWait(page, basicEdgeFn, {

packages/signals/signals-integration-tests/src/tests/custom-elements/custom-textfield.test.ts

@@ -2,7 +2,7 @@ import { test, expect } from '@playwright/test'
 import { waitForCondition } from '../../helpers/playwright-utils'
 import { IndexPage } from './index-page'
 
-const basicEdgeFn = `const processSignal = (signal) => {}`
+const basicEdgeFn = `globalThis.processSignal = (signal) => {}`
 
 test('Collecting signals whenever a user enters text input and focuses out', async ({
   page,

packages/signals/signals-integration-tests/src/tests/performance/memory-leak.test.ts

@@ -16,7 +16,7 @@ declare global {
 
 const basicEdgeFn = `
     // this is a process signal function
-    const processSignal = (signal) => {
+    globalThis.processSignal = (signal) => {
       if (signal.type === 'interaction') {
         const eventName = signal.data.eventType + ' ' + '[' + signal.type + ']'
         analytics.track(eventName, signal.data)

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

@@ -37,7 +37,7 @@ const snapshot = (
 test('Segment events', async ({ page }) => {
   const basicEdgeFn = `
     // this is a process signal function
-    const processSignal = (signal) => {
+    globalThis.processSignal = (signal) => {
       if (signal.type === 'interaction' && signal.data.eventType === 'click') {
         analytics.identify('john', { found: true })
         analytics.group('foo', { hello: 'world' })
@@ -65,7 +65,7 @@ test('Should dispatch events from signals that occurred before analytics was ins
   page,
 }) => {
   const edgeFn = `
-    const processSignal = (signal) => {
+    globalThis.processSignal = (signal) => {
        if (signal.type === 'navigation' && signal.data.action === 'pageLoad') {
           analytics.page('dispatched from signals - navigation')
       }

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

@@ -4,7 +4,7 @@ import { IndexPage } from './index-page'
 
 const basicEdgeFn = `
     // this is a process signal function
-    const processSignal = (signal) => {
+    globalThis.processSignal = (signal) => {
       if (signal.type === 'interaction') {
         const eventName = signal.data.eventType + ' ' + '[' + signal.type + ']'
         analytics.track(eventName, signal.data)