Replace deprecated doctrine SQLLogger interface

Author: kitsunet

Neos.Flow/Classes/Persistence/Doctrine/EntityManagerConfiguration.php

@@ -26,7 +26,6 @@
 use Neos\Flow\Configuration\Exception\InvalidConfigurationException;
 use Neos\Flow\ObjectManagement\ObjectManagerInterface;
 use Neos\Flow\Package;
-use Neos\Flow\Persistence\Doctrine\Logging\SqlLogger;
 use Neos\Flow\Persistence\Exception\IllegalObjectTypeException;
 use Neos\Flow\Annotations as Flow;
 use Psr\Cache\CacheItemPoolInterface;
@@ -80,10 +79,6 @@ public function injectSettings(array $settings): void
      */
     public function configureEntityManager(Connection $connection, Configuration $config, EventManager $eventManager): void
     {
-        if (isset($this->settings['doctrine']['sqlLogger']) && is_string($this->settings['doctrine']['sqlLogger']) && class_exists($this->settings['doctrine']['sqlLogger'])) {
-            $this->enableSqlLogger($this->settings['doctrine']['sqlLogger'], $config);
-        }
-
         if (isset($this->settings['doctrine']['eventSubscribers']) && is_array($this->settings['doctrine']['eventSubscribers'])) {
             $this->registerEventSubscribers($this->settings['doctrine']['eventSubscribers'], $eventManager);
         }
@@ -103,21 +98,6 @@ public function configureEntityManager(Connection $connection, Configuration $co
         }
     }
 
-    /**
-     * @param string $configuredSqlLogger
-     * @param Configuration $doctrineConfiguration
-     * @throws InvalidConfigurationException
-     */
-    protected function enableSqlLogger(string $configuredSqlLogger, Configuration $doctrineConfiguration): void
-    {
-        $sqlLoggerInstance = new $configuredSqlLogger();
-        if ($sqlLoggerInstance instanceof SQLLogger) {
-            $doctrineConfiguration->setSQLLogger($sqlLoggerInstance);
-        } else {
-            throw new InvalidConfigurationException(sprintf('Neos.Flow.persistence.doctrine.sqlLogger must point to a \Doctrine\DBAL\Logging\SQLLogger implementation, %s given.', get_class($sqlLoggerInstance)), 1426150388);
-        }
-    }
-
     /**
      * @param array $configuredSubscribers
      * @param EventManager $eventManager

Neos.Flow/Classes/Persistence/Doctrine/EntityManagerFactory.php

@@ -15,15 +15,19 @@
 use Doctrine\DBAL\DriverManager;
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Exception\ConnectionException;
+use Doctrine\DBAL\Logging\Middleware;
 use Doctrine\ORM\Configuration;
 use Doctrine\ORM\EntityManager;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Configuration\Exception\InvalidConfigurationException;
+use Neos\Flow\ObjectManagement\DependencyInjection\DependencyProxy;
 use Neos\Flow\ObjectManagement\ObjectManagerInterface;
+use Neos\Flow\Persistence\Doctrine\Logging\SqlLogger;
 use Neos\Flow\Persistence\Doctrine\Mapping\Driver\FlowAnnotationDriver;
 use Neos\Flow\Reflection\ReflectionService;
 use Neos\Flow\Utility\Environment;
 use Neos\Utility\Files;
+use Psr\Log\LoggerInterface;
 
 /**
  * EntityManager factory for Doctrine integration
@@ -85,6 +89,11 @@ public function create()
         $config = new Configuration();
         $config->setClassMetadataFactoryName(Mapping\ClassMetadataFactory::class);
 
+        $configuredSqlLogger = $this->settings['doctrine']['sqlLogger'] ?? null;
+        if ($configuredSqlLogger && class_exists($configuredSqlLogger)) {
+            $config = $this->enableSqlLogger($configuredSqlLogger, $config);
+        }
+
         $eventManager = new EventManager();
 
         $flowAnnotationDriver = $this->objectManager->get(FlowAnnotationDriver::class);
@@ -141,4 +150,30 @@ public function emitBeforeDoctrineEntityManagerCreation(Connection $connection,
     public function emitAfterDoctrineEntityManagerCreation(Configuration $config, EntityManager $entityManager)
     {
     }
+
+    /**
+     * The logger middleware needs to be set on the configuration applied to the Driver and Connection
+     *
+     * @param class-string $configuredSqlLogger
+     * @param Configuration $doctrineConfiguration
+     * @return Configuration
+     * @throws InvalidConfigurationException
+     */
+    protected function enableSqlLogger(string $configuredSqlLogger, Configuration $doctrineConfiguration): Configuration
+    {
+        $sqlLoggerInstance = $this->objectManager->get($configuredSqlLogger);
+        if (!$sqlLoggerInstance instanceof SQLLogger) {
+            throw new InvalidConfigurationException(sprintf('Neos.Flow.persistence.doctrine.sqlLogger must be \Neos\Flow\Persistence\Doctrine\Logging\SqlLogger, %s given.', get_class($sqlLoggerInstance)), 1426150388);
+        }
+
+        $logger = $sqlLoggerInstance->logger;
+        if ($logger instanceof DependencyProxy) {
+            $logger = $logger->_activateDependency();
+        }
+        if (!$logger instanceof LoggerInterface) {
+            throw new InvalidConfigurationException(sprintf('The SqlLogger needs to get a Psr LoggerInterface injected, got "%s"', get_class($logger)), 1720548075);
+        }
+
+        return $doctrineConfiguration->setMiddlewares(array_merge($doctrineConfiguration->getMiddlewares(), [new Middleware($logger)]));
+    }
 }

Neos.Flow/Classes/Persistence/Doctrine/Logging/SqlLogger.php

@@ -13,43 +13,23 @@
  * source code.
  */
 
-use Neos\Flow\ObjectManagement\DependencyInjection\DependencyProxy;
-use Neos\Flow\Log\Utility\LogEnvironment;
+use Doctrine\DBAL\Logging\Middleware;
 use Psr\Log\LoggerInterface;
 
 /**
- * A SQL logger that logs to a Flow logger.
+ * Just a stub placeholder so nothing has to be changed in user configuration,
+ * This class has no meaning apart from being referenced in settings,
+ * we extract the LoggerInterface from here and apply it to  a {@see Middleware}
+ *
+ * This class itself is mentioned in Settings to enable the logger,
+ * the property is referenced in the Objects.yaml and if someone wanted to overwrite
+ * the logger they would have done it there, so we cannot switch to constructor injection
+ * without backwards incompatibility.
  */
-class SqlLogger implements \Doctrine\DBAL\Logging\SQLLogger
+class SqlLogger
 {
     /**
      * @var LoggerInterface
      */
-    protected $logger;
-
-    /**
-     * Logs a SQL statement to the system logger (DEBUG priority).
-     *
-     * @param string $sql The SQL to be executed
-     * @param array $params The SQL parameters
-     * @param array $types The SQL parameter types.
-     * @return void
-     */
-    public function startQuery($sql, array $params = null, array $types = null)
-    {
-        if ($this->logger instanceof DependencyProxy) {
-            $this->logger->_activateDependency();
-        }
-        // this is a safeguard for when no logger might be available...
-        if ($this->logger instanceof LoggerInterface) {
-            $this->logger->debug($sql, array_merge(LogEnvironment::fromMethodName(__METHOD__), ['params' => $params, 'types' => $types]));
-        }
-    }
-
-    /**
-     * @return void
-     */
-    public function stopQuery()
-    {
-    }
+    public $logger;
 }