Add support for Convert Index to Remote action

tomsnuvv · tomsnuvv · commit 2340335dacac · 2025-05-20T23:30:17.000+02:00
- Add new ConvertIndexToRemote UI component
- Correct tests

Signed-off-by: Tom Snuverink &lt;tom_snuv@hotmail.com&gt;
diff --git a/models/interfaces.ts b/models/interfaces.ts
@@ -428,6 +428,13 @@ export interface SnapshotAction extends Action {
   };
 }
 
+export interface ConvertIndexToRemoteAction extends Action {
+  convert_index_to_remote: {
+    repository: string;
+    snapshot: string;
+  };
+}
+
 export interface IndexPriorityAction extends Action {
   index_priority: {
     priority?: number;
diff --git a/public/pages/Aliases/containers/Aliases/Aliases.test.tsx b/public/pages/Aliases/containers/Aliases/Aliases.test.tsx
@@ -228,7 +228,7 @@ describe("<Aliases /> spec", () => {
     userEvent.type(getByPlaceholderText("Specify alias name"), testAliasId);
     userEvent.click(getByTestId("createAliasButton"));
     await waitFor(() => {
-      expect(browserServicesMock.commonService.apiCaller).toBeCalledTimes(17);
+      expect(browserServicesMock.commonService.apiCaller).toBeCalledTimes(15);
       expect(browserServicesMock.commonService.apiCaller).toBeCalledWith({
         data: {
           index: ["1"],
diff --git a/public/pages/VisualCreatePolicy/components/UIActions/ConvertIndexToRemoteUIAction.tsx b/public/pages/VisualCreatePolicy/components/UIActions/ConvertIndexToRemoteUIAction.tsx
@@ -0,0 +1,82 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import React, { ChangeEvent } from "react";
+import { EuiCompressedFormRow, EuiCompressedFieldText, EuiSpacer } from "@elastic/eui";
+import { ConvertIndexToRemoteAction, UIAction } from "../../../../../models/interfaces";
+import { makeId } from "../../../../utils/helpers";
+import { ActionType } from "../../utils/constants";
+import EuiFormCustomLabel from "../EuiFormCustomLabel";
+
+export default class ConvertIndexToRemoteUIAction implements UIAction<ConvertIndexToRemoteAction> {
+  id: string;
+  action: ConvertIndexToRemoteAction;
+  type = ActionType.ConvertIndexToRemote;
+
+  constructor(action: ConvertIndexToRemoteAction, id: string = makeId()) {
+    this.action = action;
+    this.id = id;
+  }
+
+  content = () => `Convert Index To Remote`;
+
+  clone = (action: ConvertIndexToRemoteAction) => new ConvertIndexToRemoteUIAction(action, this.id);
+
+  isValid = () => {
+    return !!this.action.convert_index_to_remote.snapshot && !!this.action.convert_index_to_remote.repository;
+  };
+
+  render = (action: UIAction<ConvertIndexToRemoteAction>, onChangeAction: (action: UIAction<ConvertIndexToRemoteAction>) => void) => {
+    return (
+      <>
+        <EuiFormCustomLabel
+          title="Repository"
+          helpText="The repository name that you register through the native snapshot API operations."
+          isInvalid={!this.isValid()}
+        />
+        <EuiCompressedFormRow fullWidth isInvalid={!this.isValid()} error={null}>
+          <EuiCompressedFieldText
+            fullWidth
+            value={(action.action as ConvertIndexToRemoteAction).convert_index_to_remote.repository}
+            onChange={(e: ChangeEvent<HTMLInputElement>) => {
+              const repository = e.target.value;
+              onChangeAction(
+                this.clone({
+                  convert_index_to_remote: {
+                    ...action.action.convert_index_to_remote,
+                    repository,
+                  },
+                })
+              );
+            }}
+            data-test-subj="action-render-convert-index-to-remote-repository"
+          />
+        </EuiCompressedFormRow>
+        <EuiSpacer size="s" />
+        <EuiFormCustomLabel title="Snapshot" helpText="The name of the snapshot." isInvalid={!this.isValid()} />
+        <EuiCompressedFormRow fullWidth isInvalid={!this.isValid()} error={null}>
+          <EuiCompressedFieldText
+            fullWidth
+            value={(action.action as ConvertIndexToRemoteAction).convert_index_to_remote.snapshot}
+            onChange={(e: ChangeEvent<HTMLInputElement>) => {
+              const snapshot = e.target.value;
+              onChangeAction(
+                this.clone({
+                  convert_index_to_remote: {
+                    ...action.action.convert_index_to_remote,
+                    snapshot,
+                  },
+                })
+              );
+            }}
+            data-test-subj="action-render-convert-index-to-remote-snapshot"
+          />
+        </EuiCompressedFormRow>
+      </>
+    );
+  };
+
+  toAction = () => this.action;
+}
diff --git a/public/pages/VisualCreatePolicy/components/UIActions/index.ts b/public/pages/VisualCreatePolicy/components/UIActions/index.ts
@@ -6,6 +6,7 @@
 import AliasUIAction from "./AliasUIAction/AliasUIAction";
 import AllocationUIAction from "./AllocationUIAction";
 import CloseUIAction from "./CloseUIAction";
+import ConvertIndexToRemoteUIAction from "./ConvertIndexToRemoteUIAction";
 import DeleteUIAction from "./DeleteUIAction";
 import ForceMergeUIAction from "./ForceMergeUIAction";
 import IndexPriorityUIAction from "./IndexPriorityUIAction";
@@ -23,6 +24,7 @@ export {
   AliasUIAction,
   AllocationUIAction,
   CloseUIAction,
+  ConvertIndexToRemoteUIAction,
   DeleteUIAction,
   ForceMergeUIAction,
   IndexPriorityUIAction,
diff --git a/public/pages/VisualCreatePolicy/containers/CreateAction/__snapshots__/CreateAction.test.tsx.snap b/public/pages/VisualCreatePolicy/containers/CreateAction/__snapshots__/CreateAction.test.tsx.snap
@@ -110,6 +110,11 @@ exports[`<CreateAction /> spec renders the component 1`] = `
                 >
                   Close
                 </option>
+                <option
+                  value="convert_index_to_remote"
+                >
+                  Convert Index To Remote
+                </option>
                 <option
                   value="delete"
                 >
diff --git a/public/pages/VisualCreatePolicy/utils/constants.ts b/public/pages/VisualCreatePolicy/utils/constants.ts
@@ -9,6 +9,7 @@ export enum ActionType {
   Alias = "alias",
   Allocation = "allocation",
   Close = "close",
+  ConvertIndexToRemote = "convert_index_to_remote",
   Delete = "delete",
   ForceMerge = "force_merge",
   IndexPriority = "index_priority",
@@ -82,6 +83,12 @@ export const DEFAULT_ALLOCATION: AllocationAction = {
 export const DEFAULT_CLOSE = {
   close: {},
 };
+export const DEFAULT_CONVERT_INDEX_TO_REMOTE = {
+  convert_index_to_remote: {
+    repository: "example-repository",
+    snapshot: "example-snapshot",
+  },
+};
 export const DEFAULT_DELETE = {
   delete: {},
 };
@@ -199,6 +206,7 @@ export const actions = [
   DEFAULT_ALIAS,
   DEFAULT_ALLOCATION,
   DEFAULT_CLOSE,
+  DEFAULT_CONVERT_INDEX_TO_REMOTE,
   DEFAULT_DELETE,
   DEFAULT_FORCE_MERGE,
   DEFAULT_INDEX_PRIORITY,
diff --git a/public/pages/VisualCreatePolicy/utils/helpers.test.ts b/public/pages/VisualCreatePolicy/utils/helpers.test.ts
@@ -75,9 +75,9 @@ class DummyUIAction implements UIAction<DummyAction> {
 }
 
 test("action repository usage", () => {
-  expect(actionRepoSingleton.getAllActionTypes().length).toBe(15);
-  actionRepoSingleton.registerAction("dummy", DummyUIAction, DEFAULT_DUMMY);
   expect(actionRepoSingleton.getAllActionTypes().length).toBe(16);
+  actionRepoSingleton.registerAction("dummy", DummyUIAction, DEFAULT_DUMMY);
+  expect(actionRepoSingleton.getAllActionTypes().length).toBe(17);
   expect(actionRepoSingleton.getUIAction("dummy") instanceof DummyUIAction).toBe(true);
   expect(actionRepoSingleton.getUIActionFromData(DEFAULT_DUMMY) instanceof DummyUIAction).toBe(true);
 });
diff --git a/public/pages/VisualCreatePolicy/utils/helpers.ts b/public/pages/VisualCreatePolicy/utils/helpers.ts
@@ -9,6 +9,7 @@ import {
   DEFAULT_ALIAS,
   DEFAULT_ALLOCATION,
   DEFAULT_CLOSE,
+  DEFAULT_CONVERT_INDEX_TO_REMOTE,
   DEFAULT_DELETE,
   DEFAULT_FORCE_MERGE,
   DEFAULT_INDEX_PRIORITY,
@@ -26,6 +27,7 @@ import {
   AliasUIAction,
   AllocationUIAction,
   CloseUIAction,
+  ConvertIndexToRemoteUIAction,
   DeleteUIAction,
   ForceMergeUIAction,
   IndexPriorityUIAction,
@@ -75,6 +77,8 @@ export const getUIAction = (actionType: string): UIAction<any> => {
       return new AllocationUIAction(DEFAULT_ALLOCATION);
     case ActionType.Close:
       return new CloseUIAction(DEFAULT_CLOSE);
+    case ActionType.ConvertIndexToRemote:
+      return new ConvertIndexToRemoteUIAction(DEFAULT_CONVERT_INDEX_TO_REMOTE);
     case ActionType.Delete:
       return new DeleteUIAction(DEFAULT_DELETE);
     case ActionType.ForceMerge:
@@ -127,6 +131,7 @@ class ActionRepository {
     alias: [AliasUIAction, DEFAULT_ALIAS],
     allocation: [AllocationUIAction, DEFAULT_ALLOCATION],
     close: [CloseUIAction, DEFAULT_CLOSE],
+    convert_index_to_remote: [ConvertIndexToRemoteUIAction, DEFAULT_CONVERT_INDEX_TO_REMOTE],
     delete: [DeleteUIAction, DEFAULT_DELETE],
     force_merge: [ForceMergeUIAction, DEFAULT_FORCE_MERGE],
     index_priority: [IndexPriorityUIAction, DEFAULT_INDEX_PRIORITY],

Original file line number	Diff line number	Diff line change
@@ -110,6 +110,11 @@ exports[`<CreateAction /> spec renders the component 1`] = `
`110`	`110`	`>`
`111`	`111`	`Close`
`112`	`112`	`</option>`
	`113`	`+ <option`
	`114`	`+ value="convert_index_to_remote"`
	`115`	`+ >`
	`116`	`+ Convert Index To Remote`
	`117`	`+ </option>`
`113`	`118`	`<option`
`114`	`119`	`value="delete"`
`115`	`120`	`>`