💬 renaming suggestion

Author: bcaudan

test/e2e/lib/framework/createTest.ts

@@ -13,8 +13,8 @@ import { IntakeRegistry } from './intakeRegistry'
 import { flushEvents } from './flushEvents'
 import type { Servers } from './httpServers'
 import { getTestServers, waitForServersIdle } from './httpServers'
-import type { SetupFactory, SetupOptions, WorkerImplementationFactory } from './pageSetups'
-import { workerSetup, html, DEFAULT_SETUPS, npmSetup, reactSetup } from './pageSetups'
+import type { SetupFactory, SetupOptions, WorkerOptions } from './pageSetups'
+import { buildWorkerScript, html, DEFAULT_SETUPS, npmSetup, reactSetup } from './pageSetups'
 import { createIntakeServerApp } from './serverApps/intake'
 import { createMockServerApp } from './serverApps/mock'
 import type { Extension } from './createExtension'
@@ -59,7 +59,7 @@ class TestBuilder {
     logsConfiguration?: LogsInitConfiguration
   } = {}
   private hostName?: string
-  private workerImplementationFactory?: WorkerImplementationFactory
+  private workerOptions?: WorkerOptions
 
   constructor(private title: string) {}
 
@@ -131,15 +131,15 @@ class TestBuilder {
     return this
   }
 
-  withWorker(implementation: WorkerImplementationFactory['implementation'], options: RegistrationOptions = {}) {
-    this.workerImplementationFactory = { ...options, implementation }
+  withWorker(testCase: WorkerOptions['testCase'], registrationOptions: RegistrationOptions = {}) {
+    this.workerOptions = { ...registrationOptions, testCase }
 
     // Service workers require HTTPS or localhost due to browser security restrictions
     this.withHostName('localhost')
     this.withBody(html`
       <script>
         if (!window.myServiceWorker && 'serviceWorker' in navigator) {
-          navigator.serviceWorker.register('/sw.js', ${JSON.stringify(options)}).then((registration) => {
+          navigator.serviceWorker.register('/sw.js', ${JSON.stringify(registrationOptions)}).then((registration) => {
             window.myServiceWorker = registration
           })
         }
@@ -173,7 +173,7 @@ class TestBuilder {
       testFixture: this.testFixture,
       extension: this.extension,
       hostName: this.hostName,
-      workerImplementationFactory: this.workerImplementationFactory,
+      workerOptions: this.workerOptions,
     }
 
     if (this.alsoRunWithRumSlim) {
@@ -253,7 +253,7 @@ function declareTest(title: string, setupOptions: SetupOptions, factory: SetupFa
     servers.base.bindServerApp(
       createMockServerApp(servers, setup, {
         remoteConfiguration: setupOptions.remoteConfiguration,
-        workerImplementation: setupOptions.workerImplementationFactory && workerSetup(setupOptions, servers),
+        workerScript: buildWorkerScript(setupOptions, servers),
       })
     )
     servers.crossOrigin.bindServerApp(createMockServerApp(servers, setup))

test/e2e/lib/framework/pageSetups.ts

@@ -6,8 +6,8 @@ import { DEFAULT_LOGS_CONFIGURATION } from '../helpers/configuration'
 import { isBrowserStack, isContinuousIntegration } from './environment'
 import type { Servers } from './httpServers'
 
-export interface WorkerImplementationFactory extends RegistrationOptions {
-  implementation: (self: WorkerGlobalScope & { DD_LOGS?: DatadogLogs }) => void
+export interface WorkerOptions extends RegistrationOptions {
+  testCase: (self: WorkerGlobalScope & { DD_LOGS?: DatadogLogs }) => void
 }
 export interface SetupOptions {
   rum?: RumInitConfiguration
@@ -30,7 +30,7 @@ export interface SetupOptions {
     logsConfiguration?: LogsInitConfiguration
   }
   hostName?: string
-  workerImplementationFactory?: WorkerImplementationFactory
+  workerOptions?: WorkerOptions
 }
 
 export type SetupFactory = (options: SetupOptions, servers: Servers) => string
@@ -208,23 +208,23 @@ export function reactSetup(options: SetupOptions, servers: Servers, appName: str
   })
 }
 
-export function workerSetup(options: SetupOptions, servers: Servers) {
+export function buildWorkerScript(options: SetupOptions, servers: Servers) {
   let script = ''
 
-  if (!options.workerImplementationFactory) {
+  if (!options.workerOptions) {
     return script
   }
 
   if (options.logs) {
     script += js`
-      ${options.workerImplementationFactory.type === 'module' ? js`import '/datadog-logs.js';` : js`importScripts('/datadog-logs.js');`}
+      ${options.workerOptions.type === 'module' ? js`import '/datadog-logs.js';` : js`importScripts('/datadog-logs.js');`}
       
       // Initialize DD_LOGS in service worker
       DD_LOGS.init(${formatConfiguration({ ...DEFAULT_LOGS_CONFIGURATION, ...options.logs }, servers)})
     `
   }
 
-  script += `;(${options.workerImplementationFactory.implementation.toString()})(self);`
+  script += `;(${options.workerOptions.testCase.toString()})(self);`
 
   return script
 }

test/e2e/lib/framework/serverApps/mock.ts

@@ -11,12 +11,12 @@ export const LARGE_RESPONSE_MIN_BYTE_SIZE = 100_000
 
 interface MockServerOptions {
   remoteConfiguration?: RemoteConfiguration
-  workerImplementation?: string
+  workerScript?: string
 }
 export function createMockServerApp(
   servers: Servers,
   setup: string,
-  { remoteConfiguration, workerImplementation }: MockServerOptions = {}
+  { remoteConfiguration, workerScript }: MockServerOptions = {}
 ): MockServerApp {
   const app = express()
   let largeResponseBytesWritten = 0
@@ -49,7 +49,7 @@ export function createMockServerApp(
   })
 
   app.get('/sw.js', (_req, res) => {
-    res.contentType('application/javascript').send(workerImplementation)
+    res.contentType('application/javascript').send(workerScript)
   })
 
   function generateLargeResponse(res: ServerResponse, chunkText: string) {