Merge branch 'master' into fix/flaky-graph-53749

docs/developer/advanced/running-elasticsearch.asciidoc

@@ -13,6 +13,10 @@ This will run a snapshot of {es} that is usually built nightly. Read more about
 ----
 yarn es snapshot
 ----
+By default, two users are added to Elasticsearch:
+
+  - A superuser with username: `elastic` and password: `changeme`, which can be used to log into Kibana with.
+  - A user with username: `kibana_system` and password `changeme`. This account is used by the Kibana server to authenticate itself to Elasticsearch, and to perform certain actions on behalf of the end user. These credentials should be specified in your kibana.yml as described in <<using-kibana-with-security>>
 
 See all available options, like how to specify a specific license, with the `--help` flag.
 
@@ -115,4 +119,4 @@ PUT _cluster/settings
 }
 ----
 
-Follow the cross-cluster search instructions for setting up index patterns to search across clusters (<<management-cross-cluster-search>>).
+Follow the cross-cluster search instructions for setting up index patterns to search across clusters (<<management-cross-cluster-search>>).

packages/kbn-spec-to-console/README.md

@@ -23,10 +23,10 @@ At the root of the Kibana repository, run the following commands:
 
 ```sh
 # OSS
-yarn spec_to_console -g "<ELASTICSEARCH-REPO-FOLDER>/rest-api-spec/src/main/resources/rest-api-spec/api/*" -d "src/plugins/console/server/lib/spec_definitions/json"
+yarn spec_to_console -g "<ELASTICSEARCH-REPO-FOLDER>/rest-api-spec/src/main/resources/rest-api-spec/api/*" -d "src/plugins/console/server/lib/spec_definitions/json/generated"
 
 # X-pack
-yarn spec_to_console -g "<ELASTICSEARCH-REPO-FOLDER>/x-pack/plugin/src/test/resources/rest-api-spec/api/*" -d "x-pack/plugins/console_extensions/server/lib/spec_definitions/json"
+yarn spec_to_console -g "<ELASTICSEARCH-REPO-FOLDER>/x-pack/plugin/src/test/resources/rest-api-spec/api/*" -d "x-pack/plugins/console_extensions/server/lib/spec_definitions/json/generated"
 ```
 
 ### Information used in Console that is not available in the REST spec

src/core/server/elasticsearch/client/configure_client.test.ts

@@ -118,26 +118,40 @@ describe('configureClient', () => {
   });
 
   describe('Client logging', () => {
-    it('logs error when the client emits an error', () => {
+    it('logs error when the client emits an @elastic/elasticsearch error', () => {
+      const client = configureClient(config, { logger, scoped: false });
+
+      const response = createApiResponse({ body: {} });
+      client.emit('response', new errors.TimeoutError('message', response), response);
+
+      expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
+        Array [
+          Array [
+            "[TimeoutError]: message",
+          ],
+        ]
+      `);
+    });
+
+    it('logs error when the client emits an ResponseError returned by elasticsearch', () => {
       const client = configureClient(config, { logger, scoped: false });
 
       const response = createApiResponse({
+        statusCode: 400,
+        headers: {},
         body: {
           error: {
-            type: 'error message',
+            type: 'illegal_argument_exception',
+            reason: 'request [/_path] contains unrecognized parameter: [name]',
           },
         },
       });
-      client.emit('response', new errors.ResponseError(response), null);
-      client.emit('response', new Error('some error'), null);
+      client.emit('response', new errors.ResponseError(response), response);
 
       expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
         Array [
           Array [
-            "ResponseError: error message",
-          ],
-          Array [
-            "Error: some error",
+            "[illegal_argument_exception]: request [/_path] contains unrecognized parameter: [name]",
           ],
         ]
       `);

src/core/server/elasticsearch/client/configure_client.ts

@@ -21,6 +21,7 @@ import { stringify } from 'querystring';
 import { Client } from '@elastic/elasticsearch';
 import { Logger } from '../../logging';
 import { parseClientOptions, ElasticsearchClientConfig } from './client_config';
+import { isResponseError } from './errors';
 
 export const configureClient = (
   config: ElasticsearchClientConfig,
@@ -35,9 +36,15 @@ export const configureClient = (
 };
 
 const addLogging = (client: Client, logger: Logger, logQueries: boolean) => {
-  client.on('response', (err, event) => {
-    if (err) {
-      logger.error(`${err.name}: ${err.message}`);
+  client.on('response', (error, event) => {
+    if (error) {
+      const errorMessage =
+        // error details for response errors provided by elasticsearch
+        isResponseError(error)
+          ? `[${event.body.error.type}]: ${event.body.error.reason}`
+          : `[${error.name}]: ${error.message}`;
+
+      logger.error(errorMessage);
     }
     if (event && logQueries) {
       const params = event.meta.request.params;

src/core/server/elasticsearch/client/index.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-export { ElasticsearchClient } from './types';
+export * from './types';
 export { IScopedClusterClient, ScopedClusterClient } from './scoped_cluster_client';
 export { ElasticsearchClientConfig } from './client_config';
 export { IClusterClient, ICustomClusterClient, ClusterClient } from './cluster_client';

src/core/server/elasticsearch/client/mocks.ts

@@ -45,7 +45,7 @@ const createInternalClientMock = (): DeeplyMockedKeys<Client> => {
       .forEach((key) => {
         const propType = typeof obj[key];
         if (propType === 'function') {
-          obj[key] = jest.fn();
+          obj[key] = jest.fn(() => createSuccessTransportRequestPromise({}));
         } else if (propType === 'object' && obj[key] != null) {
           mockify(obj[key]);
         }
@@ -70,6 +70,7 @@ const createInternalClientMock = (): DeeplyMockedKeys<Client> => {
   return (mock as unknown) as DeeplyMockedKeys<Client>;
 };
 
+// TODO fix naming ElasticsearchClientMock
 export type ElasticSearchClientMock = DeeplyMockedKeys<ElasticsearchClient>;
 
 const createClientMock = (): ElasticSearchClientMock =>
@@ -124,32 +125,41 @@ export type MockedTransportRequestPromise<T> = TransportRequestPromise<T> & {
   abort: jest.MockedFunction<() => undefined>;
 };
 
-const createMockedClientResponse = <T>(body: T): MockedTransportRequestPromise<ApiResponse<T>> => {
-  const response: ApiResponse<T> = {
-    body,
-    statusCode: 200,
-    warnings: [],
-    headers: {},
-    meta: {} as any,
-  };
+const createSuccessTransportRequestPromise = <T>(
+  body: T,
+  { statusCode = 200 }: { statusCode?: number } = {}
+): MockedTransportRequestPromise<ApiResponse<T>> => {
+  const response = createApiResponse({ body, statusCode });
   const promise = Promise.resolve(response);
   (promise as MockedTransportRequestPromise<ApiResponse<T>>).abort = jest.fn();
 
   return promise as MockedTransportRequestPromise<ApiResponse<T>>;
 };
 
-const createMockedClientError = (err: any): MockedTransportRequestPromise<never> => {
+const createErrorTransportRequestPromise = (err: any): MockedTransportRequestPromise<never> => {
   const promise = Promise.reject(err);
   (promise as MockedTransportRequestPromise<never>).abort = jest.fn();
   return promise as MockedTransportRequestPromise<never>;
 };
 
+function createApiResponse(opts: Partial<ApiResponse> = {}): ApiResponse {
+  return {
+    body: {},
+    statusCode: 200,
+    headers: {},
+    warnings: [],
+    meta: {} as any,
+    ...opts,
+  };
+}
+
 export const elasticsearchClientMock = {
   createClusterClient: createClusterClientMock,
   createCustomClusterClient: createCustomClusterClientMock,
   createScopedClusterClient: createScopedClusterClientMock,
   createElasticSearchClient: createClientMock,
   createInternalClient: createInternalClientMock,
-  createClientResponse: createMockedClientResponse,
-  createClientError: createMockedClientError,
+  createSuccessTransportRequestPromise,
+  createErrorTransportRequestPromise,
+  createApiResponse,
 };

src/core/server/elasticsearch/client/retry_call_cluster.test.ts

@@ -23,7 +23,8 @@ import { loggingSystemMock } from '../../logging/logging_system.mock';
 import { retryCallCluster, migrationRetryCallCluster } from './retry_call_cluster';
 
 const dummyBody = { foo: 'bar' };
-const createErrorReturn = (err: any) => elasticsearchClientMock.createClientError(err);
+const createErrorReturn = (err: any) =>
+  elasticsearchClientMock.createErrorTransportRequestPromise(err);
 
 describe('retryCallCluster', () => {
   let client: ReturnType<typeof elasticsearchClientMock.createElasticSearchClient>;
@@ -33,7 +34,9 @@ describe('retryCallCluster', () => {
   });
 
   it('returns response from ES API call in case of success', async () => {
-    const successReturn = elasticsearchClientMock.createClientResponse({ ...dummyBody });
+    const successReturn = elasticsearchClientMock.createSuccessTransportRequestPromise({
+      ...dummyBody,
+    });
 
     client.asyncSearch.get.mockReturnValue(successReturn);
 
@@ -42,7 +45,9 @@ describe('retryCallCluster', () => {
   });
 
   it('retries ES API calls that rejects with `NoLivingConnectionsError`', async () => {
-    const successReturn = elasticsearchClientMock.createClientResponse({ ...dummyBody });
+    const successReturn = elasticsearchClientMock.createSuccessTransportRequestPromise({
+      ...dummyBody,
+    });
 
     client.asyncSearch.get
       .mockImplementationOnce(() =>
@@ -57,7 +62,9 @@ describe('retryCallCluster', () => {
   it('rejects when ES API calls reject with other errors', async () => {
     client.ping
       .mockImplementationOnce(() => createErrorReturn(new Error('unknown error')))
-      .mockImplementationOnce(() => elasticsearchClientMock.createClientResponse({ ...dummyBody }));
+      .mockImplementationOnce(() =>
+        elasticsearchClientMock.createSuccessTransportRequestPromise({ ...dummyBody })
+      );
 
     await expect(retryCallCluster(() => client.ping())).rejects.toMatchInlineSnapshot(
       `[Error: unknown error]`
@@ -73,7 +80,9 @@ describe('retryCallCluster', () => {
         createErrorReturn(new errors.NoLivingConnectionsError('no living connections', {} as any))
       )
       .mockImplementationOnce(() => createErrorReturn(new Error('unknown error')))
-      .mockImplementationOnce(() => elasticsearchClientMock.createClientResponse({ ...dummyBody }));
+      .mockImplementationOnce(() =>
+        elasticsearchClientMock.createSuccessTransportRequestPromise({ ...dummyBody })
+      );
 
     await expect(retryCallCluster(() => client.ping())).rejects.toMatchInlineSnapshot(
       `[Error: unknown error]`
@@ -94,7 +103,9 @@ describe('migrationRetryCallCluster', () => {
     client.ping
       .mockImplementationOnce(() => createErrorReturn(error))
       .mockImplementationOnce(() => createErrorReturn(error))
-      .mockImplementationOnce(() => elasticsearchClientMock.createClientResponse({ ...dummyBody }));
+      .mockImplementationOnce(() =>
+        elasticsearchClientMock.createSuccessTransportRequestPromise({ ...dummyBody })
+      );
   };
 
   it('retries ES API calls that rejects with `NoLivingConnectionsError`', async () => {
@@ -225,7 +236,9 @@ describe('migrationRetryCallCluster', () => {
           } as any)
         )
       )
-      .mockImplementationOnce(() => elasticsearchClientMock.createClientResponse({ ...dummyBody }));
+      .mockImplementationOnce(() =>
+        elasticsearchClientMock.createSuccessTransportRequestPromise({ ...dummyBody })
+      );
 
     await migrationRetryCallCluster(() => client.ping(), logger, 1);
 
@@ -258,7 +271,9 @@ describe('migrationRetryCallCluster', () => {
           } as any)
         )
       )
-      .mockImplementationOnce(() => elasticsearchClientMock.createClientResponse({ ...dummyBody }));
+      .mockImplementationOnce(() =>
+        elasticsearchClientMock.createSuccessTransportRequestPromise({ ...dummyBody })
+      );
 
     await expect(
       migrationRetryCallCluster(() => client.ping(), logger, 1)
@@ -274,7 +289,9 @@ describe('migrationRetryCallCluster', () => {
         createErrorReturn(new errors.TimeoutError('timeout error', {} as any))
       )
       .mockImplementationOnce(() => createErrorReturn(new Error('unknown error')))
-      .mockImplementationOnce(() => elasticsearchClientMock.createClientResponse({ ...dummyBody }));
+      .mockImplementationOnce(() =>
+        elasticsearchClientMock.createSuccessTransportRequestPromise({ ...dummyBody })
+      );
 
     await expect(
       migrationRetryCallCluster(() => client.ping(), logger, 1)

src/core/server/elasticsearch/client/retry_call_cluster.ts

@@ -27,7 +27,7 @@ const retryResponseStatuses = [
   403, // AuthenticationException
   408, // RequestTimeout
   410, // Gone
-];
+] as const;
 
 /**
  * Retries the provided Elasticsearch API call when a `NoLivingConnectionsError` error is

src/core/server/elasticsearch/client/types.ts

@@ -41,3 +41,83 @@ export type ElasticsearchClient = Omit<
     ): TransportRequestPromise<ApiResponse>;
   };
 };
+
+interface ShardsResponse {
+  total: number;
+  successful: number;
+  failed: number;
+  skipped: number;
+}
+
+interface Explanation {
+  value: number;
+  description: string;
+  details: Explanation[];
+}
+
+interface ShardsInfo {
+  total: number;
+  successful: number;
+  skipped: number;
+  failed: number;
+}
+
+export interface CountResponse {
+  _shards: ShardsInfo;
+  count: number;
+}
+
+/**
+ * Maintained until elasticsearch provides response typings out of the box
+ * https://github.com/elastic/elasticsearch-js/pull/970
+ */
+export interface SearchResponse<T = unknown> {
+  took: number;
+  timed_out: boolean;
+  _scroll_id?: string;
+  _shards: ShardsResponse;
+  hits: {
+    total: number;
+    max_score: number;
+    hits: Array<{
+      _index: string;
+      _type: string;
+      _id: string;
+      _score: number;
+      _source: T;
+      _version?: number;
+      _explanation?: Explanation;
+      fields?: any;
+      highlight?: any;
+      inner_hits?: any;
+      matched_queries?: string[];
+      sort?: string[];
+    }>;
+  };
+  aggregations?: any;
+}
+
+export interface GetResponse<T> {
+  _index: string;
+  _type: string;
+  _id: string;
+  _version: number;
+  _routing?: string;
+  found: boolean;
+  _source: T;
+  _seq_no: number;
+  _primary_term: number;
+}
+
+export interface DeleteDocumentResponse {
+  _shards: ShardsResponse;
+  found: boolean;
+  _index: string;
+  _type: string;
+  _id: string;
+  _version: number;
+  result: string;
+  error?: {
+    type: string;
+  };
+}