Extract chrome-launcher to a standalone thing. (#2245)

* Also extract default flags to standalone entity.

.eslintignore

@@ -17,6 +17,9 @@ coverage/**
 lighthouse-cli/*.js
 lighthouse-cli/commands/*.js
 lighthouse-cli/types/*.js
+!chrome-launcher/manual-chrome-launcher.js
+!chrome-launcher/compiled-check.js
+chrome-launcher/*.js
 
 # Handlebar-templates
 lighthouse-core/report/templates/report-templates.js

.gitignore

@@ -29,6 +29,11 @@ closure-error.log
 lighthouse-cli/*.map
 lighthouse-cli/*.js
 
+!chrome-launcher/manual-chrome-launcher.js
+!chrome-launcher/compiled-check.js
+chrome-launcher/*.map
+chrome-launcher/*.js
+
 lighthouse-cli/commands/*.map
 lighthouse-cli/commands/*.js
 

.travis.yml

@@ -30,7 +30,8 @@ before_script:
   - ./lighthouse-core/scripts/download-chrome.sh
   - yarn build-all
 script:
-  - yarn test-formatting
+  - yarn test-cli-formatting
+  - yarn test-launcher-formatting
   - yarn lint
   - yarn unit
   - yarn closure

chrome-launcher/.clang-format

@@ -0,0 +1,6 @@
+---
+BasedOnStyle: Google
+Language: JavaScript
+ColumnLimit: 100
+ReflowComments: false
+SpacesBeforeTrailingComments: 1

lighthouse-cli/chrome-launcher.ts → chrome-launcher/chrome-launcher.ts

@@ -22,6 +22,7 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as chromeFinder from './chrome-finder';
 import {ask} from './ask';
+import {DEFAULT_FLAGS} from './flags';
 
 const mkdirp = require('mkdirp');
 import * as net from 'net';
@@ -57,29 +58,12 @@ export class ChromeLauncher {
     this.port = defaults(opts.port, 9222);
   }
 
-  flags() {
-    const flags = [
+  get flags() {
+    const flags = DEFAULT_FLAGS.concat([
       `--remote-debugging-port=${this.port}`,
-      // Disable built-in Google Translate service
-      '--disable-translate',
-      // Disable all chrome extensions entirely
-      '--disable-extensions',
-      // Disable various background network services, including extension updating,
-      //   safe browsing service, upgrade detector, translate, UMA
-      '--disable-background-networking',
-      // Disable fetching safebrowsing lists, likely redundant due to disable-background-networking
-      '--safebrowsing-disable-auto-update',
-      // Disable syncing to a Google account
-      '--disable-sync',
-      // Disable reporting to UMA, but allows for collection
-      '--metrics-recording-only',
-      // Disable installation of default apps on first run
-      '--disable-default-apps',
-      // Skip first run wizards
-      '--no-first-run',
       // Place Chrome profile in a custom location we'll rm -rf later
       `--user-data-dir=${this.TMP_PROFILE_DIR}`
-    ];
+    ]);
 
     if (process.platform === 'linux') {
       flags.push('--disable-setuid-sandbox');
@@ -146,7 +130,7 @@ export class ChromeLauncher {
       }
 
       const chrome = spawn(
-          execPath, this.flags(), {detached: true, stdio: ['ignore', this.outFile, this.errFile]});
+          execPath, this.flags, {detached: true, stdio: ['ignore', this.outFile, this.errFile]});
       this.chrome = chrome;
 
       fs.writeFileSync(this.pidFile, chrome.pid.toString());

chrome-launcher/compiled-check.js

@@ -0,0 +1,14 @@
+'use strict'
+
+const fs = require('fs');
+const path = require('path');
+
+module.exports = function(filename) {
+  if (!fs.existsSync(path.join(__dirname, filename))) {
+    console.log(
+        'Oops! Looks like the chrome-launcher files needs to be compiled. Please run:');
+    console.log('   yarn install; yarn build;');
+    console.log('More at: https://github.com/GoogleChrome/lighthouse#develop');
+    process.exit(1);
+  }
+}

chrome-launcher/flags.ts

@@ -0,0 +1,19 @@
+export const DEFAULT_FLAGS = [
+  // Disable built-in Google Translate service
+  '--disable-translate',
+  // Disable all chrome extensions entirely
+  '--disable-extensions',
+  // Disable various background network services, including extension updating,
+  //   safe browsing service, upgrade detector, translate, UMA
+  '--disable-background-networking',
+  // Disable fetching safebrowsing lists, likely redundant due to disable-background-networking
+  '--safebrowsing-disable-auto-update',
+  // Disable syncing to a Google account
+  '--disable-sync',
+  // Disable reporting to UMA, but allows for collection
+  '--metrics-recording-only',
+  // Disable installation of default apps on first run
+  '--disable-default-apps',
+  // Skip first run wizards
+  '--no-first-run',
+];

lighthouse-cli/manual-chrome-launcher.js → chrome-launcher/manual-chrome-launcher.js

@@ -30,4 +30,3 @@ const chromeInstance = new ChromeLauncher({
 
 chromeInstance.prepare();
 chromeInstance.run();
-

chrome-launcher/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "chrome-launcher",
+  "private": true,
+  "main": "chrome-launcher.js",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w",
+    "test": "mocha --reporter dot test/**/*-test.js",
+    "test-formatting": "test/check-formatting.sh",
+    "format": "clang-format -i -style=file *.ts"
+  },
+  "devDependencies": {
+    "mocha": "^3.2.0",
+    "typescript": "2.2.1",
+    "clang-format": "^1.0.50"
+  },
+  "dependencies": {
+    "@types/node": "6.0.66"
+  }
+}

chrome-launcher/test/check-formatting.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+check_formatting ()
+{
+  diff -u <(cat $1) <(./node_modules/.bin/clang-format -style=file $1) &>/dev/null
+  if [ $? -eq 1 ]
+  then
+    echo "Error: formatting is required for *.ts files:"
+    echo "    cd chrome-launcher"
+    echo "    yarn format"
+    exit 1
+  fi
+}
+
+check_formatting "*.ts"

lighthouse-cli/test/cli/chrome-launcher-test.js → chrome-launcher/test/chrome-launcher-test.js

@@ -16,10 +16,10 @@
 
 'use strict';
 
-require('../../compiled-check.js')('chrome-launcher.js');
+require('../compiled-check.js')('chrome-launcher.js');
 
-const ChromeLauncher = require('../../chrome-launcher.js').ChromeLauncher;
-const log = require('../../../lighthouse-core/lib/log');
+const ChromeLauncher = require('../chrome-launcher.js').ChromeLauncher;
+const log = require('../../lighthouse-core/lib/log');
 const assert = require('assert');
 
 /* eslint-env mocha */
@@ -28,29 +28,25 @@ describe('ChromeLauncher', () => {
   it('doesn\'t fail when killed twice', () => {
     log.setLevel('error');
     const chromeInstance = new ChromeLauncher();
-    return chromeInstance.run()
-      .then(() => {
-        log.setLevel();
-        return Promise.all([
-          chromeInstance.kill(),
-          chromeInstance.kill()
-        ]);
-      });
+    return chromeInstance.run().then(() => {
+      log.setLevel();
+      return Promise.all([chromeInstance.kill(), chromeInstance.kill()]);
+    });
   });
 
   it('doesn\'t launch multiple chrome processes', () => {
     log.setLevel('error');
     const chromeInstance = new ChromeLauncher();
     let pid;
     return chromeInstance.run()
-      .then(() => {
-        pid = chromeInstance.chrome.pid;
-        return chromeInstance.run();
-      })
-      .then(() => {
-        log.setLevel();
-        assert.strictEqual(pid, chromeInstance.chrome.pid);
-        return chromeInstance.kill();
-      });
+        .then(() => {
+          pid = chromeInstance.chrome.pid;
+          return chromeInstance.run();
+        })
+        .then(() => {
+          log.setLevel();
+          assert.strictEqual(pid, chromeInstance.chrome.pid);
+          return chromeInstance.kill();
+        });
   });
 });

chrome-launcher/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "target": "es6",
+        "noImplicitAny": true,
+        "inlineSourceMap": true,
+        "noEmitOnError": false,
+        "strictNullChecks": true,
+        "noImplicitReturns": true,
+        "noUnusedLocals": true,
+        "noUnusedParameters": true
+    },
+    "exclude": [
+        "node_modules"
+    ],
+    "include": [
+        "*.ts"
+    ]
+}