bug #951 [Turbo] Fixing a bug where saving a proxy would not trigger Broadcasts (weaverryan)

This PR was squashed before being merged into the 2.x branch.

Discussion
----------

[Turbo] Fixing a bug where saving a proxy would not trigger Broadcasts

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | no
| Tickets       | None
| License       | MIT

If the object you're updating, for example, happens to be wrapped in a Proxy object, then `BroadcastListener` would fail to find the `#[Broadcast]` attribute and no broadcasting would happen.

Cheers!

Commits
-------

df20b2b [Turbo] Fixing a bug where saving a proxy would not trigger Broadcasts

Author: weaverryan

src/Turbo/src/Bridge/Mercure/Broadcaster.php

@@ -11,9 +11,11 @@
 
 namespace Symfony\UX\Turbo\Bridge\Mercure;
 
+use Doctrine\Common\Util\ClassUtils;
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 use Symfony\Component\Mercure\HubInterface;
 use Symfony\Component\Mercure\Update;
+use Symfony\Component\VarExporter\LazyObjectInterface;
 use Symfony\UX\Turbo\Broadcaster\BroadcasterInterface;
 
 /**
@@ -61,7 +63,14 @@ public function broadcast(object $entity, string $action, array $options): void
             return;
         }
 
-        $entityClass = $entity::class;
+        if ($entity instanceof LazyObjectInterface) {
+            $entityClass = get_parent_class($entity);
+            if (false === $entityClass) {
+                throw new \LogicException('Parent class missing');
+            }
+        } else {
+            $entityClass = ClassUtils::getClass($entity);
+        }
 
         if (!isset($options['rendered_action'])) {
             throw new \InvalidArgumentException(sprintf('Cannot broadcast entity of class "%s" as option "rendered_action" is missing.', $entityClass));

src/Turbo/src/Broadcaster/TwigBroadcaster.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\UX\Turbo\Broadcaster;
 
+use Doctrine\Common\Util\ClassUtils;
+use Symfony\Component\VarExporter\LazyObjectInterface;
 use Twig\Environment;
 
 /**
@@ -42,8 +44,18 @@ public function broadcast(object $entity, string $action, array $options): void
             $options['id'] = $id;
         }
 
+        // handle proxies (both styles)
+        if ($entity instanceof LazyObjectInterface) {
+            $class = get_parent_class($entity);
+            if (false === $class) {
+                throw new \LogicException('Parent class missing');
+            }
+        } else {
+            $class = ClassUtils::getClass($entity);
+        }
+
         if (null === $template = $options['template'] ?? null) {
-            $template = $entity::class;
+            $template = $class;
             foreach ($this->templatePrefixes as $namespace => $prefix) {
                 if (str_starts_with($template, $namespace)) {
                     $template = substr_replace($template, $prefix, 0, \strlen($namespace));

src/Turbo/src/Doctrine/BroadcastListener.php

@@ -13,9 +13,11 @@
 
 use Doctrine\Common\Annotations\Reader;
 use Doctrine\Common\EventArgs;
+use Doctrine\Common\Util\ClassUtils;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Event\OnFlushEventArgs;
 use Doctrine\ORM\Event\PostFlushEventArgs;
+use Symfony\Component\VarExporter\LazyObjectInterface;
 use Symfony\Contracts\Service\ResetInterface;
 use Symfony\UX\Turbo\Attribute\Broadcast;
 use Symfony\UX\Turbo\Broadcaster\BroadcasterInterface;
@@ -126,7 +128,15 @@ public function reset(): void
 
     private function storeEntitiesToPublish(EntityManagerInterface $em, object $entity, string $property): void
     {
-        $class = $entity::class;
+        // handle proxies (both styles)
+        if ($entity instanceof LazyObjectInterface) {
+            $class = get_parent_class($entity);
+            if (false === $class) {
+                throw new \LogicException('Parent class missing');
+            }
+        } else {
+            $class = ClassUtils::getClass($entity);
+        }
 
         if (!isset($this->broadcastedClasses[$class])) {
             $this->broadcastedClasses[$class] = [];

src/Turbo/tests/BroadcastTest.php

@@ -33,7 +33,7 @@ protected function setUp(): void
         parent::setUp();
     }
 
-    public function testBroadcast(): void
+    public function testBroadcastBasic(): void
     {
         ($client = self::createPantherClient())->request('GET', '/books');
 
@@ -88,4 +88,20 @@ public function testExpressionLanguageBroadcast(): void
             'Artist 2 shows a song that does not belong to them'
         );
     }
+
+    public function testBroadcastWithProxy(): void
+    {
+        // testing that Artist is updated, even though it's saved as Proxy
+        ($client = self::createPantherClient())->request('GET', '/artistFromSong');
+
+        // submit first time to create the artist
+        $client->submitForm('Submit');
+        $this->assertSelectorWillContain('#artists', 'testing artist');
+
+        // submit again to update the artist
+        $client->submitForm('Submit');
+        $this->assertSelectorWillContain('#artists', 'testing artist after change');
+        // this part is from the stream template
+        $this->assertSelectorWillContain('#artists', ', updated)');
+    }
 }

src/Turbo/tests/app/Kernel.php

@@ -33,7 +33,6 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\HttpKernel\Kernel as BaseKernel;
-use Symfony\Component\Mercure\Hub;
 use Symfony\Component\Mercure\HubInterface;
 use Symfony\Component\Mercure\Update;
 use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
@@ -117,8 +116,6 @@ protected function configureContainer(ContainerConfigurator $container): void
                 ],
             ],
         ]);
-
-        $container->services()->alias(Hub::class, 'mercure.hub.default'); // FIXME: temporary fix for a bug in https://github.com/symfony/mercure-bundle/pull/42
     }
 
     protected function configureRoutes(RoutingConfigurator $routes): void
@@ -135,6 +132,7 @@ protected function configureRoutes(RoutingConfigurator $routes): void
         $routes->add('songs', '/songs')->controller('kernel::songs');
         $routes->add('artists', '/artists')->controller('kernel::artists');
         $routes->add('artist', '/artists/{id}')->controller('kernel::artist');
+        $routes->add('artist_from_song', '/artistFromSong')->controller('kernel::artistFromSong');
     }
 
     public function getProjectDir(): string
@@ -265,4 +263,42 @@ public function artist(Request $request, EntityManagerInterface $doctrine, Envir
 
         return new Response($twig->render('artist.html.twig', ['artist' => $artist]));
     }
+
+    public function artistFromSong(Request $request, EntityManagerInterface $doctrine, Environment $twig): Response
+    {
+        $song = null;
+        if ($request->isMethod('POST')) {
+            // on first post, create the objects
+            // on second, update the artist
+            $id = $request->get('id');
+            if (!$id) {
+                $artist = new Artist();
+                $artist->name = 'testing artist';
+
+                $song = new Song();
+                $song->artist = $artist;
+                $song->title = 'testing song title';
+
+                $doctrine->persist($artist);
+                $doctrine->persist($song);
+                $doctrine->flush();
+            } else {
+                $song = $doctrine->find(Song::class, $id);
+                if (!$song) {
+                    throw new NotFoundHttpException();
+                }
+                $artist = $song->artist;
+                if (!$artist) {
+                    throw new NotFoundHttpException();
+                }
+                $artist->name = $artist->name.' after change';
+
+                $doctrine->flush();
+            }
+        }
+
+        return new Response($twig->render('artist_from_song.html.twig', [
+            'song' => $song,
+        ]));
+    }
 }

src/Turbo/tests/app/templates/artist_from_song.html.twig

@@ -0,0 +1,14 @@
+{% extends 'base.html.twig' %}
+
+{% block body %}
+    <h1>Update Artist Via Song</h1>
+
+    <div id="artists" {{ turbo_stream_listen('App\\Entity\\Artist') }}></div>
+
+    <turbo-frame id="api">
+        <form method="post" enctype="application/x-www-form-urlencoded">
+            <input name="id" value="{{ song ? song.id }}">
+            <button>Submit</button>
+        </form>
+    </turbo-frame>
+{% endblock %}