@rspack-debug/test-tools 2.0.0-beta.1 → 2.0.0-beta.3

package/README.md

@@ -8,7 +8,7 @@
 
 Test tools for rspack.
 
-## Wasm Tests
+## Wasm tests
 
 We expect to reuse the tests for Rspack wasm target as many as possible and we have managed to do it partially. Currently wasm tests should be run with an environment variable `WASM=1` under the following limitations:
 

package/dist/case/common.js

@@ -12,8 +12,8 @@ exports.checkSnapshot = checkSnapshot;
 exports.afterExecute = afterExecute;
 exports.findMultiCompilerBundle = findMultiCompilerBundle;
 exports.configMultiCompiler = configMultiCompiler;
+const node_path_1 = __importDefault(require("node:path"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
-const path_1 = __importDefault(require("path"));
 const webpack_merge_1 = __importDefault(require("webpack-merge"));
 const helper_1 = require("../helper");
 const placeholder_1 = require("../helper/expect/placeholder");
@@ -97,7 +97,7 @@ async function check(env, context, name) {
     const options = compiler.getOptions();
     if (stats) {
         if (testConfig.writeStatsOuptut) {
-            fs_extra_1.default.writeFileSync(path_1.default.join(context.getDist(), 'stats.txt'), stats.toString({
+            fs_extra_1.default.writeFileSync(node_path_1.default.join(context.getDist(), 'stats.txt'), stats.toString({
                 preset: 'verbose',
                 colors: false,
             }), 'utf-8');
@@ -110,7 +110,7 @@ async function check(env, context, name) {
                 chunkGroups: true,
                 errorDetails: true,
             });
-            fs_extra_1.default.writeFileSync(path_1.default.join(context.getDist(), 'stats.json'), JSON.stringify(jsonStats, null, 2), 'utf-8');
+            fs_extra_1.default.writeFileSync(node_path_1.default.join(context.getDist(), 'stats.json'), JSON.stringify(jsonStats, null, 2), 'utf-8');
         }
         if (fs_extra_1.default.existsSync(context.getSource('errors.js')) ||
             fs_extra_1.default.existsSync(context.getSource('warnings.js')) ||
@@ -141,7 +141,7 @@ async function check(env, context, name) {
     }
 }
 async function checkSnapshot(env, context, name, snapshot, filter) {
-    if (path_1.default.extname(snapshot) === '.snap') {
+    if (node_path_1.default.extname(snapshot) === '.snap') {
         throw new Error('Snapshot with `.snap` will be managed by rstest, please use `.snap.txt` instead');
     }
     const compilerManager = context.getCompiler();
@@ -172,20 +172,20 @@ async function checkSnapshot(env, context, name, snapshot, filter) {
         const fileContents = Object.entries(compilation.assets)
             .filter(([file]) => snapshotFileFilter(file))
             .map(([file, source]) => {
-            const tag = path_1.default.extname(file).slice(1) || 'txt';
+            const tag = node_path_1.default.extname(file).slice(1) || 'txt';
             let content = (0, placeholder_1.normalizePlaceholder)(source.source().toString());
             const testConfig = context.getTestConfig();
             if (testConfig.snapshotContent) {
                 content = testConfig.snapshotContent(content);
             }
-            const filePath = file.replaceAll(path_1.default.sep, '/');
+            const filePath = file.replaceAll(node_path_1.default.sep, '/');
             return `\`\`\`${tag} title=${filePath}\n${content}\n\`\`\``;
         });
         fileContents.sort();
         const content = fileContents.join('\n\n');
-        const snapshotPath = path_1.default.isAbsolute(snapshot)
+        const snapshotPath = node_path_1.default.isAbsolute(snapshot)
             ? snapshot
-            : path_1.default.resolve(context.getSource(), path_1.default.join('__snapshots__', `${snapshot}${total > 1 ? `-${i}` : ''}`));
+            : node_path_1.default.resolve(context.getSource(), node_path_1.default.join('__snapshots__', `${snapshot}${total > 1 ? `-${i}` : ''}`));
         env.expect(content).toMatchFileSnapshotSync(snapshotPath);
     }
 }

package/dist/case/config.js

@@ -9,8 +9,8 @@ exports.defaultOptions = defaultOptions;
 exports.enableEsmLibraryPlugin = enableEsmLibraryPlugin;
 exports.overrideOptions = overrideOptions;
 exports.findBundle = findBundle;
+const node_path_1 = __importDefault(require("node:path"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
-const path_1 = __importDefault(require("path"));
 const parseResource_1 = require("../helper/legacy/parseResource");
 const creator_1 = require("../test/creator");
 const common_1 = require("./common");
@@ -115,15 +115,15 @@ function findBundle(index, context, options) {
     if (typeof testConfig.findBundle === 'function') {
         return testConfig.findBundle(index, options);
     }
-    const ext = path_1.default.extname((0, parseResource_1.parseResource)(options.output?.filename).path);
+    const ext = node_path_1.default.extname((0, parseResource_1.parseResource)(options.output?.filename).path);
     const bundlePath = [];
     if (options.output?.path &&
-        fs_extra_1.default.existsSync(path_1.default.join(options.output.path, `bundle${index}${ext}`))) {
-        const cssOutputPath = path_1.default.join(options.output.path, (typeof options.output?.cssFilename === 'string' &&
+        fs_extra_1.default.existsSync(node_path_1.default.join(options.output.path, `bundle${index}${ext}`))) {
+        const cssOutputPath = node_path_1.default.join(options.output.path, (typeof options.output?.cssFilename === 'string' &&
             options.output?.cssFilename) ||
             `bundle${index}.css`);
         if (fs_extra_1.default.existsSync(cssOutputPath)) {
-            bundlePath.push(path_1.default.relative(options.output.path, cssOutputPath));
+            bundlePath.push(node_path_1.default.relative(options.output.path, cssOutputPath));
         }
         bundlePath.push(`./bundle${index}${ext}`);
     }

package/dist/helper/legacy/findOutputFiles.js

@@ -1,7 +1,7 @@
 // @ts-nocheck
 'use strict';
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 /**
  * @param {{output: {path: string}}} options options
  * @param {RegExp} regexp regexp

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './case';
 export * from './helper';
 export * from './plugin';
+export * from './reporter';
 export * from './runner';
 export * from './test/context';
 export * from './test/creator';

package/dist/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./case"), exports);
 __exportStar(require("./helper"), exports);
 __exportStar(require("./plugin"), exports);
+__exportStar(require("./reporter"), exports);
 __exportStar(require("./runner"), exports);
 __exportStar(require("./test/context"), exports);
 __exportStar(require("./test/creator"), exports);

package/dist/reporter/index.d.ts

@@ -0,0 +1 @@
+export * from './streamed-events-reporter';

package/dist/reporter/index.js

@@ -0,0 +1,17 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./streamed-events-reporter"), exports);

package/dist/reporter/streamed-events-reporter.d.ts

@@ -0,0 +1,34 @@
+import type { Reporter, TestCaseInfo, TestFileInfo, TestResult, TestSuiteInfo } from '@rstest/core';
+/**
+ * Stream Rstest events to a file in real-time for inspecting how tests are executed.
+ *
+ * Event format: `<context> | <event_type> | <timestamp> [| <additional_fields>]`
+ *
+ * @example
+ * __GLOBAL__ | TEST_RUN_START | 2025-01-15T10:30:00.123Z
+ * tests/unit/example.test.ts | FILE_START | 2025-01-15T10:30:00.456Z
+ * tests/unit/example.test.ts | FILE_READY | 2025-01-15T10:30:00.789Z
+ * tests/unit/example.test.ts > Suite Name | SUITE_START | 2025-01-15T10:30:01.000Z
+ * tests/unit/example.test.ts > Suite Name > nested describe | SUITE_START | 2025-01-15T10:30:01.100Z
+ * tests/unit/example.test.ts > Suite Name > nested describe > should work | TEST_START | 2025-01-15T10:30:01.200Z
+ * tests/unit/example.test.ts > Suite Name > nested describe > should work | TEST_END | 2025-01-15T10:30:01.350Z | passed | 150ms
+ * tests/unit/example.test.ts > Suite Name > nested describe | SUITE_END | 2025-01-15T10:30:01.400Z | passed | 300ms
+ * tests/unit/example.test.ts > Suite Name | SUITE_END | 2025-01-15T10:30:01.500Z | passed | 500ms
+ * __GLOBAL__ | TEST_RUN_END | 2025-01-15T10:30:02.000Z
+ * */
+export declare class StreamedEventReporter implements Reporter {
+    private stream;
+    private outputPath;
+    constructor(outputPath?: string);
+    private write;
+    private formatTimestamp;
+    onTestRunStart(): void;
+    onTestFileStart(file: TestFileInfo): void;
+    onTestFileReady(file: TestFileInfo): void;
+    onTestSuiteStart(suite: TestSuiteInfo): void;
+    onTestSuiteResult(result: TestResult): void;
+    onTestCaseStart(test: TestCaseInfo): void;
+    onTestCaseResult(result: TestResult): void;
+    onTestRunEnd(): Promise<void>;
+    onExit(): void;
+}

package/dist/reporter/streamed-events-reporter.js

@@ -0,0 +1,120 @@
+"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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamedEventReporter = void 0;
+const fs = __importStar(require("node:fs"));
+const path = __importStar(require("node:path"));
+/**
+ * Stream Rstest events to a file in real-time for inspecting how tests are executed.
+ *
+ * Event format: `<context> | <event_type> | <timestamp> [| <additional_fields>]`
+ *
+ * @example
+ * __GLOBAL__ | TEST_RUN_START | 2025-01-15T10:30:00.123Z
+ * tests/unit/example.test.ts | FILE_START | 2025-01-15T10:30:00.456Z
+ * tests/unit/example.test.ts | FILE_READY | 2025-01-15T10:30:00.789Z
+ * tests/unit/example.test.ts > Suite Name | SUITE_START | 2025-01-15T10:30:01.000Z
+ * tests/unit/example.test.ts > Suite Name > nested describe | SUITE_START | 2025-01-15T10:30:01.100Z
+ * tests/unit/example.test.ts > Suite Name > nested describe > should work | TEST_START | 2025-01-15T10:30:01.200Z
+ * tests/unit/example.test.ts > Suite Name > nested describe > should work | TEST_END | 2025-01-15T10:30:01.350Z | passed | 150ms
+ * tests/unit/example.test.ts > Suite Name > nested describe | SUITE_END | 2025-01-15T10:30:01.400Z | passed | 300ms
+ * tests/unit/example.test.ts > Suite Name | SUITE_END | 2025-01-15T10:30:01.500Z | passed | 500ms
+ * __GLOBAL__ | TEST_RUN_END | 2025-01-15T10:30:02.000Z
+ * */
+class StreamedEventReporter {
+    constructor(outputPath) {
+        this.outputPath =
+            outputPath || path.join(process.cwd(), 'rstest-streamed-report.txt');
+        const dir = path.dirname(this.outputPath);
+        if (!fs.existsSync(dir)) {
+            fs.mkdirSync(dir, { recursive: true });
+        }
+        this.stream = fs.createWriteStream(this.outputPath, { flags: 'w' });
+    }
+    write(message) {
+        this.stream.write(`${message}\n`);
+    }
+    formatTimestamp() {
+        return new Date().toISOString();
+    }
+    onTestRunStart() {
+        this.write(`__GLOBAL__ | TEST_RUN_START | ${this.formatTimestamp()}`);
+    }
+    onTestFileStart(file) {
+        this.write(`${file.testPath} | FILE_START | ${this.formatTimestamp()}`);
+    }
+    onTestFileReady(file) {
+        this.write(`${file.testPath} | FILE_READY | ${this.formatTimestamp()}`);
+    }
+    onTestSuiteStart(suite) {
+        const suitePath = suite.parentNames
+            ? `${suite.parentNames.join(' > ')} > ${suite.name}`
+            : suite.name;
+        this.write(`${suite.testPath} > ${suitePath} | SUITE_START | ${this.formatTimestamp()}`);
+    }
+    onTestSuiteResult(result) {
+        const suitePath = result.parentNames
+            ? `${result.parentNames.join(' > ')} > ${result.name}`
+            : result.name;
+        this.write(`${result.testPath} > ${suitePath} | SUITE_END | ${this.formatTimestamp()} | ${result.status} | ${result.duration}ms`);
+    }
+    onTestCaseStart(test) {
+        const testPath = test.parentNames
+            ? `${test.parentNames.join(' > ')} > ${test.name}`
+            : test.name;
+        this.write(`${test.testPath} > ${testPath} | TEST_START | ${this.formatTimestamp()}`);
+    }
+    onTestCaseResult(result) {
+        const testPath = result.parentNames
+            ? `${result.parentNames.join(' > ')} > ${result.name}`
+            : result.name;
+        this.write(`${result.testPath} > ${testPath} | TEST_END | ${this.formatTimestamp()} | ${result.status} | ${result.duration}ms`);
+        if (result.errors && result.errors.length > 0) {
+            this.write(`${result.testPath} > ${testPath} | TEST_ERROR | ${this.formatTimestamp()} | ${result.errors[0].message}`);
+        }
+    }
+    async onTestRunEnd() {
+        this.write(`__GLOBAL__ | TEST_RUN_END | ${this.formatTimestamp()}`);
+        return new Promise((resolve) => {
+            this.stream.end(() => {
+                resolve();
+            });
+        });
+    }
+    onExit() {
+        this.stream.end();
+    }
+}
+exports.StreamedEventReporter = StreamedEventReporter;

package/dist/runner/web/index.js

@@ -118,8 +118,8 @@ class WebRunner extends node_1.NodeRunner {
                     finalCode = node_fs_1.default.readFileSync(filePath);
                 }
                 try {
-                    that.dom.window['__LINK_SHEET__'] ??= {};
-                    that.dom.window['__LINK_SHEET__'][url] = finalCode.toString();
+                    that.dom.window.__LINK_SHEET__ ??= {};
+                    that.dom.window.__LINK_SHEET__[url] = finalCode.toString();
                     return Promise.resolve(finalCode);
                 }
                 catch (err) {
@@ -196,7 +196,7 @@ class WebRunner extends node_1.NodeRunner {
         moduleScope.window = this.dom.window;
         moduleScope.document = this.dom.window.document;
         moduleScope.getLinkSheet = (link) => {
-            return this.dom.window['__LINK_SHEET__'][link.href];
+            return this.dom.window.__LINK_SHEET__[link.href];
         };
         return moduleScope;
     }
@@ -268,9 +268,9 @@ class WebRunner extends node_1.NodeRunner {
             .map((arg) => `window["${scopeKey}"]["${arg}"]`)
             .join(', ');
         this.dom.window[scopeKey] = currentModuleScope;
-        this.dom.window['__GLOBAL_SHARED__'] = this.globalContext;
-        this.dom.window['__LOCATED_ERROR__'] = locatedError;
-        this.dom.window['__FILE__'] = file;
+        this.dom.window.__GLOBAL_SHARED__ = this.globalContext;
+        this.dom.window.__LOCATED_ERROR__ = locatedError;
+        this.dom.window.__FILE__ = file;
         return [
             m,
             `${proxyCode}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspack-debug/test-tools",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-beta.3",
   "license": "MIT",
   "description": "Test tools for rspack",
   "main": "dist/index.js",
@@ -15,7 +15,9 @@
     "./package.json": "./package.json",
     "./helper/*": "./dist/helper/*.js",
     "./helper/legacy/*": "./dist/helper/legacy/*.js",
-    "./helper/util/*": "./dist/helper/util/*.js"
+    "./helper/util/*": "./dist/helper/util/*.js",
+    "./reporter": "./dist/reporter/index.js",
+    "./reporter/*": "./dist/reporter/*.js"
   },
   "files": [
     "client",
@@ -35,7 +37,7 @@
     "directory": "packages/rspack-test-tools"
   },
   "dependencies": {
-    "@babel/generator": "7.29.0",
+    "@babel/generator": "7.29.1",
     "@babel/parser": "7.29.0",
     "@babel/traverse": "7.29.0",
     "@babel/types": "7.29.0",
@@ -55,7 +57,7 @@
     "terser-webpack-plugin": "^5.3.16",
     "webpack": "5.102.1",
     "webpack-merge": "6.0.1",
-    "webpack-sources": "3.3.3",
+    "webpack-sources": "3.3.4",
     "chalk": "^4.1.2"
   },
   "devDependencies": {
@@ -65,15 +67,13 @@
     "@types/jsdom": "^21.1.7",
     "typescript": "^5.9.3",
     "wast-loader": "^1.14.1",
-    "@rspack/core": "npm:@rspack-debug/core@2.0.0-beta.1"
+    "@rspack/core": "npm:@rspack-debug/core@2.0.0-beta.3"
   },
   "peerDependencies": {
     "@rspack/core": ">=1.0.0"
   },
   "scripts": {
     "build": "tsc -b ./tsconfig.build.json",
-    "dev": "tsc -b -w",
-    "api-extractor": "api-extractor run --verbose",
-    "api-extractor:ci": "api-extractor run --verbose || diff temp/test-tools.api.md etc/test-tools.api.md"
+    "dev": "tsc -b -w"
   }
 }