|
| 1 | +/* |
| 2 | + * Copyright OpenSearch Contributors |
| 3 | + * SPDX-License-Identifier: Apache-2.0 |
| 4 | + */ |
| 5 | + |
| 6 | +import React, { useEffect, useState } from 'react'; |
| 7 | +import * as yup from 'yup'; |
| 8 | +import { Formik, getIn, useFormikContext } from 'formik'; |
| 9 | +import { isEmpty } from 'lodash'; |
| 10 | +import { |
| 11 | + EuiFlexGroup, |
| 12 | + EuiFlexItem, |
| 13 | + EuiModal, |
| 14 | + EuiModalHeader, |
| 15 | + EuiModalHeaderTitle, |
| 16 | + EuiModalBody, |
| 17 | + EuiModalFooter, |
| 18 | + EuiSmallButtonEmpty, |
| 19 | + EuiSmallButton, |
| 20 | +} from '@elastic/eui'; |
| 21 | +import { |
| 22 | + MAX_STRING_LENGTH, |
| 23 | + Workflow, |
| 24 | + WORKFLOW_NAME_REGEXP, |
| 25 | + WorkflowConfig, |
| 26 | + WorkflowFormValues, |
| 27 | + WorkflowTemplate, |
| 28 | +} from '../../../../common'; |
| 29 | +import { |
| 30 | + formikToUiConfig, |
| 31 | + getDataSourceId, |
| 32 | + getInitialValue, |
| 33 | +} from '../../../utils'; |
| 34 | +import { TextField } from '../workflow_inputs/input_fields'; |
| 35 | +import { getWorkflow, updateWorkflow, useAppDispatch } from '../../../store'; |
| 36 | + |
| 37 | +interface EditWorkflowMetadataModalProps { |
| 38 | + workflow?: Workflow; |
| 39 | + setIsModalOpen(isOpen: boolean): void; |
| 40 | +} |
| 41 | +/** |
| 42 | + * Modal to allow editing workflow metadata, like name & description. |
| 43 | + */ |
| 44 | +export function EditWorkflowMetadataModal( |
| 45 | + props: EditWorkflowMetadataModalProps |
| 46 | +) { |
| 47 | + const dispatch = useAppDispatch(); |
| 48 | + const dataSourceId = getDataSourceId(); |
| 49 | + const { values } = useFormikContext<WorkflowFormValues>(); |
| 50 | + |
| 51 | + // sub-form values/schema |
| 52 | + const metadataFormValues = { |
| 53 | + name: getInitialValue('string'), |
| 54 | + description: getInitialValue('string'), |
| 55 | + }; |
| 56 | + const metadataFormSchema = yup.object({ |
| 57 | + name: yup |
| 58 | + .string() |
| 59 | + .test('workflowName', 'Invalid workflow name', (name) => { |
| 60 | + return !( |
| 61 | + name === undefined || |
| 62 | + name === '' || |
| 63 | + name.length > 100 || |
| 64 | + WORKFLOW_NAME_REGEXP.test(name) === false |
| 65 | + ); |
| 66 | + }) |
| 67 | + .required('Required') as yup.Schema, |
| 68 | + desription: yup |
| 69 | + .string() |
| 70 | + .trim() |
| 71 | + .min(0) |
| 72 | + .max(MAX_STRING_LENGTH, 'Too long') |
| 73 | + .optional() as yup.Schema, |
| 74 | + }) as yup.Schema; |
| 75 | + |
| 76 | + // persist standalone values |
| 77 | + const [tempName, setTempName] = useState<string>(props.workflow?.name || ''); |
| 78 | + const [tempDescription, setTempDescription] = useState<string>( |
| 79 | + props.workflow?.description || '' |
| 80 | + ); |
| 81 | + const [tempErrors, setTempErrors] = useState<boolean>(false); |
| 82 | + |
| 83 | + // button updating state |
| 84 | + const [isUpdating, setIsUpdating] = useState<boolean>(false); |
| 85 | + |
| 86 | + // if saving, take the updated name/description (along with any other unsaved form values) |
| 87 | + // and execute the update. |
| 88 | + async function onSave() { |
| 89 | + setIsUpdating(true); |
| 90 | + const updatedTemplate = { |
| 91 | + name: tempName, |
| 92 | + description: tempDescription, |
| 93 | + ui_metadata: { |
| 94 | + ...props.workflow?.ui_metadata, |
| 95 | + config: formikToUiConfig( |
| 96 | + values, |
| 97 | + props.workflow?.ui_metadata?.config as WorkflowConfig |
| 98 | + ), |
| 99 | + }, |
| 100 | + } as WorkflowTemplate; |
| 101 | + await dispatch( |
| 102 | + updateWorkflow({ |
| 103 | + apiBody: { |
| 104 | + workflowId: props.workflow?.id as string, |
| 105 | + workflowTemplate: updatedTemplate, |
| 106 | + updateFields: true, |
| 107 | + reprovision: false, |
| 108 | + }, |
| 109 | + dataSourceId, |
| 110 | + }) |
| 111 | + ) |
| 112 | + .unwrap() |
| 113 | + .then(async (result) => { |
| 114 | + new Promise((f) => setTimeout(f, 1000)).then(async () => { |
| 115 | + dispatch( |
| 116 | + getWorkflow({ |
| 117 | + workflowId: props.workflow?.id as string, |
| 118 | + dataSourceId, |
| 119 | + }) |
| 120 | + ); |
| 121 | + }); |
| 122 | + }) |
| 123 | + .catch((error: any) => { |
| 124 | + console.error('Error updating workflow: ', error); |
| 125 | + }) |
| 126 | + .finally(() => { |
| 127 | + setIsUpdating(false); |
| 128 | + props.setIsModalOpen(false); |
| 129 | + }); |
| 130 | + } |
| 131 | + |
| 132 | + return ( |
| 133 | + <Formik |
| 134 | + enableReinitialize={false} |
| 135 | + initialValues={metadataFormValues} |
| 136 | + validationSchema={metadataFormSchema} |
| 137 | + onSubmit={(values) => {}} |
| 138 | + validate={(values) => {}} |
| 139 | + > |
| 140 | + {(formikProps) => { |
| 141 | + // override to parent form values when changes detected |
| 142 | + useEffect(() => { |
| 143 | + formikProps.setFieldValue('name', props.workflow?.name); |
| 144 | + }, [props.workflow?.name]); |
| 145 | + useEffect(() => { |
| 146 | + formikProps.setFieldValue('description', props.workflow?.description); |
| 147 | + }, [props.workflow?.description]); |
| 148 | + |
| 149 | + // update temp vars when form changes are detected |
| 150 | + useEffect(() => { |
| 151 | + setTempName(getIn(formikProps.values, 'name')); |
| 152 | + }, [getIn(formikProps.values, 'name')]); |
| 153 | + useEffect(() => { |
| 154 | + setTempDescription(getIn(formikProps.values, 'description')); |
| 155 | + }, [getIn(formikProps.values, 'description')]); |
| 156 | + |
| 157 | + // update tempErrors if errors detected |
| 158 | + useEffect(() => { |
| 159 | + setTempErrors(!isEmpty(formikProps.errors)); |
| 160 | + }, [formikProps.errors]); |
| 161 | + |
| 162 | + return ( |
| 163 | + <EuiModal |
| 164 | + maxWidth={false} |
| 165 | + style={{ width: '50vw' }} |
| 166 | + onClose={() => props.setIsModalOpen(false)} |
| 167 | + > |
| 168 | + <EuiModalHeader> |
| 169 | + <EuiModalHeaderTitle> |
| 170 | + <p>Update workflow metadata</p> |
| 171 | + </EuiModalHeaderTitle> |
| 172 | + </EuiModalHeader> |
| 173 | + <EuiModalBody> |
| 174 | + <EuiFlexGroup direction="column"> |
| 175 | + <EuiFlexItem> |
| 176 | + <TextField |
| 177 | + label="Workflow name" |
| 178 | + fullWidth={false} |
| 179 | + fieldPath={`name`} |
| 180 | + showError={true} |
| 181 | + /> |
| 182 | + </EuiFlexItem> |
| 183 | + <EuiFlexItem> |
| 184 | + <TextField |
| 185 | + label="Workflow description" |
| 186 | + fullWidth={true} |
| 187 | + fieldPath={`description`} |
| 188 | + showError={true} |
| 189 | + /> |
| 190 | + </EuiFlexItem> |
| 191 | + </EuiFlexGroup> |
| 192 | + </EuiModalBody> |
| 193 | + <EuiModalFooter> |
| 194 | + <EuiSmallButtonEmpty |
| 195 | + onClick={() => props.setIsModalOpen(false)} |
| 196 | + color="primary" |
| 197 | + data-testid="closeEditMetadataButton" |
| 198 | + > |
| 199 | + Cancel |
| 200 | + </EuiSmallButtonEmpty> |
| 201 | + <EuiSmallButton |
| 202 | + onClick={() => { |
| 203 | + formikProps |
| 204 | + .submitForm() |
| 205 | + .then(() => { |
| 206 | + onSave(); |
| 207 | + }) |
| 208 | + .catch((err: any) => {}); |
| 209 | + }} |
| 210 | + isLoading={isUpdating} |
| 211 | + isDisabled={tempErrors} // blocking update until valid input is given |
| 212 | + fill={true} |
| 213 | + color="primary" |
| 214 | + data-testid="updateEditMetadataButton" |
| 215 | + > |
| 216 | + Save |
| 217 | + </EuiSmallButton> |
| 218 | + </EuiModalFooter> |
| 219 | + </EuiModal> |
| 220 | + ); |
| 221 | + }} |
| 222 | + </Formik> |
| 223 | + ); |
| 224 | +} |
0 commit comments