Reify AST node types and remove unneeded nullability (#751)

* Reify AST node types and remove unneeded nullability This achieves a few things: - make the code easier to understand both by humans and static analyzers - improve performance by eliminating unnecessary null checks - improve usability through a clarified API * fix codestyle * fix EnumTypeExtensionNode.php * Update src/Utils/ASTDefinitionBuilder.php Co-authored-by: Simon Podlipsky <[email protected]> * Update ASTDefinitionBuilder.php * Update src/Utils/ASTDefinitionBuilder.php * Fix intersection type sniffer * Fix interfaces property Co-authored-by: Simon Podlipsky <[email protected]>
webonyx · Jan 23, 2021 · f097de2 · f097de2
1 parent c4d2f82
commit f097de2
Show file tree

Hide file tree

Showing 23 changed files with 192 additions and 189 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -310,11 +310,6 @@ parameters:
 			count: 1
 			path: src/Utils/ASTDefinitionBuilder.php
 
-		-
-			message: "#^Only booleans are allowed in a ternary operator condition, GraphQL\\\\Language\\\\AST\\\\NodeList\\<GraphQL\\\\Language\\\\AST\\\\EnumValueDefinitionNode\\>\\|null given\\.$#"
-			count: 1
-			path: src/Utils/ASTDefinitionBuilder.php
-
 		-
 			message: "#^Only booleans are allowed in &&, array\\<bool\\>\\|null given on the left side\\.$#"
 			count: 1

diff --git a/src/Language/AST/EnumTypeDefinitionNode.php b/src/Language/AST/EnumTypeDefinitionNode.php
@@ -15,7 +15,7 @@ class EnumTypeDefinitionNode extends Node implements TypeDefinitionNode
     /** @var NodeList<DirectiveNode> */
     public $directives;
 
-    /** @var NodeList<EnumValueDefinitionNode>|null */
+    /** @var NodeList<EnumValueDefinitionNode> */
     public $values;
 
     /** @var StringValueNode|null */

diff --git a/src/Language/AST/EnumTypeExtensionNode.php b/src/Language/AST/EnumTypeExtensionNode.php
@@ -12,9 +12,9 @@ class EnumTypeExtensionNode extends Node implements TypeExtensionNode
     /** @var NameNode */
     public $name;
 
-    /** @var NodeList<DirectiveNode>|null */
+    /** @var NodeList<DirectiveNode> */
     public $directives;
 
-    /** @var NodeList<EnumValueDefinitionNode>|null */
+    /** @var NodeList<EnumValueDefinitionNode> */
     public $values;
 }
diff --git a/src/Language/AST/FieldNode.php b/src/Language/AST/FieldNode.php
@@ -15,10 +15,10 @@ class FieldNode extends Node implements SelectionNode
     /** @var NameNode|null */
     public $alias;
 
-    /** @var NodeList<ArgumentNode>|null */
+    /** @var NodeList<ArgumentNode> */
     public $arguments;
 
-    /** @var NodeList<DirectiveNode>|null */
+    /** @var NodeList<DirectiveNode> */
     public $directives;
 
     /** @var SelectionSetNode|null */

diff --git a/src/Language/AST/InlineFragmentNode.php b/src/Language/AST/InlineFragmentNode.php
@@ -12,7 +12,7 @@ class InlineFragmentNode extends Node implements SelectionNode
     /** @var NamedTypeNode */
     public $typeCondition;
 
-    /** @var NodeList<DirectiveNode>|null */
+    /** @var NodeList<DirectiveNode> */
     public $directives;
 
     /** @var SelectionSetNode */

diff --git a/src/Language/AST/InputObjectTypeDefinitionNode.php b/src/Language/AST/InputObjectTypeDefinitionNode.php
@@ -12,10 +12,10 @@ class InputObjectTypeDefinitionNode extends Node implements TypeDefinitionNode
     /** @var NameNode */
     public $name;
 
-    /** @var NodeList<DirectiveNode>|null */
+    /** @var NodeList<DirectiveNode> */
     public $directives;
 
-    /** @var NodeList<InputValueDefinitionNode>|null */
+    /** @var NodeList<InputValueDefinitionNode> */
     public $fields;
 
     /** @var StringValueNode|null */

diff --git a/src/Language/AST/InputObjectTypeExtensionNode.php b/src/Language/AST/InputObjectTypeExtensionNode.php
@@ -12,9 +12,9 @@ class InputObjectTypeExtensionNode extends Node implements TypeExtensionNode
     /** @var NameNode */
     public $name;
 
-    /** @var NodeList<DirectiveNode>|null */
+    /** @var NodeList<DirectiveNode> */
     public $directives;
 
-    /** @var NodeList<InputValueDefinitionNode>|null */
+    /** @var NodeList<InputValueDefinitionNode> */
     public $fields;
 }
diff --git a/src/Language/AST/InterfaceTypeDefinitionNode.php b/src/Language/AST/InterfaceTypeDefinitionNode.php
@@ -12,13 +12,13 @@ class InterfaceTypeDefinitionNode extends Node implements TypeDefinitionNode
     /** @var NameNode */
     public $name;
 
-    /** @var NodeList<DirectiveNode>|null */
+    /** @var NodeList<DirectiveNode> */
     public $directives;
 
-    /** @var NodeList<InterfaceTypeDefinitionNode> */
+    /** @var NodeList<NamedTypeNode> */
     public $interfaces;
 
-    /** @var NodeList<FieldDefinitionNode>|null */
+    /** @var NodeList<FieldDefinitionNode> */
     public $fields;
 
     /** @var StringValueNode|null */

diff --git a/src/Language/AST/InterfaceTypeExtensionNode.php b/src/Language/AST/InterfaceTypeExtensionNode.php
@@ -12,12 +12,12 @@ class InterfaceTypeExtensionNode extends Node implements TypeExtensionNode
     /** @var NameNode */
     public $name;
 
-    /** @var NodeList<DirectiveNode>|null */
+    /** @var NodeList<DirectiveNode> */
     public $directives;
 
     /** @var NodeList<InterfaceTypeDefinitionNode> */
     public $interfaces;
 
-    /** @var NodeList<FieldDefinitionNode>|null */
+    /** @var NodeList<FieldDefinitionNode> */
     public $fields;
 }
diff --git a/src/Language/AST/Location.php b/src/Language/AST/Location.php
@@ -30,14 +30,14 @@ class Location
     /**
      * The Token at which this Node begins.
      *
-     * @var Token
+     * @var Token|null
      */
     public $startToken;
 
     /**
      * The Token at which this Node ends.
      *
-     * @var Token
+     * @var Token|null
      */
     public $endToken;
 

diff --git a/src/Language/AST/ObjectTypeDefinitionNode.php b/src/Language/AST/ObjectTypeDefinitionNode.php
@@ -18,7 +18,7 @@ class ObjectTypeDefinitionNode extends Node implements TypeDefinitionNode
     /** @var NodeList<DirectiveNode> */
     public $directives;
 
-    /** @var NodeList<FieldDefinitionNode>|null */
+    /** @var NodeList<FieldDefinitionNode> */
     public $fields;
 
     /** @var StringValueNode|null */

diff --git a/src/Language/AST/ScalarTypeExtensionNode.php b/src/Language/AST/ScalarTypeExtensionNode.php
@@ -12,6 +12,6 @@ class ScalarTypeExtensionNode extends Node implements TypeExtensionNode
     /** @var NameNode */
     public $name;
 
-    /** @var NodeList<DirectiveNode>|null */
+    /** @var NodeList<DirectiveNode> */
     public $directives;
 }
diff --git a/src/Language/AST/SchemaTypeExtensionNode.php b/src/Language/AST/SchemaTypeExtensionNode.php
@@ -9,9 +9,9 @@ class SchemaTypeExtensionNode extends Node implements TypeExtensionNode
     /** @var string */
     public $kind = NodeKind::SCHEMA_EXTENSION;
 
-    /** @var NodeList<DirectiveNode>|null */
+    /** @var NodeList<DirectiveNode> */
     public $directives;
 
-    /** @var NodeList<OperationTypeDefinitionNode>|null */
+    /** @var NodeList<OperationTypeDefinitionNode> */
     public $operationTypes;
 }
diff --git a/src/Language/AST/StringValueNode.php b/src/Language/AST/StringValueNode.php
@@ -12,6 +12,6 @@ class StringValueNode extends Node implements ValueNode
     /** @var string */
     public $value;
 
-    /** @var bool|null */
+    /** @var bool */
     public $block;
 }
diff --git a/src/Language/AST/UnionTypeDefinitionNode.php b/src/Language/AST/UnionTypeDefinitionNode.php
@@ -15,7 +15,7 @@ class UnionTypeDefinitionNode extends Node implements TypeDefinitionNode
     /** @var NodeList<DirectiveNode> */
     public $directives;
 
-    /** @var NodeList<NamedTypeNode>|null */
+    /** @var NodeList<NamedTypeNode> */
     public $types;
 
     /** @var StringValueNode|null */

diff --git a/src/Language/AST/UnionTypeExtensionNode.php b/src/Language/AST/UnionTypeExtensionNode.php
@@ -12,9 +12,9 @@ class UnionTypeExtensionNode extends Node implements TypeExtensionNode
     /** @var NameNode */
     public $name;
 
-    /** @var NodeList<DirectiveNode>|null */
+    /** @var NodeList<DirectiveNode> */
     public $directives;
 
-    /** @var NodeList<NamedTypeNode>|null */
+    /** @var NodeList<NamedTypeNode> */
     public $types;
 }
diff --git a/src/Language/Parser.php b/src/Language/Parser.php
@@ -629,8 +629,9 @@ private function parseVariableDefinition() : VariableDefinitionNode
         return new VariableDefinitionNode([
             'variable'     => $var,
             'type'         => $type,
-            'defaultValue' =>
-                ($this->skip(Token::EQUALS) ? $this->parseValueLiteral(true) : null),
+            'defaultValue' => $this->skip(Token::EQUALS)
+                ? $this->parseValueLiteral(true)
+                : null,
             'directives'   => $this->parseDirectives(true),
             'loc'          => $this->loc($start),
         ]);
@@ -1553,7 +1554,7 @@ private function parseSchemaTypeExtension() : SchemaTypeExtensionNode
                 [$this, 'parseOperationTypeDefinition'],
                 Token::BRACE_R
             )
-            : [];
+            : new NodeList([]);
         if (count($directives) === 0 && count($operationTypes) === 0) {
             $this->unexpected();
         }

diff --git a/src/Type/Schema.php b/src/Type/Schema.php
@@ -204,11 +204,11 @@ private function resolveAdditionalTypes()
      *
      * This operation requires full schema scan. Do not use in production environment.
      *
-     * @return Type[]
+     * @return array<string, Type>
      *
      * @api
      */
-    public function getTypeMap()
+    public function getTypeMap() : array
     {
         if (! $this->fullyLoaded) {
             $this->resolvedTypes = $this->collectAllTypes();