feat: add tests of filters with stateOptions

Author: alexislefebvre

tests/Fixtures/TestBundle/ApiResource/FilterWithStateOptionsAndNoApiFilter.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\ApiResource;
+
+use ApiPlatform\Doctrine\Orm\Filter\PartialSearchFilter;
+use ApiPlatform\Doctrine\Orm\State\CollectionProvider;
+use ApiPlatform\Doctrine\Orm\State\Options;
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\GetCollection;
+use ApiPlatform\Metadata\QueryParameter;
+use ApiPlatform\Tests\Fixtures\TestBundle\Entity\FilterWithStateOptionsAndNoApiFilterEntity;
+
+#[ApiResource(
+    stateOptions: new Options(entityClass: FilterWithStateOptionsAndNoApiFilterEntity::class),
+    operations: [
+        new GetCollection(
+            uriTemplate: 'filter_with_state_options_and_no_api_filters',
+            parameters: [
+                'search[:property]' => new QueryParameter(
+                    properties: ['dummyDate', 'name'],
+                    filter: new PartialSearchFilter(),
+                ),
+            ],
+            provider: CollectionProvider::class
+        ),
+    ]
+)]
+final class FilterWithStateOptionsAndNoApiFilter
+{
+}

tests/Fixtures/TestBundle/Entity/FilterWithStateOptionsAndNoApiFilterEntity.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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 Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity]
+class FilterWithStateOptionsAndNoApiFilterEntity
+{
+    public function __construct(
+        #[ORM\Column(type: 'integer')]
+        #[ORM\Id]
+        #[ORM\GeneratedValue(strategy: 'AUTO')]
+        public ?int $id = null,
+        #[ORM\Column(type: 'date_immutable', nullable: true)]
+        public ?\DateTimeImmutable $dummyDate = null,
+        #[ORM\Column(type: 'string', nullable: true)]
+        public ?string $name = null,
+    ) {
+    }
+}

tests/Functional/Parameters/DoctrineTest.php

@@ -15,7 +15,9 @@
 
 use ApiPlatform\Symfony\Bundle\Test\ApiTestCase;
 use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\FilterWithStateOptions;
+use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\FilterWithStateOptionsAndNoApiFilter;
 use ApiPlatform\Tests\Fixtures\TestBundle\Document\SearchFilterParameter as SearchFilterParameterDocument;
+use ApiPlatform\Tests\Fixtures\TestBundle\Entity\FilterWithStateOptionsAndNoApiFilterEntity;
 use ApiPlatform\Tests\Fixtures\TestBundle\Entity\FilterWithStateOptionsEntity;
 use ApiPlatform\Tests\Fixtures\TestBundle\Entity\ProductWithQueryParameter;
 use ApiPlatform\Tests\Fixtures\TestBundle\Entity\SearchFilterParameter;
@@ -35,7 +37,7 @@ final class DoctrineTest extends ApiTestCase
      */
     public static function getResources(): array
     {
-        return [SearchFilterParameter::class, FilterWithStateOptions::class, ProductWithQueryParameter::class];
+        return [SearchFilterParameter::class, FilterWithStateOptions::class, FilterWithStateOptionsAndNoApiFilter::class, ProductWithQueryParameter::class];
     }
 
     public function testDoctrineEntitySearchFilter(): void
@@ -147,6 +149,38 @@ public function testStateOptions(): void
         $this->assertEquals('after', $a['hydra:member'][0]['name']);
     }
 
+    public function testStateOptionsAndNoApiFilter(): void
+    {
+        if ($this->isMongoDB()) {
+            $this->markTestSkipped('Not tested with mongodb.');
+        }
+
+        static::bootKernel();
+        $container = static::$kernel->getContainer();
+        $this->recreateSchema([FilterWithStateOptionsAndNoApiFilterEntity::class]);
+        $manager = $container->get('doctrine')->getManager();
+
+        $d = new \DateTimeImmutable();
+        $manager->persist(new FilterWithStateOptionsAndNoApiFilterEntity(dummyDate: $d, name: 'current'));
+        $manager->persist(new FilterWithStateOptionsAndNoApiFilterEntity(name: 'null'));
+        $manager->persist(new FilterWithStateOptionsAndNoApiFilterEntity(dummyDate: $d->add(\DateInterval::createFromDateString('1 day')), name: 'after'));
+        $manager->flush();
+
+        $response = self::createClient()->request('GET', '/filter_with_state_options_and_no_api_filters');
+        $this->assertResponseIsSuccessful();
+        $a = $response->toArray();
+        $this->assertSame('hydra:Collection', $a['@type']);
+        $this->assertSame(3, $a['hydra:totalItems']);
+        $this->assertCount(3, $a['hydra:member']);
+
+        $response = self::createClient()->request('GET', '/filter_with_state_options_and_no_api_filters?search[name]=aft');
+        $this->assertResponseIsSuccessful();
+        $a = $response->toArray();
+        $this->assertSame('hydra:Collection', $a['@type']);
+        $this->assertSame(1, $a['hydra:totalItems']);
+        $this->assertCount(1, $a['hydra:member']);
+    }
+
     #[DataProvider('partialFilterParameterProviderForSearchFilterParameter')]
     public function testPartialSearchFilterWithSearchFilterParameter(string $url, int $expectedCount, array $expectedFoos): void
     {