Run tests on PHP 8.4 and update test environment

Author: PaulRotmann

.github/workflows/ci.yml

@@ -7,10 +7,11 @@ on:
 jobs:
   PHPUnit:
     name: PHPUnit (PHP ${{ matrix.php }})
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     strategy:
       matrix:
         php:
+          - 8.4
           - 8.3
           - 8.2
           - 8.1
@@ -38,7 +39,7 @@ jobs:
 
   PHPUnit-hhvm:
     name: PHPUnit (HHVM)
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     continue-on-error: true
     steps:
       - uses: actions/checkout@v4

composer.json

@@ -22,9 +22,9 @@
     },
     "require": {
         "php": ">=5.3",
-        "clue/multicast-react": "^1.0 || ^0.2",
+        "clue/multicast-react": "1.x-dev#f1bd5df0309b9f8b3486b09bf37aedfb042addb6",
         "react/event-loop": "^1.2",
-        "react/promise": "^2.0 || ^1.0"
+        "react/promise": "^3.2 || ^2.7 || ^1.2.1"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.6 || ^5.7 || ^4.8.36"

src/Client.php

@@ -18,18 +18,15 @@ class Client
     /** @var MulticastFactory */
     private $multicast;
 
-    /**
-     * This class takes an optional `LoopInterface|null $loop` parameter that can be used to
-     * pass the event loop instance to use for this object. You can use a `null` value
-     * here in order to use the [default loop](https://github.com/reactphp/event-loop#loop).
-     * This value SHOULD NOT be given unless you're sure you want to explicitly use a
-     * given event loop instance.
-     *
-     * @param ?LoopInterface $loop
-     * @param ?MulticastFactory $multicast
-     */
-    public function __construct(LoopInterface $loop = null, MulticastFactory $multicast = null)
+    public function __construct($loop = null, $multicast = null)
     {
+        if ($loop !== null && !$loop instanceof LoopInterface) {
+            throw new \InvalidArgumentException('Argument #1 ($loop) expected null|React\EventLoop\LoopInterface');
+        }
+        if ($multicast !== null && !$multicast instanceof MulticastFactory) {
+            throw new \InvalidArgumentException('Argument #2 ($multicast) expected null|Clue\React\Multicast\Factory');
+        }
+
         $this->loop = $loop ?: Loop::get();
         $this->multicast = $multicast ?: new MulticastFactory($this->loop);
     }
@@ -46,29 +43,32 @@ public function search($searchTarget = 'ssdp:all', $mx = 2)
         $socket = $this->multicast->createSender();
         // TODO: The TTL for the IP packet SHOULD default to 2 and SHOULD be configurable.
 
-        $timer = $this->loop->addTimer($mx, function() use ($socket, &$deferred) {
-            $deferred->resolve();
-            $socket->close();
-        });
+        $messages = array();
 
-        $loop = $this->loop;
-        $deferred = new Deferred(function () use ($socket, &$timer, $loop) {
-            // canceling resulting promise cancels timer and closes socket
-            $loop->cancelTimer($timer);
+        $timer = $this->loop->addTimer($mx, function() use ($socket, &$deferred, &$messages) {
+            // resolve promise with all collected messages
+            $deferred->resolve($messages);
             $socket->close();
-            throw new RuntimeException('Cancelled');
         });
 
-        $that = $this;
-        $socket->on('message', function ($data, $remote) use ($deferred, $that) {
-            $message = $that->parseMessage($data, $remote);
+            $loop = $this->loop;
+            $deferred = new Deferred(function () use ($socket, &$timer, $loop) {
+                // canceling resulting promise cancels timer and closes socket
+                $loop->cancelTimer($timer);
+                $socket->close();
+                throw new RuntimeException('Cancelled');
+            });
 
-            $deferred->progress($message);
-        });
+                $that = $this;
+                $socket->on('message', function ($data, $remote) use ($that, &$messages) {
+                    $message = $that->parseMessage($data, $remote);
+
+                    $messages[] = $message;
+                });
 
-        $socket->send($data, self::ADDRESS);
+                    $socket->send($data, self::ADDRESS);
 
-        return $deferred->promise();
+                    return $deferred->promise();
     }
 
     /** @internal */
@@ -81,4 +81,4 @@ public function parseMessage($message, $remote)
         );
         return $message;
     }
-}
+}

tests/ClientTest.php

@@ -39,26 +39,26 @@ public function testSearchCancel()
         // prefer newer EventLoop 1.0/0.5+ TimerInterface or fall back to legacy namespace
         $timer = $this->getMockBuilder(
             interface_exists('React\EventLoop\TimerInterface') ? 'React\EventLoop\TimerInterface' : 'React\EventLoop\Timer\TimerInterface'
-        )->getMock();
+            )->getMock();
 
-        $loop->expects($this->once())->method('addTimer')->willReturn($timer);
-        $loop->expects($this->once())->method('cancelTimer')->with($timer);
+            $loop->expects($this->once())->method('addTimer')->willReturn($timer);
+            $loop->expects($this->once())->method('cancelTimer')->with($timer);
 
-        $multicast->expects($this->once())->method('createSender')->will($this->returnValue($socket));
+            $multicast->expects($this->once())->method('createSender')->will($this->returnValue($socket));
 
-        $promise = $client->search();
+            $promise = $client->search();
 
-        $this->assertInstanceOf('React\Promise\PromiseInterface', $promise);
+            $this->assertInstanceOf('React\Promise\PromiseInterface', $promise);
 
-        if (!($promise instanceof \React\Promise\CancellablePromiseInterface)) {
-            $this->markTestSkipped();
-        }
+            if (!($promise instanceof \React\Promise\CancellablePromiseInterface)) {
+                $this->markTestSkipped();
+            }
 
-        $socket->expects($this->once())->method('close');
+            $socket->expects($this->once())->method('close');
 
-        $promise->cancel();
+            $promise->cancel();
 
-        $promise->then(null, $this->expectCallableOnce());
+            $promise->then(null, $this->expectCallableOnce());
     }
 
     public function testSearchTimeout()
@@ -67,8 +67,41 @@ public function testSearchTimeout()
 
         $promise = $client->search('ssdp:all', 0.01);
 
-        Loop::run();
+        $result = null;
+        $promise->then(function ($value) use (&$result) {
+            $result = $value;
+        });
+
+            Loop::run();
+
+            $this->assertTrue(is_array($result), 'Expected result to be an array');
+    }
+
+
+    public function testCtorThrowsForInvalidLoop()
+    {
+        if (method_exists($this, 'expectException')) {
+            // PHPUnit 5.2+
+            $this->expectException('InvalidArgumentException');
+            $this->expectExceptionMessage('Argument #1 ($loop) expected null|React\EventLoop\LoopInterface');
+        } else {
+            // legacy PHPUnit
+            $this->setExpectedException('InvalidArgumentException', 'Argument #1 ($loop) expected null|React\EventLoop\LoopInterface');
+        }
+
+        new Client('invalid-loop');
+    }
 
-        $promise->then($this->expectCallableOnce(), $this->expectCallableNever(), $this->expectCallableNever());
+    public function testCtorThrowsForInvalidMulticast()
+    {
+        if (method_exists($this, 'expectException')) {
+            $this->expectException('InvalidArgumentException');
+            $this->expectExceptionMessage('Argument #2 ($multicast) expected null|Clue\React\Multicast\Factory');
+        } else {
+            $this->setExpectedException('InvalidArgumentException', 'Argument #2 ($multicast) expected null|Clue\React\Multicast\Factory');
+        }
+
+        new Client(null, 'invalid-multicast');
     }
-}
+
+}