Added AutoSubmitRequestHandler

Author: Massimiliano Braglia

src/ApiPlatformBundle.php

@@ -2,6 +2,7 @@
 
 namespace Fazland\ApiPlatformBundle;
 
+use Fazland\ApiPlatformBundle\DependencyInjection\CompilerPass\OverrideDefaultRequestHandlerPass;
 use Fazland\ApiPlatformBundle\DependencyInjection\CompilerPass\RegisterDecoders;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
@@ -15,6 +16,7 @@ public function build(ContainerBuilder $container): void
     {
         $container
             ->addCompilerPass(new RegisterDecoders())
+            ->addCompilerPass(new OverrideDefaultRequestHandlerPass())
         ;
     }
 }

src/DependencyInjection/ApiPlatformExtension.php

@@ -49,6 +49,7 @@ public function load(array $configs, ContainerBuilder $container): void
         }
 
         $container->setParameter('fazland_api.response_charset', $config['response_charset']);
+        $container->setParameter('fazland_api.auto_submit_request_handler_is_enabled', $config['auto_submit_request_handler']['enabled']);
     }
 
     /**

src/DependencyInjection/CompilerPass/OverrideDefaultRequestHandlerPass.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+
+namespace Fazland\ApiPlatformBundle\DependencyInjection\CompilerPass;
+
+use Fazland\ApiPlatformBundle\Form\Extension\AutoSubmitRequestHandler;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+final class OverrideDefaultRequestHandlerPass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container): void
+    {
+        $isAutoSubmitRequestHandlerEnabled = $container->getParameter('fazland_api.auto_submit_request_handler_is_enabled');
+        if (! $isAutoSubmitRequestHandlerEnabled) {
+            return;
+        }
+
+        $container->findDefinition('form.type_extension.form.request_handler')
+            ->setClass(AutoSubmitRequestHandler::class)
+        ;
+    }
+}

src/DependencyInjection/Configuration.php

@@ -47,6 +47,9 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->scalarNode('response_charset')
                     ->defaultValue('UTF-8')
                 ->end()
+                ->arrayNode('auto_submit_request_handler')
+                    ->canBeDisabled()
+                ->end()
             ->end()
         ;
 

src/Form/Extension/AutoSubmitRequestHandler.php

@@ -0,0 +1,101 @@
+<?php declare(strict_types=1);
+
+namespace Fazland\ApiPlatformBundle\Form\Extension;
+
+use Symfony\Component\Form\Exception\UnexpectedTypeException;
+use Symfony\Component\Form\FormError;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\Form\RequestHandlerInterface;
+use Symfony\Component\Form\Util\ServerParams;
+use Symfony\Component\HttpFoundation\File\File;
+use Symfony\Component\HttpFoundation\Request;
+
+final class AutoSubmitRequestHandler implements RequestHandlerInterface
+{
+    /**
+     * @var ServerParams
+     */
+    private $serverParams;
+
+    public function __construct(?ServerParams $serverParams = null)
+    {
+        $this->serverParams = $serverParams ?? new ServerParams();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handleRequest(FormInterface $form, $request = null): void
+    {
+        if (! $request instanceof Request) {
+            throw new UnexpectedTypeException($request, Request::class);
+        }
+
+        $name = $form->getName();
+        $method = $form->getConfig()->getMethod();
+
+        if ($request->getMethod() !== $method) {
+            return;
+        }
+
+        // For request methods that must not have a request body we fetch data
+        // from the query string. Otherwise we look for data in the request body.
+        if (Request::METHOD_GET === $method || Request::METHOD_HEAD === $method || Request::METHOD_TRACE === $method) {
+            if ('' === $name) {
+                $data = $request->query->all();
+            } else {
+                // Don't submit GET requests if the form's name does not exist
+                // in the request
+                if (! $request->query->has($name)) {
+                    return;
+                }
+
+                $data = $request->query->get($name);
+            }
+        } else {
+            // Mark the form with an error if the uploaded size was too large
+            // This is done here and not in FormValidator because $_POST is
+            // empty when that error occurs. Hence the form is never submitted.
+            if ($this->serverParams->hasPostMaxSizeBeenExceeded()) {
+                // Submit the form, but don't clear the default values
+                $form->submit(null, false);
+
+                $form->addError(new FormError(
+                    \call_user_func($form->getConfig()->getOption('upload_max_size_message')),
+                    null,
+                    ['{{ max }}' => $this->serverParams->getNormalizedIniPostMaxSize()]
+                ));
+
+                return;
+            }
+
+            if ('' === $name) {
+                $params = $request->request->all();
+                $files = $request->files->all();
+            } elseif ($request->request->has($name) || $request->files->has($name)) {
+                $default = $form->getConfig()->getCompound() ? [] : null;
+                $params = $request->request->get($name, $default);
+                $files = $request->files->get($name, $default);
+            } else {
+                // Don't submit the form if it is not present in the request
+                return;
+            }
+
+            if (\is_array($params) && \is_array($files)) {
+                $data = \array_replace_recursive($params, $files);
+            } else {
+                $data = $params ?: $files;
+            }
+        }
+
+        $form->submit($data, Request::METHOD_PATCH !== $method);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isFileUpload($data): bool
+    {
+        return $data instanceof File;
+    }
+}

tests/DependencyInjection/CompilerPass/OverrideDefaultRequestHandlerPassTest.php

@@ -0,0 +1,57 @@
+<?php declare(strict_types=1);
+
+namespace Fazland\ApiPlatformBundle\Tests\DependencyInjection\CompilerPass;
+
+use Fazland\ApiPlatformBundle\DependencyInjection\CompilerPass\OverrideDefaultRequestHandlerPass;
+use Fazland\ApiPlatformBundle\Form\Extension\AutoSubmitRequestHandler;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Prophecy\ObjectProphecy;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+
+class OverrideDefaultRequestHandlerPassTest extends TestCase
+{
+    /**
+     * @var ContainerBuilder|ObjectProphecy
+     */
+    private $container;
+
+    /**
+     * @var OverrideDefaultRequestHandlerPass
+     */
+    private $compilerPass;
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function setUp(): void
+    {
+        $this->container = $this->prophesize(ContainerBuilder::class);
+        $this->compilerPass = new OverrideDefaultRequestHandlerPass();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function testProcessShouldNotActIfAutoSubmitRequestHandlerIsDisabled(): void
+    {
+        $this->container->getParameter('fazland_api.auto_submit_request_handler_is_enabled')->willReturn(false);
+        $this->container->findDefinition('form.type_extension.form.request_handler')->shouldNotBeCalled();
+
+        $this->compilerPass->process($this->container->reveal());
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function testProcessShouldOverrideDefaultRequestHandlerWithAutoSubmitRequestHandler(): void
+    {
+        $definition = $this->prophesize(Definition::class);
+
+        $this->container->getParameter('fazland_api.auto_submit_request_handler_is_enabled')->willReturn(true);
+        $this->container->findDefinition('form.type_extension.form.request_handler')->willReturn($definition);
+        $definition->setClass(AutoSubmitRequestHandler::class)->shouldBeCalled();
+
+        $this->compilerPass->process($this->container->reveal());
+    }
+}

tests/Form/Extension/AutoSubmitRequestHandlerTest.php

@@ -0,0 +1,43 @@
+<?php declare(strict_types=1);
+
+namespace Fazland\ApiPlatformBundle\Tests\Form\Extension;
+
+use Fazland\ApiPlatformBundle\Form\Extension\AutoSubmitRequestHandler;
+use Symfony\Component\Form\RequestHandlerInterface;
+use Symfony\Component\Form\Tests\Extension\HttpFoundation\HttpFoundationRequestHandlerTest;
+use Symfony\Component\HttpFoundation\Request;
+
+class AutoSubmitRequestHandlerTest extends HttpFoundationRequestHandlerTest
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function getRequestHandler(): RequestHandlerInterface
+    {
+        return new AutoSubmitRequestHandler($this->serverParams);
+    }
+
+    /**
+     * @dataProvider methodProvider
+     */
+    public function testDoNotSubmitFormWithEmptyNameIfNoFieldInRequest($method): void
+    {
+        $form = $this->getMockForm('', $method);
+        $form->expects(self::any())
+            ->method('all')
+            ->will(self::returnValue([
+                'param1' => $this->getMockForm('param1'),
+                'param2' => $this->getMockForm('param2'),
+            ]))
+        ;
+
+        $this->setRequestData($method, ['paramx' => 'submitted value']);
+
+        $form->expects(self::once())
+            ->method('submit')
+            ->with(['paramx' => 'submitted value'], Request::METHOD_PATCH !== $method)
+        ;
+
+        $this->requestHandler->handleRequest($form, $this->request);
+    }
+}