fix(vercel): generate prerender config for o11y routes matching isr route rule (#3562)

Author: danielroe

src/presets/vercel/utils.ts

@@ -1,7 +1,7 @@
 import fsp from "node:fs/promises";
 import { defu } from "defu";
 import { writeFile } from "nitropack/kit";
-import type { Nitro } from "nitropack/types";
+import type { Nitro, NitroRouteRules } from "nitropack/types";
 import { dirname, relative, resolve } from "pathe";
 import { joinURL, withLeadingSlash, withoutLeadingSlash } from "ufo";
 import type {
@@ -10,6 +10,7 @@ import type {
   VercelServerlessFunctionConfig,
 } from "./types";
 import { isTest } from "std-env";
+import { createRouter as createRadixRouter, toRouteMatcher } from "radix3";
 
 // https://vercel.com/docs/build-output-api/configuration
 
@@ -61,31 +62,6 @@ export async function generateFunctionFiles(nitro: Nitro) {
       continue;
     }
 
-    // Normalize route rule
-    let isrConfig = value.isr;
-    if (typeof isrConfig === "number") {
-      isrConfig = { expiration: isrConfig };
-    } else if (isrConfig === true) {
-      isrConfig = { expiration: false };
-    } else {
-      isrConfig = { ...isrConfig };
-    }
-
-    // Generate prerender config
-    const prerenderConfig: PrerenderFunctionConfig = {
-      expiration: isrConfig.expiration ?? false,
-      bypassToken: nitro.options.vercel?.config?.bypassToken,
-      ...isrConfig,
-    };
-
-    // Allow query parameter for wildcard routes
-    if (key.includes("/**") /* wildcard */) {
-      isrConfig.allowQuery = isrConfig.allowQuery || [];
-      if (!isrConfig.allowQuery.includes("url")) {
-        isrConfig.allowQuery.push("url");
-      }
-    }
-
     const funcPrefix = resolve(
       nitro.options.output.serverDir,
       "..",
@@ -97,13 +73,22 @@ export async function generateFunctionFiles(nitro: Nitro) {
       funcPrefix + ".func",
       "junction"
     );
-    await writeFile(
+    await writePrerenderConfig(
       funcPrefix + ".prerender-config.json",
-      JSON.stringify(prerenderConfig, null, 2)
+      value.isr,
+      nitro.options.vercel?.config?.bypassToken
     );
   }
 
   // Write observability routes
+  if (o11Routes.length === 0) {
+    return;
+  }
+  const _routeRulesMatcher = toRouteMatcher(
+    createRadixRouter({ routes: nitro.options.routeRules })
+  );
+  const _getRouteRules = (path: string) =>
+    defu({}, ..._routeRulesMatcher.matchAll(path).reverse()) as NitroRouteRules;
   for (const route of o11Routes) {
     const funcPrefix = resolve(
       nitro.options.output.serverDir,
@@ -116,6 +101,14 @@ export async function generateFunctionFiles(nitro: Nitro) {
       funcPrefix + ".func",
       "junction"
     );
+    const routeRules = _getRouteRules(route.src);
+    if (routeRules.isr) {
+      await writePrerenderConfig(
+        funcPrefix + ".prerender-config.json",
+        routeRules.isr,
+        nitro.options.vercel?.config?.bypassToken
+      );
+    }
   }
 }
 
@@ -405,3 +398,27 @@ function normalizeRouteDest(route: string) {
       .join("/") || "index"
   );
 }
+
+async function writePrerenderConfig(
+  filename: string,
+  isrConfig: NitroRouteRules["isr"],
+  bypassToken?: string
+) {
+  // Normalize route rule
+  if (typeof isrConfig === "number") {
+    isrConfig = { expiration: isrConfig };
+  } else if (isrConfig === true) {
+    isrConfig = { expiration: false };
+  } else {
+    isrConfig = { ...isrConfig };
+  }
+
+  // Generate prerender config
+  const prerenderConfig: PrerenderFunctionConfig = {
+    expiration: isrConfig.expiration ?? false,
+    bypassToken,
+    ...isrConfig,
+  };
+
+  await writeFile(filename, JSON.stringify(prerenderConfig, null, 2));
+}

test/presets/vercel.test.ts

@@ -457,7 +457,7 @@ describe("nitro:preset:vercel", async () => {
         );
         expect(JSON.parse(isrRouteConfig)).toMatchObject({
           expiration: false,
-          allowQuery: ["q", "url"],
+          allowQuery: ["q"],
         });
       });
 
@@ -480,6 +480,7 @@ describe("nitro:preset:vercel", async () => {
             );
           }
         }
+        items.sort();
         return items;
       };
 
@@ -511,10 +512,10 @@ describe("nitro:preset:vercel", async () => {
             "functions/api/import-meta.func (symlink)",
             "functions/api/kebab.func (symlink)",
             "functions/api/meta/test.func (symlink)",
+            "functions/api/methods.func (symlink)",
             "functions/api/methods/default.func (symlink)",
             "functions/api/methods/foo.get.func (symlink)",
             "functions/api/methods/get.func (symlink)",
-            "functions/api/methods.func (symlink)",
             "functions/api/param/[test-id].func (symlink)",
             "functions/api/serialized/date.func (symlink)",
             "functions/api/serialized/error.func (symlink)",
@@ -531,14 +532,14 @@ describe("nitro:preset:vercel", async () => {
             "functions/api/typed/catchall/some/[...test].func (symlink)",
             "functions/api/typed/todos/[...].func (symlink)",
             "functions/api/typed/todos/[todoId]/comments/[...commentId].func (symlink)",
+            "functions/api/typed/user/[userId].func (symlink)",
             "functions/api/typed/user/[userId]/[userExtends].func (symlink)",
             "functions/api/typed/user/[userId]/post/[postId].func (symlink)",
             "functions/api/typed/user/[userId]/post/firstPost.func (symlink)",
-            "functions/api/typed/user/[userId].func (symlink)",
+            "functions/api/typed/user/john.func (symlink)",
             "functions/api/typed/user/john/[johnExtends].func (symlink)",
             "functions/api/typed/user/john/post/[postId].func (symlink)",
             "functions/api/typed/user/john/post/coffee.func (symlink)",
-            "functions/api/typed/user/john.func (symlink)",
             "functions/api/upload.func (symlink)",
             "functions/api/wildcard/[...param].func (symlink)",
             "functions/assets/[id].func (symlink)",
@@ -565,14 +566,14 @@ describe("nitro:preset:vercel", async () => {
             "functions/rules/_/cached/[...].isr.prerender-config.json",
             "functions/rules/_/noncached/cached.isr.func (symlink)",
             "functions/rules/_/noncached/cached.isr.prerender-config.json",
-            "functions/rules/isr/[...].isr.func (symlink)",
-            "functions/rules/isr/[...].isr.prerender-config.json",
             "functions/rules/isr-ttl/[...].isr.func (symlink)",
             "functions/rules/isr-ttl/[...].isr.prerender-config.json",
-            "functions/rules/swr/[...].isr.func (symlink)",
-            "functions/rules/swr/[...].isr.prerender-config.json",
+            "functions/rules/isr/[...].isr.func (symlink)",
+            "functions/rules/isr/[...].isr.prerender-config.json",
             "functions/rules/swr-ttl/[...].isr.func (symlink)",
             "functions/rules/swr-ttl/[...].isr.prerender-config.json",
+            "functions/rules/swr/[...].isr.func (symlink)",
+            "functions/rules/swr/[...].isr.prerender-config.json",
             "functions/static-flags.func (symlink)",
             "functions/stream.func (symlink)",
             "functions/tasks/[...name].func (symlink)",