Merge pull request #971 from ruudk/generator-callable

Support defining enum values by callable and/or generator

Author: mcg-web

src/EventListener/TypeDecoratorListener.php

@@ -16,6 +16,7 @@
 use Overblog\GraphQLBundle\Event\TypeLoadedEvent;
 use Overblog\GraphQLBundle\Resolver\ResolverMapInterface;
 use Overblog\GraphQLBundle\Resolver\ResolverMaps;
+use Traversable;
 use function array_diff;
 use function count;
 use function current;
@@ -135,24 +136,41 @@ private function decorateCustomScalarType(CustomScalarType $type, ResolverMapInt
 
     private function decorateEnumType(EnumType $type, ResolverMapInterface $resolverMap): void
     {
-        $fieldNames = [];
-        foreach ($type->config['values'] as $key => &$value) {
-            $fieldName = $value['name'] ?? $key;
-            if ($resolverMap->isResolvable($type->name, $fieldName)) {
-                $value['value'] = $resolverMap->resolve($type->name, $fieldName);
+        $values = $type->config['values'];
+
+        $decoratedValues = function () use ($type, $resolverMap, $values) {
+            if (is_callable($values)) {
+                $values = $values();
             }
-            $fieldNames[] = $fieldName;
-        }
-        $unknownFields = array_diff($resolverMap->covered($type->name), $fieldNames);
-        if (!empty($unknownFields)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    '"%s".{"%s"} defined in resolverMap, was defined in resolvers, but enum is not in schema.',
-                    $type->name,
-                    implode('", "', $unknownFields)
-                )
-            );
-        }
+
+            // Convert a Generator to an array so that can modify it (by reference)
+            // and return the new array.
+            $values = $values instanceof Traversable ? iterator_to_array($values) : (array) $values;
+
+            $fieldNames = [];
+            foreach ($values as $key => &$value) {
+                $fieldName = $value['name'] ?? $key;
+                if ($resolverMap->isResolvable($type->name, $fieldName)) {
+                    $value['value'] = $resolverMap->resolve($type->name, $fieldName);
+                }
+                $fieldNames[] = $fieldName;
+            }
+            $unknownFields = array_diff($resolverMap->covered($type->name), $fieldNames);
+            if (!empty($unknownFields)) {
+                throw new InvalidArgumentException(
+                    sprintf(
+                        '"%s".{"%s"} defined in resolverMap, was defined in resolvers, but enum is not in schema.',
+                        $type->name,
+                        implode('", "', $unknownFields)
+                    )
+                );
+            }
+
+            return $values;
+        };
+
+        /** @phpstan-ignore-next-line see https://github.com/webonyx/graphql-php/issues/1041  */
+        $type->config['values'] = is_callable($values) ? $decoratedValues : $decoratedValues();
     }
 
     private function decorateObjectTypeFields(ObjectType $type, array $fieldsResolved, ResolverMapInterface $resolverMap): void
@@ -164,6 +182,10 @@ private function decorateObjectTypeFields(ObjectType $type, array $fieldsResolve
                 $fields = $fields();
             }
 
+            // Convert a Generator to an array so that can modify it (by reference)
+            // and return the new array.
+            $fields = $fields instanceof Traversable ? iterator_to_array($fields) : (array) $fields;
+
             $fieldNames = [];
             foreach ($fields as $key => &$field) {
                 $fieldName = $field['name'] ?? $key;

tests/EventListener/TypeDecoratorListenerTest.php

@@ -60,12 +60,10 @@ public function testObjectTypeFieldDecoration(): ObjectType
     {
         $objectType = new ObjectType([
             'name' => 'Foo',
-            'fields' => function () {
-                return [
-                    'bar' => ['type' => Type::string()],
-                    'baz' => ['type' => Type::string()],
-                    'toto' => ['type' => Type::boolean(), 'resolve' => null],
-                ];
+            'fields' => function (): iterable {
+                yield 'bar' => ['type' => Type::string()];
+                yield 'baz' => ['type' => Type::string()];
+                yield 'toto' => ['type' => Type::boolean(), 'resolve' => null];
             },
         ]);
         $barResolver = static fn () => 'bar';
@@ -143,6 +141,35 @@ public function testEnumTypeValuesDecoration(): void
         );
     }
 
+    public function testEnumTypeLazyValuesDecoration(): void
+    {
+        $enumType = new EnumType([
+            'name' => 'Foo',
+            'values' => function (): iterable {
+                yield 'BAR' => ['name' => 'BAR', 'value' => 'BAR'];
+                yield 'BAZ' => ['name' => 'BAZ', 'value' => 'BAZ'];
+                yield 'TOTO' => ['name' => 'TOTO', 'value' => 'TOTO'];
+            },
+        ]);
+
+        $this->decorate(
+            [$enumType->name => $enumType],
+            [$enumType->name => ['BAR' => 1, 'BAZ' => 2]]
+        );
+
+        $values = is_callable($enumType->config['values']) ? $enumType->config['values']() : $enumType->config['values'];
+        $values = $values instanceof Traversable ? iterator_to_array($values) : (array) $values;
+
+        $this->assertSame(
+            [
+                'BAR' => ['name' => 'BAR', 'value' => 1],
+                'BAZ' => ['name' => 'BAZ', 'value' => 2],
+                'TOTO' => ['name' => 'TOTO', 'value' => 'TOTO'],
+            ],
+            $values
+        );
+    }
+
     public function testEnumTypeUnknownField(): void
     {
         $enumType = new EnumType([