Do not use Cmd + Return for inserting hard breaks in the Content Editor
What does this MR do?
This MR solves a keyboard shortcut conflict between submitting a form and inserting a hard break in the Content Editor. Both actions use the Cmd + Return keyboard shortcut. The conflict is addressed by changing the hard break command to Shift-Enter and keeping Cmd + Return for form submission because this is a web standard.
It also fixes a bug where pressing Cmd + Return for saving changes in the Wiki editor didn’t send the changes when using the Content Editor.
Why are we doing this?
Because users find confusing when the can’t get outside the code block using the arrow keys.
What else does this MR do?
It also introduces a utility for testing that the outcome of executing a command that modifies a ProseMirror document. In order to test this command, we added the prosemirror-test-builder utility. This utility allows us to build test documents that we can use to make assertions against the document produced by the Content Editor.
The testing methodology we follow is:
- Create an initial document
- Create an expected document
- Allow the Content Editor to modify the initial document
Assert that the modified document equals the expected document.
How to test?
- Edit a Wiki page in your local environment.
- Enable the content editor (it is opt-in for now).
- Insert a code block using the toolbar or a keyboard shortcut.
Screenshots (strongly suggested)
| When the code block is the last element | When the code block is set between elements |
|---|---|
 |
 |
Does this MR meet the acceptance criteria?
Conformity
-
I have included changelog trailers, or none are needed. (Does this MR need a changelog?) -
I have added/updated documentation, or it's not needed. (Is documentation required?) -
I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?) -
I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?) -
I have self-reviewed this MR per code review guidelines. -
This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines) -
I have followed the style guides. -
This change is backwards compatible across updates, or this does not apply.
Availability and Testing
-
I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.) -
I have tested this MR in all supported browsers, or it's not needed. -
I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.
Security
Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.
-
Label as security and @ mention @gitlab-com/gl-security/appsec -
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team
Related to #334191 (closed)