fix: declare .finally(...) usages as handled in async rules (#1074)

Author: bonkevin

docs/rules/await-async-queries.md

@@ -23,7 +23,7 @@ problems in the tests. The promise will be considered as handled when:
 
 - using the `await` operator
 - wrapped within `Promise.all` or `Promise.allSettled` methods
-- chaining the `then` or `catch` method
+- chaining the `then`, `catch`, `finally` method
 - chaining `resolves` or `rejects` from jest
 - chaining `toResolve()` or `toReject()` from [jest-extended](https://github.com/jest-community/jest-extended#promise)
 - chaining jasmine [async matchers](https://jasmine.github.io/api/edge/async-matchers.html)

docs/rules/await-async-utils.md

@@ -21,7 +21,7 @@ problems in the tests. The promise will be considered as handled when:
 
 - using the `await` operator
 - wrapped within `Promise.all` or `Promise.allSettled` methods
-- chaining the `then` or `catch` method
+- chaining the `then`, `catch`, `finally` method
 - chaining `resolves` or `rejects` from jest
 - chaining `toResolve()` or `toReject()` from [jest-extended](https://github.com/jest-community/jest-extended#promise)
 - chaining jasmine [async matchers](https://jasmine.github.io/api/edge/async-matchers.html)

lib/node-utils/index.ts

@@ -152,19 +152,19 @@ export function hasPromiseHandlerProperty(node: TSESTree.Node): boolean {
 	return (
 		isMemberExpression(node) &&
 		ASTUtils.isIdentifier(node.property) &&
-		['then', 'catch'].includes(node.property.name)
+		['then', 'catch', 'finally'].includes(node.property.name)
 	);
 }
 
 export function hasChainedPromiseHandler(node: TSESTree.Node): boolean {
 	const parent = node.parent;
 
-	// wait(...).then(...) or wait(...).catch(...)
+	// wait(...).then(...) or wait(...).catch(...) or wait(...).finally(...)
 	if (isCallExpression(parent) && parent.parent) {
 		return hasPromiseHandlerProperty(parent.parent);
 	}
 
-	// promise.then(...) or promise.catch(...)
+	// promise.then(...) or promise.catch(...) or promise(...).finally(...)
 	return !!parent && hasPromiseHandlerProperty(parent);
 }
 
@@ -219,7 +219,7 @@ export function isPromisesArrayResolved(node: TSESTree.Node): boolean {
  * - it belongs to the `await` expression
  * - it belongs to the `Promise.all` method
  * - it belongs to the `Promise.allSettled` method
- * - it's chained with the `then` or `catch` method
+ * - it's chained with the `then`, `catch`, `finally` method
  * - it's returned from a function
  * - has `resolves` or `rejects` jest methods
  * - has `toResolve` or `toReject` jest-extended matchers

tests/lib/rules/await-async-events.test.ts

@@ -108,6 +108,16 @@ ruleTester.run(RULE_NAME, rule, {
         `,
 				options: [{ eventModule: 'fireEvent' }] as const,
 			})),
+			...FIRE_EVENT_ASYNC_FUNCTIONS.map((eventMethod) => ({
+				code: `
+				import { fireEvent } from '${testingFramework}'
+				test('chain finally method to promise from event method is valid', async (done) => {
+					fireEvent.${eventMethod}(getByLabelText('username'))
+					.finally(() => { done() })
+				})
+				`,
+				options: [{ eventModule: 'fireEvent' }] as const,
+			})),
 			{
 				code: `
         import { fireEvent } from '${testingFramework}'
@@ -349,6 +359,16 @@ ruleTester.run(RULE_NAME, rule, {
 			...USER_EVENT_ASYNC_FUNCTIONS.map((eventMethod) => ({
 				code: `
         import userEvent from '${testingFramework}'
+        test('chain finally method to promise from event method is valid', async (done) => {
+          userEvent.${eventMethod}(getByLabelText('username'))
+            .finally(() => { done() })
+        })
+        `,
+				options: [{ eventModule: 'userEvent' }] as const,
+			})),
+			...USER_EVENT_ASYNC_FUNCTIONS.map((eventMethod) => ({
+				code: `
+        import userEvent from '${testingFramework}'
         test('chain then method to several promises from event methods is valid', async (done) => {
           userEvent.${eventMethod}(getByLabelText('username')).then(() => {
             userEvent.${eventMethod}(getByLabelText('username')).then(() => { done() })

tests/lib/rules/await-async-queries.test.ts

@@ -177,6 +177,14 @@ ruleTester.run(RULE_NAME, rule, {
       `
 		),
 
+		// async queries are valid with finally
+		...createTestCase(
+			(query) => `
+				const promise = ${query}('foo')
+        promise.finally((done) => done())
+      `
+		),
+
 		// async queries are valid when wrapped within Promise.all + await expression
 		...createTestCase(
 			(query) => `

tests/lib/rules/await-async-utils.test.ts

@@ -71,6 +71,15 @@ ruleTester.run(RULE_NAME, rule, {
 		...ASYNC_UTILS.map<RuleValidTestCase>((asyncUtil) => ({
 			code: `
         import { ${asyncUtil} } from '${testingFramework}';
+        test('${asyncUtil} util directly chained with finally is valid', () => {
+          doSomethingElse();
+          ${asyncUtil}(() => getByLabelText('email')).finally(() => { console.log('done') });
+        });
+      `,
+		})),
+		...ASYNC_UTILS.map((asyncUtil) => ({
+			code: `
+        import { ${asyncUtil} } from '${testingFramework}';
         test('${asyncUtil} util expect chained with .resolves is valid', () => {
           doSomethingElse();
           expect(${asyncUtil}(() => getByLabelText('email'))).resolves.toBe("foo");