userEvent.hover returns a promise - no-await-sync-events vs no-floating-promises reasoning

[mkosir]

Have you read the Troubleshooting section?

Yes

Plugin version

v6.0.0

ESLint version

v8.47.0

Node.js version

18.17.1

package manager and version

npm 9.6.7

Operating system

macOS Ventura, version 13.5.1

Bug description

For userEvent.hover no-await-sync-events rule reports that it's a sync event, from what I assume the typings could be wrong?

Not sure how much benefits does no-await-sync-events rule brings, since we already have no-floating-promises from typescript-eslint package.

When await keyword is being removed, no-floating-promises rule of course fails since type definition is indicating that hover function is returning a promise.

Steps to reproduce

• clone the repo
• run npm i
• run npm run lint -> no error
• In package.json upgrade eslint-plugin-testing-library to v6.0.0
• run npm i
• run npm run lint -> error

Error output/screenshots

If we remove await

ESLint configuration

"rules": {
    "@typescript-eslint/no-floating-promises": "error"
  }

Rule(s) affected

https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-await-sync-events.md

Anything else?

No response

Do you want to submit a pull request to fix this bug?

No

[Belco90]

Hi @mkosir. This is a bug in our plugin, related to #801. Basically, the mentioned error is coming from user-event prior to v14. We are fixing this in #803 so user-event methods reported are based on v14, then all of them will be treated as async when that fix gets released.

Regarding using no-floating-promises TS ESLint rule. Yeah, that rule will catch all the unhandled async usages for you, but only if you use TypeScript. The rules from our plugin about async stuff will also help developers working in plain JS to handle the floating promises in their Testing Library tests. We should probably mention in the docs of all the async rules that they can be disabled if no-floating-promises is already enabled.

[mkosir]

Hi @Belco90 ,thanks for such a fast response 🚀

Regarding using no-floating-promises TS ESLint rule. Yeah, that rule will catch all the unhandled async usages for you, but only if you use TypeScript. The rules from our plugin about async stuff will also help developers working in plain JS to handle the floating promises in their Testing Library tests. We should probably mention in the docs of all the async rules that they can be disabled if no-floating-promises is already enabled.

I see, haven't thought about plain JS 👍

Big fan of this package, keep up the awesome work!