[FEATURE] Add annotation support #120
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
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,273 @@ | ||
| // Copyright 2024 The Perses Authors | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| import { useState, useMemo, ReactElement } from 'react'; | ||
| import { | ||
| Button, | ||
| Stack, | ||
| Box, | ||
| TableContainer, | ||
| TableBody, | ||
| TableRow, | ||
| TableCell as MuiTableCell, | ||
| Table, | ||
| TableHead, | ||
| Switch, | ||
| Typography, | ||
| IconButton, | ||
| Alert, | ||
| styled, | ||
| } from '@mui/material'; | ||
| import AddIcon from 'mdi-material-ui/Plus'; | ||
| import { Action } from '@perses-dev/core'; | ||
| import { AnnotationSpec, Definition, UnknownSpec } from '@perses-dev/spec'; | ||
| import { useImmer } from 'use-immer'; | ||
| import PencilIcon from 'mdi-material-ui/Pencil'; | ||
| import TrashIcon from 'mdi-material-ui/TrashCan'; | ||
| import ArrowUp from 'mdi-material-ui/ArrowUp'; | ||
| import ArrowDown from 'mdi-material-ui/ArrowDown'; | ||
|
|
||
| import { ValidationProvider, AnnotationEditorForm } from '@perses-dev/plugin-system'; | ||
| import { useDiscardChangesConfirmationDialog } from '../../context'; | ||
|
|
||
| function getValidation(annotationSpecs: AnnotationSpec[]): { isValid: boolean; errors: string[] } { | ||
|
Contributor
There was a problem hiding this comment. The function name is vague. |
||
| const errors: string[] = []; | ||
|
|
||
| /** Annotation names must be unique */ | ||
| const annotationNames = annotationSpecs.map((annotationSpec) => annotationSpec.display.name); | ||
| const uniqueAnnotationNames = new Set(annotationNames); | ||
| if (annotationNames.length !== uniqueAnnotationNames.size) { | ||
| errors.push('Annotation names must be unique'); | ||
| } | ||
|
Comment on lines
+44
to
+51
Contributor
There was a problem hiding this comment. The error message |
||
| return { | ||
| errors: errors, | ||
| isValid: errors.length === 0, | ||
| }; | ||
| } | ||
|
|
||
| export function AnnotationEditor(props: { | ||
| annotationSpecs: AnnotationSpec[]; | ||
| onChange: (annotationSpecs: AnnotationSpec[]) => void; | ||
| onCancel: () => void; | ||
| }): ReactElement { | ||
| const [annotationSpecs, setAnnotationSpecs] = useImmer(props.annotationSpecs); | ||
| const [annotationEditIdx, setAnnotationEditIdx] = useState<number | null>(null); | ||
| const [annotationFormAction, setAnnotationFormAction] = useState<Action>('update'); | ||
|
|
||
| const validation = useMemo(() => getValidation(annotationSpecs), [annotationSpecs]); | ||
| const currentEditingAnnotationSpec: AnnotationSpec | undefined = | ||
| annotationEditIdx !== null ? annotationSpecs[annotationEditIdx] : undefined; | ||
|
|
||
| const { openDiscardChangesConfirmationDialog, closeDiscardChangesConfirmationDialog } = | ||
| useDiscardChangesConfirmationDialog(); | ||
| const handleCancel = (): void => { | ||
| if (JSON.stringify(props.annotationSpecs) !== JSON.stringify(annotationSpecs)) { | ||
| openDiscardChangesConfirmationDialog({ | ||
| onDiscardChanges: () => { | ||
| closeDiscardChangesConfirmationDialog(); | ||
| props.onCancel(); | ||
| }, | ||
| onCancel: () => { | ||
| closeDiscardChangesConfirmationDialog(); | ||
| }, | ||
| description: | ||
| 'You have unapplied changes. Are you sure you want to discard these changes? Changes cannot be recovered.', | ||
| }); | ||
| } else { | ||
| props.onCancel(); | ||
| } | ||
| }; | ||
|
|
||
| const removeAnnotation = (index: number): void => { | ||
| setAnnotationSpecs((draft) => { | ||
| draft.splice(index, 1); | ||
| }); | ||
| }; | ||
|
|
||
| const addAnnotation = (): void => { | ||
| setAnnotationFormAction('create'); | ||
| setAnnotationSpecs((draft) => { | ||
| draft.push({ | ||
| display: { name: 'NewAnnotation' }, | ||
| plugin: {} as Definition<UnknownSpec>, | ||
| }); | ||
| }); | ||
| setAnnotationEditIdx(annotationSpecs.length); | ||
| }; | ||
|
|
||
| const editAnnotation = (index: number): void => { | ||
| setAnnotationFormAction('update'); | ||
| setAnnotationEditIdx(index); | ||
| }; | ||
|
|
||
| const toggleAnnotationVisibility = (index: number, visible: boolean): void => { | ||
| setAnnotationSpecs((draft) => { | ||
| const v = draft[index]; | ||
| if (!v) { | ||
| return; | ||
| } | ||
| v.display.hidden = !visible; | ||
| }); | ||
| }; | ||
|
|
||
| const changeAnnotationOrder = (index: number, direction: 'up' | 'down'): void => { | ||
| setAnnotationSpecs((draft) => { | ||
| if (direction === 'up') { | ||
| const prevElement = draft[index - 1]; | ||
| const currentElement = draft[index]; | ||
| if (index === 0 || !prevElement || !currentElement) { | ||
| return; | ||
| } | ||
| draft[index - 1] = currentElement; | ||
| draft[index] = prevElement; | ||
| } else { | ||
| const nextElement = draft[index + 1]; | ||
| const currentElement = draft[index]; | ||
| if (index === draft.length - 1 || !nextElement || !currentElement) { | ||
| return; | ||
| } | ||
| draft[index + 1] = currentElement; | ||
| draft[index] = nextElement; | ||
| } | ||
| }); | ||
| }; | ||
|
Comment on lines
+123
to
+143
Contributor
There was a problem hiding this comment. The code could be shortened and optimized by generating the target indexes dynamically. const changeAnnotationOrder = (index: number, direction: 'up' | 'down'): void => {
const step = direction === 'up' ? -1 : 1;
setAnnotationSpecs((draft) => {
const current = draft[index];
const adjacent = draft[index + step];
if (!current || !adjacent) {
return;
}
draft[index + step] = current;
draft[index] = adjacent;
});
setAnnotationEditIdx(index + step);
}; |
||
|
|
||
| return ( | ||
| <> | ||
| {annotationEditIdx !== null && currentEditingAnnotationSpec ? ( | ||
| <ValidationProvider> | ||
| <AnnotationEditorForm | ||
| initialAnnotationSpec={currentEditingAnnotationSpec} | ||
| action={annotationFormAction} | ||
| isDraft={true} | ||
| onActionChange={setAnnotationFormAction} | ||
| onSave={(definition: AnnotationSpec) => { | ||
| setAnnotationSpecs((draft) => { | ||
| draft[annotationEditIdx] = definition; | ||
| setAnnotationEditIdx(null); | ||
| }); | ||
| }} | ||
| onClose={() => { | ||
| if (annotationFormAction === 'create') { | ||
| removeAnnotation(annotationEditIdx); | ||
| } | ||
| setAnnotationEditIdx(null); | ||
| }} | ||
| /> | ||
| </ValidationProvider> | ||
| ) : ( | ||
| <> | ||
| <Box | ||
| sx={{ | ||
| display: 'flex', | ||
| alignItems: 'center', | ||
| padding: (theme) => theme.spacing(1, 2), | ||
| borderBottom: (theme) => `1px solid ${theme.palette.divider}`, | ||
| }} | ||
| > | ||
| <Typography variant="h2">Edit Dashboard Annotations</Typography> | ||
| <Stack direction="row" spacing={1} marginLeft="auto"> | ||
| <Button | ||
| disabled={props.annotationSpecs === annotationSpecs || !validation.isValid} | ||
| variant="contained" | ||
| onClick={() => { | ||
| props.onChange(annotationSpecs); | ||
| }} | ||
| > | ||
| Apply | ||
| </Button> | ||
| <Button color="secondary" variant="outlined" onClick={handleCancel}> | ||
| Cancel | ||
| </Button> | ||
| </Stack> | ||
| </Box> | ||
| <Box padding={2} sx={{ overflowY: 'scroll' }}> | ||
| <Stack spacing={2}> | ||
| <Stack spacing={2}> | ||
| {!validation.isValid && | ||
| validation.errors.map((error) => ( | ||
| <Alert severity="error" key={error}> | ||
| {error} | ||
| </Alert> | ||
| ))} | ||
| <TableContainer> | ||
| <Table sx={{ minWidth: 650 }} aria-label="table of annotations"> | ||
| <TableHead> | ||
| <TableRow> | ||
| <TableCell>Visibility</TableCell> | ||
| <TableCell>Name</TableCell> | ||
| <TableCell>Type</TableCell> | ||
| <TableCell>Description</TableCell> | ||
| <TableCell align="right">Actions</TableCell> | ||
| </TableRow> | ||
| </TableHead> | ||
| <TableBody> | ||
| {annotationSpecs.map((v, idx) => ( | ||
| <TableRow key={v.display.name}> | ||
| <TableCell component="th" scope="row"> | ||
| <Switch | ||
| checked={v.display?.hidden !== true} | ||
| onChange={(e) => { | ||
| toggleAnnotationVisibility(idx, e.target.checked); | ||
| }} | ||
| /> | ||
| </TableCell> | ||
| <TableCell component="th" scope="row" sx={{ fontWeight: 'bold' }}> | ||
| {v.display.name} | ||
| </TableCell> | ||
| <TableCell>{v.plugin.kind}</TableCell> | ||
| <TableCell>{v.display?.description ?? ''}</TableCell> | ||
| <TableCell align="right" sx={{ whiteSpace: 'nowrap' }}> | ||
| <IconButton onClick={() => changeAnnotationOrder(idx, 'up')} disabled={idx === 0}> | ||
| <ArrowUp /> | ||
| </IconButton> | ||
| <IconButton | ||
| onClick={() => changeAnnotationOrder(idx, 'down')} | ||
| disabled={idx === annotationSpecs.length - 1} | ||
| > | ||
| <ArrowDown /> | ||
| </IconButton> | ||
| <IconButton onClick={() => editAnnotation(idx)}> | ||
| <PencilIcon /> | ||
| </IconButton> | ||
| <IconButton onClick={() => removeAnnotation(idx)}> | ||
| <TrashIcon /> | ||
| </IconButton> | ||
| </TableCell> | ||
| </TableRow> | ||
| ))} | ||
| </TableBody> | ||
| </Table> | ||
| </TableContainer> | ||
| <Box display="flex"> | ||
| <Button | ||
| variant="contained" | ||
| startIcon={<AddIcon />} | ||
| sx={{ marginLeft: 'auto' }} | ||
| onClick={addAnnotation} | ||
| > | ||
| Add Annotation | ||
| </Button> | ||
| </Box> | ||
| </Stack> | ||
| </Stack> | ||
| </Box> | ||
| </> | ||
| )} | ||
| </> | ||
| ); | ||
| } | ||
|
|
||
| const TableCell = styled(MuiTableCell)(({ theme }) => ({ | ||
| borderBottom: `solid 1px ${theme.palette.divider}`, | ||
| })); | ||
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.
Actionis available in Perses/Shared/ComponentsPlease avoid using
Core