Integrate thomas.lebeau/mf-service-modify (#2788) into staging-23

Integrated commit sha: 7d87b9d

Co-authored-by: Thomas Lebeau <thomas.lebeau@datadoghq.com>

packages/core/src/tools/utils/polyfills.ts

@@ -80,6 +80,7 @@ interface Assignable {
 export function assign<T, U>(target: T, source: U): T & U
 export function assign<T, U, V>(target: T, source1: U, source2: V): T & U & V
 export function assign<T, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W
+export function assign<T, U, V, W, X>(target: T, source1: U, source2: V, source3: W, source4: X): T & U & V & W & X
 export function assign(target: Assignable, ...toAssign: Assignable[]) {
   toAssign.forEach((source: Assignable) => {
     for (const key in source) {

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

@@ -603,6 +603,50 @@ describe('rum assembly', () => {
       expect(serverRumEvents[0].service).toEqual('new service')
       expect(serverRumEvents[0].version).toEqual('new version')
     })
+
+    describe('fields service and version', () => {
+      it('by default, it should not be modifiable', () => {
+        const { lifeCycle } = setupBuilder
+          .withConfiguration({
+            beforeSend: (event) => {
+              event.service = 'bar'
+              event.version = '0.2.0'
+
+              return true
+            },
+          })
+          .build()
+
+        notifyRawRumEvent(lifeCycle, {
+          rawRumEvent: createRawRumEvent(RumEventType.RESOURCE, { resource: { url: '/path?foo=bar' } }),
+        })
+
+        expect((serverRumEvents[0] as RumResourceEvent).service).toBe('default service')
+        expect((serverRumEvents[0] as RumResourceEvent).version).toBe('default version')
+      })
+
+      it('when the micro_frontend experimental flag is set, it should be modifiable', () => {
+        mockExperimentalFeatures([ExperimentalFeature.MICRO_FRONTEND])
+
+        const { lifeCycle } = setupBuilder
+          .withConfiguration({
+            beforeSend: (event) => {
+              event.service = 'bar'
+              event.version = '0.2.0'
+
+              return true
+            },
+          })
+          .build()
+
+        notifyRawRumEvent(lifeCycle, {
+          rawRumEvent: createRawRumEvent(RumEventType.RESOURCE, { resource: { url: '/path?foo=bar' } }),
+        })
+
+        expect((serverRumEvents[0] as RumResourceEvent).service).toBe('bar')
+        expect((serverRumEvents[0] as RumResourceEvent).version).toBe('0.2.0')
+      })
+    })
   })
 
   describe('url context', () => {

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

@@ -72,6 +72,16 @@ export function startRumAssembly(
   getCommonContext: () => CommonContext,
   reportError: (error: RawError) => void
 ) {
+  // TODO: lift this declaration to module level once feature flag is removed
+  const ROOT_MODIFIABLE_FIELD_PATHS: ModifiableFieldPaths = isExperimentalFeatureEnabled(
+    ExperimentalFeature.MICRO_FRONTEND
+  )
+    ? {
+        service: 'string',
+        version: 'string',
+      }
+    : {}
+
   modifiableFieldPathsByEvent = {
     [RumEventType.VIEW]: VIEW_MODIFIABLE_FIELD_PATHS,
     [RumEventType.ERROR]: assign(
@@ -82,24 +92,29 @@ export function startRumAssembly(
         'error.fingerprint': 'string',
       },
       USER_CUSTOMIZABLE_FIELD_PATHS,
-      VIEW_MODIFIABLE_FIELD_PATHS
+      VIEW_MODIFIABLE_FIELD_PATHS,
+      ROOT_MODIFIABLE_FIELD_PATHS
     ),
     [RumEventType.RESOURCE]: assign(
       {
         'resource.url': 'string',
       },
-      isExperimentalFeatureEnabled(ExperimentalFeature.WRITABLE_RESOURCE_GRAPHQL) && {
-        'resource.graphql': 'object',
-      },
+      isExperimentalFeatureEnabled(ExperimentalFeature.WRITABLE_RESOURCE_GRAPHQL)
+        ? {
+            'resource.graphql': 'object',
+          }
+        : {},
       USER_CUSTOMIZABLE_FIELD_PATHS,
-      VIEW_MODIFIABLE_FIELD_PATHS
+      VIEW_MODIFIABLE_FIELD_PATHS,
+      ROOT_MODIFIABLE_FIELD_PATHS
     ),
     [RumEventType.ACTION]: assign(
       {
         'action.target.name': 'string',
       },
       USER_CUSTOMIZABLE_FIELD_PATHS,
-      VIEW_MODIFIABLE_FIELD_PATHS
+      VIEW_MODIFIABLE_FIELD_PATHS,
+      ROOT_MODIFIABLE_FIELD_PATHS
     ),
     [RumEventType.LONG_TASK]: assign({}, USER_CUSTOMIZABLE_FIELD_PATHS, VIEW_MODIFIABLE_FIELD_PATHS),
     [RumEventType.VITAL]: assign({}, USER_CUSTOMIZABLE_FIELD_PATHS, VIEW_MODIFIABLE_FIELD_PATHS),

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

@@ -1116,11 +1116,11 @@ export interface CommonProperties {
   /**
    * The service name for this application
    */
-  readonly service?: string
+  service?: string
   /**
    * The version for this application
    */
-  readonly version?: string
+  version?: string
   /**
    * The build version for this application
    */

test/e2e/scenario/microfrontend.scenario.ts

@@ -5,6 +5,8 @@ import { flushEvents, createTest } from '../lib/framework'
 const HANDLING_STACK_REGEX = /^Error: \n\s+at testHandlingStack @/
 
 const CONFIG: Partial<RumInitConfiguration> = {
+  service: 'main-service',
+  version: '1.0.0',
   enableExperimentalFeatures: ['micro_frontend'],
   beforeSend: (event: RumEvent, domainContext: RumEventDomainContext) => {
     if ('handlingStack' in domainContext) {
@@ -123,4 +125,34 @@ describe('microfrontend', () => {
       expect(event).toBeTruthy()
       expect(event?.context?.handlingStack).toMatch(HANDLING_STACK_REGEX)
     })
+
+  createTest('allow to modify service and version')
+    .withRum(CONFIG)
+    .withRumInit((configuration) => {
+      window.DD_RUM!.init({
+        ...configuration,
+        beforeSend: (event: RumEvent) => {
+          if (event.type === 'resource') {
+            event.service = 'mf-service'
+            event.version = '0.1.0'
+          }
+
+          return true
+        },
+      })
+    })
+    .run(async ({ intakeRegistry }) => {
+      await flushEvents()
+
+      const viewEvent = intakeRegistry.rumViewEvents[0]
+      const resourceEvent = intakeRegistry.rumResourceEvents[0]
+
+      expect(viewEvent).toBeTruthy()
+      expect(viewEvent.service).toBe('main-service')
+      expect(viewEvent.version).toBe('1.0.0')
+
+      expect(resourceEvent).toBeTruthy()
+      expect(resourceEvent.service).toBe('mf-service')
+      expect(resourceEvent.version).toBe('0.1.0')
+    })
 })