Added X-Opaque-Id support

Author: ezimuel

src/Elasticsearch/Endpoints/AbstractEndpoint.php

@@ -57,17 +57,17 @@ abstract class AbstractEndpoint
     /**
      * @return string[]
      */
-    abstract public function getParamWhitelist();
+    abstract public function getParamWhitelist(): array;
 
     /**
      * @return string
      */
-    abstract public function getURI();
+    abstract public function getURI(): string;
 
     /**
      * @return string
      */
-    abstract public function getMethod();
+    abstract public function getMethod(): string;
 
 
     /**
@@ -82,9 +82,9 @@ public function setParams($params)
             $params = (array) $params;
         }
 
+        $this->extractOptions($params);
         $this->checkUserParams($params);
         $params = $this->convertCustom($params);
-        $this->extractOptions($params);
         $this->params = $this->convertArraysToStrings($params);
 
         return $this;
@@ -243,7 +243,7 @@ private function checkUserParams($params)
             return; //no params, just return.
         }
 
-        $whitelist = array_merge($this->getParamWhitelist(), array('client', 'custom', 'filter_path', 'human'));
+        $whitelist = array_merge($this->getParamWhitelist(), array('client', 'custom', 'filter_path', 'human', 'opaqueId'));
 
         $invalid = array_diff(array_keys($params), $whitelist);
         if (count($invalid) > 0) {
@@ -264,6 +264,15 @@ private function extractOptions(&$params)
     {
         // Extract out client options, then start transforming
         if (isset($params['client']) === true) {
+            // Check if the opaqueId is populated and add the header
+            if (isset($params['client']['opaqueId']) === true) {
+                if (isset($params['client']['headers']) === false) {
+                    $params['client']['headers'] = [];
+                }
+                $params['client']['headers']['x-opaque-id'] = [trim($params['client']['opaqueId'])];
+                unset($params['client']['opaqueId']);
+            }
+
             $this->options['client'] = $params['client'];
             unset($params['client']);
         }

tests/Elasticsearch/Tests/Endpoints/AbstractEndpointTest.php

@@ -50,4 +50,22 @@ protected function setUp(): void
     {
         $this->endpoint = $this->getMockForAbstractClass(AbstractEndpoint::class);
     }
+
+    /**
+     * @covers AbstractEndpoint::setParams
+     * @covers AbstractEndpoint::extractOptions
+     * @covers AbstractEndpoint::getOptions
+     */
+    public function testOpaqueIdInHeaders()
+    {
+        $params = ['client' => ['opaqueId' => 'test_id_' . rand(1000, 9999)]];
+        $this->endpoint->setParams($params);
+
+        $options = $this->endpoint->getOptions();
+        $this->assertArrayHasKey('client', $options);
+        $this->assertArrayHasKey('headers', $options['client']);
+        $this->assertArrayHasKey('x-opaque-id', $options['client']['headers']);
+        $this->assertNotEmpty($options['client']['headers']['x-opaque-id']);
+        $this->assertEquals($params['client']['opaqueId'], $options['client']['headers']['x-opaque-id'][0]);
+    }
 }