Can log things to DB, even if not logging SQL queries to file #8635

The middleware is unconditionally enabled, so it can notify the
DbHandler whenever we get an active connection. However, the middleware
may or may not log SQL queries to files. This is controlled via the new
config key `logSql`.

Author: PowerKiKi

phpstan-baseline.neon

@@ -108,6 +108,12 @@ parameters:
 			count: 1
 			path: src/DBAL/Logging/MiddlewareFactory.php
 
+		-
+			message: '#^Parameter \#2 \$logSql of class Ecodev\\Felix\\DBAL\\Logging\\Middleware constructor expects bool, mixed given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/DBAL/Logging/MiddlewareFactory.php
+
 		-
 			message: '#^Binary operation "\." between ''Invalid \\'''' and mixed results in an error\.$#'
 			identifier: binaryOp.invalid

src/ConfigProvider.php

@@ -14,6 +14,15 @@ public function __invoke(): array
                 'keys' => [],
                 'allowedIps' => [],
             ],
+            'logSql' => false,
+            'doctrine' => [
+                'configuration' => [
+                    'orm_default' => [
+                        // Log all SQL queries from Doctrine (to logs/all.log)
+                        'middlewares' => [DBAL\Logging\Middleware::class],
+                    ],
+                ],
+            ],
             'dependencies' => [
                 'invokables' => [
                 ],

src/DBAL/Logging/Driver.php

@@ -11,17 +11,25 @@
 
 final class Driver extends AbstractDriverMiddleware
 {
-    public function __construct(DriverInterface $driver, private readonly DbHandler $dbHandler)
-    {
+    public function __construct(
+        DriverInterface $driver,
+        private readonly DbHandler $dbHandler,
+        private readonly bool $logSql,
+    ) {
         parent::__construct($driver);
     }
 
-    public function connect(#[SensitiveParameter] array $params): Connection
+    public function connect(#[SensitiveParameter] array $params): DriverInterface\Connection
     {
         _log()->debug('Connecting to DB', $this->maskPassword($params));
 
-        $connection = new Connection(parent::connect($params));
+        // Don't bother to wrap the connection if we will never log SQL queries to file...
+        $connection = parent::connect($params);
+        if ($this->logSql) {
+            $connection = new Connection($connection);
+        }
 
+        // ... but always notify that we are now connected. so we can log other things to DB
         $this->dbHandler->enable();
 
         return $connection;

src/DBAL/Logging/Middleware.php

@@ -13,12 +13,14 @@
  */
 final class Middleware implements MiddlewareInterface
 {
-    public function __construct(private readonly DbHandler $dbHandler)
-    {
+    public function __construct(
+        private readonly DbHandler $dbHandler,
+        private readonly bool $logSql,
+    ) {
     }
 
     public function wrap(DriverInterface $driver): DriverInterface
     {
-        return new Driver($driver, $this->dbHandler);
+        return new Driver($driver, $this->dbHandler, $this->logSql);
     }
 }

src/DBAL/Logging/MiddlewareFactory.php

@@ -15,8 +15,12 @@ class MiddlewareFactory implements FactoryInterface
      */
     public function __invoke(ContainerInterface $container, $requestedName, ?array $options = null): Middleware
     {
+        /** @var array $config */
+        $config = $container->get('config');
+        $logSql = $config['logSql'];
+
         $dbHandler = $container->get(DbHandler::class);
 
-        return new Middleware($dbHandler);
+        return new Middleware($dbHandler, $logSql);
     }
 }