Skip to content

feat: add support for plugin usage with dedicated wrappers and logging #2272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
bjohansebas wants to merge 1 commit into
base: next
Choose a base branch
from
Draft

feat: add support for plugin usage with dedicated wrappers and logging #2272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 102 additions & 3 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ const noop = () => {};
* @property {Watching | MultiWatching | undefined} watching watching
* @property {Logger} logger logger
* @property {OutputFileSystem} outputFileSystem output file system
* @property {boolean} isPlugin whether wdm is used as webpack plugin
*/

/**
Expand Down Expand Up @@ -225,6 +226,7 @@ function wdm(compiler, options = {}) {
options,
compiler,
logger: compiler.getInfrastructureLogger("webpack-dev-middleware"),
isPlugin: false,
};

setupHooks(context);
Expand Down Expand Up @@ -319,9 +321,10 @@ function wdm(compiler, options = {}) {
/**
* @template HapiServer
* @template {HapiOptions} HapiOptionsInternal
* @param {boolean} usePlugin whether to use as webpack plugin
* @returns {HapiPlugin<HapiServer, HapiOptionsInternal>} hapi wrapper
*/
function hapiWrapper() {
function createHapiWrapper(usePlugin = false) {
return {
pkg: {
name: "webpack-dev-middleware",
Expand All @@ -337,6 +340,11 @@ function hapiWrapper() {

const devMiddleware = wdm(compiler, rest);

if (usePlugin) {
// Use logger when used as webpack plugin
devMiddleware.context.isPlugin = true;
}

// @ts-expect-error
if (!server.decorations.server.includes("webpackDevMiddleware")) {
// @ts-expect-error
Expand Down Expand Up @@ -387,18 +395,42 @@ function hapiWrapper() {
};
}

/**
* @template HapiServer
* @template {HapiOptions} HapiOptionsInternal
* @returns {HapiPlugin<HapiServer, HapiOptionsInternal>} hapi wrapper
*/
function hapiWrapper() {
return createHapiWrapper(false);
}

/**
* @template HapiServer
* @template {HapiOptions} HapiOptionsInternal
* @returns {HapiPlugin<HapiServer, HapiOptionsInternal>} hapi plugin wrapper
*/
function hapiPluginWrapper() {
return createHapiWrapper(true);
}

wdm.hapiWrapper = hapiWrapper;
wdm.hapiPluginWrapper = hapiPluginWrapper;

/**
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
* @template {ServerResponse} [ResponseInternal=ServerResponse]
* @param {Compiler | MultiCompiler} compiler compiler
* @param {Options<RequestInternal, ResponseInternal>=} options options
* @param {boolean} usePlugin whether to use as webpack plugin
* @returns {(ctx: EXPECTED_ANY, next: EXPECTED_FUNCTION) => Promise<void> | void} kow wrapper
*/
function koaWrapper(compiler, options) {
function createKoaWrapper(compiler, options, usePlugin = false) {
const devMiddleware = wdm(compiler, options);

if (usePlugin) {
devMiddleware.context.isPlugin = true;
}

/**
* @param {{ req: RequestInternal, res: ResponseInternal & import("./utils/compatibleAPI").ExpectedServerResponse, status: number, body: string | Buffer | import("fs").ReadStream | { message: string }, state: object }} ctx context
* @param {EXPECTED_FUNCTION} next next
Expand Down Expand Up @@ -508,18 +540,46 @@ function koaWrapper(compiler, options) {
return webpackDevMiddleware;
}

/**
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
* @template {ServerResponse} [ResponseInternal=ServerResponse]
* @param {Compiler | MultiCompiler} compiler compiler
* @param {Options<RequestInternal, ResponseInternal>=} options options
* @returns {(ctx: EXPECTED_ANY, next: EXPECTED_FUNCTION) => Promise<void> | void} kow wrapper
*/
function koaWrapper(compiler, options) {
return createKoaWrapper(compiler, options, false);
}

/**
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
* @template {ServerResponse} [ResponseInternal=ServerResponse]
* @param {Compiler | MultiCompiler} compiler compiler
* @param {Options<RequestInternal, ResponseInternal>=} options options
* @returns {(ctx: EXPECTED_ANY, next: EXPECTED_FUNCTION) => Promise<void> | void} kow plugin wrapper
*/
function koaPluginWrapper(compiler, options) {
return createKoaWrapper(compiler, options, true);
}

wdm.koaWrapper = koaWrapper;
wdm.koaPluginWrapper = koaPluginWrapper;

/**
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
* @template {ServerResponse} [ResponseInternal=ServerResponse]
* @param {Compiler | MultiCompiler} compiler compiler
* @param {Options<RequestInternal, ResponseInternal>=} options options
* @param {boolean} usePlugin whether to use as webpack plugin
* @returns {(ctx: EXPECTED_ANY, next: EXPECTED_FUNCTION) => Promise<void> | void} hono wrapper
*/
function honoWrapper(compiler, options) {
function createHonoWrapper(compiler, options, usePlugin = false) {
const devMiddleware = wdm(compiler, options);

if (usePlugin) {
devMiddleware.context.isPlugin = true;
}

/**
* @param {{ env: EXPECTED_ANY, body: EXPECTED_ANY, json: EXPECTED_ANY, status: EXPECTED_ANY, set: EXPECTED_ANY, req: RequestInternal & import("./utils/compatibleAPI").ExpectedIncomingMessage & { header: (name: string) => string }, res: ResponseInternal & import("./utils/compatibleAPI").ExpectedServerResponse & { headers: EXPECTED_ANY, status: EXPECTED_ANY } }} context context
* @param {EXPECTED_FUNCTION} next next function
Expand Down Expand Up @@ -685,6 +745,45 @@ function honoWrapper(compiler, options) {
return webpackDevMiddleware;
}

/**
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
* @template {ServerResponse} [ResponseInternal=ServerResponse]
* @param {Compiler | MultiCompiler} compiler compiler
* @param {Options<RequestInternal, ResponseInternal>=} options options
* @returns {(ctx: EXPECTED_ANY, next: EXPECTED_FUNCTION) => Promise<void> | void} hono wrapper
*/
function honoWrapper(compiler, options) {
return createHonoWrapper(compiler, options, false);
}

/**
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
* @template {ServerResponse} [ResponseInternal=ServerResponse]
* @param {Compiler | MultiCompiler} compiler compiler
* @param {Options<RequestInternal, ResponseInternal>=} options options
* @returns {(ctx: EXPECTED_ANY, next: EXPECTED_FUNCTION) => Promise<void> | void} hono plugin wrapper
*/
function honoPluginWrapper(compiler, options) {
return createHonoWrapper(compiler, options, true);
}

wdm.honoWrapper = honoWrapper;
wdm.honoPluginWrapper = honoPluginWrapper;

/**
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
* @template {ServerResponse} [ResponseInternal=ServerResponse]
* @param {Compiler | MultiCompiler} compiler compiler
* @param {Options<RequestInternal, ResponseInternal>=} options options
* @returns {API<RequestInternal, ResponseInternal>} webpack dev middleware
*/
function plugin(compiler, options = {}) {
const instance = wdm(compiler, options);
// Mark that wdm is used as webpack plugin (to use logger instead of console.log)
instance.context.isPlugin = true;
return instance;
}

wdm.plugin = plugin;

module.exports = wdm;
9 changes: 7 additions & 2 deletions src/utils/setupHooks.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,13 @@ function setupHooks(context) {

// Avoid extra empty line when `stats: 'none'`
if (printedStats) {
// eslint-disable-next-line no-console
console.log(printedStats);
if (context.isPlugin) {
// Use logger when used as webpack plugin
logger.log(printedStats);
} else {
// eslint-disable-next-line no-console
console.log(printedStats);
}
}

context.callbacks = [];
Expand Down
55 changes: 55 additions & 0 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,12 @@ declare function wdm<
declare namespace wdm {
export {
hapiWrapper,
hapiPluginWrapper,
koaWrapper,
koaPluginWrapper,
honoWrapper,
honoPluginWrapper,
plugin,
Schema,
Compiler,
MultiCompiler,
Expand Down Expand Up @@ -231,6 +235,15 @@ declare function hapiWrapper<
HapiServer,
HapiOptionsInternal extends HapiOptions,
>(): HapiPlugin<HapiServer, HapiOptionsInternal>;
/**
* @template HapiServer
* @template {HapiOptions} HapiOptionsInternal
* @returns {HapiPlugin<HapiServer, HapiOptionsInternal>} hapi plugin wrapper
*/
declare function hapiPluginWrapper<
HapiServer,
HapiOptionsInternal extends HapiOptions,
>(): HapiPlugin<HapiServer, HapiOptionsInternal>;
/**
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
* @template {ServerResponse} [ResponseInternal=ServerResponse]
Expand All @@ -245,6 +258,20 @@ declare function koaWrapper<
compiler: Compiler | MultiCompiler,
options?: Options<RequestInternal, ResponseInternal> | undefined,
): (ctx: EXPECTED_ANY, next: EXPECTED_FUNCTION) => Promise<void> | void;
/**
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
* @template {ServerResponse} [ResponseInternal=ServerResponse]
* @param {Compiler | MultiCompiler} compiler compiler
* @param {Options<RequestInternal, ResponseInternal>=} options options
* @returns {(ctx: EXPECTED_ANY, next: EXPECTED_FUNCTION) => Promise<void> | void} kow plugin wrapper
*/
declare function koaPluginWrapper<
RequestInternal extends IncomingMessage = import("http").IncomingMessage,
ResponseInternal extends ServerResponse = ServerResponse,
>(
compiler: Compiler | MultiCompiler,
options?: Options<RequestInternal, ResponseInternal> | undefined,
): (ctx: EXPECTED_ANY, next: EXPECTED_FUNCTION) => Promise<void> | void;
/**
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
* @template {ServerResponse} [ResponseInternal=ServerResponse]
Expand All @@ -259,6 +286,34 @@ declare function honoWrapper<
compiler: Compiler | MultiCompiler,
options?: Options<RequestInternal, ResponseInternal> | undefined,
): (ctx: EXPECTED_ANY, next: EXPECTED_FUNCTION) => Promise<void> | void;
/**
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
* @template {ServerResponse} [ResponseInternal=ServerResponse]
* @param {Compiler | MultiCompiler} compiler compiler
* @param {Options<RequestInternal, ResponseInternal>=} options options
* @returns {(ctx: EXPECTED_ANY, next: EXPECTED_FUNCTION) => Promise<void> | void} hono plugin wrapper
*/
declare function honoPluginWrapper<
RequestInternal extends IncomingMessage = import("http").IncomingMessage,
ResponseInternal extends ServerResponse = ServerResponse,
>(
compiler: Compiler | MultiCompiler,
options?: Options<RequestInternal, ResponseInternal> | undefined,
): (ctx: EXPECTED_ANY, next: EXPECTED_FUNCTION) => Promise<void> | void;
/**
* @template {IncomingMessage} [RequestInternal=IncomingMessage]
* @template {ServerResponse} [ResponseInternal=ServerResponse]
* @param {Compiler | MultiCompiler} compiler compiler
* @param {Options<RequestInternal, ResponseInternal>=} options options
* @returns {API<RequestInternal, ResponseInternal>} webpack dev middleware
*/
declare function plugin<
RequestInternal extends IncomingMessage = import("http").IncomingMessage,
ResponseInternal extends ServerResponse = ServerResponse,
>(
compiler: Compiler | MultiCompiler,
options?: Options<RequestInternal, ResponseInternal> | undefined,
): API<RequestInternal, ResponseInternal>;
type Schema = import("schema-utils/declarations/validate").Schema;
type Compiler = import("webpack").Compiler;
type MultiCompiler = import("webpack").MultiCompiler;
Expand Down
Loading