timeout support + bugfixes

README.md

@@ -59,8 +59,12 @@ API
     - when `true` is returned, request will be saved and ready to use
     - when `false` is returned, request won't be saved and cache entry will be
       served instead (if available)
+- `timeout` {object}:  Milliseconds, helps terminating requests for really
+  slow backends.
 
-`requestEnvelope` sample:
+
+`requestEnvelope` format:
+------
 ```
 	{
 		reqURL: 'http://my-api.local/method/route?action=sth',
@@ -86,9 +90,9 @@ var apiCache = new APICacheProxy({...})
 var app = express()
 
 app.use('/api', function(req, res, next) {
-	apiCacheProxy(req, res, next).catch(function(envelope) {
-		res.status(envelope.statusCode).send(
-			'<pre>' + envelope.body + '</pre>'
+	apiCacheProxy(req, res, next).catch(function(requestEnvelope) {
+		res.status(requestEnvelope.statusCode).send(
+			'<pre>' + requestEnvelope.body + '</pre>'
 		)
 	})
 })
@@ -101,9 +105,9 @@ var apiCache = new APICacheProxy({...})
 var app = express()
 
 app.use('/api', function(req, res, next) {
-	apiCacheProxy(req, res, next).then(function(status, envelope) {
+	apiCacheProxy(req, res, next).then(function(status) {
 		if (status.dataSource === 'Cache') {
-			console.warn('[' + envelope.method + '] ' + envelope.reqURL)
+			console.warn('[' + status.envelope.reqMethod + '] ' + status.envelope.reqURL)
 			console.warn('  API failure. Served: ' + status.filePath)
 		}
 	})

index.js

@@ -32,7 +32,8 @@ var defaultConfig = {
 	},
 	localURLReplace: function(url) {
 		return url
-	}
+	},
+	timeout: false
 }
 
 APICache.prototype._createEnvelope = function(response, responseBody, requestBody) {
@@ -97,26 +98,26 @@ APICache.prototype.sendCachedResponse = function(res, envelope, resolve, reject)
 		var data = fs.readFileSync(filePath, 'utf-8')
 	} catch(e) {
 		reject(envelope)
-		if (res.headersSent) { // in case of custom error handling in promise.catch
-			this.sendResponse(res, envelope.statusCode, envelope.headers, envelope.body)
-		}
+		this.sendResponse(res, envelope.statusCode, envelope.headers, envelope.body)
 		return false
 	}
 	var cachedEnvelope = JSON.parse(data)
 	var headers = cachedEnvelope.headers
 	headers[MODULE_NAME + '-hit-date'] = cachedEnvelope.cacheDate
 
-	this.sendResponse(res, cachedEnvelope.statusCode, headers, cachedEnvelope.body)
 	resolve({
 		dataSource: "Cache",
-		sourceFile: filePath,
+		filePath: filePath,
 		envelope: cachedEnvelope
 	})
+	this.sendResponse(res, cachedEnvelope.statusCode, headers, cachedEnvelope.body)
 }
 
 APICache.prototype.sendResponse = function(res, statusCode, headers, body) {
-	res.writeHead(statusCode ? statusCode : 500, headers);
-	res.end(body)
+	if (!res.headersSent) { // in case of custom error handling in promise.catch
+		res.writeHead(statusCode ? statusCode : 500, headers);
+		res.end(body)
+	}
 }
 
 /**
@@ -171,7 +172,7 @@ APICache.prototype.onError = function(err, apiReq, res, requestBody, resolve, re
 		reqBody: requestBody
 	}
 
-	this.sendCachedResponse(res, envelope, reject, resolve)
+	this.sendCachedResponse(res, envelope, resolve, reject)
 }
 /**
  * POST, PUT methods' payload need to be taken out from request object.
@@ -223,16 +224,23 @@ function APICache(config) {
 		var promise = new Promise(function(resolve, reject) {
 			var apiReq = request(url)
 
-			req.pipe(apiReq)
-				.on('response', function(response) {
-					this.onResponse(response, res, reqBodyRef.requestBody, resolve, reject)
-				}.bind(this))
-				.on('error', function(err) {
-					this.onError(err, apiReq, res, reqBodyRef.requestBody, resolve, reject)
-					promise.catch(function() {
-						log('API Error', url, err)
-					})
-				}.bind(this))
+			req
+			.pipe(apiReq)
+			.on('response', function(response) {
+				this.onResponse(response, res, reqBodyRef.requestBody, resolve, reject)
+			}.bind(this))
+			.on('error', function(err) {
+				this.onError(err, apiReq, res, reqBodyRef.requestBody, resolve, reject)
+				promise.catch(function() {
+					log('API Error', url, err)
+				})
+			}.bind(this))
+
+			if (this.config.timeout) {
+				setTimeout(function (argument) {
+					apiReq.abort()
+				}, this.config.timeout)
+			}
 		}.bind(this))
 
 		return promise

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-api-cache-proxy",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Cache requests in nodejs",
   "main": "index.js",
   "scripts": {