feat: add setters for errors and warnings in Compilation

web-infra-dev · Oct 14, 2024 · b2811e2 · b2811e2
1 parent 69e3bc3
commit b2811e2
Show file tree

Hide file tree

Showing 4 changed files with 102 additions and 0 deletions.
diff --git a/packages/rspack-test-tools/tests/errorCases/error-test-set.js b/packages/rspack-test-tools/tests/errorCases/error-test-set.js
@@ -0,0 +1,38 @@
+/** @type {import('../..').TErrorCaseConfig} */
+module.exports = {
+ description: "Testing set errors",
+ options() {
+ return {
+ entry: "./resolve-fail-esm",
+ plugins: [
+ compiler => {
+ compiler.hooks.afterCompile.tap("set errors", compilation => {
+ compilation.errors = [
+ new Error("error 1"),
+ new Error("error 2")
+ ];
+ });
+ }
+ ]
+ };
+ },
+ async check(diagnostics) {
+ expect(diagnostics).toMatchInlineSnapshot(`
+ Object {
+ "errors": Array [
+ Object {
+ "message": " × Error: error 1\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n",
+ "moduleTrace": Array [],
+ "stack": "Error: error 1\\n at Object.fn (<cwd>packages/rspack-test-tools/tests/errorCases/error-test-set.js:<line>:<col>)\\n at next (<cwd>node_modules/.pnpm/@rspack+lite-tapable@1.0.1/node_modules/@rspack/lite-tapable/dist/index.js:<line>:<col>)\\n at AsyncSeriesHook.callAsyncStageRange (<cwd>node_modules/.pnpm/@rspack+lite-tapable@1.0.1/node_modules/@rspack/lite-tapable/dist/index.js:<line>:<col>)\\n at AsyncSeriesHook.callAsync (<cwd>node_modules/.pnpm/@rspack+lite-tapable@1.0.1/node_modules/@rspack/lite-tapable/dist/index.js:<line>:<col>)\\n at <cwd>packages/rspack/dist/index.js:<line>:<col>\\n at <cwd>packages/rspack/dist/index.js:<line>:<col>",
+ },
+ Object {
+ "message": " × Error: error 2\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n",
+ "moduleTrace": Array [],
+ "stack": "Error: error 2\\n at Object.fn (<cwd>packages/rspack-test-tools/tests/errorCases/error-test-set.js:<line>:<col>)\\n at next (<cwd>node_modules/.pnpm/@rspack+lite-tapable@1.0.1/node_modules/@rspack/lite-tapable/dist/index.js:<line>:<col>)\\n at AsyncSeriesHook.callAsyncStageRange (<cwd>node_modules/.pnpm/@rspack+lite-tapable@1.0.1/node_modules/@rspack/lite-tapable/dist/index.js:<line>:<col>)\\n at AsyncSeriesHook.callAsync (<cwd>node_modules/.pnpm/@rspack+lite-tapable@1.0.1/node_modules/@rspack/lite-tapable/dist/index.js:<line>:<col>)\\n at <cwd>packages/rspack/dist/index.js:<line>:<col>\\n at <cwd>packages/rspack/dist/index.js:<line>:<col>",
+ },
+ ],
+ "warnings": Array [],
+ }
+ `);
+ }
+};
diff --git a/packages/rspack-test-tools/tests/errorCases/warning-test-set.js b/packages/rspack-test-tools/tests/errorCases/warning-test-set.js
@@ -0,0 +1,38 @@
+/** @type {import('../..').TErrorCaseConfig} */
+module.exports = {
+ description: "Testing set warnings",
+ options() {
+ return {
+ entry: "./require.main.require",
+ plugins: [
+ compiler => {
+ compiler.hooks.afterCompile.tap("set warnings", compilation => {
+ compilation.warnings = [
+ new Error("warning 1"),
+ new Error("warning 2")
+ ];
+ });
+ }
+ ]
+ };
+ },
+ async check(diagnostics) {
+ expect(diagnostics).toMatchInlineSnapshot(`
+ Object {
+ "errors": Array [],
+ "warnings": Array [
+ Object {
+ "message": " ⚠ Error: warning 1\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n",
+ "moduleTrace": Array [],
+ "stack": "Error: warning 1\\n at Object.fn (<cwd>packages/rspack-test-tools/tests/errorCases/warning-test-set.js:<line>:<col>)\\n at next (<cwd>node_modules/.pnpm/@rspack+lite-tapable@1.0.1/node_modules/@rspack/lite-tapable/dist/index.js:<line>:<col>)\\n at AsyncSeriesHook.callAsyncStageRange (<cwd>node_modules/.pnpm/@rspack+lite-tapable@1.0.1/node_modules/@rspack/lite-tapable/dist/index.js:<line>:<col>)\\n at AsyncSeriesHook.callAsync (<cwd>node_modules/.pnpm/@rspack+lite-tapable@1.0.1/node_modules/@rspack/lite-tapable/dist/index.js:<line>:<col>)\\n at <cwd>packages/rspack/dist/index.js:<line>:<col>\\n at <cwd>packages/rspack/dist/index.js:<line>:<col>",
+ },
+ Object {
+ "message": " ⚠ Error: warning 2\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n │ at xxx\\n",
+ "moduleTrace": Array [],
+ "stack": "Error: warning 2\\n at Object.fn (<cwd>packages/rspack-test-tools/tests/errorCases/warning-test-set.js:<line>:<col>)\\n at next (<cwd>node_modules/.pnpm/@rspack+lite-tapable@1.0.1/node_modules/@rspack/lite-tapable/dist/index.js:<line>:<col>)\\n at AsyncSeriesHook.callAsyncStageRange (<cwd>node_modules/.pnpm/@rspack+lite-tapable@1.0.1/node_modules/@rspack/lite-tapable/dist/index.js:<line>:<col>)\\n at AsyncSeriesHook.callAsync (<cwd>node_modules/.pnpm/@rspack+lite-tapable@1.0.1/node_modules/@rspack/lite-tapable/dist/index.js:<line>:<col>)\\n at <cwd>packages/rspack/dist/index.js:<line>:<col>\\n at <cwd>packages/rspack/dist/index.js:<line>:<col>",
+ },
+ ],
+ }
+ `);
+ }
+};
diff --git a/packages/rspack/etc/api.md b/packages/rspack/etc/api.md
@@ -901,6 +901,7 @@ export class Compilation {
  get entrypoints(): ReadonlyMap<string, Entrypoint>;
  // (undocumented)
  get errors(): RspackError[];
+ set errors(errors: RspackError[]);
  // (undocumented)
  fileDependencies: {
  [Symbol.iterator](): Generator<string, void, unknown>;
@@ -1048,6 +1049,7 @@ export class Compilation {
  updateAsset(filename: string, newSourceOrFunction: Source | ((source: Source) => Source), assetInfoUpdateOrFunction?: AssetInfo | ((assetInfo: AssetInfo) => AssetInfo)): void;
  // (undocumented)
  get warnings(): RspackError[];
+ set warnings(warnings: RspackError[]);
 }
 
 // @public (undocumented)

diff --git a/packages/rspack/src/Compilation.ts b/packages/rspack/src/Compilation.ts
@@ -800,6 +800,18 @@ BREAKING CHANGE: Asset processing hooks in Compilation has been merged into a si
  return errors;
  }
 
+ set errors(errors: RspackError[]) {
+ const inner = this.#inner;
+ const length = inner.getErrors().length;
+ inner.spliceDiagnostic(
+ 0,
+ length,
+ errors.map(error => {
+ return JsRspackDiagnostic.__to_binding(error, JsRspackSeverity.Error);
+ })
+ );
+ }
+
  get warnings(): RspackError[] {
  const inner = this.#inner;
  type WarnType = Error | RspackError;
@@ -893,6 +905,18 @@ BREAKING CHANGE: Asset processing hooks in Compilation has been merged into a si
  return warnings;
  }
 
+ set warnings(warnings: RspackError[]) {
+ const inner = this.#inner;
+ const length = inner.getWarnings().length;
+ inner.spliceDiagnostic(
+ 0,
+ length,
+ warnings.map(warning => {
+ return JsRspackDiagnostic.__to_binding(warning, JsRspackSeverity.Warn);
+ })
+ );
+ }
+
  getPath(filename: Filename, data: PathData = {}) {
  return this.#inner.getPath(filename, {
  ...data,