PHPLIB-721: Aggregate allowDiskUse option should be unset by default (#873)

Author: jmikola

docs/includes/apiargs-MongoDBCollection-method-find-option.yaml

@@ -51,8 +51,7 @@ name: allowDiskUse
 type: boolean
 description: |
   Enables writing to temporary files. When set to ``true``, queries can write
-  data to the ``_tmp`` sub-directory in the ``dbPath`` directory. The default is
-  ``false``.
+  data to the ``_tmp`` sub-directory in the ``dbPath`` directory.
 interface: phpmethod
 operation: ~
 optional: true

docs/includes/apiargs-aggregate-option.yaml

@@ -3,8 +3,7 @@ name: allowDiskUse
 type: boolean
 description: |
   Enables writing to temporary files. When set to ``true``, aggregation stages
-  can write data to the ``_tmp`` sub-directory in the ``dbPath`` directory. The
-  default is ``false``.
+  can write data to the ``_tmp`` sub-directory in the ``dbPath`` directory.
 interface: phpmethod
 operation: ~
 optional: true

src/Operation/Aggregate.php

@@ -89,7 +89,7 @@ class Aggregate implements Executable, Explainable
      *
      *  * allowDiskUse (boolean): Enables writing to temporary files. When set
      *    to true, aggregation stages can write data to the _tmp sub-directory
-     *    in the dbPath directory. The default is false.
+     *    in the dbPath directory.
      *
      *  * batchSize (integer): The number of documents to return per batch.
      *
@@ -179,12 +179,9 @@ public function __construct($databaseName, $collectionName, array $pipeline, arr
             $expectedIndex += 1;
         }
 
-        $options += [
-            'allowDiskUse' => false,
-            'useCursor' => true,
-        ];
+        $options += ['useCursor' => true];
 
-        if (! is_bool($options['allowDiskUse'])) {
+        if (isset($options['allowDiskUse']) && ! is_bool($options['allowDiskUse'])) {
             throw InvalidArgumentException::invalidType('"allowDiskUse" option', $options['allowDiskUse'], 'boolean');
         }
 
@@ -363,16 +360,14 @@ private function createCommandDocument(Server $server): array
             'pipeline' => $this->pipeline,
         ];
 
-        $cmd['allowDiskUse'] = $this->options['allowDiskUse'];
-
         if (
             ! empty($this->options['bypassDocumentValidation']) &&
             server_supports_feature($server, self::$wireVersionForDocumentLevelValidation)
         ) {
             $cmd['bypassDocumentValidation'] = $this->options['bypassDocumentValidation'];
         }
 
-        foreach (['comment', 'explain', 'maxTimeMS'] as $option) {
+        foreach (['allowDiskUse', 'comment', 'explain', 'maxTimeMS'] as $option) {
             if (isset($this->options[$option])) {
                 $cmd[$option] = $this->options[$option];
             }

src/Operation/Find.php

@@ -79,7 +79,7 @@ class Find implements Executable, Explainable
      *
      *  * allowDiskUse (boolean): Enables writing to temporary files. When set
      *    to true, queries can write data to the _tmp sub-directory in the
-     *    dbPath directory. The default is false.
+     *    dbPath directory.
      *
      *  * allowPartialResults (boolean): Get partial results from a mongos if
      *    some shards are inaccessible (instead of throwing an error).

tests/Operation/AggregateFunctionalTest.php

@@ -18,6 +18,24 @@
 
 class AggregateFunctionalTest extends FunctionalTestCase
 {
+    public function testAllowDiskUseIsOmittedByDefault(): void
+    {
+        (new CommandObserver())->observe(
+            function (): void {
+                $operation = new Aggregate(
+                    $this->getDatabaseName(),
+                    $this->getCollectionName(),
+                    [['$match' => ['x' => 1]]]
+                );
+
+                $operation->execute($this->getPrimaryServer());
+            },
+            function (array $event): void {
+                $this->assertObjectNotHasAttribute('allowDiskUse', $event['started']->getCommand());
+            }
+        );
+    }
+
     public function testBatchSizeIsIgnoredIfPipelineIncludesOutStage(): void
     {
         (new CommandObserver())->observe(

tests/Operation/AggregateTest.php

@@ -27,7 +27,7 @@ public function provideInvalidConstructorOptions()
     {
         $options = [];
 
-        foreach ($this->getInvalidBooleanValues(true) as $value) {
+        foreach ($this->getInvalidBooleanValues() as $value) {
             $options[][] = ['allowDiskUse' => $value];
         }