wip

doctrine · Jan 1, 2022 · d35d639 · d35d639
1 parent 2ac02d3
commit d35d639
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 27 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -96,9 +96,6 @@ private function addDbalSection(ArrayNodeDefinition $node): void
                 ->end()
                 ->children()
                     ->scalarNode('default_connection')->end()
-                    ->booleanNode('use_middlewares')
-                        ->defaultFalse()
-                    ->end()
                 ->end()
                 ->fixXmlConfig('type')
                 ->children()
@@ -190,6 +187,9 @@ private function getDbalConnectionsNode(): ArrayNodeDefinition
                     ->useAttributeAsKey('name')
                     ->prototype('scalar')->end()
                 ->end()
+                ->booleanNode('use_middlewares')
+                    ->defaultFalse()
+                ->end()
             ->end();
 
         // dbal < 2.11

diff --git a/DependencyInjection/DoctrineExtension.php b/DependencyInjection/DoctrineExtension.php
@@ -144,8 +144,6 @@ protected function dbalLoad(array $config, ContainerBuilder $container)
         foreach ($config['connections'] as $name => $connection) {
             $this->loadDbalConnection($name, $connection, $container);
         }
-
-        $this->useMiddlewaresIfAvailable($config['use_middlewares'], $container);
     }
 
     /**
@@ -160,6 +158,7 @@ protected function loadDbalConnection($name, array $connection, ContainerBuilder
         $configuration = $container->setDefinition(sprintf('doctrine.dbal.%s_connection.configuration', $name), new ChildDefinition('doctrine.dbal.connection.configuration'));
         $logger        = null;
         if ($connection['logging']) {
+            $this->useMiddlewaresIfAvailable($connection, $container, $name, $configuration);
             $logger = new Reference('doctrine.dbal.logger');
         }
 
@@ -1071,19 +1070,28 @@ private function createArrayAdapterCachePool(ContainerBuilder $container, string
         return $id;
     }
 
-    private function useMiddlewaresIfAvailable(bool $useMiddlewares, ContainerBuilder $container): void
+    /** @param array<string, mixed> $connection */
+    protected function useMiddlewaresIfAvailable(array $connection, ContainerBuilder $container, string $name, Definition $configuration): void
     {
-        if ($useMiddlewares) {
-            /** @psalm-suppress UndefinedClass */
-            if (! interface_exists(Middleware::class)) {
-                throw new InvalidConfigurationException(sprintf('%s must exist to set use_middlewares to true', Middleware::class));
-            }
+        if (! $connection['use_middlewares']) {
+            return;
+        }
 
-            $container
-                ->getDefinition('doctrine.dbal.logger')
-                ->replaceArgument(0, null);
-        } else {
-            $container->removeDefinition('doctrine.dbal.logging_middleware');
+        /** @psalm-suppress UndefinedClass */
+        if (! interface_exists(Middleware::class)) {
+            throw new InvalidConfigurationException(sprintf('%s must exist to set use_middlewares to true', Middleware::class));
         }
+
+        $container
+            ->getDefinition('doctrine.dbal.logger')
+            ->replaceArgument(0, null);
+
+        $loggingMiddlewareDef = $container->setDefinition(
+            sprintf('doctrine.dbal.%s_connection.logging_middleware', $name),
+            new ChildDefinition('doctrine.dbal.logging_middleware')
+        );
+        $loggingMiddlewareDef->addTag('monolog.logger', ['channel' => 'doctrine']);
+
+        $configuration->addMethodCall('setMiddlewares', [[$loggingMiddlewareDef]]);
     }
 }
diff --git a/Resources/config/dbal.xml b/Resources/config/dbal.xml
@@ -36,8 +36,7 @@
             <argument type="service" id="debug.stopwatch" on-invalid="null" />
         </service>
 
-        <service id="doctrine.dbal.logging_middleware" class="Doctrine\DBAL\Logging\Middleware">
-            <tag name="monolog.logger" channel="doctrine" />
+        <service id="doctrine.dbal.logging_middleware" class="Doctrine\DBAL\Logging\Middleware" abstract="true">
             <argument type="service" id="logger" on-invalid="null" />
         </service>
 

diff --git a/Tests/DependencyInjection/AbstractDoctrineExtensionTest.php b/Tests/DependencyInjection/AbstractDoctrineExtensionTest.php
@@ -197,6 +197,7 @@ public function testDbalLoadSingleMasterSlaveConnection(): void
                 'dbname' => 'mysql_db',
                 'host' => 'localhost',
                 'unix_socket' => '/path/to/mysqld.sock',
+                'use_middlewares' => false,
             ],
             $param['primary'] ?? $param['master'] // TODO: Remove 'master' support here when we require dbal >= 2.11
         );
@@ -229,6 +230,7 @@ public function testDbalLoadPoolShardingConnection(): void
                 'dbname' => 'mysql_db',
                 'host' => 'localhost',
                 'unix_socket' => '/path/to/mysqld.sock',
+                'use_middlewares' => false,
             ],
             $param['global']
         );
@@ -283,6 +285,7 @@ public function testLoadSimpleSingleConnection(): void
                 'driver' => 'pdo_mysql',
                 'driverOptions' => [],
                 'defaultTableOptions' => [],
+                'use_middlewares' => false,
             ],
             new Reference('doctrine.dbal.default_connection.configuration'),
             new Reference('doctrine.dbal.default_connection.event_manager'),
@@ -322,6 +325,7 @@ public function testLoadSimpleSingleConnectionWithoutDbName(): void
                 'driver' => 'pdo_mysql',
                 'driverOptions' => [],
                 'defaultTableOptions' => [],
+                'use_middlewares' => false,
             ],
             new Reference('doctrine.dbal.default_connection.configuration'),
             new Reference('doctrine.dbal.default_connection.event_manager'),
@@ -362,6 +366,7 @@ public function testLoadSingleConnection(): void
                 'dbname' => 'sqlite_db',
                 'memory' => true,
                 'defaultTableOptions' => [],
+                'use_middlewares' => false,
             ],
             new Reference('doctrine.dbal.default_connection.configuration'),
             new Reference('doctrine.dbal.default_connection.event_manager'),

diff --git a/Tests/DependencyInjection/DoctrineExtensionTest.php b/Tests/DependencyInjection/DoctrineExtensionTest.php
@@ -1152,6 +1152,15 @@ public function testUseMiddlewaresNotActivated(): void
         $extension = new DoctrineExtension();
 
         $config = BundleConfigurationBuilder::createBuilderWithBaseValues()
+            ->addConnection([
+                'connections' => [
+                    'default' => [
+                        'password' => 'foo',
+                        'logging' => true,
+                    ],
+                ],
+            ])
+            ->addBaseEntityManager()
             ->build();
 
         $extension->load([$config], $container);
@@ -1166,7 +1175,7 @@ public function testUseMiddlewaresNotActivated(): void
         $this->assertInstanceOf(Reference::class, $loggerDef->getArgument(0));
         $this->assertSame('logger', (string) $loggerDef->getArgument(0));
 
-        $this->assertFalse($container->hasDefinition('doctrine.dbal.logging_middleware'));
+        $this->assertFalse($container->hasDefinition('doctrine.dbal.default_connection.logging_middleware'));
     }
 
     public function testUseMiddlewaresActivated(): void
@@ -1182,28 +1191,42 @@ public function testUseMiddlewaresActivated(): void
         $config = BundleConfigurationBuilder::createBuilderWithBaseValues()
             ->addConnection([
                 'connections' => [
-                    'default' => ['password' => 'foo'],
+                    'default' => [
+                        'password' => 'foo',
+                        'logging' => true,
+                        'use_middlewares' => true,
+                    ],
                 ],
-                'use_middlewares' => true,
             ])
             ->addBaseEntityManager()
             ->build();
 
         $extension->load([$config], $container);
 
         $loggerDef = $container->getDefinition('doctrine.dbal.logger');
-
         $this->assertNull($loggerDef->getArgument(0));
 
-        $loggingMiddlewareDef = $container->getDefinition('doctrine.dbal.logging_middleware');
+        $loggingMiddlewareDef = $container->getDefinition('doctrine.dbal.default_connection.logging_middleware');
         $tags                 = $loggingMiddlewareDef->getTag('monolog.logger');
         $doctrineLoggerTags   = array_filter($tags, static function (array $tag): bool {
             return ($tag['channel'] ?? null) === 'doctrine';
         });
         $this->assertCount(1, $doctrineLoggerTags);
 
-        $this->assertInstanceOf(Reference::class, $loggingMiddlewareDef->getArgument(0));
-        $this->assertSame('logger', (string) $loggingMiddlewareDef->getArgument(0));
+        $this->assertInstanceOf(ChildDefinition::class, $loggingMiddlewareDef);
+        $parentDef = $container->getDefinition($loggingMiddlewareDef->getParent());
+        $this->assertInstanceOf(Reference::class, $parentDef->getArgument(0));
+        $this->assertSame('logger', (string) $parentDef->getArgument(0));
+
+        $connectionConfiguration = $container->getDefinition('doctrine.dbal.default_connection.configuration');
+        $setMiddlewareCalls      = array_filter($connectionConfiguration->getMethodCalls(), static function (array $call) {
+            return $call[0] === 'setMiddlewares';
+        });
+        $this->assertCount(1, $setMiddlewareCalls);
+        $callArgs = $setMiddlewareCalls[0][1];
+        $this->assertCount(1, $callArgs);
+        $this->assertCount(1, $callArgs[0]);
+        $this->assertInstanceOf(Definition::class, $callArgs[0][0]);
     }
 
     public function testUseMiddlewaresWithoutMiddlewareInterface(): void
@@ -1222,9 +1245,12 @@ public function testUseMiddlewaresWithoutMiddlewareInterface(): void
         $config = BundleConfigurationBuilder::createBuilderWithBaseValues()
             ->addConnection([
                 'connections' => [
-                    'default' => ['password' => 'foo'],
+                    'default' => [
+                        'password' => 'foo',
+                        'logging' => true,
+                        'use_middlewares' => true,
+                    ],
                 ],
-                'use_middlewares' => true,
             ])
             ->addBaseEntityManager()
             ->build();