Handle binary UUID in SearchFilter #3774

odoucet · 2020-10-20T14:51:00Z

Q	A
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tickets	fixes api-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 · 2020-10-20T14:58:01Z

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

src/Bridge/Doctrine/Orm/Filter/SearchFilter.php

odoucet

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

src/Bridge/Doctrine/Orm/Filter/SearchFilter.php

soyuka · 2020-11-08T10:27:07Z

Nice patch, please target 2.5

odoucet · 2020-11-09T08:33:39Z

Updated to use QueryNameGenerator for variable names.

alanpoulain · 2020-11-09T08:59:13Z

src/Bridge/Doctrine/Orm/Filter/SearchFilter.php

-                for ($i = 0; $i < $nbArgs; ++$i) {
-                    $inQuery[] = ':filterproperty'.$i;
-                    $parameters->add(new Parameter('filterproperty'.$i, $caseSensitive ? $values[$i] : strtolower($values[$i]), $type));
+                $args = [];


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?

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.

src/Bridge/Doctrine/Orm/Filter/SearchFilter.php

odoucet · 2020-11-10T15:55:45Z

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 · 2021-01-22T10:14:14Z

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

odoucet · 2021-02-08T17:29:18Z

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 · 2021-02-11T14:33:28Z

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 · 2021-02-19T14:40:55Z

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 · 2021-02-19T14:58:05Z

Thank you @odoucet.

This reverts commit ff248ae.

* Revert "Handle binary UUID in SearchFilter (#3774)" This reverts commit ff248ae. Co-authored-by: Alan Poulain <contact@alanpoulain.eu>

alanpoulain reviewed Oct 20, 2020

View reviewed changes

src/Bridge/Doctrine/Orm/Filter/SearchFilter.php Outdated Show resolved Hide resolved

odoucet commented Oct 20, 2020

View reviewed changes

src/Bridge/Doctrine/Orm/Filter/SearchFilter.php Outdated Show resolved Hide resolved

odoucet changed the title ~~WIP - Handle binary UUID in SearchFilter~~ Handle binary UUID in SearchFilter Oct 22, 2020

dunglas requested changes Oct 22, 2020

View reviewed changes

src/Bridge/Doctrine/Orm/Filter/SearchFilter.php Outdated Show resolved Hide resolved

src/Bridge/Doctrine/Orm/Filter/SearchFilter.php Outdated Show resolved Hide resolved

src/Bridge/Doctrine/Orm/Filter/SearchFilter.php Outdated Show resolved Hide resolved

odoucet requested a review from dunglas October 24, 2020 10:35

soyuka added the Ready label Nov 8, 2020

alanpoulain reviewed Nov 9, 2020

View reviewed changes

odoucet force-pushed the uuidbin-search branch from 80f3204 to bf34b36 Compare November 10, 2020 11:28

alanpoulain reviewed Nov 10, 2020

View reviewed changes

src/Bridge/Doctrine/Orm/Filter/SearchFilter.php Outdated Show resolved Hide resolved

odoucet mentioned this pull request Jan 21, 2021

Symfony Uuid identifiers causes binary query and 404 #3880

Closed

Base automatically changed from master to main January 23, 2021 21:59

odoucet force-pushed the uuidbin-search branch from 129a912 to 76ec314 Compare February 11, 2021 14:20

alanpoulain force-pushed the uuidbin-search branch from aa50420 to 83d4dfa Compare February 19, 2021 12:33

alanpoulain changed the base branch from main to 2.6 February 19, 2021 12:34

alanpoulain force-pushed the uuidbin-search branch 2 times, most recently from 4ded0f9 to 16dd558 Compare February 19, 2021 12:39

odoucet and others added 4 commits February 19, 2021 15:32

fix searchFilter with binary types (like UUID)

cce360c

fix php-cs-fixer

5b448ae

test: add Behat tests

04b8ffc

chore: add changelog entry

a1f12ca

alanpoulain force-pushed the uuidbin-search branch from 16dd558 to a1f12ca Compare February 19, 2021 14:36

test: binary uuid are not working with postgres

810af16

alanpoulain merged commit ff248ae into api-platform:2.6 Feb 19, 2021

odoucet deleted the uuidbin-search branch March 2, 2021 09:53

alanpoulain mentioned this pull request Mar 4, 2021

Search filter introduces #3331 back with deprecations #3521

Closed

bendavies mentioned this pull request Mar 12, 2021

BC Break on SearchFilter with date as input #4128

Closed

soyuka added a commit to soyuka/core that referenced this pull request Mar 13, 2021

Revert "Handle binary UUID in SearchFilter (api-platform#3774)"

ef89083

This reverts commit ff248ae.

soyuka added a commit to soyuka/core that referenced this pull request Mar 13, 2021

Revert "Handle binary UUID in SearchFilter (api-platform#3774)"

db90e1c

This reverts commit ff248ae.

alanpoulain pushed a commit to soyuka/core that referenced this pull request Mar 16, 2021

Revert "Handle binary UUID in SearchFilter (api-platform#3774)"

b29548d

This reverts commit ff248ae.

alanpoulain added a commit that referenced this pull request Mar 16, 2021

SearchFilter: fix regression in 2.6.3 (#4134)

e74bf8e

* Revert "Handle binary UUID in SearchFilter (#3774)" This reverts commit ff248ae. Co-authored-by: Alan Poulain <contact@alanpoulain.eu>

alanpoulain mentioned this pull request Jun 9, 2021

fix(ulid): convert Ulid object to binary for ORM search filter #4313

Closed

alanpoulain mentioned this pull request Jun 23, 2021

bugfix-2838-searchfilter-custom-types #2873

Closed

soyuka mentioned this pull request Jun 8, 2023

[RFC] Native UID support in search filter #5618

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Handle binary UUID in SearchFilter #3774

Handle binary UUID in SearchFilter #3774

odoucet commented Oct 20, 2020 •

edited

alanpoulain commented Oct 20, 2020

odoucet left a comment

soyuka commented Nov 8, 2020

odoucet commented Nov 9, 2020

alanpoulain Nov 9, 2020 •

edited

odoucet Nov 10, 2020

odoucet commented Nov 10, 2020

soyuka commented Jan 22, 2021

odoucet commented Feb 8, 2021

odoucet commented Feb 11, 2021

alanpoulain commented Feb 19, 2021

alanpoulain commented Feb 19, 2021

Handle binary UUID in SearchFilter #3774

Handle binary UUID in SearchFilter #3774

Conversation

odoucet commented Oct 20, 2020 • edited

alanpoulain commented Oct 20, 2020

odoucet left a comment

Choose a reason for hiding this comment

soyuka commented Nov 8, 2020

odoucet commented Nov 9, 2020

alanpoulain Nov 9, 2020 • edited

Choose a reason for hiding this comment

odoucet Nov 10, 2020

Choose a reason for hiding this comment

odoucet commented Nov 10, 2020

soyuka commented Jan 22, 2021

odoucet commented Feb 8, 2021

odoucet commented Feb 11, 2021

alanpoulain commented Feb 19, 2021

alanpoulain commented Feb 19, 2021

odoucet commented Oct 20, 2020 •

edited

alanpoulain Nov 9, 2020 •

edited