fix(null-ref): Fix references to existing but null values fail as missing #310

jonluca · jonluca · commit c6d21ecca551 · 2024-03-05T17:35:48.000-08:00
diff --git a/lib/bundle.ts b/lib/bundle.ts
@@ -49,7 +49,6 @@ function crawl(
   const obj = key === null ? parent : parent[key];
 
   if (obj && typeof obj === "object" && !ArrayBuffer.isView(obj)) {
-    // @ts-expect-error TS(2554): Expected 2 arguments, but got 1.
     if ($Ref.isAllowed$Ref(obj)) {
       inventory$Ref(parent, key, path, pathFromRoot, indirections, inventory, $refs, options);
     } else {
@@ -76,7 +75,6 @@ function crawl(
         const keyPathFromRoot = Pointer.join(pathFromRoot, key);
         const value = obj[key];
 
-        // @ts-expect-error TS(2554): Expected 2 arguments, but got 1.
         if ($Ref.isAllowed$Ref(value)) {
           inventory$Ref(obj, key, path, keyPathFromRoot, indirections, inventory, $refs, options);
         } else {
diff --git a/lib/parsers/yaml.ts b/lib/parsers/yaml.ts
@@ -41,9 +41,8 @@ export default {
     if (typeof data === "string") {
       try {
         return yaml.load(data, { schema: JSON_SCHEMA });
-      } catch (e) {
-        // @ts-expect-error TS(2571): Object is of type 'unknown'.
-        throw new ParserError(e.message, file.url);
+      } catch (e: any) {
+        throw new ParserError(e?.message || "Parser Error", file.url);
       }
     } else {
       // data is already a JavaScript value (object, array, number, null, NaN, etc.)
diff --git a/lib/pointer.ts b/lib/pointer.ts
@@ -49,7 +49,7 @@ class Pointer {
    */
   indirections: number;
 
-  constructor($ref: any, path: any, friendlyPath: any) {
+  constructor($ref: any, path: any, friendlyPath?: string) {
     this.$ref = $ref;
 
     this.path = path;
@@ -93,7 +93,7 @@ class Pointer {
       }
 
       const token = tokens[i];
-      if (this.value[token] === undefined || this.value[token] === null) {
+      if (this.value[token] === undefined || (this.value[token] === null && i === tokens.length - 1)) {
         this.value = null;
         throw new MissingPointerError(token, decodeURI(this.originalPath));
       } else {
@@ -198,7 +198,7 @@ class Pointer {
    * @param tokens - The token(s) to append (e.g. ["name", "first"])
    * @returns
    */
-  static join(base: any, tokens: any) {
+  static join(base: string, tokens: string | string[]) {
     // Ensure that the base path contains a hash
     if (base.indexOf("#") === -1) {
       base += "#";
diff --git a/lib/ref.ts b/lib/ref.ts
@@ -4,6 +4,7 @@ import { InvalidPointerError, isHandledError, normalizeError } from "./util/erro
 import { safePointerToPath, stripHash, getHash } from "./util/url.js";
 import type $Refs from "./refs.js";
 import type $RefParserOptions from "./options.js";
+import type { JSONSchema } from "./types";
 
 export type $RefError = JSONParserError | ResolverError | ParserError | MissingPointerError;
 
@@ -86,7 +87,7 @@ class $Ref {
    * @param options
    * @returns
    */
-  exists(path: string, options: any) {
+  exists(path: string, options?: $RefParserOptions) {
     try {
       this.resolve(path, options);
       return true;
@@ -102,7 +103,7 @@ class $Ref {
    * @param options
    * @returns - Returns the resolved value
    */
-  get(path: any, options: any) {
+  get(path: any, options: $RefParserOptions) {
     return this.resolve(path, options)?.value;
   }
 
@@ -144,8 +145,7 @@ class $Ref {
    * @param path - The full path of the property to set, optionally with a JSON pointer in the hash
    * @param value - The value to assign
    */
-  set(path: any, value: any) {
-    // @ts-expect-error TS(2554): Expected 3 arguments, but got 2.
+  set(path: string, value: any) {
     const pointer = new Pointer(this, path);
     this.value = pointer.set(this.value, value);
   }
@@ -156,8 +156,15 @@ class $Ref {
    * @param value - The value to inspect
    * @returns
    */
-  static is$Ref(value: any): value is { $ref: string; length?: number } {
-    return value && typeof value === "object" && typeof value.$ref === "string" && value.$ref.length > 0;
+  static is$Ref(value: unknown): value is { $ref: string; length?: number } {
+    return (
+      Boolean(value) &&
+      typeof value === "object" &&
+      value !== null &&
+      "$ref" in value &&
+      typeof value.$ref === "string" &&
+      value.$ref.length > 0
+    );
   }
 
   /**
@@ -166,7 +173,7 @@ class $Ref {
    * @param value - The value to inspect
    * @returns
    */
-  static isExternal$Ref(value: any): boolean {
+  static isExternal$Ref(value: unknown): boolean {
     return $Ref.is$Ref(value) && value.$ref![0] !== "#";
   }
 
@@ -178,7 +185,7 @@ class $Ref {
    * @param options
    * @returns
    */
-  static isAllowed$Ref(value: any, options: any) {
+  static isAllowed$Ref(value: unknown, options?: $RefParserOptions) {
     if (this.is$Ref(value)) {
       if (value.$ref.substring(0, 2) === "#/" || value.$ref === "#") {
         // It's a JSON Pointer reference, which is always allowed
@@ -224,7 +231,7 @@ class $Ref {
    * @param value - The value to inspect
    * @returns
    */
-  static isExtended$Ref(value: any) {
+  static isExtended$Ref(value: unknown) {
     return $Ref.is$Ref(value) && Object.keys(value).length > 1;
   }
 
@@ -259,7 +266,7 @@ class $Ref {
    * @param resolvedValue - The resolved value, which can be any type
    * @returns - Returns the dereferenced value
    */
-  static dereference($ref: $Ref, resolvedValue: any) {
+  static dereference($ref: $Ref, resolvedValue: JSONSchema): JSONSchema {
     if (resolvedValue && typeof resolvedValue === "object" && $Ref.isExtended$Ref($ref)) {
       const merged = {};
       for (const key of Object.keys($ref)) {
diff --git a/lib/util/errors.ts b/lib/util/errors.ts
@@ -1,6 +1,7 @@
 import { Ono } from "@jsdevtools/ono";
 import { stripHash, toFileSystemPath } from "./url.js";
 import type $RefParser from "../index.js";
+import type $Ref from "../ref";
 
 export type JSONParserErrorType =
   | "EUNKNOWN"
@@ -51,10 +52,8 @@ export class JSONParserErrorGroup extends Error {
   static getParserErrors(parser: any) {
     const errors = [];
 
-    for (const $ref of Object.values(parser.$refs._$refs)) {
-      // @ts-expect-error TS(2571): Object is of type 'unknown'.
+    for (const $ref of Object.values(parser.$refs._$refs) as $Ref[]) {
       if ($ref.errors) {
-        // @ts-expect-error TS(2571): Object is of type 'unknown'.
         errors.push(...$ref.errors);
       }
     }
diff --git a/test/specs/error-source/error-source.spec.ts b/test/specs/error-source/error-source.spec.ts
@@ -12,8 +12,7 @@ describe("Report correct error source and path for", () => {
     try {
       await parser.dereference({ foo: { bar: { $ref: "I do not exist" } } }, { continueOnError: true });
       helper.shouldNotGetCalled();
-    } catch (err) {
-      // @ts-expect-error TS(2571): Object is of type 'unknown'.
+    } catch (err: any) {
       expect(err.errors).to.containSubset([
         {
           name: ResolverError.name,
@@ -30,8 +29,7 @@ describe("Report correct error source and path for", () => {
     try {
       await parser.dereference(path.abs("test/specs/error-source/broken-external.json"), { continueOnError: true });
       helper.shouldNotGetCalled();
-    } catch (err) {
-      // @ts-expect-error TS(2571): Object is of type 'unknown'.
+    } catch (err: any) {
       expect(err.errors).to.containSubset([
         {
           name: ResolverError.name,
@@ -48,8 +46,7 @@ describe("Report correct error source and path for", () => {
     try {
       await parser.dereference(path.abs("test/specs/error-source/invalid-external.json"), { continueOnError: true });
       helper.shouldNotGetCalled();
-    } catch (err) {
-      // @ts-expect-error TS(2571): Object is of type 'unknown'.
+    } catch (err: any) {
       expect(err.errors).to.containSubset([
         {
           name: MissingPointerError.name,
@@ -72,8 +69,7 @@ describe("Report correct error source and path for", () => {
     try {
       await parser.dereference(path.abs("test/specs/error-source/invalid-pointer.json"), { continueOnError: true });
       helper.shouldNotGetCalled();
-    } catch (err) {
-      // @ts-expect-error TS(2571): Object is of type 'unknown'.
+    } catch (err: any) {
       expect(err.errors).to.containSubset([
         {
           name: InvalidPointerError.name,
diff --git a/test/specs/internal/internal.spec.ts b/test/specs/internal/internal.spec.ts
@@ -22,7 +22,6 @@ describe("Schema with internal $refs", () => {
     helper.testResolve(
       path.rel("test/specs/internal/internal.yaml"),
       path.abs("test/specs/internal/internal.yaml"),
-      // @ts-expect-error TS(2554): Expected 2 arguments, but got 3.
       parsedSchema,
     ),
   );
diff --git a/test/specs/invalid-pointers/invalid-pointers.ts b/test/specs/invalid-pointers/invalid-pointers.ts
@@ -11,8 +11,9 @@ describe("Schema with invalid pointers", () => {
       helper.shouldNotGetCalled();
     } catch (err) {
       expect(err).to.be.an.instanceOf(InvalidPointerError);
-      // @ts-expect-error TS(2571): Object is of type 'unknown'.
-      expect(err.message).to.contain('Invalid $ref pointer "f". Pointers must begin with "#/"');
+      expect((err as InvalidPointerError).message).to.contain(
+        'Invalid $ref pointer "f". Pointers must begin with "#/"',
+      );
     }
   });
 
@@ -21,15 +22,13 @@ describe("Schema with invalid pointers", () => {
     try {
       await parser.dereference(path.rel("test/specs/invalid-pointers/invalid.json"), { continueOnError: true });
       helper.shouldNotGetCalled();
-    } catch (err) {
+    } catch (e) {
+      const err = e as JSONParserErrorGroup;
       expect(err).to.be.instanceof(JSONParserErrorGroup);
-      // @ts-expect-error TS(2571): Object is of type 'unknown'.
       expect(err.files).to.equal(parser);
-      // @ts-expect-error TS(2571): Object is of type 'unknown'.
       expect(err.message).to.equal(
         `1 error occurred while reading '${path.abs("test/specs/invalid-pointers/invalid.json")}'`,
       );
-      // @ts-expect-error TS(2571): Object is of type 'unknown'.
       expect(err.errors).to.containSubset([
         {
           name: InvalidPointerError.name,
diff --git a/test/specs/no-refs/no-refs.spec.ts b/test/specs/no-refs/no-refs.spec.ts
@@ -17,7 +17,6 @@ describe("Schema without any $refs", () => {
 
   it(
     "should resolve successfully",
-    // @ts-expect-error TS(2554): Expected 2 arguments, but got 3.
     helper.testResolve(
       path.rel("test/specs/no-refs/no-refs.yaml"),
       path.abs("test/specs/no-refs/no-refs.yaml"),
diff --git a/test/specs/null-ref/null.spec.ts b/test/specs/null-ref/null.spec.ts
@@ -0,0 +1,14 @@
+import { describe, it } from "vitest";
+import { expect } from "vitest";
+import $RefParser from "../../../lib/index.js";
+import path from "../../utils/path";
+import parsedSchema from "./null";
+
+describe("Null references", () => {
+  it("should parse successfully", async () => {
+    const parser = new $RefParser();
+    const schema = await parser.parse(path.rel("test/specs/null-ref/null.yaml"));
+    expect(schema).to.equal(parser.schema);
+    expect(schema).to.deep.equal(parsedSchema);
+  });
+});
diff --git a/test/specs/null-ref/null.ts b/test/specs/null-ref/null.ts
@@ -0,0 +1,49 @@
+export default {
+  openapi: "3.0.3",
+  components: {
+    schemas: {
+      ReadyToPayMethods: {
+        example: [
+          {
+            brands: ["Visa", "MasterCard"],
+            feature: {
+              name: "Google Pay",
+            },
+            filters: ["brand:Visa,MasterCard;bin:!411111"],
+            method: "payment-card",
+          },
+          {
+            feature: {
+              expirationTime: "2006-01-02T15:04:05Z",
+              linkToken: "some-random-link_token-for-plaid",
+              name: "Plaid",
+            },
+            method: "ach",
+          },
+          {
+            brands: ["Visa"],
+            feature: null,
+            filters: ["brand:Visa;bin:411111,444433"],
+            method: "payment-card",
+          },
+          {
+            feature: {
+              $ref: "#/components/schemas/ReadyToPayMethods/example/2/feature",
+            },
+            filters: [],
+            method: "ach",
+          },
+          {
+            filters: [],
+            method: "paypal",
+          },
+          {
+            filters: [],
+            method: "Skrill",
+          },
+        ],
+        type: "array",
+      },
+    },
+  },
+};
diff --git a/test/specs/null-ref/null.yaml b/test/specs/null-ref/null.yaml
@@ -0,0 +1,33 @@
+openapi: 3.0.3
+components:
+  schemas:
+    ReadyToPayMethods:
+      example:
+        - brands:
+            - Visa
+            - MasterCard
+          feature:
+            name: Google Pay
+          filters:
+            - brand:Visa,MasterCard;bin:!411111
+          method: payment-card
+        - feature:
+            expirationTime: 2006-01-02T15:04:05Z
+            linkToken: some-random-link_token-for-plaid
+            name: Plaid
+          method: ach
+        - brands:
+            - Visa
+          feature: null
+          filters:
+            - brand:Visa;bin:411111,444433
+          method: payment-card
+        - feature:
+            $ref: "#/components/schemas/ReadyToPayMethods/example/2/feature"
+          filters: [ ]
+          method: ach
+        - filters: [ ]
+          method: paypal
+        - filters: [ ]
+          method: Skrill
+      type: array
diff --git a/test/specs/resolvers/resolvers.spec.ts b/test/specs/resolvers/resolvers.spec.ts
@@ -176,8 +176,7 @@ describe("options.resolve", () => {
       helper.shouldNotGetCalled();
     } catch (err) {
       expect(err).to.be.instanceof(ResolverError);
-      // @ts-expect-error TS(2571): Object is of type 'unknown'.
-      expect(err.message).to.contain("Error opening file");
+      expect((err as ResolverError).message).to.contain("Error opening file");
     }
   });
 
diff --git a/test/specs/root/root.spec.ts b/test/specs/root/root.spec.ts
@@ -38,8 +38,7 @@ describe("Schema with a top-level (root) $ref", () => {
     expect(schema).to.equal(parser.schema);
     expect(schema).to.deep.equal(dereferencedSchema);
     // Reference equality
-    // @ts-expect-error TS(2532): Object is possibly 'undefined'.
-    expect(schema.properties.first).to.deep.equal(schema.properties.last);
+    expect(schema.properties!.first).to.deep.equal(schema.properties!.last);
     // The "circular" flag should NOT be set
     expect(parser.$refs.circular).to.equal(false);
   });
diff --git a/test/specs/substrings/substrings.spec.ts b/test/specs/substrings/substrings.spec.ts
@@ -36,12 +36,11 @@ describe("$refs that are substrings of each other", () => {
     expect(schema).to.equal(parser.schema);
     expect(schema).to.deep.equal(dereferencedSchema);
     // Reference equality
-    // @ts-expect-error TS(2532): Object is possibly 'undefined'.
-    expect(schema.properties.firstName).to.equal(schema.definitions.name);
-    // @ts-expect-error TS(2532): Object is possibly 'undefined'.
-    expect(schema.properties.middleName).to.equal(schema.definitions["name-with-min-length"]);
-    // @ts-expect-error TS(2532): Object is possibly 'undefined'.
-    expect(schema.properties.lastName).to.equal(schema.definitions["name-with-min-length-max-length"]);
+    const properties = schema.properties!;
+    const definitions = schema.definitions!;
+    expect(properties.firstName).to.equal(definitions.name);
+    expect(properties.middleName).to.equal(definitions["name-with-min-length"]);
+    expect(properties.lastName).to.equal(definitions["name-with-min-length-max-length"]);
     // The "circular" flag should NOT be set
     expect(parser.$refs.circular).to.equal(false);
   });
