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 } }} [locals] */ /** @typedef {import("http").IncomingMessage} IncomingMessage */ /** @typedef {import("http").ServerResponse & ExtendedServerResponse} ServerResponse */ /** * @callback NextFunction * @param {any} [err] * @return {void} */ /** * @typedef {NonNullable} WatchOptions */ /** * @typedef {Compiler["watching"]} Watching */ /** * @typedef {ReturnType} MultiWatching */ /** * @typedef {import("webpack").OutputFileSystem & { createReadStream?: import("fs").createReadStream, statSync: import("fs").statSync, readFileSync: import("fs").readFileSync }} OutputFileSystem */ /** @typedef {ReturnType} 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} 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, "watching">} FilledContext */ /** @typedef {Record | Array<{ key: string, value: number | string }>} NormalizedHeaders */ /** * @template {IncomingMessage} [RequestInternal=IncomingMessage] * @template {ServerResponse} [ResponseInternal=ServerResponse] * @typedef {NormalizedHeaders | ((req: RequestInternal, res: ResponseInternal, context: Context) => 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} [headers] * @property {NonNullable["publicPath"]} [publicPath] * @property {Configuration["stats"]} [stats] * @property {boolean} [serverSideRender] * @property {OutputFileSystem} [outputFileSystem] * @property {boolean | string} [index] * @property {ModifyResponseData} [modifyResponseData] * @property {"weak" | "strong"} [etag] * @property {boolean} [lastModified] * @property {boolean | number | string | { maxAge?: number, immutable?: boolean }} [cacheControl] * @property {boolean} [cacheImmutable] */ /** * @template {IncomingMessage} [RequestInternal=IncomingMessage] * @template {ServerResponse} [ResponseInternal=ServerResponse] * @callback Middleware * @param {RequestInternal} req * @param {ResponseInternal} res * @param {NextFunction} next * @return {Promise} */ /** @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} context */ /** * @template {IncomingMessage} [RequestInternal=IncomingMessage] * @template {ServerResponse} [ResponseInternal=ServerResponse] * @typedef {Middleware & AdditionalMethods} API */ /** * @template T * @template {keyof T} K * @typedef {Omit & Partial} WithOptional */ /** * @template T * @template {keyof T} K * @typedef {T & { [P in K]: NonNullable }} WithoutUndefined */ /** * @template {IncomingMessage} [RequestInternal=IncomingMessage] * @template {ServerResponse} [ResponseInternal=ServerResponse] * @param {Compiler | MultiCompiler} compiler * @param {Options} [options] * @returns {API} */ 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, "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 c = /** @type {MultiCompiler} */ (context.compiler); const watchOptions = c.compilers.map( (childCompiler) => childCompiler.options.watchOptions || {}, ); context.watching = compiler.watch(watchOptions, errorHandler); } else { const c = /** @type {Compiler} */ (context.compiler); const watchOptions = c.options.watchOptions || {}; context.watching = compiler.watch(watchOptions, errorHandler); } } const filledContext = /** @type {FilledContext} */ (context); const instance = /** @type {API} */ (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} register */ /** * @template S * @template O * @typedef {HapiPluginBase & { pkg: { name: string }, multiple: boolean }} HapiPlugin */ /** * @typedef {Options & { compiler: Compiler | MultiCompiler }} HapiOptions */ /** * @template HapiServer * @template {HapiOptions} HapiOptionsInternal * @returns {HapiPlugin} */ function hapiWrapper() { return { pkg: { name: "webpack-dev-middleware", }, // Allow to have multiple middleware multiple: true, register(server, options) { const { compiler, ...rest } = options; if (!compiler) { throw new Error("The compiler options is required."); } const devMiddleware = wdm(compiler, rest); // @ts-ignore if (!server.decorations.server.includes("webpackDevMiddleware")) { // @ts-ignore server.decorate("server", "webpackDevMiddleware", devMiddleware); } // @ts-ignore server.ext("onRequest", (request, h) => new Promise((resolve, reject) => { let isFinished = false; /** * @param {string | Buffer} [data] */ // eslint-disable-next-line no-param-reassign request.raw.res.send = (data) => { isFinished = true; request.raw.res.end(data); }; /** * @param {string | Buffer} [data] */ // eslint-disable-next-line no-param-reassign request.raw.res.finish = (data) => { isFinished = true; request.raw.res.end(data); }; devMiddleware(request.raw.req, request.raw.res, (error) => { if (error) { reject(error); return; } if (!isFinished) { 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} [options] * @returns {(ctx: any, next: Function) => Promise | void} */ function koaWrapper(compiler, options) { const devMiddleware = wdm(compiler, options); /** * @param {{ req: RequestInternal, res: ResponseInternal & import("./utils/compatibleAPI").ExpectedServerResponse, status: number, body: string | Buffer | import("fs").ReadStream | { message: string }, state: Object }} ctx * @param {Function} next * @returns {Promise} */ const wrapper = async function webpackDevMiddleware(ctx, next) { const { req, res } = ctx; res.locals = ctx.state; let { status } = ctx; /** * @returns {number} code */ res.getStatusCode = () => status; /** * @param {number} statusCode status code */ res.setStatusCode = (statusCode) => { status = statusCode; // eslint-disable-next-line no-param-reassign ctx.status = statusCode; }; res.getReadyReadableStreamState = () => "open"; try { await new Promise( /** * @param {(value: void) => void} resolve * @param {(reason?: any) => void} reject */ (resolve, reject) => { /** * @param {import("fs").ReadStream} stream readable stream */ res.stream = (stream) => { // eslint-disable-next-line no-param-reassign ctx.body = stream; }; /** * @param {string | Buffer} data data */ res.send = (data) => { // eslint-disable-next-line no-param-reassign ctx.body = data; }; /** * @param {string | Buffer} [data] data */ res.finish = (data) => { // eslint-disable-next-line no-param-reassign ctx.status = status; res.end(data); }; devMiddleware(req, res, (err) => { if (err) { reject(err); return; } resolve(); }); }, ); } catch (err) { // eslint-disable-next-line no-param-reassign ctx.status = /** @type {Error & { statusCode: number }} */ (err).statusCode || /** @type {Error & { status: number }} */ (err).status || 500; // eslint-disable-next-line no-param-reassign ctx.body = { message: /** @type {Error} */ (err).message, }; } await next(); }; wrapper.devMiddleware = devMiddleware; return wrapper; } wdm.koaWrapper = koaWrapper; /** * @template {IncomingMessage} [RequestInternal=IncomingMessage] * @template {ServerResponse} [ResponseInternal=ServerResponse] * @param {Compiler | MultiCompiler} compiler * @param {Options} [options] * @returns {(ctx: any, next: Function) => Promise | void} */ function honoWrapper(compiler, options) { const devMiddleware = wdm(compiler, options); /** * @param {{ env: any, body: any, json: any, status: any, set:any, req: RequestInternal & import("./utils/compatibleAPI").ExpectedIncomingMessage & { header: (name: string) => string }, res: ResponseInternal & import("./utils/compatibleAPI").ExpectedServerResponse & { headers: any, status: any } }} c * @param {Function} next * @returns {Promise} */ // eslint-disable-next-line consistent-return const wrapper = async function webpackDevMiddleware(c, next) { const { req, res } = c; c.set("webpack", { devMiddleware: devMiddleware.context }); /** * @returns {string | undefined} */ req.getMethod = () => c.req.method; /** * @param {string} name * @returns {string | string[] | undefined} */ req.getHeader = (name) => c.req.header(name); /** * @returns {string | undefined} */ req.getURL = () => c.req.url; let { status } = c.res; /** * @returns {number} code */ res.getStatusCode = () => status; /** * @param {number} code */ res.setStatusCode = (code) => { status = code; }; /** * @param {string} name header name */ res.getHeader = (name) => c.res.headers.get(name); /** * @param {string} name * @param {string | number | Readonly} value */ res.setHeader = (name, value) => { c.res.headers.append(name, value); return c.res; }; /** * @param {string} name */ res.removeHeader = (name) => { c.res.headers.delete(name); }; /** * @returns {string[]} */ res.getResponseHeaders = () => Array.from(c.res.headers.keys()); /** * @returns {ServerResponse} */ res.getOutgoing = () => c.env.outgoing; res.setState = () => { // Do nothing, because we set it before }; res.getReadyReadableStreamState = () => "readable"; res.getHeadersSent = () => c.env.outgoing.headersSent; let body; try { await new Promise( /** * @param {(value: void) => void} resolve * @param {(reason?: any) => void} reject */ (resolve, reject) => { /** * @param {import("fs").ReadStream} stream readable stream */ res.stream = (stream) => { body = stream; // responseHandler(stream); }; /** * @param {string | Buffer} data data */ res.send = (data) => { body = data; }; /** * @param {string | Buffer} [data] data */ res.finish = (data) => { body = typeof data !== "undefined" ? data : null; }; devMiddleware(req, res, (err) => { if (err) { reject(err); return; } resolve(); }); }, ); } catch (err) { c.status(500); return c.json({ message: /** @type {Error} */ (err).message }); } if (typeof body !== "undefined") { return c.body(body, status); } await next(); }; wrapper.devMiddleware = devMiddleware; return wrapper; } wdm.honoWrapper = honoWrapper; module.exports = wdm;