[KP] Expose new es client #73651

mshustov · 2020-07-29T09:58:57Z

Summary

This PR exposes new elasticsearch client to the plugins on the server-side. The new client is available via:

requestHandlerContext

router.get({ path: '...', validate: false }, async (context, request, response) => {
  const { body } = await context.core.elasticsearch.client.asInternalUser.search({..});
  //.. 
});

coreStart contract of the elasticsearch service:

start(code: CoreStart) {
  return {
    doSomething: async () => {
      const { body } = await context.core.elasticsearch.client.asInternalUser.search({..});
      return body;
    }
  }
}

Migration guide for the new elasticsearch client available in https://github.com/elastic/kibana/blob/master/src/core/MIGRATION_EXAMPLES.md#elasticsearch-client

The legacy client is going to be deprecated and removed in 7.x.

Checklist

Delete any items that are not applicable to this PR.

Unit or functional tests were updated or added to match the most common scenarios

For maintainers

This was checked for breaking API changes and was labeled appropriately

Dev Docs

Kibana provides the new elasticsearch client as a part of the elasticsearch service on the server-side. The legacy client is deprecated on and subject for removal in 7.x. Reference the provided migration guide to refactor your code https://github.com/elastic/kibana/blob/master/src/core/MIGRATION_EXAMPLES.md#elasticsearch-client

temp

elasticmachine · 2020-07-29T15:16:41Z

Pinging @elastic/kibana-platform (Team:Platform)

joshdover

LGTM, pretty simple expose change. Had one question about test coverage w/ security enabled, but it's possible we have similar coverage somewhere else that I am not aware of.

test/plugin_functional/plugins/elasticsearch_client_plugin/server/plugin.ts

mshustov · 2020-07-30T12:24:53Z

src/plugins/data/server/server.api.md

@@ -22,6 +22,7 @@ import { CatTasksParams } from 'elasticsearch';
 import { CatThreadPoolParams } from 'elasticsearch';
 import { ClearScrollParams } from 'elasticsearch';
 import { Client } from 'elasticsearch';
+import { ClientOptions } from '@elastic/elasticsearch';


no idea why it's here. it's not used in the file

🤷‍♂️

lukeelmers · 2020-07-30T13:45:37Z

src/plugins/data/server/server.api.md

@@ -22,6 +22,7 @@ import { CatTasksParams } from 'elasticsearch';
 import { CatThreadPoolParams } from 'elasticsearch';
 import { ClearScrollParams } from 'elasticsearch';
 import { Client } from 'elasticsearch';
+import { ClientOptions } from '@elastic/elasticsearch';


🤷‍♂️

kibanamachine · 2020-07-30T14:20:53Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 7567f3d

Build metrics

✅ unchanged

History

💛 Build #65179 was flaky 36dcf1d
💔 Build #65163 failed e4bbdf5
💔 Build #65156 failed 338954a
💔 Build #65137 failed cdc0d8d

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

* mark legacy ES client types as deprecated * expose es client to plugins and update mocks * ElasticSearchClientMock --> ElasticsearchClientMock * expose es client mocks * expose es client via RequestHandlerContext * convert test/plugin_functional/config into ts * convert top_nav test into ts * add an integration test for the es client * update comments to refer to the new es client * fix import paths. do not use extensions temp * update docs * fix other refs * add test for a custom client * fix context * add test for scoped client * update docs # Conflicts: # scripts/functional_tests.js

mshustov added 9 commits July 29, 2020 09:39

mark legacy ES client types as deprecated

f821d93

expose es client to plugins and update mocks

b713c46

ElasticSearchClientMock --> ElasticsearchClientMock

51cd31a

expose es client mocks

0f8986b

expose es client via RequestHandlerContext

5650ea2

convert test/plugin_functional/config into ts

2928a97

convert top_nav test into ts

56760ac

add an integration test for the es client

a33b3a4

update comments to refer to the new es client

cdc0d8d

mshustov added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. v7.10.0 labels Jul 29, 2020

mshustov added 3 commits July 29, 2020 13:11

Merge branch 'master' into expose-new-es-client

0c22381

fix import paths. do not use extensions

80af27a

temp

update docs

e4bbdf5

mshustov force-pushed the expose-new-es-client branch from 338954a to e4bbdf5 Compare July 29, 2020 12:00

mshustov added 2 commits July 29, 2020 14:21

fix other refs

91df00c

add test for a custom client

36dcf1d

mshustov added this to Pending Review in kibana-core [DEPRECATED] via automation Jul 29, 2020

epixa mentioned this pull request Jul 29, 2020

Use new elasticsearch-js client in Elasticsearch service #35508

Closed

14 tasks

mshustov marked this pull request as ready for review July 29, 2020 15:16

mshustov requested review from a team as code owners July 29, 2020 15:16

joshdover approved these changes Jul 29, 2020

View reviewed changes

test/plugin_functional/plugins/elasticsearch_client_plugin/server/plugin.ts Show resolved Hide resolved

mshustov added 3 commits July 30, 2020 14:17

fix context

5f936b3

add test for scoped client

92d87b5

Merge branch 'master' into expose-new-es-client

734967a

mshustov commented Jul 30, 2020

View reviewed changes

update docs

7567f3d

lukeelmers approved these changes Jul 30, 2020

View reviewed changes

mshustov merged commit 585d58c into elastic:master Jul 30, 2020

kibana-core [DEPRECATED] automation moved this from Pending Review to Done (7.10) Jul 30, 2020

mshustov deleted the expose-new-es-client branch July 30, 2020 17:12

mshustov mentioned this pull request Jul 30, 2020

[7.x] [KP] Expose new es client (#73651) #73840

Merged

zhongnansu mentioned this pull request Aug 3, 2020

Keeping up withe Kibana master branch causing issues for development opendistro-for-elasticsearch/kibana-reports#54

Closed

s-newman mentioned this pull request Oct 2, 2020

Use New Elasticsearch Client scorestack/scorestack#236

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[KP] Expose new es client #73651

[KP] Expose new es client #73651

mshustov commented Jul 29, 2020 •

edited

elasticmachine commented Jul 29, 2020

joshdover left a comment

mshustov Jul 30, 2020

lukeelmers Jul 30, 2020

lukeelmers Jul 30, 2020

kibanamachine commented Jul 30, 2020

[KP] Expose new es client #73651

[KP] Expose new es client #73651

Conversation

mshustov commented Jul 29, 2020 • edited

Summary

Checklist

For maintainers

Dev Docs

elasticmachine commented Jul 29, 2020

joshdover left a comment

Choose a reason for hiding this comment

mshustov Jul 30, 2020

Choose a reason for hiding this comment

lukeelmers Jul 30, 2020

Choose a reason for hiding this comment

lukeelmers Jul 30, 2020

Choose a reason for hiding this comment

kibanamachine commented Jul 30, 2020

💚 Build Succeeded

Build metrics

History

mshustov commented Jul 29, 2020 •

edited