fix/2829: force onChange to be updated with TinyMCE content before merge #3450
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
BoardJames
added
the
[Type] Bug
Codecov Report
@@ Coverage Diff @@
## master #3450 +/- ##
=======================================
Coverage 34.64% 34.64%
=======================================
Files 260 260
Lines 6737 6737
Branches 1219 1219
=======================================
Hits 2334 2334
Misses 3717 3717
Partials 686 686
Continue to review full report at Codecov.
|
youknowriad
reviewed
Nov 14, 2017
blocks/editable/index.js
Outdated
| onChange() { | ||
| if ( ! this.editor.isDirty() ) { | ||
| onChange( forced ) { | ||
| if ( ! forced && ! this.editor.isDirty() ) { |
There was a problem hiding this comment.
Should we add a comment to explain that isDirty should be enough but due to a bug, we need to force sometimes?
There was a problem hiding this comment.
On talking to the TinyMCE team it's more of a known deficiency needed due to efficiency requirements.
youknowriad
approved these changes
Nov 14, 2017
mcsf
approved these changes
Nov 14, 2017
|
Ok I will add a comment and rename forced to shouldForce. |
3 tasks
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.
Description
The issue #2829 was caused by the React state not correctly mirroring TinyMCE's state before the merge operation. This was despite the call to onChange directly before calling merge - however onChange was gated on TinyMCE's isDirty and it seems that the isDirty function had not updated to match reality in time (Note: I am told that isDirty functions are really hard to implement efficiently so, while we will tell the TinyMCE team about this, I doubt it is fixable within TinyMCE.). The easiest fix seems to be to force the update of React's state even if the editor doesn't think it has changed which is what I have done here.
How Has This Been Tested?
Manually tested on Firefox and Chrome.
Types of changes
Bug fix.
Checklist: