chore: add jsdom web runner (#6286)

* chore: add jsdom web runner

* chore: protected

packages/rspack-test-tools/etc/api.md

@@ -280,26 +280,6 @@ export interface IBasicProcessorOptions<T extends ECompilerType = ECompilerType.
     runable: boolean;
 }
 
-// @public (undocumented)
-export interface IBasicRunnerOptions<T extends ECompilerType> {
-    // (undocumented)
-    compilerOptions: TCompilerOptions<T>;
-    // (undocumented)
-    dist: string;
-    // (undocumented)
-    env: ITestEnv;
-    // (undocumented)
-    name: string;
-    // (undocumented)
-    runInNewContext?: boolean;
-    // (undocumented)
-    source: string;
-    // (undocumented)
-    stats?: TCompilerStatsCompilation<T>;
-    // (undocumented)
-    testConfig: TTestConfig<T>;
-}
-
 // @public (undocumented)
 export interface ICompareOptions {
     // (undocumented)
@@ -1094,6 +1074,11 @@ export type TModuleCompareResult = TCompareResult & {
     name: string;
 };
 
+// @public (undocumented)
+export type TModuleObject = {
+    exports: unknown;
+};
+
 // @public (undocumented)
 export type TModuleTypeId = "normal" | "runtime";
 

packages/rspack-test-tools/src/runner/basic.ts

@@ -60,7 +60,11 @@ export class BasicRunnerFactory<T extends ECompilerType>
 			compilerOptions.target === "web" ||
 			compilerOptions.target === "webworker"
 		) {
-			return new WebRunner<T>(runnerOptions);
+			return new WebRunner<T>({
+				...runnerOptions,
+				runInNewContext: true,
+				dom: "fake"
+			});
 		} else {
 			return new EsmRunner<T>(runnerOptions);
 		}

packages/rspack-test-tools/src/runner/hot-step.ts

@@ -1,5 +1,4 @@
 import { StatsCompilation } from "@rspack/core";
-import checkArrayExpectation from "../helper/legacy/checkArrayExpectation";
 import {
 	ECompilerType,
 	ITestEnv,
@@ -8,8 +7,8 @@ import {
 	TCompilerStats,
 	TCompilerStatsCompilation
 } from "../type";
-import { HotRunner } from "./runner/hot";
 import { HotRunnerFactory } from "./hot";
+import { WebRunner } from "./runner/web";
 
 export class HotStepRunnerFactory<
 	T extends ECompilerType
@@ -30,7 +29,10 @@ export class HotStepRunnerFactory<
 		) as { updateIndex: number };
 
 		const next = (
-			callback: (error: Error | null, stats?: StatsCompilation) => void
+			callback: (
+				error: Error | null,
+				stats?: TCompilerStatsCompilation<T>
+			) => void
 		) => {
 			hotUpdateContext.updateIndex++;
 			compiler
@@ -60,15 +62,24 @@ export class HotStepRunnerFactory<
 				.catch(callback);
 		};
 
-		return new HotRunner({
+		return new WebRunner({
+			dom: "jsdom",
 			env,
 			stats,
 			name: this.name,
 			runInNewContext: false,
-			testConfig,
+			testConfig: {
+				...testConfig,
+				moduleScope(ms) {
+					if (typeof testConfig.moduleScope === "function") {
+						ms = testConfig.moduleScope(ms);
+					}
+					ms["NEXT"] = next;
+					return ms;
+				}
+			},
 			source,
 			dist,
-			next,
 			compilerOptions
 		});
 	}

packages/rspack-test-tools/src/runner/hot.ts

@@ -8,7 +8,7 @@ import {
 	TCompilerStatsCompilation
 } from "../type";
 import { BasicRunnerFactory } from "./basic";
-import { HotRunner } from "./runner/hot";
+import { WebRunner } from "./runner/web";
 
 export class HotRunnerFactory<
 	T extends ECompilerType
@@ -29,7 +29,10 @@ export class HotRunnerFactory<
 		) as { updateIndex: number };
 
 		const next = (
-			callback: (error: Error | null, stats?: StatsCompilation) => void
+			callback: (
+				error: Error | null,
+				stats?: TCompilerStatsCompilation<T>
+			) => void
 		) => {
 			hotUpdateContext.updateIndex++;
 			compiler
@@ -69,15 +72,24 @@ export class HotRunnerFactory<
 				.catch(callback);
 		};
 
-		return new HotRunner({
+		return new WebRunner({
+			dom: "fake",
 			env,
 			stats,
 			name: this.name,
 			runInNewContext: false,
-			testConfig,
+			testConfig: {
+				...testConfig,
+				moduleScope(ms) {
+					if (typeof testConfig.moduleScope === "function") {
+						ms = testConfig.moduleScope(ms);
+					}
+					ms["NEXT"] = next;
+					return ms;
+				}
+			},
 			source,
 			dist,
-			next,
 			compilerOptions
 		});
 	}

packages/rspack-test-tools/src/runner/runner/basic.ts

@@ -1,19 +1,21 @@
-import { ECompilerType, ITestRunner } from "../../type";
-import vm from "vm";
+import {
+	ECompilerType,
+	ITestEnv,
+	ITestRunner,
+	TCompilerOptions,
+	TCompilerStatsCompilation,
+	TTestConfig
+} from "../../type";
 import path from "path";
 import fs from "fs";
 import {
 	IBasicGlobalContext,
 	IBasicModuleScope,
-	IBasicRunnerOptions,
 	TBasicRunnerFile,
+	TModuleObject,
 	TRunnerRequirer
 } from "../type";
 
-const define = function (...args: unknown[]) {
-	const factory = args.pop() as () => {};
-	factory();
-};
 const isRelativePath = (p: string) => /^\.\.?\//.test(p);
 const getSubPath = (p: string) => {
 	const lastSlash = p.lastIndexOf("/");
@@ -36,8 +38,20 @@ const getSubPath = (p: string) => {
 	return "";
 };
 
-export class BasicRunner<T extends ECompilerType = ECompilerType.Rspack>
-	implements ITestRunner
+export interface IBasicRunnerOptions<T extends ECompilerType> {
+	env: ITestEnv;
+	stats?: TCompilerStatsCompilation<T>;
+	name: string;
+	runInNewContext?: boolean;
+	testConfig: TTestConfig<T>;
+	source: string;
+	dist: string;
+	compilerOptions: TCompilerOptions<T>;
+}
+
+export abstract class BasicRunner<
+	T extends ECompilerType = ECompilerType.Rspack
+> implements ITestRunner
 {
 	protected globalContext: IBasicGlobalContext | null = null;
 	protected baseModuleScope: IBasicModuleScope | null = null;
@@ -66,62 +80,13 @@ export class BasicRunner<T extends ECompilerType = ECompilerType.Rspack>
 		return this.requirers.get("entry")!;
 	}
 
-	protected createGlobalContext(): IBasicGlobalContext {
-		return {
-			console: console,
-			expect: expect,
-			setTimeout: ((
-				cb: (...args: any[]) => void,
-				ms: number | undefined,
-				...args: any
-			) => {
-				let timeout = setTimeout(cb, ms, ...args);
-				timeout.unref();
-				return timeout;
-			}) as typeof setTimeout,
-			clearTimeout: clearTimeout
-		};
-	}
-
-	protected createBaseModuleScope(): IBasicModuleScope {
-		const baseModuleScope: IBasicModuleScope = {
-			console: this.globalContext!.console,
-			expect: this.globalContext!.expect,
-			setTimeout: this.globalContext!.setTimeout,
-			clearTimeout: this.globalContext!.clearTimeout,
-			it: this._options.env.it,
-			beforeEach: this._options.env.beforeEach,
-			afterEach: this._options.env.afterEach,
-			jest,
-			nsObj: (m: Object) => {
-				Object.defineProperty(m, Symbol.toStringTag, {
-					value: "Module"
-				});
-				return m;
-			}
-		};
-		if (this._options.stats) {
-			baseModuleScope["__STATS__"] = this._options.stats;
-		}
-		return baseModuleScope;
-	}
-
-	protected createModuleScope(
+	protected abstract createGlobalContext(): IBasicGlobalContext;
+	protected abstract createBaseModuleScope(): IBasicModuleScope;
+	protected abstract createModuleScope(
 		requireFn: TRunnerRequirer,
-		m: { exports: unknown },
+		m: TModuleObject,
 		file: TBasicRunnerFile
-	): IBasicModuleScope {
-		return {
-			...this.baseModuleScope!,
-			require: requireFn.bind(null, path.dirname(file.path)),
-			module: m,
-			exports: m.exports,
-			__dirname: path.dirname(file.path),
-			__filename: file.path,
-			_globalAssign: { expect },
-			define
-		};
-	}
+	): IBasicModuleScope;
 
 	protected getFile(
 		modulePath: string[] | string,
@@ -149,80 +114,15 @@ export class BasicRunner<T extends ECompilerType = ECompilerType.Rspack>
 		}
 	}
 
-	protected createMissRequirer(): TRunnerRequirer {
-		return (currentDirectory, modulePath, context = {}) => {
-			const modulePathStr = modulePath as string;
-			const modules = this._options.testConfig.modules;
-			if (modules && modulePathStr in modules) {
-				return modules[modulePathStr];
-			} else {
-				return require(
-					modulePathStr.startsWith("node:")
-						? modulePathStr.slice(5)
-						: modulePathStr
-				);
-			}
-		};
-	}
-
-	protected createCjsRequirer(): TRunnerRequirer {
-		const requireCache = Object.create(null);
-
-		return (currentDirectory, modulePath, context = {}) => {
-			let file = context["file"] || this.getFile(modulePath, currentDirectory);
-			if (!file) {
-				return this.requirers.get("miss")!(currentDirectory, modulePath);
-			}
-
-			if (file.path in requireCache) {
-				return requireCache[file.path].exports;
-			}
-
-			const m = {
-				exports: {}
-			};
-			requireCache[file.path] = m;
-			const currentModuleScope = this.createModuleScope(
-				this.getRequire(),
-				m,
-				file
-			);
-
-			if (this._options.testConfig.moduleScope) {
-				this._options.testConfig.moduleScope(currentModuleScope);
-			}
-
-			if (!this._options.runInNewContext) {
-				file.content = `Object.assign(global, _globalAssign);\n ${file.content}`;
-			}
-			const args = Object.keys(currentModuleScope);
-			const argValues = args.map(arg => currentModuleScope[arg]);
-			const code = `(function(${args.join(", ")}) {
-        ${file.content}
-      })`;
-
-			this.preExecute(code, file);
-			const fn = this._options.runInNewContext
-				? vm.runInNewContext(code, this.globalContext!, file.path)
-				: vm.runInThisContext(code, file.path);
-
-			fn.call(
-				this._options.testConfig.nonEsmThis
-					? this._options.testConfig.nonEsmThis(modulePath)
-					: m.exports,
-				...argValues
-			);
-
-			this.postExecute(m, file);
-			return m.exports;
-		};
-	}
-
 	protected preExecute(code: string, file: TBasicRunnerFile) {}
 	protected postExecute(m: Object, file: TBasicRunnerFile) {}
 
 	protected createRunner() {
-		this.requirers.set("miss", this.createMissRequirer());
-		this.requirers.set("entry", this.createCjsRequirer());
+		this.requirers.set(
+			"entry",
+			(currentDirectory, modulePath, context = {}) => {
+				throw new Error("Not implement");
+			}
+		);
 	}
 }