Do not change HTTP status code in StandardServer (#1167)

spawnia · web-flow · commit f9f91d762bf9 · 2022-06-09T15:10:48.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -44,7 +44,7 @@ You can find and compare releases at the [GitHub release page](https://github.co
 - Align `Utils::suggestionList()` with the reference implementation (#1075)
 - Order schema topologically and according to the user-defined order, affects introspection and printing
 - `GraphQL\Utils\AST::typeFromAST()` now needs a type loader callable instead of the Schema
-- Removed `GraphQL\Utils\TypeInfo::typeFromAST()` (use `GraphQL\Utils\AST::typeFromAST()` instead)
+- Do not change HTTP status code in `StandardServer`
 
 ### Added
 
@@ -124,6 +124,9 @@ You can find and compare releases at the [GitHub release page](https://github.co
 - Remove argument `bool $exitWhenDone` from `StandardServer::send500Error()` and `StandardServer::handleRequest()`
 - Remove `Schema::getAstNode()` in favor of `Schema::$astNode`
 - Remove ability to override standard types through `Schema` option `types`, use `Type::overrideStandardTypes()`
+- Remove `GraphQL\Utils\TypeInfo::typeFromAST()`, use `GraphQL\Utils\AST::typeFromAST()`
+- Remove `StandardServer::send500Error()`, handle non-GraphQL errors yourself
+- Remove `StandardServer::getHelper()`, use `new Helper`
 
 ## 14.11.6
 
diff --git a/examples/01-blog/graphql.php b/examples/01-blog/graphql.php
@@ -16,33 +16,29 @@
 use GraphQL\Type\Definition\Type;
 use GraphQL\Type\Schema;
 
-try {
-    // Initialize our fake data source
-    DataSource::init();
-
-    // See docs on schema options:
-    // https://webonyx.github.io/graphql-php/schema-definition/#configuration-options
-    $schema = new Schema([
-        'query' => new QueryType(),
-        'typeLoader' => static fn (string $name): Type => Types::byTypeName($name),
-    ]);
-
-    // Prepare context that will be available in all field resolvers (as 3rd argument):
-    $appContext = new AppContext();
-    $currentlyLoggedInUser = DataSource::findUser(1);
-    assert($currentlyLoggedInUser !== null);
-    $appContext->viewer = $currentlyLoggedInUser;
-    $appContext->rootUrl = 'http://localhost:8080';
-    $appContext->request = $_REQUEST;
-
-    // See docs on server options:
-    // https://webonyx.github.io/graphql-php/executing-queries/#server-configuration-options
-    $server = new StandardServer([
-        'schema' => $schema,
-        'context' => $appContext,
-    ]);
-
-    $server->handleRequest();
-} catch (Throwable $error) {
-    StandardServer::send500Error($error);
-}
+// Initialize our fake data source
+DataSource::init();
+
+// See docs on schema options:
+// https://webonyx.github.io/graphql-php/schema-definition/#configuration-options
+$schema = new Schema([
+    'query' => new QueryType(),
+    'typeLoader' => static fn (string $name): Type => Types::byTypeName($name),
+]);
+
+// Prepare context that will be available in all field resolvers (as 3rd argument):
+$appContext = new AppContext();
+$currentlyLoggedInUser = DataSource::findUser(1);
+assert($currentlyLoggedInUser !== null);
+$appContext->viewer = $currentlyLoggedInUser;
+$appContext->rootUrl = 'http://localhost:8080';
+$appContext->request = $_REQUEST;
+
+// See docs on server options:
+// https://webonyx.github.io/graphql-php/executing-queries/#server-configuration-options
+$server = new StandardServer([
+    'schema' => $schema,
+    'context' => $appContext,
+]);
+
+$server->handleRequest();
diff --git a/examples/03-standard-server/graphql.php b/examples/03-standard-server/graphql.php
@@ -16,51 +16,47 @@
 use GraphQL\Type\Definition\Type;
 use GraphQL\Type\Schema;
 
-try {
-    $queryType = new ObjectType([
-        'name' => 'Query',
-        'fields' => [
-            'echo' => [
-                'type' => Type::string(),
-                'args' => [
-                    'message' => ['type' => Type::string()],
-                ],
-                'resolve' => static fn (array $rootValue, array $args): string => $rootValue['prefix'] . $args['message'],
+$queryType = new ObjectType([
+    'name' => 'Query',
+    'fields' => [
+        'echo' => [
+            'type' => Type::string(),
+            'args' => [
+                'message' => ['type' => Type::string()],
             ],
+            'resolve' => static fn (array $rootValue, array $args): string => $rootValue['prefix'] . $args['message'],
         ],
-    ]);
-
-    $mutationType = new ObjectType([
-        'name' => 'Mutation',
-        'fields' => [
-            'sum' => [
-                'type' => Type::int(),
-                'args' => [
-                    'x' => ['type' => Type::int()],
-                    'y' => ['type' => Type::int()],
-                ],
-                'resolve' => static fn (array $rootValue, array $args): int => $args['x'] + $args['y'],
+    ],
+]);
+
+$mutationType = new ObjectType([
+    'name' => 'Mutation',
+    'fields' => [
+        'sum' => [
+            'type' => Type::int(),
+            'args' => [
+                'x' => ['type' => Type::int()],
+                'y' => ['type' => Type::int()],
             ],
+            'resolve' => static fn (array $rootValue, array $args): int => $args['x'] + $args['y'],
         ],
-    ]);
-
-    // See docs on schema options:
-    // https://webonyx.github.io/graphql-php/schema-definition/#configuration-options
-    $schema = new Schema([
-        'query' => $queryType,
-        'mutation' => $mutationType,
-    ]);
-
-    $rootValue = ['prefix' => 'You said: '];
-
-    // See docs on server options:
-    // https://webonyx.github.io/graphql-php/executing-queries/#server-configuration-options
-    $server = new StandardServer([
-        'schema' => $schema,
-        'rootValue' => $rootValue,
-    ]);
-
-    $server->handleRequest();
-} catch (Throwable $e) {
-    StandardServer::send500Error($e);
-}
+    ],
+]);
+
+// See docs on schema options:
+// https://webonyx.github.io/graphql-php/schema-definition/#configuration-options
+$schema = new Schema([
+    'query' => $queryType,
+    'mutation' => $mutationType,
+]);
+
+$rootValue = ['prefix' => 'You said: '];
+
+// See docs on server options:
+// https://webonyx.github.io/graphql-php/executing-queries/#server-configuration-options
+$server = new StandardServer([
+    'schema' => $schema,
+    'rootValue' => $rootValue,
+]);
+
+$server->handleRequest();
diff --git a/src/Server/Helper.php b/src/Server/Helper.php
@@ -415,30 +415,20 @@ public function sendResponse($result): void
     {
         if ($result instanceof Promise) {
             $result->then(function ($actualResult): void {
-                $this->doSendResponse($actualResult);
+                $this->emitResponse($actualResult);
             });
         } else {
-            $this->doSendResponse($result);
+            $this->emitResponse($result);
         }
     }
 
-    /**
-     * @param ExecutionResult|array<ExecutionResult> $result
-     */
-    protected function doSendResponse($result): void
-    {
-        $httpStatus = $this->resolveHttpStatus($result);
-        $this->emitResponse($result, $httpStatus);
-    }
-
     /**
      * @param array<mixed>|JsonSerializable $jsonSerializable
      */
-    public function emitResponse($jsonSerializable, int $httpStatus): void
+    public function emitResponse($jsonSerializable): void
     {
-        $body = json_encode($jsonSerializable);
-        header('Content-Type: application/json', true, $httpStatus);
-        echo $body;
+        header('Content-Type: application/json');
+        echo json_encode($jsonSerializable);
     }
 
     protected function readRawBody(): string
@@ -451,42 +441,6 @@ protected function readRawBody(): string
         return $body;
     }
 
-    /**
-     * @param ExecutionResult|array<ExecutionResult> $result
-     */
-    protected function resolveHttpStatus($result): int
-    {
-        if (is_array($result) && isset($result[0])) {
-            foreach ($result as $index => $executionResult) {
-                // @phpstan-ignore-next-line unless PHP gains generic support, this is unsure
-                if (! $executionResult instanceof ExecutionResult) {
-                    throw new InvariantViolation(
-                        'Expecting every entry of batched query result to be instance of '
-                        . ExecutionResult::class . ' but entry at position ' . $index
-                        . ' is ' . Utils::printSafe($executionResult)
-                    );
-                }
-            }
-
-            $httpStatus = 200;
-        } else {
-            if (! $result instanceof ExecutionResult) {
-                throw new InvariantViolation(
-                    'Expecting query result to be instance of ' . ExecutionResult::class
-                    . ' but got ' . Utils::printSafe($result)
-                );
-            }
-
-            if ($result->data === null && count($result->errors) > 0) {
-                $httpStatus = 400;
-            } else {
-                $httpStatus = 200;
-            }
-        }
-
-        return $httpStatus;
-    }
-
     /**
      * Converts PSR-7 request to OperationParams or an array thereof.
      *
@@ -607,7 +561,6 @@ protected function doConvertToPsrResponse($result, ResponseInterface $response,
         $writableBodyStream->write(json_encode($result, JSON_THROW_ON_ERROR));
 
         return $response
-            ->withStatus($this->resolveHttpStatus($result))
             ->withHeader('Content-Type', 'application/json')
             ->withBody($writableBodyStream);
     }
diff --git a/src/Server/StandardServer.php b/src/Server/StandardServer.php
@@ -2,8 +2,6 @@
 
 namespace GraphQL\Server;
 
-use GraphQL\Error\DebugFlag;
-use GraphQL\Error\FormattedError;
 use GraphQL\Error\InvariantViolation;
 use GraphQL\Executor\ExecutionResult;
 use GraphQL\Executor\Promise\Promise;
@@ -12,7 +10,6 @@
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\StreamInterface;
-use Throwable;
 
 /**
  * GraphQL server compatible with both: [express-graphql](https://github.com/graphql/express-graphql)
@@ -37,31 +34,11 @@
  */
 class StandardServer
 {
-    private ServerConfig $config;
+    protected ServerConfig $config;
 
-    private Helper $helper;
+    protected Helper $helper;
 
     /**
-     * Converts and exception to error and sends spec-compliant HTTP 500 error.
-     * Useful when an exception is thrown somewhere outside of server execution context
-     * (e.g. during schema instantiation).
-     *
-     * @api
-     */
-    public static function send500Error(Throwable $error, int $debug = DebugFlag::NONE): void
-    {
-        $helper = new Helper();
-        $helper->emitResponse(
-            [
-                'errors' => [FormattedError::createFromException($error, $debug)],
-            ],
-            500,
-        );
-    }
-
-    /**
-     * Creates new instance of a standard GraphQL HTTP server.
-     *
      * @param ServerConfig|array<string, mixed> $config
      *
      * @api
@@ -84,12 +61,12 @@ public function __construct($config)
     /**
      * Parses HTTP request, executes and emits response (using standard PHP `header` function and `echo`).
      *
-     * By default (when $parsedBody is not set) it uses PHP globals to parse a request.
+     * When $parsedBody is not set, it uses PHP globals to parse a request.
      * It is possible to implement request parsing elsewhere (e.g. using framework Request instance)
      * and then pass it to the server.
      *
-     * See `executeRequest()` if you prefer to emit response yourself
-     * (e.g. using Response object of some framework)
+     * See `executeRequest()` if you prefer to emit the response yourself
+     * (e.g. using the Response object of some framework).
      *
      * @param OperationParams|array<OperationParams> $parsedBody
      *
@@ -102,19 +79,17 @@ public function handleRequest($parsedBody = null): void
     }
 
     /**
-     * Executes GraphQL operation and returns execution result
+     * Executes a GraphQL operation and returns an execution result
      * (or promise when promise adapter is different from SyncPromiseAdapter).
      *
-     * By default (when $parsedBody is not set) it uses PHP globals to parse a request.
+     * When $parsedBody is not set, it uses PHP globals to parse a request.
      * It is possible to implement request parsing elsewhere (e.g. using framework Request instance)
      * and then pass it to the server.
      *
      * PSR-7 compatible method executePsrRequest() does exactly this.
      *
      * @param OperationParams|array<OperationParams> $parsedBody
      *
-     * @throws InvariantViolation
-     *
      * @return ExecutionResult|array<int, ExecutionResult>|Promise
      *
      * @api
@@ -166,15 +141,4 @@ public function executePsrRequest(RequestInterface $request)
 
         return $this->executeRequest($parsedBody);
     }
-
-    /**
-     * Returns an instance of Server helper, which contains most of the actual logic for
-     * parsing / validating / executing request (which could be re-used by other server implementations).
-     *
-     * @api
-     */
-    public function getHelper(): Helper
-    {
-        return $this->helper;
-    }
 }
