expresser

<!DOCTYPE html> <html> <head> <title>app.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="public/stylesheets/normalize.css" /> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div class="container"> <div class="page"> <div class="header"> <h1>app.coffee</h1> <div class="toc"> <h3>Table of Contents</h3> <ol> <li> <a class="source" href="index.html"> index.coffee </a> </li> <li> <a class="source" href="app.html"> app.coffee </a> </li> <li> <a class="source" href="cron.html"> cron.coffee </a> </li> <li> <a class="source" href="database.html"> database.coffee </a> </li> <li> <a class="source" href="downloader.html"> downloader.coffee </a> </li> <li> <a class="source" href="events.html"> events.coffee </a> </li> <li> <a class="source" href="firewall.html"> firewall.coffee </a> </li> <li> <a class="source" href="imaging.html"> imaging.coffee </a> </li> <li> <a class="source" href="logger.html"> logger.coffee </a> </li> <li> <a class="source" href="mailer.html"> mailer.coffee </a> </li> <li> <a class="source" href="settings.html"> settings.coffee </a> </li> <li> <a class="source" href="sockets.html"> sockets.coffee </a> </li> <li> <a class="source" href="utils.html"> utils.coffee </a> </li> </ol> </div> </div> <h2 id="expresser-app">EXPRESSER APP</h2> The Express app server, with built-in sockets, firewall and New Relic integration.  <div class='highlight'><pre>class App express = require "express" fs = require "fs" http = require "http" https = require "https" lodash = require "lodash" net = require "net" path = require "path"</pre></div> Current node environment and HTTP server handler are set on init. <div class='highlight'><pre> nodeEnv = null</pre></div> Internal modules will be set on <code>init</code>. <div class='highlight'><pre> firewall = null logger = null settings = null sockets = null utils = null</pre></div> @property [Object] Exposes the Express HTTP or HTTPS <code>server</code> object. <div class='highlight'><pre> server: null</pre></div> @property [Array<Object>] Array of additional middlewares to be use by the Express server. Please note that if you’re adding middlewares manually you must do it BEFORE calling <code>init</code>. <div class='highlight'><pre> extraMiddlewares: []</pre></div> <h2 id="init">INIT</h2> Init the Express server. If New Relic settings are set it will automatically require and use the <code>newrelic</code> module. Firewall and Sockets modules will be used only if enabled on the settings. @param [Object] options App init options. If passed as an array, assume it’s the array with extra middlewares. @option options [Array] extraMiddlewares Array with extra middlewares to be loaded. <div class='highlight'><pre> init: (options) => if lodash.isArray options options = {extraMiddlewares: options} else if not options? options = {}</pre></div> Load settings and utils. <div class='highlight'><pre> settings = require "./settings.coffee" utils = require "./utils.coffee" nodeEnv = process.env.NODE_ENV</pre></div> Init New Relic, if enabled, and set default error handler. <div class='highlight'><pre> @initNewRelic() @setErrorHandler()</pre></div> Require logger. <div class='highlight'><pre> logger = require "./logger.coffee" logger.debug "App", "init", options.extraMiddlewares</pre></div> Configure Express server and start server. <div class='highlight'><pre> @configureServer options @startServer()</pre></div> Init new Relic, depending on its settings (enabled, appName and LicenseKey). <div class='highlight'><pre> initNewRelic: => enabled = settings.newRelic.enabled appName = process.env.NEW_RELIC_APP_NAME or settings.newRelic.appName licKey = process.env.NEW_RELIC_LICENSE_KEY or settings.newRelic.licenseKey</pre></div> Check if New Relic settings are available, and if so, start the New Relic agent. <div class='highlight'><pre> if enabled and appName? and appName isnt "" and licKey? and licKey isnt "" targetFile = path.resolve path.dirname(require.main.filename), "newrelic.js"</pre></div> Make sure the newrelic.js file exists on the app root, and create one if it doesn’t. <div class='highlight'><pre> if not fs.existsSync targetFile if process.versions.node.indexOf(".10.") > 0 enc = {encoding: settings.general.encoding} else enc = settings.general.encoding</pre></div> Set values of newrelic.js file and write it to the app root. <div class='highlight'><pre> newRelicJson = "exports.config = {app_name: ['#{appName}'], license_key: '#{licKey}', logging: {level: 'trace'}};" fs.writeFileSync targetFile, newRelicJson, enc console.log "App", "Original newrelic.js file was copied to the app root, app_name and license_key were set." require "newrelic" console.log "App", "Started New Relic agent for #{appName}."</pre></div> Log proccess termination to the console. This will force flush any buffered logs to disk. Do not log the exit if running under test environment. <div class='highlight'><pre> setErrorHandler: => process.on "exit", (sig) -> if nodeEnv? and nodeEnv.indexOf("test") < 0 console.warn "App", "Terminating Expresser app...", Date(Date.now()), sig try logger.flushLocal() catch err console.warn "App", "Could not flush buffered logs to disk."</pre></div> Configure the server. Set views, options, use Express modules, etc. <div class='highlight'><pre> configureServer: (options) => midBodyParser = require "body-parser" midCookieParser = require "cookie-parser" midSession = require "express-session" midCompression = require "compression" midErrorHandler = require "errorhandler"</pre></div> Create express v4 app. <div class='highlight'><pre> @server = express() settings.updateFromPaaS() if settings.app.paas</pre></div> Set view options, use Jade for HTML templates. <div class='highlight'><pre> @server.set "views", settings.path.viewsDir @server.set "view engine", settings.app.viewEngine @server.set "view options", { layout: false }</pre></div> Enable firewall? <div class='highlight'><pre> if settings.firewall.enabled firewall = require "./firewall.coffee" firewall.init @server</pre></div> Use Express basic handlers. <div class='highlight'><pre> @server.use midBodyParser() @server.use midCookieParser settings.app.cookieSecret if settings.app.cookieEnabled @server.use midSession {secret: settings.app.sessionSecret} if settings.app.sessionEnabled</pre></div> Use HTTP compression only if enabled on settings. <div class='highlight'><pre> @server.use midCompression if settings.app.compressionEnabled</pre></div> Fix connect assets helper context. <div class='highlight'><pre> connectAssetsOptions = settings.app.connectAssets connectAssetsOptions.helperContext = @server.locals</pre></div> Connect assets and dynamic compiling. <div class='highlight'><pre> ConnectAssets = (require "connect-assets") connectAssetsOptions @server.use ConnectAssets</pre></div> Check for extra middlewares to be added. <div class='highlight'><pre> if options.extraMiddlewares? if lodash.isArray options.extraMiddlewares @extraMiddlewares.push mw for mw in options.extraMiddlewares else @extraMiddlewares.push options.extraMiddlewares</pre></div> Add more middlewares, if any (for example passport for authentication). <div class='highlight'><pre> if @extraMiddlewares.length > 0 @server.use mw for mw in @extraMiddlewares</pre></div> Configure development environment to dump exceptions and show stack. <div class='highlight'><pre> if nodeEnv is "development" @server.use midErrorHandler {dumpExceptions: true, showStack: true}</pre></div> Configure production environment. <div class='highlight'><pre> if nodeEnv is "production" @server.use midErrorHandler()</pre></div> Use Express static routing. <div class='highlight'><pre> @server.use express.static settings.path.publicDir</pre></div> If debug is on, log requests to the console. <div class='highlight'><pre> if settings.general.debug @server.use (req, res, next) => ip = utils.getClientIP req method = req.method url = req.url</pre></div> Check if request flash is present before logging. <div class='highlight'><pre> if req.flash? and lodash.isFunction req.flash console.log "Request from #{ip}", method, url, req.flash() else console.log "Request from #{ip}", method, url next() if next?</pre></div> Start the server using HTTP or HTTPS, depending on the settings. <div class='highlight'><pre> startServer: => if settings.app.ssl.enabled and settings.path.sslKeyFile? and settings.path.sslCertFile? sslKeyFile = utils.getFilePath settings.path.sslKeyFile sslCertFile = utils.getFilePath settings.path.sslCertFile</pre></div> Certificate files were found? Proceed, otherwise alert the user and throw an error. <div class='highlight'><pre> if sslKeyFile? and sslCertFile? sslKey = fs.readFileSync sslKeyFile, {encoding: settings.general.encoding} sslCert = fs.readFileSync sslCertFile, {encoding: settings.general.encoding} sslOptions = {key: sslKey, cert: sslCert} server = https.createServer sslOptions, @server else logger.error "App", "init", "Cannot find certificate files.", settings.path.sslKeyFile, settings.path.sslCertFile throw new Error "The certificate files could not be found. Please check the 'Path.sslKeyFile' and 'Path.sslCertFile' settings." else server = http.createServer @server</pre></div> Enable sockets? <div class='highlight'><pre> if settings.sockets.enabled sockets = require "./sockets.coffee" sockets.init server</pre></div> Start the server and log output. <div class='highlight'><pre> try if settings.app.ip? and settings.app.ip isnt "" server.listen settings.app.port, settings.app.ip logger.info "App", settings.general.appTitle, "Listening on #{settings.app.ip} - #{settings.app.port}" else server.listen settings.app.port logger.info "App", settings.general.appTitle, "Listening on #{settings.app.port}"</pre></div> Using SSL and redirector port is set? Then create the http server. <div class='highlight'><pre> if settings.app.ssl.enabled and settings.app.ssl.redirectorPort > 0 logger.info "App", "#{settings.general.appTitle} will redirect HTTP #{settings.app.ssl.redirectorPort} to HTTPS on #{settings.app.port}." redirServer = express() redirServer.get "*", (req, res) -> res.redirect "https://#{req.host}:#{settings.app.port}#{req.url}" @redirectorServer = http.createServer redirServer @redirectorServer.listen settings.app.ssl.redirectorPort catch ex logger.error "App", "Could not start the server!", ex</pre></div> <h2 id="helper-and-utils">HELPER AND UTILS</h2> Helper to render pages. The request, response and view are mandatory, and the options argument is optional. @param [Object] req The request object. @param [Object] res The response object. @param [String] view The view name. @param [Object] options Options passed to the view, optional. <div class='highlight'><pre> renderView: (req, res, view, options) => options = {} if not options? options.device = utils.getClientDevice req options.title = settings.general.appTitle if not options.title? res.render view, options logger.debug "App", "Render", view, options</pre></div> Helper to send error responses. When the server can’t return a valid result, send an error response with the specified status code. @param [Object] req The response object. @param [String] message The message to be sent to the client. @param [Integer] statusCode The response status code, optional, default is 500. <div class='highlight'><pre> renderError: (res, message, statusCode) => message = JSON.stringify message statusCode = 500 if not statusCode? res.statusCode = 500 res.send "Server error: #{message}" logger.error "App", "HTTP Error", statusCode, message, res</pre></div> <h2 id="singleton-implementation">Singleton implementation</h2> <div class='highlight'><pre>App.getInstance = -> @instance = new App() if not @instance? return @instance module.exports = exports = App.getInstance()</pre></div> <div class="fleur">h</div> </div> </div> </body> </html>