Suggest mode 6: Bump payload schema to v2 (foundations)#77967
Open
adamsilverstein wants to merge 1 commit intoadd-suggestion-modefrom
Open
Suggest mode 6: Bump payload schema to v2 (foundations)#77967adamsilverstein wants to merge 1 commit intoadd-suggestion-modefrom
adamsilverstein wants to merge 1 commit intoadd-suggestion-modefrom
Conversation
v1 readers silently dropped operation types they didn't know about, which would cause a v2 payload with structural ops (block-insert-after, block-remove, block-move under #77434) to apply only its attribute-set operations. Refusing the payload outright instead surfaces an explicit "newer editor" notice and offers only Reject. The shape is unchanged: v1 payloads only ever carried attribute-set ops and remain valid as v2 payloads. The migration step in parseSuggestionPayload stamps the version field forward; no rewriting needed. Pre-versioned payloads are treated as v1. Refs #77434.
adamsilverstein
requested review from
ajitbohra,
fabiankaegy and
juanmaguitar
as code owners
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: +50 B (0%) Total Size: 7.92 MB 📦 View Changed
ℹ️ View Unchanged
|
This was referenced May 5, 2026
adamsilverstein
added
[Feature] Notes
adamsilverstein
requested review from
Mamaduka and
t-hamano
and removed request for
ajitbohra,
fabiankaegy and
juanmaguitar
This was referenced May 5, 2026
|
Flaky tests detected in f6c4e6f. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/25390203164
|
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
1 participant
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.
What
Bumps the suggestion payload
schemaVersionfrom 1 to 2 and tightensparseSuggestionPayloadto:schemaVersion > SCHEMA_VERSION) — surfaces an explicit "newer editor" notice instead of silently dropping unknown op types.schemaVersion < SCHEMA_VERSION) — pure version-field stamp; v1 payloads only ever carriedattribute-setops and remain valid as v2 payloads.schemaVersionfield as v1 (only the v1 implementation could have emitted it).This is plumbing for the structural-suggestion stack tracked in #77434. No user-visible change.
Why
Without the bump, a v1 reader receiving a v2 payload with
block-insert-after/block-remove/block-moveops would silently apply only theattribute-setops and drop the rest — a confusing partial-apply. Refusing the payload outright hands the user a clear "this suggestion was made by a newer editor" notice and only the Reject affordance.The shape is otherwise unchanged: v1 payloads carry only
attribute-setops, which are still valid in v2. The migration step inparseSuggestionPayloadis a no-op rewrite — it just stamps the version field forward.Testing the complete feature
To exercise structural suggestions end-to-end, check out the topmost branch in the stack (which contains every commit below it):
# Topmost branch in the stack: suggest-mode-6c-move-ui (PR #77979). git fetch origin suggest-mode-6c-move-ui git checkout suggest-mode-6c-move-ui npm install npm run dev npm run wp-env startTesting instructions
Then in
wp-admin:For the multi-peer scenario, open the same post in a second browser tab as a different user. Suggestions auto-saved on tab A appear in tab B's sidebar; Apply/Reject on tab B propagates back through the sync layer without the originating tab's interceptor reverting the apply (covered by
isAcceptedSuggestionChangefor attribute-set today; structural multi-peer accept hardening tracked as a follow-up).Stack
Refs #77434, #73411.