[SR] Snapshot and Restore UI

x-pack/legacy/plugins/snapshot_restore/common/constants.ts

@@ -11,7 +11,7 @@ export const PLUGIN = {
   MINIMUM_LICENSE_REQUIRED: LICENSE_TYPE_BASIC as LicenseType,
   getI18nName: (i18n: any): string => {
     return i18n.translate('xpack.snapshotRestore.appName', {
-      defaultMessage: 'Snapshot Repositories',
+      defaultMessage: 'Snapshot and Restore',
     });
   },
 };

x-pack/legacy/plugins/snapshot_restore/common/lib/index.ts

@@ -4,3 +4,4 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 export { flatten } from './flatten';
+export { serializeRestoreSettings } from './restore_settings_serialization';

x-pack/legacy/plugins/snapshot_restore/common/lib/restore_settings_serialization.test.ts

@@ -0,0 +1,57 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+import { serializeRestoreSettings } from './restore_settings_serialization';
+
+describe('restore_settings_serialization()', () => {
+  it('should serialize blank restore settings', () => {
+    expect(serializeRestoreSettings({})).toEqual({});
+  });
+
+  it('should serialize partial restore settings', () => {
+    expect(serializeRestoreSettings({})).toEqual({});
+    expect(
+      serializeRestoreSettings({
+        indices: ['foo', 'bar'],
+        ignoreIndexSettings: ['setting1'],
+        partial: true,
+      })
+    ).toEqual({
+      indices: ['foo', 'bar'],
+      ignore_index_settings: ['setting1'],
+      partial: true,
+    });
+  });
+
+  it('should serialize full restore settings', () => {
+    expect(
+      serializeRestoreSettings({
+        indices: ['foo', 'bar'],
+        renamePattern: 'capture_pattern',
+        renameReplacement: 'replacement_pattern',
+        includeGlobalState: true,
+        partial: true,
+        indexSettings: '{"modified_setting":123}',
+        ignoreIndexSettings: ['setting1'],
+      })
+    ).toEqual({
+      indices: ['foo', 'bar'],
+      rename_pattern: 'capture_pattern',
+      rename_replacement: 'replacement_pattern',
+      include_global_state: true,
+      partial: true,
+      index_settings: { modified_setting: 123 },
+      ignore_index_settings: ['setting1'],
+    });
+  });
+
+  it('should skip serialization of invalid json index settings', () => {
+    expect(
+      serializeRestoreSettings({
+        indexSettings: '{"invalid_setting:123,}',
+      })
+    ).toEqual({});
+  });
+});

x-pack/legacy/plugins/snapshot_restore/common/lib/restore_settings_serialization.ts

@@ -0,0 +1,49 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+import { RestoreSettings, RestoreSettingsEs } from '../types';
+
+const removeUndefinedSettings = (settings: RestoreSettingsEs): RestoreSettingsEs => {
+  return Object.entries(settings).reduce((sts: RestoreSettingsEs, [key, value]) => {
+    if (value !== undefined) {
+      sts[key as keyof RestoreSettingsEs] = value;
+    }
+    return sts;
+  }, {});
+};
+
+export function serializeRestoreSettings(restoreSettings: RestoreSettings): RestoreSettingsEs {
+  const {
+    indices,
+    renamePattern,
+    renameReplacement,
+    includeGlobalState,
+    partial,
+    indexSettings,
+    ignoreIndexSettings,
+  } = restoreSettings;
+
+  let parsedIndexSettings: RestoreSettingsEs['index_settings'] | undefined;
+  if (indexSettings) {
+    try {
+      parsedIndexSettings = JSON.parse(indexSettings);
+    } catch (e) {
+      // Silently swallow parsing errors since parsing validation is done on client
+      // so we should never reach this point
+    }
+  }
+
+  const settings: RestoreSettingsEs = {
+    indices,
+    rename_pattern: renamePattern,
+    rename_replacement: renameReplacement,
+    include_global_state: includeGlobalState,
+    partial,
+    index_settings: parsedIndexSettings,
+    ignore_index_settings: ignoreIndexSettings,
+  };
+
+  return removeUndefinedSettings(settings);
+}

x-pack/legacy/plugins/snapshot_restore/common/types/index.ts

@@ -6,3 +6,4 @@
 
 export * from './repository';
 export * from './snapshot';
+export * from './restore';

x-pack/legacy/plugins/snapshot_restore/common/types/restore.ts

@@ -0,0 +1,127 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export interface RestoreSettings {
+  indices?: string[];
+  renamePattern?: string;
+  renameReplacement?: string;
+  includeGlobalState?: boolean;
+  partial?: boolean;
+  indexSettings?: string;
+  ignoreIndexSettings?: string[];
+}
+
+export interface RestoreSettingsEs {
+  indices?: string[];
+  rename_pattern?: string;
+  rename_replacement?: string;
+  include_global_state?: boolean;
+  partial?: boolean;
+  index_settings?: { [key: string]: any };
+  ignore_index_settings?: string[];
+}
+
+export interface SnapshotRestore {
+  index: string;
+  latestActivityTimeInMillis: number;
+  shards: Array<Partial<SnapshotRestoreShard>>;
+  isComplete: boolean;
+}
+
+export interface SnapshotRestoreShard {
+  id: number;
+  primary: boolean;
+  stage: string;
+  snapshot: string;
+  repository: string;
+  version: string;
+
+  targetHost: string;
+  targetNode: string;
+
+  /** e.g. '2019-04-05T21:56:40.438Z' */
+  startTime: string;
+  startTimeInMillis: number;
+  /** e.g. '2019-04-05T21:56:40.438Z' */
+  stopTime: string;
+  stopTimeInMillis: number;
+  totalTime: string;
+  totalTimeInMillis: number;
+
+  bytesTotal: number;
+  bytesRecovered: number;
+  bytesPercent: string;
+
+  filesTotal: number;
+  filesRecovered: number;
+  filesPercent: string;
+}
+
+export interface SnapshotRestoreShardEs {
+  id: number;
+  type: string;
+  stage: string;
+  primary: boolean;
+  /** e.g. '2019-04-05T21:56:40.438Z' */
+  start_time: string;
+  start_time_in_millis: number;
+  /** e.g. '2019-04-05T21:56:40.438Z' */
+  stop_time: string;
+  stop_time_in_millis: number;
+  total_time: string;
+  total_time_in_millis: number;
+  source: {
+    repository: string;
+    snapshot: string;
+    version: string;
+    index: string;
+    restoreUUID: string;
+  };
+  target: {
+    id: string;
+    host: string;
+    transport_address: string;
+    ip: string;
+    name: string;
+  };
+  index: {
+    size: {
+      total: string;
+      total_in_bytes: number;
+      reused: string;
+      reused_in_bytes: number;
+      recovered: string;
+      recovered_in_bytes: number;
+      percent: string;
+    };
+    files: {
+      total: number;
+      reused: number;
+      recovered: number;
+      percent: string;
+    };
+    total_time: string;
+    total_time_in_millis: number;
+    source_throttle_time: string;
+    source_throttle_time_in_millis: number;
+    target_throttle_time: string;
+    target_throttle_time_in_millis: number;
+  };
+  translog: {
+    recovered: number;
+    total: number;
+    percent: string;
+    total_on_start: number;
+    total_time: string;
+    total_time_in_millis: number;
+  };
+  verify_index: {
+    check_index_time: string;
+    check_index_time_in_millis: number;
+    total_time: string;
+    total_time_in_millis: number;
+  };
+}

x-pack/legacy/plugins/snapshot_restore/common/types/snapshot.ts

@@ -11,7 +11,7 @@ export interface SnapshotDetails {
   versionId: number;
   version: string;
   indices: string[];
-  includeGlobalState: number;
+  includeGlobalState: boolean;
   state: string;
   /** e.g. '2019-04-05T21:56:40.438Z' */
   startTime: string;

x-pack/legacy/plugins/snapshot_restore/index.ts

@@ -17,6 +17,7 @@ export function snapshotRestore(kibana: any) {
     publicDir: resolve(__dirname, 'public'),
     require: ['kibana', 'elasticsearch', 'xpack_main'],
     uiExports: {
+      styleSheetPaths: resolve(__dirname, 'public/app/index.scss'),
       managementSections: ['plugins/snapshot_restore'],
     },
     init(server: Legacy.Server) {

x-pack/legacy/plugins/snapshot_restore/public/app/app.tsx

@@ -10,8 +10,8 @@ import { EuiPageContent, EuiEmptyPrompt } from '@elastic/eui';
 
 import { SectionLoading, SectionError } from './components';
 import { BASE_PATH, DEFAULT_SECTION, Section } from './constants';
-import { RepositoryAdd, RepositoryEdit, SnapshotRestoreHome } from './sections';
-import { loadPermissions } from './services/http';
+import { RepositoryAdd, RepositoryEdit, RestoreSnapshot, SnapshotRestoreHome } from './sections';
+import { useLoadPermissions } from './services/http';
 import { useAppDependencies } from './index';
 
 export const App: React.FunctionComponent = () => {
@@ -29,7 +29,7 @@ export const App: React.FunctionComponent = () => {
       hasPermission: true,
       missingClusterPrivileges: [],
     },
-  } = loadPermissions();
+  } = useLoadPermissions();
 
   if (loadingPermissions) {
     return (
@@ -73,7 +73,7 @@ export const App: React.FunctionComponent = () => {
             <p>
               <FormattedMessage
                 id="xpack.snapshotRestore.app.deniedPermissionDescription"
-                defaultMessage="To use Snapshot Repositories, you must have {clusterPrivilegesCount,
+                defaultMessage="To use Snapshot and Restore, you must have {clusterPrivilegesCount,
                   plural, one {this cluster privilege} other {these cluster privileges}}: {clusterPrivileges}."
                 values={{
                   clusterPrivileges: missingClusterPrivileges.join(', '),
@@ -87,7 +87,7 @@ export const App: React.FunctionComponent = () => {
     );
   }
 
-  const sections: Section[] = ['repositories', 'snapshots'];
+  const sections: Section[] = ['repositories', 'snapshots', 'restore_status'];
   const sectionsRegex = sections.join('|');
 
   return (
@@ -100,6 +100,16 @@ export const App: React.FunctionComponent = () => {
           path={`${BASE_PATH}/:section(${sectionsRegex})/:repositoryName?/:snapshotId*`}
           component={SnapshotRestoreHome}
         />
+        <Redirect
+          exact
+          from={`${BASE_PATH}/restore/:repositoryName`}
+          to={`${BASE_PATH}/snapshots`}
+        />
+        <Route
+          exact
+          path={`${BASE_PATH}/restore/:repositoryName/:snapshotId*`}
+          component={RestoreSnapshot}
+        />
         <Redirect from={`${BASE_PATH}`} to={`${BASE_PATH}/${DEFAULT_SECTION}`} />
       </Switch>
     </div>

x-pack/legacy/plugins/snapshot_restore/public/app/components/index.ts

@@ -11,3 +11,5 @@ export { RepositoryVerificationBadge } from './repository_verification_badge';
 export { RepositoryTypeLogo } from './repository_type_logo';
 export { SectionError } from './section_error';
 export { SectionLoading } from './section_loading';
+export { SnapshotDeleteProvider } from './snapshot_delete_provider';
+export { RestoreSnapshotForm } from './restore_snapshot_form';

x-pack/legacy/plugins/snapshot_restore/public/app/components/repository_form/step_one.tsx

@@ -27,7 +27,7 @@ import { REPOSITORY_TYPES } from '../../../../common/constants';
 
 import { useAppDependencies } from '../../index';
 import { documentationLinksService } from '../../services/documentation';
-import { loadRepositoryTypes } from '../../services/http';
+import { useLoadRepositoryTypes } from '../../services/http';
 import { textService } from '../../services/text';
 import { RepositoryValidation } from '../../services/validation';
 import { SectionError, SectionLoading, RepositoryTypeLogo } from '../';
@@ -56,7 +56,7 @@ export const RepositoryFormStepOne: React.FunctionComponent<Props> = ({
     error: repositoryTypesError,
     loading: repositoryTypesLoading,
     data: repositoryTypes = [],
-  } = loadRepositoryTypes();
+  } = useLoadRepositoryTypes();
 
   const hasValidationErrors: boolean = !validation.isValid;
 
@@ -143,6 +143,7 @@ export const RepositoryFormStepOne: React.FunctionComponent<Props> = ({
         <EuiCard
           title={displayName}
           icon={<RepositoryTypeLogo type={type} size="l" />}
+          description={<Fragment />} /* EuiCard requires `description` */
           footer={
             <EuiButtonEmpty
               href={documentationLinksService.getRepositoryTypeDocUrl(type)}

x-pack/legacy/plugins/snapshot_restore/public/app/components/restore_snapshot_form/_restore_snapshot_form.scss

@@ -0,0 +1,10 @@
+/*
+ * Prevent switch controls from moving around when toggling content
+ */
+.snapshotRestore__restoreForm__stepLogistics,
+.snapshotRestore__restoreForm__stepSettings {
+  .euiFormRow--hasEmptyLabelSpace {
+    min-height: auto;
+    margin-top: $euiFontSizeXS + $euiSizeS + ($euiSizeXXL / 4);
+  }
+}

x-pack/legacy/plugins/snapshot_restore/public/app/components/restore_snapshot_form/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export { RestoreSnapshotForm } from './restore_snapshot_form';