feat(live): improve TestLiveComponent::actingAs()

Author: kbond

src/LiveComponent/src/Test/TestLiveComponent.php

@@ -28,48 +28,22 @@
  */
 final class TestLiveComponent
 {
+    private bool $performedInitialRequest = false;
+
     /**
      * @internal
      */
     public function __construct(
         private ComponentMetadata $metadata,
-        array $data,
+        private array $data,
         private ComponentFactory $factory,
         private KernelBrowser $client,
         private LiveComponentHydrator $hydrator,
         private LiveComponentMetadataFactory $metadataFactory,
         private UrlGeneratorInterface $router,
     ) {
         $this->client->catchExceptions(false);
-
-        $data['attributes']['id'] ??= 'in-a-real-scenario-it-would-already-have-one---provide-one-yourself-if-needed';
-
-        $mounted = $this->factory->create($this->metadata->getName(), $data);
-        $props = $this->hydrator->dehydrate(
-            $mounted->getComponent(),
-            $mounted->getAttributes(),
-            $this->metadataFactory->getMetadata($mounted->getName())
-        );
-
-        if ('POST' === strtoupper($this->metadata->get('method'))) {
-            $this->client->request(
-                'POST',
-                $this->router->generate($this->metadata->get('route'), [
-                    '_live_component' => $this->metadata->getName(),
-                ]),
-                [
-                    'data' => json_encode(['props' => $props->getProps()], flags: \JSON_THROW_ON_ERROR),
-                ],
-            );
-        } else {
-            $this->client->request('GET', $this->router->generate(
-                $this->metadata->get('route'),
-                [
-                    '_live_component' => $this->metadata->getName(),
-                    'props' => json_encode($props->getProps(), flags: \JSON_THROW_ON_ERROR),
-                ]
-            ));
-        }
+        $this->data['attributes']['data-live-id'] ??= 'in-a-real-scenario-it-would-already-have-one---provide-one-yourself-if-needed';
     }
 
     public function render(): RenderedComponent
@@ -95,6 +69,7 @@ public function component(): object
      */
     public function actingAs(object $user, string $firewallContext = 'main'): self
     {
+        // we call loginUser() on the raw client in case the entire component requires authentication
         $this->client->loginUser($user, $firewallContext);
 
         return $this;
@@ -145,14 +120,14 @@ public function refresh(): self
 
     public function response(): Response
     {
-        return $this->client->getResponse();
+        return $this->client()->getResponse();
     }
 
     private function request(array $content = [], ?string $action = null): self
     {
         $csrfToken = $this->csrfToken();
 
-        $this->client->request(
+        $this->client()->request(
             'POST',
             $this->router->generate(
                 $this->metadata->get('route'),
@@ -170,7 +145,7 @@ private function request(array $content = [], ?string $action = null): self
 
     private function props(): array
     {
-        $crawler = $this->client->getCrawler();
+        $crawler = $this->client()->getCrawler();
 
         if (!\count($node = $crawler->filter('[data-live-props-value]'))) {
             throw new \LogicException('A live component action has redirected and you can no longer access the component.');
@@ -181,12 +156,50 @@ private function props(): array
 
     private function csrfToken(): ?string
     {
-        $crawler = $this->client->getCrawler();
+        $crawler = $this->client()->getCrawler();
 
         if (!\count($node = $crawler->filter('[data-live-csrf-value]'))) {
             return null;
         }
 
         return $node->attr('data-live-csrf-value');
     }
+
+    private function client(): KernelBrowser
+    {
+        if ($this->performedInitialRequest) {
+            return $this->client;
+        }
+
+        $mounted = $this->factory->create($this->metadata->getName(), $this->data);
+        $props = $this->hydrator->dehydrate(
+            $mounted->getComponent(),
+            $mounted->getAttributes(),
+            $this->metadataFactory->getMetadata($mounted->getName())
+        );
+
+        if ('POST' === strtoupper($this->metadata->get('method'))) {
+            $this->client->request(
+                'POST',
+                $this->router->generate($this->metadata->get('route'), [
+                    '_live_component' => $this->metadata->getName(),
+                ]),
+                [
+                    'data' => json_encode(['props' => $props->getProps()], flags: \JSON_THROW_ON_ERROR),
+                ],
+            );
+        } else {
+            $this->client->request('GET', $this->router->generate(
+                $this->metadata->get('route'),
+                [
+                    '_live_component' => $this->metadata->getName(),
+                    'props' => json_encode($props->getProps(), flags: \JSON_THROW_ON_ERROR),
+                ]
+            ));
+        }
+
+        $this->performedInitialRequest = true;
+
+        return $this->client;
+    }
 }

src/LiveComponent/tests/Fixtures/Kernel.php

@@ -16,6 +16,7 @@
 use Psr\Log\NullLogger;
 use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
 use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
+use Symfony\Bundle\SecurityBundle\Security;
 use Symfony\Bundle\SecurityBundle\SecurityBundle;
 use Symfony\Bundle\TwigBundle\TwigBundle;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
@@ -118,13 +119,19 @@ protected function configureContainer(ContainerConfigurator $c): void
             'default_path' => '%kernel.project_dir%/tests/Fixtures/templates',
         ]);
 
-        $c->extension('security', [
+        $security = [
             'password_hashers' => [InMemoryUser::class => 'plaintext'],
             'providers' => ['users' => ['memory' => ['users' => ['kevin' => ['password' => 'pass', 'roles' => ['ROLE_USER']]]]]],
             'firewalls' => ['main' => [
                 'lazy' => true,
             ]],
-        ]);
+        ];
+
+        if (!class_exists(Security::class)) {
+            $security['enable_authenticator_manager'] = true;
+        }
+
+        $c->extension('security', $security);
 
         $c->extension('twig_component', [
             'defaults' => [

src/LiveComponent/tests/Functional/EventListener/LiveComponentSubscriberTest.php

@@ -15,6 +15,7 @@
 use Symfony\Component\DomCrawler\Crawler;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\Security\Core\User\InMemoryUser;
+use Symfony\Component\Security\Http\Attribute\IsGranted;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\Entity1;
 use Symfony\UX\LiveComponent\Tests\LiveComponentTestHelper;
 use Zenstruck\Browser\Test\HasBrowser;
@@ -504,6 +505,10 @@ public function testWithNullableEntity(): void
 
     public function testCanHaveControllerAttributes(): void
     {
+        if (!class_exists(IsGranted::class)) {
+            $this->markTestSkipped('The security attributes are not available.');
+        }
+
         $dehydrated = $this->dehydrateComponent($this->mountComponent('with_security'));
 
         $this->browser()

src/LiveComponent/tests/Functional/Test/InteractsWithLiveComponentsTest.php

@@ -12,6 +12,9 @@
 namespace Symfony\UX\LiveComponent\Tests\Functional\Test;
 
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\Security\Core\Exception\AccessDeniedException;
+use Symfony\Component\Security\Core\User\InMemoryUser;
+use Symfony\Component\Security\Http\Attribute\IsGranted;
 use Symfony\UX\LiveComponent\Test\InteractsWithLiveComponents;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Component\Component2;
 
@@ -140,4 +143,30 @@ public function testCannotUpdateComponentIfNoLongerInContext(): void
 
         $testComponent->call('increase');
     }
+
+    public function testRenderingIsLazy(): void
+    {
+        if (!class_exists(IsGranted::class)) {
+            $this->markTestSkipped('The security attributes are not available.');
+        }
+
+        $testComponent = $this->createLiveComponent('with_security');
+
+        $this->expectException(AccessDeniedException::class);
+
+        $testComponent->render();
+    }
+
+    public function testActingAs(): void
+    {
+        $testComponent = $this->createLiveComponent('with_security')
+            ->actingAs(new InMemoryUser('kevin', 'pass', ['ROLE_USER']))
+        ;
+
+        $this->assertStringNotContainsString('Username: kevin', $testComponent->render());
+
+        $testComponent->call('setUsername');
+
+        $this->assertStringContainsString('Username: kevin', $testComponent->render());
+    }
 }