rspack-dev-middleware 0.4.0 → 0.4.2

package/cjs/client/HotUpdate.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme

package/cjs/client/client.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -93,7 +93,7 @@ function createClient(options) {
     const ws = new WebSocket(url);
     ws.onmessage = message => {
       const parsed = parseMessage(message);
-      if (parsed) {
+      if (parsed != null) {
         const { action, payload } = parsed;
         switch (action) {
           case 'invalid':

package/cjs/client/events.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -28,7 +28,7 @@ const events = {
  */
 function on(event, callback) {
   const callbacks = events[event];
-  if (callbacks) {
+  if (callbacks != null) {
     callbacks.push(callback);
   }
 }
@@ -40,8 +40,8 @@ function on(event, callback) {
  */
 function off(event, callback) {
   const callbacks = events[event];
-  if (callbacks) {
-    if (callback) {
+  if (callbacks != null) {
+    if (callback != null) {
       const index = callbacks.indexOf(callback);
       if (index >= 0) {
         callbacks.splice(index, 1);
@@ -53,7 +53,7 @@ function off(event, callback) {
 }
 function emit(event, message, options) {
   const callbacks = events[event];
-  if (callbacks && callbacks.length > 0) {
+  if (callbacks != null && callbacks.length > 0) {
     for (const callback of callbacks) {
       callback(message, options);
     }

package/cjs/client/events.d.cts

@@ -4,13 +4,9 @@
 import { Options } from './client.cjs';
 import { GetProp } from '../server/interface.cjs';
 import { Messages } from '../server/hot/Message.cjs';
-export interface Events {
-  ok(message: GetProp<Messages, 'ok'>, options: Options): void;
-  hash(message: GetProp<Messages, 'hash'>, options: Options): void;
-  issues(message: GetProp<Messages, 'issues'>, options: Options): void;
-  invalid(message: GetProp<Messages, 'invalid'>, options: Options): void;
-  progress(message: GetProp<Messages, 'progress'>, options: Options): void;
-}
+export type Events = {
+  [E in keyof Messages]: (message: Messages[E], options: Options) => void;
+};
 /**
  * @function on
  * @description Add an event listener callback.

package/cjs/client/index.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme

package/cjs/client/main.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -20,7 +20,7 @@ const isTLS = protocol => {
 };
 const getCurrentScript = () => {
   const { currentScript } = document;
-  if (currentScript) {
+  if (currentScript != null) {
     return currentScript;
   }
 };
@@ -37,7 +37,7 @@ const getProtocol = (params, protocol) => {
 const getOrigin = params => {
   const { location } = self;
   const script = getCurrentScript();
-  if (script) {
+  if (script != null) {
     const url = new URL(script.src, location.href);
     const protocol = getProtocol(params, url.protocol);
     return `${protocol}//${url.host}`;

package/cjs/client/ui/Overlay.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -186,8 +186,8 @@ class Overlay {
   #warningsTitle;
   constructor(name) {
     const root = utils.getRootElement(OVERLAY);
-    utils.insertCSSString(CSS, root);
-    const [dialog] = utils.appendDOMString('text/html', HTML, root);
+    utils.appendStyleSheet(CSS, root);
+    const dialog = utils.appendMarkup('text/html', HTML, root);
     this.#dialog = dialog;
     this.#name = dialog.querySelector(`.${OVERLAY}-name`);
     this.#close = dialog.querySelector(`.${OVERLAY}-close`);
@@ -213,7 +213,7 @@ class Overlay {
       problemTitle.innerText = `${count} ${name}(s)`;
       for (const { moduleName, chunkName, message } of issues) {
         const details = utils.ansiToHTML(message);
-        const filename = moduleName || chunkName || 'unknown';
+        const filename = utils.escapeHTML(moduleName || chunkName || 'unknown');
         html += `<section><em>${name}</em> in ${filename}<pre>${details}</pre></section>`;
       }
       problemList.innerHTML = html;

package/cjs/client/ui/Progress.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -67,8 +67,8 @@ class Progress {
   #track;
   constructor() {
     const root = utils.getRootElement(PROGRESS);
-    utils.insertCSSString(CSS, root);
-    [this.#svg] = utils.appendDOMString('image/svg+xml', SVG, root);
+    utils.appendStyleSheet(CSS, root);
+    this.#svg = utils.appendMarkup('image/svg+xml', SVG, root);
     this.#track = this.#svg.querySelector(`.${PROGRESS}-track`);
   }
   update(percent) {

package/cjs/client/ui/images/rspack-logo.svg.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme

package/cjs/client/ui/utils.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -65,10 +65,10 @@ function blockToHTML({ style, value, url }) {
     textDecorations.push('line-through');
   }
   const { color, background } = style;
-  if (color) {
+  if (color != null) {
     styles.push(`color: rgb(${color})`);
   }
-  if (background) {
+  if (background != null) {
     styles.push(`background-color: rgb(${background})`);
   }
   if (textDecorations.length > 0) {
@@ -104,29 +104,23 @@ function getRootElement(tagName) {
   document.body.appendChild(stage);
   return shadowRoot;
 }
-function insertCSSString(css, root = document.body, styleElement = document.createElement('style')) {
-  styleElement.appendChild(document.createTextNode(css));
-  if (!root.contains(styleElement)) {
-    root.appendChild(styleElement);
-  }
-  return styleElement;
+function appendStyleSheet(css, root) {
+  const styleElement = document.createElement('style');
+  styleElement.textContent = css;
+  root.appendChild(styleElement);
 }
-function appendDOMString(type, string, root = document.body) {
-  const nodes = [];
-  const parser = new DOMParser();
-  const fragment = document.createDocumentFragment();
-  const { body, childNodes } = parser.parseFromString(string, type);
-  for (const node of body ? body.childNodes : childNodes) {
-    nodes.push(node);
-    fragment.appendChild(node);
-  }
-  root.appendChild(fragment);
-  return nodes;
+function appendMarkup(type, string, root) {
+  const { body, documentElement } = new DOMParser().parseFromString(string, type);
+  // XML: the root element is documentElement.
+  // HTML: the implicit <head> precedes <body>, the root element is body.firstElementChild.
+  const element = type === 'image/svg+xml' ? documentElement : body.firstElementChild;
+  root.appendChild(element);
+  return element;
 }
 
 exports.ansiToHTML = ansiToHTML;
-exports.appendDOMString = appendDOMString;
+exports.appendMarkup = appendMarkup;
+exports.appendStyleSheet = appendStyleSheet;
 exports.blockToHTML = blockToHTML;
 exports.escapeHTML = escapeHTML;
 exports.getRootElement = getRootElement;
-exports.insertCSSString = insertCSSString;

package/cjs/client/ui/utils.d.cts

@@ -7,13 +7,6 @@ export declare function blockToHTML({ style, value, url }: AnsiBlock): string;
 export declare function ansiToHTML(text: string): string;
 export type RootElement = HTMLElement | ShadowRoot;
 export declare function getRootElement(tagName: string): ShadowRoot;
-export declare function insertCSSString(
-  css: string,
-  root?: HTMLElement | ShadowRoot,
-  styleElement?: HTMLStyleElement
-): HTMLStyleElement;
-export declare function appendDOMString<T extends DOMParserSupportedType>(
-  type: T,
-  string: string,
-  root?: RootElement
-): (T extends 'image/svg+xml' ? SVGElement : HTMLElement)[];
+export declare function appendStyleSheet(css: string, root: RootElement): void;
+export declare function appendMarkup(type: 'text/html', html: string, root: RootElement): HTMLElement;
+export declare function appendMarkup(type: 'image/svg+xml', svg: string, root: RootElement): SVGElement;

package/cjs/server/compose.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -33,7 +33,7 @@ async function dispatch(middlewares, index, stack, context, next) {
     await middleware(context, () => {
       return dispatch(middlewares, index + 1, stack, context, next);
     });
-  } else if (next) {
+  } else if (next != null) {
     await next();
   }
 }

package/cjs/server/dev/ReadStream.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -99,12 +99,12 @@ class ReadStream extends node_stream.Readable {
       // Change read state.
       switch (this.#readState) {
         case 0 /* ReadState.PREFIX */:
-          this.#readState = 1 /* ReadState.RANGE */;
+          this.#readState = 1; /* ReadState.RANGE */
           this.#readFileRange(fd, range, size - bytesRead);
           break;
         case 2 /* ReadState.SUFFIX */:
           this.#currentRangeIndex++;
-          this.#readState = 0 /* ReadState.PREFIX */;
+          this.#readState = 0; /* ReadState.PREFIX */
           const nextRange = this.#getRange();
           if (nextRange == null) {
             this.push(null);
@@ -147,14 +147,14 @@ class ReadStream extends node_stream.Readable {
           // file range read completed.
           if (bytesRead < size) {
             this.#bytesRead = 0;
-            this.#readState = 2 /* ReadState.SUFFIX */;
+            this.#readState = 2; /* ReadState.SUFFIX */
             this.#readPadding(fd, range, size - bytesRead);
           }
         }
       });
     } else {
       this.#bytesRead = 0;
-      this.#readState = 2 /* ReadState.SUFFIX */;
+      this.#readState = 2; /* ReadState.SUFFIX */
       this.#readPadding(fd, range, size);
     }
   }

package/cjs/server/dev/Service.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -10,7 +10,6 @@
 
 'use strict';
 
-const createETag = require('etag');
 const ReadStream = require('./ReadStream.cjs');
 const utils = require('../utils.cjs');
 const fs = require('./utils/fs.cjs');
@@ -18,12 +17,6 @@ const node_path = require('node:path');
 const path = require('./utils/path.cjs');
 const http = require('./utils/http.cjs');
 
-function _interopDefault(e) {
-  return e && e.__esModule ? e : { default: e };
-}
-
-const createETag__default = /*#__PURE__*/ _interopDefault(createETag);
-
 /**
  * @module Service
  */
@@ -66,7 +59,7 @@ class Service {
     // Get headers.
     const headers = await options.headers(path, stats);
     // If headers not empty, set headers.
-    if (headers) {
+    if (headers != null) {
       response.set(headers);
     }
     // Accept-Ranges.
@@ -83,7 +76,7 @@ class Service {
       response.remove('ETag');
     } else if (!response.get('ETag')) {
       // Set weak ETag.
-      response.set('ETag', createETag__default.default(stats));
+      response.set('ETag', http.createETag(stats));
     }
     // Last-Modified.
     if (options.lastModified === false) {
@@ -160,10 +153,8 @@ class Service {
     }
     // Head request.
     if (request.method === 'HEAD') {
-      // Set Content-Length.
+      // Set Content-Length, koa keeps it and sends no body for HEAD.
       response.length = stats.size;
-      // Set body null
-      response.body = null;
       // File found.
       return true;
     }
@@ -171,14 +162,12 @@ class Service {
     const ranges = http.parseRanges(context, stats);
     // 416
     if (ranges === -1) {
-      // Set Content-Range.
-      response.set('Content-Range', `bytes */${stats.size}`);
-      // Unsatisfiable 416.
-      return context.throw(416);
-    }
-    // 400.
-    if (ranges === -2) {
-      return context.throw(400);
+      // koa strips all response headers on error, pass Content-Range via err.headers.
+      return context.throw(416, {
+        headers: {
+          'Content-Range': `bytes */${stats.size}`
+        }
+      });
     }
     // Set response body.
     response.body = new ReadStream.ReadStream(path$1, ranges, {

package/cjs/server/dev/index.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -27,8 +27,12 @@ function setup(compiler, options) {
     compiler,
     stats: null,
     callbacks: [],
-    logger: compiler.getInfrastructureLogger(utils.PLUGIN_NAME),
-    options: { fs: fs.createMemfs(), highWaterMark: 65536, ...options }
+    options: {
+      ...options,
+      fs: options.fs ?? fs.createMemfs(),
+      highWaterMark: options.highWaterMark ?? 65536
+    },
+    logger: compiler.getInfrastructureLogger(utils.PLUGIN_NAME)
   };
   setupHooks.setupHooks(context);
   if (options.writeToDisk) {

package/cjs/server/dev/middleware.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -11,7 +11,6 @@
 'use strict';
 
 const Service = require('./Service.cjs');
-const ready = require('./utils/ready.cjs');
 const http = require('./utils/http.cjs');
 const paths = require('./utils/paths.cjs');
 
@@ -31,13 +30,13 @@ function getFileServices(context, stats) {
 }
 function getFileServicesAsync(context) {
   return new Promise(resolve => {
-    const { stats } = context;
-    // If stats exists, resolve immediately.
+    const { stats, callbacks } = context;
+    // Resolve immediately if stats exists.
     if (stats) {
       resolve(getFileServices(context, stats));
     } else {
       // Otherwise, wait until bundle finished.
-      ready.ready(context, stats => {
+      callbacks.push(stats => {
         resolve(getFileServices(context, stats));
       });
     }

package/cjs/server/dev/utils/fs.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme

package/cjs/server/dev/utils/http.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -10,9 +10,9 @@
 
 'use strict';
 
-const hash = require('./hash.cjs');
 const node_buffer = require('node:buffer');
 const parseRange = require('range-parser');
+const node_crypto = require('node:crypto');
 
 function _interopDefault(e) {
   return e && e.__esModule ? e : { default: e };
@@ -24,6 +24,7 @@ const parseRange__default = /*#__PURE__*/ _interopDefault(parseRange);
  * @module http
  */
 const SPLIT_ETAG_RE = /\s*,\s*/;
+const BOUNDARY_SCRATCH = node_buffer.Buffer.allocUnsafeSlow(24);
 const SINGLE_ETAG_RE = /^(?:W\/)?"[ !#-\x7E\x80-\xFF]+"$/;
 /**
  * @function decodeURI
@@ -37,6 +38,13 @@ function decodeURI(URI) {
     return -1;
   }
 }
+/**
+ * @function generateBoundary
+ * @description Generate a boundary string.
+ */
+function generateBoundary() {
+  return node_crypto.getRandomValues(BOUNDARY_SCRATCH).toString('base64url');
+}
 /**
  * @function isConditionalGET
  * @description Check if request is conditional GET.
@@ -50,6 +58,14 @@ function isConditionalGET({ request }) {
     request.get('If-Unmodified-Since')
   );
 }
+/**
+ * @function createETag
+ * @description Generate a weak entity tag from file stats.
+ * @param stats The file stats.
+ */
+function createETag(stats) {
+  return `W/"${stats.size.toString(16)}-${stats.mtime.getTime().toString(16)}"`;
+}
 /**
  * @function isETagMatch
  * @see https://httpwg.org/specs/rfc9110.html
@@ -58,25 +74,45 @@ function isConditionalGET({ request }) {
  * @param isIfMatch The flag of if-match.
  */
 function isETagMatch(match, etag, isIfMatch) {
+  // Trim match.
+  match = match.trim();
+  // Check If-Match.
+  if (isIfMatch && match === '*') {
+    // The condition is true if the selected representation exists.
+    return true;
+  }
   // Trim etag.
   etag = etag.trim();
   // Weak tags cannot be matched and return false.
   if (!etag || etag.startsWith('W/')) {
     return false;
   }
-  // Trim match.
-  match = match.trim();
   // Check If-Match.
   if (isIfMatch) {
-    if (match === '*') {
-      return true;
-    }
     // If-Match maybe a list of etag.
     return match.split(SPLIT_ETAG_RE).includes(etag);
   }
   // Check If-Range.
   return match === etag;
 }
+/**
+ * @function isRangeFresh
+ * @description Check if request range fresh.
+ * @param context Koa context.
+ */
+function isRangeFresh({ request, response }) {
+  const ifRange = request.get('If-Range');
+  // No If-Range.
+  if (!ifRange) {
+    return true;
+  }
+  // If-Range as modified date failed.
+  if (SINGLE_ETAG_RE.test(ifRange)) {
+    return isETagMatch(ifRange, response.get('ETag'));
+  }
+  // Check if Last-Modified is valid and equal to If-Range date
+  return Date.parse(response.get('Last-Modified')) <= Date.parse(ifRange);
+}
 /**
  * @function isPreconditionFailed
  * @description Check if request precondition failed.
@@ -99,24 +135,6 @@ function isPreconditionFailed({ request, response }) {
   // Check precondition passed.
   return false;
 }
-/**
- * @function isRangeFresh
- * @description Check if request range fresh.
- * @param context Koa context.
- */
-function isRangeFresh({ request, response }) {
-  const ifRange = request.get('If-Range');
-  // No If-Range.
-  if (!ifRange) {
-    return true;
-  }
-  // If-Range as modified date failed.
-  if (SINGLE_ETAG_RE.test(ifRange)) {
-    return isETagMatch(ifRange, response.get('ETag'));
-  }
-  // Check if Last-Modified is valid and equal to If-Range date
-  return Date.parse(response.get('Last-Modified')) <= Date.parse(ifRange);
-}
 /**
  * @function parseRanges
  * @description Parse ranges.
@@ -134,10 +152,16 @@ function parseRanges(context, stats) {
       // Parse range -1 -2 or [].
       const parsed = parseRange__default.default(size, range, { combine: true });
       // -1 signals an unsatisfiable range.
-      // -2 signals a malformed header string.
-      if (parsed === -1 || parsed === -2) {
+      if (parsed === -1) {
         return parsed;
       }
+      // -2 signals a malformed or unknown-unit range, ignore it (RFC 9110 §14.2).
+      if (parsed === -2) {
+        // Set Content-Length.
+        response.length = size;
+        // Return ranges.
+        return [{ offset: 0, length: size }];
+      }
       // Ranges ok, support multiple ranges.
       if (parsed.type === 'bytes') {
         // Set 206 status.
@@ -152,7 +176,7 @@ function parseRanges(context, stats) {
           // Parsed entries.
           const entries = parsed.entries();
           // Range boundary.
-          const boundary = `${hash.generate(32)}`;
+          const boundary = generateBoundary();
           // Multipart Content-Type.
           const contentType = `Content-Type: ${response.type}`;
           // Range suffix.
@@ -198,7 +222,11 @@ function parseRanges(context, stats) {
   return [{ offset: 0, length: size }];
 }
 
+exports.createETag = createETag;
 exports.decodeURI = decodeURI;
+exports.generateBoundary = generateBoundary;
 exports.isConditionalGET = isConditionalGET;
+exports.isETagMatch = isETagMatch;
 exports.isPreconditionFailed = isPreconditionFailed;
+exports.isRangeFresh = isRangeFresh;
 exports.parseRanges = parseRanges;