Popover: make sure that ownerDocument is always defined #42886
Merged
Conversation
This file contains 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
ciampo
added
[Type] Bug
ntsekouras
approved these changes
Aug 2, 2022
|
Size Change: +18 B (0%) Total Size: 1.27 MB
ℹ️ View Unchanged
|
This was referenced Aug 2, 2022
mirka
approved these changes
Aug 3, 2022
There was a problem hiding this comment.
I added some thoughts just in the wider context of the general Popover work, but as for this PR I'm totally fine with merging as is 👍 Thanks for taking the time to investigate tangential issues and leave explanations.
The
ownerDocumentcould sometimes beundefinedwhen the consumer of thePopoveruses a "modern style" ref (i.e. by using theuseRefhook) and passes that value through theanchorRefprop.
Would it be easy to add a quick unit test for this specific regression?
| @@ -137,25 +137,26 @@ const Popover = ( | |||
| : placement; | |||
|
|
|||
| const ownerDocument = useMemo( () => { | |||
| let documentToReturn; | |||
|
|
|||
| if ( anchorRef?.top ) { | |||
There was a problem hiding this comment.
I'm surprised anchorRef is not even documented in the readme, when it's the prop that takes the highest priority. Looks like we have a lot of work to do (docs, stories, tests) as we work out the kinks in this component 💪
There was a problem hiding this comment.
Yup! This component definitely needs a lot of work
ciampo
force-pushed
the
fix/popover-owner-document
branch
from
4e09d9f to
6d4e076
Compare
Done in 6d4e076. I checked that the test currently fails on |
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.
What?
In the
Popovercomponent, the computation ofownerDocumentfrom the anchor could sometimes produce anundefinedvalue — which then would cause runtime errors in other parts of the component.This PR adds a fix which ensures that
ownerDocumentis always defined.Why?
The
ownerDocumentcould sometimes beundefinedwhen the consumer of thePopoveruses a "modern style" ref (i.e. by using theuseRefhook) and passes that value through theanchorRefprop.For more details on how the bug was initially discovered, see #42874 (comment)
How?
The logic has been slightly changed to make sure that the current
documentis used as a fallback value in caseownerDocumentwasundefined.Testing Instructions
Here's a patch to add a Storybook example that uses a "modern style" ref as the Popover's
anchorRefClick to expand
Apply the patch on
trunkand notice how the Storybook example generates an error. Then, apply the same patch on this PR's branch and notice how the Storybook example works as expected.Finally, do a general smoke tests across the codebase to make sure that no regressions are introduced.