Improve extendability of validator rules (#854)

Author: wimski

CHANGELOG.md

@@ -4,6 +4,9 @@
 Changed:
 - PHP version required: 7.4+
 
+Feat:
+- Improve extendability of validator rules
+
 Removed:
 - Removed deprecated `Type::getInternalTypes()`
 - Remove deprecated `GraphQL::execute()`

src/Validator/Rules/CustomValidationRule.php

@@ -4,27 +4,26 @@
 
 namespace GraphQL\Validator\Rules;
 
-use GraphQL\Error\Error;
+use GraphQL\Language\AST\Node;
+use GraphQL\Language\VisitorOperation;
 use GraphQL\Validator\ValidationContext;
 
 class CustomValidationRule extends ValidationRule
 {
     /** @var callable */
-    private $visitorFn;
+    protected $visitorFn;
 
-    public function __construct($name, callable $visitorFn)
+    /**
+     * @param callable(ValidationContext): (array<string, callable(Node): VisitorOperation|mixed|null>|array<string, array<string, callable(Node): VisitorOperation|mixed|null>>) $visitorFn
+     */
+    public function __construct(string $name, callable $visitorFn)
     {
         $this->name      = $name;
         $this->visitorFn = $visitorFn;
     }
 
-    /**
-     * @return Error[]
-     */
     public function getVisitor(ValidationContext $context)
     {
-        $fn = $this->visitorFn;
-
-        return $fn($context);
+        return ($this->visitorFn)($context);
     }
 }

src/Validator/Rules/DisableIntrospection.php

@@ -13,8 +13,7 @@ class DisableIntrospection extends QuerySecurityRule
 {
     public const ENABLED = 1;
 
-    /** @var bool */
-    private $isEnabled;
+    protected int $isEnabled;
 
     public function __construct($enabled = self::ENABLED)
     {

src/Validator/Rules/ExecutableDefinitions.php

@@ -34,7 +34,7 @@ public function getVisitor(ValidationContext $context)
                     }
 
                     $context->reportError(new Error(
-                        self::nonExecutableDefinitionMessage($definition->name->value),
+                        static::nonExecutableDefinitionMessage($definition->name->value),
                         [$definition->name]
                     ));
                 }

src/Validator/Rules/FieldsOnCorrectType.php

@@ -79,7 +79,7 @@ public function getVisitor(ValidationContext $context)
      *
      * @return string[]
      */
-    private function getSuggestedTypeNames(Schema $schema, $type, $fieldName)
+    protected function getSuggestedTypeNames(Schema $schema, $type, $fieldName)
     {
         if (Type::isAbstractType($type)) {
             $suggestedObjectTypes = [];
@@ -128,7 +128,7 @@ private function getSuggestedTypeNames(Schema $schema, $type, $fieldName)
      *
      * @return array|string[]
      */
-    private function getSuggestedFieldNames(Schema $schema, $type, $fieldName)
+    protected function getSuggestedFieldNames(Schema $schema, $type, $fieldName)
     {
         if ($type instanceof ObjectType || $type instanceof InterfaceType) {
             $possibleFieldNames = array_keys($type->getFields());

src/Validator/Rules/KnownArgumentNames.php

@@ -40,7 +40,7 @@ public function getVisitor(ValidationContext $context)
                 }
 
                 $context->reportError(new Error(
-                    self::unknownArgMessage(
+                    static::unknownArgMessage(
                         $node->name->value,
                         $fieldDef->name,
                         $parentType->name,

src/Validator/Rules/KnownArgumentNamesOnDirectives.php

@@ -104,7 +104,7 @@ static function (InputValueDefinitionNode $arg): string {
 
                     $suggestions = Utils::suggestionList($argName, $knownArgs);
                     $context->reportError(new Error(
-                        self::unknownDirectiveArgMessage($argName, $directiveName, $suggestions),
+                        static::unknownDirectiveArgMessage($argName, $directiveName, $suggestions),
                         [$argNode]
                     ));
                 }

src/Validator/Rules/KnownDirectives.php

@@ -101,7 +101,7 @@ static function ($name): string {
 
                 if (! $locations) {
                     $context->reportError(new Error(
-                        self::unknownDirectiveMessage($name),
+                        static::unknownDirectiveMessage($name),
                         [$node]
                     ));
 
@@ -116,7 +116,7 @@ static function ($name): string {
 
                 $context->reportError(
                     new Error(
-                        self::misplacedDirectiveMessage($name, $candidateLocation),
+                        static::misplacedDirectiveMessage($name, $candidateLocation),
                         [$node]
                     )
                 );
@@ -134,7 +134,7 @@ public static function unknownDirectiveMessage($directiveName)
      *
      * @return string
      */
-    private function getDirectiveLocationForASTPath(array $ancestors)
+    protected function getDirectiveLocationForASTPath(array $ancestors)
     {
         $appliedTo = $ancestors[count($ancestors) - 1];
         switch (true) {

src/Validator/Rules/KnownFragmentNames.php

@@ -24,7 +24,7 @@ public function getVisitor(ValidationContext $context)
                 }
 
                 $context->reportError(new Error(
-                    self::unknownFragmentMessage($fragmentName),
+                    static::unknownFragmentMessage($fragmentName),
                     [$node->name]
                 ));
             },

src/Validator/Rules/KnownTypeNames.php

@@ -47,7 +47,7 @@ public function getVisitor(ValidationContext $context)
                 }
 
                 $context->reportError(new Error(
-                    self::unknownTypeMessage(
+                    static::unknownTypeMessage(
                         $typeName,
                         Utils::suggestionList($typeName, array_keys($schema->getTypeMap()))
                     ),