feat: squash commit

cypress/integration/plugins/index-management-dashboards-plugin/notification_settings.js

@@ -0,0 +1,106 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { IM_PLUGIN_NAME, BASE_PATH, BACKEND_BASE_PATH } from "../../../utils/constants";
+
+const ActionTypeName = {
+  reindex: "indices:data/write/reindex",
+  resize: "indices:admin/resize",
+  forcemerge: "indices:admin/forcemerge",
+  open: "indices:admin/open",
+};
+
+const channel = "test_for_cypress";
+
+const clearLRONConfig = () => {
+  Object.values(ActionTypeName).forEach((actionTypeName) => {
+    cy.request({
+      method: "PUT",
+      url: `${BACKEND_BASE_PATH}/_plugins/_im/lron/${encodeURIComponent(`LRON:${actionTypeName}`)}`,
+      body: {
+        lron_config: {
+          lron_condition: {
+            success: false,
+            failure: false,
+          },
+          action_name: actionTypeName,
+          channels: [],
+        },
+      },
+    });
+  });
+};
+
+const allAction = Object.values(ActionTypeName);
+
+const clearChannel = () => {
+  cy.request({
+    method: "DELETE",
+    url: `${BACKEND_BASE_PATH}/_plugins/_notifications/configs/test_for_cypress`,
+    failOnStatusCode: false,
+  });
+};
+
+describe("NotificationSettings", () => {
+  before(() => {
+    // Set welcome screen tracking to false
+    localStorage.setItem("home:welcome:show", "false");
+    clearLRONConfig();
+    clearChannel();
+    cy.request({
+      method: "POST",
+      url: `${BACKEND_BASE_PATH}/_plugins/_notifications/configs/`,
+      body: {
+        config_id: "test_for_cypress",
+        name: channel,
+        config: {
+          name: channel,
+          description: channel,
+          config_type: "slack",
+          is_enabled: true,
+          slack: {
+            url: "https://sample-slack-webhook",
+          },
+        },
+      },
+    });
+  });
+
+  beforeEach(() => {
+    // Visit ISM OSD
+    cy.visit(`${BASE_PATH}/app/${IM_PLUGIN_NAME}#/notifications`);
+
+    // Common text to wait for to confirm page loaded, give up to 60 seconds for initial load
+    cy.contains("Defaults for index operations", { timeout: 60000 });
+  });
+
+  describe("Display all with empty", () => {
+    it("successfully", () => {
+      allAction.forEach((item, index) => {
+        cy.get(`[data-test-subj="dataSource.${index}.channels"]`).should("not.exist");
+      });
+    });
+  });
+
+  describe("Set one to notify", () => {
+    it("successfully", () => {
+      cy.get(`[data-test-subj="dataSource.0.failure"]`).check({
+        force: true,
+      });
+      cy.get(`[data-test-subj="dataSource.0.channels"] [data-test-subj="comboBoxSearchInput"]`).type(`${channel}{enter}`);
+      cy.get('[data-test-subj="submitNotifcationSettings"]').click({
+        force: true,
+      });
+      cy.contains("Notifications settings for index operations have been successfully updated.");
+      cy.reload();
+      cy.contains(channel);
+      cy.get(`[data-test-subj="dataSource.0.failure"]`).should("be.checked");
+    });
+  });
+
+  after(() => {
+    clearLRONConfig();
+    clearChannel();
+  });
+});

opensearch_dashboards.json

@@ -2,13 +2,8 @@
   "id": "indexManagementDashboards",
   "version": "3.0.0.0",
   "opensearchDashboardsVersion": "3.0.0",
-  "configPath": [
-    "opensearch_index_management"
-  ],
-  "requiredPlugins": [
-    "navigation",
-    "opensearchDashboardsReact"
-  ],
+  "configPath": ["opensearch_index_management"],
+  "requiredPlugins": ["navigation", "opensearchDashboardsReact"],
   "server": true,
   "ui": true
-}
+}

package.json

@@ -70,4 +70,4 @@
   "engines": {
     "yarn": "^1.21.1"
   }
-}
+}

public/JobHandler/callbacks/force_merge.tsx

@@ -156,7 +156,7 @@ export const callbackForForceMergeTimeout: CallbackType = (job: ForceMergeJobMet
       ) as unknown) as string,
       text: ((
         <>
-          The force merge operation has taken more than one hour to complete. To see the latest status, use `GET /.tasks/_doc/
+          The force merge operation has taken more than one hour to complete. To see the latest status, use `GET /_tasks/
           {extras.taskId}`
         </>
       ) as unknown) as string,

public/JobHandler/callbacks/open.tsx

@@ -110,7 +110,7 @@ export const callbackForOpenTimeout: CallbackType = (job: OpenJobMetaData, { cor
         </>
       ) as unknown) as string,
       text: ((
-        <>Opening the index has taken more than one hour to complete. To see the latest status, use `GET /.tasks/_doc/{extras.taskId}`</>
+        <>Opening the index has taken more than one hour to complete. To see the latest status, use `GET /_tasks/{extras.taskId}`</>
       ) as unknown) as string,
     },
     {

public/JobHandler/callbacks/reindex.tsx

@@ -135,9 +135,7 @@ export const callbackForReindexTimeout: CallbackType = (job: ReindexJobMetaData,
         </>
       ) as unknown) as string,
       text: ((
-        <>
-          The reindex operation has taken more than one hour to complete. To see the latest status, use `GET /.tasks/_doc/{extras.taskId}`
-        </>
+        <>The reindex operation has taken more than one hour to complete. To see the latest status, use `GET /_tasks/{extras.taskId}`</>
       ) as unknown) as string,
     },
     {

public/JobHandler/callbacks/shrink.tsx

@@ -86,7 +86,7 @@ export const callbackForShrinkTimeout: CallbackType = (job: RecoveryJobMetaData,
         </>
       ) as unknown) as string,
       text: ((
-        <>The shrink operation has taken more than one hour to complete. To see the latest status, use `GET /.tasks/_doc/{extras.taskId}`</>
+        <>The shrink operation has taken more than one hour to complete. To see the latest status, use `GET /_tasks/{extras.taskId}`</>
       ) as unknown) as string,
     },
     {

public/JobHandler/callbacks/split.tsx

@@ -84,7 +84,7 @@ export const callbackForSplitTimeout: CallbackType = (job: RecoveryJobMetaData,
         </>
       ) as unknown) as string,
       text: ((
-        <>The split operation has taken more than one hour to complete. To see the latest status, use `GET /.tasks/_doc/{extras.taskId}`</>
+        <>The split operation has taken more than one hour to complete. To see the latest status, use `GET /_tasks/{extras.taskId}`</>
       ) as unknown) as string,
     },
     {

public/components/ContentPanel/ContentPanel.tsx

@@ -16,7 +16,7 @@ import {
   EuiTextColor,
 } from "@elastic/eui";
 
-interface ContentPanelProps {
+export interface ContentPanelProps {
   title?: string | JSX.Element;
   titleSize?: "xxxs" | "xxs" | "xs" | "s" | "m" | "l";
   subTitleText?: string | JSX.Element;

public/components/ContentPanel/index.ts

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import ContentPanel from "./ContentPanel";
+import ContentPanel, { ContentPanelProps } from "./ContentPanel";
 import ContentPanelActions from "./ContentPanelActions";
 
-export { ContentPanel, ContentPanelActions };
+export { ContentPanel, ContentPanelActions, ContentPanelProps };

public/components/FormGenerator/built_in_components/index.tsx

@@ -3,11 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import React, { forwardRef, useRef } from "react";
-import { EuiFieldNumber, EuiFieldText, EuiSwitch, EuiSelect, EuiText, EuiCheckbox } from "@elastic/eui";
+import { EuiFieldNumber, EuiFieldText, EuiSwitch, EuiSelect, EuiText, EuiCheckbox, EuiComboBoxOptionOption } from "@elastic/eui";
 import EuiToolTipWrapper, { IEuiToolTipWrapperProps } from "../../EuiToolTipWrapper";
 import EuiComboBox from "../../ComboBoxWithoutWarning";
 
-export type ComponentMapEnum = "Input" | "Number" | "Switch" | "Select" | "Text" | "ComboBoxSingle" | "CheckBox";
+export type ComponentMapEnum = "Input" | "Number" | "Switch" | "Select" | "Text" | "ComboBoxSingle" | "CheckBox" | "ComboBoxMultiple";
 
 export interface IFieldComponentProps extends IEuiToolTipWrapperProps {
   onChange: (val: IFieldComponentProps["value"], ...args: any) => void;
@@ -102,6 +102,58 @@ const componentMap: Record<ComponentMapEnum, React.ComponentType<IFieldComponent
       );
     })
   ) as React.ComponentType<IFieldComponentProps>,
+  ComboBoxMultiple: EuiToolTipWrapper(
+    forwardRef(
+      (
+        {
+          onChange,
+          value,
+          ...others
+        }: {
+          value?: string[];
+          options: EuiComboBoxOptionOption<string>[];
+          onChange: (val: string[], values: EuiComboBoxOptionOption<string>[], ...args: any) => void;
+        },
+        ref: React.Ref<any>
+      ) => {
+        return (
+          <EuiComboBox
+            onCreateOption={(searchValue) => {
+              const allOptions = others.options.reduce((total, current) => {
+                if (current.options) {
+                  return [...total, ...current.options];
+                } else {
+                  return [...total, current];
+                }
+              }, [] as EuiComboBoxOptionOption<string>[]);
+              const findItem = allOptions.find((item: { label: string }) => item.label === searchValue);
+              if (findItem) {
+                onChange(
+                  [...(value || []), searchValue],
+                  [
+                    ...allOptions.filter((item) => value?.includes(item.label)),
+                    {
+                      label: searchValue,
+                    },
+                  ]
+                );
+              }
+            }}
+            {...others}
+            ref={ref}
+            onChange={(selectedOptions) => {
+              onChange(selectedOptions.map((item) => item.value) as string[], selectedOptions);
+            }}
+            selectedOptions={
+              (value || [])
+                .map((item: string) => others.options.find((option) => option.value === item) || { label: item, value: item })
+                .filter((item) => item !== undefined) as EuiComboBoxOptionOption<string>[]
+            }
+          />
+        );
+      }
+    )
+  ) as React.ComponentType<IFieldComponentProps>,
 };
 
 export default componentMap;

public/components/FormGenerator/index.tsx

@@ -33,12 +33,12 @@ export interface IField {
   options?: Omit<IInitOption, "name">;
 }
 
-export interface IFormGeneratorProps<T> {
+export interface IFormGeneratorProps<T extends object = any> {
   formFields: IField[];
   resetValuesWhenPropsValueChange?: boolean;
   hasAdvancedSettings?: boolean;
   advancedSettingsProps?: IFormGeneratorAdvancedSettings<T>;
-  fieldProps?: FieldOption;
+  fieldProps?: FieldOption<T>;
   formProps?: EuiFormProps;
   value?: T;
   onChange?: (totalValue: IFormGeneratorProps<T>["value"], key?: FieldName, value?: any) => void;
@@ -48,7 +48,7 @@ export interface IFormGeneratorRef extends FieldInstance {}
 
 export { AllBuiltInComponents };
 
-function FormGenerator<T>(props: IFormGeneratorProps<T>, ref: React.Ref<IFormGeneratorRef>) {
+function FormGenerator<T extends object = any>(props: IFormGeneratorProps<T>, ref: React.Ref<IFormGeneratorRef>) {
   const { fieldProps, formFields, advancedSettingsProps } = props;
   const { blockedNameList } = advancedSettingsProps || {};
   const propsRef = useRef(props);
@@ -80,9 +80,9 @@ function FormGenerator<T>(props: IFormGeneratorProps<T>, ref: React.Ref<IFormGen
   useEffect(() => {
     if (!isEqual(field.getValues(), props.value)) {
       if (propsRef.current.resetValuesWhenPropsValueChange) {
-        field.resetValues(props.value);
+        field.resetValues(props.value as T);
       } else {
-        field.setValues(props.value);
+        field.setValues(props.value as T);
       }
     }
   }, [props.value]);
@@ -117,7 +117,7 @@ function FormGenerator<T>(props: IFormGeneratorProps<T>, ref: React.Ref<IFormGen
     });
   }, [formFields, field]);
 
-  const finalValue: T = useMemo(() => {
+  const finalValue = useMemo(() => {
     const value = field.getValues();
     if (!blockedNameList) {
       return field.getValues();
@@ -157,14 +157,14 @@ function FormGenerator<T>(props: IFormGeneratorProps<T>, ref: React.Ref<IFormGen
               "data-test-subj": "formNameAdvancedSettings",
               ...props.advancedSettingsProps?.rowProps,
             }}
-            value={finalValue}
+            value={finalValue as T}
             onChange={(val) => {
               const totalValue = field.getValues();
               const editorValue = omit(val || {}, blockedNameList || []);
               const resetValue = {
                 ...editorValue,
                 ...pick(totalValue, blockedNameList || []),
-              };
+              } as T;
               // update form field value to rerender
               field.resetValues(resetValue);
 
@@ -184,6 +184,6 @@ function FormGenerator<T>(props: IFormGeneratorProps<T>, ref: React.Ref<IFormGen
   );
 }
 
-export default forwardRef(FormGenerator) as <T>(
+export default forwardRef(FormGenerator) as <T extends object = any>(
   props: IFormGeneratorProps<T> & { ref?: React.Ref<IFormGeneratorRef> }
 ) => ReturnType<typeof FormGenerator>;