fix: issue #82

Author: sagold

package.json

@@ -82,12 +82,13 @@
     "watch": "^1.0.1"
   },
   "dependencies": {
-    "@sagold/json-pointer": "^7.0.0",
+    "@sagold/json-pointer": "^7.2.0",
     "@sagold/json-query": "^6.2.0",
     "deepmerge": "^4.3.1",
     "fast-copy": "^3.0.2",
     "fast-deep-equal": "^3.1.3",
     "smtp-address-parser": "1.0.10",
+    "uri-js": "^4.4.1",
     "valid-url": "^1.0.9"
   },
   "resolutions": {

src/SchemaNode.ts

@@ -8,7 +8,7 @@ import { toSchemaNodes } from "./methods/toSchemaNodes";
 import { isJsonError, JsonSchema, JsonError, ErrorData, DefaultErrors, OptionalNodeOrError } from "./types";
 import { isObject } from "./utils/isObject";
 import { join } from "@sagold/json-pointer";
-import { joinId } from "./utils/joinId";
+import { resolveUri } from "./utils/resolveUri";
 import { mergeNode } from "./mergeNode";
 import { omit } from "./utils/omit";
 import { pick } from "./utils/pick";
@@ -397,7 +397,7 @@ export const SchemaNodeMethods = {
      */
     addRemoteSchema(url: string, schema: JsonSchema): SchemaNode {
         // @draft >= 6
-        schema.$id = joinId(schema.$id || url);
+        schema.$id = resolveUri(schema.$id || url);
         const { context } = this as SchemaNode;
         const draft = getDraft(context.drafts, schema?.$schema ?? this.context.rootNode.$schema);
 
@@ -420,7 +420,7 @@ export const SchemaNodeMethods = {
         } as SchemaNode;
 
         node.context.rootNode = node;
-        node.context.remotes[joinId(url)] = node;
+        node.context.remotes[resolveUri(url)] = node;
         addKeywords(node);
 
         return this;

src/draft04/keywords/$ref.ts

@@ -1,5 +1,5 @@
 import { Keyword, ValidationPath } from "../../Keyword";
-import { joinId } from "../../utils/joinId";
+import { resolveUri } from "../../utils/resolveUri";
 import { isObject } from "../../utils/isObject";
 import { omit } from "../../utils/omit";
 import splitRef from "../../utils/splitRef";
@@ -24,7 +24,7 @@ function parseRef(node: SchemaNode) {
     // get and store current id of node - this may be the same as parent id
     let currentId = node.parent?.$id;
     if (node.schema?.$ref == null && node.schema?.id) {
-        currentId = joinId(node.parent?.$id, node.schema.id);
+        currentId = resolveUri(node.parent?.$id, node.schema.id);
         // console.log("create id", node.evaluationPath, ":", node.parent?.$id, node.schema?.id, "=>", currentId);
     }
     node.$id = currentId;
@@ -46,15 +46,15 @@ function parseRef(node: SchemaNode) {
     // store this node for retrieval by id + json-pointer from id
     if (node.lastIdPointer !== "#" && node.evaluationPath.startsWith(node.lastIdPointer)) {
         const localPointer = `#${node.evaluationPath.replace(node.lastIdPointer, "")}`;
-        register(node, joinId(currentId, localPointer));
+        register(node, resolveUri(currentId, localPointer));
     } else {
-        register(node, joinId(currentId, node.evaluationPath));
+        register(node, resolveUri(currentId, node.evaluationPath));
     }
-    register(node, joinId(node.context.rootNode.$id, node.evaluationPath));
+    register(node, resolveUri(node.context.rootNode.$id, node.evaluationPath));
 
     // precompile reference
     if (node.schema.$ref) {
-        node.$ref = joinId(currentId, node.schema.$ref);
+        node.$ref = resolveUri(currentId, node.schema.$ref);
     }
 }
 

src/draft06/keywords/$ref.ts

@@ -1,7 +1,7 @@
 import { Keyword, JsonSchemaValidatorParams, ValidationPath } from "../../Keyword";
 import { resolveRef } from "../../keywords/$ref";
 import { SchemaNode } from "../../types";
-import { joinId } from "../../utils/joinId";
+import { resolveUri } from "../../utils/resolveUri";
 import { validateNode } from "../../validateNode";
 
 export const $refKeyword: Keyword = {
@@ -16,7 +16,7 @@ function parseRef(node: SchemaNode) {
     // get and store current $id of node - this may be the same as parent $id
     let currentId = node.parent?.$id;
     if (node.schema?.$ref == null) {
-        currentId = joinId(node.parent?.$id, node.schema?.$id);
+        currentId = resolveUri(node.parent?.$id, node.schema?.$id);
     }
     node.$id = currentId;
     node.lastIdPointer = node.parent?.lastIdPointer ?? "#";
@@ -37,15 +37,15 @@ function parseRef(node: SchemaNode) {
     // store this node for retrieval by $id + json-pointer from $id
     if (node.lastIdPointer !== "#" && node.evaluationPath.startsWith(node.lastIdPointer)) {
         const localPointer = `#${node.evaluationPath.replace(node.lastIdPointer, "")}`;
-        node.context.refs[joinId(currentId, localPointer)] = node;
+        node.context.refs[resolveUri(currentId, localPointer)] = node;
     } else {
-        node.context.refs[joinId(currentId, node.evaluationPath)] = node;
+        node.context.refs[resolveUri(currentId, node.evaluationPath)] = node;
     }
-    node.context.refs[joinId(node.context.rootNode.$id, node.evaluationPath)] = node;
+    node.context.refs[resolveUri(node.context.rootNode.$id, node.evaluationPath)] = node;
 
     // precompile reference
     if (node.schema.$ref) {
-        node.$ref = joinId(currentId, node.schema.$ref);
+        node.$ref = resolveUri(currentId, node.schema.$ref);
     }
 }
 

src/draft2019-09/keywords/$ref.ts

@@ -1,5 +1,5 @@
 import { Keyword, JsonSchemaValidatorParams, ValidationPath } from "../../Keyword";
-import { joinId } from "../../utils/joinId";
+import { resolveUri } from "../../utils/resolveUri";
 import splitRef from "../../utils/splitRef";
 import { omit } from "../../utils/omit";
 import { isObject } from "../../utils/isObject";
@@ -29,7 +29,7 @@ export function parseRef(node: SchemaNode) {
     node.resolveRef = resolveRef;
 
     // get and store current $id of node - this may be the same as parent $id
-    const currentId = joinId(node.parent?.$id, node.schema?.$id);
+    const currentId = resolveUri(node.parent?.$id, node.schema?.$id);
     node.$id = currentId;
     node.lastIdPointer = node.parent?.lastIdPointer ?? "#";
     if (currentId !== node.parent?.$id && node.evaluationPath !== "#") {
@@ -39,18 +39,19 @@ export function parseRef(node: SchemaNode) {
     // store this node for retrieval by $id + json-pointer from $id
     if (node.lastIdPointer !== "#" && node.evaluationPath.startsWith(node.lastIdPointer)) {
         const localPointer = `#${node.evaluationPath.replace(node.lastIdPointer, "")}`;
-        register(node, joinId(currentId, localPointer));
+        register(node, resolveUri(currentId, localPointer));
     }
     // store $rootId + json-pointer to this node
-    register(node, joinId(node.context.rootNode.$id, node.evaluationPath));
+    register(node, resolveUri(node.context.rootNode.$id, node.evaluationPath));
+
     // store this node for retrieval by $id + anchor
     if (node.schema.$anchor) {
         node.context.anchors[`${currentId.replace(/#$/, "")}#${node.schema.$anchor}`] = node;
     }
 
     // precompile reference
     if (node.schema.$ref) {
-        node.$ref = joinId(currentId, node.schema.$ref);
+        node.$ref = resolveUri(currentId, node.schema.$ref);
         if (node.$ref.startsWith("/")) {
             node.$ref = `#${node.$ref}`;
         }
@@ -108,7 +109,7 @@ function resolveRecursiveRef(node: SchemaNode, path: ValidationPath): SchemaNode
     for (let i = history.length - 1; i >= 0; i--) {
         if (history[i].node.schema.$recursiveAnchor === false) {
             // $recursiveRef with $recursiveAnchor: false works like $ref
-            const nextNode = getRef(node, joinId(node.$id, node.schema.$recursiveRef));
+            const nextNode = getRef(node, resolveUri(node.$id, node.schema.$recursiveRef));
             return nextNode;
         }
         if (/^https?:\/\//.test(history[i].node.schema.$id ?? "") && history[i].node.schema.$recursiveAnchor !== true) {
@@ -124,7 +125,7 @@ function resolveRecursiveRef(node: SchemaNode, path: ValidationPath): SchemaNode
     }
 
     // $recursiveRef with no $recursiveAnchor works like $ref?
-    const nextNode = getRef(node, joinId(node.$id, node.schema.$recursiveRef));
+    const nextNode = getRef(node, resolveUri(node.$id, node.schema.$recursiveRef));
     return nextNode;
 }
 

src/keywords/$ref.ts

@@ -1,6 +1,6 @@
 import { SchemaNode } from "../types";
 import { Keyword, JsonSchemaValidatorParams, ValidationPath, JsonSchemaReducerParams } from "../Keyword";
-import { joinId } from "../utils/joinId";
+import { resolveUri } from "../utils/resolveUri";
 import splitRef from "../utils/splitRef";
 import { omit } from "../utils/omit";
 import { isObject } from "../utils/isObject";
@@ -31,7 +31,7 @@ export function parseRef(node: SchemaNode) {
     node.resolveRef = resolveRef;
 
     // get and store current $id of node - this may be the same as parent $id
-    const currentId = joinId(node.parent?.$id, node.schema?.$id);
+    const currentId = resolveUri(node.parent?.$id, node.schema?.$id);
     node.$id = currentId;
     node.lastIdPointer = node.parent?.lastIdPointer ?? "#";
     if (currentId !== node.parent?.$id && node.evaluationPath !== "#") {
@@ -41,10 +41,10 @@ export function parseRef(node: SchemaNode) {
     // store this node for retrieval by $id + json-pointer from $id
     if (node.lastIdPointer !== "#" && node.evaluationPath.startsWith(node.lastIdPointer)) {
         const localPointer = `#${node.evaluationPath.replace(node.lastIdPointer, "")}`;
-        register(node, joinId(currentId, localPointer));
+        register(node, resolveUri(currentId, localPointer));
     }
     // store $rootId + json-pointer to this node
-    register(node, joinId(node.context.rootNode.$id, node.evaluationPath));
+    register(node, resolveUri(node.context.rootNode.$id, node.evaluationPath));
 
     // @draft-2020:  A $dynamicRef to a $dynamicAnchor in the same schema resource behaves like a normal $ref to an $anchor
     const anchor = node.schema.$anchor;
@@ -67,7 +67,7 @@ export function parseRef(node: SchemaNode) {
 
     // precompile reference
     if (node.schema.$ref) {
-        node.$ref = joinId(currentId, node.schema.$ref);
+        node.$ref = resolveUri(currentId, node.schema.$ref);
         if (node.$ref.startsWith("/")) {
             node.$ref = `#${node.$ref}`;
         }
@@ -124,7 +124,7 @@ function validateRef({ node, data, pointer = "#", path }: JsonSchemaValidatorPar
 // 1. https://json-schema.org/draft/2019-09/json-schema-core#scopes
 function resolveRecursiveRef(node: SchemaNode, path: ValidationPath): SchemaNode {
     const history = path;
-    const refInCurrentScope = joinId(node.$id, node.schema.$dynamicRef);
+    const refInCurrentScope = resolveUri(node.$id, node.schema.$dynamicRef);
 
     // A $dynamicRef with a non-matching $dynamicAnchor in the same schema resource behaves like a normal $ref to $anchor
     const nonMatchingDynamicAnchor = node.context.dynamicAnchors[refInCurrentScope] == null;
@@ -142,7 +142,7 @@ function resolveRecursiveRef(node: SchemaNode, path: ValidationPath): SchemaNode
 
         // A $dynamicRef only stops at a $dynamicAnchor if it is in the same dynamic scope.
         const refWithoutScope = node.schema.$dynamicRef.split("#").pop();
-        const ref = joinId(history[i].node.$id, `#${refWithoutScope}`);
+        const ref = resolveUri(history[i].node.$id, `#${refWithoutScope}`);
         const anchorNode = node.context.dynamicAnchors[ref];
         if (anchorNode) {
             return compileNext(node.context.dynamicAnchors[ref], node);

src/tests/issues/issue82.test.ts

@@ -4,7 +4,7 @@ import { compileSchema } from "../../compileSchema";
 // @todo investigate different requirements on joining url and id
 // here json-schemer://schema + stock-assembly is joined to json-schemer://stock-assembly
 // in joinId: const trailingFragments = /\/\/*$/; will fix this issue but fail spec tests
-describe.skip("issue#82", () => {
+describe("issue#82", () => {
     it("should return validation errors for number", () => {
         const schema = compileSchema({
             $schema: "https://json-schema.org/draft/2020-12/schema",
@@ -15,7 +15,7 @@ describe.skip("issue#82", () => {
                     $ref: "stock-assembly"
                 }
             },
-            $id: "json-schemer://schema", // this works only if a trailing slash
+            $id: "json-schemer://schema", // this works only for a trailing slash
             $defs: {
                 "json-schemer://schema/stock-assembly": {
                     $schema: "http://json-schema.org/draft-07/schema#",
@@ -35,6 +35,44 @@ describe.skip("issue#82", () => {
             "stock-assembly": 1
         });
 
+        console.log(errors);
+
+        assert.equal(valid, false);
+    });
+
+    it("should return validation error for initial example", () => {
+        const schema = compileSchema({
+            $schema: "https://json-schema.org/draft/2020-12/schema",
+            type: "object",
+            properties: {
+                "1c_list_Document_СборкаЗапасов": {
+                    $ref: "1c_list_Document_%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0%D0%97%D0%B0%D0%BF%D0%B0%D1%81%D0%BE%D0%B2"
+                }
+            },
+            required: ["1c_list_Document_СборкаЗапасов"],
+            $id: "json-schemer://schema",
+            $defs: {
+                "json-schemer://schema/1c_list_Document_%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0%D0%97%D0%B0%D0%BF%D0%B0%D1%81%D0%BE%D0%B2":
+                    {
+                        $schema: "http://json-schema.org/draft-07/schema#",
+                        type: "object",
+                        properties: {
+                            $filter: {
+                                type: "string",
+                                title: "Фильтр"
+                            }
+                        },
+                        $id: "json-schemer://schema/1c_list_Document_%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0%D0%97%D0%B0%D0%BF%D0%B0%D1%81%D0%BE%D0%B2"
+                    }
+            }
+        });
+
+        const { valid, errors } = schema.validate({
+            "1c_list_Document_СборкаЗапасов": 1
+        });
+
+        console.log(errors);
+
         assert.equal(valid, false);
     });
 });