fix(doctrine): inject nameConverter into AbstractFilter via QueryParameter (#7866)

| Q             | A
| ------------- | ---
| Branch?       | main
| Tickets       | Fixes #7866
| License       | MIT
| Doc PR        | ∅

AbstractFilter subclasses (DateFilter, OrderFilter, etc.) silently failed
when used with QueryParameter and a nameConverter configured, because the
nameConverter was never injected into inline filter instances.

Author: soyuka

filters.md

@@ -20,6 +20,7 @@
 use Doctrine\Persistence\ManagerRegistry;
 use Psr\Container\ContainerInterface;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 
 trait ParameterExtensionTrait
 {
@@ -28,6 +29,7 @@ trait ParameterExtensionTrait
     protected ContainerInterface $filterLocator;
     protected ?ManagerRegistry $managerRegistry = null;
     protected ?LoggerInterface $logger = null;
+    protected ?NameConverterInterface $nameConverter = null;
 
     /**
      * @param object    $filter    the filter instance to configure
@@ -43,6 +45,10 @@ private function configureFilter(object $filter, Parameter $parameter): void
             $filter->setLogger($this->logger);
         }
 
+        if ($this->nameConverter && ($filter instanceof \ApiPlatform\Doctrine\Orm\Filter\AbstractFilter || $filter instanceof \ApiPlatform\Doctrine\Odm\Filter\AbstractFilter) && null === $filter->getNameConverter()) {
+            $filter->setNameConverter($this->nameConverter);
+        }
+
         if ($filter instanceof PropertyAwareFilterInterface) {
             $properties = [];
             // Check if the filter has getProperties method (e.g., if it's an AbstractFilter)

src/Doctrine/Common/ParameterExtensionTrait.php

@@ -22,6 +22,7 @@
 use Doctrine\ODM\MongoDB\Aggregation\Builder;
 use Psr\Container\ContainerInterface;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 
 /**
  * Reads operation parameters and execute its filter.
@@ -36,10 +37,12 @@ public function __construct(
         ContainerInterface $filterLocator,
         ?ManagerRegistry $managerRegistry = null,
         ?LoggerInterface $logger = null,
+        ?NameConverterInterface $nameConverter = null,
     ) {
         $this->filterLocator = $filterLocator;
         $this->managerRegistry = $managerRegistry;
         $this->logger = $logger;
+        $this->nameConverter = $nameConverter;
     }
 
     /**

src/Doctrine/Odm/Extension/ParameterExtension.php

@@ -85,6 +85,16 @@ public function setManagerRegistry(ManagerRegistry $managerRegistry): void
         $this->managerRegistry = $managerRegistry;
     }
 
+    public function getNameConverter(): ?NameConverterInterface
+    {
+        return $this->nameConverter;
+    }
+
+    public function setNameConverter(NameConverterInterface $nameConverter): void
+    {
+        $this->nameConverter = $nameConverter;
+    }
+
     /**
      * @return array<string, mixed>|null
      */

src/Doctrine/Odm/Filter/AbstractFilter.php

@@ -22,6 +22,7 @@
 use Doctrine\Persistence\ManagerRegistry;
 use Psr\Container\ContainerInterface;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 
 /**
  * Reads operation parameters and execute its filter.
@@ -36,10 +37,12 @@ public function __construct(
         ContainerInterface $filterLocator,
         ?ManagerRegistry $managerRegistry = null,
         ?LoggerInterface $logger = null,
+        ?NameConverterInterface $nameConverter = null,
     ) {
         $this->filterLocator = $filterLocator;
         $this->managerRegistry = $managerRegistry;
         $this->logger = $logger;
+        $this->nameConverter = $nameConverter;
     }
 
     /**

src/Doctrine/Orm/Extension/ParameterExtension.php

@@ -78,6 +78,16 @@ public function setManagerRegistry(ManagerRegistry $managerRegistry): void
         $this->managerRegistry = $managerRegistry;
     }
 
+    public function getNameConverter(): ?NameConverterInterface
+    {
+        return $this->nameConverter;
+    }
+
+    public function setNameConverter(NameConverterInterface $nameConverter): void
+    {
+        $this->nameConverter = $nameConverter;
+    }
+
     public function getProperties(): ?array
     {
         return $this->properties;

src/Doctrine/Orm/Filter/AbstractFilter.php

@@ -181,6 +181,7 @@
             service('api_platform.filter_locator'),
             service('doctrine_mongodb')->nullOnInvalid(),
             service('logger')->nullOnInvalid(),
+            service('api_platform.name_converter')->nullOnInvalid(),
         ])
         ->tag('api_platform.doctrine_mongodb.odm.aggregation_extension.collection', ['priority' => 32])
         ->tag('api_platform.doctrine_mongodb.odm.aggregation_extension.item');

src/Symfony/Bundle/Resources/config/doctrine_mongodb_odm.php

@@ -199,6 +199,7 @@
             service('api_platform.filter_locator'),
             service('doctrine')->nullOnInvalid(),
             service('logger')->nullOnInvalid(),
+            service('api_platform.name_converter')->nullOnInvalid(),
         ])
         ->tag('api_platform.doctrine.orm.query_extension.collection', ['priority' => -16])
         ->tag('api_platform.doctrine.orm.query_extension.item', ['priority' => -9]);

src/Symfony/Bundle/Resources/config/doctrine_orm.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\Entity;
+
+use ApiPlatform\Doctrine\Orm\Filter\DateFilter;
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\GetCollection;
+use ApiPlatform\Metadata\QueryParameter;
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * Tests that legacy AbstractFilter subclasses work with QueryParameter
+ * when a nameConverter is configured (issue #7866).
+ */
+#[ApiResource(
+    operations: [
+        new GetCollection(
+            parameters: [
+                'nameConverted' => new QueryParameter(
+                    filter: new DateFilter(),
+                    properties: ['nameConverted'],
+                ),
+            ],
+        ),
+    ],
+)]
+#[ORM\Entity]
+class ConvertedDateParameter
+{
+    #[ORM\Column(type: 'integer', nullable: true)]
+    #[ORM\Id]
+    #[ORM\GeneratedValue(strategy: 'AUTO')]
+    private ?int $id = null;
+
+    #[ORM\Column(type: 'date')]
+    public \DateTime $nameConverted;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+}

tests/Fixtures/TestBundle/Entity/ConvertedDateParameter.php

@@ -0,0 +1,76 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Functional\Parameters;
+
+use ApiPlatform\Symfony\Bundle\Test\ApiTestCase;
+use ApiPlatform\Tests\Fixtures\TestBundle\Entity\ConvertedDateParameter;
+use ApiPlatform\Tests\RecreateSchemaTrait;
+use ApiPlatform\Tests\SetupClassResourcesTrait;
+
+/**
+ * Tests that legacy AbstractFilter subclasses (DateFilter, etc.) work correctly
+ * with QueryParameter when a nameConverter is configured.
+ *
+ * @see https://github.com/api-platform/core/issues/7866
+ */
+final class NameConverterFilterTest extends ApiTestCase
+{
+    use RecreateSchemaTrait;
+    use SetupClassResourcesTrait;
+
+    protected static ?bool $alwaysBootKernel = false;
+
+    /**
+     * @return class-string[]
+     */
+    public static function getResources(): array
+    {
+        return [ConvertedDateParameter::class];
+    }
+
+    protected function setUp(): void
+    {
+        $this->recreateSchema([ConvertedDateParameter::class]);
+        $this->loadFixtures();
+    }
+
+    public function testDateFilterWithNameConverter(): void
+    {
+        $response = self::createClient()->request('GET', '/converted_date_parameters?nameConverted[after]=2025-01-15');
+        $this->assertResponseIsSuccessful();
+        $members = $response->toArray()['hydra:member'];
+        $this->assertCount(2, $members);
+    }
+
+    public function testDateFilterBeforeWithNameConverter(): void
+    {
+        $response = self::createClient()->request('GET', '/converted_date_parameters?nameConverted[before]=2025-01-15');
+        $this->assertResponseIsSuccessful();
+        $members = $response->toArray()['hydra:member'];
+        $this->assertCount(1, $members);
+    }
+
+    private function loadFixtures(): void
+    {
+        $manager = $this->getManager();
+
+        foreach (['2025-01-01', '2025-02-01', '2025-03-01'] as $date) {
+            $entity = new ConvertedDateParameter();
+            $entity->nameConverted = new \DateTime($date);
+            $manager->persist($entity);
+        }
+
+        $manager->flush();
+    }
+}