Support PHP 8.4 and work around reporting implicitly nullable types

.github/workflows/ci.yml

@@ -24,6 +24,7 @@ jobs:
           - "8.1"
           - "8.2"
           - "8.3"
+          - "8.4"
         dependencies:
           - "highest"
         include:

README.md

@@ -101,7 +101,7 @@ composer require cboden/ratchet:^0.4.4
 See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
 
 This project aims to run on any platform and thus does not require any PHP
-extensions and supports running on legacy PHP 5.4 through PHP 8.3+ with limited support for newer PHP.
+extensions and supports running on legacy PHP 5.4 through current PHP 8+.
 It's *highly recommended to use the latest supported PHP version* for this project.
 
 See above note about [Reviving Ratchet](#reviving-ratchet) for newer PHP support.

src/Ratchet/App.php

@@ -57,16 +57,19 @@ class App {
     protected $_routeCounter = 0;
 
     /**
-     * @param string        $httpHost   HTTP hostname clients intend to connect to. MUST match JS `new WebSocket('ws://$httpHost');`
-     * @param int           $port       Port to listen on. If 80, assuming production, Flash on 843 otherwise expecting Flash to be proxied through 8843
-     * @param string        $address    IP address to bind to. Default is localhost/proxy only. '0.0.0.0' for any machine.
-     * @param LoopInterface $loop       Specific React\EventLoop to bind the application to. null will create one for you.
-     * @param array         $context
+     * @param string         $httpHost   HTTP hostname clients intend to connect to. MUST match JS `new WebSocket('ws://$httpHost');`
+     * @param int            $port       Port to listen on. If 80, assuming production, Flash on 843 otherwise expecting Flash to be proxied through 8843
+     * @param string         $address    IP address to bind to. Default is localhost/proxy only. '0.0.0.0' for any machine.
+     * @param ?LoopInterface $loop       Specific React\EventLoop to bind the application to. null will create one for you.
+     * @param array          $context
      */
-    public function __construct($httpHost = 'localhost', $port = 8080, $address = '127.0.0.1', LoopInterface $loop = null, $context = array()) {
+    public function __construct($httpHost = 'localhost', $port = 8080, $address = '127.0.0.1', $loop = null, $context = array()) {
         if (extension_loaded('xdebug') && getenv('RATCHET_DISABLE_XDEBUG_WARN') === false) {
             trigger_error('XDebug extension detected. Remember to disable this if performance testing or going live!', E_USER_WARNING);
         }
+        if ($loop !== null && !$loop instanceof LoopInterface) { // manual type check to support legacy PHP < 7.1
+            throw new \InvalidArgumentException('Argument #4 ($loop) expected null|React\EventLoop\LoopInterface');
+        }
 
         if (null === $loop) {
             $loop = LoopFactory::create();

src/Ratchet/Http/HttpServerInterface.php

@@ -10,5 +10,6 @@ interface HttpServerInterface extends MessageComponentInterface {
      * @param \Psr\Http\Message\RequestInterface    $request null is default because PHP won't let me overload; don't pass null!!!
      * @throws \UnexpectedValueException if a RequestInterface is not passed
      */
-    public function onOpen(ConnectionInterface $conn, RequestInterface $request = null);
+    #[HackSupportForPHP8] public function onOpen(ConnectionInterface $conn, ?RequestInterface $request = null); /*
+    public function onOpen(ConnectionInterface $conn, RequestInterface $request = null); /**/
 }

src/Ratchet/Http/NoOpHttpServerController.php

@@ -4,7 +4,8 @@
 use Psr\Http\Message\RequestInterface;
 
 class NoOpHttpServerController implements HttpServerInterface {
-    public function onOpen(ConnectionInterface $conn, RequestInterface $request = null) {
+    #[HackSupportForPHP8] public function onOpen(ConnectionInterface $conn, ?RequestInterface $request = null) { /*
+    public function onOpen(ConnectionInterface $conn, RequestInterface $request = null) { /**/
     }
 
     public function onMessage(ConnectionInterface $from, $msg) {

src/Ratchet/Http/OriginCheck.php

@@ -31,7 +31,8 @@ public function __construct(MessageComponentInterface $component, array $allowed
     /**
      * {@inheritdoc}
      */
-    public function onOpen(ConnectionInterface $conn, RequestInterface $request = null) {
+    #[HackSupportForPHP8] public function onOpen(ConnectionInterface $conn, ?RequestInterface $request = null) { /*
+    public function onOpen(ConnectionInterface $conn, RequestInterface $request = null) { /**/
         $header = (string)$request->getHeader('Origin')[0];
         $origin = parse_url($header, PHP_URL_HOST) ?: $header;
 

src/Ratchet/Http/Router.php

@@ -26,7 +26,8 @@ public function __construct(UrlMatcherInterface $matcher) {
      * {@inheritdoc}
      * @throws \UnexpectedValueException If a controller is not \Ratchet\Http\HttpServerInterface
      */
-    public function onOpen(ConnectionInterface $conn, RequestInterface $request = null) {
+    #[HackSupportForPHP8] public function onOpen(ConnectionInterface $conn, ?RequestInterface $request = null) { /*
+    public function onOpen(ConnectionInterface $conn, RequestInterface $request = null) { /**/
         if (null === $request) {
             throw new \UnexpectedValueException('$request can not be null');
         }

src/Ratchet/Server/IoServer.php

@@ -34,7 +34,11 @@ class IoServer {
      * @param \React\Socket\ServerInterface       $socket   The React socket server to run the Ratchet application off of
      * @param \React\EventLoop\LoopInterface|null $loop     The React looper to run the Ratchet application off of
      */
-    public function __construct(MessageComponentInterface $app, ServerInterface $socket, LoopInterface $loop = null) {
+    public function __construct(MessageComponentInterface $app, ServerInterface $socket, $loop = null) {
+        if ($loop !== null && !$loop instanceof LoopInterface) { // manual type check to support legacy PHP < 7.1
+            throw new \InvalidArgumentException('Argument #3 ($loop) expected null|React\EventLoop\LoopInterface');
+        }
+
         if (false === strpos(PHP_VERSION, "hiphop")) {
             gc_enable();
         }

src/Ratchet/Session/SessionProvider.php

@@ -38,13 +38,16 @@ class SessionProvider implements HttpServerInterface {
     protected $_serializer;
 
     /**
-     * @param \Ratchet\Http\HttpServerInterface           $app
-     * @param \SessionHandlerInterface                    $handler
-     * @param array                                       $options
-     * @param \Ratchet\Session\Serialize\HandlerInterface $serializer
+     * @param \Ratchet\Http\HttpServerInterface            $app
+     * @param \SessionHandlerInterface                     $handler
+     * @param array                                        $options
+     * @param ?\Ratchet\Session\Serialize\HandlerInterface $serializer
      * @throws \RuntimeException
      */
-    public function __construct(HttpServerInterface $app, \SessionHandlerInterface $handler, array $options = array(), HandlerInterface $serializer = null) {
+    public function __construct(HttpServerInterface $app, \SessionHandlerInterface $handler, array $options = array(), $serializer = null) {
+        if ($serializer !== null && !$serializer instanceof HandlerInterface) { // manual type check to support legacy PHP < 7.1
+            throw new \InvalidArgumentException('Argument #4 ($serializer) expected null|Ratchet\Session\Serialize\HandlerInterface');
+        }
         $this->_app     = $app;
         $this->_handler = $handler;
         $this->_null    = new NullSessionHandler;
@@ -70,7 +73,8 @@ public function __construct(HttpServerInterface $app, \SessionHandlerInterface $
     /**
      * {@inheritdoc}
      */
-    public function onOpen(ConnectionInterface $conn, RequestInterface $request = null) {
+    #[HackSupportForPHP8] public function onOpen(ConnectionInterface $conn, ?RequestInterface $request = null) { /*
+    public function onOpen(ConnectionInterface $conn, RequestInterface $request = null) { /**/
         $sessionName = ini_get('session.name');
 
         $id = array_reduce($request->getHeader('Cookie'), function($accumulator, $cookie) use ($sessionName) {

src/Ratchet/WebSocket/WsServer.php

@@ -104,7 +104,8 @@ public function __construct(ComponentInterface $component) {
     /**
      * {@inheritdoc}
      */
-    public function onOpen(ConnectionInterface $conn, RequestInterface $request = null) {
+    #[HackSupportForPHP8] public function onOpen(ConnectionInterface $conn, ?RequestInterface $request = null) { /*
+    public function onOpen(ConnectionInterface $conn, RequestInterface $request = null) { /**/
         if (null === $request) {
             throw new \UnexpectedValueException('$request can not be null');
         }

tests/unit/AppTest.php

@@ -0,0 +1,17 @@
+<?php
+namespace Ratchet;
+
+use PHPUnit\Framework\TestCase;
+use Ratchet\App;
+
+class AppTest extends TestCase {
+    public function testCtorThrowsForInvalidLoop() {
+        if (method_exists($this, 'expectException')) {
+            $this->expectException('InvalidArgumentException');
+            $this->expectExceptionMessage('Argument #4 ($loop) expected null|React\EventLoop\LoopInterface');
+        } else {
+            $this->setExpectedException('InvalidArgumentException', 'Argument #4 ($loop) expected null|React\EventLoop\LoopInterface');
+        }
+        new App('localhost', 8080, '127.0.0.1', 'loop');
+    }
+}

tests/unit/Server/IoServerTest.php

@@ -39,6 +39,16 @@ public function setUpServer() {
         $this->server = new IoServer($this->app, $this->reactor, $loop);
     }
 
+    public function testCtorThrowsForInvalidLoop() {
+        if (method_exists($this, 'expectException')) {
+            $this->expectException('InvalidArgumentException');
+            $this->expectExceptionMessage('Argument #3 ($loop) expected null|React\EventLoop\LoopInterface');
+        } else {
+            $this->setExpectedException('InvalidArgumentException', 'Argument #3 ($loop) expected null|React\EventLoop\LoopInterface');
+        }
+        new IoServer($this->app, $this->reactor, 'loop');
+    }
+
     public function testOnOpen() {
         $this->app->expects($this->once())->method('onOpen')->with($this->isInstanceOf('Ratchet\\ConnectionInterface'));
 

tests/unit/Session/SessionComponentTest.php → tests/unit/Session/SessionProviderTest.php

@@ -24,6 +24,16 @@ public function setUpProvider() {
         $this->_serv = new SessionProvider($this->_app, new NullSessionHandler);
     }
 
+    public function testCtorThrowsForInvalidSerializer() {
+        if (method_exists($this, 'expectException')) {
+            $this->expectException('InvalidArgumentException');
+            $this->expectExceptionMessage('Argument #4 ($serializer) expected null|Ratchet\Session\Serialize\HandlerInterface');
+        } else {
+            $this->setExpectedException('InvalidArgumentException', 'Argument #4 ($serializer) expected null|Ratchet\Session\Serialize\HandlerInterface');
+        }
+        new SessionProvider($this->_app, new NullSessionHandler(), [], 'serializer');
+    }
+
     /**
      * @after
      */