Deprecate the "Master" nomenclature in nodejs client

[ananzh]

Is your feature request related to a problem? Please describe.
Coming from opensearch-project/OpenSearch#2589.

OpenSearch repository is going to replace the terminology "master"with "cluster manager".
issue: opensearch-project/OpenSearch#472 (comment), with the plan for its terminology replacement.

Although the existing usages with "master" will be supported in OpenSearch version 2.x to keep the backwards compatibility, please prepare for the nomenclature change in advance, and replace all the usages with "master" terminology in the code base.
All the OpenSearch REST APIs and settings that contain "master" terminology will be deprecated in 2.0, and alternative usages will be added.

Describe the solution you'd like
Replace the terminology "master" with "cluster manager".

When being compatible with OpenSearch 2.0:

Replace "master" in code comment and internal variable / function name
Replace OpenSearch REST API that contains "master" with the provided inclusive REST API
Replace "master" in documentation
Specifically, for the impacted OpenSearch REST API:
Replace the API request parameter "master_timeout" with "cluster_manager_timeout" in:
https://github.com/opensearch-project/OpenSearch-Dashboards/tree/1.3.1/src/plugins/console/server/lib/spec_definitions/json/generated and
https://github.com/opensearch-project/OpenSearch-Dashboards/tree/1.3.1/packages/osd-spec-to-console/test/fixtures

[ananzh]

Affected API

Multiple APIs are affected directly/indirectly (params & types)

• Cat API is affected directly. Cat API can be used to cat master node
  index.d.ts:

  opensearch-js/index.d.ts

  Line 190 in 2b1b387

  master<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.CatMaster, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

  
  new.d.ts:
  

  opensearch-js/api/new.d.ts

  Line 133 in c56751a

  master<TContext = unknown>(params?: T.CatMasterRequest, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<T.CatMasterResponse, TContext>>

  
  

  opensearch-js/api/new.d.ts

  Line 136 in c56751a

  master<TContext = unknown>(params: T.CatMasterRequest, options: TransportRequestOptions, callback: callbackFn<T.CatMasterResponse, TContext>): TransportRequestCallback

  
  opensearch_dashboards.d.ts:
  

  opensearch-js/api/opensearch_dashboards.d.ts

  Line 101 in 437a243

  master<TContext = unknown>(params?: T.CatMasterRequest, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<T.CatMasterResponse, TContext>>

• API params definitions are affected which indirectly affect APIs
  There are many requestParams containing master_timeout, for example for Cat API params:
  Interface CatAllocation:
  

  opensearch-js/api/requestParams.d.ts

  Line 74 in c56751a

  master_timeout?: string;

  
  Interface CatIndices
  

  opensearch-js/api/requestParams.d.ts

  Line 120 in c56751a

  master_timeout?: string;

  
  Interface CatMaster
  

  opensearch-js/api/requestParams.d.ts

  Line 135 in c56751a

  master_timeout?: string;

  Below is a complete list (Cat API, Cluster API, Dangling API, Indices API and etc) :

Interface CatAllocation
Interface CatIndices
Interface CatMaster
Interface CatNodeattrs
Interface CatNodes
Interface CatPendingTasks
Interface CatPlugins
Interface CatRepositories
Interface CatShards
Interface CatSnapshots
Interface CatTemplates
Interface CatThreadPool
Interface ClusterDeleteComponentTemplate
interface ClusterGetComponentTemplate
interface ClusterGetSettings
interface ClusterGetSettings
interface ClusterHealth
interface ClusterPendingTasks
interface ClusterPutComponentTemplate
interface ClusterPutSettings
interface ClusterReroute
interface ClusterState
interface DanglingIndicesDeleteDanglingIndex
interface DeleteScript
interface FeaturesGetFeatures
interface GetScript
interface IndicesAddBlock
interface IndicesClone
interface IndicesClose
interface IndicesCreate
interface IndicesDelete
interface IndicesDeleteAlias
interface IndicesDeleteIndexTemplate
interface IndicesDeleteTemplate
interface IndicesExistsIndexTemplate
interface IndicesExistsTemplate
interface IndicesGet
interface IndicesGetIndexTemplate
interface IndicesGetMapping
interface IndicesGetSettings
interface IndicesGetTemplate
interface IndicesOpen
interface IndicesPutAlias
interface IndicesPutIndexTemplate
interface IndicesPutMapping
interface IndicesPutSettings
interface IndicesPutTemplate
interface IndicesRollover
interface IndicesShrink
interface IndicesSimulateIndexTemplate
interface IndicesSimulateTemplate
interface IndicesSplit
interface IndicesUpdateAliases
interface IngestDeletePipeline
interface IngestGetPipeline
interface IngestPutPipeline
interface PutScript
interface SnapshotCleanupRepository
interface SnapshotClone
interface SnapshotCreate
interface SnapshotCreateRepository
interface SnapshotDelete
interface SnapshotDeleteRepository
interface SnapshotGet
interface SnapshotGetRepository
interface SnapshotRestore
interface SnapshotStatus
interface SnapshotVerifyRepository

• Types used in APIs containing keys master, master_timeout, master_node, initial_master_nodes? or has master in the name (interface CatMasterMasterRecord, interface CatMasterRequest, type CatMasterResponse). Below is the complete list:

interface DeleteScriptRequest
interface GetScriptRequest
interface PutScriptRequest
interface ClusterDeleteComponentTemplateRequest
interface ClusterGetComponentTemplateRequest
interface ClusterGetSettingsRequest
interface ClusterHealthRequest
interface ClusterPendingTasksRequest
interface ClusterPutComponentTemplateRequest
interface ClusterPutSettingsRequest
interface ClusterRerouteRequest
interface ClusterStateRequest
interface IndicesAddBlockRequest
interface IndicesCloneRequest
interface IndicesCloseRequest
interface IndicesCreateRequest
interface IndicesDeleteRequest
interface IndicesDeleteAliasRequest
interface IndicesDeleteTemplateRequest
interface IndicesExistsIndexTemplateRequest
interface IndicesExistsTemplateRequest
interface IndicesGetRequest
interface IndicesGetIndexTemplateRequest
interface IndicesGetMappingRequest
interface IndicesGetSettingsRequest
interface IndicesGetTemplateRequest
interface IndicesOpenRequest
interface IndicesPutAliasRequest
interface IndicesPutMappingRequest
interface IndicesPutSettingsRequest
interface IndicesPutTemplateRequest
interface IndicesRolloverRequest
interface IndicesShrinkRequest
interface IndicesSimulateTemplateRequest
interface IndicesSplitRequest 
interface IndicesUpdateAliasesRequest
interface IngestDeletePipelineRequest
interface IngestGetPipelineRequest
interface IngestPutPipelineRequest
interface NodesInfoRequest
interface NodesStatsRequest
interface SnapshotCleanupRepositoryRequest
interface SnapshotCloneRequest
interface SnapshotCreateRequest
interface SnapshotCreateRepositoryRequest
interface SnapshotDeleteRequest
interface SnapshotDeleteRepositoryRequest
interface SnapshotGetRequest
interface SnapshotGetRepositoryRequest
interface SnapshotRestoreRequest
interface SnapshotStatusRequest
interface SnapshotVerifyRepositoryRequest
interface SpecUtilsCommonCatQueryParameters
interface ClusterRerouteRerouteState
interface ClusterStateResponse
interface NodesInfoNodeInfoSettingsCluster
interface CatNodesNodesRecord
interface ClusterStatsClusterNodeCount
interface CatMasterMasterRecord
interface CatMasterRequest
type CatMasterResponse

• Contains master in variable definition and affect other functions

const acceptedQuerystring = [ …, ‘master_timeout’, …]
snakeCase key and value:
const snakeCase = {…,  masterTimeout: 'master_timeout’, …}

opensearch-js/api/api/cat.js

Line 37 in 5328c31

const acceptedQuerystring = ['format', 'local', 'h', 'help', 's', 'v', 'expand_wildcards', 'pretty', 'human', 'error_trace', 'source', 'filter_path', 'bytes', 'master_timeout', 'fields', 'time', 'ts', 'health', 'pri', 'include_unloaded_segments', 'allow_no_match', 'allow_no_datafeeds', 'allow_no_jobs', 'from', 'size', 'full_id', 'include_bootstrap', 'active_only', 'detailed', 'index', 'ignore_unavailable', 'nodes', 'actions', 'parent_task_id']

opensearch-js/api/api/cat.js

Line 38 in 5328c31

const snakeCase = { expandWildcards: 'expand_wildcards', errorTrace: 'error_trace', filterPath: 'filter_path', masterTimeout: 'master_timeout', includeUnloadedSegments: 'include_unloaded_segments', allowNoMatch: 'allow_no_match', allowNoDatafeeds: 'allow_no_datafeeds', allowNoJobs: 'allow_no_jobs', fullId: 'full_id', includeBootstrap: 'include_bootstrap', activeOnly: 'active_only', ignoreUnavailable: 'ignore_unavailable', parentTaskId: 'parent_task_id' }

Here is a complete list:

api/api/cat.js
api/api/cluster.js
api/api/dangling_indices.js
api/api/delete_script.js
api/api/features.js
api/api/get_script.js
api/api/indices.js
api/api/ingest.js
api/api/put_script.js
api/api/snapshot.js

• MASTER/master key in lib that affects multiple functions
  

  opensearch-js/lib/Transport.js

  Line 614 in 2b1b387

  if (node.roles.master === true &&

  
  

  opensearch-js/lib/pool/BaseConnectionPool.js

  Line 246 in c56751a

  [Connection.roles.MASTER]: false,

  
  

  opensearch-js/lib/Connection.d.ts

  Line 57 in c56751a

  master?: boolean

  
  

  opensearch-js/lib/Connection.d.ts

  Line 81 in c56751a

  MASTER: string;

  
  

  opensearch-js/lib/Connection.js

  Line 296 in c56751a

  MASTER: 'master',

  
  

  opensearch-js/lib/Connection.js

  Line 302 in c56751a

  [Connection.roles.MASTER]: true,

  
  

  opensearch-js/lib/Connection.js

  Line 302 in c56751a

  [Connection.roles.MASTER]: true,

[ananzh]

Affected Tests
*MASTER/master key in Connect roles or cluster node roles, for example:

opensearch-js/test/utils/buildCluster.js

Line 76 in c56751a

roles: ['master', 'data', 'ingest']

opensearch-js/test/types/connection.test-d.ts

Line 44 in c56751a

roles: { master: true },

*Affect Mock

opensearch-js/test/utils/MockConnection.js

Line 107 in 5328c31

roles: ['master', 'data', 'ingest']

opensearch-js/test/utils/MockConnection.js

Line 113 in 5328c31

roles: ['master', 'data', 'ingest']

Test list:

test/types/connection.test-d.ts
test/unit/Base-connection-pool.test.js
test/unit/Client.test.js
test/unit/Connection-pool.test.js
test/unit/Connection.test.js
test/utils/buildCluster.js
test/utils/MockConnection.js
test/acceptance/sniff.test.js

Others
*comments

opensearch-js/test/integration/test-runner.js

Line 161 in c56751a

* let's say the we have stashed the `master` value,

opensearch-js/test/integration/test-runner.js

Line 162 in c56751a

* is_true: nodes.$master.transport.profiles

opensearch-js/lib/pool/ConnectionPool.js

Line 191 in c56751a

* By default it filters the `master` only nodes.

opensearch-js/lib/pool/index.d.ts

Line 112 in 705df17

* By default it filters the `master` only nodes.

opensearch-js/lib/Transport.js

Line 613 in 2b1b387

// avoid master only nodes

*data
Might need to change test data in stackoverflow.ndjson, for example:
https://github.com/opensearch-project/opensearch-js/blob/c56751acae73f4735bf7efa3ddf1abc378c2e1a6/test/fixtures/stackoverflow.ndjson#L603