[Config] Do not generate unreachable configuration paths

Author: bobvandevijver

Builder/ConfigBuilderGenerator.php

@@ -127,10 +127,13 @@ private function handleArrayNode(ArrayNode $node, ClassBuilder $class, string $n
         $class->addRequire($childClass);
         $this->classes[] = $childClass;
 
+        $nodeTypes = $this->getParameterTypes($node);
+        $paramType = $this->getParamType($nodeTypes);
+
         $hasNormalizationClosures = $this->hasNormalizationClosures($node);
         $comment = $this->getComment($node);
-        if ($hasNormalizationClosures) {
-            $comment = \sprintf(" * @template TValue\n * @param TValue \$value\n%s", $comment);
+        if ($hasNormalizationClosures && 'array' !== $paramType) {
+            $comment = \sprintf(" * @template TValue of %s\n * @param TValue \$value\n%s", $paramType, $comment);
             $comment .= \sprintf(' * @return %s|$this'."\n", $childClass->getFqcn());
             $comment .= \sprintf(' * @psalm-return (TValue is array ? %s : static)'."\n ", $childClass->getFqcn());
         }
@@ -142,8 +145,7 @@ private function handleArrayNode(ArrayNode $node, ClassBuilder $class, string $n
             $node->getName(),
             $this->getType($childClass->getFqcn(), $hasNormalizationClosures)
         );
-        $nodeTypes = $this->getParameterTypes($node);
-        $body = $hasNormalizationClosures ? '
+        $body = $hasNormalizationClosures && 'array' !== $paramType ? '
 COMMENTpublic function NAME(PARAM_TYPE $value = []): CLASS|static
 {
     if (!\is_array($value)) {
@@ -178,7 +180,7 @@ private function handleArrayNode(ArrayNode $node, ClassBuilder $class, string $n
             'COMMENT' => $comment,
             'PROPERTY' => $property->getName(),
             'CLASS' => $childClass->getFqcn(),
-            'PARAM_TYPE' => \in_array('mixed', $nodeTypes, true) ? 'mixed' : implode('|', $nodeTypes),
+            'PARAM_TYPE' => $paramType,
         ]);
 
         $this->buildNode($node, $childClass, $this->getSubNamespace($childClass));
@@ -218,10 +220,11 @@ private function handlePrototypedArrayNode(PrototypedArrayNode $node, ClassBuild
 
         $nodeParameterTypes = $this->getParameterTypes($node);
         $prototypeParameterTypes = $this->getParameterTypes($prototype);
+        $noKey = null === $key = $node->getKeyAttribute();
         if (!$prototype instanceof ArrayNode || ($prototype instanceof PrototypedArrayNode && $prototype->getPrototype() instanceof ScalarNode)) {
             $class->addUse(ParamConfigurator::class);
             $property = $class->addProperty($node->getName());
-            if (null === $key = $node->getKeyAttribute()) {
+            if ($noKey) {
                 // This is an array of values; don't use singular name
                 $nodeTypesWithoutArray = array_filter($nodeParameterTypes, static fn ($type) => 'array' !== $type);
                 $body = '
@@ -242,7 +245,7 @@ public function NAME(PARAM_TYPE $value): static
                     'PROPERTY' => $property->getName(),
                     'PROTOTYPE_TYPE' => implode('|', $prototypeParameterTypes),
                     'EXTRA_TYPE' => $nodeTypesWithoutArray ? '|'.implode('|', $nodeTypesWithoutArray) : '',
-                    'PARAM_TYPE' => \in_array('mixed', $nodeParameterTypes, true) ? 'mixed' : 'ParamConfigurator|'.implode('|', $nodeParameterTypes),
+                    'PARAM_TYPE' => $this->getParamType($nodeParameterTypes, true),
                 ]);
             } else {
                 $body = '
@@ -259,7 +262,7 @@ public function NAME(string $VAR, TYPE $VALUE): static
 
                 $class->addMethod($methodName, $body, [
                     'PROPERTY' => $property->getName(),
-                    'TYPE' => \in_array('mixed', $prototypeParameterTypes, true) ? 'mixed' : 'ParamConfigurator|'.implode('|', $prototypeParameterTypes),
+                    'TYPE' => $this->getParamType($prototypeParameterTypes, true),
                     'VAR' => '' === $key ? 'key' : $key,
                     'VALUE' => 'value' === $key ? 'data' : 'value',
                 ]);
@@ -280,18 +283,27 @@ public function NAME(string $VAR, TYPE $VALUE): static
             $this->getType($childClass->getFqcn().'[]', $hasNormalizationClosures)
         );
 
+        $paramType = $this->getParamType($noKey ? $nodeParameterTypes : $prototypeParameterTypes);
+
         $comment = $this->getComment($node);
+<<<<<<< HEAD
         if ($hasNormalizationClosures) {
             $comment = \sprintf(" * @template TValue\n * @param TValue \$value\n%s", $comment);
             $comment .= \sprintf(' * @return %s|$this'."\n", $childClass->getFqcn());
             $comment .= \sprintf(' * @psalm-return (TValue is array ? %s : static)'."\n ", $childClass->getFqcn());
+=======
+        if ($hasNormalizationClosures && 'array' !== $paramType) {
+            $comment = sprintf(" * @template TValue of %s\n * @param TValue \$value\n%s", $paramType, $comment);
+            $comment .= sprintf(' * @return %s|$this'."\n", $childClass->getFqcn());
+            $comment .= sprintf(' * @psalm-return (TValue is array ? %s : static)'."\n ", $childClass->getFqcn());
+>>>>>>> 100c683018d ([Config] Do not generate unreachable configuration paths)
         }
         if ('' !== $comment) {
             $comment = "/**\n$comment*/\n";
         }
 
-        if (null === $key = $node->getKeyAttribute()) {
-            $body = $hasNormalizationClosures ? '
+        if ($noKey) {
+            $body = $hasNormalizationClosures && 'array' !== $paramType ? '
 COMMENTpublic function NAME(PARAM_TYPE $value = []): CLASS|static
 {
     $this->_usedProperties[\'PROPERTY\'] = true;
@@ -313,10 +325,10 @@ public function NAME(string $VAR, TYPE $VALUE): static
                 'COMMENT' => $comment,
                 'PROPERTY' => $property->getName(),
                 'CLASS' => $childClass->getFqcn(),
-                'PARAM_TYPE' => \in_array('mixed', $nodeParameterTypes, true) ? 'mixed' : implode('|', $nodeParameterTypes),
+                'PARAM_TYPE' => $paramType,
             ]);
         } else {
-            $body = $hasNormalizationClosures ? '
+            $body = $hasNormalizationClosures && 'array' !== $paramType ? '
 COMMENTpublic function NAME(string $VAR, PARAM_TYPE $VALUE = []): CLASS|static
 {
     if (!\is_array($VALUE)) {
@@ -352,7 +364,7 @@ public function NAME(string $VAR, TYPE $VALUE): static
                 'CLASS' => $childClass->getFqcn(),
                 'VAR' => '' === $key ? 'key' : $key,
                 'VALUE' => 'value' === $key ? 'data' : 'value',
-                'PARAM_TYPE' => \in_array('mixed', $prototypeParameterTypes, true) ? 'mixed' : implode('|', $prototypeParameterTypes),
+                'PARAM_TYPE' => $paramType,
             ]);
         }
 
@@ -597,4 +609,9 @@ private function getType(string $classType, bool $hasNormalizationClosures): str
     {
         return $classType.($hasNormalizationClosures ? '|scalar' : '');
     }
+
+    private function getParamType(array $types, bool $withParamConfigurator = false): string
+    {
+        return \in_array('mixed', $types, true) ? 'mixed' : ($withParamConfigurator ? 'ParamConfigurator|' : '').implode('|', $types);
+    }
 }

Tests/Builder/Fixtures/ArrayValues.config.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Symfony\Config\ArrayValuesConfig;
+
+return static function (ArrayValuesConfig $config) {
+    $config->transports('foo')->dsn('bar');
+    $config->transports('bar', ['dsn' => 'foobar']);
+
+    $config->errorPages()->withTrace(false);
+};

Tests/Builder/Fixtures/ArrayValues.output.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+return [
+    'transports' => [
+        'foo' => [
+            'dsn' => 'bar',
+        ],
+        'bar' => [
+            'dsn' => 'foobar',
+        ],
+    ],
+    'error_pages' => [
+        'with_trace' => false,
+    ]
+];

Tests/Builder/Fixtures/ArrayValues.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Symfony\Component\Config\Tests\Builder\Fixtures;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+class ArrayValues implements ConfigurationInterface
+{
+    public function getConfigTreeBuilder(): TreeBuilder
+    {
+        $tb = new TreeBuilder('array_values');
+        $rootNode = $tb->getRootNode();
+        $rootNode
+            ->children()
+                ->arrayNode('transports')
+                    ->normalizeKeys(false)
+                    ->useAttributeAsKey('name')
+                    ->arrayPrototype()
+                        ->beforeNormalization()
+                            ->ifString()
+                            ->then(function (string $dsn) {
+                                return ['dsn' => $dsn];
+                            })
+                        ->end()
+                        ->fixXmlConfig('option')
+                        ->children()
+                            ->scalarNode('dsn')->end()
+                        ->end()
+                    ->end()
+                ->end()
+                ->arrayNode('error_pages')
+                    ->canBeEnabled()
+                    ->children()
+                        ->booleanNode('with_trace')->end()
+                    ->end()
+                ->end()
+            ->end();
+
+        return $tb;
+    }
+}

Tests/Builder/Fixtures/ArrayValues/Symfony/Config/ArrayValues/ErrorPagesConfig.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Symfony\Config\ArrayValues;
+
+use Symfony\Component\Config\Loader\ParamConfigurator;
+use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
+
+/**
+ * This class is automatically generated to help in creating a config.
+ */
+class ErrorPagesConfig 
+{
+    private $enabled;
+    private $withTrace;
+    private $_usedProperties = [];
+
+    /**
+     * @default false
+     * @param ParamConfigurator|bool $value
+     * @return $this
+     */
+    public function enabled($value): static
+    {
+        $this->_usedProperties['enabled'] = true;
+        $this->enabled = $value;
+
+        return $this;
+    }
+
+    /**
+     * @default null
+     * @param ParamConfigurator|bool $value
+     * @return $this
+     */
+    public function withTrace($value): static
+    {
+        $this->_usedProperties['withTrace'] = true;
+        $this->withTrace = $value;
+
+        return $this;
+    }
+
+    public function __construct(array $value = [])
+    {
+        if (array_key_exists('enabled', $value)) {
+            $this->_usedProperties['enabled'] = true;
+            $this->enabled = $value['enabled'];
+            unset($value['enabled']);
+        }
+
+        if (array_key_exists('with_trace', $value)) {
+            $this->_usedProperties['withTrace'] = true;
+            $this->withTrace = $value['with_trace'];
+            unset($value['with_trace']);
+        }
+
+        if ([] !== $value) {
+            throw new InvalidConfigurationException(sprintf('The following keys are not supported by "%s": ', __CLASS__).implode(', ', array_keys($value)));
+        }
+    }
+
+    public function toArray(): array
+    {
+        $output = [];
+        if (isset($this->_usedProperties['enabled'])) {
+            $output['enabled'] = $this->enabled;
+        }
+        if (isset($this->_usedProperties['withTrace'])) {
+            $output['with_trace'] = $this->withTrace;
+        }
+
+        return $output;
+    }
+
+}

Tests/Builder/Fixtures/ArrayValues/Symfony/Config/ArrayValues/TransportsConfig.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Symfony\Config\ArrayValues;
+
+use Symfony\Component\Config\Loader\ParamConfigurator;
+use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
+
+/**
+ * This class is automatically generated to help in creating a config.
+ */
+class TransportsConfig 
+{
+    private $dsn;
+    private $_usedProperties = [];
+
+    /**
+     * @default null
+     * @param ParamConfigurator|mixed $value
+     * @return $this
+     */
+    public function dsn($value): static
+    {
+        $this->_usedProperties['dsn'] = true;
+        $this->dsn = $value;
+
+        return $this;
+    }
+
+    public function __construct(array $value = [])
+    {
+        if (array_key_exists('dsn', $value)) {
+            $this->_usedProperties['dsn'] = true;
+            $this->dsn = $value['dsn'];
+            unset($value['dsn']);
+        }
+
+        if ([] !== $value) {
+            throw new InvalidConfigurationException(sprintf('The following keys are not supported by "%s": ', __CLASS__).implode(', ', array_keys($value)));
+        }
+    }
+
+    public function toArray(): array
+    {
+        $output = [];
+        if (isset($this->_usedProperties['dsn'])) {
+            $output['dsn'] = $this->dsn;
+        }
+
+        return $output;
+    }
+
+}