webpack-dev-service 0.8.0 → 0.9.0

package/server/cjs/utils.cjs

@@ -0,0 +1,45 @@
+/**
+ * @package webpack-dev-service
+ * @license MIT
+ * @version 0.9.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';
+
+/**
+ * @module utils
+ */
+const { toString } = Object.prototype;
+const PLUGIN_NAME = 'webpack-dev-service';
+function isObject(value) {
+  return toString.call(value) === '[object Object]';
+}
+function isString(value) {
+  return toString.call(value) === '[object String]';
+}
+function isBoolean(value) {
+  return toString.call(value) === '[object Boolean]';
+}
+function isFunction(value) {
+  return typeof value === 'function';
+}
+function getCompilers(compiler) {
+  if (isMultiCompilerMode(compiler)) {
+    return compiler.compilers;
+  }
+  return [compiler];
+}
+function isMultiCompilerMode(compiler) {
+  return 'compilers' in compiler;
+}
+
+exports.PLUGIN_NAME = PLUGIN_NAME;
+exports.getCompilers = getCompilers;
+exports.isBoolean = isBoolean;
+exports.isFunction = isFunction;
+exports.isMultiCompilerMode = isMultiCompilerMode;
+exports.isObject = isObject;
+exports.isString = isString;

package/server/esm/{dev/utils/compose.js → compose.js}

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.8.0
+ * @version 0.9.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
@@ -24,15 +24,13 @@ async function dispatch(middlewares, index, stack, context, next) {
   }
   stack.index = index;
   const { length } = middlewares;
-  if (index <= length) {
-    if (index < length) {
-      const middleware = middlewares[index];
-      await middleware(context, () => {
-        return dispatch(middlewares, index + 1, stack, context, next);
-      });
-    } else if (next) {
-      await next();
-    }
+  if (index < length) {
+    const middleware = middlewares[index];
+    await middleware(context, () => {
+      return dispatch(middlewares, index + 1, stack, context, next);
+    });
+  } else if (next) {
+    await next();
   }
 }
 /**

package/server/esm/dev/Service.js

@@ -0,0 +1,260 @@
+/**
+ * @package webpack-dev-service
+ * @license MIT
+ * @version 0.9.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
+ */
+
+import createEtag from 'etag';
+import destroy from 'destroy';
+import { PassThrough } from 'stream';
+import { isFunction } from '../utils.js';
+import { stat } from './utils/fs.js';
+import { resolve, extname, join } from 'path';
+import { unixify, isOutRoot, hasTrailingSlash } from './utils/path.js';
+import { isConditionalGET, isPreconditionFailure, parseRanges } from './utils/http.js';
+
+/**
+ * @module Service
+ */
+/**
+ * @class Service
+ */
+class Service {
+  /**
+   * @constructor
+   * @description Create file service.
+   * @param root File service root.
+   * @param options File service options.
+   */
+  constructor(root, options) {
+    this.options = options;
+    this.root = unixify(resolve(root));
+  }
+  /**
+   * @private
+   * @method isIgnore
+   * @description Check if path is ignore.
+   * @param path File path.
+   */
+  isIgnore(path) {
+    const { ignore } = this.options;
+    return (isFunction(ignore) ? ignore(path) : false) === true;
+  }
+  /**
+   * @private
+   * @method setupHeaders
+   * @description Setup headers
+   * @param context Koa context
+   * @param path File path
+   * @param stats File stats
+   */
+  setupHeaders(context, path, stats) {
+    const { options } = this;
+    const { headers, etag } = options;
+    // Set status.
+    context.status = 200;
+    // Set Content-Type.
+    context.type = extname(path);
+    // Accept-Ranges.
+    if (options.acceptRanges === false) {
+      // Set Accept-Ranges to none tell client not support.
+      context.set('Accept-Ranges', 'none');
+    } else {
+      // Set Accept-Ranges.
+      context.set('Accept-Ranges', 'bytes');
+    }
+    // ETag.
+    if (etag === false) {
+      // Remove ETag.
+      context.remove('ETag');
+    } else {
+      // Set ETag.
+      context.set('ETag', createEtag(stats));
+    }
+    // Last-Modified.
+    if (options.lastModified === false) {
+      // Remove Last-Modified.
+      context.remove('Last-Modified');
+    } else {
+      // Set mtime utc string.
+      context.set('Last-Modified', stats.mtime.toUTCString());
+    }
+    // Set headers.
+    if (headers) {
+      if (isFunction(headers)) {
+        const fields = headers(path, stats);
+        if (fields) {
+          context.set(fields);
+        }
+      } else {
+        context.set(headers);
+      }
+    }
+  }
+  /**
+   * @private
+   * @method write
+   * @description Write file to stream.
+   * @param stream Destination stream.
+   * @param path The file path to read.
+   * @param range The range to read.
+   * @param end Is destory destination stream after read complete.
+   */
+  write(stream, path, range, end) {
+    const { fs } = this.options;
+    return new Promise(resolve => {
+      // Range prefix and suffix.
+      const { prefix, suffix } = range;
+      // Create file stream reader.
+      const reader = fs.createReadStream(path, range);
+      // File read stream open.
+      if (prefix) {
+        reader.once('open', () => {
+          // Write prefix boundary.
+          stream.write(prefix);
+        });
+      }
+      // File read stream end.
+      if (suffix) {
+        reader.once('end', () => {
+          // Push suffix boundary.
+          stream.write(suffix);
+        });
+      }
+      // File read stream error.
+      reader.once('error', () => {
+        // End stream.
+        stream.end();
+        // Unpipe.
+        reader.unpipe();
+        // Destroy.
+        destroy(reader);
+        // Resolve.
+        resolve(false);
+      });
+      // File read stream close.
+      reader.once('close', () => {
+        // Unpipe.
+        reader.unpipe();
+        // Destroy.
+        destroy(reader);
+        // Resolve.
+        resolve(true);
+      });
+      // Write data to buffer.
+      reader.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 = new PassThrough({
+      highWaterMark: 65536
+    });
+    // Set response body.
+    context.body = stream;
+    // Ranges length.
+    let { length } = ranges;
+    // Write ranges to stream.
+    for (const range of ranges) {
+      // Write range.
+      const passed = await this.write(stream, path, range, --length === 0);
+      // If not passed, break.
+      if (!passed) {
+        break;
+      }
+    }
+  }
+  /**
+   * @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 = unixify(join(root, context.path));
+    // Malicious path (403).
+    if (isOutRoot(path, root)) {
+      return false;
+    }
+    // Is ignore path or file (403).
+    if (this.isIgnore(path)) {
+      return false;
+    }
+    // File stats.
+    const stats = await stat(this.options.fs, path);
+    // Check file stats.
+    if (
+      // File not exist (404 | 500).
+      stats == null ||
+      // Is directory (403).
+      stats.isDirectory() ||
+      // Not a directory but has trailing slash (404).
+      hasTrailingSlash(path)
+    ) {
+      return false;
+    }
+    // Setup headers.
+    this.setupHeaders(context, path, stats);
+    // Conditional get support.
+    if (isConditionalGET(context)) {
+      // Request precondition failure.
+      if (isPreconditionFailure(context)) {
+        return context.throw(412);
+      }
+      // Request fresh (304).
+      if (context.fresh) {
+        // Set status.
+        context.status = 304;
+        // Set body null.
+        context.body = null;
+        // File found.
+        return true;
+      }
+    }
+    // Head request.
+    if (context.method === 'HEAD') {
+      // Set Content-Length.
+      context.length = stats.size;
+      // Set body null
+      context.body = null;
+      // File found.
+      return true;
+    }
+    // Parsed ranges.
+    const ranges = parseRanges(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, ranges);
+    // File found.
+    return true;
+  }
+}
+
+export { Service };

package/server/esm/dev/index.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.8.0
+ * @version 0.9.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
@@ -9,7 +9,7 @@
 
 import { ready } from './utils/ready.js';
 import { middleware } from './middleware.js';
-import { PLUGIN_NAME } from './utils/common.js';
+import { PLUGIN_NAME } from '../utils.js';
 import { setupHooks } from './utils/setupHooks.js';
 import { setupWatching } from './utils/setupWatching.js';
 import { setupWriteToDisk } from './utils/setupWriteToDisk.js';
@@ -23,7 +23,6 @@ function setup(compiler, options) {
     options,
     compiler,
     stats: null,
-    state: false,
     callbacks: [],
     logger: compiler.getInfrastructureLogger(PLUGIN_NAME)
   };
@@ -35,11 +34,11 @@ function setup(compiler, options) {
   setupWatching(context);
   return context;
 }
-function dev(compiler, options = {}) {
+function dev(compiler, options) {
   const context = setup(compiler, options);
   return Object.assign(middleware(context), {
-    isReady() {
-      return context.state;
+    get state() {
+      return !!context.stats;
     },
     get logger() {
       return context.logger;
@@ -47,12 +46,11 @@ function dev(compiler, options = {}) {
     ready(callback) {
       ready(context, callback);
     },
-    invalidate(callback) {
-      ready(context, callback);
-      context.watching.invalidate();
-    },
     close(callback) {
       context.watching.close(callback);
+    },
+    invalidate(callback) {
+      context.watching.invalidate(callback);
     }
   });
 }

package/server/esm/dev/middleware.js

@@ -1,57 +1,82 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.8.0
+ * @version 0.9.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
  */
 
-import Files from './Files.js';
-import { decodeURI } from './utils/common.js';
-import { getPaths } from './utils/getPaths.js';
+import { Service } from './Service.js';
+import { ready } from './utils/ready.js';
+import { decodeURI } from './utils/http.js';
+import { getPaths } from './utils/paths.js';
 
 /**
  * @module middleware
  */
-const cache = new WeakMap();
-async function getFilesInstances(context, name) {
-  const cached = cache.get(context.compiler);
-  if (cached != null) {
+function getFileServices(context, stats) {
+  const cached = context.services;
+  // Cache hit.
+  if (cached) {
     return cached;
   }
-  const { options } = context;
-  const instances = [];
-  const paths = await getPaths(context, name);
-  for (const { outputPath, publicPath } of paths) {
-    instances.push({
+  const paths = getPaths(stats);
+  const { fs, options } = context;
+  const services = [];
+  const { etag, ignore, headers, acceptRanges, lastModified } = options;
+  // Get the file services.
+  for (const [outputPath, publicPath] of paths) {
+    services.push([
       publicPath,
-      files: new Files(outputPath, {
-        etag: options.etag,
-        headers: options.headers,
-        fs: context.outputFileSystem,
-        acceptRanges: options.acceptRanges,
-        cacheControl: options.cacheControl,
-        lastModified: options.lastModified
+      new Service(outputPath, {
+        fs,
+        etag,
+        ignore,
+        headers,
+        acceptRanges,
+        lastModified
       })
-    });
+    ]);
   }
-  return instances;
+  // Cache services.
+  context.services = services;
+  // Return services.
+  return services;
+}
+function getFileServicesAsync(context, path) {
+  return new Promise(resolve => {
+    const { stats } = context;
+    // If stats exists, resolve immediately.
+    if (stats) {
+      resolve(getFileServices(context, stats));
+    } else {
+      // Log waiting info.
+      context.logger.info(`wait until bundle finished: ${path}`);
+      // Otherwise, wait until bundle finished.
+      ready(context, stats => {
+        resolve(getFileServices(context, stats));
+      });
+    }
+  });
 }
 function middleware(context) {
+  // Middleware.
   return async (ctx, next) => {
     const path = decodeURI(ctx.path);
-    // Path -1 or null byte(s)
+    // Path -1 or null byte(s).
     if (path === -1 || path.includes('\0')) {
       return ctx.throw(400);
     }
-    ctx.path = path;
+    // Is path respond.
     let respond = false;
-    const instances = await getFilesInstances(context, path);
-    for (const { files, publicPath } of instances) {
+    // Get the file services.
+    const services = await getFileServicesAsync(context, path);
+    // Try to respond.
+    for (const [publicPath, service] of services) {
       if (path.startsWith(publicPath)) {
         ctx.path = path.slice(publicPath.length);
-        respond = await files.response(ctx);
+        respond = await service.response(ctx);
         if (respond) {
           return;
         } else {
@@ -59,6 +84,7 @@ function middleware(context) {
         }
       }
     }
+    // Not respond.
     if (!respond) {
       await next();
     }

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

@@ -0,0 +1,27 @@
+/**
+ * @package webpack-dev-service
+ * @license MIT
+ * @version 0.9.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
+ */
+
+/**
+ * @module fs
+ */
+/**
+ * @function stat
+ * @description Get file stats.
+ * @param fs The file system to used.
+ * @param path The file path.
+ */
+function stat(fs, path) {
+  return new Promise(resolve => {
+    fs.stat(path, (error, stats) => {
+      resolve(error ? null : stats);
+    });
+  });
+}
+
+export { stat };

package/server/esm/dev/utils/{boundary.js → hash.js}

@@ -1,14 +1,16 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.8.0
+ * @version 0.9.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
  */
 
+import { getRandomValues } from 'crypto';
+
 /**
- * @module boundary
+ * @module hash
  */
 // prettier-ignore
 const CHARS = [
@@ -25,16 +27,18 @@ const CHARS = [
 ];
 /**
  * @function generate
- * @description Generate a boundary.
+ * @description Generate a hash.
+ * @param length The length of hash.
  */
-function generate() {
-  let boundary = '';
-  // Create boundary.
-  for (let i = 0; i < 38; i++) {
-    boundary += CHARS[Math.floor(Math.random() * 62)];
+function generate(length = 32) {
+  let hash = '';
+  const randomValues = getRandomValues(new Uint8Array(length));
+  // Create hash.
+  for (const value of randomValues) {
+    hash += CHARS[value % 62];
   }
-  // Return boundary.
-  return boundary;
+  // Return hash.
+  return hash;
 }
 
 export { generate };