[HttpFoundation][FrameworkBundle] allow configuring the session handler with a DSN

Author: nicolas-grekas

CHANGELOG.md

@@ -18,6 +18,7 @@ CHANGELOG
  * Added sort option for `translation:update` command.
  * [BC Break] The `framework.messenger.routing.senders` config key is not deep merged anymore.
  * Added `secrets:*` commands and `%env(secret:...)%` processor to deal with secrets seamlessly.
+ * Made `framework.session.handler_id` accept a DSN
 
 4.3.0
 -----

DependencyInjection/FrameworkExtension.php

@@ -240,6 +240,9 @@ public function load(array $configs, ContainerBuilder $container)
             }
         }
 
+        // register cache before session so both can share the connection services
+        $this->registerCacheConfiguration($config['cache'], $container);
+
         if ($this->isConfigEnabled($container, $config['session'])) {
             if (!\extension_loaded('session')) {
                 throw new LogicException('Session support cannot be enabled as the session extension is not installed. See https://php.net/session.installation for instructions.');
@@ -326,7 +329,6 @@ public function load(array $configs, ContainerBuilder $container)
         $this->registerFragmentsConfiguration($config['fragments'], $container, $loader);
         $this->registerTranslatorConfiguration($config['translator'], $container, $loader, $config['default_locale']);
         $this->registerProfilerConfiguration($config['profiler'], $container, $loader);
-        $this->registerCacheConfiguration($config['cache'], $container);
         $this->registerWorkflowConfiguration($config['workflows'], $container, $loader);
         $this->registerDebugConfiguration($config['php_errors'], $container, $loader);
         $this->registerRouterConfiguration($config['router'], $container, $loader);
@@ -925,7 +927,18 @@ private function registerSessionConfiguration(array $config, ContainerBuilder $c
             $container->getDefinition('session.storage.native')->replaceArgument(1, null);
             $container->getDefinition('session.storage.php_bridge')->replaceArgument(0, null);
         } else {
-            $container->setAlias('session.handler', $config['handler_id'])->setPrivate(true);
+            $container->resolveEnvPlaceholders($config['handler_id'], null, $usedEnvs);
+
+            if ($usedEnvs || preg_match('#^[a-z]++://#', $config['handler_id'])) {
+                $id = '.cache_connection.'.ContainerBuilder::hash($config['handler_id']);
+
+                $container->getDefinition('session.abstract_handler')
+                    ->replaceArgument(0, $container->hasDefinition($id) ? new Reference($id) : $config['handler_id']);
+
+                $container->setAlias('session.handler', 'session.abstract_handler')->setPrivate(true);
+            } else {
+                $container->setAlias('session.handler', $config['handler_id'])->setPrivate(true);
+            }
         }
 
         $container->setParameter('session.save_path', $config['save_path']);

Resources/config/session.xml

@@ -56,6 +56,11 @@
             </argument>
         </service>
 
+        <service id="session.abstract_handler" class="Symfony\Component\HttpFoundation\Session\Storage\Handler\AbstractSessionHandler">
+            <factory class="Symfony\Component\HttpFoundation\Session\Storage\Handler\SessionHandlerFactory" method="createHandler" />
+            <argument />
+        </service>
+
         <service id="session_listener" class="Symfony\Component\HttpKernel\EventListener\SessionListener">
             <tag name="kernel.event_subscriber" />
             <argument type="service_locator">

composer.json

@@ -22,7 +22,7 @@
         "symfony/config": "^4.3.4|^5.0",
         "symfony/dependency-injection": "^4.4|^5.0",
         "symfony/error-renderer": "^4.4|^5.0",
-        "symfony/http-foundation": "^4.3|^5.0",
+        "symfony/http-foundation": "^4.4|^5.0",
         "symfony/http-kernel": "^4.4",
         "symfony/polyfill-mbstring": "~1.0",
         "symfony/filesystem": "^3.4|^4.0|^5.0",