Accept any array as inputs and serialize it as a list (#71)

spawnia · web-flow · commit b25728ce1d68 · 2022-09-20T14:26:16.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## v0.24.0
+
+### Added
+
+- Accept any array as inputs and serialize it as a list
+
 ## v0.23.1
 
 ### Fixed
diff --git a/examples/input/expected/Operations/TakeList.php b/examples/input/expected/Operations/TakeList.php
@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spawnia\Sailor\Input\Operations;
+
+/**
+ * @extends \Spawnia\Sailor\Operation<\Spawnia\Sailor\Input\Operations\TakeList\TakeListResult>
+ */
+class TakeList extends \Spawnia\Sailor\Operation
+{
+    /**
+     * @param array<int|null>|null $values
+     */
+    public static function execute($values = 'Special default value that allows Sailor to differentiate between explicitly passing null and not passing a value at all.'): TakeList\TakeListResult
+    {
+        return self::executeOperation(
+            $values,
+        );
+    }
+
+    protected static function converters(): array
+    {
+        static $converters;
+
+        return $converters ??= [
+            ['values', new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Convert\ListConverter(new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Convert\IntConverter)))],
+        ];
+    }
+
+    public static function document(): string
+    {
+        return /* @lang GraphQL */ 'mutation TakeList($values: [Int]) {
+          __typename
+          takeList(values: $values)
+        }';
+    }
+
+    public static function endpoint(): string
+    {
+        return 'input';
+    }
+
+    public static function config(): string
+    {
+        return \Safe\realpath(__DIR__ . '/../../sailor.php');
+    }
+}
diff --git a/examples/input/expected/Operations/TakeList/TakeList.php b/examples/input/expected/Operations/TakeList/TakeList.php
@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spawnia\Sailor\Input\Operations\TakeList;
+
+/**
+ * @property string $__typename
+ * @property array<int, int|null>|null $takeList
+ */
+class TakeList extends \Spawnia\Sailor\ObjectLike
+{
+    /**
+     * @param array<int, int|null>|null $takeList
+     */
+    public static function make($takeList = 'Special default value that allows Sailor to differentiate between explicitly passing null and not passing a value at all.'): self
+    {
+        $instance = new self;
+
+        $instance->__typename = 'Mutation';
+        if ($takeList !== self::UNDEFINED) {
+            $instance->takeList = $takeList;
+        }
+
+        return $instance;
+    }
+
+    protected function converters(): array
+    {
+        static $converters;
+
+        return $converters ??= [
+            '__typename' => new \Spawnia\Sailor\Convert\NonNullConverter(new \Spawnia\Sailor\Convert\StringConverter),
+            'takeList' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Convert\ListConverter(new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Convert\IntConverter))),
+        ];
+    }
+
+    public static function endpoint(): string
+    {
+        return 'input';
+    }
+
+    public static function config(): string
+    {
+        return \Safe\realpath(__DIR__ . '/../../../sailor.php');
+    }
+}
diff --git a/examples/input/expected/Operations/TakeList/TakeListErrorFreeResult.php b/examples/input/expected/Operations/TakeList/TakeListErrorFreeResult.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spawnia\Sailor\Input\Operations\TakeList;
+
+class TakeListErrorFreeResult extends \Spawnia\Sailor\ErrorFreeResult
+{
+    public TakeList $data;
+
+    public static function endpoint(): string
+    {
+        return 'input';
+    }
+
+    public static function config(): string
+    {
+        return \Safe\realpath(__DIR__ . '/../../../sailor.php');
+    }
+}
diff --git a/examples/input/expected/Operations/TakeList/TakeListResult.php b/examples/input/expected/Operations/TakeList/TakeListResult.php
@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spawnia\Sailor\Input\Operations\TakeList;
+
+class TakeListResult extends \Spawnia\Sailor\Result
+{
+    public ?TakeList $data = null;
+
+    protected function setData(\stdClass $data): void
+    {
+        $this->data = TakeList::fromStdClass($data);
+    }
+
+    /**
+     * Useful for instantiation of successful mocked results.
+     *
+     * @return static
+     */
+    public static function fromData(TakeList $data): self
+    {
+        $instance = new static;
+        $instance->data = $data;
+
+        return $instance;
+    }
+
+    public function errorFree(): TakeListErrorFreeResult
+    {
+        return TakeListErrorFreeResult::fromResult($this);
+    }
+
+    public static function endpoint(): string
+    {
+        return 'input';
+    }
+
+    public static function config(): string
+    {
+        return \Safe\realpath(__DIR__ . '/../../../sailor.php');
+    }
+}
diff --git a/examples/input/expected/Types/SomeInput.php b/examples/input/expected/Types/SomeInput.php
@@ -6,15 +6,15 @@
 
 /**
  * @property string $required
- * @property array<int, array<int, int|null>> $matrix
+ * @property array<array<int|null>> $matrix
  * @property string|null $optional
  * @property \Spawnia\Sailor\Input\Types\SomeInput|null $nested
  */
 class SomeInput extends \Spawnia\Sailor\ObjectLike
 {
     /**
      * @param string $required
-     * @param array<int, array<int, int|null>> $matrix
+     * @param array<array<int|null>> $matrix
      * @param string|null $optional
      * @param \Spawnia\Sailor\Input\Types\SomeInput|null $nested
      */
diff --git a/examples/input/schema.graphql b/examples/input/schema.graphql
@@ -1,4 +1,5 @@
 type Mutation {
+    takeList(values: [Int]): [Int]
     takeSomeInput(input: SomeInput): Int
 }
 
diff --git a/examples/input/src/takeList.graphql b/examples/input/src/takeList.graphql
@@ -0,0 +1,3 @@
+mutation TakeList($values: [Int]) {
+    takeList(values: $values)
+}
diff --git a/examples/input/src/takeSomeInput.graphql b/examples/input/src/takeSomeInput.graphql
diff --git a/src/Codegen/ObjectLikeBuilder.php b/src/Codegen/ObjectLikeBuilder.php
@@ -11,10 +11,12 @@
 use Spawnia\Sailor\ObjectLike;
 
 /**
- * @phpstan-type PropertyArgs array{string, Type, string, string, string, mixed}
+ * @phpstan-type PropertyArgs array{string, Type, string, string, mixed}
  */
 class ObjectLikeBuilder
 {
+    private bool $isInputType;
+
     private ClassType $class;
 
     private Method $make;
@@ -31,7 +33,7 @@ class ObjectLikeBuilder
      */
     private array $optionalProperties = [];
 
-    public function __construct(string $name, string $namespace)
+    public function __construct(string $name, string $namespace, bool $isInputType)
     {
         $class = new ClassType(
             $name,
@@ -59,12 +61,13 @@ public function __construct(string $name, string $namespace)
         $this->converters = $converters;
 
         $this->class = $class;
+        $this->isInputType = $isInputType;
     }
 
     /**
      * @param mixed $defaultValue any value
      */
-    public function addProperty(string $name, Type $type, string $phpDocType, string $phpType, string $typeConverter, $defaultValue): void
+    public function addProperty(string $name, Type $type, string $phpDocType, string $typeConverter, $defaultValue): void
     {
         // Fields may be referenced multiple times in a query through fragments, but they
         // are only included once in the result sent from the server, thus we eliminate duplicates here.
@@ -74,7 +77,7 @@ public function addProperty(string $name, Type $type, string $phpDocType, string
             }
         }
 
-        $args = [$name, $type, $phpDocType, $phpType, $typeConverter, $defaultValue];
+        $args = [$name, $type, $phpDocType, $typeConverter, $defaultValue];
 
         if ($type instanceof NonNull && null === $defaultValue) {
             $this->requiredProperties[] = $args;
@@ -102,9 +105,9 @@ public function build(): ClassType
     /**
      * @param mixed $defaultValue any value
      */
-    protected function buildProperty(string $name, Type $type, string $phpDocType, string $phpType, string $typeConverter, $defaultValue): void
+    protected function buildProperty(string $name, Type $type, string $phpDocType, string $typeConverter, $defaultValue): void
     {
-        $wrappedPhpDocType = TypeWrapper::phpDoc($type, $phpDocType);
+        $wrappedPhpDocType = TypeWrapper::phpDoc($type, $phpDocType, $this->isInputType);
 
         $this->class->addComment("@property {$wrappedPhpDocType} \${$name}");
 
diff --git a/src/Codegen/OperationBuilder.php b/src/Codegen/OperationBuilder.php
@@ -116,7 +116,7 @@ public function build(): ClassType
      */
     protected function buildVariable(string $name, Type $type, string $typeReference, string $typeConverter, $defaultValue): void
     {
-        $wrappedPhpDocType = TypeWrapper::phpDoc($type, $typeReference);
+        $wrappedPhpDocType = TypeWrapper::phpDoc($type, $typeReference, true);
 
         $wrappedTypeConverter = TypeWrapper::converter($type, "new \\{$typeConverter}");
 
diff --git a/src/Codegen/OperationGenerator.php b/src/Codegen/OperationGenerator.php
@@ -304,7 +304,6 @@ public function generate(): iterable
                                         $fieldName,
                                         $type,
                                         $phpDocType,
-                                        $phpType,
                                         $typeConverter,
                                         $defaultValue,
                                     );
@@ -345,6 +344,7 @@ protected function makeObjectLikeBuilder(string $name): ObjectLikeBuilder
         return new ObjectLikeBuilder(
             $name,
             $this->currentNamespace(),
+            false,
         );
     }
 
diff --git a/src/Codegen/TypeWrapper.php b/src/Codegen/TypeWrapper.php
@@ -11,22 +11,28 @@
 
 class TypeWrapper
 {
-    public static function phpDoc(Type $type, string $typeReference, bool $shouldWrapWithNull = true): string
-    {
+    public static function phpDoc(
+        Type $type,
+        string $typeReference,
+        bool $isInputType,
+        bool $shouldWrapWithNull = true
+    ): string {
         if ($type instanceof NonNull) {
-            return self::phpDoc($type->getWrappedType(), $typeReference, false);
+            return self::phpDoc($type->getWrappedType(), $typeReference, $isInputType, false);
         }
 
         if ($shouldWrapWithNull) {
-            $nullable = self::phpDoc($type, $typeReference, false);
+            $nullable = self::phpDoc($type, $typeReference, $isInputType, false);
 
             return "{$nullable}|null";
         }
 
         if ($type instanceof ListOfType) {
-            $inArray = self::phpDoc($type->getWrappedType(), $typeReference);
+            // Allow any array as inputs, no matter the key
+            $keyType = $isInputType ? '' : 'int, ';
+            $inArray = self::phpDoc($type->getWrappedType(), $typeReference, $isInputType);
 
-            return "array<int, {$inArray}>";
+            return "array<{$keyType}{$inArray}>";
         }
 
         return $typeReference;
diff --git a/src/Convert/ListConverter.php b/src/Convert/ListConverter.php
@@ -33,6 +33,9 @@ public function toGraphQL($value): array
             throw new \InvalidArgumentException('Expected array, got ' . gettype($value));
         }
 
-        return array_map([$this->ofType, 'toGraphQL'], $value);
+        $graphQLValues = array_map([$this->ofType, 'toGraphQL'], $value);
+
+        // Accept any incoming array as if it were a proper list
+        return array_values($graphQLValues);
     }
 }
diff --git a/src/Type/InputTypeConfig.php b/src/Type/InputTypeConfig.php
@@ -56,6 +56,7 @@ public function generateClasses(): iterable
         $builder = new ObjectLikeBuilder(
             Escaper::escapeClassName($this->inputObjectType->name),
             $this->endpointConfig->typesNamespace(),
+            true,
         );
 
         foreach ($this->inputObjectType->getFields() as $name => $field) {
@@ -70,7 +71,6 @@ public function generateClasses(): iterable
                 $name,
                 $field->getType(),
                 $typeReference,
-                $typeReference,
                 $typeConfig->typeConverter(),
                 $field->defaultValue,
             );
diff --git a/tests/Integration/InputTest.php b/tests/Integration/InputTest.php
diff --git a/tests/Unit/Codegen/PhpTypeTest.php b/tests/Unit/Codegen/PhpTypeTest.php

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`type Mutation {`
	`2`	`+ takeList(values: [Int]): [Int]`
`2`	`3`	`takeSomeInput(input: SomeInput): Int`
`3`	`4`	`}`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+mutation TakeList($values: [Int]) {`
	`2`	`+ takeList(values: $values)`
	`3`	`+}`