Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve set() detection logic in no-side-effects rule to avoid false positives, catch missed cases, and check imports #914

Merged
merged 1 commit into from Aug 14, 2020
Merged

Improve set() detection logic in no-side-effects rule to avoid false positives, catch missed cases, and check imports #914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
89 changes: 73 additions & 16 deletions lib/rules/no-side-effects.js
View file
Open in desktop
Expand Up @@ -11,36 +11,77 @@ const { getImportIdentifier } = require('../utils/import');
// General rule - Don't introduce side-effects in computed properties
//------------------------------------------------------------------------------

function isUnallowedMethod(name) {
return ['set', 'setProperties'].includes(name);
// Ember.set(this, 'foo', 123)
function isEmberSetThis(node, importedEmberName) {
return (
types.isCallExpression(node) &&
types.isMemberExpression(node.callee) &&
types.isIdentifier(node.callee.object) &&
node.callee.object.name === importedEmberName &&
types.isIdentifier(node.callee.property) &&
['set', 'setProperties'].includes(node.callee.property.name) &&
node.arguments.length > 0 &&
memberExpressionBeginWithThis(node.arguments[0])
);
}

// set(this, 'foo', 123)
function isImportedSetThis(node, importedSetName, importedSetPropertiesName) {
return (
types.isCallExpression(node) &&
types.isIdentifier(node.callee) &&
[importedSetName, importedSetPropertiesName].includes(node.callee.name) &&
node.arguments.length > 0 &&
memberExpressionBeginWithThis(node.arguments[0])
);
}

function isEmberSet(node, emberImportAliasName) {
const callee = node.callee;
// this.set('foo', 123)
// this.prop.set('foo', 123)
function isThisSet(node) {
return (
(types.isIdentifier(callee) && isUnallowedMethod(callee.name)) ||
(types.isMemberExpression(callee) &&
(types.isThisExpression(callee.object) ||
callee.object.name === 'Ember' ||
callee.object.name === emberImportAliasName) &&
types.isIdentifier(callee.property) &&
isUnallowedMethod(callee.property.name))
types.isCallExpression(node) &&
types.isMemberExpression(node.callee) &&
types.isIdentifier(node.callee.property) &&
['set', 'setProperties'].includes(node.callee.property.name) &&
memberExpressionBeginWithThis(node.callee.object)
);
}

function memberExpressionBeginWithThis(node) {
if (types.isThisExpression(node)) {
return true;
} else if (types.isMemberExpression(node)) {
return memberExpressionBeginWithThis(node.object);
}
return false;
}

/**
* Recursively finds calls that could be side effects in a computed property function body.
*
* @param {ASTNode} computedPropertyBody body of computed property to search
* @param {string} emberImportAliasName
* @param {string} importedEmberName
* @param {string} importedSetName
* @param {string} importedSetPropertiesName
* @returns {Array<ASTNode>}
*/
function findSideEffects(computedPropertyBody, emberImportAliasName) {
function findSideEffects(
computedPropertyBody,
importedEmberName,
importedSetName,
importedSetPropertiesName
) {
const results = [];

new Traverser().traverse(computedPropertyBody, {
enter(child) {
if (isEmberSet(child, emberImportAliasName) || propertySetterUtils.isThisSet(child)) {
if (
isEmberSetThis(child, importedEmberName) || // Ember.set(this, 'foo', 123)
isImportedSetThis(child, importedSetName, importedSetPropertiesName) || // set(this, 'foo', 123)
isThisSet(child) || // this.set('foo', 123)
propertySetterUtils.isThisSet(child) // this.foo = 123;
) {
results.push(child);
}
},
Expand Down Expand Up @@ -70,6 +111,8 @@ module.exports = {
create(context) {
let importedEmberName;
let importedComputedName;
let importedSetName;
let importedSetPropertiesName;

const report = function (node) {
context.report(node, ERROR_MESSAGE);
Expand All @@ -83,6 +126,10 @@ module.exports = {
if (node.source.value === '@ember/object') {
importedComputedName =
importedComputedName || getImportIdentifier(node, '@ember/object', 'computed');
importedSetName = importedSetName || getImportIdentifier(node, '@ember/object', 'set');
importedSetPropertiesName =
importedSetPropertiesName ||
getImportIdentifier(node, '@ember/object', 'setProperties');
}
},

Expand All @@ -93,7 +140,12 @@ module.exports = {

const computedPropertyBody = computedPropertyUtils.getComputedPropertyFunctionBody(node);

findSideEffects(computedPropertyBody, importedEmberName).forEach(report);
findSideEffects(
computedPropertyBody,
importedEmberName,
importedSetName,
importedSetPropertiesName
).forEach(report);
},

Identifier(node) {
Expand All @@ -103,7 +155,12 @@ module.exports = {

const computedPropertyBody = computedPropertyUtils.getComputedPropertyFunctionBody(node);

findSideEffects(computedPropertyBody, importedEmberName).forEach(report);
findSideEffects(
computedPropertyBody,
importedEmberName,
importedSetName,
importedSetPropertiesName
).forEach(report);
},
};
},
Expand Down