[Snapshot & Restore] Add state filtering to snapshots list (#237254)

Author: sabarasaba

x-pack/platform/plugins/private/snapshot_restore/__jest__/client_integration/snapshot_list.test.tsx

@@ -325,6 +325,52 @@ describe('<SnapshotList />', () => {
           });
         });
       });
+
+      describe('state', () => {
+        test('partial state search is parsed', async () => {
+          await setSearchText('state:SUCCESS');
+          expect(useLoadSnapshots).lastCalledWith({
+            ...DEFAULT_SNAPSHOT_LIST_PARAMS,
+            searchField: 'state',
+            searchValue: 'SUCCESS',
+            searchMatch: 'must',
+            searchOperator: 'eq',
+          });
+        });
+
+        test('excluding partial state search is parsed', async () => {
+          await setSearchText('-state:FAILED');
+          expect(useLoadSnapshots).lastCalledWith({
+            ...DEFAULT_SNAPSHOT_LIST_PARAMS,
+            searchField: 'state',
+            searchValue: 'FAILED',
+            searchMatch: 'must_not',
+            searchOperator: 'eq',
+          });
+        });
+
+        test('exact state search is parsed', async () => {
+          await setSearchText('state=IN_PROGRESS');
+          expect(useLoadSnapshots).lastCalledWith({
+            ...DEFAULT_SNAPSHOT_LIST_PARAMS,
+            searchField: 'state',
+            searchValue: 'IN_PROGRESS',
+            searchMatch: 'must',
+            searchOperator: 'exact',
+          });
+        });
+
+        test('excluding exact state search is parsed', async () => {
+          await setSearchText('-state=PARTIAL');
+          expect(useLoadSnapshots).lastCalledWith({
+            ...DEFAULT_SNAPSHOT_LIST_PARAMS,
+            searchField: 'state',
+            searchValue: 'PARTIAL',
+            searchMatch: 'must_not',
+            searchOperator: 'exact',
+          });
+        });
+      });
     });
 
     describe('error handling', () => {

x-pack/platform/plugins/private/snapshot_restore/public/application/sections/home/snapshot_list/components/snapshot_search_bar.tsx

@@ -28,7 +28,7 @@ const onlyOneClauseMessage = i18n.translate(
     defaultMessage: 'You can only use one clause in the search bar',
   }
 );
-// for now limit the search bar to snapshot, repository and policyName queries
+// for now limit the search bar to snapshot, repository, policyName and state queries
 const searchSchema: SchemaType = {
   strict: true,
   fields: {
@@ -41,6 +41,9 @@ const searchSchema: SchemaType = {
     policyName: {
       type: 'string',
     },
+    state: {
+      type: 'string',
+    },
   },
 };
 
@@ -118,6 +121,47 @@ export const SnapshotSearchBar: React.FunctionComponent<Props> = ({
         view: repository,
       })),
     },
+    {
+      type: 'field_value_selection' as const,
+      field: 'state',
+      name: i18n.translate('xpack.snapshotRestore.snapshotList.table.stateFilterLabel', {
+        defaultMessage: 'State',
+      }),
+      operator: 'exact',
+      multiSelect: false,
+      options: [
+        {
+          value: 'SUCCESS',
+          view: i18n.translate('xpack.snapshotRestore.snapshotList.table.stateFilterSuccess', {
+            defaultMessage: 'Success',
+          }),
+        },
+        {
+          value: 'IN_PROGRESS',
+          view: i18n.translate('xpack.snapshotRestore.snapshotList.table.stateFilterInProgress', {
+            defaultMessage: 'In Progress',
+          }),
+        },
+        {
+          value: 'FAILED',
+          view: i18n.translate('xpack.snapshotRestore.snapshotList.table.stateFilterFailed', {
+            defaultMessage: 'Failed',
+          }),
+        },
+        {
+          value: 'PARTIAL',
+          view: i18n.translate('xpack.snapshotRestore.snapshotList.table.stateFilterPartial', {
+            defaultMessage: 'Partial',
+          }),
+        },
+        {
+          value: 'INCOMPATIBLE',
+          view: i18n.translate('xpack.snapshotRestore.snapshotList.table.stateFilterIncompatible', {
+            defaultMessage: 'Incompatible',
+          }),
+        },
+      ],
+    },
   ];
 
   const reloadButton = (

x-pack/platform/plugins/private/snapshot_restore/server/routes/api/snapshots.ts

@@ -7,6 +7,7 @@
 
 import type { TypeOf } from '@kbn/config-schema';
 import { schema } from '@kbn/config-schema';
+import type { SnapshotSnapshotState } from '@elastic/elasticsearch/lib/api/types';
 import type { SnapshotDetailsEs } from '../../../common/types';
 import { deserializeSnapshotDetails } from '../../../common/lib';
 import type { RouteDependencies } from '../../types';
@@ -146,6 +147,9 @@ export function registerSnapshotsRoutes({
                   operator: searchOperator,
                 })
               : '*,_none',
+          ...(searchField === 'state' && searchValue
+            ? { state: searchValue as SnapshotSnapshotState }
+            : {}),
           order: sortDirection,
           // @ts-expect-error sortField: string is not compatible with SnapshotSnapshotSort type
           sort: sortField,

x-pack/platform/plugins/private/snapshot_restore/server/routes/api/validate_schemas.ts

@@ -45,6 +45,7 @@ export const snapshotListSchema = schema.object({
       schema.literal('snapshot'),
       schema.literal('repository'),
       schema.literal('policyName'),
+      schema.literal('state'),
     ])
   ),
   searchValue: schema.maybe(schema.string()),