✨ Add initial Salesforce support.

eslint-local-rules/disallowSideEffects.ts

@@ -40,6 +40,7 @@ const pathsWithSideEffect = new Set([
   `${packagesRoot}/browser-logs/src/entries/main.ts`,
   `${packagesRoot}/browser-rum/src/entries/main.ts`,
   `${packagesRoot}/browser-rum-slim/src/entries/main.ts`,
+  `${packagesRoot}/browser-rum-slim/src/entries/salesforce.ts`,
   `${packagesRoot}/browser-debugger/src/entries/main.ts`,
 ])
 

packages/browser-core/src/browser/addEventListener.ts

@@ -39,6 +39,7 @@ export const enum DOM_EVENT {
   SECURITY_POLICY_VIOLATION = 'securitypolicyviolation',
   SELECTION_CHANGE = 'selectionchange',
   STORAGE = 'storage',
+  UNHANDLED_REJECTION = 'unhandledrejection',
 }
 
 interface AddEventListenerOptions {
@@ -146,3 +147,16 @@ export function addEventListeners<Target extends EventTarget, EventName extends
     stop,
   }
 }
+
+export function isEventSupported<Target extends EventTarget, EventName extends keyof EventMapFor<Target> & string>(
+  eventTarget: Target,
+  eventName: EventName,
+  listener: (event: EventMapFor<Target>[EventName] & { type: EventName }) => void
+) {
+  try {
+    addEventListener({}, eventTarget, eventName, listener).stop()
+    return true
+  } catch {
+    return false
+  }
+}

packages/browser-core/src/browser/cookieAccess.ts

@@ -4,10 +4,11 @@ import { Observable } from '../tools/observable'
 import { mockable } from '../tools/mockable'
 import { display } from '../tools/display'
 import { generateUUID } from '../tools/utils/stringUtils'
+import { noop } from '../tools/utils/functionUtils'
 import type { Configuration } from '../domain/configuration'
 import { addTelemetryDebug } from '../domain/telemetry'
 import { globalObject } from '../tools/globalObject'
-import { addEventListener, DOM_EVENT } from './addEventListener'
+import { addEventListener, DOM_EVENT, isEventSupported } from './addEventListener'
 import { getCookies, setCookie } from './cookie'
 import type { CookieOptions } from './cookie'
 
@@ -162,3 +163,8 @@ export function createDocumentCookieAccess(
     observable,
   }
 }
+
+// Salesforce LWS does not support the change event of CookieStore objects. https://developer.salesforce.com/tools/lws-distortion-viewer
+export function isCookieStoreSupported(): boolean {
+  return Boolean(globalObject.cookieStore && isEventSupported(globalObject.cookieStore, DOM_EVENT.CHANGE, noop))
+}

packages/browser-core/src/domain/error/trackRuntimeError.ts

@@ -4,6 +4,8 @@ import { clocksNow } from '../../tools/utils/timeUtils'
 import type { StackTrace } from '../../tools/stackTrace/computeStackTrace'
 import { computeStackTraceFromOnErrorMessage } from '../../tools/stackTrace/computeStackTrace'
 import { globalObject } from '../../tools/globalObject'
+import { DOM_EVENT, isEventSupported } from '../../browser/addEventListener'
+import { noop } from '../../tools/utils/functionUtils'
 import { computeRawError, isError } from './error'
 import type { RawError } from './error.types'
 import { ErrorHandling, ErrorSource, NonErrorPrefix } from './error.types'
@@ -44,6 +46,11 @@ export function instrumentOnError(callback: UnhandledErrorCallback) {
 }
 
 export function instrumentUnhandledRejection(callback: UnhandledErrorCallback) {
+  // Salesforce LWS does not support the unhandledrejection event. https://developer.salesforce.com/tools/lws-distortion-viewer
+  if (!isEventSupported(globalObject.window, DOM_EVENT.UNHANDLED_REJECTION, noop)) {
+    return { stop: noop }
+  }
+
   return instrumentMethod(globalObject, 'onunhandledrejection', ({ parameters: [e] }) => {
     callback(e.reason || 'Empty reason')
   })

packages/browser-core/src/domain/report/reportObservable.ts

@@ -1,12 +1,13 @@
 import { toStackTraceString } from '../../tools/stackTrace/handlingStack'
 import { monitor } from '../../tools/monitor'
 import { mergeObservables, Observable } from '../../tools/observable'
-import { addEventListener, DOM_EVENT } from '../../browser/addEventListener'
+import { addEventListener, DOM_EVENT, isEventSupported } from '../../browser/addEventListener'
 import { safeTruncate } from '../../tools/utils/stringUtils'
 import type { Configuration } from '../configuration'
 import type { RawError } from '../error/error.types'
 import { ErrorHandling, ErrorSource } from '../error/error.types'
 import { clocksNow } from '../../tools/utils/timeUtils'
+import { noop } from '../../tools/utils/functionUtils'
 import type { ReportType, InterventionReport, DeprecationReport } from './browser.types'
 
 export const RawReportType = {
@@ -60,6 +61,11 @@ function createReportObservable(reportTypes: ReportType[]) {
 
 function createCspViolationReportObservable(configuration: Configuration) {
   return new Observable<RawReportError>((observable) => {
+    // Salesforce does not allow to add a securitypolicyviolation event listener. https://developer.salesforce.com/tools/lws-distortion-viewer
+    if (!isEventSupported(document, DOM_EVENT.SECURITY_POLICY_VIOLATION, noop)) {
+      return
+    }
+
     const { stop } = addEventListener(configuration, document, DOM_EVENT.SECURITY_POLICY_VIOLATION, (event) => {
       observable.notify(buildRawReportErrorFromCspViolation(event))
     })

packages/browser-core/src/domain/session/storeStrategies/sessionInCookie.ts

@@ -13,8 +13,8 @@ import {
   areCookiesAuthorized,
   createCookieStoreAccess,
   createDocumentCookieAccess,
+  isCookieStoreSupported,
 } from '../../../browser/cookieAccess'
-import { globalObject } from '../../../tools/globalObject'
 import { CookieApi, LEGACY_SESSION_STORE_KEY, SESSION_STORE_KEY } from './sessionStoreStrategy'
 import type {
   SessionStoreStrategy,
@@ -33,10 +33,7 @@ export async function selectCookieStrategy(
     return undefined
   }
 
-  if (
-    mockable(globalObject.cookieStore) &&
-    (await areCookiesAuthorized(createCookieStoreAccess, cookieOptions, configuration))
-  ) {
+  if (isCookieStoreSupported() && (await areCookiesAuthorized(createCookieStoreAccess, cookieOptions, configuration))) {
     return { type: SessionPersistence.COOKIE, cookieOptions, cookieApi: CookieApi.COOKIE_STORE }
   }
 

packages/browser-core/src/index.ts

@@ -103,6 +103,7 @@ export {
 export { NonErrorPrefix } from './domain/error/error.types'
 export type { Context, ContextArray, ContextValue } from './tools/serialisation/context'
 export { getCookie, getInitCookie, setCookie, deleteCookie, resetInitCookies } from './browser/cookie'
+export { isCookieStoreSupported } from './browser/cookieAccess'
 export type {
   CookieStore,
   WeakRef,

packages/browser-rum-core/src/browser/cookieObservable.ts

@@ -8,12 +8,13 @@ import {
   DOM_EVENT,
   getCookie,
   globalObject,
+  isCookieStoreSupported,
 } from '@datadog/browser-core'
 
 export type CookieObservable = ReturnType<typeof createCookieObservable>
 
 export function createCookieObservable(configuration: Configuration, cookieName: string) {
-  const detectCookieChangeStrategy = globalObject.cookieStore
+  const detectCookieChangeStrategy = isCookieStoreSupported()
     ? listenToCookieStoreChange(configuration)
     : watchCookieFallback
 

packages/browser-rum-core/src/browser/locationChangeObservable.ts

@@ -1,4 +1,11 @@
-import { addEventListener, DOM_EVENT, instrumentMethod, Observable, shallowClone } from '@datadog/browser-core'
+import {
+  addEventListener,
+  DOM_EVENT,
+  globalObject,
+  instrumentMethod,
+  Observable,
+  shallowClone,
+} from '@datadog/browser-core'
 import type { RumConfiguration } from '../domain/configuration'
 
 export interface LocationChange {
@@ -7,7 +14,7 @@ export interface LocationChange {
 }
 
 export function createLocationChangeObservable(configuration: RumConfiguration) {
-  let currentLocation = shallowClone(location)
+  let currentLocation = shallowClone(globalObject.location)
 
   return new Observable<LocationChange>((observable) => {
     const { stop: stopHistoryTracking } = trackHistory(configuration, onLocationChange)

packages/browser-rum-core/src/domain/contexts/urlContexts.ts

@@ -5,8 +5,9 @@ import {
   createValueHistory,
   HookNames,
   DISCARDED,
-  mockable,
   buildUrl,
+  mockable,
+  globalObject,
 } from '@datadog/browser-core'
 import type { LocationChange } from '../../browser/locationChangeObservable'
 import type { LifeCycle } from '../lifeCycle'
@@ -41,8 +42,9 @@ export function startUrlContexts(
   let previousViewUrl: string | undefined
 
   lifeCycle.subscribe(LifeCycleEventType.BEFORE_VIEW_CREATED, ({ startClocks, url }) => {
-    const locationHref = mockable(location).href
+    const locationHref = mockable(globalObject.location).href
     const viewUrl = url !== undefined ? buildUrl(url, locationHref).href : locationHref
+
     urlContextHistory.add(
       buildUrlContext({
         url: viewUrl,

packages/browser-rum-slim/package.json

@@ -16,6 +16,7 @@
   "scripts": {
     "build": "node ../../scripts/build/build-package.ts --modules --bundle datadog-rum-slim.js",
     "build:bundle": "node ../../scripts/build/build-package.ts --bundle datadog-rum-slim.js",
+    "build:salesforce": "node ../../scripts/build/build-package.ts --bundle rum-salesforce-lightning.js --entry ./src/entries/salesforce.ts",
     "prepack": "yarn build"
   },
   "dependencies": {

packages/browser-rum-slim/src/domain/salesforce/README.md

@@ -0,0 +1,99 @@
+# Salesforce Lightning RUM
+
+This entrypoint is intended for Salesforce Lightning and LWC applications using the `rum-salesforce-lightning.js`
+bundle. The SDK forces the Salesforce-specific RUM settings required for this environment:
+
+- `trackViewsManually: true`
+- `profilingSampleRate: 0`
+- `sessionReplaySampleRate: 0`
+
+## Recommended LWC Setup
+
+```js
+import { LightningElement, api, wire } from 'lwc'
+import { NavigationMixin, CurrentPageReference } from 'lightning/navigation'
+import rumSalesforceLightning from '@salesforce/resourceUrl/rum_salesforce_lightning'
+import { loadScript } from 'lightning/platformResourceLoader'
+
+export default class DatadogInit extends NavigationMixin(LightningElement) {
+  @api applicationId
+  @api clientToken
+  @api site
+  @api service
+  @api env
+
+  connectedCallback() {
+    this.loadDatadogRum()
+  }
+
+  @wire(CurrentPageReference)
+  handleCurrentPageReference(pageReference) {
+    if (!pageReference) {
+      return
+    }
+
+    this.loadDatadogRum().then(() => {
+      this.startPageReference(pageReference)
+    })
+  }
+
+  startPageReference(pageReference) {
+    window.DD_RUM?.startSalesforceView?.({
+      pageReference,
+      baseUrl: window.location.origin || window.location.href,
+      generateUrl: (pageReferenceToGenerate) => this[NavigationMixin.GenerateUrl](pageReferenceToGenerate),
+    })
+  }
+
+  loadDatadogRum() {
+    return loadScript(this, rumSalesforceLightning).then(() => {
+      window.DD_RUM.initSalesforce({
+        applicationId: this.applicationId,
+        clientToken: this.clientToken,
+        site: this.site,
+        service: this.service,
+        env: this.env,
+      })
+    })
+  }
+}
+```
+
+## Salesforce Feature Support
+
+| Feature                | Supported                      |
+| ---------------------- | ------------------------------ |
+| **View Events**        |                                |
+| Initial View           | ✅                             |
+| Manual Tracking        | ✅                             |
+| Navigation Timings     | ✅                             |
+| Web Vitals             | ✅                             |
+| Automatic Tracking     | ✅⚠️ Supported with workaround |
+| Loading Time           | ✅⚠️(1)                        |
+| **Resource Events**    |                                |
+| Fetch Resources        | ✅⚠️(2)                        |
+| XHR Resources          | ✅⚠️(2)                        |
+| Other Resources        | ✅                             |
+| APM Correlation        | ✅⚠️(2)                        |
+| **Action Events**      |                                |
+| Custom Actions         | ✅                             |
+| Click Actions          | ✅                             |
+| Frustration Signals    | ✅                             |
+| Selectors              | ✅⚠️(3)                        |
+| Action Name            | ✅⚠️(2)                        |
+| Loading Time           | ✅⚠️(1)                        |
+| **Error Events**       |                                |
+| Console Error          | ✅                             |
+| Custom Errors          | ✅                             |
+| Runtime Errors         | ✅⚠️(4)                        |
+| `onUnhandledRejection` | ❌                             |
+| CSP Violation          | ❌                             |
+| **Other**              |                                |
+| Vital Events           | ✅                             |
+| Long Task Events       | ✅                             |
+| Session Replay         | ❌                             |
+
+1. Loading time depends on page activity detection, which may not work fully in Salesforce Lightning due to shadow DOM restrictions on page lifecycle signals.
+2. Cross-origin restrictions in the Lightning shell may hide full request URLs; APM correlation headers and action names derived from URLs may be incomplete.
+3. Due to shadow boundaries, the SDK might receive the component host as `event.target` instead of the actual clicked element.
+4. Direct synchronous errors can reach the SDK through `window.onerror`, but in the Lightning shell they may be redacted as "Script error." with no original error object, URL, line, or stack available to the SDK.