Ynlo\GraphQLBundle\Resolver\ResolverExecutor

Complexity

Total Complexity

63

Size/Duplication

Total Lines	361
Duplicated Lines	0 %

Test Coverage

Coverage

82.24%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
B	setObjectValue()	0	14	5
D	resolveMethodArguments()	0	26	9
C	prepareMethodParameters()	0	36	8
B	resolveObjectExtensions()	0	28	4
B	arrayToObject()	0	31	6
C	applyArgumentsNamingConventions()	0	22	7
A	__construct()	0	5	1
F	__invoke()	0	70	17
B	normalizeValue()	0	17	6

<?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\Resolver;

use Doctrine\Common\Util\ClassUtils;
use Doctrine\ORM\EntityManager;
use GraphQL\Type\Definition\ResolveInfo;
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerAwareTrait;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\PropertyAccess\PropertyAccessor;
use Ynlo\GraphQLBundle\Definition\ExecutableDefinitionInterface;
use Ynlo\GraphQLBundle\Definition\FieldDefinition;
use Ynlo\GraphQLBundle\Definition\HasExtensionsInterface;
use Ynlo\GraphQLBundle\Definition\NodeAwareDefinitionInterface;
use Ynlo\GraphQLBundle\Definition\ObjectDefinition;
use Ynlo\GraphQLBundle\Definition\ObjectDefinitionInterface;
use Ynlo\GraphQLBundle\Definition\Registry\Endpoint;
use Ynlo\GraphQLBundle\Extension\ExtensionInterface;
use Ynlo\GraphQLBundle\Extension\ExtensionsAwareInterface;
use Ynlo\GraphQLBundle\Model\ID;
use Ynlo\GraphQLBundle\Type\Types;

/**
 * This resolver act as a middleware between the executableDefinition and final resolvers.
 * Using injection of parameters can resolve the parameters needed by the final resolver before invoke
 */
class ResolverExecutor implements ContainerAwareInterface
{
    use ContainerAwareTrait;

    /**
     * @var ExecutableDefinitionInterface
     */
    protected $executableDefinition;

    /**
     * @var Endpoint
     */
    protected $endpoint;

    /**
     * @var mixed
     */
    protected $root;

    /**
     * @var ResolveInfo
     */
    protected $resolveInfo;

    /**
     * @var mixed
     */
    protected $context;

    /**
     * @var array
     */
    protected $args = [];

    /**
     * @param ContainerInterface            $container
     * @param Endpoint                      $endpoint
     * @param ExecutableDefinitionInterface $executableDefinition
     */
    public function __construct(ContainerInterface $container, Endpoint $endpoint, ExecutableDefinitionInterface $executableDefinition)
    {
        $this->executableDefinition = $executableDefinition;
        $this->endpoint = $endpoint;
        $this->container = $container;
    }

    /**
     * @param mixed       $root
     * @param array       $args
     * @param mixed       $context
     * @param ResolveInfo $resolveInfo
     *
     * @return mixed
     *
     * @throws \Exception
     */
    public function __invoke($root, array $args, $context, ResolveInfo $resolveInfo)
    {
        $this->root = $root;
        $this->args = $args;
        $this->context = $context;
        $this->resolveInfo = $resolveInfo;

        $resolverName = $this->executableDefinition->getResolver();

        $resolver = null;
        $refMethod = null;

        if (class_exists($resolverName)) {
            $refClass = new \ReflectionClass($resolverName);

            /** @var callable $resolver */
            $resolver = $refClass->newInstance();
            if ($resolver instanceof ContainerAwareInterface) {
                $resolver->setContainer($this->container);
            }
            if ($refClass->hasMethod('__invoke')) {
                $refMethod = $refClass->getMethod('__invoke');
            }
        } elseif (method_exists($root, $resolverName)) {
            $resolver = $root;
            $refMethod = new \ReflectionMethod(ClassUtils::getClass($root), $resolverName);
        }

        if ($resolver && $refMethod) {
            $resolveContext = new ResolverContext();
            $resolveContext->setDefinition($this->executableDefinition);
            $resolveContext->setArgs($args);
            $resolveContext->setRoot($root);
            $resolveContext->setEndpoint($this->endpoint);
            $resolveContext->setResolveInfo($resolveInfo);

            $type = null;
            if ($this->executableDefinition instanceof NodeAwareDefinitionInterface && $this->executableDefinition->getNode()) {

The expression $this->executableDefinition->getNode() of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

                $type = $this->executableDefinition->getNode();
            }

            if (!$type && $this->executableDefinition->hasMeta('node')) {

The expression $type of type null|string is loosely compared to false; this is ambiguous if the string can be empty. You might want to explicitly use === null instead.

                $type = $this->executableDefinition->getMeta('node');
            }
            if (!$type) {
                $type = $this->executableDefinition->getType();
            }

            $nodeDefinition = null;
            if ($this->endpoint->hasType($type)) {
                if ($nodeDefinition = $this->endpoint->getType($type)) {
                    $resolveContext->setNodeDefinition($nodeDefinition);
                }
            }

            if ($resolver instanceof AbstractResolver) {
                $resolver->setContext($resolveContext);
            }

            if ($resolver instanceof ExtensionsAwareInterface && $nodeDefinition instanceof HasExtensionsInterface) {
                $resolver->setExtensions($this->resolveObjectExtensions($nodeDefinition));
            }

            $params = $this->prepareMethodParameters($refMethod, $args);

            return $refMethod->invokeArgs($resolver, $params);

It seems like $resolver can also be of type callable; however, parameter $object of ReflectionMethod::invokeArgs() does only seem to accept object, maybe add an additional type check?

        }

        $error = sprintf('The resolver "%s" for executableDefinition "%s" is not a valid resolver. Resolvers should have a method "__invoke(...)"', $resolverName, $this->executableDefinition->getName());
        throw new \RuntimeException($error);
    }

    /**
     * @param HasExtensionsInterface $objectDefinition
     *
     * @return ExtensionInterface[]
     */
    protected function resolveObjectExtensions(HasExtensionsInterface $objectDefinition): array
    {
        $extensions = [];
        foreach ($objectDefinition->getExtensions() as $extensionDefinition) {
            $extensionClass = $extensionDefinition->getClass();
            if ($this->container->has($extensionClass)) {
                $extensionInstance = $this->container->get($extensionClass);
            } else {
                $extensionInstance = new $extensionClass();
                if ($extensionInstance instanceof ContainerAwareInterface) {
                    $extensionInstance->setContainer($this->container);
                }
            }
            $extensions[] = [$extensionDefinition->getPriority(), $extensionInstance];
        }

        //sort by priority
        usort(
            $extensions,
            function ($extension1, $extension2) {
                list($priority1) = $extension1;
                list($priority2) = $extension2;

                return version_compare($priority2 + 250, $priority1 + 250);
            }
        );

        return array_column($extensions, 1);
    }

    /**
     * @param \ReflectionMethod $refMethod
     * @param array             $args
     *
     * @throws \Exception
     *
     * @return array
     */
    protected function prepareMethodParameters(\ReflectionMethod $refMethod, array $args): array
    {
        //normalize arguments
        $normalizedArguments = [];
        foreach ($args as $key => $value) {
            if ($this->executableDefinition->hasArgument($key)) {
                $argument = $this->executableDefinition->getArgument($key);
                if ('input' === $key) {
                    $normalizedValue = $value;
                } else {
                    $normalizedValue = $this->normalizeValue($value, $argument->getType());

                    //normalize argument into respective inputs objects
                    if (is_array($normalizedValue) && $this->endpoint->hasType($argument->getType())) {
                        if ($argument->isList()) {
                            $tmp = [];
                            foreach ($normalizedValue as $childValue) {
                                $tmp[] = $this->arrayToObject($childValue, $this->endpoint->getType($argument->getType()));
                            }
                            $normalizedValue = $tmp;
                        } else {
                            $normalizedValue = $this->arrayToObject($normalizedValue, $this->endpoint->getType($argument->getType()));
                        }
                    }
                }
                $normalizedArguments[$argument->getName()] = $normalizedValue;
                $normalizedArguments[$argument->getInternalName()] = $normalizedValue;
            }
        }
        $this->applyArgumentsNamingConventions($normalizedArguments);
        $normalizedArguments['args'] = $normalizedArguments;
        $normalizedArguments['root'] = $this->root;
        $indexedArguments = $this->resolveMethodArguments($refMethod, $normalizedArguments);
        ksort($indexedArguments);

        return $indexedArguments;
    }

    /**
     * Apply some conventions to given arguments
     *
     * @param array $args
     */
    protected function applyArgumentsNamingConventions(&$args)
    {
        //any parameter with suffix Id of type ID automatically will be created other parameter with the real object
        //e.g. productId => ID() produce other parameter: product => Product()
        //
        // Usage:
        //  * ...
        //  * @GraphQL\Argument(name="productId", type="ID!")
        //  */
        //  public function someMethod(Product $product){
        //      //...
        //  }
        //
        foreach ($args as $name => $value) {
            if ($value instanceof ID && preg_match('/Id$/', $name)) {
                $objectParamName = preg_replace('/Id$/', null, $name);
                if (!isset($args[$objectParamName])) {
                    $definition = $this->endpoint->getType($value->getNodeType());
                    if ($definition instanceof ObjectDefinition && $definition->getClass()) {

The expression $definition->getClass() of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

                        /** @var EntityManager $em */
                        $em = $this->container->get('doctrine')->getManager();
                        $args[$objectParamName] = $em->getRepository($definition->getClass())->find($value->getDatabaseId());
                    }
                }
            }
        }
    }

    /**
     * @param \ReflectionMethod $method
     * @param array             $incomeArgs
     *
     * @return array
     */
    protected function resolveMethodArguments(\ReflectionMethod $method, array $incomeArgs)
    {
        $orderedArguments = [];
        foreach ($method->getParameters() as $parameter) {
            if ($parameter->isOptional()) {
                $orderedArguments[$parameter->getPosition()] = $parameter->getDefaultValue();
            }
            foreach ($incomeArgs as $key => $value) {
                if ($parameter->getName() === $key) {
                    $orderedArguments[$parameter->getPosition()] = $value;
                    continue 2;
                }
            }

            //inject root common argument
            if ($this->root
                && 'root' === $parameter->getName()
                && $parameter->getClass()
                && $parameter->getClass()->isInstance($this->root)

            ) {
                $orderedArguments[$parameter->getPosition()] = $this->root;
            }
        }

        return $orderedArguments;
    }

    /**
     * @param mixed  $value
     * @param string $type
     *
     * @return mixed
     */
    protected function normalizeValue($value, string $type)
    {
        if (Types::ID === $type && $value) {
            if (\is_array($value)) {
                $idsArray = [];
                foreach ($value as $id) {
                    if ($id) {
                        $idsArray[] = ID::createFromString($id);
                    }
                }
                $value = $idsArray;
            } else {
                $value = ID::createFromString($value);
            }
        }

        return $value;
    }

    /**
     * Convert a array into object using given definition
     *
     * @param array                     $data       data to populate the object
     * @param ObjectDefinitionInterface $definition object definition
     *
     * @return mixed
     */
    protected function arrayToObject(array $data, ObjectDefinitionInterface $definition)
    {
        $class = $definition->getClass();

        //normalize data
        foreach ($data as $fieldName => &$value) {
            if (!$definition->hasField($fieldName)) {
                continue;
            }
            $fieldDefinition = $definition->getField($fieldName);
            $value = $this->normalizeValue($value, $fieldDefinition->getType());
        }
        unset($value);

        //instantiate object
        if (class_exists($class)) {
            $object = new $class();
        } else {
            return $data;
        }

        //populate object
        foreach ($data as $key => $value) {
            if (!$definition->hasField($key)) {
                continue;
            }
            $fieldDefinition = $definition->getField($key);
            $this->setObjectValue($object, $fieldDefinition, $value);
        }

        return $object;
    }

    /**
     * @param mixed           $object
     * @param FieldDefinition $fieldDefinition
     * @param mixed           $value
     */
    protected function setObjectValue($object, FieldDefinition $fieldDefinition, $value)
    {
        //using setter
        $accessor = new PropertyAccessor();
        $propertyName = $fieldDefinition->getOriginName();
        if ($propertyName) {
            if ($accessor->isWritable($object, $propertyName)) {
                $accessor->setValue($object, $propertyName, $value);
            } else {
                //using reflection
                $refClass = new \ReflectionClass(\get_class($object));
                if ($refClass->hasProperty($fieldDefinition->getOriginName()) && $property = $refClass->getProperty($fieldDefinition->getOriginName())) {
                    $property->setAccessible(true);
                    $property->setValue($object, $value);
                }
            }
        }
    }
}