[2.0] Deprecate the "Master" nomenclature in nodejs client (#222)

* [2.0] Deprecate the "Master" nomenclature in nodejs client 1.Deprecate setting cluster.initial_master_nodes and introduce the alternative setting cluster.initial_cluster_manager_nodes. 2.Use a new node role cluster_manager that has the same functionality with master in the node setting node.roles: [ master ] 3.Cat API _cat/master is deprecated with _cat/cluster_manager 4.Deprecate master_timeout parameter to cluster_manager_timeout 5.Deprecate several interfaces, for example CatMasterMasterRecord 6.Replaces tests and comments Issue Resolved: #221 Signed-off-by: Anan Zhuang <[email protected]> add some comments and toDos for master deprecation Signed-off-by: Anan Zhuang <[email protected]> update TODO and use JSDoc Signed-off-by: Anan Zhuang <[email protected]> * add more unit test to test cluster_manager role Signed-off-by: Anan Zhuang <[email protected]>
opensearch-project · May 25, 2022 · e008fe8 · e008fe8
1 parent 9f137e9
commit e008fe8
Show file tree

Hide file tree

Showing 31 changed files with 2,114 additions and 2,238 deletions.
diff --git a/api/api/cat.js b/api/api/cat.js
@@ -48,6 +48,7 @@ const acceptedQuerystring = [
   'source',
   'filter_path',
   'bytes',
+  'cluster_manager_timeout',
   'master_timeout',
   'fields',
   'time',
@@ -74,6 +75,7 @@ const snakeCase = {
   expandWildcards: 'expand_wildcards',
   errorTrace: 'error_trace',
   filterPath: 'filter_path',
+  clusterManagerTimeout: 'cluster_manager_timeout',
   masterTimeout: 'master_timeout',
   includeUnloadedSegments: 'include_unloaded_segments',
   allowNoMatch: 'allow_no_match',
@@ -263,6 +265,31 @@ CatApi.prototype.indices = function catIndicesApi(params, options, callback) {
   return this.transport.request(request, options, callback);
 };
 
+CatApi.prototype.cluster_manager = function catClusterManagerApi(params, options, callback) {
+  [params, options, callback] = normalizeArguments(params, options, callback);
+
+  let { method, body, ...querystring } = params;
+  querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
+
+  let path = '';
+  if (method == null) method = 'GET';
+  path = '/' + '_cat' + '/' + 'cluster_manager';
+
+  // build request object
+  const request = {
+    method,
+    path,
+    body: null,
+    querystring,
+  };
+
+  return this.transport.request(request, options, callback);
+};
+
+/**
+ * // TODO: delete CatApi.prototype.master when it is removed from OpenSearch
+ * @deprecated use CatApi.prototype.cluster_manager instead
+ */
 CatApi.prototype.master = function catMasterApi(params, options, callback) {
   [params, options, callback] = normalizeArguments(params, options, callback);
 

diff --git a/api/api/cluster.js b/api/api/cluster.js
@@ -43,6 +43,7 @@ const acceptedQuerystring = [
   'source',
   'filter_path',
   'timeout',
+  'cluster_manager_timeout',
   'master_timeout',
   'wait_for_removal',
   'local',
@@ -73,6 +74,7 @@ const snakeCase = {
   includeDiskInfo: 'include_disk_info',
   errorTrace: 'error_trace',
   filterPath: 'filter_path',
+  clusterManagerTimeout: 'cluster_manager_timeout',
   masterTimeout: 'master_timeout',
   waitForRemoval: 'wait_for_removal',
   flatSettings: 'flat_settings',

diff --git a/api/api/dangling_indices.js b/api/api/dangling_indices.js
@@ -37,6 +37,7 @@ const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } =
 const acceptedQuerystring = [
   'accept_data_loss',
   'timeout',
+  'cluster_manager_timeout',
   'master_timeout',
   'pretty',
   'human',
@@ -46,6 +47,7 @@ const acceptedQuerystring = [
 ];
 const snakeCase = {
   acceptDataLoss: 'accept_data_loss',
+  clusterManagerTimeout: 'cluster_manager_timeout',
   masterTimeout: 'master_timeout',
   errorTrace: 'error_trace',
   filterPath: 'filter_path',

diff --git a/api/api/delete_script.js b/api/api/delete_script.js
@@ -36,6 +36,7 @@
 const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
 const acceptedQuerystring = [
   'timeout',
+  'cluster_manager_timeout',
   'master_timeout',
   'pretty',
   'human',
@@ -44,6 +45,7 @@ const acceptedQuerystring = [
   'filter_path',
 ];
 const snakeCase = {
+  clusterManagerTimeout: 'cluster_manager_timeout',
   masterTimeout: 'master_timeout',
   errorTrace: 'error_trace',
   filterPath: 'filter_path',

diff --git a/api/api/features.js b/api/api/features.js
@@ -35,6 +35,7 @@
 
 const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
 const acceptedQuerystring = [
+  'cluster_manager_timeout',
   'master_timeout',
   'pretty',
   'human',
@@ -43,6 +44,7 @@ const acceptedQuerystring = [
   'filter_path',
 ];
 const snakeCase = {
+  clusterManagerTimeout: 'cluster_manager_timeout',
   masterTimeout: 'master_timeout',
   errorTrace: 'error_trace',
   filterPath: 'filter_path',

diff --git a/api/api/get_script.js b/api/api/get_script.js
@@ -35,6 +35,7 @@
 
 const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
 const acceptedQuerystring = [
+  'cluster_manager_timeout',
   'master_timeout',
   'pretty',
   'human',
@@ -43,6 +44,7 @@ const acceptedQuerystring = [
   'filter_path',
 ];
 const snakeCase = {
+  clusterManagerTimeout: 'cluster_manager_timeout',
   masterTimeout: 'master_timeout',
   errorTrace: 'error_trace',
   filterPath: 'filter_path',

diff --git a/api/api/indices.js b/api/api/indices.js
@@ -35,6 +35,7 @@
 
 const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
 const acceptedQuerystring = [
+  'cluster_manager_timeout',
   'timeout',
   'master_timeout',
   'ignore_unavailable',
@@ -92,6 +93,7 @@ const acceptedQuerystring = [
   'all_shards',
 ];
 const snakeCase = {
+  clusterManagerTimeout: 'cluster_manager_timeout',
   masterTimeout: 'master_timeout',
   ignoreUnavailable: 'ignore_unavailable',
   allowNoIndices: 'allow_no_indices',

diff --git a/api/api/ingest.js b/api/api/ingest.js
@@ -35,6 +35,7 @@
 
 const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
 const acceptedQuerystring = [
+  'cluster_manager_timeout',
   'master_timeout',
   'timeout',
   'pretty',
@@ -46,6 +47,7 @@ const acceptedQuerystring = [
   'verbose',
 ];
 const snakeCase = {
+  clusterManagerTimeout: 'cluster_manager_timeout',
   masterTimeout: 'master_timeout',
   errorTrace: 'error_trace',
   filterPath: 'filter_path',

diff --git a/api/api/put_script.js b/api/api/put_script.js
@@ -35,6 +35,7 @@
 
 const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
 const acceptedQuerystring = [
+  'cluster_manager_timeout',
   'timeout',
   'master_timeout',
   'context',
@@ -45,6 +46,7 @@ const acceptedQuerystring = [
   'filter_path',
 ];
 const snakeCase = {
+  clusterManagerTimeout: 'cluster_manager_timeout',
   masterTimeout: 'master_timeout',
   errorTrace: 'error_trace',
   filterPath: 'filter_path',

diff --git a/api/api/snapshot.js b/api/api/snapshot.js
@@ -35,6 +35,7 @@
 
 const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
 const acceptedQuerystring = [
+  'cluster_manager_timeout',
   'master_timeout',
   'timeout',
   'pretty',
@@ -61,6 +62,7 @@ const acceptedQuerystring = [
   'rarely_abort_writes',
 ];
 const snakeCase = {
+  clusterManagerTimeout: 'cluster_manager_timeout',
   masterTimeout: 'master_timeout',
   errorTrace: 'error_trace',
   filterPath: 'filter_path',