Skip to content

refactor(assets-middleware): simplify context management #6269

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

Merged
merged 1 commit into from
Sep 28, 2025
Merged

refactor(assets-middleware): simplify context management #6269

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
90 changes: 41 additions & 49 deletions packages/core/src/server/assets-middleware/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,25 @@
* https://github.com/webpack/webpack-dev-middleware/blob/master/LICENSE
*/
import type { Stats as FSStats, ReadStream } from 'node:fs';
import type { ServerResponse as NodeServerResponse } from 'node:http';
import { createRequire } from 'node:module';
import type { Compiler, MultiCompiler, Watching } from '@rspack/core';
import { applyToCompiler, isMultiCompiler } from '../../helpers';
import { logger } from '../../logger';
import type {
EnvironmentContext,
InternalContext,
NormalizedConfig,
NormalizedDevConfig,
NormalizedEnvironmentConfig,
RequestHandler,
} from '../../types';
import { resolveHostname } from './../hmrFallback';
import type { SocketServer } from '../socketServer';
import { wrapper as createMiddleware } from './middleware';
import { setupHooks } from './setupHooks';
import { createMiddleware } from './middleware';
import { setupOutputFileSystem } from './setupOutputFileSystem';
import { resolveWriteToDiskConfig, setupWriteToDisk } from './setupWriteToDisk';

const noop = () => {};

export type ServerResponse = NodeServerResponse & {
locals?: { webpack?: { devMiddleware?: Context } };
};

export type MultiWatching = ReturnType<MultiCompiler['watch']>;

// TODO: refine types to match underlying fs-like implementations
Expand All @@ -50,11 +44,6 @@ export type Options = {
| ((targetPath: string, compilationName?: string) => boolean);
};

export type Context = {
ready: boolean;
callbacks: (() => void)[];
};

export type AssetsMiddlewareClose = (
callback: (err?: Error | null) => void,
) => void;
Expand Down Expand Up @@ -90,31 +79,19 @@ function getClientPaths(devConfig: NormalizedDevConfig) {
return clientPaths;
}

export const isClientCompiler = (compiler: {
options: {
target?: Compiler['options']['target'];
};
}): boolean => {
export const isClientCompiler = (compiler: Compiler): boolean => {
const { target } = compiler.options;

if (target) {
return Array.isArray(target) ? target.includes('web') : target === 'web';
}

return false;
};

const isNodeCompiler = (compiler: {
options: {
target?: Compiler['options']['target'];
};
}) => {
const isNodeCompiler = (compiler: Compiler) => {
const { target } = compiler.options;

if (target) {
return Array.isArray(target) ? target.includes('node') : target === 'node';
}

return false;
};

Expand All @@ -127,21 +104,20 @@ export const setupServerHooks = ({
token: string;
socketServer: SocketServer;
}): void => {
// TODO: node SSR HMR is not supported yet
// Node HMR is not supported yet
if (isNodeCompiler(compiler)) {
return;
}

const { invalid, done } = compiler.hooks;

invalid.tap('rsbuild-dev-server', (fileName) => {
compiler.hooks.invalid.tap('rsbuild-dev-server', (fileName) => {
// reload page when HTML template changed
if (typeof fileName === 'string' && fileName.endsWith('.html')) {
socketServer.sockWrite({ type: 'static-changed' }, token);
return;
}
});
done.tap('rsbuild-dev-server', (stats) => {

compiler.hooks.done.tap('rsbuild-dev-server', (stats) => {
socketServer.updateStats(stats, token);
});
};
Expand Down Expand Up @@ -198,17 +174,18 @@ function applyHMREntry({
export const assetsMiddleware = async ({
config,
compiler,
context,
socketServer,
environments,
resolvedPort,
}: {
config: NormalizedConfig;
compiler: Compiler | MultiCompiler;
context: InternalContext;
socketServer: SocketServer;
environments: Record<string, EnvironmentContext>;
resolvedPort: number;
}): Promise<AssetsMiddleware> => {
const resolvedHost = await resolveHostname(config.server.host);
const { environments } = context;

const setupCompiler = (compiler: Compiler, index: number) => {
const environment = Object.values(environments).find(
Expand Down Expand Up @@ -242,12 +219,20 @@ export const assetsMiddleware = async ({
applyToCompiler(compiler, setupCompiler);

const compilers = isMultiCompiler(compiler) ? compiler.compilers : [compiler];
const context: Context = {
ready: false,
callbacks: [],
};

setupHooks(context, compiler);
const callbacks: (() => void)[] = [];

compiler.hooks.done.tap('rsbuild-dev-middleware', () => {
process.nextTick(() => {
if (!(context.buildState.status === 'done')) {
return;
}

callbacks.forEach((callback) => {
callback();
});
callbacks.length = 0;
});
});

const writeToDisk = resolveWriteToDiskConfig(config.dev, environments);
if (writeToDisk) {
Expand All @@ -256,10 +241,18 @@ export const assetsMiddleware = async ({

const outputFileSystem = await setupOutputFileSystem(writeToDisk, compilers);

const ready = (callback: () => void) => {
if (context.buildState.status === 'done') {
callback();
} else {
callbacks.push(callback);
Comment on lines +244 to +248
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot Sep 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P1] Block dev requests when using a custom compiler

The middleware now waits for context.buildState.status === 'done' before invoking queued callbacks. buildState is only updated inside Rsbuild’s own createCompiler, but startDevServer still allows a caller-provided customCompiler (devServer.ts lines 182‑184) that never touches context.buildState. With a custom compiler the status remains idle, so the ready queue is never drained and every asset request hangs indefinitely. This is a regression from the previous hook-based Context which worked for arbitrary compilers. Consider falling back to compiler hooks when buildState isn’t driven by the given compiler or updating buildState when a custom compiler is supplied.

Useful? React with 👍 / 👎.

Copy link
Member Author

@chenjiahan chenjiahan Sep 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think customCompiler doesn't work properly in the previous implementation and needs to be deprecated

}
};

const instance = createMiddleware(
context,
ready,
outputFileSystem,
environments,
) as AssetsMiddleware;

let watching: Watching | MultiWatching | undefined;
Expand All @@ -269,20 +262,19 @@ export const assetsMiddleware = async ({
if (compiler.watching) {
watching = compiler.watching;
} else {
const errorHandler = (error: Error | null | undefined) => {
const watchOptions =
compilers.length > 1
? compilers.map(({ options }) => options.watchOptions || {})
: compilers[0].options.watchOptions || {};

watching = compiler.watch(watchOptions, (error) => {
if (error) {
if (error.message?.includes('× Error:')) {
error.message = error.message.replace('× Error:', '').trim();
}
logger.error(error);
}
};

const watchOptions =
compilers.length > 1
? compilers.map(({ options }) => options.watchOptions || {})
: compilers[0].options.watchOptions || {};
watching = compiler.watch(watchOptions, errorHandler);
});
}
};

Expand Down
27 changes: 9 additions & 18 deletions packages/core/src/server/assets-middleware/middleware.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,13 @@ import onFinished from 'on-finished';
import type { Range, Result as RangeResult, Ranges } from 'range-parser';
import rangeParser from 'range-parser';
import { logger } from '../../logger';
import type { EnvironmentContext, RequestHandler } from '../../types';
import type { InternalContext, RequestHandler } from '../../types';
import { escapeHtml } from './escapeHtml';
import { getFileFromUrl } from './getFileFromUrl';
import type { Context, OutputFileSystem, ServerResponse } from './index';
import type { OutputFileSystem } from './index';
import { memorize } from './memorize';
import { parseTokenList } from './parseTokenList';

export function ready(context: Context, callback: () => void): void {
if (context.ready) {
callback();
} else {
context.callbacks.push(callback);
}
}

function getEtag(stat: FSStats): string {
const mtime = stat.mtime.getTime().toString(16);
const size = stat.size.toString(16);
Expand Down Expand Up @@ -120,18 +112,17 @@ type SendErrorOptions = {

const acceptedMethods = ['GET', 'HEAD'];

export function wrapper(
context: Context,
export function createMiddleware(
context: InternalContext,
ready: (callback: () => void) => void,
outputFileSystem: OutputFileSystem,
environments: Record<string, EnvironmentContext>,
): RequestHandler {
return async function middleware(req, res, next) {
const { environments } = context;

async function goNext() {
return new Promise<void>((resolve) => {
ready(context, () => {
const extendedRes = res as ServerResponse;
extendedRes.locals = extendedRes.locals || {};
extendedRes.locals.webpack = { devMiddleware: context };
ready(() => {
next();
resolve();
});
Expand Down Expand Up @@ -514,6 +505,6 @@ export function wrapper(
onFinished(res, cleanup);
}

ready(context, processRequest);
ready(processRequest);
};
}
31 changes: 0 additions & 31 deletions packages/core/src/server/assets-middleware/setupHooks.ts
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion packages/core/src/server/buildManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,9 @@ export class BuildManager {

const middleware = await assetsMiddleware({
config,
context,
compiler: this.compiler,
socketServer: this.socketServer,
environments: context.environments,
resolvedPort: this.resolvedPort,
});

Expand Down
Loading