✨[RUMF-1314] Expose a DD_LOGS.getInternalContext

packages/logs/src/boot/logsPublicApi.spec.ts

@@ -12,6 +12,9 @@ import { makeLogsPublicApi } from './logsPublicApi'
 const DEFAULT_INIT_CONFIGURATION = { clientToken: 'xxx' }
 const INVALID_INIT_CONFIGURATION = {} as LogsInitConfiguration
 
+const mockSessionId = 'some-session-id'
+const getInternalContext = () => ({ session_id: mockSessionId })
+
 describe('logs entry', () => {
   let handleLogSpy: jasmine.Spy<
     (
@@ -30,7 +33,7 @@ describe('logs entry', () => {
 
   beforeEach(() => {
     handleLogSpy = jasmine.createSpy()
-    startLogs = jasmine.createSpy().and.callFake(() => ({ handleLog: handleLogSpy }))
+    startLogs = jasmine.createSpy().and.callFake(() => ({ handleLog: handleLogSpy, getInternalContext }))
   })
 
   it('should define the public API with init', () => {
@@ -305,5 +308,22 @@ describe('logs entry', () => {
         expect(LOGS.getLogger('bar')).toBeUndefined()
       })
     })
+
+    describe('internal context', () => {
+      let LOGS: LogsPublicApi
+
+      beforeEach(() => {
+        LOGS = makeLogsPublicApi(startLogs)
+      })
+
+      it('should return undefined if not initalized', () => {
+        expect(LOGS.getInternalContext()).toBeUndefined()
+      })
+
+      it('should get the internal context', () => {
+        LOGS.init(DEFAULT_INIT_CONFIGURATION)
+        expect(LOGS.getInternalContext()?.session_id).toEqual(mockSessionId)
+      })
+    })
   })
 })

packages/logs/src/boot/logsPublicApi.ts

@@ -29,11 +29,14 @@ export type StartLogs = typeof startLogs
 
 type StartLogsResult = ReturnType<typeof startLogs>
 
+type StartTime = number | undefined
+
 export function makeLogsPublicApi(startLogsImpl: StartLogs) {
   let isAlreadyInitialized = false
 
   const globalContextManager = createContextManager()
   const customLoggers: { [name: string]: Logger | undefined } = {}
+  let getInternalContextStrategy: StartLogsResult['getInternalContext'] = () => undefined
 
   const beforeInitLoggerLog = new BoundedBuffer()
 
@@ -76,7 +79,12 @@ export function makeLogsPublicApi(startLogsImpl: StartLogs) {
         return
       }
 
-      ;({ handleLog: handleLogStrategy } = startLogsImpl(configuration, getCommonContext, mainLogger))
+      ;({ handleLog: handleLogStrategy, getInternalContext: getInternalContextStrategy } = startLogsImpl(
+        configuration,
+        getCommonContext,
+        mainLogger
+      ))
+
       getInitConfigurationStrategy = () => deepClone(initConfiguration)
       beforeInitLoggerLog.drain()
 
@@ -105,6 +113,8 @@ export function makeLogsPublicApi(startLogsImpl: StartLogs) {
     getLogger: monitor((name: string) => customLoggers[name]),
 
     getInitConfiguration: monitor(() => getInitConfigurationStrategy()),
+
+    getInternalContext: monitor((startTime?: StartTime) => getInternalContextStrategy(startTime)),
   })
 
   function overrideInitConfigurationForBridge<C extends InitConfiguration>(initConfiguration: C): C {

packages/logs/src/boot/startLogs.ts

@@ -20,6 +20,7 @@ import type { CommonContext } from '../rawLogsEvent.types'
 import { startLogsBatch } from '../transport/startLogsBatch'
 import { startLogsBridge } from '../transport/startLogsBridge'
 import type { Logger } from '../domain/logger'
+import { startInternalContext } from '../domain/internalContext'
 
 export function startLogs(configuration: LogsConfiguration, getCommonContext: () => CommonContext, mainLogger: Logger) {
   const lifeCycle = new LifeCycle()
@@ -59,8 +60,11 @@ export function startLogs(configuration: LogsConfiguration, getCommonContext: ()
     startLogsBridge(lifeCycle)
   }
 
+  const internalContext = startInternalContext(session)
+
   return {
     handleLog,
+    getInternalContext: internalContext.get,
   }
 }
 

packages/logs/src/domain/internalContext.spec.ts

@@ -0,0 +1,22 @@
+import { startInternalContext } from './internalContext'
+
+describe('internal context', () => {
+  it('should return undefined if sessionManager cannot find session', () => {
+    const sessionManagerMock = {
+      findTrackedSession: () => undefined,
+    }
+    expect(startInternalContext(sessionManagerMock).get()).toEqual(undefined)
+  })
+
+  it('should return internal context corresponding to startTime', () => {
+    const sessionIdMock = '123'
+    const sessionManagerMock = {
+      findTrackedSession: () => ({
+        id: sessionIdMock,
+      }),
+    }
+    expect(startInternalContext(sessionManagerMock).get()).toEqual({
+      session_id: sessionIdMock,
+    })
+  })
+})

packages/logs/src/domain/internalContext.ts

@@ -0,0 +1,19 @@
+import type { RelativeTime } from '@datadog/browser-core'
+import type { LogsSessionManager } from './logsSessionManager'
+
+export interface InternalContext {
+  session_id: string | undefined
+}
+
+export function startInternalContext(sessionManager: LogsSessionManager) {
+  return {
+    get: (startTime?: number): InternalContext | undefined => {
+      const trackedSession = sessionManager.findTrackedSession(startTime as RelativeTime)
+      if (trackedSession) {
+        return {
+          session_id: trackedSession.id,
+        }
+      }
+    },
+  }
+}