@rspack/test-tools 1.4.1 → 1.4.3

package/README.md

@@ -1,5 +1,5 @@
 <picture>
-  <img alt="Rspack Banner" src="https://assets.rspack.dev/rspack/rspack-banner.png">
+  <img alt="Rspack Banner" src="https://assets.rspack.rs/rspack/rspack-banner.png">
 </picture>
 
 # @rspack/test-tools
@@ -8,6 +8,19 @@
 
 Test tools for rspack.
 
+## 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:
+
+1. Node 20 is required, which is consistent with the Node version in StackBlitz.
+2. Set `maxWorkers` to `1`, `maxConcurrency` to `1` and disable concurrent mode to avoid flaky failures.
+3. `forceExit` is needed.
+
+Also check all the skipped testcases with `!process.env.WASM` in `test.filter.js`s and the skipped testsuits in `jest.config.js`s. They are divided into two categories:
+
+1. Skip due to lacks of api support, such as tests related to swc wasm plugins, pnp and profiling. We skip them to avoid obsolete snapshot errors.
+2. Skip temporarily and should be investigate in the future. There could be something wrong with test harness and rspack wasm itself. Since it could be time-consuming to figure out all of them so in this stage we use the wasm test ci to avoid the regression rather than improve its stability.
+
 ## Documentation
 
 See [https://rspack.rs](https://rspack.rs) for details.

package/dist/helper/setup-env.js

@@ -1,6 +1,11 @@
 "use strict";
-// @ts-nocheck
 Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
+const path = require("node:path");
+// Setup environment variable for binding testing
+if (process.env.RSPACK_BINDING_BUILDER_TESTING) {
+    process.env.RSPACK_BINDING = path.resolve(__dirname, "../../node_modules/@rspack/binding-testing");
+}
 if (process.env.ALTERNATIVE_SORT) {
     const oldSort = Array.prototype.sort;
     Array.prototype.sort = function (cmp) {

package/dist/helper/setup-wasm.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/helper/setup-wasm.js

@@ -0,0 +1,19 @@
+"use strict";
+// Skip all snapshot tests for wasm because:
+// 1. The wasm error backtrace bypasses emnapi.
+// 2. Wasm target is a 32-bit platform, where all hash results are diffeference from the native targets.
+Object.defineProperty(exports, "__esModule", { value: true });
+function toMatchSnapshot() {
+    return { pass: true, message: () => "" };
+}
+function toMatchInlineSnapshot() {
+    return { pass: true, message: () => "" };
+}
+function toMatchFileSnapshot() {
+    return { pass: true, message: () => "" };
+}
+expect.extend({
+    toMatchSnapshot,
+    toMatchInlineSnapshot,
+    toMatchFileSnapshot
+});

package/dist/processor/hot-step.js

@@ -136,7 +136,12 @@ class HotSnapshotProcessor extends hot_1.HotProcessor {
                 }
             }
         }
-        const replaceContent = (str) => {
+        const replaceContent = (rawStr) => {
+            let str = rawStr;
+            const replaceContentConfig = context.getTestConfig().snapshotContent;
+            if (replaceContentConfig) {
+                str = replaceContentConfig(str);
+            }
             return (0, placeholder_1.normalizePlaceholder)(Object.entries(hashes)
                 .reduce((str, [raw, replacement]) => {
                 return str.split(raw).join(replacement);

package/dist/processor/snapshot.js

@@ -45,7 +45,11 @@ class SnapshotProcessor extends basic_1.BasicProcessor {
             .filter(([file]) => snapshotFileFilter(file))
             .map(([file, source]) => {
             const tag = node_path_1.default.extname(file).slice(1) || "txt";
-            const content = this.serializeEachFile(source.source().toString());
+            let content = this.serializeEachFile(source.source().toString());
+            const testConfig = context.getTestConfig();
+            if (testConfig.snapshotContent) {
+                content = testConfig.snapshotContent(content);
+            }
             return `\`\`\`${tag} title=${file}\n${content}\n\`\`\``;
         });
         fileContents.sort();

package/dist/test/creator.js

@@ -31,7 +31,9 @@ class BasicCaseCreator {
         }
         const run = this.shouldRun(name);
         const tester = this.createTester(name, src, dist, temp, testConfig);
-        const concurrent = testConfig.concurrent ?? this._options.concurrent ?? false;
+        const concurrent = process.env.WASM
+            ? false
+            : testConfig.concurrent || this._options.concurrent;
         if (this._options.describe) {
             if (run) {
                 if (concurrent) {

package/dist/type.d.ts

@@ -148,6 +148,7 @@ export type TTestConfig<T extends ECompilerType> = {
     modules?: Record<string, Object>;
     timeout?: number;
     concurrent?: boolean;
+    snapshotContent?(content: string): string;
     checkSteps?: boolean;
 };
 export type TTestFilter<T extends ECompilerType> = (creatorConfig: Record<string, unknown>, testConfig: TTestConfig<T>) => boolean | string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspack/test-tools",
-  "version": "1.4.1",
+  "version": "1.4.3",
   "license": "MIT",
   "description": "Test tools for rspack",
   "main": "dist/index.js",
@@ -11,6 +11,7 @@
     },
     "./setup-expect": "./dist/helper/setup-expect.js",
     "./setup-env": "./dist/helper/setup-env.js",
+    "./setup-wasm": "./dist/helper/setup-wasm.js",
     "./package.json": "./package.json"
   },
   "files": [
@@ -95,9 +96,10 @@
     "typescript": "^5.8.3",
     "wast-loader": "^1.14.1",
     "worker-rspack-loader": "^3.1.2",
-    "@rspack/test-tools": "1.4.1",
-    "@rspack/cli": "1.4.1",
-    "@rspack/core": "1.4.1"
+    "@rspack/core": "1.4.3",
+    "@rspack/cli": "1.4.3",
+    "@rspack/binding-testing": "1.4.1",
+    "@rspack/test-tools": "1.4.3"
   },
   "peerDependencies": {
     "@rspack/core": ">=1.0.0"