Version 4.5.0

system/3rd_party/graphql-php/Server/StandardServer.php

@@ -0,0 +1,181 @@
+<?php
+namespace GraphQL\Server;
+
+use GraphQL\Error\FormattedError;
+use GraphQL\Error\InvariantViolation;
+use GraphQL\Executor\ExecutionResult;
+use GraphQL\Executor\Promise\Promise;
+use GraphQL\Utils;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\StreamInterface;
+
+/**
+ * GraphQL server compatible with both: [express-graphql](https://github.com/graphql/express-graphql)
+ * and [Apollo Server](https://github.com/apollographql/graphql-server).
+ * Usage Example:
+ *
+ *     $server = new StandardServer([
+ *       'schema' => $mySchema
+ *     ]);
+ *     $server->handleRequest();
+ *
+ * Or using [ServerConfig](reference.md#graphqlserverserverconfig) instance:
+ *
+ *     $config = GraphQL\Server\ServerConfig::create()
+ *         ->setSchema($mySchema)
+ *         ->setContext($myContext);
+ *
+ *     $server = new GraphQL\Server\StandardServer($config);
+ *     $server->handleRequest();
+ *
+ * See [dedicated section in docs](executing-queries.md#using-server) for details.
+ *
+ */
+class StandardServer
+{
+    /**
+     * @var ServerConfig
+     */
+    private $config;
+
+    /**
+     * @var Helper
+     */
+    private $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
+     * @param \Throwable $error
+     * @param bool $debug
+     * @param bool $exitWhenDone
+     */
+    public static function send500Error($error, $debug = false, $exitWhenDone = false)
+    {
+        $response = [
+            'errors' => [
+                FormattedError::createFromException($error, $debug)
+            ]
+        ];
+        $helper = new Helper();
+        $helper->emitResponse($response, 500, $exitWhenDone);
+    }
+
+    /**
+     * Creates new instance of a standard GraphQL HTTP server
+     *
+     * @api
+     * @param ServerConfig|array $config
+     */
+    public function __construct($config)
+    {
+        if (is_array($config)) {
+            $config = ServerConfig::create($config);
+        }
+        if (!$config instanceof ServerConfig) {
+            throw new InvariantViolation("Expecting valid server config, but got " . Utils::printSafe($config));
+        }
+        $this->config = $config;
+        $this->helper = new Helper();
+    }
+
+    /**
+     * 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.
+     * 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)
+     *
+     * @api
+     * @param OperationParams|OperationParams[] $parsedBody
+     * @param bool $exitWhenDone
+     */
+    public function handleRequest($parsedBody = null, $exitWhenDone = false)
+    {
+        $result = $this->executeRequest($parsedBody);
+        $this->helper->sendResponse($result, $exitWhenDone);
+    }
+
+    /**
+     * Executes GraphQL operation and returns 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.
+     * 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.
+     *
+     * @api
+     * @param OperationParams|OperationParams[] $parsedBody
+     * @return ExecutionResult|ExecutionResult[]|Promise
+     * @throws InvariantViolation
+     */
+    public function executeRequest($parsedBody = null)
+    {
+        if (null === $parsedBody) {
+            $parsedBody = $this->helper->parseHttpRequest();
+        }
+
+        if (is_array($parsedBody)) {
+            return $this->helper->executeBatch($this->config, $parsedBody);
+        } else {
+            return $this->helper->executeOperation($this->config, $parsedBody);
+        }
+    }
+
+    /**
+     * Executes PSR-7 request and fulfills PSR-7 response.
+     *
+     * See `executePsrRequest()` if you prefer to create response yourself
+     * (e.g. using specific JsonResponse instance of some framework).
+     *
+     * @api
+     * @param ServerRequestInterface $request
+     * @param ResponseInterface $response
+     * @param StreamInterface $writableBodyStream
+     * @return ResponseInterface|Promise
+     */
+    public function processPsrRequest(
+        ServerRequestInterface $request,
+        ResponseInterface $response,
+        StreamInterface $writableBodyStream
+    )
+    {
+        $result = $this->executePsrRequest($request);
+        return $this->helper->toPsrResponse($result, $response, $writableBodyStream);
+    }
+
+    /**
+     * Executes GraphQL operation and returns execution result
+     * (or promise when promise adapter is different from SyncPromiseAdapter)
+     *
+     * @api
+     * @param ServerRequestInterface $request
+     * @return ExecutionResult|ExecutionResult[]|Promise
+     */
+    public function executePsrRequest(ServerRequestInterface $request)
+    {
+        $parsedBody = $this->helper->parsePsrRequest($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
+     * @return Helper
+     */
+    public function getHelper()
+    {
+        return $this->helper;
+    }
+}