GraphQL.php

<?php

namespace Digia\GraphQL;

use Digia\GraphQL\Error\Handler\ErrorHandlerInterface;
use Digia\GraphQL\Error\InvariantException;
use Digia\GraphQL\Execution\ExecutionInterface;
use Digia\GraphQL\Execution\ExecutionProvider;
use Digia\GraphQL\Execution\ExecutionResult;
use Digia\GraphQL\Language\LanguageProvider;
use Digia\GraphQL\Language\Node\DocumentNode;
use Digia\GraphQL\Language\Node\NodeInterface;
use Digia\GraphQL\Language\Node\TypeNodeInterface;
use Digia\GraphQL\Language\Node\ValueNodeInterface;
use Digia\GraphQL\Language\NodePrinterInterface;
use Digia\GraphQL\Language\ParserInterface;
use Digia\GraphQL\Language\Source;
use Digia\GraphQL\Language\SyntaxErrorException;
use Digia\GraphQL\Schema\Building\SchemaBuilderInterface;
use Digia\GraphQL\Schema\Building\SchemaBuildingProvider;
use Digia\GraphQL\Schema\Extension\SchemaExtenderInterface;
use Digia\GraphQL\Schema\Extension\SchemaExtensionProvider;
use Digia\GraphQL\Schema\Resolver\ResolverRegistry;
use Digia\GraphQL\Schema\Resolver\ResolverRegistryInterface;
use Digia\GraphQL\Schema\Schema;
use Digia\GraphQL\Schema\Validation\SchemaValidationProvider;
use Digia\GraphQL\Schema\Validation\SchemaValidatorInterface;
use Digia\GraphQL\Type\CoercerProvider;
use Digia\GraphQL\Type\DirectivesProvider;
use Digia\GraphQL\Type\IntrospectionProvider;
use Digia\GraphQL\Type\ScalarTypesProvider;
use Digia\GraphQL\Validation\RulesProvider;
use Digia\GraphQL\Validation\ValidationProvider;
use Digia\GraphQL\Validation\ValidatorInterface;
use League\Container\Container;

class GraphQL
{
    public const BOOLEAN = 'GraphQLBoolean';
    public const FLOAT   = 'GraphQLFloat';
    public const INT     = 'GraphQLInt';
    public const ID      = 'GraphQLID';
    public const STRING  = 'GraphQLString';

    public const DEPRECATED_DIRECTIVE = 'GraphQLDeprecatedDirective';
    public const INCLUDE_DIRECTIVE    = 'GraphQLIncludeDirective';
    public const SKIP_DIRECTIVE       = 'GraphQLSkipDirective';

    public const SCHEMA_INTROSPECTION             = '__Schema';
    public const DIRECTIVE_INTROSPECTION          = '__Directive';
    public const DIRECTIVE_LOCATION_INTROSPECTION = '__DirectiveLocation';
    public const TYPE_INTROSPECTION               = '__Type';
    public const FIELD_INTROSPECTION              = '__Field';
    public const INPUT_VALUE_INTROSPECTION        = '__InputValue';
    public const ENUM_VALUE_INTROSPECTION         = '__EnumValue';
    public const TYPE_KIND_INTROSPECTION          = '__TypeKind';

    public const SCHEMA_META_FIELD_DEFINITION    = 'SchemaMetaFieldDefinition';
    public const TYPE_META_FIELD_DEFINITION      = 'TypeMetaFieldDefinition';
    public const TYPE_NAME_META_FIELD_DEFINITION = 'TypeNameMetaFieldDefinition';

    /**
     * @var array
     */
    private static $providers = [
        LanguageProvider::class,
        SchemaBuildingProvider::class,
        SchemaExtensionProvider::class,
        SchemaValidationProvider::class,
        CoercerProvider::class,
        IntrospectionProvider::class,
        ScalarTypesProvider::class,
        DirectivesProvider::class,
        RulesProvider::class,
        ValidationProvider::class,
        ExecutionProvider::class,
    ];

    /**
     * @var GraphQL
     */
    private static $instance;

    /**
     * @var Container
     */
    protected $container;

    /**
     * GraphQL constructor.
     */
    private function __construct()
    {
        $container = new Container();

        $this->registerProviders($container);

        $this->container = $container;
    }

    /**
     * @return GraphQL
     */
    public static function getInstance(): self
    {
        if (null === self::$instance) {
            self::$instance = new self();
        }

        return self::$instance;
    }

    /**
     * @param string $id
     * @return mixed
     */
    public static function make(string $id)
    {
        return static::getInstance()
            ->getContainer()
            ->get($id);
    }

    /**
     * @param Source                          $source
     * @param array|ResolverRegistryInterface $resolverRegistry
     * @param array                           $options
     * @return Schema
     */
    public static function buildSchema(Source $source, $resolverRegistry, array $options = []): Schema
    {
        /** @var SchemaBuilderInterface $schemaBuilder */
        $schemaBuilder = static::make(SchemaBuilderInterface::class);

        return $schemaBuilder->build(
            static::parse($source, $options),
            $resolverRegistry instanceof ResolverRegistryInterface
                ? $resolverRegistry
                : new ResolverRegistry($resolverRegistry),
            $options
        );
    }

    /**
     * @param Schema                          $schema
     * @param Source                          $source
     * @param array|ResolverRegistryInterface $resolverRegistry
     * @param array                           $options
     * @return Schema
     */
    public static function extendSchema(
        Schema $schema,
        Source $source,
        $resolverRegistry,
        array $options = []
    ): Schema {
        /** @var SchemaExtenderInterface $schemaExtender */
        $schemaExtender = static::make(SchemaExtenderInterface::class);

        return $schemaExtender->extend(
            $schema,
            static::parse($source, $options),
            $resolverRegistry instanceof ResolverRegistryInterface
                ? $resolverRegistry
                : new ResolverRegistry($resolverRegistry),
            $options
        );
    }

    /**
     * @param Schema $schema
     * @return array
     */
    public static function validateSchema(Schema $schema): array
    {
        /** @var SchemaValidatorInterface $schemaValidator */
        $schemaValidator = static::make(SchemaValidatorInterface::class);

        return $schemaValidator->validate($schema);
    }

    /**
     * @param Source $source
     * @param array  $options
     * @return DocumentNode
     */
    public static function parse(Source $source, array $options = []): DocumentNode
    {
        /** @var ParserInterface $parser */
        $parser = static::make(ParserInterface::class);

        return $parser->parse($source, $options);
    }

    /**
     * @param Source $source
     * @param array  $options
     * @return ValueNodeInterface
     */
    public static function parseValue(Source $source, array $options = []): ValueNodeInterface
    {
        /** @var ParserInterface $parser */
        $parser = static::make(ParserInterface::class);

        return $parser->parseValue($source, $options);
    }

    /**
     * @param Source $source
     * @param array  $options
     * @return TypeNodeInterface
     */
    public static function parseType(Source $source, array $options = []): TypeNodeInterface
    {
        /** @var ParserInterface $parser */
        $parser = static::make(ParserInterface::class);

        return $parser->parseType($source, $options);
    }

    /**
     * @param Schema       $schema
     * @param DocumentNode $document
     * @return array
     */
    public static function validate(Schema $schema, DocumentNode $document): array
    {
        /** @var ValidatorInterface $validator */
        $validator = static::make(ValidatorInterface::class);

        return $validator->validate($schema, $document);
    }

    /**
     * @param Schema                     $schema
     * @param DocumentNode               $document
     * @param mixed                      $rootValue
     * @param mixed                      $contextValue
     * @param array                      $variableValues
     * @param string|null                $operationName
     * @param callable|null              $fieldResolver
     * @param ErrorHandlerInterface|null $errorHandler
     * @return ExecutionResult
     */
    public static function execute(
        Schema $schema,
        DocumentNode $document,
        $rootValue = null,
        $contextValue = null,
        array $variableValues = [],
        $operationName = null,
        callable $fieldResolver = null,
        ?ErrorHandlerInterface $errorHandler = null
    ): ExecutionResult {
        /** @var ExecutionInterface $execution */
        $execution = static::make(ExecutionInterface::class);

        return $execution->execute(
            $schema,
            $document,
            $rootValue,
            $contextValue,
            $variableValues,
            $operationName,
            $fieldResolver,
            $errorHandler
        );
    }

    /**
     * @param Schema                     $schema
     * @param string                     $source
     * @param mixed                      $rootValue
     * @param mixed                      $contextValue
     * @param array                      $variableValues
     * @param null|string                $operationName
     * @param callable|null              $fieldResolver
     * @param ErrorHandlerInterface|null $errorHandler
     * @return ExecutionResult
     * @throws InvariantException
     * @throws SyntaxErrorException
     */
    public static function process(
        Schema $schema,
        string $source,
        $rootValue = null,
        $contextValue = null,
        array $variableValues = [],
        ?string $operationName = null,
        ?callable $fieldResolver = null,
        ?ErrorHandlerInterface $errorHandler = null
    ): ExecutionResult {
        $schemaValidationErrors = validateSchema($schema);

        if (!empty($schemaValidationErrors)) {
            if (null !== $errorHandler) {
                foreach ($schemaValidationErrors as $schemaValidationError) {
                    $errorHandler->handleError($schemaValidationError);
                }
            }

            return new ExecutionResult(null, $schemaValidationErrors);
        }

        try {
            $document = parse($source);
        } catch (SyntaxErrorException $error) {
            if (null !== $errorHandler) {
                $errorHandler->handleError($error);
            }

            return new ExecutionResult(null, [$error]);
        }

        $validationErrors = validate($schema, $document);

        if (!empty($validationErrors)) {
            if (null !== $errorHandler) {
                foreach ($validationErrors as $validationError) {
                    $errorHandler->handleError($validationError);
                }
            }

            return new ExecutionResult(null, $validationErrors);
        }

        return execute(
            $schema,
            $document,
            $rootValue,
            $contextValue,
            $variableValues,
            $operationName,
            $fieldResolver,
            $errorHandler
        );
    }

    /**
     * @param NodeInterface $node
     * @return string
     */
    public static function print(NodeInterface $node): string
    {
        /** @var NodePrinterInterface $nodePrinter */
        $nodePrinter = static::make(NodePrinterInterface::class);

        return $nodePrinter->print($node);
    }

    /**
     * @return Container
     */
    public function getContainer(): Container
    {
        return $this->container;
    }

    /**
     * Registers the service provides with the container.
     *
     * @param Container $container
     */
    protected function registerProviders(Container $container): void
    {
        foreach (self::$providers as $className) {
            $container->addServiceProvider($className);
        }
    }
}