Introduce using PSR-7 HTTP Status code constants

WyriHaximus · clue · commit fc1cf25b7187 · 2021-11-07T20:01:21.000+01:00
Introducing using these constants makes it easier to identify a
specific HTTP status used in our code. And for our users to use
readable status codes in their own code.
diff --git a/composer.json b/composer.json
@@ -34,7 +34,8 @@
         "react/promise-stream": "^1.1",
         "react/socket": "^1.9",
         "react/stream": "^1.2",
-        "ringcentral/psr7": "^1.2"
+        "ringcentral/psr7": "^1.2",
+        "fig/http-message-util": "^1.1"
     },
     "require-dev": {
         "clue/block-react": "^1.1",
diff --git a/examples/51-server-hello-world.php b/examples/51-server-hello-world.php
@@ -1,13 +1,14 @@
 <?php
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use React\Http\Message\Response;
 
 require __DIR__ . '/../vendor/autoload.php';
 
 $http = new React\Http\HttpServer(function (ServerRequestInterface $request) {
     return new Response(
-        200,
+        StatusCodeInterface::STATUS_OK,
         array(
             'Content-Type' => 'text/plain'
         ),
diff --git a/examples/52-server-count-visitors.php b/examples/52-server-count-visitors.php
@@ -1,5 +1,6 @@
 <?php
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use React\Http\Message\Response;
 
@@ -8,7 +9,7 @@
 $counter = 0;
 $http = new React\Http\HttpServer(function (ServerRequestInterface $request) use (&$counter) {
     return new Response(
-        200,
+        StatusCodeInterface::STATUS_OK,
         array(
             'Content-Type' => 'text/plain'
         ),
diff --git a/examples/53-server-whatsmyip.php b/examples/53-server-whatsmyip.php
@@ -1,5 +1,6 @@
 <?php
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use React\Http\Message\Response;
 
@@ -9,7 +10,7 @@
     $body = "Your IP is: " . $request->getServerParams()['REMOTE_ADDR'];
 
     return new Response(
-        200,
+        StatusCodeInterface::STATUS_OK,
         array(
             'Content-Type' => 'text/plain'
         ),
diff --git a/examples/54-server-query-parameter.php b/examples/54-server-query-parameter.php
@@ -1,5 +1,6 @@
 <?php
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use React\Http\Message\Response;
 
@@ -16,7 +17,7 @@
     }
 
     return new Response(
-        200,
+        StatusCodeInterface::STATUS_OK,
         array(
             'Content-Type' => 'text/html'
         ),
diff --git a/examples/55-server-cookie-handling.php b/examples/55-server-cookie-handling.php
@@ -1,5 +1,6 @@
 <?php
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use React\Http\Message\Response;
 
@@ -12,7 +13,7 @@
         $body = "Your cookie value is: " . $request->getCookieParams()[$key];
 
         return new Response(
-            200,
+            StatusCodeInterface::STATUS_OK,
             array(
                 'Content-Type' => 'text/plain'
             ),
@@ -21,7 +22,7 @@
     }
 
     return new Response(
-        200,
+        StatusCodeInterface::STATUS_OK,
         array(
             'Content-Type' => 'text/plain',
             'Set-Cookie' => urlencode($key) . '=' . urlencode('test;more')
diff --git a/examples/56-server-sleep.php b/examples/56-server-sleep.php
@@ -1,5 +1,6 @@
 <?php
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use React\EventLoop\Loop;
 use React\Http\Message\Response;
@@ -11,7 +12,7 @@
     return new Promise(function ($resolve, $reject) {
         Loop::addTimer(1.5, function() use ($resolve) {
             $response = new Response(
-                200,
+                StatusCodeInterface::STATUS_OK,
                 array(
                     'Content-Type' => 'text/plain'
                 ),
diff --git a/examples/57-server-error-handling.php b/examples/57-server-error-handling.php
@@ -1,5 +1,6 @@
 <?php
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use React\Http\Message\Response;
 use React\Promise\Promise;
@@ -16,7 +17,7 @@
         }
 
         $response = new Response(
-            200,
+            StatusCodeInterface::STATUS_OK,
             array(
                 'Content-Type' => 'text/plain'
             ),
diff --git a/examples/58-server-stream-response.php b/examples/58-server-stream-response.php
@@ -1,5 +1,6 @@
 <?php
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use React\EventLoop\Loop;
 use React\Http\Message\Response;
@@ -9,7 +10,7 @@
 
 $http = new React\Http\HttpServer(function (ServerRequestInterface $request) {
     if ($request->getMethod() !== 'GET' || $request->getUri()->getPath() !== '/') {
-        return new Response(404);
+        return new Response(StatusCodeInterface::STATUS_NOT_FOUND);
     }
 
     $stream = new ThroughStream();
@@ -30,7 +31,7 @@
     });
 
     return new Response(
-        200,
+        StatusCodeInterface::STATUS_OK,
         array(
             'Content-Type' => 'text/plain'
         ),
diff --git a/examples/59-server-json-api.php b/examples/59-server-json-api.php
@@ -6,6 +6,7 @@
 // $ php examples/59-server-json-api.php 8080
 // $ curl -v http://localhost:8080/ -H 'Content-Type: application/json' -d '{"name":"Alice"}'
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use React\Http\Message\Response;
 
@@ -14,7 +15,7 @@
 $http = new React\Http\HttpServer(function (ServerRequestInterface $request) {
     if ($request->getHeaderLine('Content-Type') !== 'application/json') {
         return new Response(
-            415, // Unsupported Media Type
+            StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE,
             array(
                 'Content-Type' => 'application/json'
             ),
@@ -25,7 +26,7 @@
     $input = json_decode($request->getBody()->getContents());
     if (json_last_error() !== JSON_ERROR_NONE) {
         return new Response(
-            400, // Bad Request
+            StatusCodeInterface::STATUS_BAD_REQUEST,
             array(
                 'Content-Type' => 'application/json'
             ),
@@ -35,7 +36,7 @@
 
     if (!isset($input->name) || !is_string($input->name)) {
         return new Response(
-            422, // Unprocessable Entity
+            StatusCodeInterface::STATUS_UNPROCESSABLE_ENTITY,
             array(
                 'Content-Type' => 'application/json'
             ),
@@ -44,7 +45,7 @@
     }
 
     return new Response(
-        200,
+        StatusCodeInterface::STATUS_OK,
         array(
             'Content-Type' => 'application/json'
         ),
diff --git a/examples/61-server-hello-world-https.php b/examples/61-server-hello-world-https.php
@@ -1,13 +1,14 @@
 <?php
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use React\Http\Message\Response;
 
 require __DIR__ . '/../vendor/autoload.php';
 
 $http = new React\Http\HttpServer(function (ServerRequestInterface $request) {
     return new Response(
-        200,
+        StatusCodeInterface::STATUS_OK,
         array(
             'Content-Type' => 'text/plain'
         ),
diff --git a/examples/62-server-form-upload.php b/examples/62-server-form-upload.php
@@ -7,6 +7,7 @@
 // $ curl --form name=test --form age=30 http://localhost:8080/
 // $ curl --form name=hi --form avatar=@avatar.png http://localhost:8080/
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Message\UploadedFileInterface;
 use React\Http\Message\Response;
@@ -110,7 +111,7 @@
 HTML;
 
     return new Response(
-        200,
+        StatusCodeInterface::STATUS_OK,
         array(
             'Content-Type' => 'text/html; charset=UTF-8'
         ),
diff --git a/examples/63-server-streaming-request.php b/examples/63-server-streaming-request.php
@@ -1,5 +1,7 @@
 <?php
 
+use Fig\Http\Message\StatusCodeInterface;
+
 require __DIR__ . '/../vendor/autoload.php';
 
 // Note how this example uses the advanced `StreamingRequestMiddleware` to allow streaming
@@ -20,7 +22,7 @@ function (Psr\Http\Message\ServerRequestInterface $request) {
 
             $body->on('end', function () use ($resolve, &$bytes){
                 $resolve(new React\Http\Message\Response(
-                    200,
+                    StatusCodeInterface::STATUS_OK,
                     array(
                         'Content-Type' => 'text/plain'
                     ),
@@ -31,7 +33,7 @@ function (Psr\Http\Message\ServerRequestInterface $request) {
             // an error occures e.g. on invalid chunked encoded data or an unexpected 'end' event
             $body->on('error', function (Exception $e) use ($resolve, &$bytes) {
                 $resolve(new React\Http\Message\Response(
-                    400,
+                    StatusCodeInterface::STATUS_BAD_REQUEST,
                     array(
                         'Content-Type' => 'text/plain'
                     ),
diff --git a/examples/71-server-http-proxy.php b/examples/71-server-http-proxy.php
@@ -3,6 +3,7 @@
 // $ php examples/71-server-http-proxy.php 8080
 // $ curl -v --proxy http://localhost:8080 http://reactphp.org/
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\RequestInterface;
 use React\Http\Message\Response;
 use RingCentral\Psr7;
@@ -16,7 +17,7 @@
 $http = new React\Http\HttpServer(function (RequestInterface $request) {
     if (strpos($request->getRequestTarget(), '://') === false) {
         return new Response(
-            400,
+            StatusCodeInterface::STATUS_BAD_REQUEST,
             array(
                 'Content-Type' => 'text/plain'
             ),
@@ -36,7 +37,7 @@
     // left up as an exercise: use an HTTP client to send the outgoing request
     // and forward the incoming response to the original client request
     return new Response(
-        200,
+        StatusCodeInterface::STATUS_OK,
         array(
             'Content-Type' => 'text/plain'
         ),
diff --git a/examples/72-server-http-connect-proxy.php b/examples/72-server-http-connect-proxy.php
@@ -3,6 +3,7 @@
 // $ php examples/72-server-http-connect-proxy.php 8080
 // $ curl -v --proxy http://localhost:8080 https://reactphp.org/
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use React\Http\Message\Response;
 use React\Socket\Connector;
@@ -19,7 +20,7 @@
 $http = new React\Http\HttpServer(function (ServerRequestInterface $request) use ($connector) {
     if ($request->getMethod() !== 'CONNECT') {
         return new Response(
-            405,
+            StatusCodeInterface::STATUS_METHOD_NOT_ALLOWED,
             array(
                 'Content-Type' => 'text/plain',
                 'Allow' => 'CONNECT'
@@ -33,14 +34,14 @@
         function (ConnectionInterface $remote) {
             // connection established => forward data
             return new Response(
-                200,
+                StatusCodeInterface::STATUS_OK,
                 array(),
                 $remote
             );
         },
         function (Exception $e) {
             return new Response(
-                502,
+                StatusCodeInterface::STATUS_BAD_GATEWAY,
                 array(
                     'Content-Type' => 'text/plain'
                 ),
diff --git a/examples/81-server-upgrade-echo.php b/examples/81-server-upgrade-echo.php
@@ -17,6 +17,7 @@
 < world
 */
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use React\EventLoop\Loop;
 use React\Http\Message\Response;
@@ -30,7 +31,7 @@
 $http = new React\Http\HttpServer(function (ServerRequestInterface $request) {
     if ($request->getHeaderLine('Upgrade') !== 'echo' || $request->getProtocolVersion() === '1.0') {
         return new Response(
-            426,
+            StatusCodeInterface::STATUS_UPGRADE_REQUIRED,
             array(
                 'Upgrade' => 'echo'
             ),
@@ -48,7 +49,7 @@
     });
 
     return new Response(
-        101,
+        StatusCodeInterface::STATUS_SWITCHING_PROTOCOLS,
         array(
             'Upgrade' => 'echo'
         ),
diff --git a/examples/82-server-upgrade-chat.php b/examples/82-server-upgrade-chat.php
@@ -19,6 +19,7 @@
 Hint: try this with multiple connections :)
 */
 
+use Fig\Http\Message\StatusCodeInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use React\EventLoop\Loop;
 use React\Http\Message\Response;
@@ -38,7 +39,7 @@
 $http = new React\Http\HttpServer(function (ServerRequestInterface $request) use ($chat) {
     if ($request->getHeaderLine('Upgrade') !== 'chat' || $request->getProtocolVersion() === '1.0') {
         return new Response(
-            426,
+            StatusCodeInterface::STATUS_UPGRADE_REQUIRED,
             array(
                 'Upgrade' => 'chat'
             ),
@@ -76,7 +77,7 @@
     });
 
     return new Response(
-        101,
+        StatusCodeInterface::STATUS_SWITCHING_PROTOCOLS,
         array(
             'Upgrade' => 'chat'
         ),
diff --git a/examples/99-server-benchmark-download.php b/examples/99-server-benchmark-download.php
diff --git a/src/Io/RequestHeaderParser.php b/src/Io/RequestHeaderParser.php
diff --git a/src/Io/Sender.php b/src/Io/Sender.php
diff --git a/src/Io/StreamingServer.php b/src/Io/StreamingServer.php
diff --git a/src/Message/Response.php b/src/Message/Response.php
