take into account call to db

doctrine · Apr 22, 2024 · 791e8a4 · 791e8a4
1 parent eadaa66
commit 791e8a4
Show file tree

Hide file tree

Showing 7 changed files with 148 additions and 26 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -221,10 +221,9 @@ private function getDbalConnectionsNode(): ArrayNodeDefinition
                 ->end()
                 ->booleanNode('disable_type_comments')->end()
                 ->scalarNode('server_version')->end()
-                ->integerNode('check_connection_timing')->end()
+                ->integerNode('idle_connection_ttl')->defaultValue(600)->end()
                 ->scalarNode('driver_class')->end()
                 ->scalarNode('wrapper_class')->end()
-                ->scalarNode('check_connection_frequency')->defaultValue(30)->end()
                 ->booleanNode('keep_slave')
                     ->setDeprecated(
                         'doctrine/doctrine-bundle',

diff --git a/DependencyInjection/DoctrineExtension.php b/DependencyInjection/DoctrineExtension.php
@@ -37,6 +37,7 @@
 use Symfony\Bridge\Doctrine\DependencyInjection\AbstractDoctrineExtension;
 use Symfony\Bridge\Doctrine\IdGenerator\UlidGenerator;
 use Symfony\Bridge\Doctrine\IdGenerator\UuidGenerator;
+use Symfony\Bridge\Doctrine\Middleware\IdleConnection\Listener;
 use Symfony\Bridge\Doctrine\PropertyInfo\DoctrineExtractor;
 use Symfony\Bridge\Doctrine\SchemaListener\DoctrineDbalCacheAdapterSchemaListener;
 use Symfony\Bridge\Doctrine\SchemaListener\LockStoreSchemaListener;
@@ -83,7 +84,7 @@
  *
  * @final since 2.9
  * @psalm-type DBALConfig = array{
- *      connections: array<string, array{logging: bool, profiling: bool, profiling_collect_backtrace: bool}>,
+ *      connections: array<string, array{logging: bool, profiling: bool, profiling_collect_backtrace: bool, idle_connection_ttl: int}>,
  *      driver_schemes: array<string, string>,
  *      default_connection: string,
  *      types: array<string, string>,
@@ -174,12 +175,6 @@ protected function dbalLoad(array $config, ContainerBuilder $container)
             $config['default_connection'] = reset($keys);
         }
 
-        if (! $container->hasParameter('kernel.runtime_mode') && ! $container->hasParameter('kernel.runtime_mode.worker')) {
-            $container->removeDefinition('doctrine.listeners.doctrine_connection_listener');
-        } else {
-            $container->getDefinition('doctrine.orm.listeners.doctrine_connection_listener')->setArgument(1, $config['check_connection_timing']);
-        }
-
         $this->defaultConnection = $config['default_connection'];
 
         $container->setAlias('database_connection', sprintf('doctrine.dbal.%s_connection', $this->defaultConnection));
@@ -202,13 +197,8 @@ protected function dbalLoad(array $config, ContainerBuilder $container)
         $connWithLogging   = [];
         $connWithProfiling = [];
         $connWithBacktrace = [];
-        $timingByConnection = [];
-        $skipTiming = false;
-
-        if (! $container->hasParameter('kernel.runtime_mode') && ! $container->hasParameter('kernel.runtime_mode.worker')) {
-            $container->removeDefinition('doctrine.listeners.doctrine_connection_listener');
-            $skipTiming = true;
-        }
+        $ttlByConnection   = [];
+        $connWithTtl       = [];
 
         foreach ($config['connections'] as $name => $connection) {
             if ($connection['logging']) {
@@ -223,17 +213,14 @@ protected function dbalLoad(array $config, ContainerBuilder $container)
                 }
             }
 
-            if (! $skipTiming) {
-                $timingByConnection[] = ['name' => $connections[$name], 'timing' => $connection['check_connection_timing']];
+            if ($connection['idle_connection_ttl']) {
+                $connWithTtl[]          = $name;
+                $ttlByConnection[$name] = $connection['idle_connection_ttl'];
             }
 
             $this->loadDbalConnection($name, $connection, $container);
         }
 
-        if (! $skipTiming) {
-            $container->getDefinition('doctrine.orm.listeners.doctrine_connection_listener')->setArgument(1, $timingByConnection);
-        }
-
         $container->registerForAutoconfiguration(MiddlewareInterface::class)->addTag('doctrine.middleware');
 
         $container->registerAttributeForAutoconfiguration(AsMiddleware::class, static function (ChildDefinition $definition, AsMiddleware $attribute) {
@@ -250,7 +237,16 @@ protected function dbalLoad(array $config, ContainerBuilder $container)
             }
         });
 
-        $this->registerDbalMiddlewares($container, $connWithLogging, $connWithProfiling, $connWithBacktrace);
+        $this->registerDbalMiddlewares($container, $connWithLogging, $connWithProfiling, $connWithBacktrace, $connWithTtl);
+
+        $container->getDefinition('doctrine.dbal.idle_connection_middleware')->setArgument(1, $ttlByConnection);
+
+        if (class_exists(Listener::class)) {
+            return;
+        }
+
+        $container->removeDefinition('doctrine.dbal.idle_connection_listener');
+        $container->removeDefinition('doctrine.dbal.idle_connection_middleware');
     }
 
     /**
@@ -1196,12 +1192,14 @@ private function createArrayAdapterCachePool(ContainerBuilder $container, string
      * @param string[] $connWithLogging
      * @param string[] $connWithProfiling
      * @param string[] $connWithBacktrace
+     * @param string[] $connWithTtl
      */
     private function registerDbalMiddlewares(
         ContainerBuilder $container,
         array $connWithLogging,
         array $connWithProfiling,
-        array $connWithBacktrace
+        array $connWithBacktrace,
+        array $connWithTtl
     ): void {
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('middlewares.xml');
@@ -1217,5 +1215,11 @@ private function registerDbalMiddlewares(
             $debugMiddlewareAbstractDef
                 ->addTag('doctrine.middleware', ['connection' => $connName]);
         }
+
+        $idleConnectionMiddlewareAbstractDef = $container->getDefinition('doctrine.dbal.idle_connection_middleware');
+        foreach ($connWithTtl as $connName) {
+            $idleConnectionMiddlewareAbstractDef
+                ->addTag('doctrine.middleware', ['connection' => $connName, 'priority' => 10]);
+        }
     }
 }
diff --git a/Middleware/IdleConnectionMiddleware.php b/Middleware/IdleConnectionMiddleware.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace Doctrine\Bundle\DoctrineBundle\Middleware;
+
+use ArrayObject;
+use Doctrine\DBAL\Driver;
+use Doctrine\DBAL\Driver\Middleware;
+use Symfony\Bridge\Doctrine\Middleware\IdleConnection\Driver as IdleConnectionDriver;
+
+class IdleConnectionMiddleware implements Middleware, ConnectionNameAwareInterface
+{
+    private ArrayObject $connectionExpiries;
+    /** @var array<string, int> */
+    private array $ttlByConnection;
+    private string $connectionName;
+
+    /**
+     * @param ArrayObject<string, int> $connectionExpiries
+     * @param array<string, int>       $ttlByConnection
+     */
+    public function __construct(ArrayObject $connectionExpiries, array $ttlByConnection)
+    {
+        $this->connectionExpiries = $connectionExpiries;
+        $this->ttlByConnection    = $ttlByConnection;
+    }
+
+    public function setConnectionName(string $name): void
+    {
+        $this->connectionName = $name;
+    }
+
+    public function wrap(Driver $driver): Driver
+    {
+        return new IdleConnectionDriver($driver, $this->connectionExpiries, $this->ttlByConnection[$this->connectionName], $this->connectionName);
+    }
+}
diff --git a/Resources/config/dbal.xml b/Resources/config/dbal.xml
@@ -101,9 +101,9 @@
             <tag name="controller.service_arguments" />
         </service>
 
-        <service id="doctrine.listeners.doctrine_connection_listener" class="Symfony\Bridge\Doctrine\Listener\ConnectionListener">
+        <service id="doctrine.dbal.idle_connection_listener" class="Symfony\Bridge\Doctrine\Middleware\IdleConnection\Listener">
+            <argument type="service" id="doctrine.dbal.connection_expiries" />
             <argument type="service" id="service_container" />
-            <argument /> <!-- check timing -->
             <tag name="kernel.event_subscriber" />
         </service>
 

diff --git a/Resources/config/middlewares.xml b/Resources/config/middlewares.xml
@@ -5,6 +5,7 @@
     xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <services>
+        <service id="doctrine.dbal.connection_expiries" class="ArrayObject"/>
         <service id="doctrine.dbal.logging_middleware" class="Doctrine\DBAL\Logging\Middleware" abstract="true">
             <argument type="service" id="logger" />
             <tag name="monolog.logger" channel="doctrine" />
@@ -17,5 +18,9 @@
             <argument type="service" id="doctrine.debug_data_holder" />
             <argument type="service" id="debug.stopwatch" on-invalid="null" />
         </service>
+        <service id="doctrine.dbal.idle_connection_middleware" class="Doctrine\Bundle\DoctrineBundle\Middleware\IdleConnectionMiddleware" abstract="true">
+            <argument type="service" id="doctrine.dbal.connection_expiries" />
+            <argument /> <!-- check timing -->
+        </service>
     </services>
 </container>
diff --git a/Tests/DependencyInjection/DoctrineExtensionTest.php b/Tests/DependencyInjection/DoctrineExtensionTest.php
@@ -1420,6 +1420,56 @@ public function testDefinitionsToLogQueriesLoggingFalse(): void
         $this->assertArrayNotHasKey('doctrine.middleware', $abstractMiddlewareDefTags);
     }
 
+    public function testDefinitionsIdleConnection(): void
+    {
+        $container = $this->getContainer();
+        $extension = new DoctrineExtension();
+
+        $config = BundleConfigurationBuilder::createBuilder()
+            ->addConnection([
+                'connections' => [
+                    'conn1' => [
+                        'password' => 'foo',
+                        'logging' => false,
+                        'profiling' => false,
+                        'idle_connection_ttl' => 15,
+                    ],
+                    'conn2' => [
+                        'password' => 'bar',
+                        'logging' => false,
+                        'profiling' => true,
+                    ],
+                ],
+            ])
+            ->build();
+
+        $extension->load([$config], $container);
+
+        $this->assertTrue($container->hasDefinition('doctrine.dbal.idle_connection_middleware'));
+
+        $abstractMiddlewareDef = $container->getDefinition('doctrine.dbal.idle_connection_middleware');
+        $ttlByConnection       = $abstractMiddlewareDef->getArgument(1);
+
+        $this->assertArrayHasKey('conn1', $ttlByConnection);
+        $this->assertEquals(15, $ttlByConnection['conn1']);
+        $this->assertArrayHasKey('conn2', $ttlByConnection);
+        $this->assertEquals(600, $ttlByConnection['conn2']);
+
+        $abstractMiddlewareDefTags = $container->getDefinition('doctrine.dbal.idle_connection_middleware')->getTags();
+
+        $idleConnectionMiddlewareTagAttributes = [];
+        foreach ($abstractMiddlewareDefTags as $tag => $attributes) {
+            if ($tag !== 'doctrine.middleware') {
+                continue;
+            }
+
+            $idleConnectionMiddlewareTagAttributes = $attributes;
+        }
+
+        $this->assertTrue(in_array(['connection' => 'conn1', 'priority' => 10], $idleConnectionMiddlewareTagAttributes, true), 'Tag with connection conn1 not found for doctrine.dbal.idle_connection_middleware');
+        $this->assertTrue(in_array(['connection' => 'conn2', 'priority' => 10], $idleConnectionMiddlewareTagAttributes, true), 'Tag with connection conn2 found for doctrine.dbal.idle_connection_middleware');
+    }
+
     /**
      * @requires function \Symfony\Bridge\Doctrine\ArgumentResolver\EntityValueResolver::__construct
      * @testWith [true]

diff --git a/Tests/Middleware/IdleConnectionMiddlewareTest.php b/Tests/Middleware/IdleConnectionMiddlewareTest.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Doctrine\Bundle\DoctrineBundle\Tests\Middleware;
+
+use ArrayObject;
+use Doctrine\Bundle\DoctrineBundle\Middleware\IdleConnectionMiddleware;
+use Doctrine\DBAL\Driver;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\Doctrine\Middleware\IdleConnection\Driver as IdleConnectionDriver;
+
+use function time;
+
+class IdleConnectionMiddlewareTest extends TestCase
+{
+    public function testWrap()
+    {
+        $connectionExpiries = new ArrayObject(['connectionone' => time() - 30, 'connectiontwo' => time() + 40]);
+        $ttlByConnection    = ['connectionone' => 25, 'connectiontwo' => 60];
+
+        $middleware = new IdleConnectionMiddleware($connectionExpiries, $ttlByConnection);
+        $middleware->setConnectionName('connectionone');
+
+        $driverMock    = $this->createMock(Driver::class);
+        $wrappedDriver = $middleware->wrap($driverMock);
+
+        $this->assertInstanceOf(IdleConnectionDriver::class, $wrappedDriver);
+    }
+}