Digia\GraphQL\Validation\Rule\KnownDirectivesRule

Complexity

Total Complexity

5

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
B	enterNode()	0	29	5

<?php

namespace Digia\GraphQL\Validation\Rule;

use Digia\GraphQL\Error\ValidationException;
use Digia\GraphQL\Language\AST\DirectiveLocationEnum;
use Digia\GraphQL\Language\AST\Node\DirectiveNode;
use Digia\GraphQL\Language\AST\Node\EnumTypeDefinitionNode;
use Digia\GraphQL\Language\AST\Node\EnumTypeExtensionNode;
use Digia\GraphQL\Language\AST\Node\EnumValueDefinitionNode;
use Digia\GraphQL\Language\AST\Node\FieldDefinitionNode;
use Digia\GraphQL\Language\AST\Node\FieldNode;
use Digia\GraphQL\Language\AST\Node\FragmentDefinitionNode;
use Digia\GraphQL\Language\AST\Node\FragmentSpreadNode;
use Digia\GraphQL\Language\AST\Node\InlineFragmentNode;
use Digia\GraphQL\Language\AST\Node\InputObjectTypeDefinitionNode;
use Digia\GraphQL\Language\AST\Node\InputObjectTypeExtensionNode;
use Digia\GraphQL\Language\AST\Node\InputValueDefinitionNode;
use Digia\GraphQL\Language\AST\Node\InterfaceTypeDefinitionNode;
use Digia\GraphQL\Language\AST\Node\InterfaceTypeExtensionNode;
use Digia\GraphQL\Language\AST\Node\NodeInterface;
use Digia\GraphQL\Language\AST\Node\ObjectTypeDefinitionNode;
use Digia\GraphQL\Language\AST\Node\ObjectTypeExtensionNode;
use Digia\GraphQL\Language\AST\Node\OperationDefinitionNode;
use Digia\GraphQL\Language\AST\Node\ScalarTypeDefinitionNode;
use Digia\GraphQL\Language\AST\Node\ScalarTypeExtensionNode;
use Digia\GraphQL\Language\AST\Node\SchemaDefinitionNode;
use Digia\GraphQL\Language\AST\Node\UnionTypeDefinitionNode;
use Digia\GraphQL\Language\AST\Node\UnionTypeExtensionNode;
use Digia\GraphQL\Language\AST\Visitor\AcceptVisitorTrait;
use Digia\GraphQL\Type\Definition\Directive;
use function Digia\GraphQL\Util\find;

/**
 * Known directives
 *
 * A GraphQL document is only valid if all `@directives` are known by the
 * schema and legally positioned.
 */
class KnownDirectivesRule extends AbstractRule
{
    /**
     * @inheritdoc
     */
    public function enterNode(NodeInterface $node): ?NodeInterface
    {
        if ($node instanceof DirectiveNode) {
            /** @var Directive $directiveDefinition */
            $directiveDefinition = find(
                $this->context->getSchema()->getDirectives(),
                function (Directive $definition) use ($node) {
                    return $definition->getName() === $node->getNameValue();
                }
            );

            if (null == $directiveDefinition) {
                $this->context->reportError(
                    new ValidationException(unknownDirectiveMessage((string)$node), [$node])
                );

                return $node;
            }

            $location = getDirectiveLocationFromASTPath($node);

            if (null !== $location && !in_array($location, $directiveDefinition->getLocations())) {
                $this->context->reportError(
                    new ValidationException(misplacedDirectiveMessage((string)$node, $location), [$node])
                );
            }
        }

        return $node;
    }
}

/**
 * @param NodeInterface|AcceptVisitorTrait $node
 * @return string
 */
function getDirectiveLocationFromASTPath(NodeInterface $node): string
{
    /** @var NodeInterface $appliedTo */
    $appliedTo = $node->getAncestor();

The method getAncestor() does not exist on Digia\GraphQL\Language\AST\Node\NodeInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Digia\GraphQL\Language\AST\Node\DefinitionNodeInterface or Digia\GraphQL\Language\AST\Node\TypeExtensionNodeInterface or Digia\GraphQL\Language\AST\Node\ValueNodeInterface or Digia\GraphQL\Language\AST\Node\SelectionNodeInterface or Digia\GraphQL\Language\AST\Node\TypeNodeInterface or Digia\GraphQL\Language\AST\Node\TypeSystemDefinitionNodeInterface or Digia\GraphQL\Language\AST\Node\TypeDefinitionNodeInterface or Digia\GraphQL\Language\AST\Node\ExecutableDefinitionNodeInterface. Are you sure you never get one of those?

    if ($appliedTo instanceof OperationDefinitionNode) {
        switch ($appliedTo->getOperation()) {
            case 'query':
                return DirectiveLocationEnum::QUERY;
            case 'mutation':
                return DirectiveLocationEnum::MUTATION;
            case 'subscription':
                return DirectiveLocationEnum::SUBSCRIPTION;
            default:
                // TODO: Throw appropriate exception.
        }
    }
    if ($appliedTo instanceof FieldNode) {
        return DirectiveLocationEnum::FIELD;
    }
    if ($appliedTo instanceof FragmentSpreadNode) {
        return DirectiveLocationEnum::FRAGMENT_SPREAD;
    }
    if ($appliedTo instanceof InlineFragmentNode) {
        return DirectiveLocationEnum::INLINE_FRAGMENT;
    }
    if ($appliedTo instanceof FragmentDefinitionNode) {
        return DirectiveLocationEnum::FRAGMENT_DEFINITION;
    }
    if ($appliedTo instanceof SchemaDefinitionNode) {
        return DirectiveLocationEnum::SCHEMA;
    }
    if ($appliedTo instanceof ScalarTypeDefinitionNode || $appliedTo instanceof ScalarTypeExtensionNode) {
        return DirectiveLocationEnum::SCALAR;
    }
    if ($appliedTo instanceof ObjectTypeDefinitionNode || $appliedTo instanceof ObjectTypeExtensionNode) {
        return DirectiveLocationEnum::OBJECT;
    }
    if ($appliedTo instanceof FieldDefinitionNode) {
        return DirectiveLocationEnum::FIELD_DEFINITION;
    }
    if ($appliedTo instanceof InterfaceTypeDefinitionNode || $appliedTo instanceof InterfaceTypeExtensionNode) {
        return DirectiveLocationEnum::INTERFACE;
    }
    if ($appliedTo instanceof UnionTypeDefinitionNode || $appliedTo instanceof UnionTypeExtensionNode) {
        return DirectiveLocationEnum::UNION;
    }
    if ($appliedTo instanceof EnumTypeDefinitionNode || $appliedTo instanceof EnumTypeExtensionNode) {
        return DirectiveLocationEnum::ENUM;
    }
    if ($appliedTo instanceof EnumValueDefinitionNode) {
        return DirectiveLocationEnum::ENUM_VALUE;
    }
    if ($appliedTo instanceof InputObjectTypeDefinitionNode || $appliedTo instanceof InputObjectTypeExtensionNode) {
        return DirectiveLocationEnum::INPUT_OBJECT;
    }
    if ($appliedTo instanceof InputValueDefinitionNode) {
        $parentNode = $node->getAncestor(2);
        return $parentNode instanceof InputObjectTypeDefinitionNode
            ? DirectiveLocationEnum::INPUT_FIELD_DEFINITION
            : DirectiveLocationEnum::ARGUMENT_DEFINITION;
    }

The function implicitly returns null when the if condition on line 137 is false. This is incompatible with the type-hinted return string. Consider adding a return statement or allowing null as return value.

    // TODO: Throw appropriate exception.
}