Skip to content

RTC: Use activation hook to enable RTC by default#76736

Merged
chriszarate merged 4 commits intotrunkfrom
fix/rtc-default-option
Mar 20, 2026
Merged

RTC: Use activation hook to enable RTC by default#76736
chriszarate merged 4 commits intotrunkfrom
fix/rtc-default-option

Conversation

@chriszarate
Copy link
Copy Markdown
Contributor

What?

Use activation hook to enable RTC by default.

Why?

As noted by @t-hamano, since Core sets the wp_collaboration_enabled option to 0, we can't override the value with the default_option_ filter. We also can't use a pre_option_ filter, as that would prevent the user from disabling it entirely.

How?

A plugin activation hook allows us to set the option to our desired value.

@chriszarate chriszarate added [Type] Bug An existing feature does not function as intended [Feature] Real-time Collaboration Phase 3 of the Gutenberg roadmap around real-time collaboration Backport to WP 7.0 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta labels Mar 20, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 20, 2026

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: chriszarate <czarate@git.wordpress.org>
Co-authored-by: alecgeatches <alecgeatches@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@alecgeatches
Copy link
Copy Markdown
Contributor

@chriszarate Pushed up a change to replace the dirname( __DIR__, 3 ) call with a direct activate_ hook in c96592c. This hardcodes gutenberg/gutenberg.php as the plugin name, but the root Gutenberg file already does this and I think it's a bit cleaner than a directory count.

@chriszarate
Copy link
Copy Markdown
Contributor Author

Needs backport changelog. can be added to 11289.md

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 20, 2026

Flaky tests detected in 1a8b57f.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/23356243332
📝 Reported issues:

@chriszarate
Copy link
Copy Markdown
Contributor Author

Co-authored-by: chriszarate czarate@git.wordpress.org
Co-authored-by: alecgeatches alecgeatches@git.wordpress.org

@chriszarate chriszarate merged commit b9bddfc into trunk Mar 20, 2026
41 checks passed
@chriszarate chriszarate deleted the fix/rtc-default-option branch March 20, 2026 19:11
@github-actions github-actions bot added this to the Gutenberg 22.9 milestone Mar 20, 2026
@github-actions github-actions bot removed the Backport to WP 7.0 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta label Mar 20, 2026
gutenbergplugin pushed a commit that referenced this pull request Mar 20, 2026
* Use activation hook to enable RTC by default

* Fix plugin file reference

* Directly hook into the `activate_` function for enabling collaboration

* Add PR backport for opt-in change

---------

Co-authored-by: Alec Geatches <alec.geatches@automattic.com>
@github-actions
Copy link
Copy Markdown

I just cherry-picked this PR to the wp/7.0 branch to get it included in the next release: cad9ad6

@github-actions github-actions bot added the Backported to WP Core Pull request that has been successfully merged into WP Core label Mar 20, 2026
pento pushed a commit to WordPress/wordpress-develop that referenced this pull request Mar 24, 2026
This updates the pinned hash from the `gutenberg` from `2ee7ede6be6d4e55d5c7047394c5c4e0ea8d521d` to `3edafcc90fc4520939d69279e26ace69390582be`.

The following changes are included:

- RTC: Use activation hook to enable RTC by default (WordPress/gutenberg#76736)
- Connectors: Align client-side registration API with server-side (WordPress/gutenberg#76737)
- Connectors: Support non-AI provider types and add JS extensibility e2e test (WordPress/gutenberg#76722)
- RTC: Add E2E "stress test" with complex interactions (WordPress/gutenberg#76055)
- Button: restore specificity of high-contrast mode focus ring (WordPress/gutenberg#76719) (WordPress/gutenberg#76770)
- Connectors: Improve AI plugin button (WordPress/gutenberg#76759)
- RTC: Use prepared queries instead of `*_post_meta` functions (WordPress/gutenberg#76779)

A full list of changes can be found on GitHub: https://github.com/WordPress/gutenberg/compare/2ee7ede6be6d4e55d5c7047394c5c4e0ea8d521d…3edafcc90fc4520939d69279e26ace69390582be.

Log created with:

git log --reverse --format="- %s" 2ee7ede6be6d4e55d5c7047394c5c4e0ea8d521d..3edafcc90fc4520939d69279e26ace69390582be | sed 's|#\([0-9][0-9]*\)|https://github.com/WordPress/gutenberg/pull/\1|g; /github\.com\/WordPress\/gutenberg\/pull/!d' | pbcopy

See #64595.

git-svn-id: https://develop.svn.wordpress.org/trunk@62102 602fd350-edb4-49c9-b593-d223f7449a82
markjaquith pushed a commit to WordPress/WordPress that referenced this pull request Mar 24, 2026
This updates the pinned hash from the `gutenberg` from `2ee7ede6be6d4e55d5c7047394c5c4e0ea8d521d` to `3edafcc90fc4520939d69279e26ace69390582be`.

The following changes are included:

- RTC: Use activation hook to enable RTC by default (WordPress/gutenberg#76736)
- Connectors: Align client-side registration API with server-side (WordPress/gutenberg#76737)
- Connectors: Support non-AI provider types and add JS extensibility e2e test (WordPress/gutenberg#76722)
- RTC: Add E2E "stress test" with complex interactions (WordPress/gutenberg#76055)
- Button: restore specificity of high-contrast mode focus ring (WordPress/gutenberg#76719) (WordPress/gutenberg#76770)
- Connectors: Improve AI plugin button (WordPress/gutenberg#76759)
- RTC: Use prepared queries instead of `*_post_meta` functions (WordPress/gutenberg#76779)

A full list of changes can be found on GitHub: https://github.com/WordPress/gutenberg/compare/2ee7ede6be6d4e55d5c7047394c5c4e0ea8d521d…3edafcc90fc4520939d69279e26ace69390582be.

Log created with:

git log --reverse --format="- %s" 2ee7ede6be6d4e55d5c7047394c5c4e0ea8d521d..3edafcc90fc4520939d69279e26ace69390582be | sed 's|#\([0-9][0-9]*\)|https://github.com/WordPress/gutenberg/pull/\1|g; /github\.com\/WordPress\/gutenberg\/pull/!d' | pbcopy

See #64595.
Built from https://develop.svn.wordpress.org/trunk@62102


git-svn-id: http://core.svn.wordpress.org/trunk@61384 1a063a9b-81f0-0310-95a4-ce76da25c4cd
dmsnell pushed a commit to dmsnell/wordpress-develop that referenced this pull request Mar 24, 2026
See changelog in 5875321

> Editor: Bump pinned hash for the Gutenberg repository. This updates the pinned hash from the `gutenberg` from `2ee7ede6be6d4e55d5c7047394c5c4e0ea8d521d` to `3edafcc90fc4520939d69279e26ace69390582be`.
> The following changes are included:
>
> - RTC: Use activation hook to enable RTC by default (WordPress/gutenberg#76736)
dmsnell pushed a commit to dmsnell/wordpress-develop that referenced this pull request Mar 26, 2026
See changelog in 5875321

> Editor: Bump pinned hash for the Gutenberg repository. This updates the pinned hash from the `gutenberg` from `2ee7ede6be6d4e55d5c7047394c5c4e0ea8d521d` to `3edafcc90fc4520939d69279e26ace69390582be`.
> The following changes are included:
>
> - RTC: Use activation hook to enable RTC by default (WordPress/gutenberg#76736)
@dsas dsas added Backport to Gutenberg Minor Release Pull request that needs to be backported to a Gutenberg minor release and removed Backport to Gutenberg Minor Release Pull request that needs to be backported to a Gutenberg minor release labels Mar 26, 2026
@dsas dsas modified the milestones: Gutenberg 22.9, Gutenberg 22.8 Mar 26, 2026
@dsas
Copy link
Copy Markdown
Contributor

dsas commented Mar 26, 2026

I just cherry-picked this PR to the release/22.8 branch to get it included in the next release: f63d9f5

dsas pushed a commit to dsas/gutenberg that referenced this pull request Mar 26, 2026
* Use activation hook to enable RTC by default

* Fix plugin file reference

* Directly hook into the `activate_` function for enabling collaboration

* Add PR backport for opt-in change

---------

Co-authored-by: Alec Geatches <alec.geatches@automattic.com>
pento pushed a commit to WordPress/wordpress-develop that referenced this pull request Mar 26, 2026
See changelog in 5875321

> Editor: Bump pinned hash for the Gutenberg repository. This updates the pinned hash from the `gutenberg` from `2ee7ede6be6d4e55d5c7047394c5c4e0ea8d521d` to `3edafcc90fc4520939d69279e26ace69390582be`.
> The following changes are included:
>
> - RTC: Use activation hook to enable RTC by default (WordPress/gutenberg#76736)

git-svn-id: https://develop.svn.wordpress.org/branches/fixes-64393-restore-version-history@62142 602fd350-edb4-49c9-b593-d223f7449a82
ockham pushed a commit that referenced this pull request Mar 26, 2026
* Real Time Collaboration: Introduce filters for the polling intervals. (#76518)

* Introduce filters for the RTC polling intervals.

Introduces four filters for the polling intervals in the real time collaboration client:

* `sync.pollingManager.pollingIntervalNoCollaborators` the interval in milliseconds when there are no collaborators in the room
* `sync.pollingManager.pollingIntervalWithCollaborators` the interval in milliseconds when there are collaborators in the room

* Remove background tab interval filter

* Match filter to constant name

---------

Co-authored-by: peterwilsoncc <peterwilsoncc@git.wordpress.org>
Co-authored-by: chriszarate <czarate@git.wordpress.org>

* RTC: Fix RichTextData deserialization (#76607)

* Add failing unit test for RichTextData conversion

* Fix RichText attribute type via deserializeBlockAttributes() call in getPostChangesFromCRDTDoc()

* Add test for nested RichText value

* Modify deserializeAttributeValue() to recurse arrays and object, using block schema for deeply nested strings

* Remove deserializeBlockAttributeValues to avoid 3 different deserialization functions

* Add factory wrapper for rich text cache, testing

Co-authored-by: alecgeatches <alecgeatches@git.wordpress.org>
Co-authored-by: chriszarate <czarate@git.wordpress.org>
Co-authored-by: ingeniumed <ingeniumed@git.wordpress.org>

* RTC: Scroll to collaborator on click (#76561)

* Add createCursorRegistry factory and use it for scrolling to cursors

* Use createCursorRegistry for scrolling

* Localize spoken scroll to cursor announcement

* Merge two matching conditionals

* Use removeAll in cursor registry

------
Co-authored-by: maxschmeling <maxschmeling@git.wordpress.org>
Co-authored-by: ingeniumed <ingeniumed@git.wordpress.org>

* RTC: Change RTC option name (#76643)

* Change RTC option name

* Add backport changelog

* Restore option migration

* Cover previous option name in setCollaboration

* Respect previous value in setting injection

* Update migration const

* Temporary bridge

Co-authored-by: chriszarate <czarate@git.wordpress.org>
Co-authored-by: sc0ttkclark <sc0ttkclark@git.wordpress.org>
Co-authored-by: maxschmeling <maxschmeling@git.wordpress.org>
Co-authored-by: ingeniumed <ingeniumed@git.wordpress.org>

* RTC: Backport race condition fix (#76649)

* Backport race condition fix

* Add backport changelog entry

* RTC: Increase polling intervals, increase polling on primary room only (#76704)

* Bump polling intervals up by 4x

* Reset `hasCollaborators` flag on awareness check

* Use the first registered room as the primaryRoom, and only pay attention to awareness results from that entity to avoid poll increases from shared entities like categores

* Simplify primaryRoom and enforceConnectionLimit

* Fix the collaboration utility setup for collaboration tests

---------

Co-authored-by: alecgeatches <alecgeatches@git.wordpress.org>
Co-authored-by: ingeniumed <ingeniumed@git.wordpress.org>
Co-authored-by: chriszarate <czarate@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>

* RTC: Use activation hook to enable RTC by default (#76736)

* Use activation hook to enable RTC by default

* Fix plugin file reference

* Directly hook into the `activate_` function for enabling collaboration

* Add PR backport for opt-in change

---------

Co-authored-by: Alec Geatches <alec.geatches@automattic.com>

* RTC: Add E2E "stress test" with complex interactions (#76055)

* Add RTC E2E "stress test" with complex interactions

* Refactor collab utils to work for n users instead of just 2 users

* Attempting to fix the timeout, as well as the text insertion being slightly off

* insert the test rather than sequentially type it

* Respect the collaborators limit of 3

* Switch the type to insertText

* Remove refresh as that causes editor limit exceeded

* Check Gamma's movement

---------

Co-authored-by: chriszarate <czarate@git.wordpress.org>
Co-authored-by: ingeniumed <ingeniumed@git.wordpress.org>
Co-authored-by: shekharnwagh <shekharnwagh@git.wordpress.org>

* RTC: Use prepared queries instead of `*_post_meta` functions (#76779)


## What?

Use prepared queries instead of `*_post_meta` functions.

## Why?

Backport of WordPress/wordpress-develop#11325. Prevents post and post meta cache invalidation when RTC requests are handled.

- See: https://core.trac.wordpress.org/ticket/64696
- See: https://core.trac.wordpress.org/ticket/64916

* RTC: Remove stale wp_enable_real_time_collaboration option check (#76810)

Co-authored-by: shekharnwagh <shekharnwagh@git.wordpress.org>
Co-authored-by: chriszarate <czarate@git.wordpress.org>

* RTC: Fix editor freeze when replacing code editor content (#76815)

* Add failing performance test for huge code editor changes

* Use diffLines() when strings are > 10_000 characters

* Handle diffLines in diffWithCursor() when cursor information is sent. We don't care about the cursor for huge performance-sensitive updates

* Explicitly use "primary" instead of "meta" key

* Revert "Explicitly use "primary" instead of "meta" key"

This reverts commit 33e7aba.

* Fix paste keys for CI, lower timeouts

* Remove console.log

Co-authored-by: alecgeatches <alecgeatches@git.wordpress.org>
Co-authored-by: chriszarate <czarate@git.wordpress.org>

* Preferences: Hide collaboration options when RTC is not enabled (#76819)

* Preferences: Hide collaboration options when RTC is not enabled

Only show the "Show avatar in blocks" and "Show collaboration
notifications" preference controls when real-time collaboration
is actually enabled for the current post.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Preferences: Consolidate editorStore select call

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: chriszarate <czarate@git.wordpress.org>

* Fix navigation block rendering unit test (#76685)

* Fix navigation block rendering unit test

* Remove semicolon

Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: westonruter <westonruter@git.wordpress.org>

* Fix navigation block unit test and e2e test (#76692)

* Fix navigation block rendering unit test (second try)

* Fix e2e test

* Revert unncessary change

---------

Co-authored-by: Peter Wilson <519727+peterwilsoncc@users.noreply.github.com>
Co-authored-by: peterwilsoncc <peterwilsoncc@git.wordpress.org>
Co-authored-by: chriszarate <czarate@git.wordpress.org>
Co-authored-by: Alec Geatches <alec.geatches@automattic.com>
Co-authored-by: alecgeatches <alecgeatches@git.wordpress.org>
Co-authored-by: ingeniumed <ingeniumed@git.wordpress.org>
Co-authored-by: Max Schmeling <max.schmeling@automattic.com>
Co-authored-by: maxschmeling <maxschmeling@git.wordpress.org>
Co-authored-by: Chris Zarate <chris.zarate@automattic.com>
Co-authored-by: sc0ttkclark <sc0ttkclark@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: shekharnwagh <shekharnwagh@git.wordpress.org>
Co-authored-by: Shekhar Wagh <shekharnwagh@gmail.com>
Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
Co-authored-by: westonruter <westonruter@git.wordpress.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Backported to WP Core Pull request that has been successfully merged into WP Core [Feature] Real-time Collaboration Phase 3 of the Gutenberg roadmap around real-time collaboration [Type] Bug An existing feature does not function as intended

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants