fix: replace deprecated resolve function

Author: philsturgeon

lib/util/url.js

@@ -23,7 +23,21 @@ let urlDecodePatterns = [
 ];
 
 exports.parse = require("url").parse;
-exports.resolve = require("url").resolve;
+
+/**
+ * Returns resolved target URL relative to a base URL in a manner similar to that of a Web browser resolving an anchor tag HREF.
+ *
+ * @return {string}
+ */
+exports.resolve = function resolve (from, to) {
+  let resolvedUrl = new URL(to, new URL(from, "resolve://"));
+  if (resolvedUrl.protocol === "resolve:") {
+    // `from` is a relative URL.
+    let { pathname, search, hash } = resolvedUrl;
+    return pathname + search + hash;
+  }
+  return resolvedUrl.toString();
+};
 
 /**
  * Returns the current working directory (in Node) or the current page URL (in browsers).

test/specs/resolvers/dereferenced.js

@@ -8,6 +8,11 @@ module.exports =
         baz: "hello world"
       }
     },
+    bar: {
+      Foo: {
+        Baz: "hello world"
+      }
+    },
     name: {
       required: [
         "first",

test/specs/resolvers/parsed.js

@@ -6,6 +6,9 @@ module.exports =
     foo: {
       $ref: "foo://bar.baz"
     },
+    bar: {
+      $ref: "bar://Foo.Baz"
+    },
     pet: {
       $ref: "definitions/pet.yaml"
     },

test/specs/resolvers/resolvers.spec.js

@@ -37,9 +37,14 @@ describe("options.resolve", () => {
           foo: {
             canRead: /^foo\:\/\//i,
             read: { bar: { baz: "hello world" }}
+          },
+          bar: {
+            canRead: /^bar\:\/\//i,
+            read: { Foo: { Baz: "hello world" }}
           }
         }
       });
+
     expect(schema).to.deep.equal(dereferencedSchema);
   });
 
@@ -53,12 +58,44 @@ describe("options.resolve", () => {
             read (_file) {
               return { bar: { baz: "hello world" }};
             }
+          },
+          bar: {
+            canRead: /^bar\:\/\//i,
+            read (_file) {
+              return { Foo: { Baz: "hello world" }};
+            }
           }
         }
       });
     expect(schema).to.deep.equal(dereferencedSchema);
   });
 
+  it("should return _file url as it's written", async () => {
+    const schema = await $RefParser
+      .dereference(path.abs("specs/resolvers/resolvers.yaml"), {
+        resolve: {
+          // A custom resolver for "foo://" URLs
+          foo: {
+            canRead: /^foo\:\/\//i,
+            read (_file) {
+              return { bar: { baz: "hello world" }};
+            }
+          },
+          // A custom resolver with uppercase symbols
+          bar: {
+            canRead: /^bar\:\/\//i,
+            read (_file) {
+              expect(_file.url).to.be.equal("bar://Foo.Baz");
+
+              return { Foo: { Baz: "hello world" }};
+            }
+          }
+        }
+      });
+
+    expect(schema).to.deep.equal(dereferencedSchema);
+  });
+
   it("should use a custom resolver that calls a callback", async () => {
     const schema = await $RefParser
       .dereference(path.abs("specs/resolvers/resolvers.yaml"), {
@@ -69,6 +106,12 @@ describe("options.resolve", () => {
             read (_file, callback) {
               callback(null, { bar: { baz: "hello world" }});
             }
+          },
+          bar: {
+            canRead: /^bar\:\/\//i,
+            read (_file, callback) {
+              callback(null, { Foo: { Baz: "hello world" }});
+            }
           }
         }
       });
@@ -86,6 +129,12 @@ describe("options.resolve", () => {
               read (_file) {
                 return Promise.resolve({ bar: { baz: "hello world" }});
               }
+            },
+            bar: {
+              canRead: /^bar\:\/\//i,
+              read (_file) {
+                return Promise.resolve({ Foo: { Baz: "hello world" }});
+              }
             }
           }
         });
@@ -109,6 +158,10 @@ describe("options.resolve", () => {
           foo: {
             canRead: /^foo\:\/\//i,
             read: { bar: { baz: "hello world" }}
+          },
+          bar: {
+            canRead: /^bar\:\/\//i,
+            read: { Foo: { Baz: "hello world" }}
           }
         }
       });
@@ -180,7 +233,7 @@ describe("options.resolve", () => {
           message: message => message.startsWith("Could not find resolver for"),
           path: [],
           source: message => message.endsWith("specs/resolvers/resolvers.yaml"),
-        },
+        }
       ]);
     }
   });

test/specs/resolvers/resolvers.yaml

@@ -27,5 +27,7 @@ definitions:
         $ref: "#/definitions/name/properties/first"
   foo:
     $ref: foo://bar.baz
+  bar:
+    $ref: bar://Foo.Baz
   pet:
     $ref: definitions/pet.yaml