pax_global_header00006660000000000000000000000064124017701300014505gustar00rootroot0000000000000052 comment=1de30afe760066e1528cafcbc5d9a586e9d03562 timeout-1.3.0/000077500000000000000000000000001240177013000131745ustar00rootroot00000000000000timeout-1.3.0/.gitignore000066400000000000000000000012221240177013000151610ustar00rootroot00000000000000# Compiled source # ################### *.com *.class *.dll *.exe *.o *.so # Packages # ############ # it's better to unpack these files and commit the raw source # git has its own built in compression methods *.7z *.dmg *.gz *.iso *.jar *.rar *.tar *.zip # Logs and databases # ###################### *.log *.sql *.sqlite # OS generated files # ###################### .DS_Store* ehthumbs.db Icon? Thumbs.db # Node.js # ########### lib-cov *.seed *.log *.csv *.dat *.out *.pid *.gz pids logs results coverage node_modules npm-debug.log # Git # ####### *.orig *.BASE.* *.BACKUP.* *.LOCAL.* *.REMOTE.* # Components # ############## /build /components timeout-1.3.0/.travis.yml000066400000000000000000000003711240177013000153060ustar00rootroot00000000000000language: node_js node_js: - "0.8" - "0.10" - "0.11" matrix: allow_failures: - node_js: "0.11" fast_finish: true script: "npm run-script test-travis" after_script: "npm install coveralls@2.10.0 && cat ./coverage/lcov.info | coveralls" timeout-1.3.0/HISTORY.md000066400000000000000000000013271240177013000146620ustar00rootroot000000000000001.3.0 / 2014-09-03 ================== * deps: debug@~2.0.0 1.2.2 / 2014-08-10 ================== * deps: on-headers@~1.0.0 1.2.1 / 2014-07-22 ================== * deps: debug@1.0.4 1.2.0 / 2014-07-11 ================== * Accept string for `time` (converted by `ms`) * deps: debug@1.0.3 - Add support for multiple wildcards in namespaces 1.1.1 / 2014-06-16 ================== * deps: debug@1.0.2 1.1.0 / 2014-04-29 ================== * Add `req.timedout` property * Add `respond` option to constructor 1.0.1 / 2014-04-28 ================== * Clear timer on socket destroy * Compatible with node.js 0.8 * deps: debug@0.8.1 1.0.0 / 2014-03-05 ================== * Genesis from `connect` timeout-1.3.0/LICENSE000066400000000000000000000022171240177013000142030ustar00rootroot00000000000000(The MIT License) Copyright (c) 2014 Jonathan Ong Copyright (c) 2014 Douglas Christopher Wilson Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. timeout-1.3.0/README.md000066400000000000000000000077121240177013000144620ustar00rootroot00000000000000# connect-timeout [![NPM Version][npm-image]][npm-url] [![NPM Downloads][downloads-image]][downloads-url] [![Build Status][travis-image]][travis-url] [![Test Coverage][coveralls-image]][coveralls-url] [![Gratipay][gratipay-image]][gratipay-url] Times out the request in `ms`, defaulting to `5000`. ## Install ```sh $ npm install connect-timeout ``` ## API **NOTE** This module is not recommend as a "top-level" middleware (i.e. `app.use(timeout('5s'))`) unless you take precautions to halt your own middleware processing. See [as top-level middleware](#as-top-level-middleware) for how to use as a top-level middleware. ### timeout(time, options) Returns middleware that times out in `time` milliseconds. `time` can also be a string accepted by the [ms](https://www.npmjs.org/package/ms#readme) module. On timeout, `req` will emit `"timeout"`. #### options * `respond` - If `true`, the timeout error is passed to `next()` so that you may customize the response behavior. This error has a `.timeout` property as well as `.status == 503`. This defaults to `true`. ### req.clearTimeout() Clears the timeout on the request. ### req.timedout `true` if timeout fired; `false` otherwise. ## Examples ### as top-level middleware Because of the way middleware processing works, this once this module passes the request to the next middleware (which it has to do in order for you to do work), it can no longer stop the flow, so you must take care to check if the request has timedout before you continue to act on the request. ```javascript var express = require('express'); var timeout = require('connect-timeout'); // example of using this top-level; note the use of haltOnTimedout // after every middleware; it will stop the request flow on a timeout var app = express(); app.use(timeout('5s')); app.use(bodyParser()); app.use(haltOnTimedout); app.use(cookieParser()); app.use(haltOnTimedout); // Add your routes here, etc. function haltOnTimedout(req, res, next){ if (!req.timedout) next(); } app.listen(3000); ``` ### express 3.x ```javascript var express = require('express'); var bodyParser = require('body-parser'); var timeout = require('connect-timeout'); var app = express(); app.post('/save', timeout('5s'), bodyParser.json(), haltOnTimedout, function(req, res, next){ savePost(req.body, function(err, id){ if (err) return next(err); if (req.timedout) return; res.send('saved as id ' + id); }); }); function haltOnTimedout(req, res, next){ if (!req.timedout) next(); } function savePost(post, cb){ setTimeout(function(){ cb(null, ((Math.random()* 40000) >>> 0)); }, (Math.random()* 7000) >>> 0)); } app.listen(3000); ``` ### connect ```javascript var bodyParser = require('body-parser'); var connect = require('connect'); var timeout = require('connect-timeout'); var app = require('connect'); app.use('/save', timeout('5s'), bodyParser.json(), haltOnTimedout, function(req, res, next){ savePost(req.body, function(err, id){ if (err) return next(err); if (req.timedout) return; res.send('saved as id ' + id); }); }); function haltOnTimedout(req, res, next){ if (!req.timedout) next(); } function savePost(post, cb){ setTimeout(function(){ cb(null, ((Math.random()* 40000) >>> 0)); }, (Math.random()* 7000) >>> 0)); } app.listen(3000); ``` ## License [MIT](LICENSE) [npm-image]: https://img.shields.io/npm/v/connect-timeout.svg?style=flat [npm-url]: https://npmjs.org/package/connect-timeout [travis-image]: https://img.shields.io/travis/expressjs/timeout.svg?style=flat [travis-url]: https://travis-ci.org/expressjs/timeout [coveralls-image]: https://img.shields.io/coveralls/expressjs/timeout.svg?style=flat [coveralls-url]: https://coveralls.io/r/expressjs/timeout?branch=master [downloads-image]: https://img.shields.io/npm/dm/connect-timeout.svg?style=flat [downloads-url]: https://npmjs.org/package/connect-timeout [gratipay-image]: https://img.shields.io/gratipay/dougwilson.svg?style=flat [gratipay-url]: https://www.gratipay.com/dougwilson/ timeout-1.3.0/index.js000066400000000000000000000026721240177013000146500ustar00rootroot00000000000000/*! * connect-timeout * Copyright(c) 2014 Jonathan Ong * Copyright(c) 2014 Douglas Christopher Wilson * MIT Licensed */ /** * Module dependencies. */ var debug = require('debug')('connect:timeout'); var ms = require('ms'); var onHeaders = require('on-headers'); /** * Timeout: * * See README.md for documentation. * * @param {Number} time * @param {Object} options * @return {Function} middleware * @api public */ module.exports = function timeout(time, options) { options = options || {}; time = typeof time === 'string' ? ms(time) : Number(time || 5000); var respond = !('respond' in options) || options.respond === true; return function(req, res, next) { var destroy = req.socket.destroy; var id = setTimeout(function(){ req.timedout = true; req.emit('timeout', time); }, time); if (respond) { req.on('timeout', onTimeout(time, next)); } req.clearTimeout = function(){ clearTimeout(id); }; req.socket.destroy = function(){ clearTimeout(id); destroy.call(this); }; req.timedout = false; onHeaders(res, function(){ clearTimeout(id); }); next(); }; }; function generateTimeoutError(){ var err = new Error('Response timeout'); err.code = 'ETIMEDOUT'; err.status = 503; return err; } function onTimeout(time, cb){ return function(){ var err = generateTimeoutError(); err.timeout = time; cb(err); }; } timeout-1.3.0/package.json000066400000000000000000000016501240177013000154640ustar00rootroot00000000000000{ "name": "connect-timeout", "description": "timeout middleware", "version": "1.3.0", "contributors": [ "Douglas Christopher Wilson ", "Jonathan Ong (http://jongleberry.com)" ], "license": "MIT", "repository": "expressjs/timeout", "dependencies": { "debug": "~2.0.0", "ms": "0.6.2", "on-headers": "~1.0.0" }, "devDependencies": { "istanbul": "0.3.0", "mocha": "~1.21.4", "should": "~4.0.4", "supertest": "~0.13.0" }, "files": [ "LICENSE", "HISTORY.md", "index.js" ], "engines": { "node": ">= 0.8" }, "scripts": { "test": "mocha --reporter spec --bail --check-leaks test/", "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/", "test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter dot --check-leaks test/" } } timeout-1.3.0/test/000077500000000000000000000000001240177013000141535ustar00rootroot00000000000000timeout-1.3.0/test/test.js000066400000000000000000000117211240177013000154720ustar00rootroot00000000000000 var http = require('http'); var request = require('supertest'); var should = require('should'); var timeout = require('..'); describe('timeout()', function(){ it('should have a default timeout', function (done) { this.timeout(10000) var server = createServer() request(server) .get('/') .expect(503, done) }) it('should accept millisecond timeout', function (done) { var server = createServer(123) request(server) .get('/') .expect(503, /123ms/, done) }) it('should accept string timeout', function (done) { var server = createServer('45ms') request(server) .get('/') .expect(503, /45ms/, done) }) describe('when below the timeout', function(){ it('should do nothing', function(done){ var server = createServer(null, function(req, res){ res.end('Hello') }) request(server) .get('/') .expect(200, 'Hello', done) }) }) describe('when above the timeout', function(){ describe('with no response made', function(){ it('should respond with 503 Request timeout', function(done){ var server = createServer(null, null, function(req, res){ req.timedout.should.be.true res.end('Hello') }) request(server) .get('/') .expect(503, done) }) it('should pass the error to next()', function(done){ var server = createServer(null, null, function(req, res){ req.timedout.should.be.true res.end('Hello') }) request(server) .get('/') .expect('Response timeout after 100ms', done); }) }) describe('with a partial response', function(){ it('should do nothing', function(done){ var server = createServer(null, function(req, res){ res.write('Hello') }, function(req, res){ req.timedout.should.be.false res.end(' World') }) request(server) .get('/') .expect(200, 'Hello World', done) }) }) }) describe('options', function(){ it('can disable auto response', function(done){ var server = createServer({respond: false}, null, function(req, res){ res.end('Timedout ' + req.timedout) }) request(server) .get('/') .expect(200, 'Timedout true', done) }) }) describe('req.clearTimeout()', function(){ it('should revert this behavior', function(done){ var server = createServer(null, function(req, res){ req.clearTimeout() }, function(req, res){ req.timedout.should.be.false res.end('Hello') }) request(server) .get('/') .expect(200, 'Hello', done) }) }) describe('destroy()', function(){ it('req should clear timer', function(done){ var server = createServer(null, function(req, res){ req.destroy() }, function(req, res){ error.code.should.equal('ECONNRESET') req.timedout.should.be.false done() }) var error; request(server) .get('/') .end(function(err){ error = err }); }) it('res should clear timer', function(done){ var server = createServer(null, function(req, res){ res.destroy() }, function(req, res){ error.code.should.equal('ECONNRESET') req.timedout.should.be.false done() }) var error; request(server) .get('/') .end(function(err){ error = err }); }) it('socket should clear timer', function(done){ var server = createServer(null, function(req, res){ req.socket.destroy() }, function(req, res){ error.code.should.equal('ECONNRESET') req.timedout.should.be.false done() }) var error; request(server) .get('/') .end(function(err){ error = err }); }) }) describe('when request aborted', function(){ it('should clear timeout', function(done){ var aborted = false var server = createServer(null, function(req, res){ req.on('aborted', function(){ aborted = true }) test.abort() }, function(req, res){ aborted.should.be.true req.timedout.should.be.false done() }) var error var test = request(server).post('/') test.write('0') }) }) }) function createServer(options, before, after) { var _ms = 100 if (typeof options !== 'object') { _ms = options options = {} } var _timeout = timeout(_ms, options) return http.createServer(function (req, res) { _timeout(req, res, function (err) { if (err) { res.statusCode = err.status || 500 res.end(err.message + ' after ' + err.timeout + 'ms') return } if (before) { before(req, res) } if (after) { setTimeout(function(){ after(req, res) }, (_ms + 100)) } }) }) }