[DE-968] Support JSON-P types (#593)

rashtao · web-flow · commit 1b6066a03b5e · 2025-01-09T16:39:20.000+01:00
diff --git a/core/pom.xml b/core/pom.xml
@@ -41,6 +41,11 @@
             <artifactId>jackson-annotations</artifactId>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.datatype</groupId>
+            <artifactId>jackson-datatype-jakarta-jsonp</artifactId>
+            <scope>compile</scope>
+        </dependency>
         <dependency>
             <groupId>com.google.code.findbugs</groupId>
             <artifactId>jsr305</artifactId>
diff --git a/core/src/main/java/com/arangodb/internal/serde/InternalSerde.java b/core/src/main/java/com/arangodb/internal/serde/InternalSerde.java
@@ -3,7 +3,6 @@
 import com.arangodb.arch.UsedInApi;
 import com.arangodb.serde.ArangoSerde;
 import com.arangodb.ContentType;
-import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.databind.JavaType;
 import com.fasterxml.jackson.databind.JsonNode;
 
diff --git a/core/src/main/java/com/arangodb/internal/serde/InternalSerdeImpl.java b/core/src/main/java/com/arangodb/internal/serde/InternalSerdeImpl.java
@@ -17,6 +17,10 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.Module;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jsonp.JSONPModule;
+import jakarta.json.JsonException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
@@ -27,6 +31,7 @@
 import static com.arangodb.internal.serde.SerdeUtils.extractBytes;
 
 final class InternalSerdeImpl implements InternalSerde {
+    private static final Logger LOG = LoggerFactory.getLogger(InternalSerdeImpl.class);
 
     static {
         checkSupportedJacksonVersion();
@@ -50,6 +55,13 @@ final class InternalSerdeImpl implements InternalSerde {
                 new UserDataSerializer(this),
                 new UserDataDeserializer(this)
         ));
+
+        // JSON-P datatypes
+        try {
+            mapper.registerModule(new JSONPModule());
+        } catch (JsonException e) {
+            LOG.debug("Jakarta JSON-P provider not found, handling of JSON-P datatypes is disabled", e);
+        }
     }
 
     @Override
diff --git a/core/src/main/java/com/arangodb/internal/serde/SerdeUtils.java b/core/src/main/java/com/arangodb/internal/serde/SerdeUtils.java
@@ -13,6 +13,7 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.type.TypeFactory;
+import jakarta.json.JsonValue;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -127,7 +128,8 @@ public static byte[] extractBytes(JsonParser parser) throws IOException {
     }
 
     public static boolean isManagedClass(Class<?> clazz) {
-        return JsonNode.class.isAssignableFrom(clazz) ||
+        return JsonNode.class.isAssignableFrom(clazz) ||        // jackson datatypes
+                JsonValue.class.isAssignableFrom(clazz) ||      // JSON-B datatypes
                 RawJson.class.equals(clazz) ||
                 RawBytes.class.equals(clazz) ||
                 BaseDocument.class.equals(clazz) ||
diff --git a/pom.xml b/pom.xml
@@ -107,6 +107,11 @@
                 <artifactId>slf4j-api</artifactId>
                 <version>2.0.9</version>
             </dependency>
+            <dependency>
+                <groupId>jakarta.json</groupId>
+                <artifactId>jakarta.json-api</artifactId>
+                <version>2.1.3</version>
+            </dependency>
             <dependency>
                 <groupId>com.arangodb</groupId>
                 <artifactId>arangodb-java-driver</artifactId>
@@ -186,6 +191,7 @@
                                     <scopes>compile</scopes>
                                     <maxJdkVersion>1.8</maxJdkVersion>
                                     <excludes>
+                                        <exclude>jakarta.json:jakarta.json-api</exclude>
                                         <exclude>jakarta.json.bind:jakarta.json.bind-api</exclude>
                                     </excludes>
                                 </enforceBytecodeVersion>
diff --git a/shaded/pom.xml b/shaded/pom.xml
@@ -47,6 +47,11 @@
             <artifactId>slf4j-api</artifactId>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>jakarta.json</groupId>
+            <artifactId>jakarta.json-api</artifactId>
+            <scope>compile</scope>
+        </dependency>
         <dependency>
             <!-- build arangodb-java-driver before so that we can use the javadoc artifact -->
             <groupId>com.arangodb</groupId>
@@ -82,6 +87,7 @@
                             <artifactSet>
                                 <excludes>
                                     <exclude>org.slf4j:slf4j-api</exclude>
+                                    <exclude>jakarta.json:jakarta.json-api</exclude>
                                 </excludes>
                             </artifactSet>
                             <relocations>
diff --git a/test-functional/pom.xml b/test-functional/pom.xml
@@ -17,6 +17,15 @@
         <maven.deploy.skip>true</maven.deploy.skip>
     </properties>
 
+    <dependencies>
+        <dependency>
+            <groupId>org.eclipse.parsson</groupId>
+            <artifactId>parsson</artifactId>
+            <version>1.1.7</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
     <profiles>
         <profile>
             <id>shaded</id>
@@ -34,11 +43,11 @@
                         <configuration>
                             <filesToExclude>
                                 **/CustomSerdeTest.**,
-                                **/SerdeTest.**,
-                                **/SerializableTest.**,
+                                **/CustomSerdeAsyncTest.**,
                                 **/JacksonInterferenceTest.**,
                                 **/JacksonRequestContextTest.**,
-                                **/HttpProxyTest.**
+                                **/HttpProxyTest.**,
+                                **/RequestContextTest.**
                             </filesToExclude>
                             <replacements>
                                 <replacement>
@@ -49,6 +58,18 @@
                                     <token>com.fasterxml.jackson.databind.ObjectNode</token>
                                     <value>com.arangodb.shaded.fasterxml.jackson.databind.ObjectNode</value>
                                 </replacement>
+                                <replacement>
+                                    <token>com.fasterxml.jackson.databind.node</token>
+                                    <value>com.arangodb.shaded.fasterxml.jackson.databind.node</value>
+                                </replacement>
+                                <replacement>
+                                    <token>com.fasterxml.jackson.databind.ObjectMapper</token>
+                                    <value>com.arangodb.shaded.fasterxml.jackson.databind.ObjectMapper</value>
+                                </replacement>
+                                <replacement>
+                                    <token>com.fasterxml.jackson.core.JsonProcessingException</token>
+                                    <value>com.arangodb.shaded.fasterxml.jackson.core.JsonProcessingException</value>
+                                </replacement>
                             </replacements>
                         </configuration>
                     </plugin>
diff --git a/test-functional/src/test-ssl/java/com/arangodb/HttpProxyTest.java b/test-functional/src/test-ssl/java/com/arangodb/HttpProxyTest.java
@@ -36,7 +36,7 @@
 
 
 /**
- * @author Michele Rastelli
+ * NB: excluded from shaded tests
  */
 class HttpProxyTest extends BaseTest {
 
diff --git a/test-functional/src/test/java/com/arangodb/BaseJunit5.java b/test-functional/src/test/java/com/arangodb/BaseJunit5.java
@@ -101,7 +101,7 @@ static ArangoDatabase initDB(String name) {
         return database;
     }
 
-    static ArangoDatabase initDB() {
+    protected static ArangoDatabase initDB() {
         return initDB(TEST_DB);
     }
 
diff --git a/test-functional/src/test/java/com/arangodb/JacksonRequestContextTest.java b/test-functional/src/test/java/com/arangodb/JacksonRequestContextTest.java
@@ -44,7 +44,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
- * @author Michele Rastelli
+ * NB: excluded from shaded tests
  */
 class JacksonRequestContextTest {
 
diff --git a/test-functional/src/test/java/com/arangodb/RequestContextTest.java b/test-functional/src/test/java/com/arangodb/RequestContextTest.java
@@ -43,7 +43,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
- * @author Michele Rastelli
+ * NB: excluded from shaded tests
  */
 class RequestContextTest {
 
diff --git a/test-functional/src/test/java/com/arangodb/serde/CustomSerdeAsyncTest.java b/test-functional/src/test/java/com/arangodb/serde/CustomSerdeAsyncTest.java
@@ -50,7 +50,7 @@
 
 
 /**
- * @author Michele Rastelli
+ * NB: excluded from shaded tests
  */
 class CustomSerdeAsyncTest {
 
diff --git a/test-functional/src/test/java/com/arangodb/serde/CustomSerdeTest.java b/test-functional/src/test/java/com/arangodb/serde/CustomSerdeTest.java
@@ -49,7 +49,7 @@
 
 
 /**
- * @author Michele Rastelli
+ * NB: excluded from shaded tests
  */
 class CustomSerdeTest {
 
diff --git a/test-functional/src/test/java/com/arangodb/serde/JacksonInterferenceTest.java b/test-functional/src/test/java/com/arangodb/serde/JacksonInterferenceTest.java
@@ -16,6 +16,9 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+/**
+ * NB: excluded from shaded tests
+ */
 class JacksonInterferenceTest {
 
     private final ObjectMapper mapper = new ObjectMapper();
diff --git a/test-functional/src/test/java/com/arangodb/serde/JsonBTypesTest.java b/test-functional/src/test/java/com/arangodb/serde/JsonBTypesTest.java
@@ -0,0 +1,40 @@
+package com.arangodb.serde;
+
+import com.arangodb.ArangoDatabase;
+import com.arangodb.BaseJunit5;
+import jakarta.json.Json;
+import jakarta.json.JsonObject;
+import jakarta.json.JsonString;
+import jakarta.json.JsonValue;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import java.util.Collections;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class JsonBTypesTest extends BaseJunit5 {
+
+    @BeforeAll
+    static void init() {
+        BaseJunit5.initDB();
+    }
+
+    @ParameterizedTest
+    @MethodSource("dbs")
+    void jsonNode(ArangoDatabase db) {
+        JsonObject doc = Json.createObjectBuilder()
+                .add("foo", "bar")
+                .build();
+        JsonObject res = db.query("return @d", JsonObject.class, Collections.singletonMap("d", doc)).next();
+        assertThat(res.size()).isEqualTo(1);
+        assertThat(res.getString("foo")).isEqualTo("bar");
+        JsonValue value = db.query("return @d.foo", JsonValue.class, Collections.singletonMap("d", doc)).next();
+        assertThat(value)
+                .isInstanceOf(JsonString.class)
+                .extracting(v -> ((JsonString) v).getString())
+                .isEqualTo("bar");
+    }
+
+}
diff --git a/test-functional/src/test/resources/simplelogger.properties b/test-functional/src/test/resources/simplelogger.properties
@@ -9,3 +9,4 @@ org.slf4j.simpleLogger.showShortLogName=false
 org.slf4j.simpleLogger.defaultLogLevel=info
 #org.slf4j.simpleLogger.log.com.arangodb.internal.serde.JacksonUtils=debug
 #org.slf4j.simpleLogger.log.com.arangodb.internal.net.Communication=debug
+#org.slf4j.simpleLogger.log.com.arangodb.internal.serde.InternalSerdeImpl=debug

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ static ArangoDatabase initDB(String name) {`
`101`	`101`	`return database;`
`102`	`102`	`}`
`103`	`103`
`104`		`- static ArangoDatabase initDB() {`
	`104`	`+ protected static ArangoDatabase initDB() {`
`105`	`105`	`return initDB(TEST_DB);`
`106`	`106`	`}`
`107`	`107`