fix(gutenberg): prevent setAttributes on initial mount to avoid dirtying blocks - #34
Open
dfross wants to merge 1 commit into
Open
fix(gutenberg): prevent setAttributes on initial mount to avoid dirtying blocks#34dfross wants to merge 1 commit into
dfross wants to merge 1 commit into
Conversation
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.
Summary
In
packages/gutenberg/src/index.tsx, an initial render lifecycle bug causes clean posts, templates, and template parts to be marked as modified ("Review changes") immediately upon opening the WordPress Site Editor or Block Editor.Problem
The component initializes internal state with empty arrays:
A
useEffecthook depends on[classNames]and synchronizes it to Gutenberg viaprops.setAttributes(...):Because
classNamesstarts empty, this effect fires on initial mount and writes{ className: "" }to the block attributes before the saved classes finish loading. CallingsetAttributes()during initial render mutates Gutenberg's in-memory entity store, immediately flagging clean pages and template parts with unsaved changes.Solution
Added an
isInitialMountref guard (useRef(true)):isInitialMount.current = false, and returns without callingsetAttributes().className: ""on initial load.