✅ Add Salesforce E2E tests (#4761)

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: BeltranBulbarellaDD

.env.example

@@ -1,3 +1,9 @@
 # BROWSERSTACK CREDENTIALS
 BS_USERNAME=xxx
 BS_ACCESS_KEY=xxx
+
+# Salesforce credentials
+SF_LWC_CLIENT_ID=xxx
+SF_LWC_USERNAME=xxx
+SF_LWC_INSTANCE_URL=xxx
+SF_LWC_JWT_PRIVATE_KEY_B64=xxx

package.json

@@ -15,6 +15,8 @@
     "build": "yarn workspaces foreach --all --parallel --topological-dev run build",
     "build:bundle": "yarn workspaces foreach --all --parallel run build:bundle",
     "build:apps": "node scripts/build/build-test-apps.ts",
+    "salesforce:deploy-app": "yarn workspace @datadog/browser-rum-slim build:bundle && node --env-file-if-exists=.env scripts/salesforce-lwc-app.ts deploy-app",
+    "salesforce:get-url": "node --env-file-if-exists=.env scripts/salesforce-lwc-app.ts get-url",
     "build:docs:json": "typedoc --logLevel Verbose --json ./generated-docs.json",
     "build:docs:html": "typedoc --out ./generated-docs",
     "serve:docs": "yarn build:docs:html && npx http-server ./generated-docs -p 8080 -o",

scripts/build/build-test-apps.ts

@@ -35,6 +35,7 @@ const APPS: AppConfig[] = [
   { name: 'vue-router-app' },
   { name: 'nuxt-app' },
   { name: 'instrumentation-overhead' },
+  { name: 'sf-lwc-app', builderFn: buildSalesforceLwcApp },
 
   // React Router apps
   { name: 'react-router-app' },
@@ -161,6 +162,14 @@ async function buildApp(appName: string) {
   }
 }
 
+function buildSalesforceLwcApp() {
+  const sourceBundle = 'packages/browser-rum-slim/bundle/datadog-rum-slim.js'
+  const targetBundle = 'test/apps/sf-lwc-app/force-app/main/default/staticresources/datadog_rum_slim.js'
+
+  printLog('Building app at test/apps/sf-lwc-app...')
+  fs.copyFileSync(sourceBundle, targetBundle)
+}
+
 async function buildReactRouterV6App() {
   await buildGeneratedApp('react-router-app', 'react-router-v6-app', async (appPath) => {
     await modifyFile(path.join(appPath, 'package.json'), (content: string) =>

scripts/lib/secrets.ts

@@ -88,6 +88,22 @@ export function getBrowserStackAccessKey(): string {
   return getSecretKey('ci.browser-sdk.bs_access_key')
 }
 
+export function getSfLwcClientId(): string {
+  return process.env.SF_LWC_CLIENT_ID ?? getSecretKey('ci.browser-sdk.sf_lwc_client_id')
+}
+
+export function getSfLwcUsername(): string {
+  return process.env.SF_LWC_USERNAME ?? getSecretKey('ci.browser-sdk.sf_lwc_username')
+}
+
+export function getSfLwcInstanceUrl(): string {
+  return process.env.SF_LWC_INSTANCE_URL ?? getSecretKey('ci.browser-sdk.sf_lwc_instance_url')
+}
+
+export function getSfLwcJwtPrivateKey(): string {
+  return process.env.SF_LWC_JWT_PRIVATE_KEY_B64 ?? getSecretKey('ci.browser-sdk.sf_lwc_jwt_private_key_b64')
+}
+
 function getSecretKey(name: string): string {
   return command`
     aws ssm get-parameter --region=us-east-1 --with-decryption --query=Parameter.Value --out=text --name=${name}

scripts/salesforce-lwc-app.ts

@@ -0,0 +1,98 @@
+import { chmodSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs'
+import { dirname, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { tmpdir } from 'node:os'
+import { parseArgs } from 'node:util'
+
+import { printLog, runMain } from './lib/executionUtils.ts'
+import { getSfLwcClientId, getSfLwcInstanceUrl, getSfLwcJwtPrivateKey, getSfLwcUsername } from './lib/secrets.ts'
+import { command } from './lib/command.ts'
+
+const repositoryRoot = resolve(dirname(fileURLToPath(import.meta.url)), '..')
+const salesforceAppDir = resolve(repositoryRoot, 'test/apps/sf-lwc-app')
+const SALESFORCE_HOME_PATH = '/lightning/app/c__SF_LWC_App/page/home'
+const TARGET_ORG = 'sf-lwc-ci'
+
+runMain(() => {
+  const { values, positionals } = parseArgs({
+    allowPositionals: true,
+    options: {
+      help: {
+        type: 'boolean',
+        short: 'h',
+      },
+    },
+  })
+
+  if (values.help) {
+    showUsageAndExit()
+  }
+
+  if (positionals.length !== 1) {
+    throw new Error('Usage: node scripts/salesforce-lwc-app.ts <deploy-app|get-url>')
+  }
+
+  const commandName = positionals[0]
+
+  switch (commandName) {
+    // Deploy the app to the Salesforce org. To be done only when the app is updated.
+    case 'deploy-app':
+      deployApp()
+      break
+    // Get the authenticated URL of the app.
+    case 'get-url':
+      printSalesforceLwcUrl()
+      break
+    default:
+      throw new Error(`Unknown command "${commandName ?? ''}". Expected: deploy-app|get-url`)
+  }
+})
+
+function showUsageAndExit() {
+  console.log('Usage: node scripts/salesforce-lwc-app.ts <deploy-app|get-url>')
+  process.exit(0)
+}
+
+function authenticate(targetOrg: string) {
+  // Temporary directory holding the JWT private key for the duration of authentication.
+  // Using a unique temp dir avoids collisions when multiple CI jobs run in parallel.
+  const keyDirectory = mkdtempSync(resolve(tmpdir(), 'sf-lwc-jwt-'))
+  const serverKeyPath = resolve(keyDirectory, 'server.key')
+
+  try {
+    writeFileSync(serverKeyPath, Buffer.from(getSfLwcJwtPrivateKey(), 'base64').toString('utf8'), { mode: 0o600 })
+    // writeFileSync mode can be masked by the process umask; chmodSync guarantees owner-only access.
+    chmodSync(serverKeyPath, 0o600)
+
+    printLog(`Authenticating Salesforce CLI alias ${targetOrg}...`)
+    command`sf org login jwt --client-id ${getSfLwcClientId()} --jwt-key-file ${serverKeyPath} --username ${getSfLwcUsername()} --instance-url ${getSfLwcInstanceUrl()} --alias ${targetOrg}`
+      .withCurrentWorkingDirectory(salesforceAppDir)
+      .withLogs()
+      .run()
+    printLog(`Salesforce CLI authenticated as ${targetOrg}.`)
+  } finally {
+    rmSync(keyDirectory, { recursive: true, force: true })
+  }
+}
+
+function deployApp() {
+  authenticate(TARGET_ORG)
+
+  printLog(`Deploying Salesforce LWC app to ${TARGET_ORG}...`)
+  command`sf project deploy start --target-org ${TARGET_ORG} --source-dir force-app --ignore-conflicts --concise`
+    .withCurrentWorkingDirectory(salesforceAppDir)
+    .withLogs()
+    .run()
+  printLog('Salesforce LWC app deployed.')
+}
+
+function printSalesforceLwcUrl(): void {
+  const path = new URL(SALESFORCE_HOME_PATH, 'https://salesforce.local')
+
+  authenticate(TARGET_ORG)
+
+  command`sf org open --target-org ${TARGET_ORG} --path ${path.pathname}${path.search} --url-only`
+    .withCurrentWorkingDirectory(salesforceAppDir)
+    .withLogs()
+    .run()
+}

test/apps/sf-lwc-app/.gitignore

@@ -1,3 +1,3 @@
 .sf
 .sfdx
-/force-app/main/default/staticresources/datadog_rum_slim.js
+/force-app/main/default/staticresources/datadog_rum_slim.js

test/apps/sf-lwc-app/README.md

@@ -11,14 +11,59 @@ This app is Lightning-only.
 - A `Product Explorer` app page with three hardcoded editable products
 - `c:datadogInit` in the utility bar, backed by the `datadog_rum_slim` static resource
 
-## Deploy
+## Authentication
 
-From this directory:
+The Salesforce flow uses the Salesforce CLI with a JWT keypair. There is no separate manual auth step: `yarn salesforce:deploy-app` and `yarn salesforce:get-url` always (re-)authenticate the `sf-lwc-ci` alias before running, since the JWT private key file used for authentication is deleted right after login and can't be reused to refresh a cached session.
+
+Credentials are set as CI variables.
+
+For local overrides, set the matching environment variables from `.env.example`:
+
+## Initial App Deploy
+
+This app runs from Salesforce metadata already deployed to
+the Salesforce org, so any change to that metadata (Apex, LWC markup/config, permission sets, etc.) requires a full
+redeploy to take effect.
+
+For E2E testing, deployment is not necesary since we will override the deployed rum_slim bundle with Playwright.
+
+```sh
+yarn salesforce:deploy-app
+```
+
+This builds the local RUM slim bundle, copies it to the stable `datadog_rum_slim` static resource, and deploys the app metadata.
+
+## Local Bundle
+
+Regular test runs do not deploy the current SDK bundle to Salesforce.
+Build the test apps from the repository root instead:
+
+```sh
+yarn build:apps --app sf-lwc-app
+```
+
+This copies the locally built RUM slim bundle into the ignored stable `datadog_rum_slim` static resource file.
+Playwright fulfills Salesforce static resource requests with this local file during E2E tests.
+
+## Open The App
+
+Print an authenticated URL for the app:
 
 ```sh
-yarn run setup -o engrumdev --ignore-conflicts
+yarn salesforce:get-url
 ```
 
-The setup script copies the local RUM slim bundle into the static resource, deploys the app, assigns the app permission set to the target user, and prints the app-specific Home URL.
+The printed URL is authenticated and should be treated as sensitive.
+E2E tests don't use this script: they build their own authenticated URL via the JWT/REST flow in
+`test/e2e/lib/framework/buildSalesforceLwcUrl.ts`, and inject the RUM configuration on the page as
+`window.RUM_CONFIGURATION`.
+
+## Run E2E Tests
 
-If prompted for a user. Log into 1Password and use `beltran.bulbarella@datadoghq.com.engrumdev`
+Build the SDK and test apps, then run the Salesforce scenario:
+
+```sh
+yarn build
+yarn build:apps --app sf-lwc-app
+yarn test:e2e --project=chromium --grep salesforce
+```

test/apps/sf-lwc-app/force-app/main/default/lwc/customActionButtons/customActionButtons.js

@@ -111,7 +111,7 @@ export default class CustomActionButtons extends LightningElement {
   }
 
   getResourceTestUrl(token) {
-    return `https://sample-json-api.com/products/1?${token}`
+    return `${window.location.origin}/services/data/?${token}`
   }
 
   getComposedPathNames(event) {

test/apps/sf-lwc-app/force-app/main/default/lwc/datadogInit/datadogInit.js

@@ -6,30 +6,10 @@ import { loadScript } from 'lightning/platformResourceLoader'
 let datadogInitialization
 let lastStartedUrl
 
-const DATADOG_PARAMS = ['c__applicationId', 'c__clientToken', 'c__env', 'c__service', 'c__site']
-
-const cleanUrl = (url) => {
-  const cleanUrl = new URL(url, window.location.origin)
-  DATADOG_PARAMS.forEach((param) => cleanUrl.searchParams.delete(param))
-  return cleanUrl.href
-}
-
-const defaultDatadogRumConfig = {
-  trackViewsManually: true,
-  trackEarlyRequests: true,
-  trackLongTasks: true,
-  trackResources: true,
-  trackUserInteractions: true,
-  beforeSend: (event) => {
-    if (event.view) {
-      const sanitizedViewUrl = new URL(cleanUrl(event.view.url))
-      event.view.url = sanitizedViewUrl.href
-      event.view.name = sanitizedViewUrl.pathname + sanitizedViewUrl.search + sanitizedViewUrl.hash
-    }
-    if (event.resource?.url) {
-      event.resource.url = cleanUrl(event.resource.url)
-    }
-  },
+const defaultInitConfiguration = {
+  applicationId: 'xxx',
+  clientToken: 'xxx',
+  site: 'datadoghq.com',
 }
 
 export default class DatadogInit extends NavigationMixin(LightningElement) {
@@ -70,23 +50,8 @@ export default class DatadogInit extends NavigationMixin(LightningElement) {
 
   loadDatadogRum() {
     return loadScript(this, datadogRumSlim).then(() => {
-      const searchParams = new URLSearchParams(window.location.search)
-      const applicationId = searchParams.get('c__applicationId')
-      const clientToken = searchParams.get('c__clientToken')
-
-      if (!applicationId || !clientToken) {
-        window.console.warn('Datadog RUM not initialized: missing c__applicationId or c__clientToken')
-        return
-      }
-
-      window.DD_RUM.init({
-        applicationId,
-        clientToken,
-        env: searchParams.get('c__env'),
-        service: searchParams.get('c__service'),
-        site: searchParams.get('c__site'),
-        ...defaultDatadogRumConfig,
-      })
+      window.DD_RUM.setGlobalContext(window.RUM_CONTEXT)
+      window.DD_RUM.init({ ...defaultInitConfiguration, ...window.RUM_CONFIGURATION })
       lastStartedUrl = window.location.pathname + window.location.search + window.location.hash
       window.DD_RUM.startView({
         name: lastStartedUrl,

test/apps/sf-lwc-app/package.json

@@ -1,8 +1,5 @@
 {
   "name": "sf-lwc-app",
   "private": true,
-  "description": "Salesforce Lightning app for browser-sdk Salesforce testing",
-  "scripts": {
-    "setup": "node scripts/setup.mjs"
-  }
+  "description": "Salesforce Lightning app for browser-sdk Salesforce testing"
 }