Phase 4: Attribute suggestions, architecture docs, e2e coverage#77406
Open
adamsilverstein wants to merge 17 commits intosuggest-mode-phase-3from
Open
Phase 4: Attribute suggestions, architecture docs, e2e coverage#77406adamsilverstein wants to merge 17 commits intosuggest-mode-phase-3from
adamsilverstein wants to merge 17 commits intosuggest-mode-phase-3from
Conversation
adamsilverstein
changed the title
This was referenced Apr 16, 2026
|
Size Change: -2 B (0%) Total Size: 7.91 MB 📦 View Changed
ℹ️ View Unchanged
|
adamsilverstein
force-pushed
the
suggest-mode-phase-3
branch
from
3f85774 to
7e2fe59
Compare
adamsilverstein
force-pushed
the
suggest-mode-phase-4
branch
2 times, most recently
from
37bd62c to
8111615
Compare
adamsilverstein
force-pushed
the
suggest-mode-phase-3
branch
2 times, most recently
from
9debb13 to
f63fe8c
Compare
adamsilverstein
force-pushed
the
suggest-mode-phase-4
branch
from
8111615 to
7368e91
Compare
adamsilverstein
force-pushed
the
suggest-mode-phase-3
branch
from
f63fe8c to
66f2542
Compare
adamsilverstein
force-pushed
the
suggest-mode-phase-4
branch
from
7368e91 to
e6e6960
Compare
adamsilverstein
force-pushed
the
suggest-mode-phase-3
branch
from
66f2542 to
5f968da
Compare
adamsilverstein
force-pushed
the
suggest-mode-phase-4
branch
from
e6e6960 to
2a1c564
Compare
adamsilverstein
force-pushed
the
suggest-mode-phase-3
branch
from
5f968da to
8e41010
Compare
adamsilverstein
force-pushed
the
suggest-mode-phase-4
branch
from
2a1c564 to
1a1f57b
Compare
adamsilverstein
force-pushed
the
suggest-mode-phase-3
branch
from
8e41010 to
31a0ce8
Compare
adamsilverstein
force-pushed
the
suggest-mode-phase-4
branch
from
1a1f57b to
306e967
Compare
adamsilverstein
added
[Type] Enhancement
Member
Author
|
Playwright-5 failed again on the rerun of run 24542691965 with the same widespread-shard pattern — 43 tests failing across unrelated specs ( This matches the known-flaky set tracked in #76524 and #77385 (already called out by the flaky-tests bot on this stack). Shards 4 and 5 appear to be overloaded on this repo and regularly fall over mid-run regardless of the PR's code. Trunk's E2E runs on recent commits are green, so this isn't a trunk regression. Rerunning once more. |
Member
Author
|
Second rerun of Playwright-5 (job 72026854911) failed with the same shard-wide flake pattern — the known-flaky tests tracked in #76524 and #77385 plus two transient failures in our new Suggest-mode attribute spec. Accepting this shard-5 flake as unblocking:
Not rerunning again. |
|
Flaky tests detected in 452ad12. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/25348432561
|
adamsilverstein
requested review from
ajitbohra 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. |
adamsilverstein
requested review from
Mamaduka and
t-hamano
and removed request for
ajitbohra,
fabiankaegy and
juanmaguitar
Phase 4 of the Suggest mode effort. The attribute-set operation type already handles all block attributes generically (text, heading level, alignment, style objects), so this phase focuses on verification, documentation, and hardening. New: - E2E test proving non-text attribute suggestions work end-to-end (heading level change via toolbar in Suggest mode). - Architecture doc at docs/explanations/architecture/suggestions.md covering the overlay, payload schema, provider interface, apply/ reject lifecycle, diff rendering, Yjs v2 migration path, and known limitations (structural suggestions, inline selections, permissions, rich-text format fidelity). Known limitation documented: applying another user's suggestion requires moderate_comments because core's update_item_permissions_check gates on edit_comment. A follow-up PR should override this for notes. Refs #73411
…vel test MenuItemsChoice doesn't auto-close its dropdown when a radio item is selected, so `switchIntent` was leaving the Options menu open. A follow-up `switchIntent` call then toggled the open menu closed instead of reopening it, which broke the 'restores baseline when switching back to Edit intent' test. Press Escape after selecting the intent so switchIntent is idempotent. Skip the heading-level suggestion test: the overlay HOC only wraps `setAttributes` passed to a block's `BlockEdit`, but heading level on web is changed via the block-variation picker, which dispatches `updateBlockAttributes` directly on the store and bypasses the HOC. Capturing store-level attribute changes needs a dedicated interception layer in the suggestion provider (tracked as follow-up).
The skipped test was a placeholder pending an interceptor for direct updateBlockAttributes mutations. With the store-level interceptor landed in Phase 2, the block-switcher's variation picker is now captured by the overlay. Rewrite the test to actually drive the toolbar dropdown and verify both the overlay-rendered DOM and the unchanged serialized post.
adamsilverstein
force-pushed
the
suggest-mode-phase-3
branch
from
31a0ce8 to
00f4458
Compare
adamsilverstein
force-pushed
the
suggest-mode-phase-4
branch
from
a0d1658 to
9343cdf
Compare
…el e2e
- isAttributeEqual returned true for two RichTextData instances with
different content because RichTextData stores its content in private
class fields and exposes no enumerable own keys, so a key-by-key walk
found nothing different. Fall back to a String() compare when both
objects have zero own keys, so diff'ing a paragraph's content overlay
against its baseline correctly produces an attribute-set operation
and the auto-save POST actually fires.
- The block-switcher button on a heading reflects the active variation
('Heading 2'), not the bare block name ('Heading'), so the existing
selector with exact: true never matched. Use a regex on the variation
title.
- The block also renders the level as the actual h{n} tag rather than
setting aria-level, so assert tagName instead.
…ion files Add the missing 'Store interceptor' subsection covering the snapshot/diff/ revert strategy, the apply-time bypass, and the multi-peer accept loop (complementary halves: requestInterceptorBypass + isAcceptedSuggestionChange). Add an 'Implementation files' table so reviewers can navigate from the architecture description to the source. Add an 'Implementation wrinkles' section documenting the RichTextData wrapper boundary, DEEP_MERGE_KEYS, the dual lifecycle axes, and the payload-size cap that the existing doc glossed over.
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.
Overview
This is one of 5 stacked PRs implementing Suggest mode for the WordPress editor — a Google Docs–style workflow where reviewers can propose changes that the post author can Accept or Reject. Tracked in #73411, with design direction from #73410 and jasmussen's mockups.
This PR (Phase 4)
Review-UX polish + architecture docs + attribute coverage:
SuggestionSummary— compact Docs-style summary rendered in the notes sidebar. DerivesAdd:,Delete:,Formatting:, andFormat:lines from a payload's operations:contentedits produce quotedAdd:/Delete:lines from a word-level diff, ellipsized at 120 characters.<strong>) are detected by comparing visible text with tags stripped and emitFormatting: bold, italicrather than leaking raw<strong>markup.Format:line with human-readable labels.suggestion-mode.spec.jsexercises heading-level changes so non-text attribute suggestions are covered end-to-end alongside the text case.hasAttributeConflict— helper that compares each operation's capturedbeforeto the block's current value. The "apply anyway" confirmation is now scoped per-attribute instead of per-post, so unrelated activity (other blocks, auto-saves, style edits) no longer trips the staleness dialog. Post-levelbaseRevisionis still stamped into the payload for provenance.docs/explanations/architecture/suggestions.mddocuments the provider interface, payload shape, overlay semantics, auto-save timing, conflict detection, and the Yjs v2 migration path.What's NOT in this PR
Phase 4 test plan
Add: "…"/Delete: "…"quotesFormatting: boldand does not leak raw<strong>tagsFormat: heading levelnpm run test:unit -- packages/editor/src/components/suggestion-mode/test/suggestion-summary.jsnpm run test:unit -- packages/editor/src/components/suggestion-mode/test/provider.js --testNamePattern=hasAttributeConflictnpm run test:e2e -- test/e2e/specs/editor/various/suggestion-mode.spec.js🗺️ PR Stack Navigation
_wp_suggestionmeta, provider, sidebar actions📋 Tracking issue: #73411