Handle binary UUID in SearchFilter

[odoucet]

Q	A
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tickets	fixesapi-platform/api-platform#1139
License	MIT

When searching on a binary UUID field, current behaviour leads to search done on Doctrine with the string UUID and not the binary version of it.
This is because the field type must be provided to Doctrine each time we use QueryBuilder. Why ? Because Doctrine sees string on input, and does not know it needs conversion.

This PR reads $metadata->getTypeOfField() and force field type.

WARNING
Current PR passes the unit tests (so it does not break current behaviour), but does not implement two new needed tests (to make sure it fixes the issue mentioned) :

• search on a single UUIDBinary
• search with multiple UUIDBinary values

Test has been done on a local project so I know it works, but better to check this with a test :)

I need some help adding custom type to SearchFilterTestTrait as uuidBinary is not recognized.

[alanpoulain]

Since it's a bugfix, it should target 2.5.

[odoucet]

I used a less generic parameter name ... Tell me if it's the right way to do.

[soyuka]

Nice patch, please target 2.5

[odoucet]

Updated to use QueryNameGenerator for variable names.

[alanpoulain]

Why not always using this conditional branch instead of having an if / else?
It will:

• make the code easier to read (and maintain),
• prevent bugs to arise only in one conditional branch.

WDYT @soyuka@dunglas?

[odoucet]

This will require updating some tests expectations because when multiple values are given, they are set as one unique array parameter, and that will become several parameters. See https://github.com/api-platform/core/pull/3774/checks?check_run_id=1379433208#step:14:91

I'm currently blocked at adding UUID tests, I cant fully understand yet how tests are organized and how can I add custom types.

\Doctrine\DBAL\Types\Type::addType('uuid', \Ramsey\Uuid\Doctrine\UuidType::class);

is required to manipulate uuid types.

[odoucet]

I've pushed an attempt to add test on UUID field, but the current test failed because SearchFilterTest::testGetDescriptionDefaultFields() failed on $filter->getDescription : it seems the uuid type is never loaded, despite adding it in DoctrineOrmFilterTestCase:setUp().
I need help on this one... or I can update my branch with no additional test and it can be merged right away.

[soyuka]

if you need more help @odoucet ping me on symfony's slack!

[odoucet]

I'll update my PR with latest master branch in a few days.
I need help on how to provide test code for this (I did not understand how to create custom doctrine types in unit tests).

[odoucet]

Hello,
I've updated my pull request to be up to date with latest master.
This MR lacks specific unit tests because I was unable to add a binary doctrine type to tests. @soyuka if you can help, it would be great :)
This MR can also be merged as-is, I know it works because I use binary type in a private project.

[alanpoulain]

Hello @odoucet,
Adding PHPUnit tests (they are integration tests, not really unit ones) is not possible since the conversion is done at the execution.
I've added Behat tests instead.

[alanpoulain]

Thank you @odoucet.