Added HostReaderInterface for rpc-multiplex. (#6504)

Author: limingxinleo

src/ConfigProvider.php

@@ -11,7 +11,9 @@
  */
 namespace Hyperf\RpcMultiplex;
 
+use Hyperf\RpcMultiplex\Contract\HostReaderInterface;
 use Hyperf\RpcMultiplex\Contract\HttpMessageBuilderInterface;
+use Hyperf\RpcMultiplex\HttpMessage\HostReader\NullHostReader;
 use Hyperf\RpcMultiplex\Listener\RegisterProtocolListener;
 use Multiplex\Contract\IdGeneratorInterface;
 use Multiplex\Contract\PackerInterface;
@@ -30,6 +32,7 @@ public function __invoke(): array
                 SerializerInterface::class => StringSerializer::class,
                 PackerInterface::class => Packer::class,
                 HttpMessageBuilderInterface::class => HttpMessageBuilder::class,
+                HostReaderInterface::class => NullHostReader::class,
             ],
             'listeners' => [
                 RegisterProtocolListener::class,

src/Constant.php

@@ -29,6 +29,8 @@ class Constant
 
     public const CONTEXT = 'context';
 
+    public const EXTRA = 'extra';
+
     public const ERROR = 'error';
 
     public const CODE = 'code';

src/Contract/HostReaderInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  group@hyperf.io
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace Hyperf\RpcMultiplex\Contract;
+
+use Hyperf\Contract\IPReaderInterface;
+
+interface HostReaderInterface extends IPReaderInterface
+{
+}

src/Contract/HttpMessageBuilderInterface.php

@@ -17,7 +17,7 @@
 
 interface HttpMessageBuilderInterface
 {
-    public function buildRequest(array $data): ServerRequestPlusInterface;
+    public function buildRequest(array $data, array $config = []): ServerRequestPlusInterface;
 
     public function buildResponse(ServerRequestInterface $request, array $data): ResponsePlusInterface;
 

src/DataFormatter.php

@@ -36,6 +36,7 @@ public function formatRequest(Request $request): array
             Constant::ID => $request->getId(),
             Constant::PATH => $request->getPath(),
             Constant::DATA => $request->getParams(),
+            Constant::EXTRA => $request->getExtra(),
             Constant::CONTEXT => $this->context->getData(),
         ];
     }

src/HttpMessage/HostReader/NullHostReader.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  group@hyperf.io
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace Hyperf\RpcMultiplex\HttpMessage\HostReader;
+
+use Hyperf\RpcMultiplex\Contract\HostReaderInterface;
+
+class NullHostReader implements HostReaderInterface
+{
+    public function read(): string
+    {
+        return 'unknown';
+    }
+}

src/HttpMessageBuilder.php

@@ -19,6 +19,7 @@
 use Hyperf\HttpMessage\Stream\SwooleStream;
 use Hyperf\HttpMessage\Uri\Uri;
 use Hyperf\Rpc\Context as RpcContext;
+use Hyperf\RpcMultiplex\Contract\HostReaderInterface;
 use Hyperf\RpcMultiplex\Contract\HttpMessageBuilderInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Message\UriInterface;
@@ -27,23 +28,24 @@
 
 class HttpMessageBuilder implements HttpMessageBuilderInterface
 {
-    public function __construct(protected PackerInterface $packer, protected RpcContext $context)
+    public function __construct(protected PackerInterface $packer, protected RpcContext $context, protected HostReaderInterface $hostReader)
     {
     }
 
-    public function buildRequest(array $data): ServerRequestPlusInterface
+    public function buildRequest(array $data, array $config = []): ServerRequestPlusInterface
     {
+        $extra = $data[Constant::EXTRA] ?? [];
         $uri = $this->buildUri(
             $data[Constant::PATH] ?? '/',
-            $data[Constant::HOST] ?? 'unknown',
-            $data[Constant::PORT] ?? 80
+            $data[Constant::HOST] ?? $this->hostReader->read(),
+            $data[Constant::PORT] ?? $config['port'] ?? 80
         );
 
         $parsedData = $data[Constant::DATA] ?? [];
 
         $this->context->setData($data[Constant::CONTEXT] ?? []);
 
-        $request = new Request('POST', $uri, ['Content-Type' => 'application/json'], new SwooleStream(Json::encode($parsedData)));
+        $request = new Request('POST', $uri, ['Content-Type' => 'application/json', ...$extra], new SwooleStream(Json::encode($parsedData)));
 
         return $request->setParsedBody($parsedData);
     }

src/TcpServer.php

@@ -119,7 +119,7 @@ protected function buildRequest(int $fd, int $reactorId, string $data): ServerRe
     {
         $parsed = $this->packer->unpack($data);
 
-        $request = $this->messageBuilder->buildRequest($parsed);
+        $request = $this->messageBuilder->buildRequest($parsed, $this->serverConfig);
 
         return $request->withAttribute('fd', $fd)->withAttribute('request_id', $parsed['id'] ?? null);
     }

tests/Cases/HttpMessageBuilderTest.php

@@ -12,11 +12,14 @@
 namespace HyperfTest\RpcMultiplex\Cases;
 
 use Hyperf\Rpc\Context;
+use Hyperf\RpcMultiplex\Contract\HostReaderInterface;
+use Hyperf\RpcMultiplex\HttpMessage\HostReader\NullHostReader;
 use Hyperf\RpcMultiplex\HttpMessageBuilder;
 use Hyperf\RpcMultiplex\Packer\JsonPacker;
 use Hyperf\Support\Reflection\ClassInvoker;
 use PHPUnit\Framework\Attributes\CoversNothing;
 use Psr\Http\Message\UriInterface;
+use Swow\Psr7\Message\ServerRequestPlusInterface;
 
 /**
  * @internal
@@ -27,7 +30,7 @@ class HttpMessageBuilderTest extends AbstractTestCase
 {
     public function testBuildUri()
     {
-        $invoker = new ClassInvoker(new HttpMessageBuilder(new JsonPacker(), new Context()));
+        $invoker = new ClassInvoker(new HttpMessageBuilder(new JsonPacker(), new Context(), new NullHostReader()));
         /** @var UriInterface $uri */
         $uri = $invoker->buildUri('/', $host = uniqid(), 8806);
         $this->assertSame('http', $uri->getScheme());
@@ -36,9 +39,29 @@ public function testBuildUri()
         $this->assertSame(8806, $uri->getPort());
     }
 
+    public function testBuildRequestWithHostReader()
+    {
+        $invoker = new ClassInvoker(new HttpMessageBuilder(new JsonPacker(), new Context(), new class() implements HostReaderInterface {
+            public function read(): string
+            {
+                return 'test_case';
+            }
+        }));
+        /** @var ServerRequestPlusInterface $request */
+        $request = $invoker->buildRequest(['path' => '/hi', 'extra' => ['from' => 'test']], ['port' => 9502]);
+        $uri = $request->getUri();
+
+        $this->assertSame('http', $uri->getScheme());
+        $this->assertSame('/hi', $uri->getPath());
+        $this->assertSame('test_case', $uri->getHost());
+        $this->assertSame(9502, $uri->getPort());
+
+        $this->assertSame('test', $request->getHeaderLine('from'));
+    }
+
     public function testStoreContext()
     {
-        $builder = new HttpMessageBuilder(new JsonPacker(), $context = new Context());
+        $builder = new HttpMessageBuilder(new JsonPacker(), $context = new Context(), new NullHostReader());
 
         $request = $builder->buildRequest([
             'path' => '/',