@rspack/test-tools 0.4.1 → 0.4.2

package/dist/compare/compare.js

@@ -87,6 +87,8 @@ function compareContent(sourceContent, distContent) {
                 const lines = sourceContent.trim().split("\n").length;
                 return {
                     type: type_1.ECompareResultType.Same,
+                    source: sourceContent,
+                    dist: distContent,
                     lines: {
                         source: lines,
                         common: lines,
@@ -100,6 +102,8 @@ function compareContent(sourceContent, distContent) {
                 return {
                     type: type_1.ECompareResultType.Different,
                     detail: difference,
+                    source: sourceContent,
+                    dist: distContent,
                     lines: {
                         source: diffLines.filter(l => l[0] < 0).length,
                         common: diffLines.filter(l => l[0] === 0).length,
@@ -111,6 +115,7 @@ function compareContent(sourceContent, distContent) {
         else {
             return {
                 type: type_1.ECompareResultType.OnlySource,
+                source: sourceContent,
                 lines: {
                     source: sourceContent.trim().split("\n").length,
                     common: 0,
@@ -123,6 +128,7 @@ function compareContent(sourceContent, distContent) {
         if (distContent) {
             return {
                 type: type_1.ECompareResultType.OnlyDist,
+                dist: distContent,
                 lines: {
                     source: 0,
                     common: 0,

package/dist/helper/parse-modules.js

@@ -32,7 +32,7 @@ function parseModules(content) {
     // parse bootstrap code
     const bootstrap = getStringBetween(content, 0, BOOTSTRAP_SPLIT_LINE, BOOTSTRAP_SPLIT_LINE);
     if (bootstrap.result) {
-        runtimeModules.set("webpack/bootstrap", bootstrap.result);
+        runtimeModules.set("webpack/runtime/bootstrap", bootstrap.result);
     }
     // parse module & runtime module code
     let moduleName = getStringBetween(content, currentPosition, MODULE_START_FLAG, MODULE_FLAG_END).result;

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./type";
 export * from "./test/tester";
-export * from "./processor/diff";
+export * from "./processor";
+export * from "./reporter";

package/dist/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./type"), exports);
 __exportStar(require("./test/tester"), exports);
-__exportStar(require("./processor/diff"), exports);
+__exportStar(require("./processor"), exports);
+__exportStar(require("./reporter"), exports);

package/dist/processor/index.d.ts

@@ -0,0 +1 @@
+export * from "./diff";

package/dist/processor/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("./diff"), exports);

package/dist/reporter/diff-html.d.ts

@@ -0,0 +1,15 @@
+import { ITestReporter, TModuleCompareResult } from "../type";
+export interface IDiffHtmlReporterOptions {
+    dist: string;
+    ignore?: RegExp;
+}
+export declare class DiffHtmlReporter implements ITestReporter<TModuleCompareResult[]> {
+    private options;
+    private failed;
+    private results;
+    constructor(options: IDiffHtmlReporterOptions);
+    init(data?: TModuleCompareResult[]): Promise<void>;
+    failure(id: string): Promise<void>;
+    increment(id: string, data: TModuleCompareResult[]): Promise<void>;
+    output(): Promise<void>;
+}

package/dist/reporter/diff-html.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DiffHtmlReporter = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const VIEWER_DIR = path_1.default.join(__dirname, "../viewer");
+const DIFF_STATS_PLACEHOLDER = "$$RSPACK_DIFF_STATS_PLACEHOLDER$$";
+const DEFAULT_IGNORE = /node_modules/;
+class DiffHtmlReporter {
+    constructor(options) {
+        this.options = options;
+        this.failed = new Set();
+        this.results = new Map();
+    }
+    async init(data = []) { }
+    async failure(id) {
+        this.failed.add(id);
+        this.results.delete(id);
+    }
+    async increment(id, data) {
+        if (this.failed.has(id))
+            return;
+        if (!this.results.has(id)) {
+            this.results.set(id, []);
+        }
+        const ignore = this.options.ignore || DEFAULT_IGNORE;
+        const current = this.results.get(id);
+        for (let i of data) {
+            if (!ignore.test(i.name)) {
+                current.push({
+                    name: i.name,
+                    source: i.source || "",
+                    dist: i.dist || "",
+                    type: i.type
+                });
+            }
+        }
+    }
+    async output() {
+        fs_extra_1.default.ensureDirSync(this.options.dist);
+        for (let viewerFile of fs_extra_1.default
+            .readdirSync(VIEWER_DIR)
+            .filter(file => file.startsWith("diff"))) {
+            const sourceFile = path_1.default.join(VIEWER_DIR, viewerFile);
+            if (path_1.default.extname(viewerFile) === ".html") {
+                const template = fs_extra_1.default.readFileSync(sourceFile, "utf-8");
+                for (let [id, items] of this.results.entries()) {
+                    const data = {
+                        root: id,
+                        data: items
+                    };
+                    const content = template.replace(DIFF_STATS_PLACEHOLDER, JSON.stringify(data));
+                    const casename = path_1.default.basename(id);
+                    const extname = path_1.default.extname(viewerFile);
+                    const filename = path_1.default.basename(viewerFile, extname);
+                    fs_extra_1.default.writeFileSync(path_1.default.join(this.options.dist, `${filename}_${casename}${extname}`), content, "utf-8");
+                }
+            }
+            else {
+                fs_extra_1.default.copyFileSync(sourceFile, path_1.default.join(this.options.dist, viewerFile));
+            }
+        }
+    }
+}
+exports.DiffHtmlReporter = DiffHtmlReporter;

package/dist/reporter/diff-stats.d.ts

@@ -0,0 +1,24 @@
+import { ECompilerType, ITestReporter, TModuleCompareResult } from "../type";
+export interface IDiffStatsReporterOptions {
+    header?: string[];
+    footer?: string[];
+    file: string;
+    report?: boolean;
+}
+export type TCompilerTypeId = ECompilerType.Rspack | ECompilerType.Webpack | "common";
+export type TModuleTypeId = "normal" | "runtime";
+export type TDimenTypeId = "modules" | "lines" | "lines-in-common";
+export type TCaseSummaryId = `${TCompilerTypeId}|${TModuleTypeId}|${TDimenTypeId}`;
+export type TCaseSummary = Record<TCaseSummaryId, number>;
+export declare class DiffStatsReporter implements ITestReporter<TModuleCompareResult[]> {
+    private options;
+    private summary;
+    private failed;
+    constructor(options: IDiffStatsReporterOptions);
+    init(data?: TModuleCompareResult[]): Promise<void>;
+    failure(id: string): Promise<void>;
+    increment(id: string, data: TModuleCompareResult[]): Promise<void>;
+    output(): Promise<void>;
+    private stringifySummary;
+    private createSummary;
+}

package/dist/reporter/diff-stats.js

@@ -0,0 +1,132 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DiffStatsReporter = void 0;
+const type_1 = require("../type");
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const csv_to_markdown_table_1 = __importDefault(require("csv-to-markdown-table"));
+const toPercent = (d) => (d * 100).toFixed(2) + "%";
+const toFirstLetterUpperCase = (s) => (s.charAt(0).toUpperCase() + s.slice(1)).split("-").join(" ");
+const GITHUB_RUN_ID = process.env.GITHUB_RUN_ID;
+class DiffStatsReporter {
+    constructor(options) {
+        this.options = options;
+        this.summary = new Map();
+        this.failed = new Set();
+    }
+    async init(data = []) { }
+    async failure(id) {
+        this.failed.add(id);
+        if (this.summary.has(id)) {
+            this.summary.delete(id);
+        }
+    }
+    async increment(id, data) {
+        var _a, _b, _c, _d, _e, _f;
+        if (this.failed.has(id))
+            return;
+        if (!this.summary.has(id)) {
+            this.summary.set(id, this.createSummary());
+        }
+        const current = this.summary.get(id);
+        for (let item of data) {
+            if (item.type === type_1.ECompareResultType.Missing)
+                continue;
+            const moduleType = item.name.startsWith("webpack/runtime")
+                ? "normal"
+                : "runtime";
+            // handle modules
+            if (item.type === type_1.ECompareResultType.OnlySource) {
+                current[`${type_1.ECompilerType.Rspack}|${moduleType}|${"modules"}`]++;
+            }
+            else if (item.type === type_1.ECompareResultType.OnlyDist) {
+                current[`${type_1.ECompilerType.Webpack}|${moduleType}|${"modules"}`]++;
+            }
+            else {
+                current[`${"common"}|${moduleType}|${"modules"}`]++;
+            }
+            // handle lines
+            current[`${type_1.ECompilerType.Rspack}|${moduleType}|${"lines"}`] +=
+                ((_a = item.lines) === null || _a === void 0 ? void 0 : _a.source) || 0;
+            current[`${type_1.ECompilerType.Webpack}|${moduleType}|${"lines"}`] +=
+                ((_b = item.lines) === null || _b === void 0 ? void 0 : _b.dist) || 0;
+            current[`${"common"}|${moduleType}|${"lines"}`] +=
+                ((_c = item.lines) === null || _c === void 0 ? void 0 : _c.common) || 0;
+            // handle lines in common modules
+            if (item.type === type_1.ECompareResultType.Same ||
+                item.type === type_1.ECompareResultType.Different) {
+                current[`${type_1.ECompilerType.Rspack}|${moduleType}|${"lines-in-common"}`] +=
+                    ((_d = item.lines) === null || _d === void 0 ? void 0 : _d.source) || 0;
+                current[`${type_1.ECompilerType.Webpack}|${moduleType}|${"lines-in-common"}`] += ((_e = item.lines) === null || _e === void 0 ? void 0 : _e.dist) || 0;
+                current[`${"common"}|${moduleType}|${"lines-in-common"}`] +=
+                    ((_f = item.lines) === null || _f === void 0 ? void 0 : _f.common) || 0;
+            }
+        }
+    }
+    async output() {
+        const chunks = [];
+        for (let [id, summary] of this.summary.entries()) {
+            chunks.push(this.stringifySummary(id, summary));
+        }
+        for (let id of this.failed.values()) {
+            chunks.push(`### ${id}\n\n> Failed\n\n`);
+        }
+        const output = [
+            ...(this.options.header || []),
+            chunks.join("\n---\n"),
+            ...(this.options.footer || [])
+        ].join("\n\n");
+        fs_extra_1.default.ensureFileSync(this.options.file);
+        fs_extra_1.default.writeFileSync(this.options.file, output);
+    }
+    stringifySummary(id, summary) {
+        let output = `### ${id}\n\n`;
+        for (let moduleType of ["runtime", "normal"]) {
+            const csv = [];
+            csv.push(`${moduleType.charAt(0).toUpperCase() + moduleType.slice(1)} Modules,Rspack Only,Common,Webpack Only,Common Percent`);
+            for (let dimen of [
+                "modules",
+                "lines",
+                "lines-in-common"
+            ]) {
+                const counts = [
+                    type_1.ECompilerType.Rspack,
+                    "common",
+                    type_1.ECompilerType.Webpack
+                ].map(i => summary[`${i}|${moduleType}|${dimen}`]);
+                csv.push(`${dimen === "lines-in-common"
+                    ? "Lines(Common Modules)"
+                    : toFirstLetterUpperCase(dimen)},${counts.join(",")},${toPercent(counts[1] / (counts[0] + counts[1] + counts[2]))}`);
+            }
+            output += (0, csv_to_markdown_table_1.default)(csv.join("\n"), ",", true);
+            output += "\n\n";
+        }
+        if (this.options.report && GITHUB_RUN_ID) {
+            output += `> [View diff report](https://web-infra-dev.github.io/rspack-report-website/diff/${GITHUB_RUN_ID}/diff_${id}.html)`;
+            output += "\n\n";
+        }
+        return output;
+    }
+    createSummary() {
+        let result = {};
+        for (let i of [
+            type_1.ECompilerType.Rspack,
+            type_1.ECompilerType.Webpack,
+            "common"
+        ]) {
+            for (let j of ["runtime", "normal"]) {
+                for (let k of [
+                    "modules",
+                    "lines",
+                    "lines-in-common"
+                ]) {
+                    result[`${i}|${j}|${k}`] = 0;
+                }
+            }
+        }
+        return result;
+    }
+}
+exports.DiffStatsReporter = DiffStatsReporter;

package/dist/reporter/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./diff-stats";
+export * from "./diff-html";

package/dist/reporter/index.js

@@ -0,0 +1,18 @@
+"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("./diff-stats"), exports);
+__exportStar(require("./diff-html"), exports);

package/dist/type.d.ts

@@ -54,6 +54,12 @@ export interface ITestProcessor {
     run?(context: ITestContext): Promise<void>;
     check?(context: ITestContext): Promise<unknown>;
 }
+export interface ITestReporter<T> {
+    init(data?: T): Promise<void>;
+    increment(id: string, data: T): Promise<void>;
+    failure(id: string): Promise<void>;
+    output(): Promise<void>;
+}
 export declare enum ECompareResultType {
     Same = "same",
     Missing = "missing",
@@ -65,6 +71,8 @@ export type TCompareModules = string[] | true;
 export type TCompareResult = {
     type: ECompareResultType;
     detail?: unknown;
+    source?: string;
+    dist?: string;
     lines?: {
         common: number;
         source: number;
@@ -81,3 +89,13 @@ export type TFileCompareResult = TCompareResult & {
     };
     modules: Partial<Record<"modules" | "runtimeModules", TModuleCompareResult[]>>;
 };
+export type TDiffStatsItem = {
+    name: string;
+    source: string;
+    dist: string;
+    type: ECompareResultType;
+};
+export type TDiffStats = {
+    root: string;
+    data: Array<TDiffStatsItem>;
+};

package/dist/type.js

@@ -5,7 +5,7 @@ var ECompilerType;
 (function (ECompilerType) {
     ECompilerType["Rspack"] = "rspack";
     ECompilerType["Webpack"] = "webpack";
-})(ECompilerType = exports.ECompilerType || (exports.ECompilerType = {}));
+})(ECompilerType || (exports.ECompilerType = ECompilerType = {}));
 var ECompareResultType;
 (function (ECompareResultType) {
     ECompareResultType["Same"] = "same";
@@ -13,4 +13,4 @@ var ECompareResultType;
     ECompareResultType["OnlyDist"] = "only-dist";
     ECompareResultType["OnlySource"] = "only-source";
     ECompareResultType["Different"] = "different";
-})(ECompareResultType = exports.ECompareResultType || (exports.ECompareResultType = {}));
+})(ECompareResultType || (exports.ECompareResultType = ECompareResultType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspack/test-tools",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "license": "MIT",
   "description": "Test tools for rspack",
   "main": "dist/index.js",
@@ -32,16 +32,31 @@
     "@babel/template": "7.22.15",
     "@babel/traverse": "7.23.2",
     "@babel/types": "7.23.0",
+    "csv-to-markdown-table": "^1.3.0",
     "deepmerge": "^4.3.1",
     "fs-extra": "^11.1.1",
     "jest-diff": "^29.7.0",
     "webpack-sources": "3.2.3",
-    "@rspack/core": "0.4.1"
+    "@rspack/core": "0.4.2"
   },
   "devDependencies": {
+    "@arco-design/web-react": "^2.56.1",
+    "@monaco-editor/react": "^4.6.0",
+    "@types/prettier": "^2.7.2",
+    "@types/react": "^18.0.25",
+    "@types/react-dom": "^18.0.8",
     "@types/webpack": "5.28.3",
     "@types/webpack-sources": "3.2.0",
-    "webpack": "5.89.0"
+    "core-js": "3.25.0",
+    "monaco-editor": "^0.34.1",
+    "normalize.css": "^8.0.0",
+    "prettier": "^2.8.3",
+    "react": "18.0.0",
+    "react-dom": "18.0.0",
+    "react-refresh": "0.13.0",
+    "typescript": "5.1.6",
+    "webpack": "5.89.0",
+    "@rspack/cli": "0.4.2"
   },
   "peerDependenciesMeta": {},
   "jest": {
@@ -53,6 +68,8 @@
   },
   "scripts": {
     "build": "rimraf dist/ && tsc -b ./tsconfig.build.json --force",
+    "build:viewer": "rspack build",
+    "dev:viewer": "rspack serve",
     "dev": "tsc -b -w"
   }
 }