@rspack/test-tools 1.5.6 → 1.5.7

package/dist/case/hook.js

@@ -3,33 +3,215 @@ 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 common_1 = require("./common");
+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");
 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
+            dist: dist
         })
     });
     it(caseConfig.description, async () => {
-        await runner(name, new processor_1.HookTaskProcessor({
-            name,
-            compilerType: type_1.ECompilerType.Rspack,
-            findBundle: () => ["main.js"],
-            snapshot: node_path_1.default.join(src, "output.snap.txt"),
-            runable: true,
-            ...caseConfig
-        }));
+        await runner(name, {
+            config: async (context) => {
+                const compiler = (0, common_1.getCompiler)(context, name);
+                const options = await (0, common_1.config)(context, name, ["rspack.config.js", "webpack.config.js"], defaultOptions(context, caseConfig.options));
+                if (!global.printLogger) {
+                    options.infrastructureLogging = {
+                        level: "error"
+                    };
+                }
+                compiler.setOptions(options);
+            },
+            compiler: async (context) => {
+                const c = await (0, common_1.compiler)(context, name);
+                if (caseConfig.compiler) {
+                    await caseConfig.compiler(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 (0, common_1.checkSnapshot)(env, context, name, node_path_1.default.join(src, "output.snap.txt"), caseConfig.snapshotFileFilter);
+            }
+        });
     });
     const env = (0, createLazyTestEnv_1.default)(10000);
 }
+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 defaultOptions(context, custom) {
+    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 (custom) {
+        defaultOptions = (0, webpack_merge_1.default)(defaultOptions, custom(context));
+    }
+    return defaultOptions;
+}

package/dist/case/hot-step.js

@@ -1,11 +1,311 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createHotStepCase = createHotStepCase;
-const hot_step_1 = require("../processor/hot-step");
-const runner_1 = require("../runner");
+const node_path_1 = __importDefault(require("node:path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const helper_1 = require("../helper");
+const placeholder_1 = require("../helper/expect/placeholder");
 const creator_1 = require("../test/creator");
 const type_1 = require("../type");
+const common_1 = require("./common");
+const hot_1 = require("./hot");
+const NOOP_SET = new Set();
+const escapeLocalName = (str) => str.split(/[-<>:"/|?*.]/).join("_");
+const SELF_HANDLER = (file, options) => {
+    let res = [];
+    const hotUpdateGlobal = (_, modules) => {
+        res = Object.keys(modules);
+    };
+    const hotUpdateGlobalKey = escapeLocalName(`${options.output?.hotUpdateGlobal || "webpackHotUpdate"}${options.output?.uniqueName || ""}`);
+    global.self ??= {};
+    global.self[hotUpdateGlobalKey] = hotUpdateGlobal;
+    require(file);
+    delete global.self[hotUpdateGlobalKey];
+    if (!Object.keys(global.self).length) {
+        delete global.self;
+    }
+    return res;
+};
+const NODE_HANDLER = (file) => {
+    return Object.keys(require(file).modules) || [];
+};
+const GET_MODULE_HANDLER = {
+    web: SELF_HANDLER,
+    webworker: SELF_HANDLER,
+    "async-node": NODE_HANDLER,
+    node: NODE_HANDLER
+};
 const creators = new Map();
+function createHotStepProcessor(name, target) {
+    const processor = (0, hot_1.createHotProcessor)(name, target);
+    const entries = {};
+    const hashes = [];
+    function matchStepSnapshot(env, context, step, options, stats, runtime) {
+        const getModuleHandler = GET_MODULE_HANDLER[options.target];
+        env.expect(typeof getModuleHandler).toBe("function");
+        const lastHash = hashes[hashes.length - 1];
+        const snapshotPath = context.getSource(`__snapshots__/${options.target}/${step}.snap.txt`);
+        const title = `Case ${node_path_1.default.basename(name)}: Step ${step}`;
+        const hotUpdateFile = [];
+        const hotUpdateManifest = [];
+        const changedFiles = step === 0
+            ? []
+            : processor.hotUpdateContext.changedFiles.map((i) => (0, helper_1.escapeSep)(node_path_1.default.relative(context.getSource(), i)));
+        changedFiles.sort();
+        const resultHashes = {
+            [lastHash || "LAST_HASH"]: "LAST_HASH",
+            [stats.hash]: "CURRENT_HASH"
+        };
+        // TODO: find a better way
+        // replace [runtime] to [runtime of id] to prevent worker hash
+        const runtimes = {};
+        for (const [id, runtime] of Object.entries(entries)) {
+            if (typeof runtime === "string") {
+                if (runtime !== id) {
+                    runtimes[runtime] = `[runtime of ${id}]`;
+                }
+            }
+            else if (Array.isArray(runtime)) {
+                for (const r of runtime) {
+                    if (r !== id) {
+                        runtimes[r] = `[runtime of ${id}]`;
+                    }
+                }
+            }
+        }
+        const replaceContent = (rawStr) => {
+            let str = rawStr;
+            const replaceContentConfig = context.getTestConfig().snapshotContent;
+            if (replaceContentConfig) {
+                str = replaceContentConfig(str);
+            }
+            return (0, placeholder_1.normalizePlaceholder)(Object.entries(resultHashes)
+                .reduce((str, [raw, replacement]) => {
+                return str.split(raw).join(replacement);
+            }, str)
+                .replace(/\/\/ (\d+)\s+(?=var cssReload)/, "")
+                .replaceAll(/var data = "(?:.*)"/g, match => {
+                return decodeURIComponent(match).replaceAll(/\\/g, "/");
+            }));
+        };
+        const replaceFileName = (str) => {
+            return Object.entries({
+                ...resultHashes,
+                ...runtimes
+            }).reduce((str, [raw, replacement]) => {
+                return str.split(raw).join(replacement);
+            }, str);
+        };
+        const fileList = stats
+            .assets.map(i => {
+            const fileName = i.name;
+            const renderName = replaceFileName(fileName);
+            const content = replaceContent(fs_extra_1.default.readFileSync(context.getDist(fileName), "utf-8"));
+            if (fileName.endsWith("hot-update.js")) {
+                const modules = getModuleHandler(context.getDist(fileName), options);
+                const runtime = [];
+                for (const i of content.matchAll(/\/\/ (webpack\/runtime\/[\w_-]+)\s*\n/g)) {
+                    runtime.push(i[1]);
+                }
+                modules.sort();
+                runtime.sort();
+                hotUpdateFile.push({
+                    name: renderName,
+                    content,
+                    modules,
+                    runtime
+                });
+                return `- Update: ${renderName}, size: ${content.length}`;
+            }
+            if (fileName.endsWith("hot-update.json")) {
+                const manifest = JSON.parse(content);
+                manifest.c?.sort();
+                manifest.r?.sort();
+                manifest.m?.sort();
+                hotUpdateManifest.push({
+                    name: renderName,
+                    content: JSON.stringify(manifest)
+                });
+                return `- Manifest: ${renderName}, size: ${i.size}`;
+            }
+            if (fileName.endsWith(".js")) {
+                return `- Bundle: ${renderName}`;
+            }
+        })
+            .filter(Boolean);
+        fileList.sort();
+        hotUpdateManifest.sort((a, b) => (a.name > b.name ? 1 : -1));
+        hotUpdateFile.sort((a, b) => (a.name > b.name ? 1 : -1));
+        if (runtime?.javascript) {
+            runtime.javascript.outdatedModules.sort();
+            runtime.javascript.updatedModules.sort();
+            runtime.javascript.updatedRuntime.sort();
+            runtime.javascript.acceptedModules.sort();
+            runtime.javascript.disposedModules.sort();
+            for (const value of Object.values(runtime.javascript.outdatedDependencies)) {
+                value.sort();
+            }
+        }
+        const content = `
+# ${title}
+
+## Changed Files
+${changedFiles.map(i => `- ${i}`).join("\n")}
+
+## Asset Files
+${fileList.join("\n")}
+
+## Manifest
+${hotUpdateManifest
+            .map(i => `
+### ${i.name}
+
+\`\`\`json
+${i.content}
+\`\`\`
+`)
+            .join("\n\n")}
+
+## Update
+
+${hotUpdateFile
+            .map(i => `
+### ${i.name}
+
+#### Changed Modules
+${i.modules.map(i => `- ${i}`).join("\n")}
+
+#### Changed Runtime Modules
+${i.runtime.map(i => `- ${i}`).join("\n")}
+
+#### Changed Content
+\`\`\`js
+${i.content}
+\`\`\`
+`)
+            .join("\n\n")}
+
+
+${runtime
+            ? `
+## Runtime
+### Status
+
+\`\`\`txt
+${runtime.statusPath.join(" => ")}
+\`\`\`
+
+${runtime.javascript
+                ? `
+
+### JavaScript
+
+#### Outdated
+
+Outdated Modules:
+${runtime.javascript.outdatedModules.map(i => `- ${i}`).join("\n")}
+
+
+Outdated Dependencies:
+\`\`\`json
+${JSON.stringify(runtime.javascript.outdatedDependencies || {}, null, 2)}
+\`\`\`
+
+#### Updated
+
+Updated Modules:
+${runtime.javascript.updatedModules.map(i => `- ${i}`).join("\n")}
+
+Updated Runtime:
+${runtime.javascript.updatedRuntime.map(i => `- \`${i}\``).join("\n")}
+
+
+#### Callback
+
+Accepted Callback:
+${runtime.javascript.acceptedModules.map(i => `- ${i}`).join("\n")}
+
+Disposed Callback:
+${runtime.javascript.disposedModules.map(i => `- ${i}`).join("\n")}
+`
+                : ""}
+
+`
+            : ""}
+
+				`
+            .replaceAll(/%3A(\d+)%2F/g, (match, capture) => {
+            return match.replace(capture, "PORT");
+        })
+            .trim();
+        env.expect(content).toMatchFileSnapshot(snapshotPath);
+    }
+    const originRun = processor.run;
+    processor.run = async function (env, context) {
+        context.setValue(name, "hotUpdateStepChecker", (hotUpdateContext, stats, runtime) => {
+            const statsJson = stats.toJson({
+                assets: true,
+                chunks: true
+            });
+            const chunks = Array.from(
+            // Some chunk fields are missing from rspack
+            stats?.compilation.chunks || NOOP_SET);
+            for (const entry of chunks.filter(i => i.hasRuntime())) {
+                if (!entries[entry.id] && entry.runtime) {
+                    entries[entry.id] =
+                        // Webpack uses `string | SortableSet<string>` for `entry.runtime`
+                        typeof entry.runtime === "string"
+                            ? [entry.runtime]
+                            : Array.from(entry.runtime);
+                }
+            }
+            const compiler = context.getCompiler(name, type_1.ECompilerType.Rspack);
+            const compilerOptions = compiler.getOptions();
+            matchStepSnapshot(env, context, hotUpdateContext.updateIndex, compilerOptions, statsJson, runtime);
+            hashes.push(stats.hash);
+        });
+        context.setValue(name, "hotUpdateStepErrorChecker", (_, stats, runtime) => {
+            hashes.push(stats.hash);
+        });
+        await originRun(env, context);
+    };
+    processor.check = async function (env, context) {
+        const compiler = (0, common_1.getCompiler)(context, name);
+        const stats = compiler.getStats();
+        if (!stats || !stats.hash) {
+            env.expect(false);
+            return;
+        }
+        const statsJson = stats.toJson({ assets: true, chunks: true });
+        const chunks = Array.from(
+        // Some chunk fields are missing from rspack
+        stats?.compilation.chunks || NOOP_SET);
+        for (const entry of chunks.filter(i => i.hasRuntime())) {
+            if (entry.runtime) {
+                entries[entry.id] =
+                    // Webpack uses `string | SortableSet<string>` for `entry.runtime`
+                    typeof entry.runtime === "string"
+                        ? [entry.runtime]
+                        : Array.from(entry.runtime);
+            }
+        }
+        let matchFailed = null;
+        try {
+            matchStepSnapshot(env, context, 0, compiler.getOptions(), statsJson);
+        }
+        catch (e) {
+            matchFailed = e;
+        }
+        hashes.push(stats.hash);
+        if (matchFailed) {
+            throw matchFailed;
+        }
+    };
+    return processor;
+}
 function getCreator(target) {
     if (!creators.has(target)) {
         creators.set(target, new creator_1.BasicCaseCreator({
@@ -13,14 +313,12 @@ function getCreator(target) {
             describe: false,
             target,
             steps: ({ name, target }) => [
-                new hot_step_1.HotSnapshotProcessor({
-                    name,
-                    target: target,
-                    compilerType: type_1.ECompilerType.Rspack,
-                    configFiles: ["rspack.config.js", "webpack.config.js"]
-                })
+                createHotStepProcessor(name, target)
             ],
-            runner: runner_1.HotRunnerFactory,
+            runner: {
+                key: (context, name, file) => name,
+                runner: hot_1.createHotRunner
+            },
             concurrent: true
         }));
     }

package/dist/case/hot.d.ts

@@ -1,2 +1,9 @@
-import { ECompilerType, type TCompilerOptions } from "../type";
+import { type ECompilerType, type ITestContext, type ITestEnv, type ITestProcessor, type ITestRunner, type TCompilerOptions, type THotUpdateContext } from "../type";
+type TTarget = TCompilerOptions<ECompilerType.Rspack>["target"];
+export declare function createHotProcessor(name: string, target: TTarget, incremental?: boolean): THotProcessor;
 export declare function createHotCase(name: string, src: string, dist: string, target: TCompilerOptions<ECompilerType.Rspack>["target"]): void;
+type THotProcessor = ITestProcessor & {
+    hotUpdateContext: THotUpdateContext;
+};
+export declare function createHotRunner<T extends ECompilerType = ECompilerType.Rspack>(context: ITestContext, name: string, file: string, env: ITestEnv): ITestRunner;
+export {};