Immutability (#584)

* Make parts of graphqlite immutable

* Revert previous versions docs

* Refactor getters, PHPStan, codestyle

* Fix phpcbf's broken Cloneable

* Fix return types in docs

* Fix "test" class names used for resolvers

* Refactor GlobAnnotationsCache to be immutable

Author: oprypkhantc

phpstan.neon

@@ -17,6 +17,10 @@ parameters:
         - "#Parameter .* of class ReflectionMethod constructor expects string(\\|null)?, object\\|string given.#"
         - "#PHPDoc tag @throws with type Psr\\\\SimpleCache\\\\InvalidArgumentException is not subtype of Throwable#"
         - '#Variable \$context might not be defined.#'
+        # TODO: fix these in the resolver refactor PR that follows; it'll be initialized in the constructor
+        - '#Class TheCodingMachine\\GraphQLite\\(QueryFieldDescriptor|InputFieldDescriptor) has an uninitialized readonly property \$(originalResolver|resolver)\. Assign it in the constructor.#'
+        - '#Readonly property TheCodingMachine\\GraphQLite\\(QueryFieldDescriptor|InputFieldDescriptor)::\$(originalResolver|resolver) is assigned outside of the constructor\.#'
+        - '#Property TheCodingMachine\\GraphQLite\\(QueryFieldDescriptor|InputFieldDescriptor)::\$resolver \(callable\) in isset\(\) is not nullable\.#'
         -
            message: '#Parameter .* of class GraphQL\\Error\\Error constructor expects#'
            path: src/Exceptions/WebonyxErrorHandler.php

src/Context/Context.php

@@ -5,8 +5,8 @@
 namespace TheCodingMachine\GraphQLite\Context;
 
 use SplObjectStorage;
+use TheCodingMachine\GraphQLite\Parameters\ParameterInterface;
 use TheCodingMachine\GraphQLite\PrefetchBuffer;
-use TheCodingMachine\GraphQLite\QueryField;
 
 /**
  * A context class that should be passed to the Webonyx executor.
@@ -24,7 +24,7 @@ public function __construct()
      * Returns the prefetch buffer associated to the field $field.
      * (the buffer is created on the fly if it does not exist yet).
      */
-    public function getPrefetchBuffer(QueryField $field): PrefetchBuffer
+    public function getPrefetchBuffer(ParameterInterface $field): PrefetchBuffer
     {
         if ($this->prefetchBuffers->offsetExists($field)) {
             $prefetchBuffer = $this->prefetchBuffers->offsetGet($field);

src/Context/ContextInterface.php

@@ -4,8 +4,8 @@
 
 namespace TheCodingMachine\GraphQLite\Context;
 
+use TheCodingMachine\GraphQLite\Parameters\ParameterInterface;
 use TheCodingMachine\GraphQLite\PrefetchBuffer;
-use TheCodingMachine\GraphQLite\QueryField;
 
 /**
  * A context class that should be passed to the Webonyx executor.
@@ -18,5 +18,5 @@ interface ContextInterface
      * Returns the prefetch buffer associated to the field $field.
      * (the buffer is created on the fly if it does not exist yet).
      */
-    public function getPrefetchBuffer(QueryField $field): PrefetchBuffer;
+    public function getPrefetchBuffer(ParameterInterface $field): PrefetchBuffer;
 }

src/FieldsBuilder.php

@@ -14,7 +14,6 @@
 use GraphQL\Type\Definition\Type;
 use TheCodingMachine\GraphQLite\Exceptions\GraphQLAggregateException;
 use TheCodingMachine\GraphQLite\Middlewares\ResolverInterface;
-use TheCodingMachine\GraphQLite\Middlewares\SourceResolverInterface;
 use TheCodingMachine\GraphQLite\Parameters\MissingArgumentException;
 use TheCodingMachine\GraphQLite\Parameters\ParameterInterface;
 use TheCodingMachine\GraphQLite\Parameters\SourceParameter;
@@ -54,12 +53,9 @@ public function __construct(string $name, InputType $type, array $arguments, Res
         }
 
         if ($originalResolver !== null && $resolver !== null) {
-            $this->resolve = function ($source, array $args, $context, ResolveInfo $info) use ($arguments, $originalResolver, $resolver) {
-                if ($originalResolver instanceof SourceResolverInterface) {
-                    $originalResolver->setObject($source);
-                }
+            $this->resolve = function (object $source, array $args, $context, ResolveInfo $info) use ($arguments, $originalResolver, $resolver) {
                 $toPassArgs = $this->paramsToArguments($arguments, $source, $args, $context, $info, $resolver);
-                $result = $resolver(...$toPassArgs);
+                $result = $resolver($source, ...$toPassArgs);
 
                 try {
                     $this->assertInputType($result);
@@ -72,7 +68,7 @@ public function __construct(string $name, InputType $type, array $arguments, Res
             };
         } else {
             $this->forConstructorHydration = true;
-            $this->resolve = function ($source, array $args, $context, ResolveInfo $info) use ($arguments) {
+            $this->resolve = function (object|null $source, array $args, $context, ResolveInfo $info) use ($arguments) {
                 $result = $arguments[$this->name]->resolve($source, $args, $context, $info);
                 $this->assertInputType($result);
                 return $result;
@@ -143,7 +139,7 @@ public static function fromFieldDescriptor(InputFieldDescriptor $fieldDescriptor
         if ($fieldDescriptor->isInjectSource() === true) {
             $arguments = ['__graphqlite_source' => new SourceParameter()] + $arguments;
         }
-        $fieldDescriptor->setParameters($arguments);
+        $fieldDescriptor = $fieldDescriptor->withParameters($arguments);
 
         return self::fromDescriptor($fieldDescriptor);
     }