Digia\GraphQL\Validation\Rule\ExecutableDefinitionsRule

Complexity

Total Complexity

6

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	enterDocument()	0	14	3
A	getDefinitionName()	0	9	3

<?php

namespace Digia\GraphQL\Validation\Rule;

use Digia\GraphQL\Error\ValidationException;
use Digia\GraphQL\Language\Node\DefinitionNodeInterface;
use Digia\GraphQL\Language\Node\DocumentNode;
use Digia\GraphQL\Language\Node\ExecutableDefinitionNodeInterface;
use Digia\GraphQL\Language\Node\NameAwareInterface;
use Digia\GraphQL\Language\Node\NodeInterface;
use Digia\GraphQL\Language\Node\SchemaDefinitionNode;
use function Digia\GraphQL\Validation\nonExecutableDefinitionMessage;

/**
 * Executable definitions
 *
 * A GraphQL document is only valid for execution if all definitions are either
 * operation or fragment definitions.
 */
class ExecutableDefinitionsRule extends AbstractRule
{
    /**
     * @inheritdoc
     */
    protected function enterDocument(DocumentNode $node): ?NodeInterface
    {
        foreach ($node->getDefinitions() as $definition) {
            if (!$definition instanceof ExecutableDefinitionNodeInterface) {
                $this->context->reportError(
                    new ValidationException(
                        nonExecutableDefinitionMessage($this->getDefinitionName($definition)),
                        [$definition]
                    )
                );
            }
        }

        return $node;
    }

    /**
     * @param NodeInterface $node
     * @return string
     */
    protected function getDefinitionName(NodeInterface $node): string
    {
        if ($node instanceof SchemaDefinitionNode) {
            return 'schema';
        }

        return $node instanceof NameAwareInterface

The expression return $node instanceof Digia\GraphQL\Language\Node\NameAwareInterface ? $node->getNameValue() : 'unknown' could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

            ? $node->getNameValue()
            : 'unknown';
    }
}