Merge pull request #26 from boenrobot/retry-support

Added support for the "retry" field.

Author: clue

src/EventSource.php

@@ -195,6 +195,10 @@ private function request()
                         $this->lastEventId = $message->lastEventId;
                     }
 
+                    if ($message->retry !== null) {
+                        $this->reconnectTime = $message->retry / 1000;
+                    }
+
                     if ($message->data !== '') {
                         $this->emit($message->type, array($message));
                         if ($this->readyState === self::CLOSED) {

src/MessageEvent.php

@@ -29,6 +29,8 @@ public static function parse($data)
                 $message->lastEventId .= $value;
             } elseif ($name === 'event') {
                 $message->type = $value;
+            } elseif ($name === 'retry' && $value === (string)(int)$value && $value >= 0) {
+                $message->retry = (int)$value;
             }
         }
 
@@ -53,4 +55,10 @@ public static function parse($data)
      * @var string
      */
     public $type = 'message';
+
+    /**
+     * @internal
+     * @var ?int
+     */
+    public $retry;
 }

tests/EventSourceTest.php

@@ -583,6 +583,78 @@ public function testReconnectAfterStreamClosesUsesLastEventIdFromParsedEventStre
         $timerReconnect();
     }
 
+    public function testReconnectAfterStreamClosesUsesSpecifiedRetryTime()
+    {
+        $loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();
+        $timerReconnect = null;
+        $loop->expects($this->once())->method('addTimer')->with(
+            2.543,
+            $this->callback(function ($cb) use (&$timerReconnect) {
+                $timerReconnect = $cb;
+                return true;
+            })
+        );
+
+        $deferred = new Deferred();
+        $browser = $this->getMockBuilder('React\Http\Browser')->disableOriginalConstructor()->getMock();
+        $browser->expects($this->once())->method('withRejectErrorResponse')->willReturnSelf();
+        $browser->expects($this->exactly(2))->method('requestStreaming')->withConsecutive(
+            ['GET', 'http://example.com', ['Accept' => 'text/event-stream', 'Cache-Control' => 'no-cache']],
+            ['GET', 'http://example.com', ['Accept' => 'text/event-stream', 'Cache-Control' => 'no-cache']]
+        )->willReturnOnConsecutiveCalls(
+            $deferred->promise(),
+            new Promise(function () { })
+        );
+
+        $es = new EventSource('http://example.com', $browser, $loop);
+
+        $stream = new ThroughStream();
+        $response = new Response(200, array('Content-Type' => 'text/event-stream'), new ReadableBodyStream($stream));
+        $deferred->resolve($response);
+
+        $stream->write("retry:2543\n\n");
+        $stream->end();
+
+        $this->assertNotNull($timerReconnect);
+        $timerReconnect();
+    }
+
+    public function testReconnectAfterStreamClosesIgnoresInvalidRetryTime()
+    {
+        $loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();
+        $timerReconnect = null;
+        $loop->expects($this->once())->method('addTimer')->with(
+            3,
+            $this->callback(function ($cb) use (&$timerReconnect) {
+                $timerReconnect = $cb;
+                return true;
+            })
+        );
+
+        $deferred = new Deferred();
+        $browser = $this->getMockBuilder('React\Http\Browser')->disableOriginalConstructor()->getMock();
+        $browser->expects($this->once())->method('withRejectErrorResponse')->willReturnSelf();
+        $browser->expects($this->exactly(2))->method('requestStreaming')->withConsecutive(
+            ['GET', 'http://example.com', ['Accept' => 'text/event-stream', 'Cache-Control' => 'no-cache']],
+            ['GET', 'http://example.com', ['Accept' => 'text/event-stream', 'Cache-Control' => 'no-cache']]
+        )->willReturnOnConsecutiveCalls(
+            $deferred->promise(),
+            new Promise(function () { })
+        );
+
+        $es = new EventSource('http://example.com', $browser, $loop);
+
+        $stream = new ThroughStream();
+        $response = new Response(200, array('Content-Type' => 'text/event-stream'), new ReadableBodyStream($stream));
+        $deferred->resolve($response);
+
+        $stream->write("retry:now\n\n");
+        $stream->end();
+
+        $this->assertNotNull($timerReconnect);
+        $timerReconnect();
+    }
+
     public function setExpectedException($exception, $exceptionMessage = '', $exceptionCode = null)
     {
         if (method_exists($this, 'expectException')) {

tests/MessageEventTest.php

@@ -55,4 +55,28 @@ public function testParseDataWithCarrigeReturnAndNewlineOverTwoLines()
 
         $this->assertEquals("hello\n", $message->data);
     }
+
+    public function retryTimeDataProvider()
+    {
+        return [
+            ['retry: 1234', 1234,],
+            ['retry: 0', 0,],
+            ['retry: ' . PHP_INT_MAX, PHP_INT_MAX,],
+            ['retry: ' . PHP_INT_MAX . '9', null,],
+            ['retry: 1.234', null,],
+            ['retry: now', null,],
+            ['retry: -1', null,],
+            ['retry: -1.234', null,],
+        ];
+    }
+
+    /**
+     * @dataProvider retryTimeDataProvider
+     */
+    public function testParseRetryTime($input, $expected)
+    {
+        $message = MessageEvent::parse($input);
+
+        $this->assertSame($expected, $message->retry);
+    }
 }