@rspack-canary/test-tools 1.5.6-canary-e598f284-20250921173624 → 1.5.7-canary-a3406c0a-20250922173625

package/dist/case/error.d.ts

@@ -1,6 +1,6 @@
-import { type IErrorProcessorOptions } from "../processor";
+import { type ISimpleProcessorOptions } from "../processor";
 import { ECompilerType } from "../type";
-export type TErrorCaseConfig = Omit<IErrorProcessorOptions<ECompilerType.Rspack>, "name" | "compilerType"> & {
+export type TErrorCaseConfig = Omit<ISimpleProcessorOptions<ECompilerType.Rspack>, "name" | "compilerType"> & {
     description: string;
 };
 export declare function createErrorCase(name: string, src: string, dist: string, testConfig: string): void;

package/dist/case/error.js

@@ -1,10 +1,84 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createErrorCase = createErrorCase;
+const node_path_1 = __importDefault(require("node:path"));
+const webpack_merge_1 = __importDefault(require("webpack-merge"));
 const processor_1 = require("../processor");
 const simple_1 = require("../test/simple");
 const type_1 = require("../type");
 let addedSerializer = false;
+function options(context, custom) {
+    let options = {
+        context: node_path_1.default.resolve(__dirname, "../../../../tests/rspack-test/fixtures/errors"),
+        mode: "none",
+        devtool: false,
+        optimization: {
+            minimize: false,
+            moduleIds: "named",
+            chunkIds: "named"
+        },
+        experiments: {
+            css: true,
+            rspackFuture: {
+                bundlerInfo: {
+                    force: false
+                }
+            }
+        }
+    };
+    if (typeof custom === "function") {
+        options = (0, webpack_merge_1.default)(options, custom(context, options));
+    }
+    if (options.mode === "production") {
+        if (options.optimization)
+            options.optimization.minimize = true;
+        else
+            options.optimization = { minimize: true };
+    }
+    return options;
+}
+async function compiler(context, compiler, custom) {
+    if (compiler) {
+        compiler.outputFileSystem = {
+            // CHANGE: rspack outputFileSystem `mkdirp` uses option `{ recursive: true }`, webpack's second parameter is alway a callback
+            mkdir(dir, maybeOptionOrCallback, maybeCallback) {
+                if (typeof maybeOptionOrCallback === "function") {
+                    maybeOptionOrCallback();
+                }
+                else if (typeof maybeCallback === "function") {
+                    maybeCallback();
+                }
+            },
+            writeFile(file, content, callback) {
+                callback();
+            },
+            stat(file, callback) {
+                callback(new Error("ENOENT"));
+            },
+            mkdirSync() { },
+            writeFileSync() { }
+        };
+    }
+    await custom?.(context, compiler);
+}
+class RspackStatsDiagnostics {
+    constructor(errors, warnings) {
+        this.errors = errors;
+        this.warnings = warnings;
+    }
+}
+async function check(env, context, _, stats, check) {
+    env.expect(typeof stats).toBe("object");
+    const statsResult = stats.toJson({ errorDetails: false });
+    env.expect(typeof statsResult).toBe("object");
+    const { errors, warnings } = statsResult;
+    env.expect(Array.isArray(errors)).toBe(true);
+    env.expect(Array.isArray(warnings)).toBe(true);
+    await check?.(new RspackStatsDiagnostics(errors, warnings));
+}
 function createErrorCase(name, src, dist, testConfig) {
     if (!addedSerializer) {
         addedSerializer = true;
@@ -12,10 +86,13 @@ function createErrorCase(name, src, dist, testConfig) {
     const caseConfig = require(testConfig);
     const runner = (0, simple_1.getSimpleProcessorRunner)(src, dist);
     it(caseConfig.description, async () => {
-        await runner(name, new processor_1.ErrorProcessor({
+        await runner(name, new processor_1.SimpleTaskProcessor({
             name: name,
             compilerType: type_1.ECompilerType.Rspack,
-            ...caseConfig
+            options: context => options(context, caseConfig.options),
+            compiler: (context, c) => compiler(context, c, caseConfig.compiler),
+            build: caseConfig.build,
+            check: (env, context, compiler, stats) => check(env, context, compiler, stats, caseConfig.check)
         }));
     });
 }

package/dist/case/hash.js

@@ -4,6 +4,35 @@ exports.createHashCase = createHashCase;
 const processor_1 = require("../processor");
 const creator_1 = require("../test/creator");
 const type_1 = require("../type");
+const REG_ERROR_CASE = /error$/;
+function defaultOptions(index, context) {
+    return {
+        context: context.getSource(),
+        output: {
+            path: context.getDist()
+        },
+        experiments: {
+            css: true,
+            rspackFuture: {
+                bundlerInfo: {
+                    force: false
+                }
+            },
+            inlineConst: true,
+            lazyBarrel: true
+        }
+    };
+}
+function overrideOptions(index, context, options) {
+    if (!options.entry) {
+        options.entry = "./index.js";
+    }
+    if (!global.printLogger) {
+        options.infrastructureLogging = {
+            level: "error"
+        };
+    }
+}
 class HashCaseCreator extends creator_1.BasicCaseCreator {
     describe(name, tester, testConfig) {
         it(`should print correct hash for ${name}`, async () => {
@@ -14,16 +43,41 @@ class HashCaseCreator extends creator_1.BasicCaseCreator {
         }, 30000);
     }
 }
+async function check(env, context, compiler, stats) {
+    const testConfig = context.getTestConfig();
+    if (!stats) {
+        env.expect(false);
+        return;
+    }
+    if (REG_ERROR_CASE.test(this._options.name)) {
+        env.expect(stats.hasErrors());
+    }
+    else {
+        env.expect(!stats.hasErrors());
+    }
+    if (typeof testConfig.validate === "function") {
+        testConfig.validate(stats);
+    }
+    else {
+        throw new Error("HashTestCases should have test.config.js and a validate method");
+    }
+}
+function createHashProcessor(name) {
+    const processor = new processor_1.MultiTaskProcessor({
+        name,
+        compilerType: type_1.ECompilerType.Rspack,
+        configFiles: ["rspack.config.js", "webpack.config.js"],
+        runable: false,
+        defaultOptions,
+        overrideOptions,
+        check
+    });
+    return processor;
+}
 const creator = new HashCaseCreator({
     clean: true,
     describe: false,
-    steps: ({ name }) => [
-        new processor_1.HashProcessor({
-            name,
-            compilerType: type_1.ECompilerType.Rspack,
-            configFiles: ["rspack.config.js", "webpack.config.js"]
-        })
-    ]
+    steps: ({ name }) => [createHashProcessor(name)]
 });
 function createHashCase(name, src, dist) {
     creator.create(name, src, dist);

package/dist/case/hook.d.ts

@@ -1,6 +1,38 @@
-import { type IHookProcessorOptions } from "../processor";
-import { ECompilerType } from "../type";
-export type THookCaseConfig = Omit<IHookProcessorOptions<ECompilerType.Rspack>, "name" | "compilerType" | "runable"> & {
+import { type ISnapshotProcessorOptions } from "../processor";
+import { TestContext, type TTestContextOptions } from "../test/context";
+import type { ITestEnv } from "../type";
+import { ECompilerType, type ITestContext, type TCompiler, type TCompilerOptions } from "../type";
+export declare class HookCasesContext extends TestContext {
+    protected src: string;
+    protected testName: string;
+    protected options: TTestContextOptions;
+    protected promises: Promise<void>[];
+    protected count: number;
+    protected snapshots: Record<string | number, Array<[string | Buffer, string]>>;
+    protected snapshotsList: Array<string | number>;
+    constructor(src: string, testName: string, options: TTestContextOptions);
+    /**
+     * Snapshot function arguments and return value.
+     * Generated snapshot is located in the same directory with the test source.
+     * @example
+     * compiler.hooks.compilation("name", context.snapped((...args) => { ... }))
+     */
+    snapped(cb: (...args: unknown[]) => Promise<unknown>, prefix?: string): (this: any, ...args: unknown[]) => Promise<unknown>;
+    /**
+     * @internal
+     */
+    _addSnapshot(content: unknown, name: string, group: string | number): void;
+    /**
+     * @internal
+     */
+    collectSnapshots(env: ITestEnv, options?: {
+        diff: {};
+    }): Promise<void>;
+}
+export type THookCaseConfig = Omit<ISnapshotProcessorOptions<ECompilerType.Rspack>, "name" | "compilerType" | "runable"> & {
+    options?: (context: ITestContext) => TCompilerOptions<ECompilerType.Rspack>;
+    compiler?: (context: ITestContext, compiler: TCompiler<ECompilerType.Rspack>) => Promise<void>;
+    check?: (context: ITestContext) => Promise<void>;
     description: string;
 };
 export declare function createHookCase(name: string, src: string, dist: string, source: string): void;

package/dist/case/hook.js

@@ -3,32 +3,213 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.HookCasesContext = void 0;
 exports.createHookCase = createHookCase;
 const node_path_1 = __importDefault(require("node:path"));
+const core_1 = require("@rspack/core");
+const jest_snapshot_1 = require("jest-snapshot");
+const path_serializer_1 = require("path-serializer");
+const pretty_format_1 = require("pretty-format");
+const webpack_merge_1 = __importDefault(require("webpack-merge"));
 const createLazyTestEnv_1 = __importDefault(require("../helper/legacy/createLazyTestEnv"));
 const processor_1 = require("../processor");
 const runner_1 = require("../runner");
+const context_1 = require("../test/context");
 const simple_1 = require("../test/simple");
 const type_1 = require("../type");
+const srcDir = node_path_1.default.resolve(__dirname, "../../../../tests/rspack-test/fixtures");
+const distDir = node_path_1.default.resolve(__dirname, "../../../../tests/rspack-test/js/hook");
+const sourceSerializer = {
+    test(val) {
+        return val instanceof core_1.sources.Source;
+    },
+    print(val) {
+        return val.source();
+    }
+};
+const internalSerializer = {
+    test(val) {
+        return val instanceof core_1.Compiler || val instanceof core_1.Compilation;
+    },
+    print(val) {
+        return JSON.stringify(`${val.constructor.name}(internal ignored)`);
+    }
+};
+const testPathSerializer = (0, path_serializer_1.createSnapshotSerializer)({
+    replace: [
+        {
+            match: srcDir,
+            mark: "<HOOK_SRC_DIR>"
+        },
+        {
+            match: distDir,
+            mark: "<HOOK_DIST_DIR>"
+        }
+    ]
+});
+const escapeRegex = true;
+const printFunctionName = false;
+const normalizeNewlines = (str) => str.replace(/\r\n|\r/g, "\n");
+const serialize = (val, indent = 2, formatOverrides = {}) => normalizeNewlines((0, pretty_format_1.format)(val, {
+    escapeRegex,
+    indent,
+    plugins: [
+        ...(0, jest_snapshot_1.getSerializers)(),
+        sourceSerializer,
+        internalSerializer,
+        testPathSerializer
+    ],
+    printFunctionName,
+    ...formatOverrides
+}));
+class HookCasesContext extends context_1.TestContext {
+    constructor(src, testName, options) {
+        super(options);
+        this.src = src;
+        this.testName = testName;
+        this.options = options;
+        this.promises = [];
+        this.count = 0;
+        this.snapshots = {};
+        this.snapshotsList = [];
+        this.snapped = this.snapped.bind(this);
+    }
+    /**
+     * Snapshot function arguments and return value.
+     * Generated snapshot is located in the same directory with the test source.
+     * @example
+     * compiler.hooks.compilation("name", context.snapped((...args) => { ... }))
+     */
+    snapped(cb, prefix = "") {
+        // eslint-disable-next-line
+        const context = this;
+        return function SNAPPED_HOOK(...args) {
+            const group = prefix ? prefix : context.count++;
+            context._addSnapshot(args, "input", group);
+            const output = cb.apply(this, args);
+            if (output && typeof output.then === "function") {
+                let resolve;
+                context.promises.push(new Promise(r => (resolve = r)));
+                return output
+                    .then((o) => {
+                    context._addSnapshot(o, "output (Promise resolved)", group);
+                    return o;
+                })
+                    .catch((o) => {
+                    context._addSnapshot(o, "output (Promise rejected)", group);
+                    return o;
+                })
+                    .finally(resolve);
+            }
+            context._addSnapshot(output, "output", group);
+            return output;
+        };
+    }
+    /**
+     * @internal
+     */
+    _addSnapshot(content, name, group) {
+        const normalizedContent = Buffer.isBuffer(content)
+            ? content
+            : serialize(content, undefined, {
+                escapeString: true,
+                printBasicPrototype: true
+            }).replace(/\r\n/g, "\n");
+        (this.snapshots[group] = this.snapshots[group] || []).push([
+            normalizedContent,
+            name
+        ]);
+        if (!this.snapshotsList.includes(group)) {
+            this.snapshotsList.push(group);
+        }
+    }
+    /**
+     * @internal
+     */
+    async collectSnapshots(env, options = {
+        diff: {}
+    }) {
+        await Promise.allSettled(this.promises);
+        if (!this.snapshotsList.length)
+            return;
+        const snapshots = this.snapshotsList.reduce((acc, group, index) => {
+            const block = this.snapshots[group || index].reduce((acc, [content, name]) => {
+                name = `## ${name || `test: ${index}`}\n\n`;
+                const block = `\`\`\`javascript\n${content}\n\`\`\`\n`;
+                return `${acc}${name + block}\n`;
+            }, "");
+            return `${acc}# ${Number.isInteger(group) ? `Group: ${index}` : group}\n\n${block}`;
+        }, "");
+        env
+            .expect(snapshots)
+            .toMatchFileSnapshot(node_path_1.default.join(this.src, "hooks.snap.txt"), options);
+    }
+}
+exports.HookCasesContext = HookCasesContext;
 function createHookCase(name, src, dist, source) {
     const caseConfig = require(node_path_1.default.join(src, "test.js"));
     const testName = node_path_1.default.basename(name.slice(0, name.indexOf(node_path_1.default.extname(name))));
     const runner = (0, simple_1.getSimpleProcessorRunner)(source, dist, {
         env: () => env,
-        context: () => new processor_1.HookCasesContext(src, testName, {
+        context: () => new HookCasesContext(src, testName, {
             src: source,
             dist: dist,
             runnerFactory: runner_1.BasicRunnerFactory
         })
     });
     it(caseConfig.description, async () => {
-        await runner(name, new processor_1.HookTaskProcessor({
+        await runner(name, new processor_1.SnapshotProcessor({
             name,
             compilerType: type_1.ECompilerType.Rspack,
             findBundle: () => ["main.js"],
             snapshot: node_path_1.default.join(src, "output.snap.txt"),
-            runable: true,
-            ...caseConfig
+            runable: false,
+            defaultOptions: context => {
+                let defaultOptions = {
+                    context: context.getSource(),
+                    mode: "production",
+                    target: "async-node",
+                    devtool: false,
+                    cache: false,
+                    entry: "./hook",
+                    output: {
+                        path: context.getDist()
+                    },
+                    optimization: {
+                        minimize: false
+                    },
+                    experiments: {
+                        css: true,
+                        rspackFuture: {
+                            bundlerInfo: {
+                                force: false
+                            }
+                        },
+                        inlineConst: true,
+                        lazyBarrel: true
+                    }
+                };
+                if (caseConfig.options) {
+                    defaultOptions = (0, webpack_merge_1.default)(defaultOptions, caseConfig.options(context));
+                }
+                return defaultOptions;
+            },
+            overrideOptions: (context, options) => {
+                if (!global.printLogger) {
+                    options.infrastructureLogging = {
+                        level: "error"
+                    };
+                }
+            },
+            compiler: caseConfig.compiler,
+            check: async function (env, context, compiler, stats) {
+                await context.collectSnapshots(env);
+                await processor_1.SnapshotProcessor.prototype.check.call(this, env, context);
+                if (typeof caseConfig.check === "function") {
+                    await caseConfig.check(context);
+                }
+            },
+            snapshotFileFilter: caseConfig.snapshotFileFilter
         }));
     });
     const env = (0, createLazyTestEnv_1.default)(10000);

package/dist/case/hot-step.d.ts

@@ -1,2 +1,2 @@
-import { ECompilerType, type TCompilerOptions } from "../type";
+import type { ECompilerType, TCompilerOptions } from "../type";
 export declare function createHotStepCase(name: string, src: string, dist: string, target: TCompilerOptions<ECompilerType.Rspack>["target"]): void;