Make PsrLogAdapter internal and create functions to add/remove loggers

Author: jmikola

src/PsrLogAdapter.php

@@ -27,9 +27,16 @@
 use function MongoDB\Driver\Monitoring\removeSubscriber;
 use function sprintf;
 
+/**
+ * Integrates libmongoc/PHPC logging with one or more PSR-3 loggers.
+ *
+ * This class is internal and should not be utilized by applications. Logging
+ * should be configured via the add_logger() and remove_logger() functions.
+ *
+ * @internal
+ */
 final class PsrLogAdapter implements LogSubscriber
 {
-    /** @internal */
     public const LEVEL_EMERGENCY = 0;
     public const LEVEL_ALERT = 1;
     public const LEVEL_CRITICAL = 2;
@@ -78,20 +85,9 @@ public static function addLogger(LoggerInterface $logger): void
         addSubscriber($instance);
     }
 
-    public static function removeLogger(LoggerInterface $logger): void
-    {
-        $instance = self::getInstance();
-        $instance->loggers->detach($logger);
-
-        if ($instance->loggers->count() === 0) {
-            removeSubscriber($instance);
-        }
-    }
-
     /**
      * Forwards a log message from libmongoc/PHPC to all registered PSR loggers.
      *
-     * @internal
      * @see LogSubscriber::log()
      */
     public function log(int $mongocLevel, string $domain, string $message): void
@@ -116,10 +112,20 @@ public function log(int $mongocLevel, string $domain, string $message): void
         }
     }
 
+    public static function removeLogger(LoggerInterface $logger): void
+    {
+        $instance = self::getInstance();
+        $instance->loggers->detach($logger);
+
+        if ($instance->loggers->count() === 0) {
+            removeSubscriber($instance);
+        }
+    }
+
     /**
      * Writes a log message to all registered PSR loggers.
      *
-     * @internal
+     * This function is intended for internal use within the library.
      */
     public static function writeLog(string $specLevel, string $domain, string $message): void
     {

src/functions.php

@@ -31,6 +31,7 @@
 use MongoDB\Exception\RuntimeException;
 use MongoDB\Operation\ListCollections;
 use MongoDB\Operation\WithTransaction;
+use Psr\Log\LoggerInterface;
 use ReflectionClass;
 use ReflectionException;
 
@@ -46,6 +47,26 @@
 use function MongoDB\BSON\toPHP;
 use function substr;
 
+/**
+ * Registers a PSR-3 logger to receive log messages from the driver/library.
+ *
+ * Adding a registered logger is a NOP.
+ */
+function add_logger(LoggerInterface $logger): void
+{
+    PsrLogAdapter::addLogger($logger);
+}
+
+/**
+ * Unregisters a PSR-3 logger.
+ *
+ * Removing an unregistered logger is a NOP.
+ */
+function remove_logger(LoggerInterface $logger): void
+{
+    PsrLogAdapter::removeLogger($logger);
+}
+
 /**
  * Check whether all servers support executing a write stage on a secondary.
  *

tests/PsrLogAdapterTest.php

@@ -11,7 +11,9 @@
 use Psr\Log\LogLevel;
 
 use function func_get_args;
+use function MongoDB\add_logger;
 use function MongoDB\Driver\Monitoring\mongoc_log;
+use function MongoDB\remove_logger;
 use function sprintf;
 
 class PsrLogAdapterTest extends BaseTestCase
@@ -30,6 +32,31 @@ public function tearDown(): void
         PsrLogAdapter::removeLogger($this->logger);
     }
 
+    public function testAddAndRemoveLoggerFunctions(): void
+    {
+        $logger = $this->createTestPsrLogger();
+
+        mongoc_log(LogSubscriber::LEVEL_INFO, 'domain1', 'info1');
+        PsrLogAdapter::writeLog(PsrLogAdapter::LEVEL_INFO, 'domain2', 'info2');
+
+        add_logger($logger);
+
+        mongoc_log(LogSubscriber::LEVEL_INFO, 'domain3', 'info3');
+        PsrLogAdapter::writeLog(PsrLogAdapter::LEVEL_INFO, 'domain4', 'info4');
+
+        remove_logger($logger);
+
+        mongoc_log(LogSubscriber::LEVEL_INFO, 'domain5', 'info5');
+        PsrLogAdapter::writeLog(PsrLogAdapter::LEVEL_INFO, 'domain6', 'info6');
+
+        $expectedLogs = [
+            [LogLevel::INFO, 'info3', ['domain' => 'domain3']],
+            [LogLevel::INFO, 'info4', ['domain' => 'domain4']],
+        ];
+
+        $this->assertSame($expectedLogs, $logger->logs);
+    }
+
     public function testLog(): void
     {
         /* This uses PHPC's internal mongoc_log() function to write messages