sitespeed.io/lib/config.js

/**
 * Sitespeed.io - How speedy is your site? (https://www.sitespeed.io)
 * Copyright (c) 2014, Peter Hedenskog, Tobias Lidskog
 * and other contributors
 * Released under the Apache 2.0 License
 */
'use strict';
var urlParser = require('url'),
  defaultConfig = require('../conf/defaultConfig'),
  moment = require('moment'),
  fileHelper = require('./util/fileHelpers'),
  fs = require('fs-extra'),
  path = require('path');

exports.setupDefaultValues = function(config) {

  // to be able to run sitespeed.io you need a array of urls, a URL or a file
  if ((!config.url) && (!config.urls) && (!config.sites) && (!config.configFile)) {
    throw new Error('You must specify either a URL to test, an array with URL(s) or a configuration file');
  }

  // if we have default values not set in the config
  // add them from the default config
  Object.keys(defaultConfig).forEach(function(key) {
    if (!config.hasOwnProperty(key)) {
      config[key] = defaultConfig[key];
    }
  });

  // to make it easy later on, we add:
  // config.browertime = the browser(s) that will be run in browsertime (not phantomjs/slimerjs)
  // config.headlessTimings - boolean to run headless timings or not
  if (config.browser) {
    var b = config.browser.split(','),
      configuredBrowsers = b.filter(function(browser) {
        return defaultConfig.supportedBrowsers.indexOf(browser.toLowerCase()) > -1;
      });

    if (configuredBrowsers.indexOf('headless') > -1) {
      config.headlessTimings = true;
      if (configuredBrowsers.length > 1) {
        var i = configuredBrowsers.indexOf('headless');
        configuredBrowsers.splice(i, 1);
        config.browsertime = configuredBrowsers;
      }
    } else {
      config.browsertime = configuredBrowsers;
    }
  }

  // should we test YSlow rules, default is true
  config.runYslow = config.noYslow ? false : true;

  // Parse the proxy info as a real URL
  if (config.proxy) {
    config.urlProxyObject = urlParser.parse(config.proxy);
  }

  if (!config.connection) {
    config.connection = 'cable';
  }

  // decide which rules to use ...
  if (config.profile === 'mobile') {
    config.rules = require('../conf/mobileRules.json');
    config.ruleSet = 'sitespeed.io-mobile';
    config.userAgent =
      'Mozilla/5.0 (iPad; CPU OS 6_0 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10A5376e Safari/8536.25';
    config.viewPort = '320x444';
    config.connection = 'mobile3g';
  } else {
    // TODO this should be moved to the cli
    if (config.limitFile) {
      config.rules = fileHelper.getFileAsJSON(config.limitFile);
    } else {
      config.rules = require('../conf/desktopRules.json');
    }
    // The rest use the default/configured one, will that work? :)
  }

  if (config.runYslow) {
    config.summaryBoxes = ['ruleScore'];
    config.sitesColumns = ['requests', 'criticalPathScore', 'pageWeight', 'cacheTime',
      'ruleScore'
    ];
    config.pageColumns = ['yslow.assets.js', 'yslow.assets.css', 'yslow.assets.image', 'yslow.requests',
      'rules.expiresmod.items', 'yslow.pageWeight', 'rules.avoidscalingimages.items', 'rules.criticalpath'
    ];
  } else {
    config.summaryBoxes = [];
    config.sitesColumns = [];
    config.pageColumns = [];
  }

  if (config.gpsiKey) {
    config.summaryBoxes.push('scoreGPSI');
    config.sitesColumns.push('scoreGPSI');
    config.pageColumns.push('gpsi.gscore');

  }
  config.summaryBoxes.push('criticalPathScore', 'jsSyncInHead',
    'jsPerPage', 'cssPerPage', 'cssImagesPerPage', 'fontsPerPage',
    'imagesPerPage', 'requests', 'requestsWithoutExpires', 'requestsWithoutGzip',
    'docWeight', 'jsWeightPerPage', 'cssWeightPerPage', 'imageWeightPerPage',
    'pageWeight', 'browserScaledImages', 'spofPerPage', 'numberOfDomains',
    'singleDomainRequests', 'redirectsPerPage', 'cacheTime', 'timeSinceLastMod');

  if (config.wptHost) {
    config.summaryBoxes.push('firstViewTTFBWPT', 'firstViewSpeedIndexWPT',
      'repeatViewSpeedIndexWPT',
      'firstViewVisualCompleteWPT', 'repeatViewVisualCompleteWPT');
    config.sitesColumns.push('firstViewSpeedIndexWPT', 'repeatViewSpeedIndexWPT');
  }

  if (config.browsertime) {
    config.summaryBoxes.push('serverResponseTime', 'backEndTime', 'frontEndTime',
      'domContentLoadedTime', 'speedIndex',
      'pageLoadTime', 'firstPaint');
    config.sitesColumns.push('serverResponseTime', 'domContentLoadedTime');

      config.pageColumns.push('timings.serverResponseTime.median', 'timings.domContentLoadedTime.median');
  } // only show real browsers data if we configured both of them
  else if (config.headlessTimings) {
    config.summaryBoxes.push('domContentLoadedTimeHeadless', 'pageLoadTimeHeadless');
    config.sitesColumns.push('domContentLoadedTimeHeadless');
    config.pageColumns.push('headless.domContentLoadedTime.median');
  }

  // if we configure columns, lets override everything
  if (config.columns) {
    config.pageColumns = config.columns[0].split(',');
  }

  if (config.boxes) {
    if (config.boxes[0].indexOf('+') === 0) {
      config.boxes[0].split(',').forEach(function(box) {
        if (box.indexOf('+') === 0) {
          config.summaryBoxes.push(box.substring(1));
        } else {
          config.summaryBoxes.push(box);
        }
      });
    } else {
      config.summaryBoxes = config.boxes[0].split(',');
    }
  }

  config.dataDir = 'data';

  config.supportedBrowsers = defaultConfig.supportedBrowsers;

  if (config.depth) {
    config.deep = config.depth;
  }

  // If we supply a configuration file, then it will override all current conf, meaning
  // we can easily use the same conf over and over again
  if (config.configFile) {
    // keep track of new url:s
    var oldConfig = config;
    config = JSON.parse(fs.readFileSync(config.configFile));
    if (oldConfig.url) {
      config.url = oldConfig.url;
      config.urls = undefined;
      config.file = undefined;
    }
    else if (oldConfig.urls) {
      config.url = undefined;
      config.urls = oldConfig.urls;
      config.file = undefined;
    }
    else if (oldConfig.file) {
      config.url = undefined;
      config.urls = undefined;
      config.file = oldConfig.file;
    }
  }


  // The run always has a fresh date
  config.run = {};
  config.run.date = new Date();

  // Setup the absolute result dir
  var startPath = path.resolve(config.resultBaseDir);

  if (!config.outputFolderName) {
    config.startFolder = moment(config.run.date).format('YYYY-MM-DD-HH-mm-ss');
  } else {
    config.startFolder = config.outputFolderName;
  }

  if (config.url) {
    config.urlObject = urlParser.parse(config.url);
    if (config.suppressDomainFolder) {
      config.run.absResultDir = path.join(startPath, config.startFolder);
    }
    else {
      config.run.absResultDir = path.join(startPath, config.urlObject.hostname, config.startFolder);
    }
  } else if (config.urls) {
    // if we have a file, use that, else take the first domain name and create the dir
    if (config.file) {
      config.run.absResultDir = path.join(startPath, path.basename(config.file), config.startFolder);
    } else {
      if (config.suppressDomainFolder) {
        config.run.absResultDir = path.join(startPath, config.startFolder);
      }
      else {
      var firstUrl = urlParser.parse(config.urls[0]);
      config.run.absResultDir = path.join(startPath, firstUrl.hostname, config.startFolder);
      }
    }
  } else if (config.sites) {
    // The log file will end up here
    config.run.absResultDir = path.join(startPath, 'sites', config.startFolder);
  }

  return config;
};