webpack-dev-service 0.9.0 → 0.10.0

package/server/esm/dev/Service.js

@@ -1,260 +0,0 @@
-/**
- * @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,58 +0,0 @@
-/**
- * @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 { ready } from './utils/ready.js';
-import { middleware } from './middleware.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';
-import { setupOutputFileSystem } from './utils/setupOutputFileSystem.js';
-
-/**
- * @module index
- */
-function setup(compiler, options) {
-  const context = {
-    options,
-    compiler,
-    stats: null,
-    callbacks: [],
-    logger: compiler.getInfrastructureLogger(PLUGIN_NAME)
-  };
-  setupHooks(context);
-  if (options.writeToDisk) {
-    setupWriteToDisk(context);
-  }
-  setupOutputFileSystem(context);
-  setupWatching(context);
-  return context;
-}
-function dev(compiler, options) {
-  const context = setup(compiler, options);
-  return Object.assign(middleware(context), {
-    get state() {
-      return !!context.stats;
-    },
-    get logger() {
-      return context.logger;
-    },
-    ready(callback) {
-      ready(context, callback);
-    },
-    close(callback) {
-      context.watching.close(callback);
-    },
-    invalidate(callback) {
-      context.watching.invalidate(callback);
-    }
-  });
-}
-
-export { dev };

package/server/esm/dev/middleware.js

@@ -1,94 +0,0 @@
-/**
- * @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 { Service } from './Service.js';
-import { ready } from './utils/ready.js';
-import { decodeURI } from './utils/http.js';
-import { getPaths } from './utils/paths.js';
-
-/**
- * @module middleware
- */
-function getFileServices(context, stats) {
-  const cached = context.services;
-  // Cache hit.
-  if (cached) {
-    return cached;
-  }
-  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,
-      new Service(outputPath, {
-        fs,
-        etag,
-        ignore,
-        headers,
-        acceptRanges,
-        lastModified
-      })
-    ]);
-  }
-  // 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).
-    if (path === -1 || path.includes('\0')) {
-      return ctx.throw(400);
-    }
-    // Is path respond.
-    let respond = false;
-    // 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 service.response(ctx);
-        if (respond) {
-          return;
-        } else {
-          ctx.path = path;
-        }
-      }
-    }
-    // Not respond.
-    if (!respond) {
-      await next();
-    }
-  };
-}
-
-export { middleware };

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

@@ -1,27 +0,0 @@
-/**
- * @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/hash.js

@@ -1,44 +0,0 @@
-/**
- * @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 { getRandomValues } from 'crypto';
-
-/**
- * @module hash
- */
-// prettier-ignore
-const CHARS = [
-    // 0-9
-    '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
-    // A-M
-    'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
-    // N-Z
-    'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
-    // a-m
-    'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
-    // n-z
-    'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z'
-];
-/**
- * @function generate
- * @description Generate a hash.
- * @param length The length of hash.
- */
-function generate(length = 32) {
-  let hash = '';
-  const randomValues = getRandomValues(new Uint8Array(length));
-  // Create hash.
-  for (const value of randomValues) {
-    hash += CHARS[value % 62];
-  }
-  // Return hash.
-  return hash;
-}
-
-export { generate };

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

@@ -1,216 +0,0 @@
-/**
- * @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 { generate } from './hash.js';
-import parseRange from 'range-parser';
-
-/**
- * @module http
- */
-/**
- * @function isETag
- * @description Check if etag is valid.
- * @param value The value to check.
- */
-function isETag(value) {
-  return /^(?:W\/)?"[\s\S]+"$/.test(value);
-}
-/**
- * @function parseTokens
- * @description Parse HTTP tokens.
- * @param value The tokens value string.
- */
-function parseTokens(value) {
-  let end = 0;
-  let start = 0;
-  let tokens = [];
-  // Gather tokens.
-  for (let i = 0, length = value.length; i < length; i++) {
-    switch (value.charCodeAt(i)) {
-      case 0x20:
-        // ' '.
-        if (start === end) {
-          start = end = i + 1;
-        }
-        break;
-      case 0x2c:
-        // ','.
-        tokens.push(value.substring(start, end));
-        start = end = i + 1;
-        break;
-      default:
-        end = i + 1;
-        break;
-    }
-  }
-  // Final token.
-  tokens.push(value.substring(start, end));
-  return tokens;
-}
-/**
- * @function isRangeFresh
- * @description Check if request range fresh.
- * @param context Koa context.
- */
-function isRangeFresh(context) {
-  const { request, response } = context;
-  const ifRange = request.get('If-Range');
-  // No If-Range.
-  if (!ifRange) {
-    return true;
-  }
-  // If-Range as etag.
-  if (isETag(ifRange)) {
-    const etag = response.get('ETag');
-    return !!(etag && isETagFresh(ifRange, etag));
-  }
-  // If-Range as modified date.
-  const lastModified = response.get('Last-Modified');
-  return Date.parse(lastModified) <= Date.parse(ifRange);
-}
-/**
- * @function isETagFresh
- * @description Check if etag is fresh.
- * @param match The match value.
- * @param etag The etag value.
- */
-function isETagFresh(match, etag) {
-  return parseTokens(match).some(match => {
-    return match === etag || match === 'W/' + etag || 'W/' + match === etag;
-  });
-}
-/**
- * @function decodeURI
- * @description Decode URI component.
- * @param URI The URI to decode.
- */
-function decodeURI(URI) {
-  try {
-    return decodeURIComponent(URI);
-  } catch (_a) {
-    return -1;
-  }
-}
-/**
- * @function isConditionalGET
- * @description Check if request is conditional GET.
- * @param context Koa context.
- */
-function 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')
-  );
-}
-/**
- * @function isPreconditionFailure
- * @description Check if request precondition failure.
- * @param context Koa context.
- */
-function isPreconditionFailure({ request, response }) {
-  // If-Match.
-  const match = request.get('If-Match');
-  // Check if request match.
-  if (match) {
-    // Etag.
-    const etag = response.get('ETag');
-    return !etag || match === '*' || !isETagFresh(match, etag);
-  }
-  // If-Unmodified-Since.
-  const unmodifiedSince = Date.parse(request.get('If-Unmodified-Since'));
-  // Check if request unmodified.
-  if (!Number.isNaN(unmodifiedSince)) {
-    // Last-Modified.
-    const lastModified = Date.parse(response.get('Last-Modified'));
-    return Number.isNaN(lastModified) || lastModified > unmodifiedSince;
-  }
-  // Check precondition passed.
-  return false;
-}
-/**
- * @function parseRanges
- * @description Parse ranges.
- * @param context Koa context.
- * @param stats File stats.
- */
-function parseRanges(context, stats) {
-  const { size } = stats;
-  // Range support.
-  if (/^bytes$/i.test(context.response.get('Accept-Ranges'))) {
-    const range = context.request.get('Range');
-    // Range fresh.
-    if (range && isRangeFresh(context)) {
-      // 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) {
-        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 = `<${generate()}>`;
-          // Range suffix.
-          const suffix = `\r\n--${boundary}--\r\n`;
-          // Multipart Content-Type.
-          const contentType = `Content-Type: ${context.type}`;
-          // Override Content-Type.
-          context.type = `multipart/byteranges; boundary=${boundary}`;
-          // Map ranges.
-          for (let index = 0; index < length; index++) {
-            const { start, end } = parsed[index];
-            // The first prefix boundary no \r\n.
-            const head = index > 0 ? '\r\n' : '';
-            const contentRange = `Content-Range: bytes ${start}-${end}/${size}`;
-            const prefix = `${head}--${boundary}\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) }];
-}
-
-export { decodeURI, isConditionalGET, isPreconditionFailure, parseRanges };