Merge pull request #129 from leancloud/cloud-function

feat: 增加 AV.Cloud.start() 和 AV.Cloud.stop() API

Author: sdjcw

.eslintrc.js

@@ -0,0 +1,26 @@
+module.exports = {
+    "env": {
+        "es6": true,
+        "node": true
+    },
+    "extends": "eslint:recommended",
+    "rules": {
+        "indent": [
+            "error",
+            2
+        ],
+        "linebreak-style": [
+            "error",
+            "unix"
+        ],
+        "quotes": [
+            "error",
+            "single"
+        ],
+        "semi": [
+            "error",
+            "always"
+        ],
+        "no-console": 0,
+    }
+};

API.md

@@ -166,6 +166,12 @@ LeanEngine 中间件会为这些 Hook 函数检查「Hook 签名」，确保调
 
 这些 Hook 函数签名是 `function(func: function)`，其中 `func` 是接受一个 Request 对象作为参数，返回 Promise 的函数，详见文档 [实时通信概览：云引擎 Hook](https://leancloud.cn/docs/realtime_v2.html#云引擎_Hook)
 
+### 启动和停止
+
+单独运行云函数时，可以使用 `AV.Cloud.start()` 启动应用。如果该方法调用时 AV 对象尚未初始化，则 LeanEngine 中间件会使用 `LEANCLOUD_APP_ID` 等环境变量进行初始化。
+
+在需要的时候，可以调用 `AV.Cloud.stop()` 来停止新链接的创建，但是已有链接不会主动断开。
+
 ## Middlewares
 
 因为 Node SDK 同时支持多种路由框架，需要你在创建中间件时指定类型，默认为 express：

leanengine.d.ts

@@ -145,4 +145,7 @@ export namespace Cloud {
   export function LeanCloudHeaders(options?: MiddlewareOptions): RequestHandler;
   export function CookieSession(options?: CookieSessionOptions): RequestHandler;
   export function HttpsRedirect(options?: MiddlewareOptions): RequestHandler;
+
+  export function start(): void;
+  export function stop(): void;
 }

lib/cloud.js

@@ -106,7 +106,7 @@ Cloud.enqueue = function(name, params, options) {
     }, options),
     authOptions: {useMasterKey: true}
   });
-}
+};
 
 Cloud.beforeSave = function(nameOrClass, func) {
   defineClassHook(className(nameOrClass), '__before_save_for_', func);
@@ -154,9 +154,9 @@ AV.Insight.on = function(action, func) {
 
 Cloud.Error = class CloudError extends Error {
   constructor(message, extra) {
-    super()
+    super();
 
-    extra = extra || {}
+    extra = extra || {};
 
     if (!extra.status) {
       extra.status = 400;
@@ -165,11 +165,11 @@ Cloud.Error = class CloudError extends Error {
     _.extend(this, {
       name: 'CloudError',
       message: message
-    }, extra)
+    }, extra);
 
-    Error.captureStackTrace(this, this.constructor)
+    Error.captureStackTrace(this, this.constructor);
   }
-}
+};
 
 Cloud.logInByIdAndSessionToken = function(uid, sessionToken, fetchUser, cb) {
   if (fetchUser) {
@@ -208,3 +208,25 @@ function className(clazz) {
     throw new Error('Unknown class:' + clazz);
   }
 }
+
+const PORT = parseInt(process.env.LEANCLOUD_APP_PORT || 3000);
+let server;
+
+Cloud.start = function() {
+  if (!AV.applicationId) {
+    AV.init({
+      appId: process.env.LEANCLOUD_APP_ID,
+      appKey: process.env.LEANCLOUD_APP_KEY,
+      masterKey: process.env.LEANCLOUD_APP_MASTER_KEY,
+    });
+  }
+  server = AV.express().listen(PORT, function() {
+    console.log('LeanEngine Cloud Functions app is running, port:', PORT);
+  });
+};
+
+Cloud.stop = function() {
+  if (server) {
+    server.close();
+  }
+};