Skip to content

Report $set and $nextTick in computed properties #1750

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.

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

Merged
merged 3 commits into from
Jan 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions lib/rules/no-async-in-computed-properties.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,24 @@ function isPromise(node) {
return false
}

/**
* @param {CallExpression} node
* @param {RuleContext} context
*/
function isNextTick(node, context) {
const callee = utils.skipChainExpression(node.callee)
if (callee.type === 'MemberExpression') {
const name = utils.getStaticPropertyName(callee)
return (
(utils.isThis(callee.object, context) && name === '$nextTick') ||
(callee.object.type === 'Identifier' &&
callee.object.name === 'Vue' &&
name === 'nextTick')
)
}
return false
}

// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
Expand Down Expand Up @@ -90,6 +108,7 @@ module.exports = {

const expressionTypes = {
promise: 'asynchronous action',
nextTick: 'asynchronous action',
await: 'await operator',
async: 'async function declaration',
new: 'Promise object',
Expand Down Expand Up @@ -211,6 +230,13 @@ module.exports = {
'timed',
info ? computedPropertiesMap.get(info.node) : null
)
} else if (isNextTick(node, context)) {
verify(
node,
scopeStack.body,
'nextTick',
info ? computedPropertiesMap.get(info.node) : null
)
}
},

Expand Down
17 changes: 13 additions & 4 deletions lib/rules/no-side-effects-in-computed-properties.js
Original file line number Diff line number Diff line change
Expand Up @@ -83,15 +83,24 @@ module.exports = {
)
})
if (computedProperty) {
if (!utils.isThis(node, context)) {
return
}
const mem = node.parent
if (mem.object !== node) {
return
}

const invalid = utils.findMutating(mem)
const isThis = utils.isThis(node, context)
const isVue = node.type === 'Identifier' && node.name === 'Vue'

const isVueSet =
mem.parent.type === 'CallExpression' &&
mem.property.type === 'Identifier' &&
((isThis && mem.property.name === '$set') ||
(isVue && mem.property.name === 'set'))

const invalid = isVueSet
? { node: mem.property }
: isThis && utils.findMutating(mem)

if (invalid) {
context.report({
node: invalid.node,
Expand Down
63 changes: 63 additions & 0 deletions tests/lib/rules/no-async-in-computed-properties.js
Original file line number Diff line number Diff line change
Expand Up @@ -627,6 +627,69 @@ ruleTester.run('no-async-in-computed-properties', rule, {
}
]
},
{
filename: 'test.vue',
code: `
new Vue({
computed: {
foo () {
this.$nextTick(() => {})
Vue.nextTick(() => {})
return 'foo'
}
}
})
`,
parserOptions,
errors: [
{
message: 'Unexpected asynchronous action in "foo" computed property.',
line: 5
},
{
message: 'Unexpected asynchronous action in "foo" computed property.',
line: 6
}
]
},
{
filename: 'test.vue',
code: `
new Vue({
computed: {
async foo () {
await this.$nextTick()
await Vue.nextTick()
return 'foo'
}
}
})
`,
parserOptions,
errors: [
{
message:
'Unexpected async function declaration in "foo" computed property.',
line: 4
},
{
message: 'Unexpected await operator in "foo" computed property.',
line: 5
},
{
message: 'Unexpected asynchronous action in "foo" computed property.',
line: 5
},
{
message: 'Unexpected await operator in "foo" computed property.',
line: 6
},
{
message: 'Unexpected asynchronous action in "foo" computed property.',
line: 6
}
]
},
{
filename: 'test.vue',
code: `
Expand Down
22 changes: 22 additions & 0 deletions tests/lib/rules/no-side-effects-in-computed-properties.js
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,28 @@ ruleTester.run('no-side-effects-in-computed-properties', rule, {
'Unexpected side effect in "test3" computed property.'
]
},
{
// https://github.com/vuejs/eslint-plugin-vue/issues/1744
code: `app.component('test', {
computed: {
fooBar() {
this.$set(this, 'foo', 'lorem');
Vue.set(this, 'bar', 'ipsum');
return this.foo + ' ' + this.bar
},
}
})`,
errors: [
{
line: 4,
message: 'Unexpected side effect in "fooBar" computed property.'
},
{
line: 5,
message: 'Unexpected side effect in "fooBar" computed property.'
}
]
},
{
filename: 'test.vue',
code: `
Expand Down