Merge pull request #79 from php-api-clients/introduce-fibers

Introduce fibers with proper type hints

Author: WyriHaximus

composer.json

@@ -32,7 +32,8 @@
         "react/http": "^1.8",
         "reactivex/rxphp": "^2.0",
         "api-clients/contracts": "dev-main",
-        "eventsauce/object-hydrator": "^1.1"
+        "eventsauce/object-hydrator": "^1.1",
+        "react/async": "^4.0"
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -115,6 +115,7 @@ public static function generate(string $namespace, array $clients, SchemaRegistr
             )
         );
 
+        $rawCallReturnTypes = [];
         $operationCalls = [];
         $callReturnTypes = [];
 
@@ -129,10 +130,10 @@ public static function generate(string $namespace, array $clients, SchemaRegistr
                         $fallbackName = 'Operation\\' . $operationGroup . '\\Response\\' . (new Convert(str_replace('/', '\\', $contentType) . '\\H' . $code ))->toPascal();
                         $object = '\\' . $namespace . 'Schema\\' . $schemaRegistry->get($contentTypeSchema->schema, $fallbackName);
                         $callReturnTypes[] = ($contentTypeSchema->schema->type === 'array' ? '\\' . Observable::class . '<' : '') . $object . ($contentTypeSchema->schema->type === 'array' ? '>' : '');
-                        $contentTypeCases[] = $returnType[] = $contentTypeSchema->schema->type === 'array' ? '\\' . Observable::class : $object;
+                        $rawCallReturnTypes[] = $contentTypeCases[] = $returnType[] = $contentTypeSchema->schema->type === 'array' ? '\\' . Observable::class : $object;
                     }
                     if (count($contentTypeCases) === 0) {
-                        $returnType[] = $callReturnTypes[] = 'int';
+                        $rawCallReturnTypes[] = $returnType[] = $callReturnTypes[] = 'int';
                     }
                 }
                 $operationCalls[] = [
@@ -175,7 +176,7 @@ public static function generate(string $namespace, array $clients, SchemaRegistr
         }
 
         $class->addStmt(
-            $factory->method('call')->makePublic()->setReturnType(
+            $factory->method('callAsync')->makePublic()->setReturnType(
                 new Node\Name('\\' . PromiseInterface::class)
             )->setDocComment(
                 new Doc(implode(PHP_EOL, [
@@ -340,6 +341,46 @@ public static function generate(string $namespace, array $clients, SchemaRegistr
             ))
         );
 
+        $class->addStmt(
+            $factory->method('call')->makePublic()->setDocComment(
+                new Doc(implode(PHP_EOL, [
+                    '/**',
+                    ' * @return ' . (function (array $operationCalls): string {
+                        $count = count($operationCalls);
+                        $lastItem = $count - 1;
+                        $left = '';
+                        $right = '';
+                        for ($i = 0; $i < $count; $i++) {
+                            if ($i !== $lastItem) {
+                                $left .= '($call is ' . $operationCalls[$i]['className'] . '::OPERATION_MATCH ? ' . implode('|', array_unique($operationCalls[$i]['returnType'])) . ' : ';
+                            } else {
+                                $left .= implode('|', array_unique($operationCalls[$i]['returnType']));
+                            }
+                            $right .= ')';
+                        }
+                        return $left . $right;
+                    })($operationCalls),
+                    ' */',
+                ]))
+            )->setReturnType(implode('|', array_unique($rawCallReturnTypes)))->addParam((new Param('call'))->setType('string'))->addParam((new Param('params'))->setType('array')->setDefault([]))->addStmt(new Node\Stmt\Return_(
+                new Node\Expr\FuncCall(
+                    new Node\Name('\React\Async\await'),
+                    [
+                        new Node\Arg(
+                            new Node\Expr\MethodCall(
+                                new Node\Expr\Variable('this'),
+                                new Node\Name('callAsync'),
+                                [
+                                    new Node\Arg(new Node\Expr\Variable('call')),
+                                    new Node\Arg(new Node\Expr\Variable('params')),
+                                ]
+                            )
+                        ),
+                    ],
+                )
+            ))
+        );
+
         yield new File($namespace . '\\' . 'Client', $stmt->addStmt($class)->getNode());
     }
 }

src/Generator/Client.php

@@ -35,6 +35,7 @@ public static function generate(string $namespace, array $clients, SchemaRegistr
         $stmt = $factory->namespace(rtrim($namespace, '\\'));
 
         $class = $factory->interface('ClientInterface');
+        $rawCallReturnTypes = [];
         $operationCalls = [];
         $callReturnTypes = [];
 
@@ -49,10 +50,10 @@ public static function generate(string $namespace, array $clients, SchemaRegistr
                         $fallbackName = 'Operation\\' . $operationGroup . '\\Response\\' . (new Convert(str_replace('/', '\\', $contentType) . '\\H' . $code ))->toPascal();
                         $object = '\\' . $namespace . 'Schema\\' . $schemaRegistry->get($contentTypeSchema->schema, $fallbackName);
                         $callReturnTypes[] = ($contentTypeSchema->schema->type === 'array' ? '\\' . Observable::class . '<' : '') . $object . ($contentTypeSchema->schema->type === 'array' ? '>' : '');
-                        $contentTypeCases[] = $returnType[] = $contentTypeSchema->schema->type === 'array' ? '\\' . Observable::class : $object;
+                        $rawCallReturnTypes[] = $contentTypeCases[] = $returnType[] = $contentTypeSchema->schema->type === 'array' ? '\\' . Observable::class : $object;
                     }
                     if (count($contentTypeCases) === 0) {
-                        $returnType[] = $callReturnTypes[] = 'int';
+                        $rawCallReturnTypes[] = $returnType[] = $callReturnTypes[] = 'int';
                     }
                 }
                 $operationCalls[] = [
@@ -74,6 +75,32 @@ public static function generate(string $namespace, array $clients, SchemaRegistr
 
         $class->addStmt(
             $factory->method('call')->makePublic()->setReturnType(
+                new Node\Name(implode('|', array_unique($rawCallReturnTypes)))
+            )->setDocComment(
+                new Doc(implode(PHP_EOL, [
+                    '/**',
+                    ' * @return ' . (function (array $operationCalls): string {
+                        $count = count($operationCalls);
+                        $lastItem = $count - 1;
+                        $left = '';
+                        $right = '';
+                        for ($i = 0; $i < $count; $i++) {
+                            if ($i !== $lastItem) {
+                                $left .= '($call is ' . $operationCalls[$i]['className'] . '::OPERATION_MATCH ? ' . implode('|', array_unique($operationCalls[$i]['returnType'])) . ' : ';
+                            } else {
+                                $left .= implode('|', array_unique($operationCalls[$i]['returnType']));
+                            }
+                            $right .= ')';
+                        }
+                        return $left . $right;
+                    })($operationCalls),
+                    ' */',
+                ]))
+            )->addParam((new Param('call'))->setType('string'))->addParam((new Param('params'))->setType('array')->setDefault([]))
+        );
+
+        $class->addStmt(
+            $factory->method('callAsync')->makePublic()->setReturnType(
                 new Node\Name('\\' . PromiseInterface::class)
             )->setDocComment(
                 new Doc(implode(PHP_EOL, [