hotfix: add exception when the action is not a builtin action (api-platform#586)

Author: Simperfit

src/Bridge/Symfony/Bundle/Resources/config/api.xml

@@ -25,7 +25,7 @@
             <argument type="service" id="api_platform.metadata.resource.name_collection_factory" />
             <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
             <argument type="service" id="api_platform.routing.resource_path_generator" />
-
+            <argument type="service" id="service_container" />
             <tag name="routing.loader" />
         </service>
 

src/Bridge/Symfony/Routing/ApiLoader.php

@@ -19,6 +19,7 @@
 use Doctrine\Common\Inflector\Inflector;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\Config\Loader\Loader;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\Routing\Loader\XmlFileLoader;
 use Symfony\Component\Routing\Route;
@@ -34,13 +35,16 @@ final class ApiLoader extends Loader
     const ROUTE_NAME_PREFIX = 'api_';
     const DEFAULT_ACTION_PATTERN = 'api_platform.action.';
 
+    private $kernel;
     private $fileLoader;
     private $resourceNameCollectionFactory;
     private $resourceMetadataFactory;
     private $resourcePathGenerator;
+    private $container;
 
-    public function __construct(KernelInterface $kernel, ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, ResourcePathGeneratorInterface $resourcePathGenerator)
+    public function __construct(KernelInterface $kernel, ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, ResourcePathGeneratorInterface $resourcePathGenerator, ContainerInterface $container)
     {
+        $this->container = $container;
         $this->fileLoader = new XmlFileLoader(new FileLocator($kernel->locateResource('@ApiPlatformBundle/Resources/config/routing')));
         $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
         $this->resourceMetadataFactory = $resourceMetadataFactory;
@@ -108,10 +112,15 @@ private function addRoute(RouteCollection $routeCollection, string $resourceClas
         }
 
         $controller = $operation['controller'] ?? null;
-        $actionName = sprintf('%s_%s', strtolower($operation['method']), $collection ? 'collection' : 'item');
+        $collectionType = $collection ? 'collection' : 'item';
+        $actionName = sprintf('%s_%s', strtolower($operation['method']), $collectionType);
 
         if (null === $controller) {
             $controller = self::DEFAULT_ACTION_PATTERN.$actionName;
+
+            if (!$this->container->has($controller)) {
+                throw new RuntimeException(sprintf('There is no builtin action for the %s %s operation. You need to define the controller yourself.', $collectionType, $operation['method']));
+            }
         }
 
         if ($operationName !== strtolower($operation['method'])) {

tests/Bridge/Symfony/Routing/ApiLoaderTest.php

@@ -19,11 +19,13 @@
 use ApiPlatform\Core\Routing\ResourcePathGeneratorInterface;
 use ApiPlatform\Core\Tests\Fixtures\DummyEntity;
 use Prophecy\Argument;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\Routing\Route;
 
 /**
  * @author Antoine Bluchet <soyuka@gmail.com>
+ * @author Amrouche Hamza <hamza.simperfit@gmail.com>
  */
 class ApiLoaderTest extends \PHPUnit_Framework_TestCase
 {
@@ -99,6 +101,25 @@ public function testNoMethodApiLoader()
         $routeCollection = $this->getApiLoaderWithResourceMetadata($resourceMetadata)->load(null);
     }
 
+    /**
+     * @expectedException \RuntimeException
+     */
+    public function testWrongMethodApiLoader()
+    {
+        $resourceMetadata = new ResourceMetadata();
+        $resourceMetadata = $resourceMetadata->withShortName('dummy');
+
+        $resourceMetadata = $resourceMetadata->withItemOperations([
+            'post' => ['method' => 'POST'],
+        ]);
+
+        $resourceMetadata = $resourceMetadata->withCollectionOperations([
+            'get' => ['method' => 'GET'],
+        ]);
+
+        $routeCollection = $this->getApiLoaderWithResourceMetadata($resourceMetadata)->load(null);
+    }
+
     /**
      * @expectedException \ApiPlatform\Core\Exception\InvalidResourceException
      */
@@ -113,6 +134,20 @@ private function getApiLoaderWithResourceMetadata(ResourceMetadata $resourceMeta
 
         $kernelProphecy = $this->prophesize(KernelInterface::class);
         $kernelProphecy->locateResource(Argument::any())->willReturn($routingConfig);
+        $possibleArguments = [
+            'api_platform.action.get_collection',
+            'api_platform.action.post_collection',
+            'api_platform.action.get_item',
+            'api_platform.action.put_item',
+            'api_platform.action.delete_item',
+        ];
+        $containerProphecy = $this->prophesize(ContainerInterface::class);
+
+        foreach ($possibleArguments as $possibleArgument) {
+            $containerProphecy->has($possibleArgument)->willReturn(true);
+        }
+
+        $containerProphecy->has(Argument::type('string'))->willReturn(false);
 
         $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
         $resourceMetadataFactoryProphecy->create(DummyEntity::class)->willReturn($resourceMetadata);
@@ -123,7 +158,7 @@ private function getApiLoaderWithResourceMetadata(ResourceMetadata $resourceMeta
         $resourcePathGeneratorProphecy = $this->prophesize(ResourcePathGeneratorInterface::class);
         $resourcePathGeneratorProphecy->generateResourceBasePath('dummy')->willReturn('dummies');
 
-        $apiLoader = new ApiLoader($kernelProphecy->reveal(), $resourceNameCollectionFactoryProphecy->reveal(), $resourceMetadataFactoryProphecy->reveal(), $resourcePathGeneratorProphecy->reveal());
+        $apiLoader = new ApiLoader($kernelProphecy->reveal(), $resourceNameCollectionFactoryProphecy->reveal(), $resourceMetadataFactoryProphecy->reveal(), $resourcePathGeneratorProphecy->reveal(), $containerProphecy->reveal());
 
         return $apiLoader;
     }

tests/Fixtures/TestBundle/Entity/CustomAttributeDummy.php

@@ -31,10 +31,6 @@
  *     "normalization_context"={"groups"={"custom_attr_dummy_get"}},
  *     "denormalization_context"={"groups"={"custom_attr_dummy_get"}}
  *     },
- *          "post"={"method"="POST",
- *      "normalization_context"={"groups"={"custom_attr_dummy_post"}},
- *      "denormalization_context"={"groups"={"custom_attr_dummy_post"}}
- *     },
  *          "put"={"method"="PUT",
  *      "normalization_context"={"groups"={"custom_attr_dummy_put"}},
  *      "denormalization_context"={"groups"={"custom_attr_dummy_put"}}
@@ -60,7 +56,7 @@ class CustomAttributeDummy
      *
      * @ORM\Column
      * @Assert\NotBlank
-     * @Groups({"custom_attr_dummy_read", "custom_attr_dummy_write", "custom_attr_dummy_post", "custom_attr_dummy_get"})
+     * @Groups({"custom_attr_dummy_read", "custom_attr_dummy_write", "custom_attr_dummy_get"})
      * @ApiProperty(iri="http://schema.org/name")
      */
     private $name;