Improving the request/response format autodetection

yceruto · yceruto · commit 195292847120 · 2019-07-03T12:46:41.000-04:00
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -192,6 +192,10 @@ class Request
 
     protected static $requestFactory;
 
+    /**
+     * @var string|null
+     */
+    private $preferredFormat;
     private $isHostValid = true;
     private $isForwardedValid = true;
 
@@ -1559,6 +1563,25 @@ public function isNoCache()
         return $this->headers->hasCacheControlDirective('no-cache') || 'no-cache' == $this->headers->get('Pragma');
     }
 
+    public function getPreferredFormat(?string $default = 'html'): ?string
+    {
+        if (null !== $this->preferredFormat) {
+            return $this->preferredFormat;
+        }
+
+        $this->preferredFormat = $this->getRequestFormat($this->getContentType());
+
+        if (null === $this->preferredFormat) {
+            foreach ($this->getAcceptableContentTypes() as $contentType) {
+                if (null !== $this->preferredFormat = $this->getFormat($contentType)) {
+                    break;
+                }
+            }
+        }
+
+        return $this->preferredFormat ?: $default;
+    }
+
     /**
      * Returns the preferred language.
      *
diff --git a/src/Symfony/Component/HttpFoundation/Response.php b/src/Symfony/Component/HttpFoundation/Response.php
@@ -270,7 +270,7 @@ public function prepare(Request $request)
         } else {
             // Content-type based on the Request
             if (!$headers->has('Content-Type')) {
-                $format = $request->getRequestFormat();
+                $format = $request->getPreferredFormat();
                 if (null !== $format && $mimeType = $request->getMimeType($format)) {
                     $headers->set('Content-Type', $mimeType);
                 }
diff --git a/src/Symfony/Component/HttpFoundation/Tests/RequestTest.php b/src/Symfony/Component/HttpFoundation/Tests/RequestTest.php
@@ -399,6 +399,32 @@ public function testDuplicateWithFormat()
         $this->assertEquals('xml', $dup->getRequestFormat());
     }
 
+    public function testGetPreferredFormat()
+    {
+        $request = new Request();
+        $this->assertNull($request->getPreferredFormat(null));
+        $this->assertSame('html', $request->getPreferredFormat());
+        $this->assertSame('json', $request->getPreferredFormat('json'));
+
+        $request->setRequestFormat('atom');
+        $request->headers->set('Content-Type', 'application/json');
+        $request->headers->set('Accept', 'application/xml');
+        $this->assertSame('atom', $request->getPreferredFormat());
+
+        $request = new Request();
+        $request->headers->set('Content-Type', 'application/json');
+        $request->headers->set('Accept', 'application/xml');
+        $this->assertSame('json', $request->getPreferredFormat());
+
+        $request = new Request();
+        $request->headers->set('Accept', 'application/xml');
+        $this->assertSame('xml', $request->getPreferredFormat());
+
+        $request = new Request();
+        $request->headers->set('Accept', 'application/json;q=0.8,application/xml;q=0.9');
+        $this->assertSame('xml', $request->getPreferredFormat());
+    }
+
     /**
      * @dataProvider getFormatToMimeTypeMapProviderWithAdditionalNullFormat
      */
diff --git a/src/Symfony/Component/HttpKernel/EventListener/DebugHandlersListener.php b/src/Symfony/Component/HttpKernel/EventListener/DebugHandlersListener.php
@@ -174,7 +174,7 @@ public function onKernelException(GetResponseForExceptionEvent $event)
             $e = $request->attributes->get('exception');
 
             try {
-                return new Response($this->errorFormatter->render($e, $request->getRequestFormat()), $e->getStatusCode(), $e->getHeaders());
+                return new Response($this->errorFormatter->render($e, $request->getPreferredFormat()), $e->getStatusCode(), $e->getHeaders());
             } catch (ErrorRendererNotFoundException $_) {
                 return new Response($this->errorFormatter->render($e), $e->getStatusCode(), $e->getHeaders());
             }

Original file line number	Diff line number	Diff line change
`@@ -270,7 +270,7 @@ public function prepare(Request $request)`
`270`	`270`	`} else {`
`271`	`271`	`// Content-type based on the Request`
`272`	`272`	`if (!$headers->has('Content-Type')) {`
`273`		`- $format = $request->getRequestFormat();`
	`273`	`+ $format = $request->getPreferredFormat();`
`274`	`274`	`if (null !== $format && $mimeType = $request->getMimeType($format)) {`
`275`	`275`	`$headers->set('Content-Type', $mimeType);`
`276`	`276`	`}`
Original file line number	Diff line number	Diff line change
`@@ -174,7 +174,7 @@ public function onKernelException(GetResponseForExceptionEvent $event)`
`174`	`174`	`$e = $request->attributes->get('exception');`
`175`	`175`
`176`	`176`	`try {`
`177`		`- return new Response($this->errorFormatter->render($e, $request->getRequestFormat()), $e->getStatusCode(), $e->getHeaders());`
	`177`	`+ return new Response($this->errorFormatter->render($e, $request->getPreferredFormat()), $e->getStatusCode(), $e->getHeaders());`
`178`	`178`	`} catch (ErrorRendererNotFoundException $_) {`
`179`	`179`	`return new Response($this->errorFormatter->render($e), $e->getStatusCode(), $e->getHeaders());`
`180`	`180`	`}`