core: remove deprecated disableDeviceEmulation flag (#8289)

GoogleChrome · Apr 17, 2019 · f33d559 · f33d559
1 parent 5f11b90
commit f33d559
Show file tree

Hide file tree

Showing 19 changed files with 19 additions and 66 deletions.
diff --git a/docs/readme.md b/docs/readme.md
@@ -119,7 +119,7 @@ instance with an open debugging port.
 
 Lighthouse can run against a real mobile device. You can follow the [Remote Debugging on Android (Legacy Workflow)](https://developer.chrome.com/devtools/docs/remote-debugging-legacy) up through step 3.3, but the TL;DR is install & run adb, enable USB debugging, then port forward 9222 from the device to the machine with Lighthouse.
 
-You'll likely want to use the CLI flags `--disable-device-emulation --throttling.cpuSlowdownMultiplier`.
+You'll likely want to use the CLI flags `--emulated-form-factor=none --throttling.cpuSlowdownMultiplier=1` to disable any additional emulation.
 
 ```sh
 $ adb kill-server
@@ -131,7 +131,7 @@ $ adb devices -l
 
 $ adb forward tcp:9222 localabstract:chrome_devtools_remote
 
-$ lighthouse --port=9222 --disable-device-emulation --throttling.cpuSlowdownMultiplier=1 https://example.com
+$ lighthouse --port=9222 --emulated-form-factor=none --throttling.cpuSlowdownMultiplier=1 https://example.com
 ```
 
 ## Lighthouse as trace processor

diff --git a/docs/understanding-results.md b/docs/understanding-results.md
@@ -120,7 +120,7 @@ An object containing information about the configuration used by Lighthouse.
   },
   "gatherMode": false,
   "disableStorageReset": false,
-  "disableDeviceEmulation": false,
+  "emulatedFormFactor": "mobile",
   "blockedUrlPatterns": null,
   "additionalTraceCategories": null,
   "extraHeaders": null,

diff --git a/lighthouse-cli/cli-flags.js b/lighthouse-cli/cli-flags.js
@@ -32,7 +32,7 @@ function getFlags(manualArgv) {
           'lighthouse <url> --output=json --output-path=./report.json --save-assets',
           'Save trace, screenshots, and named JSON report.')
       .example(
-          'lighthouse <url> --disable-device-emulation --throttling-method=provided',
+          'lighthouse <url> --emulated-form-factor=none --throttling-method=provided',
           'Disable device emulation and all throttling')
       .example(
           'lighthouse <url> --chrome-flags="--window-size=412,660"',
@@ -70,7 +70,6 @@ function getFlags(manualArgv) {
         'blocked-url-patterns': 'Block any network requests to the specified URL patterns',
         'disable-storage-reset':
             'Disable clearing the browser cache and other storage APIs before a run',
-        'disable-device-emulation': 'Disable all device form factor emulation. Deprecated: use --emulated-form-factor=none instead',
         'emulated-form-factor': 'Controls the emulated device form factor (mobile vs. desktop) if not disabled',
         'throttling-method': 'Controls throttling method',
         'throttling.rttMs': 'Controls simulated network RTT (TCP layer)',
@@ -123,7 +122,7 @@ function getFlags(manualArgv) {
 
       // boolean values
       .boolean([
-        'disable-storage-reset', 'disable-device-emulation', 'save-assets', 'list-all-audits',
+        'disable-storage-reset', 'save-assets', 'list-all-audits',
         'list-trace-categories', 'view', 'verbose', 'quiet', 'help', 'print-config',
       ])
       .choices('output', printer.getValidOutputOptions())

diff --git a/lighthouse-cli/test/cli/__snapshots__/index-test.js.snap b/lighthouse-cli/test/cli/__snapshots__/index-test.js.snap
@@ -1194,7 +1194,6 @@ Object {
     "auditMode": false,
     "blockedUrlPatterns": null,
     "channel": "cli",
-    "disableDeviceEmulation": false,
     "disableStorageReset": false,
     "emulatedFormFactor": "mobile",
     "extraHeaders": null,
@@ -1324,7 +1323,6 @@ Object {
     "auditMode": true,
     "blockedUrlPatterns": null,
     "channel": "cli",
-    "disableDeviceEmulation": false,
     "disableStorageReset": false,
     "emulatedFormFactor": "mobile",
     "extraHeaders": null,

diff --git a/lighthouse-core/config/constants.js b/lighthouse-core/config/constants.js
@@ -50,7 +50,6 @@ const defaultSettings = {
   auditMode: false,
   gatherMode: false,
   disableStorageReset: false,
-  disableDeviceEmulation: false,
   emulatedFormFactor: 'mobile',
   channel: 'node',
 

diff --git a/lighthouse-core/gather/driver.js b/lighthouse-core/gather/driver.js
@@ -1410,12 +1410,10 @@ class Driver {
    * @return {Promise<void>}
    */
   async beginEmulation(settings) {
-    if (!settings.disableDeviceEmulation) {
-      if (settings.emulatedFormFactor === 'mobile') {
-        await emulation.enableNexus5X(this);
-      } else if (settings.emulatedFormFactor === 'desktop') {
-        await emulation.enableDesktop(this);
-      }
+    if (settings.emulatedFormFactor === 'mobile') {
+      await emulation.enableNexus5X(this);
+    } else if (settings.emulatedFormFactor === 'desktop') {
+      await emulation.enableDesktop(this);
     }
 
     await this.setThrottling(settings, {useThrottling: true});

diff --git a/lighthouse-core/lib/sentry.js b/lighthouse-core/lib/sentry.js
@@ -110,7 +110,6 @@ function init(opts) {
 
     const context = Object.assign({
       url: opts.url,
-      deviceEmulation: !opts.flags.disableDeviceEmulation,
       emulatedFormFactor: opts.flags.emulatedFormFactor,
       throttlingMethod: opts.flags.throttlingMethod,
     }, opts.flags.throttling);

diff --git a/lighthouse-core/report/html/renderer/util.js b/lighthouse-core/report/html/renderer/util.js
@@ -400,10 +400,8 @@ class Util {
     }
 
     let deviceEmulation = 'No emulation';
-    if (!settings.disableDeviceEmulation) {
-      if (settings.emulatedFormFactor === 'mobile') deviceEmulation = 'Emulated Nexus 5X';
-      if (settings.emulatedFormFactor === 'desktop') deviceEmulation = 'Emulated Desktop';
-    }
+    if (settings.emulatedFormFactor === 'mobile') deviceEmulation = 'Emulated Nexus 5X';
+    if (settings.emulatedFormFactor === 'desktop') deviceEmulation = 'Emulated Desktop';
 
     return {
       deviceEmulation,

diff --git a/lighthouse-core/test/config/config-test.js b/lighthouse-core/test/config/config-test.js
@@ -581,16 +581,16 @@ describe('Config', () => {
         extends: 'lighthouse:full',
         settings: {
           disableStorageReset: true,
-          disableDeviceEmulation: false,
+          emulatedFormFactor: 'mobile',
         },
       },
-      {disableDeviceEmulation: true}
+      {emulatedFormFactor: 'desktop'}
     );
 
     assert.ok(config, 'failed to generate config');
     assert.ok(typeof config.settings.maxWaitForLoad === 'number', 'missing setting from default');
     assert.ok(config.settings.disableStorageReset, 'missing setting from extension config');
-    assert.ok(config.settings.disableDeviceEmulation, 'missing setting from flags');
+    assert.ok(config.settings.emulatedFormFactor === 'desktop', 'missing setting from flags');
   });
 
   it('inherits default settings when undefined', () => {

diff --git a/lighthouse-core/test/gather/gather-runner-test.js b/lighthouse-core/test/gather/gather-runner-test.js
@@ -231,35 +231,6 @@ describe('GatherRunner', function() {
     });
   });
 
-  it('stops device emulation when disableDeviceEmulation flag is true', () => {
-    const tests = {
-      calledDeviceEmulation: false,
-      calledNetworkEmulation: false,
-      calledCpuEmulation: false,
-    };
-    const createEmulationCheck = variable => () => {
-      tests[variable] = true;
-      return true;
-    };
-    const driver = getMockedEmulationDriver(
-      createEmulationCheck('calledDeviceEmulation', false),
-      createEmulationCheck('calledNetworkEmulation', true),
-      createEmulationCheck('calledCpuEmulation', true)
-    );
-
-    return GatherRunner.setupDriver(driver, {
-      settings: {
-        disableDeviceEmulation: true,
-        throttlingMethod: 'devtools',
-        throttling: {},
-      },
-    }).then(_ => {
-      assert.equal(tests.calledDeviceEmulation, false);
-      assert.equal(tests.calledNetworkEmulation, true);
-      assert.equal(tests.calledCpuEmulation, true);
-    });
-  });
-
   it('uses correct emulation form factor', async () => {
     let emulationParams;
     const driver = getMockedEmulationDriver(

diff --git a/lighthouse-core/test/lib/proto-preprocessor-test.js b/lighthouse-core/test/lib/proto-preprocessor-test.js
@@ -27,7 +27,6 @@ describe('processing for proto', () => {
         },
         'gatherMode': false,
         'disableStorageReset': false,
-        'disableDeviceEmulation': false,
         'emulatedFormFactor': 'mobile',
         'locale': 'en-US',
         'blockedUrlPatterns': null,

diff --git a/lighthouse-core/test/lib/sentry-test.js b/lighthouse-core/test/lib/sentry-test.js
@@ -68,7 +68,6 @@ describe('Sentry', () => {
       expect(raven.mergeContext.mock.calls[0][0]).toEqual({
         extra: {
           url: 'http://example.com',
-          deviceEmulation: true,
           emulatedFormFactor: 'desktop',
           throttlingMethod: 'devtools',
         },

diff --git a/lighthouse-core/test/report/html/renderer/util-test.js b/lighthouse-core/test/report/html/renderer/util-test.js
@@ -94,8 +94,6 @@ describe('util helpers', () => {
 
   it('builds device emulation string', () => {
     const get = opts => Util.getEmulationDescriptions(opts).deviceEmulation;
-    assert.equal(get({disableDeviceEmulation: true}), 'No emulation');
-    assert.equal(get({disableDeviceEmulation: false}), 'No emulation');
     assert.equal(get({emulatedFormFactor: 'none'}), 'No emulation');
     assert.equal(get({emulatedFormFactor: 'mobile'}), 'Emulated Nexus 5X');
     assert.equal(get({emulatedFormFactor: 'desktop'}), 'Emulated Desktop');

diff --git a/lighthouse-core/test/results/artifacts/artifacts.json b/lighthouse-core/test/results/artifacts/artifacts.json
@@ -27,7 +27,6 @@
     "auditMode": false,
     "gatherMode": "lighthouse-core/test/results/artifacts",
     "disableStorageReset": false,
-    "disableDeviceEmulation": false,
     "emulatedFormFactor": "mobile",
     "channel": "cli",
     "locale": "en-US",

diff --git a/lighthouse-core/test/results/sample_v2.json b/lighthouse-core/test/results/sample_v2.json
@@ -2961,7 +2961,6 @@
     "auditMode": true,
     "gatherMode": false,
     "disableStorageReset": false,
-    "disableDeviceEmulation": false,
     "emulatedFormFactor": "mobile",
     "channel": "cli",
     "locale": "en-US",
@@ -5439,4 +5438,4 @@
     }
   },
   "stackPacks": []
-}
+}
diff --git a/lighthouse-core/test/runner-test.js b/lighthouse-core/test/runner-test.js
@@ -99,7 +99,7 @@ describe('Runner', () => {
     });
 
     it('-A throws if the settings change', async () => {
-      const settings = {auditMode: artifactsPath, disableDeviceEmulation: true};
+      const settings = {auditMode: artifactsPath, emulatedFormFactor: 'desktop'};
       const opts = {config: generateConfig(settings), driverMock};
       try {
         await Runner.run(null, opts);
@@ -110,7 +110,7 @@ describe('Runner', () => {
     });
 
     it('-A throws if the URL changes', async () => {
-      const settings = {auditMode: artifactsPath, disableDeviceEmulation: true};
+      const settings = {auditMode: artifactsPath, emulatedFormFactor: 'desktop'};
       const opts = {url: 'https://differenturl.com', config: generateConfig(settings), driverMock};
       try {
         await Runner.run(null, opts);

diff --git a/package.json b/package.json
@@ -45,7 +45,7 @@
     "devtools": "bash lighthouse-core/scripts/roll-to-devtools.sh",
     "compile-devtools": "bash lighthouse-core/scripts/compile-against-devtools.sh",
     "chrome": "node lighthouse-core/scripts/manual-chrome-launcher.js",
-    "fast": "yarn start --disable-device-emulation --throttlingMethod=provided",
+    "fast": "yarn start --emulated-form-factor=none --throttlingMethod=provided",
     "deploy-viewer": "yarn build-viewer --deploy",
     "bundlesize": "bundlesize",
     "timing-trace": "node lighthouse-core/scripts/generate-timing-trace.js",

diff --git a/readme.md b/readme.md
@@ -91,7 +91,6 @@ Options:
   --version                     Show version number                                                                                        [boolean]
   --blocked-url-patterns        Block any network requests to the specified URL patterns                                                     [array]
   --disable-storage-reset       Disable clearing the browser cache and other storage APIs before a run                                     [boolean]
-  --disable-device-emulation    Disable all device form factor emulation. Deprecated: use --emulated-form-factor=none instead              [boolean]
   --throttling-method                  Controls throttling method         [choices: "devtools", "provided", "simulate"]
   --throttling.rttMs                   Controls simulated network RTT (TCP layer)
   --throttling.throughputKbps          Controls simulated network download throughput
@@ -106,7 +105,7 @@ Examples:
   lighthouse <url> --config-path=./myconfig.js                              Runs Lighthouse with your own configuration: custom audits, report
                                                                             generation, etc.
   lighthouse <url> --output=json --output-path=./report.json --save-assets  Save trace, devtoolslog, and named JSON report.
-  lighthouse <url> --disable-device-emulation                               Disable device emulation and all throttling.
+  lighthouse <url> --emulated-form-factor=none                              Disable device emulation and all throttling.
     --throttling-method=provided
   lighthouse <url> --chrome-flags="--window-size=412,660"                   Launch Chrome with a specific window size
   lighthouse <url> --quiet --chrome-flags="--headless"                      Launch Headless Chrome, turn off logging

diff --git a/types/externs.d.ts b/types/externs.d.ts
@@ -101,8 +101,6 @@ declare global {
       gatherMode?: boolean | string;
       /** Flag indicating that the browser storage should not be reset for the audit. */
       disableStorageReset?: boolean;
-      /** Flag indicating that there shouldn't be any emulation during the run. */
-      disableDeviceEmulation?: boolean;
       /** The form factor the emulation should use. */
       emulatedFormFactor?: 'mobile'|'desktop'|'none';
       /** The method used to throttle the network. */