Merge pull request #2219 from antograssiot/get-item-on-collection

[2.3] Throw an InvalidArgument when trying to get Item from a collection route

Author: dunglas

features/doctrine/search_filter.feature

@@ -374,6 +374,35 @@ Feature: Search filter on collections
     }
     """
 
+  @sqlite
+  Scenario: Search for entities with an existing collection route name
+    When I send a "GET" request to "/dummies?relatedDummies=dummy_cars"
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON should be valid according to this schema:
+    """
+    {
+      "type": "object",
+      "properties": {
+        "@context": {"pattern": "^/contexts/Dummy$"},
+        "@id": {"pattern": "^/dummies$"},
+        "@type": {"pattern": "^hydra:Collection$"},
+        "hydra:member": {
+          "type": "array",
+          "maxItems": 0
+        },
+        "hydra:view": {
+          "type": "object",
+          "properties": {
+            "@id": {"pattern": "^/dummies\\?relatedDummies=dummy_cars"},
+            "@type": {"pattern": "^hydra:PartialCollectionView$"}
+          }
+        }
+      }
+    }
+    """
+
   @createSchema
   Scenario: Search related collection by name
     Given there are 3 dummy objects having each 3 relatedDummies

src/Bridge/Symfony/Routing/IriConverter.php

@@ -79,6 +79,10 @@ public function getItemFromIri(string $iri, array $context = [])
             throw new InvalidArgumentException(sprintf('No resource associated to "%s".', $iri));
         }
 
+        if (isset($parameters['_api_collection_operation_name'])) {
+            throw new InvalidArgumentException(sprintf('The iri "%s" references a collection not an item.', $iri));
+        }
+
         $attributes = AttributesExtractor::extractAttributes($parameters);
 
         try {

tests/Bridge/Symfony/Routing/IriConverterTest.php

@@ -62,6 +62,21 @@ public function testGetItemFromIriNoResourceException()
         $converter->getItemFromIri('/users/3');
     }
 
+    public function testGetItemFromIriCollectionRouteException()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('The iri "/users" references a collection not an item.');
+
+        $routerProphecy = $this->prophesize(RouterInterface::class);
+        $routerProphecy->match('/users')->willReturn([
+            '_api_resource_class' => Dummy::class,
+            '_api_collection_operation_name' => 'get',
+        ])->shouldBeCalledTimes(1);
+
+        $converter = $this->getIriConverter($routerProphecy);
+        $converter->getItemFromIri('/users');
+    }
+
     public function testGetItemFromIriItemNotFoundException()
     {
         $this->expectException(ItemNotFoundException::class);