[Cache] give control over cache prefix seed

Tobion · nicolas-grekas · commit 6681b92524d0 · 2020-09-02T11:53:39.000+02:00
The configurable cache prefix seed does not give full control over the cache prefix because the container class is added to the prefix in any case. This is a problem because the container class contains the app env name. We use different app environments for different deployment targets (dev and test). Dev and test should use the same redis cache. But this is impossible to achieve because even setting the cache prefix seed does not accomplish this.
diff --git a/UPGRADE-5.2.md b/UPGRADE-5.2.md
@@ -11,6 +11,10 @@ FrameworkBundle
 
  * Deprecated the public `form.factory`, `form.type.file`, `translator`, `security.csrf.token_manager`, `serializer`,
    `cache_clearer`, `filesystem` and `validator` services to private.
+ * If you configured the `framework.cache.prefix_seed` option, you might want to add the `%kernel.environment%` to its value to
+   keep cache namespaces separated by environment of the app. The `%kernel.container_class%` (which includes the environment)
+   used to be added by default to the seed, which is not the case anymore. This allows sharing caches between
+   apps or different environments.
 
 Mime
 ----
diff --git a/src/Symfony/Bridge/Doctrine/DependencyInjection/AbstractDoctrineExtension.php b/src/Symfony/Bridge/Doctrine/DependencyInjection/AbstractDoctrineExtension.php
@@ -332,11 +332,12 @@ protected function loadCacheDriver(string $cacheName, string $objectManagerName,
         if (!isset($cacheDriver['namespace'])) {
             // generate a unique namespace for the given application
             if ($container->hasParameter('cache.prefix.seed')) {
-                $seed = '.'.$container->getParameterBag()->resolveValue($container->getParameter('cache.prefix.seed'));
+                $seed = $container->getParameterBag()->resolveValue($container->getParameter('cache.prefix.seed'));
             } else {
                 $seed = '_'.$container->getParameter('kernel.project_dir');
+                $seed .= '.'.$container->getParameter('kernel.container_class');
             }
-            $seed .= '.'.$container->getParameter('kernel.container_class');
+
             $namespace = 'sf_'.$this->getMappingResourceExtension().'_'.$objectManagerName.'_'.ContainerBuilder::hash($seed);
 
             $cacheDriver['namespace'] = $namespace;
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -982,7 +982,8 @@ private function addCacheSection(ArrayNodeDefinition $rootNode)
                     ->children()
                         ->scalarNode('prefix_seed')
                             ->info('Used to namespace cache keys when using several apps with the same shared backend')
-                            ->example('my-application-name')
+                            ->defaultValue('_%kernel.project_dir%.%kernel.container_class%')
+                            ->example('my-application-name/%kernel.environment%')
                         ->end()
                         ->scalarNode('app')
                             ->info('App related cache pools configuration')
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -463,6 +463,7 @@ protected static function getBundleDefaultConfig()
                 'default_redis_provider' => 'redis://localhost',
                 'default_memcached_provider' => 'memcached://localhost',
                 'default_pdo_provider' => class_exists(Connection::class) ? 'database_connection' : null,
+                'prefix_seed' => '_%kernel.project_dir%.%kernel.container_class%',
             ],
             'workflows' => [
                 'enabled' => false,
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -1334,11 +1334,11 @@ public function testCachePoolServices()
                 (new ChildDefinition('cache.adapter.array'))
                     ->replaceArgument(0, 12),
                 (new ChildDefinition('cache.adapter.filesystem'))
-                    ->replaceArgument(0, 'xctxZ1lyiH')
+                    ->replaceArgument(0, 'UKoP1K+Hox')
                     ->replaceArgument(1, 12),
                 (new ChildDefinition('cache.adapter.redis'))
                     ->replaceArgument(0, new Reference('.cache_connection.kYdiLgf'))
-                    ->replaceArgument(1, 'xctxZ1lyiH')
+                    ->replaceArgument(1, 'UKoP1K+Hox')
                     ->replaceArgument(2, 12),
             ],
             12,
diff --git a/src/Symfony/Bundle/FrameworkBundle/composer.json b/src/Symfony/Bundle/FrameworkBundle/composer.json
@@ -18,7 +18,7 @@
     "require": {
         "php": ">=7.2.5",
         "ext-xml": "*",
-        "symfony/cache": "^4.4|^5.0",
+        "symfony/cache": "^5.2",
         "symfony/config": "^5.0",
         "symfony/dependency-injection": "^5.2",
         "symfony/event-dispatcher": "^5.1",
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/DependencyInjection/SecurityExtensionTest.php b/src/Symfony/Bundle/SecurityBundle/Tests/DependencyInjection/SecurityExtensionTest.php
@@ -365,6 +365,7 @@ public function testRememberMeCookieInheritFrameworkSessionCookie($config, $same
         $container->setParameter('kernel.bundles_metadata', []);
         $container->setParameter('kernel.project_dir', __DIR__);
         $container->setParameter('kernel.cache_dir', __DIR__);
+        $container->setParameter('kernel.container_class', 'app');
 
         $container->loadFromExtension('security', [
             'firewalls' => [
diff --git a/src/Symfony/Component/Cache/DependencyInjection/CachePoolPass.php b/src/Symfony/Component/Cache/DependencyInjection/CachePoolPass.php
@@ -49,11 +49,11 @@ public function __construct(string $cachePoolTag = 'cache.pool', string $kernelR
     public function process(ContainerBuilder $container)
     {
         if ($container->hasParameter('cache.prefix.seed')) {
-            $seed = '.'.$container->getParameterBag()->resolveValue($container->getParameter('cache.prefix.seed'));
+            $seed = $container->getParameterBag()->resolveValue($container->getParameter('cache.prefix.seed'));
         } else {
             $seed = '_'.$container->getParameter('kernel.project_dir');
+            $seed .= '.'.$container->getParameter('kernel.container_class');
         }
-        $seed .= '.'.$container->getParameter('kernel.container_class');
 
         $allPools = [];
         $clearers = [];
diff --git a/src/Symfony/Component/Cache/Tests/DependencyInjection/CachePoolPassTest.php b/src/Symfony/Component/Cache/Tests/DependencyInjection/CachePoolPassTest.php
@@ -135,7 +135,7 @@ public function testArgsAreReplaced()
 
         $this->assertInstanceOf(Reference::class, $cachePool->getArgument(0));
         $this->assertSame('foobar', (string) $cachePool->getArgument(0));
-        $this->assertSame('tQNhcV-8xa', $cachePool->getArgument(1));
+        $this->assertSame('6Ridbw4aMn', $cachePool->getArgument(1));
         $this->assertSame(3, $cachePool->getArgument(2));
     }
 
@@ -156,7 +156,7 @@ public function testWithNameAttribute()
 
         $this->cachePoolPass->process($container);
 
-        $this->assertSame('+naTpPa4Sm', $cachePool->getArgument(1));
+        $this->assertSame('PeXBWSl6ca', $cachePool->getArgument(1));
     }
 
     public function testThrowsExceptionWhenCachePoolTagHasUnknownAttributes()

Original file line number	Diff line number	Diff line change
`@@ -49,11 +49,11 @@ public function __construct(string $cachePoolTag = 'cache.pool', string $kernelR`
`49`	`49`	`public function process(ContainerBuilder $container)`
`50`	`50`	`{`
`51`	`51`	`if ($container->hasParameter('cache.prefix.seed')) {`
`52`		`- $seed = '.'.$container->getParameterBag()->resolveValue($container->getParameter('cache.prefix.seed'));`
	`52`	`+ $seed = $container->getParameterBag()->resolveValue($container->getParameter('cache.prefix.seed'));`
`53`	`53`	`} else {`
`54`	`54`	`$seed = '_'.$container->getParameter('kernel.project_dir');`
	`55`	`+ $seed .= '.'.$container->getParameter('kernel.container_class');`
`55`	`56`	`}`
`56`		`- $seed .= '.'.$container->getParameter('kernel.container_class');`
`57`	`57`
`58`	`58`	`$allPools = [];`
`59`	`59`	`$clearers = [];`
Original file line number	Diff line number	Diff line change
`@@ -135,7 +135,7 @@ public function testArgsAreReplaced()`
`135`	`135`
`136`	`136`	`$this->assertInstanceOf(Reference::class, $cachePool->getArgument(0));`
`137`	`137`	`$this->assertSame('foobar', (string) $cachePool->getArgument(0));`
`138`		`- $this->assertSame('tQNhcV-8xa', $cachePool->getArgument(1));`
	`138`	`+ $this->assertSame('6Ridbw4aMn', $cachePool->getArgument(1));`
`139`	`139`	`$this->assertSame(3, $cachePool->getArgument(2));`
`140`	`140`	`}`
`141`	`141`
`@@ -156,7 +156,7 @@ public function testWithNameAttribute()`
`156`	`156`
`157`	`157`	`$this->cachePoolPass->process($container);`
`158`	`158`
`159`		`- $this->assertSame('+naTpPa4Sm', $cachePool->getArgument(1));`
	`159`	`+ $this->assertSame('PeXBWSl6ca', $cachePool->getArgument(1));`
`160`	`160`	`}`
`161`	`161`
`162`	`162`	`public function testThrowsExceptionWhenCachePoolTagHasUnknownAttributes()`