core: added capability to pass cookies as CLI parameter

lighthouse-cli/bin.js

@@ -122,6 +122,21 @@ async function begin() {
     cliFlags.extraHeaders = JSON.parse(extraHeadersStr);
   }
 
+  if (cliFlags.extraCookies) {
+    // TODO: LH.Flags.extraCookies is actually a string at this point, but needs to be
+    // copied over to LH.Settings.extraCookies, which is LH.Crdp.Network.Cookies. Force
+    // the conversion here, but long term either the CLI flag or the setting should have
+    // a different name.
+    // @ts-ignore
+    let extraCookiesStr = /** @type {string} */ (cliFlags.extraCookies);
+    // If not a JSON array, assume it's a path to a JSON file.
+    if (extraCookiesStr.substr(0, 1) !== '[') {
+      extraCookiesStr = fs.readFileSync(extraCookiesStr, 'utf-8');
+    }
+
+    cliFlags.extraCookies = JSON.parse(extraCookiesStr);
+  }
+
   if (cliFlags.precomputedLanternDataPath) {
     const lanternDataStr = fs.readFileSync(cliFlags.precomputedLanternDataPath, 'utf8');
     /** @type {LH.PrecomputedLanternData} */

lighthouse-cli/cli-flags.js

@@ -53,11 +53,17 @@ function getFlags(manualArgv) {
           'lighthouse <url> --quiet --chrome-flags="--headless"',
           'Launch Headless Chrome, turn off logging')
       .example(
-          'lighthouse <url> --extra-headers "{\\"Cookie\\":\\"monster=blue\\", \\"x-men\\":\\"wolverine\\"}"',
+          'lighthouse <url> --extra-headers "{\\"x-men\\":\\"wolverine\\"}"',
           'Stringify\'d JSON HTTP Header key/value pairs to send in requests')
       .example(
           'lighthouse <url> --extra-headers=./path/to/file.json',
           'Path to JSON file of HTTP Header key/value pairs to send in requests')
+      .example(
+          'lighthouse <url> --extra-cookies "[{\\"name\\":\\"session_id\\",\\"value\\":\\"x-men\\" }]"',
+          'Stringify\'d JSON array of HTTP Cookies to send in requests')
+      .example(
+          'lighthouse <url> --extra-cookies=./path/to/file.json',
+          'Path to JSON file of HTTP Cookies to send in requests')
       .example(
           'lighthouse <url> --only-categories=performance,pwa',
           'Only run specific categories.')
@@ -126,6 +132,7 @@ function getFlags(manualArgv) {
         'max-wait-for-load':
             'The timeout (in milliseconds) to wait before the page is considered done loading and the run should continue. WARNING: Very high values can lead to large traces and instability',
         'extra-headers': 'Set extra HTTP Headers to pass with request',
+        'extra-cookies': 'Set extra HTTP Cookies to pass with request',
         'precomputed-lantern-data-path': 'Path to the file where lantern simulation data should be read from, overwriting the lantern observed estimates for RTT and server latency.',
         'lantern-data-output-path': 'Path to the file where lantern simulation data should be written to, can be used in a future run with the `precomputed-lantern-data-path` flag.',
         'only-audits': 'Only run the specified audits',
@@ -166,6 +173,7 @@ function getFlags(manualArgv) {
       .array('output')
       .array('plugins')
       .string('extraHeaders')
+      .string('extraCookies')
       .string('channel')
       .string('precomputedLanternDataPath')
       .string('lanternDataOutputPath')

lighthouse-cli/test/cli/__snapshots__/index-test.js.snap

@@ -1371,6 +1371,7 @@ Object {
     "channel": "cli",
     "disableStorageReset": false,
     "emulatedFormFactor": "mobile",
+    "extraCookies": null,
     "extraHeaders": null,
     "gatherMode": false,
     "locale": "en-US",

lighthouse-cli/test/cli/bin-test.js

@@ -170,6 +170,26 @@ describe('CLI bin', function() {
     });
   });
 
+  describe('extraCookies', () => {
+    it('should convert extra cookies to object', async () => {
+      // @ts-ignore - see TODO: in bin.js
+      cliFlags = {...cliFlags, extraCookies: '[{"name":"foo", "value": "bar", "url": "http://localhost"}]'};
+      await bin.begin();
+
+      expect(getRunLighthouseArgs()[1]).toHaveProperty('extraCookies', [{'name': 'foo', 'value': 'bar', 'url': 'http://localhost'}]);
+    });
+
+    it('should read extra cookies from file', async () => {
+      const headersFile = require.resolve('../fixtures/extra-headers/valid.json');
+      // @ts-ignore - see TODO: in bin.js
+      cliFlags = {...cliFlags, extraCookies: headersFile};
+      await bin.begin();
+
+      expect(getRunLighthouseArgs()[1]).toHaveProperty('extraCookies', require(headersFile));
+    });
+  });
+
+
   describe('precomputedLanternData', () => {
     it('should read lantern data from file', async () => {
       const lanternDataFile = require.resolve('../fixtures/lantern-data.json');

lighthouse-cli/test/cli/index-test.js

@@ -59,6 +59,15 @@ describe('CLI Tests', function() {
       assert.equal(ret.status, 1);
     });
 
+    it('should exit with a error if the file does not contain valid JSON', () => {
+      const ret = spawnSync('node', [indexPath, 'https://www.google.com',
+        '--extra-cookies',
+        path.resolve(__dirname, '../fixtures/extra-cookies/invalid.txt')], {encoding: 'utf8'});
+
+      assert.ok(ret.stderr.includes('Unexpected token'));
+      assert.equal(ret.status, 1);
+    });
+
     it('should exit with a error if the passsed in string is not valid JSON', () => {
       const ret = spawnSync('node', [indexPath, 'https://www.google.com',
         '--extra-headers', '{notjson}'], {encoding: 'utf8'});

lighthouse-cli/test/fixtures/extra-cookies/invalid.txt

@@ -0,0 +1 @@
+NotJSON

lighthouse-cli/test/fixtures/extra-cookies/valid.json

@@ -0,0 +1,7 @@
+[
+   {
+      "name":"test",
+      "value":"true",
+      "url":"http://localhost"
+   }
+]

lighthouse-cli/test/fixtures/static-server.js

@@ -105,6 +105,20 @@ function requestHandler(request, response) {
         }
       }
 
+      if (params.has('extra_cookie')) {
+        const extraCookies = new URLSearchParams(params.get('extra_cookie'));
+        let cookeString = '';
+        for (const [cookieName, cookieValue] of extraCookies) {
+          cookeString += cookieName + '=' + cookieValue + ';';
+        }
+
+        // Extra cookie we allways override possible 'Set-Cookie' header
+        // which may be already present in request by extra_header
+        headers['Set-Cookie'] = [];
+        headers['Set-Cookie'].push(cookeString);
+      }
+
+
       if (params.has('gzip')) {
         useGzip = Boolean(params.get('gzip'));
       }

lighthouse-core/config/constants.js

@@ -60,6 +60,7 @@ const defaultSettings = {
   blockedUrlPatterns: null,
   additionalTraceCategories: null,
   extraHeaders: null,
+  extraCookies: null,
   precomputedLanternData: null,
   onlyAudits: null,
   onlyCategories: null,

lighthouse-core/gather/driver.js

@@ -1487,6 +1487,19 @@ class Driver {
     return this.sendCommand('Network.setExtraHTTPHeaders', {headers});
   }
 
+  /**
+   * @param {LH.Crdp.Network.Cookies|null} cookies key/value pairs of HTTP Cookies.
+   * @return {Promise<void>}
+   */
+  async setCookies(cookies) {
+    if (!cookies) {
+      return;
+    }
+
+    return this.sendCommand('Network.setCookies', {cookies});
+  }
+
+
   /**
    * @param {string} url
    * @return {Promise<void>}

lighthouse-core/gather/gather-runner.js

@@ -213,6 +213,7 @@ class GatherRunner {
     // neccessary at the beginning of the next pass.
     await passContext.driver.blockUrlPatterns(blockedUrls);
     await passContext.driver.setExtraHTTPHeaders(passContext.settings.extraHeaders);
+    await passContext.driver.setCookies(passContext.settings.extraCookies);
 
     log.timeEnd(status);
   }

lighthouse-core/test/gather/driver-test.js

@@ -412,14 +412,41 @@ describe('.setExtraHTTPHeaders', () => {
     );
   });
 
-  it('should Network.setExtraHTTPHeaders when there are extra-headers', async () => {
+  it('should not Network.setExtraHTTPHeaders when there are extra-headers', async () => {
     connectionStub.sendCommand = createMockSendCommandFn();
     await driver.setExtraHTTPHeaders();
 
     expect(connectionStub.sendCommand).not.toHaveBeenCalled();
   });
 });
 
+describe('.setCookies', () => {
+  it('should call Network.setCookies when there are extra-cookies', async () => {
+    connectionStub.sendCommand = createMockSendCommandFn().mockResponse(
+      'Network.setCookies',
+      {}
+    );
+
+    await driver.setCookies([{
+      'name': 'cookie1',
+      'value': 'monster',
+    }]);
+
+    expect(connectionStub.sendCommand).toHaveBeenCalledWith(
+      'Network.setCookies',
+      expect.anything()
+    );
+  });
+
+  it('should not call Network.setCookies when there are extra-headers', async () => {
+    connectionStub.sendCommand = createMockSendCommandFn();
+    await driver.setCookies();
+
+    expect(connectionStub.sendCommand).not.toHaveBeenCalled();
+  });
+});
+
+
 describe('.getAppManifest', () => {
   it('should return null when no manifest', async () => {
     connectionStub.sendCommand = createMockSendCommandFn().mockResponse(

lighthouse-core/test/gather/fake-driver.js

@@ -87,6 +87,9 @@ function makeFakeDriver({protocolGetVersionResponse}) {
     setExtraHTTPHeaders() {
       return Promise.resolve();
     },
+    setCookies() {
+      return Promise.resolve();
+    },
   };
 }
 

lighthouse-core/test/gather/gather-runner-test.js

@@ -40,7 +40,7 @@ const fakeDriver = require('./fake-driver.js');
 const fakeDriverUsingRealMobileDevice = fakeDriver.fakeDriverUsingRealMobileDevice;
 
 function getMockedEmulationDriver(emulationFn, netThrottleFn, cpuThrottleFn,
-  blockUrlFn, extraHeadersFn) {
+  blockUrlFn, extraHeadersFn, extraCookiesFn) {
   const Driver = require('../../gather/driver.js');
   const Connection = require('../../gather/connections/connection.js');
   const EmulationDriver = class extends Driver {
@@ -81,6 +81,9 @@ function getMockedEmulationDriver(emulationFn, netThrottleFn, cpuThrottleFn,
         case 'Network.setExtraHTTPHeaders':
           fn = extraHeadersFn;
           break;
+        case 'Network.setCookies':
+          fn = extraCookiesFn;
+          break;
         default:
           fn = null;
           break;
@@ -393,6 +396,7 @@ describe('GatherRunner', function() {
       setThrottling: asyncFunc,
       blockUrlPatterns: asyncFunc,
       setExtraHTTPHeaders: asyncFunc,
+      setCookies: asyncFunc,
       endTrace: asyncFunc,
       endDevtoolsLog: () => [],
       getBrowserVersion: async () => ({userAgent: ''}),
@@ -578,6 +582,28 @@ describe('GatherRunner', function() {
       ));
   });
 
+  it('tells the driver to set additional cookies when extraCookies flag is given', () => {
+    let receivedCookies = null;
+    const driver = getMockedEmulationDriver(null, null, null, null, null, params => {
+      receivedCookies = params.cookies;
+    });
+    const cookies = [{
+      'name': 'cookie1',
+      'value': 'monster',
+    }];
+
+    return GatherRunner.setupPassNetwork({
+      driver,
+      settings: {
+        extraCookies: cookies,
+      },
+      passConfig: {gatherers: []},
+    }).then(() => assert.deepStrictEqual(
+        receivedCookies,
+        cookies
+      ));
+  });
+
   it('tells the driver to begin tracing', async () => {
     let calledTrace = false;
     const driver = {

lighthouse-core/test/results/artifacts/artifacts.json

@@ -60,6 +60,7 @@
     "blockedUrlPatterns": null,
     "additionalTraceCategories": null,
     "extraHeaders": null,
+    "extraCookies": null,
     "precomputedLanternData": null,
     "onlyAudits": null,
     "onlyCategories": null,

lighthouse-core/test/results/sample_v2.json

@@ -3327,6 +3327,7 @@
     "blockedUrlPatterns": null,
     "additionalTraceCategories": null,
     "extraHeaders": null,
+    "extraCookies": null,
     "precomputedLanternData": null,
     "onlyAudits": null,
     "onlyCategories": null,

readme.md

@@ -101,18 +101,20 @@ Options:
   --throttling.uploadThroughputKbps    Controls emulated network upload throughput
   --throttling.cpuSlowdownMultiplier   Controls simulated + emulated CPU throttling
   --extra-headers               Set extra HTTP Headers to pass with request                                                                 [string]
+  --extra-cookies               Set extra HTTP Cookies to pass with request                                                                 [string]
 
 Examples:
-  lighthouse <url> --view                                                   Opens the HTML report in a browser after the run completes
-  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> --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
-  lighthouse <url> --extra-headers "{\"Cookie\":\"monster=blue\"}"          Stringify\'d JSON HTTP Header key/value pairs to send in requests
-  lighthouse <url> --extra-headers=./path/to/file.json                      Path to JSON file of HTTP Header key/value pairs to send in requests
+  lighthouse <url> --view                                                              Opens the HTML report in a browser after the run completes
+  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, screenshots, and named JSON report.
+  lighthouse <url> --emulated-form-factor=none --throttling-method=provided            Disable device emulation and all throttling
+  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
+  lighthouse <url> --extra-headers "{\"x-men\":\"wolverine\"}"                         Stringify'd JSON HTTP Header key/value pairs to send in requests
+  lighthouse <url> --extra-headers=./path/to/file.json                                 Path to JSON file of HTTP Header key/value pairs to send in requests
+  lighthouse <url> --extra-cookies "[{\"name\":\"session_id\",\"value\":\"x-men\" }]"  Stringify'd JSON array of HTTP Cookies to send in requests
+  lighthouse <url> --extra-cookies=./path/to/file.json                                 Path to JSON file of HTTP Cookies to send in requests
+  lighthouse <url> --only-categories=performance,pwa                                   Only run specific categories.
 
 For more information on Lighthouse, see https://developers.google.com/web/tools/lighthouse/.
 ```