[Internal BWC Break] Refactor to remove Transport dependence in endpo…

…ints This removes the reliance on Transport inside of endpoints. Instead of endpoints calling transport->performRequest(), the endpoint is used as a temporary object that performs validation and input manipulation. The Namespace then uses this object to invoke transport->performRequest() directly. This will make injecting custom namespaces significantly easier, since it makes the dependency graph easier to wire. It also makes mocking / unit tests easier. Related to #421
elastic · Jul 6, 2016 · ecd454c · ecd454c
1 parent 38c05da
commit ecd454c
Show file tree

Hide file tree

Showing 137 changed files with 590 additions and 585 deletions.
diff --git a/src/Elasticsearch/Client.php b/src/Elasticsearch/Client.php
diff --git a/src/Elasticsearch/ClientBuilder.php b/src/Elasticsearch/ClientBuilder.php
@@ -430,12 +430,12 @@ public function build()
             $transport = $this->transport;
             $serializer = $this->serializer;
 
-            $this->endpoint = function ($class) use ($transport, $serializer) {
+            $this->endpoint = function ($class) use ($serializer) {
                 $fullPath = '\\Elasticsearch\\Endpoints\\' . $class;
                 if ($class === 'Bulk' || $class === 'Msearch' || $class === 'MPercolate') {
-                    return new $fullPath($transport, $serializer);
+                    return new $fullPath($serializer);
                 } else {
-                    return new $fullPath($transport);
+                    return new $fullPath();
                 }
             };
         }

diff --git a/src/Elasticsearch/Endpoints/AbstractEndpoint.php b/src/Elasticsearch/Endpoints/AbstractEndpoint.php
@@ -3,6 +3,7 @@
 namespace Elasticsearch\Endpoints;
 
 use Elasticsearch\Common\Exceptions\UnexpectedValueException;
+use Elasticsearch\Serializers\SerializerInterface;
 use Elasticsearch\Transport;
 use Exception;
 use GuzzleHttp\Ring\Future\FutureArrayInterface;
@@ -36,51 +37,27 @@ abstract class AbstractEndpoint
     /** @var  array */
     protected $body = null;
 
-    /** @var \Elasticsearch\Transport  */
-    private $transport = null;
-
     /** @var array  */
     private $options = [];
 
+    /** @var  SerializerInterface */
+    protected $serializer;
+
     /**
      * @return string[]
      */
-    abstract protected function getParamWhitelist();
+    abstract public function getParamWhitelist();
 
     /**
      * @return string
      */
-    abstract protected function getURI();
+    abstract public function getURI();
 
     /**
      * @return string
      */
-    abstract protected function getMethod();
-
-    /**
-     * @param Transport $transport
-     */
-    public function __construct($transport)
-    {
-        $this->transport = $transport;
-    }
+    abstract public function getMethod();
 
-    /**
-     * @throws \Exception
-     * @return array
-     */
-    public function performRequest()
-    {
-        $promise =  $this->transport->performRequest(
-            $this->getMethod(),
-            $this->getURI(),
-            $this->params,
-            $this->getBody(),
-            $this->options
-        );
-
-        return $promise;
-    }
 
     /**
      * Set the parameters for this endpoint
@@ -102,6 +79,22 @@ public function setParams($params)
         return $this;
     }
 
+    /**
+     * @return array
+     */
+    public function getParams()
+    {
+        return $this->params;
+    }
+
+    /**
+     * @return array
+     */
+    public function getOptions()
+    {
+        return $this->options;
+    }
+
     /**
      * @param string $index
      *
@@ -182,7 +175,7 @@ public function resultOrFuture($result)
     /**
      * @return array
      */
-    protected function getBody()
+    public function getBody()
     {
         return $this->body;
     }

diff --git a/src/Elasticsearch/Endpoints/Bulk.php b/src/Elasticsearch/Endpoints/Bulk.php
@@ -17,13 +17,11 @@
 class Bulk extends AbstractEndpoint implements BulkEndpointInterface
 {
     /**
-     * @param Transport           $transport
      * @param SerializerInterface $serializer
      */
-    public function __construct(Transport $transport, SerializerInterface $serializer)
+    public function __construct(SerializerInterface $serializer)
     {
         $this->serializer = $serializer;
-        parent::__construct($transport);
     }
 
     /**
@@ -51,15 +49,15 @@ public function setBody($body)
     /**
      * @return string
      */
-    protected function getURI()
+    public function getURI()
     {
         return $this->getOptionalURI('_bulk');
     }
 
     /**
      * @return string[]
      */
-    protected function getParamWhitelist()
+    public function getParamWhitelist()
     {
         return array(
             'consistency',
@@ -74,7 +72,7 @@ protected function getParamWhitelist()
     /**
      * @return string
      */
-    protected function getMethod()
+    public function getMethod()
     {
         return 'POST';
     }

diff --git a/src/Elasticsearch/Endpoints/BulkEndpointInterface.php b/src/Elasticsearch/Endpoints/BulkEndpointInterface.php
@@ -19,8 +19,7 @@ interface BulkEndpointInterface
     /**
      * Constructor
      *
-     * @param Transport           $transport  Transport instance
      * @param SerializerInterface $serializer A serializer
      */
-    public function __construct(Transport $transport, SerializerInterface $serializer);
+    public function __construct(SerializerInterface $serializer);
 }
diff --git a/src/Elasticsearch/Endpoints/Cat/Aliases.php b/src/Elasticsearch/Endpoints/Cat/Aliases.php
@@ -37,7 +37,7 @@ public function setName($name)
     /**
      * @return string
      */
-    protected function getURI()
+    public function getURI()
     {
         $name = $this->name;
         $uri   = "/_cat/aliases";
@@ -52,7 +52,7 @@ protected function getURI()
     /**
      * @return string[]
      */
-    protected function getParamWhitelist()
+    public function getParamWhitelist()
     {
         return array(
             'local',
@@ -67,7 +67,7 @@ protected function getParamWhitelist()
     /**
      * @return string
      */
-    protected function getMethod()
+    public function getMethod()
     {
         return 'GET';
     }

diff --git a/src/Elasticsearch/Endpoints/Cat/Allocation.php b/src/Elasticsearch/Endpoints/Cat/Allocation.php
@@ -37,7 +37,7 @@ public function setNodeId($node_id)
     /**
      * @return string
      */
-    protected function getURI()
+    public function getURI()
     {
         $node_id = $this->node_id;
         $uri   = "/_cat/allocation";
@@ -52,7 +52,7 @@ protected function getURI()
     /**
      * @return string[]
      */
-    protected function getParamWhitelist()
+    public function getParamWhitelist()
     {
         return array(
             'bytes',
@@ -67,7 +67,7 @@ protected function getParamWhitelist()
     /**
      * @return string
      */
-    protected function getMethod()
+    public function getMethod()
     {
         return 'GET';
     }

diff --git a/src/Elasticsearch/Endpoints/Cat/Count.php b/src/Elasticsearch/Endpoints/Cat/Count.php
@@ -18,7 +18,7 @@ class Count extends AbstractEndpoint
     /**
      * @return string
      */
-    protected function getURI()
+    public function getURI()
     {
         $index = $this->index;
         $uri   = "/_cat/count";
@@ -33,7 +33,7 @@ protected function getURI()
     /**
      * @return string[]
      */
-    protected function getParamWhitelist()
+    public function getParamWhitelist()
     {
         return array(
             'local',
@@ -47,7 +47,7 @@ protected function getParamWhitelist()
     /**
      * @return string
      */
-    protected function getMethod()
+    public function getMethod()
     {
         return 'GET';
     }

diff --git a/src/Elasticsearch/Endpoints/Cat/Fielddata.php b/src/Elasticsearch/Endpoints/Cat/Fielddata.php
@@ -36,7 +36,7 @@ public function setFields($fields)
     /**
      * @return string
      */
-    protected function getURI()
+    public function getURI()
     {
         $fields = $this->fields;
         $uri   = "/_cat/fielddata";
@@ -51,7 +51,7 @@ protected function getURI()
     /**
      * @return string[]
      */
-    protected function getParamWhitelist()
+    public function getParamWhitelist()
     {
         return array(
             'local',
@@ -65,7 +65,7 @@ protected function getParamWhitelist()
     /**
      * @return string
      */
-    protected function getMethod()
+    public function getMethod()
     {
         return 'GET';
     }

diff --git a/src/Elasticsearch/Endpoints/Cat/Health.php b/src/Elasticsearch/Endpoints/Cat/Health.php
@@ -18,7 +18,7 @@ class Health extends AbstractEndpoint
     /**
      * @return string
      */
-    protected function getURI()
+    public function getURI()
     {
         $uri   = "/_cat/health";
 
@@ -28,7 +28,7 @@ protected function getURI()
     /**
      * @return string[]
      */
-    protected function getParamWhitelist()
+    public function getParamWhitelist()
     {
         return array(
             'local',
@@ -43,7 +43,7 @@ protected function getParamWhitelist()
     /**
      * @return string
      */
-    protected function getMethod()
+    public function getMethod()
     {
         return 'GET';
     }

diff --git a/src/Elasticsearch/Endpoints/Cat/Help.php b/src/Elasticsearch/Endpoints/Cat/Help.php
@@ -18,7 +18,7 @@ class Help extends AbstractEndpoint
     /**
      * @return string
      */
-    protected function getURI()
+    public function getURI()
     {
         $uri   = "/_cat";
 
@@ -28,7 +28,7 @@ protected function getURI()
     /**
      * @return string[]
      */
-    protected function getParamWhitelist()
+    public function getParamWhitelist()
     {
         return array(
             'help',
@@ -38,7 +38,7 @@ protected function getParamWhitelist()
     /**
      * @return string
      */
-    protected function getMethod()
+    public function getMethod()
     {
         return 'GET';
     }

diff --git a/src/Elasticsearch/Endpoints/Cat/Indices.php b/src/Elasticsearch/Endpoints/Cat/Indices.php
@@ -19,7 +19,7 @@ class Indices extends AbstractEndpoint
     /**
      * @return string
      */
-    protected function getURI()
+    public function getURI()
     {
         $index = $this->index;
         $uri   = "/_cat/indices";
@@ -34,7 +34,7 @@ protected function getURI()
     /**
      * @return string[]
      */
-    protected function getParamWhitelist()
+    public function getParamWhitelist()
     {
         return array(
             'bytes',
@@ -50,7 +50,7 @@ protected function getParamWhitelist()
     /**
      * @return string
      */
-    protected function getMethod()
+    public function getMethod()
     {
         return 'GET';
     }

diff --git a/src/Elasticsearch/Endpoints/Cat/Master.php b/src/Elasticsearch/Endpoints/Cat/Master.php
@@ -18,7 +18,7 @@ class Master extends AbstractEndpoint
     /**
      * @return string
      */
-    protected function getURI()
+    public function getURI()
     {
         $uri   = "/_cat/master";
 
@@ -28,7 +28,7 @@ protected function getURI()
     /**
      * @return string[]
      */
-    protected function getParamWhitelist()
+    public function getParamWhitelist()
     {
         return array(
             'local',
@@ -42,7 +42,7 @@ protected function getParamWhitelist()
     /**
      * @return string
      */
-    protected function getMethod()
+    public function getMethod()
     {
         return 'GET';
     }