Migrate src/content-render console statements to structured logger (#60984)

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Author: Ebonsignori

eslint.config.ts

@@ -177,7 +177,6 @@ export default [
       'src/article-api/**/*.{ts,js}',
       'src/audit-logs/**/*.{ts,js}',
       'src/color-schemes/**/*.{ts,js}',
-      'src/content-render/**/*.{ts,js}',
       'src/data-directory/**/*.{ts,js}',
       'src/dev-toc/**/*.{ts,js}',
       'src/events/**/*.{ts,js}',

src/content-render/index.ts

@@ -2,6 +2,9 @@ import { renderLiquid } from './liquid/index'
 import { renderMarkdown, renderUnified } from './unified/index'
 import { engine } from './liquid/engine'
 import type { Context } from '@/types'
+import { createLogger } from '@/observability/logger'
+
+const logger = createLogger(import.meta.url)
 
 interface RenderOptions {
   cache?: boolean | ((template: string, context: Context) => string)
@@ -53,7 +56,7 @@ export async function renderContent(
     return html
   } catch (error) {
     if (options.filename) {
-      console.error(`renderContent failed on file: ${options.filename}`)
+      logger.error('renderContent failed on file', { filename: options.filename })
     }
     throw error
   }

src/content-render/liquid/data.ts

@@ -3,6 +3,9 @@ import type { TagToken, Liquid, Template } from 'liquidjs'
 
 import { THROW_ON_EMPTY, DataReferenceError } from './error-handling'
 import { getDataByLanguage } from '@/data-directory/lib/get-data'
+import { createLogger } from '@/observability/logger'
+
+const logger = createLogger(import.meta.url)
 
 const Syntax = /([a-z0-9/\\_.\-[\]]+)/i
 const SyntaxHelp = "Syntax Error in 'data' - Valid syntax: data [path]"
@@ -42,7 +45,7 @@ export default {
         if (THROW_ON_EMPTY) {
           throw new DataReferenceError(message)
         }
-        console.warn(message)
+        logger.warn(message)
       }
       return
     }

src/content-render/liquid/ifversion.ts

@@ -14,6 +14,9 @@ import versionSatisfiesRange from '@/versions/lib/version-satisfies-range'
 import supportedOperators, {
   type IfversionSupportedOperator,
 } from './ifversion-supported-operators'
+import { createLogger } from '@/observability/logger'
+
+const logger = createLogger(import.meta.url)
 
 interface Branch {
   cond: string
@@ -174,17 +177,7 @@ export default class Ifversion extends Tag {
     }
 
     if (!this.currentVersionObj) {
-      console.warn(
-        `
-        If this happens, it means the context prepared for rendering Liquid
-        did not supply an object called 'currentVersionObj'.
-        To fix the error, find the code that prepares the context before
-        calling 'liquid.parseAndRender' and make sure there's an object
-        called 'currentVersionObj' included there.
-      `
-          .replace(/\n\s+/g, ' ')
-          .trim(),
-      )
+      logger.warn('Context missing currentVersionObj for Liquid rendering')
       throw new Error('currentVersionObj not found in environment context.')
     }
 
@@ -222,7 +215,7 @@ export default class Ifversion extends Tag {
 
   handleVersionNames(resolvedBranchCond: string): string {
     if (!this.currentVersionObj) {
-      console.warn('currentVersionObj not found in ifversion context.')
+      logger.warn('currentVersionObj not found in ifversion context')
       return resolvedBranchCond
     }
 

src/content-render/liquid/indented-data-reference.ts

@@ -3,6 +3,9 @@ import assert from 'assert'
 import { type TagToken, type Liquid } from 'liquidjs'
 import { THROW_ON_EMPTY, IndentedDataReferenceError } from './error-handling'
 import { getDataByLanguage } from '@/data-directory/lib/get-data'
+import { createLogger } from '@/observability/logger'
+
+const logger = createLogger(import.meta.url)
 
 interface LiquidScope {
   environments: {
@@ -55,7 +58,7 @@ const IndentedDataReference = {
         if (THROW_ON_EMPTY) {
           throw new IndentedDataReferenceError(message)
         }
-        console.warn(message)
+        logger.warn(message)
       }
       return
     }

src/content-render/tests/copilot-code-blocks.ts

@@ -1,6 +1,16 @@
 import { describe, it, expect, vi } from 'vitest'
 import { renderContent } from '@/content-render/index'
 
+const { mockWarn } = vi.hoisted(() => ({ mockWarn: vi.fn() }))
+vi.mock('@/observability/logger', () => ({
+  createLogger: () => ({
+    info: vi.fn(),
+    warn: mockWarn,
+    error: vi.fn(),
+    debug: vi.fn(),
+  }),
+}))
+
 describe('code-header plugin', () => {
   describe('copilot language code blocks', () => {
     it('should render basic copilot code block without header (no copy meta)', async () => {
@@ -126,18 +136,17 @@ Improve the variable names in this function
 
   describe('edge cases', () => {
     it('should handle missing reference gracefully and fall back to current code only', async () => {
-      // Mock console.warn to capture warning
-      const consoleWarnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+      mockWarn.mockClear()
 
       const markdown =
         '```copilot copy prompt ref=nonexistent-id\nImprove the variable names in this function\n```'
 
       const html = await renderContent(markdown)
 
-      // Should warn about missing reference
-      expect(consoleWarnSpy).toHaveBeenCalledWith(
-        expect.stringContaining("Can't find referenced code block with id=nonexistent-id"),
-      )
+      // Should warn about missing reference via structured logger
+      expect(mockWarn).toHaveBeenCalledWith('Cannot find referenced code block', {
+        ref: 'nonexistent-id',
+      })
 
       // Should still render with prompt button using current code only
       expect(html).toContain('https://github.com/copilot?prompt=')
@@ -149,8 +158,7 @@ Improve the variable names in this function
       // Should not crash or fail
       expect(html).toContain('code-example')
 
-      // Restore console.warn
-      consoleWarnSpy.mockRestore()
+      mockWarn.mockClear()
     })
 
     it('should not process annotated code blocks', async () => {

src/content-render/unified/alerts.ts

@@ -6,6 +6,9 @@ import { visit } from 'unist-util-visit'
 import { h } from 'hastscript'
 import octicons from '@primer/octicons'
 import type { Element, Root, ElementContent } from 'hast'
+import { createLogger } from '@/observability/logger'
+
+const logger = createLogger(import.meta.url)
 
 interface AlertType {
   icon: string
@@ -33,9 +36,7 @@ export default function alerts({ alertTitles = {} }: { alertTitles?: Record<stri
         return
       const key = getAlertKey(el)
       if (!(key in alertTypes)) {
-        console.warn(
-          `Alert key '${key}' should be all uppercase (change it to '${key.toUpperCase()}')`,
-        )
+        logger.warn('Alert key should be all uppercase', { key, expected: key.toUpperCase() })
       }
       const alertType = alertTypes[getAlertKey(el).toUpperCase()]
       el.tagName = 'div'

src/content-render/unified/annotate.ts

@@ -38,6 +38,9 @@ import { toHast } from 'mdast-util-to-hast'
 import type { Root } from 'mdast'
 import { header } from './code-header'
 import findPage from '@/frame/lib/find-page'
+import { createLogger } from '@/observability/logger'
+
+const logger = createLogger(import.meta.url)
 
 interface LanguageConfig {
   comment: 'number' | 'slash' | 'xml' | 'percent' | 'hyphen'
@@ -280,10 +283,10 @@ function processAutotitleInMdast(mdast: Root, context: any): void {
               child.value = page.rawTitle || 'AUTOTITLE'
             } catch (error) {
               // Keep AUTOTITLE if we can't get the title
-              console.warn(
-                `Could not resolve AUTOTITLE for ${node.url}:`,
-                error instanceof Error ? error.message : String(error),
-              )
+              logger.warn('Could not resolve AUTOTITLE', {
+                url: node.url,
+                error: error instanceof Error ? error.message : String(error),
+              })
             }
           }
         }

src/content-render/unified/copilot-prompt.ts

@@ -8,9 +8,12 @@ import octicons from '@primer/octicons'
 import { parse } from 'parse5'
 import { fromParse5 } from 'hast-util-from-parse5'
 import { getPreMeta } from './code-header'
+import { createLogger } from '@/observability/logger'
 import { generatePromptId } from '../lib/prompt-id'
 import type { Element, Root } from 'hast'
 
+const logger = createLogger(import.meta.url)
+
 export function getPrompt(
   node: Element,
   tree: Root,
@@ -55,7 +58,7 @@ function buildPromptData(
   // If the 'ref=<id>' meta is found, find a matching code block to include as context in the prompt link.
   const matchingCodeEl = findMatchingCode(ref as string, tree)
   if (!matchingCodeEl) {
-    console.warn(`Can't find referenced code block with id=${ref}`)
+    logger.warn('Cannot find referenced code block', { ref })
     return promptOnly(code)
   }
   // AST structure: element -> code -> text node with value property

src/content-render/unified/rewrite-asset-urls.ts

@@ -1,6 +1,9 @@
 import fs from 'fs'
 import type { Element, Node } from 'hast'
 import { visit } from 'unist-util-visit'
+import { createLogger } from '@/observability/logger'
+
+const logger = createLogger(import.meta.url)
 
 // Process-level cache for stat results — file sizes don't change between deploys.
 const statCache = new Map<string, number | null>()
@@ -59,9 +62,6 @@ function getNewSrc(node: Element): string | undefined {
     return split.join('/')
   } catch {
     statCache.set(filePath, null)
-    console.warn(
-      `Failed to get a hash for ${src} ` +
-        '(This is mostly harmless and can happen with outdated translations).',
-    )
+    logger.warn('Failed to get a hash for asset URL', { src })
   }
 }