Skip to content

Do not override key of annotation when restoring from trash #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abaevbog wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Do not override key of annotation when restoring from trash #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8eee0f0
support trashing of annotations
abaevbog Aug 17, 2026
11e3e6a
fold clearAnnotationsHistory into unsetAnnotations
abaevbog Aug 17, 2026
0105db7
Clarify comment
abaevbog Aug 17, 2026
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
27 changes: 18 additions & 9 deletions src/common/annotation-manager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ class AnnotationManager {
this._onSave = options.onSave;
this._onDelete = options.onDelete;
this._onChangeHistory = options.onChangeHistory;
this._trashesAnnotations = options.trashesAnnotations;
this._adjustTextAnnotationPosition = options.adjustTextAnnotationPosition;
this.render = () => {
options.onRender([...this._annotations]);
Expand Down Expand Up @@ -62,14 +63,17 @@ class AnnotationManager {
}

// Called when deletions come from the client side
unsetAnnotations(ids) {
unsetAnnotations(ids, permanentlyDeleted) {
// Deletions we haven't applied yet are outside changes that our history
// can no longer be replayed over. Ones we have applied are our own
// deletions coming back to us, and undoing them is still valid.
let externalIDs = ids.filter(id => this._annotations.some(x => x.id === id));
// deletions coming back to us, and undoing them is still valid, unless
// the annotations were permanently deleted.
let clearIDs = permanentlyDeleted
? ids
: ids.filter(id => this._annotations.some(x => x.id === id));
this._annotations = this._annotations.filter(x => !ids.includes(x.id));
if (externalIDs.length) {
this._clearInterferingHistory(externalIDs);
if (clearIDs.length) {
this._clearInterferingHistory(clearIDs);
}
this.render();
}
Expand Down Expand Up @@ -601,8 +605,11 @@ class AnnotationManager {
if (annotation) {
annotation.dateModified = (new Date()).toISOString();
}
// Assign new id when undeleting to reduce sync conflicts
if (!prevAnnotation) {
// Assign a new ID when undeleting to reduce sync conflicts,
// except if the client trashes instead of permanently deleting -
// in that case, keep the old ID so the client can match the
// trashed annotation and untrash it.
if (!prevAnnotation && !this._trashesAnnotations) {
let newID = this._generateObjectKey();
mapping.set(annotation.id, newID);
annotation.id = newID;
Expand Down Expand Up @@ -635,8 +642,10 @@ class AnnotationManager {
if (annotation) {
annotation.dateModified = (new Date()).toISOString();
}
// Assign new id when undeleting to reduce sync conflicts
if (!prevAnnotation) {
// Assign new id when undeleting to reduce sync conflicts. Clients that

@AbeJellinek AbeJellinek Aug 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As above

// trash annotations keep the deleted one around, so undeleting restores
// it in place and the id has to stay the same for the client to find it.
if (!prevAnnotation && !this._trashesAnnotations) {
let newID = this._generateObjectKey();
mapping.set(annotation.id, newID);
annotation.id = newID;
Expand Down
6 changes: 4 additions & 2 deletions src/common/reader.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ class Reader {
this._onSetPopupPosition = options.onSetPopupPosition;
this._onChangeUndoHistory = options.onChangeUndoHistory;
this._externalUndoHistory = !!options.onChangeUndoHistory;
this._trashesAnnotations = !!options.trashesAnnotations;

for (let ftl of options.ftl) {
addFTL(ftl);
Expand Down Expand Up @@ -361,6 +362,7 @@ class Reader {
this._updateState({ filter });
},
onChangeHistory: this._onChangeUndoHistory,
trashesAnnotations: this._trashesAnnotations,
adjustTextAnnotationPosition: (annotation, option) => {
return this._primaryView.adjustTextAnnotationPosition(annotation, option);
}
Expand Down Expand Up @@ -947,8 +949,8 @@ class Reader {
this._annotationManager.setAnnotations(annotations);
}

unsetAnnotations(ids) {
this._annotationManager.unsetAnnotations(ids);
unsetAnnotations(ids, permanentlyDeleted) {
this._annotationManager.unsetAnnotations(ids, permanentlyDeleted);
}

openContextMenu(params) {
Expand Down
Loading