Merge pull request #7 from clue-labs/cancel

Support Promise cancellation

Author: clue

composer.json

@@ -18,6 +18,6 @@
         "clue/multicast-react": "~1.0|~0.2.0",
         "react/event-loop": "~0.4.0|~0.3.0",
         "react/dns": "~0.4.0|~0.3.0",
-        "react/promise": "~2.0|~1.0"
+        "react/promise": "^2.1 || ^1.2.1"
     }
 }

src/MulticastExecutor.php

@@ -72,7 +72,12 @@ public function doQuery($nameserver, $queryData, $name)
         $parser = $this->parser;
         $loop = $this->loop;
 
-        $deferred = new Deferred();
+        $deferred = new Deferred(function ($_, $reject) use (&$conn, &$timer, $name) {
+            $conn->close();
+            $timer->cancel();
+
+            $reject(new \RuntimeException(sprintf("DNS query for %s cancelled", $name)));
+        });
 
         $timer = $this->loop->addTimer($this->timeout, function () use (&$conn, $name, $deferred) {
             $conn->close();

tests/MulticastExecutorTest.php

@@ -3,29 +3,63 @@
 use Clue\React\Mdns\MulticastExecutor;
 use Clue\React\Mdns\Factory;
 use React\Dns\Query\Query;
+
 class MulticastExecutorTest extends TestCase
 {
-    public function testA()
-    {
-        $nameserver = Factory::DNS;
+    private $nameserver;
+    private $loop;
+    private $parser;
+    private $dumper;
+    private $sockets;
 
-        $loop = $this->getMock('React\EventLoop\LoopInterface');
-        $parser = $this->getMock('React\Dns\Protocol\Parser');
-        $dumper = $this->getMock('React\Dns\Protocol\BinaryDumper');
-        $sockets = $this->getMockBuilder('Clue\React\Multicast\Factory')->disableOriginalConstructor()->getMock();
+    public function setUp()
+    {
+        $this->nameserver = Factory::DNS;
+        $this->loop = $this->getMock('React\EventLoop\LoopInterface');
+        $this->parser = $this->getMock('React\Dns\Protocol\Parser');
+        $this->dumper = $this->getMock('React\Dns\Protocol\BinaryDumper');
+        $this->sockets = $this->getMockBuilder('Clue\React\Multicast\Factory')->disableOriginalConstructor()->getMock();
+    }
 
-        $executor = new MulticastExecutor($loop, $parser, $dumper, 5, $sockets);
+    public function testQueryWillReturnPromise()
+    {
+        $executor = new MulticastExecutor($this->loop, $this->parser, $this->dumper, 5, $this->sockets);
 
         $socket = $this->getMock('React\Datagram\SocketInterface');
 
-        $dumper->expects($this->once())->method('toBinary')->will($this->returnValue('message'));
-        $sockets->expects($this->once())->method('createSender')->will($this->returnValue($socket));
+        $this->dumper->expects($this->once())->method('toBinary')->will($this->returnValue('message'));
+        $this->sockets->expects($this->once())->method('createSender')->will($this->returnValue($socket));
 
-        $socket->expects($this->once())->method('send')->with($this->equalTo('message'), $this->equalTo($nameserver));
+        $socket->expects($this->once())->method('send')->with($this->equalTo('message'), $this->equalTo($this->nameserver));
 
         $query = new Query('name', 'type', 'class', time());
 
-        $ret = $executor->query($nameserver, $query);
+        $ret = $executor->query($this->nameserver, $query);
         $this->assertInstanceOf('React\Promise\PromiseInterface', $ret);
     }
+
+    public function testCancellingPromiseWillCloseSocketAndReject()
+    {
+        $executor = new MulticastExecutor($this->loop, $this->parser, $this->dumper, 5, $this->sockets);
+
+        $socket = $this->getMock('React\Datagram\SocketInterface');
+        $socket->expects($this->once())->method('close');
+        $socket->expects($this->once())->method('send')->with($this->equalTo('message'), $this->equalTo($this->nameserver));
+        $this->sockets->expects($this->once())->method('createSender')->will($this->returnValue($socket));
+
+        $timer = $this->getMock('React\EventLoop\Timer\TimerInterface');
+        $timer->expects($this->once())->method('cancel');
+        $this->loop->expects($this->once())->method('addTimer')->willReturn($timer);
+
+        $this->dumper->expects($this->once())->method('toBinary')->will($this->returnValue('message'));
+
+        $query = new Query('name', 'type', 'class', time());
+
+        $ret = $executor->query($this->nameserver, $query);
+        $this->assertInstanceOf('React\Promise\CancellablePromiseInterface', $ret);
+
+        $ret->cancel();
+
+        $ret->then($this->expectCallableNever(), $this->expectCallableOnceParameter('RuntimeException'));
+    }
 }