symfony · mw3e21a · Jan 30, 2023 · Feb 1, 2023 · Feb 2, 2023 · Feb 2, 2023
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -17,6 +17,7 @@ CHANGELOG
  * Allow setting `debug.container.dump` to `false` to disable dumping the container to XML
  * Add `framework.http_cache.skip_response_headers` option
  * Display warmers duration on debug verbosity for `cache:clear` command
+ * Improved `bin/console debug:container --env-vars` and the `--env-var` option to display the number of occurrences of each environment variable in the container.
 
 6.2
 ---

diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php
@@ -296,9 +296,12 @@ private function getContainerEnvVars(ContainerBuilder $container): array
             return [];
         }
 
-        $file = file_get_contents($container->getParameter('debug.container.dump'));
-        preg_match_all('{%env\(((?:\w++:)*+\w++)\)%}', $file, $envVars);
-        $envVars = array_unique($envVars[1]);
+        $envVarsFromContainer = [];
+        $containerFile = file_get_contents($container->getParameter('debug.container.dump'));
+        preg_match_all('{%env\(((?:\w++:)*+\w++)\)%}', $containerFile, $envVarsFromContainer);
+        $envVarsFromContainer = array_unique($envVarsFromContainer[1]);
+
+        $allEnvVars = array_unique(array_merge($envVarsFromContainer, $this->getAvailableVars()));
 
         $bag = $container->getParameterBag();
         $getDefaultParameter = fn (string $name) => parent::get($name);
@@ -308,7 +311,7 @@ private function getContainerEnvVars(ContainerBuilder $container): array
 
         $envs = [];
 
-        foreach ($envVars as $env) {
+        foreach ($allEnvVars as $env) {
             $processor = 'string';
             if (false !== $i = strrpos($name = $env, ':')) {
                 $name = substr($env, $i + 1);
@@ -319,6 +322,10 @@ private function getContainerEnvVars(ContainerBuilder $container): array
                 $runtimeValue = null;
             }
             $processedValue = ($hasRuntime = null !== $runtimeValue) || $hasDefault ? $getEnvReflection->invoke($container, $env) : null;
+
+            preg_match_all('/'.preg_quote($env).'/', $containerFile, $matches);
+            $usageCounter = \count($matches[0]);
+
             $envs["$name$processor"] = [
                 'name' => $name,
                 'processor' => $processor,
@@ -327,6 +334,7 @@ private function getContainerEnvVars(ContainerBuilder $container): array
                 'runtime_available' => $hasRuntime,
                 'runtime_value' => $runtimeValue,
                 'processed_value' => $processedValue,
+                'usage_count' => $usageCounter,
             ];
         }
         ksort($envs);
@@ -342,4 +350,12 @@ protected function getServiceEdges(ContainerBuilder $builder, string $serviceId)
             return [];
         }
     }
+
+    private function getAvailableVars(): array
+    {
+        $vars = explode(',', $_SERVER['SYMFONY_DOTENV_VARS'] ?? '');
+        sort($vars);
+
+        return $vars;
+    }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php
@@ -432,6 +432,7 @@ protected function describeContainerEnvVars(array $envs, array $options = []): v
                         ['<info>Default value</>', $env['default_available'] ? $dump($env['default_value']) : 'n/a'],
                         ['<info>Real value</>', $env['runtime_available'] ? $dump($env['runtime_value']) : 'n/a'],
                         ['<info>Processed value</>', $env['default_available'] || $env['runtime_available'] ? $dump($env['processed_value']) : 'n/a'],
+                        ['<info>Usage count</>', $dump($env['usage_count'])],
                     ]);
                 }
             }
@@ -455,20 +456,28 @@ protected function describeContainerEnvVars(array $envs, array $options = []): v
         $missing = [];
         foreach ($envs as $env) {
             if (isset($rows[$env['name']])) {
+                $rows[$env['name']][3] += $env['usage_count'];
                 continue;
             }
 
             $rows[$env['name']] = [
                 $env['name'],
                 $env['default_available'] ? $dump($env['default_value']) : 'n/a',
                 $env['runtime_available'] ? $dump($env['runtime_value']) : 'n/a',
+                $env['usage_count'],
             ];
             if (!$env['default_available'] && !$env['runtime_available']) {
                 $missing[$env['name']] = true;
             }
         }
 
-        $options['output']->table(['Name', 'Default value', 'Real value'], $rows);
+        $rows = array_map(function ($row) use ($dump) {
+            $row[3] = $dump($row[3]);
+
+            return $row;
+        }, $rows);
+
+        $options['output']->table(['Name', 'Default value', 'Real value', 'Usage count'], $rows);
         $options['output']->comment('Note real values might be different between web and CLI.');
 
         if ($missing) {

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ContainerDebugCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ContainerDebugCommandTest.php
@@ -137,7 +137,12 @@ public function testTagsPartialSearch()
 
     public function testDescribeEnvVars()
     {
+        $_SERVER['SYMFONY_DOTENV_VARS'] = 'APP_FOO,APP_BAR,APP_BAZ';
         putenv('REAL=value');
+        putenv('APP_FOO=foo');
+        putenv('APP_BAR=bar');
+        putenv('APP_BAZ=baz');
+
         static::bootKernel(['test_case' => 'ContainerDebug', 'root_config' => 'config.yml', 'debug' => true]);
 
         $application = new Application(static::$kernel);
@@ -153,13 +158,16 @@ public function testDescribeEnvVars()
 Symfony Container Environment Variables
 =======================================
 
- --------- ----------------- ------------%w
-  Name      Default value     Real value%w
- --------- ----------------- ------------%w
-  JSON      "[1, "2.5", 3]"   n/a%w
-  REAL      n/a               "value"%w
-  UNKNOWN   n/a               n/a%w
- --------- ----------------- ------------%w
+ --------- ----------------- ------------ -------------%w
+  Name      Default value     Real value   Usage count%w
+ --------- ----------------- ------------ -------------%w
+  APP_BAR   n/a               "bar"        0%w
+  APP_BAZ   n/a               "baz"        1%w
+  APP_FOO   "foo"             "foo"        1%w
+  JSON      "[1, "2.5", 3]"   n/a          2%w
+  REAL      n/a               "value"      3%w
+  UNKNOWN   n/a               n/a          1%w
+ --------- ----------------- ------------ -------------%w
 
  // Note real values might be different between web and CLI.%w
 
@@ -171,6 +179,9 @@ public function testDescribeEnvVars()
             , $tester->getDisplay(true));
 
         putenv('REAL');
+        putenv('APP_FOO');
+        putenv('APP_BAR');
+        putenv('APP_BAZ');
     }
 
     public function testDescribeEnvVar()
@@ -185,7 +196,7 @@ public function testDescribeEnvVar()
         $tester = new ApplicationTester($application);
         $tester->run(['command' => 'debug:container', '--env-var' => 'js'], ['decorated' => false]);
 
-        $this->assertStringContainsString(file_get_contents(__DIR__.'/Fixtures/describe_env_vars.txt'), $tester->getDisplay(true));
+        $this->assertStringEqualsFile(__DIR__.'/Fixtures/describe_env_vars.txt', $tester->getDisplay(true));
     }
 
     public function testGetDeprecation()

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Fixtures/describe_env_vars.txt b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Fixtures/describe_env_vars.txt
@@ -1,10 +1,17 @@
+
+Symfony Container Environment Variables
+=======================================
+
+ // Displaying detailed environment variable usage matching js                                                          
+
 %env(float:key:2:json:JSON)%
 ----------------------------
 
  ----------------- ----------------- 
   Default value     "[1, "2.5", 3]"  
   Real value        n/a              
   Processed value   3.0              
+  Usage count       1                
  ----------------- ----------------- 
 
 %env(int:key:2:json:JSON)%
@@ -14,4 +21,8 @@
   Default value     "[1, "2.5", 3]"  
   Real value        n/a              
   Processed value   3                
+  Usage count       1                
  ----------------- ----------------- 
+
+ // Note real values might be different between web and CLI.                                                            
+
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ContainerDebug/config.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ContainerDebug/config.yml
@@ -3,6 +3,7 @@ imports:
 
 parameters:
     env(JSON): '[1, "2.5", 3]'
+    env(APP_FOO): 'foo'
 
 services:
     _defaults: { public: true }
@@ -33,3 +34,9 @@ services:
             - '%env(REAL)%'
             - '%env(int:key:2:json:JSON)%'
             - '%env(float:key:2:json:JSON)%'
+    useEnv:
+        class: stdClass
+        arguments:
+            - '%env(REAL)%'
+            - '%env(REAL)%'
+            - '%env(APP_BAZ)%'