index.js

#!/usr/bin/env node

//
// A utility for saving shrinkwrapped npm packages away and installing them
// later.
//

// TODO: Show a warning if no '_resolved' is present due to npm bug
//       (https://github.com/npm/npm/issues/3581).

var fs = require('fs'),
    path = require('path'),
    async = require('async'),
    http = require('http'),
    ecstatic = require('ecstatic'),
    httpRequest = require('http-request'),
    traverse = require('traverse'),
    mkdirp = require('mkdirp'),
    portfinder = require('portfinder'),
    glob = require('glob'),
    spawn = require('child_process').spawn,
    chalk = require('chalk');

var optimist = require('optimist')
      .alias('s', 'store')
      .alias('p', 'port')
      .alias('a', 'address')
      .alias('h', 'help')
    argv = optimist.argv;

var findRootPath = function() {
  var cwd = path.resolve('.'),
      parts = cwd.split(/\//);

  for (var end = parts.length; end > 0; end -= 1) {
    var packageFile = parts.slice(0, end).concat('package.json').join(path.sep);
    if (fs.existsSync(packageFile)) {
        return path.dirname(packageFile);
    }
  }
};

// Like path.join, but ignores the first path if the second is absolute.
var pathJoin = function(p1, p2) {
  if (p2.length > 0 && p2[0] == path.sep)
    return p2;
  else
    return path.join(p1, p2);
};

var rootPath = findRootPath(),
    inRoot = function(p) { return pathJoin(rootPath, p); };

var getStorePath = function() {
  if (!rootPath) {
    console.error("Unable to find 'package.json'.  Are you in the right directory?");
    process.exit(1);
  }

  var packageJson = JSON.parse(fs.readFileSync(inRoot('package.json')));
  return argv.store || inRoot((packageJson.shrinkwrapper || {}).store || './packages');
};

var urlBasename = function(url) {
  return path.basename(require('url').parse(url).path);
};

var download = function(url, dest, next) {
  next = next || function() {};
  var filename = urlBasename(url);
  if (filename == '') return;
  filename = path.join(dest, filename);
  fs.exists(filename, function(exists) {
    if (exists) {
      next(null);
      return;
    } else {
      console.log(chalk.green('http'), chalk.magenta('GET'), url);
      httpRequest.get(url, filename, function(err, res) {
        if (err) {
          console.error(err);
          next(err);
          return;
        }
        console.log(chalk.green('http'), chalk.magenta(res.code), url);
        next(null);
      });
    }
  });
};

var getBackupFilename = function(filename) {
  return path.join(path.dirname(filename), '.' + path.basename(filename) + '.bak');
};

// Asynchronously applies a mapping function to values of the given field in
// the identified JSON file.  Makes a backup copy of the file first.
var mapFile = function(filename, field, fn, next) {
  var backupFilename = getBackupFilename(filename);
  fs.rename(filename, backupFilename, function(err) {
    if (err) return next(err);

    fs.readFile(backupFilename, function(err, data) {
      if (err) return next(err);

      var data = JSON.parse(data);
      traverse(data).forEach(function() {
        if (this.key == field) {
          this.update(fn(this.node));
        }
      });
      fs.writeFile(filename, JSON.stringify(data, null, 2), next);
    });
  });
};

// Asynchronously restores the mapped file from the backup copy.
var unmapFile = function(filename, next) {
  var backupFilename = getBackupFilename(filename);
  fs.rename(backupFilename, filename, next);
};

//
// Shrinkwrap command
//
var shrinkwrap = function() {
  var storePath = getStorePath();

  spawn('npm', ['shrinkwrap'], { stdio: 'inherit' }).
    on('close', function(code) {
      if (code != 0) {
        process.exit(code);
      }

      var tasks = {};
      traverse(JSON.parse(fs.readFileSync(inRoot('npm-shrinkwrap.json')))).
        forEach(function() {
          if (this.node['resolved']) {
            var url = this.node['resolved'];
            tasks[url] = tasks[url] || function(next) { download(url, storePath, next); };
          }
        });

      console.log("Downloading to package store", chalk.magenta(storePath));
      mkdirp.sync(storePath);

      async.parallelLimit(tasks, 10, function(err) {
        if (err) {
          console.error(err);
          process.exit(1);
        }
      });
    });
};

//
// Install command
//
var install = function() {
  var storePath = getStorePath();

  // Complain if we don't have a shrinkwrap file
  if (!fs.existsSync(inRoot('npm-shrinkwrap.json'))) {
    console.log("Missing 'npm-shrinkwrap.json'.  Run " + chalk.yellow(argv.$0 + ' shrinkwrap'));
    process.exit(1);
  }

  var basePort = argv.port    || '8080',
      host     = argv.address || 'localhost';

  portfinder.basePort = parseInt(basePort, 10);
  portfinder.getPort(function (err, port) {
    if (err) throw err;

    console.log(
      "Installing from package store", chalk.magenta(storePath),
      "as", chalk.green(host+':'+port)
    );

    var server = http.createServer(ecstatic(storePath));
    server.listen(port, host, function() {

      // Redirect resolved references from the default npm registry to
      // localhost in npm-shrinkwrap.json and all top-level package.json files

      var mapUrl = function(url) {
        return url.indexOf('https://registry.npmjs.org/') == 0 ?
          'http://' + host + ':' + port + '/' + urlBasename(url) :
          url;
      };

      var files = glob.sync(inRoot('node_modules/*/package.json'));
      files.unshift(inRoot('npm-shrinkwrap.json'));

      async.each(files, function(file, next) {
          mapFile(file,
            path.basename(file) == 'package.json' ? '_resolved' : 'resolved',
            mapUrl, next
          );
        }, function(err) {

          var restore = function(code) {
            // Restore the mapped files
            async.each(files, unmapFile, function() {
              process.exit(code);
            });
          };

          if (err) {
            console.error(err);
            restore(1);
          }

          process.on('SIGINT', function () { restore(1); });

          // Install package files from the vault
          spawn('npm', ['install'], { stdio: 'inherit' }).
            on('close', function(code) {
              server.close();
              restore(code);
            });
        }
      );
    });
  });
};

//
// Usage (help)
//
var usage = function() {
  console.log([
    'Usage: ' + argv.$0 + ' <command> <options>',
    '',
    '  Save shrinkwrapped npm packages away and install them later.',
    '',
    'Commands:',
    '',
    '  shrinkwrap (default)   run ' + chalk.yellow('npm shrinkwrap') + ' and download required packages',
    '  install                run ' + chalk.yellow('npm install') + ' using previously saved packages',
    '',
    'Options:',
    '',
    '  -s, --store            set directory for saved packages (overrides setting in package.json)',
    '  -h, --help             show usage information',
    ''
  ].join('\n'));
};

var command = argv._.join();

if      (argv.help)                                usage();
else if (command == '' || command == 'shrinkwrap') shrinkwrap();
else if (command == 'install')                     install();
else                                               usage();