Support inclusive (#65)

* feat: add cluster manager api Signed-off-by: Soner Sayakci <[email protected]> * feat: deprecate master_timeout Signed-off-by: Soner Sayakci <[email protected]> * feat: update all comments Signed-off-by: Soner Sayakci <[email protected]> Signed-off-by: Soner Sayakci <[email protected]>
opensearch-project · Sep 30, 2022 · 85c5731 · 85c5731
1 parent d84a881
commit 85c5731
Show file tree

Hide file tree

Showing 82 changed files with 722 additions and 173 deletions.
diff --git a/src/OpenSearch/Client.php b/src/OpenSearch/Client.php
@@ -395,7 +395,7 @@ public function deleteByQueryRethrottle(array $params = [])
     /**
      * $params['id']             = (string) Script ID
      * $params['timeout']        = (time) Explicit operation timeout
-     * $params['master_timeout'] = (time) Specify timeout for connection to master
+     * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager
      *
      * @param array $params Associative array of parameters
      * @return array
@@ -568,7 +568,7 @@ public function get(array $params = [])
     }
     /**
      * $params['id']             = (string) Script ID
-     * $params['master_timeout'] = (time) Specify timeout for connection to master
+     * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager
      *
      * @param array $params Associative array of parameters
      * @return array
@@ -827,7 +827,7 @@ public function ping(array $params = []): bool
      * $params['id']             = (string) Script ID (Required)
      * $params['context']        = (string) Script context
      * $params['timeout']        = (time) Explicit operation timeout
-     * $params['master_timeout'] = (time) Specify timeout for connection to master
+     * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager
      * $params['body']           = (array) The document (Required)
      *
      * @param array $params Associative array of parameters
@@ -1048,7 +1048,7 @@ public function search(array $params = [])
      * $params['index']              = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
      * $params['preference']         = (string) Specify the node or shard the operation should be performed on (default: random)
      * $params['routing']            = (string) Specific routing value
-     * $params['local']              = (boolean) Return local information, do not retrieve the state from master node (default: false)
+     * $params['local']              = (boolean) Return local information, do not retrieve the state from cluster manager node (default: false)
      * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
      * $params['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
      * $params['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open)

diff --git a/src/OpenSearch/Endpoints/AbstractEndpoint.php b/src/OpenSearch/Endpoints/AbstractEndpoint.php
@@ -91,6 +91,8 @@ public function setParams(array $params)
         $params = $this->convertCustom($params);
         $this->params = $this->convertArraysToStrings($params);
 
+        $this->checkForDeprecations();
+
         return $this;
     }
 
@@ -280,4 +282,39 @@ private function isNestedArray(array $a): bool
 
         return false;
     }
+
+    /**
+     * This function returns all param deprecations also optional with an replacement field
+     *
+     * @return array<string, string|null>
+     */
+    protected function getParamDeprecation(): array
+    {
+        return [];
+    }
+
+    private function checkForDeprecations(): void
+    {
+        $deprecations = $this->getParamDeprecation();
+
+        if ($deprecations === []) {
+            return;
+        }
+
+        $keys = array_keys($this->params);
+
+        foreach ($keys as $key) {
+            if (array_key_exists($key, $deprecations)) {
+                $val = $deprecations[$key];
+
+                $msg = sprintf('The parameter "%s" is deprecated and will be removed without replacement in the next major version', $key);
+
+                if ($val) {
+                    $msg = sprintf('The parameter "%s" is deprecated and will be replaced with parameter "%s" in the next major version', $key, $val);
+                }
+
+                trigger_error($msg, E_USER_DEPRECATED);
+            }
+        }
+    }
 }
diff --git a/src/OpenSearch/Endpoints/Cat/Allocation.php b/src/OpenSearch/Endpoints/Cat/Allocation.php
@@ -47,7 +47,8 @@ public function getParamWhitelist(): array
             'h',
             'help',
             's',
-            'v'
+            'v',
+            'cluster_manager_timeout'
         ];
     }
 
@@ -68,4 +69,9 @@ public function setNodeId($node_id): Allocation
 
         return $this;
     }
+
+    protected function getParamDeprecation(): array
+    {
+        return ['master_timeout' => 'cluster_manager_timeout'];
+    }
 }
diff --git a/src/OpenSearch/Endpoints/Cat/ClusterManager.php b/src/OpenSearch/Endpoints/Cat/ClusterManager.php
@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Elasticsearch PHP client
+ *
+ * @link      https://github.com/elastic/elasticsearch-php/
+ * @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co)
+ * @license   http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
+ * @license   https://www.gnu.org/licenses/lgpl-2.1.html GNU Lesser General Public License, Version 2.1
+ *
+ * Licensed to Elasticsearch B.V under one or more agreements.
+ * Elasticsearch B.V licenses this file to you under the Apache 2.0 License or
+ * the GNU Lesser General Public License, Version 2.1, at your option.
+ * See the LICENSE file in the project root for more information.
+ */
+
+namespace OpenSearch\Endpoints\Cat;
+
+use OpenSearch\Endpoints\AbstractEndpoint;
+
+class ClusterManager extends AbstractEndpoint
+{
+    public function getURI(): string
+    {
+        return "/_cat/cluster_manager";
+    }
+
+    public function getParamWhitelist(): array
+    {
+        return [
+            'format',
+            'local',
+            'cluster_manager_timeout',
+            'h',
+            'help',
+            's',
+            'v'
+        ];
+    }
+
+    public function getMethod(): string
+    {
+        return 'GET';
+    }
+}
diff --git a/src/OpenSearch/Endpoints/Cat/Indices.php b/src/OpenSearch/Endpoints/Cat/Indices.php
@@ -50,12 +50,17 @@ public function getParamWhitelist(): array
             'time',
             'v',
             'include_unloaded_segments',
-            'expand_wildcards'
+            'expand_wildcards',
+            'cluster_manager_timeout'
         ];
     }
 
     public function getMethod(): string
     {
         return 'GET';
     }
+    protected function getParamDeprecation(): array
+    {
+        return ['master_timeout' => 'cluster_manager_timeout'];
+    }
 }
diff --git a/src/OpenSearch/Endpoints/Cat/Master.php b/src/OpenSearch/Endpoints/Cat/Master.php
@@ -23,6 +23,9 @@
 
 use OpenSearch\Endpoints\AbstractEndpoint;
 
+/**
+ * @deprecated use \OpenSearch\Endpoints\Cat\ClusterManager instead
+ */
 class Master extends AbstractEndpoint
 {
     public function getURI(): string
@@ -39,12 +42,17 @@ public function getParamWhitelist(): array
             'h',
             'help',
             's',
-            'v'
+            'v',
+            'cluster_manager_timeout'
         ];
     }
 
     public function getMethod(): string
     {
         return 'GET';
     }
+    protected function getParamDeprecation(): array
+    {
+        return ['master_timeout' => 'cluster_manager_timeout'];
+    }
 }
diff --git a/src/OpenSearch/Endpoints/Cat/NodeAttrs.php b/src/OpenSearch/Endpoints/Cat/NodeAttrs.php
@@ -39,12 +39,17 @@ public function getParamWhitelist(): array
             'h',
             'help',
             's',
-            'v'
+            'v',
+            'cluster_manager_timeout'
         ];
     }
 
     public function getMethod(): string
     {
         return 'GET';
     }
+    protected function getParamDeprecation(): array
+    {
+        return ['master_timeout' => 'cluster_manager_timeout'];
+    }
 }
diff --git a/src/OpenSearch/Endpoints/Cat/Nodes.php b/src/OpenSearch/Endpoints/Cat/Nodes.php
@@ -42,12 +42,17 @@ public function getParamWhitelist(): array
             'help',
             's',
             'time',
-            'v'
+            'v',
+            'cluster_manager_timeout'
         ];
     }
 
     public function getMethod(): string
     {
         return 'GET';
     }
+    protected function getParamDeprecation(): array
+    {
+        return ['master_timeout' => 'cluster_manager_timeout'];
+    }
 }
diff --git a/src/OpenSearch/Endpoints/Cat/PendingTasks.php b/src/OpenSearch/Endpoints/Cat/PendingTasks.php
@@ -40,12 +40,17 @@ public function getParamWhitelist(): array
             'help',
             's',
             'time',
-            'v'
+            'v',
+            'cluster_manager_timeout'
         ];
     }
 
     public function getMethod(): string
     {
         return 'GET';
     }
+    protected function getParamDeprecation(): array
+    {
+        return ['master_timeout' => 'cluster_manager_timeout'];
+    }
 }
diff --git a/src/OpenSearch/Endpoints/Cat/Plugins.php b/src/OpenSearch/Endpoints/Cat/Plugins.php
@@ -39,12 +39,17 @@ public function getParamWhitelist(): array
             'h',
             'help',
             's',
-            'v'
+            'v',
+            'cluster_manager_timeout'
         ];
     }
 
     public function getMethod(): string
     {
         return 'GET';
     }
+    protected function getParamDeprecation(): array
+    {
+        return ['master_timeout' => 'cluster_manager_timeout'];
+    }
 }
diff --git a/src/OpenSearch/Endpoints/Cat/Repositories.php b/src/OpenSearch/Endpoints/Cat/Repositories.php
@@ -39,12 +39,17 @@ public function getParamWhitelist(): array
             'h',
             'help',
             's',
-            'v'
+            'v',
+            'cluster_manager_timeout'
         ];
     }
 
     public function getMethod(): string
     {
         return 'GET';
     }
+    protected function getParamDeprecation(): array
+    {
+        return ['master_timeout' => 'cluster_manager_timeout'];
+    }
 }
diff --git a/src/OpenSearch/Endpoints/Cat/Shards.php b/src/OpenSearch/Endpoints/Cat/Shards.php
@@ -46,12 +46,17 @@ public function getParamWhitelist(): array
             'help',
             's',
             'time',
-            'v'
+            'v',
+            'cluster_manager_timeout'
         ];
     }
 
     public function getMethod(): string
     {
         return 'GET';
     }
+    protected function getParamDeprecation(): array
+    {
+        return ['master_timeout' => 'cluster_manager_timeout'];
+    }
 }
diff --git a/src/OpenSearch/Endpoints/Cat/Snapshots.php b/src/OpenSearch/Endpoints/Cat/Snapshots.php
@@ -47,7 +47,8 @@ public function getParamWhitelist(): array
             'help',
             's',
             'time',
-            'v'
+            'v',
+            'cluster_manager_timeout'
         ];
     }
 
@@ -68,4 +69,8 @@ public function setRepository($repository): Snapshots
 
         return $this;
     }
+    protected function getParamDeprecation(): array
+    {
+        return ['master_timeout' => 'cluster_manager_timeout'];
+    }
 }
diff --git a/src/OpenSearch/Endpoints/Cat/Templates.php b/src/OpenSearch/Endpoints/Cat/Templates.php
@@ -46,7 +46,8 @@ public function getParamWhitelist(): array
             'h',
             'help',
             's',
-            'v'
+            'v',
+            'cluster_manager_timeout'
         ];
     }
 
@@ -64,4 +65,8 @@ public function setName($name): Templates
 
         return $this;
     }
+    protected function getParamDeprecation(): array
+    {
+        return ['master_timeout' => 'cluster_manager_timeout'];
+    }
 }
diff --git a/src/OpenSearch/Endpoints/Cat/ThreadPool.php b/src/OpenSearch/Endpoints/Cat/ThreadPool.php
@@ -47,7 +47,8 @@ public function getParamWhitelist(): array
             'h',
             'help',
             's',
-            'v'
+            'v',
+            'cluster_manager_timeout'
         ];
     }
 
@@ -68,4 +69,8 @@ public function setThreadPoolPatterns($thread_pool_patterns): ThreadPool
 
         return $this;
     }
+    protected function getParamDeprecation(): array
+    {
+        return ['master_timeout' => 'cluster_manager_timeout'];
+    }
 }
diff --git a/src/OpenSearch/Endpoints/Cluster/DeleteComponentTemplate.php b/src/OpenSearch/Endpoints/Cluster/DeleteComponentTemplate.php
@@ -42,7 +42,8 @@ public function getParamWhitelist(): array
     {
         return [
             'timeout',
-            'master_timeout'
+            'master_timeout',
+            'cluster_manager_timeout'
         ];
     }
 
@@ -60,4 +61,8 @@ public function setName($name): DeleteComponentTemplate
 
         return $this;
     }
+    protected function getParamDeprecation(): array
+    {
+        return ['master_timeout' => 'cluster_manager_timeout'];
+    }
 }