feature #2124 [LiveComponent] Add setRouteLocale in TestLiveComponent (smnandre)

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

Discussion
----------

[LiveComponent] Add `setRouteLocale` in `TestLiveComponent`

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| Issues        | Fix #1565
| License       | MIT

The `live_component` route can be localized. It then requires the `{_locale}` the parameter to be defined.

```diff
# config/routes/ux_live_component.yaml
  live_component:
      resource: '`@LiveComponentBundle`/config/routes.php'
-     prefix: /_components
+     prefix: /{_locale}/_components
```

This PR adds a `setRouteLocale` method in `TestLiveComponent` to help in this situation.

```php
$testComponent = $this->createLiveComponent('Acme:Foo');
$testComponent->setRouteLocale('de');

// $testComponent is rendered with the 'de' locale
```

Thank you `@javiereguiluz` for the idea and your help :)

Commits
-------

2f00e3f [LiveComponent] Add `setRouteLocale` in `TestLiveComponent`

Author: javiereguiluz

src/LiveComponent/doc/index.rst

@@ -3718,6 +3718,9 @@ uses Symfony's test client to render and make requests to your components::
             // authenticate a user ($user is instance of UserInterface)
             $testComponent->actingAs($user);
 
+            // set the '_locale' route parameter (if the component route is localized)  
+            $testComponent->setRouteLocale('fr');
+
             // customize the test client
             $client = self::getContainer()->get('test.client');
 

src/LiveComponent/src/Test/TestLiveComponent.php

@@ -31,6 +31,8 @@ final class TestLiveComponent
 {
     private bool $performedInitialRequest = false;
 
+    private ?string $locale = null;
+
     /**
      * @internal
      */
@@ -132,6 +134,17 @@ public function submitForm(array $formValues, ?string $action = null): self
         return $this->request(['updated' => $flattenValues, 'validatedFields' => array_keys($flattenValues)], $action);
     }
 
+    /**
+     * @experimental
+     */
+    public function setRouteLocale(string $locale): self
+    {
+        $this->performedInitialRequest = false;
+        $this->locale = $locale;
+
+        return $this;
+    }
+
     private function request(array $content = [], ?string $action = null, array $files = []): self
     {
         $csrfToken = $this->csrfToken();
@@ -143,7 +156,8 @@ private function request(array $content = [], ?string $action = null, array $fil
                 array_filter([
                     '_live_component' => $this->metadata->getName(),
                     '_live_action' => $action,
-                ])
+                    '_locale' => $this->locale,
+                ], static fn (mixed $v): bool => null !== $v),
             ),
             parameters: ['data' => json_encode(array_merge($content, ['props' => $this->props()]))],
             files: $files,
@@ -191,20 +205,22 @@ private function client(): KernelBrowser
         if ('POST' === strtoupper($this->metadata->get('method'))) {
             $this->client->request(
                 'POST',
-                $this->router->generate($this->metadata->get('route'), [
+                $this->router->generate($this->metadata->get('route'), array_filter([
                     '_live_component' => $this->metadata->getName(),
-                ]),
+                    '_locale' => $this->locale,
+                ], static fn (mixed $v): bool => null !== $v)),
                 [
                     'data' => json_encode(['props' => $props->getProps()], flags: \JSON_THROW_ON_ERROR),
                 ],
             );
         } else {
             $this->client->request('GET', $this->router->generate(
                 $this->metadata->get('route'),
-                [
+                array_filter([
                     '_live_component' => $this->metadata->getName(),
+                    '_locale' => $this->locale,
                     'props' => json_encode($props->getProps(), flags: \JSON_THROW_ON_ERROR),
-                ]
+                ], static fn (mixed $v): bool => null !== $v),
             ));
         }
 

src/LiveComponent/tests/Fixtures/Component/LocalizedRoute.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Symfony\UX\LiveComponent\Tests\Fixtures\Component;
+
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
+use Symfony\UX\LiveComponent\DefaultActionTrait;
+
+/**
+ * @author Simon André
+ */
+#[AsLiveComponent('localized_route', route: 'localized_route')]
+final class LocalizedRoute
+{
+    use DefaultActionTrait;
+}

src/LiveComponent/tests/Fixtures/Kernel.php

@@ -214,5 +214,6 @@ protected function configureRoutes(RoutingConfigurator $routes): void
         $routes->add('render_namespaced_template', '/render-namespaced-template/{template}')->controller('kernel::renderNamespacedTemplate');
         $routes->add('homepage', '/')->controller('kernel::index');
         $routes->add('alternate_live_route', '/alt/{_live_component}/{_live_action}')->defaults(['_live_action' => 'get']);
+        $routes->add('localized_route', '/locale/{_locale}/{_live_component}/{_live_action}')->defaults(['_live_action' => 'get']);
     }
 }

src/LiveComponent/tests/Fixtures/templates/components/localized_route.html.twig

@@ -0,0 +1,3 @@
+<div{{ attributes }}>
+    Localized route <em>Locale: {{ app.request.locale }}</em>
+</div>

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

@@ -194,4 +194,21 @@ public function testAccessAllLivePropsInsideOnUpdatedHook(): void
 
         $this->assertStringContainsString('Total: 9', $testComponent->render());
     }
+
+    public function testSetLocaleRenderLocalizedComponent(): void
+    {
+        $testComponent = $this->createLiveComponent('localized_route');
+        $testComponent->setRouteLocale('fr');
+        $this->assertStringContainsString('Locale: fr', $testComponent->render());
+
+        $testComponent->refresh();
+        $this->assertStringContainsString('Locale: fr', $testComponent->render());
+
+        $testComponent->setRouteLocale('es');
+        $this->assertStringContainsString('Locale: es', $testComponent->render());
+
+        $testComponent = $this->createLiveComponent('localized_route');
+        $testComponent->setRouteLocale('de');
+        $this->assertStringContainsString('Locale: de', $testComponent->render());
+    }
 }