Skip to content

RTC: Ensure a single canonical update log for collaborative edits.#11660

Draft
dmsnell wants to merge 1 commit intoWordPress:trunkfrom
dmsnell:rtc/avoid-duplicate-room-split
Draft

RTC: Ensure a single canonical update log for collaborative edits.#11660
dmsnell wants to merge 1 commit intoWordPress:trunkfrom
dmsnell:rtc/avoid-duplicate-room-split

Conversation

@dmsnell
Copy link
Copy Markdown
Member

@dmsnell dmsnell commented Apr 27, 2026

Trac ticket: Core-65138

Backport of WordPress/gutenberg#77675

A race condition on opening an editor session allows for Core to create duplicate post meta for sync storage. This creates two copies of the document which the editors operate on independently, leading to a mismatch between the sessions.

In this patch, when such a duplicate storage row is detected, a canonical version of the post meta is chosen (the one with the lowest id viz. the oldest one) and the duplicate is merged into it.

This should ensure that all edit sessions for a given post use the same synchronized backing store.

Trac ticket:

Use of AI Tools


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

Trac ticket: Core-65138

Backport of WordPress/gutenberg#77675

A race condition on opening an editor session allows for Core to create
duplicate post meta for sync storage. This creates two copies of the
document which the editors operate on independently, leading to a
mismatch between the sessions.

In this patch, when such a duplicate storage row is detected, a
canonical version of the post meta is chosen (the one with the lowest id
viz. the oldest one) and the duplicate is merged into it.

This should ensure that all edit sessions for a given post use the same
synchronized backing store.

Co-authored-by: Dennis Snell <dmsnell@git.wordpress.org>
@github-actions
Copy link
Copy Markdown

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Copy link
Copy Markdown

@apermo apermo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I would consider stricter conditions, and checking for int over not falsy.

array( '%d', '%s', '%s' )
);

if ( $result ) {
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While technically fine, how would you feel about a strict comparison? insert() return int|false.

What about

Suggested change
if ( $result ) {
if ( is_int( $result ) ) {

Comment on lines +193 to +195
if ( false !== $result ) {
self::$storage_post_ids[ $room_hash ] = $this->merge_duplicate_storage_posts( $room_hash, $post_id );
}
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here you actually did what i suggested above, but why the negative check instead of the positive test?

Comment on lines +210 to +212
if ( $result ) {
self::$storage_post_ids[ $room_hash ] = $this->merge_duplicate_storage_posts( $room_hash, $post_id );
}
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above, same argument/case

$canonical_post_id = $this->promote_storage_post_to_canonical_slug( $room_hash, $inserted_post_id );
}

if ( null === $canonical_post_id ) {
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would still consider checking for intval() instead for null, but in these cases the case is not as strong as above.

@dmsnell
Copy link
Copy Markdown
Member Author

dmsnell commented Apr 28, 2026

thanks @apermo — for now this is still a draft and mainly here to backport an upstream change in Gutenberg. I didn’t want to change the patch yet; just preserve what’s on the other side so tests can run and all.

I think you have good feedback; the original code was created by LLMs and that’s why it seems confused and split-brained.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants