Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

RDC Network Throttling #2770

Merged
merged 7 commits into from
May 15, 2024
Merged

RDC Network Throttling #2770

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
486a420
skeleton for network throttling
yuyi-sl May 6, 2024
ff01c14
add item to sidebar and add tables
yuyi-sl May 6, 2024
477993e
restructure
yuyi-sl May 13, 2024
799363e
network throttle doc
yuyi-sl May 14, 2024
9aa6127
Merge remote-tracking branch 'origin/main' into rdc-network-throttling
yuyi-sl May 14, 2024
6813ec8
Merge branch 'main' into rdc-network-throttling
yuyi-sl May 15, 2024
0091efb
comments
yuyi-sl May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions docs/dev/test-configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1552,6 +1552,57 @@ capabilities.setCapability("sauce:options", sauceOptions);

---

### `networkProfile`

<p><small>| OPTIONAL | STRING | <span className="sauceGreen">Real Devices Only</span> | <span className="sauceGreen">iOS BETA</span> |</small></p>

Set a network profile with predefined network conditions at the beginning of the session.
Please refer to the [list of network profiles](https://docs.saucelabs.com/mobile-apps/features/network-throttling/#predefined-network-profiles) for more information about each profile's network conditions.

```java
MutableCapabilities capabilities = new MutableCapabilities();
//...
MutableCapabilities sauceOptions = new MutableCapabilities();
sauceOptions.setCapability("networkProfile", "2G");
capabilities.setCapability("sauce:options", sauceOptions);
```

---

### `networkConditions`

<p><small>| OPTIONAL | OBJECT | <span className="sauceGreen">Real Devices Only</span> | <span className="sauceGreen">iOS BETA</span> |</small></p>

Set custom network conditions for `downloadSpeed`, `uploadSpeed`, `latency` or `loss` at the beginning of the session.
Not all parameters need to be specified and only the ones specified will have conditioning applied.
Please refer to the [supported network conditions](https://docs.saucelabs.com/mobile-apps/features/network-throttling/#supported-network-conditions) for more information.

```java
MutableCapabilities capabilities = new MutableCapabilities();
//...
MutableCapabilities sauceOptions = new MutableCapabilities();
sauceOptions.setCapability("networkConditions", ImmutableMap.of(
"downloadSpeed", 5000,
"uploadSpeed", 3000,
"latency", 200,
"loss", 2,
));
capabilities.setCapability("sauce:options", sauceOptions);
```

:::important

Each network condition has a supported value range:

- `downloadSpeed`: 0 - 50000 kbps
- `uploadSpeed`: 0 - 50000 kbps
- `latency`: 0 - 3000 ms
- `loss`: 0 - 100 %

:::

---

### `mobile: shell`

<p><small>| OPTIONAL | STRING | <span className="sauceGreen">Real Devices Only</span> | <span className="sauceGreen">Android Only</span> |</small></p>
Expand Down
155 changes: 155 additions & 0 deletions docs/mobile-apps/features/network-throttling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
---
id: network-throttling
title: Network Throttling
sidebar_label: Network Throttling
---

import useBaseUrl from '@docusaurus/useBaseUrl';

<p><small><span className="sauceGreen">Real Devices Only</span></small></p>
<p><small><span className="sauceGreen">iOS BETA</span></small></p>

With Sauce Labs Network Throttling, you can simulate and reproduce different network scenarios, ensuring that your mobile application performs optimally under
a huge variety of network conditions. From replicating slow network speeds to mimicking offline states, high latency, or connection disruptions,
this feature allows you to identify network-related performance issues early in your pipeline.

In combination with our [Network Traffic Capture](https://docs.saucelabs.com/mobile-apps/features/network-capture/) functionality to record network traffic,
you have the tools to replicate and troubleshoot any performance concerns stemming from network operations.

## What You'll Need

- A Sauce Labs paid account ([Log in](https://accounts.saucelabs.com/am/XUI/#login/))

## Supported Network Conditions

The following table shows the allowed range of supported network condition parameters:

<table>
<thead>
<tr>
<th>Network Condition</th>
<th>Range</th>
</tr>
</thead>
<tbody>
<tr>
<td>Download speed</td>
<td>0 - 50000 kbps</td>
</tr>
<tr>
<td>Upload speed</td>
<td>0 - 50000 kbps</td>
</tr>
<tr>
<td>Latency</td>
<td>0 - 3000 ms</td>
</tr>
<tr>
<td>Packet loss</td>
<td>0 - 100 %</td>
</tr>
</tbody>
</table>

Only specified parameters will undergo conditioning, allowing for flexibility in customizing network simulations to your precise testing needs.

## Predefined Network Profiles

The following table shows the predefined network profiles along with their corresponding parameter values supported on Sauce Labs:

<table>
<thead>
<tr>
<th>Network Profile</th>
<th>Download Speed (kbps)</th>
<th>Upload Speed (kbps)</th>
<th>Latency (ms)</th>
<th>Packet Loss (%)</th>
</tr>
</thead>
<tbody>
<tr>
<td>no-throttling</td>
<td>-</td>
<td>-</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>no-network</td>
<td>-</td>
<td>-</td>
<td>-</td>
<td>100</td>
</tr>
<tr>
<td>2G-packet-loss</td>
<td>100</td>
<td>50</td>
<td>500</td>
<td>10</td>
</tr>
<tr>
<td>2G</td>
<td>200</td>
<td>100</td>
<td>300</td>
<td>1</td>
</tr>
<tr>
<td>3G-slow</td>
<td>500</td>
<td>250</td>
<td>200</td>
<td>1</td>
</tr>
<tr>
<td>3G-fast</td>
<td>7000</td>
<td>2500</td>
<td>100</td>
<td>-</td>
</tr>
<tr>
<td>4G-slow</td>
<td>8000</td>
<td>4000</td>
<td>100</td>
<td>-</td>
</tr>
<tr>
<td>4G-fast</td>
<td>25000</td>
<td>15000</td>
<td>30</td>
<td>-</td>
</tr>
</tbody>
</table>

## Automated Testing

### Appium
To use the Sauce Labs Network Throttling feature in your automated Appium test, you can add the sauce-specific capability
[networkConditions](https://docs.saucelabs.com/dev/test-configuration-options/#network-conditions) to provide custom network conditions for
the entire session.
Alternatively, you can use the sauce-specific capability [networkProfile](https://docs.saucelabs.com/dev/test-configuration-options/#network-profile)
to apply one of the predefined network profiles to your session.

## Upcoming

* Change your desired network conditions dynamically any time during your automated Appium test
* Apply network throttling to your manual Live tests
* Apply network throttling to your Espresso and XCUITest tests

## Limitations
:::note Limitations

- iOS network throttling is supported on iOS/iPadOS 14.0 and above.

:::


## More Information

- Use [Network Capture](https://docs.saucelabs.com/mobile-apps/features/network-capture/) to debug the failures in the app.
1 change: 1 addition & 0 deletions sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1374,6 +1374,7 @@ module.exports = {
collapsed: true,
items: [
'mobile-apps/features/appium-inspector',
'mobile-apps/features/network-throttling',
'mobile-apps/features/biometric-authentication',
'mobile-apps/features/camera-image-injection',
'mobile-apps/features/audio-capture',
Expand Down
Loading