Skip to content
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
24 changes: 24 additions & 0 deletions src/rules/prefer-timer-args.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,15 @@ ruleTester.run('prefer-timer-args', preferTimerArgs, {
'setTimeout(() => fn(`${getData()}`), 100)',
'setTimeout(() => fn(`${i++}`), 100)',

// Member expressions may change between scheduling and firing
'setTimeout(() => fn(obj.prop), 100)',
'setTimeout(() => fn(obj[key]), 100)',
'setTimeout(() => fn(a, obj.prop), 100)',
'setTimeout(() => fn(obj.prop + 1), 100)',
'setTimeout(() => fn([obj.prop]), 100)',
'setTimeout(() => fn({key: obj.prop}), 100)',
'setTimeout(() => fn(`${obj.prop}`), 100)',

// window.setTimeout examples
'window.setTimeout(doSomething, 100)',
'window.setTimeout(() => { doSomething(a); }, 100)',
Expand Down Expand Up @@ -259,6 +268,21 @@ setTimeout(fn2, 200, b, c);`,
]
},

// bind() with member expression arguments
{
code: 'setTimeout(fn.bind(null, obj.prop, arr[0]), 100)',
output: 'setTimeout(fn, 100, obj.prop, arr[0])',
errors: [
{
messageId: 'preferArgs',
line: 1,
column: 1,
endLine: 1,
endColumn: 49
}
]
},

// bind() with null in complex expression
{
code: 'const timer = setTimeout(handler.bind(null, event, data), 0)',
Expand Down
38 changes: 23 additions & 15 deletions src/rules/prefer-timer-args.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,10 @@ function isTimerCall(node: CallExpression): boolean {
return false;
}

function isSafeArgument(arg: Expression | SpreadElement): boolean {
function isSafeArgument(
arg: Expression | SpreadElement,
allowMemberExpressions: boolean
): boolean {
if (arg.type === 'SpreadElement') {
return arg.argument.type === 'Identifier';
}
Expand All @@ -40,30 +43,35 @@ function isSafeArgument(arg: Expression | SpreadElement): boolean {
return true;

case 'TemplateLiteral':
return arg.expressions.every(isSafeArgument);
return arg.expressions.every((expr) =>
isSafeArgument(expr, allowMemberExpressions)
);

case 'MemberExpression':
if (
!allowMemberExpressions ||
arg.object.type === 'Super' ||
arg.property.type === 'PrivateIdentifier'
) {
return false;
}
if (!isSafeArgument(arg.object)) {
if (!isSafeArgument(arg.object, allowMemberExpressions)) {
return false;
}
if (arg.computed) {
return isSafeArgument(arg.property);
return isSafeArgument(arg.property, allowMemberExpressions);
}
return true;

case 'ArrayExpression':
return arg.elements.every((el) => el === null || isSafeArgument(el));
return arg.elements.every(
(el) => el === null || isSafeArgument(el, allowMemberExpressions)
);

case 'ObjectExpression':
return arg.properties.every((prop) => {
if (prop.type === 'SpreadElement') {
return isSafeArgument(prop.argument);
return isSafeArgument(prop.argument, allowMemberExpressions);
}
const valueType = prop.value.type;
if (
Expand All @@ -74,28 +82,28 @@ function isSafeArgument(arg: Expression | SpreadElement): boolean {
) {
return false;
}
return isSafeArgument(prop.value);
return isSafeArgument(prop.value, allowMemberExpressions);
});

case 'UnaryExpression':
if (arg.operator === 'delete') {
return false;
}
return isSafeArgument(arg.argument);
return isSafeArgument(arg.argument, allowMemberExpressions);

case 'BinaryExpression':
case 'LogicalExpression':
return (
arg.left.type !== 'PrivateIdentifier' &&
isSafeArgument(arg.left) &&
isSafeArgument(arg.right)
isSafeArgument(arg.left, allowMemberExpressions) &&
isSafeArgument(arg.right, allowMemberExpressions)
);

case 'ConditionalExpression':
return (
isSafeArgument(arg.test) &&
isSafeArgument(arg.consequent) &&
isSafeArgument(arg.alternate)
isSafeArgument(arg.test, allowMemberExpressions) &&
isSafeArgument(arg.consequent, allowMemberExpressions) &&
isSafeArgument(arg.alternate, allowMemberExpressions)
);

// CallExpression, NewExpression, etc.
Expand Down Expand Up @@ -166,7 +174,7 @@ export const preferTimerArgs: Rule.RuleModule = {
return;
}

if (!callArgs.every(isSafeArgument)) {
if (!callArgs.every((arg) => isSafeArgument(arg, false))) {
return;
}

Expand Down Expand Up @@ -205,7 +213,7 @@ export const preferTimerArgs: Rule.RuleModule = {
const bindArgs = bindCall.arguments.slice(1);

// Check if any bind argument contains a call expression or other unsafe construct
if (!bindArgs.every(isSafeArgument)) {
if (!bindArgs.every((arg) => isSafeArgument(arg, true))) {
return;
}

Expand Down
Loading