jspm/lib/config/global-config.js

/*
 *   Copyright 2014-2016 Guy Bedford (http://guybedford.com)
 *
 *   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.
 */

var ui = require('../ui');
var fs = require('graceful-fs');
var mkdirp = require('mkdirp');
var path = require('path');
var lockFile = require('proper-lockfile');
var dprepend = require('../common').dprepend;
var readJSONSync = require('../common').readJSONSync;
var stringify = require('../common').stringify;
var HOME = require('../common').HOME;
var dprepend = require('../common').dprepend;

function GlobalConfigFile(homePath) {
  this.globalConfigFile = homePath + path.sep + '.jspm' + path.sep + 'config';
  this.config = null;
  // global config - automatically created and loaded on startup
  this.registries = [];

  // old windows HOME migration
  // can deprecate with jspm 0.15.3
  if (process.env.USERPROFILE && HOME !== process.env.USERPROFILE && !fs.existsSync(path.join(HOME, '.jspm')) && fs.existsSync(path.join(process.env.USERPROFILE, '.jspm'))) {
    var OLD_HOME = process.env.USERPROFILE;
    var from = path.join(OLD_HOME, '.jspm');
    var to = path.join(HOME, '.jspm');
    ui.log('info', 'Migrating global jspm folder from `' + from + '` to `' + to + '`...');
    try {
      ui.log('info', 'Copying configuration...');
      var oldConfig = fs.readFileSync(path.resolve(from, 'config'));
      mkdirp.sync(to);
      fs.writeFileSync(path.resolve(to, 'config'), oldConfig);
      ui.log('ok', 'Migration successful. Note that linked packages will need to be relinked.');
    }
    catch (e) {
      ui.log('err', 'Error migrating to new jspm folder\n' + (e && e.stack || e));
    }
  }

  // Begin file lock
  this.lock();

  // after loading, we'll dprepend all defaults to `this.config` in this `try` block
  this.config = readJSONSync(this.globalConfigFile);

  // NB can deprecate with jspm 0.14
  if (!this.config.defaultRegistry && this.config.registry)
    this.config.defaultRegistry = this.config.registry;
  if (!this.config.registries && this.config.endpoints)
    this.config.registries = this.config.endpoints;

  // NB add this to deprecate 0.14
  // delete this.config.registry;
  // delete this.config.endpoints;

  // config upgrade paths
  // NB can deprecate with jspm < 10
  if (this.config.github) {
    dprepend(this.config.registries.github, this.config.github);
    delete this.config.github;
  }

  // populate default registry configuration
  dprepend(this.config, {
    defaultRegistry: 'jspm',
    strictSSL: true,
    registries: {
      github: {
        handler: 'jspm-github',
        remote: 'https://github.jspm.io'
      },
      npm: {
        handler: 'jspm-npm',
        remote: 'https://npm.jspm.io'
      },
      jspm: {
        handler: 'jspm-registry',
        remote: 'https://registry.jspm.io'
      }
    }
  });

  this.save();
  // end file lock
  this.unlock();
}

GlobalConfigFile.prototype.constructor = GlobalConfigFile;

GlobalConfigFile.prototype.save = function() {
  try {
    mkdirp.sync(path.dirname(this.globalConfigFile));
  }
  catch (e) {
    if (e.code !== 'EEXIST')
      throw 'Unable to create jspm system folder\n' + e.stack;
  }
  try {
    this.lock();
    var existing = readJSONSync(this.globalConfigFile);
    // only write to a new file if the local changes are different
    if (JSON.stringify(existing) != JSON.stringify(this.config)) {
      fs.writeFileSync(this.globalConfigFile, stringify(this.config));
    }
  }
  catch (e) {
    ui.log('err', 'Unable to write global configuration file\n' + e.stack);
  }
  finally {
    this.unlock();
  }
};

GlobalConfigFile.prototype.set = function(name, val) {
  var nameParts = name.split('.');

  var config = this.config;
  var part;
  while (nameParts.length > 1) {
    part = nameParts.shift();
    config[part] = typeof config[part] === 'object' ? config[part] : {};
    config = config[part];
  }
  if (val !== undefined) {
    config[nameParts[0]] = val;
  }
  else {
    // If no value is specified, then remove property from config
    delete config[nameParts[0]];
  }

  this.save();
};

GlobalConfigFile.prototype.lock = function() {
  if (!this._unlock) {
    try {
      this._unlock = lockFile.lockSync(this.globalConfigFile, {
        retries: {
          retries: 10,
          minTimeout: 20,
          maxTimeout: 300,
          randomize: true
        },
        realpath: false
      });
    } catch (e) {
      if (e.code === 'ELOCKED')
        throw 'Unable to lock global config file %' + this.globalConfigFile + '%, not overwriting';
    }
  }
};
GlobalConfigFile.prototype.unlock = function() {
  if (this._unlock) {
    this._unlock();
    this._unlock = undefined;
  }
};

// Map SIGINT & SIGTERM to process exit
// so that lockfile removes the lockfile automatically
process
.once('SIGINT', function () {
  process.exit(1);
})
.once('SIGTERM', function () {
  process.exit(1);
});

module.exports = new GlobalConfigFile(HOME);