如何使用Symfony和API平台过滤子对象上的GraphQL？

Question

Although an experienced developer, I'm fairly new to Symfony/API Platfrom/GraphQL. My task is simple - add a filter to the Product entity that allows to filter out only active products. Bonus points if the filter is set by default - that is, by default only active products are returned, and you need to add a parameter if you wish to see the inactive products. But if that's too hard, simply adding a filter will do.

OK, so in my Product.php I have (only relevant parts shown):

use Doctrine\ORM\Mapping as ORM;
use ApiPlatform\Core\Annotation\ApiFilter;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\BooleanFilter;

/**
 * @ApiFilter(BooleanFilter::class, properties={"active" : "exact"})
 */
class Product {
    /**
     * @ORM\Column(type="boolean")
     */
    private $active;
}

Then I try to modify an existing query to filter out only the active products:

{
  sellers(id: 5, active: true) {
    edges {
      node {
        categories {
          edges {
            node {
              products (active: true) {
                totalCount
                edges {
                  node {
                    name
                }
              }
            }
          }
        }
      }
    }
  }
}

Buuuut, I get:

{
  "errors": [
    {
      "message": "Unknown argument \"active\" on field \"products\" of type \"Category\".",
      "category": "graphql",
      "locations": [
        {
          "line": 39,
          "column": 25
        }
      ]
    }
  ]
}

Now, if I change it to querying the products directly:

{
  products (active: true) {
    totalCount
    edges {
      node {
        name
      }
    }
  }
}

That works!

So, what's going on? I'd like to make the filter on the original query so it returns all of the other data too, not just plain products. What am I doing wrong? It feels like I'm misunderstanding some fundamental concept.

Answer 1

I think it was a pernicious bug which has been resolved in the master and 2.4 branches (no release yet). See https://github.com/api-platform/core/pull/2970 for details.