bin.js

/**
 * @license Copyright 2016 Google Inc. All Rights Reserved.
 * 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 fs = require('fs');
const path = require('path');

const commands = require('./commands/commands.js');
const printer = require('./printer.js');
const getFlags = require('./cli-flags.js').getFlags;
const runLighthouse = require('./run').runLighthouse;

const log = require('lighthouse-logger');
// @ts-ignore
const perfOnlyConfig = require('../lighthouse-core/config/perf.json');
// @ts-ignore
const pkg = require('../package.json');
const Sentry = require('../lighthouse-core/lib/sentry');

const updateNotifier = require('update-notifier');
const askPermission = require('./sentry-prompt').askPermission;

/**
 * @return {boolean}
 */
function isDev() {
  return fs.existsSync(path.join(__dirname, '../.git'));
}

// Tell user if there's a newer version of LH.
updateNotifier({pkg}).notify();

const /** @type {!LH.Flags} */ cliFlags = getFlags();

// Process terminating command
if (cliFlags.listAllAudits) {
  commands.listAudits();
}

// Process terminating command
if (cliFlags.listTraceCategories) {
  commands.listTraceCategories();
}

/** @type {string} */
const url = cliFlags._[0];

/** @type {!LH.Config|undefined} */
let config;
if (cliFlags.configPath) {
  // Resolve the config file path relative to where cli was called.
  cliFlags.configPath = path.resolve(process.cwd(), cliFlags.configPath);
  config = /** @type {!LH.Config} */ (require(cliFlags.configPath));
} else if (cliFlags.perf) {
  config = /** @type {!LH.Config} */ (perfOnlyConfig);
}

// set logging preferences
cliFlags.logLevel = 'info';
if (cliFlags.verbose) {
  cliFlags.logLevel = 'verbose';
} else if (cliFlags.quiet) {
  cliFlags.logLevel = 'silent';
}
log.setLevel(cliFlags.logLevel);

if (cliFlags.output === printer.OutputMode.json && !cliFlags.outputPath) {
  cliFlags.outputPath = 'stdout';
}

if (cliFlags.extraHeaders) {
  if (cliFlags.extraHeaders.substr(0, 1) !== '{') {
    cliFlags.extraHeaders = fs.readFileSync(cliFlags.extraHeaders, 'utf-8');
  }

  cliFlags.extraHeaders = JSON.parse(cliFlags.extraHeaders);
}

/**
 * @return {!Promise<(void|!LH.Results)>}
 */
function run() {
  return Promise.resolve()
    .then(_ => {
      if (typeof cliFlags.enableErrorReporting === 'undefined') {
        return askPermission().then(answer => {
          cliFlags.enableErrorReporting = answer;
        });
      }
    })
    .then(_ => {
      Sentry.init({
        url,
        flags: cliFlags,
        environmentData: {
          name: 'redacted', // prevent sentry from using hostname
          environment: isDev() ? 'development' : 'production',
          release: pkg.version,
          tags: {
            channel: 'cli',
          },
        },
      });

      return runLighthouse(url, cliFlags, config);
    });
}

module.exports = {
  run,
};