alemonjs 2.1.0-alpha.2 → 2.1.0-alpha.21

package/lib/app/store.js

@@ -15,6 +15,8 @@ import log4js from 'log4js';
 const createLogger = () => {
     const logDir = process.env?.LOG_PATH ?? `./logs/${process.env.LOG_NAME ?? ''}`;
     mkdirSync(logDir, { recursive: true });
+    // 当环境被设置为 development 时。被视为 trace
+    const level = process.env.NODE_ENV === 'development' ? 'trace' : 'info';
     log4js.configure({
         appenders: {
             console: {
@@ -48,13 +50,12 @@ const createLogger = () => {
             }
         },
         categories: {
-            default: { appenders: ['console'], level: 'error' },
-            // 记录级别
+            default: { appenders: ['console'], level: level },
             command: { appenders: ['console', 'command'], level: 'info' },
             error: { appenders: ['console', 'command', 'error'], level: 'warn' }
         }
     });
-    const defaultLogger = log4js.getLogger('message');
+    const defaultLogger = log4js.getLogger('default');
     const commandLogger = log4js.getLogger('command');
     const errorLogger = log4js.getLogger('error');
     return {

package/lib/cbp/actions.js

@@ -1,6 +1,7 @@
 import { ResultCode } from '../core/code.js';
-import { createResult } from '../app/utils.js';
+import { createResult } from '../core/utils.js';
 import { generateUniqueId, actionResolves, deviceId, actionTimeouts, timeoutTime } from './config.js';
+import * as flattedJSON from 'flatted';
 
 /**
  * 发送行为
@@ -11,20 +12,23 @@ const sendAction = (data) => {
     return new Promise(resolve => {
         actionResolves.set(actionId, resolve);
         // 设置唯一标识符
-        data.actionID = actionId;
+        data.actionId = actionId;
         // 设置设备 ID
         data.DeviceId = deviceId;
-        global.chatbotClient.send(JSON.stringify(data));
+        // 发送消息
+        global.chatbotClient.send(flattedJSON.stringify(data));
         // 12 秒后超时
         const timeout = setTimeout(() => {
-            // 不会当错误进行处理
-            resolve(createResult(ResultCode.Fail, '请求超时', null));
-            // 手动清理
-            clearTimeout(timeout);
+            // 被清理了
+            if (!actionResolves.has(actionId) || !actionTimeouts.has(actionId)) {
+                return;
+            }
             // 删除回调
             actionResolves.delete(actionId);
             // 删除超时器
             actionTimeouts.delete(actionId);
+            // 不会当错误进行处理。而是传入错误码
+            resolve([createResult(ResultCode.Fail, '行为超时', null)]);
         }, timeoutTime);
         actionTimeouts.set(actionId, timeout);
     });

package/lib/cbp/api.js

@@ -0,0 +1,37 @@
+import { ResultCode } from '../core/code.js';
+import { createResult } from '../core/utils.js';
+import { generateUniqueId, apiResolves, deviceId, apiTimeouts, timeoutTime } from './config.js';
+import * as flattedJSON from 'flatted';
+
+/**
+ * 发送行为
+ * @param data
+ */
+const sendAPI = (data) => {
+    const ApiId = generateUniqueId();
+    return new Promise(resolve => {
+        apiResolves.set(ApiId, resolve);
+        // 设置唯一标识符
+        data.apiId = ApiId;
+        // 设置设备 ID
+        data.DeviceId = deviceId;
+        // 发送消息
+        global.chatbotClient.send(flattedJSON.stringify(data));
+        // 12 秒后超时
+        const timeout = setTimeout(() => {
+            // 被清理了
+            if (!apiResolves.has(ApiId) || !apiTimeouts.has(ApiId)) {
+                return;
+            }
+            // 删除回调
+            apiResolves.delete(ApiId);
+            // 删除超时器
+            apiTimeouts.delete(ApiId);
+            // 不会当错误进行处理。而是传入错误码
+            resolve([createResult(ResultCode.Fail, '接口超时', null)]);
+        }, timeoutTime);
+        apiTimeouts.set(ApiId, timeout);
+    });
+};
+
+export { sendAPI };

package/lib/cbp/config.js

@@ -15,8 +15,12 @@ const DEVICE_ID_HEADER = 'x-device-id';
 const FULL_RECEIVE_HEADER = 'x-full-receive';
 // 行为回调
 const actionResolves = new Map();
+// 接口回调
+const apiResolves = new Map();
 // 超时器
 const actionTimeouts = new Map();
+// 接口超时器
+const apiTimeouts = new Map();
 // 分配绑定记录
 const childrenBind = new Map();
 // 生成唯一标识符
@@ -26,6 +30,8 @@ const generateUniqueId = () => {
 // 超时时间
 const timeoutTime = 1000 * 12; // 12秒
 // 失败重连
-const reconnectInterval = 6000; // 6秒
+const reconnectInterval = 1000 * 6; // 6秒
+// 心跳间隔
+const HEARTBEAT_INTERVAL = 1000 * 18; // 18秒
 
-export { DEVICE_ID_HEADER, FULL_RECEIVE_HEADER, USER_AGENT_HEADER, actionResolves, actionTimeouts, childrenBind, childrenClient, deviceId, fullClient, generateUniqueId, platformClient, reconnectInterval, timeoutTime };
+export { DEVICE_ID_HEADER, FULL_RECEIVE_HEADER, HEARTBEAT_INTERVAL, USER_AGENT_HEADER, actionResolves, actionTimeouts, apiResolves, apiTimeouts, childrenBind, childrenClient, deviceId, fullClient, generateUniqueId, platformClient, reconnectInterval, timeoutTime };

package/lib/cbp/connect.d.ts

@@ -1,6 +1,8 @@
 import { Actions } from '../typing/actions.js';
 import { EventsEnum } from '../typing/event/map.js';
+import { Result } from '../core/utils.js';
 import '../global.js';
+import { Apis } from '../typing/apis.js';
 
 type CBPClientOptions = {
     open?: () => void;
@@ -12,12 +14,14 @@ type CBPClientOptions = {
  * @param onopen
  */
 declare const cbpClient: (url: string, options?: CBPClientOptions) => void;
-type ReplyFunc = (data: Actions, consume: (payload: any) => void) => void;
+type ActionReplyFunc = (data: Actions, consume: (payload: Result[]) => void) => void;
+type ApiReplyFunc = (data: Apis, consume: (payload: Result[]) => void) => void;
 declare const cbpPlatform: (url: string, options?: {
     open: () => void;
 }) => {
     send: (data: EventsEnum) => void;
-    onactions: (reply: ReplyFunc) => void;
+    onactions: (reply: ActionReplyFunc) => void;
+    onapis: (reply: ApiReplyFunc) => void;
 };
 
 export { cbpClient, cbpPlatform };

package/lib/cbp/connect.js

@@ -1,8 +1,67 @@
 import { WebSocket } from 'ws';
 import { onProcessor } from '../app/event-processor.js';
 import { ResultCode } from '../core/code.js';
-import { deviceId, FULL_RECEIVE_HEADER, DEVICE_ID_HEADER, USER_AGENT_HEADER, actionResolves, actionTimeouts, reconnectInterval } from './config.js';
+import { deviceId, FULL_RECEIVE_HEADER, DEVICE_ID_HEADER, USER_AGENT_HEADER, apiResolves, apiTimeouts, actionResolves, actionTimeouts, reconnectInterval, HEARTBEAT_INTERVAL } from './config.js';
+import { createResult } from '../core/utils.js';
+import * as flattedJSON from 'flatted';
 
+// 心跳
+const useHeartbeat = ({ ping, isConnected, terminate }) => {
+    let heartbeatTimer = null;
+    let lastPong = Date.now();
+    const stopHeartbeat = () => {
+        if (heartbeatTimer) {
+            clearInterval(heartbeatTimer);
+            heartbeatTimer = null;
+        }
+    };
+    const callback = () => {
+        if (isConnected()) {
+            const diff = Date.now() - lastPong;
+            const max = HEARTBEAT_INTERVAL * 2; // 最大心跳间隔
+            // 检查上次 pong 是否超时
+            if (diff > max) {
+                logger.debug({
+                    code: ResultCode.Fail,
+                    message: '心跳超时，断开重连',
+                    data: null
+                });
+                terminate(); // 强制断开
+                return;
+            }
+            ping();
+            logger.debug({
+                code: ResultCode.Ok,
+                message: `发送 ping`,
+                data: null
+            });
+            heartbeatTimer = setTimeout(callback, HEARTBEAT_INTERVAL);
+        }
+        else {
+            stopHeartbeat(); // 如果连接已关闭，停止心跳
+            terminate(); // 强制断开
+        }
+    };
+    const startHeartbeat = () => {
+        lastPong = Date.now();
+        stopHeartbeat();
+        callback();
+    };
+    const control = {
+        start: startHeartbeat,
+        stop: stopHeartbeat,
+        pong: () => {
+            // 收到 pong，说明连接正常
+            lastPong = Date.now();
+            logger.debug({
+                code: ResultCode.Ok,
+                message: `收到 pong`,
+                data: null
+            });
+        }
+    };
+    return [control];
+};
 /**
  * CBP 客户端
  * @param url
@@ -17,6 +76,27 @@ const cbpClient = (url, options = {}) => {
         delete global.chatbotClient;
     }
     const { open = () => { }, isFullReceive = true } = options;
+    const [heartbeatControl] = useHeartbeat({
+        ping: () => {
+            global?.chatbotClient?.ping?.();
+        },
+        isConnected: () => {
+            return global?.chatbotClient && global?.chatbotClient?.readyState === WebSocket.OPEN;
+        },
+        terminate: () => {
+            try {
+                // 强制断开连接
+                global?.chatbotClient?.terminate?.();
+            }
+            catch (error) {
+                logger.debug({
+                    code: ResultCode.Fail,
+                    message: '强制断开连接失败',
+                    data: error
+                });
+            }
+        }
+    });
     const start = () => {
         global.chatbotClient = new WebSocket(url, {
             headers: {
@@ -25,15 +105,21 @@ const cbpClient = (url, options = {}) => {
                 [FULL_RECEIVE_HEADER]: isFullReceive ? '1' : '0'
             }
         });
-        global.chatbotClient.on('open', open);
+        global.chatbotClient.on('open', () => {
+            open();
+            heartbeatControl.start(); // 启动心跳
+        });
+        global.chatbotClient.on('pong', () => {
+            heartbeatControl.pong(); // 更新 pong 时间
+        });
         // 客户端接收，被标准化的平台消息
         global.chatbotClient.on('message', message => {
             try {
                 // 解析消息
-                const parsedMessage = JSON.parse(message.toString());
+                const parsedMessage = flattedJSON.parse(message.toString());
                 logger.debug({
                     code: ResultCode.Ok,
-                    message: '接收到消息',
+                    message: '客户端接收到消息',
                     data: parsedMessage
                 });
                 if (parsedMessage?.activeId) {
@@ -47,19 +133,46 @@ const cbpClient = (url, options = {}) => {
                         }
                     }
                 }
-                else if (parsedMessage?.actionID) {
-                    // 如果有 actionID，说明要消费掉本地的行为请求
-                    const resolve = actionResolves.get(parsedMessage.actionID);
+                else if (parsedMessage?.apiId) {
+                    // 如果有 apiId，说明是一个接口请求。要进行处理
+                    const resolve = apiResolves.get(parsedMessage.apiId);
                     if (resolve) {
+                        apiResolves.delete(parsedMessage.apiId);
                         // 清除超时器
-                        const timeout = actionTimeouts.get(parsedMessage.actionID);
+                        const timeout = apiTimeouts.get(parsedMessage.apiId);
                         if (timeout) {
+                            apiTimeouts.delete(parsedMessage.apiId);
                             clearTimeout(timeout);
-                            actionTimeouts.delete(parsedMessage.actionID);
                         }
                         // 调用回调函数
-                        resolve(parsedMessage.payload);
-                        actionResolves.delete(parsedMessage.actionID);
+                        if (Array.isArray(parsedMessage.payload)) {
+                            resolve(parsedMessage.payload);
+                        }
+                        else {
+                            // 错误处理
+                            resolve([createResult(ResultCode.Fail, '接口处理错误', null)]);
+                        }
+                    }
+                }
+                else if (parsedMessage?.actionId) {
+                    // 如果有 actionId
+                    const resolve = actionResolves.get(parsedMessage.actionId);
+                    if (resolve) {
+                        actionResolves.delete(parsedMessage.actionId);
+                        // 清除超时器
+                        const timeout = actionTimeouts.get(parsedMessage.actionId);
+                        if (timeout) {
+                            actionTimeouts.delete(parsedMessage.actionId);
+                            clearTimeout(timeout);
+                        }
+                        // 调用回调函数
+                        if (Array.isArray(parsedMessage.payload)) {
+                            resolve(parsedMessage.payload);
+                        }
+                        else {
+                            // 错误处理
+                            resolve([createResult(ResultCode.Fail, '消费处理错误', null)]);
+                        }
                     }
                 }
                 else if (parsedMessage.name) {
@@ -70,13 +183,14 @@ const cbpClient = (url, options = {}) => {
             catch (error) {
                 logger.error({
                     code: ResultCode.Fail,
-                    message: '解析消息失败',
+                    message: '客户端解析消息失败',
                     data: error
                 });
             }
         });
         global.chatbotClient.on('close', () => {
-            logger.debug({
+            heartbeatControl.stop(); // 停止心跳
+            logger.warn({
                 code: ResultCode.Fail,
                 message: '连接关闭，尝试重新连接...',
                 data: null
@@ -87,6 +201,13 @@ const cbpClient = (url, options = {}) => {
                 start(); // 重新连接
             }, reconnectInterval); // 6秒后重连
         });
+        global.chatbotClient.on('error', err => {
+            logger.error({
+                code: ResultCode.Fail,
+                message: '客户端错误',
+                data: err
+            });
+        });
     };
     start();
 };
@@ -97,6 +218,26 @@ const cbpPlatform = (url, options = {
         delete global.chatbotPlatform;
     }
     const { open = () => { } } = options;
+    const [heartbeatControl] = useHeartbeat({
+        ping: () => {
+            global?.chatbotPlatform?.ping?.();
+        },
+        isConnected: () => {
+            return global?.chatbotPlatform && global?.chatbotPlatform?.readyState === WebSocket.OPEN;
+        },
+        terminate: () => {
+            try {
+                global?.chatbotPlatform?.terminate?.();
+            }
+            catch (error) {
+                logger.debug({
+                    code: ResultCode.Fail,
+                    message: '强制断开连接失败',
+                    data: error
+                });
+            }
+        }
+    });
     /**
      * 发送数据
      * @param data
@@ -104,32 +245,50 @@ const cbpPlatform = (url, options = {
     const send = (data) => {
         if (global.chatbotPlatform && global.chatbotPlatform.readyState === WebSocket.OPEN) {
             data.DeviceId = deviceId; // 设置设备 ID
-            global.chatbotPlatform.send(JSON.stringify(data));
+            global.chatbotPlatform.send(flattedJSON.stringify(data));
         }
     };
-    const msg = [];
+    const actionReplys = [];
+    const apiReplys = [];
     /**
      * 消费数据
      * @param data
      * @param payload
      */
-    const reply = (data, payload) => {
+    const replyAction = (data, payload) => {
         if (global.chatbotPlatform && global.chatbotPlatform.readyState === WebSocket.OPEN) {
-            global.chatbotPlatform.send(JSON.stringify({
+            // 透传消费。也就是对应的设备进行处理消费。
+            global.chatbotPlatform.send(flattedJSON.stringify({
                 action: data.action,
                 payload: payload,
-                actionID: data.actionID,
-                // 透传消费。也就是对应的设备进行处理消费。
+                actionId: data.actionId,
                 DeviceId: data.DeviceId
             }));
         }
     };
+    const replyApi = (data, payload) => {
+        if (global.chatbotPlatform && global.chatbotPlatform.readyState === WebSocket.OPEN) {
+            // 透传消费。也就是对应的设备进行处理消费。
+            global.chatbotPlatform.send(flattedJSON.stringify({
+                action: data.action,
+                apiId: data.apiId,
+                DeviceId: data.DeviceId,
+                payload: payload
+            }));
+        }
+    };
     /**
      * 接收行为
      * @param reply
      */
     const onactions = (reply) => {
-        msg.push(reply);
+        actionReplys.push(reply);
+    };
+    /**
+     * 接收接口
+     */
+    const onapis = (reply) => {
+        apiReplys.push(reply);
     };
     /**
      * 启动 WebSocket 连接
@@ -141,19 +300,34 @@ const cbpPlatform = (url, options = {
                 [DEVICE_ID_HEADER]: deviceId
             }
         });
-        global.chatbotPlatform.on('open', open);
+        global.chatbotPlatform.on('open', () => {
+            open();
+            heartbeatControl.start(); // 启动心跳
+        });
+        global.chatbotPlatform.on('pong', () => {
+            heartbeatControl.pong(); // 更新 pong 时间
+        });
         global.chatbotPlatform.on('message', message => {
             try {
-                const data = JSON.parse(message.toString());
+                const data = flattedJSON.parse(message.toString());
                 logger.debug({
                     code: ResultCode.Ok,
-                    message: '平台接收消息',
+                    message: '平台端接收消息',
                     data: data
                 });
-                for (const cb of msg) {
-                    cb(data, 
-                    // 传入一个消费函数
-                    val => reply(data, val));
+                if (data.apiId) {
+                    for (const cb of apiReplys) {
+                        cb(data, 
+                        // 传入一个消费函数
+                        val => replyApi(data, val));
+                    }
+                }
+                else if (data.actionId) {
+                    for (const cb of actionReplys) {
+                        cb(data, 
+                        // 传入一个消费函数
+                        val => replyAction(data, val));
+                    }
                 }
             }
             catch (error) {
@@ -165,9 +339,10 @@ const cbpPlatform = (url, options = {
             }
         });
         global.chatbotPlatform.on('close', err => {
-            logger.debug({
+            heartbeatControl.stop(); // 停止心跳
+            logger.warn({
                 code: ResultCode.Fail,
-                message: '平台连接关闭，尝试重新连接...',
+                message: '平台端连接关闭，尝试重新连接...',
                 data: err
             });
             delete global.chatbotPlatform;
@@ -176,11 +351,19 @@ const cbpPlatform = (url, options = {
                 start(); // 重新连接
             }, reconnectInterval); // 6秒后重连
         });
+        global.chatbotPlatform.on('error', err => {
+            logger.error({
+                code: ResultCode.Fail,
+                message: '平台端错误',
+                data: err
+            });
+        });
     };
     start();
     const client = {
         send,
-        onactions
+        onactions,
+        onapis
     };
     return client;
 };

package/lib/cbp/index.js

@@ -6,6 +6,7 @@ import koaCors from '@koa/cors';
 import { ResultCode } from '../core/code.js';
 import { USER_AGENT_HEADER, DEVICE_ID_HEADER, FULL_RECEIVE_HEADER, platformClient, childrenClient, fullClient, childrenBind } from './config.js';
 import { getConfig } from '../core/config.js';
+import * as flattedJSON from 'flatted';
 
 const cbpServer = (port, listeningListener) => {
     if (global.chatbotServer) {
@@ -46,10 +47,42 @@ const cbpServer = (port, listeningListener) => {
         ws.on('message', (message) => {
             try {
                 // 解析消息
-                const parsedMessage = JSON.parse(message.toString());
-                // 1. 解析得到 actionID ，说明是消费行为请求。要广播告诉所有客户端。
+                const parsedMessage = flattedJSON.parse(message.toString());
+                // 1. 解析得到 actionId ，说明是消费行为请求。要广播告诉所有客户端。
                 // 2. 解析得到 name ，说明是一个事件请求。
-                if (parsedMessage?.actionID) {
+                // 3. 解析得到 apiId ，说明是一个接口请求。
+                logger.debug({
+                    code: ResultCode.Ok,
+                    message: '服务端接收到消息',
+                    data: parsedMessage
+                });
+                if (parsedMessage.apiId) {
+                    // 指定的设备 处理消费。终端有记录每个客户端是谁
+                    const DeviceId = parsedMessage.DeviceId;
+                    if (childrenClient.has(DeviceId)) {
+                        const clientWs = childrenClient.get(DeviceId);
+                        if (clientWs && clientWs.readyState === WebSocket.OPEN) {
+                            // 发送消息到指定的子客户端
+                            clientWs.send(message);
+                        }
+                        else {
+                            // 如果连接已关闭，删除该客户端
+                            childrenClient.delete(DeviceId);
+                        }
+                    }
+                    else if (fullClient.has(DeviceId)) {
+                        const clientWs = fullClient.get(DeviceId);
+                        if (clientWs && clientWs.readyState === WebSocket.OPEN) {
+                            // 发送消息到指定的全量客户端
+                            clientWs.send(message);
+                        }
+                        else {
+                            // 如果连接已关闭，删除该客户端
+                            fullClient.delete(DeviceId);
+                        }
+                    }
+                }
+                else if (parsedMessage?.actionId) {
                     // 指定的设备 处理消费。终端有记录每个客户端是谁
                     const DeviceId = parsedMessage.DeviceId;
                     if (childrenClient.has(DeviceId)) {
@@ -139,7 +172,7 @@ const cbpServer = (port, listeningListener) => {
                         else {
                             logger.error({
                                 code: ResultCode.Fail,
-                                message: '出现意外，无法绑定客户端',
+                                message: '服务端出现意外，无法绑定客户端',
                                 data: null
                             });
                         }
@@ -171,7 +204,7 @@ const cbpServer = (port, listeningListener) => {
             catch (error) {
                 logger.error({
                     code: ResultCode.Fail,
-                    message: '解析平台消息失败',
+                    message: '服务端解析平台消息失败',
                     data: error
                 });
                 return;
@@ -186,6 +219,13 @@ const cbpServer = (port, listeningListener) => {
                 data: null
             });
         });
+        ws.on('error', err => {
+            logger.error({
+                code: ResultCode.Fail,
+                message: `Client ${originId} error`,
+                data: err
+            });
+        });
     };
     // 设置子客户端
     const setChildrenClient = (originId, ws) => {
@@ -217,6 +257,13 @@ const cbpServer = (port, listeningListener) => {
                 data: null
             });
         });
+        ws.on('error', err => {
+            logger.error({
+                code: ResultCode.Fail,
+                message: `Client ${originId} error`,
+                data: err
+            });
+        });
     };
     // 全量客户端
     const setFullClient = (originId, ws) => {
@@ -272,7 +319,7 @@ const cbpServer = (port, listeningListener) => {
             return;
         }
         // 连接时，需要给客户端发送主动消息
-        ws.send(JSON.stringify({
+        ws.send(flattedJSON.stringify({
             active: 'sync',
             payload: {
                 value: getConfig().value,

package/lib/{app → core}/utils.d.ts

@@ -1,5 +1,5 @@
 import { Dirent } from 'fs';
-import { ResultCode } from '../core/code.js';
+import { ResultCode } from './code.js';
 
 /**
  * 将字符串转为定长字符串
@@ -30,8 +30,7 @@ declare const useUserHashKey: (event: {
 declare const createEventName: (url: string, appKey: string) => string;
 /**
  * 将字符串转为数字
- * @param str
- * @returns
+ * @deprecated 已废弃
  */
 declare const stringToNumber: (str: string, size?: number) => number;
 /**

package/lib/{app → core}/utils.js

@@ -2,8 +2,8 @@ import crypto from 'crypto';
 import fs, { existsSync, readdirSync } from 'fs';
 import path, { join } from 'path';
 import { createRequire } from 'module';
-import { ResultCode } from '../core/code.js';
-import { file_suffix_response } from '../core/variable.js';
+import { ResultCode } from './code.js';
+import { file_suffix_response } from './variable.js';
 
 const require = createRequire(import.meta.url);
 /**
@@ -48,8 +48,7 @@ const createEventName = (url, appKey) => {
 };
 /**
  * 将字符串转为数字
- * @param str
- * @returns
+ * @deprecated 已废弃
  */
 const stringToNumber = (str, size = 33) => {
     let hash = 5381;