rspack-dev-middleware 0.1.32 → 0.2.0

package/README.md

@@ -19,20 +19,19 @@
  */
 
 import Koa from 'koa';
-import memfs from 'memfs';
 import path from 'node:path';
 import rspack from '@rspack/core';
 import compress from 'koa-compress';
+import { Volume, createFsFromVolume } from 'memfs';
 import { server as dev } from 'rspack-dev-middleware';
 import ReactRefreshPlugin from '@rspack/plugin-react-refresh';
 
 const entryHTML = path.resolve('wwwroot/index.html');
 
 function createMemfs() {
-  const volume = new memfs.Volume();
-  const fs = memfs.createFsFromVolume(volume);
+  const volume = new Volume();
 
-  return fs;
+  return createFsFromVolume(volume);
 }
 
 function httpError(error) {
@@ -50,6 +49,7 @@ const html = {
 };
 
 const compiler = rspack({
+  cache: true,
   name: 'React',
   mode: 'development',
   context: path.resolve('src'),
@@ -61,25 +61,6 @@ const compiler = rspack({
     path: path.resolve('wwwroot/public'),
     assetModuleFilename: `[path][name][ext]`
   },
-  experiments: {
-    css: true
-  },
-  watchOptions: {
-    aggregateTimeout: 256
-  },
-  stats: {
-    colors: true,
-    chunks: false,
-    children: false,
-    entrypoints: false,
-    runtimeModules: false,
-    dependentModules: false
-  },
-  devtool: 'eval-cheap-module-source-map',
-  resolve: {
-    fallback: { url: false },
-    extensions: ['.ts', '.tsx', '.js', '.jsx']
-  },
   module: {
     parser: {
       'css/auto': {
@@ -129,20 +110,50 @@ const compiler = rspack({
       }
     ]
   },
+  resolve: {
+    extensions: ['.ts', '.tsx', '.js', '.jsx']
+  },
   plugins: [
     new ReactRefreshPlugin(),
     new rspack.ProgressPlugin({
       prefix: '[Rspack]',
       progressChars: '█▒'
     }),
-    new rspack.HtmlRspackPlugin(html)
-  ]
+    new rspack.HtmlRspackPlugin(html),
+    new rspack.WarnCaseSensitiveModulesPlugin()
+  ],
+  watchOptions: {
+    aggregateTimeout: 256
+  },
+  stats: {
+    all: false,
+    assets: true,
+    colors: true,
+    errors: true,
+    timings: true,
+    version: true,
+    warnings: true,
+    errorsCount: true,
+    warningsCount: true,
+    groupAssetsByPath: true
+  },
+  devtool: 'eval-cheap-module-source-map',
+  experiments: {
+    css: true,
+    cache: {
+      type: 'persistent',
+      storage: {
+        type: 'filesystem',
+        directory: path.resolve('../node_modules/.cache/rspack')
+      }
+    }
+  }
 });
 
 const port = 8000;
 const app = new Koa();
 const fs = createMemfs();
-const server = dev(compiler, {
+const server = await dev(compiler, {
   fs,
   headers: {
     'Cache-Control': 'no-cache',
@@ -168,9 +179,7 @@ app.on('error', error => {
 });
 
 app.listen(port, () => {
-  server.ready(() => {
-    server.logger.info(`server run at: \u001B[36mhttp://127.0.0.1:${port}\u001B[0m`);
-  });
+  server.logger.info(`server run at: \x1b[36mhttp://127.0.0.1:${port}\x1b[0m`);
 });
 ```
 

package/cjs/client/HotUpdate.cjs

@@ -0,0 +1,78 @@
+/**
+ * @package rspack-dev-middleware
+ * @license MIT
+ * @version 0.2.0
+ * @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
+ */
+
+'use strict';
+
+/**
+ * @module HotUpdate
+ */
+class HotUpdate {
+  #hmr;
+  #fallback;
+  #pending = false;
+  #hash = __webpack_hash__;
+  #hot = module.hot;
+  /**
+   * @constructor
+   * @param hmr Whether to enable HMR hot update.
+   * @param fallback Fallback handler for update failures.
+   */
+  constructor(hmr = true, fallback) {
+    this.#hmr = hmr;
+    this.#fallback = fallback;
+    // Listen to status changes
+    this.#hot?.addStatusHandler(async status => {
+      if (this.#pending && status === 'idle') {
+        this.#pending = false;
+        await this.performUpdate();
+      }
+    });
+  }
+  /**
+   * @method updateHash
+   * @description Update hash value.
+   * @param hash New hash value.
+   */
+  updateHash(hash) {
+    this.#hash = hash;
+  }
+  /**
+   * @method #isUpdateAvailable
+   * @description Check if new updates are available.
+   */
+  #isUpdateAvailable() {
+    return this.#hash !== __webpack_hash__;
+  }
+  /**
+   * @method performUpdate
+   * @description Execute update strategy.
+   */
+  async performUpdate() {
+    if (this.#isUpdateAvailable()) {
+      if (!this.#hmr || !this.#hot) {
+        await this.#fallback();
+      } else if (this.#hot.status() === 'idle') {
+        try {
+          const outdated = await this.#hot.check(true);
+          if (outdated == null || outdated.length <= 0) {
+            if (this.#isUpdateAvailable()) {
+              await this.#fallback();
+            }
+          }
+        } catch (error) {
+          await this.#fallback(error);
+        }
+      } else {
+        this.#pending = true;
+      }
+    }
+  }
+}
+
+exports.HotUpdate = HotUpdate;

package/cjs/client/HotUpdate.d.cts

@@ -0,0 +1,26 @@
+/**
+ * @module HotUpdate
+ */
+export interface Fallback {
+  (error?: Error): Promise<void> | void;
+}
+export declare class HotUpdate {
+  #private;
+  /**
+   * @constructor
+   * @param hmr Whether to enable HMR hot update.
+   * @param fallback Fallback handler for update failures.
+   */
+  constructor(hmr: boolean | undefined, fallback: Fallback);
+  /**
+   * @method updateHash
+   * @description Update hash value.
+   * @param hash New hash value.
+   */
+  updateHash(hash: string): void;
+  /**
+   * @method performUpdate
+   * @description Execute update strategy.
+   */
+  performUpdate(): Promise<void>;
+}

package/cjs/client/client.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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
@@ -12,31 +12,29 @@
 const events = require('./events.cjs');
 const Overlay = require('./ui/Overlay.cjs');
 const Progress = require('./ui/Progress.cjs');
-const hot = require('./hot.cjs');
+const HotUpdate = require('./HotUpdate.cjs');
 
 /**
  * @module client
  */
 function createClient(options) {
-  let updateTimer;
-  const UPDATE_DELAY = 128;
   const RETRY_INTERVAL = 3000;
   const progress = new Progress.Progress();
   const overlay = new Overlay.Overlay(options.name);
   const fallback = () => {
-    if (options.reload) {
-      self.location.reload();
-    } else {
-      console.warn('Use fallback update but you turn off live reload, please reload by yourself.');
-    }
-  };
-  const applyUpdateAsync = () => {
-    updateTimer = self.setTimeout(() => {
-      hot.applyUpdate(options.hmr, fallback);
-    }, UPDATE_DELAY);
+    return new Promise(resolve => {
+      queueMicrotask(() => {
+        if (options.reload) {
+          self.location.reload();
+        } else {
+          console.warn('[HMR] Hot update failed. Please reload the page manually.');
+        }
+        resolve();
+      });
+    });
   };
+  const hot = new HotUpdate.HotUpdate(options.hmr, fallback);
   const onInvalid = () => {
-    clearTimeout(updateTimer);
     if (options.progress) {
       progress.update(0);
       progress.show();
@@ -74,14 +72,14 @@ function createClient(options) {
       overlay.show();
     }
     if (errors.length <= 0) {
-      applyUpdateAsync();
+      hot.performUpdate();
     }
   };
   const onOk = () => {
     progress.update(1);
     progress.hide();
     overlay.hide();
-    applyUpdateAsync();
+    hot.performUpdate();
   };
   const parseMessage = message => {
     try {

package/cjs/client/events.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/Overlay.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/Progress.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/images/rspack-logo.svg.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/compose.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/ReadStream.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/Service.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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
@@ -9,7 +9,6 @@
 
 'use strict';
 
-const ready = require('./utils/ready.cjs');
 const fs = require('./utils/fs.cjs');
 const middleware = require('./middleware.cjs');
 const setupHooks = require('./utils/setupHooks.cjs');
@@ -38,18 +37,12 @@ function setup(compiler, options) {
   setupWatching.setupWatching(context);
   return context;
 }
-function dev(compiler, options) {
+async function dev(compiler, options) {
   const context = setup(compiler, options);
-  return Object.assign(middleware.middleware(context), {
-    get state() {
-      return !!context.stats;
-    },
+  return Object.assign(await middleware.middleware(context), {
     get logger() {
       return context.logger;
     },
-    ready(callback) {
-      ready.ready(context, callback);
-    },
     close(callback) {
       context.watching.close(callback);
     },

package/cjs/server/dev/index.d.cts

@@ -5,4 +5,4 @@ import { Middleware } from 'koa';
 import { UnionCompiler } from '../interface.cjs';
 import { Expose, Options } from './interface.cjs';
 export { Expose, Options };
-export declare function dev(compiler: UnionCompiler, options: Options): Middleware & Expose;
+export declare function dev(compiler: UnionCompiler, options: Options): Promise<Middleware & Expose>;

package/cjs/server/dev/interface.d.cts

@@ -13,8 +13,6 @@ export interface ErrorCallback {
 }
 export interface Expose {
   readonly logger: Logger;
-  readonly state: boolean;
-  readonly ready: (callback: Callback) => void;
   readonly close: (callback: ErrorCallback) => void;
   readonly invalidate: (callback: ErrorCallback) => void;
 }
@@ -29,7 +27,6 @@ export interface Context {
   callbacks: Callback[];
   compiler: UnionCompiler;
   watching: UnionWatching;
-  services?: FileService[];
   stats: UnionStats | null;
   options: Options & {
     fs: FileSystem;

package/cjs/server/dev/middleware.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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
@@ -18,11 +18,6 @@ const paths = require('./utils/paths.cjs');
  * @module middleware
  */
 function getFileServices(context, stats) {
-  const cached = context.services;
-  // Cache hit.
-  if (cached) {
-    return cached;
-  }
   const { options } = context;
   const paths$1 = paths.getPaths(stats);
   const services = [];
@@ -30,8 +25,6 @@ function getFileServices(context, stats) {
   for (const [outputPath, publicPath] of paths$1) {
     services.push([publicPath, new Service.Service(outputPath, options)]);
   }
-  // Cache services.
-  context.services = services;
   // Return services.
   return services;
 }
@@ -49,24 +42,24 @@ function getFileServicesAsync(context) {
     }
   });
 }
-function middleware(context) {
+async function middleware(context) {
+  // Get the file services.
+  const services = await getFileServicesAsync(context);
   // Middleware.
-  return async (ctx, next) => {
-    const { request } = ctx;
+  return async (context, next) => {
+    const { request } = context;
     const pathname = http.decodeURI(request.path);
     // Pathname decode failed or includes null byte(s).
     if (pathname === -1 || pathname.includes('\0')) {
-      return ctx.throw(400);
+      return context.throw(400);
     }
     // Get request method.
     const { method } = request;
     // Only support GET and HEAD (405).
     if (method === 'GET' || method === 'HEAD') {
-      // Get the file services.
-      const services = await getFileServicesAsync(context);
       // Try to respond.
       for (const [publicPath, service] of services) {
-        if (await service.respond(pathname, ctx, publicPath)) {
+        if (await service.respond(pathname, context, publicPath)) {
           return;
         }
       }

package/cjs/server/dev/middleware.d.cts

@@ -3,4 +3,4 @@
  */
 import { Middleware } from 'koa';
 import { Context } from './interface.cjs';
-export declare function middleware(context: Context): Middleware;
+export declare function middleware(context: Context): Promise<Middleware>;

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

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/hash.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/path.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/paths.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/ready.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/setupHooks.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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
@@ -87,11 +87,14 @@ function setupHooks(context) {
         onCompilationDone(stats, statsOptions);
         // Callbacks.
         const { callbacks } = context;
-        // Clear callbacks.
-        context.callbacks = [];
-        // Call callbacks.
-        for (const callback of callbacks) {
-          callback(stats);
+        // Call callbacks if there are any.
+        if (callbacks.length > 0) {
+          // Clear callbacks.
+          context.callbacks = [];
+          // Call callbacks.
+          for (const callback of callbacks) {
+            callback(stats);
+          }
         }
         // Log compilation finished.
         context.logger.log('compilation finished');

package/cjs/server/dev/utils/setupOutputFileSystem.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/setupWatching.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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/setupWriteToDisk.cjs

@@ -1,7 +1,7 @@
 /**
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.1.32
+ * @version 0.2.0
  * @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