Improve http worker types

Author: SerafimArts

src/HttpWorker.php

@@ -1,20 +1,45 @@
 <?php
 
 /**
- * High-performance PHP process supervisor and load balancer written in Go. Http core.
+ * This file is part of RoadRunner package.
  *
- * @author Alex Bond
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
  */
 
 declare(strict_types=1);
 
 namespace Spiral\RoadRunner\Http;
 
+use Spiral\RoadRunner\Payload;
 use Spiral\RoadRunner\WorkerInterface;
 
+/**
+ * @psalm-import-type HeadersList from Request
+ * @psalm-import-type AttributesList from Request
+ * @psalm-import-type UploadedFilesList from Request
+ * @psalm-import-type CookiesList from Request
+ *
+ * @psalm-type RequestContext = array {
+ *      remoteAddr?:    string,
+ *      protocol?:      string,
+ *      method?:        string,
+ *      uri?:           string,
+ *      attributes?:    AttributesList,
+ *      headers?:       HeadersList,
+ *      cookies?:       CookiesList,
+ *      uploads?:       UploadedFilesList|null,
+ *      rawQuery?:      string,
+ *      parsed?:        string|null
+ * }
+ *
+ * @see Request
+ */
 class HttpWorker implements HttpWorkerInterface
 {
-    /** @var WorkerInterface */
+    /**
+     * @var WorkerInterface
+     */
     private WorkerInterface $worker;
 
     /**
@@ -34,73 +59,81 @@ public function getWorker(): WorkerInterface
     }
 
     /**
-     * Wait for incoming http request.
-     *
-     * @return Request|null
+     * {@inheritDoc}
+     * @throws \JsonException
      */
     public function waitRequest(): ?Request
     {
-        $payload = $this->getWorker()->waitPayload();
-        if (empty($payload->body) && empty($payload->header)) {
-            // termination request
+        $payload = $this->worker->waitPayload();
+
+        // Termination request
+        if ($payload === null || (!$payload->body && !$payload->header)) {
             return null;
         }
 
-        $request = new Request();
-        $request->body = $payload->body;
+        /** @var RequestContext $context */
+        $context = \json_decode($payload->header, true, 512, \JSON_THROW_ON_ERROR);
 
-        $context = json_decode($payload->header, true);
-        if ($context === null) {
-            // invalid context
-            return null;
-        }
+        return $this->createRequest($payload->body, $context);
+    }
 
-        $this->hydrateRequest($request, $context);
+    /**
+     * {@inheritDoc}
+     * @throws \JsonException
+     */
+    public function respond(int $status, string $body, array $headers = []): void
+    {
+        $headers = (string)\json_encode([
+            'status'  => $status,
+            'headers' => $headers ?: (object)[],
+        ], \JSON_THROW_ON_ERROR);
 
-        return $request;
+        $this->worker->respond(new Payload($body, $headers));
     }
 
     /**
-     * Send response to the application server.
+     * @param string $body
+     * @param RequestContext $context
+     * @return Request
      *
-     * @param int        $status  Http status code
-     * @param string     $body    Body of response
-     * @param string[][] $headers An associative array of the message's headers. Each
-     *                            key MUST be a header name, and each value MUST be an array of strings
-     *                            for that header.
+     * @psalm-suppress InaccessibleProperty
      */
-    public function respond(int $status, string $body, array $headers = []): void
+    private function createRequest(string $body, array $context): Request
     {
-        if ($headers === []) {
-            // this is required to represent empty header set as map and not as array
-            $headers = new \stdClass();
-        }
+        $request = new Request();
+        $request->body = $body;
 
-        $this->getWorker()->send(
-            $body,
-            (string) json_encode(['status' => $status, 'headers' => $headers])
-        );
+        $this->hydrateRequest($request, $context);
+
+        return $request;
     }
 
     /**
      * @param Request $request
-     * @param array   $context
+     * @param RequestContext $context
+     *
+     * @psalm-suppress InaccessibleProperty
+     * @psalm-suppress PossiblyUndefinedArrayOffset
+     * @psalm-suppress MixedPropertyTypeCoercion
      */
     private function hydrateRequest(Request $request, array $context): void
     {
+        assert(\is_string($context['remoteAddr'] ?? null), 'Missing remote address context argument');
+        assert(\is_string($context['protocol'] ?? null), 'Missing protocol context argument');
+        assert(\is_string($context['method'] ?? null), 'Missing method context argument');
+        assert(\is_string($context['uri'] ?? null), 'Missing uri context argument');
+        assert(\is_string($context['rawQuery'] ?? null), 'Missing rawQuery context argument');
+
         $request->remoteAddr = $context['remoteAddr'];
         $request->protocol = $context['protocol'];
         $request->method = $context['method'];
         $request->uri = $context['uri'];
-        $request->attributes = $context['attributes'] ?? [];
-        $request->headers = $context['headers'];
-        $request->cookies = $context['cookies'] ?? [];
-        $request->uploads = $context['uploads'] ?? [];
-
-        $request->query = [];
-        parse_str($context['rawQuery'], $request->query);
+        \parse_str($context['rawQuery'], $request->query);
 
-        // indicates that body was parsed
-        $request->parsed = $context['parsed'];
+        $request->attributes = (array)($context['attributes'] ?? []);
+        $request->headers = (array)($context['headers'] ?? []);
+        $request->cookies = (array)($context['cookies'] ?? []);
+        $request->uploads = (array)($context['uploads'] ?? []);
+        $request->parsed = (bool)$context['parsed'];
     }
 }