webpack-dev-service 0.7.2 → 0.8.0

package/README.md

@@ -168,20 +168,17 @@ const compiler = webpack({
 const port = 8000;
 const app = new Koa();
 const fs = createMemfs();
-const server = dev(compiler, { index: false, outputFileSystem: fs });
-const logger = compiler.getInfrastructureLogger('webpack-dev-middleware');
-
-app.use(async (ctx, next) => {
-  ctx.set({
+const server = dev(compiler, {
+  index: false,
+  outputFileSystem: fs,
+  headers: {
     'Cache-Control': 'no-store',
     'Access-Control-Allow-Origin': '*',
     'Access-Control-Allow-Methods': '*',
     'Access-Control-Allow-Headers': '*',
     'X-Content-Type-Options': 'nosniff',
     'Access-Control-Allow-Credentials': 'true'
-  });
-
-  await next();
+  }
 });
 
 app.use(server);
@@ -196,8 +193,8 @@ app.on('error', error => {
 });
 
 app.listen(port, () => {
-  server.waitUntilValid(() => {
-    logger.info(`server run at: \u001B[36mhttp://127.0.0.1:${port}\u001B[0m`);
+  server.ready(() => {
+    server.logger.info(`server run at: \u001B[36mhttp://127.0.0.1:${port}\u001B[0m`);
   });
 });
 ```

package/client/cjs/client.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/cjs/events.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/cjs/hot.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/cjs/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/cjs/main.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/cjs/ui/overlay.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/cjs/ui/progress.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/cjs/ui/utils.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/esm/client.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/esm/events.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/esm/hot.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/esm/index.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/esm/main.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/esm/ui/overlay.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/esm/ui/progress.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/client/esm/ui/utils.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.7.2
+ * @version 0.8.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/global.d.ts

@@ -12,3 +12,5 @@ declare const __WDS_HOT_OPTIONS__: {
 };
 
 declare type HotUpdateStatus = `${webpack.HotUpdateStatus}`;
+
+declare type Optional<T extends object, K extends keyof T = keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpack-dev-service",
-  "version": "0.7.2",
+  "version": "0.8.0",
   "description": "A koa 2 middleware for webpack development and hot reloading.",
   "type": "module",
   "sideEffects": [
@@ -89,22 +89,29 @@
     "@nuintun/ansi": "^0.0.3",
     "@types/koa": "^2.15.0",
     "@types/ws": "^8.5.10",
-    "koa-compose": "^4.1.0",
+    "destroy": "^1.2.0",
+    "etag": "^1.8.1",
+    "memfs": "^4.8.0",
+    "range-parser": "^1.2.1",
+    "supports-color": "^9.4.0",
     "tslib": "^2.6.2",
-    "webpack-dev-middleware": "^7.1.0",
     "ws": "^8.16.0"
   },
   "devDependencies": {
     "@rollup/plugin-typescript": "^11.1.6",
     "@swc/core": "^1.4.8",
     "@swc/helpers": "^0.5.7",
+    "@types/destroy": "^1.0.3",
+    "@types/etag": "^1.8.3",
     "@types/koa-compose": "^3.2.8",
     "@types/node": "^20.11.30",
+    "@types/range-parser": "^1.2.7",
     "@types/react": "^18.2.67",
     "@types/react-dom": "^18.2.22",
     "css-loader": "^6.10.0",
     "html-webpack-plugin": "^5.6.0",
-    "koa": "^2.15.1",
+    "koa": "^2.15.2",
+    "koa-compress": "^5.1.1",
     "magic-string": "^0.30.8",
     "memfs": "^4.8.0",
     "mini-css-extract-plugin": "^2.8.1",
@@ -115,8 +122,8 @@
     "rollup": "^4.13.0",
     "swc-loader": "^0.2.6",
     "tsc-alias": "^1.8.8",
-    "typescript": "^5.4.2",
-    "webpack": "^5.90.3"
+    "typescript": "^5.4.3",
+    "webpack": "^5.91.0"
   },
   "peerDependencies": {
     "webpack": "^5.0.0"

package/server/cjs/dev/Files.cjs

@@ -0,0 +1,394 @@
+/**
+ * @package webpack-dev-service
+ * @license MIT
+ * @version 0.8.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
+ */
+
+'use strict';
+
+const etag = require('etag');
+const destroy = require('destroy');
+const stream = require('stream');
+const parseRange = require('range-parser');
+const boundary = require('./utils/boundary.cjs');
+const path = require('path');
+const http = require('./utils/http.cjs');
+const common = require('./utils/common.cjs');
+
+function _interopDefault(e) {
+  return e && e.__esModule ? e : { default: e };
+}
+
+const etag__default = /*#__PURE__*/ _interopDefault(etag);
+const destroy__default = /*#__PURE__*/ _interopDefault(destroy);
+const parseRange__default = /*#__PURE__*/ _interopDefault(parseRange);
+
+/**
+ * @module Files
+ */
+/**
+ * @class Files
+ */
+class Files {
+  /**
+   * @constructor
+   * @description Create files service.
+   * @param root Files service root.
+   * @param options Files service options.
+   */
+  constructor(root, options) {
+    this.options = options;
+    this.root = common.unixify(path.resolve(root));
+  }
+  /**
+   * @private
+   * @method isConditionalGET
+   * @description Check if request is conditional GET.
+   * @param context Koa context.
+   */
+  isConditionalGET(context) {
+    const { request } = context;
+    return !!(
+      request.get('If-Match') ||
+      request.get('If-None-Match') ||
+      request.get('If-Modified-Since') ||
+      request.get('if-Unmodified-Since')
+    );
+  }
+  /**
+   * @private
+   * @method isPreconditionFailure
+   * @description Check if request precondition failure.
+   * @param context Koa context.
+   */
+  isPreconditionFailure(context) {
+    const { request, response } = context;
+    // If-Match.
+    const match = request.get('If-Match');
+    if (match) {
+      const etag = response.get('ETag');
+      return !etag || (match !== '*' && !http.isETagFresh(match, etag));
+    }
+    // If-Unmodified-Since.
+    const unmodifiedSince = Date.parse(request.get('If-Unmodified-Since'));
+    if (!isNaN(unmodifiedSince)) {
+      const lastModified = Date.parse(response.get('Last-Modified'));
+      return isNaN(lastModified) || lastModified > unmodifiedSince;
+    }
+    return false;
+  }
+  /**
+   * @private
+   * @method isRangeFresh
+   * @description Check if request range fresh.
+   * @param context Koa context.
+   */
+  isRangeFresh(context) {
+    const { request, response } = context;
+    const ifRange = request.get('If-Range');
+    // No If-Range.
+    if (!ifRange) {
+      return true;
+    }
+    // If-Range as etag.
+    if (http.isETag(ifRange)) {
+      const etag = response.get('ETag');
+      return !!(etag && http.isETagFresh(ifRange, etag));
+    }
+    // If-Range as modified date.
+    const lastModified = response.get('Last-Modified');
+    return Date.parse(lastModified) <= Date.parse(ifRange);
+  }
+  /**
+   * @private
+   * @method parseRange
+   * @description Parse range.
+   * @param context Koa context.
+   * @param stats File stats.
+   */
+  parseRange(context, stats) {
+    const { size } = stats;
+    // Range support.
+    if (this.options.acceptRanges !== false) {
+      const range = context.request.get('Range');
+      // Range fresh.
+      if (range && this.isRangeFresh(context)) {
+        // 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) {
+          return parsed;
+        }
+        // Ranges ok, support multiple ranges.
+        if (parsed.type === 'bytes') {
+          // Set 206 status.
+          context.status = 206;
+          const { length } = parsed;
+          // Multiple ranges.
+          if (length > 1) {
+            // Content-Length.
+            let contentLength = 0;
+            // Ranges.
+            const ranges = [];
+            // Range boundary.
+            const boundary$1 = `<${boundary.generate()}>`;
+            // Range suffix.
+            const suffix = `\r\n--${boundary$1}--\r\n`;
+            // Multipart Content-Type.
+            const contentType = `Content-Type: ${context.type}`;
+            // Override Content-Type.
+            context.type = `multipart/byteranges; boundary=${boundary$1}`;
+            // Map ranges.
+            for (let index = 0; index < length; index++) {
+              const { start, end } = parsed[index];
+              // The first prefix boundary no \r\n.
+              const prefixHead = index > 0 ? '\r\n' : '';
+              const contentRange = `Content-Range: bytes ${start}-${end}/${size}`;
+              const prefix = `${prefixHead}--${boundary$1}\r\n${contentType}\r\n${contentRange}\r\n\r\n`;
+              // Compute Content-Length
+              contentLength += end - start + 1 + Buffer.byteLength(prefix);
+              // Cache range.
+              ranges.push({ start, end, prefix });
+            }
+            // The last add suffix boundary.
+            ranges[length - 1].suffix = suffix;
+            // Compute Content-Length.
+            contentLength += Buffer.byteLength(suffix);
+            // Set Content-Length.
+            context.length = contentLength;
+            // Return ranges.
+            return ranges;
+          } else {
+            const [{ start, end }] = parsed;
+            // Set Content-Length.
+            context.length = end - start + 1;
+            // Set Content-Range.
+            context.set('Content-Range', `bytes ${start}-${end}/${size}`);
+            // Return ranges.
+            return parsed;
+          }
+        }
+      }
+    }
+    // Set Content-Length.
+    context.length = size;
+    // Return ranges.
+    return [{ start: 0, end: Math.max(size - 1) }];
+  }
+  /**
+   * @private
+   * @method setupHeaders
+   * @description Setup headers
+   * @param context Koa context
+   * @param path File path
+   * @param stats File stats
+   */
+  setupHeaders(context, path$1, stats) {
+    const { options } = this;
+    const { headers, cacheControl } = options;
+    // Set headers.
+    if (headers) {
+      if (common.isFunction(headers)) {
+        context.set(headers(path$1, stats));
+      } else {
+        context.set(headers);
+      }
+    }
+    // Set status.
+    context.status = 200;
+    // Set Content-Type.
+    context.type = path.extname(path$1);
+    // ETag.
+    if (options.etag === false) {
+      context.remove('ETag');
+    } else {
+      // Set ETag.
+      context.set('ETag', etag__default.default(stats));
+    }
+    // Accept-Ranges.
+    if (options.acceptRanges === false) {
+      context.remove('Accept-Ranges');
+    } else {
+      // Set Accept-Ranges.
+      context.set('Accept-Ranges', 'bytes');
+    }
+    // Cache-Control.
+    if (cacheControl && common.isString(cacheControl)) {
+      // Set Cache-Control.
+      context.set('Cache-Control', cacheControl);
+    }
+    // Last-Modified.
+    if (options.lastModified === false) {
+      context.remove('Last-Modified');
+    } else {
+      // Set mtime utc string.
+      context.set('Last-Modified', stats.mtime.toUTCString());
+    }
+  }
+  /**
+   * @private
+   * @method readTo
+   * @description Read file.
+   * @param stream Destination stream.
+   * @param path File path.
+   * @param range Read range.
+   * @param end Is destory destination stream after read.
+   */
+  readTo(stream, path, range, end) {
+    const { fs } = this.options;
+    return new Promise((resolve, reject) => {
+      // Create file stream.
+      const file = fs.createReadStream(path, range);
+      // File read stream open.
+      if (range.prefix) {
+        file.once('open', () => {
+          // Write prefix boundary.
+          stream.write(range.prefix);
+        });
+      }
+      // File read stream error.
+      file.once('error', error => {
+        // Unpipe.
+        file.unpipe(stream);
+        // Reject.
+        reject(error);
+        // Destroy file stream.
+        destroy__default.default(file);
+      });
+      // File read stream end.
+      if (range.suffix) {
+        file.once('end', () => {
+          // Push suffix boundary.
+          stream.write(range.suffix);
+        });
+      }
+      // File read stream close.
+      file.once('close', () => {
+        // Unpipe.
+        file.unpipe(stream);
+        // Resolve.
+        resolve(true);
+        // Destroy file stream.
+        destroy__default.default(file);
+      });
+      // Write data to buffer.
+      file.pipe(stream, { end });
+    });
+  }
+  /**
+   * @private
+   * @method send
+   * @description Send file.
+   * @param context Koa context.
+   * @param path File path.
+   * @param ranges Read ranges.
+   */
+  async send(context, path, ranges) {
+    // Set stream body, highWaterMark 64kb.
+    const stream$1 = new stream.PassThrough({
+      highWaterMark: 65536
+    });
+    // Set response body.
+    context.body = stream$1;
+    // Ranges length.
+    let { length } = ranges;
+    // Read file ranges.
+    try {
+      for (const range of ranges) {
+        await this.readTo(stream$1, path, range, --length === 0);
+      }
+    } catch (_a) {
+      // End stream when read exception.
+      stream$1.end();
+    }
+  }
+  /**
+   * @public
+   * @method response
+   * @description Response to koa context.
+   * @param context Koa context.
+   */
+  async response(context) {
+    const { root } = this;
+    // Only support GET and HEAD (405).
+    if (context.method !== 'GET' && context.method !== 'HEAD') {
+      return false;
+    }
+    // Get path of file.
+    const path$1 = common.unixify(path.join(root, context.path));
+    // Malicious path (403).
+    if (common.isOutRoot(path$1, root)) {
+      return false;
+    }
+    // Get file system.
+    const { fs } = this.options;
+    // File stats.
+    let stats;
+    // Get file stats.
+    try {
+      stats = await common.fstat(fs, path$1);
+    } catch (_a) {
+      // 404 | 500.
+      return false;
+    }
+    // File not exist (404 | 500).
+    if (!stats) {
+      return false;
+    }
+    // Is directory (403).
+    if (stats.isDirectory()) {
+      return false;
+    }
+    // Not a directory but has trailing slash (404).
+    if (common.hasTrailingSlash(path$1)) {
+      return false;
+    }
+    // Setup headers.
+    this.setupHeaders(context, path$1, stats);
+    // Conditional get support.
+    if (this.isConditionalGET(context)) {
+      // Request precondition failure.
+      if (this.isPreconditionFailure(context)) {
+        return context.throw(412);
+      }
+      // Request fresh (304).
+      if (context.fresh) {
+        // Set status.
+        context.status = 304;
+        // Set body null.
+        context.body = null;
+        return true;
+      }
+    }
+    // Head request.
+    if (context.method === 'HEAD') {
+      // Set Content-Length.
+      context.length = stats.size;
+      // Set body null
+      context.body = null;
+      return true;
+    }
+    // Parsed ranges.
+    const ranges = this.parseRange(context, stats);
+    // 416
+    if (ranges === -1) {
+      // Set Content-Range.
+      context.set('Content-Range', `bytes */${stats.size}`);
+      // Unsatisfiable 416.
+      return context.throw(416);
+    }
+    // 400.
+    if (ranges === -2) {
+      return context.throw(400);
+    }
+    // Send file.
+    this.send(context, path$1, ranges);
+    return true;
+  }
+}
+
+module.exports = Files;