406 lines
12 KiB
JavaScript
406 lines
12 KiB
JavaScript
|
"use strict";
|
||
|
|
|
||
|
|
const {
|
||
|
|
validate
|
||
|
|
} = require("schema-utils");
|
||
|
|
const mime = require("mime-types");
|
||
|
|
const middleware = require("./middleware");
|
||
|
|
const getFilenameFromUrl = require("./utils/getFilenameFromUrl");
|
||
|
|
const setupHooks = require("./utils/setupHooks");
|
||
|
|
const setupWriteToDisk = require("./utils/setupWriteToDisk");
|
||
|
|
const setupOutputFileSystem = require("./utils/setupOutputFileSystem");
|
||
|
|
const ready = require("./utils/ready");
|
||
|
|
const schema = require("./options.json");
|
||
|
|
const noop = () => {};
|
||
|
|
|
||
|
|
/** @typedef {import("schema-utils/declarations/validate").Schema} Schema */
|
||
|
|
/** @typedef {import("webpack").Compiler} Compiler */
|
||
|
|
/** @typedef {import("webpack").MultiCompiler} MultiCompiler */
|
||
|
|
/** @typedef {import("webpack").Configuration} Configuration */
|
||
|
|
/** @typedef {import("webpack").Stats} Stats */
|
||
|
|
/** @typedef {import("webpack").MultiStats} MultiStats */
|
||
|
|
/** @typedef {import("fs").ReadStream} ReadStream */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {Object} ExtendedServerResponse
|
||
|
|
* @property {{ webpack?: { devMiddleware?: Context<IncomingMessage, ServerResponse> } }} [locals]
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** @typedef {import("http").IncomingMessage} IncomingMessage */
|
||
|
|
/** @typedef {import("http").ServerResponse & ExtendedServerResponse} ServerResponse */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @callback NextFunction
|
||
|
|
* @param {any} [err]
|
||
|
|
* @return {void}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {NonNullable<Configuration["watchOptions"]>} WatchOptions
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {Compiler["watching"]} Watching
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {ReturnType<MultiCompiler["watch"]>} MultiWatching
|
||
|
|
*/
|
||
|
|
|
||
|
|
// TODO fix me after the next webpack release
|
||
|
|
/**
|
||
|
|
* @typedef {Object & { createReadStream?: import("fs").createReadStream, statSync?: import("fs").statSync, lstat?: import("fs").lstat, readFileSync?: import("fs").readFileSync }} OutputFileSystem
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** @typedef {ReturnType<Compiler["getInfrastructureLogger"]>} Logger */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @callback Callback
|
||
|
|
* @param {Stats | MultiStats} [stats]
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {Object} ResponseData
|
||
|
|
* @property {Buffer | ReadStream} data
|
||
|
|
* @property {number} byteLength
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
|
||
|
|
* @template {ServerResponse} [ResponseInternal=ServerResponse]
|
||
|
|
* @callback ModifyResponseData
|
||
|
|
* @param {RequestInternal} req
|
||
|
|
* @param {ResponseInternal} res
|
||
|
|
* @param {Buffer | ReadStream} data
|
||
|
|
* @param {number} byteLength
|
||
|
|
* @return {ResponseData}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
|
||
|
|
* @template {ServerResponse} [ResponseInternal=ServerResponse]
|
||
|
|
* @typedef {Object} Context
|
||
|
|
* @property {boolean} state
|
||
|
|
* @property {Stats | MultiStats | undefined} stats
|
||
|
|
* @property {Callback[]} callbacks
|
||
|
|
* @property {Options<RequestInternal, ResponseInternal>} options
|
||
|
|
* @property {Compiler | MultiCompiler} compiler
|
||
|
|
* @property {Watching | MultiWatching | undefined} watching
|
||
|
|
* @property {Logger} logger
|
||
|
|
* @property {OutputFileSystem} outputFileSystem
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
|
||
|
|
* @template {ServerResponse} [ResponseInternal=ServerResponse]
|
||
|
|
* @typedef {WithoutUndefined<Context<RequestInternal, ResponseInternal>, "watching">} FilledContext
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** @typedef {Record<string, string | number> | Array<{ key: string, value: number | string }>} NormalizedHeaders */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
|
||
|
|
* @template {ServerResponse} [ResponseInternal=ServerResponse]
|
||
|
|
* @typedef {NormalizedHeaders | ((req: RequestInternal, res: ResponseInternal, context: Context<RequestInternal, ResponseInternal>) => void | undefined | NormalizedHeaders) | undefined} Headers
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template {IncomingMessage} [RequestInternal = IncomingMessage]
|
||
|
|
* @template {ServerResponse} [ResponseInternal = ServerResponse]
|
||
|
|
* @typedef {Object} Options
|
||
|
|
* @property {{[key: string]: string}} [mimeTypes]
|
||
|
|
* @property {string | undefined} [mimeTypeDefault]
|
||
|
|
* @property {boolean | ((targetPath: string) => boolean)} [writeToDisk]
|
||
|
|
* @property {string[]} [methods]
|
||
|
|
* @property {Headers<RequestInternal, ResponseInternal>} [headers]
|
||
|
|
* @property {NonNullable<Configuration["output"]>["publicPath"]} [publicPath]
|
||
|
|
* @property {Configuration["stats"]} [stats]
|
||
|
|
* @property {boolean} [serverSideRender]
|
||
|
|
* @property {OutputFileSystem} [outputFileSystem]
|
||
|
|
* @property {boolean | string} [index]
|
||
|
|
* @property {ModifyResponseData<RequestInternal, ResponseInternal>} [modifyResponseData]
|
||
|
|
* @property {"weak" | "strong"} [etag]
|
||
|
|
* @property {boolean} [lastModified]
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
|
||
|
|
* @template {ServerResponse} [ResponseInternal=ServerResponse]
|
||
|
|
* @callback Middleware
|
||
|
|
* @param {RequestInternal} req
|
||
|
|
* @param {ResponseInternal} res
|
||
|
|
* @param {NextFunction} next
|
||
|
|
* @return {Promise<void>}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** @typedef {import("./utils/getFilenameFromUrl").Extra} Extra */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @callback GetFilenameFromUrl
|
||
|
|
* @param {string} url
|
||
|
|
* @param {Extra=} extra
|
||
|
|
* @returns {string | undefined}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @callback WaitUntilValid
|
||
|
|
* @param {Callback} callback
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @callback Invalidate
|
||
|
|
* @param {Callback} callback
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @callback Close
|
||
|
|
* @param {(err: Error | null | undefined) => void} callback
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template {IncomingMessage} RequestInternal
|
||
|
|
* @template {ServerResponse} ResponseInternal
|
||
|
|
* @typedef {Object} AdditionalMethods
|
||
|
|
* @property {GetFilenameFromUrl} getFilenameFromUrl
|
||
|
|
* @property {WaitUntilValid} waitUntilValid
|
||
|
|
* @property {Invalidate} invalidate
|
||
|
|
* @property {Close} close
|
||
|
|
* @property {Context<RequestInternal, ResponseInternal>} context
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
|
||
|
|
* @template {ServerResponse} [ResponseInternal=ServerResponse]
|
||
|
|
* @typedef {Middleware<RequestInternal, ResponseInternal> & AdditionalMethods<RequestInternal, ResponseInternal>} API
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template T
|
||
|
|
* @template {keyof T} K
|
||
|
|
* @typedef {Omit<T, K> & Partial<T>} WithOptional
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template T
|
||
|
|
* @template {keyof T} K
|
||
|
|
* @typedef {T & { [P in K]: NonNullable<T[P]> }} WithoutUndefined
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
|
||
|
|
* @template {ServerResponse} [ResponseInternal=ServerResponse]
|
||
|
|
* @param {Compiler | MultiCompiler} compiler
|
||
|
|
* @param {Options<RequestInternal, ResponseInternal>} [options]
|
||
|
|
* @returns {API<RequestInternal, ResponseInternal>}
|
||
|
|
*/
|
||
|
|
function wdm(compiler, options = {}) {
|
||
|
|
validate( /** @type {Schema} */schema, options, {
|
||
|
|
name: "Dev Middleware",
|
||
|
|
baseDataPath: "options"
|
||
|
|
});
|
||
|
|
const {
|
||
|
|
mimeTypes
|
||
|
|
} = options;
|
||
|
|
if (mimeTypes) {
|
||
|
|
const {
|
||
|
|
types
|
||
|
|
} = mime;
|
||
|
|
|
||
|
|
// mimeTypes from user provided options should take priority
|
||
|
|
// over existing, known types
|
||
|
|
// @ts-ignore
|
||
|
|
mime.types = {
|
||
|
|
...types,
|
||
|
|
...mimeTypes
|
||
|
|
};
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @type {WithOptional<Context<RequestInternal, ResponseInternal>, "watching" | "outputFileSystem">}
|
||
|
|
*/
|
||
|
|
const context = {
|
||
|
|
state: false,
|
||
|
|
// eslint-disable-next-line no-undefined
|
||
|
|
stats: undefined,
|
||
|
|
callbacks: [],
|
||
|
|
options,
|
||
|
|
compiler,
|
||
|
|
logger: compiler.getInfrastructureLogger("webpack-dev-middleware")
|
||
|
|
};
|
||
|
|
setupHooks(context);
|
||
|
|
if (options.writeToDisk) {
|
||
|
|
setupWriteToDisk(context);
|
||
|
|
}
|
||
|
|
setupOutputFileSystem(context);
|
||
|
|
|
||
|
|
// Start watching
|
||
|
|
if ( /** @type {Compiler} */context.compiler.watching) {
|
||
|
|
context.watching = /** @type {Compiler} */context.compiler.watching;
|
||
|
|
} else {
|
||
|
|
/**
|
||
|
|
* @param {Error | null | undefined} error
|
||
|
|
*/
|
||
|
|
const errorHandler = error => {
|
||
|
|
if (error) {
|
||
|
|
// TODO: improve that in future
|
||
|
|
// For example - `writeToDisk` can throw an error and right now it is ends watching.
|
||
|
|
// We can improve that and keep watching active, but it is require API on webpack side.
|
||
|
|
// Let's implement that in webpack@5 because it is rare case.
|
||
|
|
context.logger.error(error);
|
||
|
|
}
|
||
|
|
};
|
||
|
|
if (Array.isArray( /** @type {MultiCompiler} */context.compiler.compilers)) {
|
||
|
|
const compiler = /** @type {MultiCompiler} */context.compiler;
|
||
|
|
const watchOptions = compiler.compilers.map(childCompiler => childCompiler.options.watchOptions || {});
|
||
|
|
context.watching = compiler.watch(watchOptions, errorHandler);
|
||
|
|
} else {
|
||
|
|
const compiler = /** @type {Compiler} */context.compiler;
|
||
|
|
const watchOptions = compiler.options.watchOptions || {};
|
||
|
|
context.watching = compiler.watch(watchOptions, errorHandler);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
const filledContext = /** @type {FilledContext<RequestInternal, ResponseInternal>} */
|
||
|
|
context;
|
||
|
|
const instance = /** @type {API<RequestInternal, ResponseInternal>} */
|
||
|
|
middleware(filledContext);
|
||
|
|
|
||
|
|
// API
|
||
|
|
instance.getFilenameFromUrl = (url, extra) => getFilenameFromUrl(filledContext, url, extra);
|
||
|
|
instance.waitUntilValid = (callback = noop) => {
|
||
|
|
ready(filledContext, callback);
|
||
|
|
};
|
||
|
|
instance.invalidate = (callback = noop) => {
|
||
|
|
ready(filledContext, callback);
|
||
|
|
filledContext.watching.invalidate();
|
||
|
|
};
|
||
|
|
instance.close = (callback = noop) => {
|
||
|
|
filledContext.watching.close(callback);
|
||
|
|
};
|
||
|
|
instance.context = filledContext;
|
||
|
|
return instance;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template S
|
||
|
|
* @template O
|
||
|
|
* @typedef {Object} HapiPluginBase
|
||
|
|
* @property {(server: S, options: O) => void | Promise<void>} register
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template S
|
||
|
|
* @template O
|
||
|
|
* @typedef {HapiPluginBase<S, O> & { pkg: { name: string } }} HapiPlugin
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {Options & { compiler: Compiler | MultiCompiler }} HapiOptions
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template HapiServer
|
||
|
|
* @template {HapiOptions} HapiOptionsInternal
|
||
|
|
* @returns {HapiPlugin<HapiServer, HapiOptionsInternal>}
|
||
|
|
*/
|
||
|
|
function hapiWrapper() {
|
||
|
|
return {
|
||
|
|
pkg: {
|
||
|
|
name: "webpack-dev-middleware"
|
||
|
|
},
|
||
|
|
register(server, options) {
|
||
|
|
const {
|
||
|
|
compiler,
|
||
|
|
...rest
|
||
|
|
} = options;
|
||
|
|
if (!compiler) {
|
||
|
|
throw new Error("The compiler options is required.");
|
||
|
|
}
|
||
|
|
const devMiddleware = wdm(compiler, rest);
|
||
|
|
|
||
|
|
// @ts-ignore
|
||
|
|
server.decorate("server", "webpackDevMiddleware", devMiddleware);
|
||
|
|
// @ts-ignore
|
||
|
|
server.ext("onRequest", (request, h) => new Promise((resolve, reject) => {
|
||
|
|
devMiddleware(request.raw.req, request.raw.res, error => {
|
||
|
|
if (error) {
|
||
|
|
reject(error);
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
resolve(request);
|
||
|
|
});
|
||
|
|
}).then(() => h.continue).catch(error => {
|
||
|
|
throw error;
|
||
|
|
}));
|
||
|
|
}
|
||
|
|
};
|
||
|
|
}
|
||
|
|
wdm.hapiWrapper = hapiWrapper;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
|
||
|
|
* @template {ServerResponse} [ResponseInternal=ServerResponse]
|
||
|
|
* @param {Compiler | MultiCompiler} compiler
|
||
|
|
* @param {Options<RequestInternal, ResponseInternal>} [options]
|
||
|
|
* @returns {(ctx: any, next: Function) => Promise<void> | void}
|
||
|
|
*/
|
||
|
|
function koaWrapper(compiler, options) {
|
||
|
|
const devMiddleware = wdm(compiler, options);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param {{ req: RequestInternal, res: ResponseInternal & import("./utils/compatibleAPI").ExpectedResponse, status: number, body: Buffer | import("fs").ReadStream | { message: string }, state: Object }} ctx
|
||
|
|
* @param {Function} next
|
||
|
|
* @returns {Promise<void>}
|
||
|
|
*/
|
||
|
|
const wrapper = async function webpackDevMiddleware(ctx, next) {
|
||
|
|
return new Promise((resolve, reject) => {
|
||
|
|
const {
|
||
|
|
req
|
||
|
|
} = ctx;
|
||
|
|
const {
|
||
|
|
res
|
||
|
|
} = ctx;
|
||
|
|
res.locals = ctx.state;
|
||
|
|
/**
|
||
|
|
* @param {number} status status code
|
||
|
|
*/
|
||
|
|
res.status = status => {
|
||
|
|
// eslint-disable-next-line no-param-reassign
|
||
|
|
ctx.status = status;
|
||
|
|
};
|
||
|
|
/**
|
||
|
|
* @param {import("fs").ReadStream} stream readable stream
|
||
|
|
*/
|
||
|
|
res.pipeInto = stream => {
|
||
|
|
// eslint-disable-next-line no-param-reassign
|
||
|
|
ctx.body = stream;
|
||
|
|
resolve();
|
||
|
|
};
|
||
|
|
/**
|
||
|
|
* @param {Buffer} content content
|
||
|
|
*/
|
||
|
|
res.send = content => {
|
||
|
|
// eslint-disable-next-line no-param-reassign
|
||
|
|
ctx.body = content;
|
||
|
|
resolve();
|
||
|
|
};
|
||
|
|
devMiddleware(req, res, err => {
|
||
|
|
if (err) {
|
||
|
|
reject(err);
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
resolve(next());
|
||
|
|
}).catch(err => {
|
||
|
|
// eslint-disable-next-line no-param-reassign
|
||
|
|
ctx.status = err.statusCode || err.status || 500;
|
||
|
|
// eslint-disable-next-line no-param-reassign
|
||
|
|
ctx.body = {
|
||
|
|
message: err.message
|
||
|
|
};
|
||
|
|
});
|
||
|
|
});
|
||
|
|
};
|
||
|
|
wrapper.devMiddleware = devMiddleware;
|
||
|
|
return wrapper;
|
||
|
|
}
|
||
|
|
wdm.koaWrapper = koaWrapper;
|
||
|
|
module.exports = wdm;
|