@backstage/plugin-search-backend-module-elasticsearch 0.0.3 → 0.0.7

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @backstage/plugin-search-backend-module-elasticsearch
 
+## 0.0.7
+
+### Patch Changes
+
+- 68512f5178: Add `newClient()` method to re-use the configuration of the elastic search
+  engine with custom clients
+
+## 0.0.6
+
+### Patch Changes
+
+- dcd1a0c3f4: Minor improvement to the API reports, by not unpacking arguments directly
+
+## 0.0.5
+
+### Patch Changes
+
+- 36350bf8b3: Pinning version of elastic search client to 7.13.0 to prevent breaking change towards third party ElasticSearch clusters on 7.14.0.
+
+## 0.0.4
+
+### Patch Changes
+
+- f0c2c81676: Added rejectUnauthorized config option
+
 ## 0.0.3
 
 ### Patch Changes

package/config.d.ts

@@ -20,90 +20,103 @@ export interface Config {
     /**
      * Options for ElasticSearch
      */
-    elasticsearch?:
-      | // elastic = Elastic.co ElasticSearch provider
-      {
-          provider: 'elastic';
-
+    elasticsearch?: {
+      /** Miscellaneous options for the client */
+      clientOptions?: {
+        ssl?: {
           /**
-           * Elastic.co CloudID
-           * See: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#authentication
+           * If true the server will reject any connection which is not
+           * authorized with the list of supplied CAs.
+           * @default true
            */
-          cloudId: string;
-
-          auth: {
-            username: string;
+          rejectUnauthorized?: boolean;
+        };
+      } & (
+        | {
+            // elastic = Elastic.co ElasticSearch provider
+            provider: 'elastic';
 
             /**
-             * @visibility secret
+             * Elastic.co CloudID
+             * See: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#authentication
              */
-            password: string;
-          };
-        }
+            cloudId: string;
 
-      /**
-       *  AWS = Amazon Elasticsearch Service provider
-       *
-       *  Authentication is handled using the default AWS credentials provider chain
-       */
-      | {
-          provider: 'aws';
+            auth: {
+              username: string;
 
-          /**
-           * Node configuration.
-           * URL AWS ES endpoint to connect to.
-           * Eg. https://my-es-cluster.eu-west-1.es.amazonaws.com
-           */
-          node: string;
-        }
+              /**
+               * @visibility secret
+               */
+              password: string;
+            };
+          }
 
-      /**
-       * Standard ElasticSearch
-       *
-       * Includes self-hosted clusters and others that provide direct connection via an endpoint
-       * and authentication method (see possible authentication options below)
-       */
-      | {
-          /**
-           * Node configuration.
-           * URL/URLS to ElasticSearch node to connect to.
-           * Either direct URL like 'https://localhost:9200' or with credentials like 'https://username:password@localhost:9200'
-           */
-          node: string | string[];
+        /**
+         *  AWS = Amazon Elasticsearch Service provider
+         *
+         *  Authentication is handled using the default AWS credentials provider chain
+         */
+        | {
+            provider: 'aws';
 
-          /**
-           * Authentication credentials for ElasticSearch
-           * If both ApiKey/Bearer token and username+password is provided, tokens take precedence
-           */
-          auth?:
-            | {
-                username: string;
+            /**
+             * Node configuration.
+             * URL AWS ES endpoint to connect to.
+             * Eg. https://my-es-cluster.eu-west-1.es.amazonaws.com
+             */
+            node: string;
+          }
 
-                /**
-                 * @visibility secret
-                 */
-                password: string;
-              }
-            | {
-                /**
-                 * Base64 Encoded API key to be used to connect to the cluster.
-                 * See: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
-                 *
-                 * @visibility secret
-                 */
-                apiKey: string;
-              };
-          /* TODO(kuangp): unsupported until @elastic/elasticsearch@7.14 is released
+        /**
+         * Standard ElasticSearch
+         *
+         * Includes self-hosted clusters and others that provide direct connection via an endpoint
+         * and authentication method (see possible authentication options below)
+         */
         | {
+            /**
+             * Node configuration.
+             * URL/URLS to ElasticSearch node to connect to.
+             * Either direct URL like 'https://localhost:9200' or with credentials like 'https://username:password@localhost:9200'
+             */
+            node: string | string[];
 
-          /**
-           * Bearer authentication token to connect to the cluster.
-           * See: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html
-           *
-           * @visibility secret
-           *
-          bearer: string;
-        };*/
-        };
+            /**
+             * Authentication credentials for ElasticSearch
+             * If both ApiKey/Bearer token and username+password is provided, tokens take precedence
+             */
+            auth?:
+              | {
+                  username: string;
+
+                  /**
+                   * @visibility secret
+                   */
+                  password: string;
+                }
+              | {
+                  /**
+                   * Base64 Encoded API key to be used to connect to the cluster.
+                   * See: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
+                   *
+                   * @visibility secret
+                   */
+                  apiKey: string;
+                };
+            /* TODO(kuangp): unsupported until @elastic/elasticsearch@7.14 is released
+    | {
+ 
+      /**
+       * Bearer authentication token to connect to the cluster.
+       * See: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html
+       *
+       * @visibility secret
+       *
+      bearer: string;
+    };*/
+          }
+      );
+    };
   };
 }

package/dist/index.cjs.js

@@ -20,12 +20,13 @@ function isBlank(str) {
   return lodash.isEmpty(str) && !lodash.isNumber(str) || lodash.isNaN(str);
 }
 class ElasticSearchSearchEngine {
-  constructor(elasticSearchClient, aliasPostfix, indexPrefix, logger) {
-    this.elasticSearchClient = elasticSearchClient;
+  constructor(elasticSearchClientOptions, aliasPostfix, indexPrefix, logger) {
+    this.elasticSearchClientOptions = elasticSearchClientOptions;
     this.aliasPostfix = aliasPostfix;
     this.indexPrefix = indexPrefix;
     this.logger = logger;
     this.indexSeparator = "-index__";
+    this.elasticSearchClient = this.newClient((options) => new elasticsearch.Client(options));
   }
   static async fromConfig({
     logger,
@@ -33,68 +34,36 @@ class ElasticSearchSearchEngine {
     aliasPostfix = `search`,
     indexPrefix = ``
   }) {
-    return new ElasticSearchSearchEngine(await ElasticSearchSearchEngine.constructElasticSearchClient(logger, config.getConfig("search.elasticsearch")), aliasPostfix, indexPrefix, logger);
-  }
-  static async constructElasticSearchClient(logger, config) {
-    if (!config) {
-      throw new Error("No elastic search config found");
-    }
-    if (config.getOptionalString("provider") === "elastic") {
+    const options = await createElasticSearchClientOptions(config.getConfig("search.elasticsearch"));
+    if (options.provider === "elastic") {
       logger.info("Initializing Elastic.co ElasticSearch search engine.");
-      const authConfig2 = config.getConfig("auth");
-      return new elasticsearch.Client({
-        cloud: {
-          id: config.getString("cloudId")
-        },
-        auth: {
-          username: authConfig2.getString("username"),
-          password: authConfig2.getString("password")
-        }
-      });
-    }
-    if (config.getOptionalString("provider") === "aws") {
+    } else if (options.provider === "aws") {
       logger.info("Initializing AWS ElasticSearch search engine.");
-      const awsCredentials = await awsEsConnection.awsGetCredentials();
-      const AWSConnection = awsEsConnection.createAWSConnection(awsCredentials);
-      return new elasticsearch.Client({
-        node: config.getString("node"),
-        ...AWSConnection
-      });
+    } else {
+      logger.info("Initializing ElasticSearch search engine.");
     }
-    logger.info("Initializing ElasticSearch search engine.");
-    const authConfig = config.getOptionalConfig("auth");
-    const auth = authConfig && (authConfig.has("apiKey") ? {
-      apiKey: authConfig.getString("apiKey")
-    } : {
-      username: authConfig.getString("username"),
-      password: authConfig.getString("password")
-    });
-    return new elasticsearch.Client({
-      node: config.getString("node"),
-      auth
-    });
+    return new ElasticSearchSearchEngine(options, aliasPostfix, indexPrefix, logger);
   }
-  translator({
-    term,
-    filters = {},
-    types,
-    pageCursor
-  }) {
+  newClient(create) {
+    return create(this.elasticSearchClientOptions);
+  }
+  translator(query) {
+    const { term, filters = {}, types, pageCursor } = query;
     const filter = Object.entries(filters).filter(([_, value]) => Boolean(value)).map(([key, value]) => {
       if (["string", "number", "boolean"].includes(typeof value)) {
-        return esb__default['default'].matchQuery(key, value.toString());
+        return esb__default["default"].matchQuery(key, value.toString());
       }
       if (Array.isArray(value)) {
-        return esb__default['default'].boolQuery().should(value.map((it) => esb__default['default'].matchQuery(key, it.toString())));
+        return esb__default["default"].boolQuery().should(value.map((it) => esb__default["default"].matchQuery(key, it.toString())));
       }
       this.logger.error("Failed to query, unrecognized filter type", key, value);
       throw new Error("Failed to add filters to query. Unrecognized filter type");
     });
-    const query = isBlank(term) ? esb__default['default'].matchAllQuery() : esb__default['default'].multiMatchQuery(["*"], term).fuzziness("auto").minimumShouldMatch(1);
+    const esbQuery = isBlank(term) ? esb__default["default"].matchAllQuery() : esb__default["default"].multiMatchQuery(["*"], term).fuzziness("auto").minimumShouldMatch(1);
     const pageSize = 25;
-    const {page} = decodePageCursor(pageCursor);
+    const { page } = decodePageCursor(pageCursor);
     return {
-      elasticSearchQuery: esb__default['default'].requestBodySearch().query(esb__default['default'].boolQuery().filter(filter).must([query])).from(page * pageSize).size(pageSize).toJSON(),
+      elasticSearchQuery: esb__default["default"].requestBodySearch().query(esb__default["default"].boolQuery().filter(filter).must([esbQuery])).from(page * pageSize).size(pageSize).toJSON(),
       documentTypes: types,
       pageSize
     };
@@ -120,7 +89,7 @@ class ElasticSearchSearchEngine {
         datasource: documents,
         onDocument() {
           return {
-            index: {_index: index}
+            index: { _index: index }
           };
         },
         refreshOnCompletion: index
@@ -129,8 +98,8 @@ class ElasticSearchSearchEngine {
       await this.elasticSearchClient.indices.updateAliases({
         body: {
           actions: [
-            {remove: {index: this.constructIndexName(type, "*"), alias}},
-            {add: {index, alias}}
+            { remove: { index: this.constructIndexName(type, "*"), alias } },
+            { add: { index, alias } }
           ]
         }
       });
@@ -155,18 +124,18 @@ class ElasticSearchSearchEngine {
     }
   }
   async query(query) {
-    const {elasticSearchQuery, documentTypes, pageSize} = this.translator(query);
+    const { elasticSearchQuery, documentTypes, pageSize } = this.translator(query);
     const queryIndices = documentTypes ? documentTypes.map((it) => this.constructSearchAlias(it)) : this.constructSearchAlias("*");
     try {
       const result = await this.elasticSearchClient.search({
         index: queryIndices,
         body: elasticSearchQuery
       });
-      const {page} = decodePageCursor(query.pageCursor);
+      const { page } = decodePageCursor(query.pageCursor);
       const hasNextPage = result.body.hits.total.value > page * pageSize;
       const hasPreviousPage = page > 0;
-      const nextPageCursor = hasNextPage ? encodePageCursor({page: page + 1}) : void 0;
-      const previousPageCursor = hasPreviousPage ? encodePageCursor({page: page - 1}) : void 0;
+      const nextPageCursor = hasNextPage ? encodePageCursor({ page: page + 1 }) : void 0;
+      const previousPageCursor = hasPreviousPage ? encodePageCursor({ page: page - 1 }) : void 0;
       return {
         results: result.body.hits.hits.map((d) => ({
           type: this.getTypeFromIndex(d._index),
@@ -177,7 +146,7 @@ class ElasticSearchSearchEngine {
       };
     } catch (e) {
       this.logger.error(`Failed to query documents for indices ${queryIndices}`, e);
-      return Promise.reject({results: []});
+      return Promise.reject({ results: [] });
     }
   }
   constructIndexName(type, postFix) {
@@ -193,15 +162,70 @@ class ElasticSearchSearchEngine {
 }
 function decodePageCursor(pageCursor) {
   if (!pageCursor) {
-    return {page: 0};
+    return { page: 0 };
   }
   return {
     page: Number(Buffer.from(pageCursor, "base64").toString("utf-8"))
   };
 }
-function encodePageCursor({page}) {
+function encodePageCursor({ page }) {
   return Buffer.from(`${page}`, "utf-8").toString("base64");
 }
+async function createElasticSearchClientOptions(config) {
+  if (!config) {
+    throw new Error("No elastic search config found");
+  }
+  const clientOptionsConfig = config.getOptionalConfig("clientOptions");
+  const sslConfig = clientOptionsConfig == null ? void 0 : clientOptionsConfig.getOptionalConfig("ssl");
+  if (config.getOptionalString("provider") === "elastic") {
+    const authConfig2 = config.getConfig("auth");
+    return {
+      provider: "elastic",
+      cloud: {
+        id: config.getString("cloudId")
+      },
+      auth: {
+        username: authConfig2.getString("username"),
+        password: authConfig2.getString("password")
+      },
+      ...sslConfig ? {
+        ssl: {
+          rejectUnauthorized: sslConfig == null ? void 0 : sslConfig.getOptionalBoolean("rejectUnauthorized")
+        }
+      } : {}
+    };
+  }
+  if (config.getOptionalString("provider") === "aws") {
+    const awsCredentials = await awsEsConnection.awsGetCredentials();
+    const AWSConnection = awsEsConnection.createAWSConnection(awsCredentials);
+    return {
+      provider: "aws",
+      node: config.getString("node"),
+      ...AWSConnection,
+      ...sslConfig ? {
+        ssl: {
+          rejectUnauthorized: sslConfig == null ? void 0 : sslConfig.getOptionalBoolean("rejectUnauthorized")
+        }
+      } : {}
+    };
+  }
+  const authConfig = config.getOptionalConfig("auth");
+  const auth = authConfig && (authConfig.has("apiKey") ? {
+    apiKey: authConfig.getString("apiKey")
+  } : {
+    username: authConfig.getString("username"),
+    password: authConfig.getString("password")
+  });
+  return {
+    node: config.getString("node"),
+    auth,
+    ...sslConfig ? {
+      ssl: {
+        rejectUnauthorized: sslConfig == null ? void 0 : sslConfig.getOptionalBoolean("rejectUnauthorized")
+      }
+    } : {}
+  };
+}
 
 exports.ElasticSearchSearchEngine = ElasticSearchSearchEngine;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/engines/ElasticSearchSearchEngine.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  awsGetCredentials,\n  createAWSConnection,\n} from '@acuris/aws-es-connection';\nimport { Config } from '@backstage/config';\nimport {\n  IndexableDocument,\n  SearchEngine,\n  SearchQuery,\n  SearchResultSet,\n} from '@backstage/search-common';\nimport { Client } from '@elastic/elasticsearch';\nimport esb from 'elastic-builder';\nimport { isEmpty, isNaN as nan, isNumber } from 'lodash';\nimport { Logger } from 'winston';\n\nexport type ConcreteElasticSearchQuery = {\n  documentTypes?: string[];\n  elasticSearchQuery: Object;\n  pageSize: number;\n};\n\ntype ElasticSearchQueryTranslator = (\n  query: SearchQuery,\n) => ConcreteElasticSearchQuery;\n\ntype ElasticSearchOptions = {\n  logger: Logger;\n  config: Config;\n  aliasPostfix?: string;\n  indexPrefix?: string;\n};\n\ntype ElasticSearchResult = {\n  _index: string;\n  _type: string;\n  _score: number;\n  _source: IndexableDocument;\n};\n\nfunction duration(startTimestamp: [number, number]): string {\n  const delta = process.hrtime(startTimestamp);\n  const seconds = delta[0] + delta[1] / 1e9;\n  return `${seconds.toFixed(1)}s`;\n}\n\nfunction isBlank(str: string) {\n  return (isEmpty(str) && !isNumber(str)) || nan(str);\n}\n\nexport class ElasticSearchSearchEngine implements SearchEngine {\n  constructor(\n    private readonly elasticSearchClient: Client,\n    private readonly aliasPostfix: string,\n    private readonly indexPrefix: string,\n    private readonly logger: Logger,\n  ) {}\n\n  static async fromConfig({\n    logger,\n    config,\n    aliasPostfix = `search`,\n    indexPrefix = ``,\n  }: ElasticSearchOptions) {\n    return new ElasticSearchSearchEngine(\n      await ElasticSearchSearchEngine.constructElasticSearchClient(\n        logger,\n        config.getConfig('search.elasticsearch'),\n      ),\n      aliasPostfix,\n      indexPrefix,\n      logger,\n    );\n  }\n\n  private static async constructElasticSearchClient(\n    logger: Logger,\n    config?: Config,\n  ) {\n    if (!config) {\n      throw new Error('No elastic search config found');\n    }\n\n    if (config.getOptionalString('provider') === 'elastic') {\n      logger.info('Initializing Elastic.co ElasticSearch search engine.');\n      const authConfig = config.getConfig('auth');\n      return new Client({\n        cloud: {\n          id: config.getString('cloudId'),\n        },\n        auth: {\n          username: authConfig.getString('username'),\n          password: authConfig.getString('password'),\n        },\n      });\n    }\n    if (config.getOptionalString('provider') === 'aws') {\n      logger.info('Initializing AWS ElasticSearch search engine.');\n      const awsCredentials = await awsGetCredentials();\n      const AWSConnection = createAWSConnection(awsCredentials);\n      return new Client({\n        node: config.getString('node'),\n        ...AWSConnection,\n      });\n    }\n    logger.info('Initializing ElasticSearch search engine.');\n    const authConfig = config.getOptionalConfig('auth');\n    const auth =\n      authConfig &&\n      (authConfig.has('apiKey')\n        ? {\n            apiKey: authConfig.getString('apiKey'),\n          }\n        : {\n            username: authConfig.getString('username'),\n            password: authConfig.getString('password'),\n          });\n    return new Client({\n      node: config.getString('node'),\n      auth,\n    });\n  }\n\n  protected translator({\n    term,\n    filters = {},\n    types,\n    pageCursor,\n  }: SearchQuery): ConcreteElasticSearchQuery {\n    const filter = Object.entries(filters)\n      .filter(([_, value]) => Boolean(value))\n      .map(([key, value]: [key: string, value: any]) => {\n        if (['string', 'number', 'boolean'].includes(typeof value)) {\n          return esb.matchQuery(key, value.toString());\n        }\n        if (Array.isArray(value)) {\n          return esb\n            .boolQuery()\n            .should(value.map(it => esb.matchQuery(key, it.toString())));\n        }\n        this.logger.error(\n          'Failed to query, unrecognized filter type',\n          key,\n          value,\n        );\n        throw new Error(\n          'Failed to add filters to query. Unrecognized filter type',\n        );\n      });\n    const query = isBlank(term)\n      ? esb.matchAllQuery()\n      : esb\n          .multiMatchQuery(['*'], term)\n          .fuzziness('auto')\n          .minimumShouldMatch(1);\n    const pageSize = 25;\n    const { page } = decodePageCursor(pageCursor);\n\n    return {\n      elasticSearchQuery: esb\n        .requestBodySearch()\n        .query(esb.boolQuery().filter(filter).must([query]))\n        .from(page * pageSize)\n        .size(pageSize)\n        .toJSON(),\n      documentTypes: types,\n      pageSize,\n    };\n  }\n\n  setTranslator(translator: ElasticSearchQueryTranslator) {\n    this.translator = translator;\n  }\n\n  async index(type: string, documents: IndexableDocument[]): Promise<void> {\n    this.logger.info(\n      `Started indexing ${documents.length} documents for index ${type}`,\n    );\n    const startTimestamp = process.hrtime();\n    const alias = this.constructSearchAlias(type);\n    const index = this.constructIndexName(type, `${Date.now()}`);\n    try {\n      const aliases = await this.elasticSearchClient.cat.aliases({\n        format: 'json',\n        name: alias,\n      });\n      const removableIndices = aliases.body.map(\n        (r: Record<string, any>) => r.index,\n      );\n\n      await this.elasticSearchClient.indices.create({\n        index,\n      });\n      const result = await this.elasticSearchClient.helpers.bulk({\n        datasource: documents,\n        onDocument() {\n          return {\n            index: { _index: index },\n          };\n        },\n        refreshOnCompletion: index,\n      });\n\n      this.logger.info(\n        `Indexing completed for index ${type} in ${duration(startTimestamp)}`,\n        result,\n      );\n      await this.elasticSearchClient.indices.updateAliases({\n        body: {\n          actions: [\n            { remove: { index: this.constructIndexName(type, '*'), alias } },\n            { add: { index, alias } },\n          ],\n        },\n      });\n\n      this.logger.info('Removing stale search indices', removableIndices);\n      if (removableIndices.length) {\n        await this.elasticSearchClient.indices.delete({\n          index: removableIndices,\n        });\n      }\n    } catch (e) {\n      this.logger.error(`Failed to index documents for type ${type}`, e);\n      const response = await this.elasticSearchClient.indices.exists({\n        index,\n      });\n      const indexCreated = response.body;\n      if (indexCreated) {\n        this.logger.info(`Removing created index ${index}`);\n        await this.elasticSearchClient.indices.delete({\n          index,\n        });\n      }\n    }\n  }\n\n  async query(query: SearchQuery): Promise<SearchResultSet> {\n    const { elasticSearchQuery, documentTypes, pageSize } =\n      this.translator(query);\n    const queryIndices = documentTypes\n      ? documentTypes.map(it => this.constructSearchAlias(it))\n      : this.constructSearchAlias('*');\n    try {\n      const result = await this.elasticSearchClient.search({\n        index: queryIndices,\n        body: elasticSearchQuery,\n      });\n      const { page } = decodePageCursor(query.pageCursor);\n      const hasNextPage = result.body.hits.total.value > page * pageSize;\n      const hasPreviousPage = page > 0;\n      const nextPageCursor = hasNextPage\n        ? encodePageCursor({ page: page + 1 })\n        : undefined;\n      const previousPageCursor = hasPreviousPage\n        ? encodePageCursor({ page: page - 1 })\n        : undefined;\n\n      return {\n        results: result.body.hits.hits.map((d: ElasticSearchResult) => ({\n          type: this.getTypeFromIndex(d._index),\n          document: d._source,\n        })),\n        nextPageCursor,\n        previousPageCursor,\n      };\n    } catch (e) {\n      this.logger.error(\n        `Failed to query documents for indices ${queryIndices}`,\n        e,\n      );\n      return Promise.reject({ results: [] });\n    }\n  }\n\n  private readonly indexSeparator = '-index__';\n\n  private constructIndexName(type: string, postFix: string) {\n    return `${this.indexPrefix}${type}${this.indexSeparator}${postFix}`;\n  }\n\n  private getTypeFromIndex(index: string) {\n    return index\n      .substring(this.indexPrefix.length)\n      .split(this.indexSeparator)[0];\n  }\n\n  private constructSearchAlias(type: string) {\n    const postFix = this.aliasPostfix ? `__${this.aliasPostfix}` : '';\n    return `${this.indexPrefix}${type}${postFix}`;\n  }\n}\n\nexport function decodePageCursor(pageCursor?: string): { page: number } {\n  if (!pageCursor) {\n    return { page: 0 };\n  }\n\n  return {\n    page: Number(Buffer.from(pageCursor, 'base64').toString('utf-8')),\n  };\n}\n\nexport function encodePageCursor({ page }: { page: number }): string {\n  return Buffer.from(`${page}`, 'utf-8').toString('base64');\n}\n"],"names":["isEmpty","isNumber","nan","Client","awsGetCredentials","createAWSConnection","esb"],"mappings":";;;;;;;;;;;;;AAwDA,kBAAkB,gBAA0C;AAC1D,QAAM,QAAQ,QAAQ,OAAO;AAC7B,QAAM,UAAU,MAAM,KAAK,MAAM,KAAK;AACtC,SAAO,GAAG,QAAQ,QAAQ;AAAA;AAG5B,iBAAiB,KAAa;AAC5B,SAAQA,eAAQ,QAAQ,CAACC,gBAAS,QAASC,aAAI;AAAA;gCAGc;AAAA,EAC7D,YACmB,qBACA,cACA,aACA,QACjB;AAJiB;AACA;AACA;AACA;AA4NF,0BAAiB;AAAA;AAAA,eAzNrB,WAAW;AAAA,IACtB;AAAA,IACA;AAAA,IACA,eAAe;AAAA,IACf,cAAc;AAAA,KACS;AACvB,WAAO,IAAI,0BACT,MAAM,0BAA0B,6BAC9B,QACA,OAAO,UAAU,0BAEnB,cACA,aACA;AAAA;AAAA,eAIiB,6BACnB,QACA,QACA;AACA,QAAI,CAAC,QAAQ;AACX,YAAM,IAAI,MAAM;AAAA;AAGlB,QAAI,OAAO,kBAAkB,gBAAgB,WAAW;AACtD,aAAO,KAAK;AACZ,YAAM,cAAa,OAAO,UAAU;AACpC,aAAO,IAAIC,qBAAO;AAAA,QAChB,OAAO;AAAA,UACL,IAAI,OAAO,UAAU;AAAA;AAAA,QAEvB,MAAM;AAAA,UACJ,UAAU,YAAW,UAAU;AAAA,UAC/B,UAAU,YAAW,UAAU;AAAA;AAAA;AAAA;AAIrC,QAAI,OAAO,kBAAkB,gBAAgB,OAAO;AAClD,aAAO,KAAK;AACZ,YAAM,iBAAiB,MAAMC;AAC7B,YAAM,gBAAgBC,oCAAoB;AAC1C,aAAO,IAAIF,qBAAO;AAAA,QAChB,MAAM,OAAO,UAAU;AAAA,WACpB;AAAA;AAAA;AAGP,WAAO,KAAK;AACZ,UAAM,aAAa,OAAO,kBAAkB;AAC5C,UAAM,OACJ,0BACY,IAAI,YACZ;AAAA,MACE,QAAQ,WAAW,UAAU;AAAA,QAE/B;AAAA,MACE,UAAU,WAAW,UAAU;AAAA,MAC/B,UAAU,WAAW,UAAU;AAAA;AAEvC,WAAO,IAAIA,qBAAO;AAAA,MAChB,MAAM,OAAO,UAAU;AAAA,MACvB;AAAA;AAAA;AAAA,EAIM,WAAW;AAAA,IACnB;AAAA,IACA,UAAU;AAAA,IACV;AAAA,IACA;AAAA,KAC0C;AAC1C,UAAM,SAAS,OAAO,QAAQ,SAC3B,OAAO,CAAC,CAAC,GAAG,WAAW,QAAQ,QAC/B,IAAI,CAAC,CAAC,KAAK,WAAsC;AAChD,UAAI,CAAC,UAAU,UAAU,WAAW,SAAS,OAAO,QAAQ;AAC1D,eAAOG,wBAAI,WAAW,KAAK,MAAM;AAAA;AAEnC,UAAI,MAAM,QAAQ,QAAQ;AACxB,eAAOA,wBACJ,YACA,OAAO,MAAM,IAAI,QAAMA,wBAAI,WAAW,KAAK,GAAG;AAAA;AAEnD,WAAK,OAAO,MACV,6CACA,KACA;AAEF,YAAM,IAAI,MACR;AAAA;AAGN,UAAM,QAAQ,QAAQ,QAClBA,wBAAI,kBACJA,wBACG,gBAAgB,CAAC,MAAM,MACvB,UAAU,QACV,mBAAmB;AAC1B,UAAM,WAAW;AACjB,UAAM,CAAE,QAAS,iBAAiB;AAElC,WAAO;AAAA,MACL,oBAAoBA,wBACjB,oBACA,MAAMA,wBAAI,YAAY,OAAO,QAAQ,KAAK,CAAC,SAC3C,KAAK,OAAO,UACZ,KAAK,UACL;AAAA,MACH,eAAe;AAAA,MACf;AAAA;AAAA;AAAA,EAIJ,cAAc,YAA0C;AACtD,SAAK,aAAa;AAAA;AAAA,QAGd,MAAM,MAAc,WAA+C;AACvE,SAAK,OAAO,KACV,oBAAoB,UAAU,8BAA8B;AAE9D,UAAM,iBAAiB,QAAQ;AAC/B,UAAM,QAAQ,KAAK,qBAAqB;AACxC,UAAM,QAAQ,KAAK,mBAAmB,MAAM,GAAG,KAAK;AACpD,QAAI;AACF,YAAM,UAAU,MAAM,KAAK,oBAAoB,IAAI,QAAQ;AAAA,QACzD,QAAQ;AAAA,QACR,MAAM;AAAA;AAER,YAAM,mBAAmB,QAAQ,KAAK,IACpC,CAAC,MAA2B,EAAE;AAGhC,YAAM,KAAK,oBAAoB,QAAQ,OAAO;AAAA,QAC5C;AAAA;AAEF,YAAM,SAAS,MAAM,KAAK,oBAAoB,QAAQ,KAAK;AAAA,QACzD,YAAY;AAAA,QACZ,aAAa;AACX,iBAAO;AAAA,YACL,OAAO,CAAE,QAAQ;AAAA;AAAA;AAAA,QAGrB,qBAAqB;AAAA;AAGvB,WAAK,OAAO,KACV,gCAAgC,WAAW,SAAS,mBACpD;AAEF,YAAM,KAAK,oBAAoB,QAAQ,cAAc;AAAA,QACnD,MAAM;AAAA,UACJ,SAAS;AAAA,YACP,CAAE,QAAQ,CAAE,OAAO,KAAK,mBAAmB,MAAM,MAAM;AAAA,YACvD,CAAE,KAAK,CAAE,OAAO;AAAA;AAAA;AAAA;AAKtB,WAAK,OAAO,KAAK,iCAAiC;AAClD,UAAI,iBAAiB,QAAQ;AAC3B,cAAM,KAAK,oBAAoB,QAAQ,OAAO;AAAA,UAC5C,OAAO;AAAA;AAAA;AAAA,aAGJ,GAAP;AACA,WAAK,OAAO,MAAM,sCAAsC,QAAQ;AAChE,YAAM,WAAW,MAAM,KAAK,oBAAoB,QAAQ,OAAO;AAAA,QAC7D;AAAA;AAEF,YAAM,eAAe,SAAS;AAC9B,UAAI,cAAc;AAChB,aAAK,OAAO,KAAK,0BAA0B;AAC3C,cAAM,KAAK,oBAAoB,QAAQ,OAAO;AAAA,UAC5C;AAAA;AAAA;AAAA;AAAA;AAAA,QAMF,MAAM,OAA8C;AACxD,UAAM,CAAE,oBAAoB,eAAe,YACzC,KAAK,WAAW;AAClB,UAAM,eAAe,gBACjB,cAAc,IAAI,QAAM,KAAK,qBAAqB,OAClD,KAAK,qBAAqB;AAC9B,QAAI;AACF,YAAM,SAAS,MAAM,KAAK,oBAAoB,OAAO;AAAA,QACnD,OAAO;AAAA,QACP,MAAM;AAAA;AAER,YAAM,CAAE,QAAS,iBAAiB,MAAM;AACxC,YAAM,cAAc,OAAO,KAAK,KAAK,MAAM,QAAQ,OAAO;AAC1D,YAAM,kBAAkB,OAAO;AAC/B,YAAM,iBAAiB,cACnB,iBAAiB,CAAE,MAAM,OAAO,MAChC;AACJ,YAAM,qBAAqB,kBACvB,iBAAiB,CAAE,MAAM,OAAO,MAChC;AAEJ,aAAO;AAAA,QACL,SAAS,OAAO,KAAK,KAAK,KAAK,IAAI,CAAC;AAA4B,UAC9D,MAAM,KAAK,iBAAiB,EAAE;AAAA,UAC9B,UAAU,EAAE;AAAA;AAAA,QAEd;AAAA,QACA;AAAA;AAAA,aAEK,GAAP;AACA,WAAK,OAAO,MACV,yCAAyC,gBACzC;AAEF,aAAO,QAAQ,OAAO,CAAE,SAAS;AAAA;AAAA;AAAA,EAM7B,mBAAmB,MAAc,SAAiB;AACxD,WAAO,GAAG,KAAK,cAAc,OAAO,KAAK,iBAAiB;AAAA;AAAA,EAGpD,iBAAiB,OAAe;AACtC,WAAO,MACJ,UAAU,KAAK,YAAY,QAC3B,MAAM,KAAK,gBAAgB;AAAA;AAAA,EAGxB,qBAAqB,MAAc;AACzC,UAAM,UAAU,KAAK,eAAe,KAAK,KAAK,iBAAiB;AAC/D,WAAO,GAAG,KAAK,cAAc,OAAO;AAAA;AAAA;0BAIP,YAAuC;AACtE,MAAI,CAAC,YAAY;AACf,WAAO,CAAE,MAAM;AAAA;AAGjB,SAAO;AAAA,IACL,MAAM,OAAO,OAAO,KAAK,YAAY,UAAU,SAAS;AAAA;AAAA;0BAI3B,CAAE,OAAkC;AACnE,SAAO,OAAO,KAAK,GAAG,QAAQ,SAAS,SAAS;AAAA;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/engines/ElasticSearchSearchEngine.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  awsGetCredentials,\n  createAWSConnection,\n} from '@acuris/aws-es-connection';\nimport { Config } from '@backstage/config';\nimport {\n  IndexableDocument,\n  SearchEngine,\n  SearchQuery,\n  SearchResultSet,\n} from '@backstage/search-common';\nimport { Client } from '@elastic/elasticsearch';\nimport esb from 'elastic-builder';\nimport { isEmpty, isNaN as nan, isNumber } from 'lodash';\nimport { Logger } from 'winston';\n\nimport type { ElasticSearchClientOptions } from './ElasticSearchClientOptions';\n\nexport type { ElasticSearchClientOptions };\n\nexport type ConcreteElasticSearchQuery = {\n  documentTypes?: string[];\n  elasticSearchQuery: Object;\n  pageSize: number;\n};\n\ntype ElasticSearchQueryTranslator = (\n  query: SearchQuery,\n) => ConcreteElasticSearchQuery;\n\ntype ElasticSearchOptions = {\n  logger: Logger;\n  config: Config;\n  aliasPostfix?: string;\n  indexPrefix?: string;\n};\n\ntype ElasticSearchResult = {\n  _index: string;\n  _type: string;\n  _score: number;\n  _source: IndexableDocument;\n};\n\nfunction duration(startTimestamp: [number, number]): string {\n  const delta = process.hrtime(startTimestamp);\n  const seconds = delta[0] + delta[1] / 1e9;\n  return `${seconds.toFixed(1)}s`;\n}\n\nfunction isBlank(str: string) {\n  return (isEmpty(str) && !isNumber(str)) || nan(str);\n}\n\n/**\n * @public\n */\nexport class ElasticSearchSearchEngine implements SearchEngine {\n  private readonly elasticSearchClient: Client;\n\n  constructor(\n    private readonly elasticSearchClientOptions: ElasticSearchClientOptions,\n    private readonly aliasPostfix: string,\n    private readonly indexPrefix: string,\n    private readonly logger: Logger,\n  ) {\n    this.elasticSearchClient = this.newClient(options => new Client(options));\n  }\n\n  static async fromConfig({\n    logger,\n    config,\n    aliasPostfix = `search`,\n    indexPrefix = ``,\n  }: ElasticSearchOptions) {\n    const options = await createElasticSearchClientOptions(\n      config.getConfig('search.elasticsearch'),\n    );\n    if (options.provider === 'elastic') {\n      logger.info('Initializing Elastic.co ElasticSearch search engine.');\n    } else if (options.provider === 'aws') {\n      logger.info('Initializing AWS ElasticSearch search engine.');\n    } else {\n      logger.info('Initializing ElasticSearch search engine.');\n    }\n\n    return new ElasticSearchSearchEngine(\n      options,\n      aliasPostfix,\n      indexPrefix,\n      logger,\n    );\n  }\n\n  /**\n   * Create a custom search client from the derived elastic search\n   * configuration. This need not be the same client that the engine uses\n   * internally.\n   */\n  newClient<T>(create: (options: ElasticSearchClientOptions) => T): T {\n    return create(this.elasticSearchClientOptions);\n  }\n\n  protected translator(query: SearchQuery): ConcreteElasticSearchQuery {\n    const { term, filters = {}, types, pageCursor } = query;\n\n    const filter = Object.entries(filters)\n      .filter(([_, value]) => Boolean(value))\n      .map(([key, value]: [key: string, value: any]) => {\n        if (['string', 'number', 'boolean'].includes(typeof value)) {\n          return esb.matchQuery(key, value.toString());\n        }\n        if (Array.isArray(value)) {\n          return esb\n            .boolQuery()\n            .should(value.map(it => esb.matchQuery(key, it.toString())));\n        }\n        this.logger.error(\n          'Failed to query, unrecognized filter type',\n          key,\n          value,\n        );\n        throw new Error(\n          'Failed to add filters to query. Unrecognized filter type',\n        );\n      });\n    const esbQuery = isBlank(term)\n      ? esb.matchAllQuery()\n      : esb\n          .multiMatchQuery(['*'], term)\n          .fuzziness('auto')\n          .minimumShouldMatch(1);\n    const pageSize = 25;\n    const { page } = decodePageCursor(pageCursor);\n\n    return {\n      elasticSearchQuery: esb\n        .requestBodySearch()\n        .query(esb.boolQuery().filter(filter).must([esbQuery]))\n        .from(page * pageSize)\n        .size(pageSize)\n        .toJSON(),\n      documentTypes: types,\n      pageSize,\n    };\n  }\n\n  setTranslator(translator: ElasticSearchQueryTranslator) {\n    this.translator = translator;\n  }\n\n  async index(type: string, documents: IndexableDocument[]): Promise<void> {\n    this.logger.info(\n      `Started indexing ${documents.length} documents for index ${type}`,\n    );\n    const startTimestamp = process.hrtime();\n    const alias = this.constructSearchAlias(type);\n    const index = this.constructIndexName(type, `${Date.now()}`);\n    try {\n      const aliases = await this.elasticSearchClient.cat.aliases({\n        format: 'json',\n        name: alias,\n      });\n      const removableIndices = aliases.body.map(\n        (r: Record<string, any>) => r.index,\n      );\n\n      await this.elasticSearchClient.indices.create({\n        index,\n      });\n      const result = await this.elasticSearchClient.helpers.bulk({\n        datasource: documents,\n        onDocument() {\n          return {\n            index: { _index: index },\n          };\n        },\n        refreshOnCompletion: index,\n      });\n\n      this.logger.info(\n        `Indexing completed for index ${type} in ${duration(startTimestamp)}`,\n        result,\n      );\n      await this.elasticSearchClient.indices.updateAliases({\n        body: {\n          actions: [\n            { remove: { index: this.constructIndexName(type, '*'), alias } },\n            { add: { index, alias } },\n          ],\n        },\n      });\n\n      this.logger.info('Removing stale search indices', removableIndices);\n      if (removableIndices.length) {\n        await this.elasticSearchClient.indices.delete({\n          index: removableIndices,\n        });\n      }\n    } catch (e) {\n      this.logger.error(`Failed to index documents for type ${type}`, e);\n      const response = await this.elasticSearchClient.indices.exists({\n        index,\n      });\n      const indexCreated = response.body;\n      if (indexCreated) {\n        this.logger.info(`Removing created index ${index}`);\n        await this.elasticSearchClient.indices.delete({\n          index,\n        });\n      }\n    }\n  }\n\n  async query(query: SearchQuery): Promise<SearchResultSet> {\n    const { elasticSearchQuery, documentTypes, pageSize } =\n      this.translator(query);\n    const queryIndices = documentTypes\n      ? documentTypes.map(it => this.constructSearchAlias(it))\n      : this.constructSearchAlias('*');\n    try {\n      const result = await this.elasticSearchClient.search({\n        index: queryIndices,\n        body: elasticSearchQuery,\n      });\n      const { page } = decodePageCursor(query.pageCursor);\n      const hasNextPage = result.body.hits.total.value > page * pageSize;\n      const hasPreviousPage = page > 0;\n      const nextPageCursor = hasNextPage\n        ? encodePageCursor({ page: page + 1 })\n        : undefined;\n      const previousPageCursor = hasPreviousPage\n        ? encodePageCursor({ page: page - 1 })\n        : undefined;\n\n      return {\n        results: result.body.hits.hits.map((d: ElasticSearchResult) => ({\n          type: this.getTypeFromIndex(d._index),\n          document: d._source,\n        })),\n        nextPageCursor,\n        previousPageCursor,\n      };\n    } catch (e) {\n      this.logger.error(\n        `Failed to query documents for indices ${queryIndices}`,\n        e,\n      );\n      return Promise.reject({ results: [] });\n    }\n  }\n\n  private readonly indexSeparator = '-index__';\n\n  private constructIndexName(type: string, postFix: string) {\n    return `${this.indexPrefix}${type}${this.indexSeparator}${postFix}`;\n  }\n\n  private getTypeFromIndex(index: string) {\n    return index\n      .substring(this.indexPrefix.length)\n      .split(this.indexSeparator)[0];\n  }\n\n  private constructSearchAlias(type: string) {\n    const postFix = this.aliasPostfix ? `__${this.aliasPostfix}` : '';\n    return `${this.indexPrefix}${type}${postFix}`;\n  }\n}\n\nexport function decodePageCursor(pageCursor?: string): { page: number } {\n  if (!pageCursor) {\n    return { page: 0 };\n  }\n\n  return {\n    page: Number(Buffer.from(pageCursor, 'base64').toString('utf-8')),\n  };\n}\n\nexport function encodePageCursor({ page }: { page: number }): string {\n  return Buffer.from(`${page}`, 'utf-8').toString('base64');\n}\n\nasync function createElasticSearchClientOptions(\n  config?: Config,\n): Promise<ElasticSearchClientOptions> {\n  if (!config) {\n    throw new Error('No elastic search config found');\n  }\n  const clientOptionsConfig = config.getOptionalConfig('clientOptions');\n  const sslConfig = clientOptionsConfig?.getOptionalConfig('ssl');\n\n  if (config.getOptionalString('provider') === 'elastic') {\n    const authConfig = config.getConfig('auth');\n    return {\n      provider: 'elastic',\n      cloud: {\n        id: config.getString('cloudId'),\n      },\n      auth: {\n        username: authConfig.getString('username'),\n        password: authConfig.getString('password'),\n      },\n      ...(sslConfig\n        ? {\n            ssl: {\n              rejectUnauthorized:\n                sslConfig?.getOptionalBoolean('rejectUnauthorized'),\n            },\n          }\n        : {}),\n    };\n  }\n  if (config.getOptionalString('provider') === 'aws') {\n    const awsCredentials = await awsGetCredentials();\n    const AWSConnection = createAWSConnection(awsCredentials);\n    return {\n      provider: 'aws',\n      node: config.getString('node'),\n      ...AWSConnection,\n      ...(sslConfig\n        ? {\n            ssl: {\n              rejectUnauthorized:\n                sslConfig?.getOptionalBoolean('rejectUnauthorized'),\n            },\n          }\n        : {}),\n    };\n  }\n  const authConfig = config.getOptionalConfig('auth');\n  const auth =\n    authConfig &&\n    (authConfig.has('apiKey')\n      ? {\n          apiKey: authConfig.getString('apiKey'),\n        }\n      : {\n          username: authConfig.getString('username'),\n          password: authConfig.getString('password'),\n        });\n  return {\n    node: config.getString('node'),\n    auth,\n    ...(sslConfig\n      ? {\n          ssl: {\n            rejectUnauthorized:\n              sslConfig?.getOptionalBoolean('rejectUnauthorized'),\n          },\n        }\n      : {}),\n  };\n}\n"],"names":["isEmpty","isNumber","nan","Client","esb","awsGetCredentials","createAWSConnection"],"mappings":";;;;;;;;;;;;;AA4DA,kBAAkB,gBAA0C;AAC1D,QAAM,QAAQ,QAAQ,OAAO;AAC7B,QAAM,UAAU,MAAM,KAAK,MAAM,KAAK;AACtC,SAAO,GAAG,QAAQ,QAAQ;AAAA;AAG5B,iBAAiB,KAAa;AAC5B,SAAQA,eAAQ,QAAQ,CAACC,gBAAS,QAASC,aAAI;AAAA;gCAMc;AAAA,EAG7D,YACmB,4BACA,cACA,aACA,QACjB;AAJiB;AACA;AACA;AACA;AA4LF,0BAAiB;AA1LhC,SAAK,sBAAsB,KAAK,UAAU,aAAW,IAAIC,qBAAO;AAAA;AAAA,eAGrD,WAAW;AAAA,IACtB;AAAA,IACA;AAAA,IACA,eAAe;AAAA,IACf,cAAc;AAAA,KACS;AACvB,UAAM,UAAU,MAAM,iCACpB,OAAO,UAAU;AAEnB,QAAI,QAAQ,aAAa,WAAW;AAClC,aAAO,KAAK;AAAA,eACH,QAAQ,aAAa,OAAO;AACrC,aAAO,KAAK;AAAA,WACP;AACL,aAAO,KAAK;AAAA;AAGd,WAAO,IAAI,0BACT,SACA,cACA,aACA;AAAA;AAAA,EASJ,UAAa,QAAuD;AAClE,WAAO,OAAO,KAAK;AAAA;AAAA,EAGX,WAAW,OAAgD;AACnE,UAAM,EAAE,MAAM,UAAU,IAAI,OAAO,eAAe;AAElD,UAAM,SAAS,OAAO,QAAQ,SAC3B,OAAO,CAAC,CAAC,GAAG,WAAW,QAAQ,QAC/B,IAAI,CAAC,CAAC,KAAK,WAAsC;AAChD,UAAI,CAAC,UAAU,UAAU,WAAW,SAAS,OAAO,QAAQ;AAC1D,eAAOC,wBAAI,WAAW,KAAK,MAAM;AAAA;AAEnC,UAAI,MAAM,QAAQ,QAAQ;AACxB,eAAOA,wBACJ,YACA,OAAO,MAAM,IAAI,QAAMA,wBAAI,WAAW,KAAK,GAAG;AAAA;AAEnD,WAAK,OAAO,MACV,6CACA,KACA;AAEF,YAAM,IAAI,MACR;AAAA;AAGN,UAAM,WAAW,QAAQ,QACrBA,wBAAI,kBACJA,wBACG,gBAAgB,CAAC,MAAM,MACvB,UAAU,QACV,mBAAmB;AAC1B,UAAM,WAAW;AACjB,UAAM,EAAE,SAAS,iBAAiB;AAElC,WAAO;AAAA,MACL,oBAAoBA,wBACjB,oBACA,MAAMA,wBAAI,YAAY,OAAO,QAAQ,KAAK,CAAC,YAC3C,KAAK,OAAO,UACZ,KAAK,UACL;AAAA,MACH,eAAe;AAAA,MACf;AAAA;AAAA;AAAA,EAIJ,cAAc,YAA0C;AACtD,SAAK,aAAa;AAAA;AAAA,QAGd,MAAM,MAAc,WAA+C;AACvE,SAAK,OAAO,KACV,oBAAoB,UAAU,8BAA8B;AAE9D,UAAM,iBAAiB,QAAQ;AAC/B,UAAM,QAAQ,KAAK,qBAAqB;AACxC,UAAM,QAAQ,KAAK,mBAAmB,MAAM,GAAG,KAAK;AACpD,QAAI;AACF,YAAM,UAAU,MAAM,KAAK,oBAAoB,IAAI,QAAQ;AAAA,QACzD,QAAQ;AAAA,QACR,MAAM;AAAA;AAER,YAAM,mBAAmB,QAAQ,KAAK,IACpC,CAAC,MAA2B,EAAE;AAGhC,YAAM,KAAK,oBAAoB,QAAQ,OAAO;AAAA,QAC5C;AAAA;AAEF,YAAM,SAAS,MAAM,KAAK,oBAAoB,QAAQ,KAAK;AAAA,QACzD,YAAY;AAAA,QACZ,aAAa;AACX,iBAAO;AAAA,YACL,OAAO,EAAE,QAAQ;AAAA;AAAA;AAAA,QAGrB,qBAAqB;AAAA;AAGvB,WAAK,OAAO,KACV,gCAAgC,WAAW,SAAS,mBACpD;AAEF,YAAM,KAAK,oBAAoB,QAAQ,cAAc;AAAA,QACnD,MAAM;AAAA,UACJ,SAAS;AAAA,YACP,EAAE,QAAQ,EAAE,OAAO,KAAK,mBAAmB,MAAM,MAAM;AAAA,YACvD,EAAE,KAAK,EAAE,OAAO;AAAA;AAAA;AAAA;AAKtB,WAAK,OAAO,KAAK,iCAAiC;AAClD,UAAI,iBAAiB,QAAQ;AAC3B,cAAM,KAAK,oBAAoB,QAAQ,OAAO;AAAA,UAC5C,OAAO;AAAA;AAAA;AAAA,aAGJ,GAAP;AACA,WAAK,OAAO,MAAM,sCAAsC,QAAQ;AAChE,YAAM,WAAW,MAAM,KAAK,oBAAoB,QAAQ,OAAO;AAAA,QAC7D;AAAA;AAEF,YAAM,eAAe,SAAS;AAC9B,UAAI,cAAc;AAChB,aAAK,OAAO,KAAK,0BAA0B;AAC3C,cAAM,KAAK,oBAAoB,QAAQ,OAAO;AAAA,UAC5C;AAAA;AAAA;AAAA;AAAA;AAAA,QAMF,MAAM,OAA8C;AACxD,UAAM,EAAE,oBAAoB,eAAe,aACzC,KAAK,WAAW;AAClB,UAAM,eAAe,gBACjB,cAAc,IAAI,QAAM,KAAK,qBAAqB,OAClD,KAAK,qBAAqB;AAC9B,QAAI;AACF,YAAM,SAAS,MAAM,KAAK,oBAAoB,OAAO;AAAA,QACnD,OAAO;AAAA,QACP,MAAM;AAAA;AAER,YAAM,EAAE,SAAS,iBAAiB,MAAM;AACxC,YAAM,cAAc,OAAO,KAAK,KAAK,MAAM,QAAQ,OAAO;AAC1D,YAAM,kBAAkB,OAAO;AAC/B,YAAM,iBAAiB,cACnB,iBAAiB,EAAE,MAAM,OAAO,OAChC;AACJ,YAAM,qBAAqB,kBACvB,iBAAiB,EAAE,MAAM,OAAO,OAChC;AAEJ,aAAO;AAAA,QACL,SAAS,OAAO,KAAK,KAAK,KAAK,IAAI,CAAC;AAA4B,UAC9D,MAAM,KAAK,iBAAiB,EAAE;AAAA,UAC9B,UAAU,EAAE;AAAA;AAAA,QAEd;AAAA,QACA;AAAA;AAAA,aAEK,GAAP;AACA,WAAK,OAAO,MACV,yCAAyC,gBACzC;AAEF,aAAO,QAAQ,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA,EAM7B,mBAAmB,MAAc,SAAiB;AACxD,WAAO,GAAG,KAAK,cAAc,OAAO,KAAK,iBAAiB;AAAA;AAAA,EAGpD,iBAAiB,OAAe;AACtC,WAAO,MACJ,UAAU,KAAK,YAAY,QAC3B,MAAM,KAAK,gBAAgB;AAAA;AAAA,EAGxB,qBAAqB,MAAc;AACzC,UAAM,UAAU,KAAK,eAAe,KAAK,KAAK,iBAAiB;AAC/D,WAAO,GAAG,KAAK,cAAc,OAAO;AAAA;AAAA;0BAIP,YAAuC;AACtE,MAAI,CAAC,YAAY;AACf,WAAO,EAAE,MAAM;AAAA;AAGjB,SAAO;AAAA,IACL,MAAM,OAAO,OAAO,KAAK,YAAY,UAAU,SAAS;AAAA;AAAA;0BAI3B,EAAE,QAAkC;AACnE,SAAO,OAAO,KAAK,GAAG,QAAQ,SAAS,SAAS;AAAA;AAGlD,gDACE,QACqC;AACrC,MAAI,CAAC,QAAQ;AACX,UAAM,IAAI,MAAM;AAAA;AAElB,QAAM,sBAAsB,OAAO,kBAAkB;AACrD,QAAM,YAAY,2DAAqB,kBAAkB;AAEzD,MAAI,OAAO,kBAAkB,gBAAgB,WAAW;AACtD,UAAM,cAAa,OAAO,UAAU;AACpC,WAAO;AAAA,MACL,UAAU;AAAA,MACV,OAAO;AAAA,QACL,IAAI,OAAO,UAAU;AAAA;AAAA,MAEvB,MAAM;AAAA,QACJ,UAAU,YAAW,UAAU;AAAA,QAC/B,UAAU,YAAW,UAAU;AAAA;AAAA,SAE7B,YACA;AAAA,QACE,KAAK;AAAA,UACH,oBACE,uCAAW,mBAAmB;AAAA;AAAA,UAGpC;AAAA;AAAA;AAGR,MAAI,OAAO,kBAAkB,gBAAgB,OAAO;AAClD,UAAM,iBAAiB,MAAMC;AAC7B,UAAM,gBAAgBC,oCAAoB;AAC1C,WAAO;AAAA,MACL,UAAU;AAAA,MACV,MAAM,OAAO,UAAU;AAAA,SACpB;AAAA,SACC,YACA;AAAA,QACE,KAAK;AAAA,UACH,oBACE,uCAAW,mBAAmB;AAAA;AAAA,UAGpC;AAAA;AAAA;AAGR,QAAM,aAAa,OAAO,kBAAkB;AAC5C,QAAM,OACJ,0BACY,IAAI,YACZ;AAAA,IACE,QAAQ,WAAW,UAAU;AAAA,MAE/B;AAAA,IACE,UAAU,WAAW,UAAU;AAAA,IAC/B,UAAU,WAAW,UAAU;AAAA;AAEvC,SAAO;AAAA,IACL,MAAM,OAAO,UAAU;AAAA,IACvB;AAAA,OACI,YACA;AAAA,MACE,KAAK;AAAA,QACH,oBACE,uCAAW,mBAAmB;AAAA;AAAA,QAGpC;AAAA;AAAA;;;;"}

package/dist/index.d.ts

@@ -1,7 +1,100 @@
+/// <reference types="node" />
 import { Config } from '@backstage/config';
 import { SearchEngine, SearchQuery, IndexableDocument, SearchResultSet } from '@backstage/search-common';
-import { Client } from '@elastic/elasticsearch';
 import { Logger } from 'winston';
+import { ConnectionOptions } 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
+ */
+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?: ConnectionOptions;
+    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';
+}
+declare type ElasticSearchAuth = {
+    username: string;
+    password: string;
+} | {
+    apiKey: string | {
+        id: string;
+        api_key: string;
+    };
+};
+interface ElasticSearchNodeOptions {
+    url: URL;
+    id?: string;
+    agent?: ElasticSearchAgentOptions;
+    ssl?: ConnectionOptions;
+    headers?: Record<string, any>;
+    roles?: {
+        master: boolean;
+        data: boolean;
+        ingest: boolean;
+        ml: boolean;
+    };
+}
+interface ElasticSearchAgentOptions {
+    keepAlive?: boolean;
+    keepAliveMsecs?: number;
+    maxSockets?: number;
+    maxFreeSockets?: number;
+}
+interface ElasticSearchConnectionConstructor {
+    new (opts?: any): any;
+    statuses: {
+        ALIVE: string;
+        DEAD: string;
+    };
+    roles: {
+        MASTER: string;
+        DATA: string;
+        INGEST: string;
+        ML: string;
+    };
+}
+interface ElasticSearchTransportConstructor {
+    new (opts?: any): any;
+    sniffReasons: {
+        SNIFF_ON_START: string;
+        SNIFF_INTERVAL: string;
+        SNIFF_ON_CONNECTION_FAULT: string;
+        DEFAULT: string;
+    };
+}
 
 declare type ConcreteElasticSearchQuery = {
     documentTypes?: string[];
@@ -15,15 +108,24 @@ declare type ElasticSearchOptions = {
     aliasPostfix?: string;
     indexPrefix?: string;
 };
+/**
+ * @public
+ */
 declare class ElasticSearchSearchEngine implements SearchEngine {
-    private readonly elasticSearchClient;
+    private readonly elasticSearchClientOptions;
     private readonly aliasPostfix;
     private readonly indexPrefix;
     private readonly logger;
-    constructor(elasticSearchClient: Client, aliasPostfix: string, indexPrefix: string, logger: Logger);
+    private readonly elasticSearchClient;
+    constructor(elasticSearchClientOptions: ElasticSearchClientOptions, aliasPostfix: string, indexPrefix: string, logger: Logger);
     static fromConfig({ logger, config, aliasPostfix, indexPrefix, }: ElasticSearchOptions): Promise<ElasticSearchSearchEngine>;
-    private static constructElasticSearchClient;
-    protected translator({ term, filters, types, pageCursor, }: SearchQuery): ConcreteElasticSearchQuery;
+    /**
+     * Create a custom search client from the derived elastic search
+     * configuration. This need not be the same client that the engine uses
+     * internally.
+     */
+    newClient<T>(create: (options: ElasticSearchClientOptions) => T): T;
+    protected translator(query: SearchQuery): ConcreteElasticSearchQuery;
     setTranslator(translator: ElasticSearchQueryTranslator): void;
     index(type: string, documents: IndexableDocument[]): Promise<void>;
     query(query: SearchQuery): Promise<SearchResultSet>;
@@ -33,4 +135,4 @@ declare class ElasticSearchSearchEngine implements SearchEngine {
     private constructSearchAlias;
 }
 
-export { ElasticSearchSearchEngine };
+export { ElasticSearchClientOptions, ElasticSearchSearchEngine };

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@backstage/plugin-search-backend-module-elasticsearch",
-  "version": "0.0.3",
+  "description": "A module for the search backend that implements search using ElasticSearch",
+  "version": "0.0.7",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -22,15 +23,15 @@
     "@acuris/aws-es-connection": "^2.2.0",
     "@backstage/config": "^0.1.8",
     "@backstage/search-common": "^0.2.0",
-    "@elastic/elasticsearch": "^7.13.0",
+    "@elastic/elasticsearch": "7.13.0",
     "aws-sdk": "^2.948.0",
     "elastic-builder": "^2.16.0",
     "lodash": "^4.17.21",
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-common": "^0.9.1",
-    "@backstage/cli": "^0.7.10",
+    "@backstage/backend-common": "^0.9.14",
+    "@backstage/cli": "^0.10.2",
     "@elastic/elasticsearch-mock": "^0.3.0"
   },
   "files": [
@@ -41,5 +42,5 @@
     "testEnvironment": "node"
   },
   "configSchema": "config.d.ts",
-  "gitHead": "174a8b532e8b6dda0e733ec943d1aa7187a3821a"
+  "gitHead": "9ff0f1e76d4510edda2f1b1b3e58cba168a76190"
 }