Merge pull request #43 from thecodingmachine/http_code_decider

Adding an option to set HttpCodeDecider

Author: moufmouf

config/graphqlite.php

@@ -1,6 +1,7 @@
 <?php
 
 use GraphQL\Error\DebugFlag;
+use TheCodingMachine\GraphQLite\Http\HttpCodeDecider;
 
 return [
     /*
@@ -21,4 +22,7 @@
     'debug' => DebugFlag::RETHROW_UNSAFE_EXCEPTIONS,
     'uri' => env('GRAPHQLITE_URI', '/graphql'),
     'middleware' =>  ['web'],
+
+    // Sets the status code in the HTTP request where operations have errors.
+    'http_code_decider' => HttpCodeDecider::class,
 ];

src/Controllers/GraphQLiteController.php

@@ -11,6 +11,7 @@
 use GraphQL\Server\StandardServer;
 use GraphQL\Upload\UploadMiddleware;
 use TheCodingMachine\GraphQLite\Http\HttpCodeDecider;
+use TheCodingMachine\GraphQLite\Http\HttpCodeDeciderInterface;
 use function array_map;
 use function json_decode;
 use function json_last_error;
@@ -32,10 +33,13 @@ class GraphQLiteController
     private $standardServer;
     /** @var bool|int */
     private $debug;
+    /** @var HttpCodeDeciderInterface */
+    private $httpCodeDecider;
 
-    public function __construct(StandardServer $standardServer, HttpMessageFactoryInterface $httpMessageFactory = null, ?int $debug = DebugFlag::RETHROW_UNSAFE_EXCEPTIONS)
+    public function __construct(StandardServer $standardServer, HttpCodeDeciderInterface $httpCodeDecider, HttpMessageFactoryInterface $httpMessageFactory = null, ?int $debug = DebugFlag::RETHROW_UNSAFE_EXCEPTIONS)
     {
         $this->standardServer = $standardServer;
+        $this->httpCodeDecider = $httpCodeDecider;
         $this->httpMessageFactory = $httpMessageFactory ?: new DiactorosFactory();
         $this->debug = $debug === null ? false : $debug;
     }
@@ -73,7 +77,7 @@ private function handlePsr7Request(ServerRequestInterface $request): JsonRespons
     {
         $result = $this->standardServer->executePsrRequest($request);
 
-        $httpCodeDecider = new HttpCodeDecider();
+        $httpCodeDecider = $this->httpCodeDecider;
         if ($result instanceof ExecutionResult) {
             return new JsonResponse($result->toArray($this->debug), $httpCodeDecider->decideHttpStatusCode($result));
         }

src/Providers/GraphQLiteServiceProvider.php

@@ -19,6 +19,8 @@
 use Symfony\Component\Cache\Psr16Cache;
 use TheCodingMachine\GraphQLite\Context\Context;
 use TheCodingMachine\GraphQLite\Exceptions\WebonyxErrorHandler;
+use TheCodingMachine\GraphQLite\Http\HttpCodeDecider;
+use TheCodingMachine\GraphQLite\Http\HttpCodeDeciderInterface;
 use TheCodingMachine\GraphQLite\Laravel\Listeners\CachePurger;
 use TheCodingMachine\GraphQLite\Laravel\Mappers\Parameters\ValidateFieldMiddleware;
 use TheCodingMachine\GraphQLite\Laravel\Mappers\PaginatorTypeMapper;
@@ -83,13 +85,22 @@ public function register()
         if (!$this->app->has(ResponseFactoryInterface::class)) {
             $this->app->bind(ResponseFactoryInterface::class, ResponseFactory::class);
         }
+        if (!$this->app->has(HttpCodeDeciderInterface::class)) {
+            $this->app->bind(HttpCodeDeciderInterface::class, HttpCodeDecider::class);
+        }
 
         $this->app->bind(HttpMessageFactoryInterface::class, PsrHttpFactory::class);
 
         $this->app->singleton(GraphQLiteController::class, function (Application $app) {
             $debug = config('graphqlite.debug', DebugFlag::RETHROW_UNSAFE_EXCEPTIONS);
+            $decider = config('graphqlite.http_code_decider');
+            if (!$decider) {
+                $httpCodeDecider = $app[HttpCodeDeciderInterface::class];
+            } else {
+                $httpCodeDecider = $app[$decider];
+            }
 
-            return new GraphQLiteController($app[StandardServer::class], $app[HttpMessageFactoryInterface::class], $debug);
+            return new GraphQLiteController($app[StandardServer::class], $httpCodeDecider, $app[HttpMessageFactoryInterface::class], $debug);
         });
 
         $this->app->singleton(StandardServer::class, static function (Application $app) {

tests/Providers/GraphQLiteServiceProviderTest.php

@@ -3,11 +3,20 @@
 namespace TheCodingMachine\GraphQLite\Laravel\Providers;
 
 
+use GraphQL\Error\DebugFlag;
+use GraphQL\Executor\ExecutionResult;
+use GraphQL\Server\StandardServer;
 use Orchestra\Testbench\TestCase;
+use TheCodingMachine\GraphQLite\Http\HttpCodeDeciderInterface;
 use TheCodingMachine\GraphQLite\Laravel\Listeners\CachePurger;
 use TheCodingMachine\GraphQLite\Schema;
 use TheCodingMachine\TDBM\TDBMService;
 use function json_decode;
+use Illuminate\Http\Request;
+use Symfony\Bridge\PsrHttpMessage\Factory\PsrHttpFactory;
+use TheCodingMachine\GraphQLite\Laravel\Controllers\GraphQLiteController;
+use Symfony\Component\HttpFoundation\Request as SymfonyRequest;
+
 
 class GraphQLiteServiceProviderTest extends TestCase
 {
@@ -165,4 +174,45 @@ public function testCachePurger(): void
         $cachePurger->handle();
         $this->assertTrue(true);
     }
+
+    /**
+     * Asserts that the status code has been taken from the HttpCodeDeciderInterface.
+     */
+    public function testChangeTheCodeDecider()
+    {
+        $this->app->instance(HttpCodeDeciderInterface::class, $this->newCodeDecider(418));
+
+        $controller = $this->newGraphQLiteController();
+
+        $response = $controller->index($this->newRequest());
+
+        $this->assertEquals(418, $response->getStatusCode());
+    }
+
+    private function newCodeDecider(int $statusCode): HttpCodeDeciderInterface
+    {
+        return new class implements HttpCodeDeciderInterface {
+            public function decideHttpStatusCode(ExecutionResult $result): int
+            {
+                return 418;
+            }
+        };
+    }
+
+    private function newGraphQLiteController(): GraphQLiteController
+    {
+        $server = $this->app->make(StandardServer::class);
+        $httpCodeDecider = $this->app->make(HttpCodeDeciderInterface::class);
+        $messageFactory = $this->app->make(PsrHttpFactory::class);
+        return new GraphQLiteController($server, $httpCodeDecider, $messageFactory, DebugFlag::RETHROW_UNSAFE_EXCEPTIONS);
+    }
+
+    private function newRequest(): Request
+    {
+        $baseRequest = SymfonyRequest::create('https://localhost', 'GET', [
+            'query' => '{ testValidatorMultiple(foo:"192.168.1.1") }'
+        ]);
+
+        return Request::createFromBase($baseRequest);
+    }
 }