Updated no-broken-super-chain rule to account for more lifecycle hooks …
#94
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,95 +1,106 @@ | ||
| /** | ||
| * @fileOverview Prevent the absence of `this._super(...arguments)` in calls to various lifecycle hooks | ||
| */ | ||
|
|
||
| const MESSAGES = { | ||
| noSuper: '`this._super(...arguments)` must be called in', | ||
| tooManySupers: 'Only call `this._super(...arguments)` once per lifecycle hook', | ||
| argsNotPassedToSuper: '...arguments need to be passed to this._super() call' | ||
| }; | ||
|
|
||
| const LIFECYCLE_HOOKS = ['init', 'willDestroy', 'willDestroyElement', 'destroy']; | ||
|
|
||
| function isExtend(node) { | ||
| return node && node.callee && node.callee.property && node.callee.property.name === 'extend'; | ||
| } | ||
|
|
||
| function isSuperCall(lineWithinFn) { | ||
|
There was a problem hiding this comment. One more case we need to handle is: Foo.extend({
init() {
return this._super(...argument);
}
});This ^ is valid, the linting rule should not complain about it. There was a problem hiding this comment. Great catch. Updated to: |
||
| if (lineWithinFn.type !== 'MemberExpression') { | ||
| return false; | ||
| } | ||
|
|
||
| let isSuperCall = false; | ||
|
|
||
| if (lineWithinFn.object.type === 'ThisExpression') { | ||
| isSuperCall = lineWithinFn.property.type === 'Identifier' && lineWithinFn.property.name === '_super'; | ||
| } else if (lineWithinFn.object.type === 'MemberExpression') { | ||
| isSuperCall = lineWithinFn.object.property.name === '_super'; | ||
| } | ||
|
|
||
| return isSuperCall; | ||
| } | ||
|
|
||
| function wereArgumentsPassedToSuper(expression) { | ||
| const callee = expression.callee; | ||
|
|
||
| if (!expression || callee.type !== 'MemberExpression') { | ||
| return; | ||
| } | ||
|
|
||
| if (callee.property.name === '_super') { | ||
| const firstArgumentToSuper = expression.arguments[0]; | ||
| return firstArgumentToSuper && firstArgumentToSuper.type === 'SpreadElement' && firstArgumentToSuper.argument.name === 'arguments'; | ||
| } else if (callee.property.name === 'apply') { | ||
| const args = expression.arguments; | ||
| return args.length === 2 && args[0].type === 'ThisExpression' && args[1].name === 'arguments'; | ||
| } | ||
| } | ||
|
|
||
| module.exports = { | ||
| meta: { | ||
| docs: { | ||
| description: 'Prevent the absence of `this._super(...arguments)` in calls to various lifecycle hooks', | ||
| category: 'Best Practices', | ||
| recommended: true | ||
| }, | ||
| messages: MESSAGES | ||
| }, | ||
| create(context) { | ||
| return { | ||
| CallExpression(node) { | ||
| if (isExtend(node)) { | ||
| const extendedObjects = node.arguments.filter(arg => arg.type === 'ObjectExpression'); | ||
| extendedObjects.forEach(extendedObj => { | ||
| let superCount = 0; | ||
| extendedObj.properties.forEach(property => { | ||
|
There was a problem hiding this comment. We need to guard for I believe the following test should be added (which will fail ATM but pass if we filtered non ObjectExpressions): Foo.extend(SomeMixin, {
init() {
this._super(...arguments);
}
});I'd suggest either of the following: extendedObjects = node.arguments.filter(arg => arg.type === 'ObjectExpression');
// or
extendedObjects.forEach(extendedObj => {
if (extendedObj.type !== 'ObjectExpression') { return; }
// ...snip...
});There was a problem hiding this comment. I would also suggest adding a test case for this. |
||
| if (LIFECYCLE_HOOKS.includes(property.key.name)) { | ||
| const propertyFnBody = property.value.body; | ||
|
|
||
| if (propertyFnBody && propertyFnBody.body) { | ||
| let expression; | ||
| propertyFnBody.body.forEach(expressionStatement => { | ||
| expression = expressionStatement.type === 'ReturnStatement' ? expressionStatement.argument : expressionStatement.expression; | ||
| if (expression.type === 'CallExpression') { | ||
| const callee = expression.callee; | ||
| if (isSuperCall(callee)) { | ||
| if (!wereArgumentsPassedToSuper(expression)) { | ||
| context.report({ | ||
| node: expressionStatement, | ||
| message: context.meta.messages.argsNotPassedToSuper | ||
| }); | ||
| } | ||
| superCount++; | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| if (superCount === 0) { | ||
| context.report({ | ||
| node: property, | ||
| message: `${context.meta.messages.noSuper} ${property.key.name}` | ||
| }); | ||
| } else if (superCount > 1) { | ||
| context.report({ | ||
| node: property, | ||
| message: context.meta.messages.tooManySupers | ||
| }); | ||
| } | ||
| } | ||
| } | ||
| }); | ||
| }); | ||
| } | ||
| } | ||
| }; | ||
| } | ||
| }; | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rwjblue to be 100% safe, I think we should add all life cycle hooks here. Otherwise, we have no guarantee that mixins will work as expected.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ya, makes sense. Do we have a canonical list?
I guess we can start with the ones listed in https://guides.emberjs.com/v2.16.0/components/the-component-lifecycle/...