Skip to content

Commit

Permalink
fix no-unused-prop-types + async class properties and methods
Browse files Browse the repository at this point in the history 
There was an incosistency with access and storage of the usedPropTypes
of a component that would cause proptypes to not be correctly marked as
used if more than one prop was used in the body of an async function
class property or async class method.

Fixes jsx-eslint#1053

---

bug source:

First time around
  - get the parentComponent using utils.getParentComponent() https://github.com/yannickcr/eslint-plugin-react/blob/master/lib/rules/no-unused-prop-types.js#L594
  - save off the usedPropTypes array from what component was found.
  - modify the array with my new used props.
  - set the new array on the node https://github.com/yannickcr/eslint-plugin-react/blob/master/lib/rules/no-unused-prop-types.js#L638
    Note that in this case the node is a MemberExpression
  - Components#set will then just crawl the parents of the current node
  (the MemberExpresion) until one was found in the internal this._list.
  - Because all async FunctionExpressions, ArrowFunctionExpressions, and
  FunctionDeclaration are treated as components of confidence 0 (not a
  component). The unusedPropTypes would be attached
  to this. (Which is usually fine).

However, if the component tries to mark a prop as used again, it will
read from the parentComponent using utils.getParentComponent() (which in
this case will return the class) which does not have the previously used
methods. The array would then be modified (created because it doesnt
exist), and then set them onto the async arrow function overwriting
anything that was previously there.

This change just attaches used props to the found component (where the
previous usedPropTypes are pulled from) if it exists, otherwise to the
current node.

---

Squashed:
Added test cases for factory methods on classes that return async
functions.
  • Loading branch information
@benstepp
benstepp committed Feb 26, 2017
1 parent b646485 commit 5829bc8
Show file tree
Hide file tree
Showing 2 changed files with 283 additions and 1 deletion.
2 changes: 1 addition & 1 deletion lib/rules/no-unused-prop-types.js
View file
Expand Up @@ -635,7 +635,7 @@ module.exports = {
break;
}

components.set(node, {
components.set(component ? component.node : node, {
usedPropTypes: usedPropTypes,
ignorePropsValidation: ignorePropsValidation
});
Expand Down
282 changes: 282 additions & 0 deletions tests/lib/rules/no-unused-prop-types.js
View file
Expand Up @@ -1461,6 +1461,168 @@ ruleTester.run('no-unused-prop-types', rule, {
'};'
].join('\n'),
parserOptions: parserOptions
}, {
// Props used inside of an async class property
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' }',
' classProperty = async () => {',
' await this.props.foo();',
' };',
'}'
].join('\n'),
parser: 'babel-eslint'
}, {
// Multiple props used inside of an async class property
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' bar: PropTypes.func,',
' baz: PropTypes.func,',
' }',
' classProperty = async () => {',
' await this.props.foo();',
' await this.props.bar();',
' await this.props.baz();',
' };',
'}'
].join('\n'),
parser: 'babel-eslint'
}, {
// Destructured props inside of async class property
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' }',
' classProperty = async () => {',
' const { foo } = this.props;',
' await foo();',
' };',
'}'
].join('\n'),
parser: 'babel-eslint'
}, {
// Multiple destructured props inside of async class property
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' bar: PropTypes.func,',
' baz: PropTypes.func,',
' }',
' classProperty = async () => {',
' const { foo, bar, baz } = this.props;',
' await foo();',
' await bar();',
' await baz();',
' };',
'}'
].join('\n'),
parser: 'babel-eslint'
}, {
// Props used inside of an async class method
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' }',
' async method() {',
' await this.props.foo();',
' };',
'}'
].join('\n'),
parser: 'babel-eslint'
}, {
// Multiple props used inside of an async class method
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' bar: PropTypes.func,',
' baz: PropTypes.func,',
' }',
' async method() {',
' await this.props.foo();',
' await this.props.bar();',
' await this.props.baz();',
' };',
'}'
].join('\n'),
parser: 'babel-eslint'
}, {
// Destrucuted props inside of async class method
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' }',
' async method() {',
' const { foo } = this.props;',
' await foo();',
' };',
'}'
].join('\n'),
parser: 'babel-eslint'
}, {
// Multiple destrucuted props inside of async class method
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' bar: PropTypes.func,',
' baz: PropTypes.func,',
' }',
' async method() {',
' const { foo, bar, baz } = this.props;',
' await foo();',
' await bar();',
' await baz();',
' };',
'}'
].join('\n'),
parser: 'babel-eslint'
}, {
// factory functions that return async functions
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' bar: PropTypes.func,',
' baz: PropTypes.func,',
' }',
' factory() {',
' return async () => {',
' await this.props.foo();',
' await this.props.bar();',
' await this.props.baz();',
' };',
' }',
'}'
].join('\n'),
parser: 'babel-eslint'
}, {
// factory functions that return async functions
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' bar: PropTypes.func,',
' baz: PropTypes.func,',
' }',
' factory() {',
' return async function onSubmit() {',
' await this.props.foo();',
' await this.props.bar();',
' await this.props.baz();',
' };',
' }',
'}'
].join('\n'),
parser: 'babel-eslint'
}
],

Expand Down Expand Up @@ -2438,6 +2600,126 @@ ruleTester.run('no-unused-prop-types', rule, {
line: 3,
column: 16
}]
}, {
// Multiple props used inside of an async class property
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' bar: PropTypes.func,',
' baz: PropTypes.func,',
' }',
' classProperty = async () => {',
' await this.props.foo();',
' await this.props.bar();',
' };',
'}'
].join('\n'),
parser: 'babel-eslint',
errors: [{
message: '\'baz\' PropType is defined but prop is never used'
}]
}, {
// Multiple destructured props inside of async class property
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' bar: PropTypes.func,',
' baz: PropTypes.func,',
' }',
' classProperty = async () => {',
' const { bar, baz } = this.props;',
' await bar();',
' await baz();',
' };',
'}'
].join('\n'),
parser: 'babel-eslint',
errors: [{
message: '\'foo\' PropType is defined but prop is never used'
}]
}, {
// Multiple props used inside of an async class method
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' bar: PropTypes.func,',
' baz: PropTypes.func,',
' }',
' async method() {',
' await this.props.foo();',
' await this.props.baz();',
' };',
'}'
].join('\n'),
parser: 'babel-eslint',
errors: [{
message: '\'bar\' PropType is defined but prop is never used'
}]
}, {
// Multiple destrucuted props inside of async class method
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' bar: PropTypes.func,',
' baz: PropTypes.func,',
' }',
' async method() {',
' const { foo, bar } = this.props;',
' await foo();',
' await bar();',
' };',
'}'
].join('\n'),
parser: 'babel-eslint',
errors: [{
message: '\'baz\' PropType is defined but prop is never used'
}]
}, {
// factory functions that return async functions
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' bar: PropTypes.func,',
' baz: PropTypes.func,',
' }',
' factory() {',
' return async () => {',
' await this.props.foo();',
' await this.props.bar();',
' };',
' }',
'}'
].join('\n'),
parser: 'babel-eslint',
errors: [{
message: '\'baz\' PropType is defined but prop is never used'
}]
}, {
// factory functions that return async functions
code: [
'export class Example extends Component {',
' static propTypes = {',
' foo: PropTypes.func,',
' bar: PropTypes.func,',
' baz: PropTypes.func,',
' }',
' factory() {',
' return async function onSubmit() {',
' await this.props.bar();',
' await this.props.baz();',
' };',
' }',
'}'
].join('\n'),
parser: 'babel-eslint',
errors: [{
message: '\'foo\' PropType is defined but prop is never used'
}]
}/* , {
// Enable this when the following issue is fixed
// https://github.com/yannickcr/eslint-plugin-react/issues/296
Expand Down

0 comments on commit 5829bc8

Please sign in to comment.