await-async-utils false positive on chained cy.wait().its().then()

Plugin version

v5.1.0

ESLint version

v8.12.0

Node.js version

16.14.0

npm/yarn version

npm 8.3.1

Operating system

macOS Big Sur 11.6

Bug description

cy.wait getting picked up by testing-library/await-async-utils on a line like…

    cy.wait(`@${label}`, { timeout: 1000 * 60 * 3 })
      .its('status')
      .then(status => expect(status).to.be.oneOf([200, 304]));

The rule documentation says chaining is ok. I assume it’s the its that’s complicating things.

Thanks!

Steps to reproduce

Got to get back to work. I hope this helps. Thanks!

Error output/screenshots

No response

ESLint configuration

Got to get back to work. I hope this helps. Thanks!

Rule(s) affected

testing-library/await-async-utils

Anything else?

Thank you!

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

No

[Belco90]

@cburgmer that was our original approach, but that would discard reporting related to Testing Library coming from non “testing-library” modules. It’s pretty common to re-export Testing Library utils from a custom module (e.g. “test-utils”). The plugin wouldn’t be aware of it. That’s why we have this Aggressive Reporting in place, leaving it up to you to narrow the scope with ESLint settings or the plugin settings.

You can read more about it here: https://github.com/testing-library/eslint-plugin-testing-library/issues/198

[cburgmer]

Could we re-open and find a better solution? After all this plugin seems to be very fuzzy at looking for occurrences of findByRole and similar functions used in testing-library. This could lead to errors in other implementations unrelated to testing-library as well.

Currently indeed this is necessary in your .eslintrc:

{
  "plugins": ["testing-library"],
  "overrides": [
    {
      "files": ["myCypressFiles/**/*.js"],
      "rules": {
        "testing-library/prefer-screen-queries": "off",
        "testing-library/await-async-query": "off"
      }
    }
  ]
}