Ensure findOne does not set batchSize=1 (#1659)

NathanQingyangXu · web-flow · commit f9606ecf4a35 · 2025-04-01T10:58:14.000-04:00
JAVA-5666
diff --git a/driver-core/src/test/resources/unified-test-format/crud/findOne.json b/driver-core/src/test/resources/unified-test-format/crud/findOne.json
@@ -0,0 +1,158 @@
+{
+  "description": "findOne",
+  "schemaVersion": "1.0",
+  "createEntities": [
+    {
+      "client": {
+        "id": "client0",
+        "observeEvents": [
+          "commandStartedEvent"
+        ]
+      }
+    },
+    {
+      "database": {
+        "id": "database0",
+        "client": "client0",
+        "databaseName": "find-tests"
+      }
+    },
+    {
+      "collection": {
+        "id": "collection0",
+        "database": "database0",
+        "collectionName": "coll0"
+      }
+    }
+  ],
+  "initialData": [
+    {
+      "collectionName": "coll0",
+      "databaseName": "find-tests",
+      "documents": [
+        {
+          "_id": 1,
+          "x": 11
+        },
+        {
+          "_id": 2,
+          "x": 22
+        },
+        {
+          "_id": 3,
+          "x": 33
+        },
+        {
+          "_id": 4,
+          "x": 44
+        },
+        {
+          "_id": 5,
+          "x": 55
+        },
+        {
+          "_id": 6,
+          "x": 66
+        }
+      ]
+    }
+  ],
+  "tests": [
+    {
+      "description": "FindOne with filter",
+      "operations": [
+        {
+          "object": "collection0",
+          "name": "findOne",
+          "arguments": {
+            "filter": {
+              "_id": 1
+            }
+          },
+          "expectResult": {
+            "_id": 1,
+            "x": 11
+          }
+        }
+      ],
+      "expectEvents": [
+        {
+          "client": "client0",
+          "events": [
+            {
+              "commandStartedEvent": {
+                "command": {
+                  "find": "coll0",
+                  "filter": {
+                    "_id": 1
+                  },
+                  "batchSize": {
+                    "$$exists": false
+                  },
+                  "limit": 1,
+                  "singleBatch": true
+                },
+                "commandName": "find",
+                "databaseName": "find-tests"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "description": "FindOne with filter, sort, and skip",
+      "operations": [
+        {
+          "object": "collection0",
+          "name": "findOne",
+          "arguments": {
+            "filter": {
+              "_id": {
+                "$gt": 2
+              }
+            },
+            "sort": {
+              "_id": 1
+            },
+            "skip": 2
+          },
+          "expectResult": {
+            "_id": 5,
+            "x": 55
+          }
+        }
+      ],
+      "expectEvents": [
+        {
+          "client": "client0",
+          "events": [
+            {
+              "commandStartedEvent": {
+                "command": {
+                  "find": "coll0",
+                  "filter": {
+                    "_id": {
+                      "$gt": 2
+                    }
+                  },
+                  "sort": {
+                    "_id": 1
+                  },
+                  "skip": 2,
+                  "batchSize": {
+                    "$$exists": false
+                  },
+                  "limit": 1,
+                  "singleBatch": true
+                },
+                "commandName": "find",
+                "databaseName": "find-tests"
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}
diff --git a/driver-kotlin-coroutine/src/integrationTest/kotlin/com/mongodb/kotlin/client/coroutine/UnifiedCrudTest.kt b/driver-kotlin-coroutine/src/integrationTest/kotlin/com/mongodb/kotlin/client/coroutine/UnifiedCrudTest.kt
@@ -24,7 +24,7 @@ internal class UnifiedCrudTest() : UnifiedTest() {
         @JvmStatic
         @Throws(URISyntaxException::class, IOException::class)
         fun data(): Collection<Arguments>? {
-            return getTestData("unified-test-format/crud", true)
+            return getTestData("unified-test-format/crud", true, Language.KOTLIN)
         }
     }
 }
diff --git a/driver-kotlin-coroutine/src/integrationTest/kotlin/com/mongodb/kotlin/client/coroutine/UnifiedTest.kt b/driver-kotlin-coroutine/src/integrationTest/kotlin/com/mongodb/kotlin/client/coroutine/UnifiedTest.kt
@@ -39,4 +39,8 @@ internal abstract class UnifiedTest() : JUnifiedTest() {
     ): ClientEncryption {
         TODO("Not yet implemented - JAVA-4896")
     }
+
+    override fun isReactive(): Boolean = true
+
+    override fun getLanguage(): Language = Language.KOTLIN
 }
diff --git a/driver-kotlin-sync/src/integrationTest/kotlin/com/mongodb/kotlin/client/UnifiedCrudTest.kt b/driver-kotlin-sync/src/integrationTest/kotlin/com/mongodb/kotlin/client/UnifiedCrudTest.kt
@@ -24,7 +24,7 @@ internal class UnifiedCrudTest() : UnifiedTest() {
         @JvmStatic
         @Throws(URISyntaxException::class, IOException::class)
         fun data(): Collection<Arguments>? {
-            return getTestData("unified-test-format/crud", false)
+            return getTestData("unified-test-format/crud", false, Language.KOTLIN)
         }
     }
 }
diff --git a/driver-kotlin-sync/src/integrationTest/kotlin/com/mongodb/kotlin/client/UnifiedTest.kt b/driver-kotlin-sync/src/integrationTest/kotlin/com/mongodb/kotlin/client/UnifiedTest.kt
@@ -39,4 +39,6 @@ internal abstract class UnifiedTest() : JUnifiedTest() {
     ): ClientEncryption {
         TODO("Not yet implemented - JAVA-4896")
     }
+
+    override fun getLanguage(): Language = Language.KOTLIN
 }
diff --git a/driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/unified/UnifiedReactiveStreamsTest.java b/driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/unified/UnifiedReactiveStreamsTest.java
@@ -101,6 +101,6 @@ protected void postCleanUp(final TestDef testDef) {
 
     @NonNull
     protected static Collection<Arguments> getTestData(final String directory) {
-        return getTestData(directory, true);
+        return getTestData(directory, true, Language.JAVA);
     }
 }
diff --git a/driver-sync/src/test/functional/com/mongodb/client/unified/UnifiedCrudHelper.java b/driver-sync/src/test/functional/com/mongodb/client/unified/UnifiedCrudHelper.java
@@ -408,6 +408,11 @@ OperationResult executeFind(final BsonDocument operation) {
         });
     }
 
+    /**
+     * There is no explicit {@code findOne()} method in {@link MongoCollection} class.
+     * Its feature was emulated by {@link FindIterable#first()}, which would close cursor on server
+     * by setting {@code batchSize} and {@code limit} appropriately.
+     */
     OperationResult executeFindOne(final BsonDocument operation) {
         return resultOf(() ->  createFindIterable(operation).first());
     }
diff --git a/driver-sync/src/test/functional/com/mongodb/client/unified/UnifiedSyncTest.java b/driver-sync/src/test/functional/com/mongodb/client/unified/UnifiedSyncTest.java
@@ -51,6 +51,6 @@ protected ClientEncryption createClientEncryption(final MongoClient keyVaultClie
 
     @NonNull
     protected static Collection<Arguments> getTestData(final String directory) {
-        return getTestData(directory, false);
+        return getTestData(directory, false, Language.JAVA);
     }
 }
diff --git a/driver-sync/src/test/functional/com/mongodb/client/unified/UnifiedTest.java b/driver-sync/src/test/functional/com/mongodb/client/unified/UnifiedTest.java
@@ -161,15 +161,15 @@ public Entities getEntities() {
     }
 
     @NonNull
-    protected static Collection<Arguments> getTestData(final String directory, final boolean isReactive) {
+    protected static Collection<Arguments> getTestData(final String directory, final boolean isReactive, final Language language) {
         List<Arguments> data = new ArrayList<>();
         for (BsonDocument fileDocument : getTestDocuments("/" + directory + "/")) {
             for (BsonValue cur : fileDocument.getArray("tests")) {
 
                 final BsonDocument testDocument = cur.asDocument();
                 String testDescription = testDocument.getString("description").getValue();
                 String fileDescription = fileDocument.getString("description").getValue();
-                TestDef testDef = testDef(directory, fileDescription, testDescription, isReactive);
+                TestDef testDef = testDef(directory, fileDescription, testDescription, isReactive, language);
                 applyCustomizations(testDef);
 
                 boolean forceFlaky = testDef.wasAssignedModifier(Modifier.FORCE_FLAKY);
@@ -240,7 +240,7 @@ public void setUp(
         rootContext.getAssertionContext().push(ContextElement.ofTest(definition));
         ignoreExtraEvents = false;
         if (directoryName != null && fileDescription != null && testDescription != null) {
-            testDef = testDef(directoryName, fileDescription, testDescription, isReactive());
+            testDef = testDef(directoryName, fileDescription, testDescription, isReactive(), getLanguage());
             applyCustomizations(testDef);
 
             boolean skip = testDef.wasAssignedModifier(Modifier.SKIP);
@@ -329,6 +329,10 @@ protected boolean isReactive() {
         return false;
     }
 
+    protected Language getLanguage() {
+        return Language.JAVA;
+    }
+
     @ParameterizedTest(name = "{0}")
     @MethodSource("data")
     public void shouldPassAllOutcomes(
@@ -1112,4 +1116,8 @@ protected void ignoreExtraCommandEvents(final boolean ignoreExtraEvents) {
     protected void ignoreExtraEvents() {
         this.ignoreExtraEvents = true;
     }
+
+    public enum Language {
+        JAVA, KOTLIN
+    }
 }
diff --git a/driver-sync/src/test/functional/com/mongodb/client/unified/UnifiedTestModifications.java b/driver-sync/src/test/functional/com/mongodb/client/unified/UnifiedTestModifications.java
@@ -143,6 +143,10 @@ public static void applyCustomizations(final TestDef def) {
                 .test("crud", "findOneAndDelete-hint-unacknowledged", "Unacknowledged findOneAndDelete with hint string on 4.4+ server")
                 .test("crud", "findOneAndDelete-hint-unacknowledged", "Unacknowledged findOneAndDelete with hint document on 4.4+ server");
 
+        def.skipNoncompliant("https://jira.mongodb.org/browse/JAVA-5838")
+                .when(() -> def.isReactive() && UnifiedTest.Language.KOTLIN.equals(def.getLanguage()))
+                .file("crud", "findOne");
+
         // gridfs
 
         def.skipDeprecated("contentType is deprecated in GridFS spec, and 4.x Java driver no longer supports it")
@@ -256,24 +260,28 @@ public static void applyCustomizations(final TestDef def) {
 
     private UnifiedTestModifications() {}
 
-    public static TestDef testDef(final String dir, final String file, final String test, final boolean reactive) {
-        return new TestDef(dir, file, test, reactive);
+    public static TestDef testDef(final String dir, final String file, final String test, final boolean reactive,
+            final UnifiedTest.Language language) {
+        return new TestDef(dir, file, test, reactive, language);
     }
 
     public static final class TestDef {
+
         private final String dir;
         private final String file;
         private final String test;
         private final boolean reactive;
+        private final UnifiedTest.Language language;
 
         private final List<Modifier> modifiers = new ArrayList<>();
         private Function<Throwable, Boolean> matchesThrowable;
 
-        private TestDef(final String dir, final String file, final String test, final boolean reactive) {
+        private TestDef(final String dir, final String file, final String test, final boolean reactive, final UnifiedTest.Language language) {
             this.dir = assertNotNull(dir);
             this.file = assertNotNull(file);
             this.test = assertNotNull(test);
             this.reactive = reactive;
+            this.language = assertNotNull(language);
         }
 
         /**
@@ -354,6 +362,10 @@ public boolean isReactive() {
             return reactive;
         }
 
+        public UnifiedTest.Language getLanguage() {
+            return language;
+        }
+
         public boolean wasAssignedModifier(final Modifier modifier) {
             return this.modifiers.contains(modifier);
         }

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ internal class UnifiedCrudTest() : UnifiedTest() {`
`24`	`24`	`@JvmStatic`
`25`	`25`	`@Throws(URISyntaxException::class, IOException::class)`
`26`	`26`	`fun data(): Collection<Arguments>? {`
`27`		`- return getTestData("unified-test-format/crud", true)`
	`27`	`+ return getTestData("unified-test-format/crud", true, Language.KOTLIN)`
`28`	`28`	`}`
`29`	`29`	`}`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,4 +39,8 @@ internal abstract class UnifiedTest() : JUnifiedTest() {`
`39`	`39`	`): ClientEncryption {`
`40`	`40`	`TODO("Not yet implemented - JAVA-4896")`
`41`	`41`	`}`
	`42`	`+`
	`43`	`+ override fun isReactive(): Boolean = true`
	`44`	`+`
	`45`	`+ override fun getLanguage(): Language = Language.KOTLIN`
`42`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,4 +39,6 @@ internal abstract class UnifiedTest() : JUnifiedTest() {`
`39`	`39`	`): ClientEncryption {`
`40`	`40`	`TODO("Not yet implemented - JAVA-4896")`
`41`	`41`	`}`
	`42`	`+`
	`43`	`+ override fun getLanguage(): Language = Language.KOTLIN`
`42`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -101,6 +101,6 @@ protected void postCleanUp(final TestDef testDef) {`
`101`	`101`
`102`	`102`	`@NonNull`
`103`	`103`	`protected static Collection<Arguments> getTestData(final String directory) {`
`104`		`- return getTestData(directory, true);`
	`104`	`+ return getTestData(directory, true, Language.JAVA);`
`105`	`105`	`}`
`106`	`106`	`}`
Original file line number	Diff line number	Diff line change
`@@ -408,6 +408,11 @@ OperationResult executeFind(final BsonDocument operation) {`
`408`	`408`	`});`
`409`	`409`	`}`
`410`	`410`
	`411`	`+ /**`
	`412`	`+ * There is no explicit {@code findOne()} method in {@link MongoCollection} class.`
	`413`	`+ * Its feature was emulated by {@link FindIterable#first()}, which would close cursor on server`
	`414`	`+ * by setting {@code batchSize} and {@code limit} appropriately.`
	`415`	`+ */`
`411`	`416`	`OperationResult executeFindOne(final BsonDocument operation) {`
`412`	`417`	`return resultOf(() -> createFindIterable(operation).first());`
`413`	`418`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,6 @@ protected ClientEncryption createClientEncryption(final MongoClient keyVaultClie`
`51`	`51`
`52`	`52`	`@NonNull`
`53`	`53`	`protected static Collection<Arguments> getTestData(final String directory) {`
`54`		`- return getTestData(directory, false);`
	`54`	`+ return getTestData(directory, false, Language.JAVA);`
`55`	`55`	`}`
`56`	`56`	`}`