Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 | /**
* 钉钉 WebSocket 连接层
*
* 职责：
* - 管理单个钉钉账号的 WebSocket 连接
* - 实现应用层心跳检测（10 秒间隔，90 秒超时）
* - 处理连接重连逻辑，带指数退避
* - 消息去重（内置 Map，5 分钟 TTL）
*
* 核心特性：
* - 关闭 SDK 内置 keepAlive，使用自定义心跳
* - 详细的消息接收日志（三阶段：接收、解析、处理）
* - 连接统计和监控（每分钟输出）
*/
import type { ClawdbotConfig, RuntimeEnv } from "openclaw/plugin-sdk";
import type { ResolvedDingtalkAccount } from "../types/index.ts";
import type { DWClient } from "dingtalk-stream";
// ============ 消息去重（内置，避免循环依赖） ============
/** 消息去重缓存 Map<messageId, timestamp> */
const processedMessages = new Map<string, number>();
/** 消息去重缓存过期时间（5 分钟） */
const MESSAGE_DEDUP_TTL = 5 * 60 * 1000;
/** 清理过期的消息去重缓存 */
function cleanupProcessedMessages(): void {
const now = Date.now();
for (const [msgId, timestamp] of processedMessages.entries()) {
if (now - timestamp > MESSAGE_DEDUP_TTL) {
processedMessages.delete(msgId);
}
}
}
/** 检查消息是否已处理过（去重） */
function isMessageProcessed(messageId: string): boolean {
if (!messageId) return false;
return processedMessages.has(messageId);
}
/** 标记消息为已处理 */
function markMessageProcessed(messageId: string): void {
if (!messageId) return;
processedMessages.set(messageId, Date.now());
// 定期清理（每处理 100 条消息清理一次）
if (processedMessages.size >= 100) {
cleanupProcessedMessages();
}
}
// ============ 类型定义 ============
export type DingtalkReactionCreatedEvent = {
type: "reaction_created";
channelId: string;
messageId: string;
userId: string;
emoji: string;
};
export type MonitorDingtalkAccountOpts = {
cfg: ClawdbotConfig;
account: ResolvedDingtalkAccount;
runtime?: RuntimeEnv;
abortSignal?: AbortSignal;
messageHandler: MessageHandler; // 直接传入消息处理器
};
// 消息处理器函数类型
export type MessageHandler = (params: {
accountId: string;
config: any;
data: any;
sessionWebhook: string;
runtime?: RuntimeEnv;
log?: any;
cfg: ClawdbotConfig;
}) => Promise<void>;
// ============ 连接配置 ============
/** 心跳间隔（毫秒） */
const HEARTBEAT_INTERVAL = 10 * 1000; // 10 秒
/** 超时阈值（毫秒） */
const TIMEOUT_THRESHOLD = 90 * 1000; // 90 秒
/** 基础退避时间（毫秒） */
const BASE_BACKOFF_DELAY = 1000; // 1 秒
/** 最大退避时间（毫秒） */
const MAX_BACKOFF_DELAY = 30 * 1000; // 30 秒
// ============ 监控账号 ============
export async function monitorSingleAccount(
opts: MonitorDingtalkAccountOpts,
): Promise<void> {
const { cfg, account, runtime, abortSignal, messageHandler } = opts;
const { accountId } = account;
// 保存 cfg 以便传递给 messageHandler
const clawdbotConfig = cfg;
const log = runtime?.log ?? {
info: (msg: string) => {
console.log(msg);
},
error: (msg: string) => {
console.error(msg);
},
debug: (msg: string) => {
console.debug(msg);
},
};
// 验证凭据是否存在
if (!account.clientId || !account.clientSecret) {
throw new Error(
`[DingTalk][${accountId}] Missing credentials: ` +
`clientId=${account.clientId ? "present" : "MISSING"}, ` +
`clientSecret=${account.clientSecret ? "present" : "MISSING"}. ` +
`Please check your configuration in channels.dingtalk-connector.`,
);
}
// 验证凭据格式
const clientIdStr = String(account.clientId);
const clientSecretStr = String(account.clientSecret);
if (clientIdStr.length < 10 || clientSecretStr.length < 10) {
throw new Error(
`[DingTalk][${accountId}] Invalid credentials format: ` +
`clientId length=${clientIdStr.length}, clientSecret length=${clientSecretStr.length}. ` +
`Credentials appear to be too short or invalid.`,
);
}
log(`[DingTalk][${accountId}] Starting DingTalk Stream client...`);
log?.info?.(
`[DingTalk][${accountId}] Initializing with clientId: ${clientIdStr.substring(0, 8)}...`,
);
log?.info?.(
`[DingTalk][${accountId}] WebSocket keepAlive: false (using application-layer heartbeat)`,
);
// 动态导入 dingtalk-stream 模块（避免循环依赖和 ESM/CJS 兼容性问题）
const dingtalkStreamModule = await import("dingtalk-stream");
const DWClient = dingtalkStreamModule.DWClient;
const { TOPIC_ROBOT } = dingtalkStreamModule;
if (!DWClient) {
throw new Error("Failed to import DWClient from dingtalk-stream module");
}
// 配置 DWClient：禁用 SDK 内置的 keepAlive 和 autoReconnect，使用自定义实现
const client = new DWClient({
clientId: account.clientId,
clientSecret: account.clientSecret,
debug: account.config.debug,
endpoint: account.config.endpoint,
autoReconnect: false, // ❌ 禁用 SDK 自动重连
keepAlive: false, // ❌ 禁用 SDK 心跳检测
} as any);
// ============ 连接状态管理 ============
let lastSocketAvailableTime = Date.now();
let isReconnecting = false;
let reconnectAttempts = 0;
let keepAliveTimer: NodeJS.Timeout | null = null;
let isStopped = false;
// ============ 辅助函数 ============
/** 计算指数退避延迟（带抖动） */
function calculateBackoffDelay(attempt: number): number {
const exponentialDelay = BASE_BACKOFF_DELAY * Math.pow(2, attempt);
const jitter = Math.random() * 1000; // 0-1 秒随机抖动
return Math.min(exponentialDelay + jitter, MAX_BACKOFF_DELAY);
}
/** 统一重连函数，带指数退避（无限重连） */
async function doReconnect(immediate = false) {
if (isReconnecting || isStopped) {
log?.debug?.(`[${accountId}] 正在重连中或已停止，跳过`);
return;
}
isReconnecting = true;
// 应用指数退避（非立即重连时）
if (!immediate && reconnectAttempts > 0) {
const delay = calculateBackoffDelay(reconnectAttempts);
log?.info?.(
`[${accountId}] ⏳ 等待 ${Math.round(delay / 1000)} 秒后重连 (尝试 ${reconnectAttempts + 1})`,
);
await new Promise((resolve) => setTimeout(resolve, delay));
}
try {
// 1. 先断开旧连接（检查 WebSocket 状态）
if (client.socket?.readyState === 1 || client.socket?.readyState === 3) {
await client.disconnect();
log?.info?.(`[${accountId}] 已断开旧连接`);
}
// 2. 重新建立连接
await client.connect();
// 3. 重置 socket 可用时间和重连计数
lastSocketAvailableTime = Date.now();
reconnectAttempts = 0; // 重连成功，重置计数
log?.info?.(`[${accountId}] ✅ 重连成功`);
} catch (err: any) {
reconnectAttempts++;
log?.error?.(
`[${accountId}] 重连失败：${err.message} (尝试 ${reconnectAttempts})`,
);
throw err;
} finally {
isReconnecting = false;
}
}
/** 监听 pong 响应（更新 socket 可用时间） */
function setupPongListener() {
client.socket?.on("pong", () => {
lastSocketAvailableTime = Date.now();
log?.debug?.(`[${accountId}] 收到 PONG 响应`);
});
}
/** 监听 WebSocket message 事件，收到 disconnect 消息时立即触发重连 */
function setupMessageListener() {
client.socket?.on("message", (data: any) => {
try {
const msg = JSON.parse(data);
if (msg.type === "SYSTEM" && msg.headers?.topic === "disconnect") {
if (!isStopped && !isReconnecting) {
// 立即重连，不退避
doReconnect(true).catch((err) => {
log?.error?.(`[${accountId}] 重连失败：${err.message}`);
});
}
}
} catch (e) {
// 忽略解析错误
}
});
}
/** 监听 WebSocket close 事件，服务端主动断开时立即触发重连 */
function setupCloseListener() {
client.socket?.on("close", (code, reason) => {
log?.info?.(
`[${accountId}] WebSocket close: code=${code}, reason=${reason || "未知"}, isStopped=${isStopped}`,
);
if (isStopped) {
return;
}
// 立即重连，不退避
setTimeout(() => {
doReconnect(true).catch((err) => {
log?.error?.(`[${accountId}] 重连失败：${err.message}`);
});
}, 0);
});
}
/**
* 启动 keepAlive 机制（单定时器 + 指数退避）
*
* 业界最佳实践：
* - 单定时器：每 10 秒检查一次，同时完成心跳和超时检测
* - 使用 WebSocket 原生 Ping
* - 指数退避重连：避免雪崩效应
*/
function startKeepAlive(): () => void {
log?.debug?.(
`[${accountId}] 🚀 启动 keepAlive 定时器，间隔=${HEARTBEAT_INTERVAL / 1000}秒`,
);
keepAliveTimer = setInterval(async () => {
if (isStopped) {
if (keepAliveTimer) clearInterval(keepAliveTimer);
return;
}
try {
const elapsed = Date.now() - lastSocketAvailableTime;
// 【超时检测】超过 90 秒未确认 socket 可用，触发重连
if (elapsed > TIMEOUT_THRESHOLD) {
log?.info?.(
`[${accountId}] ⚠️ 超时检测：已 ${Math.round(elapsed / 1000)} 秒未确认 socket 可用，触发重连...`,
);
await doReconnect();
return;
}
// 【心跳检测】检查 socket 状态
const socketState = client.socket?.readyState;
log?.debug?.(
`[${accountId}] 🔍 心跳检测：socket 状态=${socketState}, elapsed=${Math.round(elapsed / 1000)}s`,
);
if (socketState !== 1) {
log?.info?.(
`[${accountId}] ⚠️ 心跳检测：socket 状态=${socketState}，触发重连...`,
);
await doReconnect(true); // 立即重连，不退避
return;
}
// 【发送原生 Ping】更新可用时间
try {
client.socket?.ping();
lastSocketAvailableTime = Date.now();
log?.debug?.(`[${accountId}] 💓 发送 PING 心跳成功`);
} catch (err: any) {
log?.warn?.(`[${accountId}] 发送 PING 失败：${err.message}`);
// 发送失败也计入超时
}
} catch (err: any) {
log?.error?.(`[${accountId}] keepAlive 检测失败：${err.message}`);
}
}, HEARTBEAT_INTERVAL); // 每 10 秒检测一次
log?.debug?.(`[${accountId}] ✅ keepAlive 定时器已启动`);
// 返回清理函数
return () => {
if (keepAliveTimer) clearInterval(keepAliveTimer);
keepAliveTimer = null;
log?.debug?.(`[${accountId}] keepAlive 定时器已清理`);
};
}
/** 停止并清理所有资源 */
function stop() {
isStopped = true;
// 清理定时器
if (keepAliveTimer) clearInterval(keepAliveTimer);
keepAliveTimer = null;
// 清理事件监听器
if (client.socket) {
client.socket.removeAllListeners();
}
log?.debug?.(`[${accountId}] Connection 已停止`);
}
// 初始化：设置所有事件监听器
setupPongListener();
setupMessageListener();
setupCloseListener();
return new Promise<void>(async (resolve, reject) => {
// Handle abort signal
if (abortSignal) {
const onAbort = async () => {
log(`[DingTalk][${accountId}] Abort signal received, stopping...`);
stop();
try {
// 只在连接已建立时才断开
if (client.socket && client.socket.readyState === 1) {
await client.disconnect();
}
} catch (err: any) {
log?.warn?.(
`[DingTalk][${accountId}] 断开连接时出错：${err.message}`,
);
}
resolve();
};
abortSignal.addEventListener("abort", onAbort, { once: true });
}
// 消息接收统计（用于检测消息丢失）
let receivedCount = 0;
let processedCount = 0;
let lastMessageTime = Date.now();
// 定期输出统计信息
const statsInterval = setInterval(() => {
const now = Date.now();
const timeSinceLastMessage = Math.round((now - lastMessageTime) / 1000);
log?.info?.(
`[DingTalk][${accountId}] 统计：收到=${receivedCount}, 处理=${processedCount}, ` +
`丢失=${receivedCount - processedCount}, 距上次消息=${timeSinceLastMessage}s`,
);
}, 60000); // 每分钟输出一次
// Register message handler
client.registerCallbackListener(TOPIC_ROBOT, async (res: any) => {
receivedCount++;
lastMessageTime = Date.now();
const messageId = res.headers?.messageId;
const timestamp = new Date().toISOString();
// ===== 第一步：记录原始消息接收 =====
console.log(
`\n========== [DingTalk][${accountId}] 收到新消息 ==========`,
);
console.log(`时间：${timestamp}`);
console.log(`MessageId: ${messageId || "N/A"}`);
console.log(`Headers: ${JSON.stringify(res.headers || {})}`);
console.log(`Data 长度：${res.data?.length || 0} 字符`);
// 立即确认回调
if (messageId) {
client.socketCallBackResponse(messageId, { success: true });
console.log(
`[DingTalk][${accountId}] ✅ 已立即确认回调：messageId=${messageId}`,
);
} else {
console.warn(`[DingTalk][${accountId}] ⚠️ 警告：消息没有 messageId`);
}
// 消息去重
if (messageId && isMessageProcessed(messageId)) {
console.warn(
`[DingTalk][${accountId}] ⚠️ 检测到重复消息，跳过处理：messageId=${messageId}`,
);
console.log(`========== 消息处理结束（重复） ==========\n`);
return;
}
if (messageId) {
markMessageProcessed(messageId);
console.log(
`[DingTalk][${accountId}] 标记消息为已处理：messageId=${messageId}`,
);
}
// 异步处理消息
try {
// 解析消息数据
const data = JSON.parse(res.data);
// ===== 第二步：记录解析后的消息详情 =====
console.log(`\n----- 消息详情 -----`);
console.log(`消息类型：${data.msgtype || "unknown"}`);
console.log(
`会话类型：${data.conversationType === "1" ? "DM (单聊)" : data.conversationType === "2" ? "Group (群聊)" : data.conversationType}`,
);
console.log(
`发送者：${data.senderNick || "unknown"} (${data.senderStaffId || data.senderId || "unknown"})`,
);
console.log(`会话 ID: ${data.conversationId || "N/A"}`);
console.log(`消息 ID: ${data.msgId || "N/A"}`);
console.log(
`SessionWebhook: ${data.sessionWebhook ? "已提供" : "未提供"}`,
);
console.log(
`RobotCode: ${data.robotCode || account.config?.clientId || "N/A"}`,
);
// 记录消息内容（简化版，避免过长）
let contentPreview = "N/A";
if (data.text?.content) {
contentPreview =
data.text.content.length > 100
? data.text.content.substring(0, 100) + "..."
: data.text.content;
} else if (data.content) {
contentPreview =
JSON.stringify(data.content).substring(0, 100) + "...";
}
console.log(`消息内容预览：${contentPreview}`);
console.log(`完整数据字段：${Object.keys(data).join(", ")}`);
console.log(`----- 消息详情结束 -----\n`);
// ===== 第三步：开始处理消息 =====
console.log(`[DingTalk][${accountId}] 🚀 开始处理消息...`);
console.log(`AccountId: ${accountId}`);
console.log(`HasConfig: ${!!account.config}`);
await messageHandler({
accountId,
config: account.config,
data,
sessionWebhook: data.sessionWebhook,
runtime,
log,
cfg: clawdbotConfig,
});
processedCount++;
console.log(
`[DingTalk][${accountId}] ✅ 消息处理完成 (${processedCount}/${receivedCount})`,
);
console.log(`========== 消息处理结束（成功） ==========\n`);
} catch (error: any) {
processedCount++;
console.error(
`\n[DingTalk][${accountId}] ❌ 处理消息异常 (${processedCount}/${receivedCount}):`,
);
console.error(`错误类型：${error.name || "Error"}`);
console.error(`错误信息：${error.message}`);
console.error(`错误堆栈:\n${error.stack}`);
console.log(`========== 消息处理结束（失败） ==========\n`);
}
});
// 清理定时器
const cleanup = () => {
clearInterval(statsInterval);
stop();
};
// Connect to DingTalk Stream
try {
await client.connect();
log(`[DingTalk][${accountId}] Connected to DingTalk Stream successfully`);
log(`[DingTalk][${accountId}] PID: ${process.pid}`);
log(
`[DingTalk][${accountId}] ✅ 自定义 keepAlive: true (10 秒心跳，90 秒超时), 指数退避重连`,
);
// 启动自定义心跳检测
const cleanupKeepAlive = startKeepAlive();
// 重写 cleanup 函数，包含 keepAlive 清理
const enhancedCleanup = () => {
cleanupKeepAlive();
clearInterval(statsInterval);
stop();
};
// 进程退出时清理
process.on("exit", enhancedCleanup);
process.on("SIGINT", enhancedCleanup);
process.on("SIGTERM", enhancedCleanup);
} catch (error: any) {
cleanup(); // 连接失败时清理资源
// 处理 401 认证错误
if (error.response?.status === 401 || error.message?.includes("401")) {
throw new Error(
`[DingTalk][${accountId}] Authentication failed (401 Unauthorized):\n` +
` - Your clientId or clientSecret is invalid, expired, or revoked\n` +
` - clientId: ${clientIdStr.substring(0, 8)}...\n` +
` - Please verify your credentials at DingTalk Developer Console\n` +
` - Error details: ${error.message}`,
);
}
// 处理其他连接错误
throw new Error(
`[DingTalk][${accountId}] Failed to connect to DingTalk Stream: ${error.message}`,
);
}
// Handle disconnection（已被自定义 close 监听器替代）
// client.on('close', ...) - 已移除，使用 setupCloseListener
client.on("error", (err: Error) => {
log?.error?.(`[DingTalk][${accountId}] Connection error: ${err.message}`);
});
// 监听重连事件（仅用于日志，实际重连由自定义逻辑处理）
client.on("reconnect", () => {
log?.info?.(`[DingTalk][${accountId}] SDK reconnecting...`);
});
client.on("reconnected", () => {
log?.info?.(`[DingTalk][${accountId}] ✅ SDK reconnected successfully`);
});
});
}
export function resolveReactionSyntheticEvent(
event: any,
): DingtalkReactionCreatedEvent | null {
void event;
return null;
}
|