[Autocomplete] Testing an autocomplete

[HiroKX]

Hello !

I'm currently testing an application that uses symfony/ux-autocomplete in a form and i'm facing an issue where i can't test my form because there is no possible values.

Do you have an idea of what i can do to test this field ?

PHPUnit : 9.6
Symfony : 6.4
UX-Autocomplete : 2.13.2

[norkunas]

Hey,

symfony/symfony#47642 should help if someone will care :D

[yceruto]

With Crawler you might need to add the <option value="..."> element first, e.g. using ChoiceFormField::addChoice($node) because there is a special check that validates the value option before setting it, simulating what happens in the browser via Javascript.

[norkunas]

@yceruto I've tried this but there is still a problem - it's impossible to add choice to single select element.

https://github.com/symfony/symfony/blob/0d9562ff6cdda11c71f0eb2bce0076f0d3a8ea9f/src/Symfony/Component/DomCrawler/Field/ChoiceFormField.php#L146-L148

so it's simulating a wrong behavior?

[HiroKX]

I've been through the same issue here and didn't find any solutions at that time...

[norkunas]

I found that ChoiceFormField has disableValidation method but it is internal.
Tried some hacks with Reflection to populate the option to it's option list and then setting value, but still form populates an error that value should not be blank while I explicitly set it..

[smnandre]

You do want a full application test ? Or an unit -- integration ? Can you share a bit of code ? There are as many ways to use those classes than there are developers..

[norkunas]

For sure an functional test

[yceruto]

It's really surprising that ChoiceFormField::addChoice() only work for multiple and radio choices... I don't get why this limitation and also why marked as internal when it's public and useful. I will check.

[smnandre]

If someone was inclined to create a mini reproducer that could help motivate people to digg into this with you

[HiroKX]

Hey guys!

I'm facing an issue with this test where I try to create a user from a form:

    public function testNew(): void
    {
        $this->client->loginUser($this->userRepository->findOneBy(['username' => 'admin']));
        $originalNumObjectsInRepository = $this->userRepository->count([]);
        $this->client->request('GET', $this->generateNewFormUrl());
        $this->client->submitForm('Create', [
            'User[username]' => 'Testing',
            'User[email]' => '[email protected]',
            'User[client][autocomplete]' => '1', //This field is the one facing the issue
            'User[password][first]' => 'test',
            'User[password][second]' => 'test',
        ]);
        self::assertResponseStatusCodeSame(302);
        self::assertSame($originalNumObjectsInRepository + 1, $this->userRepository->count([]));
   }

And I'm getting this error:
1) App\Tests\CrudController\UserCrudControllerTest::testNew InvalidArgumentException: Input "User[client][autocomplete]" cannot take "1" as a value (possible values: "").
Even if I'm passing an object or an id...

I'd like to add an option in my autocomplete field (maybe with ChoiceFormField::addChoice()) but I'm facing the LogicException...

[yceruto]

As temporal, ugly workaround, you can add the new options this way (this should be done before submitting the form):

\Closure::bind(function () {
    // add here the new options e.g.
    $this->options[] = ['value' => '1']; 
}, $field, ChoiceFormField::class)();

Being $field an instance of ChoiceFormField.

[simondaigre]

I also have the same issue. As a workaround, Instead of using submitForm(), I do POST requests and it works.

See https://github.com/symfony/ux/blob/2.x/src/Autocomplete/tests/Functional/AutocompleteFormRenderingTest.php for an example with zenstruck/browser.

[carsonbot]

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

[norkunas]

Not resolved

[carsonbot]

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

[bernard-ng]

Is there already an update of the documentation somewhere?

[bernard-ng]

If you're experiencing issues with submitForm in functional tests using Symfony's KernelBrowser, you can work around it by directly interacting with the form fields and submitting the form manually. Below is an example:

$form = $this->client->getCrawler()->selectButton('transaction_form')->form();

// Disabling validation for the autocomplete field
$form['transaction_form[user]']->disableValidation()->setValue($user->id->toString());
$form['transaction_form[phoneNumber]']->setValue('some phone number');
$form['transaction_form[amount]']->setValue('5');

// Submit the form manually
$this->client->submit($form);

The disableValidation method is marked as internal. Your editor may not detect it, and tools like PHPStan might flag it as an error. However, it works in practice and can be safely used in this context. If necessary, you can suppress the PHPStan error for this specific line or adjust your PHPStan configuration.