Handle AuthorizationException

CHANGELOG.md

@@ -10,6 +10,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Support extending schema using partial GraphQL schema files.
 
+### Added
+- Handle `Illuminate\Auth\Access\AuthorizationException` exceptions.
+
 ## [10.0.0] - 2023-03-02
 
 ### Changed

src/Concerns/HandlesGraphqlRequests.php

@@ -21,6 +21,7 @@
 use GraphQL\Type\Schema;
 use GraphQL\Utils\BuildSchema;
 use GraphQL\Utils\SchemaExtender;
+use Illuminate\Auth\Access\AuthorizationException;
 use Illuminate\Contracts\Debug\ExceptionHandler;
 use Illuminate\Database\Eloquent\MissingAttributeException;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
@@ -109,6 +110,16 @@ public function errorFormatter(GraphqlError $graphqlError)
             $throwable instanceof Exception ? $throwable : $graphqlError
         );
 
+        if ($throwable instanceof AuthorizationException) {
+            return array_merge($formattedError, [
+                'message' => $throwable->getMessage(),
+                'extensions' => [
+                    'category' => 'client',
+                    'code' => $throwable->status() ?: 403,
+                ],
+            ]);
+        }
+
         if (
             $throwable instanceof HttpException &&
             $throwable->getStatusCode() >= 400 &&

tests/HandlesGraphqlRequestsTest.php

@@ -289,6 +289,18 @@ public function test_error_with_trace()
         $this->assertSame('internal', Arr::get($data, 'errors.0.extensions.category'));
     }
 
+    public function test_authorization_error_is_formatted()
+    {
+        $controller = $this->app->make(GraphqlController::class);
+        $data = $controller(Request::create('/', 'POST', [
+            'query' => '{ throwAuthorizationException }',
+        ]));
+
+        $this->assertSame('This action is unauthorized.', data_get($data, 'errors.0.message'));
+        $this->assertSame('client', data_get($data, 'errors.0.extensions.category'));
+        $this->assertSame(403, data_get($data, 'errors.0.extensions.code'));
+    }
+
     public function test_http_client_error_is_formatted()
     {
         $controller = $this->app->make(GraphqlController::class);

tests/stubs/Queries/ThrowAuthorizationException.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Butler\Graphql\Tests\Queries;
+
+use Illuminate\Auth\Access\AuthorizationException;
+
+class ThrowAuthorizationException
+{
+    public function __invoke($root, $args, $context)
+    {
+        throw new AuthorizationException();
+    }
+}

tests/stubs/schema.graphql

@@ -4,6 +4,7 @@ type Query {
     testFieldResolver: [NullingType!]!
     dataLoader: [Thing]
     dataLoaderWithCollections: [Thing!]!
+    throwAuthorizationException: String!
     throwError: String!
     throwException: String!
     throwHttpException(code: Int = 400): String!