Finish the resolve

Signed-off-by: Paulo Lopes <[email protected]>

Author: pmlopes

src/main/java/io/vertx/json/schema/JsonSchema.java

@@ -110,8 +110,7 @@ static JsonSchema of(boolean bool) {
   Set<String> fieldNames();
 
   /**
-   * Tries to resolve all internal references. External references are resolved so you need to
-   * inline them yourself if required.
+   * Tries to resolve all internal references. External references are not resolved.
    *
    * The result is an object where all references have been resolved. Resolution of references is shallow This
    * should normally not be a problem for this use case.

src/main/java/io/vertx/json/schema/impl/JsonObjectSchema.java

@@ -25,6 +25,11 @@ public final class JsonObjectSchema extends JsonObject implements JsonSchema {
 
   public JsonObjectSchema(JsonObject json) {
     super(json.getMap());
+    // inherit the annotated flag
+    this.annotated =
+      json.containsKey("__absolute_uri__") ||
+      json.containsKey("__absolute_ref__") ||
+      json.containsKey("__absolute_recursive_ref__");
   }
 
   @Override
@@ -81,7 +86,7 @@ public JsonObject resolve() {
     final Map<String, List<Ref>> pointers = new HashMap<>();
 
     // find all refs
-    parse(tree, "#", "", pointers);
+    findRefsAndClean(tree, "#", "", pointers);
 
     // resolve them
     final Map<String, JsonObject> anchors = new HashMap<>();
@@ -229,22 +234,31 @@ private static final class Ref {
     }
   }
 
-  private static void parse(Object obj, String path, String id, Map<String, List<Ref>> pointers) {
+  private static void findRefsAndClean(Object obj, String path, String id, Map<String, List<Ref>> pointers) {
     if (!isObject(obj)) {
       return;
     }
     if (obj instanceof JsonObject) {
       final JsonObject json = (JsonObject) obj;
+
+      // clean up annotations
+      json.remove("__absolute_uri__");
+      json.remove("__absolute_ref__");
+      json.remove("__absolute_recursive_ref__");
+
+      // compute the id (according to draft-4 or later)
       if (json.containsKey("$id") || json.containsKey("id")) {
         id = json.getString("$id", json.getString("id"));
       }
+
+      // process the object
       for (String prop : json.fieldNames()) {
         if (POINTER_KEYWORD.contains(prop)) {
           pointers
             .computeIfAbsent(prop, key -> new ArrayList<>())
             .add(new Ref(json.getString(prop), json, prop, path, id));
         }
-        parse(json.getValue(prop), path + "/" + Utils.Pointers.encode(prop), id, pointers);
+        findRefsAndClean(json.getValue(prop), path + "/" + Utils.Pointers.encode(prop), id, pointers);
       }
     }
   }

src/test/java/io/vertx/json/schema/ResolverTest.java

@@ -1,22 +1,31 @@
 package io.vertx.json.schema;
 
+import io.vertx.core.buffer.Buffer;
 import io.vertx.core.json.JsonObject;
-import io.vertx.junit5.Timeout;
 import org.junit.jupiter.api.Test;
 
-import java.util.concurrent.TimeUnit;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Paths;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.fail;
 
 public class ResolverTest {
 
   @Test
-  @Timeout(value = 10, timeUnit = TimeUnit.SECONDS)
   public void testResolves() {
-    JsonObject res =
-      JsonSchema
-        .of(new JsonObject("{\"$id\":\"http://www.example.com/\",\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"definitions\":{\"address\":{\"type\":\"object\",\"properties\":{\"street_address\":{\"type\":\"string\"},\"city\":{\"type\":\"string\"},\"state\":{\"type\":\"string\"},\"subAddress\":{\"$ref\":\"http://www.example.com/#/definitions/address\"}}},\"req\":{\"required\":[\"billing_address\"]}},\"type\":\"object\",\"properties\":{\"billing_address\":{\"$ref\":\"#/definitions/address\"},\"shipping_address\":{\"$ref\":\"#/definitions/address\"}},\"$ref\":\"#/definitions/req\"}"))
-        .resolve();
+
+    SchemaRepository repo = SchemaRepository.create(new JsonSchemaOptions().setBaseUri("http://vertx.io"));
+
+    JsonSchema schema = JsonSchema
+      .of(new JsonObject("{\"$id\":\"http://www.example.com/\",\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"definitions\":{\"address\":{\"type\":\"object\",\"properties\":{\"street_address\":{\"type\":\"string\"},\"city\":{\"type\":\"string\"},\"state\":{\"type\":\"string\"},\"subAddress\":{\"$ref\":\"http://www.example.com/#/definitions/address\"}}},\"req\":{\"required\":[\"billing_address\"]}},\"type\":\"object\",\"properties\":{\"billing_address\":{\"$ref\":\"#/definitions/address\"},\"shipping_address\":{\"$ref\":\"#/definitions/address\"}},\"$ref\":\"#/definitions/req\"}"));
+
+    repo.dereference(schema);
+
+    String before = schema.toString();
+
+    JsonObject res = schema.resolve();
 
     JsonObject ptr = res.getJsonObject("properties").getJsonObject("billing_address").getJsonObject("properties");
     assertThat(ptr.getJsonObject("city").getString("type"))
@@ -30,5 +39,29 @@ public void testResolves() {
     // array checks
     assertThat(res.getJsonArray("required").getString(0))
       .isEqualTo("billing_address");
+
+    assertThat(res.encodePrettily().contains("__absolute_uri")).isFalse();
+    assertThat(res.encodePrettily().contains("__absolute_ref")).isFalse();
+    assertThat(res.encodePrettily().contains("__absolute_recursive_ref")).isFalse();
+
+    String after = schema.toString();
+
+    // ensure that the clean up operation doesn't affect the source object
+    assertThat(before).isEqualTo(after);
+
+  }
+
+  @Test
+  public void testRefResolverFail() throws IOException {
+    try {
+      JsonObject res =
+        JsonSchema
+          .of(new JsonObject(Buffer.buffer(Files.readAllBytes(Paths.get("src", "test", "resources", "ref_test", "person_draft201909.json")))))
+          .resolve();
+
+      fail("Should not reach here");
+    } catch (SchemaException e) {
+      // OK
+    }
   }
 }