Ignoring PSR7 request typehint in route loader (#1597)

Author: xabbuh

Routing/Loader/Reader/RestActionReader.php

@@ -16,6 +16,7 @@
 use FOS\RestBundle\Inflector\InflectorInterface;
 use FOS\RestBundle\Request\ParamReaderInterface;
 use FOS\RestBundle\Routing\RestRouteCollection;
+use Psr\Http\Message\MessageInterface;
 use Symfony\Component\Routing\Route;
 
 /**
@@ -476,6 +477,7 @@ private function getMethodArguments(\ReflectionMethod $method)
             \FOS\RestBundle\Request\ParamFetcherInterface::class,
             \Symfony\Component\Validator\ConstraintViolationListInterface::class,
             \Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter::class,
+            MessageInterface::class,
         ];
 
         $arguments = [];

Tests/Fixtures/Controller/TypeHintedController.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the FOSRestBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\RestBundle\Tests\Fixtures\Controller;
+
+use FOS\RestBundle\Controller\Annotations as Rest;
+use FOS\RestBundle\Controller\FOSRestController;
+use FOS\RestBundle\Routing\ClassResourceInterface;
+use Psr\Http\Message\MessageInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * @Rest\RouteResource("Article")
+ */
+class TypeHintedController implements ClassResourceInterface
+{
+    public function cgetAction(Request $request)
+    {
+    }
+
+    public function cpostAction(MessageInterface $request)
+    {
+    }
+
+    public function getAction(Request $request, $id)
+    {
+    }
+
+    public function postAction(ServerRequestInterface $request, $id)
+    {
+    }
+}

Tests/Routing/Loader/RestRouteLoaderTest.php

@@ -342,6 +342,24 @@ public function testNameMethodPrefixIsPrependingCorrectly()
         $this->assertNotNull($collection->get('post_users_bar'), 'route for "post_users_bar" does not exist');
     }
 
+    /**
+     * RestActionReader::getMethodArguments should ignore certain types of
+     * parameters.
+     */
+    public function testRequestTypeHintsIgnoredCorrectly()
+    {
+        $collection = $this->loadFromControllerFixture('TypeHintedController');
+
+        $this->assertNotNull($collection->get('get_articles'), 'route for "get_articles" does not exist');
+        $this->assertEquals('/articles.{_format}', $collection->get('get_articles')->getPath());
+        $this->assertNotNull($collection->get('post_articles'), 'route for "post_articles" does not exist');
+        $this->assertEquals('/articles.{_format}', $collection->get('post_articles')->getPath());
+        $this->assertNotNull($collection->get('get_article'), 'route for "get_article" does not exist');
+        $this->assertEquals('/articles/{id}.{_format}', $collection->get('get_article')->getPath());
+        $this->assertNotNull($collection->get('post_article'), 'route for "post_article" does not exist');
+        $this->assertEquals('/articles/{id}.{_format}', $collection->get('post_article')->getPath());
+    }
+
     /**
      * Load routes collection from fixture class under Tests\Fixtures directory.
      *

composer.json

@@ -54,7 +54,8 @@
         "symfony/expression-language":    "~2.7|^3.0",
         "symfony/css-selector":           "^2.7|^3.0",
         "phpoption/phpoption":            "^1.1",
-        "jms/serializer-bundle":          "^1.0"
+        "jms/serializer-bundle":          "^1.0",
+        "psr/http-message":               "^1.0"
     },
 
     "suggest": {