refactor: create reusable helper to record warnings

Author: pieh

src/run/handlers/cache.cts

@@ -28,7 +28,7 @@ import {
 } from '../regional-blob-store.cjs'
 
 import { getLogger, getRequestContext } from './request-context.cjs'
-import { getTracer } from './tracer.cjs'
+import { getTracer, recordWarning } from './tracer.cjs'
 
 type TagManifestBlobCache = Record<string, Promise<TagManifest | null>>
 
@@ -85,13 +85,7 @@ export class NetlifyCacheHandler implements CacheHandlerForMultipleVersions {
     if (!requestContext) {
       // we will not be able to use request context for date header calculation
       // we will fallback to using blobs
-      getCacheKeySpan.recordException(
-        new Error('CacheHandler was called without a request context'),
-      )
-      getCacheKeySpan.setAttributes({
-        severity: 'alert',
-        warning: true,
-      })
+      recordWarning(new Error('CacheHandler was called without a request context'), getCacheKeySpan)
       return
     }
 
@@ -100,15 +94,13 @@ export class NetlifyCacheHandler implements CacheHandlerForMultipleVersions {
       // so as a safety measure we will not use any of them and let blobs be used
       // to calculate the date header
       requestContext.responseCacheGetLastModified = undefined
-      getCacheKeySpan.recordException(
+      recordWarning(
         new Error(
           `Multiple response cache keys used in single request: ["${requestContext.responseCacheKey}, "${key}"]`,
         ),
+        getCacheKeySpan,
       )
-      getCacheKeySpan.setAttributes({
-        severity: 'alert',
-        warning: true,
-      })
+
       return
     }
 

src/run/handlers/tracer.cts

@@ -89,3 +89,16 @@ export function getTracer(): RuntimeTracer {
 
   return tracer
 }
+
+export function recordWarning(warning: Error, span?: Span) {
+  const spanToRecordWarningOn = span ?? trace.getActiveSpan()
+  if (!spanToRecordWarningOn) {
+    return
+  }
+
+  spanToRecordWarningOn.recordException(warning)
+  spanToRecordWarningOn.setAttributes({
+    severity: 'alert',
+    warning: true,
+  })
+}

src/run/headers.ts

@@ -4,6 +4,7 @@ import type { NextConfigComplete } from 'next/dist/server/config-shared.js'
 import type { NetlifyCachedRouteValue, NetlifyCacheHandlerValue } from '../shared/cache-types.cjs'
 
 import { getLogger, RequestContext } from './handlers/request-context.cjs'
+import { recordWarning } from './handlers/tracer.cjs'
 import { getMemoizedKeyValueStoreBackedByRegionalBlobStore } from './regional-blob-store.cjs'
 
 const ALL_VARIATIONS = Symbol.for('ALL_VARIATIONS')
@@ -145,13 +146,10 @@ export const adjustDateHeader = async ({
     // request context would contain lastModified value
     // this is not fatal as we have fallback,
     // but we want to know about it happening
-    span.recordException(
+    recordWarning(
       new Error('lastModified not found in requestContext, falling back to trying blobs'),
+      span,
     )
-    span.setAttributes({
-      severity: 'alert',
-      warning: true,
-    })
 
     const cacheStore = getMemoizedKeyValueStoreBackedByRegionalBlobStore({ consistency: 'strong' })
     const cacheEntry = await cacheStore.get<NetlifyCacheHandlerValue>(
@@ -164,15 +162,13 @@ export const adjustDateHeader = async ({
   if (!lastModified) {
     // this should never happen as we only execute this code path for cached responses
     // and those should always have lastModified value
-    span.recordException(
+    recordWarning(
       new Error(
         'lastModified not found in either requestContext or blobs, date header for cached response is not set',
       ),
+      span,
     )
-    span.setAttributes({
-      severity: 'alert',
-      warning: true,
-    })
+
     return
   }