Better API error handling

framework/core/src/Api/Actions/DeleteAction.php

@@ -12,7 +12,7 @@ abstract class DeleteAction implements ActionInterface
      * @param \Flarum\Api\Request $request
      * @return \Flarum\Api\Response
      */
-    public function handle(Request $request)
+    public function respond(Request $request)
     {
         $this->delete($request, $response = new Response('', 204));
 

framework/core/src/Api/Actions/JsonApiAction.php

@@ -0,0 +1,43 @@
+<?php namespace Flarum\Api\Actions;
+
+use Closure;
+use Flarum\Api\Request;
+use Illuminate\Http\JsonResponse;
+use Flarum\Core\Exceptions\ValidationFailureException;
+use Flarum\Core\Exceptions\PermissionDeniedException;
+
+abstract class JsonApiAction implements ActionInterface
+{
+    /**
+     * Handle an API request and return an API response, handling any relevant
+     * (API-related) exceptions that are thrown.
+     *
+     * @param \Flarum\Api\Request $request
+     * @return \Flarum\Api\Response
+     */
+    public function handle(Request $request)
+    {
+        try {
+            return $this->respond($request);
+        } catch (ValidationFailureException $e) {
+            $errors = [];
+            foreach ($e->getErrors()->getMessages() as $field => $messages) {
+                $errors[] = [
+                    'detail' => implode("\n", $messages),
+                    'path' => $field
+                ];
+            }
+            return new JsonResponse(['errors' => $errors], 422);
+        } catch (PermissionDeniedException $e) {
+            return new JsonResponse(null, 401);
+        }
+    }
+
+    /**
+     * Handle an API request and return an API response.
+     *
+     * @param \Flarum\Api\Request $request
+     * @return \Flarum\Api\Response
+     */
+    abstract protected function respond(Request $request);
+}

framework/core/src/Api/Actions/SerializeAction.php

@@ -3,14 +3,11 @@
 use Flarum\Api\Request;
 use Flarum\Api\JsonApiRequest;
 use Flarum\Api\JsonApiResponse;
-use Flarum\Core\Exceptions\ValidationFailureException;
-use Flarum\Core\Exceptions\PermissionDeniedException;
 use Tobscure\JsonApi\SerializerInterface;
 use Tobscure\JsonApi\Criteria;
 use Illuminate\Http\Response;
-use Illuminate\Http\JsonResponse;
 
-abstract class SerializeAction implements ActionInterface
+abstract class SerializeAction extends JsonApiAction
 {
     /**
      * The name of the serializer class to output results with.
@@ -68,24 +65,11 @@ abstract class SerializeAction implements ActionInterface
      * @param \Flarum\Api\Request $request
      * @return \Flarum\Api\Response
      */
-    public function handle(Request $request)
+    public function respond(Request $request)
     {
         $request = static::buildJsonApiRequest($request);
 
-        try {
-            $data = $this->data($request, $response = new JsonApiResponse);
-        } catch (ValidationFailureException $e) {
-            $errors = [];
-            foreach ($e->getErrors()->getMessages() as $field => $messages) {
-                $errors[] = [
-                    'detail' => implode("\n", $messages),
-                    'path' => $field
-                ];
-            }
-            return new JsonResponse(['errors' => $errors], 422);
-        } catch (PermissionDeniedException $e) {
-            return new JsonResponse(null, 401);
-        }
+        $data = $this->data($request, $response = new JsonApiResponse);
 
         $serializer = new static::$serializer($request->actor, $request->include, $request->link);
 

framework/core/src/Api/Actions/TokenAction.php

@@ -7,7 +7,7 @@ use Flarum\Core\Exceptions\PermissionDeniedException;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Contracts\Bus\Dispatcher;
 
-class TokenAction implements ActionInterface
+class TokenAction extends JsonApiAction
 {
     protected $users;
 
@@ -25,7 +25,7 @@ class TokenAction implements ActionInterface
      * @param \Flarum\Api\Request $request
      * @return \Flarum\Api\Response
      */
-    public function handle(Request $request)
+    public function respond(Request $request)
     {
         $identification = $request->get('identification');
         $password = $request->get('password');
@@ -33,8 +33,7 @@ class TokenAction implements ActionInterface
         $user = $this->users->findByIdentification($identification);
 
         if (! $user || ! $user->checkPassword($password)) {
-            // throw new PermissionDeniedException;
-            return new JsonResponse(null, 401);
+            throw new PermissionDeniedException;
         }
 
         $token = $this->bus->dispatch(