Merge branch 'master' into dependabot/composer/monolog/monolog-tw-2.8.0

Author: Vincz

.github/workflows/ci.yml

@@ -31,7 +31,7 @@ jobs:
             symfony-version: '5.4.*'
             dependencies: 'lowest'
             remove-dependencies: '--dev symfony/validator doctrine/orm doctrine/annotations'
-          - php-version: '8.0'
+          - php-version: '8.1'
             symfony-version: '5.4.*'
             dependencies: 'lowest'
             coverage: "pcov"
@@ -86,7 +86,7 @@ jobs:
         uses: "shivammathur/setup-php@v2"
         with:
           tools: flex
-          php-version: "8.0"
+          php-version: "8.1"
 
       - name: "Install dependencies"
         uses: ramsey/composer-install@v2
@@ -101,7 +101,6 @@ jobs:
       fail-fast: false
       matrix:
         php-version:
-          - '8.0'
           - '8.1'
     steps:
       - name: "Checkout"

README.md

@@ -9,7 +9,7 @@ OverblogGraphQLBundle
 [![Total Downloads](https://poser.pugx.org/overblog/graphql-bundle/downloads)](https://packagist.org/packages/overblog/graphql-bundle)
 
 This Symfony bundle provides integration of [GraphQL](https://facebook.github.io/graphql/) using [webonyx/graphql-php](https://github.com/webonyx/graphql-php)
-and [GraphQL Relay](https://facebook.github.io/relay/docs/en/graphql-server-specification.html).
+and [GraphQL Relay](https://relay.dev/docs/guides/graphql-server-specification/).
 It also supports:
 * batching with [ReactRelayNetworkLayer](https://github.com/nodkz/react-relay-network-layer)
 * batching with [Apollo GraphQL](https://www.apollographql.com/docs/react/api/link/apollo-link-batch-http/)

docs/definitions/type-system/enum.md

@@ -57,3 +57,57 @@ class Episode
     public $value;
 }
 ```
+
+## Working with native PHP 8.1 enums
+
+Given a PHP enum as follow:
+
+```php
+namespace App;
+
+enum Color 
+{
+    case RED;
+    case GREEN;
+    case BLUE;
+}
+```
+
+You can declare it with annotations or attributes as follow:
+
+```php
+#[GQL\Enum]
+enum Color 
+{
+    #[GQL\Description("The color red")]
+    case RED;
+    case GREEN;
+    case BLUE;
+}
+```
+
+or with YAML:
+
+```yaml
+Color:
+    type: enum
+    config:
+        enumClass: App\Color
+```
+
+The possible values will be automatically extracted from the enum but if you need to add description and/or deprecated, you can proceed this way
+
+```yaml
+Color:
+    type: enum
+    config:
+        enumClass: App\Color
+        values:
+            GREEN:
+                description: "The color green"
+```
+When using PHP enum, the serialization will extract the `name` of the enum case, and the deserialization will return the enum case by its `name`.  
+Even if the used enum is a Backed enum, the serialization and deserialization will always use the `name` and not the value.  
+
+
+

phpstan-baseline.neon

@@ -481,87 +481,87 @@ parameters:
 			path: tests/Functional/Validator/DummyEntity.php
 
 		-
-			message: "#^Cannot access offset mixed on iterable\\<Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\>\\.$#"
+			message: "#^Cannot access offset mixed on iterable\\<Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\<mixed\\>\\>\\.$#"
 			count: 2
 			path: tests/Relay/Connection/AbstractConnectionBuilderTest.php
 
 		-
-			message: "#^Parameter \\#1 \\$value of function count expects array\\|Countable, iterable\\<Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\> given\\.$#"
+			message: "#^Parameter \\#1 \\$value of function count expects array\\|Countable, iterable\\<Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\<mixed\\>\\> given\\.$#"
 			count: 1
 			path: tests/Relay/Connection/AbstractConnectionBuilderTest.php
 
 		-
-			message: "#^Cannot access offset 0 on iterable\\<Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\>\\.$#"
+			message: "#^Cannot access offset 0 on iterable\\<Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\<mixed\\>\\>\\.$#"
 			count: 4
 			path: tests/Relay/Connection/ConnectionBuilderTest.php
 
 		-
-			message: "#^Cannot access offset 1 on iterable\\<Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\>\\.$#"
+			message: "#^Cannot access offset 1 on iterable\\<Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\<mixed\\>\\>\\.$#"
 			count: 4
 			path: tests/Relay/Connection/ConnectionBuilderTest.php
 
 		-
-			message: "#^Cannot access offset 2 on iterable\\<Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\>\\.$#"
+			message: "#^Cannot access offset 2 on iterable\\<Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\<mixed\\>\\>\\.$#"
 			count: 1
 			path: tests/Relay/Connection/ConnectionBuilderTest.php
 
 		-
-			message: "#^Cannot access offset 3 on iterable\\<Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\>\\.$#"
+			message: "#^Cannot access offset 3 on iterable\\<Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\<mixed\\>\\>\\.$#"
 			count: 1
 			path: tests/Relay/Connection/ConnectionBuilderTest.php
 
 		-
-			message: "#^Access to an undefined property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\:\\:\\$cursor\\.$#"
+			message: "#^Access to an undefined property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\Output\\\\Connection\\<mixed\\>\\:\\:\\$extra\\.$#"
 			count: 1
 			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
 
 		-
-			message: "#^Access to an undefined property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\:\\:\\$node\\.$#"
+			message: "#^Access to an undefined property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\PageInfoInterface\\:\\:\\$endCursor\\.$#"
 			count: 1
 			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
 
 		-
-			message: "#^Access to an undefined property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\Output\\\\Connection\\:\\:\\$extra\\.$#"
+			message: "#^Access to an undefined property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\PageInfoInterface\\:\\:\\$hasNextPage\\.$#"
 			count: 1
 			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
 
 		-
-			message: "#^Access to an undefined property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\PageInfoInterface\\:\\:\\$endCursor\\.$#"
+			message: "#^Access to an undefined property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\PageInfoInterface\\:\\:\\$hasPreviousPage\\.$#"
 			count: 1
 			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
 
 		-
-			message: "#^Access to an undefined property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\PageInfoInterface\\:\\:\\$hasNextPage\\.$#"
+			message: "#^Access to an undefined property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\PageInfoInterface\\:\\:\\$startCursor\\.$#"
 			count: 1
 			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
 
 		-
-			message: "#^Access to an undefined property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\PageInfoInterface\\:\\:\\$hasPreviousPage\\.$#"
+			message: "#^Access to protected property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\Output\\\\Connection\\<mixed\\>\\:\\:\\$edges\\.$#"
 			count: 1
 			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
 
 		-
-			message: "#^Access to an undefined property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\PageInfoInterface\\:\\:\\$startCursor\\.$#"
+			message: "#^Access to protected property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\Output\\\\Connection\\<mixed\\>\\:\\:\\$pageInfo\\.$#"
 			count: 1
 			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
 
 		-
-			message: "#^Access to protected property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\Output\\\\Connection\\:\\:\\$edges\\.$#"
-			count: 2
+			message: "#^Access to protected property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\Output\\\\Connection\\<string\\>\\:\\:\\$edges\\.$#"
+			count: 1
 			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
 
 		-
-			message: "#^Access to protected property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\Output\\\\Connection\\:\\:\\$pageInfo\\.$#"
-			count: 2
+			message: "#^Access to protected property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\Output\\\\Connection\\<string\\>\\:\\:\\$pageInfo\\.$#"
+			count: 1
 			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
 
 		-
-			message: "#^Access to protected property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\Output\\\\Edge\\:\\:\\$cursor\\.$#"
+			message: "#^Access to protected property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\Output\\\\Edge\\<null\\>\\:\\:\\$cursor\\.$#"
 			count: 1
 			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
 
 		-
-			message: "#^Access to protected property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\Output\\\\Edge\\:\\:\\$node\\.$#"
+			message: "#^Access to protected property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\Output\\\\Edge\\<null\\>\\:\\:\\$node\\.$#"
 			count: 1
 			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
 
@@ -585,3 +585,18 @@ parameters:
 			count: 1
 			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
 
+		-
+			message: "#^Call to method PHPUnit\\\\Framework\\\\Assert\\:\\:assertSame\\(\\) with 'node' and null will always evaluate to false\\.$#"
+			count: 1
+			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
+
+		-
+			message: "#^Cannot access offset 0 on iterable\\<Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\EdgeInterface\\<string\\>\\>\\.$#"
+			count: 4
+			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
+
+		-
+			message: "#^Property Overblog\\\\GraphQLBundle\\\\Relay\\\\Connection\\\\Output\\\\Edge\\<null\\>\\:\\:\\$node \\(null\\) does not accept string\\.$#"
+			count: 1
+			path: tests/Relay/Connection/Output/DeprecatedPropertyPublicAccessTraitTest.php
+

src/Config/EnumTypeDefinition.php

@@ -21,6 +21,16 @@ public function getDefinition(): ArrayNodeDefinition
         $node
             ->children()
                 ->append($this->nameSection())
+                ->scalarNode('enumClass')
+                    ->validate()
+                        ->ifTrue(fn () => PHP_VERSION_ID < 80100)
+                        ->thenInvalid('The enumClass option requires PHP 8.1 or higher.')
+                    ->end()
+                    ->validate()
+                        ->ifTrue(fn ($v) => !class_exists($v))
+                        ->thenInvalid('The specified enum Class "%s" does not exist.')
+                    ->end()
+                ->end()
                 ->arrayNode('values')
                     ->useAttributeAsKey('name')
                     ->beforeNormalization()
@@ -49,8 +59,6 @@ public function getDefinition(): ArrayNodeDefinition
                             ->append($this->deprecationReasonSection())
                         ->end()
                     ->end()
-                    ->isRequired()
-                    ->requiresAtLeastOneElement()
                 ->end()
                 ->append($this->descriptionSection())
             ->end();

src/Config/Parser/MetadataParser/MetadataParser.php

@@ -42,6 +42,8 @@
 use function substr;
 use function trim;
 
+use const PHP_VERSION_ID;
+
 abstract class MetadataParser implements PreParserInterface
 {
     public const ANNOTATION_NAMESPACE = 'Overblog\GraphQLBundle\Annotation\\';
@@ -434,15 +436,15 @@ private static function enumMetadataToGQLConfiguration(ReflectionClass $reflecti
     {
         $metadatas = static::getMetadatas($reflectionClass);
         $enumValues = self::getMetadataMatching($metadatas, Metadata\EnumValue::class);
-
+        $isPhpEnum = PHP_VERSION_ID >= 80100 && $reflectionClass->isEnum();
         $values = [];
 
         foreach ($reflectionClass->getConstants() as $name => $value) {
             $reflectionConstant = new ReflectionClassConstant($reflectionClass->getName(), $name);
             $valueConfig = self::getDescriptionConfiguration(static::getMetadatas($reflectionConstant), true);
 
             $enumValueAnnotation = current(array_filter($enumValues, fn ($enumValueAnnotation) => $enumValueAnnotation->name === $name));
-            $valueConfig['value'] = $value;
+            $valueConfig['value'] = $isPhpEnum ? $value->name : $value;
 
             if (false !== $enumValueAnnotation) {
                 if (isset($enumValueAnnotation->description)) {
@@ -459,6 +461,9 @@ private static function enumMetadataToGQLConfiguration(ReflectionClass $reflecti
 
         $enumConfiguration = ['values' => $values];
         $enumConfiguration = self::getDescriptionConfiguration(static::getMetadatas($reflectionClass)) + $enumConfiguration;
+        if ($isPhpEnum) {
+            $enumConfiguration['enumClass'] = $reflectionClass->getName();
+        }
 
         return ['type' => 'enum', 'config' => $enumConfiguration];
     }