implemented and used timeout exception where relevant

Author: transistive

phpunit.xml

@@ -6,7 +6,7 @@
     </testsuites>
     <php>
         <var name="NEO_USER" value="neo4j"/>
-        <var name="NEO_PASS" value="nothing"/>
+        <var name="NEO_PASS" value="test"/>
     </php>
     <filter>
         <whitelist>

src/connection/Socket.php

@@ -4,6 +4,11 @@
 
 use Bolt\Bolt;
 use Bolt\error\ConnectException;
+use Bolt\error\ConnectionTimeoutException;
+use function microtime;
+use function round;
+use function socket_get_status;
+use function socket_strerror;
 
 /**
  * Socket class
@@ -20,6 +25,10 @@ class Socket extends AConnection
      */
     private $socket = false;
 
+    private const RESOURCE_UNAVAILABLE_CODE = 11;
+    /** @var float|null */
+    private $timetAtTimeoutConfiguration;
+
     /**
      * Create socket connection
      * @return bool
@@ -73,8 +82,7 @@ public function write(string $buffer)
         while (0 < $size) {
             $sent = socket_write($this->socket, $buffer, $size);
             if ($sent === false) {
-                $code = socket_last_error($this->socket);
-                throw new ConnectException(socket_strerror($code), $code);
+                $this->throwConnectException();
             }
 
             $buffer = mb_strcut($buffer, $sent, null, '8bit');
@@ -99,8 +107,7 @@ public function read(int $length = 2048): string
         do {
             $readed = socket_read($this->socket, $length - mb_strlen($output, '8bit'), PHP_BINARY_READ);
             if ($readed === false) {
-                $code = socket_last_error($this->socket);
-                throw new ConnectException(socket_strerror($code), $code);
+                $this->throwConnectException();
             }
             $output .= $readed;
         } while (mb_strlen($output, '8bit') < $length);
@@ -135,5 +142,23 @@ private function configureTimeout(): void
         $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);
+        $this->timetAtTimeoutConfiguration = microtime(true);
+    }
+
+    /**
+     * @return mixed
+     * @throws ConnectException
+     * @throws ConnectionTimeoutException
+     */
+    private function throwConnectException()
+    {
+        $code = socket_last_error($this->socket);
+        if ($code === self::RESOURCE_UNAVAILABLE_CODE) {
+            $timediff = microtime(true) - $this->timetAtTimeoutConfiguration;
+            if ($timediff >= $this->timeout) {
+                throw ConnectionTimeoutException::createFromTimeout($this->timeout);
+            }
+        }
+        throw new ConnectException(socket_strerror($code), $code);
     }
 }

src/connection/StreamSocket.php

@@ -5,6 +5,7 @@
 
 use Bolt\Bolt;
 use Bolt\error\ConnectException;
+use Bolt\error\ConnectionTimeoutException;
 use function floor;
 use function stream_set_timeout;
 
@@ -99,7 +100,7 @@ public function read(int $length = 2048): string
         $res = stream_get_contents($this->stream, $length);
 
         if (stream_get_meta_data($this->stream)["timed_out"])
-            throw new ConnectException('Connection timeout reached after '.$this->timeout.' seconds.');
+            throw ConnectionTimeoutException::createFromTimeout($this->timeout);
 
         if (empty($res))
             throw new ConnectException('Read error');

src/error/ConnectionTimeoutException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Bolt\error;
+
+class ConnectionTimeoutException extends ConnectException
+{
+    public static function createFromTimeout(float $timeout): self
+    {
+        return new self('Connection timeout reached after '.$timeout.' seconds.');
+    }
+}

tests/connection/AConnectionTest.php

@@ -6,7 +6,7 @@
 use Bolt\connection\IConnection;
 use Bolt\connection\Socket;
 use Bolt\connection\StreamSocket;
-use Bolt\error\ConnectException;
+use Bolt\error\ConnectionTimeoutException;
 use Bolt\error\MessageException;
 use Bolt\helpers\Auth;
 use Bolt\protocol\V4;
@@ -38,7 +38,7 @@ public function testMillisecondTimeout(string $alias): void
             $protocol->run('FOREACH ( i IN range(1,10000) | 
   MERGE (d:Day {day: i})
 )');
-        } catch (ConnectException $e) {
+        } catch (ConnectionTimeoutException $e) {
             $newTime = microtime(true);
 
             $this->assertEqualsWithDelta(1.5, $newTime - $time, 0.2);
@@ -62,7 +62,7 @@ public function testSecondsTimeout(string $alias): void
   MERGE (d:Day {day: i})
 )');
             $this->fail('No timeout error triggered');
-        } catch (ConnectException $e) {
+        } catch (ConnectionTimeoutException $e) {
             $newTime = microtime(true);
 
             $this->assertEqualsWithDelta(1.0, $newTime - $time, 0.2);
@@ -86,7 +86,7 @@ public function testTimeoutRecoverAndReset(string $alias): void
                 MERGE (d:Day {day: i})
             )');
             $this->fail('No timeout error triggered');
-        } catch (ConnectException $e) {
+        } catch (ConnectionTimeoutException $e) {
             $newTime = microtime(true);
 
             $this->assertEqualsWithDelta(1.0, $newTime - $time, 0.2);
@@ -110,7 +110,7 @@ public function testTimeoutRecoverAndReset(string $alias): void
                 MERGE (d:Day {day: i})
             )');
             $this->fail('No timeout error triggered');
-        } catch (ConnectException $e) {
+        } catch (ConnectionTimeoutException $e) {
             $newTime = microtime(true);
 
             $this->assertEqualsWithDelta(1.0, $newTime - $time, 0.2);