Updating hydrator

Making tests

Author: pink6440

src/LiveComponent/src/Hydration/DoctrineEntityHydrationExtension.php

@@ -14,6 +14,7 @@
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\Persistence\ManagerRegistry;
 use Doctrine\Persistence\ObjectManager;
+use Doctrine\Persistence\Mapping\MappingException;
 
 /**
  * Handles hydration of Doctrine entities.
@@ -27,7 +28,8 @@ class DoctrineEntityHydrationExtension implements HydrationExtensionInterface
      */
     public function __construct(
         private iterable $managerRegistries,
-    ) {
+    )
+    {
     }
 
     public function supports(string $className): bool
@@ -61,11 +63,10 @@ public function dehydrate(object $object): mixed
         $id = $this
             ->objectManagerFor($class = $object::class)
             ->getClassMetadata($class)
-            ->getIdentifierValues($object)
-        ;
+            ->getIdentifierValues($object);
 
         // Dehydrate ID values in case they are other entities
-        $id = array_map(fn ($id) => \is_object($id) && $this->supports($id::class) ? $this->dehydrate($id) : $id, $id);
+        $id = array_map(fn($id) => \is_object($id) && $this->supports($id::class) ? $this->dehydrate($id) : $id, $id);
 
         switch (\count($id)) {
             case 0:
@@ -81,21 +82,34 @@ public function dehydrate(object $object): mixed
 
     private function objectManagerFor(string $class): ?ObjectManager
     {
-        if (!interface_exist($class) && !class_exists($class)) {
+        if (!interface_exists($class) && !class_exists($class)) {
             return null;
         }
 
         // todo cache/warmup an array of classes that are "doctrine objects"
         foreach ($this->managerRegistries as $registry) {
-             foreach($registry->getManagers() as $om) {
-                // this way, it resolves the interface
-                if ($om->getClassMetadata($class)) {
-                    return self::ensureManagedObject($om, $class);
-                }
-            }
+
+            // The doctrine registry does not resolve aliased interface
             // if ($om = $registry->getManagerForClass($class)) {
             //    return self::ensureManagedObject($om, $class);
             // }
+
+            foreach ($registry->getManagers() as $om) {
+                // But we can resolve nicely by trying to ask each manager to get the metadata
+                try {
+                    if ($om->getClassMetadata($class) !== null) {
+                        return self::ensureManagedObject($om, $class);
+                    }
+
+                } catch (MappingException $e) {
+                    // I did not find a nice way to check if it is because the class is really unknown
+                    // It is good to check for a specific exception ?
+                    // eg: \Doctrine\Persistence\Mapping\MappingException
+                    // Maybe not needed, because it does not failed even when the class does not exist at all
+                    throw $e;
+                }
+
+            }
         }
 
         return null;

src/LiveComponent/tests/Fixtures/Dto/Aliased.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Symfony\UX\LiveComponent\Tests\Fixtures\Dto;
+
+class Aliased
+{
+//    public string $address;
+    public string $name;
+}

src/LiveComponent/tests/Fixtures/Entity/AliasedEntity.php

@@ -0,0 +1,27 @@
+<?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.
+ */
+
+namespace Symfony\UX\LiveComponent\Tests\Fixtures\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Doctrine\ORM\Mapping\Column;
+
+#[ORM\Entity]
+class AliasedEntity implements AliasedEntityInterface
+{
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column(type: 'integer')]
+    public $id;
+
+    #[Column(type: 'string')]
+    public ?string $name = null;
+}

src/LiveComponent/tests/Fixtures/Entity/AliasedEntityInterface.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Symfony\UX\LiveComponent\Tests\Fixtures\Entity;
+
+interface AliasedEntityInterface {
+
+}

src/LiveComponent/tests/Fixtures/Kernel.php

@@ -29,6 +29,8 @@
 use Symfony\Component\Security\Core\User\InMemoryUser;
 use Symfony\UX\LiveComponent\LiveComponentBundle;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Component\Component1;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\AliasedEntity;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\AliasedEntityInterface;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Serializer\Entity2Normalizer;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Serializer\MoneyNormalizer;
 use Symfony\UX\StimulusBundle\StimulusBundle;
@@ -170,6 +172,8 @@ protected function configureContainer(ContainerConfigurator $c): void
                         'alias' => 'XML',
                     ],
                 ],
+                'resolve_target_entities' => [
+                    AliasedEntityInterface::class => AliasedEntity::class],
             ],
         ];
 

src/LiveComponent/tests/Integration/Hydration/DoctrineEntityHydrationExtensionTest.php

@@ -11,8 +11,15 @@
 
 namespace Symfony\UX\LiveComponent\Tests\Integration\Hydration;
 
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Tools\ResolveTargetEntityListener;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Contracts\Service\Attribute\Required;
 use Symfony\UX\LiveComponent\Hydration\DoctrineEntityHydrationExtension;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\AliasedEntity;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\AliasedEntityInterface;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\CompositeIdEntity;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\ForeignKeyIdEntity;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Factory\CompositeIdEntityFactory;
@@ -50,4 +57,37 @@ public function testForeignKeyId(): void
         self::assertSame($foreignKeyIdEntity->id->id, $dehydrated);
         self::assertSame($foreignKeyIdEntity, $extension->hydrate($dehydrated, ForeignKeyIdEntity::class));
     }
+
+
+    public function testSupportInterface(): void
+    {
+        /** @var DoctrineEntityHydrationExtension $extension */
+        $extension = self::getContainer()->get('ux.live_component.doctrine_entity_hydration_extension');
+
+        self::assertTrue($extension->supports(AliasedEntityInterface::class),"AliasedEntityInterface should be supported");
+        self::assertTrue($extension->supports(AliasedEntity::class),"AliasedEntity should be supported");
+        self::assertFalse($extension->supports('UnknownClass'),"UnknownClass should not be supported");
+    }
+
+    public function testHydrationFromInterface(): void
+    {
+        /** @var DoctrineEntityHydrationExtension $extension */
+        $extension = self::getContainer()->get('ux.live_component.doctrine_entity_hydration_extension');
+        $em = self::getContainer()->get(EntityManagerInterface::class);
+
+        $a = new AliasedEntity();
+        $a->name = 'foo';
+
+        $em->persist($a);
+        $em->flush();
+
+        $dehydratedData = $extension->dehydrate($a);
+
+        $a2 = $extension->hydrate($dehydratedData, AliasedEntityInterface::class);
+
+        self::assertSame($a, $a2,"instance should be the same");
+        self::assertNull($extension->hydrate(null, AliasedEntityInterface::class),"should return null if null is passed");
+
+
+    }
 }