Editing source using the CKEditor Source mode does not fire change event [#3275611]

Problem/Motivation

The Editor module tracks when an editor has modified a field, and reverts the value of a field when its editor has not made any changes. When editing HTML source in CKEditor, the "change" event is not fired and the field is not flagged as having been changed, which will cause the field to be reverted in some conditions.

Steps to reproduce

Edit a node with a body field that uses CKEditor.
Press "Source" in the CKEditor instance, without making any other changes.
Change the source to anything you like.
Use the code inspector to inspect the accompanying, hidden textarea (its name will be "body[0][value]").
The "data-editor-value-is-changed" attribute should be "true", but is not.
Click "Source" again.
Inspect the textarea again. The "data-editor-value-is-changed" is now correctly set to "true".

Proposed resolution

Using a solution similar to what is outlined at https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_editor.html#even..., add code to behave similarly to the change event handler.

Remaining tasks

Develop and test.

User interface changes

n/a

API changes

n/a

Data model changes

n/a

Release notes snippet

n/a

Comment	File	Size	Author
#17	3275611-17.patch	1.5 KB	adinancenci
#14	reroll_diff_9-14.txt	1.05 KB	ravi.shankar
#14	3275611-14.patch	2 KB	ravi.shankar
#9	3275611.patch	2 KB	andrea.cividini

Issue fork drupal-3275611

Show commands

Start within a Git clone of the project using the version control instructions.

Add & fetch this issue fork’s repository

Or, if you do not have SSH keys set up on git.drupalcode.org:

Add & fetch this issue fork’s repository

1 hidden branch

3275611-ckeditor-source-mode

changes, plain diff MR !2123

Check out this branch for the first time

Check out existing branch, if you already have it locally

About issue forks

Comments

Comment #1

16 April 2022 at 15:05

justin2pin created an issue. See original summary.

Comment #2

16 April 2022 at 16:29

justin2pin opened merge request !2123

Comment #3

justin2pin commented 16 April 2022 at 16:30

Issue tags:

+Needs tests

Comment #4

justin2pin commented 16 April 2022 at 18:27

Status:	Active	» Needs review
Issue tags:	-Needs tests

Added test coverage

Comment #5

joelsteidl commented 18 April 2022 at 16:27

I recently hit this issue and can confirm this patch handles it.

To test, I edited a piece of content and added a link manually in the source. The attribute mentioned data-editor-value-is-changed is set to true now.

Comment #6

18 April 2022 at 18:37

yogeshmpawar made their first commit to this issue’s fork.

Comment #7

anybody

German

Porta Westfalica

commented 19 April 2022 at 07:06

Experienced the issue at #3275082: Changes in CKEditor "Source" not saved - thanks for finding the reason and fixing it @justin2pin! :)
RTBC+1

Comment #8

19 April 2022 at 07:06

Version:

9.4.x-dev

» 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Comment #9

andrea.cividini commented 15 June 2022 at 08:52

Status	File	Size
new	3275611.patch	2 KB

Thanks for providing a solution. Attaching a patch ready to use, for someone that needs a quick solution for it's production project like I do. Warning: I stripped the tests from the patch, only actual bugfixing code changes are in there.
RTBC +1