From c80d547dff681ab72eeccbd63f52e9dceb58304b Mon Sep 17 00:00:00 2001
From: Eric Peterson <ericpeterson@spotify.com>
Date: Fri, 8 Jul 2022 12:17:18 +0200
Subject: [PATCH] Ignore most likely irrelevant typescript issues.

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
---
 .../api-report.md                             | 30 ++++++++++++++-----
 .../ElasticSearchClientWrapper.test.ts        |  3 ++
 .../src/engines/ElasticSearchSearchEngine.ts  |  3 ++
 3 files changed, 29 insertions(+), 7 deletions(-)

diff --git a/plugins/search-backend-module-elasticsearch/api-report.md b/plugins/search-backend-module-elasticsearch/api-report.md
index eed2b1b10a..ff474fc9bf 100644
--- a/plugins/search-backend-module-elasticsearch/api-report.md
+++ b/plugins/search-backend-module-elasticsearch/api-report.md
@@ -6,6 +6,7 @@
 /// <reference types="node" />
 
 import { ApiResponse } from '@opensearch-project/opensearch';
+import { ApiResponse as ApiResponse_2 } from '@elastic/elasticsearch';
 import { BatchSearchEngineIndexer } from '@backstage/plugin-search-backend-node';
 import { BulkHelper } from '@opensearch-project/opensearch/lib/Helpers';
 import { BulkStats } from '@opensearch-project/opensearch/lib/Helpers';
@@ -18,6 +19,7 @@ import { Readable } from 'stream';
 import { SearchEngine } from '@backstage/plugin-search-common';
 import { SearchQuery } from '@backstage/plugin-search-common';
 import { TransportRequestPromise } from '@opensearch-project/opensearch/lib/Transport';
+import { TransportRequestPromise as TransportRequestPromise_2 } from '@elastic/elasticsearch/lib/Transport';
 
 // @public
 export interface BaseElasticSearchClientOptions {
@@ -134,13 +136,17 @@ export class ElasticSearchClientWrapper {
     index,
   }: {
     index: string;
-  }): TransportRequestPromise<ApiResponse<Record<string, any>, unknown>>;
+  }):
+    | TransportRequestPromise<ApiResponse<Record<string, any>, unknown>>
+    | TransportRequestPromise_2<ApiResponse_2<Record<string, any>, unknown>>;
   // (undocumented)
   deleteIndex({
     index,
   }: {
     index: string | string[];
-  }): TransportRequestPromise<ApiResponse<Record<string, any>, unknown>>;
+  }):
+    | TransportRequestPromise<ApiResponse<Record<string, any>, unknown>>
+    | TransportRequestPromise_2<ApiResponse_2<Record<string, any>, unknown>>;
   // (undocumented)
   static fromClientOptions(
     options: ElasticSearchClientOptions,
@@ -150,17 +156,23 @@ export class ElasticSearchClientWrapper {
     aliases,
   }: {
     aliases: string[];
-  }): TransportRequestPromise<ApiResponse<Record<string, any>, unknown>>;
+  }):
+    | TransportRequestPromise<ApiResponse<Record<string, any>, unknown>>
+    | TransportRequestPromise_2<ApiResponse_2<Record<string, any>, unknown>>;
   // (undocumented)
   indexExists({
     index,
   }: {
     index: string | string[];
-  }): TransportRequestPromise<ApiResponse<boolean, unknown>>;
+  }):
+    | TransportRequestPromise<ApiResponse<boolean, unknown>>
+    | TransportRequestPromise_2<ApiResponse_2<boolean, unknown>>;
   // (undocumented)
   putIndexTemplate(
     template: ElasticSearchCustomIndexTemplate,
-  ): TransportRequestPromise<ApiResponse<Record<string, any>, unknown>>;
+  ):
+    | TransportRequestPromise<ApiResponse<Record<string, any>, unknown>>
+    | TransportRequestPromise_2<ApiResponse_2<Record<string, any>, unknown>>;
   // (undocumented)
   search({
     index,
@@ -168,13 +180,17 @@ export class ElasticSearchClientWrapper {
   }: {
     index: string | string[];
     body: Object;
-  }): TransportRequestPromise<ApiResponse<Record<string, any>, unknown>>;
+  }):
+    | TransportRequestPromise<ApiResponse<Record<string, any>, unknown>>
+    | TransportRequestPromise_2<ApiResponse_2<Record<string, any>, unknown>>;
   // (undocumented)
   updateAliases({
     actions,
   }: {
     actions: ElasticSearchAliasAction[];
-  }): TransportRequestPromise<ApiResponse<Record<string, any>, unknown>>;
+  }):
+    | TransportRequestPromise<ApiResponse<Record<string, any>, unknown>>
+    | TransportRequestPromise_2<ApiResponse_2<Record<string, any>, unknown>>;
 }
 
 // @public
diff --git a/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchClientWrapper.test.ts b/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchClientWrapper.test.ts
index 5bd8bb30b0..cbed4f4442 100644
--- a/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchClientWrapper.test.ts
+++ b/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchClientWrapper.test.ts
@@ -224,6 +224,9 @@ describe('ElasticSearchClientWrapper', () => {
       osOptions = {
         provider: 'aws',
         node: 'https://my-es-cluster.eu-west-1.es.amazonaws.com',
+        // todo(backstage/techdocs-core): Remove the following ts-ignore when
+        // @short.io/opensearch-mock is updated to work w/opensearch >= 2.0.0
+        // @ts-ignore
         connection: mock.getConnection(),
       };
 
diff --git a/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts b/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts
index 42c99dfe61..cf0b4f441c 100644
--- a/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts
+++ b/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts
@@ -408,6 +408,9 @@ export async function createElasticSearchClientOptions(
     const AWSConnection = createAWSConnection(awsCredentials);
     return {
       provider: 'aws',
+      // todo(backstage/techdocs-core): Remove the following ts-ignore when
+      // aws-os-connection is updated to work with opensearch >= 2.0.0
+      // @ts-ignore
       node: config.getString('node'),
       ...AWSConnection,
       ...(sslConfig