[FEATURE] Add annotation support#120
Draft
Gladorme wants to merge 8 commits into
Draft
Conversation
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
This was referenced Apr 27, 2026
shahrokni
reviewed
May 22, 2026
Comment on lines
+44
to
+51
| 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'); | ||
| } |
Contributor
There was a problem hiding this comment.
The error message Annotation names must be unique is vague.
The captured error should clarify what exact annotations are redundant.
You can either .join(',') the redundant or push individual errors into the array.
It should be feasible to collect the duplicates by O(N)
shahrokni
reviewed
May 22, 2026
Comment on lines
+31
to
+32
| import AddIcon from 'mdi-material-ui/Plus'; | ||
| import { Action } from '@perses-dev/core'; |
Contributor
There was a problem hiding this comment.
Action is available in Perses/Shared/Components
Please avoid using Core
import { Action } from '@perses-dev/components';| 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. getValidation sounds like a function which returns a validation function.
Here the function simply validates the annotationSpecs. So, it could be validateAnnotationSpecs
Comment on lines
+123
to
+143
| 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; | ||
| } | ||
| }); | ||
| }; |
Contributor
There was a problem hiding this comment.
The code could be shortened and optimized by generating the target indexes dynamically.
Also, the code should probably annotationEditIdx
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);
};
shahrokni
reviewed
May 22, 2026
Comment on lines
+18
to
+37
| export function AnnotationHydrationWrapper({ children }: AnnotationHydrationWrapperProps): ReactNode { | ||
| const annotationSpecs = useAnnotationSpecs(); | ||
| const { setAnnotationState } = useAnnotationActions(); | ||
| const annotations: Array<UseQueryResult<AnnotationData[]>> = useAnnotations(annotationSpecs); | ||
|
|
||
| useEffect(() => { | ||
| for (const [index, definition] of annotationSpecs.entries()) { | ||
| const query = annotations[index] ?? null; | ||
| if (query) { | ||
| setAnnotationState(definition.display.name, { | ||
| data: query.data ?? null, | ||
| isPending: query.isLoading, | ||
| error: (query?.error as Error) ?? null, | ||
| }); | ||
| } | ||
| } | ||
| }, [annotationSpecs, annotations, setAnnotationState]); | ||
|
|
||
| return <>{children}</>; | ||
| } |
shahrokni
reviewed
May 22, 2026
Comment on lines
+1
to
+2
| // Copyright 2025 The Perses Authors | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); |
Contributor
There was a problem hiding this comment.
Should the file be removed?
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Adding Annotation support with Provider, Editor, ...
PR related to:
Screenshots
Checklist
[<catalog_entry>] <commit message>naming convention using one of thefollowing
catalog_entryvalues:FEATURE,ENHANCEMENT,BUGFIX,BREAKINGCHANGE,DOC,IGNORE.UI Changes
See e2e docs for more details. Common issues include: