[7.17] [FTR] Implement browser network condition utils (#163633) #163711
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## 📓 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._
```ts
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](https://github.com/ChromeDevTools/devtools-frontend/blob/da276a3faec9769cb55e442f0db77ebdce5cd178/front_end/core/sdk/NetworkManager.ts#L363-L393):
- `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._
```ts
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._
```ts
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();
}
});
```
Co-authored-by: Marco Antonio Ghiani <[email protected]>
Co-authored-by: Dzmitry Lemechko <[email protected]>
(cherry picked from commit aa45152)
# Conflicts:
# test/analytics/tests/instrumented_events/from_the_browser/loaded_kibana.ts
# test/functional/services/common/browser.ts
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment with: |
dmlemeshko
approved these changes
Aug 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
mainto7.17:Questions ?
Please refer to the Backport tool documentation