Merge pull request #43 from stoplightio/improve-MissingPointerError-m…

…essage improve MissingPointerError message
stoplightio · May 31, 2023 · fc3f606 · fc3f606
2 parents 5c9b100 + 70e087e
commit fc3f606
Show file tree

Hide file tree

Showing 9 changed files with 40 additions and 26 deletions.
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -7,23 +7,34 @@
 // ${cwd}: the current working directory of the spawned process
 
 {
-  "version": "0.1.0",
+  "version": "2.0.0",
   "command": "npm",
-  "isShellCommand": true,
-  "suppressTaskName": true,
   "tasks": [
     {
-      "taskName": "lint",
-      "args": ["run", "lint"],
-      "showOutput": "always",
+      "label": "lint",
+      "type": "shell",
+      "args": [
+        "run",
+        "lint"
+      ],
       "problemMatcher": "$eslint-stylish",
-      "isBuildCommand": true
+      "group": {
+        "_id": "build",
+        "isDefault": false
+      }
     },
     {
-      "taskName": "test",
-      "args": ["run", "mocha"],
-      "showOutput": "always",
-      "isTestCommand": true
+      "label": "test",
+      "type": "shell",
+      "args": [
+        "run",
+        "mocha"
+      ],
+      "problemMatcher": [],
+      "group": {
+        "_id": "test",
+        "isDefault": false
+      }
     }
   ]
 }
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -490,7 +490,7 @@ declare namespace $RefParser {
     public readonly code ="EUNMATCHEDRESOLVER";
   }
   export class MissingPointerError extends JSONParserError {
-    public constructor(token: string | number, source: string);
+    public constructor(token: string | number, source: string, unresolvableRefValue?: string, pathToUnresolvableRef?: string);
 
     public readonly name = "MissingPointerError";
     public readonly code ="EMISSINGPOINTER";

diff --git a/lib/pointer.js b/lib/pointer.js
@@ -97,7 +97,7 @@ Pointer.prototype.resolve = function (obj, options, pathFromRoot) {
     let token = tokens[i];
     if (this.value[token] === undefined || this.value[token] === null) {
       this.value = null;
-      throw new MissingPointerError(token, this.originalPath);
+      throw new MissingPointerError(token, this.originalPath, this.path, pathFromRoot);
     }
     else {
       this.value = this.value[token];

diff --git a/lib/util/errors.js b/lib/util/errors.js
@@ -2,7 +2,7 @@
 
 const { Ono } = require("@jsdevtools/ono");
 
-const { stripHash, toFileSystemPath } = require("./url");
+const { getHash, stripHash, toFileSystemPath } = require("./url");
 
 const JSONParserError = exports.JSONParserError = class JSONParserError extends Error {
   constructor (message, source) {
@@ -93,8 +93,8 @@ const UnmatchedResolverError = exports.UnmatchedResolverError = class UnmatchedR
 setErrorName(UnmatchedResolverError);
 
 const MissingPointerError = exports.MissingPointerError = class MissingPointerError extends JSONParserError {
-  constructor (token, path) {
-    super(`Token "${token}" does not exist.`, stripHash(path));
+  constructor (unresolvableTokenInRef, path, unresolvableRefValue, pathToUnresolvableRef) {
+    super(`at "${getHash(pathToUnresolvableRef)}", token "${unresolvableTokenInRef}" in "${getHash(unresolvableRefValue)}" does not exist`, stripHash(path));
 
     this.code = "EMISSINGPOINTER";
   }

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@stoplight/json-schema-ref-parser",
-  "version": "9.2.4",
+  "version": "9.2.5",
   "description": "Parse, Resolve, and Dereference JSON Schema $ref pointers",
   "keywords": [
     "json",

diff --git a/test/specs/invalid/invalid.spec.js b/test/specs/invalid/invalid.spec.js
@@ -164,7 +164,8 @@ describe("Invalid syntax", () => {
                 message.includes("invalid.json: JSON.parse: end of data while reading object contents") ||    // Firefox
                 message.includes("invalid.json: JSON Parse error: Expected '}'") ||                           // Safari
                 message.includes("invalid.json: JSON.parse Error: Invalid character") ||                      // Edge
-                message.includes("invalid.json: Syntax error")                                                // IE
+                message.includes("invalid.json: Syntax error") ||                                             // IE
+                message.includes("Expected property name or \'}\' in JSON at position 2")
               ),
               path: [],
               source: message => message.endsWith("test/specs/invalid/invalid.json"),
@@ -318,7 +319,8 @@ describe("Invalid syntax", () => {
                 message.includes("invalid.json: JSON.parse: end of data while reading object contents") ||    // Firefox
                 message.includes("invalid.json: JSON Parse error: Expected '}'") ||                           // Safari
                 message.includes("invalid.json: JSON.parse Error: Invalid character") ||                      // Edge
-                message.includes("invalid.json: Syntax error")                                                // IE
+                message.includes("invalid.json: Syntax error") ||                                             // IE
+                message.includes("Expected property name or \'}\' in JSON at position 2") // Chrome
               ),
               path: ["foo"],
               source: message => message.endsWith("/test/") || message.startsWith("http://localhost"),

diff --git a/test/specs/missing-pointers/missing-pointers.spec.js b/test/specs/missing-pointers/missing-pointers.spec.js
@@ -16,7 +16,7 @@ describe("Schema with missing pointers", () => {
     }
     catch (err) {
       expect(err).to.be.an.instanceOf(MissingPointerError);
-      expect(err.message).to.contain("Token \"baz\" does not exist.");
+      expect(err.message).to.equal('at "#/foo", token "baz" in "#/baz" does not exist');
     }
   });
 
@@ -31,12 +31,13 @@ describe("Schema with missing pointers", () => {
       expect(err.files).to.equal(parser);
       expect(err.files.$refs._root$Ref.value).to.deep.equal({ foo: null });
       expect(err.message).to.have.string("1 error occurred while reading '");
+      console.log(err.errors[0].source);
+
       expect(err.errors).to.containSubset([
         {
           name: MissingPointerError.name,
-          message: "Token \"baz\" does not exist.",
+          message: 'at "#/foo", token "baz" in "#/baz" does not exist',
           path: ["foo"],
-          source: message => message.endsWith("/test/") || message.startsWith("http://localhost"),
         }
       ]);
     }

diff --git a/test/specs/refs.spec.js b/test/specs/refs.spec.js
@@ -216,7 +216,7 @@ describe("$Refs object", () => {
       }
       catch (err) {
         expect(err).to.be.an.instanceOf(Error);
-        expect(err.message).to.equal('Token "" does not exist.');
+        expect(err.message).to.equal('at "#", token "" in "#/" does not exist');
       }
     });
 
@@ -254,7 +254,7 @@ describe("$Refs object", () => {
       }
       catch (err) {
         expect(err).to.be.an.instanceOf(Error);
-        expect(err.message).to.equal('Token "foo" does not exist.');
+        expect(err.message).to.equal('at "#", token "foo" in "#/foo/bar" does not exist');
       }
     });
   });