impress

Impress

Impressive totalitarian style multipurpose web application server for node.js. All decisions are made. Ready for applied development.

The main difference from others that Impress core is monolithic and its approach is to make all in one solution with high code coupling for obligatory things and leave not obligatory to be integrated by applied developers optionally. High coupling in core gives us advantages in performance and code simplicity. For example, why we should implement static files serving or memory caching as a plugin while no one application will omit that.

Installation

$ npm install impress

Features

• Can serve multiple applications and sites on multiple domains
• Serves multiple ports, network interfaces, hosts and protocols
• Can be run on one or multiple servers
• Supports one or multiple CPU cores with following instantiation strategies:
  • Single instance (one process)
  • Instance specialization (multiple processes, one master and different workers for each server)
  • Multiple instances (multiple processes, one master and identical workers with no sticky)
  • IP sticky (multiple processes, one master and workers with serving sticky by IP)
• URL routing based on file system
  • Caching server-side executable JavaScript in memory
  • Filesystem watching for cache reloading when file changes on disk
• API development support (simple way for JSON-based WEB-services development)
  • RPC-style API (Stateful, state stored in memory between requests)
  • REST-style API (Stateless, each call is separate, no state in memory)
• Server server-side templating
  • Caching templates in memory and ready (rendered) pages optional caching
  • Value rendering with @VariableName@ syntax, absolute and relative addressing
  • Array and hash iterations with @[arrayName]@ and @[/arrayName]@ syntax
  • Including sub-templates @[includeTemplate]@ syntax
  • Template personalization for user groups
• Config changes with zero downtime
  • Flexible configuration in JSON file
  • File watch and automatic soft reloading when config.js file changes
  • No Impress server hard restarting
• Serving static files
  • Gzipping and HTTP request field "if-modified-since" field support and HTTP 304 "Not Modified" answer
  • Memory caching and filesystem watching for cache reloading when files changed on disk
  • JavaScript optional (configurable) minification, based on module "uglify-js" as Impress plugin
• Built-in sessions support with authentication and user groups and anonymous sessions
  • Sessions and cookies (memory state or persistent sessions with MongoDB)
  • Access modifiers for each folder in access.js files and access inheritance
• Implemented SSE (Server-Sent Events) with channels and multicast
• Reverse-proxy (routing request to external HTTP server with URL-rewriting)
• Logging: "access", "debug", "error and "slow" logs
  • Log rotation: keep logs N days (configurable) delete files after N days
  • Log buffering, write stream flushing interval
• Connection drivers for database engines:
  • MySQL data access layer based on felixge/mysql low-level drivers (separate module "musql-utilities")
    • MySQL Data Access Methods: queryRow, queryValue, queryCol, queryHash, queryKeyValue
    • MySQL Introspection Methods: primary, foreign, constraints, fields, databases, tables, databaseTables, tableInfo, indexes, processes, globalVariables, globalStatus, users
    • MySQL SQL Autogenerating Methods: select, insert, update, upsert, count, delete
    • Events: 'query', 'slow'
  • MongoDB drivers as Impress plugin
  • Memcached drivers as Impress plugin
  • MySQL schema generator from JSON database schemas
• Sending Emails functionality using "nodemailer" module as Impress plugin
• IPC support (interprocess communications) for event delivery between Node.js instances
• Integrated DBMI (Web-based management interface for MySQL and MongoDB)
• GeoIP support, based on "geoip-lite" module as Impress plugin (uses MaxMind database)

Configuration

1. Install module using npm
2. Edit config.js file in project folder (or leave it untouched if you want just to test Impress)
3. If you want to store persistent sessions in MongoDB you need this DBMS installed and you need to run "node setup.js" before starting Impress
4. Run Impress using command "node server.js"

Handler examples and file system url mapping

1. Template example Location: http://localhost Base template: /sites/localhost/html.template
2. Override included "left.template" Location: http://localhost/override Overriden template: /sites/localhost/override/left.template Base template: /sites/localhost/html.template Handler: /sites/localhost/request.js
3. JSON api method example Location: http://localhost/api/examples/methodName.json Handler: /sites/localhost/api/examples/methodName.json/get.js
4. Start anonymous session Location: http://localhost/api/auth/anonymousSession.json Handler: /sites/localhost/api/auth/anonymousSession.json/get.js
5. POST request handler Location: POST http://localhost/api/auth/regvalidation.json Handler: /sites/localhost/api/auth/regvalidation.json/post.js
6. MongoDB access example Location: http://localhost/api/examples/getUsers.json Handler: /sites/localhost/api/examples/getUsers.json/get.js

Example

Following "server.js" is stating file. Run it using command line "node server" for debug or "nohup node server" for production.

require('impress');
impress.init(function() {
	// Place here other initialization code
	// to be executed after Impress initialization
});

File "access.js" is something line ".htaccess", you can easily define access restrictions for each folder, placing "access.js" in it. If folder not contains "access.js" it will inherit from parent folder and so on. Example:

module.exports = {
	guests: true, // allow requests from not logged users
	logged: true, // allow requests from logged users
	http:   true, // allow requests using http protocol
	https:  true, // allow requests using https protocol (SSL)
	groups: []    // allow access for user groups listed in array
	              // or for all if array is empty or no groups field specified
}

File "request.js": place such file in folder to be executed on each request (GET, POST, PUT, etc.). If folder not contains "request.js" it will inherit from parent folder and so on. Example:

module.exports = function(req, res, callback) {
	res.context.data = {
		title: "Page Title",
		users: [
			{
				name: "vasia", age: 22,
				emails: ["[e-mail]", "[e-mail]"]
			},{
				name: "dima", age: 32,
				emails: ["[e-mail]", "[e-mail]", "[e-mail]"]
			}
		],
		session: JSON.stringify(impress.sessions[req.impress.session])
	};
	callback();
}

File "get.js": place such file in folder to be executed on GET request. For POST request "post.js", and so on. If folder not contains "get.js" it will inherit from parent folder and so on. Example:

module.exports = function(req, res, callback) {
	db.polltool.query('select * from City', function(err, rows, fields) {
		if (err) throw err;
		res.context.data = { rows:rows, fields:fields };
		callback();
	});
}

File "html.template": place such file in folder as a main page template. Example:

<!DOCTYPE html>
<html>
<head>
	<title>@title@</title>
</head>
<body>
	<div>
		Field value: @field@
	</div>
	<div>
		Include template: @[name]@ - this will include file "./name.template"
	</div>
	<div>
		This will iterate "res.context.data" from "request.js" example above:
		@[users]@
			<div>
				User name: @.name@<br/>
				User age: @.age@<br/>
				Email addresses:
				<ul>
					@[emails]@
						<li>@.value@</li>
					@[/emails]@
				</ul>
			</div>
		@[/users]@
	</div>
</body>
</html>

Contributors

• Timur Shemsedinov (marcusaurelius)
• Sergey Andriyaschenko (tblasv)

License

Dual licensed under the MIT or RUMI licenses.

Copyright (c) 2012-2013 MetaSystems <[e-mail]>

License: RUMI

Do you know what you are? You are a manuscript of a divine letter. You are a mirror reflecting a noble face. This universe is not outside of you. Look inside yourself; everything that you want, you are already that.

Jalal ad-Din Muhammad Rumi "Hush, Don't Say Anything to God: Passionate Poems of Rumi"