[@kbn/securitysolution-es-utils] remove transport API in favour of typed public API (#113717) (#113831)

* remove transport API in favour of typed public API * put elasticsearch_client back * fix create index call * fix setpolicy * fix unit tests in SecuritySolution Co-authored-by: Mikhail Shustov <restrry@gmail.com>
2021-10-04 17:41:09 -04:00 · 2021-10-04 17:41:09 -04:00 · 9f95a44fe3
parent 4d80db3ad9
commit 9f95a44fe3
16 changed files with 28 additions and 50 deletions
--- a/packages/kbn-securitysolution-es-utils/src/create_boostrap_index/index.ts
+++ b/packages/kbn-securitysolution-es-utils/src/create_boostrap_index/index.ts
@ -6,7 +6,7 @@
 * Side Public License, v 1.
 */

-import { ElasticsearchClient } from '../elasticsearch_client';
+import type { ElasticsearchClient } from '../elasticsearch_client';

 // See the reference(s) below on explanations about why -000001 was chosen and
 // why the is_write_index is true as well as the bootstrapping step which is needed.
@ -16,9 +16,8 @@ export const createBootstrapIndex = async (
  index: string
 ): Promise<unknown> => {
  return (
-    await esClient.transport.request({
-      path: `/${index}-000001`,
-      method: 'PUT',
+    await esClient.indices.create({
+      index: `${index}-000001`,
      body: {
        aliases: {
          [index]: {
--- a/packages/kbn-securitysolution-es-utils/src/delete_all_index/index.ts
+++ b/packages/kbn-securitysolution-es-utils/src/delete_all_index/index.ts
@ -6,7 +6,7 @@
 * Side Public License, v 1.
 */

-import { ElasticsearchClient } from '../elasticsearch_client';
+import type { ElasticsearchClient } from '../elasticsearch_client';

 export const deleteAllIndex = async (
  esClient: ElasticsearchClient,
--- a/packages/kbn-securitysolution-es-utils/src/delete_policy/index.ts
+++ b/packages/kbn-securitysolution-es-utils/src/delete_policy/index.ts
@ -6,16 +6,14 @@
 * Side Public License, v 1.
 */

-import { ElasticsearchClient } from '../elasticsearch_client';
+import type { ElasticsearchClient } from '../elasticsearch_client';

 export const deletePolicy = async (
  esClient: ElasticsearchClient,
  policy: string
 ): Promise<unknown> => {
  return (
-    await esClient.transport.request({
-      path: `/_ilm/policy/${policy}`,
-      method: 'DELETE',
-    })
-  ).body;
+    // @ts-expect-error policy_id is required by mistake. fixed in the v8.0
+    (await esClient.ilm.deleteLifecycle({ policy })).body
+  );
 };
--- a/packages/kbn-securitysolution-es-utils/src/delete_template/index.ts
+++ b/packages/kbn-securitysolution-es-utils/src/delete_template/index.ts
@ -6,7 +6,7 @@
 * Side Public License, v 1.
 */

-import { ElasticsearchClient } from '../elasticsearch_client';
+import type { ElasticsearchClient } from '../elasticsearch_client';

 export const deleteTemplate = async (
  esClient: ElasticsearchClient,
--- a/packages/kbn-securitysolution-es-utils/src/elasticsearch_client/index.ts
+++ b/packages/kbn-securitysolution-es-utils/src/elasticsearch_client/index.ts
@ -10,12 +10,6 @@
 // as these types aren't part of any package yet. Once they are, remove this completely

 import type { KibanaClient } from '@elastic/elasticsearch/api/kibana';
-import type {
-  ApiResponse,
-  TransportRequestOptions,
-  TransportRequestParams,
-  TransportRequestPromise,
-} from '@elastic/elasticsearch/lib/Transport';

 /**
 * Client used to query the elasticsearch cluster.
@ -25,11 +19,4 @@ import type {
 export type ElasticsearchClient = Omit<
  KibanaClient,
  'connectionPool' | 'transport' | 'serializer' | 'extend' | 'child' | 'close'
-> & {
-  transport: {
-    request(
-      params: TransportRequestParams,
-      options?: TransportRequestOptions
-    ): TransportRequestPromise<ApiResponse>;
-  };
-};
+>;
--- a/packages/kbn-securitysolution-es-utils/src/get_index_aliases/index.ts
+++ b/packages/kbn-securitysolution-es-utils/src/get_index_aliases/index.ts
@ -6,7 +6,7 @@
 * Side Public License, v 1.
 */

-import { ElasticsearchClient } from '../elasticsearch_client';
+import type { ElasticsearchClient } from '../elasticsearch_client';

 interface AliasesResponse {
  [indexName: string]: {
--- a/packages/kbn-securitysolution-es-utils/src/get_index_count/index.ts
+++ b/packages/kbn-securitysolution-es-utils/src/get_index_count/index.ts
@ -6,7 +6,7 @@
 * Side Public License, v 1.
 */

-import { ElasticsearchClient } from '../elasticsearch_client';
+import type { ElasticsearchClient } from '../elasticsearch_client';

 /**
 * Retrieves the count of documents in a given index
--- a/packages/kbn-securitysolution-es-utils/src/get_index_exists/index.ts
+++ b/packages/kbn-securitysolution-es-utils/src/get_index_exists/index.ts
@ -6,7 +6,7 @@
 * Side Public License, v 1.
 */

-import { ElasticsearchClient } from '../elasticsearch_client';
+import type { ElasticsearchClient } from '../elasticsearch_client';

 export const getIndexExists = async (
  esClient: ElasticsearchClient,
--- a/packages/kbn-securitysolution-es-utils/src/get_policy_exists/index.ts
+++ b/packages/kbn-securitysolution-es-utils/src/get_policy_exists/index.ts
@ -5,17 +5,15 @@
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */
-
-import { ElasticsearchClient } from '../elasticsearch_client';
+import type { ElasticsearchClient } from '../elasticsearch_client';

 export const getPolicyExists = async (
  esClient: ElasticsearchClient,
  policy: string
 ): Promise<boolean> => {
  try {
-    await esClient.transport.request({
-      path: `/_ilm/policy/${policy}`,
-      method: 'GET',
+    await esClient.ilm.getLifecycle({
+      policy,
    });
    // Return true that there exists a policy which is not 404 or some error
    // Since there is not a policy exists API, this is how we create one by calling
--- a/packages/kbn-securitysolution-es-utils/src/get_template_exists/index.ts
+++ b/packages/kbn-securitysolution-es-utils/src/get_template_exists/index.ts
@ -6,7 +6,7 @@
 * Side Public License, v 1.
 */

-import { ElasticsearchClient } from '../elasticsearch_client';
+import type { ElasticsearchClient } from '../elasticsearch_client';

 export const getTemplateExists = async (
  esClient: ElasticsearchClient,
--- a/packages/kbn-securitysolution-es-utils/src/read_index/index.ts
+++ b/packages/kbn-securitysolution-es-utils/src/read_index/index.ts
@ -6,7 +6,7 @@
 * Side Public License, v 1.
 */

-import { ElasticsearchClient } from '../elasticsearch_client';
+import type { ElasticsearchClient } from '../elasticsearch_client';

 export const readIndex = async (esClient: ElasticsearchClient, index: string): Promise<unknown> => {
  return esClient.indices.get({
--- a/packages/kbn-securitysolution-es-utils/src/read_privileges/index.ts
+++ b/packages/kbn-securitysolution-es-utils/src/read_privileges/index.ts
@ -6,16 +6,14 @@
 * Side Public License, v 1.
 */

-import { ElasticsearchClient } from '../elasticsearch_client';
+import type { ElasticsearchClient } from '../elasticsearch_client';

 export const readPrivileges = async (
  esClient: ElasticsearchClient,
  index: string
 ): Promise<unknown> => {
  return (
-    await esClient.transport.request({
-      path: '/_security/user/_has_privileges',
-      method: 'POST',
+    await esClient.security.hasPrivileges({
      body: {
        cluster: [
          'all',
--- a/packages/kbn-securitysolution-es-utils/src/set_policy/index.ts
+++ b/packages/kbn-securitysolution-es-utils/src/set_policy/index.ts
@ -5,8 +5,7 @@
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */
-
-import { ElasticsearchClient } from '../elasticsearch_client';
+import type { ElasticsearchClient } from '../elasticsearch_client';

 export const setPolicy = async (
  esClient: ElasticsearchClient,
@ -14,9 +13,8 @@ export const setPolicy = async (
  body: Record<string, unknown>
 ): Promise<unknown> => {
  return (
-    await esClient.transport.request({
-      path: `/_ilm/policy/${policy}`,
-      method: 'PUT',
+    await esClient.ilm.putLifecycle({
+      policy,
      body,
    })
  ).body;
--- a/packages/kbn-securitysolution-es-utils/src/set_template/index.ts
+++ b/packages/kbn-securitysolution-es-utils/src/set_template/index.ts
@ -6,7 +6,7 @@
 * Side Public License, v 1.
 */

-import { ElasticsearchClient } from '../elasticsearch_client';
+import type { ElasticsearchClient } from '../elasticsearch_client';

 export const setTemplate = async (
  esClient: ElasticsearchClient,
--- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/mocks/request_context.ts
+++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/mocks/request_context.ts
@ -35,8 +35,8 @@ type SecuritySolutionRequestHandlerContextMock = SecuritySolutionRequestHandlerC
        asCurrentUser: {
          updateByQuery: jest.Mock;
          search: jest.Mock;
-          transport: {
-            request: jest.Mock;
+          security: {
+            hasPrivileges: jest.Mock;
          };
        };
      };
--- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/privileges/read_privileges_route.test.ts
+++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/privileges/read_privileges_route.test.ts
@ -19,7 +19,7 @@ describe('read_privileges route', () => {
    server = serverMock.create();
    ({ context } = requestContextMock.createTools());

-    context.core.elasticsearch.client.asCurrentUser.transport.request.mockResolvedValue({
+    context.core.elasticsearch.client.asCurrentUser.security.hasPrivileges.mockResolvedValue({
      body: getMockPrivilegesResult(),
    });

@ -65,7 +65,7 @@ describe('read_privileges route', () => {
    });

    test('returns 500 when bad response from cluster', async () => {
-      context.core.elasticsearch.client.asCurrentUser.transport.request.mockResolvedValue(
+      context.core.elasticsearch.client.asCurrentUser.security.hasPrivileges.mockResolvedValue(
        elasticsearchClientMock.createErrorTransportRequestPromise(new Error('Test error'))
      );
      const response = await server.inject(