Drop originalError property on validation errors

CHANGELOG.md

@@ -14,6 +14,7 @@
     - Properties `httpServer` and `httpsServer` are removed;
     - Added `servers` property — array containing those server instances in the same order.
 - The `serializer` property of `Documentation` and `Integration` constructor argument removed;
+- The `originalError` property of `InputValidationError` and `OutputValidationError` removed (use `cause` instead);
 - Consider the automated migration using the built-in ESLint rule.
 
 ```js

src/errors.ts

@@ -41,14 +41,6 @@ export class OutputValidationError extends IOSchemaError {
   constructor(public override readonly cause: z.ZodError) {
     super(getMessageFromError(cause), { cause });
   }
-
-  /**
-   * @deprecated use the cause property instead
-   * @todo remove in v21
-   * */
-  public get originalError() {
-    return this.cause;
-  }
 }
 
 /** @desc An error of validating the input sources against the Middleware or Endpoint input schema */
@@ -58,14 +50,6 @@ export class InputValidationError extends IOSchemaError {
   constructor(public override readonly cause: z.ZodError) {
     super(getMessageFromError(cause), { cause });
   }
-
-  /**
-   * @deprecated use the cause property instead
-   * @todo remove in v21
-   * */
-  public get originalError() {
-    return this.cause;
-  }
 }
 
 /** @desc An error related to the execution or incorrect configuration of ResultHandler */

src/migration.ts

@@ -10,11 +10,13 @@ const createServerName = "createServer";
 const serverPropName = "server";
 const httpServerPropName = "httpServer";
 const httpsServerPropName = "httpsServer";
+const originalErrorPropName = "originalError";
 
 const changedProps = {
   [serverPropName]: "http",
   [httpServerPropName]: "servers",
   [httpsServerPropName]: "servers",
+  [originalErrorPropName]: "cause",
 };
 
 const movedProps = [
@@ -57,7 +59,26 @@ const v21 = ESLintUtils.RuleCreator.withoutDocs({
   },
   defaultOptions: [],
   create: (ctx) => ({
-    CallExpression: (node) => {
+    [NT.MemberExpression]: (node) => {
+      if (
+        node.property.type === NT.Identifier &&
+        node.property.name === originalErrorPropName &&
+        node.object.type === NT.Identifier &&
+        node.object.name.match(/err/i) // this is probably an error instance, but we don't do type checking
+      ) {
+        const replacement = changedProps[node.property.name];
+        ctx.report({
+          node: node.property,
+          messageId: "change",
+          data: {
+            subject: "property",
+            from: node.property.name,
+            to: replacement,
+          },
+        });
+      }
+    },
+    [NT.CallExpression]: (node) => {
       if (node.callee.type !== NT.Identifier) return;
       if (
         node.callee.name === createConfigName &&

tests/unit/errors.spec.ts

@@ -69,7 +69,6 @@ describe("Errors", () => {
 
     test("should have .cause property matching the one used for constructing", () => {
       expect(error.cause).toEqual(zodError);
-      expect(error.originalError).toEqual(zodError);
     });
   });
 
@@ -88,7 +87,6 @@ describe("Errors", () => {
 
     test("should have .cause property matching the one used for constructing", () => {
       expect(error.cause).toEqual(zodError);
-      expect(error.originalError).toEqual(zodError);
     });
   });
 

tests/unit/migration.spec.ts

@@ -24,6 +24,7 @@ tester.run("v21", migration.rules.v21, {
     `createConfig({ http: {} });`,
     `createConfig({ http: { listen: 8090 }, upload: true });`,
     `const { app, servers, logger } = await createServer();`,
+    `const error = new Error(); console.error(error.cause?.message);`,
   ],
   invalid: [
     {
@@ -63,5 +64,14 @@ tester.run("v21", migration.rules.v21, {
         },
       ],
     },
+    {
+      code: `const error = new Error(); console.error(error.originalError?.message);`,
+      errors: [
+        {
+          messageId: "change",
+          data: { subject: "property", from: "originalError", to: "cause" },
+        },
+      ],
+    },
   ],
 });