Skip to content

fix(eslint-plugin): [no-floating-promises] finally should be transparent to unhandled promises #7092

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

Merged
merged 4 commits into from
Jul 16, 2023
Merged

fix(eslint-plugin): [no-floating-promises] finally should be transparent to unhandled promises #7092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d4c0d43
finally is transparent to rejection
kirkwaiblinger Jun 8, 2023
81e28f7
Unwrap object
kirkwaiblinger Jul 16, 2023
8f14f34
split up test cases and put ignoreVoid: false on some
kirkwaiblinger Jul 16, 2023
6354b30
remove duplicated line
kirkwaiblinger Jul 16, 2023
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
25 changes: 14 additions & 11 deletions packages/eslint-plugin/src/rules/no-floating-promises.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,8 @@ export default util.createRule<Options, MessageId>({
}

if (node.type === AST_NODE_TYPES.CallExpression) {
// If the outer expression is a call, it must be either a `.then()` or
// `.catch()` that handles the promise.
// If the outer expression is a call, a `.catch()` or `.then()` with
// rejection handler handles the promise.

const catchRejectionHandler = getRejectionHandlerFromCatchCall(node);
if (catchRejectionHandler) {
Expand All @@ -254,10 +254,14 @@ export default util.createRule<Options, MessageId>({
}
}

if (isPromiseFinallyCallWithHandler(node)) {
return { isUnhandled: false };
// `x.finally()` is transparent to resolution of the promise, so check `x`.
// ("object" in this context is the `x` in `x.finally()`)
Copy link
Member

Choose a reason for hiding this comment

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

[Praise] This second line was very helpful for understanding the code :) great comment!

const promiseFinallyObject = getObjectFromFinallyCall(node);
if (promiseFinallyObject) {
return isUnhandledPromise(checker, promiseFinallyObject);
}

// All other cases are unhandled.
return { isUnhandled: true };
} else if (node.type === AST_NODE_TYPES.ConditionalExpression) {
// We must be getting the promise-like value from one of the branches of the
Expand Down Expand Up @@ -381,13 +385,12 @@ function getRejectionHandlerFromThenCall(
}
}

function isPromiseFinallyCallWithHandler(
function getObjectFromFinallyCall(
expression: TSESTree.CallExpression,
): boolean {
return (
expression.callee.type === AST_NODE_TYPES.MemberExpression &&
): TSESTree.Expression | undefined {
return expression.callee.type === AST_NODE_TYPES.MemberExpression &&
expression.callee.property.type === AST_NODE_TYPES.Identifier &&
expression.callee.property.name === 'finally' &&
expression.arguments.length >= 1
);
expression.callee.property.name === 'finally'
? expression.callee.object
: undefined;
}
114 changes: 89 additions & 25 deletions packages/eslint-plugin/tests/rules/no-floating-promises.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ async function test() {
.catch(() => {})
.finally(() => {});
Promise.resolve('value').catch(() => {});
Promise.resolve('value').finally(() => {});
return Promise.resolve('value');
}
`,
Expand All @@ -58,7 +57,6 @@ async function test() {
.catch(() => {})
.finally(() => {});
Promise.reject(new Error('message')).catch(() => {});
Promise.reject(new Error('message')).finally(() => {});
return Promise.reject(new Error('message'));
}
`,
Expand All @@ -77,7 +75,6 @@ async function test() {
.catch(() => {})
.finally(() => {});
(async () => true)().catch(() => {});
(async () => true)().finally(() => {});
return (async () => true)();
}
`,
Expand All @@ -97,7 +94,6 @@ async function test() {
.catch(() => {})
.finally(() => {});
returnsPromise().catch(() => {});
returnsPromise().finally(() => {});
return returnsPromise();
}
`,
Expand All @@ -106,7 +102,6 @@ async function test() {
const x = Promise.resolve();
const y = x.then(() => {});
y.catch(() => {});
y.finally(() => {});
}
`,
`
Expand All @@ -117,7 +112,6 @@ async function test() {
`
async function test() {
Promise.resolve().catch(() => {}), 123;
Promise.resolve().finally(() => {}), 123;
123,
Promise.resolve().then(
() => {},
Expand Down Expand Up @@ -160,7 +154,6 @@ async function test() {
.catch(() => {})
.finally(() => {});
promiseValue.catch(() => {});
promiseValue.finally(() => {});
return promiseValue;
}
`,
Expand Down Expand Up @@ -193,12 +186,7 @@ async function test() {
() => {},
Copy link
Member

Choose a reason for hiding this comment

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

[Non-actionable] Aside: the promiseValue.finally(() => {}); on line 173 (unchanged by this PR) can be removed because that test case doesn't define a promiseValue value. It's an existing typo 😄. Not requesting any action, just noting for reference. This is good good first issue fodder.

);
promiseIntersection.then(() => {}).catch(() => {});
promiseIntersection
.then(() => {})
.catch(() => {})
.finally(() => {});
promiseIntersection.catch(() => {});
promiseIntersection.finally(() => {});
return promiseIntersection;
}
`,
Expand All @@ -218,7 +206,6 @@ async function test() {
.catch(() => {})
.finally(() => {});
canThen.catch(() => {});
canThen.finally(() => {});
return canThen;
}
`,
Expand Down Expand Up @@ -315,7 +302,6 @@ async function test() {
.catch(() => {})
.finally(() => {});
promise.catch(() => {});
promise.finally(() => {});
return promise;
}
`,
Expand All @@ -333,7 +319,6 @@ async function test() {
?.then(() => {})
?.catch(() => {});
returnsPromise()?.catch(() => {});
returnsPromise()?.finally(() => {});
return returnsPromise();
}
`,
Expand Down Expand Up @@ -465,6 +450,31 @@ Promise.reject().catch(definitelyCallable);
`,
options: [{ ignoreVoid: false }],
},
{
code: `
Promise.reject()
.catch(() => {})
.finally(() => {});
`,
},
{
code: `
Promise.reject()
.catch(() => {})
.finally(() => {})
.finally(() => {});
`,
options: [{ ignoreVoid: false }],
},
{
code: `
Promise.reject()
.catch(() => {})
.finally(() => {})
.finally(() => {})
.finally(() => {});
`,
},
],

invalid: [
Expand Down Expand Up @@ -612,7 +622,6 @@ async function test() {
(async () => true)();
(async () => true)().then(() => {});
(async () => true)().catch();
(async () => true)().finally();
}
`,
errors: [
Expand All @@ -628,10 +637,6 @@ async function test() {
line: 5,
messageId: 'floatingVoid',
},
{
line: 6,
messageId: 'floatingVoid',
},
],
},
{
Expand Down Expand Up @@ -940,7 +945,6 @@ async function test() {
promiseIntersection;
promiseIntersection.then(() => {});
promiseIntersection.catch();
promiseIntersection.finally();
}
`,
errors: [
Expand All @@ -956,10 +960,6 @@ async function test() {
line: 7,
messageId: 'floatingVoid',
},
{
line: 8,
messageId: 'floatingVoid',
},
],
},
{
Expand Down Expand Up @@ -1587,5 +1587,69 @@ Promise.reject() || 3;
},
],
},
{
code: `
Promise.reject().finally(() => {});
`,
errors: [{ line: 2, messageId: 'floatingVoid' }],
},
{
code: `
Promise.reject()
.finally(() => {})
.finally(() => {});
`,
options: [{ ignoreVoid: false }],
errors: [{ line: 2, messageId: 'floating' }],
},
{
code: `
Promise.reject()
.finally(() => {})
.finally(() => {})
.finally(() => {});
`,
errors: [{ line: 2, messageId: 'floatingVoid' }],
},
{
code: `
Promise.reject()
.then(() => {})
.finally(() => {});
`,
errors: [{ line: 2, messageId: 'floatingVoid' }],
},
{
code: `
declare const returnsPromise: () => Promise<void> | null;
returnsPromise()?.finally(() => {});
`,
errors: [{ line: 3, messageId: 'floatingVoid' }],
},
{
code: `
const promiseIntersection: Promise<number> & number;
promiseIntersection.finally(() => {});
`,
errors: [{ line: 3, messageId: 'floatingVoid' }],
},
{
code: `
Promise.resolve().finally(() => {}), 123;
`,
errors: [{ line: 2, messageId: 'floatingVoid' }],
},
{
code: `
(async () => true)().finally();
`,
errors: [{ line: 2, messageId: 'floatingVoid' }],
},
{
code: `
Promise.reject(new Error('message')).finally(() => {});
`,
errors: [{ line: 2, messageId: 'floatingVoid' }],
},
],
});