Backported 1303 in 8.x

Author: ezimuel

src/Traits/EndpointTrait.php

@@ -17,6 +17,7 @@
 use Elastic\Elasticsearch\Client;
 use Elastic\Elasticsearch\Exception\ContentTypeException;
 use Elastic\Elasticsearch\Exception\MissingParameterException;
+use Elastic\Elasticsearch\Utility;
 use Elastic\Transport\Serializer\JsonSerializer;
 use Elastic\Transport\Serializer\NDJsonSerializer;
 use Http\Discovery\Psr17FactoryDiscovery;
@@ -79,7 +80,7 @@ private function convertValue($value): string
      */
     protected function encode($value): string
     {
-        return urlencode($this->convertValue($value));
+        return Utility::urlencode($this->convertValue($value));
     }
 
     /**

src/Utility.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * Elasticsearch PHP Client
+ *
+ * @link      https://github.com/elastic/elasticsearch-php
+ * @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co)
+ * @license   https://opensource.org/licenses/MIT MIT License
+ *
+ * Licensed to Elasticsearch B.V under one or more agreements.
+ * Elasticsearch B.V licenses this file to you under the MIT License.
+ * See the LICENSE file in the project root for more information.
+ */
+declare(strict_types = 1);
+
+namespace Elastic\Elasticsearch;
+
+class Utility
+{
+    const ENV_URL_PLUS_AS_SPACE = 'ELASTIC_CLIENT_URL_PLUS_AS_SPACE';
+
+    /**
+     * Get the ENV variable with a thread safe fallback criteria
+     * @see https://github.com/elastic/elasticsearch-php/issues/1237
+     * 
+     * @return string | false
+     */
+    public static function getEnv(string $env)
+    {
+        return $_SERVER[$env] ?? $_ENV[$env] ?? getenv($env);
+    }
+
+    /**
+     * Encode a string in URL using urlencode() or rawurlencode()
+     * according to ENV_URL_PLUS_AS_SPACE.
+     * If ENV_URL_PLUS_AS_SPACE is not defined or true use urlencode(),
+     * otherwise use rawurlencode()
+     * 
+     * @see https://github.com/elastic/elasticsearch-php/issues/1278
+     * @deprecated will be replaced by PHP function rawurlencode()
+     */
+    public static function urlencode(string $url): string
+    {
+        $plusAsSpace = self::getEnv(self::ENV_URL_PLUS_AS_SPACE);
+        return $plusAsSpace === false || $plusAsSpace === 'true'
+            ? urlencode($url)
+            : rawurlencode($url);
+    }
+}

tests/UtilityTest.php

@@ -0,0 +1,94 @@
+<?php
+/**
+ * Elasticsearch PHP Client
+ *
+ * @link      https://github.com/elastic/elasticsearch-php
+ * @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co)
+ * @license   https://opensource.org/licenses/MIT MIT License
+ *
+ * Licensed to Elasticsearch B.V under one or more agreements.
+ * Elasticsearch B.V licenses this file to you under the MIT License.
+ * See the LICENSE file in the project root for more information.
+ */
+declare(strict_types = 1);
+
+namespace Elastic\Elasticsearch\Tests;
+
+use Elastic\Elasticsearch\Utility;
+use PHPUnit\Framework\TestCase;
+
+class UtilityTest extends TestCase
+{
+    public function tearDown(): void
+    {
+        unset($_SERVER[Utility::ENV_URL_PLUS_AS_SPACE]);
+        unset($_ENV[Utility::ENV_URL_PLUS_AS_SPACE]);
+        putenv(Utility::ENV_URL_PLUS_AS_SPACE);
+    }
+
+    public function testGetEnvWithDollarServer()
+    {
+        $_SERVER[Utility::ENV_URL_PLUS_AS_SPACE] = 'true';
+        $this->assertEquals('true', Utility::getEnv(Utility::ENV_URL_PLUS_AS_SPACE));
+    }
+
+    public function testGetEnvWithDollarEnv()
+    {
+        $_ENV[Utility::ENV_URL_PLUS_AS_SPACE] = 'true';
+        $this->assertEquals('true', Utility::getEnv(Utility::ENV_URL_PLUS_AS_SPACE));
+    }
+
+    public function testGetEnvWithPutEnv()
+    {
+        putenv(Utility::ENV_URL_PLUS_AS_SPACE . '=true');
+        $this->assertEquals('true', Utility::getEnv(Utility::ENV_URL_PLUS_AS_SPACE));
+    }
+
+    public function testUrlWithPlusAsDefault()
+    {
+        $url = Utility::urlencode('bar baz');
+        $this->assertEquals('bar+baz', $url);
+    }
+
+    public function testUrlWithPlusWithDollarServer()
+    {
+        $_SERVER[Utility::ENV_URL_PLUS_AS_SPACE] = 'true';   
+        $url = Utility::urlencode('bar baz');
+        $this->assertEquals('bar+baz', $url);
+    }
+
+    public function testUrlWithPlusWithDollarEnv()
+    {
+        $_ENV[Utility::ENV_URL_PLUS_AS_SPACE] = 'true';   
+        $url = Utility::urlencode('bar baz');
+        $this->assertEquals('bar+baz', $url);
+    }
+
+    public function testUrlWithPlusWithPutEnv()
+    {
+        putenv(Utility::ENV_URL_PLUS_AS_SPACE . '=true');   
+        $url = Utility::urlencode('bar baz');
+        $this->assertEquals('bar+baz', $url);
+    }
+
+    public function testUrlWith2BWithDollarServer()
+    {
+        $_SERVER[Utility::ENV_URL_PLUS_AS_SPACE] = 'false';   
+        $url = Utility::urlencode('bar baz');
+        $this->assertEquals('bar%20baz', $url);
+    }
+
+    public function testUrlWith2BWithDollarEnv()
+    {
+        $_ENV[Utility::ENV_URL_PLUS_AS_SPACE] = 'false';   
+        $url = Utility::urlencode('bar baz');
+        $this->assertEquals('bar%20baz', $url);
+    }
+
+    public function testUrlWith2BWithPutEnv()
+    {
+        putenv(Utility::ENV_URL_PLUS_AS_SPACE . '=false');   
+        $url = Utility::urlencode('bar baz');
+        $this->assertEquals('bar%20baz', $url);
+    }
+}