core(config): switch to throttling settings object #4879
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,9 +3,12 @@ | |
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| const Driver = require('../gather/driver'); // eslint-disable-line no-unused-vars | ||
|
|
||
| const NBSP = '\xa0'; | ||
|
|
||
| /** | ||
| * Nexus 5X metrics adapted from emulated_devices/module.json | ||
| */ | ||
|
|
@@ -40,17 +43,16 @@ const LATENCY_FACTOR = 3.75; | |
| const THROUGHPUT_FACTOR = 0.9; | ||
|
|
||
| const TARGET_LATENCY = 150; // 150ms | ||
| const TARGET_DOWNLOAD_THROUGHPUT = Math.floor(1.6 * 1024); // 1.6Mbps | ||
| const TARGET_UPLOAD_THROUGHPUT = Math.floor(750); // 750Kbps | ||
|
|
||
| const MOBILE_3G_THROTTLING = { | ||
| targetLatencyMs: TARGET_LATENCY, | ||
| adjustedLatencyMs: TARGET_LATENCY * LATENCY_FACTOR, | ||
| targetDownloadThroughputKbps: TARGET_DOWNLOAD_THROUGHPUT, | ||
| adjustedDownloadThroughputKbps: TARGET_DOWNLOAD_THROUGHPUT * THROUGHPUT_FACTOR, | ||
| targetUploadThroughputKbps: TARGET_UPLOAD_THROUGHPUT, | ||
| adjustedUploadThroughputKbps: TARGET_UPLOAD_THROUGHPUT * THROUGHPUT_FACTOR, | ||
| }; | ||
|
|
||
| const OFFLINE_METRICS = { | ||
|
|
@@ -75,34 +77,10 @@ const CPU_THROTTLE_METRICS = { | |
| rate: 4, | ||
| }; | ||
|
|
||
| /** | ||
| * @param {Driver} driver | ||
| */ | ||
| function enableNexus5X(driver) { | ||
|
|
||
| return Promise.all([ | ||
| driver.sendCommand('Emulation.setDeviceMetricsOverride', NEXUS5X_EMULATION_METRICS), | ||
| // Network.enable must be called for UA overriding to work | ||
|
|
@@ -112,55 +90,135 @@ function enableNexus5X(driver) { | |
| enabled: true, | ||
| configuration: 'mobile', | ||
| }), | ||
| ]); | ||
| } | ||
|
|
||
| /** | ||
| * @param {Driver} driver | ||
|
There was a problem hiding this comment. for type checking in this file we'll have to OTOH there's exposing the major types on There was a problem hiding this comment. yeah sg, I've used that before 馃憤 |
||
| * @param {LH.ThrottlingSettings|undefined} throttlingSettings | ||
| * @return {Promise<void>} | ||
| */ | ||
| function enableNetworkThrottling(driver, throttlingSettings) { | ||
| /** @type {LH.Crdp.Network.EmulateNetworkConditionsRequest} */ | ||
| let conditions; | ||
| if (throttlingSettings) { | ||
| conditions = { | ||
| offline: false, | ||
| latency: throttlingSettings.requestLatencyMs || 0, | ||
| downloadThroughput: throttlingSettings.downloadThroughputKbps || 0, | ||
| uploadThroughput: throttlingSettings.uploadThroughputKbps || 0, | ||
| }; | ||
| } else { | ||
|
There was a problem hiding this comment. what case is this handling? if throttlingSettings are provided via config now, what is this fallback case for? There was a problem hiding this comment. for configs that don't expressly set throttling or extend the default, also tests :) There was a problem hiding this comment. this could be one of the things we (eventually) pull into config.js so once it comes out |
||
| conditions = { | ||
| offline: false, | ||
| latency: MOBILE_3G_THROTTLING.adjustedLatencyMs, | ||
| downloadThroughput: MOBILE_3G_THROTTLING.adjustedDownloadThroughputKbps, | ||
| uploadThroughput: MOBILE_3G_THROTTLING.adjustedUploadThroughputKbps, | ||
| }; | ||
| } | ||
|
|
||
| // DevTools expects throughput in bytes per second rather than kbps | ||
| conditions.downloadThroughput = conditions.downloadThroughput * 1024 / 8; | ||
| conditions.uploadThroughput = conditions.uploadThroughput * 1024 / 8; | ||
| return driver.sendCommand('Network.emulateNetworkConditions', conditions); | ||
| } | ||
|
|
||
| /** | ||
| * @param {Driver} driver | ||
| * @return {Promise<void>} | ||
| */ | ||
| function clearAllNetworkEmulation(driver) { | ||
| return driver.sendCommand('Network.emulateNetworkConditions', NO_THROTTLING_METRICS); | ||
| } | ||
|
|
||
| /** | ||
| * @param {Driver} driver | ||
| * @return {Promise<void>} | ||
| */ | ||
| function goOffline(driver) { | ||
| return driver.sendCommand('Network.emulateNetworkConditions', OFFLINE_METRICS); | ||
| } | ||
|
|
||
| /** | ||
| * @param {Driver} driver | ||
| * @param {LH.ThrottlingSettings|undefined} throttlingSettings | ||
|
There was a problem hiding this comment. @brendankenny for some reason type checking was refusing to allow undefined as an input to There was a problem hiding this comment. looks like this is a temporary bug in the version of TS we're using. I was actually pleased that it started completely differentiating between optional and Later releases have that fixed, though. I'm about to make a PR bumping us to |
||
| * @return {Promise<void>} | ||
| */ | ||
| function enableCPUThrottling(driver, throttlingSettings) { | ||
| const rate = throttlingSettings | ||
| ? throttlingSettings.cpuSlowdownMultiplier | ||
| : CPU_THROTTLE_METRICS.rate; | ||
| return driver.sendCommand('Emulation.setCPUThrottlingRate', {rate}); | ||
| } | ||
|
|
||
| /** | ||
| * @param {Driver} driver | ||
| * @return {Promise<void>} | ||
| */ | ||
| function disableCPUThrottling(driver) { | ||
| return driver.sendCommand('Emulation.setCPUThrottlingRate', NO_CPU_THROTTLE_METRICS); | ||
| } | ||
|
|
||
| /** | ||
| * @param {LH.ConfigSettings} settings | ||
| * @return {{deviceEmulation: string, cpuThrottling: string, networkThrottling: string}} | ||
| */ | ||
| function getEmulationDesc(settings) { | ||
| let cpuThrottling; | ||
| let networkThrottling; | ||
|
|
||
| /** @type {function(number|undefined):string} */ | ||
| const byteToKbit = (bytes = 0) => (bytes / 1024 * 8).toFixed(); | ||
| /** @type {LH.ThrottlingSettings} */ | ||
| const throttling = settings.throttling || {}; | ||
|
|
||
| switch (settings.throttlingMethod) { | ||
| case 'provided': | ||
| cpuThrottling = 'Provided by environment'; | ||
| networkThrottling = 'Provided by environment'; | ||
| break; | ||
| case 'devtools': { | ||
| const {cpuSlowdownMultiplier, requestLatencyMs} = throttling; | ||
| const down = byteToKbit(throttling.downloadThroughputKbps); | ||
|
There was a problem hiding this comment. wait, shouldn't these already be Kbps? There was a problem hiding this comment. whoops yes good catch forgot to update :) |
||
| const up = byteToKbit(throttling.uploadThroughputKbps); | ||
|
|
||
| cpuThrottling = `${cpuSlowdownMultiplier}x slowdown (DevTools)`; | ||
| networkThrottling = `${requestLatencyMs}${NBSP}ms HTTP RTT, ` + | ||
| `${down}${NBSP}Kbps down, ${up}${NBSP}Kbps up (DevTools)`; | ||
| break; | ||
| } | ||
| case 'simulate': { | ||
| const {cpuSlowdownMultiplier, rttMs} = throttling; | ||
| const throughput = byteToKbit(throttling.throughputKbps); | ||
| cpuThrottling = `${cpuSlowdownMultiplier}x slowdown (Simulated)`; | ||
| networkThrottling = `${rttMs}${NBSP}ms TCP RTT, ` + | ||
| `${throughput}${NBSP}Kbps throughput (Simulated)`; | ||
| break; | ||
| } | ||
| default: | ||
| cpuThrottling = 'Unknown'; | ||
| networkThrottling = 'Unknown'; | ||
| } | ||
|
|
||
| return { | ||
| deviceEmulation: settings.disableDeviceEmulation ? 'Disabled' : 'Nexus 5X', | ||
|
There was a problem hiding this comment. 馃憤 way better than the old enabled/disabled and a decription thing |
||
| cpuThrottling, | ||
| networkThrottling, | ||
| }; | ||
| } | ||
|
|
||
| module.exports = { | ||
| enableNexus5X, | ||
| enableNetworkThrottling, | ||
| clearAllNetworkEmulation, | ||
| enableCPUThrottling, | ||
| disableCPUThrottling, | ||
| goOffline, | ||
| getEmulationDesc, | ||
| settings: { | ||
| NEXUS5X_EMULATION_METRICS, | ||
| NEXUS5X_USERAGENT, | ||
| MOBILE_3G_THROTTLING, | ||
| OFFLINE_METRICS, | ||
| NO_THROTTLING_METRICS, | ||
| NO_CPU_THROTTLE_METRICS, | ||
|
|
||
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we use
setThrottlingforgoOnlineandgoOffline, so does this break that for nondevtoolsthrottling? We may need to separate those from this anyways aspassConfig.useThrottlingprobably shouldn't affect a call todriver.goOffline()anyways.We can kick that to another PR if it gets involved, but is there another quick fix in the meantime?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah yeah good catch, we can go offline but never go back online atm if devtools throttling is off or useThrottling is false :), I'll clean this up it's a pretty easy fix
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done and tests added!