core(proto): clarify deprecated state of EmulatedFormFactor enum (#11946)

This commit is contained in:
Paul Irish 2021-01-12 15:12:20 -08:00 коммит произвёл GitHub
Родитель 71c4fd4909
Коммит 30cd201cb8
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 13 добавлений и 9 удалений

Просмотреть файл

@ -125,20 +125,27 @@ message LighthouseResult {
map<string, CategoryGroup> category_groups = 11; map<string, CategoryGroup> category_groups = 11;
// Message containing the configuration settings for the LH run // Message containing the configuration settings for the LH run
// Next field number: 6
message ConfigSettings { message ConfigSettings {
// The possible form factors an audit can be run in.
// The possible form factors an audit can be run in // This enum served the emulated_form_factor field, but in v7, that field
enum EmulatedFormFactor { // Deprecated // was deprecated. Meanwhile in v7, the form_factor field was added and has
// a mobile/desktop enum, so we simplify reuse, minus the `none` option.
// See https://github.com/GoogleChrome/lighthouse/blob/master/docs/emulation.md#changes-made-in-v7
enum EmulatedFormFactor {
UNKNOWN_FORM_FACTOR = 0; UNKNOWN_FORM_FACTOR = 0;
mobile = 1; mobile = 1;
desktop = 2; desktop = 2;
none = 3 [deprecated = true]; none = 3 [deprecated = true];
} }
// Removed in v7. Do not use.
// The form factor emulation to apply. Do not use.
EmulatedFormFactor emulated_form_factor = 1 [deprecated = true]; EmulatedFormFactor emulated_form_factor = 1 [deprecated = true];
// How Lighthouse should interpret this run in regards to scoring
// performance metrics and skipping mobile-only tests in desktop.
EmulatedFormFactor form_factor = 5;
// The locale that was active during the audit // The locale that was active during the audit
string locale = 2; string locale = 2;
@ -149,9 +156,6 @@ message LighthouseResult {
// How Lighthouse was run, e.g. from the Chrome extension or from the npm // How Lighthouse was run, e.g. from the Chrome extension or from the npm
// module // module
string channel = 4; string channel = 4;
// How Lighthouse should interpret this run in regards to scoring performance metrics and skipping mobile-only tests in desktop.
EmulatedFormFactor form_factor = 5;
} }
// The settings that were used to run this audit // The settings that were used to run this audit