JSON-B serde

rashtao · rashtao · commit 49dcdd506134 · 2022-08-01T12:50:46.000+02:00
diff --git a/pom.xml b/pom.xml
@@ -260,6 +260,11 @@
             <artifactId>jackson-dataformat-velocypack</artifactId>
             <optional>true</optional>
         </dependency>
+        <dependency>
+            <groupId>jakarta.json.bind</groupId>
+            <artifactId>jakarta.json.bind-api</artifactId>
+            <version>3.0.0</version>
+        </dependency>
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>
@@ -298,6 +303,12 @@
             <version>22.1.0</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.eclipse</groupId>
+            <artifactId>yasson</artifactId>
+            <version>3.0.0</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <dependencyManagement>
diff --git a/src/main/java/com/arangodb/entity/BaseDocument.java b/src/main/java/com/arangodb/entity/BaseDocument.java
@@ -23,6 +23,7 @@
 import com.arangodb.internal.DocumentFields;
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.fasterxml.jackson.annotation.JsonAnySetter;
+import com.fasterxml.jackson.annotation.JsonInclude;
 
 import java.io.Serializable;
 import java.util.HashMap;
@@ -94,6 +95,7 @@ public void setRevision(final String revision) {
         this.revision = revision;
     }
 
+    @JsonInclude
     @JsonAnyGetter
     public Map<String, Object> getProperties() {
         return properties;
@@ -103,6 +105,7 @@ public void setProperties(final Map<String, Object> properties) {
         this.properties = properties;
     }
 
+    @JsonInclude
     @JsonAnySetter
     public void addAttribute(final String key, final Object value) {
         properties.put(key, value);
diff --git a/src/main/java/com/arangodb/entity/From.java b/src/main/java/com/arangodb/entity/From.java
@@ -4,6 +4,8 @@
 import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import jakarta.json.bind.annotation.JsonbAnnotation;
+import jakarta.json.bind.annotation.JsonbProperty;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -19,5 +21,7 @@
 @JacksonAnnotationsInside
 @JsonProperty(DocumentFields.FROM)
 @JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonbAnnotation
+@JsonbProperty("_from")
 public @interface From {
 }
diff --git a/src/main/java/com/arangodb/entity/Id.java b/src/main/java/com/arangodb/entity/Id.java
@@ -4,6 +4,8 @@
 import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import jakarta.json.bind.annotation.JsonbAnnotation;
+import jakarta.json.bind.annotation.JsonbProperty;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -19,5 +21,7 @@
 @JacksonAnnotationsInside
 @JsonProperty(DocumentFields.ID)
 @JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonbAnnotation
+@JsonbProperty("_id")
 public @interface Id {
 }
diff --git a/src/main/java/com/arangodb/entity/Key.java b/src/main/java/com/arangodb/entity/Key.java
@@ -4,6 +4,8 @@
 import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import jakarta.json.bind.annotation.JsonbAnnotation;
+import jakarta.json.bind.annotation.JsonbProperty;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -19,5 +21,7 @@
 @JacksonAnnotationsInside
 @JsonProperty(DocumentFields.KEY)
 @JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonbAnnotation
+@JsonbProperty("_key")
 public @interface Key {
 }
diff --git a/src/main/java/com/arangodb/entity/Rev.java b/src/main/java/com/arangodb/entity/Rev.java
@@ -4,6 +4,8 @@
 import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import jakarta.json.bind.annotation.JsonbAnnotation;
+import jakarta.json.bind.annotation.JsonbProperty;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -19,5 +21,7 @@
 @JacksonAnnotationsInside
 @JsonProperty(DocumentFields.REV)
 @JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonbAnnotation
+@JsonbProperty("_rev")
 public @interface Rev {
 }
diff --git a/src/main/java/com/arangodb/entity/To.java b/src/main/java/com/arangodb/entity/To.java
@@ -4,6 +4,8 @@
 import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import jakarta.json.bind.annotation.JsonbAnnotation;
+import jakarta.json.bind.annotation.JsonbProperty;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -19,5 +21,7 @@
 @JacksonAnnotationsInside
 @JsonProperty(DocumentFields.TO)
 @JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonbAnnotation
+@JsonbProperty("_to")
 public @interface To {
 }
diff --git a/src/main/java/com/arangodb/serde/ArangoSerde.java b/src/main/java/com/arangodb/serde/ArangoSerde.java
@@ -13,7 +13,7 @@
  * - low-level libraries without support to data binding
  * <p>
  * To create a custom serde based on Jackson, existing {@link JacksonSerde} can be reused and instantiated providing a
- * custom configured ObjectMapper ({@link JacksonSerde#of(com.fasterxml.jackson.databind.ObjectMapper)}) or configured
+ * custom configured ObjectMapper ({@link JacksonSerde#create(com.fasterxml.jackson.databind.ObjectMapper)}) or configured
  * after creation through {@link JacksonSerde#configure(Consumer)}.
  */
 public interface ArangoSerde {
diff --git a/src/main/java/com/arangodb/serde/InternalSerdeImpl.java b/src/main/java/com/arangodb/serde/InternalSerdeImpl.java
@@ -1,6 +1,7 @@
 package com.arangodb.serde;
 
 import com.arangodb.ArangoDBException;
+import com.arangodb.entity.BaseDocument;
 import com.arangodb.util.RawBytes;
 import com.arangodb.util.RawJson;
 import com.fasterxml.jackson.annotation.JsonInclude;
@@ -72,7 +73,11 @@ public JsonNode parse(byte[] content, String jsonPointer) {
     @Override
     public byte[] serializeUserData(Object value) {
         Class<?> clazz = value.getClass();
-        if (RawJson.class.equals(clazz) || RawBytes.class.equals(clazz) || JsonNode.class.isAssignableFrom(clazz)) {
+        if (    RawJson.class.equals(clazz) ||
+                RawBytes.class.equals(clazz) ||
+                JsonNode.class.isAssignableFrom(clazz) ||
+                BaseDocument.class.isAssignableFrom(clazz)
+        ) {
             return serialize(value);
         } else {
             return userSerde.serialize(value);
@@ -90,7 +95,11 @@ public byte[] serializeCollectionUserData(Collection<?> value) {
 
     @Override
     public <T> T deserializeUserData(byte[] content, Class<T> clazz) {
-        if (RawJson.class.isAssignableFrom(clazz) || RawBytes.class.isAssignableFrom(clazz) || JsonNode.class.isAssignableFrom(clazz)) {
+        if (    RawJson.class.isAssignableFrom(clazz) ||
+                RawBytes.class.isAssignableFrom(clazz) ||
+                JsonNode.class.isAssignableFrom(clazz) ||
+                BaseDocument.class.isAssignableFrom(clazz)
+        ) {
             return deserialize(content, clazz);
         } else {
             return userSerde.deserialize(content, clazz);
diff --git a/src/main/java/com/arangodb/serde/JacksonSerde.java b/src/main/java/com/arangodb/serde/JacksonSerde.java
@@ -5,7 +5,7 @@
 import java.util.function.Consumer;
 
 /**
- * Contract for serialization/deserialization of user data, based on Jackson Databind.
+ * User data serde based on Jackson Databind.
  */
 public interface JacksonSerde extends ArangoSerde {
 
@@ -16,7 +16,7 @@ public interface JacksonSerde extends ArangoSerde {
      * @return the created JacksonSerde
      */
     static JacksonSerde of(final DataType dataType) {
-        return of(MapperProvider.of(dataType));
+        return create(MapperProvider.of(dataType));
     }
 
     /**
@@ -25,7 +25,7 @@ static JacksonSerde of(final DataType dataType) {
      * @param mapper   Jackson ObjectMapper to use
      * @return the created JacksonSerde
      */
-    static JacksonSerde of(final ObjectMapper mapper) {
+    static JacksonSerde create(final ObjectMapper mapper) {
         return new JacksonSerdeImpl(mapper);
     }
 
diff --git a/src/main/java/com/arangodb/serde/JsonbSerde.java b/src/main/java/com/arangodb/serde/JsonbSerde.java
@@ -0,0 +1,29 @@
+package com.arangodb.serde;
+
+import jakarta.json.bind.JsonbConfig;
+
+/**
+ * User data serde based on Jakarta JSON Binding (JSON-B).
+ */
+public interface JsonbSerde extends ArangoSerde {
+
+    /**
+     * Creates a new JsonbSerde with default settings.
+     *
+     * @return the created JsonbSerde
+     */
+    static JsonbSerde create() {
+        return new JsonbSerdeImpl();
+    }
+
+    /**
+     * Creates a new JsonbSerde using the provided .
+     *
+     * @param config JsonbConfig to use
+     * @return the created JsonbSerde
+     */
+    static JsonbSerde of(final JsonbConfig config) {
+        return new JsonbSerdeImpl(config);
+    }
+
+}
diff --git a/src/main/java/com/arangodb/serde/JsonbSerdeImpl.java b/src/main/java/com/arangodb/serde/JsonbSerdeImpl.java
@@ -0,0 +1,32 @@
+package com.arangodb.serde;
+
+import jakarta.json.bind.Jsonb;
+import jakarta.json.bind.JsonbBuilder;
+import jakarta.json.bind.JsonbConfig;
+
+import java.lang.reflect.Type;
+import java.nio.charset.StandardCharsets;
+
+class JsonbSerdeImpl implements JsonbSerde {
+
+    private final Jsonb jsonb;
+
+    JsonbSerdeImpl() {
+        jsonb = JsonbBuilder.create();
+    }
+
+    JsonbSerdeImpl(final JsonbConfig config) {
+        jsonb = JsonbBuilder.create(config);
+    }
+
+    @Override
+    public byte[] serialize(Object value) {
+        return jsonb.toJson(value).getBytes(StandardCharsets.UTF_8);
+    }
+
+    @Override
+    public <T> T deserialize(byte[] content, Type type) {
+        return jsonb.fromJson(new String(content, StandardCharsets.UTF_8), type);
+    }
+
+}
diff --git a/src/test/java/com/arangodb/ArangoCollectionTest.java b/src/test/java/com/arangodb/ArangoCollectionTest.java
@@ -686,7 +686,7 @@ void updateDocumentKeepNullFalse(ArangoCollection collection) {
         assertThat(readResult.getProperties().keySet()).doesNotContain("a");
     }
 
-    static class TestUpdateEntity {
+    public static class TestUpdateEntity {
         @SuppressWarnings("unused")
         private String a, b;
 
@@ -699,7 +699,7 @@ public String getB() {
         }
     }
 
-    static class TestUpdateEntitySerializeNullFalse {
+    public static class TestUpdateEntitySerializeNullFalse {
         @SuppressWarnings("unused")
         private String a, b;
 
diff --git a/src/test/java/com/arangodb/ArangoDatabaseTest.java b/src/test/java/com/arangodb/ArangoDatabaseTest.java
@@ -1299,13 +1299,13 @@ void transactionAllowImplicit(ArangoDatabase db) {
     public static class TransactionTestEntity {
         private String value;
 
-        public TransactionTestEntity() {
-            super();
-        }
-
         public String getValue() {
             return value;
         }
+
+        public void setValue(String value) {
+            this.value = value;
+        }
     }
 
     @ParameterizedTest(name = "{index}")
diff --git a/src/test/java/com/arangodb/BaseJunit5.java b/src/test/java/com/arangodb/BaseJunit5.java
@@ -3,6 +3,7 @@
 import com.arangodb.entity.*;
 import com.arangodb.model.CollectionCreateOptions;
 import com.arangodb.model.GraphCreateOptions;
+import com.arangodb.serde.JsonbSerde;
 import com.arangodb.util.TestUtils;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
@@ -12,17 +13,17 @@
 import java.util.Collection;
 import java.util.List;
 import java.util.UUID;
-import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 class BaseJunit5 {
     protected static final DbName TEST_DB = DbName.of("java_driver_test_db");
 
-    private static final List<ArangoDB> adbs = Arrays.stream(Protocol.values())
-            .map(p -> new ArangoDB.Builder()
-                    .useProtocol(p)
-                    .build())
-            .collect(Collectors.toList());
+    private static final List<ArangoDB> adbs = Arrays.asList(
+            new ArangoDB.Builder().useProtocol(Protocol.VST).build(),
+            new ArangoDB.Builder().useProtocol(Protocol.HTTP_VPACK).build(),
+            new ArangoDB.Builder().useProtocol(Protocol.HTTP_JSON).build(),
+            new ArangoDB.Builder().useProtocol(Protocol.HTTP_JSON).serializer(JsonbSerde.create()).build()
+    );
 
     protected static Stream<ArangoDatabase> dbsStream() {
         return adbs.stream().map(adb -> adb.db(TEST_DB));
diff --git a/src/test/java/com/arangodb/async/serde/CustomSerdeTest.java b/src/test/java/com/arangodb/async/serde/CustomSerdeTest.java
diff --git a/src/test/java/com/arangodb/serde/CustomSerdeTest.java b/src/test/java/com/arangodb/serde/CustomSerdeTest.java
