Make default iframe sandbox only require :blob csp permission

.changeset/early-comics-add.md

@@ -0,0 +1,5 @@
+---
+'@segment/analytics-signals-runtime': minor
+---
+
+Update ProcessSignal type for experimental "constants" object

.changeset/three-oranges-work.md

@@ -0,0 +1,5 @@
+---
+'@segment/analytics-signals': minor
+---
+
+Update iframe sandbox so CSP only requires :blob permission

packages/signals/signals-example/src/lib/analytics.ts

@@ -2,7 +2,11 @@
 // You only want to instantiate SignalsPlugin in a browser context, otherwise you'll get an error.
 
 import { AnalyticsBrowser } from '@segment/analytics-next'
-import { SignalsPlugin, ProcessSignal } from '@segment/analytics-signals'
+import {
+  SignalsPlugin,
+  SignalsPluginSettingsConfig,
+  ProcessSignal,
+} from '@segment/analytics-signals'
 
 export const analytics = new AnalyticsBrowser()
 if (!process.env.WRITEKEY) {
@@ -29,11 +33,20 @@ const processSignalExample: ProcessSignal = (
   }
 }
 
+const getQueryParams = () => {
+  const params = new URLSearchParams()
+  const sandboxStrategy = params.get('sandboxStrategy')
+  return {
+    sandboxStrategy:
+      sandboxStrategy as SignalsPluginSettingsConfig['sandboxStrategy'],
+  }
+}
 const isStage = process.env.STAGE === 'true'
 
+const queryParams = getQueryParams()
 const signalsPlugin = new SignalsPlugin({
   ...(isStage ? { apiHost: 'signals.segment.build/v1' } : {}),
-  sandboxStrategy: 'global',
+  sandboxStrategy: queryParams.sandboxStrategy ?? 'iframe',
   // processSignal: processSignalExample,
 })
 

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 = `globalThis.processSignal = (signal) => {}`
+const basicEdgeFn = `function 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 = `globalThis.processSignal = (signal) => {}`
+const basicEdgeFn = `function 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
-    globalThis.processSignal = (signal) => {
+    function 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

@@ -6,7 +6,6 @@ import { SegmentEvent } from '@segment/analytics-next'
 /**
  * This test ensures that
  */
-const indexPage = new IndexPage()
 
 const normalizeSnapshotEvent = (el: SegmentEvent) => {
   return {
@@ -35,9 +34,10 @@ const snapshot = (
 ).map(normalizeSnapshotEvent)
 
 test('Segment events', async ({ page }) => {
+  const indexPage = new IndexPage()
   const basicEdgeFn = `
     // this is a process signal function
-    globalThis.processSignal = (signal) => {
+    function processSignal(signal) {
       if (signal.type === 'interaction' && signal.data.eventType === 'click') {
         analytics.identify('john', { found: true })
         analytics.group('foo', { hello: 'world' })
@@ -64,8 +64,9 @@ test('Segment events', async ({ page }) => {
 test('Should dispatch events from signals that occurred before analytics was instantiated', async ({
   page,
 }) => {
+  const indexPage = new IndexPage()
   const edgeFn = `
-    globalThis.processSignal = (signal) => {
+    function processSignal(signal) {
        if (signal.type === 'navigation' && signal.data.action === 'pageLoad') {
           analytics.page('dispatched from signals - navigation')
       }
@@ -76,23 +77,25 @@ test('Should dispatch events from signals that occurred before analytics was ins
 
   await indexPage.load(page, edgeFn)
   const flush = Promise.all([
+    indexPage.addUserDefinedSignal(),
     indexPage.waitForSignalsApiFlush(),
     indexPage.waitForTrackingApiFlush(),
   ])
 
-  // add a user defined signal before analytics is instantiated
-  void indexPage.addUserDefinedSignal()
   await flush
 
   const trackingApiReqs = indexPage.trackingAPI.getEvents()
   expect(trackingApiReqs).toHaveLength(2)
 
   const pageEvents = trackingApiReqs.find((el) => el.type === 'page')!
+
   expect(pageEvents).toBeTruthy()
   expect(pageEvents.name).toEqual('dispatched from signals - navigation')
 
   const userDefinedEvents = trackingApiReqs.find((el) => el.type === 'track')!
-  expect(userDefinedEvents).toBeTruthy()
+  if (!userDefinedEvents) {
+    console.warn('invariant', trackingApiReqs)
+  }
   expect(userDefinedEvents.event).toEqual(
     'dispatched from signals - userDefined'
   )

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
-    globalThis.processSignal = (signal) => {
+    function 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/button-click-complex.test.ts

@@ -1,7 +1,7 @@
 import { test, expect } from '@playwright/test'
 import { IndexPage } from './index-page'
 
-const basicEdgeFn = `globalThis.processSignal = (signal) => {}`
+const basicEdgeFn = `function processSignal(signal) {}`
 let indexPage: IndexPage
 test.beforeEach(async ({ page }) => {
   indexPage = await new IndexPage().loadAndWait(page, basicEdgeFn)

packages/signals/signals-integration-tests/src/tests/signals-vanilla/change-input.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 = `globalThis.processSignal = (signal) => {}`
+const basicEdgeFn = `function processSignal(signal) {}`
 
 test('Collecting signals whenever a user enters text input', async ({
   page,

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

@@ -1,7 +1,7 @@
 import { test, expect } from '@playwright/test'
 import { IndexPage } from './index-page'
 
-const basicEdgeFn = `globalThis.processSignal = (signal) => {}`
+const basicEdgeFn = `function processSignal(signal) {}`
 
 let indexPage: IndexPage
 

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

@@ -1,7 +1,7 @@
 import { test, expect } from '@playwright/test'
 import { IndexPage } from './index-page'
 
-const basicEdgeFn = `globalThis.processSignal = (signal) => {}`
+const basicEdgeFn = `function processSignal(signal) {}`
 
 test('network signals allow and disallow list', async ({ page }) => {
   const indexPage = await new IndexPage().loadAndWait(page, basicEdgeFn, {

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

@@ -2,7 +2,7 @@ import { test, expect } from '@playwright/test'
 import { commonSignalData } from '../../helpers/fixtures'
 import { IndexPage } from './index-page'
 
-const basicEdgeFn = `globalThis.processSignal = (signal) => {}`
+const basicEdgeFn = `function processSignal(signal) {}`
 
 test.describe('network signals - fetch', () => {
   let indexPage: IndexPage

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

@@ -1,7 +1,7 @@
 import { test, expect } from '@playwright/test'
 import { IndexPage } from './index-page'
 
-const basicEdgeFn = `globalThis.processSignal = (signal) => {}`
+const basicEdgeFn = `function processSignal(signal) {}`
 
 test.describe('network signals - XHR', () => {
   let indexPage: IndexPage

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

@@ -7,7 +7,7 @@ import { pTimeout } from '@segment/analytics-core'
  * If a signal is generated, the signal buffer should be reset
  * when the user clicks on the complex button.
  */
-const edgeFn = `globalThis.processSignal = (signal) => {
+const edgeFn = `function processSignal(signal) {
   // create a custom signal to echo out the current signal buffer
   if (signal.type === 'userDefined') {
     analytics.track('current signal buffer', { signalBuffer: signals.signalBuffer })

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

@@ -2,7 +2,7 @@ import { test, expect } from '@playwright/test'
 import { IndexPage } from './index-page'
 
 const basicEdgeFn = `
-    globalThis.processSignal = (signal) => {
+    function processSignal(signal) {
       // test that constants are properly injected
       if (typeof EventType !== 'object') {
         throw new Error('EventType is missing?')

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

@@ -4,7 +4,7 @@ import { IndexPage } from './index-page'
 const indexPage = new IndexPage()
 
 test('should find the most recent signal', async ({ page }) => {
-  const basicEdgeFn = `globalThis.processSignal = (signal) => {
+  const basicEdgeFn = `function processSignal(signal) {
   if (signal.type === 'interaction' && signal.data.target.id === 'complex-button') {
     const mostRecentSignal = signals.find(signal, 'userDefined')
     if (mostRecentSignal.data.num === 2) {

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

@@ -4,7 +4,7 @@ import { waitForCondition } from '../../helpers/playwright-utils'
 
 const indexPage = new IndexPage()
 
-const basicEdgeFn = `globalThis.processSignal = (signal) => {}`
+const basicEdgeFn = `function processSignal(signal) {}`
 
 test('debug ingestion disabled and sample rate 0 -> will not send the signal', async ({
   page,

packages/signals/signals-integration-tests/src/tests/signals-vanilla/signals-redaction.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 = `globalThis.processSignal = (signal) => {}`
+const basicEdgeFn = `function processSignal(signal) {}`
 
 test('redaction enabled -> will XXX the value of text input', async ({
   page,

packages/signals/signals-integration-tests/src/tests/signals-vanilla/top-level-metadata.test.ts

@@ -4,7 +4,7 @@ import { IndexPage } from './index-page'
 
 const basicEdgeFn = `
     // this is a process signal function
-    globalThis.processSignal = (signal) => {
+    function processSignal(signal) {
       if (signal.type === 'interaction') {
         analytics.track('hello', { myAnonId: signal.anonymousId, myTimestamp: signal.timestamp })
       } 

packages/signals/signals-runtime/package.json

@@ -25,7 +25,6 @@
     "build:esm": "yarn tsc -p tsconfig.build.json",
     "build:cjs": "yarn tsc -p tsconfig.build.json --outDir ./dist/cjs --module commonjs",
     "build:global": "node build-signals-runtime-global.js",
-    "assert-generated": "bash scripts/assert-generated.sh",
     "watch": "rm -rf dist/esm && yarn build:esm && yarn build:esm --watch",
     "watch:test": "yarn test --watch",
     "tsc": "yarn run -T tsc",

packages/signals/signals/.lintstagedrc.js

@@ -1,5 +1,3 @@
-module.exports = {
-  ...require("@internal/config").lintStagedConfig,
-  'src/lib/workerbox/*.{js,ts,html}': ['yarn workerbox']
-}
+module.exports = require("@internal/config").lintStagedConfig
+
 

packages/signals/signals/package.json

@@ -32,8 +32,6 @@
     "build:esm": "yarn tsc -p tsconfig.build.json",
     "build:cjs": "yarn tsc -p tsconfig.build.json --outDir ./dist/cjs --module commonjs",
     "build:bundle": "NODE_ENV=production yarn run webpack",
-    "workerbox": "node scripts/build-workerbox.js",
-    "assert-generated": "sh scripts/assert-workerbox-built.sh",
     "watch": "rm -rf dist && yarn concurrently 'yarn build:bundle --watch' 'yarn build:esm --watch'",
     "version": "sh scripts/version.sh",
     "watch:test": "yarn test --watch",