PropTypes: distinguish nullable from optional object field#7291
Merged
chenglou merged 3 commits intofacebook:masterfrom Jul 26, 2016
Merged
PropTypes: distinguish nullable from optional object field#7291chenglou merged 3 commits intofacebook:masterfrom
chenglou merged 3 commits intofacebook:masterfrom
Conversation
ghost
added
Contributor
Author
|
cc @spicyj @keyanzhang realized this confusion during the codemod. |
Contributor
| null, | ||
| ReactPropTypesSecret | ||
| ); | ||
| expect(error2 instanceof Error).toBe(true); |
Collaborator
There was a problem hiding this comment.
Nit but I guess you’d want to do the instanceof check for error1 too?
Contributor
Author
There was a problem hiding this comment.
Nice catch, corrected, thanks.
Collaborator
|
To be clear, this distinguishes null from undefined, but does not distinguish undefined from an absent field – right? |
Contributor
Author
|
Right, I don't tackle that. |
Contributor
Author
|
@spicyj is this good for merging? |
| if (isRequired) { | ||
| if (props[propName] === null) { | ||
| return new Error( | ||
| `Required ${locationName} \`${propFullName}\` was specified in ` + |
Collaborator
There was a problem hiding this comment.
Can we do
The ${locationName} `${propFullName}` is required in ${componentName}, but its value is null.
and replace the other message with "…its value is undefined."?
lgtm. Can you send me a diff internally to html/shared/core/createWarning.js adding the new wording so we don't forget?
Collaborator
|
I'd like the wording to be clearer and more accurate as noted inline, but after you fix that feel free to squash and merge. |
This gives a more precise message (no type semantics change) to the case of passing a field in an object, but whose value is `null`:
Before:
```js
propTypes: {
foo: React.PropTypes.number.isRequired
}
```
Would scream "Required prop `foo` was not specified in `MyComp`".
Now it'll be "Required prop `foo` was specified in `MyComp`, but its value is `null`.".
Works as expected in nested objects.
This fixes the issue of a component transitively passing a `null`, specifying the correct field to the child but have the child tell it that it didn't provide the prop.
Optional field and nullable are two different things anyway.
zpao
pushed a commit
that referenced
this pull request
Oct 4, 2016
* PropTypes: distinguish nullable from optional object field
This gives a more precise message (no type semantics change) to the case of passing a field in an object, but whose value is `null`:
Before:
```js
propTypes: {
foo: React.PropTypes.number.isRequired
}
```
Would scream "Required prop `foo` was not specified in `MyComp`".
Now it'll be "Required prop `foo` was specified in `MyComp`, but its value is `null`.".
Works as expected in nested objects.
This fixes the issue of a component transitively passing a `null`, specifying the correct field to the child but have the child tell it that it didn't provide the prop.
Optional field and nullable are two different things anyway.
* Add missing test case.
* Reword messages.
(cherry picked from commit 0292d34)
1 task
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
5 participants
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.
This gives a more precise message (no type semantics change) to the case of passing a field in an object, but whose value is
null:Before:
Would scream "Required prop
foowas not specified inMyComp".Now it'll be "Required prop
foowas specified inMyComp, but its value isnull.".Works as expected in nested objects.
This fixes the issue of a component transitively passing a
null, specifying the correct field to the child but have the child tell it that it didn't provide the prop.Optional field and nullable are two different things anyway.