feat: event log of bots (#1441)

* feat: basic arch of event log

* feat: complete event log framework

* fix: bad struct in bot log api

* feat: add event logging to all platform adapters

Co-Authored-By: wangcham233@gmail.com <651122857@qq.com>

* feat: add event logging to client classes

Co-Authored-By: wangcham233@gmail.com <651122857@qq.com>

* refactor: bot log getting api

* perf: logger for aiocqhttp and gewechat

* fix: add ignored logger in dingtalk

* fix: seq id bug in log getting

* feat: add logger in dingtalk,QQ official,Slack, wxoa

* feat: add logger for wecom

* feat: add logger for wecomcs

* perf(event logger): image processing

* 完成机器人日志的前端部分 (#1479)

* feat: webui  bot log framework done

* feat: bot log complete

* perf(bot-log): style

* chore: fix incompleted i18n

* feat: support message session copy

* fix: filter and badge text

* perf: styles

* feat: add bot toggle switch in bot card

* fix: linter errors

---------

Co-authored-by: Junyan Qin <rockchinq@gmail.com>

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: wangcham233@gmail.com <651122857@qq.com>
Co-authored-by: HYana <65863826+KaedeSAMA@users.noreply.github.com>

pkg/platform/sources/aiocqhttp.py

@@ -12,6 +12,7 @@ from ..types import message as platform_message
 from ..types import events as platform_events
 from ..types import entities as platform_entities
 from ...utils import image
+from ..logger import EventLogger
 
 
 class AiocqhttpMessageConverter(adapter.MessageConverter):
@@ -209,8 +210,11 @@ class AiocqhttpAdapter(adapter.MessagePlatformAdapter):
 
     ap: app.Application
 
-    def __init__(self, config: dict, ap: app.Application):
+    on_websocket_connection_event_cache: typing.List[typing.Callable[[aiocqhttp.Event], None]] = []
+
+    def __init__(self, config: dict, ap: app.Application, logger: EventLogger):
         self.config = config
+        self.logger = logger
 
         async def shutdown_trigger_placeholder():
             while True:
@@ -219,6 +223,7 @@ class AiocqhttpAdapter(adapter.MessagePlatformAdapter):
         self.config['shutdown_trigger'] = shutdown_trigger_placeholder
 
         self.ap = ap
+        self.on_websocket_connection_event_cache = []
 
         if 'access-token' in config:
             self.bot = aiocqhttp.CQHttp(access_token=config['access-token'])
@@ -260,6 +265,7 @@ class AiocqhttpAdapter(adapter.MessagePlatformAdapter):
             try:
                 return await callback(await self.event_converter.target2yiri(event,self.bot), self)
             except Exception:
+                await self.logger.error(f'Error in on_message: {traceback.format_exc()}')
                 traceback.print_exc()
 
         if event_type == platform_events.GroupMessage:
@@ -267,6 +273,16 @@ class AiocqhttpAdapter(adapter.MessagePlatformAdapter):
         elif event_type == platform_events.FriendMessage:
             self.bot.on_message('private')(on_message)
 
+        async def on_websocket_connection(event: aiocqhttp.Event):
+            for event in self.on_websocket_connection_event_cache:
+                if event.self_id == event.self_id and event.time == event.time:
+                    return
+
+            self.on_websocket_connection_event_cache.append(event)
+            await self.logger.info(f'WebSocket connection established, bot id: {event.self_id}')
+
+        self.bot.on_websocket_connection(on_websocket_connection)
+
     def unregister_listener(
         self,
         event_type: typing.Type[platform_events.Event],

pkg/platform/sources/dingtalk.py

@@ -9,6 +9,7 @@ from ..types import events as platform_events
 from ..types import entities as platform_entities
 from libs.dingtalk_api.api import DingTalkClient
 import datetime
+from ..logger import EventLogger
 
 
 class DingTalkMessageConverter(adapter.MessageConverter):
@@ -99,9 +100,10 @@ class DingTalkAdapter(adapter.MessagePlatformAdapter):
     event_converter: DingTalkEventConverter = DingTalkEventConverter()
     config: dict
 
-    def __init__(self, config: dict, ap: app.Application):
+    def __init__(self, config: dict, ap: app.Application, logger: EventLogger):
         self.config = config
         self.ap = ap
+        self.logger = logger
         required_keys = [
             'client_id',
             'client_secret',
@@ -120,6 +122,7 @@ class DingTalkAdapter(adapter.MessagePlatformAdapter):
             robot_name=config['robot_name'],
             robot_code=config['robot_code'],
             markdown_card=config['markdown_card'],
+            logger=self.logger,
         )
 
     async def reply_message(
@@ -154,8 +157,8 @@ class DingTalkAdapter(adapter.MessagePlatformAdapter):
                     await self.event_converter.target2yiri(event, self.config['robot_name']),
                     self,
                 )
-            except Exception:
-                traceback.print_exc()
+            except Exception as e:
+                await self.logger.error(f"Error in dingtalk callback: {traceback.format_exc()}")
 
         if event_type == platform_events.FriendMessage:
             self.bot.on_message('FriendMessage')(on_message)

pkg/platform/sources/discord.py

@@ -16,6 +16,7 @@ from ...core import app
 from ..types import message as platform_message
 from ..types import events as platform_events
 from ..types import entities as platform_entities
+from ..logger import EventLogger
 
 
 class DiscordMessageConverter(adapter.MessageConverter):
@@ -170,9 +171,10 @@ class DiscordAdapter(adapter.MessagePlatformAdapter):
         typing.Callable[[platform_events.Event, adapter.MessagePlatformAdapter], None],
     ] = {}
 
-    def __init__(self, config: dict, ap: app.Application):
+    def __init__(self, config: dict, ap: app.Application, logger: EventLogger):
         self.config = config
         self.ap = ap
+        self.logger = logger
 
         self.bot_account_id = self.config['client_id']
 

pkg/platform/sources/gewechat.py

@@ -20,6 +20,7 @@ from ...utils import image
 import xml.etree.ElementTree as ET
 from typing import Optional, Tuple
 from functools import partial
+from ..logger import EventLogger
 
 
 class GewechatMessageConverter(adapter.MessageConverter):
@@ -371,7 +372,7 @@ class GewechatMessageConverter(adapter.MessageConverter):
                     quote_id = appmsg_data.find('.//refermsg').findtext('.//chatusr')  # 引用消息的原发送者
                     ats_bot = ats_bot or (quote_id == tousername)
         except Exception as e:
-            print(f'_ats_bot got except: {e}')
+            print(f'Error in gewechat _ats_bot: {e}')
         finally:
             return ats_bot
 
@@ -477,9 +478,10 @@ class GeWeChatAdapter(adapter.MessagePlatformAdapter):
         typing.Callable[[platform_events.Event, adapter.MessagePlatformAdapter], None],
     ] = {}
 
-    def __init__(self, config: dict, ap: app.Application):
+    def __init__(self, config: dict, ap: app.Application, logger: EventLogger):
         self.config = config
         self.ap = ap
+        self.logger = logger
         self.quart_app = quart.Quart(__name__)
 
         self.message_converter = GewechatMessageConverter(config)
@@ -503,7 +505,7 @@ class GeWeChatAdapter(adapter.MessagePlatformAdapter):
                 try:
                     event = await self.event_converter.target2yiri(data.copy(), self.bot_account_id)
                 except Exception:
-                    traceback.print_exc()
+                    await self.logger.error(f'Error in gewechat callback: {traceback.format_exc()}')
 
                 if event.__class__ in self.listeners:
                     await self.listeners[event.__class__](event, self)

pkg/platform/sources/lark.py

@@ -23,6 +23,7 @@ from ...core import app
 from ..types import message as platform_message
 from ..types import events as platform_events
 from ..types import entities as platform_entities
+from ..logger import EventLogger
 
 
 class AESCipher(object):
@@ -338,9 +339,10 @@ class LarkAdapter(adapter.MessagePlatformAdapter):
     quart_app: quart.Quart
     ap: app.Application
 
-    def __init__(self, config: dict, ap: app.Application):
+    def __init__(self, config: dict, ap: app.Application, logger: EventLogger):
         self.config = config
         self.ap = ap
+        self.logger = logger
         self.quart_app = quart.Quart(__name__)
         self.listeners = {}
 
@@ -376,15 +378,15 @@ class LarkAdapter(adapter.MessagePlatformAdapter):
                 if 'im.message.receive_v1' == type:
                     try:
                         event = await self.event_converter.target2yiri(p2v1, self.api_client)
-                    except Exception:
-                        traceback.print_exc()
+                    except Exception as e:
+                        await self.logger.error(f"Error in lark callback: {traceback.format_exc()}")
 
                     if event.__class__ in self.listeners:
                         await self.listeners[event.__class__](event, self)
 
                 return {'code': 200, 'message': 'ok'}
-            except Exception:
-                traceback.print_exc()
+            except Exception as e:
+                await self.logger.error(f"Error in lark callback: {traceback.format_exc()}")
                 return {'code': 500, 'message': 'error'}
 
         async def on_message(event: lark_oapi.im.v1.P2ImMessageReceiveV1):

pkg/platform/sources/nakuru.py

@@ -14,6 +14,7 @@ from ...pipeline.longtext.strategies import forward
 from ...platform.types import message as platform_message
 from ...platform.types import entities as platform_entities
 from ...platform.types import events as platform_events
+from ..logger import EventLogger
 
 
 class NakuruProjectMessageConverter(adapter_model.MessageConverter):
@@ -71,9 +72,8 @@ class NakuruProjectMessageConverter(adapter_model.MessageConverter):
                             content=content_list,
                         )
                         nakuru_forward_node_list.append(nakuru_forward_node)
-                    except Exception:
+                    except Exception as e:
                         import traceback
-
                         traceback.print_exc()
 
                 nakuru_msg_list.append(nakuru_forward_node_list)
@@ -178,12 +178,13 @@ class NakuruAdapter(adapter_model.MessagePlatformAdapter):
 
     cfg: dict
 
-    def __init__(self, cfg: dict, ap):
+    def __init__(self, cfg: dict, ap, logger: EventLogger):
         """初始化nakuru-project的对象"""
         cfg['port'] = cfg['ws_port']
         del cfg['ws_port']
         self.cfg = cfg
         self.ap = ap
+        self.logger = logger
         self.listener_list = []
         self.bot = nakuru.CQHTTP(**self.cfg)
 
@@ -275,7 +276,7 @@ class NakuruAdapter(adapter_model.MessagePlatformAdapter):
             # 注册监听器
             self.bot.receiver(source_cls.__name__)(listener_wrapper)
         except Exception as e:
-            traceback.print_exc()
+            self.logger.error(f"Error in nakuru register_listener: {traceback.format_exc()}")
             raise e
 
     def unregister_listener(

pkg/platform/sources/officialaccount.py

@@ -13,6 +13,7 @@ from .. import adapter
 from ...core import app
 from ..types import entities as platform_entities
 from ...command.errors import ParamNotEnoughError
+from ..logger import EventLogger
 
 
 class OAMessageConverter(adapter.MessageConverter):
@@ -63,10 +64,10 @@ class OfficialAccountAdapter(adapter.MessagePlatformAdapter):
     event_converter: OAEventConverter = OAEventConverter()
     config: dict
 
-    def __init__(self, config: dict, ap: app.Application):
+    def __init__(self, config: dict, ap: app.Application, logger: EventLogger):
         self.config = config
-
         self.ap = ap
+        self.logger = logger
 
         required_keys = [
             'token',
@@ -85,6 +86,7 @@ class OfficialAccountAdapter(adapter.MessagePlatformAdapter):
                 EncodingAESKey=config['EncodingAESKey'],
                 Appsecret=config['AppSecret'],
                 AppID=config['AppID'],
+                logger=self.logger,
             )
         elif self.config['Mode'] == 'passive':
             self.bot = OAClientForLongerResponse(
@@ -93,6 +95,7 @@ class OfficialAccountAdapter(adapter.MessagePlatformAdapter):
                 Appsecret=config['AppSecret'],
                 AppID=config['AppID'],
                 LoadingMessage=config['LoadingMessage'],
+                logger=self.logger,
             )
         else:
             raise KeyError('请设置微信公众号通信模式')
@@ -122,8 +125,8 @@ class OfficialAccountAdapter(adapter.MessagePlatformAdapter):
             self.bot_account_id = event.receiver_id
             try:
                 return await callback(await self.event_converter.target2yiri(event), self)
-            except Exception:
-                traceback.print_exc()
+            except Exception as e:
+                await self.logger.error(f"Error in officialaccount callback: {traceback.format_exc()}")
 
         if event_type == platform_events.FriendMessage:
             self.bot.on_message('text')(on_message)

pkg/platform/sources/qqbotpy.py

@@ -17,6 +17,7 @@ from ...config import manager as cfg_mgr
 from ...platform.types import entities as platform_entities
 from ...platform.types import events as platform_events
 from ...platform.types import message as platform_message
+from ..logger import EventLogger
 
 
 class OfficialGroupMessage(platform_events.GroupMessage):
@@ -357,10 +358,11 @@ class OfficialAdapter(adapter_model.MessagePlatformAdapter):
     group_msg_seq = None
     c2c_msg_seq = None
 
-    def __init__(self, cfg: dict, ap: app.Application):
+    def __init__(self, cfg: dict, ap: app.Application, logger: EventLogger):
         """初始化适配器"""
         self.cfg = cfg
         self.ap = ap
+        self.logger = logger
 
         self.group_msg_seq = 1
         self.c2c_msg_seq = 1
@@ -499,7 +501,7 @@ class OfficialAdapter(adapter_model.MessagePlatformAdapter):
             for event_handler in event_handler_mapping[event_type]:
                 setattr(self.bot, event_handler, wrapper)
         except Exception as e:
-            traceback.print_exc()
+            self.logger.error(f"Error in qqbotpy callback: {traceback.format_exc()}")
             raise e
 
     def unregister_listener(

pkg/platform/sources/qqofficial.py

@@ -14,6 +14,7 @@ from ...command.errors import ParamNotEnoughError
 from libs.qq_official_api.api import QQOfficialClient
 from libs.qq_official_api.qqofficialevent import QQOfficialEvent
 from ...utils import image
+from ..logger import EventLogger
 
 
 class QQOfficialMessageConverter(adapter.MessageConverter):
@@ -139,9 +140,10 @@ class QQOfficialAdapter(adapter.MessagePlatformAdapter):
     message_converter: QQOfficialMessageConverter = QQOfficialMessageConverter()
     event_converter: QQOfficialEventConverter = QQOfficialEventConverter()
 
-    def __init__(self, config: dict, ap: app.Application):
+    def __init__(self, config: dict, ap: app.Application, logger: EventLogger):
         self.config = config
         self.ap = ap
+        self.logger = logger
 
         required_keys = [
             'appid',
@@ -155,6 +157,7 @@ class QQOfficialAdapter(adapter.MessagePlatformAdapter):
             app_id=config['appid'],
             secret=config['secret'],
             token=config['token'],
+            logger=self.logger
         )
 
     async def reply_message(
@@ -221,8 +224,8 @@ class QQOfficialAdapter(adapter.MessagePlatformAdapter):
             self.bot_account_id = 'justbot'
             try:
                 return await callback(await self.event_converter.target2yiri(event), self)
-            except Exception:
-                traceback.print_exc()
+            except Exception as e:
+                await self.logger.error(f"Error in qqofficial callback: {traceback.format_exc()}")
 
         if event_type == platform_events.FriendMessage:
             self.bot.on_message('DIRECT_MESSAGE_CREATE')(on_message)

pkg/platform/sources/slack.py

@@ -14,6 +14,7 @@ from .. import adapter
 from ..types import entities as platform_entities
 from ...command.errors import ParamNotEnoughError
 from ...utils import image
+from ..logger import EventLogger
 
 
 class SlackMessageConverter(adapter.MessageConverter):
@@ -91,9 +92,10 @@ class SlackAdapter(adapter.MessagePlatformAdapter):
     event_converter: SlackEventConverter = SlackEventConverter()
     config: dict
 
-    def __init__(self, config: dict, ap: app.Application):
+    def __init__(self, config: dict, ap: app.Application, logger: EventLogger):
         self.config = config
         self.ap = ap
+        self.logger = logger
         required_keys = [
             'bot_token',
             'signing_secret',
@@ -102,7 +104,7 @@ class SlackAdapter(adapter.MessagePlatformAdapter):
         if missing_keys:
             raise ParamNotEnoughError('Slack机器人缺少相关配置项，请查看文档或联系管理员')
 
-        self.bot = SlackClient(bot_token=self.config['bot_token'], signing_secret=self.config['signing_secret'])
+        self.bot = SlackClient(bot_token=self.config['bot_token'], signing_secret=self.config['signing_secret'], logger=self.logger)
 
     async def reply_message(
         self,
@@ -137,8 +139,8 @@ class SlackAdapter(adapter.MessagePlatformAdapter):
             self.bot_account_id = 'SlackBot'
             try:
                 return await callback(await self.event_converter.target2yiri(event, self.bot), self)
-            except:
-                traceback.print_exc()
+            except Exception as e:
+                await self.logger.error(f"Error in slack callback: {traceback.format_exc()}")
 
         if event_type == platform_events.FriendMessage:
             self.bot.on_message('im')(on_message)

pkg/platform/sources/telegram.py

@@ -17,6 +17,7 @@ from ...core import app
 from ..types import message as platform_message
 from ..types import events as platform_events
 from ..types import entities as platform_entities
+from ..logger import EventLogger
 
 
 class TelegramMessageConverter(adapter.MessageConverter):
@@ -147,9 +148,10 @@ class TelegramAdapter(adapter.MessagePlatformAdapter):
         typing.Callable[[platform_events.Event, adapter.MessagePlatformAdapter], None],
     ] = {}
 
-    def __init__(self, config: dict, ap: app.Application):
+    def __init__(self, config: dict, ap: app.Application, logger: EventLogger):
         self.config = config
         self.ap = ap
+        self.logger = logger
 
         async def telegram_callback(update: Update, context: ContextTypes.DEFAULT_TYPE):
             if update.message.from_user.is_bot:
@@ -158,8 +160,8 @@ class TelegramAdapter(adapter.MessagePlatformAdapter):
             try:
                 lb_event = await self.event_converter.target2yiri(update, self.bot, self.bot_account_id)
                 await self.listeners[type(lb_event)](lb_event, self)
-            except Exception:
-                print(traceback.format_exc())
+            except Exception as e:
+                await self.logger.error(f"Error in telegram callback: {traceback.format_exc()}")
 
         self.application = ApplicationBuilder().token(self.config['token']).build()
         self.bot = self.application.bot

pkg/platform/sources/wechatpad.py

@@ -30,6 +30,7 @@ from ..types import message as platform_message
 from ..types import events as platform_events
 from ..types import entities as platform_entities
 from ...utils import image
+from ..logger import EventLogger
 import xml.etree.ElementTree as ET
 from typing import Optional, List, Tuple
 from functools import partial
@@ -533,9 +534,10 @@ class WeChatPadAdapter(adapter.MessagePlatformAdapter):
         typing.Callable[[platform_events.Event, adapter.MessagePlatformAdapter], None],
     ] = {}
 
-    def __init__(self, config: dict, ap: app.Application):
+    def __init__(self, config: dict, ap: app.Application, logger: EventLogger):
         self.config = config
         self.ap = ap
+        self.logger = logger
         self.quart_app = quart.Quart(__name__)
 
         self.message_converter = WeChatPadMessageConverter(config)
@@ -550,7 +552,7 @@ class WeChatPadAdapter(adapter.MessagePlatformAdapter):
         try:
             event = await self.event_converter.target2yiri(data.copy(), self.bot_account_id)
         except Exception as e:
-            traceback.print_exc()
+            await self.logger.error(f"Error in wechatpad callback: {traceback.format_exc()}")
 
         if event.__class__ in self.listeners:
             await self.listeners[event.__class__](event, self)
@@ -694,7 +696,8 @@ class WeChatPadAdapter(adapter.MessagePlatformAdapter):
 
         self.bot = WeChatPadClient(
             self.config['wechatpad_url'],
-            self.config["token"]
+            self.config["token"],
+            logger=self.logger
         )
         self.ap.logger.info(self.config["token"])
         thread_1 = threading.Event()

pkg/platform/sources/wecom.py

@@ -14,6 +14,7 @@ from ...core import app
 from ..types import entities as platform_entities
 from ...command.errors import ParamNotEnoughError
 from ...utils import image
+from ..logger import EventLogger
 
 
 class WecomMessageConverter(adapter.MessageConverter):
@@ -134,10 +135,10 @@ class WecomAdapter(adapter.MessagePlatformAdapter):
     event_converter: WecomEventConverter = WecomEventConverter()
     config: dict
 
-    def __init__(self, config: dict, ap: app.Application):
+    def __init__(self, config: dict, ap: app.Application, logger: EventLogger):
         self.config = config
-
         self.ap = ap
+        self.logger = logger
 
         required_keys = [
             'corpid',
@@ -156,6 +157,7 @@ class WecomAdapter(adapter.MessagePlatformAdapter):
             token=config['token'],
             EncodingAESKey=config['EncodingAESKey'],
             contacts_secret=config['contacts_secret'],
+            logger=self.logger
         )
 
     async def reply_message(
@@ -199,8 +201,8 @@ class WecomAdapter(adapter.MessagePlatformAdapter):
             self.bot_account_id = event.receiver_id
             try:
                 return await callback(await self.event_converter.target2yiri(event), self)
-            except Exception:
-                traceback.print_exc()
+            except Exception as e:
+                await self.logger.error(f"Error in wecom callback: {traceback.format_exc()}")
 
         if event_type == platform_events.FriendMessage:
             self.bot.on_message('text')(on_message)

pkg/platform/sources/wecomcs.py

@@ -13,6 +13,7 @@ from pkg.core import app
 from .. import adapter
 from ..types import entities as platform_entities
 from ...command.errors import ParamNotEnoughError
+from ..logger import EventLogger
 
 
 class WecomMessageConverter(adapter.MessageConverter):
@@ -124,10 +125,10 @@ class WecomCSAdapter(adapter.MessagePlatformAdapter):
     event_converter: WecomEventConverter = WecomEventConverter()
     config: dict
 
-    def __init__(self, config: dict, ap: app.Application):
+    def __init__(self, config: dict, ap: app.Application, logger: EventLogger):
         self.config = config
-
         self.ap = ap
+        self.logger = logger
 
         required_keys = [
             'corpid',
@@ -144,6 +145,7 @@ class WecomCSAdapter(adapter.MessagePlatformAdapter):
             secret=config['secret'],
             token=config['token'],
             EncodingAESKey=config['EncodingAESKey'],
+            logger=self.logger
         )
 
     async def reply_message(
@@ -176,8 +178,8 @@ class WecomCSAdapter(adapter.MessagePlatformAdapter):
             self.bot_account_id = event.receiver_id
             try:
                 return await callback(await self.event_converter.target2yiri(event), self)
-            except:
-                traceback.print_exc()
+            except Exception as e:
+                await self.logger.error(f"Error in wecomcs callback: {traceback.format_exc()}")
 
         if event_type == platform_events.FriendMessage:
             self.bot.on_message('text')(on_message)