[HttpKernel] Add KernelInterface::getShareDir(), APP_SHARE_DIR and %kernel.share_dir% to store application data that are shared between all front-end servers

Author: nicolas-grekas

CHANGELOG.md

@@ -20,6 +20,7 @@ CHANGELOG
  * Initialize `router.request_context`'s `_locale` parameter to `%kernel.default_locale%`
  * Deprecate `ConfigBuilderCacheWarmer`, return PHP arrays from your config instead
  * Add support for selecting the appropriate error renderer based on the `APP_RUNTIME_MODE` env var
+ * Add `KernelInterface::getShareDir()`, `APP_SHARE_DIR` and `%kernel.share_dir%` to store application data that are shared between all front-end servers
 
 7.3
 ---

DependencyInjection/Configuration.php

@@ -1385,7 +1385,7 @@ private function addCacheSection(ArrayNodeDefinition $rootNode, callable $willBe
                             ->info('System related cache pools configuration.')
                             ->defaultValue('cache.adapter.system')
                         ->end()
-                        ->scalarNode('directory')->defaultValue('%kernel.cache_dir%/pools/app')->end()
+                        ->scalarNode('directory')->defaultValue('%kernel.share_dir%/pools/app')->end()
                         ->scalarNode('default_psr6_provider')->end()
                         ->scalarNode('default_redis_provider')->defaultValue('redis://localhost')->end()
                         ->scalarNode('default_valkey_provider')->defaultValue('valkey://localhost')->end()

Kernel/MicroKernelTrait.php

@@ -124,6 +124,15 @@ public function getBuildDir(): string
         return parent::getBuildDir();
     }
 
+    public function getShareDir(): string
+    {
+        if (isset($_SERVER['APP_SHARE_DIR'])) {
+            return $_SERVER['APP_SHARE_DIR'].'/'.$this->environment;
+        }
+
+        return parent::getShareDir();
+    }
+
     public function getLogDir(): string
     {
         return $_SERVER['APP_LOG_DIR'] ?? parent::getLogDir();

Tests/DependencyInjection/ConfigurationTest.php

@@ -936,7 +936,7 @@ protected static function getBundleDefaultConfig()
                 'pools' => [],
                 'app' => 'cache.adapter.filesystem',
                 'system' => 'cache.adapter.system',
-                'directory' => '%kernel.cache_dir%/pools/app',
+                'directory' => '%kernel.share_dir%/pools/app',
                 'default_redis_provider' => 'redis://localhost',
                 'default_valkey_provider' => 'valkey://localhost',
                 'default_memcached_provider' => 'memcached://localhost',

Tests/DependencyInjection/FrameworkExtensionTestCase.php

@@ -2852,6 +2852,7 @@ protected function createContainer(array $data = [])
             'kernel.bundles_metadata' => ['FrameworkBundle' => ['namespace' => 'Symfony\\Bundle\\FrameworkBundle', 'path' => __DIR__.'/../..']],
             'kernel.cache_dir' => __DIR__,
             'kernel.build_dir' => __DIR__,
+            'kernel.share_dir' => __DIR__,
             'kernel.project_dir' => __DIR__,
             'kernel.debug' => false,
             'kernel.environment' => 'test',

composer.json

@@ -28,7 +28,7 @@
         "symfony/filesystem": "^7.1|^8.0",
         "symfony/finder": "^6.4|^7.0|^8.0",
         "symfony/http-foundation": "^7.4|^8.0",
-        "symfony/http-kernel": "^7.2|^8.0",
+        "symfony/http-kernel": "^7.4|^8.0",
         "symfony/polyfill-mbstring": "~1.0",
         "symfony/polyfill-php85": "^1.32",
         "symfony/routing": "^7.4|^8.0"