bug #20616 [Bridge/Doctrine] Use cache.prefix.seed parameter for generating cache namespace (nicolas-grekas)

This PR was merged into the 3.2 branch.

Discussion
----------

[Bridge/Doctrine] Use cache.prefix.seed parameter for generating cache namespace

| Q             | A
| ------------- | ---
| Branch?       | 3.2
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | -
| License       | MIT
| Doc PR        | -

Exactly the same issue as in #20610, but for Doctrine ORM's cache:
> That's a design issue: using root_dir as discriminant doesn't work with blue/green deployment strategies, and doesn't prevent collision when different apps are deployed in the same path while sharing the same cache backend.

Commits
-------

5e3cbec [Bridge/Doctrine] Use cache.prefix.seed parameter for generating cache namespace

Author: nicolas-grekas

DependencyInjection/Compiler/CachePoolClearerPass.php

@@ -25,6 +25,8 @@ final class CachePoolClearerPass implements CompilerPassInterface
      */
     public function process(ContainerBuilder $container)
     {
+        $container->getParameterBag()->remove('cache.prefix.seed');
+
         foreach ($container->findTaggedServiceIds('cache.pool') as $id => $attributes) {
             foreach (array_reverse($attributes) as $attr) {
                 if (isset($attr['clearer'])) {

DependencyInjection/Compiler/CachePoolPass.php

@@ -29,14 +29,12 @@ class CachePoolPass implements CompilerPassInterface
      */
     public function process(ContainerBuilder $container)
     {
-        $namespaceSuffix = '';
-
-        foreach (array('kernel.name', 'kernel.environment', 'kernel.debug', 'cache.prefix.seed') as $key) {
-            if ($container->hasParameter($key)) {
-                $namespaceSuffix .= '.'.$container->getParameter($key);
-            }
+        if ($container->hasParameter('cache.prefix.seed')) {
+            $seed = '.'.$container->getParameterBag()->resolveValue($container->getParameter('cache.prefix.seed'));
+        } else {
+            $seed = '_'.$container->getParameter('kernel.root_dir');
         }
-        $container->getParameterBag()->remove('cache.prefix.seed');
+        $seed .= '.'.$container->getParameter('kernel.name').'.'.$container->getParameter('kernel.environment').'.'.$container->getParameter('kernel.debug');
 
         $aliases = $container->getAliases();
         $attributes = array(
@@ -56,7 +54,7 @@ public function process(ContainerBuilder $container)
                 }
             }
             if (!isset($tags[0]['namespace'])) {
-                $tags[0]['namespace'] = $this->getNamespace($namespaceSuffix, $id);
+                $tags[0]['namespace'] = $this->getNamespace($seed, $id);
             }
             if (isset($tags[0]['clearer'])) {
                 $clearer = strtolower($tags[0]['clearer']);
@@ -88,9 +86,9 @@ public function process(ContainerBuilder $container)
         }
     }
 
-    private function getNamespace($namespaceSuffix, $id)
+    private function getNamespace($seed, $id)
     {
-        return substr(str_replace('/', '-', base64_encode(hash('sha256', $id.$namespaceSuffix, true))), 0, 10);
+        return substr(str_replace('/', '-', base64_encode(hash('sha256', $id.$seed, true))), 0, 10);
     }
 
     /**

Tests/DependencyInjection/Compiler/CachePoolClearerPassTest.php

@@ -24,6 +24,10 @@ class CachePoolClearerPassTest extends \PHPUnit_Framework_TestCase
     public function testPoolRefsAreWeak()
     {
         $container = new ContainerBuilder();
+        $container->setParameter('kernel.debug', false);
+        $container->setParameter('kernel.name', 'app');
+        $container->setParameter('kernel.environment', 'prod');
+        $container->setParameter('kernel.root_dir', 'foo');
 
         $publicPool = new Definition();
         $publicPool->addArgument('namespace');

Tests/DependencyInjection/Compiler/CachePoolPassTest.php

@@ -29,6 +29,10 @@ protected function setUp()
     public function testNamespaceArgumentIsReplaced()
     {
         $container = new ContainerBuilder();
+        $container->setParameter('kernel.debug', false);
+        $container->setParameter('kernel.name', 'app');
+        $container->setParameter('kernel.environment', 'prod');
+        $container->setParameter('kernel.root_dir', 'foo');
         $adapter = new Definition();
         $adapter->setAbstract(true);
         $adapter->addTag('cache.pool');
@@ -41,12 +45,16 @@ public function testNamespaceArgumentIsReplaced()
 
         $this->cachePoolPass->process($container);
 
-        $this->assertSame('kRFqMp5odS', $cachePool->getArgument(0));
+        $this->assertSame('C42Pcl9VBJ', $cachePool->getArgument(0));
     }
 
     public function testArgsAreReplaced()
     {
         $container = new ContainerBuilder();
+        $container->setParameter('kernel.debug', false);
+        $container->setParameter('kernel.name', 'app');
+        $container->setParameter('kernel.environment', 'prod');
+        $container->setParameter('cache.prefix.seed', 'foo');
         $cachePool = new Definition();
         $cachePool->addTag('cache.pool', array(
             'provider' => 'foobar',
@@ -61,7 +69,7 @@ public function testArgsAreReplaced()
 
         $this->assertInstanceOf(Reference::class, $cachePool->getArgument(0));
         $this->assertSame('foobar', (string) $cachePool->getArgument(0));
-        $this->assertSame('kRFqMp5odS', $cachePool->getArgument(1));
+        $this->assertSame('KO3xHaFEZU', $cachePool->getArgument(1));
         $this->assertSame(3, $cachePool->getArgument(2));
     }
 
@@ -72,6 +80,10 @@ public function testArgsAreReplaced()
     public function testThrowsExceptionWhenCachePoolTagHasUnknownAttributes()
     {
         $container = new ContainerBuilder();
+        $container->setParameter('kernel.debug', false);
+        $container->setParameter('kernel.name', 'app');
+        $container->setParameter('kernel.environment', 'prod');
+        $container->setParameter('kernel.root_dir', 'foo');
         $adapter = new Definition();
         $adapter->setAbstract(true);
         $adapter->addTag('cache.pool');