PHPLIB-1309 Add addSubscriber/removeSubscriber to Client class to ease configuration

Author: GromNaN

CHANGELOG.md

@@ -0,0 +1,8 @@
+CHANGELOG
+=========
+
+1.18.0 (unreleased)
+-------------------
+
+ * Add `addSubscriber` and `removeSubscriber` methods to the `Client` class to ease dependency injection configuration
+

src/Client.php

@@ -23,6 +23,7 @@
 use MongoDB\Driver\Exception\InvalidArgumentException as DriverInvalidArgumentException;
 use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
 use MongoDB\Driver\Manager;
+use MongoDB\Driver\Monitoring\Subscriber;
 use MongoDB\Driver\ReadConcern;
 use MongoDB\Driver\ReadPreference;
 use MongoDB\Driver\Session;
@@ -163,6 +164,16 @@ public function __toString()
         return $this->uri;
     }
 
+    /**
+     * Registers a monitoring event subscriber with this Client's Manager
+     *
+     * @see Manager::addSubscriber()
+     */
+    final public function addSubscriber(Subscriber $subscriber): void
+    {
+        $this->manager->addSubscriber($subscriber);
+    }
+
     /**
      * Returns a ClientEncryption instance for explicit encryption and decryption
      *
@@ -296,6 +307,16 @@ public function listDatabases(array $options = [])
         return $operation->execute($server);
     }
 
+    /**
+     * Unregisters a monitoring event subscriber with this Client's Manager
+     *
+     * @see Manager::removeSubscriber()
+     */
+    final public function removeSubscriber(Subscriber $subscriber): void
+    {
+        $this->manager->removeSubscriber($subscriber);
+    }
+
     /**
      * Select a collection.
      *

tests/ClientFunctionalTest.php

@@ -4,7 +4,9 @@
 
 use MongoDB\Client;
 use MongoDB\Driver\BulkWrite;
+use MongoDB\Driver\Command;
 use MongoDB\Driver\Manager;
+use MongoDB\Driver\Monitoring\CommandSubscriber;
 use MongoDB\Driver\Session;
 use MongoDB\Model\DatabaseInfo;
 use MongoDB\Model\DatabaseInfoIterator;
@@ -119,4 +121,20 @@ public function testStartSession(): void
     {
         $this->assertInstanceOf(Session::class, $this->client->startSession());
     }
+
+    public function testAddAndRemoveSubscriber(): void
+    {
+        $client = new Client(static::getUri());
+
+        $addedSubscriber = $this->createMock(CommandSubscriber::class);
+        $addedSubscriber->expects($this->once())->method('commandStarted');
+        $client->addSubscriber($addedSubscriber);
+
+        $removedSubscriber = $this->createMock(CommandSubscriber::class);
+        $removedSubscriber->expects($this->never())->method('commandStarted');
+        $client->addSubscriber($removedSubscriber);
+        $client->removeSubscriber($removedSubscriber);
+
+        $client->getManager()->executeCommand('admin', new Command(['ping' => 1]));
+    }
 }