Skip to content

Commit 80321ad

Browse files
kimpepperkimpepper
committed
Add Client factories for Guzzle and Symfony
Signed-off-by: Kim Pepper <[email protected]>
1 parent d35ea28 commit 80321ad

12 files changed

+200
-151
lines changed

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
44

55
## [Unreleased]
66
### Added
7+
- Added Guzzle and Symfony client factories.
78
### Changed
89
### Deprecated
910
### Removed

‎UPGRADING.md

+18-63
Original file line numberDiff line numberDiff line change
@@ -16,95 +16,50 @@ openseach-php removes the hard-coded dependency on the [Guzzle HTTP client](http
1616

1717
You can continue to use Guzzle, but will need to configure it as a PSR-18 HTTP Client.
1818

19-
### HTTP Client Auto-Discovery
19+
### PSR-18 HTTP Client Interfaces
2020

21-
opensearch-php 2.x will try and discover and install a PSR HTTP Client using [PHP-HTTP Discovery](https://docs.php-http.org/en/latest/discovery.html)
22-
if one is not explicitly provided.
21+
Starting with `opensearch-php` 2.4.0 you can use any PSR-18 compatible HTTP client.
2322

24-
```php
25-
$transport = (new \OpenSearch\TransportFactory())->create();
26-
$endpointFactory = new \OpenSearch\EndpointFactory();
27-
$client = new Client($transport, $endpointFactory, []);
28-
29-
// Send a request to the 'info' endpoint.
30-
$info = $client->info();
31-
```
23+
To simplify creating a Client, we provide two factories to create PSR-18 HTTP clients
24+
for Guzzle and Symfony HTTP clients.
3225

33-
### Configuring Guzzle HTTP Client in 2.x
26+
### Configuring Guzzle HTTP Client in 2.4.x
3427

3528
To configure Guzzle as a PSR HTTP Client with the similar configuration to opensearch 1.x you can use the following example:
3629

30+
Ensure the Guzzle packages are installed via composer:
31+
3732
```php
38-
$guzzleClient = new \GuzzleHttp\Client([
33+
composer require guzzlehttp/guzzle
34+
```
35+
36+
```php
37+
$client = (new \OpenSearch\GuzzleClientFactory())->create([
3938
'base_uri' => 'https://localhost:9200',
4039
'auth' => ['admin', getenv('OPENSEARCH_PASSWORD')],
4140
'verify' => false,
42-
'retries' => 2,
43-
'headers' => [
44-
'Accept' => 'application/json',
45-
'Content-Type' => 'application/json',
46-
'User-Agent' => sprintf('opensearch-php/%s (%s; PHP %s)', \OpenSearch\Client::VERSION, PHP_OS, PHP_VERSION),
47-
]
4841
]);
4942

50-
$guzzleHttpFactory = new \GuzzleHttp\Psr7\HttpFactory();
51-
52-
$serializer = new \OpenSearch\Serializers\SmartSerializer();
53-
54-
$requestFactory = new \OpenSearch\RequestFactory(
55-
$guzzleHttpFactory,
56-
$guzzleHttpFactory,
57-
$guzzleHttpFactory,
58-
$serializer,
59-
);
60-
61-
$transport = (new OpenSearch\TransportFactory())
62-
->setHttpClient($guzzleClient)
63-
->setRequestFactory($requestFactory)
64-
->create();
65-
66-
$endpointFactory = new \OpenSearch\EndpointFactory();
67-
$client = new \OpenSearch\Client($transport, $endpointFactory, []);
68-
6943
// Send a request to the 'info' endpoint.
7044
$info = $client->info();
7145
```
7246

73-
### Configuring Symfony HTTP Client in 2.x
47+
### Configuring Symfony HTTP Client in 2.4.x
7448

7549
You can configure [Symfony HTTP Client](https://symfony.com/doc/current/http_client.html) as a PSR HTTP Client using
7650
the following example:
7751

7852
```php
79-
$symfonyPsr18Client = (new \Symfony\Component\HttpClient\Psr18Client())->withOptions([
53+
composer require symfony/http-client
54+
```
55+
56+
```php
57+
$client = (new \OpenSearch\SymfonyClientFactory())->create([
8058
'base_uri' => 'https://localhost:9200',
8159
'auth_basic' => ['admin', getenv('OPENSEARCH_PASSWORD')],
8260
'verify_peer' => false,
83-
'max_retries' => 2,
84-
'headers' => [
85-
'Accept' => 'application/json',
86-
'Content-Type' => 'application/json',
87-
],
8861
]);
8962

90-
$serializer = new \OpenSearch\Serializers\SmartSerializer();
91-
92-
$requestFactory = new \OpenSearch\RequestFactory(
93-
$symfonyPsr18Client,
94-
$symfonyPsr18Client,
95-
$symfonyPsr18Client,
96-
$serializer,
97-
);
98-
99-
$transport = (new \OpenSearch\TransportFactory())
100-
->setHttpClient($symfonyPsr18Client)
101-
->setRequestFactory($requestFactory)
102-
->create();
103-
104-
$endpointFactory = new \OpenSearch\EndpointFactory();
105-
$client = new \OpenSearch\Client($transport, $endpointFactory, []);
106-
10763
// Send a request to the 'info' endpoint.
10864
$info = $client->info();
109-
11065
```

‎samples/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Start an OpenSearch instance.
44

55
```
6-
docker run -d -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" -e "OPENSEARCH_INITIAL_ADMIN_PASSWORD=myStrongPassword123!" opensearchproject/opensearch:latest
6+
docker compose up
77
```
88

99
Run sample.

‎samples/index.php

+4-64
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
11
<?php
22

3-
use GuzzleHttp\Psr7\HttpFactory;
4-
use OpenSearch\Client;
5-
use OpenSearch\EndpointFactory;
6-
use OpenSearch\RequestFactory;
7-
use OpenSearch\Serializers\SmartSerializer;
8-
use OpenSearch\TransportFactory;
9-
use Symfony\Component\HttpClient\Psr18Client;
3+
use OpenSearch\GuzzleClientFactory;
4+
use OpenSearch\SymfonyClientFactory;
105

116
/**
127
* Copyright OpenSearch Contributors
@@ -15,79 +10,24 @@
1510

1611
require_once __DIR__ . '/vendor/autoload.php';
1712

18-
// Auto-configure by discovery example
19-
20-
$transport = (new TransportFactory())->create();
21-
$endpointFactory = new EndpointFactory();
22-
$client = new Client($transport, $endpointFactory, []);
23-
24-
// Send a request to the 'info' endpoint.
25-
$info = $client->info();
26-
2713
// Guzzle example
2814

29-
$guzzleClient = new \GuzzleHttp\Client([
15+
$client = (new GuzzleClientFactory())->create([
3016
'base_uri' => 'https://localhost:9200',
3117
'auth' => ['admin', getenv('OPENSEARCH_PASSWORD')],
3218
'verify' => false,
33-
'retries' => 2,
34-
'headers' => [
35-
'Accept' => 'application/json',
36-
'Content-Type' => 'application/json',
37-
'User-Agent' => sprintf('opensearch-php/%s (%s; PHP %s)', Client::VERSION, PHP_OS, PHP_VERSION),
38-
]
3919
]);
4020

41-
$guzzleHttpFactory = new HttpFactory();
42-
43-
$serializer = new SmartSerializer();
44-
45-
$requestFactory = new RequestFactory(
46-
$guzzleHttpFactory,
47-
$guzzleHttpFactory,
48-
$guzzleHttpFactory,
49-
$serializer,
50-
);
51-
52-
$transport = (new TransportFactory())
53-
->setHttpClient($guzzleClient)
54-
->setRequestFactory($requestFactory)
55-
->create();
56-
57-
$endpointFactory = new EndpointFactory();
58-
$client = new Client($transport, $endpointFactory, []);
59-
6021
// Send a request to the 'info' endpoint.
6122
$info = $client->info();
6223

6324
// Symfony example
6425

65-
$symfonyPsr18Client = (new Psr18Client())->withOptions([
26+
$client = (new SymfonyClientFactory())->create([
6627
'base_uri' => 'https://localhost:9200',
6728
'auth_basic' => ['admin', getenv('OPENSEARCH_PASSWORD')],
6829
'verify_peer' => false,
69-
'max_retries' => 2,
70-
'headers' => [
71-
'Accept' => 'application/json',
72-
'Content-Type' => 'application/json',
73-
],
7430
]);
7531

76-
$serializer = new SmartSerializer();
77-
78-
$requestFactory = new RequestFactory(
79-
$symfonyPsr18Client,
80-
$symfonyPsr18Client,
81-
$symfonyPsr18Client,
82-
$serializer,
83-
);
84-
85-
$transport = (new TransportFactory())
86-
->setHttpClient($symfonyPsr18Client)
87-
->setRequestFactory($requestFactory)
88-
->create();
89-
90-
$client = new Client($transport, $endpointFactory, []);
91-
9232
// Send a request to the 'info' endpoint.
9333
$info = $client->info();

‎src/OpenSearch/ClientFactory.php

-19
This file was deleted.

‎src/OpenSearch/ClientFactoryInterface.php

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?php
2+
3+
namespace OpenSearch;
4+
5+
/**
6+
* Creates an OpenSearch client.
7+
*/
8+
interface ClientFactoryInterface
9+
{
10+
/**
11+
* Creates a new OpenSearch client.
12+
*
13+
* @param array<string,mixed> $options
14+
* The options to use when creating the client. The options are specific to the HTTP client implementation.
15+
*/
16+
public function create(array $options): Client;
17+
}

‎src/OpenSearch/GuzzleClientFactory.php

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace OpenSearch;
6+
7+
use OpenSearch\HttpClient\GuzzleHttpClientFactory;
8+
use Psr\Log\LoggerInterface;
9+
use GuzzleHttp\Psr7\HttpFactory;
10+
use OpenSearch\Serializers\SmartSerializer;
11+
12+
/**
13+
* Creates an OpenSearch client using Guzzle.
14+
*/
15+
class GuzzleClientFactory implements ClientFactoryInterface
16+
{
17+
public function __construct(
18+
protected int $maxRetries = 0,
19+
protected ?LoggerInterface $logger = null,
20+
) {
21+
}
22+
23+
/**
24+
* @param array<string,mixed> $options
25+
* The Guzzle client options.
26+
*/
27+
public function create(array $options): Client
28+
{
29+
$httpClient = (new GuzzleHttpClientFactory($this->maxRetries, $this->logger))->create($options);
30+
$httpFactory = new HttpFactory();
31+
32+
$serializer = new SmartSerializer();
33+
34+
$requestFactory = new RequestFactory(
35+
$httpFactory,
36+
$httpFactory,
37+
$httpFactory,
38+
$serializer,
39+
);
40+
41+
$transport = (new TransportFactory())
42+
->setHttpClient($httpClient)
43+
->setRequestFactory($requestFactory)
44+
->create();
45+
46+
return new Client($transport, new EndpointFactory($serializer), []);
47+
}
48+
}

‎src/OpenSearch/HttpClient/GuzzleHttpClientFactory.php

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
use GuzzleHttp\HandlerStack;
99
use GuzzleHttp\Middleware;
1010
use OpenSearch\Client;
11-
use Psr\Http\Client\ClientInterface;
1211
use Psr\Log\LoggerInterface;
1312

1413
/**
@@ -25,7 +24,7 @@ public function __construct(
2524
/**
2625
* {@inheritdoc}
2726
*/
28-
public function create(array $options): ClientInterface
27+
public function create(array $options): GuzzleClient
2928
{
3029
if (!isset($options['base_uri'])) {
3130
throw new \InvalidArgumentException('The base_uri option is required.');

‎src/OpenSearch/HttpClient/SymfonyHttpClientFactory.php

+1-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
namespace OpenSearch\HttpClient;
66

77
use OpenSearch\Client;
8-
use Psr\Http\Client\ClientInterface;
98
use Psr\Log\LoggerInterface;
109
use Symfony\Component\HttpClient\HttpClient;
1110
use Symfony\Component\HttpClient\Psr18Client;
@@ -25,7 +24,7 @@ public function __construct(
2524
/**
2625
* {@inheritdoc}
2726
*/
28-
public function create(array $options): ClientInterface
27+
public function create(array $options): Psr18Client
2928
{
3029
if (!isset($options['base_uri'])) {
3130
throw new \InvalidArgumentException('The base_uri option is required.');

‎src/OpenSearch/SymfonyClientFactory.php

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?php
2+
3+
namespace OpenSearch;
4+
5+
use OpenSearch\HttpClient\SymfonyHttpClientFactory;
6+
use OpenSearch\Serializers\SmartSerializer;
7+
use Psr\Log\LoggerInterface;
8+
9+
/**
10+
* Creates an OpenSearch client using Symfony HTTP Client.
11+
*/
12+
class SymfonyClientFactory implements ClientFactoryInterface
13+
{
14+
public function __construct(
15+
protected int $maxRetries = 0,
16+
protected ?LoggerInterface $logger = null,
17+
) {
18+
}
19+
20+
/**
21+
* Creates a new OpenSearch client using Symfony HTTP Client.
22+
*
23+
* @param array<string,mixed> $options
24+
* The Symfony HTTP Client options.
25+
*/
26+
public function create(array $options): Client
27+
{
28+
$httpClient = (new SymfonyHttpClientFactory($this->maxRetries, $this->logger))->create($options);
29+
30+
$serializer = new SmartSerializer();
31+
32+
$requestFactory = new RequestFactory(
33+
$httpClient,
34+
$httpClient,
35+
$httpClient,
36+
$serializer,
37+
);
38+
39+
$transport = (new TransportFactory())
40+
->setHttpClient($httpClient)
41+
->setRequestFactory($requestFactory)
42+
->create();
43+
44+
$endpointFactory = new EndpointFactory();
45+
return new Client($transport, $endpointFactory, []);
46+
}
47+
}

0 commit comments

Comments
 (0)