🔀 Merge pull request #123 from leancloud/error

✨ Add `onError` and `ignoreInvalidSessionToken` option

Author: jysperm

CHANGELOG.md

@@ -1,5 +1,11 @@
 # 更新日志
 
+## v3.1.0
+
+- `AV.Express()` 添加 `onError`（全局云函数错误处理）和 `ignoreInvalidSessionToken`（忽略不正确的 Session Token 而不是返回错误）选项。
+- 修复改进 TypeScript 定义文件
+- 修复发出请求的 User Agent
+
 ## v3.0.2
 
 - 修复 Promise 写法的 beforeHook 无法正确工作的问题。

README.md

@@ -3,8 +3,7 @@
 ## 安装
 
 ```bash
-npm install leanengine --save
-npm install leancloud-storage@3 --save
+npm install --save leanengine leancloud-storage@3 --save
 ```
 
 建议使用 Node.js 6.0 以上的版本（可在 `package.json` 中设置 `engines.node` 为 `6.x`）。
@@ -20,7 +19,7 @@ npm install leancloud-storage@3 --save
 ## 项目示例
 
 * 项目模板：<https://github.com/leancloud/node-js-getting-started>
-* Todo 列表示例：<https://github.com/leancloud/leanengine-todo-demo>
+* Node.js Demo 汇总：<https://github.com/leancloud/leanengine-nodejs-demos>
 * 微信公众平台：<https://leancloud.cn/docs/webhosting_weixin.html>
 * 微博 OAuth 授权验证：<https://leancloud.cn/docs/webhosting_oauth.html>
 

leanengine.d.ts

@@ -23,7 +23,6 @@ declare namespace Express {
   }
 }
 
-  
 interface InitializeOptions {
   appId: string,
   appKey: string,
@@ -32,7 +31,9 @@ interface InitializeOptions {
 
 interface MiddlewareOptions {
   timeout?: string,
-  printFullStack?: boolean
+  printFullStack?: boolean,
+  onError?(err: Error),
+  ignoreInvalidSessionToken?: boolean
 }
 
 export function init(options: InitializeOptions): void;

lib/leanengine.js

@@ -93,7 +93,7 @@ function createCloudFunctionRouter(options) {
       const hookName = urlParams[2];
 
       if (!hookName) {
-        return callCloudFunction(req, functionOrClass);
+        return callCloudFunction(req, functionOrClass, options);
       } else if (functionOrClass === 'onVerified') {
         return callUserHook(req, 'onVerified', hookName);
       } else if (functionOrClass === '_User' && hookName === 'onLogin') {
@@ -131,6 +131,8 @@ function createCloudFunctionRouter(options) {
           error: err.message || err.responseText || err || 'unknown error'
         }));
       }
+
+      options.onError && options.onError(err);
     });
   });
 
@@ -146,7 +148,7 @@ function createCloudFunctionRouter(options) {
   return cloudFunctions;
 }
 
-function callCloudFunction(req, funcName) {
+function callCloudFunction(req, funcName, options) {
   const cloudFunction = Cloud.functions[funcName];
 
   if (!cloudFunction) {
@@ -165,7 +167,11 @@ function callCloudFunction(req, funcName) {
 
   return promiseTry( () => {
     if (cloudFunction.fetchUser !== false && req.AV.sessionToken && req.AV.sessionToken !== '') {
-      return AV.User.become(req.AV.sessionToken);
+      return AV.User.become(req.AV.sessionToken).catch( err => {
+        if (!options.ignoreInvalidSessionToken) {
+          throw err;
+        }
+      });
     }
   }).then( user => {
     const request = utils.prepareRequestObject({req, user, params});
@@ -245,8 +251,8 @@ function callClassHook(req, className, hookName) {
   });
 }
 
-function callUserHook(req, hookName, verifType) {
-  const userHookFunction = Cloud.functions[utils.hookNameMapping[hookName] + verifType];
+function callUserHook(req, hookName, verifyType) {
+  const userHookFunction = Cloud.functions[utils.hookNameMapping[hookName] + verifyType];
 
   checkHookKey(req);
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "leanengine",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "description": "LeanCloud LeanEngine Node.js SDK.",
   "repository": {
     "type": "git",
@@ -18,8 +18,10 @@
   },
   "devDependencies": {
     "blanket": "^1.2.3",
+    "es6-promise": "^4.2.4",
     "express": "^4.14.1",
     "mocha": "^3.2.0",
+    "npm-run-all": "^4.1.2",
     "should": "^11.2.0",
     "supertest": "^3.0.0"
   },
@@ -48,9 +50,10 @@
     "email": "support@leancloud.rocks"
   },
   "scripts": {
-    "test": "npm install leancloud-storage@3 && npm run test-express && npm run test-koa1 && npm run test-koa2",
+    "test": "npm install --no-save leancloud-storage@3 && npm-run-all test-tsd test-express test-koa1 test-koa2",
     "test-express": "mocha test test/express",
-    "test-koa1": "env FRAMEWORK=koa npm install koa@1 koa-bodyparser@2 && mocha test test/koa",
-    "test-koa2": "env FRAMEWORK=koa npm install koa@2 koa-bodyparser@4 && mocha test test/koa test/koa2"
+    "test-tsd": "tsc leanengine.d.ts",
+    "test-koa1": "env FRAMEWORK=koa npm install --no-save leancloud-storage@3 koa@1 koa-bodyparser@2 && mocha test test/koa",
+    "test-koa2": "env FRAMEWORK=koa npm install --no-save leancloud-storage@3 koa@2 koa-bodyparser@4 && mocha test test/koa test/koa2"
   }
 }

test/constructor-test.js

@@ -0,0 +1,41 @@
+const request = require('supertest');
+const should = require('should');
+
+require('./fixtures/functions');
+
+const {appId, appKey} = require('./fixtures/app-info');
+
+describe('constructor', function() {
+  it('onError option', function(done) {
+    const app = require('./fixtures/app')({
+      onError: (err) => {
+        err.message.should.be.equal('some message');
+        err.status.should.be.equal(400);
+        done();
+      }
+    });
+
+    request(app)
+      .post('/1.1/functions/clientErrorPromise')
+      .set('X-AVOSCloud-Application-Id', appId)
+      .set('X-AVOSCloud-Application-Key', appKey)
+      .expect(400, (err) => {
+        if (err) {
+          done(err);
+        }
+      });
+  });
+
+  it('ignoreInvalidSessionToken option', function(done) {
+    const app = require('./fixtures/app')({
+      ignoreInvalidSessionToken: true
+    });
+
+    request(app)
+      .post('/1.1/functions/whoami')
+      .set('X-AVOSCloud-Application-Id', appId)
+      .set('X-AVOSCloud-Application-Key', appKey)
+      .set('X-LC-Session', '00000000000000000000')
+      .expect(200, done);
+  });
+});

test/fixtures/app.js

@@ -1,12 +1,12 @@
 const AV = require('../..');
 
-module.exports = function() {
+module.exports = function(options) {
   if (process.env.FRAMEWORK == 'koa') {
     const Koa = require('koa');
     var app = new Koa();
-    app.use(AV.koa());
+    app.use(AV.koa(options));
     return app.listen();
   } else {
-    return AV.express();
+    return AV.express(options);
   }
 }

test/fixtures/functions.js

@@ -123,6 +123,10 @@ AV.Cloud.define('testUser', function(request, response) {
   response.success('ok');
 });
 
+AV.Cloud.define('whoami', function(request) {
+  return request.currentUser;
+});
+
 AV.Cloud.define('dontFetchUser', {fetchUser: false}, function(req, res) {
   should.not.exist(res.user);
   should.not.exist(res.currentUser);