forked from restify/node-restify
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathserver.js
More file actions
527 lines (409 loc) · 12.2 KB
/
Copy pathserver.js
File metadata and controls
527 lines (409 loc) · 12.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
// Copyright 2012 Mark Cavage, Inc. All rights reserved.
var assert = require('assert');
var EventEmitter = require('events').EventEmitter;
var http = require('http');
var https = require('https');
var url = require('url');
var util = require('util');
var async = require('async');
var errors = require('./errors');
var Request = require('./request');
var Response = require('./response');
var Route = require('./route');
///--- Globals
var BadMethodError = errors.BadMethodError;
var InvalidVersionError = errors.InvalidVersionError;
var ResourceNotFoundError = errors.ResourceNotFoundError;
///--- Helpers
function argsToChain() {
assert.ok(arguments.length);
var args = arguments[0];
if (args.length < 0)
throw new TypeError('handler (Function) required');
var chain = [];
function process(handlers) {
handlers.forEach(function (h) {
if (Array.isArray(h))
return process(h);
if (!typeof (h) === 'function')
throw new TypeError('handlers must be Functions');
return chain.push(h);
});
}
process(Array.prototype.slice.call(args, 0));
return chain;
}
function logRequest(req) {
assert.ok(req);
req.log.trace('New Request:\n\n%s', req.toString());
}
function default404Handler(req, res, server) {
res.send(new ResourceNotFoundError(req.url + ' not found'));
server.emit('after', req, res, null);
}
function default405Handler(req, res, methods, server) {
res.header('Allow', methods.join(', '));
if (req.method === 'OPTIONS') {
res.send(200);
} else {
var msg = req.url + ' does not support ' + req.method;
res.send(new BadMethodError(msg));
}
server.emit('after', req, res, null);
}
function defaultBadVersionHandler(req, res, versions, server) {
var msg = req.method + ' ' + req.url + ' supports versions: ' +
versions.join(', ');
res.send(new InvalidVersionError(msg));
server.emit('after', req, res, null);
}
function toPort(x) {
x = parseInt(x, 10);
return (x >= 0 ? x : false);
}
function isPipeName(s) {
return (typeof (s) === 'string' && toPort(s) === false);
}
///--- API
/**
* Constructor. Creates a REST API Server.
*
* - options {Object} construction arguments. (bunyan instance required).
*/
function Server(options) {
if (typeof (options) !== 'object')
throw new TypeError('options (Object) required');
if (typeof (options.dtrace) !== 'object')
throw new TypeError('options.dtrace (Object) required');
if (typeof (options.log) !== 'object')
throw new TypeError('options.log (Object) required');
EventEmitter.call(this);
this.chain = [];
this.formatters = options.formatters || {};
this.log = options.log;
this.name = options.name || 'restify';
this.preChain = [];
this.routes = [];
this.version = options.version || false;
var secure = false;
if (options.certificate && options.key) {
secure = true;
this.server = https.createServer({
cert: options.certificate,
key: options.key
});
} else {
this.server = http.createServer();
}
var self = this;
this.server.on('error', function (err) {
self.emit('error', err);
});
this.server.on('clientError', function (err) {
self.emit('clientError', err);
});
this.server.on('close', function () {
self.emit('close');
});
this.server.on('connection', function (socket) {
self.emit('connection', socket);
});
this.server.on('upgrade', function (request, socket, headPacket) {
return self.emit('upgrade', request, socket, headPacket);
});
this.server.on('request', function (req, res) {
return self._request(req, res);
});
this.server.on('checkContinue', function (req, res) {
if (self.listeners('checkContinue').length)
return self.emit('checkContinue', req, res);
return self._request(req, res, true);
});
this.__defineGetter__('acceptable', function () {
var accept = Object.keys(self.formatters) || [];
Response.ACCEPTABLE.forEach(function (a) {
if (accept.indexOf(a) === -1)
accept.push(a);
});
return accept;
});
this.__defineGetter__('name', function () {
return options.name || 'restify';
});
this.__defineGetter__('dtrace', function () {
return options.dtrace;
});
this.__defineGetter__('url', function () {
if (self.socketPath)
return 'http://' + self.socketPath;
var str = secure ? 'https://' : 'http://';
str += self.address().address;
str += ':';
str += self.address().port;
return str;
});
}
util.inherits(Server, EventEmitter);
module.exports = Server;
Server.prototype.address = function address() {
return this.server.address();
};
/**
* Gets the server up and listening.
*
* You can call like:
* server.listen(80)
* server.listen(80, '127.0.0.1')
* server.listen('/tmp/server.sock')
*
* And pass in a callback to any of those forms. Also, by default, invoking
* this method will trigger DTrace probes to be enabled; to not do that, pass
* in 'false' as the second to last parameter.
*
* @param {Function} callback optionally get notified when listening.
* @throws {TypeError} on bad input.
*/
Server.prototype.listen = function listen() {
var callback = false;
var dtrace = true;
var self = this;
function listenCallback() {
if (dtrace)
self.dtrace.enable();
return callback ? callback.call(self) : false;
}
if (!arguments.length)
return this.server.listen(listenCallback);
callback = arguments[arguments.length - 1];
if (typeof (callback) !== 'function')
callback = false;
if (arguments.length >= 2 && arguments[arguments.length - 2] === false)
dtrace = false;
switch (typeof (arguments[0])) {
case 'function':
return this.server.listen(listenCallback);
case 'string':
if (isPipeName(arguments[0]))
return this.server.listen(arguments[0], listenCallback);
throw new TypeError(arguments[0] + ' is not a named pipe');
case 'number':
var host = arguments[1];
return this.server.listen(arguments[0],
typeof (host) === 'string' ? host : '0.0.0.0',
listenCallback);
default:
throw new TypeError('port (Number) required');
}
};
/**
* Shuts down this server, and invokes callback (optionally) when done.
*
* @param {Function} callback optional callback to invoke when done.
*/
Server.prototype.close = function close(callback) {
if (callback) {
if (typeof (callback) !== 'function')
throw new TypeError('callback must be a function');
this.server.once('close', function () {
return callback();
});
}
return this.server.close();
};
// Register all the routing methods
['del', 'get', 'head', 'post', 'put'].forEach(function (method) {
/**
* Mounts a chain on the given path against this HTTP verb
*
* @param {Object} options the URL to handle, at minimum.
* @return {Route} the newly created route.
*/
Server.prototype[method] = function (options) {
if (arguments.length < 2)
throw new Error('At least one handler (Function) required');
if (typeof (options) !== 'object' && typeof (options) !== 'string')
throw new TypeError('path (String) required');
var args = Array.prototype.slice.call(arguments, 1);
if (method === 'del')
method = 'DELETE';
return this._addRoute(method.toUpperCase(), options, args);
};
});
/**
* Removes a route from the server.
*
* You can either pass in the route name or the route object as `name`.
*
* @param {String} name the route name.
* @return {Boolean} true if route was removed, false if not.
* @throws {TypeError} on bad input.
*/
Server.prototype.rm = function rm(name) {
if (typeof (name) !== 'string' && !(name instanceof Route))
throw new TypeError('name (String) required');
for (var i = 0; i < this.routes.length; i++) {
if (this.routes[i].name === name || this.routes[i] === name) {
this.routes.splice(i, 1);
return true;
}
}
return false;
};
/**
* Installs a list of handlers to run _before_ the "normal" handlers of all
* routes.
*
* You can pass in any combination of functions or array of functions.
*
* @throws {TypeError} on input error.
*/
Server.prototype.use = function use() {
var chain = argsToChain(arguments);
if (chain.length) {
var self = this;
chain.forEach(function (h) {
self.chain.push(h);
});
this.routes.forEach(function (r) {
r.use(chain);
});
}
return this;
};
/**
* Gives you hooks to run _before_ any routes are located. This gives you
* a chance to intercept the request and change headers, etc., that routing
* depends on. Note that req.params will _not_ be set yet.
*/
Server.prototype.pre = function pre() {
var self = this;
return argsToChain(arguments).forEach(function (h) {
self.preChain.push(h);
});
};
///--- Private methods
Server.prototype._addRoute = function _addRoute(method, options, handlers) {
var self = this;
var chain = this.chain.slice(0);
argsToChain(handlers).forEach(function (h) {
chain.push(h);
});
if (typeof (options) !== 'object' || options instanceof RegExp)
options = { url: options };
var route = new Route({
log: self.log,
method: method,
url: options.path || options.url,
handlers: chain,
name: options.name,
version: options.version || self.version,
dtrace: self.dtrace
});
route.on('error', function (err) {
self.emit('error', err);
});
route.on('done', function (req, res) {
self.emit('after', req, res, route);
});
route.on('uncaughtException', function (req, res, route, err) {
if (self.listeners('uncaughtException').length) {
self.emit('uncaughtException', req, res, route, err);
} else {
res.send(err);
}
});
this.routes.forEach(function (r) {
if (r.matchesUrl({ url: options.url })) {
if (r.methods.indexOf(method) === -1)
r.methods.push(method);
}
});
this.routes.push(route);
return route;
};
Server.prototype._request = function _request(request, response, expect100) {
var self = this;
var req = new Request({
log: self.log,
request: request
});
var res = new Response({
log: self.log,
request: req,
response: response,
formatters: self.formatters,
serverName: self.name
});
logRequest(req);
var before = [];
this.preChain.forEach(function (h) {
before.push(function (callback) {
return h(req, res, callback);
});
});
// Ensure there's always one
before.push(function (callback) {
return callback();
});
return async.series(before, function (err) {
if (err)
return res.send(err);
var route = self._findRoute(req, res);
if (!route)
return false;
// Secret logger update
req._setLogger(self.log, route.name);
res.log = req.log;
res.defaultHeaders();
if (expect100)
res.writeContinue();
return route.run(req, res);
});
};
Server.prototype._findRoute = function _findRoute(req, res) {
assert.ok(req);
assert.ok(res);
var params;
var route;
var methods = [];
var versions = [];
for (var i = 0; i < this.routes.length; i++) {
var r = this.routes[i];
if ((params = r.matchesUrl(req))) {
if (r.matchesMethod(req)) {
if (r.matchesVersion(req)) {
route = r;
break;
} else {
if (r.version && versions.indexOf(r.version) === -1)
versions.push(r.version);
}
} else {
if (methods.indexOf(r.method) === -1)
methods.push(r.method);
}
}
}
if (route) {
req.params = params || {};
res.methods = route.methods;
res.version = route.version[route.version.length - 1];
} else {
res.methods = methods;
res.versions = versions;
if (versions.length) {
if (!this.listeners('VersionNotAllowed').length)
this.once('VersionNotAllowed', defaultBadVersionHandler);
this.emit('VersionNotAllowed', req, res, versions, this);
} else if (methods.length) {
if (!this.listeners('MethodNotAllowed').length)
this.once('MethodNotAllowed', default405Handler);
this.emit('MethodNotAllowed', req, res, methods, this);
} else {
if (!this.listeners('NotFound').length)
this.once('NotFound', default404Handler);
this.emit('NotFound', req, res, this);
}
}
return route || false;
};