Add headmarkup tests

Author: BeltranBulbarellaDD

test/e2e/lib/framework/buildSalesforceUrl.ts

@@ -7,10 +7,13 @@ import {
   getSfLwcUsername,
 } from '../../../../scripts/lib/secrets.ts'
 
-export type SalesforceApp = 'lwc' | 'experience-cloud'
+export type SalesforceApp = 'lwc' | 'experience-cloud' | 'experience-cloud-headmarkup'
 
 const salesforceHomePath = '/lightning/app/c__SF_LWC_App/page/home'
-const experienceSitePath = '/sfexperiencecloud/'
+const experienceSitePaths: Record<Exclude<SalesforceApp, 'lwc'>, string> = {
+  'experience-cloud': '/sfexperiencecloud/',
+  'experience-cloud-headmarkup': '/sfexperienceheadmarkup/',
+}
 
 let salesforceLwcSession: Promise<SalesforceLwcSession> | undefined
 
@@ -20,7 +23,7 @@ export interface SalesforceLwcSession {
 }
 
 export async function buildSalesforceUrl(app: SalesforceApp): Promise<string> {
-  return app === 'lwc' ? await buildSalesforceLwcUrl() : buildSalesforceExperienceUrl()
+  return app === 'lwc' ? await buildSalesforceLwcUrl() : buildSalesforceExperienceUrl(app)
 }
 
 export function getSalesforceLwcSession(): Promise<SalesforceLwcSession> {
@@ -93,13 +96,13 @@ async function getAccessToken(
 // Unlike the Lightning app, the Experience Cloud site is public, so we don't need to
 // authenticate or exchange a frontdoor token: we can derive the site URL directly from the
 // org's instance URL.
-function buildSalesforceExperienceUrl(): string {
+function buildSalesforceExperienceUrl(app: Exclude<SalesforceApp, 'lwc'>): string {
   const instanceUrl = getSfLwcInstanceUrl()
   if (!instanceUrl) {
     console.error('Salesforce credentials are not set')
     return ''
   }
 
   const siteDomain = instanceUrl.replace('.my.salesforce.com', '.my.site.com')
-  return `${siteDomain}${experienceSitePath}`
+  return `${siteDomain}${experienceSitePaths[app]}`
 }

test/e2e/lib/framework/pageSetups.ts

@@ -304,15 +304,23 @@ export function microfrontendSetup(options: SetupOptions, servers: Servers) {
   })
 }
 
+const salesforceAppDirectories: Record<SalesforceApp, string> = {
+  lwc: 'sf-lwc-app',
+  'experience-cloud': 'sf-experience-app',
+  'experience-cloud-headmarkup': 'sf-experience-headmarkup-app',
+}
+
 // Salesforce apps don't serve a locally-generated page body; this factory only drives the
 // page-side setup needed to init RUM on the remote Salesforce page.
 export async function salesforceSetup(options: SetupOptions, servers: Servers, page: Page): Promise<string> {
-  const salesforceAppDirectory = options.salesforceApp === 'experience-cloud' ? 'sf-experience-app' : 'sf-lwc-app'
+  if (!options.salesforceApp) {
+    throw new Error('Salesforce app is not set')
+  }
+  const salesforceAppDirectory = salesforceAppDirectories[options.salesforceApp]
   const salesforceBundlePath = resolve(
     __dirname,
     `../../../apps/${salesforceAppDirectory}/force-app/main/default/staticresources/datadog_rum_salesforce.js`
   )
-
   await page.route(/\/resource(?:\/[^/?#]+)?\/datadog_rum_salesforce(?:\.js)?(?:[/?#].*)?$/, async (route) => {
     await route.fulfill({
       body: await readFile(salesforceBundlePath),
@@ -332,9 +340,9 @@ export async function salesforceSetup(options: SetupOptions, servers: Servers, p
   }
 
   if (options.rum) {
-    // Both sf-lwc-app and sf-experience-app have a committed datadogInit LWC that reads
-    // these globals and calls DD_RUM.init. On experience-cloud, that component only runs
-    // when the page is loaded with init=true.
+    // The LWC and standard Experience Cloud apps have a committed datadogInit LWC that reads
+    // these globals and calls DD_RUM.init. The Head Markup site reads the same globals from its
+    // configured head markup instead.
     await page.addInitScript(
       `window.RUM_CONFIGURATION = ${formatConfiguration(options.rum, servers)}
       window.RUM_CONTEXT = ${JSON.stringify(options.context)}`

test/e2e/scenario/salesforce.scenario.ts

@@ -17,9 +17,11 @@ const baseSalesforceRumConfiguration = {
   trackUserInteractions: true,
 }
 
-const salesforceApps: SalesforceApp[] = ['lwc', 'experience-cloud']
+const salesforceApps: SalesforceApp[] = ['lwc', 'experience-cloud', 'experience-cloud-headmarkup']
 
 for (const app of salesforceApps) {
+  const canCallRumFromComponents = app !== 'experience-cloud-headmarkup'
+
   createTest(`salesforce ${app} views`)
     .withRum(baseSalesforceRumConfiguration)
     .withSalesforceApp(app)
@@ -59,19 +61,23 @@ for (const app of salesforceApps) {
       }
     })
 
-  createTest(`salesforce ${app} long tasks and vitals`)
+  createTest(`salesforce ${app} long tasks${canCallRumFromComponents ? ' and vitals' : ''}`)
     .withRum(baseSalesforceRumConfiguration)
     .withSalesforceApp(app)
     .run(async ({ page, intakeRegistry, flushEvents }) => {
       await expect(page.getByTestId('home-custom-actions')).toBeVisible({ timeout: 30000 })
 
       await page.getByTestId('long-task').click()
-      await page.getByRole('button', { name: 'Add Duration Vital' }).click()
+      if (canCallRumFromComponents) {
+        await page.getByRole('button', { name: 'Add Duration Vital' }).click()
+      }
 
       await flushEvents()
 
       expect(intakeRegistry.rumLongTaskEvents.length).toBeGreaterThanOrEqual(1)
-      expect(intakeRegistry.rumVitalEvents.length).toBeGreaterThanOrEqual(1)
+      if (canCallRumFromComponents) {
+        expect(intakeRegistry.rumVitalEvents.length).toBeGreaterThanOrEqual(1)
+      }
     })
 
   createTest(`salesforce ${app} actions`)
@@ -87,10 +93,12 @@ for (const app of salesforceApps) {
       const actionTypes = new Set(intakeRegistry.rumActionEvents.map((e) => e.action.type))
       expect(actionTypes.has('click')).toBe(true)
 
-      const customAction = intakeRegistry.rumActionEvents.find(
-        (e) => e.action.type === 'custom' && e.action.target?.name?.includes('custom action 1') === true
-      )
-      expect(customAction).toBeDefined()
+      if (canCallRumFromComponents) {
+        const customAction = intakeRegistry.rumActionEvents.find(
+          (e) => e.action.type === 'custom' && e.action.target?.name?.includes('custom action 1') === true
+        )
+        expect(customAction).toBeDefined()
+      }
     })
 
   createTest(`salesforce ${app} errors`)
@@ -99,7 +107,9 @@ for (const app of salesforceApps) {
     .run(async ({ page, intakeRegistry, flushEvents, withBrowserLogs }) => {
       await expect(page.getByTestId('home-custom-actions')).toBeVisible({ timeout: 30000 })
 
-      await page.getByTestId('custom-error-1').click()
+      if (canCallRumFromComponents) {
+        await page.getByTestId('custom-error-1').click()
+      }
       await page.getByTestId('runtime-error').click()
       await page.evaluate(() => window.console.error('salesforce console error test'))
 
@@ -119,9 +129,11 @@ for (const app of salesforceApps) {
       )
       expect(errorEvent).toBeDefined()
 
-      const customError = intakeRegistry.rumErrorEvents.find(
-        (e) => e.error.source === 'custom' && e.error.message?.includes('custom error 1') === true
-      )
-      expect(customError).toBeDefined()
+      if (canCallRumFromComponents) {
+        const customError = intakeRegistry.rumErrorEvents.find(
+          (e) => e.error.source === 'custom' && e.error.message?.includes('custom error 1') === true
+        )
+        expect(customError).toBeDefined()
+      }
     })
 }