PHPLIB-740: Support authorizedCollections option for listCollections (#884)

* PHPLIB-740: Support authorizedCollections option for listCollections

* Update tests and docs for authorizedDatabases option

Author: jmikola

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

@@ -4,7 +4,7 @@ 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>`_.
+  `listDatabases command documentation <https://docs.mongodb.com/manual/reference/command/listDatabases/>`_.
 
   For servers < 4.0.5, this option is ignored.
 

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

@@ -1,4 +1,19 @@
 arg_name: option
+name: authorizedCollections
+type: boolean
+description: |
+  A flag that determines which collections are returned based on the user
+  privileges when access control is enabled. For more information, see the
+  `listCollections command documentation <https://docs.mongodb.com/manual/reference/command/listCollections/>`_.
+
+  For servers < 4.0, this option is ignored.
+
+  .. versionadded:: 1.12
+interface: phpmethod
+operation: ~
+optional: true
+---
+arg_name: option
 name: filter
 type: array|object
 description: |

src/Command/ListCollections.php

@@ -49,6 +49,11 @@ class ListCollections implements Executable
      *
      * Supported options:
      *
+     *  * authorizedCollections (boolean): Determines which collections are
+     *    returned based on the user privileges.
+     *
+     *    For servers < 4.0, this option is ignored.
+     *
      *  * filter (document): Query by which to filter collections.
      *
      *  * maxTimeMS (integer): The maximum amount of time to allow the query to
@@ -68,6 +73,10 @@ class ListCollections implements Executable
      */
     public function __construct($databaseName, array $options = [])
     {
+        if (isset($options['authorizedCollections']) && ! is_bool($options['authorizedCollections'])) {
+            throw InvalidArgumentException::invalidType('"authorizedCollections" option', $options['authorizedCollections'], 'boolean');
+        }
+
         if (isset($options['filter']) && ! is_array($options['filter']) && ! is_object($options['filter'])) {
             throw InvalidArgumentException::invalidType('"filter" option', $options['filter'], 'array or object');
         }
@@ -104,12 +113,10 @@ public function execute(Server $server)
             $cmd['filter'] = (object) $this->options['filter'];
         }
 
-        if (isset($this->options['maxTimeMS'])) {
-            $cmd['maxTimeMS'] = $this->options['maxTimeMS'];
-        }
-
-        if (isset($this->options['nameOnly'])) {
-            $cmd['nameOnly'] = $this->options['nameOnly'];
+        foreach (['authorizedCollections', 'maxTimeMS', 'nameOnly'] as $option) {
+            if (isset($this->options[$option])) {
+                $cmd[$option] = $this->options[$option];
+            }
         }
 
         $cursor = $server->executeReadCommand($this->databaseName, new Command($cmd), $this->createOptions());

src/Command/ListDatabases.php

@@ -108,20 +108,14 @@ 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'];
         }
 
-        if (isset($this->options['maxTimeMS'])) {
-            $cmd['maxTimeMS'] = $this->options['maxTimeMS'];
-        }
-
-        if (isset($this->options['nameOnly'])) {
-            $cmd['nameOnly'] = $this->options['nameOnly'];
+        foreach (['authorizedDatabases', 'maxTimeMS', 'nameOnly'] as $option) {
+            if (isset($this->options[$option])) {
+                $cmd[$option] = $this->options[$option];
+            }
         }
 
         $cursor = $server->executeReadCommand('admin', new Command($cmd), $this->createOptions());

src/Operation/ListCollectionNames.php

@@ -41,6 +41,11 @@ class ListCollectionNames implements Executable
      *
      * Supported options:
      *
+     *  * authorizedCollections (boolean): Determines which collections are
+     *    returned based on the user privileges.
+     *
+     *    For servers < 4.0, this option is ignored.
+     *
      *  * filter (document): Query by which to filter collections.
      *
      *  * maxTimeMS (integer): The maximum amount of time to allow the query to

src/Operation/ListCollections.php

@@ -44,6 +44,11 @@ class ListCollections implements Executable
      *
      * Supported options:
      *
+     *  * authorizedCollections (boolean): Determines which collections are
+     *    returned based on the user privileges.
+     *
+     *    For servers < 4.0, this option is ignored.
+     *
      *  * filter (document): Query by which to filter collections.
      *
      *  * maxTimeMS (integer): The maximum amount of time to allow the query to

tests/Command/ListCollectionsTest.php

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

tests/Operation/ListCollectionNamesFunctionalTest.php

@@ -31,6 +31,24 @@ public function testListCollectionNamesForNewlyCreatedDatabase(): void
         }
     }
 
+    public function testAuthorizedCollectionsOption(): void
+    {
+        (new CommandObserver())->observe(
+            function (): void {
+                $operation = new ListCollectionNames(
+                    $this->getDatabaseName(),
+                    ['authorizedCollections' => true]
+                );
+
+                $operation->execute($this->getPrimaryServer());
+            },
+            function (array $event): void {
+                $this->assertObjectHasAttribute('authorizedCollections', $event['started']->getCommand());
+                $this->assertSame(true, $event['started']->getCommand()->authorizedCollections);
+            }
+        );
+    }
+
     public function testSessionOption(): void
     {
         if (version_compare($this->getServerVersion(), '3.6.0', '<')) {

tests/Operation/ListCollectionsFunctionalTest.php

@@ -80,6 +80,24 @@ public function testListCollectionsForNonexistentDatabase(): void
         $this->assertCount(0, $collections);
     }
 
+    public function testAuthorizedCollectionsOption(): void
+    {
+        (new CommandObserver())->observe(
+            function (): void {
+                $operation = new ListCollections(
+                    $this->getDatabaseName(),
+                    ['authorizedCollections' => true]
+                );
+
+                $operation->execute($this->getPrimaryServer());
+            },
+            function (array $event): void {
+                $this->assertObjectHasAttribute('authorizedCollections', $event['started']->getCommand());
+                $this->assertSame(true, $event['started']->getCommand()->authorizedCollections);
+            }
+        );
+    }
+
     public function testSessionOption(): void
     {
         if (version_compare($this->getServerVersion(), '3.6.0', '<')) {

tests/Operation/ListDatabaseNamesFunctionalTest.php

@@ -48,7 +48,7 @@ function (): void {
             },
             function (array $event): void {
                 $this->assertObjectHasAttribute('authorizedDatabases', $event['started']->getCommand());
-                $this->assertSame(true, $event['started']->getCommand()->nameOnly);
+                $this->assertSame(true, $event['started']->getCommand()->authorizedDatabases);
             }
         );
     }