DimensionsPanel: Fix site editor error on Columns block level screen #51252
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
… therefore not null
andrewserong
added
[Type] Bug
|
Size Change: +2 B (0%) Total Size: 1.4 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in b0ad156. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5184031998
|
andrewserong
requested review from
noisysocks,
apeatling,
ramonjd and
tellthemachines
t-hamano
reviewed
Jun 6, 2023
| @@ -208,7 +208,7 @@ export default function DimensionsPanel( { | |||
| includeLayoutControls = false, | |||
| } ) { | |||
| const decodeValue = ( rawValue ) => { | |||
| if ( typeof rawValue === 'object' ) { | |||
| if ( rawValue && typeof rawValue === 'object' ) { | |||
There was a problem hiding this comment.
Suggested change
| if ( rawValue && typeof rawValue === 'object' ) { | |
| if ( rawValue !== null && typeof rawValue === 'object' ) { |
While the problem can be fixed as is, I think it is more rigorous to explicitly check for null or not. This implementation is similar to the isObject() function.
There was a problem hiding this comment.
Thanks for the feedback! Usage isn't very consistent across Gutenberg, and I see a few other places where similar functions use a truthy check, e.g. in another isObject function and recent _.isEmpty removals as in #51098 and #51096.
I have a slight preference for a truthy check over !== null because, though it's less explicit, it seems to me a slightly more complete check and better matches to lodash's non-strict == null check in isEmpty.
Let me know if you think we're missing anything by not including the strict check, and we can always open up a follow-up, though!
t-hamano
reviewed
Jun 6, 2023
There was a problem hiding this comment.
Thanks for spotting the mistake, @andrewserong 🙏I will not be able to test this PR until tomorrow, but I will leave a comment.
apeatling
approved these changes
Jun 6, 2023
|
Thanks for the reviews! I've left the truthy check in as-is for now, but we can always look into a follow-up if there's any further feedback on it in terms of code style. I'll merge this in now so that the bug is fixed in |
sethrubenstein
pushed a commit
to pewresearch/gutenberg
that referenced
this pull request
Jul 13, 2023
… therefore not null (WordPress#51252)
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?
Related to: #50956
Fixes a site editor error when accessing the Columns block level screen, by ensuring that
rawValueis truthy before attempting to access its keys.Why?
Sometimes values can be
nulland unfortunatelytypeof nullin JavaScript equalsobject, so anullvalue indecodeValuescan be passed toObject.keys()which throws an error.I believe the value that was null in this case is
blockGap. Further down in the function it looks likesetGapValueswill set gap values tonull.How?
rawValuebefore passing toObject.keysTesting Instructions
Screenshots or screencast
Before this PR: