✨ [RUM-10044] Support for overriding the source (#3659)

* ✨ override source

* ✨ override version

* ♻️ revert sandbox config

* ♻️ add types to telemetry

* 🐛 fix conflict

* 🐛 telemetry of other sdks do not send the additional configuration

* 🐛 telemetry serialization

* 🐛 pr-feedback: remove namespace

* 👷 update rum format

* 🐛 format

* 🐛 pr-feedback: simplify sdk version

* 🐛 reduced the surface to browser or flutter

* 🐛 tests

* 🐛 pr-feedback: join test

* 🐛 linter warnings

* 🐛 revert change in schema

* 🐛 default value deleted on conflicts

* 🐛 default value - test

* 🐛 pr-feedback: move everything to tags

* ♻️ revert browser_sdk_version to be compliance with webview

* 👷 update rum format

* 🐛 pr-feedback: source verification on initconfiguration

* 🐛 sync json-schema

* 🐛 pr-feedback: add internal tag

* ♻️ rebase

* Apply suggestion from @BenoitZugmeyer

Co-authored-by: Benoît <[email protected]>

* 🐛 pr-feedback: remove optional chaining

---------

Co-authored-by: Benoît <[email protected]>

Author: mormubis

developer-extension/src/panel/components/tabs/eventsTab/copyEvent.spec.ts

@@ -32,6 +32,7 @@ describe('getIntakeUrlForEvent', () => {
           rum: {
             config: {
               clientToken: 'client-token',
+              source: 'browser',
             },
             version: '1.2.3',
           },
@@ -57,6 +58,7 @@ describe('getIntakeUrlForEvent', () => {
           rum: {
             config: {
               clientToken: 'client-token',
+              source: 'browser',
             },
             version: '1.2.3&4',
           },
@@ -75,6 +77,7 @@ describe('getIntakeUrlForEvent', () => {
           rum: {
             config: {
               clientToken: 'client-token',
+              source: 'browser',
             },
             version: '1.2.3',
           },
@@ -93,6 +96,7 @@ describe('getIntakeUrlForEvent', () => {
           logs: {
             config: {
               clientToken: 'client-token',
+              source: 'browser',
             },
             version: '1.2.3',
           },

packages/core/src/domain/configuration/configuration.ts

@@ -216,6 +216,27 @@ export interface InitConfiguration {
    * @defaultValue 5
    */
   telemetryUsageSampleRate?: number
+
+  /**
+   * [Internal option] Additional configuration for the SDK.
+   *
+   * @internal
+   */
+  source?: 'browser' | 'flutter' | undefined
+
+  /**
+   * [Internal option] Additional configuration for the SDK.
+   *
+   * @internal
+   */
+  sdkVersion?: string | undefined
+
+  /**
+   * [Internal option] Additional configuration for the SDK.
+   *
+   * @internal
+   */
+  variant?: string | undefined
 }
 
 // This type is only used to build the core configuration. Logs and RUM SDKs are using a proper type
@@ -261,6 +282,11 @@ export interface Configuration extends TransportConfiguration {
   flushTimeout: Duration
   batchMessagesLimit: number
   messageBytesLimit: number
+
+  // internal
+  sdkVersion: string | undefined
+  source: 'browser' | 'flutter'
+  variant: string | undefined
 }
 
 function isString(tag: unknown, tagName: string): tag is string | undefined | null {
@@ -360,6 +386,13 @@ export function validateAndBuildConfiguration(initConfiguration: InitConfigurati
      */
     batchMessagesLimit: 50,
     messageBytesLimit: 256 * ONE_KIBI_BYTE,
+
+    /**
+     * The source of the SDK, used for support plugins purposes.
+     */
+    variant: initConfiguration.variant,
+    sdkVersion: initConfiguration.sdkVersion,
+
     ...computeTransportConfiguration(initConfiguration),
   }
 }
@@ -383,5 +416,8 @@ export function serializeConfiguration(initConfiguration: InitConfiguration) {
     allow_untrusted_events: !!initConfiguration.allowUntrustedEvents,
     tracking_consent: initConfiguration.trackingConsent,
     use_allowed_tracking_origins: Array.isArray(initConfiguration.allowedTrackingOrigins),
+    source: initConfiguration.source,
+    sdk_version: initConfiguration.sdkVersion,
+    variant: initConfiguration.variant,
   } satisfies RawTelemetryConfiguration
 }

packages/core/src/domain/configuration/endpointBuilder.spec.ts

@@ -151,4 +151,17 @@ describe('endpointBuilder', () => {
       )
     })
   })
+
+  describe('source configuration', () => {
+    it('should use the default source when no configuration is provided', () => {
+      const endpoint = createEndpointBuilder(initConfiguration, 'rum').build('fetch', DEFAULT_PAYLOAD)
+      expect(endpoint).toContain('ddsource=browser')
+    })
+
+    it('should source when provided', () => {
+      const config = { ...initConfiguration, source: 'flutter' as const }
+      const endpoint = createEndpointBuilder(config, 'rum').build('fetch', DEFAULT_PAYLOAD)
+      expect(endpoint).toContain('ddsource=flutter')
+    })
+  })
 })

packages/core/src/domain/configuration/endpointBuilder.ts

@@ -85,14 +85,14 @@ export function buildEndpointHost(
  * request, as they change randomly.
  */
 function buildEndpointParameters(
-  { clientToken, internalAnalyticsSubdomain }: InitConfiguration,
+  { clientToken, internalAnalyticsSubdomain, source = 'browser' }: InitConfiguration,
   trackType: TrackType,
   api: ApiType,
   { retry, encoding }: Payload,
   extraParameters: string[] = []
 ) {
   const parameters = [
-    'ddsource=browser',
+    `ddsource=${source}`,
     `dd-api-key=${clientToken}`,
     `dd-evp-origin-version=${encodeURIComponent(__BUILD_ENV__SDK_VERSION__)}`,
     'dd-evp-origin=browser',

packages/core/src/domain/configuration/tags.ts

@@ -7,8 +7,8 @@ export const TAG_SIZE_LIMIT = 200
 declare const __BUILD_ENV__SDK_VERSION__: string
 
 export function buildTags(configuration: Configuration): string[] {
-  const { env, service, version, datacenter } = configuration
-  const tags = [buildTag('sdk_version', __BUILD_ENV__SDK_VERSION__)]
+  const { env, service, version, datacenter, sdkVersion, variant } = configuration
+  const tags = [buildTag('sdk_version', sdkVersion ?? __BUILD_ENV__SDK_VERSION__)]
 
   if (env) {
     tags.push(buildTag('env', env))
@@ -23,6 +23,10 @@ export function buildTags(configuration: Configuration): string[] {
     tags.push(buildTag('datacenter', datacenter))
   }
 
+  if (variant) {
+    tags.push(buildTag('variant', variant))
+  }
+
   return tags
 }
 

packages/core/src/domain/configuration/transportConfiguration.ts

@@ -13,6 +13,7 @@ export interface TransportConfiguration {
   datacenter?: string | undefined
   replica?: ReplicaConfiguration
   site: Site
+  source: 'browser' | 'flutter'
 }
 
 export interface ReplicaConfiguration {
@@ -22,13 +23,15 @@ export interface ReplicaConfiguration {
 
 export function computeTransportConfiguration(initConfiguration: InitConfiguration): TransportConfiguration {
   const site = initConfiguration.site || INTAKE_SITE_US1
+  const source = initConfiguration.source === 'flutter' ? 'flutter' : 'browser'
 
-  const endpointBuilders = computeEndpointBuilders(initConfiguration)
-  const replicaConfiguration = computeReplicaConfiguration(initConfiguration)
+  const endpointBuilders = computeEndpointBuilders({ ...initConfiguration, site, source })
+  const replicaConfiguration = computeReplicaConfiguration({ ...initConfiguration, site, source })
 
   return {
     replica: replicaConfiguration,
     site,
+    source,
     ...endpointBuilders,
   }
 }

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

@@ -427,6 +427,22 @@ export type TelemetryConfigurationEvent = CommonTelemetryProperties & {
        * Whether a list of allowed origins is used to control SDK execution in browser extension contexts. When enabled, the SDK will check if the current origin matches the allowed origins list before running.
        */
       use_allowed_tracking_origins?: boolean
+      /**
+       * The version of the SDK that is running.
+       */
+      sdk_version?: string
+      /**
+       * The source of the SDK, e.g., 'browser', 'ios', 'android', 'flutter', 'react-native', 'unity', 'kotlin-multiplatform'.
+       */
+      source?: string
+      /**
+       * The variant of the SDK build (e.g., standard, lite, etc.).
+       */
+      variant?: string
+      /**
+       * The id of the remote configuration
+       */
+      remote_configuration_id?: string
       [k: string]: unknown
     }
     [k: string]: unknown

packages/core/test/coreConfiguration.ts

@@ -38,6 +38,9 @@ export const EXHAUSTIVE_INIT_CONFIGURATION: Required<InitConfiguration> = {
   telemetryConfigurationSampleRate: 70,
   telemetryUsageSampleRate: 80,
   allowedTrackingOrigins: ['chrome-extension://example'],
+  source: 'browser',
+  sdkVersion: '1.0.0',
+  variant: 'variant',
 }
 
 export const SERIALIZED_EXHAUSTIVE_INIT_CONFIGURATION = {
@@ -58,6 +61,9 @@ export const SERIALIZED_EXHAUSTIVE_INIT_CONFIGURATION = {
   tracking_consent: 'not-granted' as const,
   track_anonymous_user: true,
   use_allowed_tracking_origins: true,
+  source: 'browser',
+  sdk_version: '1.0.0',
+  variant: 'variant',
 }
 
 /**

packages/rum-core/src/domain/contexts/defaultContext.ts

@@ -10,9 +10,10 @@ export function startDefaultContext(
   configuration: RumConfiguration,
   sdkName: 'rum' | 'rum-slim' | 'rum-synthetics' | undefined
 ) {
-  hooks.register(
-    HookNames.Assemble,
-    ({ eventType }): DefaultRumEventAttributes => ({
+  hooks.register(HookNames.Assemble, ({ eventType }): DefaultRumEventAttributes => {
+    const source = configuration.source
+
+    return {
       type: eventType,
       _dd: {
         format_version: 2,
@@ -29,9 +30,9 @@ export function startDefaultContext(
         id: configuration.applicationId,
       },
       date: timeStampNow(),
-      source: 'browser',
-    })
-  )
+      source,
+    }
+  })
 
   hooks.register(
     HookNames.AssembleTelemetry,

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

@@ -1239,11 +1239,15 @@ export type RumVitalEvent = CommonProperties &
       /**
        * Type of the vital
        */
-      readonly type: 'duration'
+      readonly type: 'duration' | 'operation_step'
       /**
        * UUID of the vital
        */
       readonly id: string
+      /**
+       * UUID for distinguishing the active operations in parallel, if applicable
+       */
+      readonly operation_key?: string
       /**
        * Name of the vital, as it is also used as facet path for its value, it must contain only letters, digits, or the characters - _ . @ $
        */
@@ -1257,11 +1261,13 @@ export type RumVitalEvent = CommonProperties &
        */
       readonly duration?: number
       /**
-       * User custom vital.
+       * Type of the step that triggered the vital, if applicable
        */
-      readonly custom?: {
-        [k: string]: number
-      }
+      readonly step_type?: 'start' | 'update' | 'retry' | 'end'
+      /**
+       * Reason for the failure of the step, if applicable
+       */
+      readonly failure_reason?: 'error' | 'abandoned' | 'other'
       [k: string]: unknown
     }
     /**
@@ -1959,5 +1965,9 @@ export interface ViewAccessibilityProperties {
    * Indicates whether the text-to-speech selection feature is enabled.
    */
   readonly speak_selection_enabled?: boolean
+  /**
+   * Indicates whether the right-to-left support is enabled.
+   */
+  readonly rtl_enabled?: boolean
   [k: string]: unknown
 }