JAVA-2552: Support array filters for update operations in the core driver

Author: jyemin

driver-core/src/main/com/mongodb/bulk/UpdateRequest.java

@@ -19,6 +19,8 @@
 import com.mongodb.client.model.Collation;
 import org.bson.BsonDocument;
 
+import java.util.List;
+
 import static com.mongodb.assertions.Assertions.notNull;
 
 /**
@@ -33,6 +35,7 @@ public final class UpdateRequest extends WriteRequest {
     private boolean isMulti = true;
     private boolean isUpsert = false;
     private Collation collation;
+    private List<BsonDocument> arrayFilters;
 
     /**
      * Construct a new instance.
@@ -139,5 +142,29 @@ public UpdateRequest collation(final Collation collation) {
         this.collation = collation;
         return this;
     }
+
+    /**
+     * Sets the array filters option
+     *
+     * @param arrayFilters the array filters, which may be null
+     * @return this
+     * @since 3.6
+     * @mongodb.server.release 3.6
+     */
+    public UpdateRequest arrayFilters(final List<BsonDocument> arrayFilters) {
+        this.arrayFilters = arrayFilters;
+        return this;
+    }
+
+    /**
+     * Returns the array filters option
+     *
+     * @return the array filters, which may be null
+     * @since 3.6
+     * @mongodb.server.release 3.6
+     */
+    public List<BsonDocument> getArrayFilters() {
+        return arrayFilters;
+    }
 }
 

driver-core/src/main/com/mongodb/operation/BulkWriteBatch.java

@@ -358,6 +358,13 @@ public void encode(final BsonWriter writer, final WriteRequest writeRequest, fin
                     BsonDocument collation = update.getCollation().asDocument();
                     getCodec(collation).encode(writer, collation, EncoderContext.builder().build());
                 }
+                if (update.getArrayFilters() != null) {
+                    writer.writeStartArray("arrayFilters");
+                    for (BsonDocument cur: update.getArrayFilters()) {
+                        getCodec(cur).encode(writer, cur, EncoderContext.builder().build());
+                    }
+                    writer.writeEndArray();
+                }
                 writer.writeEndDocument();
             } else {
                 DeleteRequest deleteRequest = (DeleteRequest) writeRequest;

driver-core/src/main/com/mongodb/operation/FindAndUpdateOperation.java

@@ -30,13 +30,15 @@
 import com.mongodb.internal.validator.UpdateFieldNameValidator;
 import com.mongodb.operation.OperationHelper.AsyncCallableWithConnection;
 import com.mongodb.operation.OperationHelper.CallableWithConnection;
+import org.bson.BsonArray;
 import org.bson.BsonBoolean;
 import org.bson.BsonDocument;
 import org.bson.BsonString;
 import org.bson.FieldNameValidator;
 import org.bson.codecs.Decoder;
 
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.concurrent.TimeUnit;
 
@@ -48,9 +50,9 @@
 import static com.mongodb.operation.DocumentHelper.putIfNotZero;
 import static com.mongodb.operation.DocumentHelper.putIfTrue;
 import static com.mongodb.operation.OperationHelper.LOGGER;
-import static com.mongodb.operation.OperationHelper.validateCollation;
 import static com.mongodb.operation.OperationHelper.releasingCallback;
 import static com.mongodb.operation.OperationHelper.serverIsAtLeastVersionThreeDotTwo;
+import static com.mongodb.operation.OperationHelper.validateCollation;
 import static com.mongodb.operation.OperationHelper.withConnection;
 import static java.util.concurrent.TimeUnit.MILLISECONDS;
 
@@ -74,6 +76,7 @@ public class FindAndUpdateOperation<T> implements AsyncWriteOperation<T>, WriteO
     private boolean upsert;
     private Boolean bypassDocumentValidation;
     private Collation collation;
+    private List<BsonDocument> arrayFilters;
 
     /**
      * Construct a new instance.
@@ -326,6 +329,31 @@ public FindAndUpdateOperation<T> collation(final Collation collation) {
         return this;
     }
 
+
+    /**
+     * Sets the array filters option
+     *
+     * @param arrayFilters the array filters, which may be null
+     * @return this
+     * @since 3.6
+     * @mongodb.server.release 3.6
+     */
+    public FindAndUpdateOperation<T> arrayFilters(final List<BsonDocument> arrayFilters) {
+        this.arrayFilters = arrayFilters;
+        return this;
+    }
+
+    /**
+     * Returns the array filters option
+     *
+     * @return the array filters, which may be null
+     * @since 3.6
+     * @mongodb.server.release 3.6
+     */
+    public List<BsonDocument> getArrayFilters() {
+        return arrayFilters;
+    }
+
     @Override
     public T execute(final WriteBinding binding) {
         return withConnection(binding, new CallableWithConnection<T>() {
@@ -385,6 +413,9 @@ private BsonDocument getCommand(final ConnectionDescription description) {
         if (collation != null) {
             commandDocument.put("collation", collation.asDocument());
         }
+        if (arrayFilters != null) {
+            commandDocument.put("arrayFilters", new BsonArray(arrayFilters));
+        }
         return commandDocument;
     }
 

driver-core/src/test/functional/com/mongodb/operation/FindAndUpdateOperationSpecification.groovy

@@ -354,4 +354,26 @@ class FindAndUpdateOperationSpecification extends OperationFunctionalSpecificati
         where:
         async << [true, false]
     }
+
+    @IgnoreIf({ !serverVersionAtLeast(3, 5) })
+    def 'should support array filters'() {
+        given:
+        def documentOne = Document.parse('{_id: 1, y: [ {b: 3}, {b: 1}]}')
+        def documentTwo = Document.parse('{_id: 2, y: [ {b: 0}, {b: 1}]}')
+        getCollectionHelper().insertDocuments(documentOne, documentTwo)
+        def update = BsonDocument.parse('{ $set: {"y.$[i].b": 2}}')
+        def arrayFilters = [BsonDocument.parse('{"i.b": 3}')]
+        def operation = new FindAndUpdateOperation<Document>(getNamespace(), writeConcern, documentCodec, update)
+                .returnOriginal(false)
+                .arrayFilters(arrayFilters)
+
+        when:
+        def result = execute(operation, async)
+
+        then:
+        result == Document.parse('{_id: 1, y: [ {b: 2}, {b: 1}]}')
+
+        where:
+        async << [true, false]
+    }
 }

driver-core/src/test/functional/com/mongodb/operation/MixedBulkWriteOperationSpecification.groovy

@@ -37,6 +37,7 @@ import org.bson.BsonDocument
 import org.bson.BsonInt32
 import org.bson.BsonObjectId
 import org.bson.Document
+import org.bson.codecs.BsonDocumentCodec
 import org.bson.codecs.DocumentCodec
 import org.bson.types.ObjectId
 import org.junit.experimental.categories.Category
@@ -880,6 +881,34 @@ class MixedBulkWriteOperationSpecification extends OperationFunctionalSpecificat
         async << [true, false]
     }
 
+    @IgnoreIf({ !serverVersionAtLeast(3, 5) })
+    def 'should support array filters'() {
+        given:
+        def documentOne = BsonDocument.parse('{_id: 1, y: [ {b: 3}, {b: 1}]}')
+        def documentTwo = BsonDocument.parse('{_id: 2, y: [ {b: 0}, {b: 1}]}')
+        getCollectionHelper().insertDocuments(documentOne, documentTwo)
+        def requests = [
+                new UpdateRequest(new BsonDocument(), BsonDocument.parse('{ $set: {"y.$[i].b": 2}}'), UPDATE)
+                        .arrayFilters([BsonDocument.parse('{"i.b": 3}')]),
+                new UpdateRequest(new BsonDocument(), BsonDocument.parse('{ $set: {"y.$[i].b": 4}}'), UPDATE)
+                        .multi(true)
+                        .arrayFilters([BsonDocument.parse('{"i.b": 1}')]),
+        ]
+        def operation = new MixedBulkWriteOperation(namespace, requests, true, ACKNOWLEDGED)
+
+        when:
+        execute(operation, async)
+
+        then:
+        getCollectionHelper().find(new BsonDocumentCodec()) == [
+                BsonDocument.parse('{_id: 1, y: [ {b: 2}, {b: 4}]}'),
+                BsonDocument.parse('{_id: 2, y: [ {b: 0}, {b: 4}]}')
+        ]
+
+        where:
+        async << [true, false]
+    }
+
     private static List<WriteRequest> getTestWrites() {
         [new UpdateRequest(new BsonDocument('_id', new BsonInt32(1)),
                            new BsonDocument('$set', new BsonDocument('x', new BsonInt32(2))),

driver/src/test/unit/com/mongodb/operation/DeleteRequestSpecification.groovy renamed to driver-core/src/test/unit/com/mongodb/operation/DeleteRequestSpecification.groovy

@@ -1,11 +1,11 @@
 /*
- * Copyright (c) 2008-2014 MongoDB, Inc.
+ * Copyright 2017 MongoDB, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *   http://www.apache.org/licenses/LICENSE-2.0
+ *    http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,

driver/src/test/unit/com/mongodb/operation/InsertRequestSpecification.groovy renamed to driver-core/src/test/unit/com/mongodb/operation/InsertRequestSpecification.groovy

@@ -1,11 +1,11 @@
 /*
- * Copyright (c) 2008-2014 MongoDB, Inc.
+ * Copyright 2017 MongoDB, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *   http://www.apache.org/licenses/LICENSE-2.0
+ *    http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,

driver/src/test/unit/com/mongodb/operation/UpdateRequestSpecification.groovy renamed to driver-core/src/test/unit/com/mongodb/operation/UpdateRequestSpecification.groovy

@@ -1,11 +1,11 @@
 /*
- * Copyright (c) 2008-2014 MongoDB, Inc.
+ * Copyright 2017 MongoDB, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *   http://www.apache.org/licenses/LICENSE-2.0
+ *    http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -116,4 +116,13 @@ class UpdateRequestSpecification extends Specification {
         where:
         type << [WriteRequest.Type.UPDATE, WriteRequest.Type.REPLACE]
     }
+
+    def 'should set arrayFilters property'() {
+        expect:
+        new UpdateRequest(new BsonDocument(), new BsonDocument(), WriteRequest.Type.UPDATE).arrayFilters(arrayFilters)
+                .getArrayFilters() == arrayFilters
+
+        where:
+        arrayFilters << [null, [], [new BsonDocument('a.b', new BsonInt32(42))]]
+    }
 }