✨ [RUMF-758] keep internal context in v1 format (#625)

keep compatibility with logs data format
DataDog · Nov 20, 2020 · 8488478 · 8488478
1 parent de06363
commit 8488478
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 47 deletions.
diff --git a/packages/logs/src/boot/logs.ts b/packages/logs/src/boot/logs.ts
@@ -128,18 +128,5 @@ interface Rum {
 
 function getRUMInternalContext(startTime?: number): Context | undefined {
   const rum = (window as any).DD_RUM as Rum
-  const context = rum && rum.getInternalContext ? rum.getInternalContext(startTime) : undefined
-  if (!context || !context.session) {
-    return context
-  }
-  // TODO settle on integration strategy
-  // tslint:disable:no-unsafe-any
-  const v2context = context as any
-  v2context.session_id = v2context.session.id
-  v2context.application_id = v2context.application.id
-  if (v2context.action) {
-    v2context.user_action = { id: v2context.action.id }
-  }
-  // tslint:enable:no-unsafe-any
-  return v2context as Context
+  return rum && rum.getInternalContext ? rum.getInternalContext(startTime) : undefined
 }
diff --git a/packages/rum/src/domain/internalContext.spec.ts b/packages/rum/src/domain/internalContext.spec.ts
@@ -114,15 +114,11 @@ describe('internal context v2', () => {
     setupBuilder.build()
 
     expect(internalContext.get()).toEqual({
-      action: {
+      application_id: 'appId',
+      session_id: '1234',
+      user_action: {
         id: '7890',
       },
-      application: {
-        id: 'appId',
-      },
-      session: {
-        id: '1234',
-      },
       view: {
         id: 'abcde',
         referrer: 'referrer',

diff --git a/packages/rum/src/domain/internalContext.ts b/packages/rum/src/domain/internalContext.ts
@@ -1,9 +1,12 @@
 import { combine, Configuration, withSnakeCaseKeys } from '@datadog/browser-core'
 import { InternalContext } from '../types'
-import { InternalContextV2 } from '../typesV2'
 import { ParentContexts } from './parentContexts'
 import { RumSession } from './rumSession'
 
+/**
+ * Internal context keep returning v1 format
+ * to not break compatibility with logs data format
+ */
 export function startInternalContext(
   applicationId: string,
   session: RumSession,
@@ -15,17 +18,14 @@ export function startInternalContext(
       if (configuration.isEnabled('v2_format')) {
         const viewContext = parentContexts.findViewV2(startTime)
         if (session.isTracked() && viewContext && viewContext.session.id) {
+          const actionContext = parentContexts.findActionV2(startTime)
           return (withSnakeCaseKeys(
             combine(
-              {
-                application: {
-                  id: applicationId,
-                },
-              },
-              viewContext,
-              parentContexts.findActionV2(startTime)
+              { applicationId },
+              { sessionId: viewContext.session.id, view: viewContext.view },
+              actionContext ? { userAction: { id: actionContext.action.id } } : undefined
             )
-          ) as unknown) as InternalContextV2
+          ) as unknown) as InternalContext
         }
       } else {
         const viewContext = parentContexts.findView(startTime)

diff --git a/packages/rum/src/typesV2.ts b/packages/rum/src/typesV2.ts
@@ -145,20 +145,3 @@ export type RumEventV2 =
   | RumViewEventV2 & ViewContextV2 & RumContextV2
   | RumLongTaskEventV2 & ActionContextV2 & ViewContextV2 & RumContextV2
   | RumActionEventV2 & ViewContextV2 & RumContextV2
-
-export interface InternalContextV2 {
-  application: {
-    id: string
-  }
-  session: {
-    id: string | undefined
-  }
-  view?: {
-    id: string
-    url: string
-    referrer: string
-  }
-  action?: {
-    id: string
-  }
-}