@backstage/plugin-search-backend-module-elasticsearch 1.7.4 → 1.7.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/dist/alpha.cjs.js.map +1 -1
- package/dist/engines/ElasticSearchClientOptions.cjs.js.map +1 -1
- package/dist/engines/ElasticSearchClientWrapper.cjs.js.map +1 -1
- package/dist/engines/ElasticSearchSearchEngine.cjs.js.map +1 -1
- package/dist/engines/ElasticSearchSearchEngineIndexer.cjs.js.map +1 -1
- package/dist/module.cjs.js.map +1 -1
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,24 @@
|
|
|
1
1
|
# @backstage/plugin-search-backend-module-elasticsearch
|
|
2
2
|
|
|
3
|
+
## 1.7.5
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/plugin-search-backend-node@1.3.14
|
|
9
|
+
- @backstage/backend-plugin-api@1.4.2
|
|
10
|
+
|
|
11
|
+
## 1.7.5-next.0
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- Updated dependencies
|
|
16
|
+
- @backstage/plugin-search-backend-node@1.3.14-next.0
|
|
17
|
+
- @backstage/backend-plugin-api@1.4.2-next.0
|
|
18
|
+
- @backstage/config@1.3.3
|
|
19
|
+
- @backstage/integration-aws-node@0.1.17
|
|
20
|
+
- @backstage/plugin-search-common@1.2.19
|
|
21
|
+
|
|
3
22
|
## 1.7.4
|
|
4
23
|
|
|
5
24
|
### Patch Changes
|
package/dist/alpha.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2024 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 { default as feature } from './module';\n\n/** @alpha */\nconst _feature = feature;\nexport default _feature;\n"],"names":["feature"],"mappings":";;;;;;AAmBA,MAAM,
|
|
1
|
+
{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2024 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 { default as feature } from './module';\n\n/** @alpha */\nconst _feature = feature;\nexport default _feature;\n"],"names":["feature"],"mappings":";;;;;;AAmBA,MAAM,QAAA,GAAWA;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ElasticSearchClientOptions.cjs.js","sources":["../../src/engines/ElasticSearchClientOptions.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 */\nimport type { ConnectionOptions as TLSConnectionOptions } from 'tls';\n\n/**\n * Typeguard to differentiate ElasticSearch client options which are compatible\n * with OpenSearch vs. ElasticSearch clients. Useful when calling the\n * {@link ElasticSearchSearchEngine.newClient} method.\n *\n * @public\n */\nexport const isOpenSearchCompatible = (\n opts: ElasticSearchClientOptions,\n): opts is OpenSearchElasticSearchClientOptions => {\n return ['aws', 'opensearch'].includes(opts?.provider ?? '');\n};\n\n/**\n * Options used to configure the `@elastic/elasticsearch` client or the\n * `@opensearch-project/opensearch` client, depending on the given config. It\n * will be passed as an argument to the\n * {@link ElasticSearchSearchEngine.newClient} method.\n *\n * @public\n */\nexport type ElasticSearchClientOptions =\n | ElasticSearchElasticSearchClientOptions\n | OpenSearchElasticSearchClientOptions;\n\n/**\n * Options used to configure the `@opensearch-project/opensearch` client.\n *\n * They are drawn from the `ClientOptions` class of `@opensearch-project/opensearch`,\n * but are maintained separately so that this interface is not coupled to it.\n *\n * @public\n */\nexport interface OpenSearchElasticSearchClientOptions\n extends BaseElasticSearchClientOptions {\n provider?: 'aws' | 'opensearch';\n region?: string;\n service?: 'es' | 'aoss';\n auth?: OpenSearchAuth;\n connection?: OpenSearchConnectionConstructor;\n node?: string | string[] | OpenSearchNodeOptions | OpenSearchNodeOptions[];\n nodes?: string | string[] | OpenSearchNodeOptions | OpenSearchNodeOptions[];\n}\n\n/**\n * Options used to configure the `@elastic/elasticsearch` client.\n *\n * They are drawn from the `ClientOptions` class of `@elastic/elasticsearch`,\n * but are maintained separately so that this interface is not coupled to it.\n *\n * @public\n */\nexport interface ElasticSearchElasticSearchClientOptions\n extends BaseElasticSearchClientOptions {\n provider?: 'elastic';\n auth?: ElasticSearchAuth;\n Connection?: ElasticSearchConnectionConstructor;\n node?:\n | string\n | string[]\n | ElasticSearchNodeOptions\n | ElasticSearchNodeOptions[];\n nodes?:\n | string\n | string[]\n | ElasticSearchNodeOptions\n | ElasticSearchNodeOptions[];\n cloud?: {\n id: string;\n username?: string;\n password?: string;\n };\n}\n\n/**\n * Base client options that are shared across `@opensearch-project/opensearch`\n * and `@elastic/elasticsearch` clients.\n *\n * @public\n */\nexport interface BaseElasticSearchClientOptions {\n Transport?: ElasticSearchTransportConstructor;\n maxRetries?: number;\n requestTimeout?: number;\n pingTimeout?: number;\n sniffInterval?: number | boolean;\n sniffOnStart?: boolean;\n sniffEndpoint?: string;\n sniffOnConnectionFault?: boolean;\n resurrectStrategy?: 'ping' | 'optimistic' | 'none';\n suggestCompression?: boolean;\n compression?: 'gzip';\n ssl?: TLSConnectionOptions;\n agent?: ElasticSearchAgentOptions | ((opts?: any) => unknown) | false;\n nodeFilter?: (connection: any) => boolean;\n nodeSelector?: ((connections: any[]) => any) | string;\n headers?: Record<string, any>;\n opaqueIdPrefix?: string;\n name?: string | symbol;\n proxy?: string | URL;\n enableMetaHeader?: boolean;\n disablePrototypePoisoningProtection?: boolean | 'proto' | 'constructor';\n}\n\n/**\n * @public\n */\nexport type OpenSearchAuth = {\n username: string;\n password: string;\n};\n\n/**\n * @public\n */\nexport type ElasticSearchAuth =\n | OpenSearchAuth\n | {\n apiKey:\n | string\n | {\n id: string;\n api_key: string;\n };\n };\n\n/**\n * @public\n */\nexport interface ElasticSearchNodeOptions {\n url: URL;\n id?: string;\n agent?: ElasticSearchAgentOptions;\n ssl?: TLSConnectionOptions;\n headers?: Record<string, any>;\n roles?: {\n master: boolean;\n data: boolean;\n ingest: boolean;\n ml: boolean;\n };\n}\n\n/**\n * @public\n */\nexport interface OpenSearchNodeOptions {\n url: URL;\n id?: string;\n agent?: ElasticSearchAgentOptions;\n ssl?: TLSConnectionOptions;\n headers?: Record<string, any>;\n roles?: {\n master: boolean;\n data: boolean;\n ingest: boolean;\n };\n}\n\n/**\n * @public\n */\nexport interface ElasticSearchAgentOptions {\n keepAlive?: boolean;\n keepAliveMsecs?: number;\n maxSockets?: number;\n maxFreeSockets?: number;\n}\n\n/**\n * @public\n */\nexport interface ElasticSearchConnectionConstructor {\n new (opts?: any): any;\n statuses: {\n ALIVE: string;\n DEAD: string;\n };\n roles: {\n MASTER: string;\n DATA: string;\n INGEST: string;\n ML: string;\n };\n}\n\n/**\n * @public\n */\nexport interface OpenSearchConnectionConstructor {\n new (opts?: any): any;\n statuses: {\n ALIVE: string;\n DEAD: string;\n };\n roles: {\n MASTER: string;\n DATA: string;\n INGEST: string;\n };\n}\n\n/**\n * @public\n */\nexport interface ElasticSearchTransportConstructor {\n new (opts?: any): any;\n sniffReasons: {\n SNIFF_ON_START: string;\n SNIFF_INTERVAL: string;\n SNIFF_ON_CONNECTION_FAULT: string;\n DEFAULT: string;\n };\n}\n\n// todo(iamEAP) implement canary types to ensure we remain compatible through upgrades.\n"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"ElasticSearchClientOptions.cjs.js","sources":["../../src/engines/ElasticSearchClientOptions.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 */\nimport type { ConnectionOptions as TLSConnectionOptions } from 'tls';\n\n/**\n * Typeguard to differentiate ElasticSearch client options which are compatible\n * with OpenSearch vs. ElasticSearch clients. Useful when calling the\n * {@link ElasticSearchSearchEngine.newClient} method.\n *\n * @public\n */\nexport const isOpenSearchCompatible = (\n opts: ElasticSearchClientOptions,\n): opts is OpenSearchElasticSearchClientOptions => {\n return ['aws', 'opensearch'].includes(opts?.provider ?? '');\n};\n\n/**\n * Options used to configure the `@elastic/elasticsearch` client or the\n * `@opensearch-project/opensearch` client, depending on the given config. It\n * will be passed as an argument to the\n * {@link ElasticSearchSearchEngine.newClient} method.\n *\n * @public\n */\nexport type ElasticSearchClientOptions =\n | ElasticSearchElasticSearchClientOptions\n | OpenSearchElasticSearchClientOptions;\n\n/**\n * Options used to configure the `@opensearch-project/opensearch` client.\n *\n * They are drawn from the `ClientOptions` class of `@opensearch-project/opensearch`,\n * but are maintained separately so that this interface is not coupled to it.\n *\n * @public\n */\nexport interface OpenSearchElasticSearchClientOptions\n extends BaseElasticSearchClientOptions {\n provider?: 'aws' | 'opensearch';\n region?: string;\n service?: 'es' | 'aoss';\n auth?: OpenSearchAuth;\n connection?: OpenSearchConnectionConstructor;\n node?: string | string[] | OpenSearchNodeOptions | OpenSearchNodeOptions[];\n nodes?: string | string[] | OpenSearchNodeOptions | OpenSearchNodeOptions[];\n}\n\n/**\n * Options used to configure the `@elastic/elasticsearch` client.\n *\n * They are drawn from the `ClientOptions` class of `@elastic/elasticsearch`,\n * but are maintained separately so that this interface is not coupled to it.\n *\n * @public\n */\nexport interface ElasticSearchElasticSearchClientOptions\n extends BaseElasticSearchClientOptions {\n provider?: 'elastic';\n auth?: ElasticSearchAuth;\n Connection?: ElasticSearchConnectionConstructor;\n node?:\n | string\n | string[]\n | ElasticSearchNodeOptions\n | ElasticSearchNodeOptions[];\n nodes?:\n | string\n | string[]\n | ElasticSearchNodeOptions\n | ElasticSearchNodeOptions[];\n cloud?: {\n id: string;\n username?: string;\n password?: string;\n };\n}\n\n/**\n * Base client options that are shared across `@opensearch-project/opensearch`\n * and `@elastic/elasticsearch` clients.\n *\n * @public\n */\nexport interface BaseElasticSearchClientOptions {\n Transport?: ElasticSearchTransportConstructor;\n maxRetries?: number;\n requestTimeout?: number;\n pingTimeout?: number;\n sniffInterval?: number | boolean;\n sniffOnStart?: boolean;\n sniffEndpoint?: string;\n sniffOnConnectionFault?: boolean;\n resurrectStrategy?: 'ping' | 'optimistic' | 'none';\n suggestCompression?: boolean;\n compression?: 'gzip';\n ssl?: TLSConnectionOptions;\n agent?: ElasticSearchAgentOptions | ((opts?: any) => unknown) | false;\n nodeFilter?: (connection: any) => boolean;\n nodeSelector?: ((connections: any[]) => any) | string;\n headers?: Record<string, any>;\n opaqueIdPrefix?: string;\n name?: string | symbol;\n proxy?: string | URL;\n enableMetaHeader?: boolean;\n disablePrototypePoisoningProtection?: boolean | 'proto' | 'constructor';\n}\n\n/**\n * @public\n */\nexport type OpenSearchAuth = {\n username: string;\n password: string;\n};\n\n/**\n * @public\n */\nexport type ElasticSearchAuth =\n | OpenSearchAuth\n | {\n apiKey:\n | string\n | {\n id: string;\n api_key: string;\n };\n };\n\n/**\n * @public\n */\nexport interface ElasticSearchNodeOptions {\n url: URL;\n id?: string;\n agent?: ElasticSearchAgentOptions;\n ssl?: TLSConnectionOptions;\n headers?: Record<string, any>;\n roles?: {\n master: boolean;\n data: boolean;\n ingest: boolean;\n ml: boolean;\n };\n}\n\n/**\n * @public\n */\nexport interface OpenSearchNodeOptions {\n url: URL;\n id?: string;\n agent?: ElasticSearchAgentOptions;\n ssl?: TLSConnectionOptions;\n headers?: Record<string, any>;\n roles?: {\n master: boolean;\n data: boolean;\n ingest: boolean;\n };\n}\n\n/**\n * @public\n */\nexport interface ElasticSearchAgentOptions {\n keepAlive?: boolean;\n keepAliveMsecs?: number;\n maxSockets?: number;\n maxFreeSockets?: number;\n}\n\n/**\n * @public\n */\nexport interface ElasticSearchConnectionConstructor {\n new (opts?: any): any;\n statuses: {\n ALIVE: string;\n DEAD: string;\n };\n roles: {\n MASTER: string;\n DATA: string;\n INGEST: string;\n ML: string;\n };\n}\n\n/**\n * @public\n */\nexport interface OpenSearchConnectionConstructor {\n new (opts?: any): any;\n statuses: {\n ALIVE: string;\n DEAD: string;\n };\n roles: {\n MASTER: string;\n DATA: string;\n INGEST: string;\n };\n}\n\n/**\n * @public\n */\nexport interface ElasticSearchTransportConstructor {\n new (opts?: any): any;\n sniffReasons: {\n SNIFF_ON_START: string;\n SNIFF_INTERVAL: string;\n SNIFF_ON_CONNECTION_FAULT: string;\n DEFAULT: string;\n };\n}\n\n// todo(iamEAP) implement canary types to ensure we remain compatible through upgrades.\n"],"names":[],"mappings":";;AAwBO,MAAM,sBAAA,GAAyB,CACpC,IAAA,KACiD;AACjD,EAAA,OAAO,CAAC,KAAA,EAAO,YAAY,EAAE,QAAA,CAAS,IAAA,EAAM,YAAY,EAAE,CAAA;AAC5D;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ElasticSearchClientWrapper.cjs.js","sources":["../../src/engines/ElasticSearchClientWrapper.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 { Client as ElasticSearchClient } from '@elastic/elasticsearch';\nimport { Client as OpenSearchClient } from '@opensearch-project/opensearch';\nimport { Readable } from 'stream';\nimport {\n ElasticSearchClientOptions,\n isOpenSearchCompatible,\n} from './ElasticSearchClientOptions';\nimport { ElasticSearchCustomIndexTemplate } from './types';\n\n/**\n * @public\n */\nexport type ElasticSearchAliasAction =\n | {\n remove: { index: any; alias: any };\n add?: undefined;\n }\n | {\n add: { indices: any; alias: any; index?: undefined };\n remove?: undefined;\n }\n | {\n add: { index: any; alias: any; indices?: undefined };\n remove?: undefined;\n }\n | undefined;\n\n/**\n * @public\n */\nexport type ElasticSearchIndexAction = {\n index: {\n _index: string;\n [key: string]: any;\n };\n};\n\n/**\n * A wrapper class that exposes logical methods that are conditionally fired\n * against either a configured Elasticsearch client or a configured Opensearch\n * client.\n *\n * This is necessary because, despite its intention to be API-compatible, the\n * opensearch client does not support API key-based authentication. This is\n * also the sanest way to accomplish this while making typescript happy.\n *\n * In the future, if the differences between implementations become\n * unmaintainably divergent, we should split out the Opensearch and\n * Elasticsearch search engine implementations.\n *\n * @public\n */\nexport class ElasticSearchClientWrapper {\n private readonly elasticSearchClient: ElasticSearchClient | undefined;\n private readonly openSearchClient: OpenSearchClient | undefined;\n\n private constructor(options: {\n openSearchClient?: OpenSearchClient;\n elasticSearchClient?: ElasticSearchClient;\n }) {\n this.openSearchClient = options.openSearchClient;\n this.elasticSearchClient = options.elasticSearchClient;\n }\n\n static fromClientOptions(options: ElasticSearchClientOptions) {\n if (isOpenSearchCompatible(options)) {\n return new ElasticSearchClientWrapper({\n openSearchClient: new OpenSearchClient(options),\n });\n }\n\n return new ElasticSearchClientWrapper({\n elasticSearchClient: new ElasticSearchClient(options),\n });\n }\n\n search(options: { index: string | string[]; body: Object }) {\n const searchOptions = {\n ignore_unavailable: true,\n allow_no_indices: true,\n };\n\n if (this.openSearchClient) {\n return this.openSearchClient.search({\n ...options,\n ...searchOptions,\n });\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.search({\n ...options,\n ...searchOptions,\n });\n }\n\n throw new Error('No client defined');\n }\n\n bulk(bulkOptions: {\n datasource: Readable;\n onDocument: () => ElasticSearchIndexAction;\n refreshOnCompletion?: string | boolean;\n }) {\n if (this.openSearchClient) {\n return this.openSearchClient.helpers.bulk(bulkOptions);\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.helpers.bulk(bulkOptions);\n }\n\n throw new Error('No client defined');\n }\n\n putIndexTemplate(template: ElasticSearchCustomIndexTemplate) {\n if (this.openSearchClient) {\n return this.openSearchClient.indices.putIndexTemplate(template);\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.indices.putIndexTemplate(template);\n }\n\n throw new Error('No client defined');\n }\n\n listIndices(options: { index: string }) {\n if (this.openSearchClient) {\n return this.openSearchClient.indices.get(options);\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.indices.get(options);\n }\n\n throw new Error('No client defined');\n }\n\n indexExists(options: { index: string | string[] }) {\n if (this.openSearchClient) {\n return this.openSearchClient.indices.exists(options);\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.indices.exists(options);\n }\n\n throw new Error('No client defined');\n }\n\n deleteIndex(options: { index: string | string[] }) {\n if (this.openSearchClient) {\n return this.openSearchClient.indices.delete(options);\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.indices.delete(options);\n }\n\n throw new Error('No client defined');\n }\n\n /**\n * @deprecated unused by the ElasticSearch Engine, will be removed in the future\n */\n getAliases(options: { aliases: string[] }) {\n const { aliases } = options;\n\n if (this.openSearchClient) {\n return this.openSearchClient.cat.aliases({\n format: 'json',\n name: aliases,\n });\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.cat.aliases({\n format: 'json',\n name: aliases,\n });\n }\n\n throw new Error('No client defined');\n }\n\n createIndex(options: { index: string }) {\n if (this.openSearchClient) {\n return this.openSearchClient.indices.create(options);\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.indices.create(options);\n }\n\n throw new Error('No client defined');\n }\n\n updateAliases(options: { actions: ElasticSearchAliasAction[] }) {\n const filteredActions = options.actions.filter(Boolean);\n\n if (this.openSearchClient) {\n return this.openSearchClient.indices.updateAliases({\n body: {\n actions: filteredActions,\n },\n });\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.indices.updateAliases({\n body: {\n actions: filteredActions,\n },\n });\n }\n\n throw new Error('No client defined');\n }\n}\n"],"names":["isOpenSearchCompatible","OpenSearchClient","ElasticSearchClient"],"mappings":";;;;;;AAoEO,MAAM,0BAA2B,CAAA;AAAA,EACrB,mBAAA;AAAA,EACA,gBAAA;AAAA,EAET,YAAY,OAGjB,EAAA;AACD,IAAA,IAAA,CAAK,mBAAmB,OAAQ,CAAA,gBAAA;AAChC,IAAA,IAAA,CAAK,sBAAsB,OAAQ,CAAA,mBAAA;AAAA;AACrC,EAEA,OAAO,kBAAkB,OAAqC,EAAA;AAC5D,IAAI,IAAAA,iDAAA,CAAuB,OAAO,CAAG,EAAA;AACnC,MAAA,OAAO,IAAI,0BAA2B,CAAA;AAAA,QACpC,gBAAA,EAAkB,IAAIC,iBAAA,CAAiB,OAAO;AAAA,OAC/C,CAAA;AAAA;AAGH,IAAA,OAAO,IAAI,0BAA2B,CAAA;AAAA,MACpC,mBAAA,EAAqB,IAAIC,oBAAA,CAAoB,OAAO;AAAA,KACrD,CAAA;AAAA;AACH,EAEA,OAAO,OAAqD,EAAA;AAC1D,IAAA,MAAM,aAAgB,GAAA;AAAA,MACpB,kBAAoB,EAAA,IAAA;AAAA,MACpB,gBAAkB,EAAA;AAAA,KACpB;AAEA,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAO,OAAA,IAAA,CAAK,iBAAiB,MAAO,CAAA;AAAA,QAClC,GAAG,OAAA;AAAA,QACH,GAAG;AAAA,OACJ,CAAA;AAAA;AAGH,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAO,OAAA,IAAA,CAAK,oBAAoB,MAAO,CAAA;AAAA,QACrC,GAAG,OAAA;AAAA,QACH,GAAG;AAAA,OACJ,CAAA;AAAA;AAGH,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA;AAAA;AACrC,EAEA,KAAK,WAIF,EAAA;AACD,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAA,OAAO,IAAK,CAAA,gBAAA,CAAiB,OAAQ,CAAA,IAAA,CAAK,WAAW,CAAA;AAAA;AAGvD,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAA,OAAO,IAAK,CAAA,mBAAA,CAAoB,OAAQ,CAAA,IAAA,CAAK,WAAW,CAAA;AAAA;AAG1D,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA;AAAA;AACrC,EAEA,iBAAiB,QAA4C,EAAA;AAC3D,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAA,OAAO,IAAK,CAAA,gBAAA,CAAiB,OAAQ,CAAA,gBAAA,CAAiB,QAAQ,CAAA;AAAA;AAGhE,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAA,OAAO,IAAK,CAAA,mBAAA,CAAoB,OAAQ,CAAA,gBAAA,CAAiB,QAAQ,CAAA;AAAA;AAGnE,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA;AAAA;AACrC,EAEA,YAAY,OAA4B,EAAA;AACtC,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAA,OAAO,IAAK,CAAA,gBAAA,CAAiB,OAAQ,CAAA,GAAA,CAAI,OAAO,CAAA;AAAA;AAGlD,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAA,OAAO,IAAK,CAAA,mBAAA,CAAoB,OAAQ,CAAA,GAAA,CAAI,OAAO,CAAA;AAAA;AAGrD,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA;AAAA;AACrC,EAEA,YAAY,OAAuC,EAAA;AACjD,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAA,OAAO,IAAK,CAAA,gBAAA,CAAiB,OAAQ,CAAA,MAAA,CAAO,OAAO,CAAA;AAAA;AAGrD,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAA,OAAO,IAAK,CAAA,mBAAA,CAAoB,OAAQ,CAAA,MAAA,CAAO,OAAO,CAAA;AAAA;AAGxD,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA;AAAA;AACrC,EAEA,YAAY,OAAuC,EAAA;AACjD,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAA,OAAO,IAAK,CAAA,gBAAA,CAAiB,OAAQ,CAAA,MAAA,CAAO,OAAO,CAAA;AAAA;AAGrD,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAA,OAAO,IAAK,CAAA,mBAAA,CAAoB,OAAQ,CAAA,MAAA,CAAO,OAAO,CAAA;AAAA;AAGxD,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA;AAAA;AACrC;AAAA;AAAA;AAAA,EAKA,WAAW,OAAgC,EAAA;AACzC,IAAM,MAAA,EAAE,SAAY,GAAA,OAAA;AAEpB,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAO,OAAA,IAAA,CAAK,gBAAiB,CAAA,GAAA,CAAI,OAAQ,CAAA;AAAA,QACvC,MAAQ,EAAA,MAAA;AAAA,QACR,IAAM,EAAA;AAAA,OACP,CAAA;AAAA;AAGH,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAO,OAAA,IAAA,CAAK,mBAAoB,CAAA,GAAA,CAAI,OAAQ,CAAA;AAAA,QAC1C,MAAQ,EAAA,MAAA;AAAA,QACR,IAAM,EAAA;AAAA,OACP,CAAA;AAAA;AAGH,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA;AAAA;AACrC,EAEA,YAAY,OAA4B,EAAA;AACtC,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAA,OAAO,IAAK,CAAA,gBAAA,CAAiB,OAAQ,CAAA,MAAA,CAAO,OAAO,CAAA;AAAA;AAGrD,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAA,OAAO,IAAK,CAAA,mBAAA,CAAoB,OAAQ,CAAA,MAAA,CAAO,OAAO,CAAA;AAAA;AAGxD,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA;AAAA;AACrC,EAEA,cAAc,OAAkD,EAAA;AAC9D,IAAA,MAAM,eAAkB,GAAA,OAAA,CAAQ,OAAQ,CAAA,MAAA,CAAO,OAAO,CAAA;AAEtD,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAO,OAAA,IAAA,CAAK,gBAAiB,CAAA,OAAA,CAAQ,aAAc,CAAA;AAAA,QACjD,IAAM,EAAA;AAAA,UACJ,OAAS,EAAA;AAAA;AACX,OACD,CAAA;AAAA;AAGH,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAO,OAAA,IAAA,CAAK,mBAAoB,CAAA,OAAA,CAAQ,aAAc,CAAA;AAAA,QACpD,IAAM,EAAA;AAAA,UACJ,OAAS,EAAA;AAAA;AACX,OACD,CAAA;AAAA;AAGH,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA;AAAA;AAEvC;;;;"}
|
|
1
|
+
{"version":3,"file":"ElasticSearchClientWrapper.cjs.js","sources":["../../src/engines/ElasticSearchClientWrapper.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 { Client as ElasticSearchClient } from '@elastic/elasticsearch';\nimport { Client as OpenSearchClient } from '@opensearch-project/opensearch';\nimport { Readable } from 'stream';\nimport {\n ElasticSearchClientOptions,\n isOpenSearchCompatible,\n} from './ElasticSearchClientOptions';\nimport { ElasticSearchCustomIndexTemplate } from './types';\n\n/**\n * @public\n */\nexport type ElasticSearchAliasAction =\n | {\n remove: { index: any; alias: any };\n add?: undefined;\n }\n | {\n add: { indices: any; alias: any; index?: undefined };\n remove?: undefined;\n }\n | {\n add: { index: any; alias: any; indices?: undefined };\n remove?: undefined;\n }\n | undefined;\n\n/**\n * @public\n */\nexport type ElasticSearchIndexAction = {\n index: {\n _index: string;\n [key: string]: any;\n };\n};\n\n/**\n * A wrapper class that exposes logical methods that are conditionally fired\n * against either a configured Elasticsearch client or a configured Opensearch\n * client.\n *\n * This is necessary because, despite its intention to be API-compatible, the\n * opensearch client does not support API key-based authentication. This is\n * also the sanest way to accomplish this while making typescript happy.\n *\n * In the future, if the differences between implementations become\n * unmaintainably divergent, we should split out the Opensearch and\n * Elasticsearch search engine implementations.\n *\n * @public\n */\nexport class ElasticSearchClientWrapper {\n private readonly elasticSearchClient: ElasticSearchClient | undefined;\n private readonly openSearchClient: OpenSearchClient | undefined;\n\n private constructor(options: {\n openSearchClient?: OpenSearchClient;\n elasticSearchClient?: ElasticSearchClient;\n }) {\n this.openSearchClient = options.openSearchClient;\n this.elasticSearchClient = options.elasticSearchClient;\n }\n\n static fromClientOptions(options: ElasticSearchClientOptions) {\n if (isOpenSearchCompatible(options)) {\n return new ElasticSearchClientWrapper({\n openSearchClient: new OpenSearchClient(options),\n });\n }\n\n return new ElasticSearchClientWrapper({\n elasticSearchClient: new ElasticSearchClient(options),\n });\n }\n\n search(options: { index: string | string[]; body: Object }) {\n const searchOptions = {\n ignore_unavailable: true,\n allow_no_indices: true,\n };\n\n if (this.openSearchClient) {\n return this.openSearchClient.search({\n ...options,\n ...searchOptions,\n });\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.search({\n ...options,\n ...searchOptions,\n });\n }\n\n throw new Error('No client defined');\n }\n\n bulk(bulkOptions: {\n datasource: Readable;\n onDocument: () => ElasticSearchIndexAction;\n refreshOnCompletion?: string | boolean;\n }) {\n if (this.openSearchClient) {\n return this.openSearchClient.helpers.bulk(bulkOptions);\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.helpers.bulk(bulkOptions);\n }\n\n throw new Error('No client defined');\n }\n\n putIndexTemplate(template: ElasticSearchCustomIndexTemplate) {\n if (this.openSearchClient) {\n return this.openSearchClient.indices.putIndexTemplate(template);\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.indices.putIndexTemplate(template);\n }\n\n throw new Error('No client defined');\n }\n\n listIndices(options: { index: string }) {\n if (this.openSearchClient) {\n return this.openSearchClient.indices.get(options);\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.indices.get(options);\n }\n\n throw new Error('No client defined');\n }\n\n indexExists(options: { index: string | string[] }) {\n if (this.openSearchClient) {\n return this.openSearchClient.indices.exists(options);\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.indices.exists(options);\n }\n\n throw new Error('No client defined');\n }\n\n deleteIndex(options: { index: string | string[] }) {\n if (this.openSearchClient) {\n return this.openSearchClient.indices.delete(options);\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.indices.delete(options);\n }\n\n throw new Error('No client defined');\n }\n\n /**\n * @deprecated unused by the ElasticSearch Engine, will be removed in the future\n */\n getAliases(options: { aliases: string[] }) {\n const { aliases } = options;\n\n if (this.openSearchClient) {\n return this.openSearchClient.cat.aliases({\n format: 'json',\n name: aliases,\n });\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.cat.aliases({\n format: 'json',\n name: aliases,\n });\n }\n\n throw new Error('No client defined');\n }\n\n createIndex(options: { index: string }) {\n if (this.openSearchClient) {\n return this.openSearchClient.indices.create(options);\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.indices.create(options);\n }\n\n throw new Error('No client defined');\n }\n\n updateAliases(options: { actions: ElasticSearchAliasAction[] }) {\n const filteredActions = options.actions.filter(Boolean);\n\n if (this.openSearchClient) {\n return this.openSearchClient.indices.updateAliases({\n body: {\n actions: filteredActions,\n },\n });\n }\n\n if (this.elasticSearchClient) {\n return this.elasticSearchClient.indices.updateAliases({\n body: {\n actions: filteredActions,\n },\n });\n }\n\n throw new Error('No client defined');\n }\n}\n"],"names":["isOpenSearchCompatible","OpenSearchClient","ElasticSearchClient"],"mappings":";;;;;;AAoEO,MAAM,0BAAA,CAA2B;AAAA,EACrB,mBAAA;AAAA,EACA,gBAAA;AAAA,EAET,YAAY,OAAA,EAGjB;AACD,IAAA,IAAA,CAAK,mBAAmB,OAAA,CAAQ,gBAAA;AAChC,IAAA,IAAA,CAAK,sBAAsB,OAAA,CAAQ,mBAAA;AAAA,EACrC;AAAA,EAEA,OAAO,kBAAkB,OAAA,EAAqC;AAC5D,IAAA,IAAIA,iDAAA,CAAuB,OAAO,CAAA,EAAG;AACnC,MAAA,OAAO,IAAI,0BAAA,CAA2B;AAAA,QACpC,gBAAA,EAAkB,IAAIC,iBAAA,CAAiB,OAAO;AAAA,OAC/C,CAAA;AAAA,IACH;AAEA,IAAA,OAAO,IAAI,0BAAA,CAA2B;AAAA,MACpC,mBAAA,EAAqB,IAAIC,oBAAA,CAAoB,OAAO;AAAA,KACrD,CAAA;AAAA,EACH;AAAA,EAEA,OAAO,OAAA,EAAqD;AAC1D,IAAA,MAAM,aAAA,GAAgB;AAAA,MACpB,kBAAA,EAAoB,IAAA;AAAA,MACpB,gBAAA,EAAkB;AAAA,KACpB;AAEA,IAAA,IAAI,KAAK,gBAAA,EAAkB;AACzB,MAAA,OAAO,IAAA,CAAK,iBAAiB,MAAA,CAAO;AAAA,QAClC,GAAG,OAAA;AAAA,QACH,GAAG;AAAA,OACJ,CAAA;AAAA,IACH;AAEA,IAAA,IAAI,KAAK,mBAAA,EAAqB;AAC5B,MAAA,OAAO,IAAA,CAAK,oBAAoB,MAAA,CAAO;AAAA,QACrC,GAAG,OAAA;AAAA,QACH,GAAG;AAAA,OACJ,CAAA;AAAA,IACH;AAEA,IAAA,MAAM,IAAI,MAAM,mBAAmB,CAAA;AAAA,EACrC;AAAA,EAEA,KAAK,WAAA,EAIF;AACD,IAAA,IAAI,KAAK,gBAAA,EAAkB;AACzB,MAAA,OAAO,IAAA,CAAK,gBAAA,CAAiB,OAAA,CAAQ,IAAA,CAAK,WAAW,CAAA;AAAA,IACvD;AAEA,IAAA,IAAI,KAAK,mBAAA,EAAqB;AAC5B,MAAA,OAAO,IAAA,CAAK,mBAAA,CAAoB,OAAA,CAAQ,IAAA,CAAK,WAAW,CAAA;AAAA,IAC1D;AAEA,IAAA,MAAM,IAAI,MAAM,mBAAmB,CAAA;AAAA,EACrC;AAAA,EAEA,iBAAiB,QAAA,EAA4C;AAC3D,IAAA,IAAI,KAAK,gBAAA,EAAkB;AACzB,MAAA,OAAO,IAAA,CAAK,gBAAA,CAAiB,OAAA,CAAQ,gBAAA,CAAiB,QAAQ,CAAA;AAAA,IAChE;AAEA,IAAA,IAAI,KAAK,mBAAA,EAAqB;AAC5B,MAAA,OAAO,IAAA,CAAK,mBAAA,CAAoB,OAAA,CAAQ,gBAAA,CAAiB,QAAQ,CAAA;AAAA,IACnE;AAEA,IAAA,MAAM,IAAI,MAAM,mBAAmB,CAAA;AAAA,EACrC;AAAA,EAEA,YAAY,OAAA,EAA4B;AACtC,IAAA,IAAI,KAAK,gBAAA,EAAkB;AACzB,MAAA,OAAO,IAAA,CAAK,gBAAA,CAAiB,OAAA,CAAQ,GAAA,CAAI,OAAO,CAAA;AAAA,IAClD;AAEA,IAAA,IAAI,KAAK,mBAAA,EAAqB;AAC5B,MAAA,OAAO,IAAA,CAAK,mBAAA,CAAoB,OAAA,CAAQ,GAAA,CAAI,OAAO,CAAA;AAAA,IACrD;AAEA,IAAA,MAAM,IAAI,MAAM,mBAAmB,CAAA;AAAA,EACrC;AAAA,EAEA,YAAY,OAAA,EAAuC;AACjD,IAAA,IAAI,KAAK,gBAAA,EAAkB;AACzB,MAAA,OAAO,IAAA,CAAK,gBAAA,CAAiB,OAAA,CAAQ,MAAA,CAAO,OAAO,CAAA;AAAA,IACrD;AAEA,IAAA,IAAI,KAAK,mBAAA,EAAqB;AAC5B,MAAA,OAAO,IAAA,CAAK,mBAAA,CAAoB,OAAA,CAAQ,MAAA,CAAO,OAAO,CAAA;AAAA,IACxD;AAEA,IAAA,MAAM,IAAI,MAAM,mBAAmB,CAAA;AAAA,EACrC;AAAA,EAEA,YAAY,OAAA,EAAuC;AACjD,IAAA,IAAI,KAAK,gBAAA,EAAkB;AACzB,MAAA,OAAO,IAAA,CAAK,gBAAA,CAAiB,OAAA,CAAQ,MAAA,CAAO,OAAO,CAAA;AAAA,IACrD;AAEA,IAAA,IAAI,KAAK,mBAAA,EAAqB;AAC5B,MAAA,OAAO,IAAA,CAAK,mBAAA,CAAoB,OAAA,CAAQ,MAAA,CAAO,OAAO,CAAA;AAAA,IACxD;AAEA,IAAA,MAAM,IAAI,MAAM,mBAAmB,CAAA;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA,EAKA,WAAW,OAAA,EAAgC;AACzC,IAAA,MAAM,EAAE,SAAQ,GAAI,OAAA;AAEpB,IAAA,IAAI,KAAK,gBAAA,EAAkB;AACzB,MAAA,OAAO,IAAA,CAAK,gBAAA,CAAiB,GAAA,CAAI,OAAA,CAAQ;AAAA,QACvC,MAAA,EAAQ,MAAA;AAAA,QACR,IAAA,EAAM;AAAA,OACP,CAAA;AAAA,IACH;AAEA,IAAA,IAAI,KAAK,mBAAA,EAAqB;AAC5B,MAAA,OAAO,IAAA,CAAK,mBAAA,CAAoB,GAAA,CAAI,OAAA,CAAQ;AAAA,QAC1C,MAAA,EAAQ,MAAA;AAAA,QACR,IAAA,EAAM;AAAA,OACP,CAAA;AAAA,IACH;AAEA,IAAA,MAAM,IAAI,MAAM,mBAAmB,CAAA;AAAA,EACrC;AAAA,EAEA,YAAY,OAAA,EAA4B;AACtC,IAAA,IAAI,KAAK,gBAAA,EAAkB;AACzB,MAAA,OAAO,IAAA,CAAK,gBAAA,CAAiB,OAAA,CAAQ,MAAA,CAAO,OAAO,CAAA;AAAA,IACrD;AAEA,IAAA,IAAI,KAAK,mBAAA,EAAqB;AAC5B,MAAA,OAAO,IAAA,CAAK,mBAAA,CAAoB,OAAA,CAAQ,MAAA,CAAO,OAAO,CAAA;AAAA,IACxD;AAEA,IAAA,MAAM,IAAI,MAAM,mBAAmB,CAAA;AAAA,EACrC;AAAA,EAEA,cAAc,OAAA,EAAkD;AAC9D,IAAA,MAAM,eAAA,GAAkB,OAAA,CAAQ,OAAA,CAAQ,MAAA,CAAO,OAAO,CAAA;AAEtD,IAAA,IAAI,KAAK,gBAAA,EAAkB;AACzB,MAAA,OAAO,IAAA,CAAK,gBAAA,CAAiB,OAAA,CAAQ,aAAA,CAAc;AAAA,QACjD,IAAA,EAAM;AAAA,UACJ,OAAA,EAAS;AAAA;AACX,OACD,CAAA;AAAA,IACH;AAEA,IAAA,IAAI,KAAK,mBAAA,EAAqB;AAC5B,MAAA,OAAO,IAAA,CAAK,mBAAA,CAAoB,OAAA,CAAQ,aAAA,CAAc;AAAA,QACpD,IAAA,EAAM;AAAA,UACJ,OAAA,EAAS;AAAA;AACX,OACD,CAAA;AAAA,IACH;AAEA,IAAA,MAAM,IAAI,MAAM,mBAAmB,CAAA;AAAA,EACrC;AACF;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ElasticSearchSearchEngine.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 IndexableDocument,\n IndexableResult,\n IndexableResultSet,\n SearchQuery,\n} from '@backstage/plugin-search-common';\nimport { SearchEngine } from '@backstage/plugin-search-backend-node';\nimport { isEmpty, isNumber, isNaN as nan } from 'lodash';\n\nimport { AwsSigv4Signer } from '@opensearch-project/opensearch/aws';\nimport { RequestSigner } from 'aws4';\nimport { Config } from '@backstage/config';\nimport {\n ElasticSearchClientOptions,\n OpenSearchElasticSearchClientOptions,\n} from './ElasticSearchClientOptions';\nimport { ElasticSearchClientWrapper } from './ElasticSearchClientWrapper';\nimport { ElasticSearchCustomIndexTemplate } from './types';\nimport { ElasticSearchSearchEngineIndexer } from './ElasticSearchSearchEngineIndexer';\nimport { MissingIndexError } from '@backstage/plugin-search-backend-node';\nimport esb from 'elastic-builder';\nimport { v4 as uuid } from 'uuid';\nimport {\n AwsCredentialProvider,\n DefaultAwsCredentialsManager,\n} from '@backstage/integration-aws-node';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\nexport type { ElasticSearchClientOptions };\n\n/**\n * Search query that the elasticsearch engine understands.\n * @public\n */\nexport type ElasticSearchConcreteQuery = {\n documentTypes?: string[];\n elasticSearchQuery: Object;\n pageSize: number;\n};\n\n/**\n * Options available for the Elasticsearch specific query translator.\n * @public\n */\nexport type ElasticSearchQueryTranslatorOptions = {\n highlightOptions?: ElasticSearchHighlightConfig;\n queryOptions?: ElasticSearchQueryConfig;\n};\n\n/**\n * Elasticsearch specific query translator.\n * @public\n */\nexport type ElasticSearchQueryTranslator = (\n query: SearchQuery,\n options?: ElasticSearchQueryTranslatorOptions,\n) => ElasticSearchConcreteQuery;\n\n/**\n * Options for instantiate ElasticSearchSearchEngine\n * @public\n */\nexport type ElasticSearchOptions = {\n logger: LoggerService;\n config: Config;\n aliasPostfix?: string;\n indexPrefix?: string;\n translator?: ElasticSearchQueryTranslator;\n};\n\n/**\n * @public\n */\nexport type ElasticSearchHighlightOptions = {\n fragmentDelimiter?: string;\n fragmentSize?: number;\n numFragments?: number;\n};\n\n/**\n * @public\n */\nexport type ElasticSearchQueryConfig = {\n fuzziness?: string | number;\n prefixLength?: number;\n};\n\n/**\n * @public\n */\nexport type ElasticSearchHighlightConfig = {\n fragmentDelimiter: string;\n fragmentSize: number;\n numFragments: number;\n preTag: string;\n postTag: string;\n};\n\ntype ElasticSearchResult = {\n _index: string;\n _type: string;\n _score: number;\n _source: IndexableDocument;\n highlight?: {\n [field: string]: string[];\n };\n};\n\nfunction isBlank(str: string) {\n return (isEmpty(str) && !isNumber(str)) || nan(str);\n}\n\nconst DEFAULT_INDEXER_BATCH_SIZE = 1000;\n\n/**\n * @public\n */\nexport class ElasticSearchSearchEngine implements SearchEngine {\n private readonly elasticSearchClientWrapper: ElasticSearchClientWrapper;\n private readonly highlightOptions: ElasticSearchHighlightConfig;\n private readonly queryOptions?: ElasticSearchQueryConfig;\n\n constructor(\n private readonly elasticSearchClientOptions: ElasticSearchClientOptions,\n private readonly aliasPostfix: string,\n private readonly indexPrefix: string,\n private readonly logger: LoggerService,\n private readonly batchSize: number,\n highlightOptions?: ElasticSearchHighlightOptions,\n queryOptions?: ElasticSearchQueryConfig,\n ) {\n this.elasticSearchClientWrapper =\n ElasticSearchClientWrapper.fromClientOptions(elasticSearchClientOptions);\n const uuidTag = uuid();\n this.highlightOptions = {\n preTag: `<${uuidTag}>`,\n postTag: `</${uuidTag}>`,\n fragmentSize: 1000,\n numFragments: 1,\n fragmentDelimiter: ' ... ',\n ...highlightOptions,\n };\n this.queryOptions = queryOptions;\n }\n\n static async fromConfig(options: ElasticSearchOptions) {\n const {\n logger,\n config,\n aliasPostfix = `search`,\n indexPrefix = ``,\n translator,\n } = options;\n const credentialProvider = DefaultAwsCredentialsManager.fromConfig(config);\n const clientOptions = await this.createElasticSearchClientOptions(\n await credentialProvider?.getCredentialProvider(),\n config.getConfig('search.elasticsearch'),\n );\n if (clientOptions.provider === 'elastic') {\n logger.info('Initializing Elastic.co ElasticSearch search engine.');\n } else if (clientOptions.provider === 'aws') {\n logger.info('Initializing AWS OpenSearch search engine.');\n } else if (clientOptions.provider === 'opensearch') {\n logger.info('Initializing OpenSearch search engine.');\n } else {\n logger.info('Initializing ElasticSearch search engine.');\n }\n\n const engine = new ElasticSearchSearchEngine(\n clientOptions,\n aliasPostfix,\n indexPrefix,\n logger,\n config.getOptionalNumber('search.elasticsearch.batchSize') ??\n DEFAULT_INDEXER_BATCH_SIZE,\n config.getOptional<ElasticSearchHighlightOptions>(\n 'search.elasticsearch.highlightOptions',\n ),\n config.getOptional<ElasticSearchQueryConfig>(\n 'search.elasticsearch.queryOptions',\n ),\n );\n\n for (const indexTemplate of this.readIndexTemplateConfig(\n config.getConfig('search.elasticsearch'),\n )) {\n await engine.setIndexTemplate(indexTemplate);\n }\n\n if (translator) {\n await engine.setTranslator(translator);\n }\n\n return engine;\n }\n\n /**\n * Create a custom search client from the derived search client configuration.\n * This need not be the same client that the engine uses internally.\n *\n * @example Instantiate an instance of an Elasticsearch client.\n *\n * ```ts\n * import { isOpenSearchCompatible } from '@backstage/plugin-search-backend-module-elasticsearch';\n * import { Client } from '@elastic/elasticsearch';\n *\n * const client = searchEngine.newClient<Client>(options => {\n * // This type guard ensures options are compatible with either OpenSearch\n * // or Elasticsearch client constructors.\n * if (!isOpenSearchCompatible(options)) {\n * return new Client(options);\n * }\n * throw new Error('Incompatible options provided');\n * });\n * ```\n */\n newClient<T>(create: (options: ElasticSearchClientOptions) => T): T {\n return create(this.elasticSearchClientOptions);\n }\n\n protected translator(\n query: SearchQuery,\n options?: ElasticSearchQueryTranslatorOptions,\n ): ElasticSearchConcreteQuery {\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 // Use exact matching for string datatype fields\n const keyword = typeof value === 'string' ? `${key}.keyword` : key;\n return esb.matchQuery(keyword, 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('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\n const esbQueries = [];\n // https://regex101.com/r/Lr0MqS/1\n const phraseTerms = term.match(/\"[^\"]*\"/g);\n\n if (isBlank(term)) {\n const esbQuery = esb.matchAllQuery();\n esbQueries.push(esbQuery);\n } else if (phraseTerms && phraseTerms.length > 0) {\n let restTerm = term;\n for (const phraseTerm of phraseTerms) {\n restTerm = restTerm.replace(phraseTerm, '');\n const esbPhraseQuery = esb\n .multiMatchQuery(['*'], phraseTerm.replace(/\"/g, ''))\n .type('phrase');\n esbQueries.push(esbPhraseQuery);\n }\n if (restTerm?.length > 0) {\n const esbRestQuery = esb\n .multiMatchQuery(['*'], restTerm.trim())\n .fuzziness(options?.queryOptions?.fuzziness ?? 'auto')\n .prefixLength(options?.queryOptions?.prefixLength ?? 0);\n esbQueries.push(esbRestQuery);\n }\n } else {\n const esbQuery = esb\n .multiMatchQuery(['*'], term)\n .fuzziness(options?.queryOptions?.fuzziness ?? 'auto')\n .prefixLength(options?.queryOptions?.prefixLength ?? 0);\n esbQueries.push(esbQuery);\n }\n\n const pageSize = query.pageLimit || 25;\n const { page } = decodePageCursor(pageCursor);\n\n let esbRequestBodySearch = esb\n .requestBodySearch()\n .query(esb.boolQuery().filter(filter).should(esbQueries))\n .from(page * pageSize)\n .size(pageSize);\n\n if (options?.highlightOptions) {\n esbRequestBodySearch = esbRequestBodySearch.highlight(\n esb\n .highlight('*')\n .numberOfFragments(options.highlightOptions.numFragments as number)\n .fragmentSize(options.highlightOptions.fragmentSize as number)\n .preTags(options.highlightOptions.preTag)\n .postTags(options.highlightOptions.postTag),\n );\n }\n\n return {\n elasticSearchQuery: esbRequestBodySearch.toJSON(),\n documentTypes: types,\n pageSize,\n };\n }\n\n setTranslator(translator: ElasticSearchQueryTranslator) {\n this.translator = translator;\n }\n\n async setIndexTemplate(template: ElasticSearchCustomIndexTemplate) {\n try {\n await this.elasticSearchClientWrapper.putIndexTemplate(template);\n this.logger.info('Custom index template set');\n } catch (error) {\n this.logger.error(`Unable to set custom index template: ${error}`);\n }\n }\n\n async getIndexer(type: string) {\n const alias = this.constructSearchAlias(type);\n const indexerLogger = this.logger.child({ documentType: type });\n\n const indexer = new ElasticSearchSearchEngineIndexer({\n type,\n indexPrefix: this.indexPrefix,\n indexSeparator: this.indexSeparator,\n alias,\n elasticSearchClientWrapper: this.elasticSearchClientWrapper,\n logger: indexerLogger,\n batchSize: this.batchSize,\n skipRefresh:\n (\n this\n .elasticSearchClientOptions as OpenSearchElasticSearchClientOptions\n )?.service === 'aoss',\n });\n\n // Attempt cleanup upon failure.\n // todo(@backstage/search-maintainers): Consider introducing a more\n // formal mechanism for handling such errors in BatchSearchEngineIndexer and\n // replacing this handler with it. See: #17291\n indexer.on('error', async e => {\n indexerLogger.error(`Failed to index documents for type ${type}`, e);\n let cleanupError: Error | undefined;\n\n // In some cases, a failure may have occurred before the indexer was able\n // to complete initialization. Try up to 5 times to remove the dangling\n // index.\n await new Promise<void>(async done => {\n const maxAttempts = 5;\n let attempts = 0;\n\n while (attempts < maxAttempts) {\n try {\n await this.elasticSearchClientWrapper.deleteIndex({\n index: indexer.indexName,\n });\n\n attempts = maxAttempts;\n cleanupError = undefined;\n done();\n } catch (err) {\n cleanupError = err;\n }\n\n // Wait 1 second between retries.\n await new Promise(okay => setTimeout(okay, 1000));\n\n attempts++;\n }\n done();\n });\n\n if (cleanupError) {\n indexerLogger.error(\n `Unable to clean up elastic index ${indexer.indexName}: ${cleanupError}`,\n );\n } else {\n indexerLogger.info(\n `Removed partial, failed index ${indexer.indexName}`,\n );\n }\n });\n\n return indexer;\n }\n\n async query(query: SearchQuery): Promise<IndexableResultSet> {\n const { elasticSearchQuery, documentTypes, pageSize } = this.translator(\n query,\n {\n highlightOptions: this.highlightOptions,\n queryOptions: this.queryOptions,\n },\n );\n const queryIndices = documentTypes\n ? documentTypes.map(it => this.constructSearchAlias(it))\n : this.constructSearchAlias('*');\n try {\n const result = await this.elasticSearchClientWrapper.search({\n index: queryIndices,\n body: elasticSearchQuery,\n });\n const { page } = decodePageCursor(query.pageCursor);\n const hasNextPage = result.body.hits.total.value > (page + 1) * 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(\n (d: ElasticSearchResult, index: number) => {\n const resultItem: IndexableResult = {\n type: this.getTypeFromIndex(d._index),\n document: d._source,\n rank: pageSize * page + index + 1,\n };\n\n if (d.highlight) {\n resultItem.highlight = {\n preTag: this.highlightOptions.preTag as string,\n postTag: this.highlightOptions.postTag as string,\n fields: Object.fromEntries(\n Object.entries(d.highlight).map(([field, fragments]) => [\n field,\n fragments.join(this.highlightOptions.fragmentDelimiter),\n ]),\n ),\n };\n }\n\n return resultItem;\n },\n ),\n nextPageCursor,\n previousPageCursor,\n numberOfResults: result.body.hits.total.value,\n };\n } catch (error) {\n if (error.meta?.body?.error?.type === 'index_not_found_exception') {\n throw new MissingIndexError(\n `Missing index for ${queryIndices}. This means there are no documents to search through.`,\n error,\n );\n }\n this.logger.error(\n `Failed to query documents for indices ${queryIndices}`,\n error,\n );\n return Promise.reject({ results: [] });\n }\n }\n\n private readonly indexSeparator = '-index__';\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 private static async createElasticSearchClientOptions(\n credentialProvider: AwsCredentialProvider,\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 requestSigner = new RequestSigner(config.getString('node'));\n const service =\n config.getOptionalString('service') ?? requestSigner.service;\n if (service !== 'es' && service !== 'aoss')\n throw new Error(`Unrecognized service type: ${service}`);\n return {\n provider: 'aws',\n node: config.getString('node'),\n region: config.getOptionalString('region'),\n service,\n ...(sslConfig\n ? {\n ssl: {\n rejectUnauthorized:\n sslConfig?.getOptionalBoolean('rejectUnauthorized'),\n },\n }\n : {}),\n ...AwsSigv4Signer({\n region: config.getOptionalString('region') ?? requestSigner.region, // for backwards compatibility\n service: service,\n getCredentials: async () =>\n await credentialProvider.sdkCredentialProvider(),\n }),\n };\n }\n if (config.getOptionalString('provider') === 'opensearch') {\n const authConfig = config.getConfig('auth');\n return {\n provider: 'opensearch',\n node: config.getString('node'),\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 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\n private static readIndexTemplateConfig(\n config: Config,\n ): ElasticSearchCustomIndexTemplate[] {\n return (\n config.getOptionalConfigArray('indexTemplates')?.map(templateConfig => {\n const bodyConfig = templateConfig.getConfig('body');\n return {\n name: templateConfig.getString('name'),\n body: {\n index_patterns: bodyConfig.getStringArray('index_patterns'),\n composed_of: bodyConfig.getOptionalStringArray('composed_of'),\n template: bodyConfig.getOptionalConfig('template')?.get(),\n },\n };\n }) ?? []\n );\n }\n}\n\n/**\n * @public\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","ElasticSearchClientWrapper","uuid","DefaultAwsCredentialsManager","esb","ElasticSearchSearchEngineIndexer","MissingIndexError","authConfig","RequestSigner","AwsSigv4Signer"],"mappings":";;;;;;;;;;;;;;;;AA4HA,SAAS,QAAQ,GAAa,EAAA;AAC5B,EAAQ,OAAAA,cAAA,CAAQ,GAAG,CAAK,IAAA,CAACC,gBAAS,GAAG,CAAA,IAAMC,aAAI,GAAG,CAAA;AACpD;AAEA,MAAM,0BAA6B,GAAA,GAAA;AAK5B,MAAM,yBAAkD,CAAA;AAAA,EAK7D,YACmB,0BACA,EAAA,YAAA,EACA,aACA,MACA,EAAA,SAAA,EACjB,kBACA,YACA,EAAA;AAPiB,IAAA,IAAA,CAAA,0BAAA,GAAA,0BAAA;AACA,IAAA,IAAA,CAAA,YAAA,GAAA,YAAA;AACA,IAAA,IAAA,CAAA,WAAA,GAAA,WAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AAIjB,IAAK,IAAA,CAAA,0BAAA,GACHC,qDAA2B,CAAA,iBAAA,CAAkB,0BAA0B,CAAA;AACzE,IAAA,MAAM,UAAUC,OAAK,EAAA;AACrB,IAAA,IAAA,CAAK,gBAAmB,GAAA;AAAA,MACtB,MAAA,EAAQ,IAAI,OAAO,CAAA,CAAA,CAAA;AAAA,MACnB,OAAA,EAAS,KAAK,OAAO,CAAA,CAAA,CAAA;AAAA,MACrB,YAAc,EAAA,GAAA;AAAA,MACd,YAAc,EAAA,CAAA;AAAA,MACd,iBAAmB,EAAA,OAAA;AAAA,MACnB,GAAG;AAAA,KACL;AACA,IAAA,IAAA,CAAK,YAAe,GAAA,YAAA;AAAA;AACtB,EAzBiB,0BAAA;AAAA,EACA,gBAAA;AAAA,EACA,YAAA;AAAA,EAyBjB,aAAa,WAAW,OAA+B,EAAA;AACrD,IAAM,MAAA;AAAA,MACJ,MAAA;AAAA,MACA,MAAA;AAAA,MACA,YAAe,GAAA,CAAA,MAAA,CAAA;AAAA,MACf,WAAc,GAAA,CAAA,CAAA;AAAA,MACd;AAAA,KACE,GAAA,OAAA;AACJ,IAAM,MAAA,kBAAA,GAAqBC,+CAA6B,CAAA,UAAA,CAAW,MAAM,CAAA;AACzE,IAAM,MAAA,aAAA,GAAgB,MAAM,IAAK,CAAA,gCAAA;AAAA,MAC/B,MAAM,oBAAoB,qBAAsB,EAAA;AAAA,MAChD,MAAA,CAAO,UAAU,sBAAsB;AAAA,KACzC;AACA,IAAI,IAAA,aAAA,CAAc,aAAa,SAAW,EAAA;AACxC,MAAA,MAAA,CAAO,KAAK,sDAAsD,CAAA;AAAA,KACpE,MAAA,IAAW,aAAc,CAAA,QAAA,KAAa,KAAO,EAAA;AAC3C,MAAA,MAAA,CAAO,KAAK,4CAA4C,CAAA;AAAA,KAC1D,MAAA,IAAW,aAAc,CAAA,QAAA,KAAa,YAAc,EAAA;AAClD,MAAA,MAAA,CAAO,KAAK,wCAAwC,CAAA;AAAA,KAC/C,MAAA;AACL,MAAA,MAAA,CAAO,KAAK,2CAA2C,CAAA;AAAA;AAGzD,IAAA,MAAM,SAAS,IAAI,yBAAA;AAAA,MACjB,aAAA;AAAA,MACA,YAAA;AAAA,MACA,WAAA;AAAA,MACA,MAAA;AAAA,MACA,MAAA,CAAO,iBAAkB,CAAA,gCAAgC,CACvD,IAAA,0BAAA;AAAA,MACF,MAAO,CAAA,WAAA;AAAA,QACL;AAAA,OACF;AAAA,MACA,MAAO,CAAA,WAAA;AAAA,QACL;AAAA;AACF,KACF;AAEA,IAAA,KAAA,MAAW,iBAAiB,IAAK,CAAA,uBAAA;AAAA,MAC/B,MAAA,CAAO,UAAU,sBAAsB;AAAA,KACtC,EAAA;AACD,MAAM,MAAA,MAAA,CAAO,iBAAiB,aAAa,CAAA;AAAA;AAG7C,IAAA,IAAI,UAAY,EAAA;AACd,MAAM,MAAA,MAAA,CAAO,cAAc,UAAU,CAAA;AAAA;AAGvC,IAAO,OAAA,MAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,UAAa,MAAuD,EAAA;AAClE,IAAO,OAAA,MAAA,CAAO,KAAK,0BAA0B,CAAA;AAAA;AAC/C,EAEU,UAAA,CACR,OACA,OAC4B,EAAA;AAC5B,IAAA,MAAM,EAAE,IAAM,EAAA,OAAA,GAAU,EAAI,EAAA,KAAA,EAAO,YAAe,GAAA,KAAA;AAElD,IAAM,MAAA,MAAA,GAAS,OAAO,OAAQ,CAAA,OAAO,EAClC,MAAO,CAAA,CAAC,CAAC,CAAG,EAAA,KAAK,MAAM,OAAQ,CAAA,KAAK,CAAC,CACrC,CAAA,GAAA,CAAI,CAAC,CAAC,GAAA,EAAK,KAAK,CAAiC,KAAA;AAChD,MAAI,IAAA,CAAC,UAAU,QAAU,EAAA,SAAS,EAAE,QAAS,CAAA,OAAO,KAAK,CAAG,EAAA;AAE1D,QAAA,MAAM,UAAU,OAAO,KAAA,KAAU,QAAW,GAAA,CAAA,EAAG,GAAG,CAAa,QAAA,CAAA,GAAA,GAAA;AAC/D,QAAA,OAAOC,oBAAI,CAAA,UAAA,CAAW,OAAS,EAAA,KAAA,CAAM,UAAU,CAAA;AAAA;AAEjD,MAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,KAAK,CAAG,EAAA;AACxB,QAAA,OAAOA,oBACJ,CAAA,SAAA,EACA,CAAA,MAAA,CAAO,MAAM,GAAI,CAAA,CAAA,EAAA,KAAMA,oBAAI,CAAA,UAAA,CAAW,GAAK,EAAA,EAAA,CAAG,QAAS,EAAC,CAAC,CAAC,CAAA;AAAA;AAE/D,MAAK,IAAA,CAAA,MAAA,CAAO,MAAM,2CAA6C,EAAA;AAAA,QAC7D,GAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAA,MAAM,IAAI,KAAA;AAAA,QACR;AAAA,OACF;AAAA,KACD,CAAA;AAEH,IAAA,MAAM,aAAa,EAAC;AAEpB,IAAM,MAAA,WAAA,GAAc,IAAK,CAAA,KAAA,CAAM,UAAU,CAAA;AAEzC,IAAI,IAAA,OAAA,CAAQ,IAAI,CAAG,EAAA;AACjB,MAAM,MAAA,QAAA,GAAWA,qBAAI,aAAc,EAAA;AACnC,MAAA,UAAA,CAAW,KAAK,QAAQ,CAAA;AAAA,KACf,MAAA,IAAA,WAAA,IAAe,WAAY,CAAA,MAAA,GAAS,CAAG,EAAA;AAChD,MAAA,IAAI,QAAW,GAAA,IAAA;AACf,MAAA,KAAA,MAAW,cAAc,WAAa,EAAA;AACpC,QAAW,QAAA,GAAA,QAAA,CAAS,OAAQ,CAAA,UAAA,EAAY,EAAE,CAAA;AAC1C,QAAA,MAAM,cAAiB,GAAAA,oBAAA,CACpB,eAAgB,CAAA,CAAC,GAAG,CAAA,EAAG,UAAW,CAAA,OAAA,CAAQ,IAAM,EAAA,EAAE,CAAC,CAAA,CACnD,KAAK,QAAQ,CAAA;AAChB,QAAA,UAAA,CAAW,KAAK,cAAc,CAAA;AAAA;AAEhC,MAAI,IAAA,QAAA,EAAU,SAAS,CAAG,EAAA;AACxB,QAAM,MAAA,YAAA,GAAeA,qBAClB,eAAgB,CAAA,CAAC,GAAG,CAAG,EAAA,QAAA,CAAS,MAAM,CAAA,CACtC,UAAU,OAAS,EAAA,YAAA,EAAc,aAAa,MAAM,CAAA,CACpD,aAAa,OAAS,EAAA,YAAA,EAAc,gBAAgB,CAAC,CAAA;AACxD,QAAA,UAAA,CAAW,KAAK,YAAY,CAAA;AAAA;AAC9B,KACK,MAAA;AACL,MAAA,MAAM,WAAWA,oBACd,CAAA,eAAA,CAAgB,CAAC,GAAG,CAAA,EAAG,IAAI,CAC3B,CAAA,SAAA,CAAU,OAAS,EAAA,YAAA,EAAc,aAAa,MAAM,CAAA,CACpD,aAAa,OAAS,EAAA,YAAA,EAAc,gBAAgB,CAAC,CAAA;AACxD,MAAA,UAAA,CAAW,KAAK,QAAQ,CAAA;AAAA;AAG1B,IAAM,MAAA,QAAA,GAAW,MAAM,SAAa,IAAA,EAAA;AACpC,IAAA,MAAM,EAAE,IAAA,EAAS,GAAA,gBAAA,CAAiB,UAAU,CAAA;AAE5C,IAAI,IAAA,oBAAA,GAAuBA,qBACxB,iBAAkB,EAAA,CAClB,MAAMA,oBAAI,CAAA,SAAA,GAAY,MAAO,CAAA,MAAM,EAAE,MAAO,CAAA,UAAU,CAAC,CACvD,CAAA,IAAA,CAAK,OAAO,QAAQ,CAAA,CACpB,KAAK,QAAQ,CAAA;AAEhB,IAAA,IAAI,SAAS,gBAAkB,EAAA;AAC7B,MAAA,oBAAA,GAAuB,oBAAqB,CAAA,SAAA;AAAA,QAC1CA,oBAAA,CACG,UAAU,GAAG,CAAA,CACb,kBAAkB,OAAQ,CAAA,gBAAA,CAAiB,YAAsB,CAAA,CACjE,YAAa,CAAA,OAAA,CAAQ,iBAAiB,YAAsB,CAAA,CAC5D,QAAQ,OAAQ,CAAA,gBAAA,CAAiB,MAAM,CACvC,CAAA,QAAA,CAAS,OAAQ,CAAA,gBAAA,CAAiB,OAAO;AAAA,OAC9C;AAAA;AAGF,IAAO,OAAA;AAAA,MACL,kBAAA,EAAoB,qBAAqB,MAAO,EAAA;AAAA,MAChD,aAAe,EAAA,KAAA;AAAA,MACf;AAAA,KACF;AAAA;AACF,EAEA,cAAc,UAA0C,EAAA;AACtD,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA;AAAA;AACpB,EAEA,MAAM,iBAAiB,QAA4C,EAAA;AACjE,IAAI,IAAA;AACF,MAAM,MAAA,IAAA,CAAK,0BAA2B,CAAA,gBAAA,CAAiB,QAAQ,CAAA;AAC/D,MAAK,IAAA,CAAA,MAAA,CAAO,KAAK,2BAA2B,CAAA;AAAA,aACrC,KAAO,EAAA;AACd,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAwC,qCAAA,EAAA,KAAK,CAAE,CAAA,CAAA;AAAA;AACnE;AACF,EAEA,MAAM,WAAW,IAAc,EAAA;AAC7B,IAAM,MAAA,KAAA,GAAQ,IAAK,CAAA,oBAAA,CAAqB,IAAI,CAAA;AAC5C,IAAA,MAAM,gBAAgB,IAAK,CAAA,MAAA,CAAO,MAAM,EAAE,YAAA,EAAc,MAAM,CAAA;AAE9D,IAAM,MAAA,OAAA,GAAU,IAAIC,iEAAiC,CAAA;AAAA,MACnD,IAAA;AAAA,MACA,aAAa,IAAK,CAAA,WAAA;AAAA,MAClB,gBAAgB,IAAK,CAAA,cAAA;AAAA,MACrB,KAAA;AAAA,MACA,4BAA4B,IAAK,CAAA,0BAAA;AAAA,MACjC,MAAQ,EAAA,aAAA;AAAA,MACR,WAAW,IAAK,CAAA,SAAA;AAAA,MAChB,WAAA,EAEI,IACG,CAAA,0BAAA,EACF,OAAY,KAAA;AAAA,KAClB,CAAA;AAMD,IAAQ,OAAA,CAAA,EAAA,CAAG,OAAS,EAAA,OAAM,CAAK,KAAA;AAC7B,MAAA,aAAA,CAAc,KAAM,CAAA,CAAA,mCAAA,EAAsC,IAAI,CAAA,CAAA,EAAI,CAAC,CAAA;AACnE,MAAI,IAAA,YAAA;AAKJ,MAAM,MAAA,IAAI,OAAc,CAAA,OAAM,IAAQ,KAAA;AACpC,QAAA,MAAM,WAAc,GAAA,CAAA;AACpB,QAAA,IAAI,QAAW,GAAA,CAAA;AAEf,QAAA,OAAO,WAAW,WAAa,EAAA;AAC7B,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,2BAA2B,WAAY,CAAA;AAAA,cAChD,OAAO,OAAQ,CAAA;AAAA,aAChB,CAAA;AAED,YAAW,QAAA,GAAA,WAAA;AACX,YAAe,YAAA,GAAA,KAAA,CAAA;AACf,YAAK,IAAA,EAAA;AAAA,mBACE,GAAK,EAAA;AACZ,YAAe,YAAA,GAAA,GAAA;AAAA;AAIjB,UAAA,MAAM,IAAI,OAAQ,CAAA,CAAA,IAAA,KAAQ,UAAW,CAAA,IAAA,EAAM,GAAI,CAAC,CAAA;AAEhD,UAAA,QAAA,EAAA;AAAA;AAEF,QAAK,IAAA,EAAA;AAAA,OACN,CAAA;AAED,MAAA,IAAI,YAAc,EAAA;AAChB,QAAc,aAAA,CAAA,KAAA;AAAA,UACZ,CAAoC,iCAAA,EAAA,OAAA,CAAQ,SAAS,CAAA,EAAA,EAAK,YAAY,CAAA;AAAA,SACxE;AAAA,OACK,MAAA;AACL,QAAc,aAAA,CAAA,IAAA;AAAA,UACZ,CAAA,8BAAA,EAAiC,QAAQ,SAAS,CAAA;AAAA,SACpD;AAAA;AACF,KACD,CAAA;AAED,IAAO,OAAA,OAAA;AAAA;AACT,EAEA,MAAM,MAAM,KAAiD,EAAA;AAC3D,IAAA,MAAM,EAAE,kBAAA,EAAoB,aAAe,EAAA,QAAA,KAAa,IAAK,CAAA,UAAA;AAAA,MAC3D,KAAA;AAAA,MACA;AAAA,QACE,kBAAkB,IAAK,CAAA,gBAAA;AAAA,QACvB,cAAc,IAAK,CAAA;AAAA;AACrB,KACF;AACA,IAAA,MAAM,YAAe,GAAA,aAAA,GACjB,aAAc,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA,IAAA,CAAK,oBAAqB,CAAA,EAAE,CAAC,CAAA,GACrD,IAAK,CAAA,oBAAA,CAAqB,GAAG,CAAA;AACjC,IAAI,IAAA;AACF,MAAA,MAAM,MAAS,GAAA,MAAM,IAAK,CAAA,0BAAA,CAA2B,MAAO,CAAA;AAAA,QAC1D,KAAO,EAAA,YAAA;AAAA,QACP,IAAM,EAAA;AAAA,OACP,CAAA;AACD,MAAA,MAAM,EAAE,IAAA,EAAS,GAAA,gBAAA,CAAiB,MAAM,UAAU,CAAA;AAClD,MAAA,MAAM,cAAc,MAAO,CAAA,IAAA,CAAK,KAAK,KAAM,CAAA,KAAA,GAAA,CAAS,OAAO,CAAK,IAAA,QAAA;AAChE,MAAA,MAAM,kBAAkB,IAAO,GAAA,CAAA;AAC/B,MAAM,MAAA,cAAA,GAAiB,cACnB,gBAAiB,CAAA,EAAE,MAAM,IAAO,GAAA,CAAA,EAAG,CACnC,GAAA,KAAA,CAAA;AACJ,MAAM,MAAA,kBAAA,GAAqB,kBACvB,gBAAiB,CAAA,EAAE,MAAM,IAAO,GAAA,CAAA,EAAG,CACnC,GAAA,KAAA,CAAA;AAEJ,MAAO,OAAA;AAAA,QACL,OAAS,EAAA,MAAA,CAAO,IAAK,CAAA,IAAA,CAAK,IAAK,CAAA,GAAA;AAAA,UAC7B,CAAC,GAAwB,KAAkB,KAAA;AACzC,YAAA,MAAM,UAA8B,GAAA;AAAA,cAClC,IAAM,EAAA,IAAA,CAAK,gBAAiB,CAAA,CAAA,CAAE,MAAM,CAAA;AAAA,cACpC,UAAU,CAAE,CAAA,OAAA;AAAA,cACZ,IAAA,EAAM,QAAW,GAAA,IAAA,GAAO,KAAQ,GAAA;AAAA,aAClC;AAEA,YAAA,IAAI,EAAE,SAAW,EAAA;AACf,cAAA,UAAA,CAAW,SAAY,GAAA;AAAA,gBACrB,MAAA,EAAQ,KAAK,gBAAiB,CAAA,MAAA;AAAA,gBAC9B,OAAA,EAAS,KAAK,gBAAiB,CAAA,OAAA;AAAA,gBAC/B,QAAQ,MAAO,CAAA,WAAA;AAAA,kBACb,MAAA,CAAO,OAAQ,CAAA,CAAA,CAAE,SAAS,CAAA,CAAE,IAAI,CAAC,CAAC,KAAO,EAAA,SAAS,CAAM,KAAA;AAAA,oBACtD,KAAA;AAAA,oBACA,SAAU,CAAA,IAAA,CAAK,IAAK,CAAA,gBAAA,CAAiB,iBAAiB;AAAA,mBACvD;AAAA;AACH,eACF;AAAA;AAGF,YAAO,OAAA,UAAA;AAAA;AACT,SACF;AAAA,QACA,cAAA;AAAA,QACA,kBAAA;AAAA,QACA,eAAiB,EAAA,MAAA,CAAO,IAAK,CAAA,IAAA,CAAK,KAAM,CAAA;AAAA,OAC1C;AAAA,aACO,KAAO,EAAA;AACd,MAAA,IAAI,KAAM,CAAA,IAAA,EAAM,IAAM,EAAA,KAAA,EAAO,SAAS,2BAA6B,EAAA;AACjE,QAAA,MAAM,IAAIC,yCAAA;AAAA,UACR,qBAAqB,YAAY,CAAA,sDAAA,CAAA;AAAA,UACjC;AAAA,SACF;AAAA;AAEF,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,yCAAyC,YAAY,CAAA,CAAA;AAAA,QACrD;AAAA,OACF;AACA,MAAA,OAAO,QAAQ,MAAO,CAAA,EAAE,OAAS,EAAA,IAAI,CAAA;AAAA;AACvC;AACF,EAEiB,cAAiB,GAAA,UAAA;AAAA,EAE1B,iBAAiB,KAAe,EAAA;AACtC,IAAO,OAAA,KAAA,CACJ,SAAU,CAAA,IAAA,CAAK,WAAY,CAAA,MAAM,EACjC,KAAM,CAAA,IAAA,CAAK,cAAc,CAAA,CAAE,CAAC,CAAA;AAAA;AACjC,EAEQ,qBAAqB,IAAc,EAAA;AACzC,IAAA,MAAM,UAAU,IAAK,CAAA,YAAA,GAAe,CAAK,EAAA,EAAA,IAAA,CAAK,YAAY,CAAK,CAAA,GAAA,EAAA;AAC/D,IAAA,OAAO,GAAG,IAAK,CAAA,WAAW,CAAG,EAAA,IAAI,GAAG,OAAO,CAAA,CAAA;AAAA;AAC7C,EAEA,aAAqB,gCACnB,CAAA,kBAAA,EACA,MACqC,EAAA;AACrC,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAM,MAAA,IAAI,MAAM,gCAAgC,CAAA;AAAA;AAElD,IAAM,MAAA,mBAAA,GAAsB,MAAO,CAAA,iBAAA,CAAkB,eAAe,CAAA;AACpE,IAAM,MAAA,SAAA,GAAY,mBAAqB,EAAA,iBAAA,CAAkB,KAAK,CAAA;AAE9D,IAAA,IAAI,MAAO,CAAA,iBAAA,CAAkB,UAAU,CAAA,KAAM,SAAW,EAAA;AACtD,MAAMC,MAAAA,WAAAA,GAAa,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA;AAC1C,MAAO,OAAA;AAAA,QACL,QAAU,EAAA,SAAA;AAAA,QACV,KAAO,EAAA;AAAA,UACL,EAAA,EAAI,MAAO,CAAA,SAAA,CAAU,SAAS;AAAA,SAChC;AAAA,QACA,IAAM,EAAA;AAAA,UACJ,QAAA,EAAUA,WAAW,CAAA,SAAA,CAAU,UAAU,CAAA;AAAA,UACzC,QAAA,EAAUA,WAAW,CAAA,SAAA,CAAU,UAAU;AAAA,SAC3C;AAAA,QACA,GAAI,SACA,GAAA;AAAA,UACE,GAAK,EAAA;AAAA,YACH,kBAAA,EACE,SAAW,EAAA,kBAAA,CAAmB,oBAAoB;AAAA;AACtD,YAEF;AAAC,OACP;AAAA;AAEF,IAAA,IAAI,MAAO,CAAA,iBAAA,CAAkB,UAAU,CAAA,KAAM,KAAO,EAAA;AAClD,MAAA,MAAM,gBAAgB,IAAIC,kBAAA,CAAc,MAAO,CAAA,SAAA,CAAU,MAAM,CAAC,CAAA;AAChE,MAAA,MAAM,OACJ,GAAA,MAAA,CAAO,iBAAkB,CAAA,SAAS,KAAK,aAAc,CAAA,OAAA;AACvD,MAAI,IAAA,OAAA,KAAY,QAAQ,OAAY,KAAA,MAAA;AAClC,QAAA,MAAM,IAAI,KAAA,CAAM,CAA8B,2BAAA,EAAA,OAAO,CAAE,CAAA,CAAA;AACzD,MAAO,OAAA;AAAA,QACL,QAAU,EAAA,KAAA;AAAA,QACV,IAAA,EAAM,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA;AAAA,QAC7B,MAAA,EAAQ,MAAO,CAAA,iBAAA,CAAkB,QAAQ,CAAA;AAAA,QACzC,OAAA;AAAA,QACA,GAAI,SACA,GAAA;AAAA,UACE,GAAK,EAAA;AAAA,YACH,kBAAA,EACE,SAAW,EAAA,kBAAA,CAAmB,oBAAoB;AAAA;AACtD,YAEF,EAAC;AAAA,QACL,GAAGC,kBAAe,CAAA;AAAA,UAChB,MAAQ,EAAA,MAAA,CAAO,iBAAkB,CAAA,QAAQ,KAAK,aAAc,CAAA,MAAA;AAAA;AAAA,UAC5D,OAAA;AAAA,UACA,cAAgB,EAAA,YACd,MAAM,kBAAA,CAAmB,qBAAsB;AAAA,SAClD;AAAA,OACH;AAAA;AAEF,IAAA,IAAI,MAAO,CAAA,iBAAA,CAAkB,UAAU,CAAA,KAAM,YAAc,EAAA;AACzD,MAAMF,MAAAA,WAAAA,GAAa,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA;AAC1C,MAAO,OAAA;AAAA,QACL,QAAU,EAAA,YAAA;AAAA,QACV,IAAA,EAAM,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA;AAAA,QAC7B,IAAM,EAAA;AAAA,UACJ,QAAA,EAAUA,WAAW,CAAA,SAAA,CAAU,UAAU,CAAA;AAAA,UACzC,QAAA,EAAUA,WAAW,CAAA,SAAA,CAAU,UAAU;AAAA,SAC3C;AAAA,QACA,GAAI,SACA,GAAA;AAAA,UACE,GAAK,EAAA;AAAA,YACH,kBAAA,EACE,SAAW,EAAA,kBAAA,CAAmB,oBAAoB;AAAA;AACtD,YAEF;AAAC,OACP;AAAA;AAEF,IAAM,MAAA,UAAA,GAAa,MAAO,CAAA,iBAAA,CAAkB,MAAM,CAAA;AAClD,IAAA,MAAM,IACJ,GAAA,UAAA,KACC,UAAW,CAAA,GAAA,CAAI,QAAQ,CACpB,GAAA;AAAA,MACE,MAAA,EAAQ,UAAW,CAAA,SAAA,CAAU,QAAQ;AAAA,KAEvC,GAAA;AAAA,MACE,QAAA,EAAU,UAAW,CAAA,SAAA,CAAU,UAAU,CAAA;AAAA,MACzC,QAAA,EAAU,UAAW,CAAA,SAAA,CAAU,UAAU;AAAA,KAC3C,CAAA;AACN,IAAO,OAAA;AAAA,MACL,IAAA,EAAM,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA;AAAA,MAC7B,IAAA;AAAA,MACA,GAAI,SACA,GAAA;AAAA,QACE,GAAK,EAAA;AAAA,UACH,kBAAA,EACE,SAAW,EAAA,kBAAA,CAAmB,oBAAoB;AAAA;AACtD,UAEF;AAAC,KACP;AAAA;AACF,EAEA,OAAe,wBACb,MACoC,EAAA;AACpC,IAAA,OACE,MAAO,CAAA,sBAAA,CAAuB,gBAAgB,CAAA,EAAG,IAAI,CAAkB,cAAA,KAAA;AACrE,MAAM,MAAA,UAAA,GAAa,cAAe,CAAA,SAAA,CAAU,MAAM,CAAA;AAClD,MAAO,OAAA;AAAA,QACL,IAAA,EAAM,cAAe,CAAA,SAAA,CAAU,MAAM,CAAA;AAAA,QACrC,IAAM,EAAA;AAAA,UACJ,cAAA,EAAgB,UAAW,CAAA,cAAA,CAAe,gBAAgB,CAAA;AAAA,UAC1D,WAAA,EAAa,UAAW,CAAA,sBAAA,CAAuB,aAAa,CAAA;AAAA,UAC5D,QAAU,EAAA,UAAA,CAAW,iBAAkB,CAAA,UAAU,GAAG,GAAI;AAAA;AAC1D,OACF;AAAA,KACD,KAAK,EAAC;AAAA;AAGb;AAKO,SAAS,iBAAiB,UAAuC,EAAA;AACtE,EAAA,IAAI,CAAC,UAAY,EAAA;AACf,IAAO,OAAA,EAAE,MAAM,CAAE,EAAA;AAAA;AAGnB,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,OAAO,MAAO,CAAA,IAAA,CAAK,YAAY,QAAQ,CAAA,CAAE,QAAS,CAAA,OAAO,CAAC;AAAA,GAClE;AACF;AAEgB,SAAA,gBAAA,CAAiB,EAAE,IAAA,EAAkC,EAAA;AACnE,EAAO,OAAA,MAAA,CAAO,KAAK,CAAG,EAAA,IAAI,IAAI,OAAO,CAAA,CAAE,SAAS,QAAQ,CAAA;AAC1D;;;;;;"}
|
|
1
|
+
{"version":3,"file":"ElasticSearchSearchEngine.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 IndexableDocument,\n IndexableResult,\n IndexableResultSet,\n SearchQuery,\n} from '@backstage/plugin-search-common';\nimport { SearchEngine } from '@backstage/plugin-search-backend-node';\nimport { isEmpty, isNumber, isNaN as nan } from 'lodash';\n\nimport { AwsSigv4Signer } from '@opensearch-project/opensearch/aws';\nimport { RequestSigner } from 'aws4';\nimport { Config } from '@backstage/config';\nimport {\n ElasticSearchClientOptions,\n OpenSearchElasticSearchClientOptions,\n} from './ElasticSearchClientOptions';\nimport { ElasticSearchClientWrapper } from './ElasticSearchClientWrapper';\nimport { ElasticSearchCustomIndexTemplate } from './types';\nimport { ElasticSearchSearchEngineIndexer } from './ElasticSearchSearchEngineIndexer';\nimport { MissingIndexError } from '@backstage/plugin-search-backend-node';\nimport esb from 'elastic-builder';\nimport { v4 as uuid } from 'uuid';\nimport {\n AwsCredentialProvider,\n DefaultAwsCredentialsManager,\n} from '@backstage/integration-aws-node';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\nexport type { ElasticSearchClientOptions };\n\n/**\n * Search query that the elasticsearch engine understands.\n * @public\n */\nexport type ElasticSearchConcreteQuery = {\n documentTypes?: string[];\n elasticSearchQuery: Object;\n pageSize: number;\n};\n\n/**\n * Options available for the Elasticsearch specific query translator.\n * @public\n */\nexport type ElasticSearchQueryTranslatorOptions = {\n highlightOptions?: ElasticSearchHighlightConfig;\n queryOptions?: ElasticSearchQueryConfig;\n};\n\n/**\n * Elasticsearch specific query translator.\n * @public\n */\nexport type ElasticSearchQueryTranslator = (\n query: SearchQuery,\n options?: ElasticSearchQueryTranslatorOptions,\n) => ElasticSearchConcreteQuery;\n\n/**\n * Options for instantiate ElasticSearchSearchEngine\n * @public\n */\nexport type ElasticSearchOptions = {\n logger: LoggerService;\n config: Config;\n aliasPostfix?: string;\n indexPrefix?: string;\n translator?: ElasticSearchQueryTranslator;\n};\n\n/**\n * @public\n */\nexport type ElasticSearchHighlightOptions = {\n fragmentDelimiter?: string;\n fragmentSize?: number;\n numFragments?: number;\n};\n\n/**\n * @public\n */\nexport type ElasticSearchQueryConfig = {\n fuzziness?: string | number;\n prefixLength?: number;\n};\n\n/**\n * @public\n */\nexport type ElasticSearchHighlightConfig = {\n fragmentDelimiter: string;\n fragmentSize: number;\n numFragments: number;\n preTag: string;\n postTag: string;\n};\n\ntype ElasticSearchResult = {\n _index: string;\n _type: string;\n _score: number;\n _source: IndexableDocument;\n highlight?: {\n [field: string]: string[];\n };\n};\n\nfunction isBlank(str: string) {\n return (isEmpty(str) && !isNumber(str)) || nan(str);\n}\n\nconst DEFAULT_INDEXER_BATCH_SIZE = 1000;\n\n/**\n * @public\n */\nexport class ElasticSearchSearchEngine implements SearchEngine {\n private readonly elasticSearchClientWrapper: ElasticSearchClientWrapper;\n private readonly highlightOptions: ElasticSearchHighlightConfig;\n private readonly queryOptions?: ElasticSearchQueryConfig;\n\n constructor(\n private readonly elasticSearchClientOptions: ElasticSearchClientOptions,\n private readonly aliasPostfix: string,\n private readonly indexPrefix: string,\n private readonly logger: LoggerService,\n private readonly batchSize: number,\n highlightOptions?: ElasticSearchHighlightOptions,\n queryOptions?: ElasticSearchQueryConfig,\n ) {\n this.elasticSearchClientWrapper =\n ElasticSearchClientWrapper.fromClientOptions(elasticSearchClientOptions);\n const uuidTag = uuid();\n this.highlightOptions = {\n preTag: `<${uuidTag}>`,\n postTag: `</${uuidTag}>`,\n fragmentSize: 1000,\n numFragments: 1,\n fragmentDelimiter: ' ... ',\n ...highlightOptions,\n };\n this.queryOptions = queryOptions;\n }\n\n static async fromConfig(options: ElasticSearchOptions) {\n const {\n logger,\n config,\n aliasPostfix = `search`,\n indexPrefix = ``,\n translator,\n } = options;\n const credentialProvider = DefaultAwsCredentialsManager.fromConfig(config);\n const clientOptions = await this.createElasticSearchClientOptions(\n await credentialProvider?.getCredentialProvider(),\n config.getConfig('search.elasticsearch'),\n );\n if (clientOptions.provider === 'elastic') {\n logger.info('Initializing Elastic.co ElasticSearch search engine.');\n } else if (clientOptions.provider === 'aws') {\n logger.info('Initializing AWS OpenSearch search engine.');\n } else if (clientOptions.provider === 'opensearch') {\n logger.info('Initializing OpenSearch search engine.');\n } else {\n logger.info('Initializing ElasticSearch search engine.');\n }\n\n const engine = new ElasticSearchSearchEngine(\n clientOptions,\n aliasPostfix,\n indexPrefix,\n logger,\n config.getOptionalNumber('search.elasticsearch.batchSize') ??\n DEFAULT_INDEXER_BATCH_SIZE,\n config.getOptional<ElasticSearchHighlightOptions>(\n 'search.elasticsearch.highlightOptions',\n ),\n config.getOptional<ElasticSearchQueryConfig>(\n 'search.elasticsearch.queryOptions',\n ),\n );\n\n for (const indexTemplate of this.readIndexTemplateConfig(\n config.getConfig('search.elasticsearch'),\n )) {\n await engine.setIndexTemplate(indexTemplate);\n }\n\n if (translator) {\n await engine.setTranslator(translator);\n }\n\n return engine;\n }\n\n /**\n * Create a custom search client from the derived search client configuration.\n * This need not be the same client that the engine uses internally.\n *\n * @example Instantiate an instance of an Elasticsearch client.\n *\n * ```ts\n * import { isOpenSearchCompatible } from '@backstage/plugin-search-backend-module-elasticsearch';\n * import { Client } from '@elastic/elasticsearch';\n *\n * const client = searchEngine.newClient<Client>(options => {\n * // This type guard ensures options are compatible with either OpenSearch\n * // or Elasticsearch client constructors.\n * if (!isOpenSearchCompatible(options)) {\n * return new Client(options);\n * }\n * throw new Error('Incompatible options provided');\n * });\n * ```\n */\n newClient<T>(create: (options: ElasticSearchClientOptions) => T): T {\n return create(this.elasticSearchClientOptions);\n }\n\n protected translator(\n query: SearchQuery,\n options?: ElasticSearchQueryTranslatorOptions,\n ): ElasticSearchConcreteQuery {\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 // Use exact matching for string datatype fields\n const keyword = typeof value === 'string' ? `${key}.keyword` : key;\n return esb.matchQuery(keyword, 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('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\n const esbQueries = [];\n // https://regex101.com/r/Lr0MqS/1\n const phraseTerms = term.match(/\"[^\"]*\"/g);\n\n if (isBlank(term)) {\n const esbQuery = esb.matchAllQuery();\n esbQueries.push(esbQuery);\n } else if (phraseTerms && phraseTerms.length > 0) {\n let restTerm = term;\n for (const phraseTerm of phraseTerms) {\n restTerm = restTerm.replace(phraseTerm, '');\n const esbPhraseQuery = esb\n .multiMatchQuery(['*'], phraseTerm.replace(/\"/g, ''))\n .type('phrase');\n esbQueries.push(esbPhraseQuery);\n }\n if (restTerm?.length > 0) {\n const esbRestQuery = esb\n .multiMatchQuery(['*'], restTerm.trim())\n .fuzziness(options?.queryOptions?.fuzziness ?? 'auto')\n .prefixLength(options?.queryOptions?.prefixLength ?? 0);\n esbQueries.push(esbRestQuery);\n }\n } else {\n const esbQuery = esb\n .multiMatchQuery(['*'], term)\n .fuzziness(options?.queryOptions?.fuzziness ?? 'auto')\n .prefixLength(options?.queryOptions?.prefixLength ?? 0);\n esbQueries.push(esbQuery);\n }\n\n const pageSize = query.pageLimit || 25;\n const { page } = decodePageCursor(pageCursor);\n\n let esbRequestBodySearch = esb\n .requestBodySearch()\n .query(esb.boolQuery().filter(filter).should(esbQueries))\n .from(page * pageSize)\n .size(pageSize);\n\n if (options?.highlightOptions) {\n esbRequestBodySearch = esbRequestBodySearch.highlight(\n esb\n .highlight('*')\n .numberOfFragments(options.highlightOptions.numFragments as number)\n .fragmentSize(options.highlightOptions.fragmentSize as number)\n .preTags(options.highlightOptions.preTag)\n .postTags(options.highlightOptions.postTag),\n );\n }\n\n return {\n elasticSearchQuery: esbRequestBodySearch.toJSON(),\n documentTypes: types,\n pageSize,\n };\n }\n\n setTranslator(translator: ElasticSearchQueryTranslator) {\n this.translator = translator;\n }\n\n async setIndexTemplate(template: ElasticSearchCustomIndexTemplate) {\n try {\n await this.elasticSearchClientWrapper.putIndexTemplate(template);\n this.logger.info('Custom index template set');\n } catch (error) {\n this.logger.error(`Unable to set custom index template: ${error}`);\n }\n }\n\n async getIndexer(type: string) {\n const alias = this.constructSearchAlias(type);\n const indexerLogger = this.logger.child({ documentType: type });\n\n const indexer = new ElasticSearchSearchEngineIndexer({\n type,\n indexPrefix: this.indexPrefix,\n indexSeparator: this.indexSeparator,\n alias,\n elasticSearchClientWrapper: this.elasticSearchClientWrapper,\n logger: indexerLogger,\n batchSize: this.batchSize,\n skipRefresh:\n (\n this\n .elasticSearchClientOptions as OpenSearchElasticSearchClientOptions\n )?.service === 'aoss',\n });\n\n // Attempt cleanup upon failure.\n // todo(@backstage/search-maintainers): Consider introducing a more\n // formal mechanism for handling such errors in BatchSearchEngineIndexer and\n // replacing this handler with it. See: #17291\n indexer.on('error', async e => {\n indexerLogger.error(`Failed to index documents for type ${type}`, e);\n let cleanupError: Error | undefined;\n\n // In some cases, a failure may have occurred before the indexer was able\n // to complete initialization. Try up to 5 times to remove the dangling\n // index.\n await new Promise<void>(async done => {\n const maxAttempts = 5;\n let attempts = 0;\n\n while (attempts < maxAttempts) {\n try {\n await this.elasticSearchClientWrapper.deleteIndex({\n index: indexer.indexName,\n });\n\n attempts = maxAttempts;\n cleanupError = undefined;\n done();\n } catch (err) {\n cleanupError = err;\n }\n\n // Wait 1 second between retries.\n await new Promise(okay => setTimeout(okay, 1000));\n\n attempts++;\n }\n done();\n });\n\n if (cleanupError) {\n indexerLogger.error(\n `Unable to clean up elastic index ${indexer.indexName}: ${cleanupError}`,\n );\n } else {\n indexerLogger.info(\n `Removed partial, failed index ${indexer.indexName}`,\n );\n }\n });\n\n return indexer;\n }\n\n async query(query: SearchQuery): Promise<IndexableResultSet> {\n const { elasticSearchQuery, documentTypes, pageSize } = this.translator(\n query,\n {\n highlightOptions: this.highlightOptions,\n queryOptions: this.queryOptions,\n },\n );\n const queryIndices = documentTypes\n ? documentTypes.map(it => this.constructSearchAlias(it))\n : this.constructSearchAlias('*');\n try {\n const result = await this.elasticSearchClientWrapper.search({\n index: queryIndices,\n body: elasticSearchQuery,\n });\n const { page } = decodePageCursor(query.pageCursor);\n const hasNextPage = result.body.hits.total.value > (page + 1) * 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(\n (d: ElasticSearchResult, index: number) => {\n const resultItem: IndexableResult = {\n type: this.getTypeFromIndex(d._index),\n document: d._source,\n rank: pageSize * page + index + 1,\n };\n\n if (d.highlight) {\n resultItem.highlight = {\n preTag: this.highlightOptions.preTag as string,\n postTag: this.highlightOptions.postTag as string,\n fields: Object.fromEntries(\n Object.entries(d.highlight).map(([field, fragments]) => [\n field,\n fragments.join(this.highlightOptions.fragmentDelimiter),\n ]),\n ),\n };\n }\n\n return resultItem;\n },\n ),\n nextPageCursor,\n previousPageCursor,\n numberOfResults: result.body.hits.total.value,\n };\n } catch (error) {\n if (error.meta?.body?.error?.type === 'index_not_found_exception') {\n throw new MissingIndexError(\n `Missing index for ${queryIndices}. This means there are no documents to search through.`,\n error,\n );\n }\n this.logger.error(\n `Failed to query documents for indices ${queryIndices}`,\n error,\n );\n return Promise.reject({ results: [] });\n }\n }\n\n private readonly indexSeparator = '-index__';\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 private static async createElasticSearchClientOptions(\n credentialProvider: AwsCredentialProvider,\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 requestSigner = new RequestSigner(config.getString('node'));\n const service =\n config.getOptionalString('service') ?? requestSigner.service;\n if (service !== 'es' && service !== 'aoss')\n throw new Error(`Unrecognized service type: ${service}`);\n return {\n provider: 'aws',\n node: config.getString('node'),\n region: config.getOptionalString('region'),\n service,\n ...(sslConfig\n ? {\n ssl: {\n rejectUnauthorized:\n sslConfig?.getOptionalBoolean('rejectUnauthorized'),\n },\n }\n : {}),\n ...AwsSigv4Signer({\n region: config.getOptionalString('region') ?? requestSigner.region, // for backwards compatibility\n service: service,\n getCredentials: async () =>\n await credentialProvider.sdkCredentialProvider(),\n }),\n };\n }\n if (config.getOptionalString('provider') === 'opensearch') {\n const authConfig = config.getConfig('auth');\n return {\n provider: 'opensearch',\n node: config.getString('node'),\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 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\n private static readIndexTemplateConfig(\n config: Config,\n ): ElasticSearchCustomIndexTemplate[] {\n return (\n config.getOptionalConfigArray('indexTemplates')?.map(templateConfig => {\n const bodyConfig = templateConfig.getConfig('body');\n return {\n name: templateConfig.getString('name'),\n body: {\n index_patterns: bodyConfig.getStringArray('index_patterns'),\n composed_of: bodyConfig.getOptionalStringArray('composed_of'),\n template: bodyConfig.getOptionalConfig('template')?.get(),\n },\n };\n }) ?? []\n );\n }\n}\n\n/**\n * @public\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","ElasticSearchClientWrapper","uuid","DefaultAwsCredentialsManager","esb","ElasticSearchSearchEngineIndexer","MissingIndexError","authConfig","RequestSigner","AwsSigv4Signer"],"mappings":";;;;;;;;;;;;;;;;AA4HA,SAAS,QAAQ,GAAA,EAAa;AAC5B,EAAA,OAAQA,cAAA,CAAQ,GAAG,CAAA,IAAK,CAACC,gBAAS,GAAG,CAAA,IAAMC,aAAI,GAAG,CAAA;AACpD;AAEA,MAAM,0BAAA,GAA6B,GAAA;AAK5B,MAAM,yBAAA,CAAkD;AAAA,EAK7D,YACmB,0BAAA,EACA,YAAA,EACA,aACA,MAAA,EACA,SAAA,EACjB,kBACA,YAAA,EACA;AAPiB,IAAA,IAAA,CAAA,0BAAA,GAAA,0BAAA;AACA,IAAA,IAAA,CAAA,YAAA,GAAA,YAAA;AACA,IAAA,IAAA,CAAA,WAAA,GAAA,WAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AAIjB,IAAA,IAAA,CAAK,0BAAA,GACHC,qDAAA,CAA2B,iBAAA,CAAkB,0BAA0B,CAAA;AACzE,IAAA,MAAM,UAAUC,OAAA,EAAK;AACrB,IAAA,IAAA,CAAK,gBAAA,GAAmB;AAAA,MACtB,MAAA,EAAQ,IAAI,OAAO,CAAA,CAAA,CAAA;AAAA,MACnB,OAAA,EAAS,KAAK,OAAO,CAAA,CAAA,CAAA;AAAA,MACrB,YAAA,EAAc,GAAA;AAAA,MACd,YAAA,EAAc,CAAA;AAAA,MACd,iBAAA,EAAmB,OAAA;AAAA,MACnB,GAAG;AAAA,KACL;AACA,IAAA,IAAA,CAAK,YAAA,GAAe,YAAA;AAAA,EACtB;AAAA,EAzBiB,0BAAA;AAAA,EACA,gBAAA;AAAA,EACA,YAAA;AAAA,EAyBjB,aAAa,WAAW,OAAA,EAA+B;AACrD,IAAA,MAAM;AAAA,MACJ,MAAA;AAAA,MACA,MAAA;AAAA,MACA,YAAA,GAAe,CAAA,MAAA,CAAA;AAAA,MACf,WAAA,GAAc,CAAA,CAAA;AAAA,MACd;AAAA,KACF,GAAI,OAAA;AACJ,IAAA,MAAM,kBAAA,GAAqBC,+CAAA,CAA6B,UAAA,CAAW,MAAM,CAAA;AACzE,IAAA,MAAM,aAAA,GAAgB,MAAM,IAAA,CAAK,gCAAA;AAAA,MAC/B,MAAM,oBAAoB,qBAAA,EAAsB;AAAA,MAChD,MAAA,CAAO,UAAU,sBAAsB;AAAA,KACzC;AACA,IAAA,IAAI,aAAA,CAAc,aAAa,SAAA,EAAW;AACxC,MAAA,MAAA,CAAO,KAAK,sDAAsD,CAAA;AAAA,IACpE,CAAA,MAAA,IAAW,aAAA,CAAc,QAAA,KAAa,KAAA,EAAO;AAC3C,MAAA,MAAA,CAAO,KAAK,4CAA4C,CAAA;AAAA,IAC1D,CAAA,MAAA,IAAW,aAAA,CAAc,QAAA,KAAa,YAAA,EAAc;AAClD,MAAA,MAAA,CAAO,KAAK,wCAAwC,CAAA;AAAA,IACtD,CAAA,MAAO;AACL,MAAA,MAAA,CAAO,KAAK,2CAA2C,CAAA;AAAA,IACzD;AAEA,IAAA,MAAM,SAAS,IAAI,yBAAA;AAAA,MACjB,aAAA;AAAA,MACA,YAAA;AAAA,MACA,WAAA;AAAA,MACA,MAAA;AAAA,MACA,MAAA,CAAO,iBAAA,CAAkB,gCAAgC,CAAA,IACvD,0BAAA;AAAA,MACF,MAAA,CAAO,WAAA;AAAA,QACL;AAAA,OACF;AAAA,MACA,MAAA,CAAO,WAAA;AAAA,QACL;AAAA;AACF,KACF;AAEA,IAAA,KAAA,MAAW,iBAAiB,IAAA,CAAK,uBAAA;AAAA,MAC/B,MAAA,CAAO,UAAU,sBAAsB;AAAA,KACzC,EAAG;AACD,MAAA,MAAM,MAAA,CAAO,iBAAiB,aAAa,CAAA;AAAA,IAC7C;AAEA,IAAA,IAAI,UAAA,EAAY;AACd,MAAA,MAAM,MAAA,CAAO,cAAc,UAAU,CAAA;AAAA,IACvC;AAEA,IAAA,OAAO,MAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,UAAa,MAAA,EAAuD;AAClE,IAAA,OAAO,MAAA,CAAO,KAAK,0BAA0B,CAAA;AAAA,EAC/C;AAAA,EAEU,UAAA,CACR,OACA,OAAA,EAC4B;AAC5B,IAAA,MAAM,EAAE,IAAA,EAAM,OAAA,GAAU,EAAC,EAAG,KAAA,EAAO,YAAW,GAAI,KAAA;AAElD,IAAA,MAAM,MAAA,GAAS,OAAO,OAAA,CAAQ,OAAO,EAClC,MAAA,CAAO,CAAC,CAAC,CAAA,EAAG,KAAK,MAAM,OAAA,CAAQ,KAAK,CAAC,CAAA,CACrC,GAAA,CAAI,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,KAAiC;AAChD,MAAA,IAAI,CAAC,UAAU,QAAA,EAAU,SAAS,EAAE,QAAA,CAAS,OAAO,KAAK,CAAA,EAAG;AAE1D,QAAA,MAAM,UAAU,OAAO,KAAA,KAAU,QAAA,GAAW,CAAA,EAAG,GAAG,CAAA,QAAA,CAAA,GAAa,GAAA;AAC/D,QAAA,OAAOC,oBAAA,CAAI,UAAA,CAAW,OAAA,EAAS,KAAA,CAAM,UAAU,CAAA;AAAA,MACjD;AACA,MAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,EAAG;AACxB,QAAA,OAAOA,oBAAA,CACJ,SAAA,EAAU,CACV,MAAA,CAAO,MAAM,GAAA,CAAI,CAAA,EAAA,KAAMA,oBAAA,CAAI,UAAA,CAAW,GAAA,EAAK,EAAA,CAAG,QAAA,EAAU,CAAC,CAAC,CAAA;AAAA,MAC/D;AACA,MAAA,IAAA,CAAK,MAAA,CAAO,MAAM,2CAAA,EAA6C;AAAA,QAC7D,GAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAA,MAAM,IAAI,KAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF,CAAC,CAAA;AAEH,IAAA,MAAM,aAAa,EAAC;AAEpB,IAAA,MAAM,WAAA,GAAc,IAAA,CAAK,KAAA,CAAM,UAAU,CAAA;AAEzC,IAAA,IAAI,OAAA,CAAQ,IAAI,CAAA,EAAG;AACjB,MAAA,MAAM,QAAA,GAAWA,qBAAI,aAAA,EAAc;AACnC,MAAA,UAAA,CAAW,KAAK,QAAQ,CAAA;AAAA,IAC1B,CAAA,MAAA,IAAW,WAAA,IAAe,WAAA,CAAY,MAAA,GAAS,CAAA,EAAG;AAChD,MAAA,IAAI,QAAA,GAAW,IAAA;AACf,MAAA,KAAA,MAAW,cAAc,WAAA,EAAa;AACpC,QAAA,QAAA,GAAW,QAAA,CAAS,OAAA,CAAQ,UAAA,EAAY,EAAE,CAAA;AAC1C,QAAA,MAAM,cAAA,GAAiBA,oBAAA,CACpB,eAAA,CAAgB,CAAC,GAAG,CAAA,EAAG,UAAA,CAAW,OAAA,CAAQ,IAAA,EAAM,EAAE,CAAC,CAAA,CACnD,KAAK,QAAQ,CAAA;AAChB,QAAA,UAAA,CAAW,KAAK,cAAc,CAAA;AAAA,MAChC;AACA,MAAA,IAAI,QAAA,EAAU,SAAS,CAAA,EAAG;AACxB,QAAA,MAAM,YAAA,GAAeA,qBAClB,eAAA,CAAgB,CAAC,GAAG,CAAA,EAAG,QAAA,CAAS,MAAM,CAAA,CACtC,UAAU,OAAA,EAAS,YAAA,EAAc,aAAa,MAAM,CAAA,CACpD,aAAa,OAAA,EAAS,YAAA,EAAc,gBAAgB,CAAC,CAAA;AACxD,QAAA,UAAA,CAAW,KAAK,YAAY,CAAA;AAAA,MAC9B;AAAA,IACF,CAAA,MAAO;AACL,MAAA,MAAM,WAAWA,oBAAA,CACd,eAAA,CAAgB,CAAC,GAAG,CAAA,EAAG,IAAI,CAAA,CAC3B,SAAA,CAAU,OAAA,EAAS,YAAA,EAAc,aAAa,MAAM,CAAA,CACpD,aAAa,OAAA,EAAS,YAAA,EAAc,gBAAgB,CAAC,CAAA;AACxD,MAAA,UAAA,CAAW,KAAK,QAAQ,CAAA;AAAA,IAC1B;AAEA,IAAA,MAAM,QAAA,GAAW,MAAM,SAAA,IAAa,EAAA;AACpC,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,gBAAA,CAAiB,UAAU,CAAA;AAE5C,IAAA,IAAI,oBAAA,GAAuBA,qBACxB,iBAAA,EAAkB,CAClB,MAAMA,oBAAA,CAAI,SAAA,GAAY,MAAA,CAAO,MAAM,EAAE,MAAA,CAAO,UAAU,CAAC,CAAA,CACvD,IAAA,CAAK,OAAO,QAAQ,CAAA,CACpB,KAAK,QAAQ,CAAA;AAEhB,IAAA,IAAI,SAAS,gBAAA,EAAkB;AAC7B,MAAA,oBAAA,GAAuB,oBAAA,CAAqB,SAAA;AAAA,QAC1CA,oBAAA,CACG,UAAU,GAAG,CAAA,CACb,kBAAkB,OAAA,CAAQ,gBAAA,CAAiB,YAAsB,CAAA,CACjE,YAAA,CAAa,OAAA,CAAQ,iBAAiB,YAAsB,CAAA,CAC5D,QAAQ,OAAA,CAAQ,gBAAA,CAAiB,MAAM,CAAA,CACvC,QAAA,CAAS,OAAA,CAAQ,gBAAA,CAAiB,OAAO;AAAA,OAC9C;AAAA,IACF;AAEA,IAAA,OAAO;AAAA,MACL,kBAAA,EAAoB,qBAAqB,MAAA,EAAO;AAAA,MAChD,aAAA,EAAe,KAAA;AAAA,MACf;AAAA,KACF;AAAA,EACF;AAAA,EAEA,cAAc,UAAA,EAA0C;AACtD,IAAA,IAAA,CAAK,UAAA,GAAa,UAAA;AAAA,EACpB;AAAA,EAEA,MAAM,iBAAiB,QAAA,EAA4C;AACjE,IAAA,IAAI;AACF,MAAA,MAAM,IAAA,CAAK,0BAAA,CAA2B,gBAAA,CAAiB,QAAQ,CAAA;AAC/D,MAAA,IAAA,CAAK,MAAA,CAAO,KAAK,2BAA2B,CAAA;AAAA,IAC9C,SAAS,KAAA,EAAO;AACd,MAAA,IAAA,CAAK,MAAA,CAAO,KAAA,CAAM,CAAA,qCAAA,EAAwC,KAAK,CAAA,CAAE,CAAA;AAAA,IACnE;AAAA,EACF;AAAA,EAEA,MAAM,WAAW,IAAA,EAAc;AAC7B,IAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,oBAAA,CAAqB,IAAI,CAAA;AAC5C,IAAA,MAAM,gBAAgB,IAAA,CAAK,MAAA,CAAO,MAAM,EAAE,YAAA,EAAc,MAAM,CAAA;AAE9D,IAAA,MAAM,OAAA,GAAU,IAAIC,iEAAA,CAAiC;AAAA,MACnD,IAAA;AAAA,MACA,aAAa,IAAA,CAAK,WAAA;AAAA,MAClB,gBAAgB,IAAA,CAAK,cAAA;AAAA,MACrB,KAAA;AAAA,MACA,4BAA4B,IAAA,CAAK,0BAAA;AAAA,MACjC,MAAA,EAAQ,aAAA;AAAA,MACR,WAAW,IAAA,CAAK,SAAA;AAAA,MAChB,WAAA,EAEI,IAAA,CACG,0BAAA,EACF,OAAA,KAAY;AAAA,KAClB,CAAA;AAMD,IAAA,OAAA,CAAQ,EAAA,CAAG,OAAA,EAAS,OAAM,CAAA,KAAK;AAC7B,MAAA,aAAA,CAAc,KAAA,CAAM,CAAA,mCAAA,EAAsC,IAAI,CAAA,CAAA,EAAI,CAAC,CAAA;AACnE,MAAA,IAAI,YAAA;AAKJ,MAAA,MAAM,IAAI,OAAA,CAAc,OAAM,IAAA,KAAQ;AACpC,QAAA,MAAM,WAAA,GAAc,CAAA;AACpB,QAAA,IAAI,QAAA,GAAW,CAAA;AAEf,QAAA,OAAO,WAAW,WAAA,EAAa;AAC7B,UAAA,IAAI;AACF,YAAA,MAAM,IAAA,CAAK,2BAA2B,WAAA,CAAY;AAAA,cAChD,OAAO,OAAA,CAAQ;AAAA,aAChB,CAAA;AAED,YAAA,QAAA,GAAW,WAAA;AACX,YAAA,YAAA,GAAe,KAAA,CAAA;AACf,YAAA,IAAA,EAAK;AAAA,UACP,SAAS,GAAA,EAAK;AACZ,YAAA,YAAA,GAAe,GAAA;AAAA,UACjB;AAGA,UAAA,MAAM,IAAI,OAAA,CAAQ,CAAA,IAAA,KAAQ,UAAA,CAAW,IAAA,EAAM,GAAI,CAAC,CAAA;AAEhD,UAAA,QAAA,EAAA;AAAA,QACF;AACA,QAAA,IAAA,EAAK;AAAA,MACP,CAAC,CAAA;AAED,MAAA,IAAI,YAAA,EAAc;AAChB,QAAA,aAAA,CAAc,KAAA;AAAA,UACZ,CAAA,iCAAA,EAAoC,OAAA,CAAQ,SAAS,CAAA,EAAA,EAAK,YAAY,CAAA;AAAA,SACxE;AAAA,MACF,CAAA,MAAO;AACL,QAAA,aAAA,CAAc,IAAA;AAAA,UACZ,CAAA,8BAAA,EAAiC,QAAQ,SAAS,CAAA;AAAA,SACpD;AAAA,MACF;AAAA,IACF,CAAC,CAAA;AAED,IAAA,OAAO,OAAA;AAAA,EACT;AAAA,EAEA,MAAM,MAAM,KAAA,EAAiD;AAC3D,IAAA,MAAM,EAAE,kBAAA,EAAoB,aAAA,EAAe,QAAA,KAAa,IAAA,CAAK,UAAA;AAAA,MAC3D,KAAA;AAAA,MACA;AAAA,QACE,kBAAkB,IAAA,CAAK,gBAAA;AAAA,QACvB,cAAc,IAAA,CAAK;AAAA;AACrB,KACF;AACA,IAAA,MAAM,YAAA,GAAe,aAAA,GACjB,aAAA,CAAc,GAAA,CAAI,CAAA,EAAA,KAAM,IAAA,CAAK,oBAAA,CAAqB,EAAE,CAAC,CAAA,GACrD,IAAA,CAAK,oBAAA,CAAqB,GAAG,CAAA;AACjC,IAAA,IAAI;AACF,MAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,0BAAA,CAA2B,MAAA,CAAO;AAAA,QAC1D,KAAA,EAAO,YAAA;AAAA,QACP,IAAA,EAAM;AAAA,OACP,CAAA;AACD,MAAA,MAAM,EAAE,IAAA,EAAK,GAAI,gBAAA,CAAiB,MAAM,UAAU,CAAA;AAClD,MAAA,MAAM,cAAc,MAAA,CAAO,IAAA,CAAK,KAAK,KAAA,CAAM,KAAA,GAAA,CAAS,OAAO,CAAA,IAAK,QAAA;AAChE,MAAA,MAAM,kBAAkB,IAAA,GAAO,CAAA;AAC/B,MAAA,MAAM,cAAA,GAAiB,cACnB,gBAAA,CAAiB,EAAE,MAAM,IAAA,GAAO,CAAA,EAAG,CAAA,GACnC,KAAA,CAAA;AACJ,MAAA,MAAM,kBAAA,GAAqB,kBACvB,gBAAA,CAAiB,EAAE,MAAM,IAAA,GAAO,CAAA,EAAG,CAAA,GACnC,KAAA,CAAA;AAEJ,MAAA,OAAO;AAAA,QACL,OAAA,EAAS,MAAA,CAAO,IAAA,CAAK,IAAA,CAAK,IAAA,CAAK,GAAA;AAAA,UAC7B,CAAC,GAAwB,KAAA,KAAkB;AACzC,YAAA,MAAM,UAAA,GAA8B;AAAA,cAClC,IAAA,EAAM,IAAA,CAAK,gBAAA,CAAiB,CAAA,CAAE,MAAM,CAAA;AAAA,cACpC,UAAU,CAAA,CAAE,OAAA;AAAA,cACZ,IAAA,EAAM,QAAA,GAAW,IAAA,GAAO,KAAA,GAAQ;AAAA,aAClC;AAEA,YAAA,IAAI,EAAE,SAAA,EAAW;AACf,cAAA,UAAA,CAAW,SAAA,GAAY;AAAA,gBACrB,MAAA,EAAQ,KAAK,gBAAA,CAAiB,MAAA;AAAA,gBAC9B,OAAA,EAAS,KAAK,gBAAA,CAAiB,OAAA;AAAA,gBAC/B,QAAQ,MAAA,CAAO,WAAA;AAAA,kBACb,MAAA,CAAO,OAAA,CAAQ,CAAA,CAAE,SAAS,CAAA,CAAE,IAAI,CAAC,CAAC,KAAA,EAAO,SAAS,CAAA,KAAM;AAAA,oBACtD,KAAA;AAAA,oBACA,SAAA,CAAU,IAAA,CAAK,IAAA,CAAK,gBAAA,CAAiB,iBAAiB;AAAA,mBACvD;AAAA;AACH,eACF;AAAA,YACF;AAEA,YAAA,OAAO,UAAA;AAAA,UACT;AAAA,SACF;AAAA,QACA,cAAA;AAAA,QACA,kBAAA;AAAA,QACA,eAAA,EAAiB,MAAA,CAAO,IAAA,CAAK,IAAA,CAAK,KAAA,CAAM;AAAA,OAC1C;AAAA,IACF,SAAS,KAAA,EAAO;AACd,MAAA,IAAI,KAAA,CAAM,IAAA,EAAM,IAAA,EAAM,KAAA,EAAO,SAAS,2BAAA,EAA6B;AACjE,QAAA,MAAM,IAAIC,yCAAA;AAAA,UACR,qBAAqB,YAAY,CAAA,sDAAA,CAAA;AAAA,UACjC;AAAA,SACF;AAAA,MACF;AACA,MAAA,IAAA,CAAK,MAAA,CAAO,KAAA;AAAA,QACV,yCAAyC,YAAY,CAAA,CAAA;AAAA,QACrD;AAAA,OACF;AACA,MAAA,OAAO,QAAQ,MAAA,CAAO,EAAE,OAAA,EAAS,IAAI,CAAA;AAAA,IACvC;AAAA,EACF;AAAA,EAEiB,cAAA,GAAiB,UAAA;AAAA,EAE1B,iBAAiB,KAAA,EAAe;AACtC,IAAA,OAAO,KAAA,CACJ,SAAA,CAAU,IAAA,CAAK,WAAA,CAAY,MAAM,EACjC,KAAA,CAAM,IAAA,CAAK,cAAc,CAAA,CAAE,CAAC,CAAA;AAAA,EACjC;AAAA,EAEQ,qBAAqB,IAAA,EAAc;AACzC,IAAA,MAAM,UAAU,IAAA,CAAK,YAAA,GAAe,CAAA,EAAA,EAAK,IAAA,CAAK,YAAY,CAAA,CAAA,GAAK,EAAA;AAC/D,IAAA,OAAO,GAAG,IAAA,CAAK,WAAW,CAAA,EAAG,IAAI,GAAG,OAAO,CAAA,CAAA;AAAA,EAC7C;AAAA,EAEA,aAAqB,gCAAA,CACnB,kBAAA,EACA,MAAA,EACqC;AACrC,IAAA,IAAI,CAAC,MAAA,EAAQ;AACX,MAAA,MAAM,IAAI,MAAM,gCAAgC,CAAA;AAAA,IAClD;AACA,IAAA,MAAM,mBAAA,GAAsB,MAAA,CAAO,iBAAA,CAAkB,eAAe,CAAA;AACpE,IAAA,MAAM,SAAA,GAAY,mBAAA,EAAqB,iBAAA,CAAkB,KAAK,CAAA;AAE9D,IAAA,IAAI,MAAA,CAAO,iBAAA,CAAkB,UAAU,CAAA,KAAM,SAAA,EAAW;AACtD,MAAA,MAAMC,WAAAA,GAAa,MAAA,CAAO,SAAA,CAAU,MAAM,CAAA;AAC1C,MAAA,OAAO;AAAA,QACL,QAAA,EAAU,SAAA;AAAA,QACV,KAAA,EAAO;AAAA,UACL,EAAA,EAAI,MAAA,CAAO,SAAA,CAAU,SAAS;AAAA,SAChC;AAAA,QACA,IAAA,EAAM;AAAA,UACJ,QAAA,EAAUA,WAAAA,CAAW,SAAA,CAAU,UAAU,CAAA;AAAA,UACzC,QAAA,EAAUA,WAAAA,CAAW,SAAA,CAAU,UAAU;AAAA,SAC3C;AAAA,QACA,GAAI,SAAA,GACA;AAAA,UACE,GAAA,EAAK;AAAA,YACH,kBAAA,EACE,SAAA,EAAW,kBAAA,CAAmB,oBAAoB;AAAA;AACtD,YAEF;AAAC,OACP;AAAA,IACF;AACA,IAAA,IAAI,MAAA,CAAO,iBAAA,CAAkB,UAAU,CAAA,KAAM,KAAA,EAAO;AAClD,MAAA,MAAM,gBAAgB,IAAIC,kBAAA,CAAc,MAAA,CAAO,SAAA,CAAU,MAAM,CAAC,CAAA;AAChE,MAAA,MAAM,OAAA,GACJ,MAAA,CAAO,iBAAA,CAAkB,SAAS,KAAK,aAAA,CAAc,OAAA;AACvD,MAAA,IAAI,OAAA,KAAY,QAAQ,OAAA,KAAY,MAAA;AAClC,QAAA,MAAM,IAAI,KAAA,CAAM,CAAA,2BAAA,EAA8B,OAAO,CAAA,CAAE,CAAA;AACzD,MAAA,OAAO;AAAA,QACL,QAAA,EAAU,KAAA;AAAA,QACV,IAAA,EAAM,MAAA,CAAO,SAAA,CAAU,MAAM,CAAA;AAAA,QAC7B,MAAA,EAAQ,MAAA,CAAO,iBAAA,CAAkB,QAAQ,CAAA;AAAA,QACzC,OAAA;AAAA,QACA,GAAI,SAAA,GACA;AAAA,UACE,GAAA,EAAK;AAAA,YACH,kBAAA,EACE,SAAA,EAAW,kBAAA,CAAmB,oBAAoB;AAAA;AACtD,YAEF,EAAC;AAAA,QACL,GAAGC,kBAAA,CAAe;AAAA,UAChB,MAAA,EAAQ,MAAA,CAAO,iBAAA,CAAkB,QAAQ,KAAK,aAAA,CAAc,MAAA;AAAA;AAAA,UAC5D,OAAA;AAAA,UACA,cAAA,EAAgB,YACd,MAAM,kBAAA,CAAmB,qBAAA;AAAsB,SAClD;AAAA,OACH;AAAA,IACF;AACA,IAAA,IAAI,MAAA,CAAO,iBAAA,CAAkB,UAAU,CAAA,KAAM,YAAA,EAAc;AACzD,MAAA,MAAMF,WAAAA,GAAa,MAAA,CAAO,SAAA,CAAU,MAAM,CAAA;AAC1C,MAAA,OAAO;AAAA,QACL,QAAA,EAAU,YAAA;AAAA,QACV,IAAA,EAAM,MAAA,CAAO,SAAA,CAAU,MAAM,CAAA;AAAA,QAC7B,IAAA,EAAM;AAAA,UACJ,QAAA,EAAUA,WAAAA,CAAW,SAAA,CAAU,UAAU,CAAA;AAAA,UACzC,QAAA,EAAUA,WAAAA,CAAW,SAAA,CAAU,UAAU;AAAA,SAC3C;AAAA,QACA,GAAI,SAAA,GACA;AAAA,UACE,GAAA,EAAK;AAAA,YACH,kBAAA,EACE,SAAA,EAAW,kBAAA,CAAmB,oBAAoB;AAAA;AACtD,YAEF;AAAC,OACP;AAAA,IACF;AACA,IAAA,MAAM,UAAA,GAAa,MAAA,CAAO,iBAAA,CAAkB,MAAM,CAAA;AAClD,IAAA,MAAM,IAAA,GACJ,UAAA,KACC,UAAA,CAAW,GAAA,CAAI,QAAQ,CAAA,GACpB;AAAA,MACE,MAAA,EAAQ,UAAA,CAAW,SAAA,CAAU,QAAQ;AAAA,KACvC,GACA;AAAA,MACE,QAAA,EAAU,UAAA,CAAW,SAAA,CAAU,UAAU,CAAA;AAAA,MACzC,QAAA,EAAU,UAAA,CAAW,SAAA,CAAU,UAAU;AAAA,KAC3C,CAAA;AACN,IAAA,OAAO;AAAA,MACL,IAAA,EAAM,MAAA,CAAO,SAAA,CAAU,MAAM,CAAA;AAAA,MAC7B,IAAA;AAAA,MACA,GAAI,SAAA,GACA;AAAA,QACE,GAAA,EAAK;AAAA,UACH,kBAAA,EACE,SAAA,EAAW,kBAAA,CAAmB,oBAAoB;AAAA;AACtD,UAEF;AAAC,KACP;AAAA,EACF;AAAA,EAEA,OAAe,wBACb,MAAA,EACoC;AACpC,IAAA,OACE,MAAA,CAAO,sBAAA,CAAuB,gBAAgB,CAAA,EAAG,IAAI,CAAA,cAAA,KAAkB;AACrE,MAAA,MAAM,UAAA,GAAa,cAAA,CAAe,SAAA,CAAU,MAAM,CAAA;AAClD,MAAA,OAAO;AAAA,QACL,IAAA,EAAM,cAAA,CAAe,SAAA,CAAU,MAAM,CAAA;AAAA,QACrC,IAAA,EAAM;AAAA,UACJ,cAAA,EAAgB,UAAA,CAAW,cAAA,CAAe,gBAAgB,CAAA;AAAA,UAC1D,WAAA,EAAa,UAAA,CAAW,sBAAA,CAAuB,aAAa,CAAA;AAAA,UAC5D,QAAA,EAAU,UAAA,CAAW,iBAAA,CAAkB,UAAU,GAAG,GAAA;AAAI;AAC1D,OACF;AAAA,IACF,CAAC,KAAK,EAAC;AAAA,EAEX;AACF;AAKO,SAAS,iBAAiB,UAAA,EAAuC;AACtE,EAAA,IAAI,CAAC,UAAA,EAAY;AACf,IAAA,OAAO,EAAE,MAAM,CAAA,EAAE;AAAA,EACnB;AAEA,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,OAAO,MAAA,CAAO,IAAA,CAAK,YAAY,QAAQ,CAAA,CAAE,QAAA,CAAS,OAAO,CAAC;AAAA,GAClE;AACF;AAEO,SAAS,gBAAA,CAAiB,EAAE,IAAA,EAAK,EAA6B;AACnE,EAAA,OAAO,MAAA,CAAO,KAAK,CAAA,EAAG,IAAI,IAAI,OAAO,CAAA,CAAE,SAAS,QAAQ,CAAA;AAC1D;;;;;;"}
|
|
@@ -1 +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.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;;;;"}
|
|
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.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,cAAA,EAA0C;AAC1D,EAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,MAAA,CAAO,cAAc,CAAA;AAC3C,EAAA,MAAM,UAAU,KAAA,CAAM,CAAC,CAAA,GAAI,KAAA,CAAM,CAAC,CAAA,GAAI,GAAA;AACtC,EAAA,OAAO,CAAA,EAAG,OAAA,CAAQ,OAAA,CAAQ,CAAC,CAAC,CAAA,CAAA,CAAA;AAC9B;AAMO,MAAM,yCAAyCA,gDAAA,CAAyB;AAAA,EACrE,SAAA,GAAoB,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,OAAA,EAAkD;AAC5D,IAAA,KAAA,CAAM,EAAE,SAAA,EAAW,OAAA,CAAQ,SAAA,EAAW,CAAA;AACtC,IAAA,IAAA,CAAK,sBAAsB,OAAA,CAAQ,SAAA;AACnC,IAAA,IAAA,CAAK,MAAA,GAAS,QAAQ,MAAA,CAAO,KAAA,CAAM,EAAE,YAAA,EAAc,OAAA,CAAQ,MAAM,CAAA;AACjE,IAAA,IAAA,CAAK,cAAA,GAAiB,QAAQ,MAAA,EAAO;AACrC,IAAA,IAAA,CAAK,OAAO,OAAA,CAAQ,IAAA;AACpB,IAAA,IAAA,CAAK,cAAc,OAAA,CAAQ,WAAA;AAC3B,IAAA,IAAA,CAAK,iBAAiB,OAAA,CAAQ,cAAA;AAC9B,IAAA,IAAA,CAAK,YAAY,IAAA,CAAK,kBAAA,CAAmB,GAAG,IAAA,CAAK,GAAA,EAAK,CAAA,CAAE,CAAA;AACxD,IAAA,IAAA,CAAK,QAAQ,OAAA,CAAQ,KAAA;AACrB,IAAA,IAAA,CAAK,6BAA6B,OAAA,CAAQ,0BAAA;AAK1C,IAAA,IAAA,CAAK,eAAe,IAAIC,eAAA,CAAS,EAAE,UAAA,EAAY,MAAM,CAAA;AACrD,IAAA,IAAA,CAAK,YAAA,CAAa,QAAQ,MAAM;AAAA,IAAC,CAAA;AAGjC,IAAA,MAAM,IAAA,GAAO,IAAA;AAIb,IAAA,IAAA,CAAK,UAAA,GAAa,IAAA,CAAK,0BAAA,CAA2B,IAAA,CAAK;AAAA,MACrD,YAAY,IAAA,CAAK,YAAA;AAAA,MACjB,UAAA,GAAa;AACX,QAAA,IAAA,CAAK,SAAA,EAAA;AACL,QAAA,OAAO;AAAA,UACL,KAAA,EAAO,EAAE,MAAA,EAAQ,IAAA,CAAK,SAAA;AAAU,SAClC;AAAA,MACF,CAAA;AAAA,MACA,mBAAA,EAAqB,QAAQ,WAAA,KAAgB;AAAA,KAC9C,CAAA;AAGD,IAAA,IAAA,CAAK,UAAA,CAAW,MAAM,CAAA,CAAA,KAAK;AACzB,MAAA,IAAA,CAAK,eAAA,GAAkB,CAAA;AAAA,IACzB,CAAC,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,UAAA,GAA4B;AAChC,IAAA,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,CAAA,qCAAA,EAAwC,IAAA,CAAK,IAAI,CAAA,CAAE,CAAA;AAEpE,IAAA,MAAM,OAAA,GAAU,MAAM,IAAA,CAAK,0BAAA,CAA2B,WAAA,CAAY;AAAA,MAChE,KAAA,EAAO,IAAA,CAAK,kBAAA,CAAmB,GAAG;AAAA,KACnC,CAAA;AAED,IAAA,KAAA,MAAW,GAAA,IAAO,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,IAAI,CAAA,EAAG;AAC3C,MAAA,IAAA,CAAK,gBAAA,CAAiB,KAAK,GAAG,CAAA;AAAA,IAChC;AAEA,IAAA,MAAM,IAAA,CAAK,2BAA2B,WAAA,CAAY;AAAA,MAChD,OAAO,IAAA,CAAK;AAAA,KACb,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,MAAM,SAAA,EAA+C;AACzD,IAAA,MAAM,KAAK,OAAA,EAAQ;AACnB,IAAA,SAAA,CAAU,QAAQ,CAAA,QAAA,KAAY;AAC5B,MAAA,IAAA,CAAK,YAAA,CAAa,KAAK,QAAQ,CAAA;AAAA,IACjC,CAAC,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,QAAA,GAA0B;AAE9B,IAAA,MAAM,KAAK,OAAA,EAAQ;AAInB,IAAA,IAAA,CAAK,YAAA,CAAa,KAAK,IAAI,CAAA;AAG3B,IAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,UAAA;AAI1B,IAAA,IAAI,IAAA,CAAK,cAAc,CAAA,EAAG;AACxB,MAAA,IAAA,CAAK,MAAA,CAAO,IAAA;AAAA,QACV,CAAA,UAAA,EAAa,IAAA,CAAK,SAAS,CAAA,IAAA,EAAO,IAAA,CAAK,IAAI,CAAA,SAAA,EACzC,IAAA,CAAK,gBAAA,CAAiB,MAAA,GAAS,UAAA,GAAa,SAC9C,CAAA,8BAAA;AAAA,OACF;AACA,MAAA,IAAI;AACF,QAAA,MAAM,IAAA,CAAK,2BAA2B,WAAA,CAAY;AAAA,UAChD,OAAO,IAAA,CAAK;AAAA,SACb,CAAA;AAAA,MACH,SAAS,KAAA,EAAO;AACd,QAAA,IAAA,CAAK,MAAA,CAAO,KAAA,CAAM,CAAA,kCAAA,EAAqC,KAAK,CAAA,CAAE,CAAA;AAAA,MAChE;AACA,MAAA;AAAA,IACF;AAKA,IAAA,IAAA,CAAK,MAAA,CAAO,IAAA;AAAA,MACV,CAAA,6BAAA,EAAgC,IAAA,CAAK,SAAS,CAAA,IAAA,EAC5C,IAAA,CAAK,IACP,CAAA,IAAA,EAAO,QAAA,CAAS,IAAA,CAAK,cAAc,CAAC,CAAA,CAAA;AAAA,MACpC;AAAA,KACF;AACA,IAAA,MAAM,IAAA,CAAK,2BAA2B,aAAA,CAAc;AAAA,MAClD,OAAA,EAAS;AAAA,QACP;AAAA,UACE,MAAA,EAAQ,EAAE,KAAA,EAAO,IAAA,CAAK,mBAAmB,GAAG,CAAA,EAAG,KAAA,EAAO,IAAA,CAAK,KAAA;AAAM,SACnE;AAAA,QACA;AAAA,UACE,KAAK,EAAE,KAAA,EAAO,KAAK,SAAA,EAAW,KAAA,EAAO,KAAK,KAAA;AAAM;AAClD,OACF,CAAE,OAAO,OAAO;AAAA,KACjB,CAAA;AAID,IAAA,IAAI,IAAA,CAAK,iBAAiB,MAAA,EAAQ;AAChC,MAAA,IAAA,CAAK,MAAA,CAAO,KAAK,+BAAA,EAAiC;AAAA,QAChD,kBAAkB,IAAA,CAAK;AAAA,OACxB,CAAA;AAID,MAAA,MAAM,MAAA,GAAS,KAAK,gBAAA,CAAiB,MAAA;AAAA,QACnC,CAAC,WAAA,EAAa,IAAA,EAAM,KAAA,KAAU;AAC5B,UAAA,MAAM,UAAA,GAAa,IAAA,CAAK,KAAA,CAAM,KAAA,GAAQ,EAAE,CAAA;AAExC,UAAA,IAAI,CAAC,WAAA,CAAY,UAAU,CAAA,EAAG;AAC5B,YAAA,WAAA,CAAY,UAAU,IAAI,EAAC;AAAA,UAC7B;AAEA,UAAA,WAAA,CAAY,UAAU,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA;AAEjC,UAAA,OAAO,WAAA;AAAA,QACT,CAAA;AAAA,QACA;AAAC,OACH;AAGA,MAAA,KAAA,MAAW,SAAS,MAAA,EAAQ;AAC1B,QAAA,IAAI;AACF,UAAA,MAAM,IAAA,CAAK,2BAA2B,WAAA,CAAY;AAAA,YAChD,KAAA,EAAO;AAAA,WACR,CAAA;AAAA,QACH,SAAS,CAAA,EAAG;AACV,UAAA,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,CAAA,uCAAA,EAA0C,CAAC,CAAA,CAAE,CAAA;AAAA,QAChE;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,OAAA,GAAyB;AAE/B,IAAA,IAAI,KAAK,eAAA,EAAiB;AACxB,MAAA,OAAO,OAAA,CAAQ,MAAA,CAAO,IAAA,CAAK,eAAe,CAAA;AAAA,IAC5C;AAKA,IAAA,IAAI,IAAA,CAAK,YAAA,CAAa,cAAA,GAAiB,IAAA,CAAK,mBAAA,EAAqB;AAC/D,MAAA,OAAO,QAAQ,OAAA,EAAQ;AAAA,IACzB;AAIA,IAAA,OAAO,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,KAAA,KAAU;AACrC,MAAA,IAAI,kBAAA,GAAqB,CAAA;AACzB,MAAA,MAAM,QAAA,GAAW,YAAY,MAAM;AACjC,QAAA,kBAAA,EAAA;AAEA,QAAA,IAAI,IAAA,CAAK,YAAA,CAAa,cAAA,GAAiB,IAAA,CAAK,mBAAA,EAAqB;AAC/D,UAAA,aAAA,CAAc,QAAQ,CAAA;AACtB,UAAA,OAAA,EAAQ;AAAA,QACV;AAMA,QAAA,IAAI,sBAAsB,GAAA,EAAM;AAC9B,UAAA,aAAA,CAAc,QAAQ,CAAA;AACtB,UAAA,KAAA;AAAA,YACE,IAAI,KAAA;AAAA,cACF;AAAA;AACF,WACF;AAAA,QACF;AAAA,MACF,GAAG,EAAE,CAAA;AAAA,IACP,CAAC,CAAA;AAAA,EACH;AAAA,EAEQ,mBAAmB,OAAA,EAAiB;AAC1C,IAAA,OAAO,CAAA,EAAG,IAAA,CAAK,WAAW,CAAA,EAAG,IAAA,CAAK,IAAI,CAAA,EAAG,IAAA,CAAK,cAAc,CAAA,EAAG,OAAO,CAAA,CAAA;AAAA,EACxE;AACF;;;;"}
|
package/dist/module.cjs.js.map
CHANGED
|
@@ -1 +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 './engines/ElasticSearchSearchEngine';\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 initialization.',\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,
|
|
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 './engines/ElasticSearchSearchEngine';\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 initialization.',\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,qCAAA,CAAiE;AAAA,EAC/D,EAAA,EAAI;AACN,CAAC;AAOH,cAAeC,oCAAA,CAAoB;AAAA,EACjC,QAAA,EAAU,QAAA;AAAA,EACV,QAAA,EAAU,sBAAA;AAAA,EACV,SAAS,GAAA,EAAK;AACZ,IAAA,IAAI,UAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuB,qCAAA,EAAuC;AAAA,MAChE,cAAc,aAAA,EAAe;AAC3B,QAAA,IAAI,UAAA,EAAY;AACd,UAAA,MAAM,IAAI,KAAA;AAAA,YACR;AAAA,WACF;AAAA,QACF;AACA,QAAA,UAAA,GAAa,aAAA;AAAA,MACf;AAAA,KACD,CAAA;AAED,IAAA,GAAA,CAAI,YAAA,CAAa;AAAA,MACf,IAAA,EAAM;AAAA,QACJ,oBAAA,EAAsBC,wCAAA;AAAA,QACtB,QAAQC,6BAAA,CAAa,MAAA;AAAA,QACrB,QAAQA,6BAAA,CAAa;AAAA,OACvB;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,oBAAA,EAAsB,MAAA,EAAQ,QAAO,EAAG;AACnD,QAAA,MAAM,OAAA,GAAU,sBAAA;AAChB,QAAA,MAAM,UAAA,GAAa,MAAA,CAAO,WAAA,CAAY,OAAO,CAAA;AAC7C,QAAA,IAAI,CAAC,UAAA,EAAY;AACf,UAAA,MAAA,CAAO,IAAA;AAAA,YACL;AAAA,WACF;AACA,UAAA;AAAA,QACF;AACA,QAAA,MAAM,cAAc,MAAA,CAAO,iBAAA;AAAA,UACzB;AAAA,SACF;AACA,QAAA,IAAI,WAAA,EAAa;AACf,UAAA,MAAA,CAAO,IAAA,CAAK,CAAA,uCAAA,EAA0C,WAAW,CAAA,CAAE,CAAA;AAAA,QACrE;AACA,QAAA,oBAAA,CAAqB,eAAA;AAAA,UACnB,MAAMC,oDAA0B,UAAA,CAAW;AAAA,YACzC,MAAA;AAAA,YACA,MAAA;AAAA,YACA,UAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAAA,MACF;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC,CAAA;;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-search-backend-module-elasticsearch",
|
|
3
|
-
"version": "1.7.
|
|
3
|
+
"version": "1.7.5",
|
|
4
4
|
"description": "A module for the search backend that implements search using ElasticSearch",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "backend-plugin-module",
|
|
@@ -62,10 +62,10 @@
|
|
|
62
62
|
"test": "backstage-cli package test"
|
|
63
63
|
},
|
|
64
64
|
"dependencies": {
|
|
65
|
-
"@backstage/backend-plugin-api": "^1.4.
|
|
65
|
+
"@backstage/backend-plugin-api": "^1.4.2",
|
|
66
66
|
"@backstage/config": "^1.3.3",
|
|
67
67
|
"@backstage/integration-aws-node": "^0.1.17",
|
|
68
|
-
"@backstage/plugin-search-backend-node": "^1.3.
|
|
68
|
+
"@backstage/plugin-search-backend-node": "^1.3.14",
|
|
69
69
|
"@backstage/plugin-search-common": "^1.2.19",
|
|
70
70
|
"@elastic/elasticsearch": "^7.13.0",
|
|
71
71
|
"@opensearch-project/opensearch": "^2.2.1",
|
|
@@ -75,8 +75,8 @@
|
|
|
75
75
|
"uuid": "^11.0.0"
|
|
76
76
|
},
|
|
77
77
|
"devDependencies": {
|
|
78
|
-
"@backstage/backend-test-utils": "^1.
|
|
79
|
-
"@backstage/cli": "^0.
|
|
78
|
+
"@backstage/backend-test-utils": "^1.8.0",
|
|
79
|
+
"@backstage/cli": "^0.34.0",
|
|
80
80
|
"@elastic/elasticsearch-mock": "^1.0.0",
|
|
81
81
|
"@short.io/opensearch-mock": "^0.4.0"
|
|
82
82
|
},
|