feat: add configurable, optional logger / profiler

Author: lotyp

Makefile

@@ -172,9 +172,12 @@ lint-stan-ci:
 	$(APP_COMPOSER) stan:ci
 .PHONY: lint-stan-ci
 
+#test: ## Run project php-unit and pest tests
+#	$(APP_COMPOSER) test
+#.PHONY: test
+
 test: ## Run project php-unit and pest tests
-	$(APP_COMPOSER) test
-.PHONY: test
+	$(APP_RUNNER) vendor/bin/pest tests/src/Bridge/Laravel/LoggerFactoryTest.php
 
 test-cc: ## Run project php-unit and pest tests in coverage mode and build report
 	$(APP_COMPOSER) test:cc

config/cycle.php

@@ -136,6 +136,21 @@
                 queryCache: true,
             ),
         ],
+
+        /*
+         * Default logger configuration
+         *
+         * Use any of channels configured in your logging.php file
+         */
+        'logger' => [
+            'default' => env('DB_DEFAULT_LOGGER_CHANNEL', null),
+            'drivers' => [
+                'sqlite' => env('DB_DEFAULT_LOGGER_CHANNEL', null),
+                'pgsql' => env('DB_DEFAULT_LOGGER_CHANNEL', null),
+                'mysql' => env('DB_DEFAULT_LOGGER_CHANNEL', null),
+                'sqlserver' => env('DB_DEFAULT_LOGGER_CHANNEL', null),
+            ],
+        ],
     ],
 
     'schema' => [

src/Bridge/Laravel/LoggerFactory.php

@@ -4,19 +4,41 @@
 
 namespace WayOfDev\Cycle\Bridge\Laravel;
 
+use Cycle\Database\Config\DatabaseConfig;
 use Cycle\Database\Driver\DriverInterface;
 use Cycle\Database\LoggerFactoryInterface;
-use Illuminate\Log\Logger;
+use Cycle\Database\NamedInterface;
+use Illuminate\Log\LogManager;
 use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
 
 final class LoggerFactory implements LoggerFactoryInterface
 {
-    public function __construct(private readonly Logger $logger)
-    {
+    private array $config;
+
+    public function __construct(
+        private readonly LogManager $manager,
+        DatabaseConfig $databaseConfig
+    ) {
+        $this->config = $databaseConfig->toArray()['logger'] ?? [];
     }
 
     public function getLogger(?DriverInterface $driver = null): LoggerInterface
     {
-        return $this->logger->getLogger();
+        if (! isset($this->config['default'])) {
+            return new NullLogger();
+        }
+
+        $channel = $this->config['default'];
+
+        if ($driver instanceof NamedInterface) {
+            $driverName = $driver->getName();
+
+            if (isset($this->config['drivers'][$driverName])) {
+                $channel = $this->config['drivers'][$driverName];
+            }
+        }
+
+        return $this->manager->channel($channel);
     }
 }

src/Bridge/Laravel/Providers/Registrators/RegisterDatabase.php

@@ -10,7 +10,7 @@
 use Cycle\Database\DatabaseProviderInterface;
 use Cycle\Database\LoggerFactoryInterface;
 use Illuminate\Contracts\Foundation\Application;
-use Illuminate\Log\Logger;
+use Illuminate\Log\LogManager;
 use WayOfDev\Cycle\Bridge\Laravel\LoggerFactory;
 
 /**
@@ -22,7 +22,8 @@ public function __invoke(Application $app): void
     {
         $app->singleton(LoggerFactoryInterface::class, static function (Application $app): LoggerFactoryInterface {
             return new LoggerFactory(
-                logger: $app->get(Logger::class)
+                manager: $app->get(LogManager::class),
+                databaseConfig: $app->get(DatabaseConfig::class),
             );
         });
 

tests/src/Bridge/Laravel/LoggerFactoryTest.php

@@ -0,0 +1,102 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WayOfDev\Tests\Bridge\Laravel;
+
+use Cycle\Database\Config\DatabaseConfig;
+use Cycle\Database\Driver\DriverInterface;
+use Cycle\Database\NamedInterface;
+use Illuminate\Log\LogManager;
+use Mockery as m;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\NotFoundExceptionInterface;
+use Psr\Log\NullLogger;
+use WayOfDev\Cycle\Bridge\Laravel\LoggerFactory;
+use WayOfDev\Tests\TestCase;
+
+use function file_get_contents;
+
+class LoggerFactoryTest extends TestCase
+{
+    protected function tearDown(): void
+    {
+        m::close();
+        parent::tearDown();
+    }
+
+    /**
+     * @test
+     *
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
+     */
+    public function it_should_return_custom_logger_from_factory(): void
+    {
+        $mockDriver = m::mock(DriverInterface::class, NamedInterface::class);
+        $mockDriver->shouldReceive('getName')->andReturn('custom');
+
+        $loggerFactory = new LoggerFactory(
+            $this->app->get(LogManager::class),
+            new DatabaseConfig(config('cycle.database'))
+        );
+
+        // @phpstan-ignore-next-line
+        $logger = $loggerFactory->getLogger($mockDriver);
+        $logger->info('Test log entry');
+
+        $logContent = file_get_contents(storage_path('logs/logger-factory-test.log'));
+        $this::assertStringContainsString('Test log entry', $logContent);
+    }
+
+    /**
+     * @test
+     *
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
+     */
+    public function it_should_return_null_logger_from_factory(): void
+    {
+        config()->set('cycle.database.logger', [
+            'default' => null,
+            'drivers' => [
+                'sqlite' => null,
+                'pgsql' => null,
+                'mysql' => null,
+                'sqlserver' => null,
+            ],
+        ]);
+
+        $loggerFactory = new LoggerFactory(
+            $this->app->get(LogManager::class),
+            new DatabaseConfig(config('database'))
+        );
+        $logger = $loggerFactory->getLogger();
+
+        $this::assertInstanceOf(NullLogger::class, $logger);
+    }
+
+    protected function getEnvironmentSetUp($app): void
+    {
+        parent::getEnvironmentSetUp($app);
+
+        // Add custom logging channel configuration
+        $app['config']->set('logging.channels.custom_channel', [
+            'driver' => 'single',
+            'path' => storage_path('logs/logger-factory-test.log'),
+            'level' => 'debug',
+        ]);
+
+        // Set the database logger configuration
+        $app['config']->set('cycle.database.logger', [
+            'default' => 'stack',
+            'drivers' => [
+                'sqlite' => 'stack',
+                'pgsql' => 'stack',
+                'mysql' => 'stack',
+                'sqlserver' => 'stack',
+                'custom' => 'custom_channel',
+            ],
+        ]);
+    }
+}