[LiveComponent] Test helper doesn't work with localized components

[javiereguiluz]

If your live components are localized as explained in https://symfony.com/bundles/ux-live-component/current/index.html#installation:

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

You can't use the test helper (https://symfony.com/bundles/ux-live-component/current/index.html#test-helper) because you'll see this error:

Symfony\Component\Routing\Exception\MissingMandatoryParametersException:
Some mandatory parameters are missing ("_locale") to generate a URL for route "ux_live_component".

The arguments used to generate the URL seem hardcoded, so I don't know how to solve this:

ux/src/LiveComponent/src/Test/TestLiveComponent.php

Lines 132 to 138 in 1a4f208

	$this->router->generate(
	$this->metadata->get('route'),
	array_filter([
	'_live_component' => $this->metadata->getName(),
	'_live_action' => $action,
	])
	),

Thanks!

[kbond]

Thanks for reporting, thinking the following as a fix:

$testComponent = $this->createLiveComponent(
    name: 'MyComponent', // can also use FQCN (MyComponent::class)
    data: ['foo' => 'bar'],
    routeParams: ['_locale' => 'fr'],
);

WDYT?

[javiereguiluz]

Yes, I think that adding a routeParams options would be a nice solution. Thanks!

[smnandre]

I'm thinking outloud there but could this be done automatically depending on the current locale ?

[kbond]

Indeed, I think it would safe to always add ['_locale' => \Locale:getDefault()]. We should still probably have the routeParams option to easily override without setting global state in your test.

[carsonbot]

Thank you for this issue.
There has not been a lot of activity here for a while. Has this been resolved?

[javiereguiluz]

@carsonbot no, it's still pending. Don't close it. Thanks.

[smnandre]

Hi @javier, there may be an even easier method (and more integrated in the framework)

Could you hard-code this new method in the src/Test/TestLiveComponent.php file

public function setLocale(?string $locale): self
{
    $this->router->getContext()->setParameter('_locale', $locale);
}

And where you run your test, call it like this

$testComponent = $this->createLiveComponent( ... ) 
$testComponent->setLocale('es');

// the rest of your test

Tell me if this works for you, and i'll implement it / test it :)

[javiereguiluz]

@smnandre I just tested your code and it worked beautifully 😍 Thanks!

I just had to change this line:

     // vendor/symfony/ux-live-component/src/Test/TestLiveComponent.php
     public function setLocale(?string $locale): self
     {
         $this->router->getContext()->setParameter('_locale', $locale);
+
+        return $this;
     }

[smnandre]

Oh yes, this is a mistake, thanks!

I'll open the PR later tonight :)