Introduce lock mechanism for Editor#isReadOnly #11441

ma2ciek · 2022-03-09T16:13:44Z

Suggested merge commit message (convention)

Feature (core): Introduced locking mechanism for Editor#isReadOnly. Read-only mode can now be separately enabled and disabled by multiple features which allows for proper control without conflicts between features. Closes #10496.

Other (core): Editor#isReadOnly is now a read-only property.

MAJOR BREAKING CHANGE: The Editor#isReadOnly property is now read-only. From now, this property is controlled by Editor#enableReadOnlyMode( lockId ) and Editor#disableReadOnlyMode( lockId ), which allow controlling the Editor#isReadOnly state by more than one feature without collisions.

Additional information

For example – encountered issues, assumptions you had to make, other affected tickets, etc.

pomek · 2022-03-09T17:34:31Z

This major breaking change breaks our integrations that set editor.isReadOnly=true.

https://github.com/ckeditor/ckeditor5-react/blob/dc3093c98ef566a0a422413e326e4bd086ecd54a/src/ckeditor.jsx#L63-L65

Now, integrations have to support both forms - the previous (as mentioned above), and the new one (that the PR adds).

ma2ciek · 2022-03-09T21:17:29Z

Yes... Perhaps we can still support the old behavior and when encountering this kind of assignments we can try to set/remove a custom lock instead. I'll research it tomorrow.

ma2ciek · 2022-03-10T10:18:37Z

During a recent discussion with @scofalik we decided that we can do a breaking change and then release major releases in our integrations (the BC in these integrations will be the fact that they will be working only with CKEditor 5 v34+), so they will not have to support two versions at the same time.

Introducing a lock mechanism from custom assignments looks pretty bad, imagine this situation:

editor.isReadOnly = false; // clears a custom assignment lock on the `isReadOnly` property.

editor.isReadOnly // still `true` as other features may still have their locks on the `isReadOnly` property.

TBH, the fact that integrations also change the isReadOnly property is another reason of why this PR is important 😄

pomek · 2022-03-10T10:26:15Z

I have nothing to do with the API, as you know better what you want to achieve. I agree that the proposed method is much better than a single property.

However, we cannot assume people update their builds. They don't have to, and it's our responsibility to think about it. So, integrations must detect (somehow) a version of the CKEditor 5 API and, based on that, use old or new API.

In the worst scenario, if we cannot support both APIs, we need to release new versions of integrations with adjusted API.

scofalik · 2022-03-17T14:06:43Z

In the worst scenario, if we cannot support both APIs, we need to release new versions of integrations with adjusted API.

But we will, it's obvious. If we make breaking change in our code, we will fix it :).

scofalik

I don't like current method names, I propose:

setReadOnly( id ) and clearReadOnly( id ), or
enableReadOnly( id ) and disableReadOnly( id ).

I understand that setReadOnly( 'foo' ) looks like we are setting the property value to 'foo', hence the second proposal.

Other than that, maybe you could also check if manually firing set:... event has any change working with bind() and if there are other mechanisms that we should also consider.

packages/ckeditor5-core/src/editor/editor.js

scofalik · 2022-03-21T10:01:26Z

packages/ckeditor5-core/src/editor/editor.js

+	 *
+	 * @param {String} lockId The lock ID for setting the editor to the read-only state.
+	 */
+	hasReadOnlyLock( lockId ) {


I am not sure if this method is actually needed after giving it a second thought. In overwhelmingly most cases, you set read only basing on another value/event, for example, when the internet connection is turned off, or when you switch on/off a feature, etc.

It looks like this is useful mostly for "toggle buttons" but such buttons do not really exist in real integrations. Do we need hasReadOnlyLock() in our own code?

From what I remember there is no place where this method is used in the source code, but as for the tests there is currently no other way to write it without using the hasReadOnlyLock(). I was thinking about just using the Editor.isReadOnly in manual tests but then these buttons will look broken 😅

So without using hasReadOnlyLock we would have to either use internals, Editor.isReadOnly, I don't have other ideas.

packages/ckeditor5-core/src/editor/editor.js

Co-authored-by: Szymon Cofalik <s.cofalik@cksource.com>

…e:isReadOnly correctness.

scofalik · 2022-03-29T10:49:08Z

LGTM except of the new method names.

I propose:

setReadOnly( id, value ) and clearReadOnly( id ), or

enableReadOnly( id, value ) and disableReadOnly( id ).

I also think that hasReadOnlyLock() is not needed at the moment. You can use local variable in manual tests.

…clearReadOnlyLock to editor.clearReadOnly.

ma2ciek · 2022-03-29T13:55:13Z

@ckeditor/qa-team Can I ask you to test this PR? I changed also the ckeditor5-core/tests/manual/readonly test to allow testing setting a few locks at the same time.

Unfortunately, there are a lot of places where we use or observer editor.isReadOnly and set this property via editor.setReadOnly()

packages/ckeditor5-core/src/editor/editor.js

…clearReadOnly to editor.clearReadOnlyMode.

…yMode()` to `disableReadOnlyMode()`.

LukaszGudel · 2022-03-31T14:05:50Z

I've tested this PR, and also CF branch related to this changes and everything seems fine. The lock mechanism is working correctly. I've also tested CF features where read-only mode can be set and that was also working correctly 👍

scofalik · 2022-03-31T15:45:39Z

Migration guide missing 😬

ma2ciek · 2022-04-01T13:20:22Z

Can we add this guide as a follow-up? The DLL changes already introduce the migration guide for the next iteration and I'd be happy to not merge these files if I do not have to :)

… migration guide.

scofalik

I reworded the migration guide a bit 😬

docs/updating/migration-to-34.md

ma2ciek · 2022-04-04T12:58:10Z

I reworded the migration guide a bit 😬

I thought that it will be fine and you rewrote it from scratch ;p

scofalik · 2022-04-04T13:02:24Z

It's not at all from scratch. In one place it looks like a lot of changes but I just changed the order.

ma2ciek added 3 commits March 8, 2022 15:57

Introduced lock mechanism for Editor#isReadOnly.

71efd32

Added tests for the Editor#isReadOnly, fixed immutability.

9d16103

Simplified the logic in setting Editor#isReadOnly locks.

c1f1e4a

ma2ciek requested a review from scofalik March 9, 2022 16:13

ma2ciek added 3 commits March 10, 2022 11:51

Updated manual tests.

0663db3

Added missing test.

a7b3a0b

Merge branch 'master' into cke/10496

cf7d5f9

scofalik requested changes Mar 21, 2022

View reviewed changes

ma2ciek and others added 6 commits March 23, 2022 07:42

Apply suggestions from code review

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

d31616b

Co-authored-by: Szymon Cofalik <s.cofalik@cksource.com>

Apply suggestions from code review

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

c97776a

Co-authored-by: Szymon Cofalik <s.cofalik@cksource.com>

Removed unnecessary arguments when stopping event listeners.

ca1b85e

Changed Editor#isReadOnly to a pure getter. Added tests for the chang…

c67a0ee

…e:isReadOnly correctness.

Allowed using symbols as lock IDs.

e6e93dd

Updated docs snippet.

48e5321

ma2ciek added 2 commits March 29, 2022 15:26

Removed usage of editor.hasReadOnlyLock().

5a8cad7

Renamed editor.setReadOnlyLock to editor.setReadOnly, renamed editor.…

de7acca

…clearReadOnlyLock to editor.clearReadOnly.

scofalik reviewed Mar 29, 2022

View reviewed changes

scofalik and others added 3 commits March 29, 2022 17:42

Apply suggestions from code review

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

e3c8c43

Renamed editor.setReadOnly to editor.setReadOnlyMode, renamed editor.…

ea425ff

…clearReadOnly to editor.clearReadOnlyMode.

Renamed setReadOnlyMode() enableReadOnlyMode(), and `clearReadOnl…

4aee683

…yMode()` to `disableReadOnlyMode()`.

scofalik added 2 commits March 31, 2022 16:34

Added more explanation to editor.enableReadOnlyMode().

6dfaa3e

Editor#isReadOnly should throw when set directly.

ca9917e

ma2ciek added 3 commits April 4, 2022 12:16

Merge branch 'master' into cke/10496

e368b40

Added required code changes for the new editor read-only usage to the…

949eff6

… migration guide.

Updated migration guide date.

1b25e32

scofalik approved these changes Apr 4, 2022

View reviewed changes

Apply suggestions from code review

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

8fc68fd

scofalik merged commit b0234d9 into master Apr 4, 2022

scofalik deleted the cke/10496 branch April 4, 2022 11:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce lock mechanism for Editor#isReadOnly #11441

Introduce lock mechanism for Editor#isReadOnly #11441

ma2ciek commented Mar 9, 2022 •

edited by scofalik

Loading

pomek commented Mar 9, 2022

ma2ciek commented Mar 9, 2022

ma2ciek commented Mar 10, 2022 •

edited

Loading

pomek commented Mar 10, 2022

scofalik commented Mar 17, 2022

scofalik left a comment •

edited

Loading

scofalik Mar 21, 2022

ma2ciek Mar 23, 2022

ma2ciek Mar 23, 2022

scofalik commented Mar 29, 2022 •

edited

Loading

ma2ciek commented Mar 29, 2022

LukaszGudel commented Mar 31, 2022

scofalik commented Mar 31, 2022

ma2ciek commented Apr 1, 2022

scofalik left a comment

ma2ciek commented Apr 4, 2022

scofalik commented Apr 4, 2022

Introduce lock mechanism for Editor#isReadOnly #11441

Introduce lock mechanism for Editor#isReadOnly #11441

Conversation

ma2ciek commented Mar 9, 2022 • edited by scofalik Loading

Suggested merge commit message (convention)

Additional information

pomek commented Mar 9, 2022

ma2ciek commented Mar 9, 2022

ma2ciek commented Mar 10, 2022 • edited Loading

pomek commented Mar 10, 2022

scofalik commented Mar 17, 2022

scofalik left a comment • edited Loading

Choose a reason for hiding this comment

scofalik Mar 21, 2022

Choose a reason for hiding this comment

ma2ciek Mar 23, 2022

Choose a reason for hiding this comment

ma2ciek Mar 23, 2022

Choose a reason for hiding this comment

scofalik commented Mar 29, 2022 • edited Loading

ma2ciek commented Mar 29, 2022

LukaszGudel commented Mar 31, 2022

scofalik commented Mar 31, 2022

ma2ciek commented Apr 1, 2022

scofalik left a comment

Choose a reason for hiding this comment

ma2ciek commented Apr 4, 2022

scofalik commented Apr 4, 2022

ma2ciek commented Mar 9, 2022 •

edited by scofalik

Loading

ma2ciek commented Mar 10, 2022 •

edited

Loading

scofalik left a comment •

edited

Loading

scofalik commented Mar 29, 2022 •

edited

Loading