Skip to content

Use TypeInfo types if available #1862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Use TypeInfo types if available #1862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions src/LiveComponent/src/LiveComponentHydrator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;
use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
use Symfony\Component\PropertyInfo\Type;
use Symfony\Component\PropertyInfo\Type as LegacyType;
use Symfony\Component\Serializer\Exception\ExceptionInterface as SerializerExceptionInterface;
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\TypeInfo\Type\BuiltinType;
use Symfony\Component\TypeInfo\Type\ObjectType;
use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
use Symfony\UX\LiveComponent\Attribute\LiveProp;
use Symfony\UX\LiveComponent\Exception\HydrationException;
Expand Down Expand Up @@ -245,6 +247,7 @@ public function hydrateValue(mixed $value, LivePropMetadata $propMetadata, objec
return $parentObject->{$propMetadata->hydrateMethod()}($value);
}

$collectionValueType = $propMetadata->collectionValueType();
if ($propMetadata->useSerializerForHydration()) {
if (!interface_exists(DenormalizerInterface::class)) {
throw new \LogicException(sprintf('The LiveProp "%s" on component "%s" has "useSerializerForHydration: true", but the Serializer component is not installed. Try running "composer require symfony/serializer".', $propMetadata->getName(), $parentObject::class));
Expand All @@ -256,10 +259,12 @@ public function hydrateValue(mixed $value, LivePropMetadata $propMetadata, objec
throw new \LogicException(sprintf('The LiveProp "%s" on component "%s" has "useSerializerForHydration: true", but the given serializer does not implement DenormalizerInterface.', $propMetadata->getName(), $parentObject::class));
}

if ($propMetadata->collectionValueType()) {
$builtInType = $propMetadata->collectionValueType()->getBuiltinType();
if (Type::BUILTIN_TYPE_OBJECT === $builtInType) {
$type = $propMetadata->collectionValueType()->getClassName().'[]';
if ($collectionValueType instanceof BuiltinType || $collectionValueType instanceof ObjectType) {
$type = $collectionValueType->asNonNullable().'[]';
} elseif ($collectionValueType instanceof LegacyType) {
$builtInType = $collectionValueType->getBuiltinType();
if (LegacyType::BUILTIN_TYPE_OBJECT === $builtInType) {
$type = $collectionValueType->getClassName().'[]';
} else {
$type = $builtInType.'[]';
}
Expand All @@ -274,8 +279,10 @@ public function hydrateValue(mixed $value, LivePropMetadata $propMetadata, objec
return $this->serializer->denormalize($value, $type, 'json', $propMetadata->serializationContext());
}

if ($propMetadata->collectionValueType() && Type::BUILTIN_TYPE_OBJECT === $propMetadata->collectionValueType()->getBuiltinType()) {
$collectionClass = $propMetadata->collectionValueType()->getClassName();
if ($collectionValueType instanceof ObjectType
|| $collectionValueType instanceof LegacyType && LegacyType::BUILTIN_TYPE_OBJECT === $collectionValueType->getBuiltinType()
) {
$collectionClass = $collectionValueType->getClassName();
foreach ($value as $key => $objectItem) {
$value[$key] = $this->hydrateObjectValue($objectItem, $collectionClass, true, $propMetadata->getFormat(), $parentObject::class, sprintf('%s.%s', $propMetadata->getName(), $key), $parentObject);
}
Expand Down Expand Up @@ -448,8 +455,11 @@ private function dehydrateValue(mixed $value, LivePropMetadata $propMetadata, ob
}

if (\is_array($value)) {
if ($propMetadata->collectionValueType() && Type::BUILTIN_TYPE_OBJECT === $propMetadata->collectionValueType()->getBuiltinType()) {
$collectionClass = $propMetadata->collectionValueType()->getClassName();
$collectionValueType = $propMetadata->collectionValueType();
if ($collectionValueType instanceof ObjectType
|| $collectionValueType instanceof LegacyType && LegacyType::BUILTIN_TYPE_OBJECT === $collectionValueType->getBuiltinType()
) {
$collectionClass = $collectionValueType->getClassName();
foreach ($value as $key => $objectItem) {
if (!$objectItem instanceof $collectionClass) {
throw new \LogicException(sprintf('The LiveProp "%s" on component "%s" is an array. We determined the array is full of %s objects, but at least on key had a different value of %s', $propMetadata->getName(), $parentObject::class, $collectionClass, get_debug_type($objectItem)));
Expand Down
54 changes: 37 additions & 17 deletions src/LiveComponent/src/Metadata/LiveComponentMetadataFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@
namespace Symfony\UX\LiveComponent\Metadata;

use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
use Symfony\Component\PropertyInfo\Type;
use Symfony\Component\PropertyInfo\Type as LegacyType;
use Symfony\Component\TypeInfo\Type\BuiltinType;
use Symfony\Component\TypeInfo\Type\CollectionType;
use Symfony\Component\TypeInfo\Type\IntersectionType;
use Symfony\Component\TypeInfo\Type\UnionType;
use Symfony\Contracts\Service\ResetInterface;
use Symfony\UX\LiveComponent\Attribute\LiveProp;
use Symfony\UX\TwigComponent\ComponentFactory;
Expand Down Expand Up @@ -79,26 +83,42 @@ public function createLivePropMetadata(string $className, string $propertyName,
throw new \LogicException(sprintf('Union or intersection types are not supported for LiveProps. You may want to change the type of property %s in %s.', $property->getName(), $property->getDeclaringClass()->getName()));
}

$infoTypes = $this->propertyTypeExtractor->getTypes($className, $propertyName) ?? [];
if (method_exists($this->propertyTypeExtractor, 'getType')) {
$infoType = $this->propertyTypeExtractor->getType($className, $propertyName);
$isTypeBuiltIn = $type?->isBuiltin() ?? ($infoType instanceof BuiltinType);
$isTypeNullable = $type?->allowsNull() ?? $infoType?->isNullable() ?? true;

$collectionValueType = null;
foreach ($infoTypes as $infoType) {
if ($infoType->isCollection()) {
foreach ($infoType->getCollectionValueTypes() as $valueType) {
$collectionValueType = $valueType;
break;
$infoType = $infoType?->asNonNullable();

$collectionValueType = null;
if ($infoType instanceof CollectionType) {
$collectionValueType = $infoType->getCollectionValueType()->asNonNullable();
if ($collectionValueType instanceof UnionType || $collectionValueType instanceof IntersectionType) {
[$collectionValueType] = $collectionValueType->getTypes();
}
}
}

if (null === $type && null === $collectionValueType && isset($infoTypes[0])) {
$infoType = Type::BUILTIN_TYPE_OBJECT === $infoTypes[0]->getBuiltinType() ? $infoTypes[0]->getClassName() : $infoTypes[0]->getBuiltinType();
$isTypeBuiltIn = null === $infoTypes[0]->getClassName();
$isTypeNullable = $infoTypes[0]->isNullable();
} else {
$infoType = $type?->getName();
$isTypeBuiltIn = $type?->isBuiltin() ?? false;
$isTypeNullable = $type?->allowsNull() ?? true;
$infoTypes = $this->propertyTypeExtractor->getTypes($className, $propertyName) ?? [];

$collectionValueType = null;
foreach ($infoTypes as $infoType) {
if ($infoType->isCollection()) {
foreach ($infoType->getCollectionValueTypes() as $valueType) {
$collectionValueType = $valueType;
break;
}
}
}

if (null === $type && null === $collectionValueType && isset($infoTypes[0])) {
$infoType = LegacyType::BUILTIN_TYPE_OBJECT === $infoTypes[0]->getBuiltinType() ? $infoTypes[0]->getClassName() : $infoTypes[0]->getBuiltinType();
$isTypeBuiltIn = null === $infoTypes[0]->getClassName();
$isTypeNullable = $infoTypes[0]->isNullable();
} else {
$infoType = $type?->getName();
$isTypeBuiltIn = $type?->isBuiltin() ?? false;
$isTypeNullable = $type?->allowsNull() ?? true;
}
}

return new LivePropMetadata(
Expand Down
7 changes: 4 additions & 3 deletions src/LiveComponent/src/Metadata/LivePropMetadata.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@

namespace Symfony\UX\LiveComponent\Metadata;

use Symfony\Component\PropertyInfo\Type;
use Symfony\Component\PropertyInfo\Type as LegacyType;
use Symfony\Component\TypeInfo\Type;
use Symfony\UX\LiveComponent\Attribute\LiveProp;

/**
Expand All @@ -27,7 +28,7 @@ public function __construct(
private ?string $typeName,
private bool $isBuiltIn,
private bool $allowsNull,
private ?Type $collectionValueType,
private Type|LegacyType|null $collectionValueType,
) {
}

Expand Down Expand Up @@ -99,7 +100,7 @@ public function serializationContext(): array
return $this->liveProp->serializationContext();
}

public function collectionValueType(): ?Type
public function collectionValueType(): Type|LegacyType|null
{
return $this->collectionValueType;
}
Expand Down