fix(graphql): allow search filter to use an int for its value (api-pl…

…atform#4295)
LoicBoursin · Aug 18, 2021 · d89fae6 · d89fae6
1 parent 100ba69
commit d89fae6
Show file tree

Hide file tree

Showing 9 changed files with 90 additions and 7 deletions.
diff --git a/features/graphql/filters.feature b/features/graphql/filters.feature
@@ -84,6 +84,36 @@ Feature: Collections filtering
     Then the JSON node "data.dummies.edges" should have 1 element
     And the JSON node "data.dummies.edges[0].node.id" should be equal to "/dummies/2"
 
+  @createSchema
+  Scenario: Retrieve a collection filtered using the search filter with an int
+    Given there are 4 dummy objects having each 3 relatedDummies
+    When I send the following GraphQL request:
+    """
+    {
+      dummies(name: "Dummy #1") {
+        totalCount
+        edges {
+          node {
+            name
+            relatedDummies(age: 31) {
+              totalCount
+              edges {
+                node {
+                  id
+                  name
+                  age
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+    """
+    Then the JSON node "data.dummies.totalCount" should be equal to 1
+    And the JSON node "data.dummies.edges[0].node.relatedDummies.totalCount" should be equal to 1
+    And the JSON node "data.dummies.edges[0].node.relatedDummies.edges[0].node.age" should be equal to "31"
+
   @createSchema
   Scenario: Retrieve a collection filtered using the search filter and a name converter
     Given there are 10 dummy objects
@@ -130,7 +160,7 @@ Feature: Collections filtering
     And the JSON node "data.convertedOwners.edges[1].node.name_converted.name_converted" should be equal to "Converted 20"
 
   @createSchema
-  Scenario: Retrieve a collection filtered using the search filter
+  Scenario: Retrieve a nested collection filtered using the search filter
     Given there are 3 dummy objects having each 3 relatedDummies
     When I send the following GraphQL request:
     """

diff --git a/features/main/subresource.feature b/features/main/subresource.feature
@@ -104,7 +104,7 @@ Feature: Subresource support
       "hydra:totalItems": 2,
       "hydra:search": {
         "@type": "hydra:IriTemplate",
-        "hydra:template": "/dummies/1/related_dummies{?relatedToDummyFriend.dummyFriend,relatedToDummyFriend.dummyFriend[],name}",
+        "hydra:template": "/dummies/1/related_dummies{?relatedToDummyFriend.dummyFriend,relatedToDummyFriend.dummyFriend[],name,age,age[]}",
         "hydra:variableRepresentation": "BasicRepresentation",
         "hydra:mapping": [
           {
@@ -124,6 +124,18 @@ Feature: Subresource support
             "variable": "name",
             "property": "name",
             "required": false
+          },
+          {
+            "@type": "IriTemplateMapping",
+            "variable": "age",
+            "property": "age",
+            "required": false
+          },
+          {
+            "@type": "IriTemplateMapping",
+            "variable": "age[]",
+            "property": "age",
+            "required": false
           }
         ]
       }
@@ -167,7 +179,7 @@ Feature: Subresource support
       },
       "hydra:search": {
         "@type": "hydra:IriTemplate",
-        "hydra:template": "/dummies/1/related_dummies{?relatedToDummyFriend.dummyFriend,relatedToDummyFriend.dummyFriend[],name}",
+        "hydra:template": "/dummies/1/related_dummies{?relatedToDummyFriend.dummyFriend,relatedToDummyFriend.dummyFriend[],name,age,age[]}",
         "hydra:variableRepresentation": "BasicRepresentation",
         "hydra:mapping": [
           {
@@ -187,6 +199,18 @@ Feature: Subresource support
             "variable": "name",
             "property": "name",
             "required": false
+          },
+          {
+            "@type": "IriTemplateMapping",
+            "variable": "age",
+            "property": "age",
+            "required": false
+          },
+          {
+            "@type": "IriTemplateMapping",
+            "variable": "age[]",
+            "property": "age",
+            "required": false
           }
         ]
       }

diff --git a/src/Bridge/Doctrine/Common/Filter/SearchFilterTrait.php b/src/Bridge/Doctrine/Common/Filter/SearchFilterTrait.php
@@ -136,7 +136,7 @@ protected function getIdFromValue(string $value)
     protected function normalizeValues(array $values, string $property): ?array
     {
         foreach ($values as $key => $value) {
-            if (!\is_int($key) || !\is_string($value)) {
+            if (!\is_int($key) || !(\is_string($value) || \is_int($value))) {
                 unset($values[$key]);
             }
         }

diff --git a/tests/Behat/DoctrineContext.php b/tests/Behat/DoctrineContext.php
@@ -728,7 +728,7 @@ public function thereAreDummyObjectsWithRelatedDummies(int $nb, int $nbrelated)
             for ($j = 1; $j <= $nbrelated; ++$j) {
                 $relatedDummy = $this->buildRelatedDummy();
                 $relatedDummy->setName('RelatedDummy'.$j.$i);
-
+                $relatedDummy->setAge((int) ($j.$i));
                 $this->manager->persist($relatedDummy);
 
                 $dummy->addRelatedDummy($relatedDummy);

diff --git a/tests/Bridge/Doctrine/Common/Filter/SearchFilterTestTrait.php b/tests/Bridge/Doctrine/Common/Filter/SearchFilterTestTrait.php
@@ -474,6 +474,14 @@ private function provideApplyTestArguments(): array
                     'relatedDummy.symfony' => [],
                 ],
             ],
+            'integer value' => [
+                [
+                    'age' => 'exact',
+                ],
+                [
+                    'age' => 46,
+                ],
+            ],
         ];
     }
 }
diff --git a/tests/Bridge/Doctrine/MongoDbOdm/Filter/SearchFilterTest.php b/tests/Bridge/Doctrine/MongoDbOdm/Filter/SearchFilterTest.php
@@ -690,6 +690,21 @@ public function provideApplyTestData(): array
                     [],
                     $filterFactory,
                 ],
+                'integer value' => [
+                    [
+                        [
+                            '$match' => [
+                                'age' => [
+                                    '$in' => [
+                                        '46',
+                                    ],
+                                ],
+                            ],
+                        ],
+                    ],
+                    $filterFactory,
+                    RelatedDummy::class,
+                ],
             ]
         );
     }

diff --git a/tests/Bridge/Doctrine/Orm/Filter/SearchFilterTest.php b/tests/Bridge/Doctrine/Orm/Filter/SearchFilterTest.php
@@ -567,6 +567,12 @@ public function provideApplyTestData(): array
                     [],
                     $filterFactory,
                 ],
+                'integer value' => [
+                    sprintf('SELECT %s FROM %s %1$s WHERE %1$s.age = :age_p1', $this->alias, RelatedDummy::class),
+                    ['age_p1' => 46],
+                    $filterFactory,
+                    RelatedDummy::class,
+                ],
             ]
         );
     }

diff --git a/tests/Fixtures/app/config/config_mongodb.yml b/tests/Fixtures/app/config/config_mongodb.yml
@@ -54,7 +54,7 @@ services:
         tags:      [ { name: 'api_platform.filter', id: 'my_dummy.mongodb.search' } ]
     app.related_dummy_resource.mongodb.search_filter:
         parent:    'api_platform.doctrine_mongodb.odm.search_filter'
-        arguments: [ { 'relatedToDummyFriend.dummyFriend': 'exact', 'name': 'partial' } ]
+        arguments: [ { 'relatedToDummyFriend.dummyFriend': 'exact', 'name': 'partial', 'age': 'exact' } ]
         tags:      [ { name: 'api_platform.filter', id: 'related_dummy.mongodb.friends' } ]
     app.my_dummy_date_resource.mongodb.date_filter:
         parent:    'api_platform.doctrine_mongodb.odm.date_filter'

diff --git a/tests/Fixtures/app/config/config_test.yml b/tests/Fixtures/app/config/config_test.yml
@@ -64,7 +64,7 @@ services:
 
     app.related_dummy_resource.search_filter:
         parent:    'api_platform.doctrine.orm.search_filter'
-        arguments: [ { 'relatedToDummyFriend.dummyFriend': 'exact', 'name': 'partial' } ]
+        arguments: [ { 'relatedToDummyFriend.dummyFriend': 'exact', 'name': 'partial', 'age': 'exact' } ]
         tags:      [ { name: 'api_platform.filter', id: 'related_dummy.friends' } ]
 
     app.related_dummy_resource.complex_sub_query_filter: