Slides from a webinar recorded on June 11, 2015 by Jordan Kasper on Node.js architecture and Express Fundamentals

1. NODE.JS ARCHITECTURE AND
GETTING STARTED WITH EXPRESS.JS
Jordan Kasper | Developer Evangelist

2. NODE.JS ARCHITECTURE

3. MODULARITY

4. MODULE PATTERNS
There are various patterns...
Simple Object API
Revealing Module (Function Initialization)
Object Constructor

5. SIMPLE OBJECT API
// lib/employee.js
module.exports = {
salary: 50000,
giveRaise: function( amount ) {
salary += amount;
}
};
Why not always use simple objects?
Modules are cached!

6. REVEALING MODULE PATTERN
module.exports = function createWorker( options ) {
// Setup...
return {
salary: 50000,
giveRaise: function( amount ) {
this.salary += amount;
}
};
};

7. OBJECT CONSTRUCTOR PATTERN
var Worker = module.exports = function Worker( options ) {
// ...
};
Worker.prototype.salary = 50000;
Worker.prototype.giveRaise = function( amount ) {
this.salary += amount;
};

8. SCALING

10. VERTICAL SCALING

11. NODE CLUSTERING

12. var http = require('http'),
cluster = require('cluster');
if (cluster.isMaster) {
for (var i = 0; i < numCPUCores; i++) {
cluster.fork();
};
} else {
http
.createServer(function(req, res) {
// ...
})
.listen(8080, ...);
});

13. USING A PROCESS MANAGER
Easy clustering and scaling without altering application
code
StrongLoop Process Manager (strong-pm)
PM2
Comparison Chart
Forever

14. LOAD BALANCING
cluster uses a simple round-robin approach...
...but there are better ways!

15. HORIZONTAL SCALING

17. HORIZONTAL SCALING

19. Nginx

20. BASIC NGINX CONFIG
server {
listen 80
location / {
proxy_pass http://localhost:3000;
}
location /static/ {
root /var/www/my­app/public;
}
}
$ sudo service nginx start

21. NGINX LOAD BALANCER
http {
upstream myapp {
least_conn; # round­robin is the default...
# Or use ip_hash; for "sticky" sessions...
server www1.my­app.com;
server www2.my­app.com;
server www3.my­app.com;
}
server {
listen 80
location / {
proxy_pass http://myapp;
}
}
}

22. STRONGLOOP AND NGINX
If you're using strong-pm you can use the
!
StrongLoop nginx
controller
~$ npm install ­g strong­nginx­controller
~$ sl­nginx­ctl­install
Install the Controller on the load balancing host...

23. ...then manage the load balancing infrastructure from
:StrongLoop Arc

25. SCALING WITH STRONGLOOP ARC

27. Nginx

28. EXPRESS.JS

29. EXPRESS.JS
Fast, light, unopinionated framework for web applications.

30. EXPRESS HELLO WORLD
~/my­app$ npm init
...
~/my­app$ npm install express ­­save

31. EXPRESS HELLO WORLD
// in app.js
var express = require('express');
var myApp = express();
myApp.get('/', function handleRoot(req, res, next) {
res.send('Hello World!');
});
myApp.listen(8080);
~/my­app$ node app.js

32. SCAFFOLDING AN EXPRESS APP

33. SCAFFOLDING EXPRESS
Install the CLI generator first...
~$ npm install ­g express­generator
~$ express my­app
...
~$ cd my­app
~/my­app$ npm install

34. A SCAFFOLDED APP
my­app/
|_ bin # execution file (shell script)
|_ node_modules
|_ public # images, css, fonts, etc
|_ routes # Node.js routing code
|_ views # server­side templates
|_ app.js
|_ package.json

35. RUNNING A SCAFFOLDED APP
~/my­app$ npm start
{
...,
"scripts": {
"start": "node ./bin/www"
},
...

36. CONFIGURING EXPRESS

37. CONFIGURING EXPRESS
var app = express();
app.set('views', 'views');
app.set('view engine', 'jade');
app.set('port', process.env.PORT || 3000);
app.set('foo', 'bar');
server.listen( app.get('port') );

38. REQUEST ROUTING

39. BASIC ROUTING
var express = require('express');
var myApp = express();
myApp.get('/', function handleRoot(req, res, next) {
res.send('Hello World!');
});
myApp.listen( 3000 );

40. POST ROUTING
myApp.post('/user', function createUser(req, res, next) {
// Create the user record...
res.redirect('/my­account');
});

41. POST ROUTING
myApp.post('/user', function createUser(req, res, next) {
// Create the user record...
// Where do we get the data from?
res.redirect('/my­account');
});

42. MIDDLEWARE

44. MIDDLEWARE EXAMPLES
var express = require('express'),
bodyParser = require('body­parser');
var app = express();
// app config...
// Parse POST form data...
app.use( bodyParser.urlencoded({ extended: false }) );
app.post('/user', function createUser() {
var user = {
username: req.body.username,
...
};
...
});

45. ORDER MATTERS!
Middleware are executed in the order specified
app.use( express.logger('dev') );
app.use( myAuthModule() );
app.use( bodyParser.json() );
app.use(bodyParser.urlencoded({ extended: false }));
app.use(express.static(path.join(__dirname, 'public')));
// Routing middleware...

46. MIDDLEWARE - WHEN DOES IT END?
Middleware processing ends when next() is not called
(or an error is generated)
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: false }));
app.get('/about', function aboutUs(req, res, next) {
res.send('We are StrongLoop!');
// no call to next()
});
app.get('/user', ...);

47. CUSTOM MIDDLEWARE
app.use(function (req, res, next) {
// Do some work...
// Modify the req or res...
// execute the callback when done
next();
});

48. CUSTOM MIDDLEWARE - ERRORS
app.use(function (req, res, next) {
// do something...
if (thereWasAnError) {
var err = new Error(' ... ');
next( err );
return;
}
// No error, so we proceed...
next();
});

49. HANDLING MIDDLEWARE ERRORS
app.use(function(err, req, res, next) {
// Do whatever you need to...
if (err.code === 404) {
res.redirect('/error­404');
} else {
// Or you can keep processing this (or a new) Error
next(err);
}
});

51. HANDLING MIDDLEWARE ERRORS
Always set up a "catchall" error handler!

52. SERVER-SIDE TEMPLATING

53. TEMPLATES
Small blocks that we can plug data into at run-time
//­ /views/index.jade
doctype html
html
head
title #{title}
body
section.main­body.clear
#{homepageText}

54. TEMPLATING ENGINE
~/my­app$ npm install ­­save jade
var app = express();
app.set('views', 'views');
app.set('view engine', 'jade');

55. USING A TEMPLATE
app.get('/' function handleRoot(req, res, next) {
res.render('index', {
title: 'StrongLoop ­ Home',
homepageText: 'We all love StrongLoop!'
});
});

56. DON'T FORGET YOUR MODULARITY!

57. NOT MODULAR...
var express = require('express'),
bodyParser = require('body­parser');
var app = express();
// app config and other middleware...
app.post('/user', function createUser() {
var user = {
username: req.body.username,
...
};
db.create(user, function() {
res.render('user/my­account', { ... });
});
});

58. THE 4.0 ROUTER INTERFACE
// in routes/users.js
var express = require('express');
var router = express.Router();
router.get('/', function(req, res, next) {
// Get a list of users...
res.render('user/list', { results: users });
});
router.get('/:id', function(req, res, next) {
// Get a single user...
res.render('user/my­account', { user: user });
});
router.post('/', function(req, res, next) {
// Create a user...
res.redirect('user/my­account', { user: user });
});
module.exports = router;

59. THE 4.0 ROUTER INTERFACE
// in app.js
var express = require('express'),
...;
var app = express();
// app config and middleware...
app.use('/users', require('./routes/users'));

60. REQUEST OBJECT

61. QUERY PARAMETERS
app.get('/users', function (req, res, next) {
var limit = req.query.limit || 10,
users = [];
// Retrieve all users...
res.render('user/list', {
results: users,
nextIndex: 11
});
});

62. URL PARAMETERS
app.get('/users/:id', function (req, res, next) {
var id = req.params.id,
user = null;
// Retrieve a single user...
if (req.xhr) {
res.json({ user: user });
} else {
res.render('user/single', {
user: user
});
}
});

63. URL PARAMETERS
app.get(/^/users/(d+)$/, function (req, res, next) {
var id = req.params[0],
user = null;
// Retrieve a single user...
// ...
});

64. RESPONSE OBJECT

65. RESPONSE METHODS
response.send(data) or response.end(data)
response.status(httpStatus)
response.send(201, someData)
response.sendfile('path/to/someFile.json')
response.download('/report-12345.pdf')

66. HTTP STATUS CODES
2XX: for successfully processed requests
3XX: for redirections or cache information
4XX: for client-side errors
5XX: for server-side errors

67. QUESTIONS?
NODE.JS ARCHITECTURE AND
GETTING STARTED WITH EXPRESS.JS
Jordan Kasper | Developer Evangelist
Join us for more events!
strongloop.com/developers/events