✨ [RUMF-996] set synthetics ids on RUM events

packages/rum-core/src/domain/assembly.spec.ts

@@ -516,7 +516,8 @@ describe('rum assembly', () => {
     })
 
     it('should detect synthetics sessions from global', () => {
-      ;(window as BrowserWindow)._DATADOG_SYNTHETICS_BROWSER = true
+      ;(window as BrowserWindow)._DATADOG_SYNTHETICS_PUBLIC_ID = 'foo'
+      ;(window as BrowserWindow)._DATADOG_SYNTHETICS_RESULT_ID = 'bar'
 
       const { lifeCycle } = setupBuilder.build()
       notifyRawRumEvent(lifeCycle, {
@@ -525,7 +526,8 @@ describe('rum assembly', () => {
 
       expect(serverRumEvents[0].session.type).toEqual('synthetics')
 
-      delete (window as BrowserWindow)._DATADOG_SYNTHETICS_BROWSER
+      delete (window as BrowserWindow)._DATADOG_SYNTHETICS_PUBLIC_ID
+      delete (window as BrowserWindow)._DATADOG_SYNTHETICS_RESULT_ID
     })
 
     it('should set the session.has_replay attribute if it is defined in the common context', () => {
@@ -549,6 +551,39 @@ describe('rum assembly', () => {
     })
   })
 
+  describe('synthetics context', () => {
+    it('sets the synthetics context defined by global variables', () => {
+      ;(window as BrowserWindow)._DATADOG_SYNTHETICS_PUBLIC_ID = 'foo'
+      ;(window as BrowserWindow)._DATADOG_SYNTHETICS_RESULT_ID = 'bar'
+
+      const { lifeCycle } = setupBuilder.build()
+      notifyRawRumEvent(lifeCycle, {
+        rawRumEvent: createRawRumEvent(RumEventType.VIEW),
+      })
+
+      expect(serverRumEvents[0].synthetics).toEqual({
+        test_id: 'foo',
+        result_id: 'bar',
+      })
+
+      delete (window as BrowserWindow)._DATADOG_SYNTHETICS_PUBLIC_ID
+      delete (window as BrowserWindow)._DATADOG_SYNTHETICS_RESULT_ID
+    })
+
+    it('does not set synthetics context if one global variable is undefined', () => {
+      ;(window as BrowserWindow)._DATADOG_SYNTHETICS_PUBLIC_ID = 'foo'
+
+      const { lifeCycle } = setupBuilder.build()
+      notifyRawRumEvent(lifeCycle, {
+        rawRumEvent: createRawRumEvent(RumEventType.VIEW),
+      })
+
+      expect(serverRumEvents[0].synthetics).toBeUndefined()
+
+      delete (window as BrowserWindow)._DATADOG_SYNTHETICS_PUBLIC_ID
+    })
+  })
+
   describe('error events limitation', () => {
     const notifiedRawErrors: RawError[] = []
 

packages/rum-core/src/domain/assembly.ts

@@ -30,7 +30,8 @@ import { ParentContexts } from './parentContexts'
 import { RumSession, RumSessionPlan } from './rumSession'
 
 export interface BrowserWindow extends Window {
-  _DATADOG_SYNTHETICS_BROWSER?: unknown
+  _DATADOG_SYNTHETICS_PUBLIC_ID?: string
+  _DATADOG_SYNTHETICS_RESULT_ID?: string
 }
 
 enum SessionType {
@@ -93,6 +94,7 @@ export function startRumAssembly(
             // must be computed on each event because synthetics instrumentation can be done after sdk execution
             type: getSessionType(),
           },
+          synthetics: getSyntheticsContext(),
         }
         const serverRumEvent = (needToAssembleWithAction(rawRumEvent)
           ? combine(rumContext, viewContext, actionContext, rawRumEvent)
@@ -162,8 +164,19 @@ function needToAssembleWithAction(
 }
 
 function getSessionType() {
-  return navigator.userAgent.indexOf('DatadogSynthetics') === -1 &&
-    (window as BrowserWindow)._DATADOG_SYNTHETICS_BROWSER === undefined
+  return navigator.userAgent.indexOf('DatadogSynthetics') === -1 && !getSyntheticsContext()
     ? SessionType.USER
     : SessionType.SYNTHETICS
 }
+
+function getSyntheticsContext() {
+  const testId = (window as BrowserWindow)._DATADOG_SYNTHETICS_PUBLIC_ID
+  const resultId = (window as BrowserWindow)._DATADOG_SYNTHETICS_RESULT_ID
+
+  if (testId && resultId) {
+    return {
+      test_id: testId,
+      result_id: resultId,
+    }
+  }
+}

packages/rum-core/src/rawRumEvent.types.ts

@@ -179,6 +179,10 @@ export interface RumContext {
     type: string
     has_replay?: boolean
   }
+  synthetics?: {
+    test_id: string
+    result_id: string
+  }
   _dd: {
     format_version: 2
     drift: number

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

@@ -14,7 +14,7 @@ export type RumActionEvent = CommonProperties & {
   /**
    * RUM event type
    */
-  readonly type: string
+  readonly type: 'action'
   /**
    * Action properties
    */
@@ -102,7 +102,7 @@ export type RumErrorEvent = CommonProperties & {
   /**
    * RUM event type
    */
-  readonly type: string
+  readonly type: 'error'
   /**
    * Error properties
    */
@@ -220,7 +220,7 @@ export type RumLongTaskEvent = CommonProperties & {
   /**
    * RUM event type
    */
-  readonly type: string
+  readonly type: 'long_task'
   /**
    * Long Task properties
    */
@@ -233,6 +233,10 @@ export type RumLongTaskEvent = CommonProperties & {
      * Duration in ns of the long task
      */
     readonly duration: number
+    /**
+     * Whether this long task is considered a frozen frame
+     */
+    readonly is_frozen_frame?: boolean
     [k: string]: unknown
   }
   /**
@@ -254,7 +258,7 @@ export type RumResourceEvent = CommonProperties & {
   /**
    * RUM event type
    */
-  readonly type: string
+  readonly type: 'resource'
   /**
    * Resource properties
    */
@@ -438,7 +442,7 @@ export type RumViewEvent = CommonProperties & {
   /**
    * RUM event type
    */
-  readonly type: string
+  readonly type: 'view'
   /**
    * View properties
    */
@@ -509,6 +513,10 @@ export type RumViewEvent = CommonProperties & {
      * Whether the View corresponding to this event is considered active
      */
     readonly is_active?: boolean
+    /**
+     * Whether the View had a low average refresh rate
+     */
+    readonly is_slow_rendered?: boolean
     /**
      * Properties of the actions of the view
      */
@@ -549,6 +557,16 @@ export type RumViewEvent = CommonProperties & {
       readonly count: number
       [k: string]: unknown
     }
+    /**
+     * Properties of the frozen frames of the view
+     */
+    readonly frozen_frame?: {
+      /**
+       * Number of frozen frames that occurred on the view
+       */
+      readonly count: number
+      [k: string]: unknown
+    }
     /**
      * Properties of the resources of the view
      */
@@ -730,14 +748,38 @@ export interface CommonProperties {
     }
     [k: string]: unknown
   }
+  /**
+   * Synthetics properties
+   */
+  readonly synthetics?: {
+    /**
+     * The identifier of the current Synthetics test
+     */
+    readonly test_id: string
+    /**
+     * The identifier of the current Synthetics test results
+     */
+    readonly result_id: string
+    [k: string]: unknown
+  }
   /**
    * Internal properties
    */
   readonly _dd: {
     /**
      * Version of the RUM event format
      */
-    readonly format_version: number
+    readonly format_version: 2
+    /**
+     * Session-related internal properties
+     */
+    session?: {
+      /**
+       * Session plan: 1 is the 'lite' plan, 2 is the 'replay' plan
+       */
+      plan: 1 | 2
+      [k: string]: unknown
+    }
     [k: string]: unknown
   }
   /**