[GraphQL] ExistsFilter and SearchFilter can not be defined on the same property

[epourail]

When a resource is defined with an ExistsFilter and a SearchFilter on the same property, the graphql schema will convert both filters in the same way using the property name to identify the filter.

In the following example

/**
 * @ApiResource()
 * @ApiFilter(ExistsFilter::class, properties={"title"})
 * @ApiFilter(SearchFilter::class, properties={"title": "exact"})
 */
class Dummy
{
   /** @var null|string $title a nullable property */
   private $title;

   // ...
}

The REST collection endpoint enables both filter with the syntax /dummies?title=shirt and /dummies?title[exists]=true

But the GraphQL endpoint enables only the SearchFilter with the syntax dummies(title: "shirt") { ... }
(as the ExistFilter uses the syntax dummies(title: {exists: true}))

[epourail]

Below I share my solution/workaround to enable the ExistsFilter on the graphql endpoint.
The syntax is :

• notempty[<property>]=true/false on the REST collection endpoints
• dummies(notempty: {<property>: "true/false"}) { ... } on the graphql collection endpoints

<?php

declare(strict_types=1);

namespace App\Filter;

use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\ExistsFilter as ParentExistsFilter;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
use Doctrine\ORM\QueryBuilder;

/**
 * Class EmptyFilter
 * @package App\Filter
 *
 */
final class ExistsFilter extends ParentExistsFilter
{
    /**
     * @inheritdoc
     */
    protected function filterProperty(
        string $property,
        $value,
        QueryBuilder $queryBuilder,
        QueryNameGeneratorInterface $queryNameGenerator,
        string $resourceClass,
        string $operationName = null
    ) {
        if ($property !== 'notempty') {
            return;
        }

        foreach ($value as $propertyName => $exists) {
            parent::filterProperty(
                $propertyName,
                ['exists' => $exists],
                $queryBuilder,
                $queryNameGenerator,
                $resourceClass,
                $operationName
            );
        }
    }

    /**
     * @inheritdoc
     */
    public function getDescription(string $resourceClass): array
    {
        $parentDescription = parent::getDescription($resourceClass);

        $description = [];

        array_walk(
            $parentDescription,
            function ($item, $key) use (&$description) {
                $item['swagger'] = [
                    'description' => 'Search elements which the property is empty (or not) : ' . $item['property'],
                    'type' => $item['type']
                ];
                $description[sprintf('notempty[%s]', $item['property'])] = $item;
            }
        );

        return $description;
    }
}

[dunglas]

Hi,

Thanks for the report, and sharing your workaround. Would you be interested to open a PR to fix upstream’s behavior?

[epourail]

OK, i will suggest a PR.

[antograssiot]

related PR and doc has been merged, closing this. thanks again @epourail