noPlaywrightNetworkidle (JavaScript)

Language JavaScript (and super languages)

Summary

Rule available since: v2.4.2
Diagnostic Category: lint/suspicious/noPlaywrightNetworkidle
This rule isn’t recommended, so you need to enable it.
This rule doesn’t have a fix.
The default severity of this rule is warning.
This rule belongs to the following domains:
- playwright
Sources:
- Same as playwright/no-networkidle

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "suspicious": {
5
        "noPlaywrightNetworkidle": "error"
6
      }
7
    }
8
  }
9
}

Description

Disallow usage of the networkidle option.

Using networkidle is discouraged in favor of using web-first assertions. The networkidle event is unreliable and can lead to flaky tests.

Examples

Invalid

1
await page.waitForLoadState('networkidle');

code-block.js:1:7 lint/suspicious/noPlaywrightNetworkidle ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unexpected use of networkidle option.
  
  > 1 │ await page.waitForLoadState('networkidle');
      │       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ The networkidle event is unreliable and can lead to flaky tests.
  
  ℹ Use web-first assertions or wait for specific elements instead.

1
await page.goto('https://example.com', { waitUntil: 'networkidle' });

code-block.js:1:7 lint/suspicious/noPlaywrightNetworkidle ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unexpected use of networkidle option.
  
  > 1 │ await page.goto('https://example.com', { waitUntil: 'networkidle' });
      │       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ The networkidle event is unreliable and can lead to flaky tests.
  
  ℹ Use web-first assertions or wait for specific elements instead.

Valid

1
await page.waitForLoadState('load');

1
await page.goto('https://example.com');
2
await page.locator('.content').waitFor();