Elasticsearch ^8.0 support

composer.json

@@ -13,7 +13,7 @@
  "keywords": ["Laravel", "Scout", "Elasticsearch", "Elastic", "search", "Explorer"],
  "require": {
  "php": "8.0.*||8.1.*||8.2.*||8.3.*",
- "elasticsearch/elasticsearch": "^7.16",
+ "elasticsearch/elasticsearch": "^8.0",
  "illuminate/support": "^9.0||^10.0||^11.0",
  "laravel/scout": "^9.0||^10.0||^11.0",
  "webmozart/assert": "^1.10",
@@ -47,7 +47,8 @@
  },
  "config": {
  "allow-plugins": {
- "infection/extension-installer": false
+ "infection/extension-installer": false,
+ "php-http/discovery": true
  }
  }
 }

config/explorer.php

@@ -3,15 +3,16 @@
 declare(strict_types=1);
 
 return [
- /*
- * There are different options for the connection. Since Explorer uses the Elasticsearch PHP SDK
- * under the hood, all the host configuration options of the SDK are applicable here. See
- * https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/configuration.html
+ /**
+ * This now follows the same updated configuration options as the official Elasticsearch PHP SDK.
+ * https://www.elastic.co/guide/en/elasticsearch/client/php-api/8.13/node_pool.html#config-hash
  */
  'connection' => [
- 'host' => 'localhost',
- 'port' => '9200',
- 'scheme' => 'http',
+ 'ElasticCloudId' => 'YOUR_ELASTIC_CLOUD_ID',
+ 'ApiKey' => [
+ 'apiKey' => 'YOUR_API_KEY',
+ 'id' => 'YOUR_API_KEY_ID',
+ ],
  ],
 
  /**

docs/connection.md

@@ -3,15 +3,15 @@
 Explorer connects to ElasticSearch through the PHP ElasticSearch client and has several options to configure a connection.
 The connection configuration is defined `config/explorer.php`. 
 
+See * https://www.elastic.co/guide/en/elasticsearch/client/php-api/8.13/node_pool.html#config-hash
+
 ## Basic
 
 The most basic connection is with http without authorization.
 ```php
  return [
  'connection' => [
- 'host' => 'localhost',
- 'port' => '9200',
- 'scheme' => 'http',
+ 'Hosts' => ['localhost:9200'],
  ],
  ];
 ```
@@ -22,7 +22,22 @@ Another connection option is to use an elastic cloud id as shown below
 ```php
  return [
  'connection' => [
- 'elasticCloudId' => 'staging:dXMtZWFzdC0xLmF3cy5mb3VuZC5pbyRjZWM2ZjI2MWE3NGJmMjRjZTMzYmI4ODExYjg0Mjk0ZiRjNmMyY2E2ZDA0MjI0OWFmMGNjN2Q3YTllOTYyNTc0Mw',
+ 'ElasticCloudId' => 'staging:dXMtZWFzdC03LmF3cy5mb3VuZC5pbyRjZWM2ZjI2MWE3SGJmMjRjZvMzYmI4ODExYjg0Mjk0ZiRjNmMyY2E2ZDA0MjI0OWFmMGNjN2Q3YTllOTYyNTc0Mw',
+ ],
+ ];
+```
+
+## * *Preferred Method* - Encoded API key and id
+
+Replace the auth part with API and give it your encoded id and key.
+
+```php
+ return [
+ 'connection' => [
+ 'ElasticCloudId' => 'staging:dXMtZWFzdC03LmF3cy5mb3VuZC5pbyRjZWM2ZjI2MWE3SGJmMjRjZvMzYmI4ODExYjg0Mjk0ZiRjNmMyY2E2ZDA0MjI0OWFmMGNjN2Q3YTllOTYyNTc0Mw',
+ 'ApiKey' => [
+ 'apiKey' => 'myEncodedKeyAndID'
+ ],
  ],
  ];
 ```
@@ -34,34 +49,27 @@ To specify a username and password use the `auth` key with a `username` and a `p
 ```php
  return [
  'connection' => [
- 'host' => 'localhost',
- 'port' => '9200',
- 'scheme' => 'http',
- 'auth' => [
+ 'Hosts' => ['localhost:9200'],
+ 'BasicAuthentication' => [
  'username' => 'myName',
  'password' => 'myPassword'
  ],
  ],
  ];
 ```
 
-## API key
-
-Replace the auth part with API and give it your key and id.
+## API key and id
 
 ```php
  return [
  'connection' => [
- 'host' => 'localhost',
- 'port' => '9200',
- 'scheme' => 'http',
- 'api' => [
+ 'Hosts' => ['localhost:9200'],
+ 'ApiKey' => [
  'id' => 'myId',
- 'key' => 'myKey'
+ 'apiKey' => 'myKey'
  ],
  ],
  ];
-```
 
 ## Verify TLS with CA
 
@@ -73,12 +81,8 @@ From Elastic 8 and upwards TLS is becoming the default, even in development. Thi
 ```php
  return [
  'connection' => [
- 'host' => 'localhost',
- 'port' => '9200',
- 'scheme' => 'http',
- 'ssl' => [
- 'verify' => './path/to/ca.crt',
- ],
+ 'Hosts' => ['localhost:9200'],
+ 'CABundle' => './path/to/ca.crt',
  ],
  ];
 ```
@@ -87,12 +91,8 @@ To disable TLS verification set it to `false`. **NOT recommended for production*
 ```php
  return [
  'connection' => [
- 'host' => 'localhost',
- 'port' => '9200',
- 'scheme' => 'http',
- 'ssl' => [
- 'verify' => false,
- ],
+ 'Hosts' => ['localhost:9200'],
+ 'SSLVerification' => false,
  ],
  ];
 ```
@@ -101,12 +101,14 @@ To disable TLS verification set it to `false`. **NOT recommended for production*
 ```
  return [
  'connection' => [
- 'host' => 'localhost',
- 'port' => '9200',
- 'scheme' => 'https',
- 'ssl' => [
- 'cert' => ['path/to/cert.pem', 'passphrase'],
- 'key' => ['path/to/key.pem', 'passphrase'],
+ 'Hosts' => ['localhost:9200'],
+ 'SSLCert' => [
+ 'cert' => './path/to/cert.crt',
+ 'password' => null,
+ ],
+ 'SSLKey' => [
+ 'key' => './path/to/key.key',
+ password' => null,
  ],
  ],
  ];
@@ -117,29 +119,11 @@ To disable TLS verification set it to `false`. **NOT recommended for production*
 Elastic can also have multiple possible connections
 
 ```php
- use Elasticsearch\ConnectionPool\Selectors\RoundRobinSelector;
-
+
  return [
  'connection' => [
- 'host' => 'localhost',
- 'port' => '9200',
- 'scheme' => 'http',
- 'ssl' => [
- 'verify' => false,
- ],
- 'selector' => RoundRobinSelector::class
- ],
- 'additionalConnections' => [
- [
- 'host' => 'localhost',
- 'port' => '9201',
- 'scheme' => 'http',
- ],
- [
- 'host' => 'localhost',
- 'port' => '9202',
- 'scheme' => 'http',
- ]
+ 'Hosts' => ['host1:9200', 'host2:9200'],
+ 'SSLVerification' => true,
  ],
  ];
 ```

phpstan-baseline.neon

@@ -10,11 +10,6 @@ parameters:
  count: 1
  path: src/Infrastructure/Console/ElasticSearch.php
 
- -
- message: "#^Call to an undefined method JeroenG\\\\Explorer\\\\Domain\\\\IndexManagement\\\\IndexConfigurationInterface\\:\\:getAliasConfiguration\\(\\)\\.$#"
- count: 1
- path: src/Infrastructure/Elastic/ElasticIndexAdapter.php
-
  -
  message: "#^Call to an undefined method JeroenG\\\\Explorer\\\\Domain\\\\IndexManagement\\\\IndexConfigurationInterface\\:\\:getAliasConfiguration\\(\\)\\.$#"
  count: 2

src/Application/IndexAdapterInterface.php

@@ -4,6 +4,7 @@
 
 namespace JeroenG\Explorer\Application;
 
+use JeroenG\Explorer\Domain\IndexManagement\AliasedIndexConfiguration;
 use JeroenG\Explorer\Domain\IndexManagement\IndexConfigurationInterface;
 
 interface IndexAdapterInterface
@@ -16,7 +17,7 @@ public function delete(IndexConfigurationInterface $indexConfiguration): void;
 
  public function flush(string $index): void;
 
- public function createNewWriteIndex(IndexConfigurationInterface $indexConfiguration): string;
+ public function createNewWriteIndex(AliasedIndexConfiguration $indexConfiguration): string;
 
  public function ensureIndex(IndexConfigurationInterface $indexConfiguration): void;
 }

src/Application/Results.php

@@ -5,14 +5,15 @@
 namespace JeroenG\Explorer\Application;
 
 use Countable;
+use Elastic\Elasticsearch\Response\Elasticsearch;
 
 class Results implements Countable
 {
  private array $rawResults;
 
- public function __construct(array $rawResults)
+ public function __construct(array|Elasticsearch $rawResults)
  {
- $this->rawResults = $rawResults;
+ $this->rawResults = is_array($rawResults) ? $rawResults : $rawResults->asArray();
  }
 
  public function hits(): array

src/ExplorerServiceProvider.php

@@ -4,20 +4,17 @@
 
 namespace JeroenG\Explorer;
 
-use Elasticsearch\Client;
+use Elastic\Elasticsearch\ClientBuilder;
+use Elastic\Elasticsearch\Client;
 use Illuminate\Foundation\Application;
 use Illuminate\Support\ServiceProvider;
 use JeroenG\Explorer\Application\DocumentAdapterInterface;
 use JeroenG\Explorer\Application\IndexAdapterInterface;
-use JeroenG\Explorer\Domain\Aggregations\AggregationSyntaxInterface;
 use JeroenG\Explorer\Domain\IndexManagement\IndexConfigurationRepositoryInterface;
 use JeroenG\Explorer\Infrastructure\Console\ElasticSearch;
 use JeroenG\Explorer\Infrastructure\Console\ElasticUpdate;
-use JeroenG\Explorer\Infrastructure\Elastic\ElasticClientFactory;
-use JeroenG\Explorer\Infrastructure\Elastic\ElasticClientBuilder;
 use JeroenG\Explorer\Infrastructure\Elastic\ElasticDocumentAdapter;
 use JeroenG\Explorer\Infrastructure\Elastic\ElasticIndexAdapter;
-use JeroenG\Explorer\Infrastructure\IndexManagement\ElasticIndexChangedChecker;
 use JeroenG\Explorer\Infrastructure\IndexManagement\ElasticIndexConfigurationRepository;
 use JeroenG\Explorer\Infrastructure\Scout\Builder;
 use JeroenG\Explorer\Infrastructure\Scout\ElasticEngine;
@@ -48,13 +45,11 @@ public function boot(): void
  $this->bootForConsole();
  }
 
- $this->app->when(ElasticClientFactory::class)
- ->needs(Client::class)
- ->give(static fn () => ElasticClientBuilder::fromConfig(config())->build());
-
- $this->app->when(ElasticDocumentAdapter::class)
- ->needs(Client::class)
- ->give(static fn (Application $app) => $app->make(ElasticClientFactory::class)->client());
+ // Removed the old client builder and factory in favor of the native elastic client builder for simplicity
+ // This if statement allows the user to define their own client implementation outside of this package
+ if (!$this->app->has(Client::class)) {
+ $this->app->singleton(Client::class, fn (Application $app) => ClientBuilder::fromConfig(config('explorer.connection')));
+ }
 
  $this->app->when(ElasticIndexConfigurationRepository::class)
  ->needs('$indexConfigurations')
@@ -94,8 +89,8 @@ protected function bootForConsole(): void
  ], 'explorer.config');
 
  $this->commands([
-  ElasticSearch::class,
-  ElasticUpdate::class,
-  ]);
+ ElasticSearch::class,
+ ElasticUpdate::class,
+ ]);
  }
 }