Merge pull request #48 from transistive/timeout-microtime

Microsecond timeout support

Author: stefanak-michal

composer.json

@@ -36,5 +36,10 @@
         "psr-4": {
             "Bolt\\": "src/"
         }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Bolt\\tests\\": "tests/"
+        }
     }
 }

src/connection/AConnection.php

@@ -31,9 +31,9 @@ abstract class AConnection implements IConnection
      * AConnection constructor.
      * @param string $ip
      * @param int $port
-     * @param int $timeout
+     * @param int|float $timeout
      */
-    public function __construct(string $ip = '127.0.0.1', int $port = 7687, int $timeout = 15)
+    public function __construct(string $ip = '127.0.0.1', int $port = 7687, $timeout = 15)
     {
         $this->ip = $ip;
         $this->port = $port;

src/connection/IConnection.php

@@ -11,7 +11,12 @@
  */
 interface IConnection
 {
-    public function __construct(string $ip = '127.0.0.1', int $port = 7687, int $timeout = 15);
+    /**
+     * @param string $ip
+     * @param int $port
+     * @param int|float $timeout
+     */
+    public function __construct(string $ip = '127.0.0.1', int $port = 7687, $timeout = 15);
 
     public function connect(): bool;
 

src/connection/Socket.php

@@ -42,8 +42,11 @@ public function connect(): bool
 
         socket_set_option($this->socket, SOL_TCP, TCP_NODELAY, 1);
         socket_set_option($this->socket, SOL_SOCKET, SO_KEEPALIVE, 1);
-        socket_set_option($this->socket, SOL_SOCKET, SO_RCVTIMEO, ['sec' => $this->timeout, 'usec' => 0]);
-        socket_set_option($this->socket, SOL_SOCKET, SO_SNDTIMEO, ['sec' => $this->timeout, 'usec' => 0]);
+        $timeoutSeconds = floor($this->timeout);
+        $microSeconds = floor(($this->timeout - $timeoutSeconds) * 1000000);
+        $timeoutOption = ['sec' => $timeoutSeconds, 'usec' => $microSeconds];
+        socket_set_option($this->socket, SOL_SOCKET, SO_RCVTIMEO, $timeoutOption);
+        socket_set_option($this->socket, SOL_SOCKET, SO_SNDTIMEO, $timeoutOption);
 
         $conn = @socket_connect($this->socket, $this->ip, $this->port);
         if (!$conn) {

src/connection/StreamSocket.php

@@ -66,6 +66,11 @@ public function connect(): bool
             }
         }
 
+        $timeout = (int) floor($this->timeout);
+        if (!stream_set_timeout($this->stream, $timeout, (int) floor(($this->timeout - $timeout) * 1000000))) {
+            throw new ConnectException('Cannot set timeout on stream');
+        }
+
         return true;
     }
 

tests/SocketTest.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Bolt\tests;
+
+use Bolt\Bolt;
+use Bolt\connection\StreamSocket;
+use Bolt\error\ConnectException;
+use Exception;
+use PHPUnit\Framework\TestCase;
+
+final class SocketTest extends TestCase
+{
+    /**
+     * @throws Exception
+     */
+    public function testMillisecondTimeout(): void
+    {
+        $socket = new StreamSocket($GLOBALS['NEO_HOST'] ?? '127.0.0.1', (int) ($GLOBALS['NEO_PORT'] ?? 7687), 1.5);
+        $bolt = new Bolt($socket);
+
+        $bolt->init('Test/1.0', $GLOBALS['NEO_USER'], $GLOBALS['NEO_PASS']);
+
+        $time = microtime(true);
+        try {
+            $bolt->run('FOREACH ( i IN range(1,10000) | 
+  MERGE (d:Day {day: i})
+)');
+        } catch (ConnectException $e) {
+            $newTime = microtime(true);
+
+            $this->assertEqualsWithDelta(1.5, $newTime - $time, 0.2);
+        }
+
+        self::assertTrue(true);
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function testSecondsTimeout(): void
+    {
+        $socket = new StreamSocket($GLOBALS['NEO_HOST'] ?? '127.0.0.1', (int) ($GLOBALS['NEO_PORT'] ?? 7687), 1);
+        $bolt = new Bolt($socket);
+        $bolt->init('Test/1.0', $GLOBALS['NEO_USER'], $GLOBALS['NEO_PASS']);
+
+        $time = microtime(true);
+        try {
+            $bolt->run('FOREACH ( i IN range(1,10000) | 
+  MERGE (d:Day {day: i})
+)');
+            $this->assertTrue(false, 'No timeout error triggered');
+        } catch (ConnectException $e) {
+            $newTime = microtime(true);
+
+            $this->assertEqualsWithDelta(1.0, $newTime - $time, 0.2);
+        }
+    }
+}