accessmode parameter is added, tests are created

Author: 123kiran17

src/Neo4jQueryAPI.php

@@ -6,6 +6,7 @@
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\GuzzleException;
 use GuzzleHttp\Exception\RequestException;
+use InvalidArgumentException;
 use Neo4j\QueryAPI\Objects\ChildQueryPlan;
 use Neo4j\QueryAPI\Objects\QueryArguments;
 use Neo4j\QueryAPI\Objects\ResultCounters;
@@ -52,23 +53,40 @@ public static function login(string $address, string $username, string $password
      * @throws RequestExceptionInterface
      * @api
      */
-    public function run(string $cypher, array $parameters = [], string $database = 'neo4j', Bookmarks $bookmark = null): ResultSet
+    public function run(string $cypher, array $parameters = [], string $database = 'neo4j', Bookmarks $bookmark = null, ?string $impersonatedUser = null, string $accessMode = 'WRITE' ): ResultSet
     {
+        $validAccessModes = ['READ', 'WRITE', 'ROUTE'];
+        if (!in_array(strtoupper($accessMode), $validAccessModes, true)) {
+            throw new InvalidArgumentException("Invalid access mode: $accessMode. Allowed values are 'READ', 'WRITE', or 'ROUTE'.");
+        }
         try {
             $payload = [
                 'statement' => $cypher,
                 'parameters' => empty($parameters) ? new stdClass() : $parameters,
                 'includeCounters' => true,
+                'routing' => strtoupper($accessMode)
             ];
+            error_log("Request Payload: " . json_encode($payload));
 
             if ($bookmark !== null) {
                 $payload['bookmarks'] = $bookmark->getBookmarks();
             }
+            if ($impersonatedUser !== null) {
+                $payload['impersonatedUser'] = $impersonatedUser;
+            }
+
+//
+
 
             $response = $this->client->post('/db/' . $database . '/query/v2', [
                 'json' => $payload,
+
             ]);
 
+//            if ($response->getStatusCode() !== 200) {
+//                throw new Neo4jException("Failed to run query: " . $response->getReasonPhrase());
+//            }
+
             $data = json_decode($response->getBody()->getContents(), true);
             $ogm = new OGM();
 
@@ -111,16 +129,21 @@ public function run(string $cypher, array $parameters = [], string $database = '
                 $profile
             );
         } catch (RequestExceptionInterface $e) {
+            error_log("Request Exception: " . $e->getMessage());
+
             $response = $e->getResponse();
             if ($response !== null) {
                 $contents = $response->getBody()->getContents();
-                $errorResponse = json_decode($contents, true);
+                error_log("Error Response: " . $contents);
 
-                    throw Neo4jException::fromNeo4jResponse($errorResponse, $e);
-                }
+                $errorResponse = json_decode($contents, true);
+                throw Neo4jException::fromNeo4jResponse($errorResponse, $e);
             }
-            throw new RuntimeException('Error executing query: ' . $e->getMessage(), 0, $e);
+
+            throw $e;
         }
+    }
+
 
     /**
      * @api

src/Results/ResultSet.php

@@ -22,9 +22,9 @@ class ResultSet implements IteratorAggregate, Countable
      * @param list<ResultRow> $rows
      */
     public function __construct(
-        private readonly array $rows,
-        private ResultCounters $counters,
-        private Bookmarks $bookmarks,
+        private readonly array     $rows,
+        private ResultCounters     $counters,
+        private Bookmarks          $bookmarks,
         private ?ProfiledQueryPlan $profiledQueryPlan = null
     )
     {
@@ -47,6 +47,7 @@ public function getQueryCounters(): ?ResultCounters
     {
         return $this->counters;
     }
+
     /**
      * @api
      */
@@ -71,4 +72,24 @@ public function getBookmarks(): ?Bookmarks
     {
         return $this->bookmarks;
     }
+
+    /**
+     * @api
+     */
+
+    public function testAccessMode()
+    {
+        $resultSet = new ResultSet([], null, 'WRITE');
+        $this->assertEquals('WRITE', $resultSet->getAccessMode());
+    }
+
+
+//    public function getImpersonatedUser(): ?ImpersonatedUser
+//    {
+//
+//    }
+
+
+
+
 }

tests/Integration/Neo4jQueryAPIIntegrationTest.php

@@ -13,6 +13,7 @@
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 use Neo4j\QueryAPI\Transaction;
+use Psr\Http\Message\ResponseInterface;
 
 class Neo4jQueryAPIIntegrationTest extends TestCase
 {
@@ -193,6 +194,67 @@ public function testChildQueryPlanExistence(): void
             $this->assertInstanceOf(ProfiledQueryPlan::class, $child);
         }
     }
+    public function testImpersonatedUserSuccess(): void
+    {
+
+        $result = $this->api->run(
+            "PROFILE MATCH (n:Person {name: 'Alice'}) RETURN n.name",
+            [],
+            'neo4j',
+            null,
+            'HAPPYBDAY'
+        );
+
+
+        $impersonatedUser = $result->getImpersonatedUser();
+        $this->assertNotNull($impersonatedUser, "Impersonated user should not be null.");
+
+        //A user being impersonated (ImpersonatedUser) might have other users who are being impersonated through it, forming a chain or hierarchy.
+
+    }
+
+
+    public function testImpersonatedUserFailure(): void
+    {
+        $this->expectException(Neo4jException::class);
+
+
+        $this->api->run(
+            "PROFILE MATCH (n:Person {name: 'Alice'}) RETURN n.name",
+            [],
+            'neo4j',
+            null,
+            'invalidUser'
+        );
+    }
+
+//
+
+    public function testRunWithDefaultAccessMode(): void
+    {
+        $result = $this->api->run("MATCH (n) RETURN COUNT(n)");
+
+        $this->assertInstanceOf(ResultSet::class, $result);
+        // Default mode is WRITE;
+    }
+
+    public function testRunWithAccessMode(): void
+    {
+        $result = $this->api->run(
+            "MATCH (n) RETURN COUNT(n)",
+            [],
+            'neo4j',
+            null,
+            'READ'
+        );
+
+    }
+
+
+
+
+
+
 
     public function testTransactionCommit(): void
     {