🐛 [RUM-11848] Block Logs initialization on Node environments (#3904)

fix: block logs in node

fix: compatibility test

fix: linter warnings

fix: super weird linter fix

fix: throw the error

🐛 pr-feedback: replace node check

🐛 replace check

🐛 replace isworker by due to multiple events

🐛 add check for messages

🐛 pr-feedback: add 100% telemetry sample rate

Author: mormubis

packages/core/src/tools/globalObject.ts

@@ -48,4 +48,6 @@ export function getGlobalObject<T = typeof globalThis>(): T {
 // eslint-disable-next-line local-rules/disallow-side-effects
 export const globalObject = getGlobalObject<GlobalObject>()
 
+export const isBrowserEnvironment = 'document' in globalObject
 export const isWorkerEnvironment = 'WorkerGlobalScope' in globalObject
+export const isNodeEnvironment = 'process' in globalObject

packages/logs/src/boot/preStartLogs.ts

@@ -1,5 +1,6 @@
 import type { TrackingConsentState } from '@datadog/browser-core'
 import {
+  isNodeEnvironment,
   createBoundedBuffer,
   canUseEventBridge,
   display,
@@ -55,6 +56,10 @@ export function createPreStartStrategy(
 
   return {
     init(initConfiguration, errorStack) {
+      if (isNodeEnvironment) {
+        return
+      }
+
       if (!initConfiguration) {
         display.error('Missing configuration')
         return

packages/logs/src/boot/startLogs.ts

@@ -1,5 +1,6 @@
 import type { TrackingConsentState, BufferedObservable, BufferedData, PageMayExitEvent } from '@datadog/browser-core'
 import {
+  isBrowserEnvironment,
   Observable,
   sendToExtension,
   createPageMayExitObservable,
@@ -11,7 +12,6 @@ import {
   TelemetryService,
   createIdentityEncoder,
   startUserContext,
-  isWorkerEnvironment,
 } from '@datadog/browser-core'
 import { startLogsSessionManager, startLogsSessionManagerStub } from '../domain/logsSessionManager'
 import type { LogsConfiguration } from '../domain/configuration'
@@ -55,7 +55,7 @@ export function startLogs(
 
   const reportError = startReportError(lifeCycle)
   // Page exit is not observable in worker environments (no window/document events)
-  const pageMayExitObservable = isWorkerEnvironment
+  const pageMayExitObservable = !isBrowserEnvironment
     ? new Observable<PageMayExitEvent>()
     : createPageMayExitObservable(configuration)
 

packages/logs/src/domain/networkError/networkErrorCollection.ts

@@ -1,6 +1,6 @@
 import type { FetchResolveContext, XhrCompleteContext } from '@datadog/browser-core'
 import {
-  isWorkerEnvironment,
+  isBrowserEnvironment,
   Observable,
   ErrorSource,
   initXhrObservable,
@@ -28,7 +28,7 @@ export function startNetworkErrorCollection(configuration: LogsConfiguration, li
 
   // XHR is not available in web workers, so we use an empty observable that never emits
   const xhrSubscription = (
-    isWorkerEnvironment ? new Observable<XhrCompleteContext>() : initXhrObservable(configuration)
+    !isBrowserEnvironment ? new Observable<XhrCompleteContext>() : initXhrObservable(configuration)
   ).subscribe((context) => {
     if (context.state === 'complete') {
       handleResponse(RequestType.XHR, context)

packages/rum-core/src/boot/preStartRum.ts

@@ -1,5 +1,6 @@
 import type { TrackingConsentState, DeflateWorker, Context, ContextManager, BoundedBuffer } from '@datadog/browser-core'
 import {
+  isNodeEnvironment,
   createBoundedBuffer,
   display,
   canUseEventBridge,
@@ -100,6 +101,10 @@ export function createPreStartStrategy(
   }
 
   function doInit(initConfiguration: RumInitConfiguration, errorStack?: string) {
+    if (isNodeEnvironment) {
+      return
+    }
+
     const eventBridgeAvailable = canUseEventBridge()
     if (eventBridgeAvailable) {
       initConfiguration = overrideInitConfigurationForBridge(initConfiguration)

test/apps/vanilla/app.ts

@@ -17,8 +17,19 @@ if (typeof window !== 'undefined') {
     window.RUM_INIT()
   }
 } else {
+  // Document is always generated by the SSR environment
+  // @ts-ignore If document is mocked, the SDK executes further enough to throw an error
+  globalThis.document = {}
+  ;(globalThis as any).__ddBrowserSdkExtensionCallback = () => {
+    throw new Error('the SDK should not send events')
+  }
+
   // compat test
-  datadogLogs.init({ clientToken: 'xxx', beforeSend: undefined })
-  datadogRum.init({ clientToken: 'xxx', applicationId: 'xxx', beforeSend: undefined })
+  datadogLogs.init({ clientToken: 'xxx', beforeSend: undefined, telemetrySampleRate: 100 })
+  datadogRum.init({ clientToken: 'xxx', applicationId: 'xxx', beforeSend: undefined, telemetrySampleRate: 100 })
   datadogRum.setUser({ id: undefined })
+
+  if (datadogLogs.getInternalContext() || datadogRum.getInternalContext()) {
+    throw new Error('SDK should not start on SSR environments')
+  }
 }