Fix stale layout when a child switches to display: contents after insertion - #58721
Closed
cipolleschi wants to merge 1 commit into
Closed
cipolleschi wants to merge 1 commit into
cipolleschi wants to merge 1 commit into
Conversation
…nsertion Summary: Each node caches how many of its children use `display: contents` (`contentsChildrenCount_`, added in react/yoga#1726). The count is updated in `insertChild`, `removeChild`, `replaceChild` and `setChildren`, but not when the display of a child that is already attached changes. So if `YGNodeStyleSetDisplay(child, YGDisplayContents)` is called after the child was inserted, the owner still reports `hasContentsChildren() == false`. The layout algorithm then skips `cleanupContentsNodesRecursively` for it, and the contents node keeps `isDirty == true` after layout. When a descendant of that node changes later, `markDirtyAndPropagate` stops at the contents node because it is already dirty, the root is never marked dirty, and the next `YGNodeCalculateLayout` returns the cached layout. Minimal repro: ```cpp YGNodeRef root = YGNodeNew(); YGNodeStyleSetWidth(root, 100); YGNodeStyleSetHeight(root, 100); YGNodeRef child = YGNodeNew(); YGNodeInsertChild(root, child, 0); YGNodeRef grandchild = YGNodeNew(); YGNodeStyleSetWidth(grandchild, 10); YGNodeStyleSetHeight(grandchild, 10); YGNodeInsertChild(child, grandchild, 0); YGNodeStyleSetDisplay(child, YGDisplayContents); YGNodeCalculateLayout(root, YGUndefined, YGUndefined, YGDirectionLTR); // YGNodeIsDirty(child) is still true YGNodeStyleSetWidth(grandchild, 20); // YGNodeIsDirty(root) is false YGNodeCalculateLayout(root, YGUndefined, YGUndefined, YGDirectionLTR); // YGNodeLayoutGetWidth(grandchild) is 10, expected 20 ``` This affects any binding that mutates nodes in place (the JS and Java bindings both go through `YGNodeStyleSetDisplay`). Setting the display before inserting the child works, which is what the existing tests do. The fix recomputes the owner's count in `YGNodeStyleSetDisplay` when a node that has an owner switches to or from `display: contents`. Changelog: [General][Fixed] - Fix stale layout when a child switches to `display: contents` after being inserted X-link: react/yoga#2028 Reviewed By: javache Differential Revision: D122122520 Pulled By: cipolleschi
|
@cipolleschi has exported this pull request. If you are a Meta employee, you can view the originating Diff in D122122520. |
|
@cipolleschi merged this pull request in 19a6722. |
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:
Each node caches how many of its children use
display: contents(contentsChildrenCount_, added in react/yoga#1726). The count is updated ininsertChild,removeChild,replaceChildandsetChildren, but not when the display of a child that is already attached changes.So if
YGNodeStyleSetDisplay(child, YGDisplayContents)is called after the child was inserted, the owner still reportshasContentsChildren() == false. The layout algorithm then skipscleanupContentsNodesRecursivelyfor it, and the contents node keepsisDirty == trueafter layout. When a descendant of that node changes later,markDirtyAndPropagatestops at the contents node because it is already dirty, the root is never marked dirty, and the nextYGNodeCalculateLayoutreturns the cached layout.Minimal repro:
This affects any binding that mutates nodes in place (the JS and Java bindings both go through
YGNodeStyleSetDisplay). Setting the display before inserting the child works, which is what the existing tests do.The fix recomputes the owner's count in
YGNodeStyleSetDisplaywhen a node that has an owner switches to or fromdisplay: contents.Changelog: [General][Fixed] - Fix stale layout when a child switches to
display: contentsafter being insertedX-link: react/yoga#2028
Reviewed By: javache
Differential Revision: D122122520
Pulled By: cipolleschi