test(snapshot): make snapshots cleaner and update path-serializer 0.3.4 (#8161)

* chore: update

* chore: upate

* chore: update

* chore: update

* chore: update

* chore: update

* chore: update

Author: SoonIter

biome.jsonc

@@ -33,6 +33,7 @@
 				"useKeyWithClickEvents": "off"
 			},
 			"complexity": {
+				"useArrowFunction": "off",
 				"noStaticOnlyClass": "off",
 				"noThisInStatic": "off",
 				"noBannedTypes": "off"

package.json

@@ -20,7 +20,7 @@
     "build:cli:release:win": "pnpm --filter @rspack/binding build:release:win && npm run build:js",
     "build:viewer": "pnpm --filter \"@rspack/*\" build:viewer",
     "test:js": "pnpm -r run test",
-    "format:rs": "pnpm --filter @rspack/core... build",
+    "format:rs": "cargo fmt --all",
     "format:js": "pnpm run format-ci:js --write",
     "format-ci:js": "node ./node_modules/prettier/bin/prettier.cjs \"packages/**/src/**/*.{ts,tsx,js}\" \"crates/rspack_plugin_runtime/**/*.{ts,js}\" \"scripts/**/*.{cjs,mjs,js}\"  \"x.mjs\" \"x\" --check",
     "format-ci:toml": "npx @taplo/cli format --check '.cargo/*.toml' './crates/**/Cargo.toml' './Cargo.toml'",

packages/rspack-test-tools/etc/test-tools.api.md

@@ -352,9 +352,6 @@ export class ErrorProcessor<T extends ECompilerType> extends SimpleTaskProcessor
     run(env: ITestEnv, context: ITestContext): Promise<void>;
 }
 
-// @public (undocumented)
-export function escapeEOL(str: string): string;
-
 // @public (undocumented)
 export function escapeSep(str: string): string;
 
@@ -1130,9 +1127,6 @@ export function readConfigFile<T extends ECompilerType>(files: string[], functio
 // @public (undocumented)
 export function replaceModuleArgument(raw: string): string;
 
-// @public (undocumented)
-export function replacePaths(input: string): any;
-
 // @public (undocumented)
 export function replaceRuntimeModuleName(name: string): string;
 
@@ -1194,6 +1188,8 @@ export class SnapshotProcessor<T extends ECompilerType> extends BasicProcessor<T
     // (undocumented)
     check(env: ITestEnv, context: ITestContext): Promise<void>;
     // (undocumented)
+    serializeEachFile(content: string): string;
+    // (undocumented)
     protected _snapshotOptions: ISnapshotProcessorOptions<T>;
 }
 

packages/rspack-test-tools/package.json

@@ -57,12 +57,11 @@
     "fs-extra": "^11.2.0",
     "glob": "^10.3.10",
     "jest-diff": "^29.7.0",
-    "jest-serializer-path": "^0.1.15",
     "jest-snapshot": "29.7.0",
     "jsdom": "^25.0.0",
     "memfs": "4.14.0",
     "mkdirp": "0.5.6",
-    "path-serializer": "0.1.2",
+    "path-serializer": "0.3.4",
     "pretty-format": "29.7.0",
     "rimraf": "3.0.2",
     "webpack": "^5.94.0",

packages/rspack-test-tools/src/helper/expect/char.ts

@@ -1,16 +1,19 @@
 import path from "node:path";
-const { createSnapshotSerializer } = require("path-serializer");
+import { createSnapshotSerializer } from "path-serializer";
 
+// 1. escapeEOL \r\n -> \n
+// 2. replace <RSPACK_ROOT> etc
+// 3. transform win32 sep
 const placeholderSerializer = createSnapshotSerializer({
-	workspace: path.resolve(__dirname, "../../../../../"),
+	root: path.resolve(__dirname, "../../../../../"),
 	replace: [
 		{
-			match: path.resolve(__dirname, "../../../rspack"),
-			mark: "rspack"
+			match: path.resolve(__dirname, "../../../"),
+			mark: "test_tools_root"
 		},
 		{
-			match: path.resolve(__dirname, "../../"),
-			mark: "test_tools"
+			match: path.resolve(__dirname, "../../../../rspack"),
+			mark: "rspack_root"
 		},
 		{
 			match: /:\d+:\d+-\d+:\d+/g,
@@ -22,8 +25,9 @@ const placeholderSerializer = createSnapshotSerializer({
 		}
 	],
 	features: {
+		replaceWorkspace: false,
 		addDoubleQuotes: false,
-		ansiDoubleQuotes: false
+		escapeDoubleQuotes: false
 	}
 });
 

packages/rspack-test-tools/src/helper/expect/placeholder.ts

@@ -3,5 +3,4 @@ export * from "./parse-modules";
 export * from "./read-config-file";
 export * from "./update-snapshot";
 export * from "./win";
-export * from "./replace-paths";
 export * from "./util/checkStats";

packages/rspack-test-tools/src/helper/index.ts

@@ -1,12 +1,10 @@
-import { normalizeCLR, normalizeCRLF, normalizeSlash } from "./expect/char";
 import { normalizeDiff } from "./expect/diff";
 import { normalizeDignostics, normalizeError } from "./expect/error";
 import { normalizePlaceholder } from "./expect/placeholder";
 import { normalizeStats } from "./expect/rspack";
 import { toBeTypeOf } from "./expect/to-be-typeof";
 import { toEndWith } from "./expect/to-end-with";
 import { toMatchFileSnapshot } from "./expect/to-match-file-snapshot";
-const { normalizePaths } = require("jest-serializer-path");
 
 expect.extend({
 	// CHANGE: new test matcher for `rspack-test-tools`
@@ -16,26 +14,12 @@ expect.extend({
 	toEndWith
 });
 
-const pipes = [
-	normalizeSlash,
-	normalizeCLR,
-	normalizeCRLF,
-	normalizePlaceholder,
-	normalizePaths
-];
-
-const serialize = (
-	str: string,
-	extra: Array<(str: string) => string> = []
-): string =>
-	[...pipes, ...extra].reduce((res, transform) => transform(res), str);
-
 expect.addSnapshotSerializer({
 	test(received) {
 		return typeof received === "string";
 	},
 	print(received) {
-		return serialize((received as string).trim());
+		return normalizePlaceholder((received as string).trim());
 	}
 });
 

packages/rspack-test-tools/src/helper/replace-paths.ts

@@ -3,7 +3,3 @@ import path from "node:path";
 export function escapeSep(str: string) {
 	return str.split(path.win32.sep).join(path.posix.sep);
 }
-
-export function escapeEOL(str: string) {
-	return str.split("\r\n").join("\n").trim();
-}

packages/rspack-test-tools/src/helper/setup-expect.ts

@@ -1,8 +1,7 @@
 import assert from "node:assert";
 import path from "node:path";
 
-import { escapeEOL } from "../helper";
-import { replacePaths } from "../helper/replace-paths";
+import { normalizePlaceholder } from "../helper/expect/placeholder";
 import type {
 	ECompilerType,
 	ITestContext,
@@ -34,13 +33,13 @@ export class DiagnosticProcessor<
 			throw new Error("Stats should exists");
 		}
 		assert(stats.hasErrors() || stats.hasWarnings());
-		let output = replacePaths(
+		let output = normalizePlaceholder(
 			stats.toString({
 				all: false,
 				errors: true,
 				warnings: true
 			})
-		);
+		).replaceAll("\\", "/"); // stats has some win32 paths that path-serializer can not handle
 
 		if (typeof this._diagnosticOptions.format === "function") {
 			output = this._diagnosticOptions.format(output);
@@ -49,7 +48,7 @@ export class DiagnosticProcessor<
 		const errorOutputPath = path.resolve(
 			context.getSource(this._diagnosticOptions.snapshot)
 		);
-		env.expect(escapeEOL(output)).toMatchFileSnapshot(errorOutputPath);
+		env.expect(output).toMatchFileSnapshot(errorOutputPath);
 	}
 
 	static defaultOptions<T extends ECompilerType>(

packages/rspack-test-tools/src/helper/win.ts

@@ -6,6 +6,7 @@ import {
 	format as prettyFormat
 } from "pretty-format";
 
+import { createSnapshotSerializer as createPathSerializer } from "path-serializer";
 import { type TTestContextOptions, TestContext } from "../test/context";
 import type {
 	ECompilerType,
@@ -16,8 +17,6 @@ import type {
 } from "../type";
 import { type ISnapshotProcessorOptions, SnapshotProcessor } from "./snapshot";
 
-const pathSerializer = require("jest-serializer-path");
-const normalizePaths = pathSerializer.normalizePaths;
 const srcDir = path.resolve(__dirname, "../../tests/fixtures");
 const distDir = path.resolve(__dirname, "../../tests/js/hook");
 
@@ -39,23 +38,18 @@ const internalSerializer = {
 	}
 };
 
-const testPathSerializer = {
-	test(val: unknown) {
-		return typeof val === "string";
-	},
-	print(val: string) {
-		return JSON.stringify(
-			normalizePaths(
-				// @ts-ignore
-				val
-					.split(srcDir)
-					.join("<HOOK_SRC_DIR>")
-					.split(distDir)
-					.join("<HOOK_DIST_DIR>")
-			)
-		);
-	}
-};
+const testPathSerializer = createPathSerializer({
+	replace: [
+		{
+			match: srcDir,
+			mark: "<HOOK_SRC_DIR>"
+		},
+		{
+			match: distDir,
+			mark: "<HOOK_DIST_DIR>"
+		}
+	]
+});
 
 const escapeRegex = true;
 const printFunctionName = false;

packages/rspack-test-tools/src/processor/diagnostic.ts

@@ -2,7 +2,8 @@ import path from "node:path";
 import fs from "fs-extra";
 
 import type { Chunk } from "webpack";
-import { escapeEOL, escapeSep, replacePaths } from "../helper";
+import { normalizePlaceholder } from "../helper/expect/placeholder";
+import { escapeSep } from "../helper/win";
 import type { THotStepRuntimeData } from "../runner";
 import type {
 	ECompilerType,
@@ -223,7 +224,7 @@ export class HotSnapshotProcessor<
 		}
 
 		const replaceContent = (str: string) => {
-			return replacePaths(
+			return normalizePlaceholder(
 				Object.entries(hashes)
 					.reduce((str, [raw, replacement]) => {
 						return str.split(raw).join(replacement);
@@ -400,6 +401,6 @@ ${runtime.javascript.disposedModules.map(i => `- ${i}`).join("\n")}
 
 				`.trim();
 
-		env.expect(escapeEOL(content)).toMatchFileSnapshot(snapshotPath);
+		env.expect(content).toMatchFileSnapshot(snapshotPath);
 	}
 }

packages/rspack-test-tools/src/processor/hook.ts

@@ -5,7 +5,6 @@ import type {
 	Compiler as WebpackCompiler
 } from "webpack";
 
-import { escapeEOL } from "../helper";
 import type { ECompilerType, ITestContext, ITestEnv } from "../type";
 import { BasicProcessor, type IBasicProcessorOptions } from "./basic";
 
@@ -56,12 +55,12 @@ export class SnapshotProcessor<
 			.filter(([file]) => snapshotFileFilter(file))
 			.map(([file, source]) => {
 				const tag = path.extname(file).slice(1) || "txt";
-				return `\`\`\`${tag} title=${file}\n${source
-					.source()
-					.toString()}\n\`\`\``;
+				const content = this.serializeEachFile(source.source().toString());
+
+				return `\`\`\`${tag} title=${file}\n${content}\n\`\`\``;
 			});
 		fileContents.sort();
-		const content = escapeEOL(fileContents.join("\n\n"));
+		const content = fileContents.join("\n\n");
 		const snapshotPath = path.isAbsolute(this._snapshotOptions.snapshot)
 			? this._snapshotOptions.snapshot
 			: path.resolve(
@@ -71,4 +70,8 @@ export class SnapshotProcessor<
 
 		env.expect(content).toMatchFileSnapshot(snapshotPath);
 	}
+
+	serializeEachFile(content: string): string {
+		return content;
+	}
 }

packages/rspack-test-tools/src/processor/hot-step.ts

@@ -2,7 +2,7 @@ import fs from "node:fs";
 import path from "node:path";
 import type { Compiler, Stats } from "@rspack/core";
 
-import { escapeEOL } from "../helper";
+import { normalizePlaceholder } from "../helper/expect/placeholder";
 import captureStdio from "../helper/legacy/captureStdio";
 import type {
 	ECompilerType,
@@ -63,7 +63,7 @@ export class StatsProcessor<
 							if (err) return callback(err);
 							if (!/\.(js|json|txt)$/.test(args[0]))
 								return callback(null, result);
-							callback(null, escapeEOL(result.toString("utf-8")));
+							callback(null, normalizePlaceholder(result.toString("utf-8")));
 						}
 					]) as Parameters<typeof ifs.readFile>
 				);

packages/rspack-test-tools/src/processor/snapshot.ts

@@ -1,3 +1,4 @@
+import { normalizePlaceholder } from "../helper/expect/placeholder";
 import type { ECompilerType, ITestContext, TCompilerOptions } from "../type";
 import { BuiltinProcessor } from "./builtin";
 import { type ISnapshotProcessorOptions, SnapshotProcessor } from "./snapshot";
@@ -27,4 +28,8 @@ export class TreeShakingProcessor<
 		options.optimization.innerGraph = true;
 		options.optimization.usedExports = true;
 	}
+
+	serializeEachFile(content: string): string {
+		return normalizePlaceholder(content);
+	}
 }