Improve missing pointer error message (#360)

Signed-off-by: Dan Hudlow <[email protected]>
APIDevTools · Dec 5, 2024 · 782cbf7 · 782cbf7
1 parent 588197e
commit 782cbf7
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 11 deletions.
diff --git a/lib/pointer.ts b/lib/pointer.ts
@@ -210,7 +210,7 @@ class Pointer<S extends object = JSONSchema, O extends ParserOptions<S> = Parser
     }
 
     if (split[0] !== "") {
-      throw new InvalidPointerError(split, originalPath === undefined ? path : originalPath);
+      throw new InvalidPointerError(pointer, originalPath === undefined ? path : originalPath);
     }
 
     return split.slice(1);

diff --git a/lib/util/errors.ts b/lib/util/errors.ts
@@ -1,5 +1,5 @@
 import { Ono } from "@jsdevtools/ono";
-import { stripHash, toFileSystemPath } from "./url.js";
+import { getHash, stripHash, toFileSystemPath } from "./url.js";
 import type $RefParser from "../index.js";
 import type { ParserOptions } from "../index.js";
 import type { JSONSchema } from "../index.js";
@@ -121,10 +121,10 @@ export class UnmatchedResolverError extends JSONParserError {
 }
 
 export class MissingPointerError extends JSONParserError {
-  code = "EUNMATCHEDRESOLVER" as JSONParserErrorType;
+  code = "EMISSINGPOINTER" as JSONParserErrorType;
   name = "MissingPointerError";
-  constructor(token: any, path: any) {
-    super(`Token "${token}" does not exist.`, stripHash(path));
+  constructor(token: string, path: string) {
+    super(`Missing $ref pointer "${getHash(path)}". Token "${token}" does not exist.`, stripHash(path));
   }
 }
 
@@ -139,7 +139,7 @@ export class TimeoutError extends JSONParserError {
 export class InvalidPointerError extends JSONParserError {
   code = "EUNMATCHEDRESOLVER" as JSONParserErrorType;
   name = "InvalidPointerError";
-  constructor(pointer: any, path: any) {
+  constructor(pointer: string, path: string) {
     super(`Invalid $ref pointer "${pointer}". Pointers must begin with "#/"`, stripHash(path));
   }
 }

diff --git a/test/specs/missing-pointers/missing-pointers.spec.ts b/test/specs/missing-pointers/missing-pointers.spec.ts
@@ -26,7 +26,7 @@ describe("Schema with missing pointers", () => {
     } catch (err) {
       expect(err).to.be.an.instanceOf(MissingPointerError);
       // @ts-expect-error TS(2571): Object is of type 'unknown'.
-      expect(err.message).to.contain('Token "external" does not exist.');
+      expect(err.message).to.contain('Missing $ref pointer "#/external". Token "external" does not exist.');
     }
   });
 
@@ -48,7 +48,7 @@ describe("Schema with missing pointers", () => {
         expect(err.errors).to.containSubset([
           {
             name: MissingPointerError.name,
-            message: 'Token "baz" does not exist.',
+            message: 'Missing $ref pointer "#/baz". Token "baz" does not exist.',
             path: ["foo"],
             // source: message => message.endsWith("/test/") || message.startsWith("http://localhost"),
           },
@@ -81,7 +81,7 @@ describe("Schema with missing pointers", () => {
         expect(err.errors).to.containSubset([
           {
             name: MissingPointerError.name,
-            message: 'Token "external" does not exist.',
+            message: 'Missing $ref pointer "#/external". Token "external" does not exist.',
             path: ["internal2"],
             source: (message: any) =>
               message.endsWith("missing-pointers/external-from-internal.yaml") ||

diff --git a/test/specs/refs.spec.ts b/test/specs/refs.spec.ts
@@ -233,7 +233,7 @@ describe("$Refs object", () => {
       } catch (err) {
         expect(err).to.be.an.instanceOf(Error);
         // @ts-expect-error TS(2571): Object is of type 'unknown'.
-        expect(err.message).to.equal('Token "" does not exist.');
+        expect(err.message).to.equal('Missing $ref pointer "#/". Token "" does not exist.');
       }
     });
 
@@ -271,7 +271,7 @@ describe("$Refs object", () => {
       } catch (err) {
         expect(err).to.be.an.instanceOf(Error);
         // @ts-expect-error TS(2571): Object is of type 'unknown'.
-        expect(err.message).to.equal('Token "foo" does not exist.');
+        expect(err.message).to.equal('Missing $ref pointer "#/foo/bar". Token "foo" does not exist.');
       }
     });
   });