✨ Add realtime hook define function

Author: jysperm

CHANGELOG.md

@@ -12,6 +12,7 @@
 - **不兼容改动** `AV.Insight.on` 注册的回调函数改为只接受一个 `result` 参数（去掉了 err 参数，请从 `result.status` 判断成功或失败）。
 - **不兼容改动** 一些错误提示被调整过，如果你依赖于对错误信息进行字符串匹配，请注意测试你的错误处理逻辑。
 - 新增 TypeScript 类型定义文件，位于 `leanengine.d.ts`。
+- 新增 `AV.Cloud.onIMMessageReceived` 系列方法，用于更方便地定义实时通讯 Hook 函数。
 
 **新增云函数、Class Hook 和 User Hook 的 Promise 模式**，会使用 Promise 的值作为响应内容。如果在 Promise 中抛了使用新增的 `AV.Cloud.Error` 构造的异常则作为错误返回给客户端，`AV.Cloud.Error` 的第二个参数可以指定 HTTP Status Code 和 Error Code（`AV.Cloud.Error('posts is empty', {status: 422, code: 422})`）；如果抛出了其他错误类型则视作服务器端错误，返回 500 响应并打印错误到标准输出。
 

leanengine.d.ts

@@ -115,6 +115,14 @@ declare module 'leanengine' {
     export function onVerified(handler: UserHookFunction): void;
     export function onLogin(handler: UserHookFunction): void;
 
+    export function onIMMessageReceived(handler: CloudFunction): void;
+    export function onIMReceiversOffline(handler: CloudFunction): void;
+    export function onIMMessageSent(handler: CloudFunction): void;
+    export function onIMConversationStart(handler: CloudFunction): void;
+    export function onIMConversationStarted(handler: CloudFunction): void;
+    export function onIMConversationAdd(handler: CloudFunction): void;
+    export function onIMConversationUpdate(handler: CloudFunction): void;
+
     export function LeanCloudHeaders(options?: MiddlewareOptions): RequestHandler;
     export function CookieSession(options?: CookieSessionOptions): RequestHandler;
     export function HttpsRedirect(options?: MiddlewareOptions): RequestHandler;

lib/cloud.js

@@ -112,6 +112,10 @@ Cloud.onLogin = function(func) {
   Cloud.define('__on_login__User', func);
 };
 
+_.each(utils.realtimeHookMapping, (metadataName, hookName) => {
+  Cloud[hookName] = Cloud.define.bind(null, metadataName);
+});
+
 if (!AV.Insight) {
   AV.Insight = {};
 }
@@ -168,7 +172,7 @@ function defineClassHook(className, hook, func) {
 }
 
 function className(clazz) {
-  if (utils.typeOf(clazz) === 'string') {
+  if (_.isString(clazz)) {
     return clazz;
   } else if (clazz.className) {
     return clazz.className;

lib/leanengine.js

@@ -11,22 +11,6 @@ var utils = require('./utils');
 
 var NODE_ENV = process.env.NODE_ENV || 'development';
 
-const REALTIME_HOOKS = [
-  '_messageReceived', '_receiversOffline', '_messageSent', '_conversationStart',
-  '_conversationStarted', '_conversationAdd', '_conversationRemove', '_conversationUpdate'
-];
-
-const hookNameMapping = {
-  beforeSave: '__before_save_for_',
-  beforeUpdate: '__before_update_for_',
-  afterSave: '__after_save_for_',
-  afterUpdate: '__after_update_for_',
-  beforeDelete: '__before_delete_for_',
-  afterDelete: '__after_delete_for_',
-  onVerified: '__on_verified_',
-  onLogin: '__on_login_'
-};
-
 AV.express = function(options) {
   var router = connect();
 
@@ -170,7 +154,7 @@ function callCloudFunction(req, funcName) {
     throw new Cloud.Error(`No such cloud function '${funcName}'`, {status: 404, printToLog: true, printFullStack: false});
   }
 
-  if (_.contains(REALTIME_HOOKS, funcName)) {
+  if (_.contains(_.values(utils.realtimeHookMapping), funcName)) {
     checkHookKey(req);
   }
 
@@ -212,7 +196,7 @@ function callCloudFunction(req, funcName) {
 }
 
 function callClassHook(req, className, hookName) {
-  const hookFunction = Cloud.functions[hookNameMapping[hookName] + className];
+  const hookFunction = Cloud.functions[utils.hookNameMapping[hookName] + className];
   const hookType = hookName.indexOf('before') === 0 ? 'before' : 'after';
 
   checkHookKey(req);
@@ -263,7 +247,7 @@ function callClassHook(req, className, hookName) {
 }
 
 function callUserHook(req, hookName, verifType) {
-  const userHookFunction = Cloud.functions[hookNameMapping[hookName] + verifType];
+  const userHookFunction = Cloud.functions[utils.hookNameMapping[hookName] + verifType];
 
   checkHookKey(req);
 

lib/utils.js

@@ -2,22 +2,25 @@
 
 var crypto = require('crypto');
 
-exports.typeOf = function(obj) {
-  var classToType;
-  if (obj === void 0 || obj === null) {
-    return String(obj);
-  }
-  classToType = {
-    '[object Boolean]': 'boolean',
-    '[object Number]': 'number',
-    '[object String]': 'string',
-    '[object Function]': 'function',
-    '[object Array]': 'array',
-    '[object Date]': 'date',
-    '[object RegExp]': 'regexp',
-    '[object Object]': 'object'
-  };
-  return classToType[Object.prototype.toString.call(obj)];
+exports.hookNameMapping = {
+  beforeSave: '__before_save_for_',
+  beforeUpdate: '__before_update_for_',
+  afterSave: '__after_save_for_',
+  afterUpdate: '__after_update_for_',
+  beforeDelete: '__before_delete_for_',
+  afterDelete: '__after_delete_for_',
+  onVerified: '__on_verified_',
+  onLogin: '__on_login_'
+};
+
+exports.realtimeHookMapping = {
+  onIMMessageReceived: '_messageReceived',
+  onIMReceiversOffline: '_receiversOffline',
+  onIMMessageSent: '_messageSent',
+  onIMConversationStart: '_conversationStart',
+  onIMConversationStarted: '_conversationStarted',
+  onIMConversationAdd: '_conversationAdd',
+  onIMConversationUpdate: '_conversationUpdate'
 };
 
 exports.unauthResp = function(res) {
@@ -26,18 +29,6 @@ exports.unauthResp = function(res) {
   return res.end(JSON.stringify({ code: 401, error: 'Unauthorized.' }));
 };
 
-exports.signHook = function(masterKey, hookName, ts) {
-  return ts + ',' + crypto.createHmac('sha1', masterKey).update(hookName + ':' + ts).digest('hex');
-};
-
-exports.verifyHookSign = function(masterKey, hookName, sign) {
-  if (sign) {
-    return exports.signHook(masterKey, hookName, sign.split(',')[0]) === sign;
-  } else {
-    return false;
-  }
-};
-
 /* options: req, user, params, object*/
 exports.prepareRequestObject = function(options) {
   var req = options.req;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "leanengine",
-  "version": "2.0.0-rc.0",
+  "version": "2.0.0-beta",
   "description": "LeanCloud LeanEngine Node.js SDK.",
   "repository": {
     "type": "git",

test/helpers/functions.js

@@ -223,6 +223,6 @@ AV.Cloud.define('testTimeout', function(req, res) {
   }, req.params.delay);
 });
 
-AV.Cloud.define('_messageReceived', function(request, response) {
+AV.Cloud.onIMMessageReceived(function(request, response) {
   response.success('ok');
 });