feat(connection): add client info retrieval and improved error handling

- Introduced `getClientInfo` method to retrieve Elasticsearch client information.
- Added `AuthenticationException` for better error handling during connection build.
- Configured connection name dynamically instead of hardcoding.
- Enhanced docstrings for connection validation and builder options.
- Implemented new tests for prefix handling and client info retrieval.
- Refactored existing tests to use `expect` instead of `$this->assertInstanceOf`.

Who needs a crystal ball when you have comprehensive client info? 🔮

Author: UseTheFork

src/Connection.php

@@ -6,13 +6,17 @@
 
 use Elastic\Elasticsearch\Client;
 use Elastic\Elasticsearch\ClientBuilder;
+use Elastic\Elasticsearch\Exception\AuthenticationException;
 use Illuminate\Database\Connection as BaseConnection;
 use Illuminate\Support\Str;
 use PDPhilip\Elasticsearch\DSL\Bridge;
 use PDPhilip\Elasticsearch\DSL\Results;
 use RuntimeException;
 
 use function array_replace_recursive;
+use function in_array;
+use function is_array;
+use function strtolower;
 
 /**
  * @method bool indexModify(array $settings)
@@ -71,7 +75,7 @@ class Connection extends BaseConnection
 
     protected bool $rebuild = false;
 
-    protected string $connectionName = 'elasticsearch';
+    protected string $connectionName;
 
     /**
      * @var Query\Processor
@@ -81,7 +85,6 @@ class Connection extends BaseConnection
     /** {@inheritdoc} */
     public function __construct(array $config)
     {
-
         $this->connectionName = $config['name'];
 
         $this->config = $config;
@@ -136,6 +139,16 @@ public function getIndexPrefix(): ?string
         return $this->indexPrefix;
     }
 
+    /**
+     * Retrieves information about the client.
+     *
+     * @return array An associative array containing the client's information.
+     */
+    public function getClientInfo(): array
+    {
+        return $this->client->info()->asArray();
+    }
+
     /** {@inheritdoc} */
     public function getPostProcessor(): Query\Processor
     {
@@ -172,6 +185,7 @@ public function setIndex(string $index): string
         return $this->getIndex();
     }
 
+    /** {@inheritdoc} */
     public function table($table, $as = null)
     {
         $query = new Query\Builder($this, new Query\Processor);
@@ -296,10 +310,14 @@ private function _sanitizeConfig(): void
 
     }
 
-    //----------------------------------------------------------------------
-    // Connection Builder
-    //----------------------------------------------------------------------
-
+    /**
+     * Builds and configures a connection to the ElasticSearch client based on
+     * the provided configuration settings.
+     *
+     * @return Client The configured ElasticSearch client.
+     *
+     * @throws AuthenticationException
+     */
     protected function buildConnection(): Client
     {
 
@@ -329,6 +347,11 @@ protected function buildConnection(): Client
         return $cb->build();
     }
 
+    /**
+     * Validates the connection configuration based on the specified authentication type.
+     *
+     * @throws RuntimeException if the configuration is invalid for the specified authentication type.
+     */
     private function _validateConnection(): void
     {
         if (! in_array($this->config['auth_type'], self::VALID_AUTH_TYPES)) {
@@ -339,13 +362,18 @@ private function _validateConnection(): void
             throw new RuntimeException('auth_type of `cloud` requires `cloud_id` to be set');
         }
 
-        if ($this->config['auth_type'] === 'http' && ! $this->config['hosts']) {
-            throw new RuntimeException('auth_type of `http` requires `hosts` to be set');
+        if ($this->config['auth_type'] === 'http' && (! $this->config['hosts'] || ! is_array($this->config['hosts']))) {
+            throw new RuntimeException('auth_type of `http` requires `hosts` to be set and be an array');
         }
 
     }
 
-    protected function _builderOptions($cb)
+    /**
+     * Configures and returns the client builder with the provided SSL and retry settings.
+     *
+     * @param  ClientBuilder  $cb  The callback builder instance.
+     */
+    protected function _builderOptions(ClientBuilder $cb): ClientBuilder
     {
         $cb->setSSLVerification($this->sslVerification);
         if (isset($this->elasticMetaHeader)) {

tests/ConnectionTest.php

@@ -34,7 +34,7 @@
 
   $connection->disconnect();
   $client = $connection->getClient();
-  $this->assertNull($client);
+  expect($client)->toBeNull();
   DB::purge('elasticsearch');
 
   $connection = DB::connection('elasticsearch');
@@ -46,28 +46,37 @@
 
 test('DB', function () {
   $connection = DB::connection('elasticsearch');
-  $this->assertInstanceOf(Client::class, $connection->getClient());
+  expect($connection->getClient())->toBeInstanceOf(Client::class);
 });
 
 test('Connection Without auth_type', function () {
-  $this->expectException(RuntimeException::class);
-  $this->expectExceptionMessage('Invalid [auth_type] in database config. Must be: http or cloud');
-
   new Connection(['name' => 'test']);
-});
+})->throws(RuntimeException::class, 'Invalid [auth_type] in database config. Must be: http or cloud');
 
 test('Cloud Connection Without cloud_id', function () {
   $this->expectException(RuntimeException::class);
-  $this->expectExceptionMessage('auth_type of `cloud` requires `cloud_id` to be set');
 
   new Connection(['name' => 'test', 'auth_type' => 'cloud']);
-});
+})->throws(RuntimeException::class, 'auth_type of `cloud` requires `cloud_id` to be set');
 
 test('Http Connection Without hosts', function () {
   $this->expectException(RuntimeException::class);
   $this->expectExceptionMessage('auth_type of `http` requires `hosts` to be set');
 
   new Connection(['name' => 'test', 'auth_type' => 'http']);
+})->throws(RuntimeException::class, 'auth_type of `http` requires `hosts` to be set and be an array');
+
+test('Prefix', function () {
+  $config = [
+    'name' => 'test',
+    'auth_type' => 'http',
+    'hosts' => ['http://localhost:9200'],
+    'index_prefix' => 'prefix_',
+  ];
+
+  $connection = new Connection($config);
+
+  expect($connection->getIndexPrefix())->toBe('prefix_');
 });
 
 test('Schema Builder', function () {
@@ -79,3 +88,9 @@
     $driver = DB::connection('elasticsearch')->getDriverName();
     expect($driver === 'elasticsearch')->toBeTrue();
 });
+
+test('Info', function () {
+    $info = DB::connection('elasticsearch')->getClientInfo();
+    expect($info['cluster_name'])->toBe('elasticsearch')
+                                 ->and($info['tagline'])->toBe('You Know, for Search');
+});