[GraphQL] NumericFilter and RangeFilter can not be defined on the same property

[epourail]

API Platform version(s) affected: 2.5.4

Description

In my context, i need to enable both RangeFilter and NumericFilter on the same property to have the following filtering option : less than, equals, between and greater than
In such case, 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(RangeFilter::class, properties={"age"})
 * @ApiFilter(NumericFilter::class, properties={"age"})
 */
class Dummy
{
   /** @var int $age */
   private $age;

   // ...
}

The REST collection endpoint enables both filters with the syntax /dummies?age=18 and /dummies?age[gt]=18

But the GraphQL endpoint enables only the NumericFilter with the syntax dummies(age: "18") { ... }
(as the RangeFilter uses the syntax dummies(age: {gt: "18"}))

How to reproduce
Here a valid entity declaration

<?php

declare(strict_types=1);

namespace App\Entity;

use ApiPlatform\Core\Annotation\ApiProperty;
use ApiPlatform\Core\Annotation\ApiResource;
use ApiPlatform\Core\Annotation\ApiFilter;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\RangeFilter;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\NumericFilter;

use Doctrine\ORM\Mapping as ORM;

/**
 * Class Dummy
 * @package App\Entity
 *
 * @ApiResource(
 *     graphql={
 *         "item_query",
 *         "collection_query"
 *     }
 * )
 * @ApiFilter(RangeFilter::class, properties={"age"})
 * @ApiFilter(NumericFilter::class, properties={"age"})
 * @ORM\Entity
 */
class Dummy
{
    /**
     * @var string|null
     * @ApiProperty(iri="http://schema.org/identifier")
     * @ORM\Column(type="guid")
     * @ORM\GeneratedValue(strategy="UUID")
     * @ORM\Id()
     */
    private $id;

    public function getId() 
    {
        return $this->id;
    }

    public function setId($id): void
    {
        $this->id = $id;
    }

    /**
     * @var integer
     * @ApiProperty
     * @ORM\Column(type="integer")
     */
    private $age;

    public function getAge()
    {
        return $this->age;
    }

    public function setAge($age): void
    {
        $this->age = $age;
    }
}

Case 1. Both RangeFilter and NumericFilter

In the entity definition, enabling both the RangeFilter and the NumericFilter the following graphql query is available

{
  dummies(age: 18) {
    edges {
      node {
        id age
      }
    }
  }
}

And the following syntax:

{
  dummies(age: {gt:"18"}) {
    edges {
      node {
        id age
      }
    }
  }
}

raises the error:

{
  "errors": [
    {
      "message": "Field \"dummies\" argument \"age\" requires type Int, found {gt: \"18\"}.",
      "extensions": {
        "category": "graphql"
      },
      "locations": [
        {
          "line": 2,
          "column": 16
        }
      ]
    }
  ]
}

Case 2. Only RangeFilter

In the entity definition, enabling only the RangeFilter (delete the NumericFilter filter declaration) the following graphql query is available

{
  dummies(age: {gt:"18"}) {
    edges {
      node {
        id age
      }
    }
  }
}

And the following syntax:

{
  dummies(age: 18) {
    edges {
      node {
        id age
      }
    }
  }
}

raises the error:

{
  "errors": [
    {
      "message": "Field \"dummies\" argument \"age\" requires type DummyFilter_age, found 18.",
      "extensions": {
        "category": "graphql"
      },
      "locations": [
        {
          "line": 2,
          "column": 16
        }
      ]
    }
  ]
}

Possible Solution

The RangeFilter should supports an eq (and neq) syntax allowing to use, with one filter, all the cases : less than, between, greater than and equal to

Additional Context
Note that using the NumericFilter a numerical value should be defined but using the RangeFilter, a string should be used to define the value.
Should I open another issue ?

[alanpoulain]

Another solution would be to change the way these filters are used for GraphQL.
We could use the same future syntax as the date or exists filter (see #3468):

{
  dummies(range: [{age: {gt: "18"}}]) {
    edges {
      node {
        id age
      }
    }
  }
}

Maybe the best way to do this is to change the filters by adding code to handle both syntaxes (REST and GraphQL) and modify the getFilterDescription method to add a $graphQl boolean.

[epourail]

This could be an alternative but I am not a big fan as it complexifies the syntax.
Question : in the core, is it possible (or a suggestion) to switch between the filters according the syntax value (dummies(age: <int>) vs dummies(age: <object>)) ?

[alanpoulain]

It complexifies the syntax, but if every filter behaves the same way, the DX will be better. And since only this syntax is able to keep the order of the arguments, I think it's the best one to use.

For your question, I think it depends of the declaration order of the filters in the fields builder.
And it seems it depends itself of the declaration order of the filters in the resource.

[epourail]

You're right. It complexifies but it uniformizes the syntax with the 'exists' and 'order' filters.

[epourail]

@alanpoulain FYI, I will try to work on a PR.