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

feat(eslint-plugin): [no-floating-promises] error on logical expression #6356

Merged
merged 4 commits into from Feb 3, 2023
Merged

feat(eslint-plugin): [no-floating-promises] error on logical expression #6356

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7c3f94e
feat(eslint-plugin) [no-floating-promises] Error on logical expression
islandryu Jan 20, 2023
7abf0af
Merge branch 'main' of https://github.com/typescript-eslint/typescrip…
islandryu Feb 3, 2023
899966b
Update packages/eslint-plugin/src/rules/no-floating-promises.ts
islandryu Feb 3, 2023
ab1bf4c
remove sourceCode Variable
islandryu Feb 3, 2023
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
35 changes: 24 additions & 11 deletions packages/eslint-plugin/src/rules/no-floating-promises.ts
View file
Open in desktop
Expand Up @@ -4,6 +4,7 @@ import * as tsutils from 'tsutils';
import * as ts from 'typescript';

import * as util from '../util';
import { OperatorPrecedence } from '../util';

type Options = [
{
Expand Down Expand Up @@ -88,10 +89,21 @@ export default util.createRule<Options, MessageId>({
suggest: [
{
messageId: 'floatingFixVoid',
fix(fixer): TSESLint.RuleFix {
let code = sourceCode.getText(node);
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved
code = `void ${code}`;
return fixer.replaceText(node, code);
fix(fixer): TSESLint.RuleFix | TSESLint.RuleFix[] {
const tsNode = parserServices.esTreeNodeToTSNodeMap.get(
node.expression,
);
if (isHigherPrecedenceThanUnary(tsNode)) {
return fixer.insertTextBefore(node, 'void ');
} else {
return [
fixer.insertTextBefore(node, 'void ('),
fixer.insertTextAfterRange(
[expression.range[1], expression.range[1]],
')',
),
];
}
},
},
],
Expand All @@ -116,7 +128,7 @@ export default util.createRule<Options, MessageId>({
const tsNode = parserServices.esTreeNodeToTSNodeMap.get(
node.expression,
);
if (isHigherPrecedenceThanAwait(tsNode)) {
if (isHigherPrecedenceThanUnary(tsNode)) {
return fixer.insertTextBefore(node, 'await ');
} else {
return [
Expand All @@ -136,16 +148,12 @@ export default util.createRule<Options, MessageId>({
},
};

function isHigherPrecedenceThanAwait(node: ts.Node): boolean {
function isHigherPrecedenceThanUnary(node: ts.Node): boolean {
const operator = tsutils.isBinaryExpression(node)
? node.operatorToken.kind
: ts.SyntaxKind.Unknown;
const nodePrecedence = util.getOperatorPrecedence(node.kind, operator);
const awaitPrecedence = util.getOperatorPrecedence(
ts.SyntaxKind.AwaitExpression,
ts.SyntaxKind.Unknown,
);
return nodePrecedence > awaitPrecedence;
return nodePrecedence > OperatorPrecedence.Unary;
}

function isAsyncIife(node: TSESTree.ExpressionStatement): boolean {
Expand Down Expand Up @@ -214,6 +222,11 @@ export default util.createRule<Options, MessageId>({
// `new Promise()`), the promise is not handled because it doesn't have the
// necessary then/catch call at the end of the chain.
return true;
} else if (node.type === AST_NODE_TYPES.LogicalExpression) {
return (
isUnhandledPromise(checker, node.left) ||
isUnhandledPromise(checker, node.right)
);
}

// We conservatively return false for all other types of expressions because
Expand Down
310 changes: 310 additions & 0 deletions packages/eslint-plugin/tests/rules/no-floating-promises.test.ts
View file
Open in desktop
Expand Up @@ -405,6 +405,57 @@ void doSomething();
`,
options: [{ ignoreIIFE: true }],
},
{
code: `
async function foo() {
const myPromise = async () => void 0;
const condition = true;
void (condition && myPromise());
}
`,
},
{
code: `
async function foo() {
const myPromise = async () => void 0;
const condition = true;
await (condition && myPromise());
}
`,
options: [{ ignoreVoid: false }],
},
{
code: `
async function foo() {
const myPromise = async () => void 0;
const condition = true;
condition && void myPromise();
}
`,
},
{
code: `
async function foo() {
const myPromise = async () => void 0;
const condition = true;
condition && (await myPromise());
}
`,
options: [{ ignoreVoid: false }],
},
{
code: `
async function foo() {
const myPromise = async () => void 0;
let condition = false;
condition && myPromise();
condition = true;
condition || myPromise();
condition ?? myPromise();
}
`,
options: [{ ignoreVoid: false }],
},
],

invalid: [
Expand Down Expand Up @@ -1117,5 +1168,264 @@ async function test() {
},
],
},
{
code: `
async function foo() {
const myPromise = async () => void 0;
const condition = true;

void condition || myPromise();
}
`,
errors: [
{
line: 6,
messageId: 'floatingVoid',
suggestions: [
{
messageId: 'floatingFixVoid',
output: `
async function foo() {
const myPromise = async () => void 0;
const condition = true;

void (void condition || myPromise());
}
`,
},
],
},
],
},
{
code: `
async function foo() {
const myPromise = async () => void 0;
const condition = true;

(await condition) && myPromise();
}
`,
options: [{ ignoreVoid: false }],
errors: [
{
line: 6,
messageId: 'floating',
suggestions: [
{
messageId: 'floatingFixAwait',
output: `
async function foo() {
const myPromise = async () => void 0;
const condition = true;

await ((await condition) && myPromise());
}
`,
},
],
},
],
},
{
code: `
async function foo() {
const myPromise = async () => void 0;
const condition = true;

condition && myPromise();
}
`,
errors: [
{
line: 6,
messageId: 'floatingVoid',
suggestions: [
{
messageId: 'floatingFixVoid',
output: `
async function foo() {
const myPromise = async () => void 0;
const condition = true;

void (condition && myPromise());
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The entire logical expression is enclosed in parentheses as in return-await.
https://typescript-eslint.io/play/#ts=4.9.3&sourceType=module&code=IYZwngdgxgBAZgV2gFwJYHsIwEbAE4AUAlDAN4wC+AsAFCiSyIoZZzrrFm0wzJ5hcaPHngCmyBHixIAJqLioIomTAA+qnPmIBubpRhRgyKAAsylWhSA&eslintrc=N4KABGBEBOCuA2BTAzpAXGUEKQAIBcBPABxQGNoBLY-AWhXkoDt8B6aRfWaJ2gQwDufSvnRRE0aAHtokcGAC+IBUA&tsconfig=N4KABGBEDGD2C2AHAlgGwKYCcDyiAuysAdgM6QBcYoEEkJemy0eAcgK6qoDCAFutAGsylBm3TgwAXxCSgA

}
`,
},
],
},
],
},
{
code: `
async function foo() {
const myPromise = async () => void 0;
const condition = false;

condition || myPromise();
}
`,
errors: [
{
line: 6,
messageId: 'floatingVoid',
suggestions: [
{
messageId: 'floatingFixVoid',
output: `
async function foo() {
const myPromise = async () => void 0;
const condition = false;

void (condition || myPromise());
}
`,
},
],
},
],
},
{
code: `
async function foo() {
const myPromise = async () => void 0;
const condition = null;

condition ?? myPromise();
}
`,
errors: [
{
line: 6,
messageId: 'floatingVoid',
suggestions: [
{
messageId: 'floatingFixVoid',
output: `
async function foo() {
const myPromise = async () => void 0;
const condition = null;

void (condition ?? myPromise());
}
`,
},
],
},
],
},
{
code: `
async function foo() {
const myPromise = Promise.resolve(true);
let condition = true;
condition && myPromise;
}
`,
options: [{ ignoreVoid: false }],
errors: [
{
line: 5,
messageId: 'floating',
suggestions: [
{
messageId: 'floatingFixAwait',
output: `
async function foo() {
const myPromise = Promise.resolve(true);
let condition = true;
await (condition && myPromise);
}
`,
},
],
},
],
},
{
code: `
async function foo() {
const myPromise = Promise.resolve(true);
let condition = false;
condition || myPromise;
}
`,
options: [{ ignoreVoid: false }],
errors: [
{
line: 5,
messageId: 'floating',
suggestions: [
{
messageId: 'floatingFixAwait',
output: `
async function foo() {
const myPromise = Promise.resolve(true);
let condition = false;
await (condition || myPromise);
}
`,
},
],
},
],
},
{
code: `
async function foo() {
const myPromise = Promise.resolve(true);
let condition = null;
condition ?? myPromise;
}
`,
options: [{ ignoreVoid: false }],
errors: [
{
line: 5,
messageId: 'floating',
suggestions: [
{
messageId: 'floatingFixAwait',
output: `
async function foo() {
const myPromise = Promise.resolve(true);
let condition = null;
await (condition ?? myPromise);
}
`,
},
],
},
],
},
{
code: `
async function foo() {
const myPromise = async () => void 0;
const condition = false;

condition || condition || myPromise();
}
`,
errors: [
{
line: 6,
messageId: 'floatingVoid',
suggestions: [
{
messageId: 'floatingFixVoid',
output: `
async function foo() {
const myPromise = async () => void 0;
const condition = false;

void (condition || condition || myPromise());
}
`,
},
],
},
],
},
],
});