[TypeInfo] Fix template key-type for array #62738
Open
+25
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull request overview
This PR fixes a bug where template keys constrained to array-key (which is int|string) incorrectly threw an InvalidArgumentException when used as array key types. The fix unwraps template types to access their bounds before validation.
Key Changes:
- Added unwrapping logic for template types in array key validation to check the bound type rather than the template wrapper
- Added comprehensive test cases covering template keys with
array-keybounds - Updated the
DummyCollectionfixture with template annotations forTKeyandTValue
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/Symfony/Component/TypeInfo/Type/CollectionType.php |
Added logic to unwrap TemplateType and validate its bound when checking array key types |
src/Symfony/Component/TypeInfo/Tests/TypeResolver/StringTypeResolverTest.php |
Added test cases for arrays and lists with template types, plus a negative test for invalid template key bounds |
src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyCollection.php |
Added template annotations for TKey (constrained to array-key) and TValue to support new test cases |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mtarld
requested changes
Dec 12, 2025
Comment on lines
53
to
65
| $keyType = $this->getCollectionKeyType(); | ||
|
|
||
| if ($keyType instanceof TemplateType) { | ||
| $keyType = $keyType->getWrappedType(); | ||
| } | ||
|
|
||
| $keyTypes = $keyType instanceof UnionType ? $keyType->getTypes() : [$keyType]; | ||
|
|
||
| foreach ($keyTypes as $type) { | ||
| if (!$type instanceof BuiltinType || !\in_array($type->getTypeIdentifier(), [TypeIdentifier::INT, TypeIdentifier::STRING], true)) { | ||
| throw new InvalidArgumentException(\sprintf('"%s" is not a valid array key type.', (string) $keyType)); | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
We must be able to handle
- Union of scalars
- Union of template types, such as
TFoo|TBar. - Template type that is a union
- Template type that is scalar
To handle every case, maybe we can do the following:
$keyType = $this->getCollectionKeyType();
foreach ($keyType->traverse(false) as $t) { // to traverse composite but not wrapped (because nullable, collection, etc are not valid)
if ($t instanceof UnionType) {
continue;
}
if (($t instanceof BuiltinType || $t instanceof TemplateType) && $t->isIdentifiedBy(TypeIdentifier::INT, TypeIdentifier::STRING) {
continue;
}
// others types, such as intersection, nullable types, etc are not valid
throw new InvalidArgumentException(\sprintf('"%s" is not a valid array key type.', (string) $keyType));
}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#62388 broke type detection for template keys for array:
Above example currently throws an exception
Symfony\Component\TypeInfo\Exception\InvalidArgumentException: "TKey" is not a valid array key type.even thoughTKeyis a type ofarray-key(int|string).This PR fixes this by getting the wrapped type when dealing with a template type when checking if a valid array key type is provided.