[Discover] Inline shard failures warnings

src/plugins/data/common/search/search_source/search_source.ts

@@ -543,6 +543,8 @@ export class SearchSource {
 
     return search({ params, indexType: searchRequest.indexType }, options).pipe(
       switchMap((response) => {
+        // For testing timeout messages in UI, uncomment the next line
+        // response.rawResponse.timed_out = true;
         return new Observable<IKibanaSearchResponse<unknown>>((obs) => {
           if (isErrorResponse(response)) {
             obs.error(response);
@@ -916,6 +918,20 @@ export class SearchSource {
     };
     body.query = buildEsQuery(index, query, filters, esQueryConfigs);
 
+    // For testing shard failure messages in UI, uncomment the next block
+    // body.query = {
+    //   error_query: {
+    //     indices: [
+    //       {
+    //         name: 'kibana_sample_data_logs',
+    //         shard_ids: [0, 1],
+    //         error_type: 'exception',
+    //         message: 'Testing shard failures!',
+    //       },
+    //     ],
+    //   },
+    // };
+
     if (highlightAll && body.query) {
       body.highlight = getHighlightRequest(getConfig(UI_SETTINGS.DOC_HIGHLIGHT));
       delete searchRequest.highlightAll;

src/plugins/discover/common/constants.ts

@@ -12,3 +12,5 @@ export enum VIEW_MODE {
   DOCUMENT_LEVEL = 'documents',
   AGGREGATED_LEVEL = 'aggregated',
 }
+
+export const DISABLE_SHARD_FAILURE_WARNING = true;

src/plugins/discover/public/__mocks__/search_response_warnings.ts

@@ -0,0 +1,50 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { SearchResponseWarning } from '@kbn/data-plugin/public';
+
+export const searchResponseTimeoutWarningMock: SearchResponseWarning = {
+  type: 'timed_out',
+  message: 'Data might be incomplete because your request timed out',
+  reason: undefined,
+};
+
+export const searchResponseShardFailureWarningMock: SearchResponseWarning = {
+  type: 'shard_failure',
+  message: '3 of 4 shards failed',
+  text: 'The data might be incomplete or wrong.',
+  reason: {
+    type: 'illegal_argument_exception',
+    reason: 'Field [__anonymous_] of type [boolean] does not support custom formats',
+  },
+};
+
+export const searchResponseWarningsMock: SearchResponseWarning[] = [
+  searchResponseTimeoutWarningMock,
+  searchResponseShardFailureWarningMock,
+  {
+    type: 'shard_failure',
+    message: '3 of 4 shards failed',
+    text: 'The data might be incomplete or wrong.',
+    reason: {
+      type: 'query_shard_exception',
+      reason:
+        'failed to create query: [.ds-kibana_sample_data_logs-2023.07.11-000001][0] Testing shard failures!',
+    },
+  },
+  {
+    type: 'shard_failure',
+    message: '1 of 4 shards failed',
+    text: 'The data might be incomplete or wrong.',
+    reason: {
+      type: 'query_shard_exception',
+      reason:
+        'failed to create query: [.ds-kibana_sample_data_logs-2023.07.11-000001][0] Testing shard failures!',
+    },
+  },
+];

src/plugins/discover/public/application/context/context_app.tsx

@@ -30,6 +30,7 @@ import { SurrDocType } from './services/context';
 import { DocViewFilterFn } from '../../services/doc_views/doc_views_types';
 import { useDiscoverServices } from '../../hooks/use_discover_services';
 import { getRootBreadcrumbs } from '../../utils/breadcrumbs';
+import { removeInterceptedWarningDuplicates } from '../../utils/get_search_response_intercepted_warnings';
 
 const ContextAppContentMemoized = memo(ContextAppContent);
 
@@ -172,6 +173,20 @@ export const ContextApp = ({ dataView, anchorId, referrer }: ContextAppProps) =>
     [fetchedState.predecessors, fetchedState.anchor, fetchedState.successors]
   );
 
+  const interceptedWarnings = useMemo(
+    () =>
+      removeInterceptedWarningDuplicates([
+        ...(fetchedState.predecessorsInterceptedWarnings || []),
+        ...(fetchedState.anchorInterceptedWarnings || []),
+        ...(fetchedState.successorsInterceptedWarnings || []),
+      ]),
+    [
+      fetchedState.predecessorsInterceptedWarnings,
+      fetchedState.anchorInterceptedWarnings,
+      fetchedState.successorsInterceptedWarnings,
+    ]
+  );
+
   const addFilter = useCallback(
     async (field: DataViewField | string, values: unknown, operation: string) => {
       const newFilters = generateFilters(filterManager, field, values, operation, dataView);
@@ -251,6 +266,7 @@ export const ContextApp = ({ dataView, anchorId, referrer }: ContextAppProps) =>
                 anchorStatus={fetchedState.anchorStatus.value}
                 predecessorsStatus={fetchedState.predecessorsStatus.value}
                 successorsStatus={fetchedState.successorsStatus.value}
+                interceptedWarnings={interceptedWarnings}
               />
             </EuiPageBody>
           </EuiPage>

src/plugins/discover/public/application/context/context_app_content.tsx

@@ -8,7 +8,7 @@
 
 import React, { useState, Fragment, useMemo, useCallback } from 'react';
 import { FormattedMessage } from '@kbn/i18n-react';
-import { EuiHorizontalRule, EuiText } from '@elastic/eui';
+import { EuiHorizontalRule, EuiSpacer, EuiText } from '@elastic/eui';
 import type { DataView } from '@kbn/data-views-plugin/public';
 import { SortDirection } from '@kbn/data-plugin/public';
 import type { SortOrder } from '@kbn/saved-search-plugin/public';
@@ -23,9 +23,10 @@ import { SurrDocType } from './services/context';
 import { MAX_CONTEXT_SIZE, MIN_CONTEXT_SIZE } from './services/constants';
 import { DocTableContext } from '../../components/doc_table/doc_table_context';
 import { useDiscoverServices } from '../../hooks/use_discover_services';
-import type { DataTableRecord } from '../../types';
+import type { DataTableRecord, SearchResponseInterceptedWarning } from '../../types';
 import { DiscoverGridFlyout } from '../../components/discover_grid/discover_grid_flyout';
 import { DocViewer } from '../../services/doc_views/components/doc_viewer';
+import { WarningsCallout } from '../../components/common/warnings_callout';
 
 export interface ContextAppContentProps {
   columns: string[];
@@ -41,6 +42,7 @@ export interface ContextAppContentProps {
   anchorStatus: LoadingStatus;
   predecessorsStatus: LoadingStatus;
   successorsStatus: LoadingStatus;
+  interceptedWarnings: SearchResponseInterceptedWarning[] | undefined;
   useNewFieldsApi: boolean;
   isLegacy: boolean;
   setAppState: (newState: Partial<AppState>) => void;
@@ -71,6 +73,7 @@ export function ContextAppContent({
   anchorStatus,
   predecessorsStatus,
   successorsStatus,
+  interceptedWarnings,
   useNewFieldsApi,
   isLegacy,
   setAppState,
@@ -118,6 +121,16 @@ export function ContextAppContent({
 
   return (
     <Fragment>
+      {!!interceptedWarnings?.length && (
+        <>
+          <WarningsCallout
+            variant="inline"
+            interceptedWarnings={interceptedWarnings}
+            data-test-subj="dscContextInterceptedWarnings"
+          />
+          <EuiSpacer size="s" />
+        </>
+      )}
       <ActionBarMemoized
         type={SurrDocType.PREDECESSORS}
         defaultStepSize={defaultStepSize}

src/plugins/discover/public/application/context/hooks/use_context_app_fetch.test.tsx

@@ -19,13 +19,20 @@ import {
   mockSuccessorHits,
 } from '../__mocks__/use_context_app_fetch';
 import { dataViewWithTimefieldMock } from '../../../__mocks__/data_view_with_timefield';
+import { searchResponseWarningsMock } from '../../../__mocks__/search_response_warnings';
 import { createContextSearchSourceStub } from '../services/_stubs';
 import { DataView } from '@kbn/data-views-plugin/public';
 import { themeServiceMock } from '@kbn/core/public/mocks';
 import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public';
 
+const mockInterceptedWarnings = searchResponseWarningsMock.map((originalWarning) => ({
+  originalWarning,
+}));
+
 const mockFilterManager = createFilterManagerMock();
 
+let mockOverrideInterceptedWarnings = false;
+
 jest.mock('../services/context', () => {
   const originalModule = jest.requireActual('../services/context');
   return {
@@ -35,7 +42,12 @@ jest.mock('../services/context', () => {
       if (!dataView || !dataView.id) {
         throw new Error();
       }
-      return type === 'predecessors' ? mockPredecessorHits : mockSuccessorHits;
+      return {
+        rows: type === 'predecessors' ? mockPredecessorHits : mockSuccessorHits,
+        interceptedWarnings: mockOverrideInterceptedWarnings
+          ? [mockInterceptedWarnings[type === 'predecessors' ? 0 : 1]]
+          : undefined,
+      };
     },
   };
 });
@@ -45,7 +57,12 @@ jest.mock('../services/anchor', () => ({
     if (!dataView.id || !anchorId) {
       throw new Error();
     }
-    return mockAnchorHit;
+    return {
+      anchorRow: mockAnchorHit,
+      interceptedWarnings: mockOverrideInterceptedWarnings
+        ? [mockInterceptedWarnings[2]]
+        : undefined,
+    };
   },
 }));
 
@@ -118,6 +135,9 @@ describe('test useContextAppFetch', () => {
     expect(result.current.fetchedState.anchor).toEqual({ ...mockAnchorHit, isAnchor: true });
     expect(result.current.fetchedState.predecessors).toEqual(mockPredecessorHits);
     expect(result.current.fetchedState.successors).toEqual(mockSuccessorHits);
+    expect(result.current.fetchedState.predecessorsInterceptedWarnings).toBeUndefined();
+    expect(result.current.fetchedState.successorsInterceptedWarnings).toBeUndefined();
+    expect(result.current.fetchedState.anchorInterceptedWarnings).toBeUndefined();
   });
 
   it('should set anchorStatus to failed when tieBreakingField array is empty', async () => {
@@ -187,4 +207,34 @@ describe('test useContextAppFetch', () => {
     expect(result.current.fetchedState.predecessors).toEqual([]);
     expect(result.current.fetchedState.successors).toEqual([]);
   });
+
+  it('should handle warnings', async () => {
+    mockOverrideInterceptedWarnings = true;
+
+    const { result } = initDefaults(['_doc']);
+
+    expect(result.current.fetchedState.anchorStatus.value).toBe(LoadingStatus.UNINITIALIZED);
+    expect(result.current.fetchedState.predecessorsStatus.value).toBe(LoadingStatus.UNINITIALIZED);
+    expect(result.current.fetchedState.successorsStatus.value).toBe(LoadingStatus.UNINITIALIZED);
+
+    await act(async () => {
+      await result.current.fetchAllRows();
+    });
+
+    expect(result.current.fetchedState.anchorStatus.value).toBe(LoadingStatus.LOADED);
+    expect(result.current.fetchedState.predecessorsStatus.value).toBe(LoadingStatus.LOADED);
+    expect(result.current.fetchedState.successorsStatus.value).toBe(LoadingStatus.LOADED);
+    expect(result.current.fetchedState.anchor).toEqual({ ...mockAnchorHit, isAnchor: true });
+    expect(result.current.fetchedState.predecessors).toEqual(mockPredecessorHits);
+    expect(result.current.fetchedState.successors).toEqual(mockSuccessorHits);
+    expect(result.current.fetchedState.predecessorsInterceptedWarnings).toEqual([
+      mockInterceptedWarnings[0],
+    ]);
+    expect(result.current.fetchedState.successorsInterceptedWarnings).toEqual([
+      mockInterceptedWarnings[1],
+    ]);
+    expect(result.current.fetchedState.anchorInterceptedWarnings).toEqual([
+      mockInterceptedWarnings[2],
+    ]);
+  });
 });

src/plugins/discover/public/application/context/hooks/use_context_app_fetch.tsx

@@ -41,13 +41,8 @@ export function useContextAppFetch({
   appState,
   useNewFieldsApi,
 }: ContextAppFetchProps) {
-  const {
-    uiSettings: config,
-    data,
-    toastNotifications,
-    filterManager,
-    core,
-  } = useDiscoverServices();
+  const services = useDiscoverServices();
+  const { uiSettings: config, data, toastNotifications, filterManager, core } = services;
   const { theme$ } = core.theme;
 
   const searchSource = useMemo(() => {
@@ -95,9 +90,20 @@ export function useContextAppFetch({
         { [dataView.timeFieldName!]: SortDirection.desc },
         { [tieBreakerField]: SortDirection.desc },
       ];
-      const anchor = await fetchAnchor(anchorId, dataView, searchSource, sort, useNewFieldsApi);
-      setState({ anchor, anchorStatus: { value: LoadingStatus.LOADED } });
-      return anchor;
+      const result = await fetchAnchor(
+        anchorId,
+        dataView,
+        searchSource,
+        sort,
+        useNewFieldsApi,
+        services
+      );
+      setState({
+        anchor: result.anchorRow,
+        anchorInterceptedWarnings: result.interceptedWarnings,
+        anchorStatus: { value: LoadingStatus.LOADED },
+      });
+      return result.anchorRow;
     } catch (error) {
       setState(createError('anchorStatus', FailureReason.UNKNOWN, error));
       toastNotifications.addDanger({
@@ -106,6 +112,7 @@ export function useContextAppFetch({
       });
     }
   }, [
+    services,
     tieBreakerField,
     setState,
     toastNotifications,
@@ -124,13 +131,14 @@ export function useContextAppFetch({
         type === SurrDocType.PREDECESSORS ? appState.predecessorCount : appState.successorCount;
       const anchor = fetchedAnchor || fetchedState.anchor;
       const statusKey = `${type}Status`;
+      const warningsKey = `${type}InterceptedWarnings`;
       const errorTitle = i18n.translate('discover.context.unableToLoadDocumentDescription', {
         defaultMessage: 'Unable to load documents',
       });
 
       try {
         setState({ [statusKey]: { value: LoadingStatus.LOADING } });
-        const rows = anchor.id
+        const result = anchor.id
           ? await fetchSurroundingDocs(
               type,
               dataView,
@@ -140,10 +148,15 @@ export function useContextAppFetch({
               count,
               filters,
               data,
-              useNewFieldsApi
+              useNewFieldsApi,
+              services
             )
-          : [];
-        setState({ [type]: rows, [statusKey]: { value: LoadingStatus.LOADED } });
+          : { rows: [], interceptedWarnings: undefined };
+        setState({
+          [type]: result.rows,
+          [warningsKey]: result.interceptedWarnings,
+          [statusKey]: { value: LoadingStatus.LOADED },
+        });
       } catch (error) {
         setState(createError(statusKey, FailureReason.UNKNOWN, error));
         toastNotifications.addDanger({
@@ -155,6 +168,7 @@ export function useContextAppFetch({
       }
     },
     [
+      services,
       filterManager,
       appState,
       fetchedState.anchor,