V0.6 Support for Symfony 7

.github/workflows/ci.yml

@@ -16,19 +16,14 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "5.4"
-          - "5.5"
-          - "5.6"
-          - "7.0"
-          - "7.1"
-          - "7.2"
           - "7.3"
           - "7.4"
+          - "8.0"
         dependencies:
           - "highest"
         include:
           - dependencies: "lowest"
-            php-version: "5.4"
+            php-version: "7.3"
 
     steps:
       - name: "Checkout"

.gitignore

@@ -1,3 +1,4 @@
+.idea
 phpunit.xml
 reports
 sandbox

CHANGELOG.md

@@ -7,6 +7,10 @@ CHANGELOG
 * "BF": Bug fix
 
 ---
+* 0.5.0
+  * PHP 7.2 is minimum supported version
+  * BC: `Ratchet\Session\Storage\Proxy\VirtualSessionStorage` requires `Ratchet\Session\OptionsHandler`
+  * `ComponentInterface::onError()` now accepts `Throwable` instead of `Exception`
 
 * 0.4.4 (2021-12-11)
   * Correct and update dependencies for forward compatibility

README.md

@@ -82,6 +82,7 @@ class MyChat implements MessageComponentInterface {
     conn.onopen = function(e) { conn.send('Hello Me!'); };
 ```
 
-[GA Image]: https://github.com/ratchetphp/Ratchet/workflows/CI/badge.svg
+[GA Image]: https://github.com/ratchetphp/Ratchet/workflows/CI/badge.svg?branch=v0.5
+
+[GA Link]: https://github.com/ratchetphp/Ratchet/actions?query=workflow%3A%22CI%22+branch=v0.5
 
-[GA Link]: https://github.com/ratchetphp/Ratchet/actions?query=workflow%3A%22CI%22+branch%3Amaster

composer.json

@@ -25,16 +25,22 @@
             "Ratchet\\": "src/Ratchet"
         }
     }
+   , "autoload-dev": {
+        "psr-4": {
+            "Ratchet\\Tests\\": "tests/"
+        }
+    }
   , "require": {
-        "php": ">=5.4.2"
-      , "ratchet/rfc6455": "^0.3.1"
-      , "react/socket": "^1.0 || ^0.8 || ^0.7 || ^0.6 || ^0.5"
-      , "react/event-loop": ">=0.4"
-      , "guzzlehttp/psr7": "^1.7|^2.0"
-      , "symfony/http-foundation": "^2.6|^3.0|^4.0|^5.0|^6.0"
-      , "symfony/routing": "^2.6|^3.0|^4.0|^5.0|^6.0"
+        "php": "^7.3 || ^8.0"
+      , "ratchet/rfc6455": "^0.3"
+      , "react/socket": "^1.0 || ^0.8 || ^0.7 || ^0.6 || ^0.5 || ^v1.15"
+      , "react/event-loop": ">=v1.5.0"
+      , "guzzlehttp/psr7": "^1.7|^2.0|^2.6"
+      , "symfony/http-foundation": "^2.6|^3.0|^4.0|^5.0|^6.0|^v7.0"
+      , "symfony/routing": "^2.6|^3.0|^4.0|^5.0|^6.0|^7.0"
     }
   , "require-dev": {
-        "phpunit/phpunit": "~4.8"
+        "phpunit/phpunit": "^8.5|^10.5",
+        "react/stream": "^1.0|^1.3"
     }
 }

phpunit.xml.dist

@@ -1,13 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
     forceCoversAnnotation="true"
-    mapTestClassNameToCoveredClassName="true"
     bootstrap="tests/bootstrap.php"
     colors="true"
-    backupGlobals="false"
-    backupStaticAttributes="false"
-    syntaxCheck="false"
-    stopOnError="false"
 >
 
     <testsuites>
@@ -16,15 +13,9 @@
         </testsuite>
     </testsuites>
 
-    <testsuites>
-        <testsuite name="integration">
-            <directory>./tests/integration/</directory>
-        </testsuite>
-    </testsuites>
-
     <filter>
         <whitelist>
             <directory>./src/</directory>
         </whitelist>
     </filter>
-</phpunit>
+</phpunit>

src/Ratchet/ComponentInterface.php

@@ -1,6 +1,8 @@
 <?php
 namespace Ratchet;
 
+use Throwable;
+
 /**
  * This is the interface to build a Ratchet application with.
  * It implements the decorator pattern to build an application stack
@@ -9,23 +11,23 @@ interface ComponentInterface {
     /**
      * When a new connection is opened it will be passed to this method
      * @param  ConnectionInterface $conn The socket/connection that just connected to your application
-     * @throws \Exception
+     * @throws Throwable
      */
     function onOpen(ConnectionInterface $conn);
 
     /**
      * This is called before or after a socket is closed (depends on how it's closed).  SendMessage to $conn will not result in an error if it has already been closed.
      * @param  ConnectionInterface $conn The socket/connection that is closing/closed
-     * @throws \Exception
+     * @throws Throwable
      */
     function onClose(ConnectionInterface $conn);
 
     /**
-     * If there is an error with one of the sockets, or somewhere in the application where an Exception is thrown,
-     * the Exception is sent back down the stack, handled by the Server and bubbled back up the application through this method
+     * If there is an error with one of the sockets, or somewhere in the application where an Throwable is thrown,
+     * the Throwable is sent back down the stack, handled by the Server and bubbled back up the application through this method
      * @param  ConnectionInterface $conn
-     * @param  \Exception          $e
-     * @throws \Exception
+     * @param  Throwable          $e
+     * @throws Throwable
      */
-    function onError(ConnectionInterface $conn, \Exception $e);
+    function onError(ConnectionInterface $conn, Throwable $e);
 }

src/Ratchet/Http/HttpServer.php

@@ -2,6 +2,7 @@
 namespace Ratchet\Http;
 use Ratchet\MessageComponentInterface;
 use Ratchet\ConnectionInterface;
+use Throwable;
 
 class HttpServer implements MessageComponentInterface {
     use CloseResponseTrait;
@@ -66,7 +67,7 @@ public function onClose(ConnectionInterface $conn) {
     /**
      * {@inheritdoc}
      */
-    public function onError(ConnectionInterface $conn, \Exception $e) {
+    public function onError(ConnectionInterface $conn, Throwable $e) {
         if ($conn->httpHeadersReceived) {
             $this->_httpServer->onError($conn, $e);
         } else {

src/Ratchet/Http/NoOpHttpServerController.php

@@ -2,6 +2,7 @@
 namespace Ratchet\Http;
 use Ratchet\ConnectionInterface;
 use Psr\Http\Message\RequestInterface;
+use Throwable;
 
 class NoOpHttpServerController implements HttpServerInterface {
     public function onOpen(ConnectionInterface $conn, RequestInterface $request = null) {
@@ -13,6 +14,6 @@ public function onMessage(ConnectionInterface $from, $msg) {
     public function onClose(ConnectionInterface $conn) {
     }
 
-    public function onError(ConnectionInterface $conn, \Exception $e) {
+    public function onError(ConnectionInterface $conn, Throwable $e) {
     }
 }

src/Ratchet/Http/OriginCheck.php

@@ -3,6 +3,7 @@
 use Ratchet\ConnectionInterface;
 use Ratchet\MessageComponentInterface;
 use Psr\Http\Message\RequestInterface;
+use Throwable;
 
 /**
  * A middleware to ensure JavaScript clients connecting are from the expected domain.
@@ -59,7 +60,7 @@ function onClose(ConnectionInterface $conn) {
     /**
      * {@inheritdoc}
      */
-    function onError(ConnectionInterface $conn, \Exception $e) {
+    function onError(ConnectionInterface $conn, Throwable $e) {
         return $this->_component->onError($conn, $e);
     }
-}
+}

src/Ratchet/Http/Router.php

@@ -5,7 +5,8 @@
 use Symfony\Component\Routing\Matcher\UrlMatcherInterface;
 use Symfony\Component\Routing\Exception\MethodNotAllowedException;
 use Symfony\Component\Routing\Exception\ResourceNotFoundException;
-use GuzzleHttp\Psr7\Query;
+use GuzzleHttp\Psr7 as gPsr;
+use Throwable;
 
 class Router implements HttpServerInterface {
     use CloseResponseTrait;
@@ -88,7 +89,7 @@ public function onClose(ConnectionInterface $conn) {
     /**
      * {@inheritdoc}
      */
-    public function onError(ConnectionInterface $conn, \Exception $e) {
+    public function onError(ConnectionInterface $conn, Throwable $e) {
         if (isset($conn->controller)) {
             $conn->controller->onError($conn, $e);
         }

src/Ratchet/MessageInterface.php

@@ -1,12 +1,14 @@
 <?php
 namespace Ratchet;
 
+use Throwable;
+
 interface MessageInterface {
     /**
      * Triggered when a client sends data through the socket
      * @param  \Ratchet\ConnectionInterface $from The socket/connection that sent the message to your application
      * @param  string                       $msg  The message received
-     * @throws \Exception
+     * @throws Throwable
      */
     function onMessage(ConnectionInterface $from, $msg);
 }

src/Ratchet/Server/EchoServer.php

@@ -2,6 +2,7 @@
 namespace Ratchet\Server;
 use Ratchet\MessageComponentInterface;
 use Ratchet\ConnectionInterface;
+use Throwable;
 
 /**
  * A simple Ratchet application that will reply to all messages with the message it received
@@ -17,7 +18,7 @@ public function onMessage(ConnectionInterface $from, $msg) {
     public function onClose(ConnectionInterface $conn) {
     }
 
-    public function onError(ConnectionInterface $conn, \Exception $e) {
+    public function onError(ConnectionInterface $conn, Throwable $e) {
         $conn->close();
     }
 }

src/Ratchet/Server/FlashPolicy.php

@@ -2,6 +2,7 @@
 namespace Ratchet\Server;
 use Ratchet\MessageComponentInterface;
 use Ratchet\ConnectionInterface;
+use Throwable;
 
 /**
  * An app to go on a server stack to pass a policy file to a Flash socket
@@ -132,7 +133,7 @@ public function onClose(ConnectionInterface $conn) {
     /**
      * {@inheritdoc}
      */
-    public function onError(ConnectionInterface $conn, \Exception $e) {
+    public function onError(ConnectionInterface $conn, Throwable $e) {
         $conn->close();
     }
 

src/Ratchet/Server/IoServer.php

@@ -6,6 +6,7 @@
 use React\EventLoop\Factory as LoopFactory;
 use React\Socket\Server as Reactor;
 use React\Socket\SecureServer as SecureReactor;
+use Throwable;
 
 /**
  * Creates an open-ended socket to listen on a port for incoming connections.
@@ -97,7 +98,7 @@ public function handleConnect($conn) {
         $conn->on('close', function () use ($conn) {
             $this->handleEnd($conn);
         });
-        $conn->on('error', function (\Exception $e) use ($conn) {
+        $conn->on('error', function (Throwable $e) use ($conn) {
             $this->handleError($e, $conn);
         });
     }
@@ -110,7 +111,7 @@ public function handleConnect($conn) {
     public function handleData($data, $conn) {
         try {
             $this->app->onMessage($conn->decor, $data);
-        } catch (\Exception $e) {
+        } catch (Throwable $e) {
             $this->handleError($e, $conn);
         }
     }
@@ -122,7 +123,7 @@ public function handleData($data, $conn) {
     public function handleEnd($conn) {
         try {
             $this->app->onClose($conn->decor);
-        } catch (\Exception $e) {
+        } catch (Throwable $e) {
             $this->handleError($e, $conn);
         }
 
@@ -131,10 +132,10 @@ public function handleEnd($conn) {
 
     /**
      * An error has occurred, let the listening application know
-     * @param \Exception                        $e
+     * @param Throwable                         $e
      * @param \React\Socket\ConnectionInterface $conn
      */
-    public function handleError(\Exception $e, $conn) {
+    public function handleError(Throwable $e, $conn) {
         $this->app->onError($conn->decor, $e);
     }
 }

src/Ratchet/Server/IpBlackList.php

@@ -2,6 +2,7 @@
 namespace Ratchet\Server;
 use Ratchet\MessageComponentInterface;
 use Ratchet\ConnectionInterface;
+use Throwable;
 
 class IpBlackList implements MessageComponentInterface {
     /**
@@ -67,7 +68,7 @@ public function getBlockedAddresses() {
      */
     public function filterAddress($address) {
         if (strstr($address, ':') && substr_count($address, '.') == 3) {
-            list($address, $port) = explode(':', $address);
+            [$address, $port] = explode(':', $address);
         }
 
         return $address;
@@ -103,7 +104,7 @@ function onClose(ConnectionInterface $conn) {
     /**
      * {@inheritdoc}
      */
-    function onError(ConnectionInterface $conn, \Exception $e) {
+    function onError(ConnectionInterface $conn, Throwable $e) {
         if (!$this->isBlocked($conn->remoteAddress)) {
             $this->_decorating->onError($conn, $e);
         }

src/Ratchet/Session/IniOptionsHandler.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Ratchet\Session;
+
+use function ini_get;
+use function ini_set;
+
+final class IniOptionsHandler implements OptionsHandlerInterface
+{
+    public function get(string $name) : string
+    {
+        return ini_get($name);
+    }
+
+    public function set(string $name, $value) : void
+    {
+        ini_set($name, $value);
+    }
+}

src/Ratchet/Session/OptionsHandlerInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Ratchet\Session;
+
+interface OptionsHandlerInterface
+{
+    public function get(string $name) : string;
+
+    /**
+     * @param mixed $value
+     */
+    public function set(string $name, $value) : void;
+}