Allow wildcard Accept header for CRUDController AJAX requests

sonata-project · Jul 29, 2020 · fc95c52 · fc95c52
1 parent ca3d5c3
commit fc95c52
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/composer.json b/composer.json
@@ -75,7 +75,7 @@
         "symfony/css-selector": "^4.4",
         "symfony/filesystem": "^4.4",
         "symfony/maker-bundle": "^1.17",
-        "symfony/phpunit-bridge": "^5.1",
+        "symfony/phpunit-bridge": "^5.1.1",
         "symfony/yaml": "^4.4"
     },
     "suggest": {

diff --git a/src/Controller/CRUDController.php b/src/Controller/CRUDController.php
@@ -1563,8 +1563,8 @@ private function setFormTheme(FormView $formView, ?array $theme = null): void
 
     private function handleXmlHttpRequestErrorResponse(Request $request, FormInterface $form): ?JsonResponse
     {
-        if (!\in_array('application/json', $request->getAcceptableContentTypes(), true)) {
-            @trigger_error('In next major version response will return 406 NOT ACCEPTABLE without `Accept: application/json`', E_USER_DEPRECATED);
+        if (0 === \count(array_intersect(['application/json', '*/*'], $request->getAcceptableContentTypes()))) {
+            @trigger_error('In next major version response will return 406 NOT ACCEPTABLE without `Accept: application/json` or `Accept: */*`', E_USER_DEPRECATED);
 
             return null;
         }
@@ -1585,8 +1585,8 @@ private function handleXmlHttpRequestErrorResponse(Request $request, FormInterfa
      */
     private function handleXmlHttpRequestSuccessResponse(Request $request, $object): JsonResponse
     {
-        if (!\in_array('application/json', $request->getAcceptableContentTypes(), true)) {
-            @trigger_error('In next major version response will return 406 NOT ACCEPTABLE without `Accept: application/json`', E_USER_DEPRECATED);
+        if (0 === \count(array_intersect(['application/json', '*/*'], $request->getAcceptableContentTypes()))) {
+            @trigger_error('In next major version response will return 406 NOT ACCEPTABLE without `Accept: application/json` or `Accept: */*`', E_USER_DEPRECATED);
         }
 
         return $this->renderJson([

diff --git a/tests/Controller/CRUDControllerTest.php b/tests/Controller/CRUDControllerTest.php
@@ -40,6 +40,7 @@
 use Sonata\Exporter\Exporter;
 use Sonata\Exporter\Source\SourceIteratorInterface;
 use Sonata\Exporter\Writer\JsonWriter;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Symfony\Bundle\FrameworkBundle\Templating\DelegatingEngine;
 use Symfony\Component\DependencyInjection\Container;
@@ -74,6 +75,8 @@
  */
 class CRUDControllerTest extends TestCase
 {
+    use ExpectDeprecationTrait;
+
     /**
      * @var CRUDController
      */
@@ -1665,7 +1668,6 @@ public function testEditActionAjaxError(): void
 
     /**
      * @legacy
-     * @expectedDeprecation In next major version response will return 406 NOT ACCEPTABLE without `Accept: application/json`
      */
     public function testEditActionAjaxErrorWithoutAcceptApplicationJson(): void
     {
@@ -1706,6 +1708,7 @@ public function testEditActionAjaxErrorWithoutAcceptApplicationJson(): void
             ->method('trans')
             ->willReturn('flash message');
 
+        $this->expectDeprecation('In next major version response will return 406 NOT ACCEPTABLE without `Accept: application/json` or `Accept: */*`');
         $this->assertInstanceOf(Response::class, $response = $this->controller->editAction(null));
         $this->assertSame($this->admin, $this->parameters['admin']);
         $this->assertSame('@SonataAdmin/ajax_layout.html.twig', $this->parameters['base_template']);
@@ -2363,7 +2366,6 @@ public function testCreateActionAjaxError(): void
 
     /**
      * @legacy
-     * @expectedDeprecation In next major version response will return 406 NOT ACCEPTABLE without `Accept: application/json`
      */
     public function testCreateActionAjaxErrorWithoutAcceptApplicationJson(): void
     {
@@ -2408,6 +2410,7 @@ public function testCreateActionAjaxErrorWithoutAcceptApplicationJson(): void
             ->method('trans')
             ->willReturn('flash message');
 
+        $this->expectDeprecation('In next major version response will return 406 NOT ACCEPTABLE without `Accept: application/json` or `Accept: */*`');
         $this->assertInstanceOf(Response::class, $response = $this->controller->createAction());
         $this->assertSame($this->admin, $this->parameters['admin']);
         $this->assertSame('@SonataAdmin/ajax_layout.html.twig', $this->parameters['base_template']);