Fix for #993, added ClientBuilder::includePortInHostHeader()

Author: ezimuel

src/Elasticsearch/ClientBuilder.php

@@ -128,6 +128,11 @@ class ClientBuilder
      */
     private $sslVerification = null;
 
+    /**
+     *  @var bool
+     */
+    private $includePortInHostHeader = false;
+
     public static function create(): ClientBuilder
     {
         return new static();
@@ -465,6 +470,18 @@ public function setSSLVerification($value = true): ClientBuilder
         return $this;
     }
 
+    /**
+     * Include the port in Host header
+     * 
+     * @see https://github.com/elastic/elasticsearch-php/issues/993
+     */
+    public function includePortInHostHeader(bool $enable): ClientBuilder
+    {
+        $this->includePortInHostHeader = $enable;
+
+        return $this;
+    }
+
     public function build(): Client
     {
         $this->buildLoggers();
@@ -505,6 +522,8 @@ public function build(): Client
             $this->serializer = new $this->serializer;
         }
 
+        $this->connectionParams['client']['port_in_header'] = $this->includePortInHostHeader;
+        
         if (is_null($this->connectionFactory)) {
             if (is_null($this->connectionParams)) {
                 $this->connectionParams = [];

src/Elasticsearch/Connections/Connection.php

@@ -168,6 +168,11 @@ public function __construct(
         }
         $port = $hostDetails['port'];
 
+        if (isset($connectionParams['client']['port_in_header']) && $connectionParams['client']['port_in_header']) {
+            if (!in_array((int) $port, [80,443])) {
+                $host .= ":$port";
+            }
+        }
         $this->host             = $host;
         $this->path             = $path;
         $this->port             = $port;
@@ -198,6 +203,7 @@ public function performRequest(string $method, string $uri, ?array $params = [],
             $this->headers = array_merge($this->headers, $options['client']['headers']);
         }
 
+        
         $request = [
             'http_method' => $method,
             'scheme'      => $this->transportSchema,

tests/Elasticsearch/Tests/ClientBuilderTest.php

@@ -70,4 +70,101 @@ public function testElasticCloudIdNotOverrideCurlEncoding()
             $this->assertNotContains('gzip', $request['request']['client']['curl']);
         }
     }
+
+    public function getHttpPorts()
+    {
+        return [
+            [ 80, false ],  // not included since 80 is standard port for HTTP
+            [ 443, false ], // not included since 442 is standard port for HTTPS
+            [ 1234, true ]  // included since 1234 is not a standard port
+        ];
+    }
+
+    /**
+     * @dataProvider getHttpPorts
+     * 
+     * @see https://github.com/elastic/elasticsearch-php/issues/993
+     */
+    public function testIncludePortInHostHeader(int $port, bool $included)
+    {
+        $host = "localhost";
+        $url = "localhost:$port";
+        $params = [
+            'client' => [
+                'verbose' => true
+            ]
+        ];
+        $client = ClientBuilder::create()
+            ->setConnectionParams($params)
+            ->setHosts([$url])
+            ->includePortInHostHeader(true)
+            ->build();
+
+        $this->assertInstanceOf(Client::class, $client);
+
+        try {
+            $result = $client->info();
+        } catch (ElasticsearchException $e) {
+            $request = $client->transport->getLastConnection()->getLastRequestInfo();
+            $this->assertTrue(isset($request['request']['headers']['Host'][0]));
+            $this->assertEquals($included ? $url : $host, $request['request']['headers']['Host'][0]);
+        }
+    }
+
+    /**
+     * @see https://github.com/elastic/elasticsearch-php/issues/993
+     */
+    public function testNotIncludeStandardPortInHostHeaderAsDefault()
+    {
+        $host = "localhost";
+        $url  = "$host:1234";
+        $params = [
+            'client' => [
+                'verbose' => true
+            ]
+        ];
+        $client = ClientBuilder::create()
+            ->setConnectionParams($params)
+            ->setHosts([$url])
+            ->build();
+
+        $this->assertInstanceOf(Client::class, $client);
+
+        try {
+            $result = $client->info();
+        } catch (ElasticsearchException $e) {
+            $request = $client->transport->getLastConnection()->getLastRequestInfo();
+            $this->assertTrue(isset($request['request']['headers']['Host'][0]));
+            $this->assertEquals($host, $request['request']['headers']['Host'][0]);
+        }
+    }
+
+    /**
+     * @see https://github.com/elastic/elasticsearch-php/issues/993
+     */
+    public function testNotIncludeStandardPortInHostHeader()
+    {
+        $host = "localhost";
+        $url  = "$host:1234";
+        $params = [
+            'client' => [
+                'verbose' => true
+            ]
+        ];
+        $client = ClientBuilder::create()
+            ->setConnectionParams($params)
+            ->setHosts([$url])
+            ->includePortInHostHeader(false)
+            ->build();
+
+        $this->assertInstanceOf(Client::class, $client);
+
+        try {
+            $result = $client->info();
+        } catch (ElasticsearchException $e) {
+            $request = $client->transport->getLastConnection()->getLastRequestInfo();
+            $this->assertTrue(isset($request['request']['headers']['Host'][0]));
+            $this->assertEquals($host, $request['request']['headers']['Host'][0]);
+        }
+    }
 }