Merge pull request #374 from clue-labs/expose-reactphp

Expose ReactPHP in `User-Agent` and `Server` header

Author: clue

README.md

@@ -1626,65 +1626,70 @@ create your own HTTP response message instead.
 When a response is returned from the request handler function, it will be
 processed by the [`Server`](#server) and then sent back to the client.
 
-The `Server` will automatically add the protocol version of the request, so you
-don't have to.
-
-A `Date` header will be automatically added with the system date and time if none is given.
-You can add a custom `Date` header yourself like this:
+A `Server: ReactPHP/1` response header will be added automatically. You can add
+a custom `Server` response header like this:
 
 ```php
-$server = new Server($loop, function (ServerRequestInterface $request) {
-    return new Response(
+$server = new React\Http\Server($loop, function (ServerRequestInterface $request) {
+    return new React\Http\Message\Response(
         200,
         array(
-            'Date' => date('D, d M Y H:i:s T')
+            'Server' => 'PHP/3'
         )
     );
 });
 ```
 
-If you don't have a appropriate clock to rely on, you should
-unset this header with an empty string:
+If you do not want to send this `Sever` response header at all (such as when you
+don't want to expose the underlying server software), you can use an empty
+string value like this:
 
 ```php
-$server = new Server($loop, function (ServerRequestInterface $request) {
-    return new Response(
+$server = new React\Http\Server($loop, function (ServerRequestInterface $request) {
+    return new React\Http\Message\Response(
         200,
         array(
-            'Date' => ''
+            'Server' => ''
         )
     );
 });
 ```
 
-Note that it will automatically assume a `X-Powered-By: react/alpha` header
-unless your specify a custom `X-Powered-By` header yourself:
+A `Date` response header will be added automatically with the current system
+date and time if none is given. You can add a custom `Date` response header
+like this:
 
 ```php
-$server = new Server($loop, function (ServerRequestInterface $request) {
-    return new Response(
+$server = new React\Http\Server($loop, function (ServerRequestInterface $request) {
+    return new React\Http\Message\Response(
         200,
         array(
-            'X-Powered-By' => 'PHP 3'
+            'Date' => gmdate('D, d M Y H:i:s \G\M\T')
         )
     );
 });
 ```
 
-If you do not want to send this header at all, you can use an empty string as
-value like this:
+If you do not want to send this `Date` response header at all (such as when you
+don't have an appropriate clock to rely on), you can use an empty string value
+like this:
 
 ```php
-$server = new Server($loop, function (ServerRequestInterface $request) {
-    return new Response(
+$server = new React\Http\Server($loop, function (ServerRequestInterface $request) {
+    return new React\Http\Message\Response(
         200,
         array(
-            'X-Powered-By' => ''
+            'Date' => ''
         )
     );
 });
 ```
 
+The `Server` class will automatically add the protocol version of the request,
+so you don't have to. For instance, if the client sends the request using the
+HTTP/1.1 protocol version, the response message will also use the same protocol
+version, no matter what version is returned from the request handler function.
+
 Note that persistent connections (`Connection: keep-alive`) are currently
 not supported.
 As such, HTTP/1.1 response messages will automatically include a

src/Client/RequestData.php

@@ -29,7 +29,7 @@ private function mergeDefaultheaders(array $headers)
         $defaults = array_merge(
             array(
                 'Host'          => $this->getHost().$port,
-                'User-Agent'    => 'React/alpha',
+                'User-Agent'    => 'ReactPHP/1',
             ),
             $connectionHeaders,
             $authHeaders

src/Io/StreamingServer.php

@@ -244,11 +244,11 @@ public function handleResponse(ConnectionInterface $connection, ServerRequestInt
         $version = $request->getProtocolVersion();
         $response = $response->withProtocolVersion($version);
 
-        // assign default "X-Powered-By" header automatically
-        if (!$response->hasHeader('X-Powered-By')) {
-            $response = $response->withHeader('X-Powered-By', 'React/alpha');
-        } elseif ($response->getHeaderLine('X-Powered-By') === ''){
-            $response = $response->withoutHeader('X-Powered-By');
+        // assign default "Server" header automatically
+        if (!$response->hasHeader('Server')) {
+            $response = $response->withHeader('Server', 'ReactPHP/1');
+        } elseif ($response->getHeaderLine('Server') === ''){
+            $response = $response->withoutHeader('Server');
         }
 
         // assign default "Date" header from current time automatically

tests/Client/RequestDataTest.php

@@ -14,7 +14,7 @@ public function toStringReturnsHTTPRequestMessage()
 
         $expected = "GET / HTTP/1.0\r\n" .
             "Host: www.example.com\r\n" .
-            "User-Agent: React/alpha\r\n" .
+            "User-Agent: ReactPHP/1\r\n" .
             "\r\n";
 
         $this->assertSame($expected, $requestData->__toString());
@@ -27,7 +27,7 @@ public function toStringReturnsHTTPRequestMessageWithEmptyQueryString()
 
         $expected = "GET /path?hello=world HTTP/1.0\r\n" .
             "Host: www.example.com\r\n" .
-            "User-Agent: React/alpha\r\n" .
+            "User-Agent: ReactPHP/1\r\n" .
             "\r\n";
 
         $this->assertSame($expected, $requestData->__toString());
@@ -40,7 +40,7 @@ public function toStringReturnsHTTPRequestMessageWithZeroQueryStringAndRootPath(
 
         $expected = "GET /?0 HTTP/1.0\r\n" .
             "Host: www.example.com\r\n" .
-            "User-Agent: React/alpha\r\n" .
+            "User-Agent: ReactPHP/1\r\n" .
             "\r\n";
 
         $this->assertSame($expected, $requestData->__toString());
@@ -53,7 +53,7 @@ public function toStringReturnsHTTPRequestMessageWithOptionsAbsoluteRequestForm(
 
         $expected = "OPTIONS / HTTP/1.0\r\n" .
             "Host: www.example.com\r\n" .
-            "User-Agent: React/alpha\r\n" .
+            "User-Agent: ReactPHP/1\r\n" .
             "\r\n";
 
         $this->assertSame($expected, $requestData->__toString());
@@ -66,7 +66,7 @@ public function toStringReturnsHTTPRequestMessageWithOptionsAsteriskRequestForm(
 
         $expected = "OPTIONS * HTTP/1.0\r\n" .
             "Host: www.example.com\r\n" .
-            "User-Agent: React/alpha\r\n" .
+            "User-Agent: ReactPHP/1\r\n" .
             "\r\n";
 
         $this->assertSame($expected, $requestData->__toString());
@@ -80,7 +80,7 @@ public function toStringReturnsHTTPRequestMessageWithProtocolVersion()
 
         $expected = "GET / HTTP/1.1\r\n" .
             "Host: www.example.com\r\n" .
-            "User-Agent: React/alpha\r\n" .
+            "User-Agent: ReactPHP/1\r\n" .
             "Connection: close\r\n" .
             "\r\n";
 
@@ -131,7 +131,7 @@ public function toStringReturnsHTTPRequestMessageWithProtocolVersionThroughConst
 
         $expected = "GET / HTTP/1.1\r\n" .
             "Host: www.example.com\r\n" .
-            "User-Agent: React/alpha\r\n" .
+            "User-Agent: ReactPHP/1\r\n" .
             "Connection: close\r\n" .
             "\r\n";
 
@@ -145,7 +145,7 @@ public function toStringUsesUserPassFromURL()
 
         $expected = "GET / HTTP/1.0\r\n" .
             "Host: www.example.com\r\n" .
-            "User-Agent: React/alpha\r\n" .
+            "User-Agent: ReactPHP/1\r\n" .
             "Authorization: Basic am9objpkdW1teQ==\r\n" .
             "\r\n";
 

tests/Io/StreamingServerTest.php

@@ -650,7 +650,7 @@ public function testRequestEventWithPartialBodyWillEmitData()
         $this->connection->emit('data', array($data));
     }
 
-    public function testResponseContainsPoweredByHeader()
+    public function testResponseContainsServerHeader()
     {
         $server = new StreamingServer(Factory::create(), function (ServerRequestInterface $request) {
             return new Response();
@@ -675,7 +675,7 @@ function ($data) use (&$buffer) {
         $data = $this->createGetRequest();
         $this->connection->emit('data', array($data));
 
-        $this->assertContainsString("\r\nX-Powered-By: React/alpha\r\n", $buffer);
+        $this->assertContainsString("\r\nServer: ReactPHP/1\r\n", $buffer);
     }
 
     public function testResponsePendingPromiseWillNotSendAnything()
@@ -931,7 +931,7 @@ public function testResponseUpgradeInResponseCanBeUsedToAdvertisePossibleUpgrade
                 200,
                 array(
                     'date' => '',
-                    'x-powered-by' => '',
+                    'server' => '',
                     'Upgrade' => 'demo'
                 ),
                 'foo'
@@ -967,7 +967,7 @@ public function testResponseUpgradeWishInRequestCanBeIgnoredByReturningNormalRes
                 200,
                 array(
                     'date' => '',
-                    'x-powered-by' => ''
+                    'server' => ''
                 ),
                 'foo'
             );
@@ -1002,7 +1002,7 @@ public function testResponseUpgradeSwitchingProtocolIncludesConnectionUpgradeHea
                 101,
                 array(
                     'date' => '',
-                    'x-powered-by' => '',
+                    'server' => '',
                     'Upgrade' => 'demo'
                 ),
                 'foo'
@@ -1042,7 +1042,7 @@ public function testResponseUpgradeSwitchingProtocolWithStreamWillPipeDataToConn
                 101,
                 array(
                     'date' => '',
-                    'x-powered-by' => '',
+                    'server' => '',
                     'Upgrade' => 'demo'
                 ),
                 $stream
@@ -2171,7 +2171,7 @@ public function testResponseCanContainMultipleCookieHeaders()
                         'session=abc'
                     ),
                     'Date' => '',
-                    'X-Powered-By' => ''
+                    'Server' => ''
                 )
             );
         });