-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support importing local workflow templates (#208)
Signed-off-by: Tyler Ohlsen <[email protected]>
- Loading branch information
Showing
8 changed files
with
351 additions
and
89 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
163 changes: 163 additions & 0 deletions
163
public/pages/workflows/import_workflow/import_workflow_modal.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import React, { useEffect, useState } from 'react'; | ||
| import { | ||
| EuiSpacer, | ||
| EuiFlexGroup, | ||
| EuiButtonEmpty, | ||
| EuiButton, | ||
| EuiText, | ||
| EuiModal, | ||
| EuiModalHeader, | ||
| EuiModalHeaderTitle, | ||
| EuiModalBody, | ||
| EuiModalFooter, | ||
| EuiFilePicker, | ||
| EuiCallOut, | ||
| EuiFlexItem, | ||
| } from '@elastic/eui'; | ||
| import { | ||
| getObjFromJsonOrYamlString, | ||
| isValidUiWorkflow, | ||
| isValidWorkflow, | ||
| } from '../../../utils'; | ||
| import { getCore } from '../../../services'; | ||
| import { | ||
| createWorkflow, | ||
| searchWorkflows, | ||
| useAppDispatch, | ||
| } from '../../../store'; | ||
| import { FETCH_ALL_QUERY_BODY, Workflow } from '../../../../common'; | ||
| import { WORKFLOWS_TAB } from '../workflows'; | ||
|
|
||
| interface ImportWorkflowModalProps { | ||
| isImportModalOpen: boolean; | ||
| setIsImportModalOpen(isOpen: boolean): void; | ||
| setSelectedTabId(tabId: WORKFLOWS_TAB): void; | ||
| } | ||
|
|
||
| /** | ||
| * The import workflow modal. Allows uploading local JSON or YAML files to be uploaded, parsed, and | ||
| * created as new workflows. Automatic validation is handled to: | ||
| * 1/ allow upload (valid workflow with UI data), | ||
| * 2/ warn and allow upload (valid workflow but missing/no UI data), and | ||
| * 3/ prevent upload (invalid workflow). | ||
| */ | ||
| export function ImportWorkflowModal(props: ImportWorkflowModalProps) { | ||
| const dispatch = useAppDispatch(); | ||
|
|
||
| // file contents & file obj state | ||
| const [fileContents, setFileContents] = useState<string | undefined>( | ||
| undefined | ||
| ); | ||
| const [fileObj, setFileObj] = useState<object | undefined>(undefined); | ||
| useEffect(() => { | ||
| setFileObj(getObjFromJsonOrYamlString(fileContents)); | ||
| }, [fileContents]); | ||
|
|
||
| // file reader to read the file and set the fileContents var | ||
| const fileReader = new FileReader(); | ||
| fileReader.onload = (e) => { | ||
| if (e.target) { | ||
| setFileContents(e.target.result as string); | ||
| } | ||
| }; | ||
|
|
||
| function onModalClose(): void { | ||
| props.setIsImportModalOpen(false); | ||
| setFileContents(undefined); | ||
| setFileObj(undefined); | ||
| } | ||
|
|
||
| return ( | ||
| <EuiModal onClose={() => onModalClose()} style={{ width: '40vw' }}> | ||
| <EuiModalHeader> | ||
| <EuiModalHeaderTitle> | ||
| <p>{`Import a workflow (JSON/YAML)`}</p> | ||
| </EuiModalHeaderTitle> | ||
| </EuiModalHeader> | ||
| <EuiModalBody> | ||
| <EuiFlexGroup | ||
| direction="column" | ||
| justifyContent="center" | ||
| alignItems="center" | ||
| > | ||
| {fileContents !== undefined && !isValidWorkflow(fileObj) && ( | ||
| <> | ||
| <EuiFlexItem> | ||
| <EuiCallOut | ||
| title="The uploaded file is not a valid workflow, remove the file and upload a compatible workflow in JSON or YAML format." | ||
| iconType={'alert'} | ||
| color="danger" | ||
| /> | ||
| </EuiFlexItem> | ||
| <EuiSpacer size="m" /> | ||
| </> | ||
| )} | ||
| {isValidWorkflow(fileObj) && !isValidUiWorkflow(fileObj) && ( | ||
| <> | ||
| <EuiFlexItem> | ||
| <EuiCallOut | ||
| title="The uploaded file may not be compatible with Search Studio. You may not be able to edit or run this file with Search Studio." | ||
| iconType={'help'} | ||
| color="warning" | ||
| /> | ||
| </EuiFlexItem> | ||
| <EuiSpacer size="m" /> | ||
| </> | ||
| )} | ||
| <EuiFlexItem grow={false}> | ||
| <EuiFilePicker | ||
| multiple={false} | ||
| initialPromptText="Select or drag and drop a file" | ||
| onChange={(files) => { | ||
| if (files && files.length > 0) { | ||
| fileReader.readAsText(files[0]); | ||
| } | ||
| }} | ||
| display="large" | ||
| /> | ||
| </EuiFlexItem> | ||
| <EuiFlexItem> | ||
| <EuiText size="s" color="subdued"> | ||
| Must be in JSON or YAML format. | ||
| </EuiText> | ||
| </EuiFlexItem> | ||
| </EuiFlexGroup> | ||
| </EuiModalBody> | ||
| <EuiModalFooter> | ||
| <EuiButtonEmpty onClick={() => onModalClose()}>Cancel</EuiButtonEmpty> | ||
| <EuiButton | ||
| disabled={!isValidWorkflow(fileObj)} | ||
| onClick={() => { | ||
| dispatch(createWorkflow(fileObj as Workflow)) | ||
| .unwrap() | ||
| .then((result) => { | ||
| const { workflow } = result; | ||
| dispatch(searchWorkflows(FETCH_ALL_QUERY_BODY)); | ||
| props.setSelectedTabId(WORKFLOWS_TAB.MANAGE); | ||
| getCore().notifications.toasts.addSuccess( | ||
| `Successfully imported ${workflow.name}` | ||
| ); | ||
| }) | ||
| .catch((error: any) => { | ||
| getCore().notifications.toasts.addDanger(error); | ||
| }) | ||
| .finally(() => { | ||
| onModalClose(); | ||
| }); | ||
| }} | ||
| fill={true} | ||
| color="primary" | ||
| > | ||
| {isValidWorkflow(fileObj) && !isValidUiWorkflow(fileObj) | ||
| ? 'Import anyway' | ||
| : 'Import'} | ||
| </EuiButton> | ||
| </EuiModalFooter> | ||
| </EuiModal> | ||
| ); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| export { ImportWorkflowModal } from './import_workflow_modal'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.