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
@@ -24,30 +25,41 @@ jobs:
           - 5.5
           - 5.4
           - 5.3
+      fail-fast: false
     steps:
       - uses: actions/checkout@v4
       - uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
           coverage: xdebug
-      - run: composer install
-      - run: vendor/bin/phpunit --coverage-text
-        if: ${{ matrix.php >= 7.3 }}
-      - run: vendor/bin/phpunit --coverage-text -c phpunit.xml.legacy
-        if: ${{ matrix.php < 7.3 }}
+        env:
+          # Für PHP 8.4 Deprecation Warnings als nicht-fatal behandeln
+          fail-fast: false
+      - name: Install dependencies (Modern PHP)
+        if: ${{ matrix.php >= '7.3' }}
+        run: composer install --prefer-dist --no-progress
+      - name: Install dependencies (Legacy PHP)
+        if: ${{ matrix.php < '7.3' }}
+        run: composer install --prefer-dist --no-progress --ignore-platform-reqs
+      - name: Run tests (Modern PHP)
+        if: ${{ matrix.php >= '7.3' }}
+        run: vendor/bin/phpunit --coverage-text
+      - name: Run tests (Legacy PHP)
+        if: ${{ matrix.php < '7.3' }}
+        run: vendor/bin/phpunit --coverage-text -c phpunit.xml.legacy
 
   PHPUnit-hhvm:
     name: PHPUnit (HHVM)
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     continue-on-error: true
     steps:
       - uses: actions/checkout@v4
       - run: cp "$(which composer)" composer.phar && ./composer.phar self-update --2.2 # downgrade Composer for HHVM
       - name: Run hhvm composer.phar install
         uses: docker://hhvm/hhvm:3.30-lts-latest
         with:
-          args: hhvm composer.phar install
+          args: hhvm composer.phar install --ignore-platform-reqs
       - name: Run hhvm vendor/bin/phpunit
         uses: docker://hhvm/hhvm:3.30-lts-latest
         with:
-          args: hhvm vendor/bin/phpunit
+          args: hhvm vendor/bin/phpunit

composer.json

@@ -22,11 +22,11 @@
     },
     "require": {
         "php": ">=5.3",
-        "clue/multicast-react": "^1.0 || ^0.2",
+        "clue/multicast-react": "^1.2 || ^0.2",
         "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"
+        "phpunit/phpunit": "^9.6 || ^7.5 || ^5.7 || ^4.8.36"
     }
-}
+}

src/Client.php

@@ -28,8 +28,15 @@ class Client
      * @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) { // manual type check to support legacy PHP < 7.1
+            throw new \InvalidArgumentException('Argument #1 ($loop) expected null|React\EventLoop\LoopInterface');
+        }
+        if ($multicast !== null && !$multicast instanceof MulticastFactory) { // manual type check to support legacy PHP < 7.1
+            throw new \InvalidArgumentException('Argument #2 ($multicast) expected null|Clue\React\Multicast\Factory');
+        }
+
         $this->loop = $loop ?: Loop::get();
         $this->multicast = $multicast ?: new MulticastFactory($this->loop);
     }
@@ -44,31 +51,33 @@ public function search($searchTarget = 'ssdp:all', $mx = 2)
         $data .= "\r\n";
 
         $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();
-        });
+        // TODO: The TTL for the IP packet SHOULD default to 2 and SHOULD be configurable.
 
         $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');
-        });
+        $timer = null;
 
-        $that = $this;
-        $socket->on('message', function ($data, $remote) use ($deferred, $that) {
-            $message = $that->parseMessage($data, $remote);
+        $deferred = new Deferred();
 
-            $deferred->progress($message);
+        $timer = $this->loop->addTimer($mx, function() use ($socket, $deferred) {
+            $deferred->resolve();
+            $socket->close();
         });
 
-        $socket->send($data, self::ADDRESS);
+            $that = $this;
+            $socket->on('message', function ($data, $remote) use ($deferred, $that) {
+                $message = $that->parseMessage($data, $remote);
+                // React Promise v3+ doesn't support progress(), use notify() instead
+                if (method_exists($deferred, 'progress')) {
+                    $deferred->progress($message);
+                } else if (method_exists($deferred, 'notify')) {
+                    $deferred->notify($message);
+                }
+            });
+
+                $socket->send($data, self::ADDRESS);
 
-        return $deferred->promise();
+                return $deferred->promise();
     }
 
     /** @internal */
@@ -79,6 +88,7 @@ public function parseMessage($message, $remote)
             'data' => $message,
             '_sender' => $remote
         );
+
         return $message;
     }
-}
+}

tests/ClientTest.php

@@ -71,4 +71,32 @@ public function testSearchTimeout()
 
         $promise->then($this->expectCallableOnce(), $this->expectCallableNever(), $this->expectCallableNever());
     }
+
+    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');
+    }
+
+    public function testCtorThrowsForInvalidMulticast()
+    {
+        if (method_exists($this, 'expectException')) {
+            // PHPUnit 5.2+
+            $this->expectException('InvalidArgumentException');
+            $this->expectExceptionMessage('Argument #2 ($multicast) expected null|Clue\React\Multicast\Factory');
+        } else {
+            // legacy PHPUnit
+            $this->setExpectedException('InvalidArgumentException', 'Argument #2 ($multicast) expected null|Clue\React\Multicast\Factory');
+        }
+
+        new Client(null, 'invalid');
+    }
 }