server.js

#!/bin/env node
/**
 * Tech-radar Application
 */

// Setup the console logging format
require('console-stamp')(console, '[ddd mmm dd HH:MM:ss]]');

// Load in the environment variables
require('dotenv').config({path: 'process.env'});

// Express
var express = require('express');
var helmet = require('helmet');
var express_enforces_ssl = require('express-enforces-ssl');
var helpers = require('express-helpers')();
var expressValidator = require('express-validator');
var flash = require('connect-flash');
var session = require('express-session');
var bodyParser = require('body-parser');

// Caching to remove some frequent db operations
var cache = require('./dao/cache.js');

// Authentication
var users = require('./dao/users');
var passport = require('passport');
require('./utils/passport.js');


// Load the routes for the web Application and API REST services
var routes = require('./routes/web/routes.js');
var technologyRoutes = require('./routes/web/technology-routes');
var stackRoutes = require('./routes/web/stack-routes');
var categoryRoutes = require('./routes/web/category-routes');
var projectRoutes = require('./routes/web/project-routes');
var userRoutes = require('./routes/web/user-routes');
var commentRoutes = require('./routes/web/comment-routes');

// Load the API routes
var apiStack = require('./routes/api/api-stacks-routes.js');
var apiTechnologies = require('./routes/api/api-technology-routes.js');
var apiSoftwareVersions = require('./routes/api/api-software-versions-routes.js');
var apiUsers = require('./routes/api/api-users-routes.js');
var apiComments = require('./routes/api/api-comments-routes.js');
var apiProjects = require('./routes/api/api-projects-routes.js');
var apiCategories = require('./routes/api/api-categories-routes.js');
var apiDashboard = require('./routes/api/api-dashboard-routes.js');


/**
 *  Define the application.
 */
var TechRadar = function () {

    //  Scope.
    var self = this;
    
    /**
     *  Set up server IP address and port # using env variables/defaults.
     */
    self.setupVariables = function () {
        //  Set the environment variables we need.
        self.port = process.env.PORT || 8090;
    };


    /**
     *  terminator === the termination handler
     *  Terminate server on receipt of the specified signal.
     *  @param {string} sig  Signal to terminate on.
     */
    self.terminator = function (sig) {
        if (typeof sig === "string") {
            console.log('%s: Received %s - terminating Tech Radar ...',
                Date(Date.now()), sig);
            process.exit(1);
        }
        console.log('%s: Node server stopped.', Date(Date.now()));
    };


    /**
     *  Setup termination handlers (for exit and a list of signals).
     */
    self.setupTerminationHandlers = function () {
        //  Process on exit and signals.
        process.on('exit', function () {
            self.terminator();
        });

        // Removed 'SIGPIPE' from the list - bugz 852598.
        ['SIGHUP', 'SIGINT', 'SIGQUIT', 'SIGILL', 'SIGTRAP', 'SIGABRT',
            'SIGBUS', 'SIGFPE', 'SIGUSR1', 'SIGSEGV', 'SIGUSR2', 'SIGTERM'
        ].forEach(function (element, index, array) {
            process.on(element, function () {
                self.terminator(element);
            });
        });
    };



    /**
     *  Initialize the server (express) and create the routes and register
     *  the handlers.
     */
    self.initialize = function () {
        self.setupVariables();
        self.setupTerminationHandlers();

        self.app = express();

        self.app.set('view engine', 'ejs');

        // Define helper functions
        self.app.locals.link_to = helpers.link_to;

        /*
        * Uses 7 out of 10 helmet middleware functions,
        * leaving out contentSecurityPolicy, hpkp, and noCache
        */
        self.app.use(helmet()); 

        self.app.use(bodyParser.json());
        self.app.use(bodyParser.urlencoded({
            extended: true
        }));

        self.app.use(expressValidator());
        self.app.use(flash());

        self.app.use(function(err, req, res, next) {
            console.error(err.stack);
            res.status(500).send('A Fatal error has occurred');
        });

        // Setup the secret cookie key
        var cookie_key = process.env.COOKIE_KEY || 'aninsecurecookiekey';
        var sess = {
            secret: cookie_key,
            cookie: {}
         }
 
         if (self.app.get('env')  == 'production') {
            self.app.enable('trust proxy', 1); // trusts first proxy - Heroku load balancer
            console.log("In production mode");
            self.app.use(express_enforces_ssl());
            sess.cookie.secure = true;
         }
 
        self.app.use(session(sess));

        // Setup the Google Analytics ID if defined
        self.app.locals.google_id = process.env.GOOGLE_ID || undefined;

        console.log("GA ID:" + self.app.locals.google_id);
        console.log("Cookie key:" + cookie_key);
        
        // Browser Cache
        var oneDay = 86400000;
        self.app.use('/', express.static('public', {maxAge: oneDay}));
        self.app.use('/shared', express.static('shared', {maxAge: oneDay}));

        // Initialize Passport and restore authentication state, if any, from the
        // session.
        self.app.use(passport.initialize());
        self.app.use(passport.session());
        
        
        // update the cache of static information from the DB
        cache.refresh(self.app);


        // Create all the routes and refresh the cache
        routes.createRoutes(self);
        technologyRoutes.createRoutes(self);
        stackRoutes.createRoutes(self);
        categoryRoutes.createRoutes(self);
        projectRoutes.createRoutes(self);
        userRoutes.createRoutes(self);
        commentRoutes.createRoutes(self);
        //
        // // API routes
        apiStack.createRoutes(self);
        apiTechnologies.createRoutes(self);
        apiSoftwareVersions.createRoutes(self);
        apiUsers.createRoutes(self);
        apiComments.createRoutes(self);
        apiProjects.createRoutes(self);
        apiCategories.createRoutes(self);
        apiDashboard.createRoutes(self);
    };

    /**
     *  Start the server (starts up the sample application).
     */
    self.start = function () {
        //  Start the app on the specific interface (and port).
        self.app.listen(self.port, function () {
            console.log('%s: Node server started on %s:%d ...',
                Date(Date.now()), self.port);
        });
    };

};



/**
 *  main():  Main code.
 */
var radarApp = new TechRadar();
radarApp.initialize();
radarApp.start();