Desktop: Fixes #8960: Fix cursor jump in the Rich Text Editor on sync #10558
Conversation
This file contains 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
…r on sync Marks the current note as changed immediately after pressing a key.
laurent22
reviewed
Jun 10, 2024
| async function onKeyDown(event: KeyboardEvent) { | ||
| // Although the onChangeHandler also marks the editor content as changed, it's important | ||
| // to set changed to true as soon as possible. See https://github.com/laurent22/joplin/issues/8960. | ||
| props.setChanged(true); |
There was a problem hiding this comment.
What even are actually processed by this handler? Would it be triggered by non-printable keys too? Because in that case the note wouldn't actually be changed
|
Is the cursor jump an issue in the RTE too? I don't remember having had this problem in this editor |
Users in #8960 listed the issue as occurring in the RTE. On reflection, however, we only have confirmation that this is still an issue in the legacy markdown editor. As such, a better approach could be something similar to this, but for CodeMirror 5. I'm closing this for now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This pull request tries to fix #8960 (#10449 seems to have failed to do so). It does so by marking the current note as changed immediately after a key is pressed (rather than waiting for an
onChangeevent to be received).In particular, this pull request focuses on the Rich Text Editor because it's simpler to implement and I am not certain that this will fix the issue. If it does, a similar change can be made to the beta and legacy markdown editors.
May fix #8960.
Rationale
Logs collected before #10449 was merged suggest that #8960 was caused by a race condition where:
#10449 eliminated the need for a React re-render between the editor's
changeevent and marking the editor's content as changed (in step 3). If #8960 is still happening because thechangeevent isn't firing soon enough after the editor is changed, marking the editor as changed on key down events might fix the issue.Testing plan
Regression testing:
This has been tested successfully on Ubuntu 24.04.