CustomSelectControl V2: fix setting initial value and reacting to external controlled updates #62733
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
ciampo
changed the title
This was referenced Jun 21, 2024
|
Size Change: 0 B Total Size: 1.76 MB ℹ️ View Unchanged
|
ciampo
changed the base branch from
trunk
to
fix/custom-select-control-v2-legacy-adapter-option-handling
|
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. |
ciampo
commented
Jun 21, 2024
| @@ -64,7 +64,7 @@ const ControlledCustomSelectControl = ( { | |||
| onChange: onChangeProp, | |||
| ...restProps | |||
| }: React.ComponentProps< typeof UncontrolledCustomSelectControl > ) => { | |||
| const [ value, setValue ] = useState( options[ 0 ] ); | |||
| const [ value, setValue ] = useState( restProps.value ?? options[ 0 ] ); | |||
There was a problem hiding this comment.
This change allows the Controlled version of the component to use the value prop as the initial value (the same change was applied to the v1 component)
Base automatically changed from
fix/custom-select-control-v2-legacy-adapter-option-handling
to
trunk
June 21, 2024 14:00
ciampo
force-pushed
the
fix/custom-select-control-initial-value
branch
from
94b6f07
to
b0c11f0
Compare
ciampo
commented
Jun 21, 2024
| onChange={ mockOnChange } | ||
| /> | ||
| ); | ||
| render( <Component { ...props } onChange={ mockOnChange } /> ); |
There was a problem hiding this comment.
Align the test with the legacy v2 adapter (which doesn't set the value prop)
tyxla
approved these changes
Jun 21, 2024
packages/components/src/custom-select-control-v2/legacy-component/test/index.tsx
Outdated
Show resolved
Hide resolved
packages/components/src/custom-select-control-v2/legacy-component/test/index.tsx
Outdated
Show resolved
Hide resolved
packages/components/src/custom-select-control-v2/legacy-component/test/index.tsx
Outdated
Show resolved
Hide resolved
packages/components/src/custom-select-control-v2/legacy-component/test/index.tsx
Outdated
Show resolved
Hide resolved
| expect.objectContaining( { | ||
| inputValue: '', | ||
| isOpen: false, | ||
| selectedItem: expect.objectContaining( { | ||
| name: 'aquamarine', | ||
| } ), | ||
| type: '', | ||
| type: expect.any( String ), |
There was a problem hiding this comment.
type will literally always be an empty string, though?
There was a problem hiding this comment.
It will, but since we don't really document it in the v1, I thought that tests should be generic about what value to expect — as far as the attribute exists and it's a string. This also allows for the v1 and legacy v2 unit tests to be aligned on this particular assertion
| expect.objectContaining( { | ||
| inputValue: '', | ||
| isOpen: false, | ||
| selectedItem: expect.objectContaining( { | ||
| name: 'aquamarine', | ||
| } ), | ||
| type: '__item_click__', | ||
| type: expect.any( String ), |
There was a problem hiding this comment.
To make sure I understand this change: it's for compatibility so the both versions of the tests would have the same expectation against the different implementations?
There was a problem hiding this comment.
Yup! See reply in #62733 (comment)
ciampo
force-pushed
the
fix/custom-select-control-initial-value
branch
from
b0c11f0
to
c5b6a4c
Compare
|
All feedback addressed (either with code changes or replies). Will merge when CI checks pass. Thank you @tyxla for the review! |
|
Flaky tests detected in c5b6a4c. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/9616335298
|
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?
Supersedes #62308
Depends on #62255
Fixes how the
CustomSelectControlV2legacy adapter behaves around its initial value (and consequent firing of theonChangecallback)Why?
How?
Pass explicit
valueanddefaultValueto theuseStorecall in the legacy adapter. This has two consequences:valueexplicitly, we fix the controlled updates bugdefaultValueexplicitly to the first option, we don't rely on Ariakit's internal automatic selection and thus we avoid firing theonChangecallback on initial renderI edited existing unit tests and added a few more in both the v1 and the v2 legacy adapter to cover those changes and ensure that the two components behave the same.
Testing Instructions
packages/components/src/custom-select-control-v2/legacy-component/index.tsxAdditionally, check testing instructions from #62308