PHPLIB-810: Always use count command for estimatedDocumentCount

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

@@ -11,7 +11,7 @@ source:
   ref: bypassDocumentValidation
 ---
 source:
-  file: apiargs-aggregate-option.yaml
+  file: apiargs-common-option.yaml
   ref: comment
 post: |
   .. versionadded:: 1.3

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

@@ -2,6 +2,12 @@ source:
   file: apiargs-MongoDBCollection-common-option.yaml
   ref: collation
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: comment
+post: |
+  .. versionadded:: 1.13
+---
 arg_name: option
 name: hint
 type: string|array|object

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

@@ -2,6 +2,12 @@ source:
   file: apiargs-MongoDBCollection-common-option.yaml
   ref: collation
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: comment
+post: |
+  .. versionadded:: 1.13
+---
 arg_name: option
 name: hint
 type: string|array|object

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

@@ -1,3 +1,9 @@
+source:
+  file: apiargs-common-option.yaml
+  ref: comment
+post: |
+  .. versionadded:: 1.13
+---
 source:
   file: apiargs-common-option.yaml
   ref: maxTimeMS

docs/includes/apiargs-MongoDBDatabase-method-aggregate-option.yaml

@@ -11,7 +11,7 @@ source:
   ref: bypassDocumentValidation
 ---
 source:
-  file: apiargs-aggregate-option.yaml
+  file: apiargs-common-option.yaml
   ref: comment
 ---
 source:

docs/includes/apiargs-aggregate-option.yaml

@@ -27,16 +27,6 @@ post: |
   :ref:`$out <agg-merge>` stages.
 ---
 arg_name: option
-name: comment
-type: string
-description: |
-  Users can specify an arbitrary string to help trace the operation through the
-  database profiler, currentOp, and logs.
-interface: phpmethod
-operation: ~
-optional: true
----
-arg_name: option
 name: explain
 type: boolean
 description: |

docs/includes/apiargs-common-option.yaml

@@ -13,6 +13,22 @@ operation: ~
 optional: true
 ---
 arg_name: option
+name: comment
+type: mixed
+description: |
+  Enables users to specify an arbitrary comment to help trace the operation through
+  the database profiler, currentOp and logs. The default is to not send a value.
+
+  The comment can be any valid BSON type for server versions 4.4 and above.
+  Server versions between 3.6 and 4.2 only support string as comment,
+  and providing a non-string type will result in a server-side error.
+  Older server versions do not support comment for aggregate command at all,
+  and providing one will result in a server-side error.
+interface: phpmethod
+operation: ~
+optional: true
+---
+arg_name: option
 name: hint
 type: string|array|object
 description: |

src/Operation/Aggregate.php

@@ -86,8 +86,15 @@ class Aggregate implements Executable, Explainable
      *
      *  * collation (document): Collation specification.
      *
-     *  * comment (string): An arbitrary string to help trace the operation
-     *    through the database profiler, currentOp, and logs.
+     *  * comment (mixed): Enables users to specify an arbitrary comment to help trace
+     *    the operation through the database profiler, currentOp and logs. The
+     *    default is to not send a value.
+     *
+     *    The comment can be any valid BSON type for server versions 4.4 and above.
+     *    Server versions between 3.6 and 4.2 only support string as comment,
+     *    and providing a non-string type will result in a server-side error.
+     *    Older server versions do not support comment for aggregate command at all,
+     *    and providing one will result in a server-side error.
      *
      *  * explain (boolean): Specifies whether or not to return the information
      *    on the processing of the pipeline.
@@ -170,10 +177,6 @@ public function __construct($databaseName, $collectionName, array $pipeline, arr
             throw InvalidArgumentException::invalidType('"collation" option', $options['collation'], 'array or object');
         }
 
-        if (isset($options['comment']) && ! is_string($options['comment'])) {
-            throw InvalidArgumentException::invalidType('"comment" option', $options['comment'], 'string');
-        }
-
         if (isset($options['explain']) && ! is_bool($options['explain'])) {
             throw InvalidArgumentException::invalidType('"explain" option', $options['explain'], 'boolean');
         }

src/Operation/Count.php

@@ -62,6 +62,16 @@ class Count implements Executable, Explainable
      *
      *  * collation (document): Collation specification.
      *
+     *  * comment (mixed): Enables users to specify an arbitrary comment to help trace
+     *    the operation through the database profiler, currentOp and logs. The
+     *    default is to not send a value.
+     *
+     *    The comment can be any valid BSON type for server versions 4.4 and above.
+     *    Server versions between 3.6 and 4.2 only support string as comment,
+     *    and providing a non-string type will result in a server-side error.
+     *    Older server versions do not support comment for aggregate command at all,
+     *    and providing one will result in a server-side error.
+     *
      *  * hint (string|document): The index to use. Specify either the index
      *    name as a string or the index key pattern as a document. If specified,
      *    then the query system will only consider plans using the hinted index.
@@ -195,7 +205,7 @@ private function createCommandDocument()
             $cmd['hint'] = is_array($this->options['hint']) ? (object) $this->options['hint'] : $this->options['hint'];
         }
 
-        foreach (['limit', 'maxTimeMS', 'skip'] as $option) {
+        foreach (['comment', 'limit', 'maxTimeMS', 'skip'] as $option) {
             if (isset($this->options[$option])) {
                 $cmd[$option] = $this->options[$option];
             }

src/Operation/CountDocuments.php

@@ -65,6 +65,16 @@ class CountDocuments implements Executable
      *
      *  * collation (document): Collation specification.
      *
+     *  * comment (mixed): Enables users to specify an arbitrary comment to help trace
+     *    the operation through the database profiler, currentOp and logs. The
+     *    default is to not send a value.
+     *
+     *    The comment can be any valid BSON type for server versions 4.4 and above.
+     *    Server versions between 3.6 and 4.2 only support string as comment,
+     *    and providing a non-string type will result in a server-side error.
+     *    Older server versions do not support comment for aggregate command at all,
+     *    and providing one will result in a server-side error.
+     *
      *  * hint (string|document): The index to use. Specify either the index
      *    name as a string or the index key pattern as a document. If specified,
      *    then the query system will only consider plans using the hinted index.
@@ -107,7 +117,7 @@ public function __construct($databaseName, $collectionName, $filter, array $opti
         $this->collectionName = (string) $collectionName;
         $this->filter = $filter;
 
-        $this->aggregateOptions = array_intersect_key($options, ['collation' => 1, 'hint' => 1, 'maxTimeMS' => 1, 'readConcern' => 1, 'readPreference' => 1, 'session' => 1]);
+        $this->aggregateOptions = array_intersect_key($options, ['collation' => 1, 'comment' => 1, 'hint' => 1, 'maxTimeMS' => 1, 'readConcern' => 1, 'readPreference' => 1, 'session' => 1]);
         $this->countOptions = array_intersect_key($options, ['limit' => 1, 'skip' => 1]);
 
         $this->aggregate = $this->createAggregate();

src/Operation/EstimatedDocumentCount.php

@@ -29,7 +29,6 @@
 
 use function array_intersect_key;
 use function is_integer;
-use function MongoDB\server_supports_feature;
 
 /**
  * Operation for obtaining an estimated count of documents in a collection
@@ -61,6 +60,16 @@ class EstimatedDocumentCount implements Executable, Explainable
      *
      * Supported options:
      *
+     *  * comment (mixed): Enables users to specify an arbitrary comment to help trace
+     *    the operation through the database profiler, currentOp and logs. The
+     *    default is to not send a value.
+     *
+     *    The comment can be any valid BSON type for server versions 4.4 and above.
+     *    Server versions between 3.6 and 4.2 only support string as comment,
+     *    and providing a non-string type will result in a server-side error.
+     *    Older server versions do not support comment for aggregate command at all,
+     *    and providing one will result in a server-side error.
+     *
      *  * maxTimeMS (integer): The maximum amount of time to allow the query to
      *    run.
      *
@@ -96,7 +105,7 @@ public function __construct($databaseName, $collectionName, array $options = [])
             throw InvalidArgumentException::invalidType('"session" option', $options['session'], Session::class);
         }
 
-        $this->options = array_intersect_key($options, ['maxTimeMS' => 1, 'readConcern' => 1, 'readPreference' => 1, 'session' => 1]);
+        $this->options = array_intersect_key($options, ['comment' => 1, 'maxTimeMS' => 1, 'readConcern' => 1, 'readPreference' => 1, 'session' => 1]);
     }
 
     /**
@@ -157,12 +166,9 @@ private function createAggregate(): Aggregate
         );
     }
 
-    /** @return Aggregate|Count */
-    private function createCommand(Server $server)
+    private function createCommand(Server $server): Count
     {
-        return server_supports_feature($server, self::$wireVersionForCollStats)
-            ? $this->createAggregate()
-            : $this->createCount();
+        return $this->createCount();
     }
 
     private function createCount(): Count

tests/Operation/AggregateTest.php

@@ -43,10 +43,6 @@ public function provideInvalidConstructorOptions()
             $options[][] = ['collation' => $value];
         }
 
-        foreach ($this->getInvalidStringValues() as $value) {
-            $options[][] = ['comment' => $value];
-        }
-
         foreach ($this->getInvalidHintValues() as $value) {
             $options[][] = ['hint' => $value];
         }