Skip to content
This repository was archived by the owner on Jan 19, 2025. It is now read-only.

feat(gui): only add author when annotation was actually changed #977

Merged
merged 5 commits into from
Jul 9, 2022
Merged

feat(gui): only add author when annotation was actually changed #977

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dd5fdba
build(gui): add lodash for object equality check
lars-reimann Jul 9, 2022
ef40293
feat(gui): only add author when annotation was actually changed
lars-reimann Jul 9, 2022
a7d356c
fix(gui): only increase counter for changed annotations if annotation…
lars-reimann Jul 9, 2022
a9af7c5
refactor(gui): function now does what its name suggests
lars-reimann Jul 9, 2022
a437bed
style: apply automatic fixes of linters
lars-reimann Jul 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions api-editor/gui/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions api-editor/gui/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
"framer-motion": "^6.3.16",
"idb-keyval": "^6.2.0",
"katex": "^0.16.0",
"lodash": "^4.17.21",
"react": "^18.2.0",
"react-chartjs-2": "^4.2.0",
"react-dom": "^18.2.0",
Expand Down
125 changes: 106 additions & 19 deletions api-editor/gui/src/features/annotations/annotationSlice.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import {
ValueAnnotation,
} from './versioning/AnnotationStoreV2';
import { migrateAnnotationStoreToCurrentVersion } from './versioning/migrations';
import { isEqual } from 'lodash/fp';

export const EXPECTED_ANNOTATION_SLICE_SCHEMA_VERSION = 1;

Expand Down Expand Up @@ -167,7 +168,11 @@ const annotationsSlice = createSlice({
updateQueue(state);
},
upsertBoundaryAnnotation(state, action: PayloadAction<BoundaryAnnotation>) {
updateCreationOrChangedCount(state, state.annotations.boundaryAnnotations[action.payload.target]);
updateCreationOrChangedCount(
state,
state.annotations.boundaryAnnotations[action.payload.target],
action.payload,
);

state.annotations.boundaryAnnotations[action.payload.target] = withAuthorAndReviewers(
state.annotations.boundaryAnnotations[action.payload.target],
Expand Down Expand Up @@ -204,7 +209,7 @@ const annotationsSlice = createSlice({
state.annotations.calledAfterAnnotations[action.payload.annotation.target] = {};
}

updateCreationOrChangedCount(state, oldAnnotation);
updateCreationOrChangedCount(state, oldAnnotation, action.payload.annotation);

state.annotations.calledAfterAnnotations[action.payload.annotation.target][
action.payload.annotation.calledAfterName
Expand Down Expand Up @@ -282,7 +287,11 @@ const annotationsSlice = createSlice({
},
// Cannot review complete annotations
upsertDescriptionAnnotation(state, action: PayloadAction<DescriptionAnnotation>) {
updateCreationOrChangedCount(state, state.annotations.descriptionAnnotations[action.payload.target]);
updateCreationOrChangedCount(
state,
state.annotations.descriptionAnnotations[action.payload.target],
action.payload,
);

state.annotations.descriptionAnnotations[action.payload.target] = withAuthorAndReviewers(
state.annotations.descriptionAnnotations[action.payload.target],
Expand All @@ -307,7 +316,11 @@ const annotationsSlice = createSlice({
updateQueue(state);
},
upsertEnumAnnotation(state, action: PayloadAction<EnumAnnotation>) {
updateCreationOrChangedCount(state, state.annotations.enumAnnotations[action.payload.target]);
updateCreationOrChangedCount(
state,
state.annotations.enumAnnotations[action.payload.target],
action.payload,
);

state.annotations.enumAnnotations[action.payload.target] = withAuthorAndReviewers(
state.annotations.enumAnnotations[action.payload.target],
Expand Down Expand Up @@ -379,7 +392,7 @@ const annotationsSlice = createSlice({
}
}

updateCreationOrChangedCount(state, oldAnnotation);
updateCreationOrChangedCount(state, oldAnnotation, action.payload.annotation);

state.annotations.groupAnnotations[action.payload.annotation.target][action.payload.annotation.groupName] =
withAuthorAndReviewers(oldAnnotation, action.payload.annotation, state.username);
Expand Down Expand Up @@ -419,7 +432,11 @@ const annotationsSlice = createSlice({
updateQueue(state);
},
upsertMoveAnnotation(state, action: PayloadAction<MoveAnnotation>) {
updateCreationOrChangedCount(state, state.annotations.moveAnnotations[action.payload.target]);
updateCreationOrChangedCount(
state,
state.annotations.moveAnnotations[action.payload.target],
action.payload,
);

state.annotations.moveAnnotations[action.payload.target] = withAuthorAndReviewers(
state.annotations.moveAnnotations[action.payload.target],
Expand All @@ -431,7 +448,7 @@ const annotationsSlice = createSlice({
},
upsertMoveAnnotations(state, action: PayloadAction<MoveAnnotation[]>) {
action.payload.forEach((annotation) => {
updateCreationOrChangedCount(state, state.annotations.moveAnnotations[annotation.target]);
updateCreationOrChangedCount(state, state.annotations.moveAnnotations[annotation.target], annotation);

state.annotations.moveAnnotations[annotation.target] = withAuthorAndReviewers(
state.annotations.moveAnnotations[annotation.target],
Expand All @@ -457,7 +474,11 @@ const annotationsSlice = createSlice({
updateQueue(state);
},
upsertPureAnnotation(state, action: PayloadAction<PureAnnotation>) {
updateCreationOrChangedCount(state, state.annotations.pureAnnotations[action.payload.target]);
updateCreationOrChangedCount(
state,
state.annotations.pureAnnotations[action.payload.target],
action.payload,
);

state.annotations.pureAnnotations[action.payload.target] = withAuthorAndReviewers(
state.annotations.pureAnnotations[action.payload.target],
Expand All @@ -482,7 +503,11 @@ const annotationsSlice = createSlice({
updateQueue(state);
},
upsertRemoveAnnotation(state, action: PayloadAction<RemoveAnnotation>) {
updateCreationOrChangedCount(state, state.annotations.removeAnnotations[action.payload.target]);
updateCreationOrChangedCount(
state,
state.annotations.removeAnnotations[action.payload.target],
action.payload,
);

state.annotations.removeAnnotations[action.payload.target] = withAuthorAndReviewers(
state.annotations.removeAnnotations[action.payload.target],
Expand All @@ -494,7 +519,7 @@ const annotationsSlice = createSlice({
},
upsertRemoveAnnotations(state, action: PayloadAction<RemoveAnnotation[]>) {
action.payload.forEach((annotation) => {
updateCreationOrChangedCount(state, state.annotations.removeAnnotations[annotation.target]);
updateCreationOrChangedCount(state, state.annotations.removeAnnotations[annotation.target], annotation);

state.annotations.removeAnnotations[annotation.target] = withAuthorAndReviewers(
state.annotations.removeAnnotations[annotation.target],
Expand All @@ -520,7 +545,11 @@ const annotationsSlice = createSlice({
updateQueue(state);
},
upsertRenameAnnotation(state, action: PayloadAction<RenameAnnotation>) {
updateCreationOrChangedCount(state, state.annotations.renameAnnotations[action.payload.target]);
updateCreationOrChangedCount(
state,
state.annotations.renameAnnotations[action.payload.target],
action.payload,
);

state.annotations.renameAnnotations[action.payload.target] = withAuthorAndReviewers(
state.annotations.renameAnnotations[action.payload.target],
Expand All @@ -532,7 +561,7 @@ const annotationsSlice = createSlice({
},
upsertRenameAnnotations(state, action: PayloadAction<RenameAnnotation[]>) {
action.payload.forEach((annotation) => {
updateCreationOrChangedCount(state, state.annotations.renameAnnotations[annotation.target]);
updateCreationOrChangedCount(state, state.annotations.renameAnnotations[annotation.target], annotation);

state.annotations.renameAnnotations[annotation.target] = withAuthorAndReviewers(
state.annotations.renameAnnotations[annotation.target],
Expand All @@ -558,7 +587,11 @@ const annotationsSlice = createSlice({
updateQueue(state);
},
upsertTodoAnnotation(state, action: PayloadAction<TodoAnnotation>) {
updateCreationOrChangedCount(state, state.annotations.todoAnnotations[action.payload.target]);
updateCreationOrChangedCount(
state,
state.annotations.todoAnnotations[action.payload.target],
action.payload,
);

state.annotations.todoAnnotations[action.payload.target] = withAuthorAndReviewers(
state.annotations.todoAnnotations[action.payload.target],
Expand All @@ -583,7 +616,23 @@ const annotationsSlice = createSlice({
updateQueue(state);
},
upsertValueAnnotation(state, action: PayloadAction<ValueAnnotation>) {
updateCreationOrChangedCount(state, state.annotations.valueAnnotations[action.payload.target]);
updateCreationOrChangedCount(
state,
state.annotations.valueAnnotations[action.payload.target],
action.payload,
);

if (action.payload.variant === 'required' || action.payload.variant === 'omitted') {
// @ts-ignore
delete action.payload.defaultValue;
// @ts-ignore
delete action.payload.defaultValueType;
}

if (action.payload.defaultValueType === 'number' && typeof action.payload.defaultValue === 'string') {
// @ts-ignore
action.payload.defaultValue = parseFloat(action.payload.defaultValue);
}

state.annotations.valueAnnotations[action.payload.target] = withAuthorAndReviewers(
state.annotations.valueAnnotations[action.payload.target],
Expand All @@ -595,7 +644,19 @@ const annotationsSlice = createSlice({
},
upsertValueAnnotations(state, action: PayloadAction<ValueAnnotation[]>) {
action.payload.forEach((annotation) => {
updateCreationOrChangedCount(state, state.annotations.valueAnnotations[annotation.target]);
updateCreationOrChangedCount(state, state.annotations.valueAnnotations[annotation.target], annotation);

if (annotation.variant === 'required' || annotation.variant === 'omitted') {
// @ts-ignore
delete annotation.defaultValue;
// @ts-ignore
delete annotation.defaultValueType;
}

if (annotation.defaultValueType === 'number' && typeof annotation.defaultValue === 'string') {
// @ts-ignore
annotation.defaultValue = parseFloat(annotation.defaultValue);
}

state.annotations.valueAnnotations[annotation.target] = withAuthorAndReviewers(
state.annotations.valueAnnotations[annotation.target],
Expand Down Expand Up @@ -662,9 +723,15 @@ const updateQueue = function (state: AnnotationSlice) {
state.queueIndex = state.queueIndex + 1;
};

const updateCreationOrChangedCount = function (state: AnnotationSlice, annotationOrNull: Annotation | null) {
if (annotationOrNull) {
state.numberOfAnnotationsChanged++;
const updateCreationOrChangedCount = function (
state: AnnotationSlice,
oldAnnotation: Annotation | null,
newAnnotation: Annotation,
) {
if (oldAnnotation) {
if (annotationWasChanged(oldAnnotation, newAnnotation)) {
state.numberOfAnnotationsChanged++;
}
} else {
state.numberOfAnnotationsCreated++;
}
Expand All @@ -678,7 +745,9 @@ const withAuthorAndReviewers = function <T extends Annotation>(
let authors = oldAnnotation?.authors ?? [];
const reviewers = oldAnnotation?.reviewers ?? [];

authors = [...authors.filter((it) => it !== author), author];
if (!oldAnnotation || annotationWasChanged(oldAnnotation, newAnnotation)) {
authors = [...authors.filter((it) => it !== author), author];
}

return {
...newAnnotation,
Expand All @@ -687,6 +756,24 @@ const withAuthorAndReviewers = function <T extends Annotation>(
};
};

const annotationWasChanged = function <T extends Annotation>(oldAnnotation: T, newAnnotation: T): boolean {
// Unify the metadata, so we only compare the actual annotation data
const oldAnnotationWithoutMetadata = annotationWithoutMetadata(oldAnnotation);
const newAnnotationWithoutMetadata = annotationWithoutMetadata(newAnnotation);

return !isEqual(oldAnnotationWithoutMetadata, newAnnotationWithoutMetadata);
};

const annotationWithoutMetadata = function <T extends Annotation>(annotation: T): T {
return {
...annotation,
authors: undefined,
reviewers: undefined,
reviewResult: undefined,
comment: undefined,
};
};

const withToggledReviewer = function <T extends Annotation>(
state: AnnotationSlice,
oldAnnotation: T,
Expand Down