webpack-dev-service 0.13.2 → 0.14.0

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

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

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

@@ -0,0 +1,24 @@
+/**
+ * @module fs
+ */
+import webpack from 'webpack';
+import fs, { Stats } from 'node:fs';
+import { GetProp } from '../../interface.cjs';
+export interface FileSystem extends GetProp<webpack.Compiler, 'outputFileSystem'> {
+  stat: typeof fs.stat;
+  open: typeof fs.open;
+  read: typeof fs.read;
+  close: typeof fs.close;
+}
+/**
+ * @function createMemfs
+ * @description Create memfs instance.
+ */
+export declare function createMemfs(): FileSystem;
+/**
+ * @function stat
+ * @description Get file stats.
+ * @param fs The file system to used.
+ * @param path The file path.
+ */
+export declare function stat(fs: FileSystem, path: string): Promise<Stats | null>;

package/cjs/server/dev/utils/hash.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

package/cjs/server/dev/utils/hash.d.cts

@@ -0,0 +1,9 @@
+/**
+ * @module hash
+ */
+/**
+ * @function generate
+ * @description Generate a hash.
+ * @param length The length of hash.
+ */
+export declare function generate(length: number): string;

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

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

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

@@ -0,0 +1,37 @@
+/**
+ * @module http
+ */
+import { Context } from 'koa';
+import { Stats } from 'node:fs';
+import { Buffer } from 'node:buffer';
+export interface Range {
+  offset: number;
+  length: number;
+  prefix?: Buffer;
+  suffix?: Buffer;
+}
+/**
+ * @function decodeURI
+ * @description Decode URI component.
+ * @param URI The URI to decode.
+ */
+export declare function decodeURI(URI: string): string | -1;
+/**
+ * @function isConditionalGET
+ * @description Check if request is conditional GET.
+ * @param context The koa context.
+ */
+export declare function isConditionalGET({ request }: Context): boolean;
+/**
+ * @function isPreconditionFailed
+ * @description Check if request precondition failed.
+ * @param context The koa context.
+ */
+export declare function isPreconditionFailed({ request, response }: Context): boolean;
+/**
+ * @function parseRanges
+ * @description Parse ranges.
+ * @param context The koa context.
+ * @param stats The file stats.
+ */
+export declare function parseRanges(context: Context, stats: Stats): Range[] | -1 | -2;

package/cjs/server/dev/utils/path.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

package/cjs/server/dev/utils/path.d.cts

@@ -0,0 +1,22 @@
+/**
+ * @module path
+ */
+/**
+ * @function unixify
+ * @description Convert path to unix style.
+ * @param path The path to convert.
+ */
+export declare function unixify(path: string): string;
+/**
+ * @function hasTrailingSlash
+ * @description Check if path has trailing slash.
+ * @param path The path to check.
+ */
+export declare function hasTrailingSlash(path: string): boolean;
+/**
+ * @function isOutRoot
+ * @description Check if path is out of root.
+ * @param path The path to check.
+ * @param root The root path.
+ */
+export declare function isOutRoot(path: string, root: string): boolean;

package/cjs/server/dev/utils/paths.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

package/cjs/server/dev/utils/paths.d.cts

@@ -0,0 +1,7 @@
+/**
+ * @module paths
+ */
+import { UnionStats } from '../../interface.cjs';
+type PathsItem = [outputPath: string, publicPath: string];
+export declare function getPaths(stats: UnionStats): PathsItem[];
+export {};

package/cjs/server/dev/utils/ready.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

package/cjs/server/dev/utils/ready.d.cts

@@ -0,0 +1,5 @@
+/**
+ * @module ready
+ */
+import { Callback, Context } from '../interface.cjs';
+export declare function ready({ stats, callbacks }: Context, callback: Callback): void;

package/cjs/server/dev/utils/setupHooks.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme
@@ -38,7 +38,7 @@ function normalizeStatsOptions(statsOptions) {
 function getStatsOptions(context) {
   const { compiler } = context;
   const { stats } = context.options;
-  if (stats) {
+  if (stats != null) {
     if (utils.isMultiCompiler(compiler)) {
       return {
         children: compiler.compilers.map(() => {
@@ -63,8 +63,6 @@ function setupHooks(context) {
   const invalid = () => {
     // We are now in invalid state.
     context.stats = null;
-  };
-  const watchRun = () => {
     // Log compilation starting.
     context.logger.log('compilation starting...');
   };
@@ -102,7 +100,6 @@ function setupHooks(context) {
   };
   hooks.done.tap(utils.PLUGIN_NAME, done);
   hooks.invalid.tap(utils.PLUGIN_NAME, invalid);
-  hooks.watchRun.tap(utils.PLUGIN_NAME, watchRun);
 }
 
 exports.setupHooks = setupHooks;

package/cjs/server/dev/utils/setupHooks.d.cts

@@ -0,0 +1,5 @@
+/**
+ * @module setupHooks
+ */
+import { InitialContext } from '../interface.cjs';
+export declare function setupHooks(context: InitialContext): void;

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

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

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

@@ -0,0 +1,5 @@
+/**
+ * @module setupOutputFileSystem
+ */
+import { InitialContext } from '../interface.cjs';
+export declare function setupOutputFileSystem(context: InitialContext): void;

package/cjs/server/dev/utils/setupWatching.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

package/cjs/server/dev/utils/setupWatching.d.cts

@@ -0,0 +1,5 @@
+/**
+ * @module setupWatching
+ */
+import { InitialContext } from '../interface.cjs';
+export declare function setupWatching(context: InitialContext): void;

package/cjs/server/dev/utils/setupWriteToDisk.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme
@@ -17,7 +17,7 @@ const utils = require('../../utils.cjs');
  * @module setupWriteToDisk
  */
 function getCompilerName({ options: { name } }) {
-  return name ? `compiler "${name}": ` : '';
+  return `compiler ${name ? `${name}: ` : ''}`;
 }
 function isAllowWrite(targetPath, filter) {
   return utils.isFunction(filter) ? filter(targetPath) : filter === true;

package/cjs/server/dev/utils/setupWriteToDisk.d.cts

@@ -0,0 +1,5 @@
+/**
+ * @module setupWriteToDisk
+ */
+import { InitialContext } from '../interface.cjs';
+export declare function setupWriteToDisk(context: InitialContext): void;

package/cjs/server/hot/Message.d.cts

@@ -0,0 +1,49 @@
+/**
+ * @module message
+ */
+import webpack from 'webpack';
+import { GetProp } from '../interface.cjs';
+export interface Invalid {
+  action: 'invalid';
+  payload: {
+    timestamp: number;
+    path: string | null;
+  };
+}
+export interface Progress {
+  action: 'progress';
+  payload: {
+    status: string;
+    messages: string[];
+    percentage: number;
+  };
+}
+export interface Hash {
+  action: 'hash';
+  payload: {
+    hash: string;
+    timestamp: number;
+  };
+}
+export interface Issues {
+  action: 'issues';
+  payload: {
+    timestamp: number;
+    errors: webpack.StatsError[];
+    warnings: webpack.StatsError[];
+  };
+}
+export interface Ok {
+  action: 'ok';
+  payload: {
+    timestamp: number;
+  };
+}
+export interface Messages {
+  ok: GetProp<Ok, 'payload'>;
+  hash: GetProp<Hash, 'payload'>;
+  issues: GetProp<Issues, 'payload'>;
+  invalid: GetProp<Invalid, 'payload'>;
+  progress: GetProp<Progress, 'payload'>;
+}
+export type Message = Invalid | Progress | Hash | Issues | Ok;

package/cjs/server/hot/Socket.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme
@@ -10,9 +10,10 @@
 'use strict';
 
 const webpack = require('webpack');
+const uuid = require('uuid');
 const node_buffer = require('node:buffer');
-const node_url = require('node:url');
 const node_path = require('node:path');
+const node_url = require('node:url');
 const WebSocket = require('ws');
 const utils$1 = require('../utils.cjs');
 const utils = require('./utils.cjs');
@@ -29,52 +30,45 @@ const WebSocket__default = /*#__PURE__*/ _interopDefault(WebSocket);
  */
 function entrypoint() {
   const filename = require.main.filename;
-  try {
-    return node_path.dirname(node_url.fileURLToPath(filename));
-  } catch {
-    return node_path.dirname(filename);
-  }
+  return node_path.dirname(filename);
 }
 const client = node_path.resolve(entrypoint(), '../../client/main.cjs');
 class Socket {
   // Readonly props.
   #logger;
-  #compiler;
   #server;
   #options;
-  // Mutable props.
-  #percentage = -1;
-  #stats = null;
   constructor(compiler, options) {
-    this.#compiler = compiler;
     this.#options = utils.getOptions(options);
     this.#logger = compiler.getInfrastructureLogger(utils$1.PLUGIN_NAME);
     this.#server = new WebSocket.WebSocketServer({ noServer: true, path: this.#options.path });
-    this.#setupWss();
-    this.#setupHooks();
-    this.#setupPlugins();
-  }
-  #setupWss() {
-    const logger = this.#logger;
-    const server = this.#server;
-    server.on('connection', client => {
-      const stats = this.#stats;
-      logger.log('client connected');
-      client.on('close', () => {
-        logger.log('client disconnected');
-      });
-      if (stats) {
-        this.#broadcastStats([client], stats);
-      }
-    });
-    server.on('error', error => {
-      logger.error(error);
-    });
+    const compilers = utils$1.getCompilers(compiler);
+    const contexts = new Map();
+    for (const compiler of compilers) {
+      const uuid$1 = uuid.v7();
+      const context = {
+        uuid: uuid$1,
+        stats: null,
+        percentage: -1,
+        clients: new Set()
+      };
+      contexts.set(uuid$1, context);
+      this.#setupHooks(compiler, context);
+      this.#setupPlugins(compiler, context);
+    }
+    this.#setupWss(contexts);
   }
-  #setupHooks() {
-    const compiler = this.#compiler;
+  #setupHooks(compiler, context) {
     const { hooks } = compiler;
     const statsOptions = utils.getStatsOptions(compiler);
+    hooks.invalid.tap(utils$1.PLUGIN_NAME, (path, timestamp) => {
+      // Set stats to null.
+      context.stats = null;
+      // Reset percentage.
+      context.percentage = -1;
+      // Broadcast invalid.
+      this.#broadcast(context.clients, 'invalid', { path, timestamp });
+    });
     hooks.done.tap(utils$1.PLUGIN_NAME, stats => {
       // Get json stats.
       const jsonStats = stats.toJson(statsOptions);
@@ -83,66 +77,102 @@ class Socket {
         jsonStats.builtAt = utils.getTimestamp(jsonStats);
       }
       // Cache stats.
-      this.#stats = jsonStats;
+      context.stats = jsonStats;
       // Do the stuff in nextTick, because bundle may be invalidated if a change happened while compiling.
       process.nextTick(() => {
-        const stats = this.#stats;
+        const { stats } = context;
         // Broadcast stats.
         if (stats) {
-          this.#broadcastStats(this.clients(), stats);
+          this.#broadcastStats(context.clients, stats);
         }
       });
     });
-    hooks.invalid.tap(utils$1.PLUGIN_NAME, (path, timestamp) => {
-      // Set stats to null.
-      this.#stats = null;
-      // Reset percentage.
-      this.#percentage = -1;
-      // Broadcast invalid.
-      this.broadcast(this.clients(), 'invalid', { path, timestamp });
-    });
   }
-  #setupPlugins() {
+  #setupPlugins(compiler, context) {
     const options = this.#options;
-    const compiler = this.#compiler;
-    const compilers = utils$1.getCompilers(compiler);
+    const params = new URLSearchParams();
+    params.set('uuid', context.uuid);
+    params.set('path', options.path);
+    const { wss } = options;
+    if (wss != null) {
+      params.set('wss', wss ? 'true' : 'false');
+    }
+    params.set('name', compiler.name || 'rspack');
+    params.set('hmr', options.hmr ? 'true' : 'false');
+    params.set('reload', options.reload ? 'true' : 'false');
+    params.set('overlay', options.overlay ? 'true' : 'false');
+    params.set('progress', options.progress ? 'true' : 'false');
     const plugins = [
-      () => {
-        return new webpack__default.default.HotModuleReplacementPlugin();
-      },
-      ({ name, context }) => {
-        const params = new URLSearchParams();
-        params.set('path', options.path);
-        params.set('name', name || 'webpack');
-        params.set('hmr', options.hmr ? 'true' : 'false');
-        params.set('wss', options.wss ? 'true' : 'false');
-        params.set('reload', options.reload ? 'true' : 'false');
-        params.set('overlay', options.overlay ? 'true' : 'false');
-        params.set('progress', options.progress ? 'true' : 'false');
-        // Auto add hot client to entry.
-        return new webpack__default.default.EntryPlugin(context, `${client}?${params}`, {
-          // Don't create runtime.
-          runtime: false
-        });
-      }
+      new webpack__default.default.HotModuleReplacementPlugin(),
+      // Auto add hot client to entry.
+      new webpack__default.default.EntryPlugin(compiler.context, `${client}?${params}`, {
+        // Don't create runtime.
+        runtime: false
+      })
     ];
-    for (const compiler of compilers) {
-      for (const plugin of plugins) {
-        plugin(compiler).apply(compiler);
-      }
-    }
     if (options.progress) {
-      const progress = new webpack__default.default.ProgressPlugin((percentage, status, ...messages) => {
-        if (percentage > this.#percentage) {
-          this.#percentage = percentage;
-          this.broadcast(this.clients(), 'progress', { status, messages, percentage });
+      plugins.push(
+        new webpack__default.default.ProgressPlugin((percentage, status, ...messages) => {
+          if (percentage > context.percentage) {
+            context.percentage = percentage;
+            this.#broadcast(context.clients, 'progress', { status, messages, percentage });
+          }
+        })
+      );
+    }
+    for (const plugin of plugins) {
+      plugin.apply(compiler);
+    }
+  }
+  #setupWss(contexts) {
+    const logger = this.#logger;
+    const server = this.#server;
+    const { path } = this.#options;
+    server.on('connection', (client, { url: input = path }) => {
+      const url = new node_url.URL(input, utils.BASE_URL);
+      const uuid = url.searchParams.get('uuid');
+      if (uuid) {
+        const context = contexts.get(uuid);
+        if (context) {
+          const { stats } = context;
+          context.clients.add(client);
+          logger.log('client connected');
+          client.on('close', () => {
+            context.clients.delete(client);
+            logger.log('client disconnected');
+          });
+          if (stats) {
+            const clients = new Set([client]);
+            this.#broadcastStats(clients, stats);
+          }
+        } else {
+          client.close(4001, 'compiler not found');
         }
-      });
-      progress.apply(compiler);
+      } else {
+        client.close(4000, 'uuid not found');
+      }
+    });
+    server.on('error', error => {
+      logger.error(error);
+    });
+  }
+  #broadcast(clients, action, payload) {
+    for (const client of clients) {
+      if (client.readyState === WebSocket__default.default.OPEN) {
+        client.send(JSON.stringify({ action, payload }));
+      }
     }
   }
-  clients() {
-    return this.#server.clients;
+  #broadcastStats(clients, stats) {
+    if (clients.size > 0) {
+      const { hash, errors, warnings, builtAt: timestamp } = stats;
+      this.#broadcast(clients, 'hash', { hash, timestamp });
+      if (utils.hasIssues(errors) || utils.hasIssues(warnings)) {
+        this.#broadcast(clients, 'issues', { errors, warnings, timestamp });
+      } else {
+        this.#broadcast(clients, 'ok', { timestamp });
+      }
+    }
   }
   upgrade(context) {
     const server = this.#server;
@@ -158,24 +188,6 @@ class Socket {
     }
     return false;
   }
-  broadcast(clients, action, payload) {
-    for (const client of clients) {
-      if (client.readyState === WebSocket__default.default.OPEN) {
-        client.send(JSON.stringify({ action, payload }));
-      }
-    }
-  }
-  #broadcastStats(clients, stats) {
-    if (clients.size > 0 || clients.length > 0) {
-      const { hash, errors, warnings, builtAt: timestamp } = stats;
-      this.broadcast(clients, 'hash', { hash, timestamp });
-      if (utils.hasIssues(errors) || utils.hasIssues(warnings)) {
-        this.broadcast(clients, 'issues', { errors, warnings, timestamp });
-      } else {
-        this.broadcast(clients, 'ok', { timestamp });
-      }
-    }
-  }
 }
 
 exports.Socket = Socket;

package/cjs/server/hot/Socket.d.cts

@@ -0,0 +1,11 @@
+/**
+ * @module Socket
+ */
+import { Context } from 'koa';
+import { UnionCompiler } from '../interface.cjs';
+import { Options } from './interface.cjs';
+export declare class Socket {
+  #private;
+  constructor(compiler: UnionCompiler, options?: Options);
+  upgrade(context: Context): boolean;
+}

package/cjs/server/hot/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme
@@ -16,19 +16,12 @@ const Socket = require('./Socket.cjs');
  */
 function hot(compiler, options) {
   const socket = new Socket.Socket(compiler, options);
-  const middleware = async (ctx, next) => {
+  // Middleware.
+  return async (ctx, next) => {
     if (!socket.upgrade(ctx)) {
       await next();
     }
   };
-  return Object.assign(middleware, {
-    clients() {
-      return socket.clients();
-    },
-    broadcast(clients, action, payload) {
-      socket.broadcast(clients, action, payload);
-    }
-  });
 }
 
 exports.hot = hot;

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

@@ -0,0 +1,8 @@
+/**
+ * @module index
+ */
+import { Middleware } from 'koa';
+import { Options } from './interface.cjs';
+import { UnionCompiler } from '../interface.cjs';
+export { Options };
+export declare function hot(compiler: UnionCompiler, options?: Options): Middleware;

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

@@ -0,0 +1,22 @@
+/**
+ * @module interface
+ */
+import WebSocket from 'ws';
+import webpack from 'webpack';
+import { RequiredKeys } from '../interface.cjs';
+export interface Options {
+  hmr?: boolean;
+  path?: string;
+  wss?: boolean;
+  reload?: boolean;
+  overlay?: boolean;
+  progress?: boolean;
+}
+export type Clients = Set<WebSocket>;
+export interface CompilerContext {
+  percentage: number;
+  readonly uuid: string;
+  readonly clients: Clients;
+  stats: Required<webpack.StatsCompilation> | null;
+}
+export type NormalizedOptions = RequiredKeys<Options, 'hmr' | 'path' | 'reload' | 'overlay' | 'progress'>;