Merge branch 'timeout' of https://github.com/sdjcw/leanengine-node-sdk into sdjcw-timeout

Conflicts:
	lib/leanengine.js

Author: sdjcw

lib/leanengine.js

@@ -4,6 +4,7 @@ var connect = require('connect'),
   https = require('https'),
   domain = require('domain'),
   crypto = require('crypto'),
+  timeout = require('connect-timeout'),
   version = require('../package.json').version,
   AV = require('./av-extra'),
   utils = require('./utils'),
@@ -31,6 +32,8 @@ if (https.globalAgent && https.globalAgent.options) {
   https.globalAgent.options.rejectUnauthorized = false;
 }
 
+var TIMEOUT = '15s';
+
 AV.Cloud.CookieSession = avosExpressCookieSession(AV);
 AV.Cloud.HttpsRedirect = avosExpressHttpsRedirect(AV);
 
@@ -59,6 +62,7 @@ Cloud.use('/__engine/1/ping', function(req, res) {
       next();
     });
 
+    Cloud.use(route, timeout(TIMEOUT));
     Cloud.use(route, bodyParser.urlencoded({extended: false, limit: '40mb'}));
     Cloud.use(route, bodyParser.json({limit: '40mb'}));
     Cloud.use(route, bodyParser.text({limit: '40mb'}));
@@ -72,7 +76,7 @@ Cloud.use('/__engine/1/ping', function(req, res) {
       d.add(req);
       d.add(res);
       d.on('error', function(err) {
-        console.error('LeanEngine function uncaughtException url=%s, msg=%s', req.url, err.stack || err.message || err);
+        console.error('LeanEngine function uncaughtException url=%s, msg=%s', req.originalUrl, err.stack || err.message || err);
         if(!res.finished) {
           res.statusCode = 500;
           res.setHeader('content-type', 'application/json; charset=UTF-8');
@@ -262,6 +266,11 @@ Cloud.use('/__engine/1/ping', function(req, res) {
 
     // next 参数即使不使用，也一定要存在，否则 error handler 不生效
     Cloud.use(route, function(err, req, res, next) { // jshint ignore:line
+      if(req.timedout) {
+        console.error('LeanEngine function timeout, url=%s, timeout=%d', req.originalUrl, err.timeout);
+        err.code = 124; // https://leancloud.cn/docs/error_code.html#_124
+        err.message = 'The request timed out on the server.';
+      }
       respError(res, err);
     });
   });

package.json

@@ -10,6 +10,7 @@
     "avoscloud-sdk": "0.x",
     "body-parser": "1.9.0",
     "connect": "3.2.0",
+    "connect-timeout": "^1.7.0",
     "cookies": "0.5.0",
     "debug": "2.0.0",
     "iconv-lite": "^0.4.8",

test/function_test.js

@@ -211,6 +211,12 @@ AV.Cloud.define("userMatching", function(req, res) {
   }, Math.floor((Math.random() * 2000) + 1));
 });
 
+AV.Cloud.define('testTimeout', function(req, res) {
+  setTimeout(function() {
+    res.success('ok');
+  }, req.params.delay);
+});
+
 AV.Insight.on('end', function(err, result) {
   assert.deepEqual({
     "id" : "job id",
@@ -472,7 +478,6 @@ describe('functions', function() {
 
   // 测试带有 sessionToken 时，user 对象的正确解析
   it('testUser', function(done) {
-    this.timeout(5000);
     request(AV.Cloud)
       .post('/1/functions/testUser')
       .set('X-AVOSCloud-Application-Id', appId)
@@ -483,7 +488,6 @@ describe('functions', function() {
 
   // 无效 sessionToken 测试
   it('testUser_invalid_sessionToken', function(done) {
-    this.timeout(5000);
     request(AV.Cloud)
       .post('/1/functions/testUser')
       .set('X-AVOSCloud-Application-Id', appId)
@@ -498,7 +502,6 @@ describe('functions', function() {
 
   // 测试调用 run 方法时，传递 user 对象的有效性
   it('testRunWithUser', function(done) {
-    this.timeout(5000);
     request(AV.Cloud)
       .post('/1/functions/testRunWithUser')
       .set('X-AVOSCloud-Application-Id', appId)
@@ -509,7 +512,6 @@ describe('functions', function() {
 
   // 测试调用 run 方法 options callback
   it('testRun_options_callback', function(done) {
-    this.timeout(5000);
     request(AV.Cloud)
       .post('/1/functions/testRun_options_callback')
       .set('X-AVOSCloud-Application-Id', appId)
@@ -520,7 +522,6 @@ describe('functions', function() {
 
   // 测试调用 run 方法，返回值是 promise 类型
   it('testRun_promise', function(done) {
-    this.timeout(5000);
     request(AV.Cloud)
       .post('/1/functions/testRun_promise')
       .set('X-AVOSCloud-Application-Id', appId)
@@ -574,6 +575,24 @@ describe('functions', function() {
       });
   });
 
+  it('timeoutTest', function(done) {
+    this.timeout(17000);
+    request(AV.Cloud)
+      .post('/1.1/functions/testTimeout')
+      .set('X-AVOSCloud-Application-Id', appId)
+      .set('X-AVOSCloud-Application-Key', appKey)
+      .send({
+        delay: 15200,
+      })
+      .expect(503)
+      .end(function(err, res) {
+        res.body.should.eql({code:124, error:"The request timed out on the server."});
+        setTimeout(function() { // 等待业务逻辑真正响应，确认异常信息
+          done();
+        }, 1000);
+      });
+  });
+
   // 用户串号测试
   it('user_matching_func', function(done) {
     this.timeout(30000);