refactor search source warnings to return a single warning for 'is_partial' results

examples/search_examples/public/search/app.tsx

@@ -311,17 +311,15 @@ export const SearchExamplesApp = ({
       const result = await lastValueFrom(
         searchSource.fetch$({
           abortSignal: abortController.signal,
-          disableShardFailureWarning: !showWarningToastNotifications,
+          disableWarningToasts: !showWarningToastNotifications,
           inspector,
         })
       );
       setRawResponse(result.rawResponse);
 
-      /* Here is an example of using showWarnings on the search service, using an optional callback to
-       * intercept the warnings before notification warnings are shown.
-       *
-       * Suppressing the shard failure warning notification from appearing by default requires setting
-       * { disableShardFailureWarning: true } in the SearchSourceSearchOptions passed to $fetch
+      /*
+       * Set disableWarningToasts to true to disable warning toasts and customize warning display.
+       * Then use showWarnings to customize warning notification.
        */
       if (showWarningToastNotifications) {
         setWarningContents([]);
@@ -498,7 +496,7 @@ export const SearchExamplesApp = ({
             {' '}
             <FormattedMessage
               id="searchExamples.warningsObject"
-              defaultMessage="Timeout and shard failure warnings for high-level search may be handled in a callback to the showWarnings method on the search service."
+              defaultMessage="Search warnings may optionally be handed with search service showWarnings method."
             />{' '}
           </EuiText>{' '}
           <EuiProgress value={loaded} max={total} size="xs" data-test-subj="progressBar" />{' '}

packages/kbn-es-types/index.ts

@@ -18,4 +18,5 @@ export type {
   AggregationResultOfMap,
   ESFilter,
   MaybeReadonlyArray,
+  ClusterDetails,
 } from './src';

packages/kbn-es-types/src/index.ts

@@ -11,6 +11,7 @@ import {
   AggregateOf as AggregationResultOf,
   AggregateOfMap as AggregationResultOfMap,
   SearchHit,
+  ClusterDetails,
 } from './search';
 
 export type ESFilter = estypes.QueryDslQueryContainer;
@@ -34,4 +35,10 @@ export type ESSearchResponse<
   TOptions extends { restTotalHitsAsInt: boolean } = { restTotalHitsAsInt: false }
 > = InferSearchResponseOf<TDocument, TSearchRequest, TOptions>;
 
-export type { InferSearchResponseOf, AggregationResultOf, AggregationResultOfMap, SearchHit };
+export type {
+  InferSearchResponseOf,
+  AggregationResultOf,
+  AggregationResultOfMap,
+  SearchHit,
+  ClusterDetails,
+};

packages/kbn-es-types/src/search.ts

@@ -644,3 +644,12 @@ export type InferSearchResponseOf<
         >;
       };
   };
+
+export interface ClusterDetails {
+  status: 'running' | 'successful' | 'partial' | 'skipped' | 'failed';
+  indices: string;
+  took?: number;
+  timed_out: boolean;
+  _shards?: estypes.ShardStatistics;
+  failures?: estypes.ShardFailure[];
+}

packages/kbn-search-response-warnings/index.ts

@@ -13,7 +13,5 @@ export {
   type SearchResponseWarningsProps,
 } from './src/components/search_response_warnings';
 
-export {
-  getSearchResponseInterceptedWarnings,
-  removeInterceptedWarningDuplicates,
-} from './src/utils/get_search_response_intercepted_warnings';
+export { getSearchResponseInterceptedWarnings } from './src/utils/get_search_response_intercepted_warnings';
+export { hasUnsupportedDownsampledAggregationFailure } from './src/utils/has_unsupported_downsampled_aggregation_failure';

packages/kbn-search-response-warnings/src/__mocks__/search_response_warnings.ts

@@ -8,43 +8,33 @@
 
 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!',
+export const searchResponseIncompleteWarningLocalCluster: SearchResponseWarning = {
+  type: 'incomplete',
+  message: 'The data might be incomplete or wrong.',
+  clusters: {
+    '(local)': {
+      status: 'partial',
+      indices: '',
+      took: 25,
+      timed_out: false,
+      _shards: {
+        total: 4,
+        successful: 3,
+        skipped: 0,
+        failed: 1,
+      },
+      failures: [
+        {
+          shard: 0,
+          index: 'sample-01-rollup',
+          node: 'VFTFJxpHSdaoiGxJFLSExQ',
+          reason: {
+            type: 'illegal_argument_exception',
+            reason:
+              'Field [kubernetes.container.memory.available.bytes] of type [aggregate_metric_double] is not supported for aggregation [percentiles]',
+          },
+        },
+      ],
     },
   },
-];
+};