Backport #1075, #1065 and #952 + type fixes for PHP 8

Author: ezimuel

docs/per-request-configuration.asciidoc

@@ -214,6 +214,28 @@ Array
 )
 ----
 
+=== Request Identification
+
+You can enrich your requests against Elasticsearch with an identifier string, that allows you to discover this identifier
+in https://www.elastic.co/guide/en/elasticsearch/reference/6.8/logging.html#deprecation-logging[deprecation logs], to support you with
+https://www.elastic.co/guide/en/elasticsearch/reference/6.8/index-modules-slowlog.html[identifying search slow log origin]
+or to help with https://www.elastic.co/guide/en/elasticsearch/reference/6.8/tasks.html#_identifying_running_tasks[identifying running tasks].
+
+
+[source,php]
+----
+$client = ClientBuilder::create()->build();
+$params = [
+    'index' => 'test',
+    'id'    => 1,
+    'client' => [
+        'opaqueId' => '[email protected]_user1234', <1>
+    ]
+];
+$response = $client->get($params);
+----
+<1> This will populate the `X-Opaque-Id` header with the value `[email protected]_user1234`
+
 === Curl Timeouts
 
 It is possible to configure per-request curl timeouts via the `timeout` and `connect_timeout` parameters.  These

src/Elasticsearch/ClientBuilder.php

@@ -35,6 +35,9 @@
 use GuzzleHttp\Ring\Client\Middleware;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
+use ReflectionClass;
+
+use function filter_var;
 
 /**
  * Class ClientBuilder
@@ -512,7 +515,11 @@ public function build()
 
             $this->endpoint = function ($class) use ($serializer) {
                 $fullPath = '\\Elasticsearch\\Endpoints\\' . $class;
-                if ($class === 'Bulk' || $class === 'Msearch' || $class === 'MsearchTemplate' || $class === 'MPercolate') {
+                
+                $reflection = new ReflectionClass($fullPath);
+                $constructor = $reflection->getConstructor();
+
+                if ($constructor && $constructor->getParameters()) {
                     return new $fullPath($serializer);
                 } else {
                     return new $fullPath();
@@ -576,7 +583,7 @@ private function buildTransport()
         }
 
         if (is_null($this->transport)) {
-            $this->transport = new Transport($this->retries, $this->sniffOnStart, $this->connectionPool, $this->logger);
+            $this->transport = new Transport($this->retries, $this->connectionPool, $this->logger, $this->sniffOnStart);
         }
     }
 

src/Elasticsearch/Connections/Connection.php

@@ -175,14 +175,17 @@ public function performRequest($method, $uri, $params = null, $body = null, $opt
             $body = $this->serializer->serialize($body);
         }
 
+        $headers = $this->headers;
+        if (isset($options['client']['headers']) && is_array($options['client']['headers'])) {
+            $headers = array_merge($this->headers, $options['client']['headers']);
+        }
+
         $request = [
             'http_method' => $method,
             'scheme'      => $this->transportSchema,
             'uri'         => $this->getURI($uri, $params),
             'body'        => $body,
-            'headers'     => array_merge([
-                'Host'  => [$this->host]
-            ], $this->headers)
+            'headers'     => array_merge(['Host' => [$this->host]], $headers)
         ];
 
         $request = array_replace_recursive($request, $this->connectionParams, $options);
@@ -333,16 +336,20 @@ private function wrapHandler(callable $handler)
      *
      * @return string
      */
-    private function getURI(string $uri, ?array $params)
+    private function getURI(string $uri, ?array $params): string
     {
         if (isset($params) === true && !empty($params)) {
-            array_walk($params, function (&$value, &$key) {
-                if ($value === true) {
-                    $value = 'true';
-                } elseif ($value === false) {
-                    $value = 'false';
-                }
-            });
+            $params = array_map(
+                function ($value) {
+                    if ($value === true) {
+                        return 'true';
+                    } elseif ($value === false) {
+                        return 'false';
+                    }
+                    return $value;
+                },
+                $params
+            );
 
             $uri .= '?' . http_build_query($params);
         }
@@ -351,7 +358,7 @@ private function getURI(string $uri, ?array $params)
             $uri = $this->path . $uri;
         }
 
-        return $uri;
+        return $uri ?? '';
     }
 
     /**

src/Elasticsearch/Connections/ConnectionInterface.php

@@ -112,6 +112,6 @@ public function getLastRequestInfo();
      */
 	// @codingStandardsIgnoreStart
 	// "Arguments with default values must be at the end of the argument list" - cannot change the interface
-    public function performRequest($method, $uri, $params = null, $body = null, $options = [], Transport $transport);
+    public function performRequest(string $method, string $uri, ?array $params = [], $body = null, array $options = [], Transport $transport = null);
 	// @codingStandardsIgnoreEnd
 }

src/Elasticsearch/Transport.php

@@ -61,7 +61,7 @@ class Transport
      */
 	// @codingStandardsIgnoreStart
 	// "Arguments with default values must be at the end of the argument list" - cannot change the interface
-    public function __construct($retries, $sniffOnStart = false, AbstractConnectionPool $connectionPool, LoggerInterface $log)
+    public function __construct(int $retries, AbstractConnectionPool $connectionPool, LoggerInterface $log, bool $sniffOnStart = false)
     {
 	    // @codingStandardsIgnoreEnd
 

tests/Elasticsearch/Tests/Connections/ConnectionTest.php

@@ -19,6 +19,7 @@
 use Elasticsearch\ClientBuilder;
 use Elasticsearch\Connections\Connection;
 use Elasticsearch\Serializers\SerializerInterface;
+use Elasticsearch\Serializers\SmartSerializer;
 use Psr\Log\LoggerInterface;
 
 class ConnectionTest extends \PHPUnit\Framework\TestCase
@@ -91,4 +92,65 @@ public function testUserAgentHeaderIsSent()
         $this->assertArrayHasKey('User-Agent', $request['headers']);
         $this->assertStringContainsString('elasticsearch-php/'. Client::VERSION, $request['headers']['User-Agent'][0]);
     }
+
+    /**
+     * @depends testGetHeadersContainUserAgent
+     *
+     * @covers \Connection::performRequest
+     * @covers \Connection::getURI
+     */
+    public function testParametersAreSent()
+    {
+        $connectionParams = [];
+        $host = [
+            'host' => 'localhost'
+        ];
+        $requestParams = [
+            'foo' => true,
+            'baz' => false,
+            'bar' => 'baz'
+        ];
+
+        $connection = new Connection(
+            ClientBuilder::defaultHandler(),
+            $host,
+            $connectionParams,
+            $this->serializer,
+            $this->logger,
+            $this->trace
+        );
+        $result  = $connection->performRequest('GET', '/', $requestParams);
+        $request = $connection->getLastRequestInfo()['request'];
+
+        $this->assertEquals('/?foo=true&baz=false&bar=baz', $request['uri']);
+    }
+
+    public function testHeaderClientParamIsResetAfterSent()
+    {
+        $host = [
+            'host' => 'localhost'
+        ];
+
+        $connection = new Connection(
+            ClientBuilder::defaultHandler(),
+            $host,
+            [],
+            new SmartSerializer(),
+            $this->logger,
+            $this->trace
+        );
+
+        $options = [
+            'client' => [
+                'headers' => [
+                    'Foo' => [ 'Bar' ]
+                ]
+            ]
+        ];
+
+        $headersBefore = $connection->getHeaders();
+        $result = $connection->performRequest('GET', '/', null, null, $options);
+        $headersAfter = $connection->getHeaders();
+        $this->assertEquals($headersBefore, $headersAfter);
+    }
 }

util/template/test/warnings

@@ -3,5 +3,5 @@
         $this->assertTrue(isset($headers['Warning']));
         $expectedHeaders = :expected;
         foreach ($expectedHeaders as $expected) {
-            $this->assertStringContainsString($expected, $headers['Warning'][0]);
+            $this->assertStringContainsString($expected, implode('', $headers['Warning']));
         }