Merge pull request #271 from zcstarr/fix/nested-json-resolution

fix: This corrects the behavior for nested resolution for json schemas.

Author: shanejonas

nestedtest/test-schema.json

@@ -3,7 +3,7 @@ import { InvalidRemoteURLError, NonJsonRefError } from "./errors";
 import { JSONSchema } from "@json-schema-tools/meta-schema";
 import fetch from "isomorphic-fetch";
 
-const fetchHandler = async (uri: string): Promise<JSONSchema> => {
+const fetchHandler = async (uri: string, root: JSONSchema): Promise<JSONSchema> => {
   let schemaReq;
   try {
     schemaReq = await fetch(uri);

src/default-protocol-handler-map.ts

@@ -71,6 +71,15 @@ describe("referenceResolver", () => {
     expect(resolved.$ref).toBe("./src/test-schema.json");
   });
 
+  it("works with nested folders when using different root context", async () => {
+    expect.assertions(1);
+    const resolved = await referenceResolver
+      .resolve("./test-schema-1.json", {
+        "$ref": "./nestedtest/test-schema.json"
+      }) as JSONSchemaObject;
+    expect(resolved.$ref).toBe("./src/test-schema.json");
+  });
+
   it("errors on urls that arent real", async () => {
     expect.assertions(1);
     try {

src/index.test.ts

@@ -1,8 +1,9 @@
 import ReferenceResolver, { ProtocolHandlerMap } from "./reference-resolver";
 import * as fs from "fs";
-import { JSONSchema } from "@json-schema-tools/meta-schema";
+import { JSONSchema, JSONSchemaObject } from "@json-schema-tools/meta-schema";
 import { InvalidRemoteURLError, NonJsonRefError } from "./errors";
 import defaultProtocolHandlerMap from "./default-protocol-handler-map";
+import path from "path";
 
 const fileExistsAndReadable = (f: string): Promise<boolean> => {
   return new Promise((resolve) => {
@@ -19,12 +20,15 @@ const readFile = (f: string): Promise<string> => {
 
 const nodeProtocolHandlerMap: ProtocolHandlerMap = {
   ...defaultProtocolHandlerMap,
-  "file": async (uri) => {
-    if (await fileExistsAndReadable(uri) === true) {
-      const fileContents = await readFile(uri);
+  "file": async (uri,root: JSONSchema) => {
+    let filePath = uri;
+    const ref = (root as JSONSchemaObject).$ref;
+    if(ref && ref !== uri && await fileExistsAndReadable(ref)) filePath = `${path.parse(ref).dir}/${uri}`;
+    if (await fileExistsAndReadable(filePath) === true) {
+      const fileContents = await readFile(filePath);
       return JSON.parse(fileContents) as JSONSchema;
     }
-  }
+  },
 }
 
 export default new ReferenceResolver(nodeProtocolHandlerMap);

src/index.ts

@@ -11,7 +11,7 @@ const isUrlLike = (s: string) => {
 }
 
 export interface ProtocolHandlerMap {
-  [protocol: string]: (uri: string) => Promise<JSONSchema | undefined>;
+  [protocol: string]: (uri: string, root: JSONSchema) => Promise<JSONSchema | undefined>;
 };
 
 export default class ReferenceResolver {
@@ -41,7 +41,7 @@ export default class ReferenceResolver {
     // protocol handler
     let relativePathSchema;
     try {
-      relativePathSchema = await this.protocolHandlerMap.file(hashlessRef);
+      relativePathSchema = await this.protocolHandlerMap.file(hashlessRef, root);
     } catch (e) {
       throw new NonJsonRefError({ $ref: ref }, e.message);
     }
@@ -57,7 +57,7 @@ export default class ReferenceResolver {
 
     for (const protocol of Object.keys(this.protocolHandlerMap)) {
       if (hashlessRef.startsWith(protocol)) {
-        const maybeSchema = await this.protocolHandlerMap[protocol](hashlessRef);
+        const maybeSchema = await this.protocolHandlerMap[protocol](hashlessRef, root);
 
         if (maybeSchema !== undefined) {
           let schema: JSONSchema = maybeSchema;