Remove trace logging and introduce static method to write logs

Author: jmikola

src/PsrLogAdapter.php

@@ -18,12 +18,14 @@
 namespace MongoDB;
 
 use MongoDB\Driver\Logging\Logger as DriverLogger;
+use MongoDB\Exception\UnexpectedValueException;
 use Psr\Log\LoggerInterface as PsrLogger;
 use Psr\Log\LogLevel as PsrLogLevel;
 use SplObjectStorage;
 
 use function MongoDB\Driver\Logging\addLogger;
 use function MongoDB\Driver\Logging\removeLogger;
+use function sprintf;
 
 final class PsrLogAdapter implements DriverLogger
 {
@@ -41,10 +43,6 @@ final class PsrLogAdapter implements DriverLogger
         DriverLogger::LEVEL_MESSAGE => PsrLogLevel::NOTICE,
         DriverLogger::LEVEL_INFO => PsrLogLevel::INFO,
         DriverLogger::LEVEL_DEBUG => PsrLogLevel::DEBUG,
-        /* PSR does not define a "trace" level, so map it to "debug" in the PSR
-         * logger. That said, trace logging is very verbose and should not be
-         * encouraged when using a PSR logger. */
-        DriverLogger::LEVEL_TRACE => PsrLogLevel::DEBUG,
     ];
 
     public static function addLogger(PsrLogger $psrLogger): void
@@ -56,21 +54,26 @@ public static function addLogger(PsrLogger $psrLogger): void
         addLogger($instance);
     }
 
-    public static function getInstance(): self
+    /**
+     * Pipes a log message from PHPC to all registered PSR loggers.
+     *
+     * @internal
+     * @see DriverLogger::log()
+     */
+    public function log(int $level, string $domain, string $message): void
     {
-        if (self::$instance === null) {
-            self::$instance = new self();
+        if (! isset(self::PSR_LEVELS[$level])) {
+            throw new UnexpectedValueException(sprintf(
+                'Expected level to be >= %d and <= %d, %d given for domain "%s" and message: %s',
+                DriverLogger::LEVEL_ERROR,
+                DriverLogger::LEVEL_DEBUG,
+                $level,
+                $domain,
+                $message,
+            ));
         }
 
-        return self::$instance;
-    }
-
-    public function log(int $level, string $domain, string $message): void
-    {
         $instance = self::getInstance();
-        /* A default case is intentionally not handled since libmongoc and
-         * PHPC should avoid emitting bogus levels; however, we can consider
-         * throwing an UnexpectedValueException here. */
         $psrLevel = self::PSR_LEVELS[$level];
         $context = ['domain' => $domain];
 
@@ -89,8 +92,27 @@ public static function removeLogger(PsrLogger $psrLogger): void
         }
     }
 
+    /**
+     * Writes a log message to all registered PSR loggers.
+     *
+     * @internal
+     */
+    public static function writeLog(int $level, string $domain, string $message): void
+    {
+        self::getInstance()->log($level, $domain, $message);
+    }
+
     private function __construct()
     {
         $this->psrLoggers = new SplObjectStorage();
     }
+
+    private static function getInstance(): self
+    {
+        if (self::$instance === null) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
 }

tests/PsrLogAdapterTest.php

@@ -3,14 +3,15 @@
 namespace MongoDB\Tests;
 
 use MongoDB\Driver\Logging\Logger as DriverLogger;
+use MongoDB\Exception\UnexpectedValueException;
 use MongoDB\PsrLogAdapter;
 use PHPUnit\Framework\TestCase as BaseTestCase;
 use Psr\Log\AbstractLogger;
 use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
 
 use function func_get_args;
-use function MongoDB\Driver\Logging\log;
+use function sprintf;
 
 class PsrLogAdapterTest extends BaseTestCase
 {
@@ -28,19 +29,32 @@ public function tearDown(): void
         PsrLogAdapter::removeLogger($this->logger);
     }
 
-    public function testDriverLogLevelsAreMappedToPsrLogLevels(): void
+    /**
+     * @testWith [-1]
+     *           [6]
+     */
+    public function testWriteLogWithInvalidLevel(int $level): void
+    {
+        $this->expectException(UnexpectedValueException::class);
+        $this->expectExceptionMessage(sprintf('Expected level to be >= 0 and <= 5, %d given for domain "domain" and message: message', $level));
+
+        PsrLogAdapter::writeLog($level, 'domain', 'message');
+    }
+
+    public function testWriteLogMapsDriverLogLevelsToPsrLogLevels(): void
     {
         PsrLogAdapter::addLogger($this->logger);
 
-        log(DriverLogger::LEVEL_ERROR, 'error');
-        log(DriverLogger::LEVEL_CRITICAL, 'critical');
-        log(DriverLogger::LEVEL_WARNING, 'warning');
-        log(DriverLogger::LEVEL_MESSAGE, 'message');
-        log(DriverLogger::LEVEL_INFO, 'info');
-        log(DriverLogger::LEVEL_DEBUG, 'debug');
-        log(DriverLogger::LEVEL_TRACE, 'trace');
+        $domain = 'domain';
+
+        PsrLogAdapter::writeLog(DriverLogger::LEVEL_ERROR, $domain, 'error');
+        PsrLogAdapter::writeLog(DriverLogger::LEVEL_CRITICAL, $domain, 'critical');
+        PsrLogAdapter::writeLog(DriverLogger::LEVEL_WARNING, $domain, 'warning');
+        PsrLogAdapter::writeLog(DriverLogger::LEVEL_MESSAGE, $domain, 'message');
+        PsrLogAdapter::writeLog(DriverLogger::LEVEL_INFO, $domain, 'info');
+        PsrLogAdapter::writeLog(DriverLogger::LEVEL_DEBUG, $domain, 'debug');
 
-        $context = ['domain' => 'php'];
+        $context = ['domain' => $domain];
 
         $expectedLogs = [
             [LogLevel::ERROR, 'error', $context],
@@ -49,7 +63,6 @@ public function testDriverLogLevelsAreMappedToPsrLogLevels(): void
             [LogLevel::NOTICE, 'message', $context],
             [LogLevel::INFO, 'info', $context],
             [LogLevel::DEBUG, 'debug', $context],
-            [LogLevel::DEBUG, 'trace', $context],
         ];
 
         $this->assertSame($this->logger->logs, $expectedLogs);