Update ErrorFormatGuesser to handle custom formats and improve guess… (#1656)

* Updated ErrorFormatGuesser to handle custom formats and improve guessing from request

* Use isset instead of array_key_exists and use Request::getMimeTypes instead of private function.

* Fix comments

Author: natepage

src/Util/ErrorFormatGuesser.php

@@ -37,14 +37,24 @@ private function __construct()
     public static function guessErrorFormat(Request $request, array $errorFormats): array
     {
         $requestFormat = $request->getRequestFormat('');
+
         if ('' !== $requestFormat && isset($errorFormats[$requestFormat])) {
             return ['key' => $requestFormat, 'value' => $errorFormats[$requestFormat]];
         }
 
-        foreach ($errorFormats as $key => $value) {
-            return ['key' => $key, 'value' => $value];
+        $requestMimeTypes = Request::getMimeTypes($request->getRequestFormat());
+        $defaultFormat = [];
+
+        foreach ($errorFormats as $format => $errorMimeTypes) {
+            if (array_intersect($requestMimeTypes, $errorMimeTypes)) {
+                return ['key' => $format, 'value' => $errorMimeTypes];
+            }
+
+            if (!$defaultFormat) {
+                $defaultFormat = ['key' => $format, 'value' => $errorMimeTypes];
+            }
         }
 
-        return [];
+        return $defaultFormat;
     }
 }

tests/Util/ErrorFormatGuesserTest.php

@@ -48,4 +48,14 @@ public function testFallbackWhenNotSupported()
         $this->assertEquals('xml', $format['key']);
         $this->assertEquals('text/xml', $format['value'][0]);
     }
+
+    public function testGuessCustomErrorFormat()
+    {
+        $request = new Request();
+        $request->setRequestFormat('custom_json_format');
+
+        $format = ErrorFormatGuesser::guessErrorFormat($request, ['xml' => ['text/xml'], 'custom_json_format' => ['application/json']]);
+        $this->assertEquals('custom_json_format', $format['key']);
+        $this->assertEquals('application/json', $format['value'][0]);
+    }
 }