@rspack/dev-middleware 2.0.0-beta.1 → 2.0.0

package/README.md

@@ -39,9 +39,9 @@ bun add -D @rspack/dev-middleware
 ## Usage
 
 ```js
-const { devMiddleware } = require("@rspack/dev-middleware");
-const express = require("express");
-const { rspack } = require("@rspack/core");
+import { rspack } from "@rspack/core";
+import { devMiddleware } from "@rspack/dev-middleware";
+import express from "express";
 
 const compiler = rspack({
   // Rspack options
@@ -58,7 +58,7 @@ app.use(
 app.listen(3000, () => console.log("Example app listening on port 3000!"));
 ```
 
-See [below](#other-servers) for an example of use with fastify.
+See [below](#other-servers) for examples of use with other servers.
 
 ## Options
 
@@ -72,7 +72,7 @@ See [below](#other-servers) for an example of use with fastify.
 |               **[`etag`](#tag)**                |   `boolean\| "weak"\| "strong"`   |                  `undefined`                  | Enable or disable etag generation.                                                                                   |
 |       **[`lastModified`](#lastmodified)**       |             `boolean`             |                  `undefined`                  | Enable or disable `Last-Modified` header. Uses the file system's last modified value.                                |
 |       **[`cacheControl`](#cachecontrol)**       | `boolean\|number\|string\|Object` |                  `undefined`                  | Enable or disable setting `Cache-Control` response header.                                                           |
-|     **[`cacheImmutable`](#cacheimmutable)**     |            `boolean\`             |                  `undefined`                  | Enable or disable setting `Cache-Control: public, max-age=31536000, immutable` response header for immutable assets. |
+|     **[`cacheImmutable`](#cacheimmutable)**     |             `boolean`             |                    `true`                     | Enable or disable setting `Cache-Control: public, max-age=31536000, immutable` response header for immutable assets. |
 |         **[`publicPath`](#publicpath)**         |             `string`              |                  `undefined`                  | The public path that the middleware is bound to.                                                                     |
 |              **[`stats`](#stats)**              |     `boolean\|string\|Object`     |        `stats` (from a configuration)         | Stats options object or preset name.                                                                                 |
 |   **[`serverSideRender`](#serversiderender)**   |             `boolean`             |                  `undefined`                  | Instructs the module to enable or disable the server-side rendering mode.                                            |
@@ -196,21 +196,25 @@ Default: `undefined`
 
 Depending on the setting, the following headers will be generated:
 
-- `Boolean` - `Cache-Control: public, max-age=31536000000`
-- `Number` - `Cache-Control: public, max-age=YOUR_NUMBER`
+- `Boolean` - `Cache-Control: public, max-age=31536000`
+- `Number` - `Cache-Control: public, max-age=YOUR_NUMBER_IN_SECONDS`
 - `String` - `Cache-Control: YOUR_STRING`
-- `{ maxAge?: number, immutable?: boolean }` - `Cache-Control: public, max-age=YOUR_MAX_AGE_or_31536000000`, also `, immutable` can be added if you set the `immutable` option to `true`
+- `{ maxAge?: number, immutable?: boolean }` - `Cache-Control: public, max-age=YOUR_MAX_AGE_IN_SECONDS_or_31536000`, also `, immutable` is added when you set the `immutable` option to `true`
+
+Numeric `cacheControl` and `cacheControl.maxAge` values are interpreted as milliseconds, clamped to `0..31536000000`, and converted to seconds for the response header.
 
 Enable or disable setting `Cache-Control` response header.
 
 ### cacheImmutable
 
 Type: `Boolean`
-Default: `undefined`
+Default: `true`
 
 Enable or disable setting `Cache-Control: public, max-age=31536000, immutable` response header for immutable assets (i.e. asset with a hash like `image.a4c12bde.jpg`).
 Immutable assets are assets that have their hash in the file name therefore they can be cached, because if you change their contents the file name will be changed.
-Take preference over the `cacheControl` option if the asset was defined as immutable.
+When omitted, immutable assets use this header by default.
+Set `cacheImmutable: false` to fall back to the `cacheControl` option even for immutable assets.
+This takes precedence over the `cacheControl` option only when the asset was defined as immutable and `cacheImmutable` is not `false`.
 
 ### publicPath
 
@@ -249,7 +253,7 @@ This option also accepts a `Function` value, which can be used to filter which f
 The function follows the same premise as [`Array#filter`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter) in which a return value of `false` _will not_ write the file, and a return value of `true` _will_ write the file to disk. eg.
 
 ```js
-const { rspack } = require("@rspack/core");
+import { rspack } from "@rspack/core";
 
 const configuration = {
   /* Rspack configuration */
@@ -269,16 +273,16 @@ Default: [memfs](https://github.com/streamich/memfs)
 Set the default file system which will be used by Rspack as primary destination of generated files.
 This option isn't affected by the [writeToDisk](#writeToDisk) option.
 
-This can be done simply by using `path.join`:
+This can be done simply by using `node:path`'s `join`:
 
 ```js
-const path = require("node:path");
-const mkdirp = require("mkdirp");
-const myOutputFileSystem = require("my-fs");
-const { rspack } = require("@rspack/core");
+import { join } from "node:path";
+import { rspack } from "@rspack/core";
+import mkdirp from "mkdirp";
+import myOutputFileSystem from "my-fs";
 
-myOutputFileSystem.join = path.join.bind(path); // no need to bind
-myOutputFileSystem.mkdirp = mkdirp.bind(mkdirp); // no need to bind
+myOutputFileSystem.join = join;
+myOutputFileSystem.mkdirp = mkdirp;
 
 const compiler = rspack({
   /* Rspack configuration */
@@ -292,7 +296,7 @@ devMiddleware(compiler, { outputFileSystem: myOutputFileSystem });
 Allows to set up a callback to change the response data.
 
 ```js
-const { rspack } = require("@rspack/core");
+import { rspack } from "@rspack/core";
 
 const configuration = {
   /* Rspack configuration */
@@ -328,9 +332,9 @@ Required: `No`
 A function executed once the middleware has stopped watching.
 
 ```js
-const { devMiddleware } = require("@rspack/dev-middleware");
-const express = require("express");
-const { rspack } = require("@rspack/core");
+import { rspack } from "@rspack/core";
+import { devMiddleware } from "@rspack/dev-middleware";
+import express from "express";
 
 const compiler = rspack({
   /* Rspack configuration */
@@ -338,8 +342,7 @@ const compiler = rspack({
 
 const instance = devMiddleware(compiler);
 
-// eslint-disable-next-line new-cap
-const app = new express();
+const app = express();
 
 app.use(instance);
 
@@ -363,9 +366,9 @@ Required: `No`
 A function executed once the middleware has invalidated.
 
 ```js
-const { devMiddleware } = require("@rspack/dev-middleware");
-const express = require("express");
-const { rspack } = require("@rspack/core");
+import { rspack } from "@rspack/core";
+import { devMiddleware } from "@rspack/dev-middleware";
+import express from "express";
 
 const compiler = rspack({
   /* Rspack configuration */
@@ -373,8 +376,7 @@ const compiler = rspack({
 
 const instance = devMiddleware(compiler);
 
-// eslint-disable-next-line new-cap
-const app = new express();
+const app = express();
 
 app.use(instance);
 
@@ -403,9 +405,9 @@ A function executed when the bundle becomes valid.
 If the bundle is valid at the time of calling, the callback is executed immediately.
 
 ```js
-const { devMiddleware } = require("@rspack/dev-middleware");
-const express = require("express");
-const { rspack } = require("@rspack/core");
+import { rspack } from "@rspack/core";
+import { devMiddleware } from "@rspack/dev-middleware";
+import express from "express";
 
 const compiler = rspack({
   /* Rspack configuration */
@@ -413,8 +415,7 @@ const compiler = rspack({
 
 const instance = devMiddleware(compiler);
 
-// eslint-disable-next-line new-cap
-const app = new express();
+const app = express();
 
 app.use(instance);
 
@@ -437,9 +438,9 @@ Required: `Yes`
 URL for the requested file.
 
 ```js
-const { devMiddleware } = require("@rspack/dev-middleware");
-const express = require("express");
-const { rspack } = require("@rspack/core");
+import { rspack } from "@rspack/core";
+import { devMiddleware } from "@rspack/dev-middleware";
+import express from "express";
 
 const compiler = rspack({
   /* Rspack configuration */
@@ -447,15 +448,26 @@ const compiler = rspack({
 
 const instance = devMiddleware(compiler);
 
-// eslint-disable-next-line new-cap
-const app = new express();
+const app = express();
 
 app.use(instance);
 
 instance.waitUntilValid(() => {
-  const filename = instance.getFilenameFromUrl("/bundle.js");
+  let resolved;
+
+  try {
+    resolved = instance.getFilenameFromUrl("/bundle.js");
+  } catch (error) {
+    console.error(error);
+    return;
+  }
+
+  if (!resolved) {
+    console.log("Not found");
+    return;
+  }
 
-  console.log(`Filename is ${filename}`);
+  console.log(`Filename is ${resolved.filename}`);
 });
 ```
 
@@ -468,9 +480,9 @@ Since `output.publicPath` and `output.filename`/`output.chunkFilename` can be dy
 But there is a solution to avoid it - mount the middleware to a non-root route, for example:
 
 ```js
-const { devMiddleware } = require("@rspack/dev-middleware");
-const express = require("express");
-const { rspack } = require("@rspack/core");
+import { rspack } from "@rspack/core";
+import { devMiddleware } from "@rspack/dev-middleware";
+import express from "express";
 
 const compiler = rspack({
   // Rspack options
@@ -509,17 +521,17 @@ process is finished with server-side rendering enabled._
 Example Implementation:
 
 ```js
-const { devMiddleware } = require("@rspack/dev-middleware");
-const express = require("express");
-const isObject = require("is-object");
-const { rspack } = require("@rspack/core");
+import { join } from "node:path";
+import { rspack } from "@rspack/core";
+import { devMiddleware } from "@rspack/dev-middleware";
+import express from "express";
+import isObject from "is-object";
 
 const compiler = rspack({
   /* Rspack configuration */
 });
 
-// eslint-disable-next-line new-cap
-const app = new express();
+const app = express();
 
 // This function makes server rendering of asset references consistent with different Rspack chunk/entry configurations
 function normalizeAssets(assets) {
@@ -547,16 +559,16 @@ app.use((req, res) => {
     <title>My App</title>
     <style>
     ${normalizeAssets(assetsByChunkName.main)
-      .filter((path) => path.endsWith(".css"))
-      .map((path) => outputFileSystem.readFileSync(path.join(outputPath, path)))
+      .filter((asset) => asset.endsWith(".css"))
+      .map((asset) => outputFileSystem.readFileSync(join(outputPath, asset)))
       .join("\n")}
     </style>
   </head>
   <body>
     <div id="root"></div>
     ${normalizeAssets(assetsByChunkName.main)
-      .filter((path) => path.endsWith(".js"))
-      .map((path) => `<script src="${path}"></script>`)
+      .filter((asset) => asset.endsWith(".js"))
+      .map((asset) => `<script src="${asset}"></script>`)
       .join("\n")}
   </body>
 </html>
@@ -568,14 +580,16 @@ app.use((req, res) => {
 
 Examples of use with other servers will follow here.
 
-### Connect
+### connect-next
+
+[connect-next](https://github.com/rstackjs/connect-next) is an actively maintained fork of Connect.
 
 ```js
-const http = require("node:http");
-const { devMiddleware } = require("@rspack/dev-middleware");
-const connect = require("connect");
-const { rspack } = require("@rspack/core");
-const rspackConfig = require("./rspack.config.js");
+import { createServer } from "node:http";
+import { rspack } from "@rspack/core";
+import { devMiddleware } from "@rspack/dev-middleware";
+import { connect } from "connect-next";
+import rspackConfig from "./rspack.config.js";
 
 const compiler = rspack(rspackConfig);
 const devMiddlewareOptions = {
@@ -585,18 +599,18 @@ const app = connect();
 
 app.use(devMiddleware(compiler, devMiddlewareOptions));
 
-http.createServer(app).listen(3000);
+createServer(app).listen(3000);
 ```
 
 ### Router
 
 ```js
-const http = require("node:http");
-const { devMiddleware } = require("@rspack/dev-middleware");
-const finalhandler = require("finalhandler");
-const Router = require("router");
-const { rspack } = require("@rspack/core");
-const rspackConfig = require("./rspack.config.js");
+import { createServer } from "node:http";
+import { rspack } from "@rspack/core";
+import { devMiddleware } from "@rspack/dev-middleware";
+import finalhandler from "finalhandler";
+import Router from "router";
+import rspackConfig from "./rspack.config.js";
 
 const compiler = rspack(rspackConfig);
 const devMiddlewareOptions = {
@@ -608,7 +622,7 @@ const router = Router();
 
 router.use(devMiddleware(compiler, devMiddlewareOptions));
 
-const server = http.createServer((req, res) => {
+const server = createServer((req, res) => {
   router(req, res, finalhandler(req, res));
 });
 
@@ -618,10 +632,10 @@ server.listen(3000);
 ### Express
 
 ```js
-const { devMiddleware } = require("@rspack/dev-middleware");
-const express = require("express");
-const { rspack } = require("@rspack/core");
-const rspackConfig = require("./rspack.config.js");
+import { rspack } from "@rspack/core";
+import { devMiddleware } from "@rspack/dev-middleware";
+import express from "express";
+import rspackConfig from "./rspack.config.js";
 
 const compiler = rspack(rspackConfig);
 const devMiddlewareOptions = {
@@ -637,10 +651,10 @@ app.listen(3000, () => console.log("Example app listening on port 3000!"));
 ### Koa
 
 ```js
-const { devMiddleware } = require("@rspack/dev-middleware");
-const Koa = require("koa");
-const { rspack } = require("@rspack/core");
-const rspackConfig = require("./rspack.simple.config");
+import { rspack } from "@rspack/core";
+import { devMiddleware } from "@rspack/dev-middleware";
+import Koa from "koa";
+import rspackConfig from "./rspack.simple.config.js";
 
 const compiler = rspack(rspackConfig);
 const devMiddlewareOptions = {
@@ -648,7 +662,7 @@ const devMiddlewareOptions = {
 };
 const app = new Koa();
 
-app.use(middleware.koaWrapper(compiler, devMiddlewareOptions));
+app.use(devMiddleware.koaWrapper(compiler, devMiddlewareOptions));
 
 app.listen(3000);
 ```
@@ -656,10 +670,10 @@ app.listen(3000);
 ### Hapi
 
 ```js
-const Hapi = require("@hapi/hapi");
-const { devMiddleware } = require("@rspack/dev-middleware");
-const { rspack } = require("@rspack/core");
-const rspackConfig = require("./rspack.config.js");
+import Hapi from "@hapi/hapi";
+import { rspack } from "@rspack/core";
+import { devMiddleware } from "@rspack/dev-middleware";
+import rspackConfig from "./rspack.config.js";
 
 const compiler = rspack(rspackConfig);
 const devMiddlewareOptions = {};
@@ -685,33 +699,13 @@ process.on("unhandledRejection", (err) => {
 });
 ```
 
-### Fastify
-
-Fastify interop will require the use of `fastify-express` instead of `middie` for providing middleware support. As the authors of `fastify-express` recommend, this should only be used as a stopgap while full Fastify support is worked on.
-
-```js
-const { devMiddleware } = require("@rspack/dev-middleware");
-const fastify = require("fastify")();
-const { rspack } = require("@rspack/core");
-const rspackConfig = require("./rspack.config.js");
-
-const compiler = rspack(rspackConfig);
-const devMiddlewareOptions = {
-  // options
-};
-
-await fastify.register(require("@fastify/express"));
-await fastify.use(devMiddleware(compiler, devMiddlewareOptions));
-await fastify.listen(3000);
-```
-
 ### Hono
 
 ```js
+import { rspack } from "@rspack/core";
+import { devMiddleware } from "@rspack/dev-middleware";
 import { serve } from "@hono/node-server";
-import devMiddleware from "@rspack/dev-middleware";
 import { Hono } from "hono";
-import { rspack } from "@rspack/core";
 import rspackConfig from "./rspack.config.js";
 
 const compiler = rspack(rspackConfig);

package/dist/index.js

@@ -10,7 +10,6 @@ import { __webpack_require__ } from "./rslib-runtime.js";
 import node_path from "node:path";
 import node_crypto from "node:crypto";
 import node_querystring from "node:querystring";
-import { parse } from "node:url";
 import node_fs from "node:fs";
 __webpack_require__.add({
     "./node_modules/.pnpm/@jsonjoy.com+base64@17.67.0_tslib@2.8.1/node_modules/@jsonjoy.com/base64/lib/constants.js" (__unused_rspack_module, exports) {
@@ -8337,7 +8336,6 @@ function getRequestMethod(req) {
 }
 function getRequestURL(req) {
     if ("function" == typeof req.getURL) return req.getURL();
-    if (void 0 !== req.originalUrl) return req.originalUrl;
     return req.url;
 }
 function setStatusCode(res, code) {
@@ -8498,8 +8496,10 @@ function getPaths(context) {
                 asset.name,
                 asset.info
             ]));
+        const { outputFileSystem } = compilation.compiler;
         publicPaths.push({
             outputPath,
+            outputFileSystem,
             publicPath,
             assetsInfo
         });
@@ -8527,70 +8527,113 @@ const utils_memorize = memorize;
 function decode(input) {
     return node_querystring.unescape(input);
 }
-const memoizedParse = utils_memorize(parse, void 0, (value)=>{
-    if (value.pathname) value.pathname = decode(value.pathname);
-    return value;
+const memoizedParse = utils_memorize((url)=>{
+    const urlObject = new URL(url, "http://localhost");
+    return {
+        ...urlObject,
+        pathname: decode(urlObject.pathname)
+    };
 });
 const UP_PATH_REGEXP = /(?:^|[\\/])\.\.(?:[\\/]|$)/;
-function getFilenameFromUrl(context, url, extra = {}) {
+class FilenameError extends Error {
+    constructor(message, code){
+        super(message);
+        this.name = "FilenameError";
+        this.statusCode = code;
+    }
+}
+function isNotFoundError(error) {
+    switch(error.code){
+        case "ENAMETOOLONG":
+        case "ENOENT":
+        case "ENOTDIR":
+            return true;
+        default:
+            return false;
+    }
+}
+function getFilenameFromUrl(context, url) {
     const { options } = context;
     const paths = utils_getPaths(context);
-    let foundFilename;
+    const index = false === options.index ? [] : void 0 === options.index || true === options.index ? [
+        "index.html"
+    ] : [
+        options.index
+    ];
     let urlObject;
     try {
-        urlObject = memoizedParse(url, false, true);
+        urlObject = memoizedParse(url);
     } catch  {
         return;
     }
-    for (const { publicPath, outputPath, assetsInfo } of paths){
+    for (const { publicPath, outputPath, assetsInfo, outputFileSystem } of paths){
         let filename;
         let publicPathObject;
         try {
-            publicPathObject = memoizedParse("auto" !== publicPath && publicPath ? publicPath : "/", false, true);
+            publicPathObject = memoizedParse("auto" !== publicPath && publicPath ? publicPath : "/");
         } catch  {
             continue;
         }
         const { pathname } = urlObject;
         const { pathname: publicPathPathname } = publicPathObject;
         if (pathname && publicPathPathname && pathname.startsWith(publicPathPathname)) {
-            if (pathname.includes("\0")) {
-                extra.errorCode = 400;
-                return;
-            }
-            if (UP_PATH_REGEXP.test(node_path.normalize(`./${pathname}`))) {
-                extra.errorCode = 403;
-                return;
-            }
+            if (pathname.includes("\0")) throw new FilenameError("Bad Request", 400);
+            if (UP_PATH_REGEXP.test(node_path.normalize(`./${pathname}`))) throw new FilenameError("Forbidden", 403);
             filename = node_path.join(outputPath, pathname.slice(publicPathPathname.length));
-            try {
-                extra.stats = context.outputFileSystem.statSync(filename);
-            } catch  {
-                continue;
-            }
-            if (extra.stats.isFile()) {
-                foundFilename = filename;
-                if (assetsInfo) {
-                    const assetInfo = assetsInfo.get(pathname.slice(publicPathPathname.length));
-                    extra.immutable = assetInfo ? assetInfo.immutable : false;
-                }
-                break;
-            }
-            if (extra.stats.isDirectory() && (void 0 === options.index || options.index)) {
-                const indexValue = void 0 === options.index || "boolean" == typeof options.index ? "index.html" : options.index;
-                filename = node_path.join(filename, indexValue);
+            const resolveIndex = (filename, visited = new Set())=>{
+                if (0 === index.length) return;
+                const nextFilename = node_path.join(filename, index[0]);
+                if (visited.has(nextFilename)) return;
+                visited.add(nextFilename);
+                filename = nextFilename;
+                let stats;
                 try {
-                    extra.stats = context.outputFileSystem.statSync(filename);
-                } catch  {
-                    continue;
+                    stats = outputFileSystem.statSync(filename);
+                } catch (error) {
+                    if (isNotFoundError(error)) return;
+                    throw error;
                 }
-                if (extra.stats.isFile()) {
-                    foundFilename = filename;
-                    break;
+                if (stats.isDirectory()) return resolveIndex(filename, visited);
+                const extra = {
+                    immutable: assetsInfo ? assetsInfo.get(pathname.slice(publicPathPathname.length))?.immutable : false,
+                    outputFileSystem,
+                    stats: stats
+                };
+                return {
+                    filename,
+                    extra
+                };
+            };
+            const resolveFile = (filename)=>{
+                let stats;
+                try {
+                    stats = outputFileSystem.statSync(filename);
+                } catch (error) {
+                    if (isNotFoundError(error)) return;
+                    throw error;
                 }
+                if (stats.isDirectory()) return resolveIndex(filename);
+                if (filename.endsWith(node_path.sep)) return;
+                const extra = {
+                    immutable: assetsInfo ? assetsInfo.get(pathname.slice(publicPathPathname.length))?.immutable : false,
+                    outputFileSystem,
+                    stats: stats
+                };
+                return {
+                    filename,
+                    extra
+                };
+            };
+            if (index.length > 0 && pathname.endsWith("/")) {
+                const result = resolveIndex(filename);
+                if (!result) continue;
+                return result;
             }
+            const result = resolveFile(filename);
+            if (!result) continue;
+            return result;
         }
     }
-    return foundFilename;
 }
 const utils_getFilenameFromUrl = getFilenameFromUrl;
 function parseTokenList(str) {
@@ -8736,7 +8779,7 @@ function wrapper(context) {
             setResponseHeader(res, "Content-Length", byteLength);
             finish(res, document);
         }
-        async function errorHandler(error) {
+        async function errorHandler(error, message, code) {
             switch(error.code){
                 case "ENAMETOOLONG":
                 case "ENOENT":
@@ -8746,7 +8789,7 @@ function wrapper(context) {
                     });
                     break;
                 default:
-                    await sendError(error.message, 500, {
+                    await sendError(message || error.message, code || 500, {
                         modifyResponseData: context.options.modifyResponseData
                     });
                     break;
@@ -8835,17 +8878,19 @@ function wrapper(context) {
             ];
         }
         async function processRequest() {
-            const extra = {};
-            const filename = utils_getFilenameFromUrl(context, getRequestURL(req), extra);
-            if (extra.errorCode) {
-                if (403 === extra.errorCode) context.logger.error(`Malicious path "${filename}".`);
-                await sendError(400 === extra.errorCode ? "Bad Request" : "Forbidden", extra.errorCode, {
-                    modifyResponseData: context.options.modifyResponseData
-                });
+            let resolved;
+            const requestUrl = getRequestURL(req);
+            try {
+                resolved = utils_getFilenameFromUrl(context, requestUrl);
+            } catch (error) {
+                const errorCode = "object" == typeof error && null !== error && void 0 !== error.statusCode ? error.statusCode : void 0;
+                if (403 === errorCode) context.logger.error(`Malicious path "${requestUrl}".`);
+                await errorHandler(error, 400 === errorCode ? "Bad Request" : 403 === errorCode ? "Forbidden" : void 0, errorCode);
                 return;
             }
-            if (!filename) return void await goNext();
+            if (!resolved) return void await goNext();
             if (getHeadersSent(res)) return void await goNext();
+            const { extra, filename } = resolved;
             const { size } = extra.stats;
             let len = size;
             let offset = 0;
@@ -8866,23 +8911,21 @@ function wrapper(context) {
             }
             if (!getResponseHeader(res, "Accept-Ranges")) setResponseHeader(res, "Accept-Ranges", "bytes");
             if (!getResponseHeader(res, "Cache-Control")) {
-                const cacheControl = context.options.cacheImmutable && extra.immutable ? {
-                    immutable: true
-                } : context.options.cacheControl;
-                if (cacheControl) {
-                    let cacheControlValue;
-                    if ("boolean" == typeof cacheControl) cacheControlValue = "public, max-age=31536000";
-                    else if ("number" == typeof cacheControl) {
-                        const maxAge = Math.floor(Math.min(Math.max(0, cacheControl), MAX_MAX_AGE) / 1000);
-                        cacheControlValue = `public, max-age=${maxAge}`;
-                    } else if ("string" == typeof cacheControl) cacheControlValue = cacheControl;
-                    else {
-                        const maxAge = cacheControl.maxAge ? Math.floor(Math.min(Math.max(0, cacheControl.maxAge), MAX_MAX_AGE) / 1000) : MAX_MAX_AGE / 1000;
-                        cacheControlValue = `public, max-age=${maxAge}`;
-                        if (cacheControl.immutable) cacheControlValue += ", immutable";
-                    }
-                    setResponseHeader(res, "Cache-Control", cacheControlValue);
-                }
+                const { cacheControl, cacheImmutable } = context.options;
+                const useImmutableCache = (void 0 === cacheImmutable || cacheImmutable) && extra.immutable;
+                let cacheControlValue;
+                if (useImmutableCache) cacheControlValue = `public, max-age=${Math.floor(MAX_MAX_AGE / 1000)}, immutable`;
+                else if (true === cacheControl) cacheControlValue = `public, max-age=${Math.floor(MAX_MAX_AGE / 1000)}`;
+                else if ("number" == typeof cacheControl) {
+                    const maxAge = Math.min(Math.max(0, cacheControl), MAX_MAX_AGE);
+                    cacheControlValue = `public, max-age=${Math.floor(maxAge / 1000)}`;
+                } else if ("string" == typeof cacheControl) cacheControlValue = cacheControl;
+                else if (cacheControl) {
+                    const maxAge = void 0 !== cacheControl.maxAge ? Math.min(Math.max(0, cacheControl.maxAge), MAX_MAX_AGE) : MAX_MAX_AGE;
+                    cacheControlValue = `public, max-age=${Math.floor(maxAge / 1000)}`;
+                    if (cacheControl.immutable) cacheControlValue += ", immutable";
+                }
+                if (cacheControlValue) setResponseHeader(res, "Cache-Control", cacheControlValue);
             }
             if (context.options.lastModified && !getResponseHeader(res, "Last-Modified")) {
                 const modified = extra.stats.mtime.toUTCString();
@@ -8902,7 +8945,7 @@ function wrapper(context) {
                     }
                     [start, end] = calcStartAndEnd(offset, len);
                     try {
-                        const result = createReadStreamOrReadFileSync(filename, context.outputFileSystem, start, end);
+                        const result = createReadStreamOrReadFileSync(filename, extra.outputFileSystem, start, end);
                         ({ bufferOrStream, byteLength } = result);
                     } catch (error) {
                         await errorHandler(error);
@@ -8964,7 +9007,7 @@ function wrapper(context) {
             if (!bufferOrStream) {
                 [start, end] = calcStartAndEnd(offset, len);
                 try {
-                    ({ bufferOrStream, byteLength } = createReadStreamOrReadFileSync(filename, context.outputFileSystem, start, end));
+                    ({ bufferOrStream, byteLength } = createReadStreamOrReadFileSync(filename, extra.outputFileSystem, start, end));
                 } catch (error) {
                     await errorHandler(error);
                     return;
@@ -9121,7 +9164,7 @@ function rdm(compiler, options = {}) {
     }
     const filledContext = context;
     const instance = src_middleware(filledContext);
-    instance.getFilenameFromUrl = (url, extra)=>utils_getFilenameFromUrl(filledContext, url, extra);
+    instance.getFilenameFromUrl = (url)=>utils_getFilenameFromUrl(filledContext, url);
     instance.waitUntilValid = (callback = noop)=>{
         utils_ready(filledContext, callback);
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspack/dev-middleware",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0",
   "description": "A development middleware for Rspack",
   "keywords": [
     "rspack",
@@ -23,6 +23,7 @@
     "build": "rslib --syntax es2023 && pnpm run build:types",
     "build:types": "tsc --declaration --emitDeclarationOnly --outDir types && prettier \"types/**/*.ts\" --write",
     "lint": "npm-run-all -l -p \"lint:**\"",
+    "lint:rslint": "rslint",
     "lint:prettier": "prettier --cache --list-different .",
     "lint:spelling": "cspell --cache --no-must-find-files --quiet \"**/*.*\"",
     "lint:types": "tsc --pretty --noEmit",
@@ -32,24 +33,21 @@
     "bump": "npx bumpp"
   },
   "devDependencies": {
-    "@fastify/express": "^4.0.2",
     "@hapi/hapi": "^21.3.7",
     "@hono/node-server": "^1.12.0",
     "@rslib/core": "^0.20.0",
+    "@rslint/core": "^0.3.3",
     "@rspack/core": "2.0.0-beta.5",
     "@rstest/core": "0.9.2",
-    "@types/connect": "^3.4.35",
     "@types/express": "^5.0.2",
     "@types/node": "^22.3.0",
     "@types/on-finished": "^2.3.4",
     "@types/range-parser": "^1.2.7",
-    "connect": "^3.7.0",
+    "connect-next": "^4.0.0",
     "cspell": "^9.6.2",
     "deepmerge": "^4.2.2",
     "execa": "^5.1.1",
     "express": "^5.1.0",
-    "fastify": "^5.2.1",
-    "file-loader": "^6.2.0",
     "finalhandler": "^2.1.0",
     "hono": "^4.4.13",
     "koa": "^3.0.0",
@@ -61,7 +59,7 @@
     "range-parser": "^1.2.1",
     "router": "^2.2.0",
     "supertest": "^7.0.0",
-    "typescript": "^5.3.3"
+    "typescript": "^6.0.2"
   },
   "peerDependencies": {
     "@rspack/core": "^2.0.0-0"

package/types/index.d.ts

@@ -95,23 +95,22 @@
  * @property {"weak" | "strong"=} etag options to generate etag header
  * @property {boolean=} lastModified options to generate last modified header
  * @property {(boolean | number | string | { maxAge?: number, immutable?: boolean })=} cacheControl options to generate cache headers
- * @property {boolean=} cacheImmutable is cache immutable
+ * @property {boolean=} cacheImmutable enable immutable cache headers for immutable assets (defaults to true when omitted)
  */
 /**
  * @template {IncomingMessage} [RequestInternal=IncomingMessage]
  * @template {ServerResponse} [ResponseInternal=ServerResponse]
  * @callback Middleware
- * @param {RequestInternal} req
- * @param {ResponseInternal} res
- * @param {NextFunction} next
+ * @param {RequestInternal} req request
+ * @param {ResponseInternal} res response
+ * @param {NextFunction} next next function
  * @returns {Promise<void>}
  */
-/** @typedef {import("./utils/getFilenameFromUrl").Extra} Extra */
+/** @typedef {import("./utils/getFilenameFromUrl.js").Extra} Extra */
 /**
  * @callback GetFilenameFromUrl
- * @param {string} url
- * @param {Extra=} extra
- * @returns {string | undefined}
+ * @param {string} url request URL
+ * @returns {{ filename: string, extra: Extra } | undefined} a filename with additional information, or `undefined` if nothing is found
  */
 /**
  * @callback WaitUntilValid
@@ -364,7 +363,7 @@ export type Options<
       )
     | undefined;
   /**
-   * is cache immutable
+   * enable immutable cache headers for immutable assets (defaults to true when omitted)
    */
   cacheImmutable?: boolean | undefined;
 };
@@ -376,11 +375,13 @@ export type Middleware<
   res: ResponseInternal,
   next: NextFunction,
 ) => Promise<void>;
-export type Extra = import("./utils/getFilenameFromUrl").Extra;
-export type GetFilenameFromUrl = (
-  url: string,
-  extra?: Extra | undefined,
-) => string | undefined;
+export type Extra = import("./utils/getFilenameFromUrl.js").Extra;
+export type GetFilenameFromUrl = (url: string) =>
+  | {
+      filename: string;
+      extra: Extra;
+    }
+  | undefined;
 export type WaitUntilValid = (callback: Callback) => any;
 export type Invalidate = (callback: Callback) => any;
 export type Close = (callback: (err: Error | null | undefined) => void) => any;

package/types/middleware.d.ts

@@ -14,20 +14,27 @@ export type SendErrorOptions<
    * modify response data callback
    */
   modifyResponseData?:
-    | import("./index").ModifyResponseData<Request, Response>
+    | import("./index.js").ModifyResponseData<Request, Response>
     | undefined;
 };
 export type NextFunction = import("./index.js").NextFunction;
 export type IncomingMessage = import("./index.js").IncomingMessage;
 export type ServerResponse = import("./index.js").ServerResponse;
 export type NormalizedHeaders = import("./index.js").NormalizedHeaders;
+export type FilenameError =
+  import("./utils/getFilenameFromUrl.js").FilenameError;
+export type Extra = import("./utils/getFilenameFromUrl.js").Extra;
 export type ReadStream = import("fs").ReadStream;
+export type FilenameWithExtra = {
+  filename: string;
+  extra: Extra;
+};
 /**
  * @template {IncomingMessage} Request
  * @template {ServerResponse} Response
  * @typedef {object} SendErrorOptions send error options
  * @property {Record<string, number | string | string[] | undefined>=} headers headers
- * @property {import("./index").ModifyResponseData<Request, Response>=} modifyResponseData modify response data callback
+ * @property {import("./index.js").ModifyResponseData<Request, Response>=} modifyResponseData modify response data callback
  */
 /**
  * @template {IncomingMessage} Request

package/types/utils/compatibleAPI.d.ts

@@ -1,7 +1,7 @@
-export type IncomingMessage = import("../index").IncomingMessage;
-export type ServerResponse = import("../index").ServerResponse;
-export type OutputFileSystem = import("../index").OutputFileSystem;
-export type EXPECTED_ANY = import("../index").EXPECTED_ANY;
+export type IncomingMessage = import("../index.js").IncomingMessage;
+export type ServerResponse = import("../index.js").ServerResponse;
+export type OutputFileSystem = import("../index.js").OutputFileSystem;
+export type EXPECTED_ANY = import("../index.js").EXPECTED_ANY;
 export type ExpectedIncomingMessage = {
   /**
    * get header extra method
@@ -15,10 +15,6 @@ export type ExpectedIncomingMessage = {
    * get URL extra method
    */
   getURL?: (() => string | undefined) | undefined;
-  /**
-   * an extra option for `fastify` (and `@fastify/express`) to get original URL
-   */
-  originalUrl?: string | undefined;
 };
 export type ExpectedServerResponse = {
   /**
@@ -115,16 +111,15 @@ export function getHeadersSent<
 export function getOutgoing<
   Response extends ServerResponse & ExpectedServerResponse,
 >(res: Response): Response;
-/** @typedef {import("../index").IncomingMessage} IncomingMessage */
-/** @typedef {import("../index").ServerResponse} ServerResponse */
-/** @typedef {import("../index").OutputFileSystem} OutputFileSystem */
-/** @typedef {import("../index").EXPECTED_ANY} EXPECTED_ANY */
+/** @typedef {import("../index.js").IncomingMessage} IncomingMessage */
+/** @typedef {import("../index.js").ServerResponse} ServerResponse */
+/** @typedef {import("../index.js").OutputFileSystem} OutputFileSystem */
+/** @typedef {import("../index.js").EXPECTED_ANY} EXPECTED_ANY */
 /**
  * @typedef {object} ExpectedIncomingMessage
  * @property {((name: string) => string | string[] | undefined)=} getHeader get header extra method
  * @property {(() => string | undefined)=} getMethod get method extra method
  * @property {(() => string | undefined)=} getURL get URL extra method
- * @property {string=} originalUrl an extra option for `fastify` (and `@fastify/express`) to get original URL
  */
 /**
  * @typedef {object} ExpectedServerResponse

package/types/utils/getFilenameFromUrl.d.ts

@@ -1,25 +1,31 @@
 export default getFilenameFromUrl;
 export type IncomingMessage = import("../index.js").IncomingMessage;
+export type OutputFileSystem = import("../index.js").OutputFileSystem;
 export type ServerResponse = import("../index.js").ServerResponse;
+export type FSStats = import("fs").Stats;
+export type FilenameWithExtra = {
+  filename: string;
+  extra: Extra;
+};
 export type Extra = {
   /**
    * stats
    */
-  stats?: import("fs").Stats | undefined;
-  /**
-   * error code
-   */
-  errorCode?: number | undefined;
+  stats: FSStats;
   /**
    * true when immutable, otherwise false
    */
   immutable?: boolean | undefined;
+  /**
+   * output file system
+   */
+  outputFileSystem: OutputFileSystem;
 };
 /**
  * @typedef {object} Extra
- * @property {import("fs").Stats=} stats stats
- * @property {number=} errorCode error code
+ * @property {FSStats} stats stats
  * @property {boolean=} immutable true when immutable, otherwise false
+ * @property {OutputFileSystem} outputFileSystem output file system
  */
 /**
  * decodeURIComponent.
@@ -28,13 +34,20 @@ export type Extra = {
  * @param {string} input
  * @returns {string}
  */
+export class FilenameError extends Error {
+  /**
+   * @param {string} message message
+   * @param {number=} code error code
+   */
+  constructor(message: string, code?: number | undefined);
+  statusCode: number | undefined;
+}
 /**
  * @template {IncomingMessage} Request
  * @template {ServerResponse} Response
  * @param {import("../index.js").FilledContext<Request, Response>} context context
  * @param {string} url url
- * @param {Extra=} extra extra
- * @returns {string | undefined} filename
+ * @returns {FilenameWithExtra | undefined} result of get filename from url
  */
 declare function getFilenameFromUrl<
   Request extends IncomingMessage,
@@ -42,5 +55,4 @@ declare function getFilenameFromUrl<
 >(
   context: import("../index.js").FilledContext<Request, Response>,
   url: string,
-  extra?: Extra | undefined,
-): string | undefined;
+): FilenameWithExtra | undefined;

package/types/utils/getPaths.d.ts

@@ -5,6 +5,7 @@ export type MultiStats = import("@rspack/core").MultiStats;
 export type Asset = import("@rspack/core").Asset;
 export type DevServerOption = import("../index.js").DevServerOption;
 export type IncomingMessage = import("../index.js").IncomingMessage;
+export type OutputFileSystem = import("../index.js").OutputFileSystem;
 export type ServerResponse = import("../index.js").ServerResponse;
 /** @typedef {import("@rspack/core").Compiler} Compiler */
 /** @typedef {import("@rspack/core").Stats} Stats */
@@ -12,12 +13,13 @@ export type ServerResponse = import("../index.js").ServerResponse;
 /** @typedef {import("@rspack/core").Asset} Asset */
 /** @typedef {import("../index.js").DevServerOption} DevServerOption */
 /** @typedef {import("../index.js").IncomingMessage} IncomingMessage */
+/** @typedef {import("../index.js").OutputFileSystem} OutputFileSystem */
 /** @typedef {import("../index.js").ServerResponse} ServerResponse */
 /**
  * @template {IncomingMessage} Request
  * @template {ServerResponse} Response
  * @param {import("../index.js").FilledContext<Request, Response>} context context
- * @returns {{ outputPath: string, publicPath: string, assetsInfo: Map<string, Asset["info"]> | undefined }[]} paths
+ * @returns {{ outputPath: string, outputFileSystem: OutputFileSystem, publicPath: string, assetsInfo: Map<string, Asset["info"]> | undefined }[]} paths
  */
 declare function getPaths<
   Request extends IncomingMessage,
@@ -26,6 +28,7 @@ declare function getPaths<
   context: import("../index.js").FilledContext<Request, Response>,
 ): {
   outputPath: string;
+  outputFileSystem: OutputFileSystem;
   publicPath: string;
   assetsInfo: Map<string, Asset["info"]> | undefined;
 }[];

package/types/utils/memorize.d.ts

@@ -1,6 +1,6 @@
 export default memorize;
 export type FunctionReturning<T> = (...args: EXPECTED_ANY) => T;
-export type EXPECTED_ANY = import("../index").EXPECTED_ANY;
+export type EXPECTED_ANY = import("../index.js").EXPECTED_ANY;
 /**
  * @template T
  * @typedef {(...args: EXPECTED_ANY) => T} FunctionReturning