lockerd.js

/*
*
* Copyright (C) 2011, The Locker Project
* All rights reserved.
*
* Please see the LICENSE file for more information.
*
*/

/* random notes:
on startup scan all folders
    Apps Collections Connectors - generate lists of "available"
    Me - generate lists of "existing"

when asked, run any existing and return localhost:port
if first time
    check dependencies
    create Me/ dir
    create me.json settings
    pick a port
*/
var conf = {};
conf._exit = false;
exports.alive = false;


var spawn = require('child_process').spawn;
var fs = require('fs');
var path = require('path');
var request = require('request');
var async = require('async');
var util = require('util');
var lutil = require('lutil');
var carrier = require('carrier');
require('graceful-fs');


// This lconfig stuff has to come before any other locker modules are loaded!!
var lconfig = require('lconfig');
lconfig.load((process.argv[2] == '--config'? process.argv[3] : 'Config/config.json'));

if(!path.existsSync(path.join(lconfig.lockerDir, 'Config', 'apikeys.json'))) {
    console.error('You must have an apikeys.json file in the Config directory. See the Config/apikeys.json.example file');
    process.exit(1);
}

fs.writeFileSync(__dirname + '/Logs/locker.pid', "" + process.pid);

var logger = require("logger");
logger.info('process id:' + process.pid);
var lscheduler = require("lscheduler");
var syncManager = require('lsyncmanager');
var serviceManager = require("lservicemanager");
var pushManager = require(__dirname + "/Common/node/lpushmanager");
var mongodb = require('mongodb');
var lcrypto = require("lcrypto");
var registry = require(__dirname + "/Ops/registry.js");
var lmongo = require('lmongo');

var buildInfo = fs.readFileSync(path.join(lconfig.lockerDir, 'build.json'));
logger.info("Starting locker with build info:" + buildInfo);

if(process.argv.indexOf("offline") >= 0) syncManager.setExecuteable(false);

if(lconfig.lockerHost != "localhost" && lconfig.lockerHost != "127.0.0.1") {
    logger.warn('if I\'m running on a public IP I needs to have password protection,' + // uniquely self (de?)referential? lolz!
                'which if so inclined can be hacked into lockerd.js and added since' +
                ' it\'s apparently still not implemented :)\n\n');
}
var shuttingDown_ = false;

var mongoProcess;
path.exists(lconfig.me + '/' + lconfig.mongo.dataDir, function(exists) {
    if(!exists) {
        try {
            //ensure there is a Me dir
            fs.mkdirSync(lconfig.me, 0755);
        } catch(err) {
            if(err.code !== 'EEXIST')
                logger.error('err: ' + util.inspect(err));
        }
        fs.mkdirSync(lconfig.me + '/' + lconfig.mongo.dataDir, 0755);
    }
    var mongoOptions = ['--dbpath',
      lconfig.lockerDir + '/' + lconfig.me + '/' + lconfig.mongo.dataDir,
      '--port', lconfig.mongo.port].concat(lconfig.mongo.options);

    mongoProcess = spawn('mongod', mongoOptions);

    var mongoStdout = carrier.carry(mongoProcess.stdout);
    var waitingForMongo = true;
    mongoStdout.on('line', function (line) {
        logger.info('[mongo] ' + line);
        if (waitingForMongo && line.indexOf("[initandlisten] waiting for connections on port " + lconfig.mongo.port) >= 0) {
          waitingForMongo = false;
          lmongo.connect(checkKeys);
        }
    });
    var mongoStderr = carrier.carry(mongoProcess.stderr);
    mongoStderr.on('line', function (line) {
        logger.error('[mongo] ' + line);
    });

    mongoProcess.on('exit', function(code, signal) {
        mongoProcess = null;
        if (shuttingDown_) {
            logger.info('mongod exited with code '+code+', signal '+signal);
        } else {
            logger.error('mongod exited unexpectedly with code '+code+', signal '+signal+', shutting down!');
            shutdown(1);
        }
    });
});


function checkKeys() {
    lcrypto.generateSymKey(function(hasKey) {
        if (!hasKey) {
            shutdown(1);
            return;
        }
        lcrypto.generatePKKeys(function(hasKeys) {
            if (!hasKeys) {
                shutdown(1);
                return;
            }
            runMigrations("preServices", finishStartup);
        });
    });
}

function finishStartup() {
    // get current git revision if git is available
    var gitHead = spawn('git', ['rev-parse', '--verify', 'HEAD']);
    gitHead.stdout.on('data', function(data) {
        fs.writeFileSync(path.join(lconfig.lockerDir, lconfig.me, 'gitrev.json'), JSON.stringify(data.toString()));
    });

    pushManager.init();

    // ordering sensitive, as synclet manager is inert during init, servicemanager's init will call into syncletmanager
    syncManager.init(serviceManager, function() {
        registry.init(serviceManager, syncManager, lconfig, lcrypto, function() {
            serviceManager.init(syncManager, registry, function() {  // this may trigger synclets to start!
                runMigrations("postServices", function() {
                    // start web server (so we can all start talking)
                    var webservice = require(__dirname + "/Ops/webservice.js");
                    webservice.startService(lconfig.lockerPort, lconfig.lockerListenIP, function(locker) {
                        if (lconfig.airbrakeKey) locker.initAirbrake(lconfig.airbrakeKey);
                        registry.app(locker); // add it's endpoints
                        postStartup();
                    });
                });
            });
        });
    });
    var lockerPortNext = "1"+lconfig.lockerPort;
    lockerPortNext++;
}

var origVer;
function runMigrations(phase, migrationCB) {
    var migrations = [];
    var metaData = {version: 0};
    try {
        migrations = fs.readdirSync(path.join(lconfig.lockerDir, "/migrations"));
        metaData = JSON.parse(fs.readFileSync(path.join(lconfig.lockerDir, lconfig.me, "state.json")));
    } catch (E) {}
    if(!origVer) origVer = metaData.version; // persist this across phases on startup

    if (migrations.length > 0) migrations = migrations.sort(); // do in order, so versions are saved properly

    if (!metaData.version && phase == "preServices") {
        metaData.version = Number(migrations[migrations.length - 1].substring(0, 13));
        lutil.atomicWriteFileSync(path.join(lconfig.lockerDir, lconfig.me, "state.json"), JSON.stringify(metaData, null, 4));
        return migrationCB();
    }

    async.forEachSeries(migrations, function(migration, cb) {
        if (Number(migration.substring(0, 13)) <= origVer) return cb();

        try {
            migrate = require(path.join(lconfig.lockerDir, "migrations", migration))[phase];
            if(typeof migrate !== 'function') return cb();
            logger.info("running global migration : " + migration + ' for phase ' + phase);
            migrate(lconfig, function(ret) {
                if (!ret) {
                    logger.error("failed to run global migration!");
                    return shutdown(1);
                }
                metaData.version = Number(migration.substring(0, 13));
                lutil.atomicWriteFileSync(path.join(lconfig.lockerDir, lconfig.me, "state.json"), JSON.stringify(metaData, null, 4));
                logger.info("Migration complete for: " + migration);
                cb();

                /*
                // XXX: These are synchronous only right now, until we can find a less destructive way to do post startup
                // if they returned a string, it's a post-startup callback!
                if (typeof ret == 'string')
                {
                    serviceMap.migrations.push(lconfig.lockerBase+"/Me/"+metaData.id+"/"+ret);
                }
                */
            });
        } catch (E) {
            // TODO: do we need to exit here?!?
            logger.error("error running global migration : " + migration + " ---- " + E);
            shutdown(1);
        }
    }, migrationCB);
}

// scheduling and misc things
function postStartup() {
    lscheduler.masterScheduler.loadAndStart();
    logger.info('locker is up and running at ' + lconfig.lockerBase);
    exports.alive = true;
    runMigrations("postStartup", function() {});
}

function shutdown(returnCode) {
    if (shuttingDown_) {
        try {
            console.error("Aieee, shutdown called while already shutting down!  Aborting!");
        } catch (e) {
            // we tried...
        }
        process.exit(1);
    }
    shuttingDown_ = true;
    process.stdout.write("\n");
    logger.info("Shutting down...");
    serviceManager.shutdown(function() {
        cleanupMongo(function() {
            exit(returnCode);
        });
    });
}

function cleanupMongo(cb) {
    if (!mongoProcess) {
        cb();
        return;
    }

    var gaveUp = false; // make sure we only call the callback once
    mongoProcess.on('exit', function (code, signal) { if (!gaveUp) { cb(); } });

    mongoProcess.kill();

    var timeout = 5000;
    setTimeout(function() {
        gaveUp = true;
        logger.error('Mongo did not exit after timeout ('+timeout+'ms), giving up');
        cb();
    }, timeout);
}

function exit(returnCode) {
    logger.info("Shutdown complete", {}, function (err, level, msg, meta) {
        process.exit(returnCode);
    });
}

process.on("SIGINT", function() {
    shutdown(0);
});

process.on("SIGTERM", function() {
    shutdown(0);
});

process.on('uncaughtException', function(err) {
    try {
        logger.error('Uncaught exception:');
        logger.error(util.inspect(err));
        if(err && err.stack) logger.error(util.inspect(err.stack));
        if (lconfig.airbrakeKey) {
            var airbrake = require('airbrake').createClient(lconfig.airbrakeKey);
            airbrake.notify(err, function(err, url) {
                if(url) logger.error(url);
                shutdown(1);
            });
        }else{
            shutdown(1);
        }
    } catch (e) {
        try {
            console.error("Caught an exception while handling an uncaught exception!");
            console.error(e);
        } catch (e) {
            // we tried...
        }
        process.exit(1);
    }
});

// Export some things so this can be used by other processes, mainly for the test runner
exports.shutdown = shutdown;