Include final retain in tree deltas - #27809
Open
CraigMacomber wants to merge 2 commits into
Open
Conversation
…ug with last new line
github-actions
Bot
added
base: main
Contributor
|
Hi! Thank you for opening this PR. Want me to review it? Based on the diff (460 lines, 12 files), I've queued these reviewers:
How this works
|
Contributor
Bundle size comparisonBase commit: Notable changesNo bundles changed by ≥ 500 bytes parsed. Per-bundle deltas
|
Josmithr
reviewed
Jul 31, 2026
| }; | ||
| } | ||
|
|
||
| function lineAtomToQuillAttributes( |
Josmithr
reviewed
Jul 31, 2026
Comment on lines
+242
to
+251
| if (remainingQuillContent.length > 0) { | ||
| assert( | ||
| remainingQuillContent === "\n", | ||
| "Expected only Quill's mandatory terminal newline to remain", | ||
| ); | ||
| quillOps.push({ delete: 1 }); | ||
| } | ||
| if (!root.fullString().endsWith("\n")) { | ||
| quillOps.push({ insert: "\n" }); | ||
| } |
Contributor
There was a problem hiding this comment.
Nit: some docs here would probably be useful
Josmithr
reviewed
Jul 31, 2026
Comment on lines
+426
to
+429
| function getArrayLength(arrayNodeKernel: TreeNodeKernel): number { | ||
| return arrayNodeKernel.getInnerNode().getBoxed(EmptyKey).length; | ||
| } | ||
|
|
Contributor
There was a problem hiding this comment.
I'm assuming there's no stricter typing we can use here? If not, some docs would probably be good.
Josmithr
reviewed
Jul 31, 2026
Comment on lines
+94
to
+125
| it("keeps remote editor DOM in sync after a user edit", () => { | ||
| const text = TextAsTree.Tree.fromString(""); | ||
| const root = toPropTreeNode(text); | ||
| const rendered = render( | ||
| <> | ||
| <ViewComponent root={root} /> | ||
| <ViewComponent root={root} /> | ||
| </>, | ||
| { reactStrictMode }, | ||
| ); | ||
| const sourceContainer = | ||
| rendered.container.querySelector<HTMLElement>(".ql-container"); | ||
| const editors = rendered.container.querySelectorAll<HTMLElement>(".ql-editor"); | ||
| const sourceEditor = editors[0]; | ||
| const remoteEditor = editors[1]; | ||
| assert.ok( | ||
| sourceContainer !== null && | ||
| sourceEditor !== undefined && | ||
| remoteEditor !== undefined, | ||
| ); | ||
| const source = Quill.find(sourceContainer) as Quill; | ||
|
|
||
| source.setText("Hello", "user"); | ||
|
|
||
| assert.equal(sourceEditor.innerHTML, "<p>Hello</p>"); | ||
| assert.equal(remoteEditor.innerHTML, sourceEditor.innerHTML); | ||
|
|
||
| source.setText("Hello\nWorld", "user"); | ||
|
|
||
| assert.equal(sourceEditor.innerHTML, "<p>Hello</p><p>World</p>"); | ||
| assert.equal(remoteEditor.innerHTML, sourceEditor.innerHTML); | ||
| }); |
Contributor
There was a problem hiding this comment.
Nit: some docs in here would be useful
Josmithr
reviewed
Jul 31, 2026
Comment on lines
+297
to
+328
| it("keeps remote editor DOM in sync after a user edit", () => { | ||
| const { tree } = createFormattedTreeView(); | ||
| const root = toPropTreeNode(tree); | ||
| const rendered = render( | ||
| <> | ||
| <FormattedMainView root={root} /> | ||
| <FormattedMainView root={root} /> | ||
| </>, | ||
| { reactStrictMode }, | ||
| ); | ||
| const sourceContainer = | ||
| rendered.container.querySelector<HTMLElement>(".ql-container"); | ||
| const editors = rendered.container.querySelectorAll<HTMLElement>(".ql-editor"); | ||
| const sourceEditor = editors[0]; | ||
| const remoteEditor = editors[1]; | ||
| assert.ok( | ||
| sourceContainer !== null && | ||
| sourceEditor !== undefined && | ||
| remoteEditor !== undefined, | ||
| ); | ||
| const source = Quill.find(sourceContainer) as Quill; | ||
|
|
||
| source.setText("Hello", "user"); | ||
|
|
||
| assert.equal(sourceEditor.innerHTML, "<p>Hello</p>"); | ||
| assert.equal(remoteEditor.innerHTML, sourceEditor.innerHTML); | ||
|
|
||
| source.formatLine(0, source.getLength(), "list", "bullet", "user"); | ||
|
|
||
| assert.match(sourceEditor.innerHTML, /^<ol>/); | ||
| assert.equal(remoteEditor.innerHTML, sourceEditor.innerHTML); | ||
| }); |
Contributor
There was a problem hiding this comment.
Nit: some docs in here would be useful
CraigMacomber
added a commit
that referenced
this pull request
Jul 31, 2026
## Description While authoring #27809 I had to make some assumptions about deltas, which were undocumented. This fills in the missing documentation.
This file contains hidden or 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
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
Previously our array node deltas were not required to include the final retain. This is now alwayse included.
Addationally handling of the extra new line required to make quill a happe is now more robust, fixing a buig where remote copllaborators should end up with extra new lines.
Reviewer Guidance
The review process is outlined on this wiki page.