Add full parameters for emulateNetworkConditions

WordPress · Jul 23, 2020 · 02e53bb · 02e53bb
1 parent bf74f23
commit 02e53bb
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 7 deletions.
diff --git a/docs/contributors/testing-overview.md b/docs/contributors/testing-overview.md
@@ -432,10 +432,18 @@ THROTTLE_CPU=4 npm run test-e2e
 Related: https://chromedevtools.github.io/devtools-protocol/tot/Emulation#method-setCPUThrottlingRate
 
 ```
-DOWNLOAD_THROUGHPUT=125000 npm run test-e2e
+SLOW_NETWORK=true npm run test-e2e
 ```
 
-`DOWNLOAD_THROUGHPUT` is a numeric value representing bytes-per-second network download (in this example, a 1Mbps download speed).
+`SLOW_NETWORK` emulates a network speed equivalent to "Fast 3G" in the Chrome devtools.
+
+Related: https://chromedevtools.github.io/devtools-protocol/tot/Network#method-emulateNetworkConditions and https://github.com/ChromeDevTools/devtools-frontend/blob/80c102878fd97a7a696572054007d40560dcdd21/front_end/sdk/NetworkManager.js#L252-L274
+
+```
+OFFLINE=true npm run test-e2e
+```
+
+`OFFLINE` emulates network disconnection.
 
 Related: https://chromedevtools.github.io/devtools-protocol/tot/Network#method-emulateNetworkConditions
 

diff --git a/packages/e2e-tests/config/setup-test-framework.js b/packages/e2e-tests/config/setup-test-framework.js
@@ -34,7 +34,14 @@ const THROTTLE_CPU = process.env.THROTTLE_CPU;
  *
  * @type {string|undefined}
  */
-const DOWNLOAD_THROUGHPUT = process.env.DOWNLOAD_THROUGHPUT;
+const SLOW_NETWORK = process.env.SLOW_NETWORK;
+
+/**
+ * Emulate no internet connection.
+ *
+ * @type {string|undefined}
+ */
+const OFFLINE = process.env.OFFLINE;
 
 /**
  * Set of console logging types observed to protect against unexpected yet
@@ -213,17 +220,23 @@ async function runAxeTestsForBlockEditor() {
  * Simulate slow network or throttled CPU if provided via environment variables.
  */
 async function simulateAdverseConditions() {
-	if ( ! DOWNLOAD_THROUGHPUT && ! THROTTLE_CPU ) {
+	if ( ! SLOW_NETWORK && ! OFFLINE && ! THROTTLE_CPU ) {
 		return;
 	}
 
 	const client = await page.target().createCDPSession();
 
-	if ( DOWNLOAD_THROUGHPUT ) {
+	if ( SLOW_NETWORK || OFFLINE ) {
 		// See: https://chromedevtools.github.io/devtools-protocol/tot/Network#method-emulateNetworkConditions
 		await client.send( 'Network.emulateNetworkConditions', {
-			// Simulated download speed (bytes/s)
-			downloadThroughput: Number( DOWNLOAD_THROUGHPUT ),
+			// Network connectivity is absent
+			offline: Boolean( OFFLINE || false ),
+			// Download speed (bytes/s)
+			downloadThroughput: ( ( 1.6 * 1024 * 1024 ) / 8 ) * 0.9,
+			// Upload speed (bytes/s)
+			uploadThroughput: ( ( 750 * 1024 ) / 8 ) * 0.9,
+			// Latency (ms)
+			latency: 150 * 3.75,
 		} );
 	}