get_search_response_intercepted_warnings.tsx

/*
 * 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 React from 'react';
import { uniqBy } from 'lodash';
import {
  type DataPublicPluginStart,
  type ShardFailureRequest,
  ShardFailureOpenModalButton,
} from '@kbn/data-plugin/public';
import type { RequestAdapter } from '@kbn/inspector-plugin/common';
import type { CoreStart } from '@kbn/core-lifecycle-browser';
import type { SearchResponseInterceptedWarning } from '../types';

/**
 * Intercepts warnings for a search source request
 * @param services
 * @param adapter
 * @param options
 */
export const getSearchResponseInterceptedWarnings = ({
  services,
  adapter,
  options,
}: {
  services: {
    data: DataPublicPluginStart;
    theme: CoreStart['theme'];
  };
  adapter: RequestAdapter;
  options?: {
    disableShardFailureWarning?: boolean;
  };
}): SearchResponseInterceptedWarning[] | undefined => {
  if (!options?.disableShardFailureWarning) {
    return undefined;
  }

  const interceptedWarnings: SearchResponseInterceptedWarning[] = [];

  services.data.search.showWarnings(adapter, (warning, meta) => {
    const { request, response } = meta;

    interceptedWarnings.push({
      originalWarning: warning,
      action:
        warning.type === 'shard_failure' && warning.text && warning.message ? (
          <ShardFailureOpenModalButton
            theme={services.theme}
            title={warning.message}
            size="s"
            getRequestMeta={() => ({
              request: request as ShardFailureRequest,
              response,
            })}
            color="primary"
            isButtonEmpty={true}
          />
        ) : undefined,
    });
    return true; // suppress the default behaviour
  });

  return removeInterceptedWarningDuplicates(interceptedWarnings);
};

/**
 * Removes duplicated warnings
 * @param interceptedWarnings
 */
export const removeInterceptedWarningDuplicates = (
  interceptedWarnings: SearchResponseInterceptedWarning[] | undefined
): SearchResponseInterceptedWarning[] | undefined => {
  if (!interceptedWarnings?.length) {
    return undefined;
  }

  const uniqInterceptedWarnings = uniqBy(interceptedWarnings, (interceptedWarning) =>
    JSON.stringify(interceptedWarning.originalWarning)
  );

  return uniqInterceptedWarnings?.length ? uniqInterceptedWarnings : undefined;
};