Merge branch 'benoit/update-rum-events-format' into staging-38

BenoitZugmeyer · BenoitZugmeyer · commit 0ed9fb1f7778 · 2025-09-16T19:05:38.000+02:00
diff --git a/developer-extension/src/panel/components/tabs/eventsTab/eventRow.tsx b/developer-extension/src/panel/components/tabs/eventsTab/eventRow.tsx
@@ -35,6 +35,7 @@ const RUM_EVENT_TYPE_COLOR = {
   resource: 'cyan',
   telemetry: 'teal',
   vital: 'orange',
+  transition: 'green',
 }
 
 const LOG_STATUS_COLOR = {
diff --git a/packages/core/src/domain/telemetry/telemetryEvent.types.ts b/packages/core/src/domain/telemetry/telemetryEvent.types.ts
@@ -157,6 +157,10 @@ export type TelemetryConfigurationEvent = CommonTelemetryProperties & {
        * Whether resources are tracked
        */
       track_resources?: boolean
+      /**
+       * Whether early requests are tracked
+       */
+      track_early_requests?: boolean
       /**
        * Whether long tasks are tracked
        */
diff --git a/packages/rum-core/src/domain/action/trackClickActions.spec.ts b/packages/rum-core/src/domain/action/trackClickActions.spec.ts
@@ -1,4 +1,4 @@
-import type { Context, Duration } from '@datadog/browser-core'
+import type { Duration } from '@datadog/browser-core'
 import {
   addDuration,
   clocksNow,
@@ -11,8 +11,8 @@ import {
 import type { Clock } from '@datadog/browser-core/test'
 import { createNewEvent, mockClock, mockExperimentalFeatures } from '@datadog/browser-core/test'
 import { createFakeClick, createMutationRecord, mockRumConfiguration } from '../../../test'
+import type { AssembledRumEvent } from '../../rawRumEvent.types'
 import { RumEventType, ActionType, FrustrationType } from '../../rawRumEvent.types'
-import type { RumEvent } from '../../rumEvent.types'
 import { LifeCycle, LifeCycleEventType } from '../lifeCycle'
 import { PAGE_ACTIVITY_VALIDATION_DELAY } from '../waitPageActivityEnd'
 import type { RumConfiguration } from '../configuration'
@@ -177,7 +177,7 @@ describe('trackClickActions', () => {
     lifeCycle.notify(LifeCycleEventType.RUM_EVENT_COLLECTED, {
       type: RumEventType.RESOURCE,
       action: { id: 'unrelated-action-id' },
-    } as RumEvent & Context)
+    } as AssembledRumEvent)
 
     clock.tick(EXPIRE_DELAY)
 
@@ -602,7 +602,7 @@ describe('trackClickActions', () => {
   }
 
   function createFakeErrorEvent() {
-    return { type: RumEventType.ERROR, action: { id: findActionId() } } as RumEvent & Context
+    return { type: RumEventType.ERROR, action: { id: findActionId() } } as AssembledRumEvent
   }
 })
 
diff --git a/packages/rum-core/src/domain/assembly.ts b/packages/rum-core/src/domain/assembly.ts
@@ -1,4 +1,4 @@
-import type { Context, RawError, EventRateLimiter } from '@datadog/browser-core'
+import type { RawError, EventRateLimiter } from '@datadog/browser-core'
 import {
   combine,
   isEmptyObject,
@@ -11,8 +11,8 @@ import {
   buildTags,
 } from '@datadog/browser-core'
 import type { RumEventDomainContext } from '../domainContext.types'
+import type { AssembledRumEvent } from '../rawRumEvent.types'
 import { RumEventType } from '../rawRumEvent.types'
-import type { RumEvent } from '../rumEvent.types'
 import type { LifeCycle } from './lifeCycle'
 import { LifeCycleEventType } from './lifeCycle'
 import type { RumConfiguration } from './configuration'
@@ -120,7 +120,7 @@ export function startRumAssembly(
 
       const serverRumEvent = combine(defaultRumEventAttributes, rawRumEvent, {
         ddtags: buildTags(configuration).join(','),
-      }) as RumEvent & Context
+      }) as AssembledRumEvent
 
       if (shouldSend(serverRumEvent, configuration.beforeSend, domainContext, eventRateLimiters)) {
         if (isEmptyObject(serverRumEvent.context!)) {
@@ -133,7 +133,7 @@ export function startRumAssembly(
 }
 
 function shouldSend(
-  event: RumEvent & Context,
+  event: AssembledRumEvent,
   beforeSend: RumConfiguration['beforeSend'],
   domainContext: RumEventDomainContext,
   eventRateLimiters: { [key in RumEventType]?: EventRateLimiter }
diff --git a/packages/rum-core/src/domain/lifeCycle.ts b/packages/rum-core/src/domain/lifeCycle.ts
@@ -1,8 +1,7 @@
 import type { Context, Duration, PageMayExitEvent, RawError, RelativeTime } from '@datadog/browser-core'
 import { AbstractLifeCycle } from '@datadog/browser-core'
 import type { RumEventDomainContext } from '../domainContext.types'
-import type { RawRumEvent } from '../rawRumEvent.types'
-import type { RumEvent } from '../rumEvent.types'
+import type { RawRumEvent, AssembledRumEvent } from '../rawRumEvent.types'
 import type { RequestCompleteEvent, RequestStartEvent } from './requestCollection'
 import type { AutoAction } from './action/actionCollection'
 import type { ViewEvent, ViewCreatedEvent, ViewEndedEvent, BeforeViewUpdateEvent } from './view/trackViews'
@@ -85,7 +84,7 @@ export interface LifeCycleEventMap {
   [LifeCycleEventTypeAsConst.SESSION_RENEWED]: void
   [LifeCycleEventTypeAsConst.PAGE_MAY_EXIT]: PageMayExitEvent
   [LifeCycleEventTypeAsConst.RAW_RUM_EVENT_COLLECTED]: RawRumEventCollectedData
-  [LifeCycleEventTypeAsConst.RUM_EVENT_COLLECTED]: RumEvent & Context
+  [LifeCycleEventTypeAsConst.RUM_EVENT_COLLECTED]: AssembledRumEvent
   [LifeCycleEventTypeAsConst.RAW_ERROR_COLLECTED]: {
     error: RawError
     customerContext?: Context
diff --git a/packages/rum-core/src/domain/startCustomerDataTelemetry.spec.ts b/packages/rum-core/src/domain/startCustomerDataTelemetry.spec.ts
@@ -2,8 +2,8 @@ import type { FlushEvent, Context, Telemetry } from '@datadog/browser-core'
 import { Observable, resetExperimentalFeatures } from '@datadog/browser-core'
 import type { Clock, MockTelemetry } from '@datadog/browser-core/test'
 import { mockClock, startMockTelemetry } from '@datadog/browser-core/test'
+import type { AssembledRumEvent } from '../rawRumEvent.types'
 import { RumEventType } from '../rawRumEvent.types'
-import type { RumEvent } from '../rumEvent.types'
 import { LifeCycle, LifeCycleEventType } from './lifeCycle'
 import {
   MEASURES_PERIOD_DURATION,
@@ -17,7 +17,7 @@ describe('customerDataTelemetry', () => {
   let telemetry: MockTelemetry
   let fakeContextBytesCount: number
   let lifeCycle: LifeCycle
-  const viewEvent = { type: RumEventType.VIEW } as RumEvent & Context
+  const viewEvent = { type: RumEventType.VIEW } as AssembledRumEvent
 
   function generateBatch({
     eventNumber,
diff --git a/packages/rum-core/src/domain/trackEventCounts.spec.ts b/packages/rum-core/src/domain/trackEventCounts.spec.ts
@@ -1,6 +1,5 @@
-import type { Context } from '@datadog/browser-core'
 import { objectValues } from '@datadog/browser-core'
-import type { RumEvent } from '../rumEvent.types'
+import type { AssembledRumEvent } from '../rawRumEvent.types'
 import { FrustrationType, RumEventType } from '../rawRumEvent.types'
 import { LifeCycle, LifeCycleEventType } from './lifeCycle'
 import { trackEventCounts } from './trackEventCounts'
@@ -12,8 +11,8 @@ describe('trackEventCounts', () => {
     lifeCycle = new LifeCycle()
   })
 
-  function notifyCollectedRawRumEvent(partialEvent: Partial<RumEvent>) {
-    lifeCycle.notify(LifeCycleEventType.RUM_EVENT_COLLECTED, partialEvent as RumEvent & Context)
+  function notifyCollectedRawRumEvent(partialEvent: Partial<AssembledRumEvent>) {
+    lifeCycle.notify(LifeCycleEventType.RUM_EVENT_COLLECTED, partialEvent as AssembledRumEvent)
   }
 
   it('tracks errors', () => {
diff --git a/packages/rum-core/src/domain/view/trackViewEventCounts.spec.ts b/packages/rum-core/src/domain/view/trackViewEventCounts.spec.ts
@@ -1,7 +1,6 @@
-import type { Context } from '@datadog/browser-core'
 import { registerCleanupTask } from '@datadog/browser-core/test'
-import type { RumEvent } from '../../rumEvent.types'
 import { LifeCycle, LifeCycleEventType } from '../lifeCycle'
+import type { AssembledRumEvent } from '../../rawRumEvent.types'
 import { RumEventType } from '../../rawRumEvent.types'
 import { trackViewEventCounts } from './trackViewEventCounts'
 
@@ -20,7 +19,7 @@ describe('trackViewEventCounts', () => {
     lifeCycle.notify(LifeCycleEventType.RUM_EVENT_COLLECTED, {
       type: RumEventType.ERROR,
       view: { id: 'view-id' },
-    } as RumEvent & Context)
+    } as AssembledRumEvent)
 
     expect(onChange).toHaveBeenCalledTimes(1)
   })
@@ -29,7 +28,7 @@ describe('trackViewEventCounts', () => {
     lifeCycle.notify(LifeCycleEventType.RUM_EVENT_COLLECTED, {
       type: RumEventType.ERROR,
       view: { id: 'unrelated-view-id' },
-    } as RumEvent & Context)
+    } as AssembledRumEvent)
 
     expect(onChange).not.toHaveBeenCalled()
   })
diff --git a/packages/rum-core/src/domain/view/trackViews.spec.ts b/packages/rum-core/src/domain/view/trackViews.spec.ts
@@ -1,4 +1,4 @@
-import type { Context, Duration, RelativeTime } from '@datadog/browser-core'
+import type { Duration, RelativeTime } from '@datadog/browser-core'
 import {
   PageExitReason,
   timeStampNow,
@@ -11,8 +11,8 @@ import {
 import type { Clock } from '@datadog/browser-core/test'
 import { mockClock, registerCleanupTask, createNewEvent } from '@datadog/browser-core/test'
 import { createPerformanceEntry, mockPerformanceObserver } from '../../../test'
+import type { AssembledRumEvent } from '../../rawRumEvent.types'
 import { RumEventType, ViewLoadingType } from '../../rawRumEvent.types'
-import type { RumEvent } from '../../rumEvent.types'
 import { LifeCycle, LifeCycleEventType } from '../lifeCycle'
 import type { RumPerformanceEntry } from '../../browser/performanceObservable'
 import { RumPerformanceEntryType } from '../../browser/performanceObservable'
@@ -874,7 +874,7 @@ describe('view event count', () => {
     lifeCycle.notify(LifeCycleEventType.RUM_EVENT_COLLECTED, {
       type: RumEventType.RESOURCE,
       view: { id: firstView.id },
-    } as RumEvent & Context)
+    } as AssembledRumEvent)
 
     clock.tick(THROTTLE_VIEW_UPDATE_PERIOD)
 
@@ -895,7 +895,7 @@ describe('view event count', () => {
     lifeCycle.notify(LifeCycleEventType.RUM_EVENT_COLLECTED, {
       type: RumEventType.RESOURCE,
       view: { id: firstView.id },
-    } as RumEvent & Context)
+    } as AssembledRumEvent)
 
     clock.tick(THROTTLE_VIEW_UPDATE_PERIOD)
 
@@ -908,7 +908,7 @@ describe('view event count', () => {
       type: RumEventType.ACTION,
       action: {},
       view: viewTest.getLatestViewContext(),
-    } as RumEvent & Context
+    } as AssembledRumEvent
   }
 
   describe('view specific context', () => {
diff --git a/packages/rum-core/src/rawRumEvent.types.ts b/packages/rum-core/src/rawRumEvent.types.ts
@@ -12,6 +12,14 @@ import type {
 } from '@datadog/browser-core'
 import type { GraphQlMetadata } from './domain/resource/graphql'
 import type { PageState } from './domain/contexts/pageStateHistory'
+import type {
+  RumActionEvent,
+  RumErrorEvent,
+  RumLongTaskEvent,
+  RumResourceEvent,
+  RumViewEvent,
+  RumVitalEvent,
+} from './rumEvent.types'
 
 export const RumEventType = {
   ACTION: 'action',
@@ -24,6 +32,16 @@ export const RumEventType = {
 
 export type RumEventType = (typeof RumEventType)[keyof typeof RumEventType]
 
+export type AssembledRumEvent = (
+  | RumViewEvent
+  | RumActionEvent
+  | RumResourceEvent
+  | RumErrorEvent
+  | RumVitalEvent
+  | RumLongTaskEvent
+) &
+  Context
+
 export const RumLongTaskEntryType = {
   LONG_TASK: 'long-task',
   LONG_ANIMATION_FRAME: 'long-animation-frame',
diff --git a/packages/rum-core/src/rumEvent.types.ts b/packages/rum-core/src/rumEvent.types.ts
@@ -8,6 +8,7 @@
  */
 export type RumEvent =
   | RumActionEvent
+  | RumTransitionEvent
   | RumErrorEvent
   | RumLongTaskEvent
   | RumResourceEvent
@@ -166,6 +167,60 @@ export type RumActionEvent = CommonProperties &
     }
     [k: string]: unknown
   }
+/**
+ * Schema of all properties of an Transition event
+ */
+export type RumTransitionEvent = CommonProperties & {
+  /**
+   * RUM event type
+   */
+  readonly type: 'transition'
+  /**
+   * Stream properties
+   */
+  readonly stream: {
+    /**
+     * UUID of the stream
+     */
+    readonly id: string
+    [k: string]: unknown
+  }
+  /**
+   * Transition properties
+   */
+  readonly transition: {
+    /**
+     * Type of the transition
+     */
+    readonly type: string
+    /**
+     * UUID of the transition
+     */
+    readonly id?: string
+    /**
+     * The player's current timestamp in milliseconds
+     */
+    readonly timestamp?: number
+    /**
+     * Buffer starvation duration, the amount of time spent rebuffering in milliseconds
+     */
+    readonly buffer_starvation_duration?: number
+    /**
+     * Media start delay, the amount of time spent loading before playing in milliseconds
+     */
+    readonly media_start_delay?: number
+    /**
+     * Error code, as reported by the player
+     */
+    readonly error_code?: number
+    /**
+     * Duration of the event in milliseconds
+     */
+    readonly duration?: number
+    [k: string]: unknown
+  }
+  [k: string]: unknown
+}
 /**
  * Schema of all properties of an Error event
  */
diff --git a/packages/rum-core/src/transport/startRumBatch.ts b/packages/rum-core/src/transport/startRumBatch.ts
@@ -1,10 +1,10 @@
-import type { Context, Observable, RawError, PageMayExitEvent, Encoder } from '@datadog/browser-core'
+import type { Observable, RawError, PageMayExitEvent, Encoder } from '@datadog/browser-core'
 import { createBatch, createFlushController, createHttpRequest, DeflateEncoderStreamId } from '@datadog/browser-core'
 import type { RumConfiguration } from '../domain/configuration'
 import type { LifeCycle } from '../domain/lifeCycle'
 import { LifeCycleEventType } from '../domain/lifeCycle'
+import type { AssembledRumEvent } from '../rawRumEvent.types'
 import { RumEventType } from '../rawRumEvent.types'
-import type { RumEvent } from '../rumEvent.types'
 
 export function startRumBatch(
   configuration: RumConfiguration,
@@ -32,7 +32,7 @@ export function startRumBatch(
     messageBytesLimit: configuration.messageBytesLimit,
   })
 
-  lifeCycle.subscribe(LifeCycleEventType.RUM_EVENT_COLLECTED, (serverRumEvent: RumEvent & Context) => {
+  lifeCycle.subscribe(LifeCycleEventType.RUM_EVENT_COLLECTED, (serverRumEvent: AssembledRumEvent) => {
     if (serverRumEvent.type === RumEventType.VIEW) {
       batch.upsert(serverRumEvent, serverRumEvent.view.id)
     } else {
diff --git a/packages/rum-core/src/transport/startRumEventBridge.ts b/packages/rum-core/src/transport/startRumEventBridge.ts
@@ -1,4 +1,3 @@
-import type { Context } from '@datadog/browser-core'
 import { getEventBridge } from '@datadog/browser-core'
 import type { LifeCycle } from '../domain/lifeCycle'
 import { LifeCycleEventType } from '../domain/lifeCycle'
@@ -7,7 +6,7 @@ import type { RumEvent } from '../rumEvent.types'
 export function startRumEventBridge(lifeCycle: LifeCycle) {
   const bridge = getEventBridge<'rum', RumEvent>()!
 
-  lifeCycle.subscribe(LifeCycleEventType.RUM_EVENT_COLLECTED, (serverRumEvent: RumEvent & Context) => {
+  lifeCycle.subscribe(LifeCycleEventType.RUM_EVENT_COLLECTED, (serverRumEvent) => {
     bridge.send('rum', serverRumEvent)
   })
 }
diff --git a/rum-events-format b/rum-events-format
@@ -1 +1 @@
-Subproject commit 5a038867f765232319cb6ddd5117d3aab570b838
+Subproject commit fbf83da4ab8e7b6ad956aa0038d6e9fef3ec0a9a

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ const RUM_EVENT_TYPE_COLOR = {`
`35`	`35`	`resource: 'cyan',`
`36`	`36`	`telemetry: 'teal',`
`37`	`37`	`vital: 'orange',`
	`38`	`+ transition: 'green',`
`38`	`39`	`}`
`39`	`40`
`40`	`41`	`const LOG_STATUS_COLOR = {`