Merge pull request #37 from stoplightio/fix/fetch-auth

fix(http): replace url based basic auth with header

Author: mmarti21

.circleci/config.yml

@@ -49,8 +49,8 @@ jobs:
  docker:
  - image: cimg/node:16.13-browsers
  steps:
- - browser-tools/install-browser-tools
  - checkout
+ - browser-tools/install-browser-tools
  - install
  - run:
  name: Run browser tests
@@ -65,7 +65,6 @@ workflows:
  os:
  - linux
  node-version:
- - "12.22"
  - "14.19"
  - "16.13"
  - test-browser

lib/index.js

@@ -27,7 +27,7 @@ module.exports.UnmatchedResolverError = UnmatchedResolverError;
  * This class parses a JSON schema, builds a map of its JSON references and their resolved values,
  * and provides methods for traversing, manipulating, and dereferencing those references.
  *
- * @constructor
+ * @class
  */
 function $RefParser () {
  /**
@@ -55,7 +55,7 @@ function $RefParser () {
  * @param {string} [path] - The file path or URL of the JSON schema
  * @param {object} [schema] - A JSON schema object. This object will be used instead of reading from `path`.
  * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed
- * @param {function} [callback] - An error-first callback. The second parameter is the parsed JSON schema object.
+ * @param {Function} [callback] - An error-first callback. The second parameter is the parsed JSON schema object.
  * @returns {Promise} - The returned promise resolves with the parsed JSON schema object.
  */
 $RefParser.parse = function parse (path, schema, options, callback) {
@@ -72,7 +72,7 @@ $RefParser.parse = function parse (path, schema, options, callback) {
  * @param {string} [path] - The file path or URL of the JSON schema
  * @param {object} [schema] - A JSON schema object. This object will be used instead of reading from `path`.
  * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed
- * @param {function} [callback] - An error-first callback. The second parameter is the parsed JSON schema object.
+ * @param {Function} [callback] - An error-first callback. The second parameter is the parsed JSON schema object.
  * @returns {Promise} - The returned promise resolves with the parsed JSON schema object.
  */
 $RefParser.prototype.parse = async function parse (path, schema, options, callback) {
@@ -152,7 +152,7 @@ $RefParser.prototype.parse = async function parse (path, schema, options, callba
  * @param {string} [path] - The file path or URL of the JSON schema
  * @param {object} [schema] - A JSON schema object. This object will be used instead of reading from `path`.
  * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed and resolved
- * @param {function} [callback]
+ * @param {Function} [callback]
  * - An error-first callback. The second parameter is a {@link $Refs} object containing the resolved JSON references
  *
  * @returns {Promise}
@@ -171,7 +171,7 @@ $RefParser.resolve = function resolve (path, schema, options, callback) {
  * @param {string} [path] - The file path or URL of the JSON schema
  * @param {object} [schema] - A JSON schema object. This object will be used instead of reading from `path`.
  * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed and resolved
- * @param {function} [callback]
+ * @param {Function} [callback]
  * - An error-first callback. The second parameter is a {@link $Refs} object containing the resolved JSON references
  *
  * @returns {Promise}
@@ -200,7 +200,7 @@ $RefParser.prototype.resolve = async function resolve (path, schema, options, ca
  * @param {string} [path] - The file path or URL of the JSON schema
  * @param {object} [schema] - A JSON schema object. This object will be used instead of reading from `path`.
  * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed, resolved, and dereferenced
- * @param {function} [callback] - An error-first callback. The second parameter is the bundled JSON schema object
+ * @param {Function} [callback] - An error-first callback. The second parameter is the bundled JSON schema object
  * @returns {Promise} - The returned promise resolves with the bundled JSON schema object.
  */
 $RefParser.bundle = function bundle (path, schema, options, callback) {
@@ -217,7 +217,7 @@ $RefParser.bundle = function bundle (path, schema, options, callback) {
  * @param {string} [path] - The file path or URL of the JSON schema
  * @param {object} [schema] - A JSON schema object. This object will be used instead of reading from `path`.
  * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed, resolved, and dereferenced
- * @param {function} [callback] - An error-first callback. The second parameter is the bundled JSON schema object
+ * @param {Function} [callback] - An error-first callback. The second parameter is the bundled JSON schema object
  * @returns {Promise} - The returned promise resolves with the bundled JSON schema object.
  */
 $RefParser.prototype.bundle = async function bundle (path, schema, options, callback) {
@@ -242,7 +242,7 @@ $RefParser.prototype.bundle = async function bundle (path, schema, options, call
  * @param {string} [path] - The file path or URL of the JSON schema
  * @param {object} [schema] - A JSON schema object. This object will be used instead of reading from `path`.
  * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed, resolved, and dereferenced
- * @param {function} [callback] - An error-first callback. The second parameter is the dereferenced JSON schema object
+ * @param {Function} [callback] - An error-first callback. The second parameter is the dereferenced JSON schema object
  * @returns {Promise} - The returned promise resolves with the dereferenced JSON schema object.
  */
 $RefParser.dereference = function dereference (path, schema, options, callback) {
@@ -258,7 +258,7 @@ $RefParser.dereference = function dereference (path, schema, options, callback)
  * @param {string} [path] - The file path or URL of the JSON schema
  * @param {object} [schema] - A JSON schema object. This object will be used instead of reading from `path`.
  * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed, resolved, and dereferenced
- * @param {function} [callback] - An error-first callback. The second parameter is the dereferenced JSON schema object
+ * @param {Function} [callback] - An error-first callback. The second parameter is the dereferenced JSON schema object
  * @returns {Promise} - The returned promise resolves with the dereferenced JSON schema object.
  */
 $RefParser.prototype.dereference = async function dereference (path, schema, options, callback) {

lib/options.js

@@ -14,7 +14,7 @@ module.exports = $RefParserOptions;
  * Options that determine how JSON schemas are parsed, resolved, and dereferenced.
  *
  * @param {object|$RefParserOptions} [options] - Overridden options
- * @constructor
+ * @class
  */
 function $RefParserOptions (options) {
  merge(this, $RefParserOptions.defaults);
@@ -59,7 +59,7 @@ $RefParserOptions.defaults = {
  * By default, JSON Schema $Ref Parser throws the first error it encounters. Setting `continueOnError` to `true`
  * causes it to keep processing as much as possible and then throw a single error that contains all errors
  * that were encountered.
- */
+  */
  continueOnError: false,
 
  /**
@@ -132,7 +132,7 @@ function merge (target, source) {
  * or if it is a scalar value that should just override the target value.
  *
  * @param {*} val
- * @returns {Boolean}
+ * @returns {boolean}
  */
 function isMergeable (val) {
  return val &&

lib/parsers/json.js

@@ -26,7 +26,7 @@ module.exports = {
  * Parsers that don't match will be skipped, UNLESS none of the parsers match, in which case
  * every parser will be tried.
  *
- * @type {RegExp|string|string[]|function}
+ * @type {RegExp | string | string[] | Function}
  */
  canParse: ".json",
 

lib/parsers/yaml.js

@@ -27,7 +27,7 @@ module.exports = {
  * Parsers that don't match will be skipped, UNLESS none of the parsers match, in which case
  * every parser will be tried.
  *
- * @type {RegExp|string[]|function}
+ * @type {RegExp | string[] | Function}
  */
  canParse: [".yaml", ".yml", ".json"], // JSON is valid YAML
 

lib/pointer.js

@@ -16,44 +16,50 @@ const escapedTilde = /~0/g;
  * @param {$Ref} $ref
  * @param {string} path
  * @param {string} [friendlyPath] - The original user-specified path (used for error messages)
- * @constructor
+ * @class
  */
 function Pointer ($ref, path, friendlyPath) {
  /**
  * The {@link $Ref} object that contains this {@link Pointer} object.
+ *
  * @type {$Ref}
  */
  this.$ref = $ref;
 
  /**
  * The file path or URL, containing the JSON pointer in the hash.
  * This path is relative to the path of the main JSON schema file.
+ *
  * @type {string}
  */
  this.path = path;
 
  /**
  * The original path or URL, used for error messages.
+ *
  * @type {string}
  */
  this.originalPath = friendlyPath || path;
 
  /**
  * The value of the JSON pointer.
  * Can be any JSON type, not just objects. Unknown file types are represented as Buffers (byte arrays).
+ *
  * @type {?*}
  */
  this.value = undefined;
 
  /**
  * Indicates whether the pointer references itself.
+ *
  * @type {boolean}
  */
  this.circular = false;
 
  /**
  * The number of indirect references that were traversed to resolve the value.
  * Resolving a single pointer may require resolving multiple $Refs.
+ *
  * @type {number}
  */
  this.indirections = 0;

lib/ref.js

@@ -9,7 +9,7 @@ const { safePointerToPath, stripHash, getHash } = require("./util/url");
 /**
  * This class represents a single JSON reference and its resolved value.
  *
- * @constructor
+ * @class
  */
 function $Ref () {
  /**
@@ -27,24 +27,28 @@ function $Ref () {
  /**
  * The resolved value of the JSON reference.
  * Can be any JSON type, not just objects. Unknown file types are represented as Buffers (byte arrays).
+ *
  * @type {?*}
  */
  this.value = undefined;
 
  /**
  * The {@link $Refs} object that contains this {@link $Ref} object.
+ *
  * @type {$Refs}
  */
  this.$refs = undefined;
 
  /**
  * Indicates the type of {@link $Ref#path} (e.g. "file", "http", etc.)
+ *
  * @type {?string}
  */
  this.pathType = undefined;
 
  /**
  * List of all errors. Undefined if no errors.
+ *
  * @type {Array<JSONParserError | ResolverError | ParserError | MissingPointerError>}
  */
  this.errors = undefined;
@@ -106,7 +110,7 @@ $Ref.prototype.get = function (path, options) {
  * @param {string} path - The full path being resolved, optionally with a JSON pointer in the hash
  * @param {$RefParserOptions} options
  * @param {string} friendlyPath - The original user-specified path (used for error messages)
-* @param {string} pathFromRoot - The path of `obj` from the schema root
+ * @param {string} pathFromRoot - The path of `obj` from the schema root
  * @returns {Pointer}
  */
 $Ref.prototype.resolve = function (path, options, friendlyPath, pathFromRoot) {

lib/resolvers/http.js

@@ -81,7 +81,7 @@ module.exports = {
  }
 
  return download(u, this, []);
- }
+ },
 };
 
 /**
@@ -99,16 +99,29 @@ async function download (u, httpOptions, redirects) {
 
  redirects.push(u.href);
 
+ // Certain implementations of `fetch` do not support URL based basic-auth
+ // Convert to headers
+ const headers = new Headers(httpOptions.headers);
+ if (u.auth && !headers.has("Authorization")) {
+ headers.set("Authorization", "Basic " + btoa(u.auth));
+ }
+
+ u = url.parse(url.format(Object.assign(u, { auth: "" })));
+
  const controller = new AbortController();
 
  /** @type {RequestInit} */
  const init = {
  method: "GET",
- headers: httpOptions.headers || {},
+ headers: Object.fromEntries(headers.entries()),
  credentials: httpOptions.withCredentials ? "include" : "omit",
  signal: controller.signal,
  // browser fetch API does not support redirects https://fetch.spec.whatwg.org/#atomic-http-redirect-handling
- redirect: process.browser ? "follow" : httpOptions.redirects === 0 ? "error" : "manual",
+ redirect: process.browser
+ ? "follow"
+ : httpOptions.redirects === 0
+ ? "error"
+ : "manual",
  };
 
  let timeout;
@@ -124,13 +137,24 @@ async function download (u, httpOptions, redirects) {
 
  if (res.status >= 300 && res.status < 400) {
  if (redirects.length > httpOptions.redirects) {
- throw new ResolverError(ono({ status: res.status },
- `Error downloading ${redirects[0]}. \nToo many redirects: \n ${redirects.join(" \n ")}`));
+ throw new ResolverError(
+ ono(
+ { status: res.status },
+ `Error downloading ${
+ redirects[0]
+ }. \nToo many redirects: \n ${redirects.join(" \n ")}`
+ )
+ );
  }
 
  let location = res.headers.get("Location");
  if (!location) {
- throw new ResolverError(ono({ status: res.status }, `HTTP ${res.status} redirect with no location header`));
+ throw new ResolverError(
+ ono(
+ { status: res.status },
+ `HTTP ${res.status} redirect with no location header`
+ )
+ );
  }
 
  let redirectTo = url.resolve(u, location);

lib/util/plugins.js

@@ -5,7 +5,7 @@
  * All other methods in this module expect an array of plugins rather than an object map.
  *
  * @param {object} plugins - A map of plugin objects
- * @return {object[]}
+ * @returns {object[]}
  */
 exports.all = function (plugins) {
  return Object.keys(plugins)
@@ -24,7 +24,7 @@ exports.all = function (plugins) {
  * @param {object[]} plugins - An array of plugin objects
  * @param {string} method - The name of the filter method to invoke for each plugin
  * @param {object} file - A file info object, which will be passed to each method
- * @return {object[]}
+ * @returns {object[]}
  */
 exports.filter = function (plugins, method, file) {
  return plugins
@@ -128,7 +128,7 @@ exports.run = function (plugins, method, file, $refs) {
  * @param {object} obj - The object whose property/method is called
  * @param {string} prop - The name of the property/method to invoke
  * @param {object} file - A file info object, which will be passed to the method
- * @param {function} [callback] - A callback function, which will be passed to the method
+ * @param {Function} [callback] - A callback function, which will be passed to the method
  * @returns {*}
  */
 function getResult (obj, prop, file, callback, $refs) {

lib/util/url.js

@@ -10,20 +10,23 @@ let isWindows = /^win/.test(process.platform),
  jsonPointerTilde = /~0/g;
 
 // RegExp patterns to URL-encode special characters in local filesystem paths
-let urlEncodePatterns = [
- /\?/g, "%3F",
- /\#/g, "%23",
-];
+let urlEncodePatterns = [/\?/g, "%3F", /\#/g, "%23"];
 
 // RegExp patterns to URL-decode special characters for local filesystem paths
 let urlDecodePatterns = [
- /\%23/g, "#",
- /\%24/g, "$",
- /\%26/g, "&",
- /\%2C/g, ",",
- /\%40/g, "@"
+ /\%23/g,
+ "#",
+ /\%24/g,
+ "$",
+ /\%26/g,
+ "&",
+ /\%2C/g,
+ ",",
+ /\%40/g,
+ "@",
 ];
 
+exports.format = require("url").format;
 exports.parse = require("url").parse;
 exports.resolve = require("url").resolve;
 
@@ -269,7 +272,11 @@ exports.safePathToPointer = function safePointerToPath (path) {
  return "#";
  }
 
- return `#/${path.map(segment => {
- return typeof segment === "number" ? String(segment) : segment.replace(tilde, "~0").replace(slash, "~1");
- }).join("/")}`;
+ return `#/${path
+ .map((segment) => {
+ return typeof segment === "number"
+ ? String(segment)
+ : segment.replace(tilde, "~0").replace(slash, "~1");
+ })
+ .join("/")}`;
 };