fix: wip - fix for caching issues on catch all routes

Author: mrstork

src/run/handlers/cache.cts

@@ -121,11 +121,19 @@ export class NetlifyCacheHandler implements CacheHandlerForMultipleVersions {
   }
 
   private captureCacheTags(cacheValue: NetlifyIncrementalCacheValue | null, key: string) {
+    const requestContext = getRequestContext()
+
     if (!cacheValue) {
+      if (requestContext?.responseCacheTags) {
+        const cacheTags = [`_N_T_${key === '/index' ? '/' : encodeURI(key)}`]
+        requestContext.responseCacheTags = cacheTags
+
+        console.log('cache tags set:', cacheTags)
+      }
+
       return
     }
 
-    const requestContext = getRequestContext()
     // Bail if we can't get request context
     if (!requestContext) {
       return
@@ -393,28 +401,28 @@ export class NetlifyCacheHandler implements CacheHandlerForMultipleVersions {
 
       await this.cacheStore.set(key, { lastModified, value }, 'blobStore.set')
 
-      if (data?.kind === 'PAGE' || data?.kind === 'PAGES') {
-        const requestContext = getRequestContext()
-        if (requestContext?.didPagesRouterOnDemandRevalidate) {
-          // encode here to deal with non ASCII characters in the key
-          const tag = `_N_T_${key === '/index' ? '/' : encodeURI(key)}`
-          const tags = tag.split(/,|%2c/gi).filter(Boolean)
-
-          if (tags.length === 0) {
-            return
-          }
+      // if (data?.kind === 'PAGE' || data?.kind === 'PAGES') {
+      const requestContext = getRequestContext()
+      if (requestContext?.didPagesRouterOnDemandRevalidate) {
+        // encode here to deal with non ASCII characters in the key
+        const tag = `_N_T_${key === '/index' ? '/' : encodeURI(key)}`
+        const tags = tag.split(/,|%2c/gi).filter(Boolean)
 
-          getLogger().debug(`Purging CDN cache for: [${tag}]`)
-          requestContext.trackBackgroundWork(
-            purgeCache({ tags, userAgent: purgeCacheUserAgent }).catch((error) => {
-              // TODO: add reporting here
-              getLogger()
-                .withError(error)
-                .error(`[NetlifyCacheHandler]: Purging the cache for tag ${tag} failed`)
-            }),
-          )
+        if (tags.length === 0) {
+          return
         }
+
+        getLogger().debug(`Purging CDN cache for: [${tag}]`)
+        requestContext.trackBackgroundWork(
+          purgeCache({ tags, userAgent: purgeCacheUserAgent }).catch((error) => {
+            // TODO: add reporting here
+            getLogger()
+              .withError(error)
+              .error(`[NetlifyCacheHandler]: Purging the cache for tag ${tag} failed`)
+          }),
+        )
       }
+      // }
     })
   }
 

src/run/handlers/server.ts

@@ -132,7 +132,7 @@ export default async (
     }
 
     setCacheControlHeaders(response, request, requestContext, nextConfig)
-    setCacheTagsHeaders(response.headers, requestContext)
+    setCacheTagsHeaders(response.headers, request, requestContext)
     setVaryHeaders(response.headers, request, nextConfig)
     setCacheStatusHeader(response.headers, nextCache)
 

src/run/headers.ts

@@ -220,7 +220,6 @@ export const setCacheControlHeaders = (
       .log('NetlifyHeadersHandler.trailingSlashRedirect')
   }
 
-  const cacheControl = headers.get('cache-control')
   if (status === 404) {
     if (request.url.endsWith('.php')) {
       // temporary CDN Cache Control handling for bot probes on PHP files
@@ -241,6 +240,8 @@ export const setCacheControlHeaders = (
     }
   }
 
+  const cacheControl = headers.get('cache-control')
+
   if (
     cacheControl !== null &&
     ['GET', 'HEAD'].includes(request.method) &&
@@ -281,13 +282,24 @@ export const setCacheControlHeaders = (
   }
 }
 
-export const setCacheTagsHeaders = (headers: Headers, requestContext: RequestContext) => {
-  if (
-    requestContext.responseCacheTags &&
-    (headers.has('cache-control') || headers.has('netlify-cdn-cache-control'))
-  ) {
+export const setCacheTagsHeaders = (
+  headers: Headers,
+  request: Request,
+  requestContext: RequestContext,
+) => {
+  if (!headers.has('cache-control') && !headers.has('netlify-cdn-cache-control')) {
+    return
+  }
+
+  if (requestContext.responseCacheTags) {
     headers.set('netlify-cache-tag', requestContext.responseCacheTags.join(','))
+    return
   }
+
+  const key = new URL(request.url).pathname
+  const cacheTag = `_N_T_${key === '/index' ? '/' : encodeURI(key)}`
+  console.log('setCacheTagsHeaders', 'netlify-cache-tag', key)
+  headers.set('netlify-cache-tag', cacheTag)
 }
 
 /**

src/run/next.cts

@@ -99,7 +99,8 @@ export async function getMockedRequestHandler(...args: Parameters<typeof getRequ
             if (!file.isFallback) {
               const requestContext = getRequestContext()
               if (requestContext) {
-                requestContext.usedFsReadForNonFallback = true
+                // Causing caching for too many requests (e.g. api routes)
+                // requestContext.usedFsReadForNonFallback = true
               }
             }