Merge branch 'master' into patch-3

bartv2 · web-flow · commit 8b52961fcc3a · 2020-08-18T20:59:37.000+02:00
diff --git a/docs/annotations/index.md b/docs/annotations/index.md
@@ -116,6 +116,27 @@ In the previous example, the generated `resolve` config of the `something` field
 
 ## Type & Args auto-guessing
 
+### @Field type auto-guessing when defined on a property with a type hint
+
+The type of the `@Field` annotation can be auto-guessed if it's defined on a property with a type hint.
+If the property has a usable type hint this is used and no futher guessing is done.
+
+For example:
+
+```php
+/**
+ * @GQL\Type
+ */
+class MyType {
+    /**
+     * @GQL\Field
+     */
+    protected string $property;
+}
+```
+
+In this example, the type `String!` will be auto-guessed from the type hint of the property.  
+
 ### @Field type auto-guessing from Doctrine ORM Annotations
 
 Based on other Doctrine annotations on your fields, the corresponding GraphQL type can sometimes be guessed automatically.  
diff --git a/src/Annotation/Access.php b/src/Annotation/Access.php
@@ -15,7 +15,7 @@ final class Access implements Annotation
     /**
      * Field access.
      *
-     * @required
+     * @Required
      *
      * @var string
      */
diff --git a/src/Annotation/Arg.php b/src/Annotation/Arg.php
@@ -15,7 +15,7 @@ final class Arg implements Annotation
     /**
      * Argument name.
      *
-     * @required
+     * @Required
      *
      * @var string
      */
@@ -31,7 +31,7 @@ final class Arg implements Annotation
     /**
      * Argument type.
      *
-     * @required
+     * @Required
      *
      * @var string
      */
diff --git a/src/Annotation/Deprecated.php b/src/Annotation/Deprecated.php
@@ -15,7 +15,7 @@ final class Deprecated implements Annotation
     /**
      * The deprecation reason.
      *
-     * @required
+     * @Required
      *
      * @var string
      */
diff --git a/src/Annotation/Description.php b/src/Annotation/Description.php
@@ -15,7 +15,7 @@ final class Description implements Annotation
     /**
      * The object description.
      *
-     * @required
+     * @Required
      *
      * @var string
      */
diff --git a/src/Annotation/Field.php b/src/Annotation/Field.php
@@ -22,8 +22,6 @@ class Field implements Annotation
     /**
      * Field Type.
      *
-     * @required
-     *
      * @var string
      */
     public string $type;
diff --git a/src/Annotation/FieldsBuilder.php b/src/Annotation/FieldsBuilder.php
@@ -15,7 +15,7 @@ final class FieldsBuilder implements Annotation
     /**
      * Builder name.
      *
-     * @required
+     * @Required
      *
      * @var string
      */
diff --git a/src/Annotation/IsPublic.php b/src/Annotation/IsPublic.php
@@ -15,7 +15,7 @@ final class IsPublic implements Annotation
     /**
      * Field publicity.
      *
-     * @required
+     * @Required
      *
      * @var string
      */
diff --git a/src/Annotation/Relay/Edge.php b/src/Annotation/Relay/Edge.php
@@ -17,7 +17,7 @@ final class Edge extends Type
     /**
      * Edge Node type.
      *
-     * @required
+     * @Required
      *
      * @var string
      */
diff --git a/src/Annotation/TypeInterface.php b/src/Annotation/TypeInterface.php
@@ -22,7 +22,7 @@ final class TypeInterface implements Annotation
     /**
      * Resolver type for interface.
      *
-     * @required
+     * @Required
      *
      * @var string
      */
diff --git a/src/Config/Parser/AnnotationParser.php b/src/Config/Parser/AnnotationParser.php
@@ -408,7 +408,7 @@ private static function scalarAnnotationToGQLConfiguration(GraphClass $graphClas
      */
     private static function enumAnnotationToGQLConfiguration(GraphClass $graphClass, GQL\Enum $enumAnnotation): array
     {
-        $enumValues = $enumAnnotation->values ? $enumAnnotation->values : [];
+        $enumValues = $enumAnnotation->values ?? [];
 
         $values = [];
 
@@ -585,7 +585,7 @@ private static function getTypeFieldConfigurationFromReflector(GraphClass $graph
                     }
                 } else {
                     try {
-                        $fieldConfiguration['type'] = self::guessType($graphClass, $annotations);
+                        $fieldConfiguration['type'] = self::guessType($graphClass, $reflector, self::VALID_OUTPUT_TYPES);
                     } catch (Exception $e) {
                         throw new InvalidArgumentException(sprintf('The attribute "type" on "@%s" defined on "%s" is required and cannot be auto-guessed : %s.', $fieldAnnotationName, $reflector->getName(), $e->getMessage()));
                     }
@@ -622,16 +622,29 @@ private static function getGraphQLInputFieldsFromAnnotations(GraphClass $graphCl
         foreach ($reflectors as $reflector) {
             $annotations = $graphClass->getAnnotations($reflector);
 
-            /** @var GQL\Field $fieldAnnotation */
+            /** @var GQL\Field|null $fieldAnnotation */
             $fieldAnnotation = self::getFirstAnnotationMatching($annotations, GQL\Field::class);
 
+            // No field annotation found
+            if (null === $fieldAnnotation) {
+                continue;
+            }
+
             // Ignore field with resolver when the type is an Input
             if (isset($fieldAnnotation->resolve)) {
                 continue;
             }
 
             $fieldName = $reflector->getName();
-            $fieldType = $fieldAnnotation->type;
+            if (isset($fieldAnnotation->type)) {
+                $fieldType = $fieldAnnotation->type;
+            } else {
+                try {
+                    $fieldType = self::guessType($graphClass, $reflector, self::VALID_INPUT_TYPES);
+                } catch (Exception $e) {
+                    throw new InvalidArgumentException(sprintf('The attribute "type" on GraphQL annotation "@%s" is missing on property "%s" and cannot be auto-guessed as there is no type hint or Doctrine annotation.', GQL\Field::class, $reflector->getName()));
+                }
+            }
             $fieldConfiguration = [];
             if ($fieldType) {
                 // Resolve a PHP class from a GraphQL type
@@ -729,7 +742,7 @@ private static function getGraphQLFieldsFromProviders(GraphClass $graphClass, st
             $currentValue = sprintf("service('%s')", self::formatNamespaceForExpression($providerMetadata->getName()));
             $providerFields = self::getGraphQLTypeFieldsFromAnnotations($graphClass, $methods, $expectedAnnotation, $currentValue);
             foreach ($providerFields as $fieldName => $fieldConfig) {
-                if ($providerAnnotation->prefix) {
+                if (isset($providerAnnotation->prefix)) {
                     $fieldName = sprintf('%s%s', $providerAnnotation->prefix, $fieldName);
                 }
 
@@ -839,8 +852,17 @@ private static function suffixName(string $name, string $suffix): string
      *
      * @throws RuntimeException
      */
-    private static function guessType(GraphClass $graphClass, array $annotations): string
+    private static function guessType(GraphClass $graphClass, ReflectionProperty $reflector, array $filterGraphQLTypes = []): string
     {
+        if ($reflector->hasType()) {
+            try {
+                // @phpstan-ignore-next-line
+                return self::resolveGraphQLTypeFromReflectionType($reflector->getType(), $filterGraphQLTypes);
+            } catch (Exception $e) {
+            }
+        }
+
+        $annotations = $graphClass->getAnnotations($reflector);
         $columnAnnotation = self::getFirstAnnotationMatching($annotations, Column::class);
         if (null !== $columnAnnotation) {
             $type = self::resolveTypeFromDoctrineType($columnAnnotation->type);
diff --git a/tests/Config/Parser/AnnotationParserTest.php b/tests/Config/Parser/AnnotationParserTest.php
@@ -188,6 +188,10 @@ public function testInput(): void
             'fields' => [
                 'name' => ['type' => 'String!'],
                 'population' => ['type' => 'Int!'],
+                'description' => ['type' => 'String!'],
+                'diameter' => ['type' => 'Int'],
+                'variable' => ['type' => 'Int!'],
+                'tags' => ['type' => '[String]!'],
             ],
         ]);
     }
diff --git a/tests/Config/Parser/fixtures/annotations/Input/Planet.php b/tests/Config/Parser/fixtures/annotations/Input/Planet.php
@@ -4,6 +4,7 @@
 
 namespace Overblog\GraphQLBundle\Tests\Config\Parser\fixtures\annotations\Input;
 
+use Doctrine\ORM\Mapping as ORM;
 use Overblog\GraphQLBundle\Annotation as GQL;
 
 /**
@@ -26,4 +27,31 @@ class Planet
      * @GQL\Field(type="Int!")
      */
     protected string $population;
+
+    /**
+     * @GQL\Field
+     */
+    protected string $description;
+
+    /**
+     * @GQL\Field
+     * @ORM\Column(type="integer", nullable=true)
+     */
+    // @phpstan-ignore-next-line
+    protected $diameter;
+
+    /**
+     * @GQL\Field
+     * @ORM\Column(type="boolean")
+     */
+    protected int $variable;
+
+    // @phpstan-ignore-next-line
+    protected $dummy;
+
+    /**
+     * @GQL\Field
+     * @ORM\Column(type="text[]")
+     */
+    protected array $tags;
 }
diff --git a/tests/Config/Parser/fixtures/annotations/Invalid/InvalidAccess.php b/tests/Config/Parser/fixtures/annotations/Invalid/InvalidAccess.php
@@ -12,7 +12,7 @@
 class InvalidAccess
 {
     /**
-     * @GQL\Access()
+     * @GQL\Access("access")
      */
     protected string $field;
 }
diff --git a/tests/Config/Parser/fixtures/annotations/Type/Droid.php b/tests/Config/Parser/fixtures/annotations/Type/Droid.php
@@ -13,7 +13,7 @@
 class Droid extends Character
 {
     /**
-     * @GQL\Field(type="Int!")
+     * @GQL\Field
      */
     protected int $memory;
 }
diff --git a/tests/Config/Parser/fixtures/annotations/Type/Lightsaber.php b/tests/Config/Parser/fixtures/annotations/Type/Lightsaber.php
@@ -23,38 +23,44 @@ class Lightsaber
      * @ORM\Column(type="integer", nullable=true)
      * @GQL\Field
      */
-    protected int $size;
+    // @phpstan-ignore-next-line
+    protected $size;
 
     /**
      * @ORM\OneToMany(targetEntity="Hero")
      * @GQL\Field
      */
-    protected Hero $holders;
+    // @phpstan-ignore-next-line
+    protected $holders;
 
     /**
      * @ORM\ManyToOne(targetEntity="Hero")
      * @GQL\Field
      */
-    protected Hero $creator;
+    // @phpstan-ignore-next-line
+    protected $creator;
 
     /**
      * @ORM\OneToOne(targetEntity="Crystal")
      * @GQL\Field
      */
-    protected Crystal $crystal;
+    // @phpstan-ignore-next-line
+    protected $crystal;
 
     /**
      * @ORM\ManyToMany(targetEntity="Battle")
      * @GQL\Field
      */
-    protected Battle $battles;
+    // @phpstan-ignore-next-line
+    protected $battles;
 
     /**
      * @GQL\Field
      * @ORM\OneToOne(targetEntity="Hero")
      * @ORM\JoinColumn(nullable=true)
      */
-    protected Hero $currentHolder;
+    // @phpstan-ignore-next-line
+    protected $currentHolder;
 
     /**
      * @GQL\Field

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ final class Access implements Annotation`
`15`	`15`	`/**`
`16`	`16`	`* Field access.`
`17`	`17`	`*`
`18`		`- * @required`
	`18`	`+ * @Required`
`19`	`19`	`*`
`20`	`20`	`* @var string`
`21`	`21`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ final class Arg implements Annotation`
`15`	`15`	`/**`
`16`	`16`	`* Argument name.`
`17`	`17`	`*`
`18`		`- * @required`
	`18`	`+ * @Required`
`19`	`19`	`*`
`20`	`20`	`* @var string`
`21`	`21`	`*/`
`@@ -31,7 +31,7 @@ final class Arg implements Annotation`
`31`	`31`	`/**`
`32`	`32`	`* Argument type.`
`33`	`33`	`*`
`34`		`- * @required`
	`34`	`+ * @Required`
`35`	`35`	`*`
`36`	`36`	`* @var string`
`37`	`37`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ final class Deprecated implements Annotation`
`15`	`15`	`/**`
`16`	`16`	`* The deprecation reason.`
`17`	`17`	`*`
`18`		`- * @required`
	`18`	`+ * @Required`
`19`	`19`	`*`
`20`	`20`	`* @var string`
`21`	`21`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ final class Description implements Annotation`
`15`	`15`	`/**`
`16`	`16`	`* The object description.`
`17`	`17`	`*`
`18`		`- * @required`
	`18`	`+ * @Required`
`19`	`19`	`*`
`20`	`20`	`* @var string`
`21`	`21`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,6 @@ class Field implements Annotation`
`22`	`22`	`/**`
`23`	`23`	`* Field Type.`
`24`	`24`	`*`
`25`		`- * @required`
`26`		`- *`
`27`	`25`	`* @var string`
`28`	`26`	`*/`
`29`	`27`	`public string $type;`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ final class FieldsBuilder implements Annotation`
`15`	`15`	`/**`
`16`	`16`	`* Builder name.`
`17`	`17`	`*`
`18`		`- * @required`
	`18`	`+ * @Required`
`19`	`19`	`*`
`20`	`20`	`* @var string`
`21`	`21`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ final class IsPublic implements Annotation`
`15`	`15`	`/**`
`16`	`16`	`* Field publicity.`
`17`	`17`	`*`
`18`		`- * @required`
	`18`	`+ * @Required`
`19`	`19`	`*`
`20`	`20`	`* @var string`
`21`	`21`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ final class Edge extends Type`
`17`	`17`	`/**`
`18`	`18`	`* Edge Node type.`
`19`	`19`	`*`
`20`		`- * @required`
	`20`	`+ * @Required`
`21`	`21`	`*`
`22`	`22`	`* @var string`
`23`	`23`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ final class TypeInterface implements Annotation`
`22`	`22`	`/**`
`23`	`23`	`* Resolver type for interface.`
`24`	`24`	`*`
`25`		`- * @required`
	`25`	`+ * @Required`
`26`	`26`	`*`
`27`	`27`	`* @var string`
`28`	`28`	`*/`