SearchFilter on an association with a Ulid primary key causes an exception

[gnito-org]

API Platform version(s) affected: 2.6.8

Description

Article has many Tags. Tag has a primary key id that's defined as a Symfony Ulid type.

A search filter on Article to find articles with a specific Tag causes an exception An exception occurred while executing a query: SQLSTATE[22P02]: Invalid text representation: 7 ERROR: invalid input syntax for type uuid: \"01FVQ6SJ6GPCE97X8JPZ6VV5ZX\. This is on PostgreSQL.

The exception is not thrown when the id is a Symfony Uuid type.

How to reproduce

See the reproducer at https://github.com/gnito-org/api-platform-ulid-demo.

Create a Tag, associate it with an Article, then do a collection get on Article with the Tag Ulid in the tags filter field.

Same exception is thrown when valid Ulid values are entered in the tags[] filter fields.

Possible Causes

Api-platform does not supply the third parameter of the QueryBuilder::setParameter() method for Ulid fields, as decribed by the Symfony docs.

Possible Solution

The easy solution is to insert something like the following into SearchFilter:

    if ('ulid' === $doctrineTypeField){
        foreach ($values as $key => $uLidValue){
            $uLid = new Ulid($uLidValue);
            $values[$key] = $uLid->toRfc4122();
        }
    }

That works... however, that makes API Platform dependent on symfony/uid.

Will it break compatibility with Symfony 4.4?

[gnito-org]

Pinging @dunglas

[gnito-org]

A work-around for this issue is to create a special filter:

// src/Filter/UlidAssociationFilter
<?php

namespace App\Filter;

use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
use Doctrine\ORM\QueryBuilder;
use Symfony\Component\Uid\Ulid;

class UlidAssociationFilter extends SearchFilter
{
    protected function filterProperty(
        string $property,
        $value,
        QueryBuilder $queryBuilder,
        QueryNameGeneratorInterface $queryNameGenerator,
        string $resourceClass,
        string $operationName = null
    ): void
    {
        $field = $property;
        $associations = [];
        $values = (array) $value;
        $metadata = $this->getNestedMetadata(
            $resourceClass,
            $associations
        );
        if ($metadata->hasAssociation($field)) {
            $associationResourceClass = $metadata->getAssociationTargetClass($field);
            $associationFieldIdentifier = $this->identifiersExtractor->getIdentifiersFromResourceClass($associationResourceClass)[0];
            $doctrineTypeField = $this->getDoctrineFieldType(
                $associationFieldIdentifier,
                $associationResourceClass
            );
            if ('ulid' === $doctrineTypeField) {
                foreach ($values as $key => $uLidValue) {
                    if (!empty($uLidValue)) {
                        try {
                            $uLid = new Ulid($uLidValue);
                            $values[$key] = $uLid->toRfc4122();
                        } catch (\Throwable) {
                            $values[$key] = (new Ulid())->toRfc4122();
                        }
                    } else {
                        unset($values[$key]);
                    }
                }
            }
        }
        parent::filterProperty(
            $property,
            $values,
            $queryBuilder,
            $queryNameGenerator,
            $resourceClass,
            $operationName
        );
    }
}

and then use it:

#[ApiFilter(
    filterClass: UlidAssociationFilter::class,
    properties: [
        'tags' => SearchFilterInterface::STRATEGY_EXACT,
    ]
)]

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[madonzy]

My solution was to add a custom filter, but it a slightly other way:

class UlidFilter implements FilterInterface
{
    public function __construct(
        #[Autowire(service: 'api_platform.doctrine.orm.search_filter.instance')] readonly private SearchFilter $searchFilter,
        ?array $properties = null
    ) {
        $this->searchFilter->setProperties($properties);
    }

    public function apply(
        QueryBuilder $queryBuilder,
        QueryNameGeneratorInterface $queryNameGenerator,
        string $resourceClass,
        ?Operation $operation = null,
        array $context = []
    ): void {
        $this->searchFilter->apply($queryBuilder, $queryNameGenerator, $resourceClass, $operation, $context);

        $parameters = $queryBuilder->getParameters();

        if ($parameters->isEmpty()) {
            return;
        }

        $ulidParameter = $parameters->first();

        $name = $ulidParameter->getName();
        $value = $ulidParameter->getValue();

        $parameters->removeElement($ulidParameter);

        $queryBuilder->setParameter($name, $value, UlidType::NAME);
    }

    public function getDescription(string $resourceClass): array
    {
        return $this->searchFilter->getDescription($resourceClass);
    }
}

And use just like

#[ApiFilter(
    UlidFilter::class,
    properties: ['ulid' => SearchFilterInterface::STRATEGY_IEXACT]
)]

But is there a way to use PARTIAL search since, in DB, it's stored as UUID...