rspack-dev-middleware 0.4.0 → 0.4.2

package/esm/client/ui/Progress.js

@@ -2,14 +2,14 @@
  * @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
  */
 
 import logo from './images/rspack-logo.svg.js';
-import { getRootElement, insertCSSString, appendDOMString } from './utils.js';
+import { getRootElement, appendStyleSheet, appendMarkup } from './utils.js';
 
 /**
  * @module Progress
@@ -65,8 +65,8 @@ class Progress {
   #track;
   constructor() {
     const root = getRootElement(PROGRESS);
-    insertCSSString(CSS, root);
-    [this.#svg] = appendDOMString('image/svg+xml', SVG, root);
+    appendStyleSheet(CSS, root);
+    this.#svg = appendMarkup('image/svg+xml', SVG, root);
     this.#track = this.#svg.querySelector(`.${PROGRESS}-track`);
   }
   update(percent) {

package/esm/client/ui/images/rspack-logo.svg.js

@@ -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/esm/client/ui/utils.d.ts

@@ -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/esm/client/ui/utils.js

@@ -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
@@ -63,10 +63,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) {
@@ -102,24 +102,18 @@ 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;
 }
 
-export { ansiToHTML, appendDOMString, blockToHTML, escapeHTML, getRootElement, insertCSSString };
+export { ansiToHTML, appendMarkup, appendStyleSheet, blockToHTML, escapeHTML, getRootElement };

package/esm/server/compose.js

@@ -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
@@ -31,7 +31,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/esm/server/dev/ReadStream.js

@@ -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
@@ -97,12 +97,12 @@ class ReadStream extends 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);
@@ -145,14 +145,14 @@ class ReadStream extends 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/esm/server/dev/Service.js

@@ -2,19 +2,18 @@
  * @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
  */
 
-import createETag from 'etag';
 import { ReadStream } from './ReadStream.js';
 import { isFunction } from '../utils.js';
 import { stat } from './utils/fs.js';
 import { resolve, extname, join } from 'node:path';
 import { unixify, isOutRoot, hasTrailingSlash } from './utils/path.js';
-import { isConditionalGET, isPreconditionFailed, parseRanges } from './utils/http.js';
+import { createETag, isConditionalGET, isPreconditionFailed, parseRanges } from './utils/http.js';
 
 /**
  * @module Service
@@ -58,7 +57,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.
@@ -152,10 +151,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;
     }
@@ -163,14 +160,12 @@ class Service {
     const ranges = 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(path, ranges, {

package/esm/server/dev/index.js

@@ -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
@@ -25,8 +25,12 @@ function setup(compiler, options) {
     compiler,
     stats: null,
     callbacks: [],
-    logger: compiler.getInfrastructureLogger(PLUGIN_NAME),
-    options: { fs: createMemfs(), highWaterMark: 65536, ...options }
+    options: {
+      ...options,
+      fs: options.fs ?? createMemfs(),
+      highWaterMark: options.highWaterMark ?? 65536
+    },
+    logger: compiler.getInfrastructureLogger(PLUGIN_NAME)
   };
   setupHooks(context);
   if (options.writeToDisk) {

package/esm/server/dev/middleware.js

@@ -2,14 +2,13 @@
  * @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
  */
 
 import { Service } from './Service.js';
-import { ready } from './utils/ready.js';
 import { decodeURI } from './utils/http.js';
 import { getPaths } from './utils/paths.js';
 
@@ -29,13 +28,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(context, stats => {
+      callbacks.push(stats => {
         resolve(getFileServices(context, stats));
       });
     }

package/esm/server/dev/utils/fs.js

@@ -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/esm/server/dev/utils/http.d.ts

@@ -16,12 +16,37 @@ export interface Range {
  * @param URI The URI to decode.
  */
 export declare function decodeURI(URI: string): string | -1;
+/**
+ * @function generateBoundary
+ * @description Generate a boundary string.
+ */
+export declare function generateBoundary(): string;
 /**
  * @function isConditionalGET
  * @description Check if request is conditional GET.
  * @param context The koa context.
  */
 export declare function isConditionalGET({ request }: Context): boolean;
+/**
+ * @function createETag
+ * @description Generate a weak entity tag from file stats.
+ * @param stats The file stats.
+ */
+export declare function createETag(stats: Stats): string;
+/**
+ * @function isETagMatch
+ * @see https://httpwg.org/specs/rfc9110.html
+ * @param match The match value.
+ * @param etag The etag value.
+ * @param isIfMatch The flag of if-match.
+ */
+export declare function isETagMatch(match: string, etag: string, isIfMatch?: boolean): boolean;
+/**
+ * @function isRangeFresh
+ * @description Check if request range fresh.
+ * @param context Koa context.
+ */
+export declare function isRangeFresh({ request, response }: Context): boolean;
 /**
  * @function isPreconditionFailed
  * @description Check if request precondition failed.
@@ -34,4 +59,4 @@ export declare function isPreconditionFailed({ request, response }: Context): bo
  * @param context The koa context.
  * @param stats The file stats.
  */
-export declare function parseRanges(context: Context, stats: Stats): -1 | -2 | Range[];
+export declare function parseRanges(context: Context, stats: Stats): -1 | Range[];

package/esm/server/dev/utils/http.js

@@ -2,20 +2,21 @@
  * @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
  */
 
-import { generate } from './hash.js';
 import { Buffer } from 'node:buffer';
 import parseRange from 'range-parser';
+import { getRandomValues } from 'node:crypto';
 
 /**
  * @module http
  */
 const SPLIT_ETAG_RE = /\s*,\s*/;
+const BOUNDARY_SCRATCH = Buffer.allocUnsafeSlow(24);
 const SINGLE_ETAG_RE = /^(?:W\/)?"[ !#-\x7E\x80-\xFF]+"$/;
 /**
  * @function decodeURI
@@ -29,6 +30,13 @@ function decodeURI(URI) {
     return -1;
   }
 }
+/**
+ * @function generateBoundary
+ * @description Generate a boundary string.
+ */
+function generateBoundary() {
+  return getRandomValues(BOUNDARY_SCRATCH).toString('base64url');
+}
 /**
  * @function isConditionalGET
  * @description Check if request is conditional GET.
@@ -42,6 +50,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
@@ -50,25 +66,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.
@@ -91,24 +127,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.
@@ -126,10 +144,16 @@ function parseRanges(context, stats) {
       // Parse range -1 -2 or [].
       const parsed = parseRange(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.
@@ -144,7 +168,7 @@ function parseRanges(context, stats) {
           // Parsed entries.
           const entries = parsed.entries();
           // Range boundary.
-          const boundary = `${generate(32)}`;
+          const boundary = generateBoundary();
           // Multipart Content-Type.
           const contentType = `Content-Type: ${response.type}`;
           // Range suffix.
@@ -190,4 +214,13 @@ function parseRanges(context, stats) {
   return [{ offset: 0, length: size }];
 }
 
-export { decodeURI, isConditionalGET, isPreconditionFailed, parseRanges };
+export {
+  createETag,
+  decodeURI,
+  generateBoundary,
+  isConditionalGET,
+  isETagMatch,
+  isPreconditionFailed,
+  isRangeFresh,
+  parseRanges
+};

package/esm/server/dev/utils/path.js

@@ -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/esm/server/dev/utils/paths.js

@@ -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/esm/server/dev/utils/setupHooks.js

@@ -2,26 +2,20 @@
  * @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
  */
 
 import supportsColor from 'supports-color';
-import { PLUGIN_NAME, isMultiCompiler, isString, isBoolean } from '../../utils.js';
+import { PLUGIN_NAME, isMultiCompiler, toStatsPreset } from '../../utils.js';
 
 /**
  * @module setupHooks
  */
 function normalizeStatsOptions(statsOptions) {
-  if (statsOptions == null) {
-    return { preset: 'normal' };
-  } else if (isString(statsOptions)) {
-    return { preset: statsOptions };
-  } else if (isBoolean(statsOptions)) {
-    return statsOptions ? { preset: 'normal' } : { preset: 'none' };
-  }
+  statsOptions = toStatsPreset(statsOptions);
   if (statsOptions.colors == null) {
     const { stdout, stderr } = supportsColor;
     statsOptions.colors = stdout !== false && stderr !== false;
@@ -75,7 +69,7 @@ function setupHooks(context) {
     process.nextTick(() => {
       const { stats } = context;
       // Check if still in valid state.
-      if (stats) {
+      if (stats != null) {
         // Call onCompilationDone.
         onCompilationDone(stats, statsOptions);
         // Callbacks.

package/esm/server/dev/utils/setupOutputFileSystem.js

@@ -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/esm/server/dev/utils/setupWatching.js

@@ -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
@@ -13,11 +13,8 @@ import { isMultiCompiler } from '../../utils.js';
 /**
  * @module setupWatching
  */
-function getWatching({ compiler, logger }) {
-  const isMulti = isMultiCompiler(compiler);
-  if (!isMulti && compiler.watching) {
-    return compiler.watching;
-  }
+function setupWatching(context) {
+  const { compiler, logger } = context;
   const errorHandler = error => {
     if (error != null) {
       // For example - `writeToDisk` can throw an error and right now it is ends watching.
@@ -26,17 +23,15 @@ function getWatching({ compiler, logger }) {
       logger.error(error);
     }
   };
-  if (!isMulti) {
-    const { watchOptions } = compiler.options;
-    return compiler.watch(watchOptions, errorHandler);
+  if (isMultiCompiler(compiler)) {
+    const watchOptions = compiler.compilers.map(({ options }) => {
+      return options.watchOptions;
+    });
+    context.watching = compiler.watch(watchOptions, errorHandler);
+  } else {
+    // Reuse existing watching if present, otherwise start watching.
+    context.watching = compiler.watching ?? compiler.watch(compiler.options.watchOptions, errorHandler);
   }
-  const watchOptions = compiler.compilers.map(({ options }) => {
-    return options.watchOptions;
-  });
-  return compiler.watch(watchOptions, errorHandler);
-}
-function setupWatching(context) {
-  context.watching = getWatching(context);
 }
 
 export { setupWatching };

package/esm/server/dev/utils/setupWriteToDisk.js

@@ -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