Migrate src/search console statements to structured logger (#61080)

Author: Ebonsignori

eslint.config.ts

@@ -161,6 +161,17 @@ export default [
     },
   },
 
+  // Client-side files that run in the browser where the server-only logger is unavailable
+  {
+    files: [
+      'src/search/components/hooks/useAISearchAutocomplete.ts',
+      'src/search/components/hooks/useAISearchLocalStorageCache.ts',
+    ],
+    rules: {
+      'custom-rules/use-custom-logger': 'off',
+    },
+  },
+
   // Disable custom logger rule for logger implementation itself
   {
     files: ['src/observability/logger/**/*.{ts,js}'],
@@ -183,7 +194,6 @@ export default [
       'src/journeys/**/*.{ts,js}',
       'src/metrics/**/*.{ts,js}',
       'src/observability/lib/handle-package-not-found.ts',
-      'src/search/**/*.{ts,js}',
     ],
     rules: {
       'custom-rules/use-custom-logger': 'off',

src/search/lib/ai-search-proxy.ts

@@ -1,11 +1,14 @@
 import { Response } from 'express'
+import { createLogger } from '@/observability/logger'
 import statsd from '@/observability/lib/statsd'
 import { fetchStream } from '@/frame/lib/fetch-utils'
 import { getHmacWithEpoch } from '@/search/lib/helpers/get-cse-copilot-auth'
 import { getCSECopilotSource } from '@/search/lib/helpers/cse-copilot-docs-versions'
 import type { ExtendedRequest } from '@/types'
 import { handleExternalSearchAnalytics } from '@/search/lib/helpers/external-search-analytics'
 
+const logger = createLogger(import.meta.url)
+
 // Maximum time (ms) to wait for the initial response from the upstream
 // AI search service. Streaming may take longer once the connection is
 // established, but the connect + first-byte must complete within this window.
@@ -83,7 +86,7 @@ export const aiSearchProxy = async (req: ExtendedRequest, res: Response) => {
 
     if (!response.ok) {
       const errorMessage = `Upstream server responded with status code ${response.status}`
-      console.error(errorMessage)
+      logger.error(errorMessage, { statusCode: response.status })
       statsd.increment('ai-search.stream_response_error', 1, diagnosticTags)
       res.status(response.status).json({
         errors: [{ message: errorMessage }],
@@ -131,7 +134,7 @@ export const aiSearchProxy = async (req: ExtendedRequest, res: Response) => {
       statsd.increment('ai-search.success_stream_end', 1, diagnosticTags)
       res.end()
     } catch (streamError) {
-      console.error('Error streaming from cse-copilot:', streamError)
+      logger.error('Error streaming from cse-copilot', { error: streamError })
       statsd.increment('ai-search.stream_error', 1, diagnosticTags)
 
       if (!res.headersSent) {
@@ -153,11 +156,11 @@ export const aiSearchProxy = async (req: ExtendedRequest, res: Response) => {
 
     if (isTimeout) {
       statsd.increment('ai-search.timeout', 1, diagnosticTags)
-      console.error(`AI search request timed out after ${AI_SEARCH_TIMEOUT_MS}ms`)
+      logger.error('AI search request timed out', { timeoutMs: AI_SEARCH_TIMEOUT_MS })
       res.status(504).json({ errors: [{ message: 'Upstream request timed out' }] })
     } else {
       statsd.increment('ai-search.route_error', 1, diagnosticTags)
-      console.error('Error posting /answers to cse-copilot:', error)
+      logger.error('Error posting /answers to cse-copilot', { error })
       res.status(500).json({ errors: [{ message: 'Internal server error' }] })
     }
   } finally {

src/search/lib/helpers/get-client.ts

@@ -1,5 +1,8 @@
 import { Client } from '@elastic/elasticsearch'
 import { safeUrlDisplay } from '@/search/lib/helpers/strings'
+import { createLogger } from '@/observability/logger'
+
+const logger = createLogger(import.meta.url)
 
 const DEFAULT_REQUEST_TIMEOUT = 5000
 
@@ -10,7 +13,7 @@ export function getElasticsearchClient(
 ): Client {
   const node = getElasticsearchURL(overrideURL)
   if (verbose) {
-    console.log('Connecting to Elasticsearch URL:', safeUrlDisplay(node))
+    logger.info('Connecting to Elasticsearch URL', { url: safeUrlDisplay(node) })
   }
   const client = new Client({
     node,

src/search/middleware/ai-search-local-proxy.ts

@@ -3,6 +3,9 @@
 import { Router, Request, Response, NextFunction } from 'express'
 import { fetchStream } from '@/frame/lib/fetch-utils'
 import { pipeline, Readable } from 'node:stream'
+import { createLogger } from '@/observability/logger'
+
+const logger = createLogger(import.meta.url)
 
 const router = Router()
 
@@ -84,7 +87,7 @@ router.post('/ai-search/v1', async (req: Request, res: Response, next: NextFunct
 
     pipeline(nodeStream, res, (err) => {
       if (err) {
-        console.error('[ai-search proxy] pipeline error:', err)
+        logger.error('[ai-search proxy] pipeline error', { error: err })
         if (!res.headersSent) res.status(502).end('Bad Gateway')
       }
       if (reader) {
@@ -93,7 +96,7 @@ router.post('/ai-search/v1', async (req: Request, res: Response, next: NextFunct
       }
     })
   } catch (err) {
-    console.error('[ai-search proxy] request failed:', err)
+    logger.error('[ai-search proxy] request failed', { error: err })
     next(err)
   } finally {
     // Ensure reader lock is always released

src/search/middleware/general-search-middleware.ts

@@ -8,6 +8,7 @@ When a user directly hits our API e.g. /api/search/v1?query=foo, they will hit t
 
 import { fetchWithRetry } from '@/frame/lib/fetch-utils'
 import { Request, Response, NextFunction } from 'express'
+import { createLogger } from '@/observability/logger'
 import { errors } from '@elastic/elasticsearch'
 import statsd, { adaptForTimer } from '@/observability/lib/statsd'
 
@@ -23,6 +24,8 @@ import type {
   SearchValidationErrorEntry,
 } from '@/search/types'
 
+const logger = createLogger(import.meta.url)
+
 interface Context<Type extends SearchTypes> {
   currentVersion: string
   currentLanguage: string
@@ -122,17 +125,12 @@ export default async function contextualizeGeneralSearch(
       } catch (error) {
         // If the Elasticsearch sends a 4XX we want the user to see a 500
         if (error instanceof errors.ResponseError) {
-          console.error(
-            'Error calling getSearchResults(%s):',
-            JSON.stringify({
-              indexName,
-              searchParams,
-            }),
+          logger.error('Error calling getSearchResults', {
+            indexName,
+            searchParams,
             error,
-          )
-          if (error?.meta?.body) {
-            console.error(`Meta:`, error.meta.body)
-          }
+            meta: error?.meta?.body,
+          })
           throw new Error(error.message)
         } else {
           throw error
@@ -175,7 +173,7 @@ async function getProxySearch(
   }
   // Add client_name for external API requests
   url.searchParams.set('client_name', 'docs.github.com-client')
-  console.log(`Proxying search to ${url}`)
+  logger.info('Proxying search', { url: url.toString() })
 
   const response = await fetchWithRetry(url.toString())
   if (!response.ok) {

src/search/middleware/search-routes.ts

@@ -12,7 +12,7 @@ import { aiSearchAutocompleteRoute } from '@/search/lib/routes/ai-search-autocom
 import { combinedSearchRoute } from '@/search/lib/routes/combined-search-route'
 import { createLogger } from '@/observability/logger'
 
-const logger = createLogger('search:middleware:search-routes')
+const logger = createLogger(import.meta.url)
 const router = express.Router()
 
 router.get('/legacy', (req: Request, res: Response) => {
@@ -35,7 +35,7 @@ export async function handleGetSearchResultsError(
 ) {
   const errorMessage = error instanceof Error ? error.message : String(error)
   if (process.env.NODE_ENV === 'development') {
-    console.error(`Error calling getSearchResults(${options})`, error)
+    logger.error('Error calling getSearchResults', { options, error })
   } else {
     const extra: Record<string, unknown> =
       options && typeof options === 'object' && !Array.isArray(options)