@rspack-debug/test-tools 1.4.9 → 1.6.2

package/dist/runner/node/index.d.ts

@@ -0,0 +1,41 @@
+import type { RspackOptions, StatsCompilation } from "@rspack/core";
+import { type IGlobalContext, type IModuleScope, type ITestEnv, type ITestRunner, type TModuleObject, type TRunnerFile, type TRunnerRequirer, type TTestConfig } from "../../type";
+declare global {
+    var printLogger: boolean;
+}
+export interface INodeRunnerOptions {
+    env: ITestEnv;
+    stats?: () => StatsCompilation;
+    name: string;
+    runInNewContext?: boolean;
+    testConfig: TTestConfig;
+    source: string;
+    dist: string;
+    compilerOptions: RspackOptions;
+    cachable?: boolean;
+    logs?: string[];
+    errors?: Error[];
+}
+export declare class NodeRunner implements ITestRunner {
+    protected _options: INodeRunnerOptions;
+    protected requireCache: any;
+    protected globalContext: IGlobalContext | null;
+    protected baseModuleScope: IModuleScope | null;
+    protected requirers: Map<string, TRunnerRequirer>;
+    constructor(_options: INodeRunnerOptions);
+    protected log(message: string): void;
+    run(file: string): Promise<unknown>;
+    getRequire(): TRunnerRequirer;
+    getGlobal(name: string): unknown;
+    protected createGlobalContext(): IGlobalContext;
+    protected createBaseModuleScope(): IModuleScope;
+    protected createModuleScope(requireFn: TRunnerRequirer, m: TModuleObject, file: TRunnerFile): IModuleScope;
+    protected getFile(modulePath: string[] | string, currentDirectory: string): TRunnerFile | null;
+    protected preExecute(code: string, file: TRunnerFile): void;
+    protected postExecute(m: Object, file: TRunnerFile): void;
+    protected createRunner(): void;
+    protected createMissRequirer(): TRunnerRequirer;
+    protected createJsonRequirer(): TRunnerRequirer;
+    protected createCjsRequirer(): TRunnerRequirer;
+    protected createEsmRequirer(): TRunnerRequirer;
+}

package/dist/runner/node/index.js

@@ -0,0 +1,450 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeRunner = void 0;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const node_url_1 = require("node:url");
+const node_vm_1 = __importStar(require("node:vm"));
+const asModule_1 = __importDefault(require("../../helper/legacy/asModule"));
+const createFakeWorker_1 = __importDefault(require("../../helper/legacy/createFakeWorker"));
+const urlToRelativePath_1 = __importDefault(require("../../helper/legacy/urlToRelativePath"));
+const type_1 = require("../../type");
+const isRelativePath = (p) => /^\.\.?\//.test(p);
+const getSubPath = (p) => {
+    const lastSlash = p.lastIndexOf("/");
+    let firstSlash = p.indexOf("/");
+    if (lastSlash !== -1 && firstSlash !== lastSlash) {
+        if (firstSlash !== -1) {
+            let next = p.indexOf("/", firstSlash + 1);
+            let dir = p.slice(firstSlash + 1, next);
+            while (dir === ".") {
+                firstSlash = next;
+                next = p.indexOf("/", firstSlash + 1);
+                dir = p.slice(firstSlash + 1, next);
+            }
+        }
+        return p.slice(firstSlash + 1, lastSlash + 1);
+    }
+    return "";
+};
+const cached = new Map();
+class NodeRunner {
+    constructor(_options) {
+        this._options = _options;
+        this.requireCache = Object.create(null);
+        this.globalContext = null;
+        this.baseModuleScope = null;
+        this.requirers = new Map();
+    }
+    log(message) {
+        this._options.logs?.push(`[NodeRunner] ${message}`);
+    }
+    run(file) {
+        if (!this.globalContext) {
+            this.globalContext = this.createGlobalContext();
+        }
+        this.baseModuleScope = this.createBaseModuleScope();
+        if (typeof this._options.testConfig.moduleScope === "function") {
+            this._options.testConfig.moduleScope(this.baseModuleScope, this._options.stats, this._options.compilerOptions);
+        }
+        this.createRunner();
+        const res = this.getRequire()(node_path_1.default.isAbsolute(file) ? node_path_1.default.dirname(file) : this._options.dist, file.startsWith("./") ||
+            file.startsWith("https://test.cases/") ||
+            node_path_1.default.isAbsolute(file)
+            ? file
+            : `./${file}`);
+        if (typeof res === "object" && "then" in res) {
+            return res;
+        }
+        return Promise.resolve(res);
+    }
+    getRequire() {
+        const entryRequire = this.requirers.get("entry");
+        const runner = this;
+        return function (currentDirectory, modulePath, context = {}) {
+            const from = this?.from;
+            if (from) {
+                runner.log(`require: ${modulePath} from ${from}`);
+            }
+            else {
+                runner.log(`require: ${modulePath}`);
+            }
+            const p = Array.isArray(modulePath)
+                ? modulePath
+                : modulePath.split("?")[0];
+            return entryRequire(currentDirectory, p, context);
+        };
+    }
+    getGlobal(name) {
+        return (this.globalContext || {})[name];
+    }
+    createGlobalContext() {
+        return {
+            console: {
+                log: (...args) => {
+                    if (printLogger) {
+                        console.log(...args);
+                    }
+                },
+                warn: (...args) => {
+                    if (printLogger) {
+                        console.warn(...args);
+                    }
+                },
+                error: (...args) => {
+                    console.error(...args);
+                },
+                info: (...args) => {
+                    if (printLogger) {
+                        console.info(...args);
+                    }
+                },
+                debug: (...args) => {
+                    if (printLogger) {
+                        console.info(...args);
+                    }
+                },
+                trace: (...args) => {
+                    if (printLogger) {
+                        console.info(...args);
+                    }
+                },
+                assert: (...args) => {
+                    console.assert(...args);
+                },
+                clear: () => {
+                    console.clear();
+                }
+            },
+            setTimeout: ((cb, ms, ...args) => {
+                const timeout = setTimeout(cb, ms, ...args);
+                timeout.unref();
+                return timeout;
+            }),
+            clearTimeout: clearTimeout
+        };
+    }
+    createBaseModuleScope() {
+        const baseModuleScope = {
+            console: this.globalContext.console,
+            setTimeout: this.globalContext.setTimeout,
+            clearTimeout: this.globalContext.clearTimeout,
+            nsObj: (m) => {
+                Object.defineProperty(m, Symbol.toStringTag, {
+                    value: "Module"
+                });
+                return m;
+            },
+            process,
+            URL,
+            Blob,
+            Symbol,
+            Buffer,
+            setImmediate,
+            self: this.globalContext,
+            __TEST_PATH__: __TEST_PATH__,
+            __MODE__: this._options.compilerOptions.mode,
+            __SNAPSHOT__: node_path_1.default.join(this._options.source, "__snapshot__"),
+            Worker: (0, createFakeWorker_1.default)(this._options.env, {
+                outputDirectory: this._options.dist
+            }),
+            ...this._options.env
+        };
+        return baseModuleScope;
+    }
+    createModuleScope(requireFn, m, file) {
+        const requirer = requireFn.bind({
+            from: file.path,
+            module: m
+        }, node_path_1.default.dirname(file.path));
+        requirer.webpackTestSuiteRequire = true;
+        return {
+            ...this.baseModuleScope,
+            require: requirer,
+            module: m,
+            exports: m.exports,
+            __dirname: node_path_1.default.dirname(file.path),
+            __filename: file.path,
+            _globalAssign: {
+                expect: this._options.env.expect
+            }
+        };
+    }
+    getFile(modulePath, currentDirectory) {
+        const cacheKey = `${currentDirectory}|${modulePath}`;
+        if (this._options.cachable && cached.has(cacheKey)) {
+            return cached.get(cacheKey);
+        }
+        let res = null;
+        if (Array.isArray(modulePath)) {
+            res = {
+                path: node_path_1.default.join(currentDirectory, ".array-require.js"),
+                content: `module.exports = (${modulePath
+                    .map(arg => {
+                    return `require(${JSON.stringify(`./${arg}`)})`;
+                })
+                    .join(", ")});`,
+                subPath: ""
+            };
+        }
+        else if (modulePath.startsWith("https://test.cases/")) {
+            const relativePath = (0, urlToRelativePath_1.default)(modulePath);
+            const absPath = node_path_1.default.join(currentDirectory, relativePath);
+            res = {
+                path: absPath,
+                content: node_fs_1.default.readFileSync(absPath, "utf-8"),
+                subPath: ""
+            };
+        }
+        else if (isRelativePath(modulePath)) {
+            const p = node_path_1.default.join(currentDirectory, modulePath);
+            res = {
+                path: p,
+                content: node_fs_1.default.readFileSync(p, "utf-8"),
+                subPath: getSubPath(modulePath)
+            };
+        }
+        else if (node_path_1.default.isAbsolute(modulePath)) {
+            res = {
+                path: modulePath,
+                content: node_fs_1.default.readFileSync(modulePath, "utf-8"),
+                subPath: "absolute_path"
+            };
+        }
+        if (this._options.cachable && res) {
+            cached.set(cacheKey, res);
+        }
+        return res;
+    }
+    preExecute(code, file) { }
+    postExecute(m, file) { }
+    createRunner() {
+        this.requirers.set("cjs", this.createCjsRequirer());
+        this.requirers.set("esm", this.createEsmRequirer());
+        this.requirers.set("miss", this.createMissRequirer());
+        this.requirers.set("json", this.createJsonRequirer());
+        this.requirers.set("entry", (currentDirectory, modulePath, context) => {
+            const file = this.getFile(modulePath, currentDirectory);
+            this.log(`entry: ${modulePath} -> ${file?.path}`);
+            if (!file) {
+                return this.requirers.get("miss")(currentDirectory, modulePath);
+            }
+            if (file.path.endsWith(".json")) {
+                return this.requirers.get("json")(currentDirectory, modulePath, {
+                    ...context,
+                    file
+                });
+            }
+            if (file.path.endsWith(".mjs") &&
+                this._options.compilerOptions.experiments?.outputModule) {
+                return this.requirers.get("esm")(currentDirectory, modulePath, {
+                    ...context,
+                    file
+                });
+            }
+            return this.requirers.get("cjs")(currentDirectory, modulePath, {
+                ...context,
+                file
+            });
+        });
+    }
+    createMissRequirer() {
+        return (currentDirectory, modulePath, context = {}) => {
+            this.log(`missing: ${modulePath}`);
+            const modulePathStr = modulePath;
+            const modules = this._options.testConfig.modules;
+            if (modules && modulePathStr in modules) {
+                this.log(`mock module: ${modulePathStr}`);
+                return modules[modulePathStr];
+            }
+            this.log(`native require: ${modulePathStr}`);
+            return require(modulePathStr.startsWith("node:")
+                ? modulePathStr.slice(5)
+                : modulePathStr);
+        };
+    }
+    createJsonRequirer() {
+        return (currentDirectory, modulePath, context = {}) => {
+            if (Array.isArray(modulePath)) {
+                throw new Error("Array module path is not supported in hot cases");
+            }
+            const file = context.file || this.getFile(modulePath, currentDirectory);
+            this.log(`json: ${modulePath} -> ${file?.path}`);
+            if (!file) {
+                return this.requirers.get("miss")(currentDirectory, modulePath);
+            }
+            return JSON.parse(node_fs_1.default.readFileSync(node_path_1.default.join(this._options.dist, modulePath), "utf-8"));
+        };
+    }
+    createCjsRequirer() {
+        return (currentDirectory, modulePath, context = {}) => {
+            if (modulePath === "@rspack/test-tools") {
+                return require("@rspack/test-tools");
+            }
+            const file = context.file || this.getFile(modulePath, currentDirectory);
+            this.log(`cjs: ${modulePath} -> ${file?.path}`);
+            if (!file) {
+                return this.requirers.get("miss")(currentDirectory, modulePath);
+            }
+            if (file.path in this.requireCache) {
+                this.log(`cjs cache hit: ${file.path}`);
+                return this.requireCache[file.path].exports;
+            }
+            const m = {
+                exports: {},
+                webpackTestSuiteModule: true
+            };
+            this.requireCache[file.path] = m;
+            if (!this._options.runInNewContext) {
+                file.content = `Object.assign(global, _globalAssign);${file.content}`;
+            }
+            const currentModuleScope = this.createModuleScope(this.getRequire(), m, file);
+            if (this._options.testConfig.moduleScope) {
+                this._options.testConfig.moduleScope(currentModuleScope, this._options.stats, this._options.compilerOptions);
+            }
+            if (file.content.includes("__STATS__") && this._options.stats) {
+                currentModuleScope.__STATS__ = this._options.stats();
+            }
+            if (file.content.includes("__STATS_I__")) {
+                const statsIndex = this._options.stats?.()?.__index__;
+                if (typeof statsIndex === "number") {
+                    currentModuleScope.__STATS_I__ = statsIndex;
+                }
+            }
+            const args = Object.keys(currentModuleScope);
+            const argValues = args.map(arg => currentModuleScope[arg]);
+            const code = `(function(${args.join(", ")}) {
+				${file.content}
+      })`;
+            this.preExecute(code, file);
+            this.log(`run mode: ${this._options.runInNewContext ? "new context" : "this context"}`);
+            try {
+                const fn = this._options.runInNewContext
+                    ? node_vm_1.default.runInNewContext(code, this.globalContext, {
+                        filename: file.path,
+                        lineOffset: -1
+                    })
+                    : node_vm_1.default.runInThisContext(code, {
+                        filename: file.path,
+                        lineOffset: -1
+                    });
+                fn.call(this._options.testConfig.nonEsmThis
+                    ? this._options.testConfig.nonEsmThis(modulePath)
+                    : m.exports, ...argValues);
+            }
+            catch (e) {
+                this._options.errors?.push(e);
+                throw e;
+            }
+            this.postExecute(m, file);
+            this.log(`end cjs: ${modulePath}`);
+            return m.exports;
+        };
+    }
+    createEsmRequirer() {
+        const esmContext = node_vm_1.default.createContext(this.baseModuleScope, {
+            name: "context for esm"
+        });
+        const esmCache = new Map();
+        const esmIdentifier = this._options.name;
+        return (currentDirectory, modulePath, context = {}) => {
+            if (!node_vm_1.SourceTextModule) {
+                throw new Error("Running this test requires '--experimental-vm-modules'.\nRun with 'node --experimental-vm-modules node_modules/@rstest/core/bin/rstest'.");
+            }
+            const _require = this.getRequire();
+            const file = context.file || this.getFile(modulePath, currentDirectory);
+            this.log(`esm: ${modulePath} -> ${file?.path}`);
+            if (!file) {
+                return this.requirers.get("miss")(currentDirectory, modulePath);
+            }
+            if (file.content.includes("__STATS__")) {
+                esmContext.__STATS__ = this._options.stats?.();
+            }
+            if (file.content.includes("__STATS_I__")) {
+                const statsIndex = this._options.stats?.()?.__index__;
+                if (typeof statsIndex === "number") {
+                    esmContext.__STATS_I__ = statsIndex;
+                }
+            }
+            let esm = esmCache.get(file.path);
+            if (!esm) {
+                esm = new node_vm_1.SourceTextModule(file.content, {
+                    identifier: `${esmIdentifier}-${file.path}`,
+                    // no attribute
+                    url: `${(0, node_url_1.pathToFileURL)(file.path).href}?${esmIdentifier}`,
+                    context: esmContext,
+                    initializeImportMeta: (meta, _) => {
+                        meta.url = (0, node_url_1.pathToFileURL)(file.path).href;
+                        meta.dirname = node_path_1.default.dirname(file.path);
+                        meta.filename = file.path;
+                    },
+                    importModuleDynamically: async (specifier, module) => {
+                        this.log(`import: ${specifier} from ${file?.path}`);
+                        const result = await _require(node_path_1.default.dirname(file.path), specifier, {
+                            esmMode: type_1.EEsmMode.Evaluated
+                        });
+                        return await (0, asModule_1.default)(result, module.context);
+                    }
+                });
+                esmCache.set(file.path, esm);
+            }
+            if (context.esmMode === type_1.EEsmMode.Unlinked)
+                return esm;
+            return (async () => {
+                if (esm.status === "unlinked") {
+                    await esm.link(async (specifier, referencingModule) => {
+                        return await (0, asModule_1.default)(await _require(node_path_1.default.dirname(referencingModule.identifier
+                            ? referencingModule.identifier.slice(esmIdentifier.length + 1)
+                            : (0, node_url_1.fileURLToPath)(referencingModule.url)), specifier, {
+                            esmMode: type_1.EEsmMode.Unlinked
+                        }), referencingModule.context, true);
+                    });
+                }
+                await esm.evaluate();
+                if (context.esmMode === type_1.EEsmMode.Evaluated) {
+                    return esm;
+                }
+                const ns = esm.namespace;
+                this.log(`end esm: ${modulePath}`);
+                return ns.default && ns.default instanceof Promise ? ns.default : ns;
+            })();
+        };
+    }
+}
+exports.NodeRunner = NodeRunner;

package/dist/runner/web/index.d.ts

@@ -0,0 +1,30 @@
+import type { TRunnerFile, TRunnerRequirer } from "../../type";
+import { type INodeRunnerOptions, NodeRunner } from "../node";
+export interface IWebRunnerOptions extends INodeRunnerOptions {
+    location: string;
+}
+export declare class WebRunner extends NodeRunner {
+    protected _webOptions: IWebRunnerOptions;
+    private dom;
+    constructor(_webOptions: IWebRunnerOptions);
+    run(file: string): Promise<unknown>;
+    getGlobal(name: string): unknown;
+    protected log(message: string): void;
+    protected createResourceLoader(): {
+        fetch(url: string, options: {
+            element: HTMLScriptElement;
+        }): any;
+    };
+    private urlToPath;
+    protected createBaseModuleScope(): import("../../type").IModuleScope;
+    protected getModuleContent(file: TRunnerFile): [
+        {
+            exports: Record<string, unknown>;
+        },
+        string,
+        number
+    ];
+    protected createJSDOMRequirer(): TRunnerRequirer;
+    protected createRunner(): void;
+}
+export declare const createLocatedError: (collectedErrors: Error[], offset: number) => (e: Error, file: TRunnerFile) => Error;