Merge pull request #42 from tuyakhov/error_formatting

Improve errors formatting

Author: tuyakhov

src/JsonApiResponseFormatter.php

@@ -8,11 +8,29 @@
 use yii\base\Component;
 use yii\helpers\ArrayHelper;
 use yii\helpers\Json;
+use yii\web\ErrorHandler;
 use yii\web\Response;
 use yii\web\ResponseFormatterInterface;
 
 class JsonApiResponseFormatter extends Component implements ResponseFormatterInterface
 {
+    /**
+     * Mapping between the error handler component and JSON API error object
+     * @see ErrorHandler::convertExceptionToArray()
+     */
+    const ERROR_EXCEPTION_MAPPING = [
+        'title' => 'name',
+        'detail' => 'message',
+        'code' => 'code',
+        'status' => 'status'
+    ];
+    /**
+     * An error object MAY have the following members
+     * @link http://jsonapi.org/format/#error-objects
+     */
+    const ERROR_ALLOWED_MEMBERS = [
+        'id', 'links', 'status', 'code', 'title', 'detail', 'source', 'meta'
+    ];
     /**
      * @var integer the encoding options passed to [[Json::encode()]]. For more details please refer to
      * <http://www.php.net/manual/en/function.json-encode.php>.
@@ -44,7 +62,19 @@ public function format($response)
                 if (ArrayHelper::isAssociative($response->data)) {
                     $response->data = [$response->data];
                 }
-                $apiDocument = ['errors' => $response->data];
+                $formattedErrors = [];
+                foreach ($response->data as $error) {
+                    $formattedError = array_intersect_key($error, array_flip(static::ERROR_ALLOWED_MEMBERS));
+                    foreach (static::ERROR_EXCEPTION_MAPPING as $member => $key) {
+                        if (isset($error[$key])) {
+                            $formattedError[$member] = (string) $error[$key];
+                        }
+                    }
+                    if (!empty($formattedError)) {
+                        $formattedErrors[] = $formattedError;
+                    }
+                }
+                $apiDocument = ['errors' => $formattedErrors];
             }
 
             $response->content = Json::encode($apiDocument, $options);

src/Serializer.php

@@ -326,6 +326,7 @@ protected function serializeModelErrors($model)
             $result[] = [
                 'source' => ['pointer' => "/data/attributes/{$memberName}"],
                 'detail' => $message,
+                'status' => '422'
             ];
         }
 

tests/JsonApiResponseFormatterTest.php

@@ -0,0 +1,71 @@
+<?php
+/**
+ * @author Anton Tuyakhov <atuyakhov@gmail.com>
+ */
+namespace tuyakhov\jsonapi\tests;
+
+
+use tuyakhov\jsonapi\JsonApiResponseFormatter;
+use tuyakhov\jsonapi\Serializer;
+use tuyakhov\jsonapi\tests\data\ResourceModel;
+use yii\helpers\Json;
+use yii\web\Response;
+use yii\web\ServerErrorHttpException;
+
+class JsonApiResponseFormatterTest extends TestCase
+{
+    public function testFormatException()
+    {
+        $formatter = new JsonApiResponseFormatter();
+        $exception = new ServerErrorHttpException('Server error');
+        $response = new Response();
+        $response->setStatusCode($exception->statusCode);
+        $response->data = [
+            'name' => $exception->getName(),
+            'message' => $exception->getMessage(),
+            'code' => $exception->getCode(),
+            'status' => $exception->statusCode
+        ];
+        $formatter->format($response);
+        $this->assertJson($response->content);
+        $this->assertSame(Json::encode([
+            'errors' => [
+                [
+                    'code' => '0',
+                    'status' => '500',
+                    'title' => Response::$httpStatuses[500],
+                    'detail' => 'Server error',
+                ]
+            ]
+        ]), $response->content);
+    }
+
+    public function testFormModelError()
+    {
+        $formatter = new JsonApiResponseFormatter();
+        $exception = new ServerErrorHttpException('Server error');
+        $response = new Response();
+        $response->setStatusCode($exception->statusCode);
+        $serializer = new Serializer();
+        $model = new ResourceModel();
+        $model->addError('field1', 'Error');
+        $model->addError('field2', 'Test Error');
+        $response->data = $serializer->serialize($model);
+        $formatter->format($response);
+        $this->assertJson($response->content);
+        $this->assertSame(Json::encode([
+            'errors' => [
+                [
+                    'source' => ['pointer' => "/data/attributes/field1"],
+                    'detail' => 'Error',
+                    'status' => '422'
+                ],
+                [
+                    'source' => ['pointer' => "/data/attributes/field2"],
+                    'detail' => 'Test Error',
+                    'status' => '422'
+                ]
+            ]
+        ]), $response->content);
+    }
+}

tests/SerializerTest.php

@@ -40,14 +40,17 @@ public function testSerializeModelErrors()
             [
                 'source' => ['pointer' => "/data/attributes/field1"],
                 'detail' => 'Test error',
+                'status' => '422'
             ],
             [
                 'source' => ['pointer' => "/data/attributes/field2"],
                 'detail' => 'Multiple error 1',
+                'status' => '422'
             ],
             [
                 'source' => ['pointer' => "/data/attributes/first-name"],
                 'detail' => 'Member name check',
+                'status' => '422'
             ]
         ], $serializer->serialize($model));
     }

tests/TestCase.php

@@ -5,6 +5,7 @@
 namespace tuyakhov\jsonapi\tests;
 
 use \yii\helpers\ArrayHelper;
+use yii\web\Response;
 
 class TestCase extends \PHPUnit_Framework_TestCase
 {
@@ -37,6 +38,12 @@ protected function mockApplication($config = [], $appClass = '\yii\web\Applicati
                     'cookieValidationKey' => 'wefJDF8sfdsfSDefwqdxj9oq',
                     'scriptFile' => __DIR__ .'/index.php',
                     'scriptUrl' => '/index.php',
+                ],
+                'response' => [
+                    'format' => Response::FORMAT_JSON,
+                    'formatters' => [
+                        Response::FORMAT_JSON => 'tuyakhov\jsonapi\JsonApiResponseFormatter'
+                    ]
                 ]
             ],
             'vendorPath' => $this->getVendorPath(),