use endpoint params for opaque id support + test

Author: philkra

src/Elasticsearch/Endpoints/AbstractEndpoint.php

@@ -225,7 +225,7 @@ private function checkUserParams(array $params)
 
         $whitelist = array_merge(
             $this->getParamWhitelist(),
-            [ 'pretty', 'human', 'error_trace', 'source', 'filter_path' ]
+            [ 'pretty', 'human', 'error_trace', 'source', 'filter_path', 'opaqueId' ]
         );
 
         $invalid = array_diff(array_keys($params), $whitelist);
@@ -262,6 +262,15 @@ private function extractOptions(&$params)
                 $this->options['client']['ignore'] = [$ignore];
             }
         }
+
+        // Check if the opaqueId is populated and add the header
+        if (isset($params['opaqueId']) === true) {
+            if (isset($this->options['client']['headers']) === false) {
+                $this->options['client']['headers'] = [];
+            }
+            $this->options['client']['headers']['x-opaque-id'] = [trim($params['opaqueId'])];
+            unset($params['opaqueId']);
+        }
     }
 
     private function convertCustom(array $params): array

tests/Elasticsearch/Tests/Endpoints/AbstractEndpointTest.php

@@ -10,6 +10,11 @@ class AbstractEndpointTest extends \PHPUnit\Framework\TestCase
 {
     private $endpoint;
 
+    protected function setUp()
+    {
+        $this->endpoint = $this->getMockForAbstractClass(AbstractEndpoint::class);
+    }
+
     public static function invalidParameters(): array
     {
         return [
@@ -20,6 +25,8 @@ public static function invalidParameters(): array
 
     /**
      * @dataProvider invalidParameters
+     *
+     * @covers AbstractEndpoint::setParams
      */
     public function testInvalidParamsCauseErrorsWhenProvidedToSetParams(array $params)
     {
@@ -32,8 +39,22 @@ public function testInvalidParamsCauseErrorsWhenProvidedToSetParams(array $param
         $this->endpoint->setParams($params);
     }
 
-    protected function setUp()
+    /**
+     * @covers AbstractEndpoint::setParams
+     * @covers AbstractEndpoint::extractOptions
+     * @covers AbstractEndpoint::getOptions
+     */
+    public function testOpaqueIdInHeaders()
     {
-        $this->endpoint = $this->getMockForAbstractClass(AbstractEndpoint::class);
+        $params = ['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['opaqueId'], $options['client']['headers']['x-opaque-id'][0]);
     }
+
 }