feat(routeRules): allow wildcard redirects (#1976)

docs/1.guide/2.routing.md

@@ -243,6 +243,7 @@ export default defineNitroConfig({
     '/assets/**': { headers: { 'cache-control': 's-maxage=0' } },
     '/api/v1/**': { cors: true, headers: { 'access-control-allow-methods': 'GET' } },
     '/old-page': { redirect: '/new-page' },
+    '/old-page/**': { redirect: '/new-page/**' },
     '/proxy/example': { proxy: 'https://example.com' },
     '/proxy/**': { proxy: '/api/**' },
   }
@@ -258,6 +259,7 @@ export default defineNuxtConfig({
     '/assets/**': { headers: { 'cache-control': 's-maxage=0' } },
     '/api/v1/**': { cors: true, headers: { 'access-control-allow-methods': 'GET' } },
     '/old-page': { redirect: '/new-page' },
+    '/old-page/**': { redirect: '/new-page/**' },
     '/proxy/example': { proxy: 'https://example.com' },
     '/proxy/**': { proxy: '/api/**' },
   }

docs/3.config/0.index.md

@@ -316,6 +316,7 @@ routeRules: {
   '/api/v1/**': { cors: true, headers: { 'access-control-allow-methods': 'GET' } },
   '/old-page': { redirect: '/new-page' }, // uses status code 307 (Temporary Redirect)
   '/old-page2': { redirect: { to:'/new-page2', statusCode: 301 } },
+  '/old-page/**': { redirect: '/new-page/**' },
   '/proxy/example': { proxy: 'https://example.com' },
   '/proxy/**': { proxy: '/api/**' },
 }

src/options.ts

@@ -479,6 +479,10 @@ export function normalizeRouteRules(
           ? { to: routeConfig.redirect }
           : routeConfig.redirect),
       };
+      if (path.endsWith("/**")) {
+        // Internal flag
+        (routeRules.redirect as any)._redirectStripBase = path.slice(0, -3);
+      }
     }
     // Proxy
     if (routeConfig.proxy) {

src/presets/netlify.ts

@@ -148,7 +148,7 @@ async function writeRedirects(nitro: Nitro) {
     let code = routeRules.redirect.statusCode;
     code = { 307: 302, 308: 301 }[code] || code;
     contents =
-      `${key.replace("/**", "/*")}\t${routeRules.redirect.to}\t${code}\n` +
+      `${key.replace("/**", "/*")}\t${routeRules.redirect.to.replace("/**", "/:splat")}\t${code}\n` +
       contents;
   }
 

src/presets/vercel.ts

@@ -178,12 +178,14 @@ function generateBuildConfig(nitro: Nitro) {
         .filter(([_, routeRules]) => routeRules.redirect || routeRules.headers)
         .map(([path, routeRules]) => {
           let route = {
-            src: path.replace("/**", "/.*"),
+            src: path.replace("/**", "/(.*)"),
           };
           if (routeRules.redirect) {
             route = defu(route, {
               status: routeRules.redirect.statusCode,
-              headers: { Location: routeRules.redirect.to },
+              headers: {
+                Location: routeRules.redirect.to.replace("/**", "/$1"),
+              },
             });
           }
           if (routeRules.headers) {

src/runtime/route-rules.ts

@@ -28,11 +28,19 @@ export function createRouteRulesHandler(ctx: {
     }
     // Apply redirect options
     if (routeRules.redirect) {
-      return sendRedirect(
-        event,
-        routeRules.redirect.to,
-        routeRules.redirect.statusCode
-      );
+      let target = routeRules.redirect.to;
+      if (target.endsWith("/**")) {
+        let targetPath = event.path;
+        const strpBase = (routeRules.redirect as any)._redirectStripBase;
+        if (strpBase) {
+          targetPath = withoutBase(targetPath, strpBase);
+        }
+        target = joinURL(target.slice(0, -3), targetPath);
+      } else if (event.path.includes("?")) {
+        const query = getQuery(event.path);
+        target = withQuery(target, query);
+      }
+      return sendRedirect(event, target, routeRules.redirect.statusCode);
     }
     // Apply proxy options
     if (routeRules.proxy) {

test/fixture/nitro.config.ts

@@ -70,6 +70,7 @@ export default defineNitroConfig({
     "/rules/redirect/obj": {
       redirect: { to: "https://nitro.unjs.io/", statusCode: 308 },
     },
+    "/rules/redirect/wildcard/**": { redirect: "https://nitro.unjs.io/**" },
     "/rules/nested/**": { redirect: "/base", headers: { "x-test": "test" } },
     "/rules/nested/override": { redirect: { to: "/other" } },
     "/rules/_/noncached/cached": { swr: true },

test/presets/netlify.test.ts

@@ -51,6 +51,7 @@ describe("nitro:preset:netlify", async () => {
         /* eslint-disable no-tabs */
         expect(redirects).toMatchInlineSnapshot(`
         "/rules/nested/override	/other	302
+        /rules/redirect/wildcard/*	https://nitro.unjs.io/:splat	302
         /rules/redirect/obj	https://nitro.unjs.io/	301
         /rules/nested/*	/base	302
         /rules/redirect	/base	302

test/presets/vercel.test.ts

@@ -40,6 +40,13 @@ describe("nitro:preset:vercel", async () => {
                 "src": "/rules/redirect/obj",
                 "status": 308,
               },
+              {
+                "headers": {
+                  "Location": "https://nitro.unjs.io/$1",
+                },
+                "src": "/rules/redirect/wildcard/(.*)",
+                "status": 307,
+              },
               {
                 "headers": {
                   "Location": "/other",
@@ -74,14 +81,14 @@ describe("nitro:preset:vercel", async () => {
                   "Location": "/base",
                   "x-test": "test",
                 },
-                "src": "/rules/nested/.*",
+                "src": "/rules/nested/(.*)",
                 "status": 307,
               },
               {
                 "headers": {
                   "cache-control": "public, max-age=3600, immutable",
                 },
-                "src": "/build/.*",
+                "src": "/build/(.*)",
               },
               {
                 "continue": true,

test/tests.ts

@@ -248,6 +248,12 @@ export function testNitro(
     const obj = await callHandler({ url: "/rules/redirect/obj" });
     expect(obj.status).toBe(308);
     expect(obj.headers.location).toBe("https://nitro.unjs.io/");
+
+    const wildcard = await callHandler({
+      url: "/rules/redirect/wildcard/nuxt",
+    });
+    expect(wildcard.status).toBe(307);
+    expect(wildcard.headers.location).toBe("https://nitro.unjs.io/nuxt");
   });
 
   it("binary response", async () => {