Adding the ability to configure the default channel

CHANGELOG.md

@@ -152,7 +152,9 @@
   - `Spiral\Snapshots\SnapshotterInterface` usage replaced with `Spiral\Exceptions\ExceptionReporterInterface` in all classes.
 - **Other Features**
   - [spiral/debug] Added `Spiral\Debug\StateConsumerInterface`.
-
+  - [spiral/monolog-bridge] Added the ability to configure the default channel using the configuration file or 
+    environment variable `MONOLOG_DEFAULT_CHANNEL`.
+
 ## v2.12.0 - 2022-04-07
 - **Medium Impact Changes**
   - Bootloaders `Spiral\Bootloader\Broadcast\BroadcastBootloader`, `Spiral\Bootloader\Http\WebsocketsBootloader`

src/Bridge/Monolog/src/Bootloader/MonologBootloader.php

@@ -11,6 +11,7 @@
 use Monolog\ResettableInterface;
 use Psr\Log\LoggerInterface;
 use Spiral\Boot\Bootloader\Bootloader;
+use Spiral\Boot\EnvironmentInterface;
 use Spiral\Boot\FinalizerInterface;
 use Spiral\Config\ConfiguratorInterface;
 use Spiral\Config\Patch\Append;
@@ -35,7 +36,7 @@ public function __construct(
     ) {
     }
 
-    public function boot(Container $container, FinalizerInterface $finalizer): void
+    public function boot(Container $container, FinalizerInterface $finalizer, EnvironmentInterface $env): void
     {
         $finalizer->addFinalizer(static function () use ($container): void {
             if ($container->hasInstance(LoggerInterface::class)) {
@@ -56,6 +57,7 @@ public function boot(Container $container, FinalizerInterface $finalizer): void
         });
 
         $this->config->setDefaults(MonologConfig::CONFIG, [
+            'default' => $env->get('MONOLOG_DEFAULT_CHANNEL', MonologConfig::DEFAULT_CHANNEL),
             'globalLevel' => Logger::DEBUG,
             'handlers' => [],
         ]);

src/Bridge/Monolog/src/Config/MonologConfig.php

@@ -12,13 +12,20 @@
 final class MonologConfig extends InjectableConfig
 {
     public const CONFIG = 'monolog';
+    public const DEFAULT_CHANNEL = 'default';
 
     /** @var array */
     protected $config = [
+        'default'     => self::DEFAULT_CHANNEL,
         'globalLevel' => Logger::DEBUG,
         'handlers'    => [],
     ];
 
+    public function getDefault(): string
+    {
+        return $this->config['default'] ?? self::DEFAULT_CHANNEL;
+    }
+
     public function getEventLevel(): int
     {
         return $this->config['globalLevel'] ?? Logger::DEBUG;

src/Bridge/Monolog/src/LogFactory.php

@@ -20,9 +20,6 @@
 
 final class LogFactory implements LogsInterface, InjectorInterface, ResettableInterface
 {
-    // Default logger channel (supplied via injection)
-    public const DEFAULT = 'default';
-
     private ?LoggerInterface $default = null;
     private readonly HandlerInterface $eventHandler;
 
@@ -36,16 +33,18 @@ public function __construct(
 
     public function getLogger(string $channel = null): LoggerInterface
     {
-        if ($channel === null || $channel === self::DEFAULT) {
+        $default = $this->config->getDefault();
+
+        if ($channel === null || $channel === $default) {
             if ($this->default !== null) {
                 // we should use only one default logger per system
                 return $this->default;
             }
 
             return $this->default = new Logger(
-                self::DEFAULT,
-                $this->getHandlers(self::DEFAULT),
-                $this->getProcessors(self::DEFAULT)
+                $default,
+                $this->getHandlers($default),
+                $this->getProcessors($default)
             );
         }
 

src/Bridge/Monolog/tests/BaseTest.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Tests\Monolog;
+
+use PHPUnit\Framework\TestCase;
+use Spiral\Boot\Environment;
+use Spiral\Boot\EnvironmentInterface;
+use Spiral\Core\Container;
+
+abstract class BaseTest extends TestCase
+{
+    protected Container $container;
+
+    protected function setUp(): void
+    {
+        $this->container = new Container();
+        $this->container->bind(EnvironmentInterface::class, new Environment());
+    }
+}

src/Bridge/Monolog/tests/FactoryTest.php

@@ -16,7 +16,6 @@
 use Monolog\Logger;
 use Monolog\Processor\ProcessorInterface;
 use Monolog\ResettableInterface;
-use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
 use Spiral\Boot\BootloadManager;
 use Spiral\Boot\Finalizer;
@@ -31,27 +30,37 @@
 use Spiral\Monolog\Config\MonologConfig;
 use Spiral\Monolog\LogFactory;
 
-class FactoryTest extends TestCase
+class FactoryTest extends BaseTest
 {
     use MockeryPHPUnitIntegration;
 
     public function testDefaultLogger(): void
     {
-        $factory = new LogFactory(new MonologConfig([]), new ListenerRegistry(), new Container());
+        $factory = new LogFactory(new MonologConfig([]), new ListenerRegistry(),$this->container);
+        $logger = $factory->getLogger();
+
+        $this->assertNotEmpty($logger);
+        $this->assertSame($logger, $factory->getLogger());
+        $this->assertSame($logger, $factory->getLogger(MonologConfig::DEFAULT_CHANNEL));
+    }
+
+    public function testChangedDefaultLogger(): void
+    {
+        $factory = new LogFactory(new MonologConfig(['default' => 'foo']), new ListenerRegistry(), $this->container);
+
         $logger = $factory->getLogger();
 
         $this->assertNotEmpty($logger);
         $this->assertSame($logger, $factory->getLogger());
-        $this->assertSame($logger, $factory->getLogger(LogFactory::DEFAULT));
+        $this->assertSame($logger, $factory->getLogger('foo'));
     }
 
     public function testInjection(): void
     {
         $factory = new LogFactory(new MonologConfig([]), new ListenerRegistry(), new Container());
         $logger = $factory->getLogger();
 
-        $container = new Container();
-        $container->bind(ConfiguratorInterface::class, new ConfigManager(
+        $this->container->bind(ConfiguratorInterface::class, new ConfigManager(
             new class() implements LoaderInterface {
                 public function has(string $section): bool
                 {
@@ -65,20 +74,19 @@ public function load(string $section): array
             }
         ));
 
-        $container->bind(FinalizerInterface::class, $finalizer = \Mockery::mock(FinalizerInterface::class));
+        $this->container->bind(FinalizerInterface::class, $finalizer = \Mockery::mock(FinalizerInterface::class));
         $finalizer->shouldReceive('addFinalizer')->once();
 
-        $container->get(BootloadManager::class)->bootload([MonologBootloader::class]);
-        $container->bind(LogFactory::class, $factory);
+        $this->container->get(BootloadManager::class)->bootload([MonologBootloader::class]);
+        $this->container->bind(LogFactory::class, $factory);
 
-        $this->assertSame($logger, $container->get(Logger::class));
-        $this->assertSame($logger, $container->get(LoggerInterface::class));
+        $this->assertSame($logger, $this->container->get(Logger::class));
+        $this->assertSame($logger, $this->container->get(LoggerInterface::class));
     }
 
     public function testFinalizerShouldResetDefaultLogger()
     {
-        $container = new Container();
-        $container->bind(ConfiguratorInterface::class, new ConfigManager(
+        $this->container->bind(ConfiguratorInterface::class, new ConfigManager(
             new class() implements LoaderInterface {
                 public function has(string $section): bool
                 {
@@ -92,7 +100,7 @@ public function load(string $section): array
             }
         ));
 
-        $container->bind(FinalizerInterface::class, $finalizer = new Finalizer());
+        $this->container->bind(FinalizerInterface::class, $finalizer = new Finalizer());
 
         $factory = new LogFactory(new MonologConfig([
             'handlers' => [
@@ -105,14 +113,14 @@ public function load(string $section): array
                     $processor = \Mockery::mock(ProcessorInterface::class, ResettableInterface::class)
                 ]
             ]
-        ]), new ListenerRegistry(), $container);
+        ]), new ListenerRegistry(), $this->container);
 
         $handler->shouldReceive('reset')->once();
         $processor->shouldReceive('reset')->once();
 
-        $container->bind(LogFactory::class, $factory);
-        $container->get(BootloadManager::class)->bootload([MonologBootloader::class]);
-        $container->get(LogsInterface::class)->getLogger();
+        $this->container->bind(LogFactory::class, $factory);
+        $this->container->get(BootloadManager::class)->bootload([MonologBootloader::class]);
+        $this->container->get(LogsInterface::class)->getLogger();
         $finalizer->finalize();
     }
 }

src/Bridge/Monolog/tests/HandlersTest.php

@@ -13,7 +13,6 @@
 
 use Monolog\Handler\NullHandler;
 use Monolog\Logger;
-use PHPUnit\Framework\TestCase;
 use Spiral\Boot\BootloadManager;
 use Spiral\Boot\FinalizerInterface;
 use Spiral\Config\ConfigManager;
@@ -27,14 +26,11 @@
 use Spiral\Monolog\Config\MonologConfig;
 use Spiral\Monolog\Exception\ConfigException;
 
-class HandlersTest extends TestCase
+class HandlersTest extends BaseTest
 {
-    /** @var Container */
-    private $container;
-
     public function setUp(): void
     {
-        $this->container = new Container();
+        parent::setUp();
 
         $this->container->bind(FinalizerInterface::class, $finalizer = \Mockery::mock(FinalizerInterface::class));
         $finalizer->shouldReceive('addFinalizer')->once();

src/Bridge/Monolog/tests/LoggerTest.php

@@ -7,7 +7,6 @@
 use Mockery as m;
 use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Monolog\Logger;
-use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
 use Spiral\Boot\BootloadManager;
 use Spiral\Boot\Finalizer;
@@ -19,14 +18,13 @@
 use Spiral\Monolog\Bootloader\MonologBootloader;
 use Spiral\Monolog\LogFactory;
 
-class LoggerTest extends TestCase
+class LoggerTest extends BaseTest
 {
     use MockeryPHPUnitIntegration;
 
     public function testLoggerShouldBeReset()
     {
-        $container = new Container();
-        $container->bind(ConfiguratorInterface::class, new ConfigManager(
+        $this->container->bind(ConfiguratorInterface::class, new ConfigManager(
             new class() implements LoaderInterface {
                 public function has(string $section): bool
                 {
@@ -40,16 +38,16 @@ public function load(string $section): array
             }
         ));
 
-        $container->bind(FinalizerInterface::class, $finalizer = new Finalizer());
-        $container->bind(LogFactory::class, $injector = m::mock(Container\InjectorInterface::class));
+        $this->container->bind(FinalizerInterface::class, $finalizer = new Finalizer());
+        $this->container->bind(LogFactory::class, $injector = m::mock(Container\InjectorInterface::class));
 
         $logger = m::mock(Logger::class);
         $logger->shouldReceive('reset')->once();
 
         $injector->shouldReceive('createInjection')->once()->andReturn($logger);
 
-        $container->get(BootloadManager::class)->bootload([MonologBootloader::class]);
-        $container->get(LoggerInterface::class);
+        $this->container->get(BootloadManager::class)->bootload([MonologBootloader::class]);
+        $this->container->get(LoggerInterface::class);
 
         $finalizer->finalize();
     }

src/Bridge/Monolog/tests/ProcessorsTest.php

@@ -5,28 +5,23 @@
 namespace Spiral\Tests\Monolog;
 
 use Monolog\Processor\PsrLogMessageProcessor;
-use PHPUnit\Framework\TestCase;
 use Spiral\Boot\BootloadManager;
 use Spiral\Boot\FinalizerInterface;
 use Spiral\Config\ConfigManager;
 use Spiral\Config\ConfiguratorInterface;
 use Spiral\Config\LoaderInterface;
-use Spiral\Core\Container;
 use Spiral\Logger\ListenerRegistry;
 use Spiral\Logger\ListenerRegistryInterface;
 use Spiral\Logger\LogsInterface;
 use Spiral\Monolog\Bootloader\MonologBootloader;
 use Spiral\Monolog\Config\MonologConfig;
 use Spiral\Monolog\Exception\ConfigException;
 
-class ProcessorsTest extends TestCase
+class ProcessorsTest extends BaseTest
 {
-    /** @var Container */
-    private $container;
-
     public function setUp(): void
     {
-        $this->container = new Container();
+        parent::setUp();
 
         $this->container->bind(FinalizerInterface::class, $finalizer = \Mockery::mock(FinalizerInterface::class));
         $finalizer->shouldReceive('addFinalizer')->once();
@@ -147,7 +142,6 @@ public function testConstructWithOptionsProcessor(): void
         $this->assertInstanceOf(PsrLogMessageProcessor::class, $processor);
 
         $property = new \ReflectionProperty(PsrLogMessageProcessor::class, 'dateFormat');
-        $property->setAccessible(true);
 
         $this->assertSame('c', $property->getValue($processor));
     }

src/Bridge/Monolog/tests/RotateHandlerTest.php

@@ -13,7 +13,6 @@
 
 use Monolog\Handler\RotatingFileHandler;
 use Monolog\Logger;
-use PHPUnit\Framework\TestCase;
 use Spiral\Boot\BootloadManager;
 use Spiral\Boot\FinalizerInterface;
 use Spiral\Config\ConfigManager;
@@ -22,16 +21,14 @@
 use Spiral\Core\Container;
 use Spiral\Monolog\Bootloader\MonologBootloader;
 
-class RotateHandlerTest extends TestCase
+class RotateHandlerTest extends BaseTest
 {
     public function testRotateHandler(): void
     {
-        $container = new Container();
-
-        $container->bind(FinalizerInterface::class, $finalizer = \Mockery::mock(FinalizerInterface::class));
+        $this->container->bind(FinalizerInterface::class, $finalizer = \Mockery::mock(FinalizerInterface::class));
         $finalizer->shouldReceive('addFinalizer')->once();
 
-        $container->bind(ConfiguratorInterface::class, new ConfigManager(
+        $this->container->bind(ConfiguratorInterface::class, new ConfigManager(
             new class() implements LoaderInterface {
                 public function has(string $section): bool
                 {
@@ -44,14 +41,14 @@ public function load(string $section): array
                 }
             }
         ));
-        $container->get(BootloadManager::class)->bootload([MonologBootloader::class]);
+        $this->container->get(BootloadManager::class)->bootload([MonologBootloader::class]);
 
         $autowire = new Container\Autowire('log.rotate', [
             'filename' => 'monolog.log'
         ]);
 
         /** @var RotatingFileHandler $handler */
-        $handler = $autowire->resolve($container);
+        $handler = $autowire->resolve($this->container);
         $this->assertInstanceOf(RotatingFileHandler::class, $handler);
 
         $this->assertSame(Logger::DEBUG, $handler->getLevel());