Improving error message if a Query has no return type

Author: moufmouf

src/ControllerQueryProvider.php

@@ -165,15 +165,21 @@ private function getFieldsByAnnotations(string $annotationName, bool $injectSour
 
                 $args = $this->mapParameters($refMethod, $docBlockObj);
 
-                $phpdocType = $typeResolver->resolve((string) $refMethod->getReturnType());
-
                 if ($queryAnnotation->getReturnType()) {
                     $type = $this->registry->get($queryAnnotation->getReturnType());
                 } else {
+                    $phpdocType = null;
+                    $returnType = $refMethod->getReturnType();
+                    if ($returnType !== null) {
+                        $phpdocType = $typeResolver->resolve((string) $refMethod->getReturnType());
+                    } else {
+                        $phpdocType = new Mixed_();
+                    }
+
                     $docBlockReturnType = $this->getDocBlocReturnType($docBlockObj, $refMethod);
 
                     try {
-                        $type = $this->mapType($phpdocType, $docBlockReturnType, $refMethod->getReturnType()->allowsNull(), false);
+                        $type = $this->mapType($phpdocType, $docBlockReturnType, $returnType ? $returnType->allowsNull() : true, false);
                     } catch (TypeMappingException $e) {
                         throw TypeMappingException::wrapWithReturnInfo($e, $refMethod);
                     }
@@ -417,7 +423,7 @@ private function mapType(Type $type, ?Type $docBlockType, bool $isNullable, bool
                 }
             } catch (TypeMappingException | CannotMapTypeException $e) {
                 // Is the type iterable? If yes, let's analyze the docblock
-                // TODO: it would be bettrr not to go through an exception for this.
+                // TODO: it would be better not to go through an exception for this.
                 if ($type instanceof Object_) {
                     $fqcn = (string) $type->getFqsen();
                     $refClass = new ReflectionClass($fqcn);

tests/ControllerQueryProviderTest.php

@@ -13,6 +13,7 @@
 use GraphQL\Type\Definition\StringType;
 use GraphQL\Type\Definition\ObjectType;
 use TheCodingMachine\GraphQL\Controllers\Fixtures\TestController;
+use TheCodingMachine\GraphQL\Controllers\Fixtures\TestControllerNoReturnType;
 use TheCodingMachine\GraphQL\Controllers\Fixtures\TestObject;
 use TheCodingMachine\GraphQL\Controllers\Fixtures\TestType;
 use TheCodingMachine\GraphQL\Controllers\Fixtures\TestTypeId;
@@ -290,4 +291,11 @@ public function testQueryProviderWithIterable()
         $this->assertInstanceOf(ObjectType::class, $iterableQuery->getType()->getWrappedType()->getWrappedType()->getWrappedType());
         $this->assertSame('TestObject', $iterableQuery->getType()->getWrappedType()->getWrappedType()->getWrappedType()->name);
     }
+
+    public function testNoReturnTypeError()
+    {
+        $queryProvider = new ControllerQueryProvider(new TestControllerNoReturnType(), $this->getRegistry());
+        $this->expectException(TypeMappingException::class);
+        $queryProvider->getQueries();
+    }
 }

tests/Fixtures/TestControllerNoReturnType.php

@@ -0,0 +1,21 @@
+<?php
+
+
+namespace TheCodingMachine\GraphQL\Controllers\Fixtures;
+
+use ArrayObject;
+use TheCodingMachine\GraphQL\Controllers\Annotations\Logged;
+use TheCodingMachine\GraphQL\Controllers\Annotations\Mutation;
+use TheCodingMachine\GraphQL\Controllers\Annotations\Query;
+use TheCodingMachine\GraphQL\Controllers\Annotations\Right;
+
+class TestControllerNoReturnType
+{
+    /**
+     * @Query()
+     */
+    public function test()
+    {
+        return 'foo';
+    }
+}