Testkit

.github/workflows/testkit.yml

@@ -0,0 +1,80 @@
+name: Testkit Tests
+
+on:
+  push:
+    branches: [ '**' ]
+  pull_request:
+    branches: ['**']
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    name: "Running Testkit tests for PHP ${{matrix.php-version}} on Neo4j and testkit ${{ matrix.neo4j-version }} with simple config"
+    strategy:
+      fail-fast: false
+      matrix:
+        neo4j-version: ["3.5", "4.0", "4.1", "4.2", "4.3"]
+        php-version: ["7.4", "8.0", "8.1"]
+
+    services:
+      neo4j:
+        image: neo4j:${{ matrix.neo4j-version }}
+        env:
+          NEO4J_AUTH: neo4j/test
+          NEO4JLABS_PLUGINS: '["apoc"]'
+        ports:
+          - 7687:7687
+          - 7474:7474
+        options: >-
+          --health-cmd "wget http://localhost:7474 || exit 1"
+
+    steps:
+      - name: Checkout driver
+        uses: actions/checkout@v2
+
+      - uses: php-actions/composer@v6
+        with:
+          progress: yes
+          php_version: ${{ matrix.php-version }}
+          version: 2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+
+      - name: Checkout TestKit (testing tool)
+        uses: actions/checkout@v2
+        with:
+          repository: neo4j-drivers/testkit
+          path: testkit
+          ref: '4.3'
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          # install docker
+          sudo apt-get install \
+            apt-transport-https \
+            ca-certificates \
+            curl \
+            gnupg \
+            lsb-release
+          # Python (needed for dummy driver and TestKit)
+          sudo apt-get install python3 python3-pip
+          git clone https://github.com/pyenv/pyenv.git .pyenv
+          python -m pip install --upgrade pip
+          cd testkit
+          python -m pip install -r requirements.txt
+
+      - name: Run TestKit
+        env:
+          TEST_NEO4J_HOST: localhost
+          TEST_NEO4J_USER: neo4j
+          TEST_NEO4J_PASS: test
+          TEST_DRIVER_NAME: php
+        run: |
+          php testkit-backend/index.php &
+          cd testkit
+          sleep 2
+          python3 -m unittest -v "tests.neo4j.test_authentication.TestAuthenticationBasic"

README.md

@@ -119,7 +119,7 @@ Auto committed queries are the most straightforward and most intuitive but have
 ```php
 $client->run(
     'MERGE (user {email: $email})', //The query is a required parameter
-    ['email' => '[email protected]'],  //Parameters can be optionally added
+    ['email' => '[email protected]'],  //Requests can be optionally added
     'backup' //The default connection can be overridden
 );
 ```

composer.json

@@ -31,7 +31,7 @@
         "psr/http-client": "^1.0",
         "php-http/message": "^1.0",
         "php-http/message-factory": "^1.0",
-        "stefanak-michal/bolt": "^2.5.2",
+        "stefanak-michal/bolt": "^2.5.3",
         "symfony/polyfill-php80": "^1.2",
         "ext-json": "*"
     },
@@ -47,7 +47,13 @@
         "vimeo/psalm": "^4.13.0",
         "friendsofphp/php-cs-fixer": "3.0.2",
         "psalm/plugin-phpunit": "^0.15.1",
-        "vlucas/phpdotenv": "^5.0"
+        "monolog/monolog": "^2.2",
+        "psr/log": "^1.1",
+        "php-di/php-di": "^6.3",
+        "vlucas/phpdotenv": "^5.0",
+        "psr/container": "^1.1",
+        "lctrs/psalm-psr-container-plugin": "^1.3",
+        "symfony/uid": "^5.0"
     },
     "autoload": {
         "psr-4": {
@@ -56,7 +62,8 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Laudis\\Neo4j\\Tests\\": "tests/"
+            "Laudis\\Neo4j\\Tests\\": "tests/",
+            "Laudis\\Neo4j\\TestkitBackend\\": "testkit-backend/src"
         }
     },
     "minimum-stability": "stable"

docker-compose.yml

@@ -41,6 +41,22 @@ services:
             - 9000
         env_file:
           - .env
+    testkit-backend:
+        build:
+            context: .
+            dockerfile: Dockerfile
+            args:
+                - WITH_XDEBUG=true
+        working_dir: /opt/project
+        volumes:
+            - .:/opt/project
+        command: php /opt/project/testkit-backend/index.php
+        networks:
+          - neo4j
+        depends_on:
+          - neo4j
+        ports:
+          - "9876:9876"
     neo4j:
         networks:
             - neo4j

psalm.xml

@@ -12,7 +12,8 @@
 >
     <projectFiles>
         <directory name="src"/>
-        <directory ignoreTypeStats="true" name="tests"/>
+        <directory name="tests"/>
+        <directory name="testkit-backend"/>
         <ignoreFiles>
             <directory name="vendor"/>
         </ignoreFiles>
@@ -52,11 +53,17 @@
                 <directory name="tests"/>
             </errorLevel>
         </MissingConstructor>
+        <UncaughtThrowInGlobalScope>
+            <errorLevel type="suppress">
+                <file name="testkit-backend/index.php"/>
+            </errorLevel>
+        </UncaughtThrowInGlobalScope>
     </issueHandlers>
     <stubs>
         <file name="./vendor/vimeo/psalm/stubs/ext-ds.phpstub"/>
     </stubs>
     <plugins>
         <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>
+        <pluginClass class="Lctrs\PsalmPsrContainerPlugin\Plugin"/>
     </plugins>
 </psalm>

src/Authentication/BasicAuth.php

@@ -15,8 +15,12 @@
 
 use function base64_encode;
 use Bolt\Bolt;
+use Bolt\error\MessageException;
 use Exception;
+use Laudis\Neo4j\Common\TransactionHelper;
 use Laudis\Neo4j\Contracts\AuthenticateInterface;
+use Laudis\Neo4j\Databags\Neo4jError;
+use Laudis\Neo4j\Exception\Neo4jException;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\UriInterface;
 
@@ -58,7 +62,12 @@ public function authenticateHttp(RequestInterface $request, UriInterface $uri, s
      */
     public function authenticateBolt(Bolt $bolt, UriInterface $uri, string $userAgent): void
     {
-        $bolt->init($userAgent, $this->username, $this->password);
+        try {
+            $bolt->init($userAgent, $this->username, $this->password);
+        } catch (MessageException $e) {
+            $code = TransactionHelper::extractCode($e) ?? '';
+            throw new Neo4jException([new Neo4jError($code, $e->getMessage())]);
+        }
     }
 
     /**

src/Bolt/BoltConfiguration.php

@@ -15,6 +15,7 @@
 
 use function call_user_func;
 use function is_callable;
+use function is_string;
 use Laudis\Neo4j\Client;
 use Laudis\Neo4j\Contracts\ConfigInterface;
 

src/Bolt/BoltConnectionPool.php

@@ -64,6 +64,8 @@ public function acquire(
             if (!$connection->isOpen()) {
                 $connection->open();
 
+                $authenticate->authenticateBolt($connection->getImplementation(), $connectingTo, $userAgent);
+
                 return $connection;
             }
         }

src/Client.php

@@ -140,15 +140,7 @@ public function verifyConnectivity(?string $driver = null): bool
      */
     private function decideAlias(?string $alias): string
     {
-        if ($alias !== null) {
-            return $alias;
-        }
-
-        if ($this->default !== null) {
-            return $this->default;
-        }
-
-        return array_key_first($this->drivers);
+        return $alias ?? $this->default ?? array_key_first($this->drivers);
     }
 
     /**

src/Contracts/SessionInterface.php

@@ -13,6 +13,7 @@
 
 namespace Laudis\Neo4j\Contracts;
 
+use Laudis\Neo4j\Databags\Bookmark;
 use Laudis\Neo4j\Databags\Statement;
 use Laudis\Neo4j\Databags\TransactionConfiguration;
 use Laudis\Neo4j\Exception\Neo4jException;
@@ -95,4 +96,6 @@ public function readTransaction(callable $tsxHandler, ?TransactionConfiguration
      * @return HandlerResult
      */
     public function transaction(callable $tsxHandler, ?TransactionConfiguration $config = null);
+
+//    public function getLastBookmark(): Bookmark;
 }

src/Databags/Bookmark.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Laudis Neo4j package.
+ *
+ * (c) Laudis technologies <http://laudis.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\Databags;
+
+use function bin2hex;
+use Exception;
+use function random_bytes;
+use function substr;
+
+final class Bookmark
+{
+    /** @var list<string> */
+    private array $bookmarks;
+
+    /**
+     * @param list<string> $bookmarks
+     */
+    public function __construct(?array $bookmarks = null)
+    {
+        $this->bookmarks = $bookmarks ?? [];
+    }
+
+    public function isEmpty(): bool
+    {
+        return count($this->bookmarks) === 0;
+    }
+
+    /**
+     * @return list<string>
+     */
+    public function values(): array
+    {
+        return $this->bookmarks;
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function withIncrement(?string $bookmark = null): self
+    {
+        $copy = $this->bookmarks;
+        if ($bookmark === null) {
+            $bookmark = $this->generateUuidV4();
+        }
+        $copy[] = $bookmark;
+
+        return new self($copy);
+    }
+
+    /**
+     * @throws Exception
+     */
+    private function generateUuidV4(): string
+    {
+        $uuid = random_bytes(16);
+        $uuid[6] = ((int) $uuid[6]) & 0x0F | 0x40;
+        $uuid[8] = ((int) $uuid[8]) & 0x3F | 0x80;
+        $uuid = bin2hex($uuid);
+
+        return substr($uuid, 0, 8).'-'
+            .substr($uuid, 8, 4).'-'
+            .substr($uuid, 12, 4).'-'
+            .substr($uuid, 16, 4).'-'
+            .substr($uuid, 20, 12);
+    }
+}

src/Databags/BookmarkHolder.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Laudis Neo4j package.
+ *
+ * (c) Laudis technologies <http://laudis.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\Databags;
+
+final class BookmarkHolder
+{
+    private Bookmark $bookmark;
+
+    public function __construct(?Bookmark $bookmark = null)
+    {
+        $this->bookmark = $bookmark ?? new Bookmark();
+    }
+
+    public function getBookmark(): Bookmark
+    {
+        return $this->bookmark;
+    }
+
+    public function setBookmark(Bookmark $bookmark): void
+    {
+        $this->bookmark = $bookmark;
+    }
+}

src/Databags/SessionConfiguration.php

@@ -138,6 +138,7 @@ public function getAccessMode(): AccessMode
     {
         $accessMode = is_callable($this->accessMode) ? call_user_func($this->accessMode) : $this->accessMode;
 
+        /** @psalm-suppress ImpureMethodCall */
         return $accessMode ?? AccessMode::WRITE();
     }