fix: leverage system logger for debug logs (instead of console) (#467)

* chore: move systemlog to a cts file

* fix: leverage system logger in place of console

Author: mrstork

src/build/content/server.ts

@@ -1,25 +1,26 @@
 import { existsSync } from 'node:fs'
 import {
+  access,
   cp,
   mkdir,
   readFile,
   readdir,
   readlink,
   symlink,
   writeFile,
-  access,
 } from 'node:fs/promises'
 import { createRequire } from 'node:module'
 // eslint-disable-next-line no-restricted-imports
 import { dirname, join, resolve, sep } from 'node:path'
-import { sep as posixSep, join as posixJoin } from 'node:path/posix'
+import { join as posixJoin, sep as posixSep } from 'node:path/posix'
 
 import { trace } from '@opentelemetry/api'
 import { wrapTracer } from '@opentelemetry/api/experimental'
 import glob from 'fast-glob'
 import { prerelease, lt as semverLowerThan, lte as semverLowerThanOrEqual } from 'semver'
 
 import { RUN_CONFIG } from '../../run/constants.js'
+import { logger } from '../../run/systemlog.cjs'
 import { PluginContext } from '../plugin-context.js'
 import { verifyNextVersion } from '../verification.js'
 
@@ -342,7 +343,7 @@ export const writeTagsManifest = async (ctx: PluginContext): Promise<void> => {
       } catch {
         // Parallel route default layout has no prerendered page, so don't warn about it
         if (!definition.dataRoute?.endsWith('/default.rsc')) {
-          console.log(`Unable to read cache tags for: ${path}`)
+          logger.log(`Unable to read cache tags for: ${path}`)
         }
       }
     }

src/run/handlers/cache.cts

@@ -17,6 +17,7 @@ import type {
   NetlifyIncrementalCacheValue,
 } from '../../shared/cache-types.cjs'
 import { getRegionalBlobStore } from '../regional-blob-store.cjs'
+import { logger } from '../systemlog.cjs'
 
 import { getRequestContext } from './request-context.cjs'
 import { getTracer } from './tracer.cjs'
@@ -108,7 +109,7 @@ export class NetlifyCacheHandler implements CacheHandler {
   async get(...args: Parameters<CacheHandler['get']>): ReturnType<CacheHandler['get']> {
     return this.tracer.withActiveSpan('get cache key', async (span) => {
       const [key, ctx = {}] = args
-      console.debug(`[NetlifyCacheHandler.get]: ${key}`)
+      logger.debug(`[NetlifyCacheHandler.get]: ${key}`)
 
       const blobKey = await this.encodeBlobKey(key)
       span.setAttributes({ key, blobKey })
@@ -176,7 +177,7 @@ export class NetlifyCacheHandler implements CacheHandler {
       const lastModified = Date.now()
       span.setAttributes({ key, lastModified, blobKey })
 
-      console.debug(`[NetlifyCacheHandler.set]: ${key}`)
+      logger.debug(`[NetlifyCacheHandler.set]: ${key}`)
 
       const value: NetlifyIncrementalCacheValue | null =
         data?.kind === 'ROUTE'
@@ -197,10 +198,12 @@ export class NetlifyCacheHandler implements CacheHandler {
         const requestContext = getRequestContext()
         if (requestContext?.didPagesRouterOnDemandRevalidate) {
           const tag = `_N_T_${key === '/index' ? '/' : key}`
-          console.debug('Purging CDN cache for:', [tag])
+          logger.debug(`Purging CDN cache for: [${tag}]`)
           purgeCache({ tags: [tag] }).catch((error) => {
             // TODO: add reporting here
-            console.error(`[NetlifyCacheHandler]: Purging the cache for tag ${tag} failed`, error)
+            logger
+              .withError(error)
+              .error(`[NetlifyCacheHandler]: Purging the cache for tag ${tag} failed`)
           })
         }
       }
@@ -209,7 +212,7 @@ export class NetlifyCacheHandler implements CacheHandler {
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   async revalidateTag(tagOrTags: string | string[], ...args: any) {
-    console.debug('NetlifyCacheHandler.revalidateTag', tagOrTags, args)
+    logger.withFields({ tagOrTags, args }).debug('NetlifyCacheHandler.revalidateTag')
 
     const tags = Array.isArray(tagOrTags) ? tagOrTags : [tagOrTags]
 
@@ -222,17 +225,16 @@ export class NetlifyCacheHandler implements CacheHandler {
         try {
           await this.blobStore.setJSON(await this.encodeBlobKey(tag), data)
         } catch (error) {
-          console.warn(`Failed to update tag manifest for ${tag}`, error)
+          logger.withError(error).log(`Failed to update tag manifest for ${tag}`)
         }
       }),
     )
 
     purgeCache({ tags }).catch((error) => {
       // TODO: add reporting here
-      console.error(
-        `[NetlifyCacheHandler]: Purging the cache for tags ${tags.join(', ')} failed`,
-        error,
-      )
+      logger
+        .withError(error)
+        .error(`[NetlifyCacheHandler]: Purging the cache for tags ${tags.join(', ')} failed`)
     })
   }
 

src/run/handlers/server.ts

@@ -1,20 +1,20 @@
 import type { OutgoingHttpHeaders } from 'http'
 
-import { toComputeResponse, toReqRes, ComputeJsOutgoingMessage } from '@fastly/http-compute-js'
+import { ComputeJsOutgoingMessage, toComputeResponse, toReqRes } from '@fastly/http-compute-js'
 import { Context } from '@netlify/functions'
 import type { NextConfigComplete } from 'next/dist/server/config-shared.js'
 import type { WorkerRequestHandler } from 'next/dist/server/lib/types.js'
 
 import { TagsManifest, getTagsManifest } from '../config.js'
 import {
   adjustDateHeader,
-  setCacheStatusHeader,
   setCacheControlHeaders,
+  setCacheStatusHeader,
   setCacheTagsHeaders,
   setVaryHeaders,
 } from '../headers.js'
 import { nextResponseProxy } from '../revalidate.js'
-import { logger } from '../systemlog.js'
+import { logger } from '../systemlog.cjs'
 
 import { createRequestContext, getRequestContext } from './request-context.cjs'
 import { getTracer } from './tracer.cjs'

src/run/handlers/tracing.ts

@@ -7,6 +7,8 @@ import {
   SEMRESATTRS_SERVICE_VERSION,
 } from '@opentelemetry/semantic-conventions'
 
+import { logger } from '../systemlog.cjs'
+
 const {
   default: { version, name },
 } = await import('../../../package.json')
@@ -31,7 +33,7 @@ process.on('SIGTERM', () => {
     .then(
       // eslint-disable-next-line @typescript-eslint/no-empty-function
       () => {},
-      (error: unknown) => console.log('Error shutting down OpenTelemetry NodeSDK', error),
+      (error: unknown) => logger.withError(error).log('Error shutting down OpenTelemetry NodeSDK'),
     )
     // eslint-disable-next-line n/no-process-exit
     .finally(() => process.exit(0))