fix(reference): use JavaScript error causes interface

Refs #2561
swagger-api · Feb 15, 2023 · 437e0f5 · 437e0f5
1 parent d3f5089
commit 437e0f5
Show file tree

Hide file tree

Showing 25 changed files with 33 additions and 42 deletions.
diff --git a/packages/apidom-reference/src/dereference/index.ts b/packages/apidom-reference/src/dereference/index.ts
@@ -57,7 +57,7 @@ export const dereferenceApiDOM = async <T extends Element>(
     // unwrap the element from ParseResult assuming first element is the actual result
     return surrogateWrapping ? result.get(0) : result;
   } catch (error: any) {
-    throw new DereferenceError(`Error while dereferencing file "${file.uri}"`, error);
+    throw new DereferenceError(`Error while dereferencing file "${file.uri}"`, { cause: error });
   }
 };
 

diff --git a/packages/apidom-reference/src/parse/index.ts b/packages/apidom-reference/src/parse/index.ts
@@ -36,7 +36,7 @@ const parseFile = async (file: IFile, options: IReferenceOptions): Promise<Parse
 
     return result;
   } catch (error: any) {
-    throw new ParserError(`Error while parsing file "${file.uri}"`, error);
+    throw new ParserError(`Error while parsing file "${file.uri}"`, { cause: error });
   }
 };
 

diff --git a/packages/apidom-reference/src/parse/parsers/api-design-systems-json/index.ts b/packages/apidom-reference/src/parse/parsers/api-design-systems-json/index.ts
@@ -37,7 +37,7 @@ const ApiDesignSystemsJsonParser: stampit.Stamp<IParser> = stampit(Parser, {
         const parserOpts = pick(['sourceMap', 'syntacticAnalysis', 'refractorOpts'], this);
         return await parse(source, parserOpts);
       } catch (error: any) {
-        throw new ParserError(`Error parsing "${file.uri}"`, error);
+        throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
       }
     },
   },

diff --git a/packages/apidom-reference/src/parse/parsers/api-design-systems-yaml/index.ts b/packages/apidom-reference/src/parse/parsers/api-design-systems-yaml/index.ts
@@ -37,7 +37,7 @@ const ApiDesignSystemsYamlParser: stampit.Stamp<IParser> = stampit(Parser, {
         const parserOpts = pick(['sourceMap', 'refractorOpts'], this);
         return await parse(source, parserOpts);
       } catch (error: any) {
-        throw new ParserError(`Error parsing "${file.uri}"`, error);
+        throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
       }
     },
   },

diff --git a/packages/apidom-reference/src/parse/parsers/asyncapi-json-2/index.ts b/packages/apidom-reference/src/parse/parsers/asyncapi-json-2/index.ts
@@ -33,7 +33,7 @@ const AsyncApiJson2Parser: stampit.Stamp<IParser> = stampit(Parser, {
         const parserOpts = pick(['sourceMap', 'syntacticAnalysis', 'refractorOpts'], this);
         return await parse(source, parserOpts);
       } catch (error: any) {
-        throw new ParserError(`Error parsing "${file.uri}"`, error);
+        throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
       }
     },
   },

diff --git a/packages/apidom-reference/src/parse/parsers/asyncapi-yaml-2/index.ts b/packages/apidom-reference/src/parse/parsers/asyncapi-yaml-2/index.ts
@@ -33,7 +33,7 @@ const AsyncApiYaml2Parser: stampit.Stamp<IParser> = stampit(Parser, {
         const parserOpts = pick(['sourceMap', 'refractorOpts'], this);
         return await parse(source, parserOpts);
       } catch (error: any) {
-        throw new ParserError(`Error parsing "${file.uri}"`, error);
+        throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
       }
     },
   },

diff --git a/packages/apidom-reference/src/parse/parsers/binary/index-browser.ts b/packages/apidom-reference/src/parse/parsers/binary/index-browser.ts
@@ -46,7 +46,7 @@ const BinaryParser: stampit.Stamp<IParser> = stampit(Parser, {
 
         return parseResultElement;
       } catch (error: any) {
-        throw new ParserError(`Error parsing "${file.uri}"`, error);
+        throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
       }
     },
   },

diff --git a/packages/apidom-reference/src/parse/parsers/binary/index-node.ts b/packages/apidom-reference/src/parse/parsers/binary/index-node.ts
@@ -43,7 +43,7 @@ const BinaryParser: stampit.Stamp<IParser> = stampit(Parser, {
 
         return parseResultElement;
       } catch (error: any) {
-        throw new ParserError(`Error parsing "${file.uri}"`, error);
+        throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
       }
     },
   },

diff --git a/packages/apidom-reference/src/parse/parsers/json/index.ts b/packages/apidom-reference/src/parse/parsers/json/index.ts
@@ -33,7 +33,7 @@ const JsonParser: stampit.Stamp<IParser> = stampit(Parser, {
         const parserOpts = pick(['sourceMap', 'syntacticAnalysis'], this);
         return await parse(source, parserOpts);
       } catch (error: any) {
-        throw new ParserError(`Error parsing "${file.uri}"`, error);
+        throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
       }
     },
   },

diff --git a/packages/apidom-reference/src/parse/parsers/openapi-json-3-0/index.ts b/packages/apidom-reference/src/parse/parsers/openapi-json-3-0/index.ts
@@ -34,7 +34,7 @@ const OpenApiJson3_0Parser: stampit.Stamp<IParser> = stampit(Parser, {
         const parserOpts = pick(['sourceMap', 'syntacticAnalysis', 'refractorOpts'], this);
         return await parse(source, parserOpts);
       } catch (error: any) {
-        throw new ParserError(`Error parsing "${file.uri}"`, error);
+        throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
       }
     },
   },

diff --git a/packages/apidom-reference/src/parse/parsers/openapi-json-3-1/index.ts b/packages/apidom-reference/src/parse/parsers/openapi-json-3-1/index.ts
@@ -34,7 +34,7 @@ const OpenApiJson3_1Parser: stampit.Stamp<IParser> = stampit(Parser, {
         const parserOpts = pick(['sourceMap', 'syntacticAnalysis', 'refractorOpts'], this);
         return await parse(source, parserOpts);
       } catch (error: any) {
-        throw new ParserError(`Error parsing "${file.uri}"`, error);
+        throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
       }
     },
   },

diff --git a/packages/apidom-reference/src/parse/parsers/openapi-yaml-3-0/index.ts b/packages/apidom-reference/src/parse/parsers/openapi-yaml-3-0/index.ts
@@ -34,7 +34,7 @@ const OpenApiYaml3_0Parser: stampit.Stamp<IParser> = stampit(Parser, {
         const parserOpts = pick(['sourceMap', 'refractorOpts'], this);
         return await parse(source, parserOpts);
       } catch (error: any) {
-        throw new ParserError(`Error parsing "${file.uri}"`, error);
+        throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
       }
     },
   },

diff --git a/packages/apidom-reference/src/parse/parsers/openapi-yaml-3-1/index.ts b/packages/apidom-reference/src/parse/parsers/openapi-yaml-3-1/index.ts
@@ -34,7 +34,7 @@ const OpenApiYaml3_1Parser: stampit.Stamp<IParser> = stampit(Parser, {
         const parserOpts = pick(['sourceMap', 'refractorOpts'], this);
         return await parse(source, parserOpts);
       } catch (error: any) {
-        throw new ParserError(`Error parsing "${file.uri}"`, error);
+        throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
       }
     },
   },

diff --git a/packages/apidom-reference/src/parse/parsers/yaml-1-2/index.ts b/packages/apidom-reference/src/parse/parsers/yaml-1-2/index.ts
@@ -31,7 +31,7 @@ const YamlParser: stampit.Stamp<IParser> = stampit(Parser, {
       try {
         return await parse(source, { sourceMap: this.sourceMap });
       } catch (error: any) {
-        throw new ParserError(`Error parsing "${file.uri}"`, error);
+        throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
       }
     },
   },

diff --git a/packages/apidom-reference/src/resolve/index.ts b/packages/apidom-reference/src/resolve/index.ts
@@ -50,7 +50,7 @@ export const resolveApiDOM = async <T extends Element>(
     const { result } = await plugins.run('resolve', [file, options], resolveStrategies);
     return result;
   } catch (error: any) {
-    throw new ResolverError(`Error while resolving file "${file.uri}"`, error);
+    throw new ResolverError(`Error while resolving file "${file.uri}"`, { cause: error });
   }
 };
 

diff --git a/packages/apidom-reference/src/resolve/resolvers/file/index-node.ts b/packages/apidom-reference/src/resolve/resolvers/file/index-node.ts
@@ -33,7 +33,7 @@ const FileResolver: stampit.Stamp<IFileResolver> = stampit(Resolver, {
       try {
         return await promisify(readFile)(fileSystemPath);
       } catch (error: any) {
-        throw new ResolverError(`Error opening file "${file.uri}"`, error);
+        throw new ResolverError(`Error opening file "${file.uri}"`, { cause: error });
       }
     },
   },

diff --git a/packages/apidom-reference/src/resolve/resolvers/http-axios/index.ts b/packages/apidom-reference/src/resolve/resolvers/http-axios/index.ts
@@ -72,7 +72,7 @@ const HttpResolverAxios: stampit.Stamp<IHttpResolverAxios> = stampit(HttpResolve
         const response = await client.get<Buffer>(file.uri);
         return response.data;
       } catch (error: any) {
-        throw new ResolverError(`Error downloading "${file.uri}"`, error);
+        throw new ResolverError(`Error downloading "${file.uri}"`, { cause: error });
       }
     };
   },

diff --git a/packages/apidom-reference/src/resolve/util.ts b/packages/apidom-reference/src/resolve/util.ts
@@ -29,6 +29,6 @@ export const readFile = async (file: IFile, options: IReferenceOptions): Promise
     const { result } = await plugins.run('read', [file], resolvers);
     return result;
   } catch (error: any) {
-    throw new ResolverError(`Error while reading file "${file.uri}"`, error);
+    throw new ResolverError(`Error while reading file "${file.uri}"`, { cause: error });
   }
 };
diff --git a/packages/apidom-reference/src/util/errors/DereferenceError.ts b/packages/apidom-reference/src/util/errors/DereferenceError.ts
@@ -1,9 +1,7 @@
 class DereferenceError extends Error {
-  public cause: undefined | Error;
-
-  constructor(message: string, cause?: Error) {
-    super(message);
-    this.cause = cause;
+  constructor(message: string, options?: { cause?: Error }) {
+    super(message, options);
+    this.cause = this.cause ?? options?.cause;
   }
 }
 

diff --git a/packages/apidom-reference/src/util/errors/InvalidSelectorError.ts b/packages/apidom-reference/src/util/errors/InvalidSelectorError.ts
@@ -1,9 +1,7 @@
 class InvalidSelectorError extends Error {
-  public cause: undefined | Error;
-
-  constructor(message: string, cause?: Error) {
+  constructor(message: string, options?: { cause?: Error }) {
     super(message);
-    this.cause = cause;
+    this.cause = this.cause ?? options?.cause;
   }
 }
 

diff --git a/packages/apidom-reference/src/util/errors/NotImplementedError.ts b/packages/apidom-reference/src/util/errors/NotImplementedError.ts
@@ -1,6 +1,7 @@
 class NotImplementedError extends Error {
-  constructor(message = 'Not Implemented') {
+  constructor(message = 'Not Implemented', options?: { cause?: Error }) {
     super(message);
+    this.cause = this.cause ?? options?.cause;
   }
 }
 

diff --git a/packages/apidom-reference/src/util/errors/ParserError.ts b/packages/apidom-reference/src/util/errors/ParserError.ts
@@ -1,9 +1,7 @@
 class ParserError extends Error {
-  public cause: undefined | Error;
-
-  constructor(message: string, cause?: Error) {
+  constructor(message: string, options?: { cause?: Error }) {
     super(message);
-    this.cause = cause;
+    this.cause = this.cause ?? options?.cause;
   }
 }
 

diff --git a/packages/apidom-reference/src/util/errors/PluginError.ts b/packages/apidom-reference/src/util/errors/PluginError.ts
@@ -1,12 +1,10 @@
 class PluginError extends Error {
-  public cause: Error;
-
   public plugin: any;
 
-  constructor(message: string, cause: Error, plugin: any) {
+  constructor(message: string, options: { cause?: Error; plugin: any }) {
     super(message);
-    this.cause = cause;
-    this.plugin = plugin;
+    this.cause = this.cause ?? options?.cause;
+    this.plugin = options.plugin;
   }
 }
 

diff --git a/packages/apidom-reference/src/util/errors/ResolverError.ts b/packages/apidom-reference/src/util/errors/ResolverError.ts
@@ -1,9 +1,7 @@
 class ResolverError extends Error {
-  public cause: undefined | Error;
-
-  constructor(message: string, cause?: Error) {
+  constructor(message: string, options?: { cause?: Error }) {
     super(message);
-    this.cause = cause;
+    this.cause = this.cause ?? options?.cause;
   }
 }
 

diff --git a/packages/apidom-reference/src/util/plugins.ts b/packages/apidom-reference/src/util/plugins.ts
@@ -33,7 +33,7 @@ export const run = async (method: string, parameters: any[], plugins: any[]): Pr
       const result = await plugin[method].call(plugin, ...parameters); // eslint-disable-line no-await-in-loop
       return { plugin, result };
     } catch (error: any) {
-      lastError = new PluginError('Error while running plugin', error, plugin);
+      lastError = new PluginError('Error while running plugin', { cause: error, plugin });
     }
   }