fix(eslint-plugin): [return-await] clean up in-try-catch detection and make autofixes safe #9031

kirkwaiblinger · 2024-04-30T07:48:45Z

PR Checklist

Overview

These 3 bugs are closely related, and the code is largely interdependent, so I figured it would be easiest to group into 1 PR. We can do sequential PRs instead if need be.

The diff looks like there's a lot going on, but I think it's actually not so bad, if we go step-by-step. (Then again, this is all swimming around in my head so it probably makes more sense to me than to a reader):

docs changes. Not tied to any specific code change, just tried to improve them somewhat.
Refactoring/Logic simplification - when determining whether a node is inside of a try, catch, or finally, we now just find the nearest try-catch-finally statement and work from there, rather than checking each ancestor separately. (bye-bye inTry, inCatch, hasFinallyBlock, isReturnPromiseInFinally, all replaced by findEnclosingTryStatement)
Logic change - extract error-handling logic from in-try-catch into a helper function that now also checks nested try-catch-finally statements, rather than just the closest one found (affectsExplicitErrorHandling), fixing Bug: [return-await] should handle nested try-catch-finally blocks with "in-try-catch" option #8907.
Trivially fix the control flow in the in-try-catch thanks to the above helper, fixing Bug: [return-await] awaited promise allowed in terminal catch block #8663.
Logic change - Use the above utilities outside of the in-try-catch option as well, as the condition for whether to autofix or suggest a fix, fixing Bug: [return-await] unsafe autofixes in error handling code #8661.
Lots of accompanying test changes. With the exception of one valid test change for Bug: [return-await] awaited promise allowed in terminal catch block #8663, all the test changes are just changing autofixes to suggestions (Bug: [return-await] unsafe autofixes in error handling code #8661). The test additions are to handle the nested try-catch-finallys (Bug: [return-await] should handle nested try-catch-finally blocks with "in-try-catch" option #8907)

…ake autofixes safe

typescript-eslint · 2024-04-30T07:48:48Z

Thanks for the PR, @kirkwaiblinger!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

netlify · 2024-04-30T07:49:03Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`c23b3a6`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6659e95db4c9d30008efaa7f
😎 Deploy Preview	https://deploy-preview-9031--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 100 (🟢 up 2 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 98 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

nx-cloud · 2024-04-30T07:50:02Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit c23b3a6. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 31 targets

Sent with 💌 from NxCloud.

kirkwaiblinger · 2024-04-30T07:50:22Z

packages/eslint-plugin/tests/rules/return-await.test.ts

        },
      ],
    },
    {
      code: `
-        async function bar() {}


This just tests 3 totally separable errors, so I broke it up into 3 separate tests.

kirkwaiblinger · 2024-04-30T07:55:16Z

packages/eslint-plugin/src/rules/return-await.ts

          });
-        } else if (!isAwait && isInTryCatch) {
-          if (inCatch(expression) && !hasFinallyBlock(expression)) {
-            return;


The return statements were just wrong. Directly caused #8663 and played into #8907 as well.

With the inCatch/hasFinallyBlock etc logic extracted to the affectsErrorHandling variable, they now correctly are included in the preceeding branch (enforcing removing the await).

kirkwaiblinger · 2024-04-30T08:03:25Z

packages/eslint-plugin/src/rules/return-await.ts

@@ -222,13 +250,29 @@ export default createRule({
        return;
      }

+      const affectsErrorHandling = affectsExplicitErrorHandling(expression);


The thought is that one day (soon) there will be a || affectsExplicitResourceManagement(expression) 🙏 #7889/#9044

JoshuaKGoldberg

This is excellent work, nicely done @kirkwaiblinger. I tried a few times to find something major to complain about but couldn't find anything. 👏

From me, there's just the one nit on a thrown error. Since this is a pretty tricky area I'll slap on the 1 approval label in the hopes someone else will be able to review too.

✨

packages/eslint-plugin/src/rules/return-await.ts

JoshuaKGoldberg · 2024-05-26T10:45:53Z

packages/eslint-plugin/src/rules/return-await.ts

+  | { fix: TSESLint.ReportFixFunction }
+  | { suggest: TSESLint.SuggestionReportDescriptor<MessageId>[] } {
+  return useFix ? { fix: suggestion.fix } : { suggest: [suggestion] };
+}


[Praise] I like this :)

JoshuaKGoldberg

wrong button

kirkwaiblinger · 2024-05-26T14:40:20Z

@JoshuaKGoldberg

wrong button

JoshuaKGoldberg

[no-return-await] Clean up the logic for in-try-catch detection and m…

3d6ed66

…ake autofixes safe

kirkwaiblinger commented Apr 30, 2024

View reviewed changes

kirkwaiblinger changed the title ~~fix(eslint-plugin): [no-return-await] Clean up the logic for in-try-catch detection and make autofixes safe~~ fix(eslint-plugin): [no-return-await] clean up in-try-catch detection and make autofixes safe Apr 30, 2024

kirkwaiblinger added 2 commits April 30, 2024 02:06

spell

189a6b4

snapshot

2abfe6a

kirkwaiblinger marked this pull request as ready for review April 30, 2024 15:28

kirkwaiblinger added 2 commits May 2, 2024 09:07

Merge branch 'main' into return-await-bugs

dd1adda

nicer diff

1777ac9

kirkwaiblinger added the bug Something isn't working label May 3, 2024

kirkwaiblinger changed the title ~~fix(eslint-plugin): [no-return-await] clean up in-try-catch detection and make autofixes safe~~ fix(eslint-plugin): [return-await] clean up in-try-catch detection and make autofixes safe May 4, 2024

kirkwaiblinger mentioned this pull request May 4, 2024

fix(eslint-plugin): [return-await] support explicit resource management #9044

Merged

3 tasks

JoshuaKGoldberg requested changes May 26, 2024

View reviewed changes

JoshuaKGoldberg previously approved these changes May 26, 2024

View reviewed changes

adjust unreachable case

3bda3a5

kirkwaiblinger dismissed JoshuaKGoldberg’s stale review via 3bda3a5 May 26, 2024 23:45

kirkwaiblinger requested a review from JoshuaKGoldberg May 26, 2024 23:47

JoshuaKGoldberg approved these changes May 27, 2024

View reviewed changes

kirkwaiblinger mentioned this pull request May 29, 2024

Configs: include return-await in strict-type-checked preset #8667

Closed

2 tasks

bradzacher approved these changes May 31, 2024

View reviewed changes

Merge branch 'main' into return-await-bugs

c23b3a6

kirkwaiblinger merged commit 2619c3b into typescript-eslint:main May 31, 2024
59 of 60 checks passed

kirkwaiblinger deleted the return-await-bugs branch May 31, 2024 15:37

fpapado mentioned this pull request Jun 3, 2024

feat(parser, typescript-estree): export withoutProjectParserOptions utility #9233

Merged

3 tasks

github-actions bot locked as resolved and limited conversation to collaborators Jun 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(eslint-plugin): [return-await] clean up in-try-catch detection and make autofixes safe #9031

fix(eslint-plugin): [return-await] clean up in-try-catch detection and make autofixes safe #9031

kirkwaiblinger commented Apr 30, 2024 •

edited

Loading

typescript-eslint bot commented Apr 30, 2024

netlify bot commented Apr 30, 2024 •

edited

Loading

nx-cloud bot commented Apr 30, 2024 •

edited

Loading

kirkwaiblinger Apr 30, 2024

kirkwaiblinger Apr 30, 2024

kirkwaiblinger Apr 30, 2024 •

edited

Loading

JoshuaKGoldberg left a comment

JoshuaKGoldberg May 26, 2024

JoshuaKGoldberg left a comment

kirkwaiblinger commented May 26, 2024

JoshuaKGoldberg left a comment

fix(eslint-plugin): [return-await] clean up in-try-catch detection and make autofixes safe #9031

fix(eslint-plugin): [return-await] clean up in-try-catch detection and make autofixes safe #9031

Conversation

kirkwaiblinger commented Apr 30, 2024 • edited Loading

PR Checklist

Overview

typescript-eslint bot commented Apr 30, 2024

netlify bot commented Apr 30, 2024 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

nx-cloud bot commented Apr 30, 2024 • edited Loading

☁️ Nx Cloud Report

kirkwaiblinger Apr 30, 2024

Choose a reason for hiding this comment

kirkwaiblinger Apr 30, 2024

Choose a reason for hiding this comment

kirkwaiblinger Apr 30, 2024 • edited Loading

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg May 26, 2024

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

kirkwaiblinger commented May 26, 2024

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

kirkwaiblinger commented Apr 30, 2024 •

edited

Loading

netlify bot commented Apr 30, 2024 •

edited

Loading

nx-cloud bot commented Apr 30, 2024 •

edited

Loading

kirkwaiblinger Apr 30, 2024 •

edited

Loading