Merge pull request #51 from stoplightio/fix/2385-external-ref-resolution

fix bug in test helper

Author: mmarti21

.github/workflows/CI-CD.yaml

@@ -67,7 +67,7 @@ jobs:
  matrix:
  os:
  - ubuntu-latest # Chrome, Firefox
- - windows-latest # Internet Explorer
+ - windows-latest # Edge
 
  steps:
  - name: Checkout source

lib/resolve-external.js

@@ -75,11 +75,7 @@ function crawl (obj, path, $refs, options, external, seen) {
  if (external && $Ref.is$Ref(obj)) {
  /* Correct the reference in the external document so we can resolve it */
  let withoutHash = url.stripHash(path);
- const isFileUrl = withoutHash.substr(0, 7).toLowerCase() === "file://";
- if (isFileUrl) {
- // Strip-off the protocol
- withoutHash = withoutHash.substr(7);
- }
+ withoutHash = url.removeFileProtocol(withoutHash);
  obj.$ref = withoutHash + obj.$ref;
  }
 

lib/util/url.js

@@ -240,6 +240,34 @@ exports.toFileSystemPath = function toFileSystemPath (path, keepFileProtocol) {
  return path;
 };
 
+/**
+ * Removes file protocol from path.
+ *
+ * @param {string} path
+ * @returns {string}
+ */
+exports.removeFileProtocol = function removeFileProtocol (path) {
+ // Step 1: `decodeURI` will decode characters such as Cyrillic characters, spaces, etc.
+ path = decodeURI(path);
+
+ // Step 2: Manually decode characters that are not decoded by `decodeURI`.
+ // This includes characters such as "#" and "?", which have special meaning in URLs,
+ // but are just normal characters in a filesystem path.
+ for (let i = 0; i < urlDecodePatterns.length; i += 2) {
+ path = path.replace(urlDecodePatterns[i], urlDecodePatterns[i + 1]);
+ }
+
+ // Step 3: If it's a "file://" URL, then format it consistently
+ // or convert it to a local filesystem path
+ let isFileUrl = path.substr(0, 7).toLowerCase() === "file://";
+ if (isFileUrl) {
+ // Strip-off the protocol, and the initial "/", if there is one
+ path = path.substr(7);
+ }
+
+ return path;
+};
+
 /**
  * Converts a $ref pointer to a valid JSON Path.
  *

test/utils/helper.js

@@ -83,7 +83,7 @@ const helper = (module.exports = {
  if (typeof entry.$ref === "string") {
  if (entry.$ref.startsWith("#")) {
  clonedExpected[i].$ref =
- url.toFileSystemPath(filePath) + entry.$ref;
+ url.removeFileProtocol(filePath) + entry.$ref;
  }
  continue;
  } else {