JAVA-1134: Added BulkWriteResult.isModifiedCountAvailable(), which returns false if the server is unable to provide the count. BulkWriteResult.getModifiedCount() now throws if the count is unavailable.

jyemin · jyemin · commit 696272a5afa1 · 2014-03-11T21:03:08.000-04:00
diff --git a/src/main/com/mongodb/AcknowledgedBulkWriteResult.java b/src/main/com/mongodb/AcknowledgedBulkWriteResult.java
@@ -25,11 +25,11 @@ class AcknowledgedBulkWriteResult extends BulkWriteResult {
     private int insertedCount;
     private int matchedCount;
     private int removedCount;
-    private int modifiedCount;
+    private Integer modifiedCount;
     private final List<BulkWriteUpsert> upserts;
 
     AcknowledgedBulkWriteResult(final int insertedCount, final int matchedCount, final int removedCount,
-                                final int modifiedCount, final List<BulkWriteUpsert> upserts) {
+                                final Integer modifiedCount, final List<BulkWriteUpsert> upserts) {
         this.insertedCount = insertedCount;
         this.matchedCount = matchedCount;
         this.removedCount = removedCount;
@@ -41,7 +41,7 @@ class AcknowledgedBulkWriteResult extends BulkWriteResult {
         this(type, count, 0, upserts);
     }
 
-    AcknowledgedBulkWriteResult(final WriteRequest.Type type, final int count, final int modifiedCount,
+    AcknowledgedBulkWriteResult(final WriteRequest.Type type, final int count, final Integer modifiedCount,
                                 final List<BulkWriteUpsert> upserts) {
         this(type == WriteRequest.Type.INSERT ? count : 0,
              (type == WriteRequest.Type.UPDATE || type == WriteRequest.Type.REPLACE)  ? count : 0,
@@ -69,9 +69,20 @@ public int getRemovedCount() {
         return removedCount;
     }
 
+    @Override
+    public boolean isModifiedCountAvailable() {
+        return modifiedCount != null;
+    }
+
     @Override
     public int getModifiedCount() {
+        if (modifiedCount == null) {
+            throw new UnsupportedOperationException("The modifiedCount is not available because at least one of the servers that was " +
+                                                    "updated was not able to provide this information (the server is must be at least " +
+                                                    "version 2.6");
+        }
         return modifiedCount;
+
     }
 
     @Override
@@ -93,13 +104,13 @@ public boolean equals(final Object o) {
         if (insertedCount != that.insertedCount) {
             return false;
         }
-        if (modifiedCount != that.modifiedCount) {
+        if (matchedCount != that.matchedCount) {
             return false;
         }
         if (removedCount != that.removedCount) {
             return false;
         }
-        if (matchedCount != that.matchedCount) {
+        if (modifiedCount != null ? !modifiedCount.equals(that.modifiedCount) : that.modifiedCount != null) {
             return false;
         }
         if (!upserts.equals(that.upserts)) {
@@ -111,11 +122,11 @@ public boolean equals(final Object o) {
 
     @Override
     public int hashCode() {
-        int result = upserts.hashCode();
-        result = 31 * result + insertedCount;
+        int result = insertedCount;
         result = 31 * result + matchedCount;
         result = 31 * result + removedCount;
-        result = 31 * result + modifiedCount;
+        result = 31 * result + (modifiedCount != null ? modifiedCount.hashCode() : 0);
+        result = 31 * result + upserts.hashCode();
         return result;
     }
 
diff --git a/src/main/com/mongodb/BulkWriteBatchCombiner.java b/src/main/com/mongodb/BulkWriteBatchCombiner.java
@@ -33,7 +33,7 @@ class BulkWriteBatchCombiner {
     private int insertedCount;
     private int matchedCount;
     private int removedCount;
-    private int modifiedCount;
+    private Integer modifiedCount = 0;
     private final Set<BulkWriteUpsert> writeUpserts = new TreeSet<BulkWriteUpsert>(new Comparator<BulkWriteUpsert>() {
         @Override
         public int compare(final BulkWriteUpsert o1, final BulkWriteUpsert o2) {
@@ -58,7 +58,11 @@ public void addResult(final BulkWriteResult result, final IndexMap indexMap) {
         insertedCount += result.getInsertedCount();
         matchedCount += result.getMatchedCount();
         removedCount += result.getRemovedCount();
-        modifiedCount += result.getModifiedCount();
+        if (result.isModifiedCountAvailable() && modifiedCount != null) {
+            modifiedCount += result.getModifiedCount();
+        } else {
+            modifiedCount = null;
+        }
         mergeUpserts(result.getUpserts(), indexMap);
     }
 
diff --git a/src/main/com/mongodb/BulkWriteResult.java b/src/main/com/mongodb/BulkWriteResult.java
@@ -65,15 +65,34 @@ public abstract class BulkWriteResult {
      */
     public abstract int getRemovedCount();
 
+    /**
+     * Returns true if the server was able to provide a count of modified documents.  If this method returns false (which can happen if
+     * the server is not at least version 2.6) then the {@code getModifiedCount} method will throw {@code UnsupportedOperationException}.
+     *
+     * @return true if modifiedCount is available
+     *
+     * @throws UnacknowledgedWriteException if the write was unacknowledged.
+     * @see WriteConcern#UNACKNOWLEDGED
+     * @see #getModifiedCount()
+     */
+    public abstract boolean isModifiedCountAvailable();
+
     /**
      * Returns the number of documents modified by updates or replacements in the write operation.  This will only count documents that
      * were actually changed; for example, if you set the value of some field, and the field already has that value,
      * that will not count as a modification.
+     * <p>
+     *     If the server is not able to provide a count of modified documents (which can happen if the server is not at least version
+     *     2.6), then this method will throw an {@code UnsupportedOperationException}
+     * </p>
      *
      * @return the number of documents modified by the write operation
      *
      * @throws UnacknowledgedWriteException if the write was unacknowledged.
+     * @throws java.lang.UnsupportedOperationException if no modified count is available
      * @see WriteConcern#UNACKNOWLEDGED
+     * @see #isModifiedCountAvailable()
+     * @mongodb.server.release 2.6
      */
     public abstract int getModifiedCount();
 
diff --git a/src/main/com/mongodb/DBCollectionImpl.java b/src/main/com/mongodb/DBCollectionImpl.java
@@ -825,7 +825,7 @@ private abstract class RunExecutor {
             BulkWriteResult getResult(final WriteResult writeResult) {
                 int count = getCount(writeResult);
                 List<BulkWriteUpsert> upsertedItems = getUpsertedItems(writeResult);
-                int modifiedCount = (getType() == UPDATE || getType() == REPLACE) ? count - upsertedItems.size() : 0;
+                Integer modifiedCount = (getType() == UPDATE || getType() == REPLACE) ? null : 0;
                 return new AcknowledgedBulkWriteResult(getType(), count - upsertedItems.size(), modifiedCount, upsertedItems);
             }
 
diff --git a/src/main/com/mongodb/UnacknowledgedBulkWriteResult.java b/src/main/com/mongodb/UnacknowledgedBulkWriteResult.java
@@ -43,6 +43,11 @@ public int getRemovedCount() {
         throw getUnacknowledgedWriteException();
     }
 
+    @Override
+    public boolean isModifiedCountAvailable() {
+        throw getUnacknowledgedWriteException();
+    }
+
     @Override
     public int getModifiedCount() {
         throw getUnacknowledgedWriteException();
diff --git a/src/main/com/mongodb/WriteCommandResultHelper.java b/src/main/com/mongodb/WriteCommandResultHelper.java
@@ -20,6 +20,9 @@
 import java.util.Collections;
 import java.util.List;
 
+import static com.mongodb.WriteRequest.Type.REPLACE;
+import static com.mongodb.WriteRequest.Type.UPDATE;
+
 final class WriteCommandResultHelper {
 
     static boolean hasError(final CommandResult commandResult) {
@@ -29,7 +32,7 @@ static boolean hasError(final CommandResult commandResult) {
     static BulkWriteResult getBulkWriteResult(final WriteRequest.Type type, final CommandResult commandResult) {
         int count = getCount(commandResult);
         List<BulkWriteUpsert> upsertedItems = getUpsertedItems(commandResult);
-        return new AcknowledgedBulkWriteResult(type, count - upsertedItems.size(), getModifiedCount(commandResult), upsertedItems);
+        return new AcknowledgedBulkWriteResult(type, count - upsertedItems.size(), getModifiedCount(type, commandResult), upsertedItems);
     }
 
     static BulkWriteException getBulkWriteException(final WriteRequest.Type type, final CommandResult commandResult) {
@@ -84,8 +87,12 @@ private static int getCount(final CommandResult commandResult) {
         return commandResult.getInt("n");
     }
 
-    private static Integer getModifiedCount(final CommandResult commandResult) {
-        return commandResult.getInt("nModified", 0);
+    private static Integer getModifiedCount(final WriteRequest.Type type, final CommandResult commandResult) {
+        Integer modifiedCount =  (Integer) commandResult.get("nModified");
+        if (modifiedCount == null && !(type == UPDATE || type == REPLACE)) {
+            modifiedCount = 0;
+        }
+        return modifiedCount;
     }
 
     private static DBObject getErrInfo(final DBObject response) {
diff --git a/src/test/com/mongodb/BulkWriteBatchCombinerSpecification.groovy b/src/test/com/mongodb/BulkWriteBatchCombinerSpecification.groovy
@@ -48,6 +48,18 @@ class BulkWriteBatchCombinerSpecification extends Specification {
         result == new AcknowledgedBulkWriteResult(INSERT, 1, 0, [])
     }
 
+    def 'should handle null modifiedCount'() {
+        def runResults = new BulkWriteBatchCombiner(new ServerAddress(), ACKNOWLEDGED)
+        runResults.addResult(new AcknowledgedBulkWriteResult(UPDATE, 1, null, []), new IndexMap.RangeBased().add(0, 0))
+        runResults.addResult(new AcknowledgedBulkWriteResult(INSERT, 1, 0, []), new IndexMap.RangeBased().add(0, 0))
+
+        when:
+        def result = runResults.getResult()
+
+        then:
+        result == new AcknowledgedBulkWriteResult(1, 1, 0, null, [])
+    }
+
     def 'should sort upserts'() {
         given:
         def runResults = new BulkWriteBatchCombiner(new ServerAddress(), ACKNOWLEDGED)
diff --git a/src/test/com/mongodb/BulkWriteOperationSpecification.groovy b/src/test/com/mongodb/BulkWriteOperationSpecification.groovy
@@ -175,14 +175,14 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
         def result = operation.execute()
 
         then:
-        result == new AcknowledgedBulkWriteResult(UPDATE, 1, 1, [])
+        result == new AcknowledgedBulkWriteResult(UPDATE, 1, expectedModifiedCount(1), [])
         collection.find(new BasicDBObject('y', 1), new BasicDBObject('x', 1).append('_id', 0)).toArray() == [new BasicDBObject('x', true)]
 
         where:
         ordered << [true, false]
     }
 
-    def 'when documents match the query, an update should update all of them'() {
+     def 'when documents match the query, an update should update all of them'() {
         given:
         collection.insert(new BasicDBObject('x', true))
         collection.insert(new BasicDBObject('x', true))
@@ -195,7 +195,7 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
         def result = operation.execute()
 
         then:
-        result == new AcknowledgedBulkWriteResult(UPDATE, 2, 2, [])
+        result == new AcknowledgedBulkWriteResult(UPDATE, 2, expectedModifiedCount(2), [])
         collection.count(new BasicDBObject('y', 1)) == 2
 
         where:
@@ -212,7 +212,7 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
         def result = operation.execute()
 
         then:
-        result == new AcknowledgedBulkWriteResult(UPDATE, 0, [new BulkWriteUpsert(0, id)])
+        result == new AcknowledgedBulkWriteResult(UPDATE, 0, expectedModifiedCount(0), [new BulkWriteUpsert(0, id)])
         collection.findOne() == new BasicDBObject('_id', id).append('x', 2)
 
         where:
@@ -229,7 +229,7 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
         def result = operation.execute()
 
         then:
-        result == new AcknowledgedBulkWriteResult(UPDATE, 0, [new BulkWriteUpsert(0, id)])
+        result == new AcknowledgedBulkWriteResult(UPDATE, 0, expectedModifiedCount(0), [new BulkWriteUpsert(0, id)])
         collection.findOne() == new BasicDBObject('_id', id).append('x', 2)
 
         where:
@@ -249,7 +249,7 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
         def result = operation.execute()
 
         then:
-        result == new AcknowledgedBulkWriteResult(UPDATE, 2, 2, [])
+        result == new AcknowledgedBulkWriteResult(UPDATE, 2, expectedModifiedCount(2), [])
         collection.count(new BasicDBObject('y', 1)) == 2
 
         where:
@@ -284,7 +284,7 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
         def result = operation.execute()
 
         then:
-        result == new AcknowledgedBulkWriteResult(UPDATE, 0, [new BulkWriteUpsert(0, id)])
+        result == new AcknowledgedBulkWriteResult(UPDATE, 0, expectedModifiedCount(0), [new BulkWriteUpsert(0, id)])
         collection.findOne() == new BasicDBObject('_id', id).append('x', 2)
 
         where:
@@ -304,7 +304,7 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
         def result = operation.execute()
 
         then:
-        result == new AcknowledgedBulkWriteResult(UPDATE, 1, 1, [])
+        result == new AcknowledgedBulkWriteResult(UPDATE, 1, expectedModifiedCount(1), [])
         collection.find(new BasicDBObject('x', false), new BasicDBObject('_id', 0)).toArray() == [replacement]
 
         where:
@@ -322,7 +322,7 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
         def result = operation.execute()
 
         then:
-        result == new AcknowledgedBulkWriteResult(UPDATE, 1, 1, [])
+        result == new AcknowledgedBulkWriteResult(UPDATE, 1, expectedModifiedCount(1), [])
         collection.findOne() == new BasicDBObject('_id', id).append('x', 2)
 
         where:
@@ -340,7 +340,7 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
         def result = operation.execute()
 
         then:
-        result == new AcknowledgedBulkWriteResult(REPLACE, 1, 1, [])
+        result == new AcknowledgedBulkWriteResult(REPLACE, 1, expectedModifiedCount(1), [])
         collection.findOne() == new BasicDBObject('_id', 1).append('x', 2)
 
         where:
@@ -359,7 +359,7 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
         def result = operation.execute()
 
         then:
-        result == new AcknowledgedBulkWriteResult(REPLACE, 1, 1, [])
+        result == new AcknowledgedBulkWriteResult(REPLACE, 1, expectedModifiedCount(1), [])
         collection.count() == 1
     }
 
@@ -374,7 +374,7 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
         def result = operation.execute()
 
         then:
-        result == new AcknowledgedBulkWriteResult(2, 4, 2, 4, [])
+        result == new AcknowledgedBulkWriteResult(2, 4, 2, expectedModifiedCount(4), [])
 
         collection.findOne(new BasicDBObject('_id', 1)) == new BasicDBObject('_id', 1).append('x', 2)
         collection.findOne(new BasicDBObject('_id', 2)) == new BasicDBObject('_id', 2).append('x', 3)
@@ -446,7 +446,7 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
         def result = operation.execute()
 
         then:
-        result == new AcknowledgedBulkWriteResult(2, 4, 2, 4, [])
+        result == new AcknowledgedBulkWriteResult(2, 4, 2, expectedModifiedCount(4), [])
 
         collection.findOne(new BasicDBObject('_id', 1)) == new BasicDBObject('_id', 1).append('x', 2)
         collection.findOne(new BasicDBObject('_id', 2)) == new BasicDBObject('_id', 2).append('x', 3)
@@ -712,4 +712,8 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
     private BulkWriteOperation initializeBulkOperation(boolean ordered) {
         ordered ? collection.initializeOrderedBulkOperation() : collection.initializeUnorderedBulkOperation()
     }
+
+    private static Integer expectedModifiedCount(final int expectedCountForServersThatSupportIt) {
+        (serverIsAtLeastVersion(2.5)) ? expectedCountForServersThatSupportIt : null
+    }
 }
diff --git a/src/test/com/mongodb/WriteCommandHelperSpecification.groovy b/src/test/com/mongodb/WriteCommandHelperSpecification.groovy
@@ -22,6 +22,8 @@ import static com.mongodb.WriteCommandResultHelper.getBulkWriteException
 import static com.mongodb.WriteCommandResultHelper.getBulkWriteResult
 import static com.mongodb.WriteCommandResultHelper.hasError
 import static com.mongodb.WriteRequest.Type.INSERT
+import static com.mongodb.WriteRequest.Type.REMOVE
+import static com.mongodb.WriteRequest.Type.REPLACE
 import static com.mongodb.WriteRequest.Type.UPDATE
 
 class WriteCommandHelperSpecification extends Specification {
@@ -41,6 +43,26 @@ class WriteCommandHelperSpecification extends Specification {
                 .getUpserts()
     }
 
+    def 'should not have modified count for update with no nModified field in the result'() {
+        expect:
+        !getBulkWriteResult(UPDATE, getCommandResult(new BasicDBObject('n', 1))).isModifiedCountAvailable()
+    }
+
+    def 'should not have modified count for replace with no nModified field in the result'() {
+        expect:
+        !getBulkWriteResult(REPLACE, getCommandResult(new BasicDBObject('n', 1))).isModifiedCountAvailable()
+    }
+
+    def 'should have modified count of 0 for insert with no nModified field in the result'() {
+        expect:
+        0 == getBulkWriteResult(INSERT, getCommandResult(new BasicDBObject('n', 1))).getModifiedCount()
+    }
+
+    def 'should have modified count of 0 for remove with no nModified field in the result'() {
+        expect:
+        0 == getBulkWriteResult(REMOVE, getCommandResult(new BasicDBObject('n', 1))).getModifiedCount()
+    }
+
     def 'should not have error if writeErrors is empty and writeConcernError is missing'() {
         expect:
         !hasError(getCommandResult(new BasicDBObject()));

Original file line number	Diff line number	Diff line change
`@@ -825,7 +825,7 @@ private abstract class RunExecutor {`
`825`	`825`	`BulkWriteResult getResult(final WriteResult writeResult) {`
`826`	`826`	`int count = getCount(writeResult);`
`827`	`827`	`List<BulkWriteUpsert> upsertedItems = getUpsertedItems(writeResult);`
`828`		`- int modifiedCount = (getType() == UPDATE \|\| getType() == REPLACE) ? count - upsertedItems.size() : 0;`
	`828`	`+ Integer modifiedCount = (getType() == UPDATE \|\| getType() == REPLACE) ? null : 0;`
`829`	`829`	`return new AcknowledgedBulkWriteResult(getType(), count - upsertedItems.size(), modifiedCount, upsertedItems);`
`830`	`830`	`}`
`831`	`831`