👍Use a separately maintained set of ElasticSearchClientOptions

This completely decouples us from any particular point release of the
ElasticSearch Client

Signed-off-by: Charles Lowell <cowboyd@frontside.com>

plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchClientOptions.ts

@@ -0,0 +1,125 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { ConnectionOptions as TLSConnectionOptions } from 'tls';
+
+/**
+ * Options used to configure the `@elastic/elasticsearch` client and
+ * are what will be passed as an argument to the
+ * {@link ElasticSearchEngine.newClient} method
+ *
+ * They are drawn from the `ClientOptions` class of `@elastic/elasticsearch`,
+ * but are maintained separately so that this interface is not coupled to
+ */
+export interface ElasticSearchClientOptions {
+  provider?: 'aws' | 'elastic';
+  node?:
+    | string
+    | string[]
+    | ElasticSearchNodeOptions
+    | ElasticSearchNodeOptions[];
+  nodes?:
+    | string
+    | string[]
+    | ElasticSearchNodeOptions
+    | ElasticSearchNodeOptions[];
+  Transport?: ElasticSearchTransportConstructor;
+  Connection?: ElasticSearchConnectionConstructor;
+  maxRetries?: number;
+  requestTimeout?: number;
+  pingTimeout?: number;
+  sniffInterval?: number | boolean;
+  sniffOnStart?: boolean;
+  sniffEndpoint?: string;
+  sniffOnConnectionFault?: boolean;
+  resurrectStrategy?: 'ping' | 'optimistic' | 'none';
+  suggestCompression?: boolean;
+  compression?: 'gzip';
+  ssl?: TLSConnectionOptions;
+  agent?: ElasticSearchAgentOptions | ((opts?: any) => unknown) | false;
+  nodeFilter?: (connection: any) => boolean;
+  nodeSelector?: ((connections: any[]) => any) | string;
+  headers?: Record<string, any>;
+  opaqueIdPrefix?: string;
+  name?: string | symbol;
+  auth?: ElasticSearchAuth;
+  proxy?: string | URL;
+  enableMetaHeader?: boolean;
+  cloud?: {
+    id: string;
+    username?: string;
+    password?: string;
+  };
+  disablePrototypePoisoningProtection?: boolean | 'proto' | 'constructor';
+}
+
+export type ElasticSearchAuth =
+  | {
+      username: string;
+      password: string;
+    }
+  | {
+      apiKey:
+        | string
+        | {
+            id: string;
+            api_key: string;
+          };
+    };
+
+export interface ElasticSearchNodeOptions {
+  url: URL;
+  id?: string;
+  agent?: ElasticSearchAgentOptions;
+  ssl?: TLSConnectionOptions;
+  headers?: Record<string, any>;
+  roles?: {
+    master: boolean;
+    data: boolean;
+    ingest: boolean;
+    ml: boolean;
+  };
+}
+
+export interface ElasticSearchAgentOptions {
+  keepAlive?: boolean;
+  keepAliveMsecs?: number;
+  maxSockets?: number;
+  maxFreeSockets?: number;
+}
+
+export interface ElasticSearchConnectionConstructor {
+  new (opts?: any): any;
+  statuses: {
+    ALIVE: string;
+    DEAD: string;
+  };
+  roles: {
+    MASTER: string;
+    DATA: string;
+    INGEST: string;
+    ML: string;
+  };
+}
+
+export interface ElasticSearchTransportConstructor {
+  new (opts?: any): any;
+  sniffReasons: {
+    SNIFF_ON_START: string;
+    SNIFF_INTERVAL: string;
+    SNIFF_ON_CONNECTION_FAULT: string;
+    DEFAULT: string;
+  };
+}

plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.test.ts

@@ -55,7 +55,8 @@ describe('ElasticSearchSearchEngine', () => {
       '',
       getVoidLogger(),
     );
-    client = testSearchEngine.elasticSearchClient;
+    // eslint-disable-next-line dot-notation
+    client = testSearchEngine['elasticSearchClient'];
   });
 
   describe('queryTranslator', () => {

plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts

@@ -30,11 +30,9 @@ import esb from 'elastic-builder';
 import { isEmpty, isNaN as nan, isNumber } from 'lodash';
 import { Logger } from 'winston';
 
-export type ElasticSearchClientOptions = ConstructorParameters<
-  typeof Client
->[0] & {
-  provider?: 'aws' | 'elastic' | 'generic';
-};
+import type { ElasticSearchClientOptions } from './ElasticSearchClientOptions';
+
+export type { ElasticSearchClientOptions };
 
 export type ConcreteElasticSearchQuery = {
   documentTypes?: string[];
@@ -366,7 +364,6 @@ async function createElasticSearchClientOptions(
           password: authConfig.getString('password'),
         });
   return {
-    provider: 'generic',
     node: config.getString('node'),
     auth,
     ...(sslConfig

plugins/search-backend-module-elasticsearch/src/engines/index.ts

@@ -15,4 +15,7 @@
  */
 
 export { ElasticSearchSearchEngine } from './ElasticSearchSearchEngine';
-export type { ConcreteElasticSearchQuery } from './ElasticSearchSearchEngine';
+export type {
+  ConcreteElasticSearchQuery,
+  ElasticSearchClientOptions,
+} from './ElasticSearchSearchEngine';