feat: added disconnect functionality

Author: Deploy

docs/arangodb-client.md

@@ -66,8 +66,28 @@ Send a request to ArangoDB's HTTP REST API. This is mostly for internal use but
 $arangoClient->request(
     'get',
      '/_api/version', 
-    'query' => [
-        'details' => $details
+     [
+        'query' => [
+            'details' => $details
+        ]
+    ]
+]);
+```
+
+### rawRequest(string $method, string $uri, array|HttpRequestOptions $options = []): ResponseInterface|null
+Returns the raw response of the request. 
+*Note* that the request itself is made against the configured endpoint but the databasename is _not_ automatically 
+prepended to the uri as opposed to a regular request.
+
+
+```
+$arangoClient->rawRequest(
+    'get',
+     '/_api/version', 
+     [
+        'query' => [
+            'details' => $details
+        ]
     ]
 ]);
 ```
@@ -106,4 +126,12 @@ $arangoClient->schema()->createCollection('users');
 Pass chained method to the admin manager.
 ```
 $arangoClient->admin()->getVersion();
+```
+
+### disconnect(): bool
+Disconnect from the current keep-alive connection, if any.
+*Note* that a disconnect request is sent to the database upon destruction of the arangoClient object as well.
+
+```
+$arangoClient->disconnect();
 ```

src/ArangoClient.php

@@ -50,6 +50,42 @@ public function __construct(array $config = [], ?GuzzleClient $httpClient = null
         $this->httpClient = $httpClient ?? new GuzzleClient($this->config->mapGuzzleHttpClientConfig());
     }
 
+    public function __destruct()
+    {
+        $this->disconnect();
+    }
+
+    public function disconnect(): bool
+    {
+        $config = $this->getConfig();
+
+        if ($config['connection'] !== 'Keep-Alive') {
+            return true;
+        }
+
+        $response = $this->rawRequest(
+            'HEAD',
+            '/_api/version',
+            [
+                'headers' => [
+                    'Connection' => 'close',
+                ],
+            ],
+        );
+
+        if ($response === null) {
+            return false;
+        }
+
+        $connection = $response->getHeader('Connection');
+        if (reset($connection) !== 'Close') {
+            return false;
+        }
+
+        return true;
+    }
+
+
     /**
      * @param  array<mixed>  $config
      */
@@ -58,10 +94,12 @@ public function generateEndpoint(array $config): string
         if (isset($config['endpoint'])) {
             return (string) $config['endpoint'];
         }
+
         $endpoint = 'http://localhost:8529';
         if (isset($config['host'])) {
             $endpoint = (string) $config['host'];
         }
+
         if (isset($config['port'])) {
             $endpoint .= ':' . (string) $config['port'];
         }
@@ -96,6 +134,28 @@ public function request(string $method, string $uri, array|HttpRequestOptions $o
         return new stdClass();
     }
 
+    /**
+     * @param  array<mixed>|HttpRequestOptions  $options
+     *
+     * @throws ArangoException
+     */
+    public function rawRequest(string $method, string $uri, array|HttpRequestOptions $options = []): ResponseInterface|null
+    {
+        if (is_array($options)) {
+            $options = $this->prepareRequestOptions($options);
+        }
+
+        $response = null;
+        try {
+            $response = $this->httpClient->request($method, $uri, $options->all());
+        } catch (Throwable $e) {
+            $this->handleGuzzleException($e);
+        }
+
+        return $response;
+    }
+
+
     /**
      * @param  array<mixed>  $options
      *

tests/ArangoClientTest.php

@@ -4,14 +4,18 @@
 
 use ArangoClient\Admin\AdminManager;
 use ArangoClient\ArangoClient;
+use ArangoClient\Http\HttpClientConfig;
 use ArangoClient\Schema\SchemaManager;
 use ArangoClient\Statement\Statement;
 use GuzzleHttp\Client;
+use GuzzleHttp\Client as GuzzleClient;
 use GuzzleHttp\Handler\MockHandler;
 use GuzzleHttp\HandlerStack;
 use GuzzleHttp\Middleware;
 use GuzzleHttp\Psr7\Response;
 
+use function PHPUnit\Framework\assertTrue;
+
 uses(Tests\TestCase::class);
 
 test('get config', function () {
@@ -46,21 +50,21 @@
 test('client with host port config', function () {
     $config = [
         'host' => 'http://127.0.0.1',
-        'port' => '1234',
+        'port' => '8529',
         'username' => 'root',
     ];
     $client = new ArangoClient($config);
     $retrievedConfig = $client->getConfig();
 
-    expect($retrievedConfig['endpoint'])->toEqual('http://127.0.0.1:1234');
+    expect($retrievedConfig['endpoint'])->toEqual('http://127.0.0.1:8529');
 });
 
 test('config with alien properties', function () {
     $config = [
         'name' => 'arangodb',
         'driver' => 'arangodb',
         'host' => 'http://127.0.0.1',
-        'port' => '1234',
+        'port' => '8529',
         'username' => 'root',
     ];
     $client = new ArangoClient($config);
@@ -73,8 +77,26 @@
 test('set and get http client', function () {
     $oldClient = $this->arangoClient->getHttpClient();
 
-    $newClient = Mockery::mock(Client::class);
+    $defaultConfig = [
+        'endpoint' => 'http://localhost:8529',
+        'host' => null,
+        'port' => null,
+        'version' => 1.1,
+        'connection' => 'Keep-Alive',
+        'allow_redirects' => false,
+        'connect_timeout' => 0.0,
+        'username' => 'root',
+        'password' => null,
+        'database' => $this->testDatabaseName,
+        'jsonStreamDecoderThreshold' => 1048576,
+    ];
+
+    $config = new HttpClientConfig($defaultConfig);
+
+    $newClient = new GuzzleClient($config->mapGuzzleHttpClientConfig());
+
     $this->arangoClient->setHttpClient($newClient);
+
     $retrievedClient = $this->arangoClient->getHttpClient();
 
     expect($oldClient)->toBeInstanceOf(Client::class);
@@ -103,10 +125,13 @@
 
     $database = $this->arangoClient->getDatabase();
     expect($database)->toBe($newDatabaseName);
+
+    // Reset DB name
+    $this->arangoClient->setDatabase($this->testDatabaseName);
 });
 
 test('database name is used in requests', function () {
-    $database = 'some_database';
+    $database = 'arangodb_php_client__test';
     if (!$this->arangoClient->schema()->hasDatabase($database)) {
         $this->arangoClient->schema()->createDatabase($database);
     }
@@ -234,3 +259,9 @@
 
     $this->schemaManager->deleteCollection($collection);
 });
+
+test('disconnect', function () {
+    $disconnected = $this->arangoClient->disconnect();
+
+    assertTrue($disconnected);
+});