refactor: cache test case support NEXT_MOVE_DIR_START (#12359)

* refactor: cache test support NEXT_MOVE_DIR_START

* test: add test

* fix: comment

Author: jerrykingxyz

packages/rspack-test-tools/src/case/cache.ts

@@ -19,8 +19,6 @@ import { cachedStats } from "./runner";
 
 type TTarget = RspackOptions["target"];
 
-const MAX_COMPILER_INDEX = 100;
-
 function createCacheProcessor(
 	name: string,
 	src: string,
@@ -35,16 +33,12 @@ function createCacheProcessor(
 		},
 		config: async (context: ITestContext) => {
 			const compiler = context.getCompiler();
-			let options = defaultOptions(context, temp, target);
-			options = await config(
+			const options = await generateOptions(
 				context,
-				name,
-				["rspack.config.js", "webpack.config.js"].map(i =>
-					path.resolve(temp, i)
-				),
-				options
+				temp,
+				target,
+				updatePlugin
 			);
-			overrideOptions(options, temp, target, updatePlugin);
 			compiler.setOptions(options);
 		},
 		compiler: async (context: ITestContext) => {
@@ -111,12 +105,13 @@ export function createCacheCase(
 
 const creators: Map<TTarget, BasicCaseCreator> = new Map();
 
-function defaultOptions(
+async function generateOptions(
 	context: ITestContext,
 	temp: string,
-	target: TTarget
-): RspackOptions {
-	const options = {
+	target: TTarget,
+	updatePlugin: HotUpdatePlugin
+): Promise<RspackOptions> {
+	let options = {
 		context: temp,
 		mode: "production",
 		cache: true,
@@ -147,15 +142,14 @@ function defaultOptions(
 	options.plugins ??= [];
 	options.plugins.push(new rspack.HotModuleReplacementPlugin());
 
-	return options;
-}
+	options = await config(
+		context,
+		"cacheCase",
+		["rspack.config.js", "webpack.config.js"].map(i => path.resolve(temp, i)),
+		options
+	);
 
-function overrideOptions(
-	options: RspackOptions,
-	temp: string,
-	target: TTarget,
-	updatePlugin: HotUpdatePlugin
-): void {
+	// overwrite
 	if (!options.entry) {
 		options.entry = "./index.js";
 	}
@@ -176,6 +170,8 @@ function overrideOptions(
 			level: "error"
 		};
 	}
+
+	return options;
 }
 
 function findBundle(
@@ -245,6 +241,7 @@ function createRunner(
 					moduleScope.COMPILER_INDEX = compilerIndex;
 					moduleScope.NEXT_HMR = nextHmr;
 					moduleScope.NEXT_START = nextStart;
+					moduleScope.NEXT_MOVE_DIR_START = nextMoveDirStart;
 					return moduleScope;
 				}
 			},
@@ -253,34 +250,35 @@ function createRunner(
 			compilerOptions: options
 		});
 	};
-	const nextHmr = async (m: any, options?: any): Promise<StatsCompilation> => {
-		await updatePlugin.goNext();
-		const stats = await compiler.build();
-		if (!stats) {
-			throw new Error("Should generate stats during build");
-		}
-		const jsonStats = stats.toJson({
-			// errorDetails: true
-		});
-		const compilerOptions = compiler.getOptions();
 
+	const checkStats = async (stats: StatsCompilation) => {
+		const compilerOptions = compiler.getOptions();
 		const updateIndex = updatePlugin.getUpdateIndex();
 		await checkArrayExpectation(
 			source,
-			jsonStats,
+			stats,
 			"error",
 			`errors${updateIndex}`,
 			"Error",
 			compilerOptions
 		);
 		await checkArrayExpectation(
 			source,
-			jsonStats,
+			stats,
 			"warning",
 			`warnings${updateIndex}`,
 			"Warning",
 			compilerOptions
 		);
+	};
+
+	const nextHmr = async (m: any, options?: any): Promise<StatsCompilation> => {
+		await updatePlugin.goNext();
+		const stats = await compiler.build();
+		const jsonStats = stats.toJson({
+			// errorDetails: true
+		});
+		await checkStats(jsonStats);
 
 		const updatedModules = await m.hot.check(options || true);
 		if (!updatedModules) {
@@ -292,43 +290,48 @@ function createRunner(
 
 	const nextStart = async (): Promise<StatsCompilation> => {
 		await compiler.close();
-		compiler.createCompiler();
+
 		await updatePlugin.goNext();
+		compilerIndex++;
+
+		compiler.createCompiler();
 		const stats = await compiler.build();
-		if (!stats) {
-			throw new Error("Should generate stats during build");
-		}
 		const jsonStats = stats.toJson({
 			// errorDetails: true
 		});
-		const compilerOptions = compiler.getOptions();
+		await checkStats(jsonStats);
 
-		const updateIndex = updatePlugin.getUpdateIndex();
-		await checkArrayExpectation(
-			source,
-			jsonStats,
-			"error",
-			`errors${updateIndex}`,
-			"Error",
-			compilerOptions
-		);
-		await checkArrayExpectation(
-			source,
-			jsonStats,
-			"warning",
-			`warnings${updateIndex}`,
-			"Warning",
-			compilerOptions
+		env.it(`NEXT_START run with compilerIndex==${compilerIndex}`, async () => {
+			return getWebRunner().run(file);
+		});
+		return jsonStats;
+	};
+
+	const nextMoveDirStart = async (): Promise<StatsCompilation> => {
+		await compiler.close();
+
+		const tempDir = await updatePlugin.moveTempDir();
+		const options = await generateOptions(
+			context,
+			tempDir,
+			compiler.getOptions().target,
+			updatePlugin
 		);
+		compiler.setOptions(options);
+		await updatePlugin.goNext();
+		compilerIndex++;
+
+		compiler.createCompiler();
+		const stats = await compiler.build();
+		const jsonStats = stats.toJson({
+			// errorDetails: true
+		});
+
+		await checkStats(jsonStats);
+
 		env.it(
-			`NEXT_START run with compilerIndex==${compilerIndex + 1}`,
+			`NEXT_MOVE_DIR_START run with compilerIndex==${compilerIndex}`,
 			async () => {
-				if (compilerIndex > MAX_COMPILER_INDEX) {
-					throw new Error(
-						"NEXT_START has been called more than the maximum times"
-					);
-				}
-				compilerIndex++;
 				return getWebRunner().run(file);
 			}
 		);

packages/rspack-test-tools/src/helper/hot-update/plugin.ts

@@ -23,6 +23,7 @@ async function loopFile(
 }
 
 const PLUGIN_NAME = "HotUpdatePlugin";
+const MAX_UPDATE_INDEX = 100;
 
 export class HotUpdatePlugin {
 	private initialized = false;
@@ -107,9 +108,33 @@ export class HotUpdatePlugin {
 		}, 1);
 	}
 	async goNext() {
+		if (this.updateIndex > MAX_UPDATE_INDEX) {
+			throw new Error("NEXT_* has been called more than the maximum times");
+		}
 		this.updateIndex++;
 		await this.updateFiles();
 	}
+	async moveTempDir() {
+		// generate next temp dir path.
+		const nextTempDir =
+			this.tempDir.replace(/(___[0-9]+)?[/\\]*$/, "") +
+			"___" +
+			this.updateIndex;
+
+		// update this.files.
+		for (const key of Object.keys(this.files)) {
+			const nextKey = key.replace(this.tempDir, nextTempDir);
+			this.files[nextKey] = this.files[key];
+			delete this.files[key];
+		}
+
+		// move files.
+		rimrafSync(nextTempDir);
+		fs.renameSync(this.tempDir, nextTempDir);
+		this.tempDir = nextTempDir;
+
+		return this.tempDir;
+	}
 
 	apply(compiler: Compiler) {
 		const options = compiler.options;

tests/rspack-test/cacheCases/portable/basic/file.js

@@ -0,0 +1,5 @@
+export default 1;
+---
+export default 2;
+---
+export default 3;

tests/rspack-test/cacheCases/portable/basic/index.js

@@ -0,0 +1,17 @@
+import value from "./file";
+
+it("should basic test work", async () => {
+	if (COMPILER_INDEX == 0) {
+		expect(value).toBe(1);
+		await NEXT_START();
+	}
+	if (COMPILER_INDEX == 1) {
+		expect(value).toBe(1);
+		await NEXT_MOVE_DIR_START();
+	}
+	if (COMPILER_INDEX == 2) {
+		expect(value).toBe(3);
+	}
+});
+
+module.hot.accept("./file");

tests/rspack-test/cacheCases/portable/basic/rspack.config.js

@@ -0,0 +1,14 @@
+const path = require("path");
+
+/** @type {import("@rspack/core").Configuration} */
+module.exports = {
+	context: __dirname,
+	experiments: {
+		cache: {
+			type: "persistent",
+			snapshot: {
+				immutablePaths: [path.resolve(__dirname, "./file.js")]
+			}
+		}
+	}
+};