Merge pull request #430 from clue-labs/no-content-length

Improve assigning `Content-Length` for `304 Not Modified` response
reactphp · Nov 7, 2021 · e19e987 · e19e987
2 parents 3e2caeb + 5f795a0
commit e19e987
Show file tree

Hide file tree

Showing 2 changed files with 74 additions and 6 deletions.
diff --git a/src/Io/StreamingServer.php b/src/Io/StreamingServer.php
@@ -260,23 +260,27 @@ public function handleResponse(ConnectionInterface $connection, ServerRequestInt
             $response = $response->withoutHeader('Date');
         }
 
-        // assign "Content-Length" and "Transfer-Encoding" headers automatically
+        // assign "Content-Length" header automatically
         $chunked = false;
         if (($method === 'CONNECT' && $code >= 200 && $code < 300) || ($code >= 100 && $code < 200) || $code === 204) {
             // 2xx response to CONNECT and 1xx and 204 MUST NOT include Content-Length or Transfer-Encoding header
-            $response = $response->withoutHeader('Content-Length')->withoutHeader('Transfer-Encoding');
+            $response = $response->withoutHeader('Content-Length');
+        } elseif ($code === 304 && ($response->hasHeader('Content-Length') || $body->getSize() === 0)) {
+            // 304 Not Modified: preserve explicit Content-Length and preserve missing header if body is empty
         } elseif ($body->getSize() !== null) {
             // assign Content-Length header when using a "normal" buffered body string
-            $response = $response->withHeader('Content-Length', (string)$body->getSize())->withoutHeader('Transfer-Encoding');
+            $response = $response->withHeader('Content-Length', (string)$body->getSize());
         } elseif (!$response->hasHeader('Content-Length') && $version === '1.1') {
             // assign chunked transfer-encoding if no 'content-length' is given for HTTP/1.1 responses
-            $response = $response->withHeader('Transfer-Encoding', 'chunked');
             $chunked = true;
+        }
+
+        // assign "Transfer-Encoding" header automatically
+        if ($chunked) {
+            $response = $response->withHeader('Transfer-Encoding', 'chunked');
         } else {
             // remove any Transfer-Encoding headers unless automatically enabled above
-            // we do not want to keep connection alive, so pretend we received "Connection: close" request header
             $response = $response->withoutHeader('Transfer-Encoding');
-            $request = $request->withHeader('Connection', 'close');
         }
 
         // assign "Connection" header automatically

diff --git a/tests/Io/StreamingServerTest.php b/tests/Io/StreamingServerTest.php
@@ -1362,6 +1362,70 @@ function ($data) use (&$buffer) {
         $this->assertNotContainsString("\r\nContent-Length: 3\r\n", $buffer);
     }
 
+    public function testResponseContainsNoContentLengthHeaderForNotModifiedStatus()
+    {
+        $server = new StreamingServer(Factory::create(), function (ServerRequestInterface $request) {
+            return new Response(
+                304,
+                array(),
+                ''
+            );
+        });
+
+        $buffer = '';
+        $this->connection
+            ->expects($this->any())
+            ->method('write')
+            ->will(
+                $this->returnCallback(
+                    function ($data) use (&$buffer) {
+                        $buffer .= $data;
+                    }
+                )
+            );
+
+        $server->listen($this->socket);
+        $this->socket->emit('connection', array($this->connection));
+
+        $data = "GET / HTTP/1.1\r\nHost: localhost\r\n\r\n";
+        $this->connection->emit('data', array($data));
+
+        $this->assertContainsString("HTTP/1.1 304 Not Modified\r\n", $buffer);
+        $this->assertNotContainsString("\r\nContent-Length: 0\r\n", $buffer);
+    }
+
+    public function testResponseContainsExplicitContentLengthHeaderForNotModifiedStatus()
+    {
+        $server = new StreamingServer(Factory::create(), function (ServerRequestInterface $request) {
+            return new Response(
+                304,
+                array('Content-Length' => 3),
+                ''
+            );
+        });
+
+        $buffer = '';
+        $this->connection
+            ->expects($this->any())
+            ->method('write')
+            ->will(
+                $this->returnCallback(
+                    function ($data) use (&$buffer) {
+                        $buffer .= $data;
+                    }
+                )
+            );
+
+        $server->listen($this->socket);
+        $this->socket->emit('connection', array($this->connection));
+
+        $data = "GET / HTTP/1.1\r\nHost: localhost\r\n\r\n";
+        $this->connection->emit('data', array($data));
+
+        $this->assertContainsString("HTTP/1.1 304 Not Modified\r\n", $buffer);
+        $this->assertContainsString("\r\nContent-Length: 3\r\n", $buffer);
+    }
+
     public function testResponseContainsNoResponseBodyForNotModifiedStatus()
     {
         $server = new StreamingServer(Factory::create(), function (ServerRequestInterface $request) {