Merge pull request #70 from ensi-platform/v8-cloudtech-5

CLOUDTECH-5

Author: MsNatali

README.md

@@ -305,6 +305,69 @@ Hosts should be comma seperated string of hosts with protocol prefix and port su
  ELASTICSEARCH_SSL_VERIFICATION=true,
 ```
 
+## Async Usage
+
+All methods can return a `Promise`.  
+To enable this, you will need to add `http_async_client` to your config and then execute `ElasticSearch::getClient()->setAsync(true).`  
+To disable: `ElasticQuery::getClient()->setAsync(false)`.
+
+For example:
+
+laravel-elastic-query.php:
+
+```php
+return [
+    'connection' => [
+    
+        // ..
+
+        'http_async_client' => [HttpClientOptionsBuilder::class, 'getAsyncClient'],
+    ],
+];
+```
+
+HttpClientOptionsBuilder:
+
+```php
+use Http\Adapter\Guzzle7\Client as GuzzleAdapter;
+use Http\Client\HttpAsyncClient;
+
+class HttpClientOptionsBuilder
+{
+    public static function getAsyncClient(): HttpAsyncClient
+    {
+        return GuzzleAdapter::createWithConfig([]);
+    }
+}
+```
+
+Action:
+
+```php
+
+use Ensi\LaravelElasticQuery\ElasticQuery;
+
+ElasticQuery::getClient()->setAsync(true);
+
+// With async
+$promises = [
+    'key1' => FirstIndex::query()->get(),
+    'key2' => FirstIndex::suggest()->paginate(/* ... */),
+];
+
+$results = [];
+foreach ($promises as $key => $promise) {
+    $results[$key] = $promise->wait();
+}
+
+$firstResponse = $results['key1'];
+
+ElasticQuery::getClient()->setAsync(false);
+
+// Without async
+$firstResponse = FirstIndex::query()->get()
+```
+
 ## Elasticsearch 7 and 8 support.
 
 Due to the incompatibility of clients for Elasticsearch 7 and 8, separate releases will be created for these versions.

config/laravel-elastic-query.php

@@ -14,5 +14,9 @@
 
         'http_client' => null, // class implementing the \Psr\Http\Client\ClientInterface
         'http_client_options' => null, // for call_user_func_array
+
+        'http_client_logger' => null, // for call_user_func_array, return class implementing the \Psr\Log\LoggerInterface
+
+        'http_async_client' => null, // for call_user_func_array, return class implementing the \Http\Client\HttpAsyncClient
     ],
 ];

src/Aggregating/AggregationsQuery.php

@@ -7,6 +7,8 @@
 use Ensi\LaravelElasticQuery\Contracts\AggregationsBuilder;
 use Ensi\LaravelElasticQuery\Contracts\SearchIndex;
 use Ensi\LaravelElasticQuery\Filtering\BoolQueryBuilder;
+use Ensi\LaravelElasticQuery\Response;
+use Http\Promise\Promise;
 use Illuminate\Support\Collection;
 
 class AggregationsQuery implements AggregationsBuilder
@@ -29,18 +31,21 @@ public function composite(Closure $callback): static
         return $this;
     }
 
-    public function get(): Collection
+    public function get(): Collection|Promise
     {
         if ($this->aggregations->isEmpty()) {
             return new Collection();
         }
 
-        $response = $this->execute();
-
-        return $this->aggregations->parseResults($response['aggregations'] ?? []);
+        return Response::fn(
+            $this->execute(),
+            function (array $response) {
+                return $this->aggregations->parseResults($response['aggregations'] ?? []);
+            }
+        );
     }
 
-    protected function execute(): array
+    protected function execute(): array|Promise
     {
         $dsl = [
             'size' => 0,

src/Concerns/InteractsWithIndex.php

@@ -8,6 +8,7 @@
 use Ensi\LaravelElasticQuery\Search\SearchQuery;
 use Ensi\LaravelElasticQuery\Suggesting\SuggestQuery;
 use Exception;
+use Http\Promise\Promise;
 
 trait InteractsWithIndex
 {
@@ -28,50 +29,50 @@ protected function settings(): array
     /**
      * @see SearchIndex::search()
      */
-    public function search(array $dsl, ?string $searchType = null): array
+    public function search(array $dsl, ?string $searchType = null): array|Promise
     {
         return $this->resolveClient()->search($this->indexName(), $dsl, $searchType);
     }
 
     /**
      * @see SearchIndex::search()
      */
-    public function deleteByQuery(array $dsl): array
+    public function deleteByQuery(array $dsl): array|Promise
     {
         return $this->resolveClient()->deleteByQuery($this->indexName(), $dsl);
     }
 
-    public function isCreated(): bool
+    public function isCreated(): bool|Promise
     {
         return $this->resolveClient()->indicesExists($this->indexName());
     }
 
-    public function create(): void
+    public function create(): ?Promise
     {
-        $this->resolveClient()->indicesCreate($this->indexName(), $this->settings());
+        return $this->resolveClient()->indicesCreate($this->indexName(), $this->settings());
     }
 
-    public function bulk(array $body): array
+    public function bulk(array $body): array|Promise
     {
         return $this->resolveClient()->bulk($this->indexName(), $body);
     }
 
-    public function get(int|string $id): array
+    public function get(int|string $id): array|Promise
     {
         return $this->resolveClient()->get($this->indexName(), $id);
     }
 
-    public function documentDelete(int|string $id): array
+    public function documentDelete(int|string $id): array|Promise
     {
         return $this->resolveClient()->documentDelete($this->indexName(), $id);
     }
 
-    public function catIndices(string $indexName, ?array $getFields = null): array
+    public function catIndices(string $indexName, ?array $getFields = null): array|Promise
     {
         return $this->resolveClient()->catIndices($indexName, $getFields);
     }
 
-    public function indicesInfo(array $columns = ['i'], array $sort = [], ?string $health = null): array
+    public function indicesInfo(array $columns = ['i'], array $sort = [], ?string $health = null): array|Promise
     {
         return $this->resolveClient()->indicesInfo(
             indices: [$this->indexName()],
@@ -81,17 +82,17 @@ public function indicesInfo(array $columns = ['i'], array $sort = [], ?string $h
         );
     }
 
-    public function indicesDelete(string $index): array
+    public function indicesDelete(string $index): array|Promise
     {
         return $this->resolveClient()->indicesDelete($index);
     }
 
-    public function indicesRefresh(): array
+    public function indicesRefresh(): array|Promise
     {
         return $this->resolveClient()->indicesRefresh($this->indexName());
     }
 
-    public function indicesReloadSearchAnalyzers(): array
+    public function indicesReloadSearchAnalyzers(): array|Promise
     {
         return $this->resolveClient()->indicesReloadSearchAnalyzers($this->indexName());
     }

src/Contracts/SearchIndex.php

@@ -2,6 +2,8 @@
 
 namespace Ensi\LaravelElasticQuery\Contracts;
 
+use Http\Promise\Promise;
+
 interface SearchIndex
 {
     /**
@@ -16,15 +18,15 @@ public function tiebreaker(): string;
      *
      * @param array $dsl
      * @param string|null $searchType
-     * @return array
+     * @return array|Promise
      */
-    public function search(array $dsl, ?string $searchType = null): array;
+    public function search(array $dsl, ?string $searchType = null): array|Promise;
 
     /**
      * Perform delete by query.
      *
      * @param array $dsl
-     * @return array
+     * @return array|Promise
      */
-    public function deleteByQuery(array $dsl): array;
+    public function deleteByQuery(array $dsl): array|Promise;
 }