Add Job tagging to UI #2837
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,290 @@ | ||
| // Copyright 2018-2024 contributors to the Marquez project | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| import * as Redux from 'redux' | ||
| import { | ||
| Autocomplete, | ||
| AutocompleteChangeDetails, | ||
| AutocompleteChangeReason, | ||
| Checkbox, | ||
| TextField, | ||
| } from '@mui/material' | ||
| import { Box, createTheme } from '@mui/material' | ||
| import { IState } from '../../store/reducers' | ||
| import { Tag } from '../../types/api' | ||
| import { addJobTag, addTags, deleteJobTag } from '../../store/actionCreators' | ||
| import { bindActionCreators } from 'redux' | ||
| import { connect, useSelector } from 'react-redux' | ||
| import { useTheme } from '@emotion/react' | ||
| import Button from '@mui/material/Button' | ||
| import CheckBoxIcon from '@mui/icons-material/CheckBox' | ||
| import CheckBoxOutlineBlankIcon from '@mui/icons-material/CheckBoxOutlineBlank' | ||
| import Chip from '@mui/material/Chip' | ||
| import Dialog from '@mui/material/Dialog' | ||
| import DialogActions from '@mui/material/DialogActions' | ||
| import DialogContent from '@mui/material/DialogContent' | ||
| import DialogTitle from '@mui/material/DialogTitle' | ||
| import LocalOfferIcon from '@mui/icons-material/LocalOffer' | ||
| import MQText from '../core/text/MqText' | ||
| import MQTooltip from '../core/tooltip/MQTooltip' | ||
| import React, { useState } from 'react' | ||
| import Snackbar from '@mui/material/Snackbar' | ||
|
|
||
| interface JobTagsProps { | ||
| namespace: string | ||
| jobName: string | ||
| jobTags: string[] | ||
| } | ||
|
|
||
| interface DispatchProps { | ||
| deleteJobTag: typeof deleteJobTag | ||
| addJobTag: typeof addJobTag | ||
| addTags: typeof addTags | ||
| } | ||
|
|
||
| type IProps = JobTagsProps & DispatchProps | ||
|
|
||
| const JobTags: React.FC<IProps> = (props) => { | ||
| const { namespace, jobName, jobTags, deleteJobTag, addJobTag, addTags } = props | ||
|
|
||
| const [listTag, setListTag] = useState('') | ||
| const [openTagDesc, setOpenTagDesc] = useState(false) | ||
| const [tagDescription, setTagDescription] = useState('No Description') | ||
| const [selectedTags, setSelectedTags] = useState<string[]>(jobTags) | ||
|
|
||
| const handleButtonClick = () => { | ||
| setOpenTagDesc(true) | ||
| } | ||
|
|
||
| const [snackbarOpen, setSnackbarOpen] = useState(false) | ||
| const theme = createTheme(useTheme()) | ||
|
|
||
| const handleTagDescClose = () => { | ||
| setOpenTagDesc(false) | ||
| setListTag('') | ||
| setTagDescription('No Description') | ||
| } | ||
|
|
||
| const handleTagDescChange = (_event: any, value: string) => { | ||
| const selectedTagData = tagData.find((tag) => tag.name === value) | ||
| setListTag(value) | ||
| setTagDescription(selectedTagData ? selectedTagData.description : 'No Description') | ||
| } | ||
|
|
||
| const handleDescriptionChange = (event: any) => { | ||
|
Member
There was a problem hiding this comment. I think you can have an explicit type here, right? |
||
| setTagDescription(event.target.value) | ||
| } | ||
|
|
||
| const tagData = useSelector((state: IState) => | ||
| state.tags.tags.sort((a, b) => a.name.localeCompare(b.name)) | ||
| ) | ||
|
|
||
| const handleTagChange = ( | ||
| _event: React.SyntheticEvent, | ||
| _value: string[], | ||
| _reason: AutocompleteChangeReason, | ||
| details?: AutocompleteChangeDetails<string> | undefined | ||
| ) => { | ||
| if (details && _reason === 'removeOption') { | ||
| const newTag = details.option | ||
| const newSelectedTags = selectedTags.filter((tag) => newTag !== tag) | ||
| setSelectedTags(newSelectedTags) | ||
| deleteJobTag(namespace, jobName, newTag) | ||
| } else if (details && !selectedTags.includes(details.option)) { | ||
| const newTag = details.option | ||
| const newSelectedTags = [...selectedTags, newTag] | ||
| setSelectedTags(newSelectedTags) | ||
| addJobTag(namespace, jobName, newTag) | ||
| } | ||
| } | ||
|
|
||
| const handleDelete = (deletedTag: string) => { | ||
| const newSelectedTags = selectedTags.filter((tag) => deletedTag !== tag) | ||
|
|
||
| setSelectedTags(newSelectedTags) | ||
|
|
||
| deleteJobTag(namespace, jobName, deletedTag) | ||
| } | ||
|
|
||
| const addTag = () => { | ||
| addTags(listTag, tagDescription) | ||
| setSnackbarOpen(true) | ||
| setOpenTagDesc(false) | ||
| setListTag('') | ||
| setTagDescription('No Description') | ||
| } | ||
|
|
||
| const formatTags = (tags: string[], tag_desc: Tag[]) => { | ||
| return tags.map((tag, index) => { | ||
| const tagDescription = tag_desc.find((tagItem) => tagItem.name === tag) | ||
| const tooltipTitle = tagDescription?.description || 'No Tag Description' | ||
| return ( | ||
| <MQTooltip title={tooltipTitle} key={tag}> | ||
| <Chip | ||
| color={'primary'} | ||
| variant='outlined' | ||
| label={tag} | ||
| size='small' | ||
| onDelete={() => handleDelete(tag)} | ||
| style={{ | ||
| display: 'row', | ||
| marginLeft: index === 0 ? theme.spacing(0) : theme.spacing(1), | ||
| }} | ||
| /> | ||
| </MQTooltip> | ||
| ) | ||
| }) | ||
| } | ||
|
|
||
| return ( | ||
| <> | ||
| <Snackbar | ||
| open={snackbarOpen} | ||
| autoHideDuration={1000} | ||
| style={{ zIndex: theme.zIndex.snackbar }} | ||
| onClose={() => setSnackbarOpen(false)} | ||
| message={'Tag updated.'} | ||
| anchorOrigin={{ vertical: 'bottom', horizontal: 'left' }} | ||
| /> | ||
| <Box display={'flex'} alignItems='center' justifyContent='center' width={'100%'}> | ||
| <MQTooltip title='Edit a Tag' key='edit-tag'> | ||
| <Button | ||
| variant='outlined' | ||
| onClick={handleButtonClick} | ||
| color='primary' | ||
| sx={{ marginRight: '8px' }} | ||
| style={{ paddingTop: '6.75px', paddingBottom: '6.75px' }} | ||
| startIcon={<LocalOfferIcon />} | ||
| > | ||
| Edit Tag | ||
| </Button> | ||
| </MQTooltip> | ||
| <Autocomplete | ||
| multiple | ||
| disableCloseOnSelect | ||
| id='dataset-tags' | ||
| sx={{ flex: 1, width: 'auto' }} | ||
| limitTags={6} | ||
| autoHighlight | ||
| disableClearable | ||
| disablePortal | ||
| options={tagData.map((option) => option.name)} | ||
| value={selectedTags} | ||
| onChange={handleTagChange} | ||
| renderTags={(value: string[]) => formatTags(value, tagData)} | ||
| renderOption={(props, option, { selected }) => ( | ||
| <li {...props}> | ||
| <Checkbox | ||
| icon={<CheckBoxOutlineBlankIcon fontSize='small' />} | ||
| checkedIcon={<CheckBoxIcon fontSize='small' />} | ||
| style={{ marginRight: 4 }} | ||
| checked={selected} | ||
| /> | ||
| <div> | ||
| <MQText bold>{option}</MQText> | ||
| <MQText subdued overflowHidden> | ||
| {tagData.find((tagItem) => tagItem.name === option)?.description || | ||
| 'No Tag Description'} | ||
| </MQText> | ||
| </div> | ||
| </li> | ||
| )} | ||
| renderInput={(params) => ( | ||
| <TextField | ||
| variant={'outlined'} | ||
| {...params} | ||
| placeholder={selectedTags.length > 0 ? '' : 'Search Tags'} | ||
| InputProps={{ | ||
| ...params.InputProps, | ||
| }} | ||
| InputLabelProps={{ | ||
| shrink: true, | ||
| }} | ||
| size='small' | ||
| /> | ||
| )} | ||
| /> | ||
| </Box> | ||
| <Dialog | ||
| PaperProps={{ | ||
| sx: { backgroundColor: theme.palette.background.default, backgroundImage: 'none' }, | ||
| }} | ||
| open={openTagDesc} | ||
| fullWidth | ||
| maxWidth='sm' | ||
| onKeyDown={(event) => { | ||
| if (event.key === 'Escape') { | ||
| handleTagDescClose() | ||
| } | ||
| }} | ||
| > | ||
| <DialogTitle>Select a Tag to change</DialogTitle> | ||
| <DialogContent> | ||
| <MQText subheading>Tag</MQText> | ||
| <Autocomplete | ||
| options={tagData.map((option) => option.name)} | ||
| autoSelect | ||
| freeSolo | ||
| fullWidth | ||
| autoFocus | ||
| forcePopupIcon | ||
| onChange={handleTagDescChange} | ||
| renderInput={(params) => ( | ||
| <TextField | ||
| {...params} | ||
| placeholder={'Search for a Tag...or enter a new one.'} | ||
| autoFocus | ||
| margin='dense' | ||
| id='tag' | ||
| variant='outlined' | ||
| InputLabelProps={{ | ||
| ...params.InputProps, | ||
| shrink: false, | ||
| }} | ||
| /> | ||
| )} | ||
| /> | ||
| <MQText subheading bottomMargin> | ||
| Description | ||
| </MQText> | ||
|
Member
There was a problem hiding this comment. I was thinking we may want to use the |
||
| <TextField | ||
| multiline | ||
| id='tag-description' | ||
| name='tag-description' | ||
| fullWidth | ||
| variant='outlined' | ||
| placeholder={'No Description'} | ||
| onChange={handleDescriptionChange} | ||
| rows={6} | ||
| value={tagDescription} | ||
| InputProps={{ | ||
| style: { padding: '12px 16px' }, | ||
| }} | ||
| InputLabelProps={{ | ||
| shrink: false, | ||
| }} | ||
| /> | ||
| </DialogContent> | ||
| <DialogActions> | ||
| <Button color='primary' onClick={addTag} disabled={listTag === ''}> | ||
| Submit | ||
| </Button> | ||
| <Button color='primary' onClick={handleTagDescClose}> | ||
| Cancel | ||
| </Button> | ||
| </DialogActions> | ||
| </Dialog> | ||
| </> | ||
| ) | ||
| } | ||
|
|
||
| const mapDispatchToProps = (dispatch: Redux.Dispatch) => | ||
| bindActionCreators( | ||
| { | ||
| deleteJobTag: deleteJobTag, | ||
| addJobTag: addJobTag, | ||
| addTags: addTags, | ||
| }, | ||
| dispatch | ||
| ) | ||
|
|
||
| export default connect(null, mapDispatchToProps)(JobTags) | ||
This file contains hidden or 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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"No description" is kind of a description in and of itself, is this what you want out of this, would you prefer if it was just empty?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah that's my data hat talking - can leave blank.