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.

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

fix(eslint-plugin): [no-misused-promises] factor thenable returning function overload signatures #4620

Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
84 changes: 66 additions & 18 deletions packages/eslint-plugin/src/rules/no-misused-promises.ts
Expand Up @@ -394,9 +394,13 @@ function voidFunctionParams(
checker: ts.TypeChecker,
node: ts.CallExpression | ts.NewExpression,
): Set<number> {
const thenableReturnIndices = new Set<number>();
const voidReturnIndices = new Set<number>();
const type = checker.getTypeAtLocation(node.expression);

// We can't use checker.getResolvedSignature because it prefers an early '() => void' over a later '() => Promise<void>'
// See https://github.com/microsoft/TypeScript/issues/48077

for (const subType of tsutils.unionTypeParts(type)) {
// Standard function calls and `new` have two different types of signatures
const signatures = ts.isCallExpression(node)
Expand All @@ -408,50 +412,94 @@ function voidFunctionParams(
parameter,
node.expression,
);
if (isVoidReturningFunctionType(checker, node.expression, type)) {
if (isThenableReturningFunctionType(checker, node.expression, type)) {
thenableReturnIndices.add(index);
} else if (
!thenableReturnIndices.has(index) &&
isVoidReturningFunctionType(checker, node.expression, type)
) {
voidReturnIndices.add(index);
}
}
}
}

for (const index of thenableReturnIndices) {
voidReturnIndices.delete(index);
}

return voidReturnIndices;
}

// Returns true if given type is a void-returning function.
/**
* @returns Whether any call signature of the type has a thenable return type.
*/
function anySignatureIsThenableType(
checker: ts.TypeChecker,
node: ts.Node,
type: ts.Type,
): boolean {
for (const signature of type.getCallSignatures()) {
const returnType = signature.getReturnType();
if (tsutils.isThenableType(checker, node, returnType)) {
return true;
}
}

return false;
}

/**
* @returns Whether type is a thenable-returning function.
*/
function isThenableReturningFunctionType(
checker: ts.TypeChecker,
node: ts.Node,
type: ts.Type,
): boolean {
for (const subType of tsutils.unionTypeParts(type)) {
if (anySignatureIsThenableType(checker, node, subType)) {
return true;
}
}

return false;
}

/**
* @returns Whether type is a void-returning function.
*/
function isVoidReturningFunctionType(
checker: ts.TypeChecker,
node: ts.Node,
type: ts.Type,
): boolean {
let hasVoidReturningFunction = false;
let hasThenableReturningFunction = false;
for (const subType of tsutils.unionTypeParts(type)) {
for (const signature of subType.getCallSignatures()) {
const returnType = signature.getReturnType();

// If a certain positional argument accepts both thenable and void returns,
// a promise-returning function is valid
if (tsutils.isThenableType(checker, node, returnType)) {
return false;
}

if (tsutils.isTypeFlagSet(returnType, ts.TypeFlags.Void)) {
hasVoidReturningFunction = true;
} else if (tsutils.isThenableType(checker, node, returnType)) {
hasThenableReturningFunction = true;
return true;
}
}
}
// If a certain positional argument accepts both thenable and void returns,
// a promise-returning function is valid
return hasVoidReturningFunction && !hasThenableReturningFunction;
return false;
}

// Returns true if the expression is a function that returns a thenable
/**
* @returns Whether expression is a function that returns a thenable.
*/
function returnsThenable(checker: ts.TypeChecker, node: ts.Node): boolean {
const type = checker.getApparentType(checker.getTypeAtLocation(node));

for (const subType of tsutils.unionTypeParts(type)) {
for (const signature of subType.getCallSignatures()) {
const returnType = signature.getReturnType();
if (tsutils.isThenableType(checker, node, returnType)) {
return true;
}
}
if (anySignatureIsThenableType(checker, node, type)) {
return true;
}

return false;
Expand Down
42 changes: 42 additions & 0 deletions packages/eslint-plugin/tests/rules/no-misused-promises.test.ts
Expand Up @@ -252,6 +252,30 @@ const Component: any = () => null;
`,
filename: 'react.tsx',
},
{
code: `
interface ItLike {
(name: string, callback: () => Promise<void>): void;
(name: string, callback: () => void): void;
}

declare const it: ItLike;

it('', async () => {});
`,
},
{
code: `
interface ItLike {
(name: string, callback: () => void): void;
(name: string, callback: () => Promise<void>): void;
}

declare const it: ItLike;

it('', async () => {});
`,
},
],

invalid: [
Expand Down Expand Up @@ -687,5 +711,23 @@ const Component = (obj: O) => null;
},
],
},
{
code: `
interface ItLike {
(name: string, callback: () => number): void;
(name: string, callback: () => void): void;
}

declare const it: ItLike;

it('', async () => {});
`,
errors: [
{
line: 9,
messageId: 'voidReturnArgument',
},
],
},
],
});