Replace endpoint callable with EndpointFactory

Signed-off-by: Kim Pepper <[email protected]> Signed-off-by: Kim Pepper <[email protected]> Signed-off-by: Kim Pepper <[email protected]>
opensearch-project · Nov 5, 2024 · bbe2ad3 · bbe2ad3
1 parent add2d03
commit bbe2ad3
Show file tree

Hide file tree

Showing 45 changed files with 309 additions and 225 deletions.
diff --git a/src/OpenSearch/ClientBuilder.php b/src/OpenSearch/ClientBuilder.php
@@ -54,10 +54,7 @@ class ClientBuilder
      */
     private $transport;
 
-    /**
-     * @var callable|null
-     */
-    private $endpoint;
+    private ?EndpointFactoryInterface $endpointFactory = null;
 
     /**
      * @var NamespaceBuilderInterface[]
@@ -182,14 +179,6 @@ public function getTransport(): Transport
         return $this->transport;
     }
 
-    /**
-     * Can supply second param to Client::__construct() when invoking manually or with dependency injection
-     */
-    public function getEndpoint(): callable
-    {
-        return $this->endpoint;
-    }
-
     /**
      * Can supply third param to Client::__construct() when invoking manually or with dependency injection
      *
@@ -325,15 +314,9 @@ public function setConnectionPool($connectionPool, array $args = []): ClientBuil
         return $this;
     }
 
-    /**
-     * Set the endpoint
-     *
-     * @param callable $endpoint
-     */
-    public function setEndpoint(callable $endpoint): ClientBuilder
+    public function setEndpointFactory(EndpointFactoryInterface $endpointFactory): ClientBuilder
     {
-        $this->endpoint = $endpoint;
-
+        $this->endpointFactory = $endpointFactory;
         return $this;
     }
 
@@ -671,21 +654,8 @@ public function build(): Client
 
         $this->buildTransport();
 
-        if (is_null($this->endpoint)) {
-            $serializer = $this->serializer;
-
-            $this->endpoint = function ($class) use ($serializer) {
-                $fullPath = '\\OpenSearch\\Endpoints\\' . $class;
-
-                $reflection = new ReflectionClass($fullPath);
-                $constructor = $reflection->getConstructor();
-
-                if ($constructor && $constructor->getParameters()) {
-                    return new $fullPath($serializer);
-                } else {
-                    return new $fullPath();
-                }
-            };
+        if (is_null($this->endpointFactory)) {
+            $this->endpointFactory = new EndpointFactory($this->serializer);
         }
 
         $registeredNamespaces = [];
@@ -696,12 +666,12 @@ public function build(): Client
             $registeredNamespaces[$builder->getName()] = $builder->getObject($this->transport, $this->serializer);
         }
 
-        return $this->instantiate($this->transport, $this->endpoint, $registeredNamespaces);
+        return $this->instantiate($this->transport, $this->endpointFactory, $registeredNamespaces);
     }
 
-    protected function instantiate(Transport $transport, callable $endpoint, array $registeredNamespaces): Client
+    protected function instantiate(Transport $transport, EndpointFactoryInterface $endpointFactory, array $registeredNamespaces): Client
     {
-        return new Client($transport, $endpoint, $registeredNamespaces);
+        return new Client($transport, $endpointFactory, $registeredNamespaces);
     }
 
     private function buildLoggers(): void

diff --git a/src/OpenSearch/EndpointFactory.php b/src/OpenSearch/EndpointFactory.php
@@ -0,0 +1,55 @@
+<?php
+
+namespace OpenSearch;
+
+use OpenSearch\Endpoints\AbstractEndpoint;
+use OpenSearch\Serializers\SerializerInterface;
+use ReflectionClass;
+
+/**
+ * A factory for creating endpoints.
+ */
+class EndpointFactory implements EndpointFactoryInterface
+{
+    /**
+     * @var array<string, AbstractEndpoint>
+     */
+    private array $endpoints = [];
+
+    public function __construct(
+        protected SerializerInterface $serializer,
+    ) {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getEndpoint(string $class): AbstractEndpoint
+    {
+        if (!isset($this->endpoints[$class])) {
+            $this->endpoints[$class] = $this->createEndpoint($class);
+        }
+
+        return $this->endpoints[$class];
+    }
+
+    /**
+     * Creates an endpoint.
+     *
+     * @phpstan-template T of AbstractEndpoint
+     * @phpstan-param class-string<T> $class
+     * @phpstan-return T
+     * @throws \ReflectionException
+     */
+    private function createEndpoint(string $class): AbstractEndpoint
+    {
+        $reflection = new ReflectionClass($class);
+        $constructor = $reflection->getConstructor();
+
+        if ($constructor && $constructor->getParameters()) {
+            return new $class($this->serializer);
+        }
+        return new $class();
+    }
+
+}
diff --git a/src/OpenSearch/EndpointFactoryInterface.php b/src/OpenSearch/EndpointFactoryInterface.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace OpenSearch;
+
+use OpenSearch\Endpoints\AbstractEndpoint;
+
+/**
+ * A factory for creating endpoints.
+ */
+interface EndpointFactoryInterface
+{
+    /**
+     * Gets an endpoint.
+     *
+     * @phpstan-template T of AbstractEndpoint
+     * @phpstan-param class-string<T> $class
+     * @phpstan-return T
+     */
+    public function getEndpoint(string $class): AbstractEndpoint;
+
+}
diff --git a/src/OpenSearch/EndpointInterface.php b/src/OpenSearch/EndpointInterface.php
@@ -0,0 +1,77 @@
+<?php
+
+namespace OpenSearch;
+
+/**
+ * Provides and interface for endpoints.
+ */
+interface EndpointInterface
+{
+    /**
+     * Get the whitelist of allowed parameters.
+     *
+     * @return string[]
+     */
+    public function getParamWhitelist(): array;
+
+    /**
+     * Get the URI.
+     */
+    public function getURI(): string;
+
+    /**
+     * Get the HTTP method.
+     */
+    public function getMethod(): string;
+
+    /**
+     * Set the query string parameters.
+     */
+    public function setParams(array $params): static;
+
+    /**
+     * Get the query string parameters.
+     */
+    public function getParams(): array;
+
+    /**
+     * Get the options.
+     */
+    public function getOptions(): array;
+
+    /**
+     * Get the index.
+     */
+    public function getIndex(): ?string;
+
+    /**
+     * Set the index.
+     *
+     * @param string|string[]|null $index
+     *
+     * @return $this
+     */
+    public function setIndex(string|array|null $index): static;
+
+    /**
+     * Get the document ID.
+     *
+     * @param int|string|null $docID
+     *
+     * @return $this
+     */
+    public function setId(int|string|null $docID): static;
+
+    /**
+     * Get the body of the request.
+     *
+     * @return array|string
+     */
+    public function getBody(): array|string;
+
+    /**
+     * Set the body of the request.
+     */
+    public function setBody(array $body): static;
+
+}
diff --git a/src/OpenSearch/Namespaces/AbstractNamespace.php b/src/OpenSearch/Namespaces/AbstractNamespace.php
@@ -21,6 +21,7 @@
 
 namespace OpenSearch\Namespaces;
 
+use OpenSearch\EndpointFactoryInterface;
 use OpenSearch\Endpoints\AbstractEndpoint;
 use OpenSearch\Transport;
 
@@ -36,10 +37,9 @@ abstract class AbstractNamespace
      */
     protected $endpoints;
 
-    public function __construct(Transport $transport, callable $endpoints)
+    public function __construct(Transport $transport, protected readonly EndpointFactoryInterface $endpointFactory)
     {
         $this->transport = $transport;
-        $this->endpoints = $endpoints;
     }
 
     /**

diff --git a/tests/ClientTest.php b/tests/ClientTest.php
@@ -413,9 +413,9 @@ public function testExtractArgumentIterable()
     /** @test */
     public function sendRawRequest(): void
     {
-        $callable = function () {};
         $transport = $this->createMock(OpenSearch\Transport::class);
-        $client = new OpenSearch\Client($transport, $callable, []);
+        $endpointFactory = $this->createMock(OpenSearch\EndpointFactoryInterface::class);
+        $client = new OpenSearch\Client($transport, $endpointFactory, []);
 
         $transport->expects($this->once())->method('performRequest')->with('GET', '/', [], null, []);
 
@@ -425,9 +425,9 @@ public function sendRawRequest(): void
     /** @test */
     public function sendRawRequestWithBody(): void
     {
-        $callable = function () {};
         $transport = $this->createMock(OpenSearch\Transport::class);
-        $client = new OpenSearch\Client($transport, $callable, []);
+        $endpointFactory = $this->createMock(OpenSearch\EndpointFactoryInterface::class);
+        $client = new OpenSearch\Client($transport, $endpointFactory, []);
         $body = ['query' => ['match' => ['text_entry' => 'long live king']]];
 
         $transport->expects($this->once())->method('performRequest')->with('GET', '/shakespeare/_search', [], $body, []);
@@ -438,9 +438,9 @@ public function sendRawRequestWithBody(): void
     /** @test */
     public function sendRawRequestWithParams(): void
     {
-        $callable = function () {};
         $transport = $this->createMock(OpenSearch\Transport::class);
-        $client = new OpenSearch\Client($transport, $callable, []);
+        $endpointFactory = $this->createMock(OpenSearch\EndpointFactoryInterface::class);
+        $client = new OpenSearch\Client($transport, $endpointFactory, []);
         $params = ['foo' => 'bar'];
 
         $transport->expects($this->once())->method('performRequest')->with('GET', '/_search', $params, null, []);
@@ -451,9 +451,9 @@ public function sendRawRequestWithParams(): void
     /** @test */
     public function sendRawRequestWithOptions(): void
     {
-        $callable = function () {};
         $transport = $this->createMock(OpenSearch\Transport::class);
-        $client = new OpenSearch\Client($transport, $callable, []);
+        $endpointFactory = $this->createMock(OpenSearch\EndpointFactoryInterface::class);
+        $client = new OpenSearch\Client($transport, $endpointFactory, []);
         $options = ['client' => ['future' => 'lazy']];
 
         $transport->expects($this->once())->method('performRequest')->with('GET', '/', [], null, $options);