Refactor GlobalState and PSR7Worker to cache and enrich $_SERVER variables

Author: roxblnfk

composer.json

@@ -50,6 +50,7 @@
         "jetbrains/phpstorm-attributes": "^1.0",
         "nyholm/psr7": "^1.3",
         "phpunit/phpunit": "^10.0",
+        "spiral/dumper": "^3.3",
         "symfony/process": "^6.2 || ^7.0",
         "vimeo/psalm": "^5.9"
     },

src/GlobalState.php

@@ -13,40 +13,48 @@
 final class GlobalState
 {
     /**
-     * Sets ip-address, request-time and other values.
-     *
-     * @return  non-empty-array<array-key|string, mixed|string>
+     * @var array<array-key, mixed> Cached state of the $_SERVER superglobal.
      */
-    public static function populateServer(Request $request): array
-    {
-        /** @var non-empty-array<array-key|string, mixed|string>|null $originalServer */
-        static $originalServer = null;
+    private static array $cachedServer = [];
 
-        if ($originalServer == null) {
-            $originalServer = $_SERVER;
-        }
+    /**
+     * Cache superglobal $_SERVER to avoid state leaks between requests.
+     */
+    public static function cacheServerVars(): void
+    {
+        self::$cachedServer = $_SERVER;
+    }
 
-        $newServer = $originalServer;
+    /**
+     * Enrich cached $_SERVER with data from the request.
+     *
+     * @return non-empty-array<array-key, mixed> Cached $_SERVER data enriched with request data.
+     */
+    public static function enrichServerVars(Request $request): array
+    {
+        $server = self::$cachedServer;
 
-        $newServer['REQUEST_URI'] = $request->uri;
-        $newServer['REQUEST_TIME'] = time();
-        $newServer['REQUEST_TIME_FLOAT'] = microtime(true);
-        $newServer['REMOTE_ADDR'] = $request->getRemoteAddr();
-        $newServer['REQUEST_METHOD'] = $request->method;
-        $newServer['HTTP_USER_AGENT'] = '';
+        $server['REQUEST_URI'] = $request->uri;
+        $server['REQUEST_TIME'] = time();
+        $server['REQUEST_TIME_FLOAT'] = microtime(true);
+        $server['REMOTE_ADDR'] = $request->getRemoteAddr();
+        $server['REQUEST_METHOD'] = $request->method;
+        $server['HTTP_USER_AGENT'] = '';
 
         foreach ($request->headers as $key => $value) {
             $key = strtoupper(str_replace('-', '_', $key));
 
             if ($key == 'CONTENT_TYPE' || $key == 'CONTENT_LENGTH') {
-                $newServer[$key] = implode(', ', $value);
+                $server[$key] = implode(', ', $value);
 
                 continue;
             }
 
-            $newServer['HTTP_' . $key] = implode(', ', $value);
+            $server['HTTP_' . $key] = implode(', ', $value);
         }
 
-        return $newServer;
+        return $server;
     }
 }
+
+GlobalState::cacheServerVars();

src/PSR7Worker.php

@@ -60,18 +60,24 @@ public function getHttpWorker(): HttpWorker
     /**
      * @psalm-suppress DeprecatedMethod
      *
+     * @param bool $populateServer Whether to populate $_SERVER superglobal.
+     *
      * @throws \JsonException
      */
-    public function waitRequest(): ?ServerRequestInterface
+    public function waitRequest(bool $populateServer = true): ?ServerRequestInterface
     {
         $httpRequest = $this->httpWorker->waitRequest();
         if ($httpRequest === null) {
             return null;
         }
 
-        $_SERVER = $this->configureServer($httpRequest);
+        $vars = $this->configureServer($httpRequest);
+
+        if ($populateServer) {
+            $_SERVER = $vars;
+        }
 
-        return $this->mapRequest($httpRequest, $_SERVER);
+        return $this->mapRequest($httpRequest, $vars);
     }
 
     /**
@@ -92,7 +98,7 @@ public function respond(ResponseInterface $response): void
 
     /**
      * @return Generator<mixed, scalar|Stringable, mixed, Stringable|scalar|null> Compatible
-     *         with {@see \Spiral\RoadRunner\Http\HttpWorker::respondStream()}.
+     *         with {@see HttpWorker::respondStream}.
      */
     private function streamToGenerator(StreamInterface $stream): Generator
     {
@@ -121,16 +127,13 @@ private function streamToGenerator(StreamInterface $stream): Generator
      * Returns altered copy of _SERVER variable. Sets ip-address,
      * request-time and other values.
      *
-     * @deprecated
-     *
      * @return non-empty-array<array-key|string, mixed|string>
      */
     protected function configureServer(Request $request): array
     {
-        return GlobalState::populateServer($request);
+        return GlobalState::enrichServerVars($request);
     }
 
-
     /**
      * @deprecated
      */
@@ -139,7 +142,6 @@ protected function timeInt(): int
         return \time();
     }
 
-
     /**
      * @deprecated
      */