Merge pull request #14 from spiral/feature/method-deprecation

Mark Broadcast::isAvailable method as deprecated.

Author: butschster

README.md

@@ -66,10 +66,6 @@ require __DIR__ . '/vendor/autoload.php';
 
 $broadcast = new Broadcast(RPC::create('tcp://127.0.0.1:6001'));
 
-if (!$broadcast->isAvailable()) {
-    throw new \LogicException('The [broadcast] plugin not available');
-}
-
 //
 // Now we can send a message to a specific topic
 //

src/Broadcast.php

@@ -38,24 +38,11 @@ public function __construct(RPCInterface $rpc)
     }
 
     /**
-     * {@inheritDoc}
+     * @deprecated Information about RoadRunner plugins is not available since RoadRunner version 2.2
      */
     public function isAvailable(): bool
     {
-        try {
-            /** @var array<string>|mixed $result */
-            $result = $this->rpc
-                ->withCodec(new JsonCodec())
-                ->call('informer.List', true);
-
-            if (! \is_array($result)) {
-                return false;
-            }
-
-            return \in_array('websockets', $result, true);
-        } catch (\Throwable $e) {
-            return false;
-        }
+        throw new \RuntimeException(\sprintf('%s::isAvailable method is deprecated.', self::class));
     }
 
     /**

src/BroadcastInterface.php

@@ -20,13 +20,6 @@
  */
 interface BroadcastInterface
 {
-    /**
-     * Returns information about whether a broadcast plugin is available.
-     *
-     * @return bool
-     */
-    public function isAvailable(): bool;
-
     /**
      * Method to send messages to the required topic (channel).
      * <code>

tests/BroadcastTestCase.php

@@ -37,29 +37,10 @@ public function testFactoryCreation(): void
 
     public function testIsAvailable(): void
     {
-        $factory = $this->broadcast(['informer.List' => '["websockets"]']);
-        $this->assertTrue($factory->isAvailable());
-    }
-
-    public function testNotAvailable(): void
-    {
-        $factory = $this->broadcast(['informer.List' => '[]']);
-        $this->assertFalse($factory->isAvailable());
-    }
-
-    public function testNotAvailableOnNonArrayResponse(): void
-    {
-        $factory = $this->broadcast(['informer.List' => '42']);
-        $this->assertFalse($factory->isAvailable());
-    }
-
-    public function testNotAvailableOnErrorResponse(): void
-    {
-        $factory = $this->broadcast(['informer.List' => (static function () {
-            throw new \Exception();
-        })]);
+        $this->expectException(\RuntimeException::class);
+        $this->expectErrorMessage('Spiral\RoadRunner\Broadcast\Broadcast::isAvailable method is deprecated.');
 
-        $this->assertFalse($factory->isAvailable());
+        $this->broadcast()->isAvailable();
     }
 
     public function testPublishingSingleMessage(): void