add loggerWithContext to web

Author: charleslien

common/src/types/contracts/logger.ts

@@ -10,3 +10,5 @@ export type Logger = {
   warn: LoggerFn
   error: LoggerFn
 }
+
+export type LoggerWithContextFn = (context: Record<string, any>) => Logger

web/src/app/api/v1/agent-runs/[runId]/steps/_post.ts

@@ -8,7 +8,10 @@ import { z } from 'zod'
 
 import type { TrackEventFn } from '@codebuff/common/types/contracts/analytics'
 import type { GetUserInfoFromApiKeyFn } from '@codebuff/common/types/contracts/database'
-import type { Logger } from '@codebuff/common/types/contracts/logger'
+import type {
+  Logger,
+  LoggerWithContextFn,
+} from '@codebuff/common/types/contracts/logger'
 import type { CodebuffPgDatabase } from '@codebuff/internal/db/types'
 import type { NextRequest } from 'next/server'
 
@@ -29,10 +32,19 @@ export async function postAgentRunsSteps(params: {
   runId: string
   getUserInfoFromApiKey: GetUserInfoFromApiKeyFn
   logger: Logger
+  loggerWithContext: LoggerWithContextFn
   trackEvent: TrackEventFn
   db: CodebuffPgDatabase
 }) {
-  const { req, runId, getUserInfoFromApiKey, logger, trackEvent, db } = params
+  const {
+    req,
+    runId,
+    getUserInfoFromApiKey,
+    loggerWithContext,
+    trackEvent,
+    db,
+  } = params
+  let { logger } = params
 
   const apiKey = extractApiKeyFromHeader(req)
 
@@ -46,7 +58,7 @@ export async function postAgentRunsSteps(params: {
   // Get user info
   const userInfo = await getUserInfoFromApiKey({
     apiKey,
-    fields: ['id'],
+    fields: ['id', 'email', 'discord_id'],
     logger,
   })
 
@@ -56,6 +68,7 @@ export async function postAgentRunsSteps(params: {
       { status: 404 },
     )
   }
+  logger = loggerWithContext({ userInfo })
 
   // Parse and validate request body
   let body: unknown

web/src/app/api/v1/agent-runs/[runId]/steps/route.ts

@@ -6,7 +6,7 @@ import { postAgentRunsSteps } from './_post'
 import type { NextRequest } from 'next/server'
 
 import { getUserInfoFromApiKey } from '@/db/user'
-import { logger } from '@/util/logger'
+import { logger, loggerWithContext } from '@/util/logger'
 
 export async function POST(
   req: NextRequest,
@@ -18,6 +18,7 @@ export async function POST(
     runId,
     getUserInfoFromApiKey,
     logger,
+    loggerWithContext,
     trackEvent,
     db,
   })

web/src/app/api/v1/agent-runs/_post.ts

@@ -8,7 +8,10 @@ import { z } from 'zod'
 
 import type { TrackEventFn } from '@codebuff/common/types/contracts/analytics'
 import type { GetUserInfoFromApiKeyFn } from '@codebuff/common/types/contracts/database'
-import type { Logger } from '@codebuff/common/types/contracts/logger'
+import type {
+  Logger,
+  LoggerWithContextFn,
+} from '@codebuff/common/types/contracts/logger'
 import type { CodebuffPgDatabase } from '@codebuff/internal/db/types'
 import type { NextRequest } from 'next/server'
 
@@ -169,10 +172,13 @@ export async function postAgentRuns(params: {
   req: NextRequest
   getUserInfoFromApiKey: GetUserInfoFromApiKeyFn
   logger: Logger
+  loggerWithContext: LoggerWithContextFn
   trackEvent: TrackEventFn
   db: CodebuffPgDatabase
 }) {
-  const { req, getUserInfoFromApiKey, logger, trackEvent, db } = params
+  const { req, getUserInfoFromApiKey, loggerWithContext, trackEvent, db } =
+    params
+  let { logger } = params
 
   const apiKey = extractApiKeyFromHeader(req)
 
@@ -186,7 +192,7 @@ export async function postAgentRuns(params: {
   // Get user info
   const userInfo = await getUserInfoFromApiKey({
     apiKey,
-    fields: ['id'],
+    fields: ['id', 'email', 'discord_id'],
     logger,
   })
 
@@ -197,6 +203,8 @@ export async function postAgentRuns(params: {
     )
   }
 
+  logger = loggerWithContext({ userInfo })
+
   // Track API request
   trackEvent({
     event: AnalyticsEvent.AGENT_RUN_API_REQUEST,

web/src/app/api/v1/agent-runs/route.ts

@@ -6,8 +6,8 @@ import { postAgentRuns } from './_post'
 import type { NextRequest } from 'next/server'
 
 import { getUserInfoFromApiKey } from '@/db/user'
-import { logger } from '@/util/logger'
+import { logger, loggerWithContext } from '@/util/logger'
 
 export async function POST(req: NextRequest) {
-  return postAgentRuns({ req, getUserInfoFromApiKey, logger, trackEvent, db })
+  return postAgentRuns({ req, getUserInfoFromApiKey, logger, loggerWithContext, trackEvent, db })
 }

web/src/app/api/v1/chat/completions/_post.ts

@@ -10,7 +10,10 @@ import type {
   GetAgentRunFromIdFn,
   GetUserInfoFromApiKeyFn,
 } from '@codebuff/common/types/contracts/database'
-import type { Logger } from '@codebuff/common/types/contracts/logger'
+import type {
+  Logger,
+  LoggerWithContextFn,
+} from '@codebuff/common/types/contracts/logger'
 import type { NextRequest } from 'next/server'
 
 import {
@@ -23,6 +26,7 @@ export async function postChatCompletions(params: {
   req: NextRequest
   getUserInfoFromApiKey: GetUserInfoFromApiKeyFn
   logger: Logger
+  loggerWithContext: LoggerWithContextFn
   trackEvent: TrackEventFn
   getUserUsageData: GetUserUsageDataFn
   getAgentRunFromId: GetAgentRunFromIdFn
@@ -32,13 +36,14 @@ export async function postChatCompletions(params: {
   const {
     req,
     getUserInfoFromApiKey,
-    logger,
+    loggerWithContext,
     trackEvent,
     getUserUsageData,
     getAgentRunFromId,
     fetch,
     insertMessageBigquery,
   } = params
+  let { logger } = params
 
   try {
     // Parse request body
@@ -80,7 +85,7 @@ export async function postChatCompletions(params: {
     // Get user info
     const userInfo = await getUserInfoFromApiKey({
       apiKey,
-      fields: ['id'],
+      fields: ['id', 'email', 'discord_id'],
       logger,
     })
     if (!userInfo) {
@@ -97,6 +102,7 @@ export async function postChatCompletions(params: {
         { status: 401 },
       )
     }
+    logger = loggerWithContext({ userInfo })
 
     const userId = userInfo.id
 
@@ -107,6 +113,7 @@ export async function postChatCompletions(params: {
       properties: {
         hasStream: !!bodyStream,
         hasRunId: !!runId,
+        userInfo,
       },
       logger,
     })

web/src/app/api/v1/chat/completions/route.ts

@@ -8,13 +8,14 @@ import type { NextRequest } from 'next/server'
 
 import { getAgentRunFromId } from '@/db/agent-run'
 import { getUserInfoFromApiKey } from '@/db/user'
-import { logger } from '@/util/logger'
+import { logger, loggerWithContext } from '@/util/logger'
 
 export async function POST(req: NextRequest) {
   return postChatCompletions({
     req,
     getUserInfoFromApiKey,
     logger,
+    loggerWithContext,
     trackEvent,
     getUserUsageData,
     getAgentRunFromId,

web/src/app/api/v1/me/__tests__/route.test.ts renamed to web/src/app/api/v1/me/__tests__/me.test.ts

@@ -6,6 +6,9 @@ import { env } from '@codebuff/common/env'
 import { splitData } from '@codebuff/common/util/split-data'
 import pino from 'pino'
 
+import type { LoggerWithContextFn } from '@codebuff/common/types/contracts/logger'
+import type { ParamsOf } from '@codebuff/common/types/function-params'
+
 // --- Constants ---
 const MAX_LENGTH = 65535 // Max total log size is sometimes 100k (sometimes 65535?)
 const BUFFER = 1000 // Buffer for context, etc.
@@ -117,3 +120,16 @@ export const logger: Record<LogLevel, pino.LogFn> =
           ]
         }),
       ) as Record<LogLevel, pino.LogFn>)
+
+export function loggerWithContext(
+  context: ParamsOf<LoggerWithContextFn>,
+): ReturnType<LoggerWithContextFn> {
+  return {
+    debug: (data: any, ...args) =>
+      logger.debug({ ...context, ...data }, ...args),
+    info: (data: any, ...args) => logger.info({ ...context, ...data }, ...args),
+    warn: (data: any, ...args) => logger.warn({ ...context, ...data }, ...args),
+    error: (data: any, ...args) =>
+      logger.error({ ...context, ...data }, ...args),
+  }
+}