fix(file): support trailing slashes in file resolver #389

Author: jonluca

lib/resolvers/file.ts

@@ -31,6 +31,10 @@ export default {
       e.message = `Malformed URI: ${file.url}: ${e.message}`;
       throw new ResolverError(e, file.url);
     }
+    // strip trailing slashes
+    if (path.endsWith("/") || path.endsWith("\\")) {
+      path = path.slice(0, -1);
+    }
     try {
       return await fs.promises.readFile(path);
     } catch (err: any) {

test/specs/external-partial/external-partial-trailing-slash.yaml

@@ -0,0 +1,11 @@
+title: Person
+type: object
+required:
+  - name
+properties:
+  name:
+    $ref: "definitions/definitions.json/#/name"
+  age:
+    $ref: "definitions/definitions.json/#/age"
+  gender:
+    $ref: "definitions/definitions.json/#/gender"

test/specs/external-partial/external-partial.spec.ts

@@ -3,6 +3,7 @@ import $RefParser from "../../../lib/index.js";
 import helper from "../../utils/helper.js";
 import path from "../../utils/path.js";
 import parsedSchema from "./parsed.js";
+import parsedSchemaTrailing from "./parsed-trailing.js";
 import dereferencedSchema from "./dereferenced.js";
 import bundledSchema from "./bundled.js";
 
@@ -17,6 +18,16 @@ describe("Schema with $refs to parts of external files", () => {
     expect(parser.$refs.paths()).to.deep.equal([path.abs("test/specs/external-partial/external-partial.yaml")]);
   });
 
+  it("should parse successfully with files with trailing slashes", async () => {
+    const parser = new $RefParser();
+    const schema = await parser.parse(path.rel("test/specs/external-partial/external-partial-trailing-slash.yaml"));
+    expect(schema).to.equal(parser.schema);
+    expect(schema).to.deep.equal(parsedSchemaTrailing.schema);
+    expect(parser.$refs.paths()).to.deep.equal([
+      path.abs("test/specs/external-partial/external-partial-trailing-slash.yaml"),
+    ]);
+  });
+
   it(
     "should resolve successfully",
     helper.testResolve(

test/specs/external-partial/parsed-trailing.ts

@@ -0,0 +1,75 @@
+export default {
+  schema: {
+    required: ["name"],
+    type: "object",
+    properties: {
+      gender: {
+        $ref: "definitions/definitions.json/#/gender",
+      },
+      age: {
+        $ref: "definitions/definitions.json/#/age",
+      },
+      name: {
+        $ref: "definitions/definitions.json/#/name",
+      },
+    },
+    title: "Person",
+  },
+
+  definitions: {
+    "required string": {
+      $ref: "required-string.yaml",
+    },
+    string: {
+      $ref: "#/required%20string/type",
+    },
+    name: {
+      $ref: "../definitions/name.yaml",
+    },
+    age: {
+      type: "integer",
+      minimum: 0,
+    },
+    gender: {
+      type: "string",
+      enum: ["male", "female"],
+    },
+  },
+
+  name: {
+    required: ["first", "last"],
+    type: "object",
+    properties: {
+      middle: {
+        minLength: {
+          $ref: "definitions.json#/name/properties/first/minLength",
+        },
+        type: {
+          $ref: "definitions.json#/name/properties/first/type",
+        },
+      },
+      prefix: {
+        minLength: 3,
+        $ref: "../definitions/definitions.json#/name/properties/last",
+      },
+      last: {
+        $ref: "./required-string.yaml",
+      },
+      suffix: {
+        $ref: "definitions.json#/name/properties/prefix",
+        type: "string",
+        maxLength: 3,
+      },
+      first: {
+        $ref: "../definitions/definitions.json#/required string",
+      },
+    },
+    title: "name",
+  },
+
+  requiredString: {
+    minLength: 1,
+    type: "string",
+    title: "required string",
+  },
+};

test/utils/helper.ts

@@ -18,7 +18,7 @@ const helper = {
    * @param {...*} [params] - The expected resolved file paths and values
    * @returns {Function}
    */
-  testResolve(filePath: string) {
+  testResolve(filePath: string, ..._args: any[]) {
     const parsedSchema = arguments[2];
     const expectedFiles: any = [];
     const messages: any = [];

test/utils/path.ts

@@ -138,27 +138,27 @@ function urlPathHelpers() {
 }
 
 export default {
-  rel() {
+  rel(..._args: any[]) {
     // @ts-expect-error TS(2556): A spread argument must either have a tuple type or... Remove this comment to see the full error message
     return !isDom ? pathHelpers.filesystem.rel(...arguments) : pathHelpers.url.rel(...arguments);
   },
 
-  abs() {
+  abs(..._args: any[]) {
     // @ts-expect-error TS(2556): A spread argument must either have a tuple type or... Remove this comment to see the full error message
     return !isDom ? pathHelpers.filesystem.abs(...arguments) : pathHelpers.url.abs(...arguments);
   },
 
-  unixify() {
+  unixify(..._args: any[]) {
     // @ts-expect-error TS(2556): A spread argument must either have a tuple type or... Remove this comment to see the full error message
     return !isDom ? pathHelpers.filesystem.unixify(...arguments) : pathHelpers.url.unixify(...arguments);
   },
 
-  url() {
+  url(..._args: any[]) {
     // @ts-expect-error TS(2556): A spread argument must either have a tuple type or... Remove this comment to see the full error message
     return !isDom ? pathHelpers.filesystem.url(...arguments) : pathHelpers.url.url(...arguments);
   },
 
-  cwd() {
+  cwd(..._args: any[]) {
     // @ts-expect-error TS(2556): A spread argument must either have a tuple type or... Remove this comment to see the full error message
     return !isDom ? pathHelpers.filesystem.cwd(...arguments) : pathHelpers.url.cwd(...arguments);
   },