[FTR] Implement browser network condition utils

[tonyghiani]

📓 Summary

The PR implements some utilities into the browser service to allow controlling the network conditions during the execution of a functional test.

getNetworkConditions

Returns the current network simulation options. If none conditions are previously set, it returns undefined

N.B.: if the testing environment is not a Chromium browser, it throws an error that can be easily caught to manually skip the test or handle a fallback scenario.

it('should display a loading skeleton while loading', async function () {
  // Skip the test in case network condition utils are not available
  try {
    const networkConditions = await browser.getNetworkConditions(); // undefined

    await browser.setNetworkConditions('SLOW_3G');

    const networkConditions = await browser.getNetworkConditions();
    // {
    //   offline: false,
    //   latency: 2000,
    //   download_throughput: 50000,
    //   upload_throughput: 50000,
    // }
  } catch (error) {
    this.skip();
  }
});

setNetworkConditions

Set the desired network conditions.
It supports different presets that match the network profiles provided by Chrome debugger:

• NO_THROTTLING
• FAST_3G
• SLOW_3G
• OFFLINE
• CLOUD_USER (pre-existing)
  It also accepts ad-hoc options to configure more specifically the network conditions.

N.B.: if the testing environment is not a Chromium browser, it throws an error that can be easily caught to manually skip the test or handle a fallback scenario.

it('should display a loading skeleton while loading', async function () {
  // Skip the test in case network condition utils are not available
  try {
    await browser.setNetworkConditions('NO_THROTTLING');
    await browser.setNetworkConditions('FAST_3G');
    await browser.setNetworkConditions('SLOW_3G');
    await browser.setNetworkConditions('OFFLINE');
    await browser.setNetworkConditions('CLOUD_USER');
    await browser.setNetworkConditions({
      offline: false,
      latency: 5, // Additional latency (ms).
      download_throughput: 500 * 1024, // Maximal aggregated download throughput.
      upload_throughput: 500 * 1024, // Maximal aggregated upload throughput.
    });
  } catch (error) {
    this.skip();
  }
});

restoreNetworkConditions

Restore the original network conditions, setting to NO_THROTTLING.
The native implementation of deleteNetworkConditions exposed by selenium is unofficial and didn't consistently work, the recommended approach by the google dev tools team is to restore the connection setting the no throttling profile.

N.B.: if the testing environment is not a Chromium browser, it throws an error that can be easily caught to manually skip the test or handle a fallback scenario.

it('should display a loading skeleton while loading', async function () {
  // Skip the test in case network condition utils are not available
  try {
    await browser.setNetworkConditions('SLOW_3G'); // Slow down network conditions
    
    // Do your assertions

    await browser.restoreNetworkConditions(); // Restore network conditions
  } catch (error) {
    this.skip();
  }
});

[apmmachine]

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

• /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
• /oblt-deploy-serverless : Deploy a serverless Kibana instance using the Observability test environments.
• run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

[afharo]

Core changes LGTM

[dmlemeshko]

Tested locally. Code LGTM.
Great work @tonyghiani !

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: 1bccde5

Metrics [docs]

✅ unchanged

History

• 💚 Build #149327 succeeded 1f153a7

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

[kibanamachine]

💔 Some backports could not be created

Status	Branch	Result
❌	7.17	Backport failed because of merge conflicts
✅	8.9

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 163633

Questions ?

Please refer to the Backport tool documentation

[tonyghiani]

@dmlemeshko Do we need to backport this to 7.17 too? Being an enhancement and not a fix, shouldn't exist any test requiring these new methods.

UPDATE: I fixed the conflicts and created the backport anyway, I guess won't hurt having these utils in 7.17 too.

[tonyghiani]

💚 All backports created successfully

Status	Branch	Result
✅	7.17

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

[dmlemeshko]

UPDATE: I fixed the conflicts and created the backport anyway, I guess won't hurt having these utils in 7.17 too.

Thank you, it is better to backport for services consistency. We still be running CI tests on 7.17.x for some time and by backporting changes we keep it easier to make any framework changes we might have to do in the future.

[mistic]

This pr didn't make it into the build candidate for v8.9.1. Updating the labels.