[index management] Faster index list loading

x-pack/platform/packages/shared/index-management/index_management_shared_types/moon.yml

@@ -22,6 +22,7 @@ dependsOn:
   - '@kbn/utility-types'
   - '@kbn/share-plugin'
   - '@kbn/management-plugin'
+  - '@kbn/core'
 tags:
   - shared-common
   - package

x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts

@@ -15,9 +15,24 @@ import type { ScopedHistory } from '@kbn/core-application-browser';
 import type { SerializableRecord } from '@kbn/utility-types';
 import type { LocatorPublic } from '@kbn/share-plugin/public';
 import type { ManagementAppMountParams } from '@kbn/management-plugin/public';
+import type { HttpSetup } from '@kbn/core/public';
 import type { ExtensionsSetup } from './services/extensions_service';
 import type { PublicApiServiceSetup } from './services/public_api_service';
 
+export interface EnricherResponse {
+  source: string;
+  indices?: Index[];
+  error?: boolean;
+  /**
+   * Apply this enricher's updates to any index aliases
+   */
+  applyToAliases?: boolean;
+}
+export interface Enricher {
+  name: string;
+  fn: (client: HttpSetup, signal: AbortSignal) => Promise<EnricherResponse>;
+}
+
 export type IndexManagementLocatorParams = SerializableRecord &
   (
     | {
@@ -82,6 +97,9 @@ export interface IndexManagementPluginSetup {
   extensionsService: ExtensionsSetup;
   renderIndexManagementApp: (params: IndexManagementAppMountParams) => Promise<() => void>;
   locator?: IndexManagementLocator;
+  indexDataEnricher: {
+    add: (enricher: Enricher) => void;
+  };
 }
 
 export interface IndexManagementPluginStart {
@@ -104,13 +122,15 @@ export interface IndexManagementPluginStart {
   }) => React.FC<DatastreamFlyoutProps>;
 }
 
-export interface Index {
+export interface Index extends IndexAttributes {
   name: string;
+}
+export interface IndexAttributes {
   primary?: number | string;
   replica?: number | string;
-  isFrozen: boolean;
-  hidden: boolean;
-  aliases: string | string[];
+  isFrozen?: boolean;
+  hidden?: boolean;
+  aliases?: string | string[];
   data_stream?: string;
   mode?: string;
 
@@ -125,8 +145,8 @@ export interface Index {
   status?: IndicesStatsIndexMetadataState;
   uuid?: Uuid;
   documents?: number;
-  size?: string;
-  primary_size?: string;
+  size?: number;
+  primary_size?: number;
   documents_deleted?: number;
 }
 

x-pack/platform/packages/shared/index-management/index_management_shared_types/tsconfig.json

@@ -19,6 +19,7 @@
     "@kbn/core-application-browser",
     "@kbn/utility-types",
     "@kbn/share-plugin",
-    "@kbn/management-plugin"
+    "@kbn/management-plugin",
+    "@kbn/core"
   ]
 }

x-pack/platform/plugins/private/cross_cluster_replication/moon.yml

@@ -38,6 +38,7 @@ dependsOn:
   - '@kbn/react-kibana-context-render'
   - '@kbn/licensing-types'
   - '@kbn/data-views-plugin'
+  - '@kbn/index-management-shared-types'
 tags:
   - plugin
   - prod

x-pack/platform/plugins/private/cross_cluster_replication/public/ccr_data_enricher.ts

@@ -0,0 +1,30 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type { HttpSetup } from '@kbn/core/public';
+import type { CcrFollowInfoResponse } from '@elastic/elasticsearch/lib/api/types';
+import type { EnricherResponse } from '@kbn/index-management-shared-types';
+import { i18n } from '@kbn/i18n';
+const SOURCE = i18n.translate('xpack.crossClusterReplication.ccrDataEnricher.source', {
+  defaultMessage: 'cross cluster replication',
+});
+
+export const ccrDataEnricher = {
+  name: SOURCE,
+  fn: async (client: HttpSetup, signal: AbortSignal): Promise<EnricherResponse> =>
+    client
+      .get<CcrFollowInfoResponse>('/api/cross_cluster_replication/follower_info', { signal })
+      .then((response) => {
+        return {
+          indices: response.follower_indices.map((followerIndex) => ({
+            name: followerIndex.follower_index,
+            isFollowerIndex: true,
+          })),
+          source: SOURCE,
+        };
+      }),
+};

x-pack/platform/plugins/private/cross_cluster_replication/public/plugin.ts

@@ -14,8 +14,8 @@ import { PLUGIN, MANAGEMENT_ID } from '../common/constants';
 import { init as initUiMetric } from './app/services/track_ui_metric';
 import { init as initNotification } from './app/services/notifications';
 import type { PluginDependencies, ClientConfigType } from './types';
+import { ccrDataEnricher } from './ccr_data_enricher';
 
-// @ts-ignore;
 import { setHttpClient } from './app/services/api';
 
 export class CrossClusterReplicationPlugin implements Plugin {
@@ -105,6 +105,7 @@ export class CrossClusterReplicationPlugin implements Plugin {
             };
 
             indexManagement.extensionsService.addBadge(followerBadgeExtension);
+            indexManagement.indexDataEnricher.add(ccrDataEnricher);
           }
         } else {
           ccrApp.disable();

x-pack/platform/plugins/private/cross_cluster_replication/server/routes/api/follower_index/index.ts

@@ -13,6 +13,7 @@ import { registerPauseRoute } from './register_pause_route';
 import { registerResumeRoute } from './register_resume_route';
 import { registerUnfollowRoute } from './register_unfollow_route';
 import { registerUpdateRoute } from './register_update_route';
+import { registerGetFollowerInfoRoute } from './register_get_follower_info';
 
 export function registerFollowerIndexRoutes(dependencies: RouteDependencies) {
   registerCreateRoute(dependencies);
@@ -22,4 +23,5 @@ export function registerFollowerIndexRoutes(dependencies: RouteDependencies) {
   registerResumeRoute(dependencies);
   registerUnfollowRoute(dependencies);
   registerUpdateRoute(dependencies);
+  registerGetFollowerInfoRoute(dependencies);
 }

x-pack/platform/plugins/private/cross_cluster_replication/server/routes/api/follower_index/register_get_follower_info.ts

@@ -0,0 +1,43 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { addBasePath } from '../../../services';
+import type { RouteDependencies } from '../../../types';
+
+export const registerGetFollowerInfoRoute = ({
+  router,
+  license,
+  lib: { handleEsError },
+}: RouteDependencies) => {
+  router.get(
+    {
+      path: addBasePath('/follower_info'),
+      security: {
+        authz: {
+          enabled: false,
+          reason: 'Relies on es client for authorization',
+        },
+      },
+      validate: {},
+    },
+    license.guardApiRoute(async (context, request, response) => {
+      const { client } = (await context.core).elasticsearch;
+
+      try {
+        const body = await client.asCurrentUser.ccr.followInfo({
+          index: '_all',
+        });
+
+        return response.ok({
+          body,
+        });
+      } catch (error) {
+        return handleEsError({ error, response });
+      }
+    })
+  );
+};

x-pack/platform/plugins/private/cross_cluster_replication/tsconfig.json

@@ -32,6 +32,7 @@
     "@kbn/react-kibana-context-render",
     "@kbn/licensing-types",
     "@kbn/data-views-plugin",
+    "@kbn/index-management-shared-types",
   ],
   "exclude": [
     "target/**/*",

x-pack/platform/plugins/private/index_lifecycle_management/__jest__/extend_index_management.test.tsx

@@ -12,7 +12,8 @@ import { useEuiTheme } from '@elastic/eui';
 import { screen, waitFor } from '@testing-library/react';
 import { renderWithI18n } from '@kbn/test-jest-helpers';
 import { usageCollectionPluginMock } from '@kbn/usage-collection-plugin/public/mocks';
-import type { Index } from '@kbn/index-management-plugin/common';
+import type { Index as IndexManagementIndex } from '@kbn/index-management-shared-types';
+import type { Index } from '../common/types';
 
 import { init } from '../integration_tests/helpers/http_requests';
 import {
@@ -401,7 +402,7 @@ describe('extend index management', () => {
     const policyErrorPanel = 'policyErrorPanel';
     const phaseDefinitionPanel = 'phaseDefinitionPanel';
 
-    const IlmContentComponent = ({ index }: { index: Index }) => {
+    const IlmContentComponent = ({ index }: { index: IndexManagementIndex }) => {
       const { euiTheme } = useEuiTheme();
       return <IlmComponent index={index} getUrlForApp={getUrlForApp} euiTheme={euiTheme} />;
     };
@@ -410,7 +411,7 @@ describe('extend index management', () => {
       const shouldRenderTab =
         indexLifecycleTab.shouldRenderTab &&
         indexLifecycleTab.shouldRenderTab({
-          index: indexWithoutLifecyclePolicy,
+          index: indexWithoutLifecyclePolicy as IndexManagementIndex,
         });
       expect(shouldRenderTab).toBeFalsy();
     });
@@ -419,11 +420,11 @@ describe('extend index management', () => {
       const shouldRenderTab =
         indexLifecycleTab.shouldRenderTab &&
         indexLifecycleTab.shouldRenderTab({
-          index: indexWithLifecyclePolicy,
+          index: indexWithLifecyclePolicy as IndexManagementIndex,
         });
       expect(shouldRenderTab).toBeTruthy();
       const { container } = renderWithI18n(
-        <IlmContentComponent index={indexWithLifecyclePolicy} />
+        <IlmContentComponent index={indexWithLifecyclePolicy as IndexManagementIndex} />
       );
       expect(container).toMatchSnapshot();
       expect(screen.getByTestId(policyPropertiesPanel)).toBeInTheDocument();
@@ -433,7 +434,9 @@ describe('extend index management', () => {
     });
 
     test('should render an error panel when index has lifecycle error', () => {
-      const { container } = renderWithI18n(<IlmContentComponent index={indexWithLifecycleError} />);
+      const { container } = renderWithI18n(
+        <IlmContentComponent index={indexWithLifecycleError as IndexManagementIndex} />
+      );
       expect(container).toMatchSnapshot();
       expect(screen.getByTestId(policyPropertiesPanel)).toBeInTheDocument();
       expect(screen.queryByTestId(phaseDefinitionPanel)).not.toBeInTheDocument();
@@ -443,7 +446,7 @@ describe('extend index management', () => {
 
     test('should render a phase definition panel when lifecycle has phase definition', () => {
       const { container } = renderWithI18n(
-        <IlmContentComponent index={indexWithLifecyclePhaseDefinition} />
+        <IlmContentComponent index={indexWithLifecyclePhaseDefinition as IndexManagementIndex} />
       );
       expect(container).toMatchSnapshot();
       expect(screen.getByTestId(policyPropertiesPanel)).toBeInTheDocument();
@@ -454,7 +457,7 @@ describe('extend index management', () => {
 
     test('should render a step info panel when lifecycle is waiting for a step completion', () => {
       const { container } = renderWithI18n(
-        <IlmContentComponent index={indexWithLifecycleWaitingStep} />
+        <IlmContentComponent index={indexWithLifecycleWaitingStep as IndexManagementIndex} />
       );
       expect(container).toMatchSnapshot();
       expect(screen.getByTestId(policyPropertiesPanel)).toBeInTheDocument();

x-pack/platform/plugins/private/index_lifecycle_management/common/types/index.ts

@@ -9,6 +9,14 @@ export type * from './api';
 
 export * from '@kbn/index-lifecycle-management-common-shared';
 
+import type { Index as IndexImported } from '@kbn/index-management-plugin/common';
+
+// index management plugin uses number for these fields
+export interface Index extends Omit<IndexImported, 'size' | 'primary_size'> {
+  size?: string;
+  primary_size?: string;
+}
+
 /**
  * These roles reflect how nodes are stratified into different data tiers.
  */

x-pack/platform/plugins/private/index_lifecycle_management/public/extend_index_management/components/add_lifecycle_confirm_modal.tsx

@@ -26,7 +26,7 @@ import {
   htmlIdGenerator,
 } from '@elastic/eui';
 
-import type { Index } from '@kbn/index-management-plugin/common';
+import type { Index } from '../../../common/types';
 import { loadPolicies, addLifecyclePolicyToIndex } from '../../application/services/api';
 import { showApiError } from '../../application/services/api_errors';
 import { toasts } from '../../application/services/notification';

x-pack/platform/plugins/private/index_lifecycle_management/public/extend_index_management/components/index_lifecycle_summary.tsx

@@ -25,14 +25,15 @@ import {
 } from '@elastic/eui';
 
 import type { ApplicationStart } from '@kbn/core/public';
-import type { Index, IndexDetailsTab } from '@kbn/index-management-shared-types';
+import type { IndexDetailsTab } from '@kbn/index-management-shared-types';
 import type { IlmExplainLifecycleLifecycleExplainManaged } from '@elastic/elasticsearch/lib/api/types';
+import type { Index } from '../../../common/types';
 import type { Phase } from '../../../common/types';
 import { getPolicyEditPath } from '../../application/services/navigation';
 import { usePhaseColors } from '../../application/lib';
 
 interface IndexLifecycleSummaryProps {
-  index: Index;
+  index: Omit<Index, 'size' | 'primary_size'>;
   getUrlForApp: ApplicationStart['getUrlForApp'];
 }
 

x-pack/platform/plugins/private/index_lifecycle_management/public/extend_index_management/index.tsx

@@ -11,7 +11,8 @@ import { i18n } from '@kbn/i18n';
 import { EuiSearchBar } from '@elastic/eui';
 import type { ApplicationStart } from '@kbn/core/public';
 
-import type { Index, IndexManagementPluginSetup } from '@kbn/index-management-plugin/public';
+import type { IndexManagementPluginSetup } from '@kbn/index-management-plugin/public';
+import type { Index } from '../../common/types';
 
 import { retryLifecycleForIndex } from '../application/services/api';
 import { indexLifecycleTab } from './components/index_lifecycle_summary';

x-pack/platform/plugins/private/index_lifecycle_management/public/index_lifecycle_data_enricher.ts

@@ -0,0 +1,30 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type { IlmExplainLifecycleResponse } from '@elastic/elasticsearch/lib/api/types';
+import type { HttpSetup } from '@kbn/core/public';
+import type { EnricherResponse } from '@kbn/index-management-shared-types';
+import { i18n } from '@kbn/i18n';
+const SOURCE = i18n.translate('xpack.indexLifecycleMgmt.indexLifecycleDataEnricher.source', {
+  defaultMessage: 'index lifecycle',
+});
+
+export const indexLifecycleDataEnricher = {
+  name: SOURCE,
+  fn: async (client: HttpSetup, signal: AbortSignal): Promise<EnricherResponse> =>
+    client
+      .get<IlmExplainLifecycleResponse>('/api/index_lifecycle_management/explain', { signal })
+      .then((response) => {
+        return {
+          indices: Object.keys(response.indices).map((index) => ({
+            name: index,
+            ilm: response.indices[index],
+          })),
+          source: SOURCE,
+        };
+      }),
+};

x-pack/platform/plugins/private/index_lifecycle_management/public/plugin.tsx

@@ -21,6 +21,7 @@ import type {
   StartDependencies,
 } from './types';
 import { IlmLocatorDefinition } from './locator';
+import { indexLifecycleDataEnricher } from './index_lifecycle_data_enricher';
 import { PublicApiService } from './services';
 
 export class IndexLifecycleManagementPlugin
@@ -115,6 +116,7 @@ export class IndexLifecycleManagementPlugin
 
       if (indexManagement) {
         addAllExtensions(indexManagement.extensionsService);
+        indexManagement.indexDataEnricher.add(indexLifecycleDataEnricher);
       }
 
       plugins.share.url.locators.create(

x-pack/platform/plugins/private/index_lifecycle_management/server/routes/api/policies/index.ts

@@ -9,9 +9,11 @@ import type { RouteDependencies } from '../../../types';
 import { registerFetchRoute } from './register_fetch_route';
 import { registerCreateRoute } from './register_create_route';
 import { registerDeleteRoute } from './register_delete_route';
+import { registerExplainRoute } from './register_explain_route';
 
 export function registerPoliciesRoutes(dependencies: RouteDependencies) {
   registerFetchRoute(dependencies);
   registerCreateRoute(dependencies);
   registerDeleteRoute(dependencies);
+  registerExplainRoute(dependencies);
 }