Clean up frontend change tracker and snackbars related to undoing operations #3480

bjester · 2022-08-03T22:14:44Z

Summary

Description of the change(s) you made

Removes the troubled change-locking implementation of the frontend change tracker used for reverting changes
Resolves some issues with snackbars related to copying and moving nodes, and clipboard operations too, to ensure that the snackbars display

Manual verification steps performed

Duplicating a node and undo it
Copying a node to the clipboard
Moving a node
Delete a node and undo it

References

Comments

Contributor's Checklist

PR process:

If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
If this includes an internal dependency change, a link to the diff is provided
The docs label has been added if this introduces a change that needs to be updated in the user docs?
If any Python requirements have changed, the updated requirements.txt files also included in this PR
Opportunities for using Google Analytics here are noted
Migrations are safe for a large db

Studio-specifc:

All user-facing strings are translated properly
The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
All UI components are LTR and RTL compliant
Views are organized into pages, components, and layouts directories as described in the docs
Users' storage used is recalculated properly on any changes to main tree files
If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

Code is clean and well-commented
Contributor has fully tested the PR manually
If there are any front-end changes, before/after screenshots are included
Critical user journeys are covered by Gherkin stories
Any new interactions have been added to the QA Sheet
Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

Automated test coverage is satisfactory
PR is fully functional
PR has been tested for accessibility regressions
External dependency files were updated if necessary (yarn and pip)
Documentation is updated
Contributor is in AUTHORS.md

bjester · 2022-08-03T22:18:41Z

contentcuration/contentcuration/frontend/shared/data/resources.js

+        }
+      });
+    });
+  }


@rtibbles Interested in your thoughts on this use of liveQuery. I added this to detect when copying is finished so we can show the snackbars appropriately.

rtibbles

This looks like good cleanup - one comment about possible future directions for undoing, but I don't think it affects the code as is. Will manually test.

rtibbles · 2022-08-10T16:28:41Z

contentcuration/contentcuration/frontend/shared/data/changes.js

+    return promiseChunk(this._changes.reverse(), 1, ([change]) => {
+      const table = db[change.table];
+      return db.transaction('rw', change.table, () => {
+        // This source inherits from `IGNORED_SOURCE` so this will be ignored


Thinking about the future, if we are immediately sending changes to the backend using websockets, maybe we should be emitting 'reversions' as full changes that also get propagated to the backend, rather than trying to catch them before they're applied?

More like git reverting a commit, rather than dropping a commit. The main challenge comes for things like publishing and syncing where there is not a clear path for what a 'restore' looks like.

This is a great catch because by removing the change locks, I did change the behavior to be more like a git revert, but I did not update this logic accordingly! This logic should no longer use an ignored source for the updates. At the moment, we're only wrapping copy and move operations, so events like publishing and syncing shouldn't even occur here, but it would be good to be defensive against those things.

rtibbles · 2022-08-10T16:29:50Z

contentcuration/contentcuration/frontend/shared/data/resources.js

+        .toArray();
+    });
+
+    return new Promise((resolve, reject) => {


I think your comment got lost in a rebase, but this does look like a neat way to watch for changes.

rtibbles

Code review looks good, manual testing shows no errors, and I am seeing snackbars!

rtibbles · 2022-08-15T18:22:28Z

contentcuration/contentcuration/frontend/shared/data/changes.js

-      if (this._isBlocking) {
-        this._isBlocking = false;
-        this.emit('unblocked');
+  doRevert() {


I think this logic could also be useful for handling changes that error on the backend too (but in that case I suppose it would be an ignored change).

pcenov · 2022-09-27T13:15:45Z

Sometimes I am getting an "Unable to revert changes without tracking some changes" error in the console when I attempt to Undo a deleted resource but this is not always reproducible.

As reported in Hotifxes - Undoing a move operation does not revert the change in the backend #3680 if I delete a resource and restore it and then sign out when I sign in again and go to the channel the resource is not displayed in the Editor, only in the Trash.
Not sure if this is caused by changes made here but I also noticed that again sometimes after performing Undo, the Delete option ceases to function:

2022-09-27_16-12-39.mp4

cc @radinamatic

bjester commented Aug 3, 2022

View reviewed changes

bjester added TAG: tech update / debt TAG: performance labels Aug 4, 2022

bjester force-pushed the change-tracking branch from 1d9ea97 to e7b7215 Compare August 5, 2022 18:41

bjester marked this pull request as ready for review August 5, 2022 21:18

rtibbles reviewed Aug 10, 2022

View reviewed changes

bjester force-pushed the change-tracking branch from facfacc to a980a00 Compare August 11, 2022 16:10

bjester added 3 commits August 11, 2022 09:27

Clean up change tracking, removing locks, and fixing snackbars

bdacf4f

Remove event emitter inheritance

44adf97

Remove revert source, update revert logic to track its changes

90fb223

bjester force-pushed the change-tracking branch from a980a00 to 90fb223 Compare August 11, 2022 16:27

bjester requested a review from rtibbles August 11, 2022 16:30

rtibbles approved these changes Aug 15, 2022

View reviewed changes

rtibbles merged commit a34942d into learningequality:unstable Aug 15, 2022

This was referenced Sep 15, 2022

Hotfixes release for development ending 2022-09-16 #3644

Merged

Release v2022.10.03 #3658

Merged

bjester mentioned this pull request Sep 29, 2022

Generate a reverse move when reverting a move #3700

Merged

24 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up frontend change tracker and snackbars related to undoing operations #3480

Clean up frontend change tracker and snackbars related to undoing operations #3480

bjester commented Aug 3, 2022 •

edited

Loading

bjester Aug 3, 2022 •

edited

Loading

rtibbles left a comment

rtibbles Aug 10, 2022

bjester Aug 10, 2022

rtibbles Aug 10, 2022

rtibbles left a comment

rtibbles Aug 15, 2022

pcenov commented Sep 27, 2022

Clean up frontend change tracker and snackbars related to undoing operations #3480

Clean up frontend change tracker and snackbars related to undoing operations #3480

Conversation

bjester commented Aug 3, 2022 • edited Loading

Summary

Description of the change(s) you made

Manual verification steps performed

References

Comments

Contributor's Checklist

Reviewer's Checklist

This section is for reviewers to fill out.

bjester Aug 3, 2022 • edited Loading

Choose a reason for hiding this comment

rtibbles left a comment

Choose a reason for hiding this comment

rtibbles Aug 10, 2022

Choose a reason for hiding this comment

bjester Aug 10, 2022

Choose a reason for hiding this comment

rtibbles Aug 10, 2022

Choose a reason for hiding this comment

rtibbles left a comment

Choose a reason for hiding this comment

rtibbles Aug 15, 2022

Choose a reason for hiding this comment

pcenov commented Sep 27, 2022

bjester commented Aug 3, 2022 •

edited

Loading

bjester Aug 3, 2022 •

edited

Loading