✨ Add betaEnableViewUpdates config option

Author: mormubis

package.json

@@ -43,7 +43,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=c90ea19ee1804c20a37193f938c43559ba92abea",
     "@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

@@ -6,10 +6,7 @@
  * Schema of all properties of a telemetry event
  */
 export type TelemetryEvent =
-  | TelemetryErrorEvent
-  | TelemetryDebugEvent
-  | TelemetryConfigurationEvent
-  | TelemetryUsageEvent
+  TelemetryErrorEvent | TelemetryDebugEvent | TelemetryConfigurationEvent | TelemetryUsageEvent
 /**
  * Schema of all properties of a telemetry error event
  */
@@ -482,6 +479,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

@@ -163,12 +163,7 @@ export type RumActionEvent = CommonProperties &
          * The strategy of how the auto click action name is computed
          */
         name_source?:
-          | 'custom_attribute'
-          | 'mask_placeholder'
-          | 'standard_attribute'
-          | 'text_content'
-          | 'mask_disallowed'
-          | 'blank'
+          'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank'
         [k: string]: unknown
       }
       [k: string]: unknown
@@ -611,12 +606,7 @@ export type RumLongTaskEvent = CommonProperties &
          * Type of the invoker of the script
          */
         readonly invoker_type?:
-          | 'user-callback'
-          | 'event-listener'
-          | 'resolve-promise'
-          | 'reject-promise'
-          | 'classic-script'
-          | 'module-script'
+          'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script'
         /**
          * The container (the top-level document, or an <iframe>) the long animation frame occurred in
          */
@@ -663,17 +653,7 @@ export type RumResourceEvent = CommonProperties &
        * Resource type
        */
       readonly type:
-        | 'document'
-        | 'xhr'
-        | 'beacon'
-        | 'fetch'
-        | 'css'
-        | 'js'
-        | 'image'
-        | 'font'
-        | 'media'
-        | 'other'
-        | 'native'
+        'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native'
       /**
        * HTTP method of the resource
        */
@@ -1254,15 +1234,7 @@ export interface CommonProperties {
      * The list of available network interfaces
      */
     readonly interfaces?: (
-      | 'bluetooth'
-      | 'cellular'
-      | 'ethernet'
-      | 'wifi'
-      | 'wimax'
-      | 'mixed'
-      | 'other'
-      | 'unknown'
-      | 'none'
+      'bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none'
     )[]
     /**
      * Cellular connection type reflecting the measured network performance
@@ -1653,10 +1625,21 @@ export interface ProfilingInternalContextSchema {
    * - `unexpected-exception`: An exception occurred when starting the Profiler.
    */
   readonly error_reason?:
-    | 'not-supported-by-browser'
-    | 'failed-to-lazy-load'
-    | 'missing-document-policy-header'
-    | 'unexpected-exception'
+    'not-supported-by-browser' | '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
 }
 /**

packages/browser-rum/src/types/sessionReplay.ts

@@ -138,10 +138,7 @@ export type AddCDataSectionNodeChange = [InsertionPoint, '#cdata-section' | Stri
  * Browser-specific. Schema representing the insertion point of a node which is being added to the document.
  */
 export type InsertionPoint =
-  | AppendChildInsertionPoint
-  | InsertAfterPreviousInsertionPoint
-  | InsertBeforeInsertionPoint
-  | RootInsertionPoint
+  AppendChildInsertionPoint | InsertAfterPreviousInsertionPoint | InsertBeforeInsertionPoint | RootInsertionPoint
 /**
  * A positive integer insertion point. Inserting a node at positive integer N indicates that the new node's parent is the node with an id N lower than the new node, and that we should insert the new node at the end of its parent's child list, as if the DOM method appendChild() was being used.
  */
@@ -266,9 +263,7 @@ export type AddStyleSheetChange = StyleSheetSnapshot
  * @minItems 1
  */
 export type StyleSheetSnapshot =
-  | [StyleSheetRules]
-  | [StyleSheetRules, StyleSheetMediaList]
-  | [StyleSheetRules, StyleSheetMediaList, boolean]
+  [StyleSheetRules] | [StyleSheetRules, StyleSheetMediaList] | [StyleSheetRules, StyleSheetMediaList, boolean]
 /**
  * Schema representing a CSS stylesheet's rules, encoded either as a single string or as an array containing a separate string for each rule.
  */

yarn.lock

@@ -599,10 +599,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=c90ea19ee1804c20a37193f938c43559ba92abea":
   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=c90ea19ee1804c20a37193f938c43559ba92abea"
+  checksum: 10c0/24cb4527dbdb216687de7378ac04ff28235015fd02a47608012bd055eed7e32e57cc30282922aafb5e37fa7b549902e66396f1fb9e3bd7915cb75a87a08d6411
   languageName: node
   linkType: hard
 
@@ -3919,7 +3919,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=c90ea19ee1804c20a37193f938c43559ba92abea"
     "@eslint/js": "npm:10.0.1"
     "@jsdevtools/coverage-istanbul-loader": "npm:3.0.5"
     "@microsoft/api-extractor": "npm:7.58.9"