Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Oct 4, 2021
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1f295c4
remove transport API in favour of typed public API
mshustov Oct 4, 2021
eae8675
put elasticsearch_client back
mshustov Oct 4, 2021
52ee43c
fix create index call
mshustov Oct 4, 2021
7c8c391
fix setpolicy
mshustov Oct 4, 2021
096ff33
fix unit tests in SecuritySolution
mshustov Oct 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions packages/kbn-securitysolution-es-utils/src/create_boostrap_index/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* Side Public License, v 1.
*/

import { ElasticsearchClient } from '../elasticsearch_client';
import type { ElasticsearchClient } from '../elasticsearch_client';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Thanks for the additional import type here.


// 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.
Expand All @@ -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]: {
Expand Down
2 changes: 1 addition & 1 deletion packages/kbn-securitysolution-es-utils/src/delete_all_index/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
10 changes: 4 additions & 6 deletions packages/kbn-securitysolution-es-utils/src/delete_policy/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see https://github.com/elastic/elasticsearch-js/blob/main/src/api/api/ilm.ts

);
};
2 changes: 1 addition & 1 deletion packages/kbn-securitysolution-es-utils/src/delete_template/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
15 changes: 1 addition & 14 deletions packages/kbn-securitysolution-es-utils/src/elasticsearch_client/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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>;
};
};
>;
2 changes: 1 addition & 1 deletion packages/kbn-securitysolution-es-utils/src/get_index_aliases/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* Side Public License, v 1.
*/

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

interface AliasesResponse {
[indexName: string]: {
Expand Down
2 changes: 1 addition & 1 deletion packages/kbn-securitysolution-es-utils/src/get_index_count/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/kbn-securitysolution-es-utils/src/get_index_exists/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
8 changes: 3 additions & 5 deletions packages/kbn-securitysolution-es-utils/src/get_policy_exists/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/kbn-securitysolution-es-utils/src/get_template_exists/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/kbn-securitysolution-es-utils/src/read_index/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand Down
6 changes: 2 additions & 4 deletions packages/kbn-securitysolution-es-utils/src/read_privileges/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
8 changes: 3 additions & 5 deletions packages/kbn-securitysolution-es-utils/src/set_policy/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,16 @@
* 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,
policy: string,
body: Record<string, unknown>
): Promise<unknown> => {
return (
await esClient.transport.request({
path: `/_ilm/policy/${policy}`,
method: 'PUT',
await esClient.ilm.putLifecycle({
policy,
body,
})
).body;
Expand Down
2 changes: 1 addition & 1 deletion packages/kbn-securitysolution-es-utils/src/set_template/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions ...plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ type SecuritySolutionRequestHandlerContextMock = SecuritySolutionRequestHandlerC
asCurrentUser: {
updateByQuery: jest.Mock;
search: jest.Mock;
transport: {
request: jest.Mock;
security: {
hasPrivileges: jest.Mock;
};
};
};
Expand Down
4 changes: 2 additions & 2 deletions ...rity_solution/server/lib/detection_engine/routes/privileges/read_privileges_route.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(),
});

Expand Down Expand Up @@ -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(
Expand Down