Coverage for /Users/yunong/workspace/node-restify/lib/server.js : 90%
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 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 | // Copyright 2012 Mark Cavage, Inc. All rights reserved. var domain = require('domain'); var EventEmitter = require('events').EventEmitter; var http = require('http'); var https = require('https'); var util = require('util'); var assert = require('assert-plus'); var mime = require('mime'); var once = require('once'); var spdy = require('spdy'); var uuid = require('node-uuid'); var dtrace = require('./dtrace'); var errors = require('./errors'); var formatters = require('./formatters'); var shallowCopy = require('./utils').shallowCopy; var upgrade = require('./upgrade'); var semver = require('semver'); var maxSatisfying = semver.maxSatisfying; // Ensure these are loaded require('./request'); require('./response'); ///--- Globals var sprintf = util.format; var ResourceNotFoundError = errors.ResourceNotFoundError; var PROXY_EVENTS = [ 'clientError', 'close', 'connection', 'error', 'listening', 'secureConnection' ]; ///--- Helpers function argumentsToChain(args, start) { assert.ok(args); args = Array.prototype.slice.call(args, start); if (args.length < 0) throw new TypeError('handler (function) required'); var chain = []; function process(handlers) { for (var i = 0; i < handlers.length; i++) { if (Array.isArray(handlers[i])) { process(handlers[i], 0); } else { assert.func(handlers[i], 'handler'); chain.push(handlers[i]); } } return (chain); } return (process(args)); } function mergeFormatters(fmt) { var arr = []; var defaults = Object.keys(formatters).length; var i = 0; var obj = {}; function addFormatter(src, k) { assert.func(src[k], 'formatter'); var q; var t = k; if (k.indexOf(';') !== -1) { /* JSSTYLED */ var tmp = k.split(/\s*;\s*/); t = tmp[0]; if (tmp[1].indexOf('q=') !== -1) { q = parseFloat(tmp[1].split('=')[1]) * 10; } } if (k.indexOf('/') === -1) k = mime.lookup(k); obj[t] = src[k]; arr.push({ q: q || (i + defaults), t: t }); i++; } Object.keys(formatters).forEach(addFormatter.bind(this, formatters)); Object.keys(fmt || {}).forEach(addFormatter.bind(this, fmt || {})); arr = arr.sort(function (a, b) { return (b.q - a.q); }).map(function (a) { return (a.t); }); return ({ formatters: obj, acceptable: arr }); } function ifError(n) { function _ifError(err) { if (err) { err._restify_next = n; throw err; } } return (_ifError); } function emitRouteError(server, req, res, err) { var name; if (err.name === 'ResourceNotFoundError') { name = 'NotFound'; } else if (err.name === 'InvalidVersionError') { name = 'VersionNotAllowed'; } else { name = err.name.replace(/Error$/, ''); } req.log.trace({name: name, err: err}, 'entering emitRouteError'); if (server.listeners(name).length > 0) { server.emit(name, req, res, err, once(function () { server.emit('after', req, res, null); })); } else { res.send(err); server.emit('after', req, res, null); } } function optionsError(err, req, res) { var code = err.statusCode; var ok = false; if (code === 404 && req.method === 'OPTIONS' && req.url === '*') { res.send(200); ok = true; } return (ok); } ///--- API function Server(options) { assert.object(options, 'options'); assert.object(options.log, 'options.log'); assert.object(options.router, 'options.router'); var self = this; EventEmitter.call(this); this.before = []; this.chain = []; this.log = options.log; this.name = options.name || 'restify'; this.router = options.router; this.routes = {}; this.secure = false; this.versions = options.versions || options.version || []; this.socketio = options.socketio || false; var fmt = mergeFormatters(options.formatters); this.acceptable = fmt.acceptable; this.formatters = fmt.formatters; if (options.spdy) { this.spdy = true; this.server = spdy.createServer(options.spdy); } else if ((options.cert || options.certificate) && options.key) { this.ca = options.ca; this.certificate = options.certificate || options.cert; this.key = options.key; this.passphrase = options.passphrase || null; this.secure = true; this.server = https.createServer({ ca: self.ca, cert: self.certificate, key: self.key, passphrase: self.passphrase, rejectUnauthorized: options.rejectUnauthorized, requestCert: options.requestCert, ciphers: options.ciphers }); } else if (options.httpsServerOptions) { this.server = https.createServer(options.httpsServerOptions); } else { this.server = http.createServer(); } this.router.on('mount', this.emit.bind(this, 'mount')); if (!options.handleUpgrades && PROXY_EVENTS.indexOf('upgrade') === -1) PROXY_EVENTS.push('upgrade'); PROXY_EVENTS.forEach(function (e) { self.server.on(e, self.emit.bind(self, e)); }); // Now the things we can't blindly proxy this.server.on('checkContinue', function onCheckContinue(req, res) { if (self.listeners('checkContinue').length > 0) { self.emit('checkContinue', req, res); return; } if (!options.noWriteContinue) res.writeContinue(); self._setupRequest(req, res); self._handle(req, res, true); }); if (options.handleUpgrades) { this.server.on('upgrade', function onUpgrade(req, socket, head) { req._upgradeRequest = true; var res = upgrade.createResponse(req, socket, head); self._setupRequest(req, res); self._handle(req, res); }); } this.server.on('request', function onRequest(req, res) { self.emit('request', req, res); if (options.socketio && (/^\/socket\.io.*/).test(req.url)) return; self._setupRequest(req, res); self._handle(req, res); }); this.__defineGetter__('maxHeadersCount', function () { return (self.server.maxHeadersCount); }); this.__defineSetter__('maxHeadersCount', function (c) { self.server.maxHeadersCount = c; return (c); }); this.__defineGetter__('url', function () { if (self.socketPath) return ('http://' + self.socketPath); var addr = self.address(); var str = ''; if (self.spdy) { str += 'spdy://'; } else if (self.secure) { str += 'https://'; } else { str += 'http://'; } if (addr) { str += addr.family === 'IPv6' ? '[' + addr.address + ']' : addr.address; str += ':'; str += addr.port; } else { str += '169.254.0.1:0000'; } 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') * * @param {Function} callback optionally get notified when listening. * @throws {TypeError} on bad input. */ Server.prototype.listen = function listen() { var args = Array.prototype.slice.call(arguments); return (this.server.listen.apply(this.server, args)); }; /** * 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) assert.func(callback, 'callback'); this.server.once('close', function onClose() { return (callback ? callback() : false); }); return (this.server.close()); }; // Register all the routing methods /** * 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. */ [ 'del', 'get', 'head', 'opts', 'post', 'put', 'patch' ].forEach(function (method) { Server.prototype[method] = function (opts) { if (opts instanceof RegExp || typeof (opts) === 'string') { opts = { path: opts }; } else if (typeof (opts) === 'object') { opts = shallowCopy(opts); } else { throw new TypeError('path (string) required'); } if (arguments.length < 2) throw new TypeError('handler (function) required'); var chain = []; var route; var self = this; function addHandler(h) { assert.func(h, 'handler'); chain.push(h); } if (method === 'del') method = 'DELETE'; if (method === 'opts') method = 'OPTIONS'; opts.method = method.toUpperCase(); opts.versions = opts.versions || opts.version || self.versions; if (!Array.isArray(opts.versions)) opts.versions = [opts.versions]; if (!opts.name) { opts.name = method + '-' + (opts.path || opts.url); if (opts.versions.length > 0) { opts.name += '-' + opts.versions.join('--'); } opts.name = opts.name.replace(/\W/g, '').toLowerCase(); if (this.router.mounts[opts.name]) // GH-401 opts.name += uuid.v4().substr(0, 7); } else { opts.name = opts.name.replace(/\W/g, '').toLowerCase(); } if (!(route = this.router.mount(opts))) return (false); this.chain.forEach(addHandler); argumentsToChain(arguments, 1).forEach(addHandler); this.routes[route] = chain; return (route); }; }); /** * Minimal port of the functionality offered by Express.js Route Param * Pre-conditions * @link http://expressjs.com/guide.html#route-param%20pre-conditions * * This basically piggy-backs on the `server.use` method. It attaches a * new middleware function that only fires if the specified parameter exists * in req.params * * Exposes an API: * server.param("user", function (req, res, next) { * // load the user's information here, always making sure to call next() * }); * * @param {String} The name of the URL param to respond to * @param {Function} The middleware function to execute */ Server.prototype.param = function param(name, fn) { this.use(function _param(req, res, next) { if (req.params && req.params[name]) { fn.call(this, req, res, next, req.params[name], name); } else { next(); } }); return (this); }; /** * Piggy-backs on the `server.use` method. It attaches a new middleware * function that only fires if the specified version matchtes the request. * * Note that if the client does not request a specific version, the middleware * function always fires. If you don't want this set a default version with a * pre handler on requests where the client omits one. * * Exposes an API: * server.versionedUse("version", function (req, res, next, ver) { * // do stuff that only applies to routes of this API version * }); * * @param {String|Array} The version or versions of the URL to respond to * @param {Function} The middleware function to execute, the fourth parameter * will be the selected version */ Server.prototype.versionedUse = function versionedUse(versions, fn) { if (!Array.isArray(versions)) versions = [versions]; assert.arrayOfString(versions, 'versions'); versions.forEach(function (v) { if (!semver.valid(v)) throw new TypeError('%s is not a valid semver', v); }); this.use(function _versionedUse(req, res, next) { var ver; if (req.version() === '*' || (ver = maxSatisfying(versions, req.version()) || false)) { fn.call(this, req, res, next, ver); } else { next(); } }); return (this); }; /** * Removes a route from the server. * * You pass in the route 'blob' you got from a mount call. * * @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(route) { var r = this.router.unmount(route); if (r && this.routes[r]) delete this.routes[r]; return (r); }; /** * 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 self = this; (argumentsToChain(arguments) || []).forEach(function (h) { self.chain.push(h); }); 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; argumentsToChain(arguments).forEach(function (h) { self.before.push(h); }); return (this); }; Server.prototype.toString = function toString() { var LINE_FMT = '\t%s: %s\n'; var SUB_LINE_FMT = '\t\t%s: %s\n'; var self = this; var str = ''; function handlersToString(arr) { var s = '[' + arr.map(function (b) { return (b.name || 'function'); }).join(', ') + ']'; return (s); } str += sprintf(LINE_FMT, 'Accepts', this.acceptable.join(', ')); str += sprintf(LINE_FMT, 'Name', this.name); str += sprintf(LINE_FMT, 'Pre', handlersToString(this.before)); str += sprintf(LINE_FMT, 'Router', this.router.toString()); str += sprintf(LINE_FMT, 'Routes', ''); Object.keys(this.routes).forEach(function (k) { var handlers = handlersToString(self.routes[k]); str += sprintf(SUB_LINE_FMT, k, handlers); }); str += sprintf(LINE_FMT, 'Secure', this.secure); str += sprintf(LINE_FMT, 'Url', this.url); str += sprintf(LINE_FMT, 'Version', this.versions.join()); return (str); }; ///--- Private methods Server.prototype._handle = function _handle(req, res) { var self = this; function routeAndRun() { self._route(req, res, function (route, context) { req.context = req.params = context; req.route = route.spec; var r = route ? route.name : null; var chain = self.routes[r]; self._run(req, res, route, chain, function done(e) { self.emit('after', req, res, route, e); }); }); } if (this.before.length > 0) { this._run(req, res, null, this.before, function (err) { if (!err) { routeAndRun(); } }); } else { routeAndRun(); } }; Server.prototype._route = function _route(req, res, name, cb) { var self = this; if (typeof (name) === 'function') { cb = name; name = null; this.router.find(req, res, function onRoute(err, route, ctx) { var r = route ? route.name : null; if (err) { if (optionsError(err, req, res)) { self.emit('after', req, res, err); } else { emitRouteError(self, req, res, err); } } else if (r === 'preflight') { res.writeHead(200); res.end(); self.emit('after', req, res, null); } else if (!r || !self.routes[r]) { err = new ResourceNotFoundError(req.path()); emitRouteError(self, res, res, err); } else { cb(route, ctx); } }); } else { this.router.get(name, req, function (err, route, ctx) { if (err) { emitRouteError(self, req, res, err); } else { cb(route, ctx); } }); } }; // The goofy checks in next() are to make sure we fire the DTrace // probes after an error might have been sent, as in a handler // return next(new Error) is basically shorthand for sending an // error via res.send(), so we do that before firing the dtrace // probe (namely so the status codes get updated in the // response). // // Callers can stop the chain from proceding if they do // return next(false); This is useful for non-errors, but where // a response was sent and you don't want the chain to keep // going Server.prototype._run = function _run(req, res, route, chain, cb) { var d; var i = -1; var id = dtrace.nextId(); req._dtraceId = id; if (!req._anonFuncCount) { // Counter used to keep track of anonymous functions. Used when a // handler function is anonymous. This ensures we're using a // monotonically increasing int for anonymous handlers through out the // the lifetime of this request req._anonFuncCount = 0; } var log = this.log; var self = this; var handlerName = null; var errName; var emittedError = false; if (cb) cb = once(cb); function next(arg) { var done = false; if (arg) { if (arg instanceof Error) { errName = arg.name.replace(/Error$/, ''); log.trace({err: arg, errName: errName}, 'next(err=%s)', (arg.name || 'Error')); if (self.listeners(errName).length > 0) { self.emit(errName, req, res, arg, once(function () { res.send(arg); return (cb ? cb(arg) : true); })); emittedError = true; } else { res.send(arg); } done = true; } else if (typeof (arg) === 'string') { // GH-193, allow redirect if (req._rstfy_chained_route) { var _e = new errors.InternalError(); log.error({ err: _e }, 'Multiple next("chain") calls not ' + 'supported'); res.send(_e); return (false); } // Stop running the rest of this route since we're redirecting return self._route(req, res, arg, function (r, ctx) { req.context = req.params = ctx; req.route = r.spec; var _c = chain.slice(0, i + 1); function _uniq(fn) { return (_c.indexOf(fn) === -1); } var _routes = self.routes[r.name] || []; var _chain = _routes.filter(_uniq); req._rstfy_chained_route = true; // Need to fire DTrace done for previous handler here too. if ((i + 1) > 0 && chain[i] && !chain[i]._skip) { req.endHandlerTimer(handlerName); } self._run(req, res, r, _chain, cb); }); } } if (arg === false) done = true; // Fire DTrace done for the previous handler. if ((i + 1) > 0 && chain[i] && !chain[i]._skip) { req.endHandlerTimer(handlerName); } // Run the next handler up if (!done && chain[++i]) { if (chain[i]._skip) return (next()); if (log.trace()) log.trace('running %s', chain[i].name || '?'); req._currentRoute = (route !== null ? route.name : 'pre'); handlerName = (chain[i].name || ('handler-' + req._anonFuncCount++)); req._currentHandler = handlerName; req.startHandlerTimer(handlerName); var n = once(next); n.ifError = ifError(n); return (chain[i].call(self, req, res, n)); } dtrace._rstfy_probes['route-done'].fire(function () { return ([ self.name, route !== null ? route.name : 'pre', id, res.statusCode || 200, res.headers() ]); }); if (route === null) { self.emit('preDone', req, res); } else { self.emit('done', req, res, route); } // Don't return cb here if we emit an error since we will cb after the // handler fires. if (!emittedError) { return (cb ? cb(arg) : true); } else { return (true); } } var n1 = once(next); n1.ifError = ifError(n1); dtrace._rstfy_probes['route-start'].fire(function () { return ([ self.name, route !== null ? route.name : 'pre', id, req.method, req.href(), req.headers ]); }); d = domain.create(); d.add(req); d.add(res); d.on('error', function onError(err) { if (err._restify_next) { err._restify_next(err); } else { log.trace({err: err}, 'uncaughtException'); self.emit('uncaughtException', req, res, route, err); } }); d.run(n1); }; Server.prototype._setupRequest = function _setupRequest(req, res) { req.log = res.log = this.log; req._time = res._time = Date.now(); req.serverName = this.name; res.acceptable = this.acceptable; res.formatters = this.formatters; res.req = req; res.serverName = this.name; res.version = this.router.versions[this.router.versions.length - 1]; }; |