fix(eslint-plugin): [return-await] handle nested functions correctly (#…

…3601)
typescript-eslint · Jul 31, 2021 · 4a196b5 · 4a196b5
1 parent f5a6806
commit 4a196b5
Show file tree

Hide file tree

Showing 2 changed files with 72 additions and 7 deletions.
diff --git a/packages/eslint-plugin/src/rules/return-await.ts b/packages/eslint-plugin/src/rules/return-await.ts
@@ -7,15 +7,16 @@ import * as tsutils from 'tsutils';
 import * as ts from 'typescript';
 import * as util from '../util';
 
-interface ScopeInfo {
-  hasAsync: boolean;
-}
-
 type FunctionNode =
   | TSESTree.FunctionDeclaration
   | TSESTree.FunctionExpression
   | TSESTree.ArrowFunctionExpression;
 
+interface ScopeInfo {
+  hasAsync: boolean;
+  owningFunc: FunctionNode;
+}
+
 export default util.createRule({
   name: 'return-await',
   meta: {
@@ -49,12 +50,17 @@ export default util.createRule({
     const checker = parserServices.program.getTypeChecker();
     const sourceCode = context.getSourceCode();
 
-    let scopeInfo: ScopeInfo | null = null;
+    const scopeInfoStack: ScopeInfo[] = [];
 
     function enterFunction(node: FunctionNode): void {
-      scopeInfo = {
+      scopeInfoStack.push({
         hasAsync: node.async,
-      };
+        owningFunc: node,
+      });
+    }
+
+    function exitFunction(): void {
+      scopeInfoStack.pop();
     }
 
     function inTry(node: ts.Node): boolean {
@@ -263,6 +269,11 @@ export default util.createRule({
       FunctionExpression: enterFunction,
       ArrowFunctionExpression: enterFunction,
 
+      'FunctionDeclaration:exit': exitFunction,
+      'FunctionExpression:exit': exitFunction,
+      'ArrowFunctionExpression:exit': exitFunction,
+
+      // executes after less specific handler, so exitFunction is called
       'ArrowFunctionExpression[async = true]:exit'(
         node: TSESTree.ArrowFunctionExpression,
       ): void {
@@ -274,6 +285,7 @@ export default util.createRule({
         }
       },
       ReturnStatement(node): void {
+        const scopeInfo = scopeInfoStack[scopeInfoStack.length - 1];
         if (!scopeInfo || !scopeInfo.hasAsync || !node.argument) {
           return;
         }

diff --git a/packages/eslint-plugin/tests/rules/return-await.test.ts b/packages/eslint-plugin/tests/rules/return-await.test.ts
@@ -232,6 +232,21 @@ ruleTester.run('return-await', rule, {
         }
       `,
     },
+    {
+      code: `
+        async function test() {
+          const res = await Promise.resolve('{}');
+          try {
+            async function nested() {
+              return Promise.resolve('ok');
+            }
+            return await nested();
+          } catch (error) {
+            return await Promise.resolve('error');
+          }
+        }
+      `,
+    },
   ],
   invalid: [
     {
@@ -827,5 +842,43 @@ const buzz = async () => ((await foo()) ? 1 : await bar());
         },
       ],
     },
+    {
+      code: `
+        async function test() {
+          try {
+            const callback1 = function () {};
+            const callback2 = async function () {};
+            function callback3() {}
+            async function callback4() {}
+            const callback5 = () => {};
+            const callback6 = async () => {};
+            return Promise.resolve('try');
+          } finally {
+            return Promise.resolve('finally');
+          }
+        }
+      `,
+      output: `
+        async function test() {
+          try {
+            const callback1 = function () {};
+            const callback2 = async function () {};
+            function callback3() {}
+            async function callback4() {}
+            const callback5 = () => {};
+            const callback6 = async () => {};
+            return await Promise.resolve('try');
+          } finally {
+            return Promise.resolve('finally');
+          }
+        }
+      `,
+      errors: [
+        {
+          line: 10,
+          messageId: 'requiredPromiseAwait',
+        },
+      ],
+    },
   ],
 });