prefer-wait-for: Cannot read property 'arguments' of null

[AriPerkkio]

Hello, prefer-wait-for rule seems to crash in certain cases. This issue was spotted by automated CI run - it is not blocking my development or anything. ESlint rules should not crash in any condition since this makes all valid linting problems disappear. If this is a false flag please let me know.

https://github.com/AriPerkkio/eslint-remote-tester/runs/1551964310?check_suite_focus=true

Complete list of dependencies and .eslintrc is available at CI runs logs, steps Run yarn list | grep eslint and Run yarn log --config ./plugin-configs/eslint-plugin-testing-library.config.js.

eslint-plugin-testing-library@3.10.1

rules: {
    'testing-library/prefer-wait-for': 'error',
}

Minimal repro:

import { waitForElement } from '@testing-library/react';

global.waitForElement = waitForElement;

TypeError: Cannot read property 'arguments' of null Occurred while linting <text>:2
    at Object.fix (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:61:50)

Crash reports from real projects

Rule: prefer-wait-for

• Message: Cannot read property 'arguments' of null Occurred while linting <text>:2
• Path: diondirza/rexr/test/test-utils.js
• Link

import React from 'react';
import { fireEvent, render, waitForElement } from '@testing-library/react';
import { HelmetProvider } from 'react-helmet-async';
import { Router } from 'react-router-dom';
import { createBrowserHistory } from 'history';

import { GlobalProvider } from '@context';

TypeError: Cannot read property 'arguments' of null Occurred while linting <text>:2
    at Object.fix (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:61:50)
    at normalizeFixes (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/report-translator.js:178:28)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/report-translator.js:347:49
    at Object.report (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/linter.js:920:41)
    at reportWait (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:53:21)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:97:36
    at Array.forEach (<anonymous>)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:96:52
    at Array.forEach (<anonymous>)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:95:26

Rule: prefer-wait-for

• Message: Cannot read property 'arguments' of null Occurred while linting <text>:18
• Path: gravitational/webapps/packages/design/src/utils/testing.tsx
• Link

 * limitations under the License.
 */

import React from 'react';
import {
  render as testingRender,
  act,
  fireEvent,
  waitForElement,
} from '@testing-library/react';

TypeError: Cannot read property 'arguments' of null Occurred while linting <text>:18
    at Object.fix (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:61:50)
    at normalizeFixes (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/report-translator.js:178:28)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/report-translator.js:347:49
    at Object.report (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/linter.js:920:41)
    at reportWait (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:53:21)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:97:36
    at Array.forEach (<anonymous>)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:96:52
    at Array.forEach (<anonymous>)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:95:26

Rule: prefer-wait-for

• Message: Cannot read property 'arguments' of null Occurred while linting <text>:2
• Path: faultable/wardex/src/setupTests.js
• Link

import React from 'react'
import {
  afterEach,
  render,
  cleanup,
  fireEvent,
  wait,

TypeError: Cannot read property 'arguments' of null Occurred while linting <text>:2
    at Object.fix (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:61:50)
    at normalizeFixes (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/report-translator.js:178:28)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/report-translator.js:347:49
    at Object.report (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/linter.js:920:41)
    at reportWait (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:53:21)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:97:36
    at Array.forEach (<anonymous>)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:96:52
    at Array.forEach (<anonymous>)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:95:26

Rule: prefer-wait-for

• Message: Cannot read property 'arguments' of null Occurred while linting <text>:2
• Path: activewidgets/react/test/adapter/react.js
• Link

import {render, fireEvent, wait, waitForElement} from '@testing-library/react';
import {h} from '@activewidgets/components';


export function mount(component, props){
    return render(h(component, props));

TypeError: Cannot read property 'arguments' of null Occurred while linting <text>:2
    at Object.fix (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:61:50)
    at normalizeFixes (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/report-translator.js:178:28)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/report-translator.js:347:49
    at Object.report (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/linter.js:920:41)
    at reportWait (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:53:21)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:97:36
    at Array.forEach (<anonymous>)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:96:52
    at Array.forEach (<anonymous>)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:95:26

Rule: prefer-wait-for

• Message: Cannot read property 'arguments' of null Occurred while linting <text>:3
• Path: w-sr/React-Storybook-Game/src/setupTests.js
• Link

import React from 'react';
import '@testing-library/jest-dom/extend-expect';
import { render, fireEvent, waitForElement } from '@testing-library/react';
import renderer from 'react-test-renderer';
import sinon from 'sinon';
import { act } from 'react-dom/test-utils';
import 'jest-styled-components';

TypeError: Cannot read property 'arguments' of null Occurred while linting <text>:3
    at Object.fix (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:61:50)
    at normalizeFixes (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/report-translator.js:178:28)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/report-translator.js:347:49
    at Object.report (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/linter.js:920:41)
    at reportWait (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:53:21)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:97:36
    at Array.forEach (<anonymous>)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:96:52
    at Array.forEach (<anonymous>)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:95:26

Rule: prefer-wait-for

• Message: Cannot read property 'arguments' of null Occurred while linting <text>:20
• Path: sumup-oss/circuit-ui/src/util/test-utils.tsx
• Link

import React, { FunctionComponent } from 'react';
import { renderToStaticMarkup } from 'react-dom/server';
import '@testing-library/jest-dom/extend-expect';
import { configureAxe } from 'jest-axe';
import {
  render as renderTest,
  wait,
  act,
  RenderResult,
} from '@testing-library/react';

TypeError: Cannot read property 'arguments' of null Occurred while linting <text>:20
    at Object.fix (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:61:50)
    at normalizeFixes (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/report-translator.js:178:28)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/report-translator.js:347:49
    at Object.report (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint/lib/linter/linter.js:920:41)
    at reportWait (/home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:53:21)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:97:36
    at Array.forEach (<anonymous>)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:96:52
    at Array.forEach (<anonymous>)
    at /home/runner/work/eslint-remote-tester/eslint-remote-tester/ci/node_modules/eslint-plugin-testing-library/rules/prefer-wait-for.js:95:26

[gndelia]

Hi AriPerkkio , thanks for posting. How would the test usage look like? Just a regular

waitForElement(() => getByText('foo')) 

?

I wouldn't recommend storing the queries in the global space. You can always import screen and use them from there. In addition to that, you might want to use waitFor instead of waitForElement as waitForElement is deprecated.

Either way, we could try to fix this scenario to prevent the suite from crashing

[AriPerkkio]

I should have mentioned that the use case causing the crash might not be valid or recommended. I'm just testing stability of various community ESLint plugins and reporting the issues to plugin developers. This same issue could come up in completely valid case too.

This is also crashing:

import { waitForElement } from '@testing-library/react';

const renamedWaitForElement = waitForElement;

[Belco90]

Hello Ari. Thanks for opening this issue. You are right: this scenario shouldn't cause any error. However, we are close to finish v4 of the plugin, which includes a huge refactor of all rules almost from the ground. I can confirm this case has been fixed on v4 as you can see here:

So I would suggest to wait for this version if it is an extreme edge case to catch errors in the plugin.

[AriPerkkio]

Thanks for the verification @Belco90. Feel free to close this issue.

Once v4 is available in npm I'll include it to my weekly scheduled CI runs on eslint-remote-tester.

[Belco90]

Awesome! I think I'm gonna leave it open as I did with other issues solved on v4 until it gets released.

[Belco90]

This should be fixed on v4.0.0

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

[Belco90]

Hey @AriPerkkio! I saw after releasing v4 of the plugin the badge for this ESLint plugin is green in your eslint-remote-tester! 🎉

Would be fine to include such a badge in our README?

[AriPerkkio]

Congratulations about v4! 🎉

I was excited to see how it stands against heavy 6 hour tests - and it was perfect score with 0 crashes.
It was so fast that I'm even suspecting I've misconfigured the eslintrc 😄.
[eslint-plugin-testing-library]: Repositories (14024/14496)

Here are some comparisons from other plugins. The results are not 100% comparable but it provides some useful feedback about plugin's performance.

6 hour time limit, maximum of 14K repositories to test:
[eslint-plugin-unicorn]: Repositories (6101/14496)
[eslint-plugin-react]: Repositories (5823/14496)
[eslint-plugin-import]: Repositories (7830/14496)
[eslint-plugin-mocha]: Repositories (3198/14496) 😢 
[eslint-plugin-jest]: Repositories (12910/14496)

Would be fine to include such a badge in our README?

Definitely!

If you are interested in keeping master branch of this repository stable I could help by setting up PR where eslint-remote-tester would be run in this repository. Some ESLint plugins are already doing this. See https://github.com/marketplace/actions/eslint-remote-tester-runner.

[MichaelDeBoey]

@AriPerkkio Would it also be possible to have your workflows report automatically in our repo somehow? 🤔
Maybe with a restriction that it would only be possible from a certain bot (with permissions on this repo), so that it's not flagged as spam or something.

You're already running all tests, so CI would run a second time on this repo for no other reason than to report possible bugs to us.

Can you also provide us with the list of the other ESLint plugins that already use your action themselves please?

[AriPerkkio]

Would it also be possible to have your workflows report automatically in our repo somehow?

I'm not sure whether Github provides functionality for this. The workflow is currently utilizing octokit client for creating the issues. I'll need to look into octokit's documentation - PRs to eslint-remote-tester-run-action are also welcome. 👍

so CI would run a second time on this repo for no other reason than to report possible bugs to us.

Note that eslint-remote-tester is running against the latest published release. It would be ideal if plugins would caught these issues even before publishing their release. Running against latest master is easiest from the plugin repositories themselves.

So far eslint-plugin-unicorn, eslint-plugin-jest-dom and eslint-plugin-knex(?) are running tests in their repositories. There is an open PR for eslint-plugin-react too. I haven't really advertised this tool much.