Enhanced Generator Code to generate Endpoints using OpenSearch API Specifications

CHANGELOG.md

@@ -4,6 +4,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## [Unreleased]
 ### Added
+- Enhanced Generator Code to generate Endpoints using OpenSearch API Specifications ([#194](https://github.com/opensearch-project/opensearch-php/pull/194))
 ### Changed
 ### Deprecated
 ### Removed

composer.json

@@ -17,7 +17,8 @@
     "ext-json": ">=1.3.7",
     "ext-curl": "*",
     "ezimuel/ringphp": "^1.1.2",
-    "psr/log": "^1|^2|^3"
+    "psr/log": "^1|^2|^3",
+    "symfony/yaml": "*"
   },
   "require-dev": {
     "ext-zip": "*",

src/OpenSearch/Endpoints/AbstractEndpoint.php

@@ -23,6 +23,7 @@
 
 use OpenSearch\Common\Exceptions\UnexpectedValueException;
 use OpenSearch\Serializers\SerializerInterface;
+
 use function array_filter;
 
 abstract class AbstractEndpoint

src/OpenSearch/Namespaces/IndicesNamespace.php

@@ -1175,7 +1175,7 @@ public function getDataStream(array $params = [])
     }
     /**
      * $params['index']              = (list) A comma-separated list of index names to refresh analyzers for
-     * 
+     *
      * @param array $params Associative array of parameters
      * @return array
      */

src/OpenSearch/Namespaces/SqlNamespace.php

@@ -14,6 +14,7 @@
 namespace OpenSearch\Namespaces;
 
 use OpenSearch\Endpoints\AbstractEndpoint;
+
 use function array_filter;
 
 class SqlNamespace extends AbstractNamespace

src/OpenSearch/Transport.php

@@ -122,7 +122,7 @@ public function performRequest(string $method, string $uri, array $params = [],
             //onSuccess
             function ($response) {
                 $this->retryAttempts = 0;
-            // Note, this could be a 4xx or 5xx error
+                // Note, this could be a 4xx or 5xx error
             },
             //onFailure
             function ($response) {

tests/ConnectionPool/StaticConnectionPoolTest.php

@@ -190,7 +190,7 @@ public function testAllExceptLastHostFailPingRevivesPreSkip()
         $goodConnection->expects('isAlive')->andReturns(false);
         $goodConnection->expects('markDead');
         $goodConnection->expects('getPingFailures')->andReturns(0);
-        $goodConnection->expects('getLastPing')->andReturns(time()-10000);
+        $goodConnection->expects('getLastPing')->andReturns(time() - 10000);
 
         $connections[] = $goodConnection;
 

tests/Connections/ConnectionTest.php

@@ -31,6 +31,7 @@
 use Exception;
 use Psr\Log\LoggerInterface;
 use ReflectionClass;
+
 use function base64_encode;
 use function random_bytes;
 

util/ActionTest.php

@@ -244,7 +244,7 @@ private function match(array $actions)
         if (is_string($actions[$key]) && substr($actions[$key], 0, 1) !== '$') {
             $expected = sprintf("'%s'", addslashes($actions[$key]));
         } elseif (is_string($actions[$key]) && substr($actions[$key], 0, 2) === '${') {
-            $expected = sprintf("\$%s", substr($actions[$key], 2, strlen($actions[$key])-3));
+            $expected = sprintf("\$%s", substr($actions[$key], 2, strlen($actions[$key]) - 3));
         } elseif (is_bool($actions[$key])) {
             $expected = $actions[$key] ? 'true' : 'false';
         } elseif (is_array($actions[$key])) {
@@ -422,8 +422,8 @@ private function convertDotToArrow(string $dot)
         $result = str_replace('.', '()->', $dot);
         $tot = strlen($result);
         for ($i = 0; $i < $tot; $i++) {
-            if ($result[$i] === '_' && ($i+1) < $tot) {
-                $result[$i+1] = strtoupper($result[$i+1]);
+            if ($result[$i] === '_' && ($i + 1) < $tot) {
+                $result[$i + 1] = strtoupper($result[$i + 1]);
             }
         }
         return str_replace('_', '', $result);

util/ClientEndpoint.php

@@ -34,14 +34,10 @@ class ClientEndpoint extends NamespaceEndpoint
     protected $endpoints = [];
     protected $endpointNames = [];
     protected $namespace = [];
-    protected $version;
-    protected $buildhash;
 
-    public function __construct(array $namespace, string $version, string $buildhash)
+    public function __construct(array $namespace)
     {
         $this->namespace = $namespace;
-        $this->version = $version;
-        $this->buildhash = $buildhash;
     }
 
     public function renderClass(): string
@@ -108,8 +104,6 @@ public function renderClass(): string
             $functions .= $func;
         }
         $class = str_replace(':functions', $functions, $class);
-        $class = str_replace(':version', $this->version, $class);
-        $class = str_replace(':buildhash', $this->buildhash, $class);
 
         return $class;
     }

util/Endpoint.php

@@ -35,6 +35,7 @@ class Endpoint
     public const CHECK_OPTIONS_TEMPLATE       = __DIR__ . '/template/check-options';
     public const SET_BULK_BODY_TEMPLATE       = __DIR__ . '/template/set-bulk-body';
     public const DEPRECATED_PART              = __DIR__ . '/template/deprecated';
+    public const DEPRECATED_PARAM             = __DIR__ . '/template/deprecated-param-master-timeout';
     public const PHP_RESERVED_WORDS = [
         'abstract', 'and', 'array', 'as', 'break', 'callable', 'case', 'catch',
         'class', 'clone', 'const', 'continue', 'declare', 'default', 'die', 'do',
@@ -58,8 +59,6 @@ class Endpoint
     public $name;
     public $apiName;
     protected $content;
-    protected $version;
-    protected $buildhash;
     protected $parts = [];
     protected $requiredParts = [];
     protected $useNamespace = [];
@@ -69,8 +68,6 @@ class Endpoint
     public function __construct(
         string $fileName,
         string $content,
-        string $version,
-        string $buildhash
     ) {
         $this->apiName = basename($fileName, '.json');
         $parts = explode('.', $this->apiName);
@@ -95,8 +92,6 @@ public function __construct(
             ));
         }
         $this->content = $this->content[$this->apiName];
-        $this->version = $version;
-        $this->buildhash = $buildhash;
 
         $this->parts = $this->getPartsFromContent($this->content);
         $this->requiredParts = $this->getRequiredParts($this->content);
@@ -127,6 +122,8 @@ private function getRequiredParts(array $content): array
         }
         if (count($required) > 1) {
             return call_user_func_array('array_intersect', $required);
+        } elseif (count($required) === 1) {
+            return $required[0];
         }
         return $required;
     }
@@ -146,7 +143,7 @@ public function renderClass(): string
         }
         $class = str_replace(
             ':uri',
-            $this->extractUrl($this->content['url']['paths']),
+            trim($this->extractUrl($this->content['url']['paths'])),
             $class
         );
         $class = str_replace(
@@ -164,11 +161,15 @@ public function renderClass(): string
 
         // Set the HTTP method
         $action = $this->getMethod();
-        if (!empty($this->content['body']) &&
-            ($action === ['GET', 'POST'] || $action === ['POST', 'GET'])) {
-            $method = 'isset($this->body) ? \'POST\' : \'GET\'';
+        if ($action === ['POST', 'PUT'] && $this->getClassName() !== 'Bulk') {
+            $method = "'PUT'";
         } else {
-            $method = sprintf("'%s'", reset($action));
+            if (!empty($this->content['body']) &&
+                ($action === ['GET', 'POST'] || $action === ['POST', 'GET'])) {
+                $method = 'isset($this->body) ? \'POST\' : \'GET\'';
+            } else {
+                $method = sprintf("'%s'", reset($action));
+            }
         }
         $class = str_replace(':method', $method, $class);
 
@@ -186,19 +187,44 @@ public function renderClass(): string
             if (in_array($part, ['type', 'index', 'id'])) {
                 continue;
             }
-            if (isset($value['type']) && $value['type'] === 'list') {
+            if (isset($value['type']) && $value['type'] === 'array') {
                 $parts .= $this->getSetPartList($part);
             } else {
                 $parts .= $this->getSetPart($part);
             }
         }
         $class = str_replace(':set-parts', $parts, $class);
         $class = str_replace(':endpoint', $this->getClassName(), $class);
-        $class = str_replace(':version', $this->version, $class);
-        $class = str_replace(':buildhash', $this->buildhash, $class);
         $class = str_replace(':use-namespace', $this->getNamespaces(), $class);
         $class = str_replace(':properties', $this->getProperties(), $class);
+        if (isset($this->content['params']['master_timeout'])) {
+            $deprecatedContent = file_get_contents(self::DEPRECATED_PARAM);
+            $class = str_replace(':master_timeout_ParamDeprecation', $deprecatedContent, $class);
+        } else {
+            $class = preg_replace('/\s*:master_timeout_ParamDeprecation\s*\}/', '}', $class);
+        }
+
+        // Adding licence header
+        $currentDir = dirname(__FILE__);
+        $baseDir = dirname($currentDir);
+        $EndpointName = $this->getClassName();
+
+        if (!empty($this->namespace)) {
+            $filePath = $baseDir . "/src/OpenSearch/Endpoints/$this->namespace/$EndpointName.php";
+        } else {
+            $filePath = $baseDir . "/src/OpenSearch/Endpoints/$EndpointName.php";
+        }
+
+        if (file_exists($filePath)) {
+            $content = file_get_contents($filePath);
 
+            if (strpos($content, 'Copyright OpenSearch') !== false) {
+                $pattern = '/\/\*\*.*?\*\//s';
+                if (preg_match($pattern, $content, $matches)) {
+                    $class = str_replace('declare(strict_types=1);', 'declare(strict_types=1);' . PHP_EOL . PHP_EOL . $matches[0], $class);
+                }
+            }
+        }
         return str_replace(':apiname', $this->apiName, $class);
     }
 
@@ -291,7 +317,7 @@ private function extractUrl(array $paths): string
                 $check = sprintf("isset(\$%s)", $parts[0]);
             }
             $url = str_replace('{' . $parts[0] .'}', '$' . $parts[0], $path);
-            for ($i=1; $i<count($parts); $i++) {
+            for ($i = 1; $i < count($parts); $i++) {
                 $url = str_replace('{' . $parts[$i] .'}', '$' . $parts[$i], $url);
                 if (in_array($parts[$i], $this->requiredParts)) {
                     continue;
@@ -351,7 +377,7 @@ private function extractPaths(array $paths): array
         $urls = $this->removePathWithSameParts($paths);
         // Order the url based on descendant length
         usort($urls, function ($a, $b) {
-            return strlen($b)-strlen($a);
+            return strlen($b) - strlen($a);
         });
 
         return $urls;
@@ -494,8 +520,8 @@ private function extractPartsDescription(int $space): string
                 "     * \$params['%s']%s = %s(%s) %s%s\n",
                 $part,
                 str_repeat(' ', $space - strlen($part)),
-                $part ==='type' || (isset($values['deprecated']) && $values['deprecated']) ? 'DEPRECATED ' : '',
-                $values['type'],
+                $part === 'type' || (isset($values['deprecated']) && $values['deprecated']) ? 'DEPRECATED ' : '',
+                $values['type'] ?? 'any',
                 $values['description'] ?? '',
                 in_array($part, $this->requiredParts) ? ' (Required)' : ''
             );
@@ -518,7 +544,7 @@ private function extractParamsDescription(int $space): string
                 "     * \$params['%s']%s = (%s) %s%s%s%s\n",
                 $param,
                 str_repeat(' ', $space - strlen($param)),
-                $values['type'],
+                $values['type'] ?? 'any',
                 $values['description'] ?? '',
                 isset($values['required']) && $values['required'] ? ' (Required)' : '',
                 isset($values['options']) ? sprintf(" (Options = %s)", implode(',', $values['options'])) : '',

util/GenerateDocExamples.php

@@ -97,7 +97,7 @@
 
 printf("\nLanguage statistics:\n");
 foreach ($langs as $lang => $num) {
-    printf("%-8s: %4d (%.2f%% completed)\n", $lang, $num, (100/$tot)*$num);
+    printf("%-8s: %4d (%.2f%% completed)\n", $lang, $num, (100 / $tot) * $num);
 }
 printf("\n");