@backstage/plugin-search-backend-module-elasticsearch 1.6.5 → 1.6.6-next.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @backstage/plugin-search-backend-module-elasticsearch
 
+## 1.6.6-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.2.1-next.1
+  - @backstage/config@1.3.2
+  - @backstage/integration-aws-node@0.1.15
+  - @backstage/plugin-search-backend-node@1.3.9-next.1
+  - @backstage/plugin-search-common@1.2.17
+
+## 1.6.6-next.0
+
+### Patch Changes
+
+- 37e5386: Allow `indexPrefix` configuration through the `app-config.yaml`
+- Updated dependencies
+  - @backstage/plugin-search-backend-node@1.3.9-next.0
+  - @backstage/backend-plugin-api@1.2.1-next.0
+
 ## 1.6.5
 
 ### Patch Changes

package/config.d.ts

@@ -21,6 +21,10 @@ export interface Config {
      * Options for ElasticSearch
      */
     elasticsearch?: {
+      /**
+       * Prefix to be used for all index creation. Value will be put in front of the index as is.
+       */
+      indexPrefix?: string;
       /**
        * Batch size for elastic search indexing tasks. Defaults to 1000.
        */

package/dist/engines/ElasticSearchSearchEngineIndexer.cjs.js

@@ -76,7 +76,7 @@ class ElasticSearchSearchEngineIndexer extends pluginSearchBackendNode.BatchSear
     const result = await this.bulkResult;
     if (this.processed === 0) {
       this.logger.warn(
-        `Index for ${this.type} was not ${this.removableIndices.length ? "replaced" : "created"}: indexer received 0 documents`
+        `Index for ${this.indexName} of ${this.type} was not ${this.removableIndices.length ? "replaced" : "created"}: indexer received 0 documents`
       );
       try {
         await this.elasticSearchClientWrapper.deleteIndex({
@@ -88,9 +88,7 @@ class ElasticSearchSearchEngineIndexer extends pluginSearchBackendNode.BatchSear
       return;
     }
     this.logger.info(
-      `Indexing completed for index ${this.type} in ${duration(
-        this.startTimestamp
-      )}`,
+      `Indexing completed for index ${this.indexName} of ${this.type} in ${duration(this.startTimestamp)}`,
       result
     );
     await this.elasticSearchClientWrapper.updateAliases({

package/dist/engines/ElasticSearchSearchEngineIndexer.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"ElasticSearchSearchEngineIndexer.cjs.js","sources":["../../src/engines/ElasticSearchSearchEngineIndexer.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { BatchSearchEngineIndexer } from '@backstage/plugin-search-backend-node';\nimport { ElasticSearchClientWrapper } from './ElasticSearchClientWrapper';\nimport { IndexableDocument } from '@backstage/plugin-search-common';\nimport { Readable } from 'stream';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\n/**\n * Options for instantiate ElasticSearchSearchEngineIndexer\n * @public\n */\nexport type ElasticSearchSearchEngineIndexerOptions = {\n  type: string;\n  indexPrefix: string;\n  indexSeparator: string;\n  alias: string;\n  logger: LoggerService;\n  elasticSearchClientWrapper: ElasticSearchClientWrapper;\n  batchSize: number;\n  skipRefresh?: boolean;\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\n/**\n * Elasticsearch specific search engine indexer.\n * @public\n */\nexport class ElasticSearchSearchEngineIndexer extends BatchSearchEngineIndexer {\n  private processed: number = 0;\n  private removableIndices: string[] = [];\n\n  private readonly startTimestamp: [number, number];\n  private readonly type: string;\n  public readonly indexName: string;\n  private readonly indexPrefix: string;\n  private readonly indexSeparator: string;\n  private readonly alias: string;\n  private readonly logger: LoggerService;\n  private readonly sourceStream: Readable;\n  private readonly elasticSearchClientWrapper: ElasticSearchClientWrapper;\n  private configuredBatchSize: number;\n  private bulkResult: Promise<any>;\n  private bulkClientError?: Error;\n\n  constructor(options: ElasticSearchSearchEngineIndexerOptions) {\n    super({ batchSize: options.batchSize });\n    this.configuredBatchSize = options.batchSize;\n    this.logger = options.logger.child({ documentType: options.type });\n    this.startTimestamp = process.hrtime();\n    this.type = options.type;\n    this.indexPrefix = options.indexPrefix;\n    this.indexSeparator = options.indexSeparator;\n    this.indexName = this.constructIndexName(`${Date.now()}`);\n    this.alias = options.alias;\n    this.elasticSearchClientWrapper = options.elasticSearchClientWrapper;\n\n    // The ES client bulk helper supports stream-based indexing, but we have to\n    // supply the stream directly to it at instantiation-time. We can't supply\n    // this class itself, so instead, we create this inline stream instead.\n    this.sourceStream = new Readable({ objectMode: true });\n    this.sourceStream._read = () => {};\n\n    // eslint-disable-next-line consistent-this\n    const that = this;\n\n    // Keep a reference to the ES Bulk helper so that we can know when all\n    // documents have been successfully written to ES.\n    this.bulkResult = this.elasticSearchClientWrapper.bulk({\n      datasource: this.sourceStream,\n      onDocument() {\n        that.processed++;\n        return {\n          index: { _index: that.indexName },\n        };\n      },\n      refreshOnCompletion: options.skipRefresh !== true,\n    });\n\n    // Safely catch errors thrown by the bulk helper client, e.g. HTTP timeouts\n    this.bulkResult.catch(e => {\n      this.bulkClientError = e;\n    });\n  }\n\n  async initialize(): Promise<void> {\n    this.logger.info(`Started indexing documents for index ${this.type}`);\n\n    const indices = await this.elasticSearchClientWrapper.listIndices({\n      index: this.constructIndexName('*'),\n    });\n\n    for (const key of Object.keys(indices.body)) {\n      this.removableIndices.push(key);\n    }\n\n    await this.elasticSearchClientWrapper.createIndex({\n      index: this.indexName,\n    });\n  }\n\n  async index(documents: IndexableDocument[]): Promise<void> {\n    await this.isReady();\n    documents.forEach(document => {\n      this.sourceStream.push(document);\n    });\n  }\n\n  async finalize(): Promise<void> {\n    // Wait for all documents to be processed.\n    await this.isReady();\n\n    // Close off the underlying stream connected to ES, indicating that no more\n    // documents will be written.\n    this.sourceStream.push(null);\n\n    // Wait for the bulk helper to finish processing.\n    const result = await this.bulkResult;\n\n    // Warn that no documents were indexed, early return so that alias swapping\n    // does not occur, and clean up the empty index we just created.\n    if (this.processed === 0) {\n      this.logger.warn(\n        `Index for ${this.type} was not ${\n          this.removableIndices.length ? 'replaced' : 'created'\n        }: indexer received 0 documents`,\n      );\n      try {\n        await this.elasticSearchClientWrapper.deleteIndex({\n          index: this.indexName,\n        });\n      } catch (error) {\n        this.logger.error(`Unable to clean up elastic index: ${error}`);\n      }\n      return;\n    }\n\n    // Rotate main alias upon completion. Apply permanent secondary alias so\n    // stale indices can be referenced for deletion in case initial attempt\n    // fails. Allow errors to bubble up so that we can clean up the created index.\n    this.logger.info(\n      `Indexing completed for index ${this.type} in ${duration(\n        this.startTimestamp,\n      )}`,\n      result,\n    );\n    await this.elasticSearchClientWrapper.updateAliases({\n      actions: [\n        {\n          remove: { index: this.constructIndexName('*'), alias: this.alias },\n        },\n        {\n          add: { index: this.indexName, alias: this.alias },\n        },\n      ].filter(Boolean),\n    });\n\n    // If any indices are removable, remove them. Do not bubble up this error,\n    // as doing so would delete the now aliased index. Log instead.\n    if (this.removableIndices.length) {\n      this.logger.info('Removing stale search indices', {\n        removableIndices: this.removableIndices,\n      });\n\n      // Split the array into chunks of up to 50 indices to handle the case\n      // where we need to delete a lot of stalled indices\n      const chunks = this.removableIndices.reduce(\n        (resultArray, item, index) => {\n          const chunkIndex = Math.floor(index / 50);\n\n          if (!resultArray[chunkIndex]) {\n            resultArray[chunkIndex] = []; // start a new chunk\n          }\n\n          resultArray[chunkIndex].push(item);\n\n          return resultArray;\n        },\n        [] as string[][],\n      );\n\n      // Call deleteIndex for each chunk\n      for (const chunk of chunks) {\n        try {\n          await this.elasticSearchClientWrapper.deleteIndex({\n            index: chunk,\n          });\n        } catch (e) {\n          this.logger.warn(`Failed to remove stale search indices: ${e}`);\n        }\n      }\n    }\n  }\n\n  /**\n   * Ensures that the number of documents sent over the wire to ES matches the\n   * number of documents this stream has received so far. This helps manage\n   * backpressure in other parts of the indexing pipeline.\n   */\n  private isReady(): Promise<void> {\n    // Early exit if the underlying ES client encountered an error.\n    if (this.bulkClientError) {\n      return Promise.reject(this.bulkClientError);\n    }\n\n    // Optimization: if the stream that ES reads from has fewer docs queued\n    // than the configured batch size, continue early to allow more docs to be\n    // queued\n    if (this.sourceStream.readableLength < this.configuredBatchSize) {\n      return Promise.resolve();\n    }\n\n    // Otherwise, continue periodically checking the stream queue to see if\n    // ES has consumed the documents and continue when it's ready for more.\n    return new Promise((isReady, abort) => {\n      let streamLengthChecks = 0;\n      const interval = setInterval(() => {\n        streamLengthChecks++;\n\n        if (this.sourceStream.readableLength < this.configuredBatchSize) {\n          clearInterval(interval);\n          isReady();\n        }\n\n        // Do not allow this interval to loop endlessly; anything longer than 5\n        // minutes likely indicates an unrecoverable error in ES; direct the\n        // user to inspect ES logs for more clues and abort in order to allow\n        // the index to be cleaned up.\n        if (streamLengthChecks >= 6000) {\n          clearInterval(interval);\n          abort(\n            new Error(\n              'Exceeded 5 minutes waiting for elastic to be ready to accept more documents. Check the elastic logs for possible problems.',\n            ),\n          );\n        }\n      }, 50);\n    });\n  }\n\n  private constructIndexName(postFix: string) {\n    return `${this.indexPrefix}${this.type}${this.indexSeparator}${postFix}`;\n  }\n}\n"],"names":["BatchSearchEngineIndexer","Readable"],"mappings":";;;;;AAqCA,SAAS,SAAS,cAA0C,EAAA;AAC1D,EAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,MAAA,CAAO,cAAc,CAAA;AAC3C,EAAA,MAAM,UAAU,KAAM,CAAA,CAAC,CAAI,GAAA,KAAA,CAAM,CAAC,CAAI,GAAA,GAAA;AACtC,EAAA,OAAO,CAAG,EAAA,OAAA,CAAQ,OAAQ,CAAA,CAAC,CAAC,CAAA,CAAA,CAAA;AAC9B;AAMO,MAAM,yCAAyCA,gDAAyB,CAAA;AAAA,EACrE,SAAoB,GAAA,CAAA;AAAA,EACpB,mBAA6B,EAAC;AAAA,EAErB,cAAA;AAAA,EACA,IAAA;AAAA,EACD,SAAA;AAAA,EACC,WAAA;AAAA,EACA,cAAA;AAAA,EACA,KAAA;AAAA,EACA,MAAA;AAAA,EACA,YAAA;AAAA,EACA,0BAAA;AAAA,EACT,mBAAA;AAAA,EACA,UAAA;AAAA,EACA,eAAA;AAAA,EAER,YAAY,OAAkD,EAAA;AAC5D,IAAA,KAAA,CAAM,EAAE,SAAA,EAAW,OAAQ,CAAA,SAAA,EAAW,CAAA;AACtC,IAAA,IAAA,CAAK,sBAAsB,OAAQ,CAAA,SAAA;AACnC,IAAK,IAAA,CAAA,MAAA,GAAS,QAAQ,MAAO,CAAA,KAAA,CAAM,EAAE,YAAc,EAAA,OAAA,CAAQ,MAAM,CAAA;AACjE,IAAK,IAAA,CAAA,cAAA,GAAiB,QAAQ,MAAO,EAAA;AACrC,IAAA,IAAA,CAAK,OAAO,OAAQ,CAAA,IAAA;AACpB,IAAA,IAAA,CAAK,cAAc,OAAQ,CAAA,WAAA;AAC3B,IAAA,IAAA,CAAK,iBAAiB,OAAQ,CAAA,cAAA;AAC9B,IAAA,IAAA,CAAK,YAAY,IAAK,CAAA,kBAAA,CAAmB,GAAG,IAAK,CAAA,GAAA,EAAK,CAAE,CAAA,CAAA;AACxD,IAAA,IAAA,CAAK,QAAQ,OAAQ,CAAA,KAAA;AACrB,IAAA,IAAA,CAAK,6BAA6B,OAAQ,CAAA,0BAAA;AAK1C,IAAA,IAAA,CAAK,eAAe,IAAIC,eAAA,CAAS,EAAE,UAAA,EAAY,MAAM,CAAA;AACrD,IAAK,IAAA,CAAA,YAAA,CAAa,QAAQ,MAAM;AAAA,KAAC;AAGjC,IAAA,MAAM,IAAO,GAAA,IAAA;AAIb,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,0BAAA,CAA2B,IAAK,CAAA;AAAA,MACrD,YAAY,IAAK,CAAA,YAAA;AAAA,MACjB,UAAa,GAAA;AACX,QAAK,IAAA,CAAA,SAAA,EAAA;AACL,QAAO,OAAA;AAAA,UACL,KAAO,EAAA,EAAE,MAAQ,EAAA,IAAA,CAAK,SAAU;AAAA,SAClC;AAAA,OACF;AAAA,MACA,mBAAA,EAAqB,QAAQ,WAAgB,KAAA;AAAA,KAC9C,CAAA;AAGD,IAAK,IAAA,CAAA,UAAA,CAAW,MAAM,CAAK,CAAA,KAAA;AACzB,MAAA,IAAA,CAAK,eAAkB,GAAA,CAAA;AAAA,KACxB,CAAA;AAAA;AACH,EAEA,MAAM,UAA4B,GAAA;AAChC,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAAwC,qCAAA,EAAA,IAAA,CAAK,IAAI,CAAE,CAAA,CAAA;AAEpE,IAAA,MAAM,OAAU,GAAA,MAAM,IAAK,CAAA,0BAAA,CAA2B,WAAY,CAAA;AAAA,MAChE,KAAA,EAAO,IAAK,CAAA,kBAAA,CAAmB,GAAG;AAAA,KACnC,CAAA;AAED,IAAA,KAAA,MAAW,GAAO,IAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,IAAI,CAAG,EAAA;AAC3C,MAAK,IAAA,CAAA,gBAAA,CAAiB,KAAK,GAAG,CAAA;AAAA;AAGhC,IAAM,MAAA,IAAA,CAAK,2BAA2B,WAAY,CAAA;AAAA,MAChD,OAAO,IAAK,CAAA;AAAA,KACb,CAAA;AAAA;AACH,EAEA,MAAM,MAAM,SAA+C,EAAA;AACzD,IAAA,MAAM,KAAK,OAAQ,EAAA;AACnB,IAAA,SAAA,CAAU,QAAQ,CAAY,QAAA,KAAA;AAC5B,MAAK,IAAA,CAAA,YAAA,CAAa,KAAK,QAAQ,CAAA;AAAA,KAChC,CAAA;AAAA;AACH,EAEA,MAAM,QAA0B,GAAA;AAE9B,IAAA,MAAM,KAAK,OAAQ,EAAA;AAInB,IAAK,IAAA,CAAA,YAAA,CAAa,KAAK,IAAI,CAAA;AAG3B,IAAM,MAAA,MAAA,GAAS,MAAM,IAAK,CAAA,UAAA;AAI1B,IAAI,IAAA,IAAA,CAAK,cAAc,CAAG,EAAA;AACxB,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,QACV,CAAA,UAAA,EAAa,KAAK,IAAI,CAAA,SAAA,EACpB,KAAK,gBAAiB,CAAA,MAAA,GAAS,aAAa,SAC9C,CAAA,8BAAA;AAAA,OACF;AACA,MAAI,IAAA;AACF,QAAM,MAAA,IAAA,CAAK,2BAA2B,WAAY,CAAA;AAAA,UAChD,OAAO,IAAK,CAAA;AAAA,SACb,CAAA;AAAA,eACM,KAAO,EAAA;AACd,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAqC,kCAAA,EAAA,KAAK,CAAE,CAAA,CAAA;AAAA;AAEhE,MAAA;AAAA;AAMF,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,MACV,CAAA,6BAAA,EAAgC,IAAK,CAAA,IAAI,CAAO,IAAA,EAAA,QAAA;AAAA,QAC9C,IAAK,CAAA;AAAA,OACN,CAAA,CAAA;AAAA,MACD;AAAA,KACF;AACA,IAAM,MAAA,IAAA,CAAK,2BAA2B,aAAc,CAAA;AAAA,MAClD,OAAS,EAAA;AAAA,QACP;AAAA,UACE,MAAA,EAAQ,EAAE,KAAO,EAAA,IAAA,CAAK,mBAAmB,GAAG,CAAA,EAAG,KAAO,EAAA,IAAA,CAAK,KAAM;AAAA,SACnE;AAAA,QACA;AAAA,UACE,KAAK,EAAE,KAAA,EAAO,KAAK,SAAW,EAAA,KAAA,EAAO,KAAK,KAAM;AAAA;AAClD,OACF,CAAE,OAAO,OAAO;AAAA,KACjB,CAAA;AAID,IAAI,IAAA,IAAA,CAAK,iBAAiB,MAAQ,EAAA;AAChC,MAAK,IAAA,CAAA,MAAA,CAAO,KAAK,+BAAiC,EAAA;AAAA,QAChD,kBAAkB,IAAK,CAAA;AAAA,OACxB,CAAA;AAID,MAAM,MAAA,MAAA,GAAS,KAAK,gBAAiB,CAAA,MAAA;AAAA,QACnC,CAAC,WAAa,EAAA,IAAA,EAAM,KAAU,KAAA;AAC5B,UAAA,MAAM,UAAa,GAAA,IAAA,CAAK,KAAM,CAAA,KAAA,GAAQ,EAAE,CAAA;AAExC,UAAI,IAAA,CAAC,WAAY,CAAA,UAAU,CAAG,EAAA;AAC5B,YAAY,WAAA,CAAA,UAAU,IAAI,EAAC;AAAA;AAG7B,UAAY,WAAA,CAAA,UAAU,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA;AAEjC,UAAO,OAAA,WAAA;AAAA,SACT;AAAA,QACA;AAAC,OACH;AAGA,MAAA,KAAA,MAAW,SAAS,MAAQ,EAAA;AAC1B,QAAI,IAAA;AACF,UAAM,MAAA,IAAA,CAAK,2BAA2B,WAAY,CAAA;AAAA,YAChD,KAAO,EAAA;AAAA,WACR,CAAA;AAAA,iBACM,CAAG,EAAA;AACV,UAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAA0C,uCAAA,EAAA,CAAC,CAAE,CAAA,CAAA;AAAA;AAChE;AACF;AACF;AACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,OAAyB,GAAA;AAE/B,IAAA,IAAI,KAAK,eAAiB,EAAA;AACxB,MAAO,OAAA,OAAA,CAAQ,MAAO,CAAA,IAAA,CAAK,eAAe,CAAA;AAAA;AAM5C,IAAA,IAAI,IAAK,CAAA,YAAA,CAAa,cAAiB,GAAA,IAAA,CAAK,mBAAqB,EAAA;AAC/D,MAAA,OAAO,QAAQ,OAAQ,EAAA;AAAA;AAKzB,IAAA,OAAO,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,KAAU,KAAA;AACrC,MAAA,IAAI,kBAAqB,GAAA,CAAA;AACzB,MAAM,MAAA,QAAA,GAAW,YAAY,MAAM;AACjC,QAAA,kBAAA,EAAA;AAEA,QAAA,IAAI,IAAK,CAAA,YAAA,CAAa,cAAiB,GAAA,IAAA,CAAK,mBAAqB,EAAA;AAC/D,UAAA,aAAA,CAAc,QAAQ,CAAA;AACtB,UAAQ,OAAA,EAAA;AAAA;AAOV,QAAA,IAAI,sBAAsB,GAAM,EAAA;AAC9B,UAAA,aAAA,CAAc,QAAQ,CAAA;AACtB,UAAA,KAAA;AAAA,YACE,IAAI,KAAA;AAAA,cACF;AAAA;AACF,WACF;AAAA;AACF,SACC,EAAE,CAAA;AAAA,KACN,CAAA;AAAA;AACH,EAEQ,mBAAmB,OAAiB,EAAA;AAC1C,IAAO,OAAA,CAAA,EAAG,IAAK,CAAA,WAAW,CAAG,EAAA,IAAA,CAAK,IAAI,CAAG,EAAA,IAAA,CAAK,cAAc,CAAA,EAAG,OAAO,CAAA,CAAA;AAAA;AAE1E;;;;"}
+{"version":3,"file":"ElasticSearchSearchEngineIndexer.cjs.js","sources":["../../src/engines/ElasticSearchSearchEngineIndexer.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { BatchSearchEngineIndexer } from '@backstage/plugin-search-backend-node';\nimport { ElasticSearchClientWrapper } from './ElasticSearchClientWrapper';\nimport { IndexableDocument } from '@backstage/plugin-search-common';\nimport { Readable } from 'stream';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\n/**\n * Options for instantiate ElasticSearchSearchEngineIndexer\n * @public\n */\nexport type ElasticSearchSearchEngineIndexerOptions = {\n  type: string;\n  indexPrefix: string;\n  indexSeparator: string;\n  alias: string;\n  logger: LoggerService;\n  elasticSearchClientWrapper: ElasticSearchClientWrapper;\n  batchSize: number;\n  skipRefresh?: boolean;\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\n/**\n * Elasticsearch specific search engine indexer.\n * @public\n */\nexport class ElasticSearchSearchEngineIndexer extends BatchSearchEngineIndexer {\n  private processed: number = 0;\n  private removableIndices: string[] = [];\n\n  private readonly startTimestamp: [number, number];\n  private readonly type: string;\n  public readonly indexName: string;\n  private readonly indexPrefix: string;\n  private readonly indexSeparator: string;\n  private readonly alias: string;\n  private readonly logger: LoggerService;\n  private readonly sourceStream: Readable;\n  private readonly elasticSearchClientWrapper: ElasticSearchClientWrapper;\n  private configuredBatchSize: number;\n  private bulkResult: Promise<any>;\n  private bulkClientError?: Error;\n\n  constructor(options: ElasticSearchSearchEngineIndexerOptions) {\n    super({ batchSize: options.batchSize });\n    this.configuredBatchSize = options.batchSize;\n    this.logger = options.logger.child({ documentType: options.type });\n    this.startTimestamp = process.hrtime();\n    this.type = options.type;\n    this.indexPrefix = options.indexPrefix;\n    this.indexSeparator = options.indexSeparator;\n    this.indexName = this.constructIndexName(`${Date.now()}`);\n    this.alias = options.alias;\n    this.elasticSearchClientWrapper = options.elasticSearchClientWrapper;\n\n    // The ES client bulk helper supports stream-based indexing, but we have to\n    // supply the stream directly to it at instantiation-time. We can't supply\n    // this class itself, so instead, we create this inline stream instead.\n    this.sourceStream = new Readable({ objectMode: true });\n    this.sourceStream._read = () => {};\n\n    // eslint-disable-next-line consistent-this\n    const that = this;\n\n    // Keep a reference to the ES Bulk helper so that we can know when all\n    // documents have been successfully written to ES.\n    this.bulkResult = this.elasticSearchClientWrapper.bulk({\n      datasource: this.sourceStream,\n      onDocument() {\n        that.processed++;\n        return {\n          index: { _index: that.indexName },\n        };\n      },\n      refreshOnCompletion: options.skipRefresh !== true,\n    });\n\n    // Safely catch errors thrown by the bulk helper client, e.g. HTTP timeouts\n    this.bulkResult.catch(e => {\n      this.bulkClientError = e;\n    });\n  }\n\n  async initialize(): Promise<void> {\n    this.logger.info(`Started indexing documents for index ${this.type}`);\n\n    const indices = await this.elasticSearchClientWrapper.listIndices({\n      index: this.constructIndexName('*'),\n    });\n\n    for (const key of Object.keys(indices.body)) {\n      this.removableIndices.push(key);\n    }\n\n    await this.elasticSearchClientWrapper.createIndex({\n      index: this.indexName,\n    });\n  }\n\n  async index(documents: IndexableDocument[]): Promise<void> {\n    await this.isReady();\n    documents.forEach(document => {\n      this.sourceStream.push(document);\n    });\n  }\n\n  async finalize(): Promise<void> {\n    // Wait for all documents to be processed.\n    await this.isReady();\n\n    // Close off the underlying stream connected to ES, indicating that no more\n    // documents will be written.\n    this.sourceStream.push(null);\n\n    // Wait for the bulk helper to finish processing.\n    const result = await this.bulkResult;\n\n    // Warn that no documents were indexed, early return so that alias swapping\n    // does not occur, and clean up the empty index we just created.\n    if (this.processed === 0) {\n      this.logger.warn(\n        `Index for ${this.indexName} of ${this.type} was not ${\n          this.removableIndices.length ? 'replaced' : 'created'\n        }: indexer received 0 documents`,\n      );\n      try {\n        await this.elasticSearchClientWrapper.deleteIndex({\n          index: this.indexName,\n        });\n      } catch (error) {\n        this.logger.error(`Unable to clean up elastic index: ${error}`);\n      }\n      return;\n    }\n\n    // Rotate main alias upon completion. Apply permanent secondary alias so\n    // stale indices can be referenced for deletion in case initial attempt\n    // fails. Allow errors to bubble up so that we can clean up the created index.\n    this.logger.info(\n      `Indexing completed for index ${this.indexName} of ${\n        this.type\n      } in ${duration(this.startTimestamp)}`,\n      result,\n    );\n    await this.elasticSearchClientWrapper.updateAliases({\n      actions: [\n        {\n          remove: { index: this.constructIndexName('*'), alias: this.alias },\n        },\n        {\n          add: { index: this.indexName, alias: this.alias },\n        },\n      ].filter(Boolean),\n    });\n\n    // If any indices are removable, remove them. Do not bubble up this error,\n    // as doing so would delete the now aliased index. Log instead.\n    if (this.removableIndices.length) {\n      this.logger.info('Removing stale search indices', {\n        removableIndices: this.removableIndices,\n      });\n\n      // Split the array into chunks of up to 50 indices to handle the case\n      // where we need to delete a lot of stalled indices\n      const chunks = this.removableIndices.reduce(\n        (resultArray, item, index) => {\n          const chunkIndex = Math.floor(index / 50);\n\n          if (!resultArray[chunkIndex]) {\n            resultArray[chunkIndex] = []; // start a new chunk\n          }\n\n          resultArray[chunkIndex].push(item);\n\n          return resultArray;\n        },\n        [] as string[][],\n      );\n\n      // Call deleteIndex for each chunk\n      for (const chunk of chunks) {\n        try {\n          await this.elasticSearchClientWrapper.deleteIndex({\n            index: chunk,\n          });\n        } catch (e) {\n          this.logger.warn(`Failed to remove stale search indices: ${e}`);\n        }\n      }\n    }\n  }\n\n  /**\n   * Ensures that the number of documents sent over the wire to ES matches the\n   * number of documents this stream has received so far. This helps manage\n   * backpressure in other parts of the indexing pipeline.\n   */\n  private isReady(): Promise<void> {\n    // Early exit if the underlying ES client encountered an error.\n    if (this.bulkClientError) {\n      return Promise.reject(this.bulkClientError);\n    }\n\n    // Optimization: if the stream that ES reads from has fewer docs queued\n    // than the configured batch size, continue early to allow more docs to be\n    // queued\n    if (this.sourceStream.readableLength < this.configuredBatchSize) {\n      return Promise.resolve();\n    }\n\n    // Otherwise, continue periodically checking the stream queue to see if\n    // ES has consumed the documents and continue when it's ready for more.\n    return new Promise((isReady, abort) => {\n      let streamLengthChecks = 0;\n      const interval = setInterval(() => {\n        streamLengthChecks++;\n\n        if (this.sourceStream.readableLength < this.configuredBatchSize) {\n          clearInterval(interval);\n          isReady();\n        }\n\n        // Do not allow this interval to loop endlessly; anything longer than 5\n        // minutes likely indicates an unrecoverable error in ES; direct the\n        // user to inspect ES logs for more clues and abort in order to allow\n        // the index to be cleaned up.\n        if (streamLengthChecks >= 6000) {\n          clearInterval(interval);\n          abort(\n            new Error(\n              'Exceeded 5 minutes waiting for elastic to be ready to accept more documents. Check the elastic logs for possible problems.',\n            ),\n          );\n        }\n      }, 50);\n    });\n  }\n\n  private constructIndexName(postFix: string) {\n    return `${this.indexPrefix}${this.type}${this.indexSeparator}${postFix}`;\n  }\n}\n"],"names":["BatchSearchEngineIndexer","Readable"],"mappings":";;;;;AAqCA,SAAS,SAAS,cAA0C,EAAA;AAC1D,EAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,MAAA,CAAO,cAAc,CAAA;AAC3C,EAAA,MAAM,UAAU,KAAM,CAAA,CAAC,CAAI,GAAA,KAAA,CAAM,CAAC,CAAI,GAAA,GAAA;AACtC,EAAA,OAAO,CAAG,EAAA,OAAA,CAAQ,OAAQ,CAAA,CAAC,CAAC,CAAA,CAAA,CAAA;AAC9B;AAMO,MAAM,yCAAyCA,gDAAyB,CAAA;AAAA,EACrE,SAAoB,GAAA,CAAA;AAAA,EACpB,mBAA6B,EAAC;AAAA,EAErB,cAAA;AAAA,EACA,IAAA;AAAA,EACD,SAAA;AAAA,EACC,WAAA;AAAA,EACA,cAAA;AAAA,EACA,KAAA;AAAA,EACA,MAAA;AAAA,EACA,YAAA;AAAA,EACA,0BAAA;AAAA,EACT,mBAAA;AAAA,EACA,UAAA;AAAA,EACA,eAAA;AAAA,EAER,YAAY,OAAkD,EAAA;AAC5D,IAAA,KAAA,CAAM,EAAE,SAAA,EAAW,OAAQ,CAAA,SAAA,EAAW,CAAA;AACtC,IAAA,IAAA,CAAK,sBAAsB,OAAQ,CAAA,SAAA;AACnC,IAAK,IAAA,CAAA,MAAA,GAAS,QAAQ,MAAO,CAAA,KAAA,CAAM,EAAE,YAAc,EAAA,OAAA,CAAQ,MAAM,CAAA;AACjE,IAAK,IAAA,CAAA,cAAA,GAAiB,QAAQ,MAAO,EAAA;AACrC,IAAA,IAAA,CAAK,OAAO,OAAQ,CAAA,IAAA;AACpB,IAAA,IAAA,CAAK,cAAc,OAAQ,CAAA,WAAA;AAC3B,IAAA,IAAA,CAAK,iBAAiB,OAAQ,CAAA,cAAA;AAC9B,IAAA,IAAA,CAAK,YAAY,IAAK,CAAA,kBAAA,CAAmB,GAAG,IAAK,CAAA,GAAA,EAAK,CAAE,CAAA,CAAA;AACxD,IAAA,IAAA,CAAK,QAAQ,OAAQ,CAAA,KAAA;AACrB,IAAA,IAAA,CAAK,6BAA6B,OAAQ,CAAA,0BAAA;AAK1C,IAAA,IAAA,CAAK,eAAe,IAAIC,eAAA,CAAS,EAAE,UAAA,EAAY,MAAM,CAAA;AACrD,IAAK,IAAA,CAAA,YAAA,CAAa,QAAQ,MAAM;AAAA,KAAC;AAGjC,IAAA,MAAM,IAAO,GAAA,IAAA;AAIb,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,0BAAA,CAA2B,IAAK,CAAA;AAAA,MACrD,YAAY,IAAK,CAAA,YAAA;AAAA,MACjB,UAAa,GAAA;AACX,QAAK,IAAA,CAAA,SAAA,EAAA;AACL,QAAO,OAAA;AAAA,UACL,KAAO,EAAA,EAAE,MAAQ,EAAA,IAAA,CAAK,SAAU;AAAA,SAClC;AAAA,OACF;AAAA,MACA,mBAAA,EAAqB,QAAQ,WAAgB,KAAA;AAAA,KAC9C,CAAA;AAGD,IAAK,IAAA,CAAA,UAAA,CAAW,MAAM,CAAK,CAAA,KAAA;AACzB,MAAA,IAAA,CAAK,eAAkB,GAAA,CAAA;AAAA,KACxB,CAAA;AAAA;AACH,EAEA,MAAM,UAA4B,GAAA;AAChC,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAAwC,qCAAA,EAAA,IAAA,CAAK,IAAI,CAAE,CAAA,CAAA;AAEpE,IAAA,MAAM,OAAU,GAAA,MAAM,IAAK,CAAA,0BAAA,CAA2B,WAAY,CAAA;AAAA,MAChE,KAAA,EAAO,IAAK,CAAA,kBAAA,CAAmB,GAAG;AAAA,KACnC,CAAA;AAED,IAAA,KAAA,MAAW,GAAO,IAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,IAAI,CAAG,EAAA;AAC3C,MAAK,IAAA,CAAA,gBAAA,CAAiB,KAAK,GAAG,CAAA;AAAA;AAGhC,IAAM,MAAA,IAAA,CAAK,2BAA2B,WAAY,CAAA;AAAA,MAChD,OAAO,IAAK,CAAA;AAAA,KACb,CAAA;AAAA;AACH,EAEA,MAAM,MAAM,SAA+C,EAAA;AACzD,IAAA,MAAM,KAAK,OAAQ,EAAA;AACnB,IAAA,SAAA,CAAU,QAAQ,CAAY,QAAA,KAAA;AAC5B,MAAK,IAAA,CAAA,YAAA,CAAa,KAAK,QAAQ,CAAA;AAAA,KAChC,CAAA;AAAA;AACH,EAEA,MAAM,QAA0B,GAAA;AAE9B,IAAA,MAAM,KAAK,OAAQ,EAAA;AAInB,IAAK,IAAA,CAAA,YAAA,CAAa,KAAK,IAAI,CAAA;AAG3B,IAAM,MAAA,MAAA,GAAS,MAAM,IAAK,CAAA,UAAA;AAI1B,IAAI,IAAA,IAAA,CAAK,cAAc,CAAG,EAAA;AACxB,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,QACV,CAAA,UAAA,EAAa,IAAK,CAAA,SAAS,CAAO,IAAA,EAAA,IAAA,CAAK,IAAI,CAAA,SAAA,EACzC,IAAK,CAAA,gBAAA,CAAiB,MAAS,GAAA,UAAA,GAAa,SAC9C,CAAA,8BAAA;AAAA,OACF;AACA,MAAI,IAAA;AACF,QAAM,MAAA,IAAA,CAAK,2BAA2B,WAAY,CAAA;AAAA,UAChD,OAAO,IAAK,CAAA;AAAA,SACb,CAAA;AAAA,eACM,KAAO,EAAA;AACd,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAqC,kCAAA,EAAA,KAAK,CAAE,CAAA,CAAA;AAAA;AAEhE,MAAA;AAAA;AAMF,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,MACV,CAAA,6BAAA,EAAgC,IAAK,CAAA,SAAS,CAC5C,IAAA,EAAA,IAAA,CAAK,IACP,CAAO,IAAA,EAAA,QAAA,CAAS,IAAK,CAAA,cAAc,CAAC,CAAA,CAAA;AAAA,MACpC;AAAA,KACF;AACA,IAAM,MAAA,IAAA,CAAK,2BAA2B,aAAc,CAAA;AAAA,MAClD,OAAS,EAAA;AAAA,QACP;AAAA,UACE,MAAA,EAAQ,EAAE,KAAO,EAAA,IAAA,CAAK,mBAAmB,GAAG,CAAA,EAAG,KAAO,EAAA,IAAA,CAAK,KAAM;AAAA,SACnE;AAAA,QACA;AAAA,UACE,KAAK,EAAE,KAAA,EAAO,KAAK,SAAW,EAAA,KAAA,EAAO,KAAK,KAAM;AAAA;AAClD,OACF,CAAE,OAAO,OAAO;AAAA,KACjB,CAAA;AAID,IAAI,IAAA,IAAA,CAAK,iBAAiB,MAAQ,EAAA;AAChC,MAAK,IAAA,CAAA,MAAA,CAAO,KAAK,+BAAiC,EAAA;AAAA,QAChD,kBAAkB,IAAK,CAAA;AAAA,OACxB,CAAA;AAID,MAAM,MAAA,MAAA,GAAS,KAAK,gBAAiB,CAAA,MAAA;AAAA,QACnC,CAAC,WAAa,EAAA,IAAA,EAAM,KAAU,KAAA;AAC5B,UAAA,MAAM,UAAa,GAAA,IAAA,CAAK,KAAM,CAAA,KAAA,GAAQ,EAAE,CAAA;AAExC,UAAI,IAAA,CAAC,WAAY,CAAA,UAAU,CAAG,EAAA;AAC5B,YAAY,WAAA,CAAA,UAAU,IAAI,EAAC;AAAA;AAG7B,UAAY,WAAA,CAAA,UAAU,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA;AAEjC,UAAO,OAAA,WAAA;AAAA,SACT;AAAA,QACA;AAAC,OACH;AAGA,MAAA,KAAA,MAAW,SAAS,MAAQ,EAAA;AAC1B,QAAI,IAAA;AACF,UAAM,MAAA,IAAA,CAAK,2BAA2B,WAAY,CAAA;AAAA,YAChD,KAAO,EAAA;AAAA,WACR,CAAA;AAAA,iBACM,CAAG,EAAA;AACV,UAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAA0C,uCAAA,EAAA,CAAC,CAAE,CAAA,CAAA;AAAA;AAChE;AACF;AACF;AACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,OAAyB,GAAA;AAE/B,IAAA,IAAI,KAAK,eAAiB,EAAA;AACxB,MAAO,OAAA,OAAA,CAAQ,MAAO,CAAA,IAAA,CAAK,eAAe,CAAA;AAAA;AAM5C,IAAA,IAAI,IAAK,CAAA,YAAA,CAAa,cAAiB,GAAA,IAAA,CAAK,mBAAqB,EAAA;AAC/D,MAAA,OAAO,QAAQ,OAAQ,EAAA;AAAA;AAKzB,IAAA,OAAO,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,KAAU,KAAA;AACrC,MAAA,IAAI,kBAAqB,GAAA,CAAA;AACzB,MAAM,MAAA,QAAA,GAAW,YAAY,MAAM;AACjC,QAAA,kBAAA,EAAA;AAEA,QAAA,IAAI,IAAK,CAAA,YAAA,CAAa,cAAiB,GAAA,IAAA,CAAK,mBAAqB,EAAA;AAC/D,UAAA,aAAA,CAAc,QAAQ,CAAA;AACtB,UAAQ,OAAA,EAAA;AAAA;AAOV,QAAA,IAAI,sBAAsB,GAAM,EAAA;AAC9B,UAAA,aAAA,CAAc,QAAQ,CAAA;AACtB,UAAA,KAAA;AAAA,YACE,IAAI,KAAA;AAAA,cACF;AAAA;AACF,WACF;AAAA;AACF,SACC,EAAE,CAAA;AAAA,KACN,CAAA;AAAA;AACH,EAEQ,mBAAmB,OAAiB,EAAA;AAC1C,IAAO,OAAA,CAAA,EAAG,IAAK,CAAA,WAAW,CAAG,EAAA,IAAA,CAAK,IAAI,CAAG,EAAA,IAAA,CAAK,cAAc,CAAA,EAAG,OAAO,CAAA,CAAA;AAAA;AAE1E;;;;"}

package/dist/module.cjs.js

@@ -39,11 +39,18 @@ var feature = backendPluginApi.createBackendModule({
           );
           return;
         }
+        const indexPrefix = config.getOptionalString(
+          "search.elasticsearch.indexPrefix"
+        );
+        if (indexPrefix) {
+          logger.info(`Index prefix will be used for indices: ${indexPrefix}`);
+        }
         searchEngineRegistry.setSearchEngine(
           await pluginSearchBackendModuleElasticsearch.ElasticSearchSearchEngine.fromConfig({
             logger,
             config,
-            translator
+            translator,
+            indexPrefix
           })
         );
       }

package/dist/module.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["/*\n * Copyright 2023 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 */\nimport {\n  coreServices,\n  createBackendModule,\n  createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport { searchEngineRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport {\n  ElasticSearchQueryTranslator,\n  ElasticSearchSearchEngine,\n} from '@backstage/plugin-search-backend-module-elasticsearch';\n\n/** @public */\nexport interface ElasticSearchQueryTranslatorExtensionPoint {\n  setTranslator(translator: ElasticSearchQueryTranslator): void;\n}\n\n/**\n * Extension point used to customize the ElasticSearch query translator.\n *\n * @public\n */\nexport const elasticsearchTranslatorExtensionPoint =\n  createExtensionPoint<ElasticSearchQueryTranslatorExtensionPoint>({\n    id: 'search.elasticsearchEngine.translator',\n  });\n\n/**\n * Search backend module for the Elasticsearch engine.\n *\n * @public\n */\nexport default createBackendModule({\n  pluginId: 'search',\n  moduleId: 'elasticsearch-engine',\n  register(env) {\n    let translator: ElasticSearchQueryTranslator | undefined;\n\n    env.registerExtensionPoint(elasticsearchTranslatorExtensionPoint, {\n      setTranslator(newTranslator) {\n        if (translator) {\n          throw new Error(\n            'ElasticSearch query translator may only be set once',\n          );\n        }\n        translator = newTranslator;\n      },\n    });\n\n    env.registerInit({\n      deps: {\n        searchEngineRegistry: searchEngineRegistryExtensionPoint,\n        logger: coreServices.logger,\n        config: coreServices.rootConfig,\n      },\n      async init({ searchEngineRegistry, logger, config }) {\n        const baseKey = 'search.elasticsearch';\n        const baseConfig = config.getOptional(baseKey);\n        if (!baseConfig) {\n          logger.warn(\n            'No configuration found under \"search.elasticsearch\" key.  Skipping search engine inititalization.',\n          );\n          return;\n        }\n\n        searchEngineRegistry.setSearchEngine(\n          await ElasticSearchSearchEngine.fromConfig({\n            logger,\n            config,\n            translator,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createExtensionPoint","createBackendModule","searchEngineRegistryExtensionPoint","coreServices","ElasticSearchSearchEngine"],"mappings":";;;;;;;;AAoCO,MAAM,wCACXA,qCAAiE,CAAA;AAAA,EAC/D,EAAI,EAAA;AACN,CAAC;AAOH,cAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,sBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,UAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuB,qCAAuC,EAAA;AAAA,MAChE,cAAc,aAAe,EAAA;AAC3B,QAAA,IAAI,UAAY,EAAA;AACd,UAAA,MAAM,IAAI,KAAA;AAAA,YACR;AAAA,WACF;AAAA;AAEF,QAAa,UAAA,GAAA,aAAA;AAAA;AACf,KACD,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,oBAAsB,EAAAC,wCAAA;AAAA,QACtB,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA;AAAA,OACvB;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,oBAAsB,EAAA,MAAA,EAAQ,QAAU,EAAA;AACnD,QAAA,MAAM,OAAU,GAAA,sBAAA;AAChB,QAAM,MAAA,UAAA,GAAa,MAAO,CAAA,WAAA,CAAY,OAAO,CAAA;AAC7C,QAAA,IAAI,CAAC,UAAY,EAAA;AACf,UAAO,MAAA,CAAA,IAAA;AAAA,YACL;AAAA,WACF;AACA,UAAA;AAAA;AAGF,QAAqB,oBAAA,CAAA,eAAA;AAAA,UACnB,MAAMC,iEAA0B,UAAW,CAAA;AAAA,YACzC,MAAA;AAAA,YACA,MAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC,CAAA;;;;;"}
+{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["/*\n * Copyright 2023 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 */\nimport {\n  coreServices,\n  createBackendModule,\n  createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport { searchEngineRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport {\n  ElasticSearchQueryTranslator,\n  ElasticSearchSearchEngine,\n} from '@backstage/plugin-search-backend-module-elasticsearch';\n\n/** @public */\nexport interface ElasticSearchQueryTranslatorExtensionPoint {\n  setTranslator(translator: ElasticSearchQueryTranslator): void;\n}\n\n/**\n * Extension point used to customize the ElasticSearch query translator.\n *\n * @public\n */\nexport const elasticsearchTranslatorExtensionPoint =\n  createExtensionPoint<ElasticSearchQueryTranslatorExtensionPoint>({\n    id: 'search.elasticsearchEngine.translator',\n  });\n\n/**\n * Search backend module for the Elasticsearch engine.\n *\n * @public\n */\nexport default createBackendModule({\n  pluginId: 'search',\n  moduleId: 'elasticsearch-engine',\n  register(env) {\n    let translator: ElasticSearchQueryTranslator | undefined;\n\n    env.registerExtensionPoint(elasticsearchTranslatorExtensionPoint, {\n      setTranslator(newTranslator) {\n        if (translator) {\n          throw new Error(\n            'ElasticSearch query translator may only be set once',\n          );\n        }\n        translator = newTranslator;\n      },\n    });\n\n    env.registerInit({\n      deps: {\n        searchEngineRegistry: searchEngineRegistryExtensionPoint,\n        logger: coreServices.logger,\n        config: coreServices.rootConfig,\n      },\n      async init({ searchEngineRegistry, logger, config }) {\n        const baseKey = 'search.elasticsearch';\n        const baseConfig = config.getOptional(baseKey);\n        if (!baseConfig) {\n          logger.warn(\n            'No configuration found under \"search.elasticsearch\" key.  Skipping search engine inititalization.',\n          );\n          return;\n        }\n        const indexPrefix = config.getOptionalString(\n          'search.elasticsearch.indexPrefix',\n        );\n        if (indexPrefix) {\n          logger.info(`Index prefix will be used for indices: ${indexPrefix}`);\n        }\n        searchEngineRegistry.setSearchEngine(\n          await ElasticSearchSearchEngine.fromConfig({\n            logger,\n            config,\n            translator,\n            indexPrefix,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createExtensionPoint","createBackendModule","searchEngineRegistryExtensionPoint","coreServices","ElasticSearchSearchEngine"],"mappings":";;;;;;;;AAoCO,MAAM,wCACXA,qCAAiE,CAAA;AAAA,EAC/D,EAAI,EAAA;AACN,CAAC;AAOH,cAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,sBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,UAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuB,qCAAuC,EAAA;AAAA,MAChE,cAAc,aAAe,EAAA;AAC3B,QAAA,IAAI,UAAY,EAAA;AACd,UAAA,MAAM,IAAI,KAAA;AAAA,YACR;AAAA,WACF;AAAA;AAEF,QAAa,UAAA,GAAA,aAAA;AAAA;AACf,KACD,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,oBAAsB,EAAAC,wCAAA;AAAA,QACtB,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA;AAAA,OACvB;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,oBAAsB,EAAA,MAAA,EAAQ,QAAU,EAAA;AACnD,QAAA,MAAM,OAAU,GAAA,sBAAA;AAChB,QAAM,MAAA,UAAA,GAAa,MAAO,CAAA,WAAA,CAAY,OAAO,CAAA;AAC7C,QAAA,IAAI,CAAC,UAAY,EAAA;AACf,UAAO,MAAA,CAAA,IAAA;AAAA,YACL;AAAA,WACF;AACA,UAAA;AAAA;AAEF,QAAA,MAAM,cAAc,MAAO,CAAA,iBAAA;AAAA,UACzB;AAAA,SACF;AACA,QAAA,IAAI,WAAa,EAAA;AACf,UAAO,MAAA,CAAA,IAAA,CAAK,CAA0C,uCAAA,EAAA,WAAW,CAAE,CAAA,CAAA;AAAA;AAErE,QAAqB,oBAAA,CAAA,eAAA;AAAA,UACnB,MAAMC,iEAA0B,UAAW,CAAA;AAAA,YACzC,MAAA;AAAA,YACA,MAAA;AAAA,YACA,UAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC,CAAA;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-backend-module-elasticsearch",
-  "version": "1.6.5",
+  "version": "1.6.6-next.1",
   "description": "A module for the search backend that implements search using ElasticSearch",
   "backstage": {
     "role": "backend-plugin-module",
@@ -62,11 +62,11 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^1.2.0",
-    "@backstage/config": "^1.3.2",
-    "@backstage/integration-aws-node": "^0.1.15",
-    "@backstage/plugin-search-backend-node": "^1.3.8",
-    "@backstage/plugin-search-common": "^1.2.17",
+    "@backstage/backend-plugin-api": "1.2.1-next.1",
+    "@backstage/config": "1.3.2",
+    "@backstage/integration-aws-node": "0.1.15",
+    "@backstage/plugin-search-backend-node": "1.3.9-next.1",
+    "@backstage/plugin-search-common": "1.2.17",
     "@elastic/elasticsearch": "^7.13.0",
     "@opensearch-project/opensearch": "^2.2.1",
     "aws4": "^1.12.0",
@@ -75,8 +75,8 @@
     "uuid": "^11.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.3.0",
-    "@backstage/cli": "^0.30.0",
+    "@backstage/backend-test-utils": "1.3.1-next.1",
+    "@backstage/cli": "0.30.1-next.0",
     "@elastic/elasticsearch-mock": "^1.0.0",
     "@short.io/opensearch-mock": "^0.4.0"
   },