[LiveComponent] Fix BC break when using PropertyTypeExtractorInterface::getType() on a #[LiveProp] property x when getter getX exists

[Kocal]

Q	A
Bug fix?	yes
New feature?	no
Docs?	no
Issues	Fix #2888
License	MIT

Prevent:

1) Symfony\UX\LiveComponent\Tests\Functional\Form\ComponentWithFormTest::testFormWithLivePropContainingAnEntityImplementingAnInterface LogicException: Cannot dehydrate value typed as interface "Symfony\UX\LiveComponent\Tests\Fixtures\Entity\User" on component "Symfony\UX\LiveComponent\Tests\Fixtures\Component\FormWithUserInterfaceComponent". Change this to a concrete type that can be dehydrated. Or set the hydrateWith/dehydrateWith options in LiveProp or set "useSerializerForHydration: true" on the LiveProp to use the serializer. 

Given the LiveComponent:

<?php /*  * This file is part of the Symfony package.  *  * (c) Fabien Potencier <fabien@symfony.com>  *  * For the full copyright and license information, please view the LICENSE  * file that was distributed with this source code.  */ namespace Symfony\UX\LiveComponent\Tests\Fixtures\Component; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Component\Form\FormInterface; use Symfony\UX\LiveComponent\Attribute\AsLiveComponent; use Symfony\UX\LiveComponent\Attribute\LiveProp; use Symfony\UX\LiveComponent\ComponentWithFormTrait; use Symfony\UX\LiveComponent\DefaultActionTrait; use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\User; use Symfony\UX\LiveComponent\Tests\Fixtures\Form\UserFormType; #[AsLiveComponent('form_with_user_interface', template: 'components/form_with_user_interface.html.twig')] class FormWithUserInterfaceComponent extends AbstractController { use ComponentWithFormTrait; use DefaultActionTrait; #[LiveProp] public User $user; protected function instantiateForm(): FormInterface { return $this->createForm(UserFormType::class, $this->user); } }

Dumping $propMetadata in \Symfony\UX\LiveComponent\LiveComponentHydrator::dehydrateValue gives:

Symfony\UX\LiveComponent\Metadata\LivePropMetadata {#240 -name: "user" -liveProp: Symfony\UX\LiveComponent\Attribute\LiveProp {#230 -writable: false -hydrateWith: null -dehydrateWith: null -useSerializerForHydration: false -serializationContext: [] -fieldName: null -format: null -updateFromParent: false -onUpdated: null -url: false -modifier: null } -type: Symfony\Component\TypeInfo\Type\NullableType {#4197 -types: array:2 [ 0 => Symfony\Component\TypeInfo\Type\ObjectType {#5811 -className: "Symfony\Component\Security\Core\User\UserInterface" } 1 => Symfony\Component\TypeInfo\Type\BuiltinType {#4208 -typeIdentifier: Symfony\Component\TypeInfo\TypeIdentifier {#5983 +name: "NULL" +value: "null" } } ] -type: Symfony\Component\TypeInfo\Type\ObjectType {#5811} } } 

The class name is the UserInterface and not User 🤔

To tests it

• With PropertyInfo only: sfcp req symfony/property-info:^6.4 -W && sfp vendor/bin/simple-phpunit tests/Functional/Form/ComponentWithFormTest.php --filter "testFormWithLivePropContainingAnEntityImplementingAnInterface"
• With PropertyInfo & Type: sfcp req 'symfony/property-info:7.2.*' 'symfony/type-info:7.2.*' && sfp vendor/bin/simple-phpunit tests/Functional/Form/ComponentWithFormTest.php --filter "testFormWithLivePropContainingAnEntityImplementingAnInterface"

[Kocal]

After some investigations, it happens because of PhpStanExtractor from Symfony PropertyInfo.

When trying to resolve the type of FormWithUserInterfaceComponent::$user, it will instead resolve the type of AbstractController::getUser() which returns ?UserInterface.

[Kocal]

After more investigations, I don't think it's related to PropertyInfo itself (PropertyInfo 6.4 also returns type for AbstractController::getUser()) but because of the extra logic that use the native ReflectionType if possible:

[Kocal]

Should not happens since PropertyTypeInfoExtractor::getType() exists since 7.1, which also ship TypeInfo, but just in case..

[Kocal]

I'm really not sure about this code, it feels fragile.

I tried to re-use the legacy logic and use ReflectionType or the result of PropertyTypeExtractorInterface::getType(), and now all tests pass, even the one added in this PR (which was previously breaking)

[Kocal]

I've added some comments to improve comprehensibility.

Since the PR fixed the issue from issue's author (#2888 (comment)), and no tests are failing (either when using PropertyTypeExtractorInterface::getTypes() or PropertyTypeExtractorInterface::getType()), I'm merging.

Thanks both of you :)