Merge branch 'main' into transaction-commit-bug

Author: transistive

composer.json

@@ -53,7 +53,8 @@
         "vlucas/phpdotenv": "^5.0",
         "psr/container": "^1.1",
         "lctrs/psalm-psr-container-plugin": "^1.3",
-        "symfony/uid": "^5.0"
+        "symfony/uid": "^5.0",
+        "symfony/var-dumper": "^5.0"
     },
     "autoload": {
         "psr-4": {

src/Bolt/Session.php

@@ -160,7 +160,9 @@ private function beginInstantTransaction(
     private function acquireConnection(TransactionConfiguration $config, SessionConfiguration $sessionConfig): BoltConnection
     {
         $connection = $this->pool->acquire($this->uri, $this->auth, $sessionConfig);
-        $connection->setTimeout($config->getTimeout());
+        // We try and let the server do the timeout management.
+        // Since the client should not run indefinitely, we just multiply the client side by two, just in case
+        $connection->setTimeout($config->getTimeout() * 2);
 
         return $connection;
     }

src/Types/AbstractCypherSequence.php

@@ -16,10 +16,12 @@
 use function array_key_exists;
 use function array_reverse;
 use ArrayAccess;
+use ArrayIterator;
 use BadMethodCallException;
 use function call_user_func;
 use function count;
 use Countable;
+use function get_object_vars;
 use function implode;
 use const INF;
 use function is_array;
@@ -533,4 +535,16 @@ protected function isStringable($key): bool
     {
         return is_string($key) || is_numeric($key) || (is_object($key) && method_exists($key, '__toString'));
     }
+
+    public function __serialize(): array
+    {
+        $this->preload();
+
+        $tbr = get_object_vars($this);
+        $tbr['generator'] = new ArrayIterator($this->cache);
+        $tbr['currentPosition'] = 0;
+        $tbr['generatorPosition'] = 0;
+
+        return $tbr;
+    }
 }

tests/Integration/ComplexQueryTest.php

@@ -376,6 +376,52 @@ public function testLongQueryUnmanaged(string $alias): void
         $tsx->run('CALL apoc.util.sleep(10000)');
     }
 
+    /**
+     * @dataProvider connectionAliases
+     */
+    public function testSimpleTimeout(string $alias): void
+    {
+        if (str_starts_with($alias, 'http')) {
+            self::markTestSkipped('Http does not support timeouts at the moment');
+        }
+
+        try {
+            $this->getClient()
+                ->getDriver($alias)
+                ->createSession()
+                ->run(
+                    "MATCH (n:Node) SET n.testing = 'hello' WITH * CALL apoc.util.sleep(2000000)",
+                    [],
+                    TransactionConfiguration::default()->withTimeout(10)
+                );
+        } catch (Neo4jException $e) {
+            self::assertEquals('Neo.ClientError.Transaction.TransactionTimedOut', $e->getNeo4jCode());
+        }
+    }
+
+    /**
+     * @dataProvider connectionAliases
+     */
+    public function testDiscardAfterTimeout(string $alias): void
+    {
+        if (str_starts_with($alias, 'http')) {
+            self::markTestSkipped('Http does not support timeouts at the moment');
+        }
+
+        $this->expectException(Neo4jException::class);
+
+        $result = $this->getClient()
+            ->getDriver($alias)
+            ->createSession()
+            ->run(
+                "MATCH (n:Node) SET n.testing = 'hello' WITH * CALL apoc.util.sleep(2000000)",
+                [],
+                TransactionConfiguration::default()->withTimeout(150)
+            );
+
+        unset($result);
+    }
+
     /**
      * @dataProvider connectionAliases
      */

tests/Integration/SummarizedResultFormatterTest.php

@@ -14,6 +14,7 @@
 namespace Laudis\Neo4j\Tests\Integration;
 
 use function bin2hex;
+use function dump;
 use Exception;
 use Laudis\Neo4j\Contracts\FormatterInterface;
 use Laudis\Neo4j\Contracts\TransactionInterface;
@@ -23,6 +24,8 @@
 use Laudis\Neo4j\Types\CypherList;
 use Laudis\Neo4j\Types\CypherMap;
 use function random_bytes;
+use function serialize;
+use function unserialize;
 
 /**
  * @psalm-import-type OGMTypes from \Laudis\Neo4j\Formatter\OGMFormatter
@@ -82,4 +85,30 @@ public function testGetResults(string $alias): void
         self::assertInstanceOf(CypherMap::class, $first);
         self::assertEquals(1, $first->get('one'));
     }
+
+    /**
+     * @dataProvider connectionAliases
+     */
+    public function testSerialize(string $alias): void
+    {
+        $results = $this->getClient()->run('RETURN 1 AS one', [], $alias);
+
+        $serialise = serialize($results);
+        $resultHasBeenSerialized = unserialize($serialise);
+
+        self::assertInstanceOf(SummarizedResult::class, $resultHasBeenSerialized);
+        self::assertEquals($results->toRecursiveArray(), $resultHasBeenSerialized->toRecursiveArray());
+    }
+
+    /**
+     * @dataProvider connectionAliases
+     *
+     * @doesNotPerformAssertions
+     */
+    public function testDump(string $alias): void
+    {
+        $results = $this->getClient()->run('RETURN 1 AS one', [], $alias);
+
+        dump($results);
+    }
 }

tests/Integration/TransactionIntegrationTest.php

@@ -21,6 +21,7 @@
 use Laudis\Neo4j\Formatter\BasicFormatter;
 use ReflectionClass;
 use function str_starts_with;
+use Throwable;
 
 /**
  * @psalm-import-type BasicResults from \Laudis\Neo4j\Formatter\BasicFormatter
@@ -308,7 +309,7 @@ public function testCommitInvalid(string $alias): void
         $exception = false;
         try {
             $tsx->commit();
-        } catch (Neo4jException $e) {
+        } catch (Throwable $e) {
             $exception = true;
         }
         self::assertTrue($exception);
@@ -354,7 +355,7 @@ public function testRollbackInvalid(string $alias): void
         $exception = false;
         try {
             $tsx->rollback();
-        } catch (Neo4jException $e) {
+        } catch (Throwable $e) {
             $exception = true;
         }
         self::assertTrue($exception);