fix(dev): apply headers from route rules for static assets

from #2814

Co-authored-by: peterthenelson <nelson.peter.a@gmail.com>
Co-authored-by: Pooya Parsa <pooya@pi0.io>

Author: 3 people

src/core/dev-server/server.ts

@@ -5,14 +5,21 @@ import type { FSWatcher } from "chokidar";
 import type { App } from "h3";
 import type { Listener, ListenOptions } from "listhen";
 import { NodeDevWorker, type DevWorker, type WorkerAddress } from "./worker";
-import type { Nitro, NitroBuildInfo, NitroDevServer } from "nitropack/types";
+import type {
+  Nitro,
+  NitroBuildInfo,
+  NitroDevServer,
+  NitroRouteRules,
+} from "nitropack/types";
 import {
   createApp,
   createError,
   eventHandler,
   fromNodeMiddleware,
   toNodeListener,
 } from "h3";
+import { createRouter as createRadixRouter, toRouteMatcher } from "radix3";
+import defu from "defu";
 import devErrorHandler, {
   defaultHandler as devErrorHandlerInternal,
   loadStackTrace,
@@ -211,6 +218,10 @@ class DevServer {
     // Debugging endpoint to view vfs
     app.use("/_vfs", createVFSHandler(this.nitro));
 
+    const routeRulesMatcher = toRouteMatcher(
+      createRadixRouter({ routes: this.nitro.options.routeRules })
+    );
+
     // Serve asset dirs
     for (const asset of this.nitro.options.publicAssets) {
       const url = joinURL(
@@ -227,6 +238,18 @@ class DevServer {
               if (path.endsWith(".gz")) {
                 res.setHeader("Content-Encoding", "gzip");
               }
+              if (!res.req.url) {
+                return;
+              }
+              const rules: NitroRouteRules = defu(
+                {},
+                ...routeRulesMatcher.matchAll(res.req.url).reverse()
+              );
+              if (rules.headers) {
+                for (const [k, v] of Object.entries(rules.headers)) {
+                  res.appendHeader(k, v);
+                }
+              }
             },
           })
         )

test/fixture/nitro.config.ts

@@ -107,6 +107,7 @@ export default defineNitroConfig({
     "/rules/_/cached/noncached": { cache: false, swr: false, isr: false },
     "/rules/_/cached/**": { swr: true },
     "/api/proxy/**": { proxy: "/api/echo" },
+    "/build/**": { headers: { "x-build-header": "works" } },
     "**": { headers: { "x-test": "test" } },
   },
   prerender: {

test/presets/netlify-legacy.test.ts

@@ -93,6 +93,7 @@ describe("nitro:preset:netlify-legacy", async () => {
             x-test: test
           /build/*
             cache-control: public, max-age=3600, immutable
+            x-build-header: works
           /*
             x-test: test
           "

test/presets/netlify.test.ts

@@ -73,6 +73,7 @@ describe("nitro:preset:netlify", async () => {
             x-test: test
           /build/*
             cache-control: public, max-age=3600, immutable
+            x-build-header: works
           /*
             x-test: test
           "

test/presets/nitro-dev.test.ts

@@ -28,6 +28,22 @@ describe("nitro:preset:nitro-dev", async () => {
         expect(data.keys).includes("src:public:favicon.ico");
       });
 
+      it("static asset headers", async () => {
+        const { headers } = await ctx.fetch("/build/test.txt");
+        expect(Object.fromEntries(headers)).toMatchObject({
+          "accept-ranges": "bytes",
+          "cache-control": "public, max-age=0",
+          "last-modified": expect.any(String),
+          etag: 'W/"7-18df5a508c5"',
+          "content-type": "text/plain; charset=UTF-8",
+          // "content-length": "7",
+          date: expect.any(String),
+          connection: "keep-alive",
+          "keep-alive": "timeout=5",
+          "x-build-header": "works",
+        });
+      });
+
       describe("openAPI", () => {
         let spec: OpenAPI3;
         it("/_openapi.json", async () => {

test/presets/vercel.test.ts

@@ -93,6 +93,7 @@ describe("nitro:preset:vercel", async () => {
               {
                 "headers": {
                   "cache-control": "public, max-age=3600, immutable",
+                  "x-build-header": "works",
                 },
                 "src": "/build/(.*)",
               },