[8.x] [Onboarding] Remove retrying when fetch index API query fails (e…

…lastic#193634) (elastic#194173) # Backport This will backport the following commits from `main` to `8.x`: - [[Onboarding] Remove retrying when fetch index API query fails (elastic#193634)](elastic#193634)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Saarika Bhasi <[email protected]>
kibanamachine · Sep 26, 2024 · 8125595 · 8125595
1 parent 9c3af40
commit 8125595
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 11 deletions.
diff --git a/x-pack/plugins/search_indices/public/components/indices/details_page.tsx b/x-pack/plugins/search_indices/public/components/indices/details_page.tsx
@@ -43,11 +43,18 @@ export const SearchIndexDetailsPage = () => {
   const tabId = decodeURIComponent(useParams<{ tabId: string }>().tabId);
 
   const { console: consolePlugin, docLinks, application, history } = useKibana().services;
-  const { data: index, refetch, isError: isIndexError, isInitialLoading } = useIndex(indexName);
+  const {
+    data: index,
+    refetch,
+    isError: isIndexError,
+    isInitialLoading,
+    error: indexLoadingError,
+  } = useIndex(indexName);
   const {
     data: mappings,
     isError: isMappingsError,
     isInitialLoading: isMappingsInitialLoading,
+    error: mappingsError,
   } = useIndexMapping(indexName);
 
   const detailsPageTabs: EuiTabbedContentTab[] = useMemo(() => {
@@ -103,6 +110,19 @@ export const SearchIndexDetailsPage = () => {
   const refetchIndex = useCallback(() => {
     refetch();
   }, [refetch]);
+  const indexError = useMemo(
+    () =>
+      isIndexError
+        ? {
+            title: indexLoadingError ? indexLoadingError.body?.error : '',
+            message: indexLoadingError ? indexLoadingError.body?.message : '',
+          }
+        : {
+            title: mappingsError ? mappingsError.body?.error : '',
+            message: mappingsError ? mappingsError.body?.message : '',
+          },
+    [isIndexError, indexLoadingError, mappingsError]
+  );
   const [showMoreOptions, setShowMoreOptions] = useState<boolean>(false);
   const [isShowingDeleteModal, setShowDeleteIndexModal] = useState<boolean>(false);
   const moreOptionsPopover = (
@@ -165,7 +185,7 @@ export const SearchIndexDetailsPage = () => {
     >
       {isIndexError || isMappingsError || !index || !mappings ? (
         <IndexloadingError
-          indexName={indexName}
+          error={indexError}
           navigateToIndexListPage={navigateToIndexListPage}
           reloadFunction={refetchIndex}
         />

diff --git a/x-pack/plugins/search_indices/public/components/indices/details_page_loading_error.tsx b/x-pack/plugins/search_indices/public/components/indices/details_page_loading_error.tsx
@@ -15,12 +15,15 @@ import {
 import React from 'react';
 import { FormattedMessage } from '@kbn/i18n-react';
 interface IndexloadingErrorProps {
-  indexName: string;
+  error: {
+    title: string;
+    message: string;
+  };
   navigateToIndexListPage: () => void;
   reloadFunction: () => void;
 }
 export const IndexloadingError = ({
-  indexName,
+  error: { title, message },
   navigateToIndexListPage,
   reloadFunction,
 }: IndexloadingErrorProps) => (
@@ -31,18 +34,21 @@ export const IndexloadingError = ({
     title={
       <h2>
         <FormattedMessage
-          id="xpack.searchIndices.pageLoaError.errorTitle"
-          defaultMessage="Unable to load index details"
+          id="xpack.searchIndices.pageLoadError.errorTitle"
+          defaultMessage="{error}"
+          values={{
+            error: title,
+          }}
         />
       </h2>
     }
     body={
       <EuiText color="subdued">
         <FormattedMessage
           id="xpack.searchIndices.pageLoadError.description"
-          defaultMessage="We encountered an error loading data for index {indexName}. Make sure that the index name in the URL is correct and try again."
+          defaultMessage="{message}"
           values={{
-            indexName,
+            message,
           }}
         />
       </EuiText>

diff --git a/x-pack/plugins/search_indices/public/hooks/api/use_index.ts b/x-pack/plugins/search_indices/public/hooks/api/use_index.ts
@@ -14,12 +14,14 @@ const POLLING_INTERVAL = 15 * 1000;
 export const useIndex = (indexName: string) => {
   const { http } = useKibana().services;
   const queryKey = [QueryKeys.FetchIndex, indexName];
-  const result = useQuery({
+  const result = useQuery<Index, { body: { statusCode: number; message: string; error: string } }>({
     queryKey,
     refetchInterval: POLLING_INTERVAL,
     refetchIntervalInBackground: true,
     refetchOnWindowFocus: 'always',
-    retry: 3,
+    retry: (failureCount, error) => {
+      return !(error?.body?.statusCode === 404 || failureCount === 3);
+    },
     queryFn: () =>
       http.fetch<Index>(`/internal/index_management/indices/${encodeURIComponent(indexName)}`),
   });

diff --git a/x-pack/plugins/search_indices/public/hooks/api/use_index_mappings.ts b/x-pack/plugins/search_indices/public/hooks/api/use_index_mappings.ts
@@ -12,7 +12,7 @@ import { Mappings } from '../../types';
 export const useIndexMapping = (indexName: string) => {
   const { http } = useKibana().services;
   const queryKey = ['fetchMapping', indexName];
-  const result = useQuery({
+  const result = useQuery<Mappings, { body: { message: string; error: string } }>({
     queryKey,
     refetchOnWindowFocus: 'always',
     queryFn: () =>

diff --git a/x-pack/test_serverless/functional/page_objects/svl_search_index_detail_page.ts b/x-pack/test_serverless/functional/page_objects/svl_search_index_detail_page.ts
@@ -103,6 +103,12 @@ export function SvlSearchIndexDetailPageProvider({ getService }: FtrProviderCont
       await testSubjects.existOrFail('loadingErrorBackToIndicesButton');
       await testSubjects.existOrFail('reloadButton');
     },
+    async expectIndexNotFoundErrorExists() {
+      const pageLoadErrorElement = await (
+        await testSubjects.find('pageLoadError')
+      ).findByClassName('euiTitle');
+      expect(await pageLoadErrorElement.getVisibleText()).to.contain('Not Found');
+    },
     async clickPageReload() {
       await retry.tryForTime(60 * 1000, async () => {
         await testSubjects.click('reloadButton', 2000);

diff --git a/x-pack/test_serverless/functional/test_suites/search/search_index_detail.ts b/x-pack/test_serverless/functional/test_suites/search/search_index_detail.ts
@@ -124,6 +124,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
         });
         it('has page load error section', async () => {
           await pageObjects.svlSearchIndexDetailPage.expectPageLoadErrorExists();
+          await pageObjects.svlSearchIndexDetailPage.expectIndexNotFoundErrorExists();
         });
         it('reload button shows details page again', async () => {
           await es.indices.create({ index: indexName });