Ynlo\GraphQLBundle\Controller\GraphQLEndpointController

Complexity

Total Complexity

26

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Test Coverage

Coverage

72%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
A	addGlobalValidationRules()	0	13	4
F	__invoke()	0	98	21

<?php

/*******************************************************************************
 *  This file is part of the GraphQL Bundle package.
 *
 *  (c) YnloUltratech <support@ynloultratech.com>
 *
 *  For the full copyright and license information, please view the LICENSE
 *  file that was distributed with this source code.
 ******************************************************************************/

namespace Ynlo\GraphQLBundle\Controller;

use GraphQL\Error\ClientAware;
use GraphQL\Error\Debug;
use GraphQL\GraphQL;
use GraphQL\Validator\DocumentValidator;
use GraphQL\Validator\Rules;
use Psr\Log\LoggerInterface;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\HttpKernel\Exception\HttpException;
use Ynlo\GraphQLBundle\Request\ExecuteQuery;
use Ynlo\GraphQLBundle\Request\RequestMiddlewareInterface;
use Ynlo\GraphQLBundle\Schema\SchemaCompiler;
use Ynlo\GraphQLBundle\Security\EndpointResolver;

class GraphQLEndpointController
{
    /**
     * @var EndpointResolver
     */
    protected $resolver;

    /**
     * @var SchemaCompiler
     */
    protected $compiler;

    /**
     * @var bool
     */
    protected $debug;

    /**
     * @var LoggerInterface
     */
    protected $logger;

    /**
     * @var iterable
     */
    protected $middlewares = [];

    public function __construct(
        EndpointResolver $endpointResolver,
        SchemaCompiler $compiler,
        iterable $middlewares = [],
        bool $debug = false,
        LoggerInterface $logger = null
    )
    {
        $this->resolver = $endpointResolver;
        $this->middlewares = $middlewares;
        $this->compiler = $compiler;
        $this->debug = $debug;
        $this->logger = $logger;
    }

    public function __invoke(Request $request): JsonResponse
    {
        if (!$this->debug && $request->getMethod() !== Request::METHOD_POST) {
            throw new HttpException(Response::HTTP_BAD_REQUEST, 'The method should be POST to talk with GraphQL API');
        }

        $query = new ExecuteQuery();
        foreach ($this->middlewares as $middleware) {
            if ($middleware instanceof RequestMiddlewareInterface) {
                $middleware->processRequest($request, $query);
            }
        }

        $context = null;
        $validationRules = null;

        try {
            $endpoint = $this->resolver->resolveEndpoint($request);
            if (!$endpoint) {
                throw new AccessDeniedHttpException();
            }

            $schema = $this->compiler->compile($endpoint);
            $schema->assertValid();

            $result = GraphQL::executeQuery(
                $schema,
                $query->getRequestString(),
                null,
                $context,
                $query->getVariables(),
                $query->getOperationName(),
                null,
                $validationRules
            );

            if (!$this->debug) {
                // in case of debug = false
                // If API_DEBUG is passed, output of error formatter is enriched which debugging information.
                // Helpful for tests to get full error logs without the need of enable full app debug flag
                if (isset($_ENV['API_DEBUG'])) {
                    $this->debug = $_ENV['API_DEBUG'];
                } elseif (isset($_SERVER['API_DEBUG'])) {
                    $this->debug = $_SERVER['API_DEBUG'];
                }
            }

            $debugFlags = false;
            if ($this->debug) {
                $debugFlags = Debug::INCLUDE_DEBUG_MESSAGE | Debug::INCLUDE_TRACE;
            }

            foreach ($result->errors as $error) {
                if (null !== $this->logger) {
                    $originError = $error->getTrace()[0]['args'][0] ?? null;
                    $context = [];
                    if ($originError instanceof \Exception) {
                        $context = [
                            'file' => $originError->getFile(),
                            'line' => $originError->getLine(),
                            'error' => get_class($originError),
                        ];
                    }
                    if ($error->isClientSafe()) {
                        $this->logger->notice($error->getMessage(), $context);
                    } else {
                        $this->logger->error($error->getMessage(), $context);
                    }
                }
            }

            $output = $result->toArray($debugFlags);
            $statusCode = Response::HTTP_OK;
        } catch (\Exception $e) {
            if (null !== $this->logger) {
                $this->logger->error($e->getMessage(), $e->getTrace());
            }

            if ($e instanceof HttpException) {
                $message = Response::$statusTexts[$e->getStatusCode()];
                $statusCode = $e->getStatusCode();
            } else {
                $statusCode = Response::HTTP_INTERNAL_SERVER_ERROR;
                $message = 'Internal Server Error';
                if ($this->debug || ($e instanceof ClientAware && $e->isClientSafe())) {
                    $message = $e->getMessage();
                }
            }

            $output['errors']['message'] = $message;
            $output['errors']['category'] = 'internal';

            if ($this->debug) {
                $output['errors']['trace'] = $e->getTraceAsString();
            }
        }

        return JsonResponse::create($output, $statusCode);
    }

    public function addGlobalValidationRules(array $validationRules): void
    {
        $rules = [];
        if (!empty($validationRules['query_complexity'])) {
            $rules[] = new Rules\QueryComplexity($validationRules['query_complexity']);
        }
        if (!empty($validationRules['query_depth'])) {
            $rules[] = new Rules\QueryDepth($validationRules['query_depth']);
        }
        if (!empty($validationRules['disable_introspection'])) {
            $rules[] = new Rules\DisableIntrospection();
        }
        array_map([DocumentValidator::class, 'addRule'], $rules);
    }
}