Added Swow support for hyperf/websocket-server. (#4873)

Author: limingxinleo

src/Sender.php

@@ -19,6 +19,7 @@
 use Psr\Log\LoggerInterface;
 use Swoole\Http\Response;
 use Swoole\Server;
+use Swow\Http\Server\Connection;
 
 /**
  * @method push(int $fd, $data, int $opcode = null, $finish = null)
@@ -31,7 +32,7 @@ class Sender
     protected ?int $workerId = null;
 
     /**
-     * @var Response[]
+     * @var Connection[]|Response[]
      */
     protected array $responses = [];
 
@@ -95,7 +96,10 @@ public function check($fd): bool
         return false;
     }
 
-    public function setResponse(int $fd, ?Response $response): void
+    /**
+     * @param null|Connection|Response $response
+     */
+    public function setResponse(int $fd, mixed $response): void
     {
         if ($response === null) {
             unset($this->responses[$fd]);
@@ -104,7 +108,7 @@ public function setResponse(int $fd, ?Response $response): void
         }
     }
 
-    public function getResponse(int $fd): ?Response
+    public function getResponse(int $fd): mixed
     {
         return $this->responses[$fd] ?? null;
     }

src/Server.php

@@ -24,6 +24,7 @@
 use Hyperf\Dispatcher\HttpDispatcher;
 use Hyperf\Engine\Constant;
 use Hyperf\Engine\Http\FdGetter;
+use Hyperf\Engine\Http\Server as HttpServer;
 use Hyperf\Engine\WebSocket\WebSocket;
 use Hyperf\ExceptionHandler\ExceptionHandlerDispatcher;
 use Hyperf\HttpMessage\Base\Response;
@@ -44,9 +45,11 @@
 use Psr\Container\ContainerInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
+use Swoole\Coroutine\Http\Server as SwCoServer;
 use Swoole\Http\Response as SwooleResponse;
 use Swoole\Server as SwooleServer;
 use Swoole\WebSocket\Server as WebSocketServer;
+use Swow\Http\Server\Connection;
 use Throwable;
 
 class Server implements MiddlewareInitializerInterface, OnHandShakeInterface, OnCloseInterface, OnMessageInterface
@@ -60,7 +63,7 @@ class Server implements MiddlewareInitializerInterface, OnHandShakeInterface, On
     protected string $serverName = 'websocket';
 
     /**
-     * @var null|\Swoole\Coroutine\Http\Server|WebSocketServer
+     * @var null|HttpServer|SwCoServer|WebSocketServer
      */
     protected mixed $server = null;
 
@@ -80,7 +83,7 @@ public function initCoreMiddleware(string $serverName): void
         ]);
     }
 
-    public function getServer(): \Swoole\Coroutine\Http\Server|WebSocketServer
+    public function getServer(): SwCoServer|WebSocketServer|HttpServer
     {
         if ($this->server) {
             return $this->server;
@@ -105,7 +108,7 @@ public function getSender(): Sender
 
     /**
      * @param \Swoole\Http\Request|\Swow\Http\Server\Request $request
-     * @param SwooleResponse $response
+     * @param Connection|SwooleResponse $response
      */
     public function onHandShake($request, $response): void
     {
@@ -149,8 +152,7 @@ public function onHandShake($request, $response): void
             if (Constant::isCoroutineServer($server)) {
                 $upgrade = new WebSocket($response, $request);
 
-                // TODO: Support SWOW
-                $response instanceof SwooleResponse && $this->getSender()->setResponse($fd, $response);
+                $this->getSender()->setResponse($fd, $response);
                 $this->deferOnOpen($request, $class, $response, $fd);
 
                 $upgrade->on(WebSocket::ON_MESSAGE, $this->getOnMessageCallback());
@@ -240,7 +242,7 @@ protected function getFd($response): int
     /**
      * @param mixed $request
      */
-    protected function deferOnOpen($request, string $class, SwooleResponse|WebSocketServer $server, int $fd)
+    protected function deferOnOpen($request, string $class, SwooleResponse|WebSocketServer|Connection $server, int $fd)
     {
         $instance = $this->container->get($class);
         if ($server instanceof WebSocketServer) {

tests/ServerTest.php

@@ -20,6 +20,7 @@
 use Hyperf\Utils\Reflection\ClassInvoker;
 use Hyperf\Utils\Waiter;
 use Hyperf\WebSocketServer\Server;
+use HyperfTest\WebSocketServer\Stub\FooServer;
 use HyperfTest\WebSocketServer\Stub\WebSocketStub;
 use Mockery;
 use PHPUnit\Framework\TestCase;
@@ -58,4 +59,10 @@ public function testDeferOnOpenInCoroutineStyleServer()
         $this->assertNotEquals(Coroutine::id(), WebSocketStub::$coroutineId);
         $this->assertFalse(\Swoole\Coroutine::exists(WebSocketStub::$coroutineId));
     }
+
+    public function testEngineServer()
+    {
+        $serv = new FooServer();
+        $this->assertSame(1, $serv->getServer());
+    }
 }

tests/Stub/FooServer.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace HyperfTest\WebSocketServer\Stub;
+
+use Hyperf\Engine\Http\Server as HttpServer;
+
+class FooServer
+{
+    public function getServer(): HttpServer|int
+    {
+        return 1;
+    }
+}