From d0d9d22fe2e1a4a9abea331c4fc954b0b3d86642 Mon Sep 17 00:00:00 2001
From: Iain Sproat <68657+iainsproat@users.noreply.github.com>
Date: Mon, 3 Mar 2025 09:17:55 +0000
Subject: [PATCH] chore(server): tidy up maybeLoggerWithContext (#4095)

---
 packages/server/modules/auth/services/postAuth.ts   |  4 ++--
 packages/server/modules/automate/index.ts           |  8 ++++----
 .../components/express/requestContext.ts            | 13 +++++--------
 3 files changed, 11 insertions(+), 14 deletions(-)

diff --git a/packages/server/modules/auth/services/postAuth.ts b/packages/server/modules/auth/services/postAuth.ts
index d903e1013..755e3888c 100644
--- a/packages/server/modules/auth/services/postAuth.ts
+++ b/packages/server/modules/auth/services/postAuth.ts
@@ -1,5 +1,5 @@
 import { authLogger, type Logger } from '@/observability/logging'
-import { maybeLoggerWithContext } from '@/observability/components/express/requestContext'
+import { loggerWithMaybeContext } from '@/observability/components/express/requestContext'
 import {
   addToMailchimpAudience,
   triggerMailchimpCustomerJourney
@@ -16,7 +16,7 @@ import { mixpanel } from '@/modules/shared/utils/mixpanel'
 
 const onUserCreatedFactory =
   () => async (payload: EventPayload<typeof UserEvents.Created>) => {
-    const logger = maybeLoggerWithContext({ logger: authLogger })!
+    const logger = loggerWithMaybeContext({ logger: authLogger })
     const { user, signUpCtx } = payload.payload
 
     try {
diff --git a/packages/server/modules/automate/index.ts b/packages/server/modules/automate/index.ts
index 0ce22f83a..18ce5b0fe 100644
--- a/packages/server/modules/automate/index.ts
+++ b/packages/server/modules/automate/index.ts
@@ -58,7 +58,7 @@ import { getEventBus } from '@/modules/shared/services/eventBus'
 import { VersionEvents } from '@/modules/core/domain/commits/events'
 import { AutomationEvents, AutomationRunEvents } from '@/modules/automate/domain/events'
 import { LogicError } from '@/modules/shared/errors'
-import { maybeLoggerWithContext } from '@/observability/components/express/requestContext'
+import { loggerWithMaybeContext } from '@/observability/components/express/requestContext'
 
 const { FF_AUTOMATE_MODULE_ENABLED } = getFeatureFlags()
 let quitListeners: Optional<() => void> = undefined
@@ -177,7 +177,7 @@ const initializeEventListeners = () => {
     getEventBus().listen(
       AutomationRunEvents.Created,
       async ({ payload: { manifests, run, automation } }) => {
-        const logger = maybeLoggerWithContext({ logger: automateLogger })!
+        const logger = loggerWithMaybeContext({ logger: automateLogger })
         const validatedManifests = manifests
           .map((manifest) => {
             if (isVersionCreatedTriggerManifest(manifest)) {
@@ -267,7 +267,7 @@ const initializeEventListeners = () => {
       AutomationRunEvents.StatusUpdated,
       async ({ payload: { run, functionRun, automationId, projectId } }) => {
         if (!isFinished(run.status)) return
-        const logger = maybeLoggerWithContext({ logger: automateLogger })!
+        const logger = loggerWithMaybeContext({ logger: automateLogger })
         const projectDb = await getProjectDbClient({ projectId })
         const project = await getProjectFactory({ db: projectDb })({ projectId })
 
@@ -321,7 +321,7 @@ const initializeEventListeners = () => {
     getEventBus().listen(
       AutomationRunEvents.Created,
       async ({ payload: { automation, run: automationRun, source, manifests } }) => {
-        const logger = maybeLoggerWithContext({ logger: automateLogger })!
+        const logger = loggerWithMaybeContext({ logger: automateLogger })
         const manifest = manifests.at(0)
         if (!manifest || !isVersionCreatedTriggerManifest(manifest)) {
           logger.error(
diff --git a/packages/server/observability/components/express/requestContext.ts b/packages/server/observability/components/express/requestContext.ts
index 93b175445..e87c63691 100644
--- a/packages/server/observability/components/express/requestContext.ts
+++ b/packages/server/observability/components/express/requestContext.ts
@@ -40,14 +40,11 @@ export const enterNewRequestContext = (params: { reqId: string }) => {
 
 export const getRequestContext = () => storage?.getStore()
 
-export const maybeLoggerWithContext = ({ logger }: { logger?: Logger }) => {
+export const loggerWithMaybeContext = ({ logger }: { logger: Logger }) => {
   const reqCtx = getRequestContext()
-  return logger?.child({
-    ...(reqCtx
-      ? {
-          req: { id: reqCtx.requestId },
-          dbMetrics: reqCtx.dbMetrics
-        }
-      : {})
+  if (!reqCtx) return logger
+  return logger.child({
+    req: { id: reqCtx.requestId },
+    dbMetrics: reqCtx.dbMetrics
   })
 }