bug #62344 [OptionsResolver] Fix missing prototype key in nested error paths (yoeunes)

nicolas-grekas · nicolas-grekas · commit 19f6580ecb13 · 2025-11-12T14:07:01.000+01:00
This PR was merged into the 6.4 branch. Discussion ---------- [OptionsResolver] Fix missing prototype key in nested error paths | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | - | License | MIT This PR fixes a bug where `MissingOptionsException` error messages for nested prototypes generated an incomplete path. When an option was missing inside a prototype that was *itself* nested inside another prototype, the key of the parent prototype was omitted from the error message. The fix ensures the parent's prototype index is correctly tracked and prepended when resolving nested options, providing a full and accurate path for easier debugging. **Example:** Given the following nested prototype setup: ```php $resolver->setOptions('connections', static function (OptionsResolver $connResolver) { $connResolver->setPrototype(true); // Parent prototype // ... $connResolver->setOptions('replicas', static function (OptionsResolver $replicaResolver) { $replicaResolver->setPrototype(true); // Nested prototype $replicaResolver->setRequired(['host']); }); }); ``` And this configuration, which is missing a `host` in `main_db`'s second replica: ```php $options = [ 'connections' => [ 'main_db' => [ // ... 'replicas' => [ ['host' => 'replica-01.local'], [], // Missing 'host' here ], ], ], ]; $resolver->resolve($options); ``` **Before (The Bug):** The exception message was incorrect, missing the `main_db` key: `The required option "connections[replicas][1][host]" is missing.` **After (The Fix):** The exception message is now correct and includes the full path: `The required option "connections[main_db][replicas][1][host]" is missing.` A test case (`testNestedPrototypeErrorPathHasFullContext`) has been added to cover this scenario and prevent regressions. Commits ------- 7d9c810 [OptionsResolver] Fix missing prototype key in nested error paths
diff --git a/src/Symfony/Component/OptionsResolver/OptionsResolver.php b/src/Symfony/Component/OptionsResolver/OptionsResolver.php
@@ -964,6 +964,11 @@ public function offsetGet(mixed $option, bool $triggerDeprecation = true): mixed
                 $resolver = new self();
                 $resolver->prototype = false;
                 $resolver->parentsOptions = $this->parentsOptions;
+
+                if ($this->prototype && null !== $this->prototypeIndex && null !== ($parentOptionKey = array_key_last($resolver->parentsOptions))) {
+                    $resolver->parentsOptions[$parentOptionKey] .= \sprintf('[%s]', $this->prototypeIndex);
+                }
+
                 $resolver->parentsOptions[] = $option;
                 foreach ($this->nested[$option] as $closure) {
                     $closure($resolver, $this);
diff --git a/src/Symfony/Component/OptionsResolver/Tests/OptionsResolverTest.php b/src/Symfony/Component/OptionsResolver/Tests/OptionsResolverTest.php
@@ -2595,4 +2595,46 @@ public function testRemoveAlsoRemovesDeprecation()
             restore_error_handler();
         }
     }
+
+    public function testNestedPrototypeErrorPathHasFullContext()
+    {
+        $resolver = new OptionsResolver();
+
+        $resolver->setDefault('connections', static function (OptionsResolver $connResolver) {
+            $connResolver->setPrototype(true);
+            $connResolver->setRequired(['host', 'database']);
+            $connResolver->setDefault('user', 'root');
+
+            $connResolver->setDefault('replicas', static function (OptionsResolver $replicaResolver) {
+                $replicaResolver->setPrototype(true);
+                $replicaResolver->setRequired(['host']);
+                $replicaResolver->setDefault('user', 'read_only');
+            });
+        });
+
+        $this->expectException(MissingOptionsException::class);
+        $this->expectExceptionMessage('The required option "connections[main_db][replicas][1][host]" is missing.');
+
+        $options = [
+            'connections' => [
+                'main_db' => [
+                    'host' => 'localhost',
+                    'database' => 'app_db',
+                    'replicas' => [
+                        ['host' => 'replica-01.local', 'user' => 'read_only'],
+                        ['user' => 'other_user'], // Index 1 -> "host" is missing here
+                    ],
+                ],
+                'audit_db' => [
+                    'host' => 'audit.local',
+                    'database' => 'audit_db',
+                    'replicas' => [
+                        ['host' => 'audit-replica.local'],
+                    ],
+                ],
+            ],
+        ];
+
+        $resolver->resolve($options);
+    }
 }
