Optimized code for testing which mock request in an alone coroutine. (#3338)

Author: limingxinleo

src/Client.php

@@ -13,7 +13,6 @@
 
 use Hyperf\Contract\PackerInterface;
 use Hyperf\Dispatcher\HttpDispatcher;
-use Hyperf\Engine\Coroutine;
 use Hyperf\ExceptionHandler\ExceptionHandlerDispatcher;
 use Hyperf\HttpMessage\Server\Request as Psr7Request;
 use Hyperf\HttpMessage\Server\Response as Psr7Response;
@@ -28,25 +27,21 @@
 use Hyperf\Utils\Context;
 use Hyperf\Utils\Filesystem\Filesystem;
 use Hyperf\Utils\Packer\JsonPacker;
-use Hyperf\Utils\Str;
 use Psr\Container\ContainerInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 
 class Client extends Server
 {
     /**
-     * @var array
+     * @var PackerInterface
      */
-    public $ignoreContextPrefix = [
-        'database.connection',
-        'redis.connection',
-    ];
+    protected $packer;
 
     /**
-     * @var PackerInterface
+     * @var float
      */
-    protected $packer;
+    protected $waitTimeout = 10.0;
 
     public function __construct(ContainerInterface $container, PackerInterface $packer = null, $server = 'http')
     {
@@ -134,34 +129,34 @@ public function file($uri, $data = [], $headers = [])
 
     public function request(string $method, string $path, array $options = [])
     {
-        /*
-         * @var Psr7Request
-         */
-        [$psr7Request, $psr7Response] = $this->init($method, $path, $options);
-
-        $psr7Request = $this->coreMiddleware->dispatch($psr7Request);
-        /** @var Dispatched $dispatched */
-        $dispatched = $psr7Request->getAttribute(Dispatched::class);
-        $middlewares = $this->middlewares;
-        if ($dispatched->isFound()) {
-            $registeredMiddlewares = MiddlewareManager::get($this->serverName, $dispatched->handler->route, $psr7Request->getMethod());
-            $middlewares = array_merge($middlewares, $registeredMiddlewares);
-        }
+        return wait(function () use ($method, $path, $options) {
+            /*
+             * @var Psr7Request
+             */
+            [$psr7Request, $psr7Response] = $this->init($method, $path, $options);
+
+            $psr7Request = $this->coreMiddleware->dispatch($psr7Request);
+            /** @var Dispatched $dispatched */
+            $dispatched = $psr7Request->getAttribute(Dispatched::class);
+            $middlewares = $this->middlewares;
+            if ($dispatched->isFound()) {
+                $registeredMiddlewares = MiddlewareManager::get($this->serverName, $dispatched->handler->route, $psr7Request->getMethod());
+                $middlewares = array_merge($middlewares, $registeredMiddlewares);
+            }
 
-        try {
-            $psr7Response = $this->dispatcher->dispatch($psr7Request, $middlewares, $this->coreMiddleware);
-        } catch (\Throwable $throwable) {
-            // Delegate the exception to exception handler.
-            $psr7Response = $this->exceptionHandlerDispatcher->dispatch($throwable, $this->exceptionHandlers);
-        }
+            try {
+                $psr7Response = $this->dispatcher->dispatch($psr7Request, $middlewares, $this->coreMiddleware);
+            } catch (\Throwable $throwable) {
+                // Delegate the exception to exception handler.
+                $psr7Response = $this->exceptionHandlerDispatcher->dispatch($throwable, $this->exceptionHandlers);
+            }
 
-        return $psr7Response;
+            return $psr7Response;
+        }, $this->waitTimeout);
     }
 
     protected function init(string $method, string $path, array $options = []): array
     {
-        $this->flushContext();
-
         $query = $options['query'] ?? [];
         $params = $options['form_params'] ?? [];
         $json = $options['json'] ?? [];
@@ -192,18 +187,6 @@ protected function init(string $method, string $path, array $options = []): arra
         return [$psr7Request, $psr7Response];
     }
 
-    protected function flushContext()
-    {
-        $context = Coroutine::getContextFor() ?? [];
-
-        foreach ($context as $key => $value) {
-            if (Str::startsWith($key, $this->ignoreContextPrefix)) {
-                continue;
-            }
-            $context[$key] = null;
-        }
-    }
-
     protected function normalizeFiles(array $multipart): array
     {
         $files = [];

tests/ClientTest.php

@@ -26,8 +26,10 @@
 use Hyperf\HttpServer\Router\Router;
 use Hyperf\Testing\Client;
 use Hyperf\Utils\ApplicationContext;
+use Hyperf\Utils\Coroutine;
 use Hyperf\Utils\Filesystem\Filesystem;
 use Hyperf\Utils\Serializer\SimpleNormalizer;
+use Hyperf\Utils\Waiter;
 use HyperfTest\Testing\Stub\Exception\Handler\FooExceptionHandler;
 use HyperfTest\Testing\Stub\FooController;
 use Mockery;
@@ -51,6 +53,19 @@ public function testClientRequest()
         $this->assertSame('Hello Hyperf!', $data['data']);
     }
 
+    public function testClientReturnCoroutineId()
+    {
+        $container = $this->getContainer();
+
+        $client = new Client($container);
+
+        $id = Coroutine::id();
+        $data = $client->get('/id');
+
+        $this->assertSame(0, $data['code']);
+        $this->assertNotEquals($id, $data['data']);
+    }
+
     public function testClientException()
     {
         $container = $this->getContainer();
@@ -90,11 +105,13 @@ public function getContainer()
         $container->shouldReceive('make')->with(CoreMiddleware::class, Mockery::any())->andReturnUsing(function ($class, $args) {
             return new CoreMiddleware(...array_values($args));
         });
+        $container->shouldReceive('get')->with(Waiter::class)->andReturn(new Waiter());
         ApplicationContext::setContainer($container);
 
         Router::init($factory);
         Router::get('/', [FooController::class, 'index']);
         Router::get('/exception', [FooController::class, 'exception']);
+        Router::get('/id', [FooController::class, 'id']);
 
         return $container;
     }

tests/Stub/FooController.php

@@ -11,6 +11,8 @@
  */
 namespace HyperfTest\Testing\Stub;
 
+use Hyperf\Utils\Coroutine;
+
 class FooController
 {
     public function index()
@@ -22,4 +24,9 @@ public function exception()
     {
         throw new \RuntimeException('Server Error', 500);
     }
+
+    public function id()
+    {
+        return ['code' => 0, 'data' => Coroutine::id()];
+    }
 }