✨ Add betaEnableViewUpdates config option

Author: mormubis

package.json

@@ -44,7 +44,7 @@
     "woke": "scripts/cli woke"
   },
   "devDependencies": {
-    "@datadog/rum-events-format": "DataDog/rum-events-format#commit=02c94b31a2676458a156ed627f3edcd87254beb7",
+    "@datadog/rum-events-format": "DataDog/rum-events-format#commit=bfe6bd954f5ac9f481598e19504a3548ccb2100d",
     "@eslint/js": "10.0.1",
     "@jsdevtools/coverage-istanbul-loader": "3.0.5",
     "@microsoft/api-extractor": "7.58.9",

packages/browser-core/src/domain/telemetry/telemetryEvent.types.ts

@@ -482,6 +482,10 @@ export type TelemetryConfigurationEvent = CommonTelemetryProperties & {
        * Whether the beta encode cookie options is enabled
        */
       beta_encode_cookie_options?: boolean
+      /**
+       * Whether the beta partial view updates feature is enabled
+       */
+      beta_enable_view_updates?: boolean
       [k: string]: unknown
     }
     [k: string]: unknown

packages/browser-rum-core/src/boot/preStartRum.ts

@@ -10,6 +10,8 @@ import {
   noop,
   getEventBridge,
   initFeatureFlags,
+  addExperimentalFeatures,
+  ExperimentalFeature,
   addTelemetryConfiguration,
   CustomerContextKey,
   buildAccountContextManager,
@@ -229,6 +231,9 @@ export function createPreStartStrategy(
       }
       // Set the experimental feature flags as early as possible, so we can use them in most places
       initFeatureFlags(initConfiguration.enableExperimentalFeatures)
+      if (initConfiguration.betaEnableViewUpdates) {
+        addExperimentalFeatures([ExperimentalFeature.PARTIAL_VIEW_UPDATES])
+      }
       setAllowUntrustedEvents(initConfiguration.allowUntrustedEvents)
 
       // Expose the initial configuration regardless of initialization success.

packages/browser-rum-core/src/domain/configuration/configuration.spec.ts

@@ -832,6 +832,7 @@ describe('serializeRumConfiguration', () => {
       profilingSampleRate: 42,
       propagateTraceBaggage: true,
       trackResourceHeaders: true,
+      betaEnableViewUpdates: true,
     }
 
     type MapRumInitConfigurationKey<Key extends string> = Key extends keyof InitConfiguration
@@ -887,6 +888,7 @@ describe('serializeRumConfiguration', () => {
       use_remote_configuration_proxy: true,
       profiling_sample_rate: 42,
       track_resource_headers: 'default_headers',
+      beta_enable_view_updates: true,
     })
   })
 })

packages/browser-rum-core/src/domain/configuration/configuration.ts

@@ -343,6 +343,14 @@ export interface RumInitConfiguration extends InitConfiguration {
    * @category Data Collection
    */
   allowedGraphQlUrls?: Array<MatchOption | GraphQlUrlOption> | undefined
+
+  /**
+   * Enable partial view updates, which reduces bandwidth by sending only changed
+   * fields instead of full view events on intermediate updates.
+   *
+   * @category Beta
+   */
+  betaEnableViewUpdates?: boolean | undefined
 }
 
 export type HybridInitConfiguration = Omit<RumInitConfiguration, 'applicationId' | 'clientToken'>
@@ -386,6 +394,7 @@ export interface RumConfiguration extends Configuration {
   sessionReplaySampleRate: number
   startSessionReplayRecordingManually: boolean
   trackUserInteractions: boolean
+  betaEnableViewUpdates: boolean
   trackViewsManually: boolean
   trackResources: boolean
   trackResourceHeaders: MatchHeader[]
@@ -457,6 +466,7 @@ export function validateAndBuildRumConfiguration(
     workerUrl: initConfiguration.workerUrl,
     compressIntakeRequests: !!initConfiguration.compressIntakeRequests,
     trackUserInteractions: !!(initConfiguration.trackUserInteractions ?? true),
+    betaEnableViewUpdates: !!initConfiguration.betaEnableViewUpdates,
     trackViewsManually: !!initConfiguration.trackViewsManually,
     trackResources: !!(initConfiguration.trackResources ?? true),
     trackResourceHeaders: validateAndBuildTrackResourceHeaders(initConfiguration),
@@ -685,6 +695,7 @@ export function serializeRumConfiguration(configuration: RumInitConfiguration) {
     profiling_sample_rate: configuration.profilingSampleRate,
     use_remote_configuration_proxy: !!configuration.remoteConfigurationProxy,
     track_resource_headers: getTrackResourceHeadersTelemetryValue(configuration.trackResourceHeaders),
+    beta_enable_view_updates: configuration.betaEnableViewUpdates,
     ...baseSerializedConfiguration,
   } satisfies RawTelemetryConfiguration
 }

packages/browser-rum-core/src/rumEvent.types.ts

@@ -513,6 +513,15 @@ export type RumErrorEvent = CommonProperties &
        * Profiling context
        */
       profiling?: ProfilingInternalContextSchema
+      /**
+       * Mapping of source file URLs to their debug IDs for source map deobfuscation
+       */
+      readonly debug_ids?: {
+        /**
+         * Debug ID (UUID) for the source file
+         */
+        [k: string]: string
+      }
       [k: string]: unknown
     }
     [k: string]: unknown
@@ -637,6 +646,15 @@ export type RumLongTaskEvent = CommonProperties &
        * Profiling context
        */
       profiling?: ProfilingInternalContextSchema
+      /**
+       * Mapping of source file URLs to their debug IDs for source map deobfuscation
+       */
+      readonly debug_ids?: {
+        /**
+         * Debug ID (UUID) for the source file
+         */
+        [k: string]: string
+      }
       [k: string]: unknown
     }
     [k: string]: unknown
@@ -919,70 +937,7 @@ export type RumViewEvent = CommonProperties &
       }
       [k: string]: unknown
     }
-    /**
-     * Internal properties
-     */
     readonly _dd: {
-      /**
-       * Version of the update of the view event
-       */
-      readonly document_version: number
-      /**
-       * List of the page states during the view
-       */
-      readonly page_states?: {
-        /**
-         * Page state name
-         */
-        readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated'
-        /**
-         * Duration in ns between start of the view and start of the page state
-         */
-        readonly start: number
-        [k: string]: unknown
-      }[]
-      /**
-       * Debug metadata for Replay Sessions
-       */
-      replay_stats?: {
-        /**
-         * The number of records produced during this view lifetime
-         */
-        records_count?: number
-        /**
-         * The number of segments sent during this view lifetime
-         */
-        segments_count?: number
-        /**
-         * The total size in bytes of the segments sent during this view lifetime
-         */
-        segments_total_raw_size?: number
-        [k: string]: unknown
-      }
-      /**
-       * Additional information of the reported Cumulative Layout Shift
-       */
-      readonly cls?: {
-        /**
-         * Pixel ratio of the device where the layout shift was reported
-         */
-        readonly device_pixel_ratio?: number
-        [k: string]: unknown
-      }
-      /**
-       * Subset of the SDK configuration options in use during its execution
-       */
-      readonly configuration?: {
-        /**
-         * Whether session replay recording configured to start manually
-         */
-        readonly start_session_replay_recording_manually?: boolean
-        [k: string]: unknown
-      }
-      /**
-       * Profiling context
-       */
-      profiling?: ProfilingInternalContextSchema
       [k: string]: unknown
     }
     [k: string]: unknown
@@ -998,16 +953,6 @@ export type RumViewUpdateEvent = ViewContainerSchema &
      * RUM event type
      */
     readonly type: 'view_update'
-    /**
-     * Internal properties
-     */
-    readonly _dd?: {
-      /**
-       * Version of the update of the view event
-       */
-      readonly document_version: number
-      [k: string]: unknown
-    }
     [k: string]: unknown
   }
 export type RumVitalEvent = RumVitalDurationEvent | RumVitalOperationStepEvent
@@ -1657,6 +1602,26 @@ export interface ProfilingInternalContextSchema {
     | 'failed-to-lazy-load'
     | 'missing-document-policy-header'
     | 'unexpected-exception'
+  /**
+   * The reason provided by the profiling quota admission API. This attribute is only present if the status is `stopped` due to quota.
+   *
+   * Possible values:
+   * - `quota_ok`: Quota check passed.
+   * - `quota_exceeded`: The organization has exceeded its profiling quota.
+   * - `org_disabled`: The organization has profiling disabled.
+   * - `backend_unavailable`: The quota admission API is unavailable or not initialized.
+   * - `undefined`: The quota reason is undefined.
+   * - `timeout`: The quota check timed out on the client side.
+   * - `api-error`: An API error occurred on the client side.
+   */
+  readonly quota_reason?:
+    | 'quota_ok'
+    | 'quota_exceeded'
+    | 'org_disabled'
+    | 'backend_unavailable'
+    | 'undefined'
+    | 'timeout'
+    | 'api-error'
   [k: string]: unknown
 }
 /**
@@ -2045,6 +2010,72 @@ export interface ViewProperties {
     }
     [k: string]: unknown
   }
+  /**
+   * Internal properties
+   */
+  readonly _dd?: {
+    /**
+     * Version of the update of the view event
+     */
+    readonly document_version: number
+    /**
+     * List of the page states during the view
+     */
+    readonly page_states?: {
+      /**
+       * Page state name
+       */
+      readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated'
+      /**
+       * Duration in ns between start of the view and start of the page state
+       */
+      readonly start: number
+      [k: string]: unknown
+    }[]
+    /**
+     * Debug metadata for Replay Sessions
+     */
+    replay_stats?: {
+      /**
+       * The number of records produced during this view lifetime
+       */
+      records_count?: number
+      /**
+       * The number of segments sent during this view lifetime
+       */
+      segments_count?: number
+      /**
+       * The total size in bytes of the segments sent during this view lifetime
+       */
+      segments_total_raw_size?: number
+      [k: string]: unknown
+    }
+    /**
+     * Additional information of the reported Cumulative Layout Shift
+     */
+    readonly cls?: {
+      /**
+       * Pixel ratio of the device where the layout shift was reported
+       */
+      readonly device_pixel_ratio?: number
+      [k: string]: unknown
+    }
+    /**
+     * Subset of the SDK configuration options in use during its execution
+     */
+    readonly configuration?: {
+      /**
+       * Whether session replay recording configured to start manually
+       */
+      readonly start_session_replay_recording_manually?: boolean
+      [k: string]: unknown
+    }
+    /**
+     * Profiling context
+     */
+    profiling?: ProfilingInternalContextSchema
+    [k: string]: unknown
+  }
   [k: string]: unknown
 }
 /**

yarn.lock

@@ -601,10 +601,10 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@datadog/rum-events-format@DataDog/rum-events-format#commit=02c94b31a2676458a156ed627f3edcd87254beb7":
+"@datadog/rum-events-format@DataDog/rum-events-format#commit=bfe6bd954f5ac9f481598e19504a3548ccb2100d":
   version: 0.0.0
-  resolution: "@datadog/rum-events-format@https://github.com/DataDog/rum-events-format.git#commit=02c94b31a2676458a156ed627f3edcd87254beb7"
-  checksum: 10c0/4a14c1afb23b3e4a0f631f8a1f077d6abab913c82f1145e1585002b488038b00ed19ce16c8840c20c7d94e5d113bc43c48bbb69f46038533cd53d3ebbcbc74c5
+  resolution: "@datadog/rum-events-format@https://github.com/DataDog/rum-events-format.git#commit=bfe6bd954f5ac9f481598e19504a3548ccb2100d"
+  checksum: 10c0/a7b3ac3fbdd4743b55c27e75cd073520fea1616a4e5a1c28372576b93afd4742aa02492e37ef6019f019d7dd23f7f3b1c6f18c0c92bace4afc70192455062f25
   languageName: node
   linkType: hard
 
@@ -3930,7 +3930,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "browser-sdk@workspace:."
   dependencies:
-    "@datadog/rum-events-format": "DataDog/rum-events-format#commit=02c94b31a2676458a156ed627f3edcd87254beb7"
+    "@datadog/rum-events-format": "DataDog/rum-events-format#commit=bfe6bd954f5ac9f481598e19504a3548ccb2100d"
     "@eslint/js": "npm:10.0.1"
     "@jsdevtools/coverage-istanbul-loader": "npm:3.0.5"
     "@microsoft/api-extractor": "npm:7.58.9"