alemonjs 2.1.0-alpha.1 → 2.1.0-alpha.10

package/lib/cbp/connect.js

@@ -1,8 +1,66 @@
 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';
 
+// 心跳
+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 +75,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,7 +104,13 @@ 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 {
@@ -33,7 +118,7 @@ const cbpClient = (url, options = {}) => {
                 const parsedMessage = JSON.parse(message.toString());
                 logger.debug({
                     code: ResultCode.Ok,
-                    message: '接收到消息',
+                    message: '客户端接收到消息',
                     data: parsedMessage
                 });
                 if (parsedMessage?.activeId) {
@@ -47,19 +132,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 = apiTimeouts.get(parsedMessage.apiId);
+                        if (timeout) {
+                            apiTimeouts.delete(parsedMessage.apiId);
+                            clearTimeout(timeout);
+                        }
+                        // 调用回调函数
+                        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);
+                        const timeout = actionTimeouts.get(parsedMessage.actionId);
                         if (timeout) {
+                            actionTimeouts.delete(parsedMessage.actionId);
                             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.name) {
@@ -70,13 +182,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 +200,13 @@ const cbpClient = (url, options = {}) => {
                 start(); // 重新连接
             }, reconnectInterval); // 6秒后重连
         });
+        global.chatbotClient.on('error', err => {
+            logger.error({
+                code: ResultCode.Fail,
+                message: '客户端错误',
+                data: err
+            });
+        });
     };
     start();
 };
@@ -97,6 +217,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
@@ -107,29 +247,47 @@ const cbpPlatform = (url, options = {
             global.chatbotPlatform.send(JSON.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({
                 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(JSON.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 +299,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());
                 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 +338,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 +350,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

@@ -47,9 +47,41 @@ const cbpServer = (port, listeningListener) => {
             try {
                 // 解析消息
                 const parsedMessage = JSON.parse(message.toString());
-                // 1. 解析得到 actionID ，说明是消费行为请求。要广播告诉所有客户端。
+                // 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 +171,7 @@ const cbpServer = (port, listeningListener) => {
                         else {
                             logger.error({
                                 code: ResultCode.Fail,
-                                message: '出现意外，无法绑定客户端',
+                                message: '服务端出现意外，无法绑定客户端',
                                 data: null
                             });
                         }
@@ -171,7 +203,7 @@ const cbpServer = (port, listeningListener) => {
             catch (error) {
                 logger.error({
                     code: ResultCode.Fail,
-                    message: '解析平台消息失败',
+                    message: '服务端解析平台消息失败',
                     data: error
                 });
                 return;
@@ -186,6 +218,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 +256,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) => {

package/lib/core/utils.d.ts

@@ -0,0 +1,77 @@
+import { Dirent } from 'fs';
+import { ResultCode } from './code.js';
+
+/**
+ * 将字符串转为定长字符串
+ * @param str 输入字符串
+ * @param options 可选项
+ * @returns 固定长度的哈希值
+ */
+declare const createHash: (str: string, options?: {
+    length?: number;
+    algorithm?: string;
+}) => string;
+/**
+ * 使用用户的哈希键
+ * @param e
+ * @returns
+ */
+declare const useUserHashKey: (event: {
+    UserId: string;
+    Platform: string;
+}) => string;
+/**
+ * 创建app名称
+ * @param url
+ * @param app 模块名
+ * @param select 选择事件类型,默认 res
+ * @returns
+ */
+declare const createEventName: (url: string, appKey: string) => string;
+/**
+ * 将字符串转为数字
+ * @param str
+ * @returns
+ */
+declare const stringToNumber: (str: string, size?: number) => number;
+/**
+ * 递归获取所有文件
+ * @param dir
+ * @param condition
+ * @returns
+ */
+declare const getRecursiveDirFiles: (dir: string, condition?: (func: Dirent) => boolean) => {
+    path: string;
+    name: string;
+}[];
+/**
+ * 解析错误并提示缺失的模块
+ * @param e
+ * @returns
+ */
+declare const showErrorModule: (e: Error) => void;
+declare const getInputExportPath: (input?: string) => any;
+/**
+ * 属于直接调用的函数
+ * 参数错误直接抛出错误
+ * 如果函数内部有错误，则使用 Result 进行返回
+ */
+/**
+ * 异步方法。且需要读取返回值的进行判断的，
+ * 都要以 Result 作为返回值
+ */
+type Result = {
+    code: ResultCode;
+    message: string | Object;
+    data: any;
+};
+/**
+ * 创建结果
+ * @param code
+ * @param message
+ * @returns
+ */
+declare const createResult: (code: ResultCode, message: string | Object, data?: any) => Result;
+
+export { createEventName, createHash, createResult, getInputExportPath, getRecursiveDirFiles, showErrorModule, stringToNumber, useUserHashKey };
+export type { Result };

package/lib/core/utils.js

@@ -0,0 +1,162 @@
+import crypto from 'crypto';
+import fs, { existsSync, readdirSync } from 'fs';
+import path, { join } from 'path';
+import { createRequire } from 'module';
+import { ResultCode } from './code.js';
+import { file_suffix_response } from './variable.js';
+
+const require = createRequire(import.meta.url);
+/**
+ * 将字符串转为定长字符串
+ * @param str 输入字符串
+ * @param options 可选项
+ * @returns 固定长度的哈希值
+ */
+const createHash = (str, options = {}) => {
+    const { length = 11, algorithm = 'sha256' } = options;
+    // 使用 crypto 生成哈希
+    const hash = crypto.createHash(algorithm).update(str).digest('hex');
+    // 截取指定长度
+    return hash.slice(0, length);
+};
+/**
+ * 使用用户的哈希键
+ * @param e
+ * @returns
+ */
+const useUserHashKey = (event) => {
+    return createHash(`${event.Platform}:${event.UserId}`);
+};
+/**
+ * 创建app名称
+ * @param url
+ * @param app 模块名
+ * @param select 选择事件类型,默认 res
+ * @returns
+ */
+const createEventName = (url, appKey) => {
+    let uri = url;
+    if (process.platform === 'win32') {
+        uri = uri.replace(/\\/g, '/');
+    }
+    // 去掉空字符串
+    const names = uri.split('/').filter(item => item !== '');
+    // 去掉最后一个文件名
+    names.pop();
+    const name = `${appKey}:${names.join(':')}`;
+    return name;
+};
+/**
+ * 将字符串转为数字
+ * @param str
+ * @returns
+ */
+const stringToNumber = (str, size = 33) => {
+    let hash = 5381;
+    let i = str.length;
+    while (i) {
+        hash = (hash * size) ^ str.charCodeAt(--i);
+    }
+    /*JavaScript对32位签名执行逐位操作（如上面的XOR）
+     *整数。由于我们希望结果始终为正，因此转换
+     *通过执行无符号位移，将带符号的int转换为无符号*/
+    return hash >>> 0;
+};
+/**
+ * 递归获取所有文件
+ * @param dir
+ * @param condition
+ * @returns
+ */
+const getRecursiveDirFiles = (dir, condition = item => file_suffix_response.test(item.name)) => {
+    //
+    let results = [];
+    if (!existsSync(dir))
+        return results;
+    const list = readdirSync(dir, { withFileTypes: true });
+    list.forEach(item => {
+        const fullPath = join(dir, item.name);
+        if (item.isDirectory()) {
+            results = results.concat(getRecursiveDirFiles(fullPath, condition));
+        }
+        else if (item.isFile() && condition(item)) {
+            results.push({
+                path: fullPath,
+                name: item.name
+            });
+        }
+    });
+    return results;
+};
+/**
+ * 解析错误并提示缺失的模块
+ * @param e
+ * @returns
+ */
+const showErrorModule = (e) => {
+    if (!e)
+        return;
+    const moduleNotFoundRegex = /Cannot find (module|package)/;
+    // 处理模块未找到的错误
+    if (moduleNotFoundRegex.test(e?.message)) {
+        const match = e.stack?.match(/'(.+?)'/);
+        if (match) {
+            const pack = match[1];
+            logger.error({
+                code: ResultCode.FailInternal,
+                message: `缺少模块或依赖 ${pack},请安装`,
+                data: null
+            });
+            return;
+        }
+    }
+    // 处理其他错误
+    logger.error({
+        code: ResultCode.FailInternal,
+        message: e?.message,
+        data: e
+    });
+};
+const createExports = (packageJson) => {
+    if (packageJson?.exports) {
+        if (typeof packageJson.exports === 'string') {
+            return packageJson.exports;
+        }
+        else if (typeof packageJson.exports === 'object') {
+            return packageJson.exports['.'] || packageJson.exports['./index.js'];
+        }
+    }
+};
+const getInputExportPath = (input) => {
+    const packageJsonPath = path.join(input ?? process.cwd(), 'package.json');
+    if (fs.existsSync(packageJsonPath)) {
+        const packageJson = require(packageJsonPath);
+        const main = packageJson?.main || createExports(packageJson);
+        if (main) {
+            return main;
+        }
+    }
+};
+/**
+ * 创建结果
+ * @param code
+ * @param message
+ * @returns
+ */
+const createResult = (code, message, data) => {
+    // 如果不是 2000。则logger
+    if (code !== ResultCode.Ok) {
+        logger.error({
+            code,
+            message,
+            data: data
+        });
+    }
+    return {
+        code,
+        message,
+        data: data
+    };
+};
+
+export { createEventName, createHash, createResult, getInputExportPath, getRecursiveDirFiles, showErrorModule, stringToNumber, useUserHashKey };

package/lib/global.d.ts

@@ -60,6 +60,14 @@ declare global {
      * 定义数据格式
      */
     var format: OnDataFormatFunc;
+    namespace NodeJS {
+        interface ProcessEnv {
+            login?: string;
+            platform?: string;
+            port?: string;
+            NODE_ENV?: 'development' | 'production';
+        }
+    }
 }
 declare const logger: any;
 declare const core: {