added keepNull & mergeObjects parameters for insert-update document

Author: rashtao

src/main/java/com/arangodb/internal/InternalArangoCollection.java

@@ -88,8 +88,13 @@ protected <T> Request insertDocumentRequest(final T value, final DocumentCreateO
         request.putQueryParam(SILENT, params.getSilent());
         request.putQueryParam(OVERWRITE, params.getOverwrite());
         request.putQueryParam(OVERWRITE_MODE, params.getOverwriteMode() != null ? params.getOverwriteMode().getValue() : null);
+        request.putQueryParam(ArangoRequestParam.KEEP_NULL, params.getKeepNull());
+        request.putQueryParam(MERGE_OBJECTS, params.getMergeObjects());
         request.putHeaderParam(TRANSACTION_ID, params.getStreamTransactionId());
-        request.setBody(util(Serializer.CUSTOM).serialize(value));
+
+        boolean serializeNullValues = OverwriteMode.update.equals(params.getOverwriteMode());
+        request.setBody(util(Serializer.CUSTOM).serialize(value, new ArangoSerializer.Options().serializeNullValues(serializeNullValues)));
+
         return request;
     }
 
@@ -125,9 +130,13 @@ protected <T> Request insertDocumentsRequest(final Collection<T> values, final D
         request.putQueryParam(SILENT, params.getSilent());
         request.putQueryParam(OVERWRITE, params.getOverwrite());
         request.putQueryParam(OVERWRITE_MODE, params.getOverwriteMode() != null ? params.getOverwriteMode().getValue() : null);
+        request.putQueryParam(ArangoRequestParam.KEEP_NULL, params.getKeepNull());
+        request.putQueryParam(MERGE_OBJECTS, params.getMergeObjects());
         request.putHeaderParam(TRANSACTION_ID, params.getStreamTransactionId());
-        request.setBody(util(Serializer.CUSTOM)
-                .serialize(values, new ArangoSerializer.Options().serializeNullValues(false).stringAsJson(true)));
+
+        boolean serializeNullValues = OverwriteMode.update.equals(params.getOverwriteMode());
+        request.setBody(util(Serializer.CUSTOM).serialize(values, new ArangoSerializer.Options()
+                .serializeNullValues(serializeNullValues).stringAsJson(true)));
         return request;
     }
 

src/main/java/com/arangodb/model/DocumentCreateOptions.java

@@ -35,6 +35,9 @@ public class DocumentCreateOptions {
     private OverwriteMode overwriteMode;
     private Boolean silent;
     private String streamTransactionId;
+    private Boolean keepNull;
+    private Boolean mergeObjects;
+
 
     public DocumentCreateOptions() {
         super();
@@ -141,4 +144,38 @@ public DocumentCreateOptions streamTransactionId(final String streamTransactionI
         return this;
     }
 
+    public Boolean getKeepNull() {
+        return keepNull;
+    }
+
+    /**
+     * @param keepNull If the intention is to delete existing attributes with the patch command, the URL query parameter
+     *                 keepNull can be used with a value of false. This will modify the behavior of the patch command to
+     *                 remove any attributes from the existing document that are contained in the patch document with an
+     *                 attribute value of null.
+     * @return options
+     * @apiNote only considered if {@link this#overwriteMode} is set to {@link OverwriteMode#update}
+     * @apiNote the document key field must be not null
+     */
+    public DocumentCreateOptions keepNull(Boolean keepNull) {
+        this.keepNull = keepNull;
+        return this;
+    }
+
+    public Boolean getMergeObjects() {
+        return mergeObjects;
+    }
+
+    /**
+     * @param mergeObjects Controls whether objects (not arrays) will be merged if present in both the existing and the patch
+     *                     document. If set to false, the value in the patch document will overwrite the existing document's
+     *                     value. If set to true, objects will be merged. The default is true.
+     * @return options
+     * @apiNote only considered if {@link this#overwriteMode} is set to {@link OverwriteMode#update}
+     */
+    public DocumentCreateOptions mergeObjects(Boolean mergeObjects) {
+        this.mergeObjects = mergeObjects;
+        return this;
+    }
+
 }

src/test/java/com/arangodb/ArangoCollectionTest.java

@@ -224,13 +224,59 @@ public void insertDocumentOverwriteModeUpdate() {
         final DocumentCreateEntity<BaseDocument> meta = collection.insertDocument(doc);
 
         doc.addAttribute("bar", "b");
-        final DocumentCreateEntity<BaseDocument> upsert = collection
+        final DocumentCreateEntity<BaseDocument> updated = collection
                 .insertDocument(doc, new DocumentCreateOptions().overwriteMode(OverwriteMode.update).returnNew(true));
 
-        assertThat(upsert, is(notNullValue()));
-        assertThat(upsert.getRev(), is(not(meta.getRev())));
-        assertThat(upsert.getNew().getAttribute("foo").toString(), is("a"));
-        assertThat(upsert.getNew().getAttribute("bar").toString(), is("b"));
+        assertThat(updated, is(notNullValue()));
+        assertThat(updated.getRev(), is(not(meta.getRev())));
+        assertThat(updated.getNew().getAttribute("foo").toString(), is("a"));
+        assertThat(updated.getNew().getAttribute("bar").toString(), is("b"));
+    }
+
+    @Test
+    public void insertDocumentOverwriteModeUpdateKeepNullTrue() {
+        assumeTrue(isAtLeastVersion(3, 7));
+
+        final BaseDocument initialDoc = new BaseDocument();
+        initialDoc.addAttribute("foo", "a");
+        final DocumentCreateEntity<BaseDocument> meta = collection.insertDocument(initialDoc);
+
+        final BaseDocument updatedDoc = new BaseDocument(initialDoc.getKey());
+        updatedDoc.addAttribute("foo", null);
+        updatedDoc.addAttribute("bar", "b");
+        final DocumentCreateEntity<BaseDocument> updated = collection
+                .insertDocument(updatedDoc, new DocumentCreateOptions()
+                        .overwriteMode(OverwriteMode.update)
+                        .keepNull(true)
+                        .returnNew(true));
+
+        assertThat(updated, is(notNullValue()));
+        assertThat(updated.getRev(), is(not(meta.getRev())));
+        assertThat(updated.getNew().getProperties().containsKey("foo"), is(true));
+        assertThat(updated.getNew().getAttribute("foo"), is(nullValue()));
+        assertThat(updated.getNew().getAttribute("bar").toString(), is("b"));
+    }
+
+    @Test
+    public void insertDocumentOverwriteModeUpdateMergeObjectsFalse() {
+        assumeTrue(isAtLeastVersion(3, 7));
+
+        final BaseDocument doc = new BaseDocument();
+        Map<String, String> fieldA = Collections.singletonMap("a", "a");
+        doc.addAttribute("foo", fieldA);
+        final DocumentCreateEntity<BaseDocument> meta = collection.insertDocument(doc);
+
+        Map<String, String> fieldB = Collections.singletonMap("b", "b");
+        doc.addAttribute("foo", fieldB);
+        final DocumentCreateEntity<BaseDocument> updated = collection
+                .insertDocument(doc, new DocumentCreateOptions()
+                        .overwriteMode(OverwriteMode.update)
+                        .mergeObjects(false)
+                        .returnNew(true));
+
+        assertThat(updated, is(notNullValue()));
+        assertThat(updated.getRev(), is(not(meta.getRev())));
+        assertThat(updated.getNew().getAttribute("foo"), is(fieldB));
     }
 
     @Test