Explicitly send Connection: close header for HTTP/1.1 messages

Persistent connections (`Connection: keep-alive`) are currently not supported, so make sure we let the client know.
reactphp · Feb 19, 2017 · c72c125 · c72c125
1 parent 531c466
commit c72c125
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -279,6 +279,12 @@ $response->writeHead(200, array(
 ));
 ```
 
+Note that persistent connections (`Connection: keep-alive`) are currently
+not supported.
+As such, HTTP/1.1 response messages will automatically include a
+`Connection: close` header, irrespective of what header values are
+passed explicitly.
+
 ## Install
 
 The recommended way to install this library is [through Composer](http://getcomposer.org).

diff --git a/src/Response.php b/src/Response.php
@@ -172,6 +172,12 @@ public function writeContinue()
      * ));
      * ```
      *
+     * Note that persistent connections (`Connection: keep-alive`) are currently
+     * not supported.
+     * As such, HTTP/1.1 response messages will automatically include a
+     * `Connection: close` header, irrespective of what header values are
+     * passed explicitly.
+     *
      * @param int   $status
      * @param array $headers
      * @throws \Exception
@@ -204,6 +210,18 @@ public function writeHead($status = 200, array $headers = array())
             $this->chunkedEncoding = true;
         }
 
+        // HTTP/1.1 assumes persistent connection support by default
+        // we do not support persistent connections, so let the client know
+        if ($this->protocolVersion === '1.1') {
+            foreach($headers as $name => $value) {
+                if (strtolower($name) === 'connection') {
+                    unset($headers[$name]);
+                }
+            }
+
+            $headers['Connection'] = 'close';
+        }
+
         $data = $this->formatHead($status, $headers);
         $this->conn->write($data);
 

diff --git a/tests/ResponseTest.php b/tests/ResponseTest.php
@@ -12,6 +12,7 @@ public function testResponseShouldBeChunkedByDefault()
         $expected .= "HTTP/1.1 200 OK\r\n";
         $expected .= "X-Powered-By: React/alpha\r\n";
         $expected .= "Transfer-Encoding: chunked\r\n";
+        $expected .= "Connection: close\r\n";
         $expected .= "\r\n";
 
         $conn = $this
@@ -51,6 +52,7 @@ public function testResponseShouldBeChunkedEvenWithOtherTransferEncoding()
         $expected .= "HTTP/1.1 200 OK\r\n";
         $expected .= "X-Powered-By: React/alpha\r\n";
         $expected .= "Transfer-Encoding: chunked\r\n";
+        $expected .= "Connection: close\r\n";
         $expected .= "\r\n";
 
         $conn = $this
@@ -71,6 +73,7 @@ public function testResponseShouldNotBeChunkedWithContentLength()
         $expected .= "HTTP/1.1 200 OK\r\n";
         $expected .= "X-Powered-By: React/alpha\r\n";
         $expected .= "Content-Length: 22\r\n";
+        $expected .= "Connection: close\r\n";
         $expected .= "\r\n";
 
         $conn = $this
@@ -91,6 +94,7 @@ public function testResponseShouldNotBeChunkedWithContentLengthCaseInsensitive()
         $expected .= "HTTP/1.1 200 OK\r\n";
         $expected .= "X-Powered-By: React/alpha\r\n";
         $expected .= "CONTENT-LENGTH: 0\r\n";
+        $expected .= "Connection: close\r\n";
         $expected .= "\r\n";
 
         $conn = $this
@@ -111,6 +115,7 @@ public function testResponseShouldIncludeCustomByPoweredAsFirstHeaderIfGivenExpl
         $expected .= "HTTP/1.1 200 OK\r\n";
         $expected .= "Content-Length: 0\r\n";
         $expected .= "X-POWERED-BY: demo\r\n";
+        $expected .= "Connection: close\r\n";
         $expected .= "\r\n";
 
         $conn = $this
@@ -130,6 +135,7 @@ public function testResponseShouldNotIncludePoweredByIfGivenEmptyArray()
         $expected = '';
         $expected .= "HTTP/1.1 200 OK\r\n";
         $expected .= "Content-Length: 0\r\n";
+        $expected .= "Connection: close\r\n";
         $expected .= "\r\n";
 
         $conn = $this
@@ -144,6 +150,27 @@ public function testResponseShouldNotIncludePoweredByIfGivenEmptyArray()
         $response->writeHead(200, array('Content-Length' => 0, 'X-Powered-By' => array()));
     }
 
+    public function testResponseShouldAlwaysIncludeConnectionCloseIrrespectiveOfExplicitValue()
+    {
+        $expected = '';
+        $expected .= "HTTP/1.1 200 OK\r\n";
+        $expected .= "X-Powered-By: React/alpha\r\n";
+        $expected .= "Content-Length: 0\r\n";
+        $expected .= "Connection: close\r\n";
+        $expected .= "\r\n";
+
+        $conn = $this
+            ->getMockBuilder('React\Socket\ConnectionInterface')
+            ->getMock();
+        $conn
+            ->expects($this->once())
+            ->method('write')
+            ->with($expected);
+
+        $response = new Response($conn);
+        $response->writeHead(200, array('Content-Length' => 0, 'connection' => 'ignored'));
+    }
+
     public function testResponseBodyShouldBeChunkedCorrectly()
     {
         $conn = $this
@@ -283,6 +310,7 @@ public function shouldRemoveNewlinesFromHeaders()
         $expected .= "X-Powered-By: React/alpha\r\n";
         $expected .= "FooBar: BazQux\r\n";
         $expected .= "Transfer-Encoding: chunked\r\n";
+        $expected .= "Connection: close\r\n";
         $expected .= "\r\n";
 
         $conn = $this
@@ -304,6 +332,7 @@ public function missingStatusCodeTextShouldResultInNumberOnlyStatus()
         $expected .= "HTTP/1.1 700 \r\n";
         $expected .= "X-Powered-By: React/alpha\r\n";
         $expected .= "Transfer-Encoding: chunked\r\n";
+        $expected .= "Connection: close\r\n";
         $expected .= "\r\n";
 
         $conn = $this
@@ -327,6 +356,7 @@ public function shouldAllowArrayHeaderValues()
         $expected .= "Set-Cookie: foo=bar\r\n";
         $expected .= "Set-Cookie: bar=baz\r\n";
         $expected .= "Transfer-Encoding: chunked\r\n";
+        $expected .= "Connection: close\r\n";
         $expected .= "\r\n";
 
         $conn = $this
@@ -348,6 +378,7 @@ public function shouldIgnoreHeadersWithNullValues()
         $expected .= "HTTP/1.1 200 OK\r\n";
         $expected .= "X-Powered-By: React/alpha\r\n";
         $expected .= "Transfer-Encoding: chunked\r\n";
+        $expected .= "Connection: close\r\n";
         $expected .= "\r\n";
 
         $conn = $this