@rspack-debug/test-tools 1.4.11 → 1.6.4

package/dist/case/runner.d.ts

@@ -0,0 +1,19 @@
+import type { StatsCompilation } from "@rspack/core";
+import type { ITestContext, ITestEnv, ITestRunner } from "../type";
+export type THotStepRuntimeLangData = {
+    outdatedModules: string[];
+    outdatedDependencies: Record<string, string[]>;
+    updatedModules: string[];
+    updatedRuntime: string[];
+    acceptedModules: string[];
+    disposedModules: string[];
+};
+export type THotStepRuntimeData = {
+    javascript: THotStepRuntimeLangData;
+    css: THotStepRuntimeLangData;
+    statusPath: string[];
+};
+export declare function cachedStats(context: ITestContext, name: string): () => StatsCompilation;
+export declare function createRunner(context: ITestContext, name: string, file: string, env: ITestEnv): ITestRunner;
+export declare function getMultiCompilerRunnerKey(context: ITestContext, name: string, file: string): string;
+export declare function createMultiCompilerRunner(context: ITestContext, name: string, file: string, env: ITestEnv): ITestRunner;

package/dist/case/runner.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cachedStats = cachedStats;
+exports.createRunner = createRunner;
+exports.getMultiCompilerRunnerKey = getMultiCompilerRunnerKey;
+exports.createMultiCompilerRunner = createMultiCompilerRunner;
+const runner_1 = require("../runner");
+const debug_1 = require("../test/debug");
+function cachedStats(context, name) {
+    const compiler = context.getCompiler();
+    const statsGetter = (() => {
+        let cached = null;
+        return () => {
+            if (cached) {
+                return cached;
+            }
+            cached = compiler.getStats().toJson({
+                errorDetails: true
+            });
+            return cached;
+        };
+    })();
+    return statsGetter;
+}
+function createRunner(context, name, file, env) {
+    const compiler = context.getCompiler();
+    const testConfig = context.getTestConfig();
+    const compilerOptions = compiler.getOptions();
+    const runnerOptions = {
+        runInNewContext: false,
+        cachable: true,
+        env,
+        stats: cachedStats(context, name),
+        name,
+        testConfig: context.getTestConfig(),
+        source: context.getSource(),
+        dist: context.getDist(),
+        compilerOptions
+    };
+    if (compilerOptions.target === "web" ||
+        compilerOptions.target === "webworker") {
+        return new runner_1.WebRunner({
+            ...runnerOptions,
+            runInNewContext: true,
+            location: testConfig.location || "https://test.cases/path/index.html"
+        });
+    }
+    return new runner_1.NodeRunner(runnerOptions);
+}
+function getFileIndexHandler(context, name, file) {
+    const multiFileIndexMap = context.getValue("multiFileIndexMap") || {};
+    const runned = context.getValue("runned") || new Set();
+    if (typeof multiFileIndexMap[file] === "undefined") {
+        throw new Error("Unexpect file in multiple runner");
+    }
+    const indexList = multiFileIndexMap[file];
+    const seq = indexList.findIndex((index, n) => !runned.has(`${name}:${file}[${n}]`));
+    if (seq === -1) {
+        throw new Error(`File ${file} should run only ${indexList.length} times`);
+    }
+    const getIndex = () => [indexList[seq], seq];
+    const flagIndex = () => runned.add(`${name}:${file}[${seq}]`);
+    context.setValue("runned", runned);
+    return { getIndex, flagIndex };
+}
+function getMultiCompilerRunnerKey(context, name, file) {
+    const { getIndex } = getFileIndexHandler(context, name, file);
+    const [index, seq] = getIndex();
+    return `${name}-${index}[${seq}]`;
+}
+function createMultiCompilerRunner(context, name, file, env) {
+    const testConfig = context.getTestConfig();
+    const { getIndex, flagIndex } = getFileIndexHandler(context, name, file);
+    const multiCompilerOptions = context.getValue("multiCompilerOptions") || [];
+    const [index] = getIndex();
+    const compilerOptions = multiCompilerOptions[index];
+    const logs = context.getValue(debug_1.DEBUG_SCOPES.RunLogs);
+    const errors = context.getValue(debug_1.DEBUG_SCOPES.RunErrors);
+    let runner;
+    const runnerOptions = {
+        runInNewContext: false,
+        cachable: true,
+        env,
+        stats: () => {
+            const s = cachedStats(context, name)();
+            if (s.children?.length && s.children.length > 1) {
+                s.__index__ = index;
+                return s;
+            }
+            return s.children[index];
+        },
+        name,
+        testConfig: context.getTestConfig(),
+        source: context.getSource(),
+        dist: context.getDist(),
+        compilerOptions,
+        logs,
+        errors
+    };
+    if (compilerOptions.target === "web" ||
+        compilerOptions.target === "webworker") {
+        runner = new runner_1.WebRunner({
+            ...runnerOptions,
+            runInNewContext: true,
+            location: testConfig.location || "https://test.cases/path/index.html"
+        });
+    }
+    else {
+        runner = new runner_1.NodeRunner(runnerOptions);
+    }
+    flagIndex();
+    return runner;
+}

package/dist/case/serial.d.ts

@@ -1,3 +1,3 @@
-import { ECompilerType, type TTestConfig } from "../type";
-export type TSerialCaseConfig = Omit<TTestConfig<ECompilerType.Rspack>, "validate">;
+import type { TTestConfig } from "../type";
+export type TSerialCaseConfig = Omit<TTestConfig, "validate">;
 export declare function createSerialCase(name: string, src: string, dist: string): void;

package/dist/case/serial.js

@@ -1,33 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createSerialCase = createSerialCase;
-const config_1 = require("../processor/config");
-const runner_1 = require("../runner");
 const creator_1 = require("../test/creator");
-const type_1 = require("../type");
+const config_1 = require("./config");
+const runner_1 = require("./runner");
 const creator = new creator_1.BasicCaseCreator({
     clean: true,
     describe: false,
     testConfig: testConfig => {
         const oldModuleScope = testConfig.moduleScope;
-        testConfig.moduleScope = (ms, stats) => {
+        testConfig.moduleScope = (ms, stats, compilerOptions) => {
             let res = ms;
             // TODO: modify runner module scope based on stats here
             if (typeof oldModuleScope === "function") {
-                res = oldModuleScope(ms, stats);
+                res = oldModuleScope(ms, stats, compilerOptions);
             }
             return res;
         };
     },
-    steps: ({ name }) => [
-        new config_1.ConfigProcessor({
-            name,
-            runable: true,
-            compilerType: type_1.ECompilerType.Rspack,
-            configFiles: ["rspack.config.js", "webpack.config.js"]
-        })
-    ],
-    runner: runner_1.MultipleRunnerFactory
+    steps: ({ name }) => [(0, config_1.createConfigProcessor)(name)],
+    runner: {
+        key: runner_1.getMultiCompilerRunnerKey,
+        runner: runner_1.createMultiCompilerRunner
+    },
+    concurrent: 1
 });
 function createSerialCase(name, src, dist) {
     creator.create(name, src, dist);

package/dist/case/stats-api.d.ts

@@ -1,6 +1,11 @@
-import { type IStatsAPIProcessorOptions } from "../processor";
-import { ECompilerType } from "../type";
-export type TStatsAPICaseConfig = Omit<IStatsAPIProcessorOptions<ECompilerType.Rspack>, "name" | "compilerType"> & {
+import type { Compiler, RspackOptions, Stats } from "@rspack/core";
+import type { ITestContext } from "../type";
+export type TStatsAPICaseConfig = {
     description: string;
+    options?: (context: ITestContext) => RspackOptions;
+    snapshotName?: string;
+    compiler?: (context: ITestContext, compiler: Compiler) => Promise<void>;
+    build?: (context: ITestContext, compiler: Compiler) => Promise<void>;
+    check?: (stats: Stats, compiler: Compiler) => Promise<void>;
 };
 export declare function createStatsAPICase(name: string, src: string, dist: string, testConfig: string): void;

package/dist/case/stats-api.js

@@ -1,21 +1,80 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createStatsAPICase = createStatsAPICase;
-const processor_1 = require("../processor");
-const simple_1 = require("../test/simple");
-const type_1 = require("../type");
+const memfs_1 = require("memfs");
+const creator_1 = require("../test/creator");
 let addedSerializer = false;
+const creator = new creator_1.BasicCaseCreator({
+    clean: true,
+    describe: true,
+    steps: ({ name, caseConfig }) => {
+        const config = caseConfig;
+        return [
+            {
+                config: async (context) => {
+                    const compiler = context.getCompiler();
+                    compiler.setOptions(options(context, config.options));
+                },
+                compiler: async (context) => {
+                    const compilerManager = context.getCompiler();
+                    compilerManager.createCompiler();
+                    compiler(context, compilerManager.getCompiler(), config.compiler);
+                },
+                build: async (context) => {
+                    const compiler = context.getCompiler();
+                    if (typeof config.build === "function") {
+                        await config.build(context, compiler.getCompiler());
+                    }
+                    else {
+                        await compiler.build();
+                    }
+                },
+                run: async (env, context) => {
+                    // no need to run, just check the snapshot of diagnostics
+                },
+                check: async (env, context) => {
+                    await check(env, context, name, config.check);
+                }
+            }
+        ];
+    },
+    concurrent: true
+});
 function createStatsAPICase(name, src, dist, testConfig) {
     if (!addedSerializer) {
         addedSerializer = true;
     }
     const caseConfig = require(testConfig);
-    const runner = (0, simple_1.getSimpleProcessorRunner)(src, dist);
-    it(caseConfig.description, async () => {
-        await runner(name, new processor_1.StatsAPIProcessor({
-            name: name,
-            compilerType: type_1.ECompilerType.Rspack,
-            ...caseConfig
-        }));
+    creator.create(name, src, dist, undefined, {
+        caseConfig,
+        description: () => caseConfig.description
     });
 }
+function options(context, custom) {
+    const res = (custom?.(context) || {});
+    res.experiments ??= {};
+    res.experiments.css ??= true;
+    res.experiments.rspackFuture ??= {};
+    res.experiments.rspackFuture.bundlerInfo ??= {};
+    res.experiments.rspackFuture.bundlerInfo.force ??= false;
+    if (!global.printLogger) {
+        res.infrastructureLogging = {
+            level: "error"
+        };
+    }
+    return res;
+}
+async function compiler(context, compiler, custom) {
+    if (custom) {
+        await custom(context, compiler);
+    }
+    if (compiler) {
+        compiler.outputFileSystem = (0, memfs_1.createFsFromVolume)(new memfs_1.Volume());
+    }
+}
+async function check(env, context, name, custom) {
+    const manager = context.getCompiler();
+    const stats = manager.getStats();
+    env.expect(typeof stats).toBe("object");
+    await custom?.(stats, manager.getCompiler());
+}

package/dist/case/stats-output.d.ts

@@ -1 +1,12 @@
+import type { RspackOptions } from "@rspack/core";
+import type { ITestContext, ITestEnv } from "../type";
+export declare function createStatsProcessor(name: string, defaultOptions: (index: number, context: ITestContext) => RspackOptions, overrideOptions: (index: number, context: ITestContext, options: RspackOptions) => void): {
+    before: (context: ITestContext) => Promise<void>;
+    config: (context: ITestContext) => Promise<void>;
+    compiler: (context: ITestContext) => Promise<void>;
+    build: (context: ITestContext) => Promise<void>;
+    run: (env: ITestEnv, context: ITestContext) => Promise<void>;
+    check: (env: ITestEnv, context: ITestContext) => Promise<void>;
+    after: (context: ITestContext) => Promise<void>;
+};
 export declare function createStatsOutputCase(name: string, src: string, dist: string): void;

package/dist/case/stats-output.js

@@ -1,22 +1,213 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStatsProcessor = createStatsProcessor;
 exports.createStatsOutputCase = createStatsOutputCase;
-const stats_1 = require("../processor/stats");
+const node_path_1 = __importDefault(require("node:path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const placeholder_1 = require("../helper/expect/placeholder");
+const captureStdio_1 = __importDefault(require("../helper/legacy/captureStdio"));
 const creator_1 = require("../test/creator");
-const type_1 = require("../type");
+const common_1 = require("./common");
+const REG_ERROR_CASE = /error$/;
+function createStatsProcessor(name, defaultOptions, overrideOptions) {
+    const writeStatsOuptut = false;
+    const snapshotName = "stats.txt";
+    let stderr = null;
+    return {
+        before: async (context) => {
+            stderr = (0, captureStdio_1.default)(process.stderr, true);
+        },
+        config: async (context) => {
+            (0, common_1.configMultiCompiler)(context, name, ["rspack.config.js", "webpack.config.js"], defaultOptions, overrideOptions);
+        },
+        compiler: async (context) => {
+            const c = await (0, common_1.compiler)(context, name);
+            await statsCompiler(context, c);
+        },
+        build: async (context) => {
+            await (0, common_1.build)(context, name);
+        },
+        run: async (env, context) => {
+            // no need to run, just check snapshot
+        },
+        check: async (env, context) => {
+            await check(env, context, name, writeStatsOuptut, snapshotName, stderr);
+        },
+        after: async (context) => {
+            stderr.restore();
+        }
+    };
+}
 const creator = new creator_1.BasicCaseCreator({
     clean: true,
     describe: false,
     steps: ({ name }) => [
-        new stats_1.StatsProcessor({
-            name,
-            writeStatsOuptut: false,
-            compilerType: type_1.ECompilerType.Rspack,
-            configFiles: ["rspack.config.js", "webpack.config.js"]
-        })
+        createStatsProcessor(name, defaultOptions, overrideOptions)
     ],
     description: () => "should print correct stats for"
 });
 function createStatsOutputCase(name, src, dist) {
     creator.create(name, src, dist);
 }
+function defaultOptions(index, context) {
+    if (fs_extra_1.default.existsSync(node_path_1.default.join(context.getSource(), "rspack.config.js")) ||
+        fs_extra_1.default.existsSync(node_path_1.default.join(context.getSource(), "webpack.config.js"))) {
+        return {
+            experiments: {
+                css: true,
+                rspackFuture: {
+                    bundlerInfo: {
+                        force: false
+                    }
+                }
+            }
+        };
+    }
+    return {
+        context: context.getSource(),
+        mode: "development",
+        entry: "./index.js",
+        output: {
+            filename: "bundle.js",
+            path: context.getDist()
+        },
+        optimization: {
+            minimize: false
+        },
+        experiments: {
+            css: true,
+            rspackFuture: {
+                bundlerInfo: {
+                    force: false
+                }
+            },
+            inlineConst: true
+        }
+    };
+}
+function overrideOptions(index, context, options) {
+    if (!options.context)
+        options.context = context.getSource();
+    if (!options.output)
+        options.output = options.output || {};
+    if (!options.output.path)
+        options.output.path = context.getDist();
+    if (!options.plugins)
+        options.plugins = [];
+    if (!options.optimization)
+        options.optimization = {};
+    if (options.optimization.minimize === undefined) {
+        options.optimization.minimize = false;
+    }
+    if (!global.printLogger) {
+        options.infrastructureLogging = {
+            level: "error"
+        };
+    }
+}
+class RspackStats {
+    constructor(value) {
+        this.value = value;
+    }
+}
+async function check(env, context, name, writeStatsOuptut, snapshot, stderr) {
+    const compiler = context.getCompiler();
+    const options = compiler.getOptions();
+    const stats = compiler.getStats();
+    if (!stats || !compiler)
+        return;
+    for (const compilation of []
+        .concat(stats.stats || stats)
+        .map((s) => s.compilation)) {
+        compilation.logging.delete("webpack.Compilation.ModuleProfile");
+    }
+    if (REG_ERROR_CASE.test(name)) {
+        env.expect(stats.hasErrors()).toBe(true);
+    }
+    else if (stats.hasErrors()) {
+        throw new Error(stats.toString({
+            all: false,
+            errors: true
+            // errorStack: true,
+            // errorDetails: true
+        }));
+    }
+    else if (writeStatsOuptut) {
+        fs_extra_1.default.writeFileSync(node_path_1.default.join(context.getDist(), "stats.txt"), stats.toString({
+            preset: "verbose",
+            // context: context.getSource(),
+            colors: false
+        }), "utf-8");
+    }
+    let toStringOptions = {
+        context: context.getSource(),
+        colors: false
+    };
+    let hasColorSetting = false;
+    if (typeof options.stats !== "undefined") {
+        toStringOptions = options.stats;
+        if (toStringOptions === null || typeof toStringOptions !== "object")
+            toStringOptions = { preset: toStringOptions };
+        if (!toStringOptions.context)
+            toStringOptions.context = context.getSource();
+        hasColorSetting = typeof toStringOptions.colors !== "undefined";
+    }
+    if (Array.isArray(options) && !toStringOptions.children) {
+        toStringOptions.children = options.map(o => o.stats);
+    }
+    // mock timestamps
+    for (const { compilation: s } of [].concat(stats.stats || stats)) {
+        env.expect(s.startTime).toBeGreaterThan(0);
+        env.expect(s.endTime).toBeGreaterThan(0);
+        s.endTime = new Date("04/20/1970, 12:42:42 PM").getTime();
+        s.startTime = s.endTime - 1234;
+    }
+    let actual = stats.toString(toStringOptions);
+    env.expect(typeof actual).toBe("string");
+    actual = stderr.toString() + actual;
+    if (!hasColorSetting) {
+        actual = actual
+            .replace(/\u001b\[[0-9;]*m/g, "")
+            // CHANGE: The time unit display in Rspack is second
+            .replace(/[.0-9]+(\s?s)/g, "X$1")
+            // CHANGE: Replace bundle size, since bundle sizes may differ between platforms
+            .replace(/[0-9]+\.?[0-9]+ KiB/g, "xx KiB")
+            .replace(/[0-9]+ ms/g, "xx ms");
+    }
+    const snapshotPath = node_path_1.default.isAbsolute(snapshot)
+        ? snapshot
+        : node_path_1.default.resolve(context.getSource(), `./__snapshots__/${snapshot}`);
+    env.expect(new RspackStats(actual)).toMatchFileSnapshotSync(snapshotPath);
+    const testConfig = context.getTestConfig();
+    if (typeof testConfig?.validate === "function") {
+        testConfig.validate(stats, stderr.toString());
+    }
+}
+async function statsCompiler(context, compiler) {
+    const compilers = compiler.compilers
+        ? compiler.compilers
+        : [compiler];
+    for (const compiler of compilers) {
+        if (!compiler.inputFileSystem) {
+            continue;
+        }
+        const ifs = compiler.inputFileSystem;
+        const inputFileSystem = Object.create(ifs);
+        compiler.inputFileSystem = inputFileSystem;
+        inputFileSystem.readFile = (...args) => {
+            const callback = args.pop();
+            ifs.readFile.apply(ifs, args.concat([
+                (err, result) => {
+                    if (err)
+                        return callback(err);
+                    if (!/\.(js|json|txt)$/.test(args[0]))
+                        return callback(null, result);
+                    callback(null, (0, placeholder_1.normalizePlaceholder)(result.toString("utf-8")));
+                }
+            ]));
+        };
+    }
+}

package/dist/case/treeshaking.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createTreeShakingCase = createTreeShakingCase;
-const treeshaking_1 = require("../processor/treeshaking");
 const creator_1 = require("../test/creator");
-const type_1 = require("../type");
+const builtin_1 = require("./builtin");
+const common_1 = require("./common");
 const creator = new creator_1.BasicCaseCreator({
     clean: true,
     describe: false,
@@ -11,13 +11,40 @@ const creator = new creator_1.BasicCaseCreator({
         return `${name} with newTreeshaking should match snapshot`;
     },
     steps: ({ name }) => [
-        new treeshaking_1.TreeShakingProcessor({
-            name,
-            snapshot: "treeshaking.snap.txt",
-            compilerType: type_1.ECompilerType.Rspack
-        })
+        {
+            config: async (context) => {
+                const compiler = context.getCompiler();
+                const options = (0, builtin_1.defaultOptions)(context);
+                overrideOptions(context, options);
+                compiler.setOptions(options);
+            },
+            compiler: async (context) => {
+                await (0, common_1.compiler)(context, name);
+            },
+            build: async (context) => {
+                await (0, common_1.build)(context, name);
+            },
+            run: async (env, context) => {
+                // no need to run, just check snapshot
+            },
+            check: async (env, context) => {
+                await (0, common_1.checkSnapshot)(env, context, name, "treeshaking.snap.txt");
+            }
+        }
     ]
 });
 function createTreeShakingCase(name, src, dist) {
     creator.create(name, src, dist);
 }
+function overrideOptions(context, options) {
+    options.target = options.target || ["web", "es2022"];
+    options.optimization ??= {};
+    options.optimization.providedExports = true;
+    options.optimization.innerGraph = true;
+    options.optimization.usedExports = true;
+    if (!global.printLogger) {
+        options.infrastructureLogging = {
+            level: "error"
+        };
+    }
+}

package/dist/case/watch.d.ts

@@ -1 +1,28 @@
+import type { ITestContext, ITestEnv, ITestRunner } from "../type";
+export declare function createWatchInitialProcessor(name: string, tempDir: string, step: string, watchState: Record<string, any>, { incremental, nativeWatcher }?: {
+    incremental?: boolean | undefined;
+    nativeWatcher?: boolean | undefined;
+}): {
+    before: (context: ITestContext) => Promise<void>;
+    config: (context: ITestContext) => Promise<void>;
+    compiler: (context: ITestContext) => Promise<void>;
+    build: (context: ITestContext) => Promise<void>;
+    run: (env: ITestEnv, context: ITestContext) => Promise<void>;
+    check: (env: ITestEnv, context: ITestContext) => Promise<void>;
+    after: (context: ITestContext) => Promise<void>;
+};
+export declare function createWatchStepProcessor(name: string, tempDir: string, step: string, watchState: Record<string, any>, { incremental, nativeWatcher }?: {
+    incremental?: boolean | undefined;
+    nativeWatcher?: boolean | undefined;
+}): {
+    before: (context: ITestContext) => Promise<void>;
+    config: (context: ITestContext) => Promise<void>;
+    compiler: (context: ITestContext) => Promise<void>;
+    build: (context: ITestContext) => Promise<void>;
+    run: (env: ITestEnv, context: ITestContext) => Promise<void>;
+    check: (env: ITestEnv, context: ITestContext) => Promise<void>;
+    after: (context: ITestContext) => Promise<void>;
+};
 export declare function createWatchCase(name: string, src: string, dist: string, temp: string): void;
+export declare function getWatchRunnerKey(context: ITestContext, name: string, file: string): string;
+export declare function createWatchRunner(context: ITestContext, name: string, file: string, env: ITestEnv): ITestRunner;