`no-await-sync-query` reports error on my `getBy*` function

[razbensimon]

Have you read the Troubleshooting section?

Yes

Plugin version

v5.6.0

ESLint version

v7.32.0

Node.js version

v16.10.0

package manager and version

pnpm v6.16.0

Operating system

macOS Monterey, version 12.3.1

Bug description

no-await-sync-query yells on unrelated testing-library code.

Steps to reproduce

1. enable the rule
2. create getBySomething function
3. call the new getBySomething function

Error output/screenshots

1. 

135:41  error  `getById` query is sync so it does not need to be awaited  testing-library/no-await-sync-query

3. 

4. also tried to create a new method
   

ESLint configuration

{
	"plugins": [
		"jest",
		 // ...
		"testing-library",
		"jest-dom"
	],
	"extends": [
		// ...
		"plugin:testing-library/react",
		"plugin:jest-dom/recommended"
	],
	"rules": {
		// ...
		"testing-library/no-await-sync-events": "error",
		"testing-library/no-global-regexp-flag-in-query": "error",
		"testing-library/no-manual-cleanup": "error",
		"testing-library/prefer-explicit-assert": "error",
		"testing-library/prefer-user-event": "error",
		"testing-library/no-render-in-setup": "off",
		"testing-library/render-result-naming-convention": "off"
	}
}

Rule(s) affected

no-await-sync-query

Anything else?

No response

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

No

[Belco90]

Hi @razbensimon!

This false positive is related to the Aggressive Reporting feature. Have you checked the Troubleshooting section to find more about restricting this behavior?

[razbensimon]

Oh, I see now, missed that. Looks like I can bypass this issue with the overrides and use the plugin for specs only.
Thanks!

[gardnerjr]

Strangely, i have the exact same problem, on a method with the exact same name. but it is reporting this in test code, and i don't really want to turn it OFF, i just want it to work...

the workaround i found is to wrap it in expect.resolves:

// before, generates error
const result = provider.getById("templateId", true);
expect(result).toBe("whatever you expected");

turns into this:

// after, no error
await expect(provider.getById("templateId", true)).resolves.toBe("whatever you expected");

which doesn't produce a build error and is effectively the same.