Merge remote-tracking branch 'origin/main' into Psalm

Author: Pratiksha

.gitignore

@@ -13,3 +13,5 @@ test
 #PHP-CS-FIXER
 .php-cs-fixer.php
 .php-cs-fixer.cache
+
+

src/OGM.php

@@ -13,7 +13,7 @@
 class OGM
 {
     /**
-     * @param array{'$type': string, '_value': mixed} $object
+     * @param array{'$type': string, ' $object _value': mixed} $object
      * @return mixed
      */
     public function map(array $object): mixed
@@ -43,7 +43,7 @@ public static function parseWKT(string $wkt): Point
         $srid = (int)str_replace('SRID=', '', $sridPart);
 
         $pointPart = substr($wkt, strpos($wkt, 'POINT') + 6);
-        if (strpos($pointPart, 'Z') !== false) {
+        if (str_contains($pointPart, 'Z')) {
             $pointPart = str_replace('Z', '', $pointPart);
         }
         $pointPart = trim($pointPart, ' ()');
@@ -67,8 +67,8 @@ public static function parseWKT(string $wkt): Point
     private function mapNode(array $nodeData): Node
     {
         return new Node(
-            $nodeData['_labels'], // Labels of the node
-            $this->mapProperties($nodeData['_properties']) // Mapped properties
+            $nodeData['_labels'],
+            $this->mapProperties($nodeData['_properties'])
         );
     }
 

src/Transaction.php

@@ -2,6 +2,7 @@
 
 namespace Neo4j\QueryAPI;
 
+use GuzzleHttp\Exception\GuzzleException;
 use Neo4j\QueryAPI\Exception\Neo4jException;
 use Neo4j\QueryAPI\Objects\Authentication;
 use Neo4j\QueryAPI\Objects\Bookmarks;
@@ -25,11 +26,11 @@ public function __construct(
 
     /**
      * Execute a Cypher query within the transaction.
-     * @api
      * @param string $query The Cypher query to be executed.
      * @param array $parameters Parameters for the query.
      * @return ResultSet The result rows in ResultSet format.
-     * @throws Neo4jException If the response structure is invalid.
+     * @throws Neo4jException|GuzzleException If the response structure is invalid.
+     *@api
      */
     public function run(string $query, array $parameters): ResultSet
     {

tests/Integration/Neo4jQueryAPIIntegrationTest.php

@@ -87,6 +87,7 @@ public function testProfileExistence(): void
 
     public function testProfileCreateQueryExistence(): void
     {
+
         $query = "
     PROFILE UNWIND range(1, 100) AS i
     CREATE (:Person {
@@ -188,14 +189,16 @@ public function testProfileCreateKnowsBidirectionalRelationshipsMock(): void
 
         $handler = HandlerStack::create($mockSack);
         $client = new Client(['handler' => $handler]);
-
-        $auth = Authentication::basic(getenv("NEO4J_USERNAME"), getenv("NEO4J_PASSWORD"));
+        $auth = Authentication::fromEnvironment();
         $api = new Neo4jQueryAPI($client, $auth);
+
         $result = $api->run($query);
 
         $plan = $result->getProfiledQueryPlan();
         $this->assertNotNull($plan, "The result of the query should not be null.");
+
         $expected = require __DIR__ . '/../resources/expected/complex-query-profile.php';
+
         $this->assertEquals($expected->getProfiledQueryPlan(), $plan, "Profiled query plan does not match the expected value.");
     }
 
@@ -227,9 +230,6 @@ public function testChildQueryPlanExistence(): void
     }
 
 
-
-
-
     /**
      * @throws GuzzleException
      */

tests/Integration/Neo4jTransactionIntegrationTest.php

@@ -56,6 +56,7 @@ private function populateTestData(): void
     }
     public function testTransactionCommit(): void
     {
+
         $tsx = $this->api->beginTransaction();
 
         $name = (string)mt_rand(1, 100000);

tests/Unit/Neo4jRequestFactoryTest.php

@@ -10,6 +10,7 @@
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Utils;
 use Neo4j\QueryAPI\Neo4jRequestFactory;
+use Neo4j\QueryAPI\Objects\Authentication;
 
 /**
  *  @api
@@ -18,8 +19,8 @@ class Neo4jRequestFactoryTest extends TestCase
 {
     private $psr17Factory;
     private $streamFactory;
-    private string $baseUri = 'https://6f72daa1.databases.neo4j.io';
-    private string $authHeader = 'Basic dXNlcjpwYXNzd29yZA==';
+    private string $address;
+    private string $authHeader;
 
     /**
      * @throws Exception
@@ -28,6 +29,11 @@ protected function setUp(): void
     {
         $this->psr17Factory = $this->createMock(RequestFactoryInterface::class);
         $this->streamFactory = $this->createMock(StreamFactoryInterface::class);
+
+        $this->address = getenv('NEO4J_ADDRESS');
+
+        $auth = Authentication::fromEnvironment();
+        $this->authHeader = $auth->getHeader();
     }
 
     /**
@@ -39,21 +45,16 @@ public function testBuildRunQueryRequest()
         $parameters = ['param1' => 'value1'];
         $database = 'neo4j';
 
-
         $payload = json_encode([
             'statement' => $cypher,
             'parameters' => $parameters,
             'includeCounters' => true,
         ]);
-        $uri = "{$this->baseUri}/db/{$database}/query/v2";
-
+        $uri = "{$this->address}/db/{$database}/query/v2";
 
         $mockRequest = new Request('POST', $uri);
-
-
         $mockStream = Utils::streamFor($payload);
 
-
         $this->streamFactory->method('createStream')
             ->willReturn($mockStream);
 
@@ -63,7 +64,7 @@ public function testBuildRunQueryRequest()
         $factory = new Neo4jRequestFactory(
             $this->psr17Factory,
             $this->streamFactory,
-            $this->baseUri,
+            $this->address,
             $this->authHeader
         );
         $request = $factory->buildRunQueryRequest($database, $cypher, $parameters);
@@ -79,7 +80,7 @@ public function testBuildRunQueryRequest()
     public function testBuildBeginTransactionRequest()
     {
         $database = 'neo4j';
-        $uri = "{$this->baseUri}/db/{$database}/query/v2/tx";
+        $uri = "{$this->address}/db/{$database}/query/v2/tx";
 
         $mockRequest = new Request('POST', $uri);
         $mockStream = Utils::streamFor('');
@@ -93,9 +94,10 @@ public function testBuildBeginTransactionRequest()
         $factory = new Neo4jRequestFactory(
             $this->psr17Factory,
             $this->streamFactory,
-            $this->baseUri
+            $this->address
         );
         $request = $factory->buildBeginTransactionRequest($database);
+
         $this->assertEquals('POST', $request->getMethod());
         $this->assertEquals($uri, (string) $request->getUri());
     }
@@ -107,7 +109,7 @@ public function testBuildCommitRequest()
     {
         $database = 'neo4j';
         $transactionId = '12345';
-        $uri = "{$this->baseUri}/db/{$database}/query/v2/tx/{$transactionId}/commit";
+        $uri = "{$this->address}/db/{$database}/query/v2/tx/{$transactionId}/commit";
 
         $mockRequest = new Request('POST', $uri);
         $mockStream = Utils::streamFor('');
@@ -121,7 +123,7 @@ public function testBuildCommitRequest()
         $factory = new Neo4jRequestFactory(
             $this->psr17Factory,
             $this->streamFactory,
-            $this->baseUri
+            $this->address
         );
         $request = $factory->buildCommitRequest($database, $transactionId);
 
@@ -136,7 +138,7 @@ public function testBuildRollbackRequest()
     {
         $database = 'neo4j';
         $transactionId = '12345';
-        $uri = "{$this->baseUri}/db/{$database}/query/v2/tx/{$transactionId}/rollback";
+        $uri = "{$this->address}/db/{$database}/query/v2/tx/{$transactionId}/rollback";
 
         $mockRequest = new Request('POST', $uri);
         $mockStream = Utils::streamFor('');
@@ -150,7 +152,7 @@ public function testBuildRollbackRequest()
         $factory = new Neo4jRequestFactory(
             $this->psr17Factory,
             $this->streamFactory,
-            $this->baseUri
+            $this->address
         );
         $request = $factory->buildRollbackRequest($database, $transactionId);
 
@@ -159,14 +161,15 @@ public function testBuildRollbackRequest()
     }
 
     /**
-     * Test for the createRequest method (Private method should be tested indirectly through other public methods)
+     * Test for createRequest method with headers and body
      */
     public function testCreateRequestWithHeadersAndBody()
     {
         $cypher = 'MATCH (n) RETURN n';
         $parameters = ['param1' => 'value1'];
         $database = 'neo4j';
-        $uri = "{$this->baseUri}/db/{$database}/query/v2";
+        $uri = "{$this->address}/db/{$database}/query/v2";
+
         $payload = json_encode([
             'statement' => $cypher,
             'parameters' => $parameters,
@@ -184,7 +187,7 @@ public function testCreateRequestWithHeadersAndBody()
         $factory = new Neo4jRequestFactory(
             $this->psr17Factory,
             $this->streamFactory,
-            $this->baseUri,
+            $this->address,
             $this->authHeader
         );
 
@@ -196,13 +199,16 @@ public function testCreateRequestWithHeadersAndBody()
         $this->assertJsonStringEqualsJsonString($payload, (string) $request->getBody());
     }
 
-
+    /**
+     * Test createRequest without Authorization header
+     */
     public function testCreateRequestWithoutAuthorizationHeader()
     {
         $cypher = 'MATCH (n) RETURN n';
         $parameters = ['param1' => 'value1'];
         $database = 'neo4j';
-        $uri = "{$this->baseUri}/db/{$database}/query/v2";
+        $uri = "{$this->address}/db/{$database}/query/v2";
+
         $payload = json_encode([
             'statement' => $cypher,
             'parameters' => $parameters,
@@ -220,15 +226,14 @@ public function testCreateRequestWithoutAuthorizationHeader()
         $factory = new Neo4jRequestFactory(
             $this->psr17Factory,
             $this->streamFactory,
-            $this->baseUri
+            $this->address
         );
 
         $request = $factory->buildRunQueryRequest($database, $cypher, $parameters);
 
         $this->assertEquals('application/json', $request->getHeaderLine('Content-Type'));
         $this->assertEquals('application/json', $request->getHeaderLine('Accept'));
         $this->assertEmpty($request->getHeaderLine('Authorization'));
-
         $this->assertJsonStringEqualsJsonString($payload, (string) $request->getBody());
     }
 }