ckeditor / ckeditor5-react

Official CKEditor 5 React component.
https://ckeditor.com/ckeditor-5
Other
425 stars 99 forks source link

Setting data of any root with MultiRoot editor results in revision history marking all roots as changed #534

Closed f1ames closed 1 month ago

f1ames commented 2 months ago

Reproduction steps

It can be done in multiple ways, the fastest for me was by using collaboration samples.

  1. Checkout collaboration samples repo and follow setup instructions.
  2. In real-time-collaboration-editor-multi-root-for-react expose data and setData returned by useMultiRootEditor. This can be done by modifying this line as:
    const { data, setData, editableElements, toolbarElement, attributes } = useMultiRootEditor( editorProps );

    window.setData = setData;
    window.data = data;
  1. Run the sample with yarn && yarn dev.
  2. Go to http://localhost:5173/.
  3. Open dev console, paste and execute window.setData({...window.data, header: '123123'}).
  4. Go to editor revision history.

Expected

Only header root is marked as changed.

Actual

All roots are marked as changed:

image

A bit of context

This happens because setData returned from useMultiRootEditor hook, expects all roots to be passed (since it diffs root list enabling to add/remove them) and existing roots are just updated with passed data, even if it's the same. Such update results in each root model data to be wiped out and re-added which is interpreted by revision history as complete data replace (since it works on model operations and does not diff data changes).