PHPLIB-545: Support the authorizedDatabases options for listDatabases

Author: alcaeus

docs/includes/apiargs-MongoDBClient-method-listDatabases-option.yaml

@@ -1,4 +1,16 @@
 arg_name: option
+name: authorizedDatabases
+type: boolean
+description: |
+  A flag that determines which databases are returned based on the user
+  privileges when access control is enabled. For more information, see the
+  `listDatabases command documentation <https://docs.mongodb.com/manual/reference/command/listDatabases/#dbcmd.listDatabases>`_.
+
+  For servers < 4.0.5, this option is ignored.
+
+  .. versionadded:: 1.7
+---
+arg_name: option
 name: filter
 type: array|object
 description: |

src/Operation/ListDatabases.php

@@ -27,6 +27,7 @@
 use MongoDB\Model\DatabaseInfoLegacyIterator;
 use function current;
 use function is_array;
+use function is_bool;
 use function is_integer;
 use function is_object;
 
@@ -47,6 +48,11 @@ class ListDatabases implements Executable
      *
      * Supported options:
      *
+     *  * authorizedDatabases (boolean): Determines which databases are returned
+     *    based on the user privileges.
+     *
+     *    For servers < 4.0.5, this option is ignored.
+     *
      *  * filter (document): Query by which to filter databases.
      *
      *    For servers < 3.6, this option is ignored.
@@ -63,6 +69,10 @@ class ListDatabases implements Executable
      */
     public function __construct(array $options = [])
     {
+        if (isset($options['authorizedDatabases']) && ! is_bool($options['authorizedDatabases'])) {
+            throw InvalidArgumentException::invalidType('"authorizedDatabases" option', $options['authorizedDatabases'], 'boolean');
+        }
+
         if (isset($options['filter']) && ! is_array($options['filter']) && ! is_object($options['filter'])) {
             throw InvalidArgumentException::invalidType('"filter" option', $options['filter'], 'array or object');
         }
@@ -91,6 +101,10 @@ public function execute(Server $server)
     {
         $cmd = ['listDatabases' => 1];
 
+        if (isset($this->options['authorizedDatabases'])) {
+            $cmd['authorizedDatabases'] = $this->options['authorizedDatabases'];
+        }
+
         if (! empty($this->options['filter'])) {
             $cmd['filter'] = (object) $this->options['filter'];
         }

tests/Operation/ListDatabasesFunctionalTest.php

@@ -19,8 +19,17 @@ public function testListDatabases()
         $writeResult = $insertOne->execute($server);
         $this->assertEquals(1, $writeResult->getInsertedCount());
 
-        $operation = new ListDatabases();
-        $databases = $operation->execute($server);
+        $databases = null;
+        (new CommandObserver())->observe(
+            function () use (&$databases, $server) {
+                $operation = new ListDatabases();
+
+                $databases = $operation->execute($server);
+            },
+            function (array $event) {
+                $this->assertObjectNotHasAttribute('authorizedDatabases', $event['started']->getCommand());
+            }
+        );
 
         $this->assertInstanceOf(DatabaseInfoIterator::class, $databases);
 
@@ -29,6 +38,22 @@ public function testListDatabases()
         }
     }
 
+    public function testAuthorizedDatabasesOption()
+    {
+        (new CommandObserver())->observe(
+            function () {
+                $operation = new ListDatabases(
+                    ['authorizedDatabases' => true]
+                );
+
+                $operation->execute($this->getPrimaryServer());
+            },
+            function (array $event) {
+                $this->assertObjectHasAttribute('authorizedDatabases', $event['started']->getCommand());
+            }
+        );
+    }
+
     public function testFilterOption()
     {
         if (version_compare($this->getServerVersion(), '3.6.0', '<')) {

tests/Operation/ListDatabasesTest.php

@@ -20,6 +20,10 @@ public function provideInvalidConstructorOptions()
     {
         $options = [];
 
+        foreach ($this->getInvalidBooleanValues() as $value) {
+            $options[][] = ['authorizedDatabases' => $value];
+        }
+
         foreach ($this->getInvalidDocumentValues() as $value) {
             $options[][] = ['filter' => $value];
         }