Ynlo\GraphQLBundle\Definition\Loader\Annotation\ObjectTypeAnnotationParser

Complexity

Total Complexity

82

Size/Duplication

Total Lines	465
Duplicated Lines	0 %

Test Coverage

Coverage

88.05%

Importance

Changes	13
Bugs	1	Features	3

12 Methods

Rating	Name	Duplication	Size	Complexity
A	supports()	0	3	2
B	parse()	0	37	6
A	__construct()	0	4	1
A	getFieldAnnotation()	0	7	2
B	extractInterfaceDefinitions()	0	52	10
A	getClassMethods()	0	8	2
A	copyFieldsFromInterface()	0	9	3
A	loadInheritedProperties()	0	5	2
B	isExposed()	0	30	10
A	getClassProperties()	0	18	4
B	resolveDefinitionInterfaces()	0	39	10
F	resolveFields()	0	139	30

<?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\Definition\Loader\Annotation;

use Doctrine\Common\Annotations\Reader;
use Ynlo\GraphQLBundle\Annotation;
use Ynlo\GraphQLBundle\Definition\ArgumentDefinition;
use Ynlo\GraphQLBundle\Definition\FieldDefinition;
use Ynlo\GraphQLBundle\Definition\FieldsAwareDefinitionInterface;
use Ynlo\GraphQLBundle\Definition\ImplementorInterface;
use Ynlo\GraphQLBundle\Definition\InputObjectDefinition;
use Ynlo\GraphQLBundle\Definition\InterfaceDefinition;
use Ynlo\GraphQLBundle\Definition\Loader\Annotation\FieldDecorator\FieldDefinitionDecoratorInterface;
use Ynlo\GraphQLBundle\Definition\NodeAwareDefinitionInterface;
use Ynlo\GraphQLBundle\Definition\ObjectDefinition;
use Ynlo\GraphQLBundle\Definition\ObjectDefinitionInterface;
use Ynlo\GraphQLBundle\Definition\Registry\Endpoint;
use Ynlo\GraphQLBundle\Resolver\FieldExpressionResolver;
use Ynlo\GraphQLBundle\Util\TypeUtil;

/**
 * Parse the ObjectType annotation to fetch object definitions
 */
class ObjectTypeAnnotationParser implements AnnotationParserInterface
{
    /**
     * @var Reader
     */
    protected $reader;

    /**
     * @var FieldDefinitionDecoratorInterface[]
     */
    protected $fieldDecorators;
    /**
     * @var Endpoint
     */
    protected $endpoint;

    /**
     * ObjectTypeAnnotationParser constructor.
     *
     * @param Reader   $reader
     * @param iterable $fieldDecorators
     */
    public function __construct(Reader $reader, iterable $fieldDecorators = [])
    {
        $this->reader = $reader;
        $this->fieldDecorators = $fieldDecorators;

It seems like $fieldDecorators can also be of type iterable. However, the property $fieldDecorators is declared as type Ynlo\GraphQLBundle\Definition\Loader\Annotation\FieldDecorator\FieldDefinitionDecoratorInterface[]. Maybe add an additional type check?

    }

    /**
     * {@inheritdoc}
     */
    public function supports($annotation): bool
    {
        return $annotation instanceof Annotation\ObjectType || $annotation instanceof Annotation\InputObjectType;
    }

    /**
     * {@inheritdoc}
     */
    public function parse($annotation, \ReflectionClass $refClass, Endpoint $endpoint)
    {
        $this->endpoint = $endpoint;

        if ($annotation instanceof Annotation\ObjectType) {
            $objectDefinition = new ObjectDefinition();
        } else {
            $objectDefinition = new InputObjectDefinition();
        }

        $objectDefinition->setName($annotation->name);
        $objectDefinition->setExclusionPolicy($annotation->exclusionPolicy);
        $objectDefinition->setClass($refClass->name);
        $objectDefinition->setMetas($annotation->options);

        if (!$objectDefinition->getName()) {
            preg_match('/\w+$/', $refClass->getName(), $matches);
            $objectDefinition->setName($matches[0] ?? '');
        }

        if ($objectDefinition instanceof NodeAwareDefinitionInterface) {
            $objectDefinition->setNode($objectDefinition->getName());
        }

        if ($endpoint->hasType($objectDefinition->getName())) {
            return;
        }

        $objectDefinition->setDescription($annotation->description);

        if ($objectDefinition instanceof ImplementorInterface) {
            $this->resolveDefinitionInterfaces($refClass, $objectDefinition, $endpoint, $annotation);
        }

        $this->loadInheritedProperties($refClass, $objectDefinition);
        $this->resolveFields($refClass, $objectDefinition);
        $endpoint->addType($objectDefinition);
    }

    /**
     * @param \ReflectionClass      $refClass
     * @param ImplementorInterface  $implementor
     * @param Endpoint              $endpoint
     * @param Annotation\ObjectType $annotation
     */
    protected function resolveDefinitionInterfaces(\ReflectionClass $refClass, ImplementorInterface $implementor, Endpoint $endpoint, Annotation\ObjectType $annotation)
    {
        $interfaceDefinitions = $this->extractInterfaceDefinitions($refClass);
        foreach ($interfaceDefinitions as $interfaceDefinition) {
            if (in_array($interfaceDefinition->getName(), $annotation->ignoreInterface)) {
                continue;
            }

            $implementor->addInterface($interfaceDefinition->getName());

            if (!$endpoint->hasType($interfaceDefinition->getName())) {
                $endpoint->addType($interfaceDefinition);
            } else {
                $interfaceDefinition = $endpoint->getType($interfaceDefinition->getName());
            }

            $interfaceDefinition->addImplementor($implementor->getName());

The method addImplementor() does not exist on Ynlo\GraphQLBundle\Definition\DefinitionInterface. It seems like you code against a sub-type of Ynlo\GraphQLBundle\Definition\DefinitionInterface such as Ynlo\GraphQLBundle\Definition\InterfaceDefinition or Ynlo\GraphQLBundle\Definition\InterfaceDefinition.

            $this->copyFieldsFromInterface($interfaceDefinition, $implementor);
        }

        //support interface inheritance
        //Interface inheritance is not implemented in GraphQL
        //@see https://github.com/facebook/graphql/issues/295
        //BUT, GraphQLBundle use this feature in some places like extensions etc.
        foreach ($interfaceDefinitions as $interfaceDefinition) {
            if ($interfaceDefinition->getClass()) {
                $childInterface = new \ReflectionClass($interfaceDefinition->getClass());
                /** @var Annotation\InterfaceType $interface */
                $interface = $this->reader->getClassAnnotation($childInterface, Annotation\InterfaceType::class);
                $parentDefinitions = $this->extractInterfaceDefinitions($childInterface);
                foreach ($parentDefinitions as $parentDefinition) {
                    if (in_array($parentDefinition->getName(), $interface->ignoreParent)) {
                        continue;
                    }
                    $this->copyFieldsFromInterface($parentDefinition, $interfaceDefinition);
                    if ($endpoint->hasType($parentDefinition->getName())) {
                        $existentParentDefinition = $endpoint->getType($parentDefinition->getName());
                        if ($existentParentDefinition instanceof InterfaceDefinition) {
                            $existentParentDefinition->addImplementor($interfaceDefinition->getName());
                        }
                    }
                }
            }
        }
    }

    /**
     * @param \ReflectionClass $refClass
     *
     * @return InterfaceDefinition[]
     */
    protected function extractInterfaceDefinitions(\ReflectionClass $refClass)
    {
        $int = $refClass->getInterfaces();

        //get recursively all parent abstract classes to use as interfaces
        $currentClass = $refClass;
        while ($currentClass->getParentClass()) {
            if ($currentClass->getParentClass()->isAbstract()) {
                $int[] = $currentClass->getParentClass();
            }
            $currentClass = $currentClass->getParentClass();
        }

        //current class can be a object and interface at the same time,
        //When use different object types using discriminator map
        if ($this->reader->getClassAnnotation($refClass, Annotation\InterfaceType::class)) {
            $int[] = $refClass;
        }

        $definitions = [];
        foreach ($int as $intRef) {
            /** @var Annotation\InterfaceType $intAnnot */
            $intAnnot = $this->reader->getClassAnnotation(
                $intRef,
                Annotation\InterfaceType::class
            );

            if ($intAnnot) {
                $intDef = new InterfaceDefinition();
                $intDef->setName($intAnnot->name);
                $intDef->setClass($intRef->getName());

                if (!$intDef->getName() && preg_match('/\w+$/', $intRef->getName(), $matches)) {
                    $intDef->setName(preg_replace('/Interface$/', null, $matches[0]));
                }

                $intDef->setMetas($intAnnot->options);
                $intDef->setDescription($intAnnot->description);
                $intDef->setDeprecationReason($intAnnot->deprecationReason);
                $intDef->setDiscriminatorMap($intAnnot->discriminatorMap);
                $intDef->setDiscriminatorProperty($intAnnot->discriminatorProperty);
                $intDef->setExclusionPolicy($intAnnot->exclusionPolicy);
                $this->resolveFields($intRef, $intDef);
                if (!$intDef->getName() && preg_match('/\w+$/', $intRef->getName(), $matches)) {
                    $intDef->setName(preg_replace('/Interface$/', null, $matches[0]));
                }

                $definitions[] = $intDef;
            }
        }

        return $definitions;
    }

    /**
     * @param \ReflectionClass          $refClass
     * @param ObjectDefinitionInterface $objectDefinition
     */
    protected function loadInheritedProperties(\ReflectionClass $refClass, ObjectDefinitionInterface $objectDefinition)
    {
        while ($parent = $refClass->getParentClass()) {
            $this->resolveFields($refClass, $objectDefinition);
            $refClass = $parent;
        }
    }

    /**
     * Copy all fields from interface to given object implementor
     *
     * @param InterfaceDefinition            $intDef
     * @param FieldsAwareDefinitionInterface $fieldsAwareDefinition
     */
    protected function copyFieldsFromInterface(InterfaceDefinition $intDef, FieldsAwareDefinitionInterface $fieldsAwareDefinition)
    {
        foreach ($intDef->getFields() as $field) {
            if (!$fieldsAwareDefinition->hasField($field->getName())) {
                $newField = clone $field;
                $newField->addInheritedFrom($intDef->getName());
                $fieldsAwareDefinition->addField($newField);
            } else {
                $fieldsAwareDefinition->getField($field->getName())->addInheritedFrom($intDef->getName());
            }
        }
    }

    /**
     * Extract all fields for given definition
     *
     * @param \ReflectionClass          $refClass
     * @param ObjectDefinitionInterface $objectDefinition
     */
    protected function resolveFields(\ReflectionClass $refClass, ObjectDefinitionInterface $objectDefinition)
    {
        $props = array_merge($this->getClassProperties($refClass), $this->getClassMethods($refClass));
        foreach ($props as $prop) {
            if (!$this->isExposed($objectDefinition, $prop)) {
                continue;
            }

            $field = new FieldDefinition();
            foreach ($this->fieldDecorators as $fieldDecorator) {
                $fieldDecorator->decorateFieldDefinition($prop, $field, $objectDefinition);
            }

            //in case the object already have this field (inherited from interface),
            //copy interfaces and remove the existent field to add the new definition
            if ($objectDefinition->hasField($field->getName())) {
                $existentField = $objectDefinition->getField($field->getName());
                $field->setInheritedFrom($existentField->getInheritedFrom());
                $objectDefinition->removeField($existentField->getName());
                //force type compatibility
                $field->setList($existentField->isList());
                $field->setNonNull($existentField->isNonNull());
                $field->setNonNullList($existentField->isNonNullList());
            }

            $objectDefinition->addField($field);

            $field->setOriginName($prop->name);
            $field->setOriginType(\get_class($prop));

            //resolve field arguments
            if ($prop instanceof \ReflectionMethod) {
                foreach ($this->reader->getMethodAnnotations($prop) as $argAnnotation) {
                    if (!$argAnnotation instanceof Annotation\Argument) {
                        continue;
                    }

                    $arg = new ArgumentDefinition();
                    $arg->setName($argAnnotation->name);
                    $arg->setDescription($argAnnotation->description);
                    $arg->setInternalName($argAnnotation->internalName);
                    $arg->setDefaultValue($argAnnotation->defaultValue);
                    $arg->setType(TypeUtil::normalize($argAnnotation->type));
                    $arg->setList(TypeUtil::isTypeList($argAnnotation->type));
                    $arg->setNonNullList(TypeUtil::isTypeNonNullList($argAnnotation->type));
                    $arg->setNonNull(TypeUtil::isTypeNonNull($argAnnotation->type));
                    $field->addArgument($arg);
                }
            }
        }

        //load overrides
        foreach ($this->reader->getClassAnnotations($refClass) as $annotation) {
            if (!$annotation instanceof Annotation\OverrideField) {
                continue;
            }

            if ($annotation->in && !\in_array($objectDefinition->getName(), $annotation->in)) {

The expression $annotation->in of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                continue;
            }

            if ($annotation->notIn && \in_array($objectDefinition->getName(), $annotation->notIn)) {

The expression $annotation->notIn of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                continue;
            }

            if (!$objectDefinition->hasField($annotation->name)) {
                throw new \InvalidArgumentException(sprintf(
                    'The object definition "%s" does not have any field called "%s" in any of its parents definitions.',
                    $objectDefinition->getName(),
                    $annotation->name
                ));
            }

            if (true === $annotation->hidden) {
                $objectDefinition->removeField($annotation->name);

                continue;
            }

            $fieldDefinition = $objectDefinition->getField($annotation->name);

            if ($annotation->type) {
                $fieldDefinition->setType(TypeUtil::normalize($annotation->type));
                $fieldDefinition->setNonNull(TypeUtil::isTypeNonNull($annotation->type));
                $fieldDefinition->setNonNullList(TypeUtil::isTypeNonNullList($annotation->type));
                $fieldDefinition->setList(TypeUtil::isTypeList($annotation->type));
            }
            if ($annotation->alias) {
                $objectDefinition->removeField($fieldDefinition->getName());
                $fieldDefinition->setName($annotation->alias);
                $objectDefinition->addField(clone $fieldDefinition);
            }
            if ($annotation->description) {
                $fieldDefinition->setDescription($annotation->description);
            }
            if ($annotation->deprecationReason || false === $annotation->deprecationReason) {
                $fieldDefinition->setDeprecationReason($annotation->deprecationReason);
            }
            if ($annotation->complexity) {
                $fieldDefinition->setComplexity($annotation->complexity);
            }
        }

        //load virtual fields
        $annotations = $this->reader->getClassAnnotations($refClass);
        foreach ($annotations as $annotation) {
            if ($annotation instanceof Annotation\VirtualField) {
                if ($annotation->in && !\in_array($objectDefinition->getName(), $annotation->in)) {

The expression $annotation->in of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                    continue;
                }

                if ($annotation->notIn && \in_array($objectDefinition->getName(), $annotation->notIn)) {

The expression $annotation->notIn of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                    continue;
                }

                if (!$objectDefinition->hasField($annotation->name)) {
                    $fieldDefinition = new FieldDefinition();
                    $fieldDefinition->setName($annotation->name);
                    $fieldDefinition->setDescription($annotation->description);
                    $fieldDefinition->setDeprecationReason($annotation->deprecationReason);
                    $fieldDefinition->setType(TypeUtil::normalize($annotation->type));
                    $fieldDefinition->setNonNull(TypeUtil::isTypeNonNull($annotation->type));
                    $fieldDefinition->setNonNullList(TypeUtil::isTypeNonNullList($annotation->type));
                    $fieldDefinition->setList(TypeUtil::isTypeList($annotation->type));
                    $fieldDefinition->setMeta('expression', $annotation->expression);
                    $fieldDefinition->setResolver(FieldExpressionResolver::class);
                    $fieldDefinition->setComplexity($annotation->complexity);
                    $objectDefinition->addField($fieldDefinition);
                } else {
                    $fieldDefinition = $objectDefinition->getField($annotation->name);
                    if ($fieldDefinition->getResolver() === FieldExpressionResolver::class) {
                        continue;
                    }
                    $error = sprintf(
                        'The object definition "%s" already has a field called "%s".',
                        $objectDefinition->getName(),
                        $annotation->name
                    );
                    throw new \InvalidArgumentException($error);
                }
            }
        }
    }

    /**
     * Verify if a given property for given definition is exposed or not
     *
     * @param ObjectDefinitionInterface             $definition
     * @param \ReflectionMethod|\ReflectionProperty $prop
     *
     * @return boolean
     */
    protected function isExposed(ObjectDefinitionInterface $definition, $prop): bool
    {
        $exposed = $definition->getExclusionPolicy() === ObjectDefinitionInterface::EXCLUDE_NONE;

        if ($prop instanceof \ReflectionMethod) {
            $exposed = false;

            //implicit inclusion
            if ($this->getFieldAnnotation($prop, Annotation\Field::class)) {
                $exposed = true;
            }
        }

        if ($exposed && $this->getFieldAnnotation($prop, Annotation\Exclude::class)) {
            $exposed = false;
        } elseif (!$exposed && $this->getFieldAnnotation($prop, Annotation\Expose::class)) {
            $exposed = true;
        }

        /** @var Annotation\Field $fieldAnnotation */
        if ($fieldAnnotation = $this->getFieldAnnotation($prop, Annotation\Field::class)) {
            $exposed = true;
            if ($fieldAnnotation->in) {

The expression $fieldAnnotation->in of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                $exposed = \in_array($definition->getName(), $fieldAnnotation->in);
            } elseif (($fieldAnnotation->notIn)) {

The expression $fieldAnnotation->notIn of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                $exposed = !\in_array($definition->getName(), $fieldAnnotation->notIn);
            }
        }

        return $exposed;
    }

    /**
     * Get field specific annotation matching given implementor
     *
     * @param \ReflectionMethod|\ReflectionProperty $prop
     * @param string                                $annotationClass
     *
     * @return mixed
     */
    protected function getFieldAnnotation($prop, string $annotationClass)
    {
        if ($prop instanceof \ReflectionProperty) {
            return $this->reader->getPropertyAnnotation($prop, $annotationClass);
        }

        return $this->reader->getMethodAnnotation($prop, $annotationClass);
    }

    /**
     * @param \ReflectionClass $refClass
     *
     * @return array
     */
    protected function getClassProperties(\ReflectionClass $refClass)
    {
        $props = [];

        //fields from parents, including private fields
        $currentClass = $refClass;
        while ($parent = $currentClass->getParentClass()) {
            foreach ($parent->getProperties() as $prop) {
                $props[$prop->name] = $prop;
            }
            $currentClass = $parent;
        }

        foreach ($refClass->getProperties() as $prop) {
            $props[$prop->name] = $prop;
        }

        return $props;
    }

    /**
     * @param \ReflectionClass $refClass
     *
     * @return array
     */
    protected function getClassMethods(\ReflectionClass $refClass)
    {
        $methods = [];
        foreach ($refClass->getMethods(\ReflectionMethod::IS_PUBLIC) as $method) {
            $methods[$method->name] = $method;
        }

        return $methods;
    }
}