Merge branch '3.3' into 3.4

* 3.3: (27 commits)
  Always require symfony/polyfill-apcu to provide APCuIterator everywhere
  bumped Symfony version to 3.3.9
  updated VERSION for 3.3.8
  updated CHANGELOG for 3.3.8
  [DI] Fix tracking env var placeholders nested in object graphs
  bumped Symfony version to 3.3.8
  updated VERSION for 3.3.7
  updated CHANGELOG for 3.3.7
  [DI] Fix tracking env vars when merging configs (bis)
  removed obsolete comment
  install PHPUnit 6 on PHP 7.2
  [Cache] Use zend.detect_unicode instead of zend.multibyte
  Fix case sensitive typo in use class name
  [VarDumper] Enhance docblock to tell about AbstractDumper::dumpLine(-1)
  [Debug] Remove false-positive check in DebugClassLoader
  [Validator] Fix use of GroupSequenceProvider in child classes
  Change number PHPDoc type to int|float
  [Cache] Workaround zend.detect_unicode + zend.multibyte
  [VarDumper] Strengthen dumped JS
  [VarDumper] Strengthen dumped JS
  ...

Author: fabpot

Compiler/MergeExtensionConfigurationPass.php

@@ -15,7 +15,7 @@
 use Symfony\Component\DependencyInjection\Extension\ConfigurationExtensionInterface;
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
-use Symfony\Component\DependencyInjection\Parameterbag\EnvPlaceholderParameterBag;
+use Symfony\Component\DependencyInjection\ParameterBag\EnvPlaceholderParameterBag;
 
 /**
  * Merges extension configs into the container builder.
@@ -45,12 +45,14 @@ public function process(ContainerBuilder $container)
                 // this extension was not called
                 continue;
             }
-            // EnvPlaceholderParameterBag tracks env vars when calling resolveValue().
-            // Clone so that tracking is done in a dedicated bag.
-            $resolvingBag = clone $container->getParameterBag();
+            $resolvingBag = $container->getParameterBag();
+            if ($resolvingBag instanceof EnvPlaceholderParameterBag && $extension instanceof Extension) {
+                // create a dedicated bag so that we can track env vars per-extension
+                $resolvingBag = new MergeExtensionConfigurationParameterBag($resolvingBag);
+            }
             $config = $resolvingBag->resolveValue($config);
 
-            $tmpContainer = new ContainerBuilder($container->getParameterBag());
+            $tmpContainer = new ContainerBuilder($resolvingBag);
             $tmpContainer->setResourceTracking($container->isTrackingResources());
             $tmpContainer->addObjectResource($extension);
             if ($extension instanceof ConfigurationExtensionInterface && null !== $configuration = $extension->getConfiguration($config, $tmpContainer)) {
@@ -63,13 +65,9 @@ public function process(ContainerBuilder $container)
 
             $extension->load($config, $tmpContainer);
 
-            if ($resolvingBag instanceof EnvPlaceholderParameterBag) {
-                // $resolvingBag keeps track of env vars encoutered *before* merging configs
-                if ($extension instanceof Extension) {
-                    // but we don't want to keep track of env vars that are *overridden* when configs are merged
-                    $resolvingBag = new MergeExtensionConfigurationParameterBag($extension, $resolvingBag);
-                }
-                $container->getParameterBag()->mergeEnvPlaceholders($resolvingBag);
+            if ($resolvingBag instanceof MergeExtensionConfigurationParameterBag) {
+                // don't keep track of env vars that are *overridden* when configs are merged
+                $resolvingBag->freezeAfterProcessing($extension);
             }
 
             $container->merge($tmpContainer);
@@ -86,60 +84,36 @@ public function process(ContainerBuilder $container)
  */
 class MergeExtensionConfigurationParameterBag extends EnvPlaceholderParameterBag
 {
-    private $beforeProcessingEnvPlaceholders;
+    private $processedEnvPlaceholders;
 
-    public function __construct(Extension $extension, parent $resolvingBag)
+    public function __construct(parent $parameterBag)
     {
-        $this->beforeProcessingEnvPlaceholders = $resolvingBag->getEnvPlaceholders();
-        $config = $this->resolveEnvPlaceholders($extension->getProcessedConfigs());
-        parent::__construct($this->resolveValue($config));
+        parent::__construct($parameterBag->all());
+        $this->mergeEnvPlaceholders($parameterBag);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function get($name)
+    public function freezeAfterProcessing(Extension $extension)
     {
-        return $this->has($name) || (0 === strpos($name, 'env(') && ')' === substr($name, -1) && 'env()' !== $name) ? parent::get($name) : '';
-    }
+        $this->processedEnvPlaceholders = array();
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getEnvPlaceholders()
-    {
-        // contains the list of env vars that are still used after configs have been merged
-        $envPlaceholders = parent::getEnvPlaceholders();
+        // serialize config to catch env vars nested in object graphs
+        $config = serialize($extension->getProcessedConfigs());
 
-        foreach ($envPlaceholders as $env => $placeholders) {
-            if (isset($this->beforeProcessingEnvPlaceholders[$env])) {
-                // for still-used env vars, keep track of their before-processing placeholders
-                $envPlaceholders[$env] += $this->beforeProcessingEnvPlaceholders[$env];
+        foreach (parent::getEnvPlaceholders() as $env => $placeholders) {
+            foreach ($placeholders as $placeholder) {
+                if (false !== stripos($config, $placeholder)) {
+                    $this->processedEnvPlaceholders[$env] = $placeholders;
+                    break;
+                }
             }
         }
-
-        return $envPlaceholders;
     }
 
     /**
-     * Replaces-back env placeholders to their original "%env(FOO)%" version.
+     * {@inheritdoc}
      */
-    private function resolveEnvPlaceholders($value)
+    public function getEnvPlaceholders()
     {
-        if (is_array($value)) {
-            foreach ($value as $k => $v) {
-                $value[$this->resolveEnvPlaceholders($k)] = $this->resolveEnvPlaceholders($v);
-            }
-        } elseif (is_string($value)) {
-            foreach ($this->beforeProcessingEnvPlaceholders as $env => $placeholders) {
-                foreach ($placeholders as $placeholder) {
-                    if (false !== stripos($value, $placeholder)) {
-                        $value = str_ireplace($placeholder, "%env($env)%", $value);
-                    }
-                }
-            }
-        }
-
-        return $value;
+        return null !== $this->processedEnvPlaceholders ? $this->processedEnvPlaceholders : parent::getEnvPlaceholders();
     }
 }

ContainerBuilder.php

@@ -641,10 +641,16 @@ public function merge(ContainerBuilder $container)
         }
 
         if ($this->getParameterBag() instanceof EnvPlaceholderParameterBag && $container->getParameterBag() instanceof EnvPlaceholderParameterBag) {
+            $envPlaceholders = $container->getParameterBag()->getEnvPlaceholders();
             $this->getParameterBag()->mergeEnvPlaceholders($container->getParameterBag());
+        } else {
+            $envPlaceholders = array();
         }
 
         foreach ($container->envCounters as $env => $count) {
+            if (!$count && !isset($envPlaceholders[$env])) {
+                continue;
+            }
             if (!isset($this->envCounters[$env])) {
                 $this->envCounters[$env] = $count;
             } else {

Tests/Compiler/MergeExtensionConfigurationPassTest.php

@@ -76,12 +76,13 @@ public function testOverriddenEnvsAreMerged()
         $container = new ContainerBuilder();
         $container->registerExtension(new FooExtension());
         $container->prependExtensionConfig('foo', array('bar' => '%env(FOO)%'));
-        $container->prependExtensionConfig('foo', array('bar' => '%env(BAR)%'));
+        $container->prependExtensionConfig('foo', array('bar' => '%env(BAR)%', 'baz' => '%env(BAZ)%'));
 
         $pass = new MergeExtensionConfigurationPass();
         $pass->process($container);
 
-        $this->assertSame(array('FOO'), array_keys($container->getParameterBag()->getEnvPlaceholders()));
+        $this->assertSame(array('BAZ', 'FOO'), array_keys($container->getParameterBag()->getEnvPlaceholders()));
+        $this->assertSame(array('BAZ' => 1, 'FOO' => 0), $container->getEnvCounters());
     }
 }
 
@@ -94,6 +95,7 @@ public function getConfigTreeBuilder()
         $rootNode
             ->children()
                 ->scalarNode('bar')->end()
+                ->scalarNode('baz')->end()
             ->end();
 
         return $treeBuilder;
@@ -116,5 +118,10 @@ public function load(array $configs, ContainerBuilder $container)
     {
         $configuration = $this->getConfiguration($configs, $container);
         $config = $this->processConfiguration($configuration, $configs);
+
+        if (isset($config['baz'])) {
+            $container->getParameterBag()->get('env(BOZ)');
+            $container->resolveEnvPlaceholders($config['baz']);
+        }
     }
 }