mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-06-27 07:54:19 +00:00
feat(platform): add qqofficial eba adapter
This commit is contained in:
WangCham
@@ -0,0 +1,171 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import asyncio
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
|
||||
from quart import Quart, request
|
||||
|
||||
from langbot.pkg.platform.adapters.qqofficial.adapter import QQOfficialAdapter
|
||||
from langbot_plugin.api.definition.abstract.platform.event_logger import AbstractEventLogger
|
||||
from langbot_plugin.api.entities.builtin.platform import events as platform_events
|
||||
from langbot_plugin.api.entities.builtin.platform import message as platform_message
|
||||
|
||||
|
||||
class ProbeLogger(AbstractEventLogger):
|
||||
async def info(self, text, images=None, message_session_id=None, no_throw=True):
|
||||
print(f'[info] {text}')
|
||||
|
||||
async def debug(self, text, images=None, message_session_id=None, no_throw=True):
|
||||
print(f'[debug] {text}')
|
||||
|
||||
async def warning(self, text, images=None, message_session_id=None, no_throw=True):
|
||||
print(f'[warning] {text}')
|
||||
|
||||
async def error(self, text, images=None, message_session_id=None, no_throw=True):
|
||||
print(f'[error] {text}')
|
||||
|
||||
|
||||
def redact(value: Any) -> Any:
|
||||
if isinstance(value, dict):
|
||||
secret_keys = {'secret', 'token', 'authorization', 'access_token', 'clientsecret'}
|
||||
return {key: '<redacted>' if key.lower() in secret_keys else redact(item) for key, item in value.items()}
|
||||
if isinstance(value, list):
|
||||
return [redact(item) for item in value]
|
||||
return value
|
||||
|
||||
|
||||
def summarize_event(event: platform_events.EBAEvent) -> dict:
|
||||
data = {
|
||||
'type': event.type,
|
||||
'adapter_name': event.adapter_name,
|
||||
'timestamp': event.timestamp,
|
||||
}
|
||||
for field in ('message_id', 'chat_id', 'chat_type', 'action', 'data'):
|
||||
if hasattr(event, field):
|
||||
value = getattr(event, field)
|
||||
if hasattr(value, 'value'):
|
||||
value = value.value
|
||||
data[field] = redact(value)
|
||||
if hasattr(event, 'sender') and event.sender is not None:
|
||||
data['sender'] = event.sender.model_dump()
|
||||
if hasattr(event, 'group') and event.group is not None:
|
||||
data['group'] = event.group.model_dump()
|
||||
if hasattr(event, 'message_chain') and event.message_chain is not None:
|
||||
data['message_chain'] = event.message_chain.model_dump()
|
||||
return data
|
||||
|
||||
|
||||
def record_api(results: list[dict[str, Any]], name: str, ok: bool, result: Any = None, error: Exception | None = None):
|
||||
entry = {'name': name, 'ok': ok}
|
||||
if result is not None:
|
||||
entry['result'] = redact(result)
|
||||
if error is not None:
|
||||
entry['error'] = repr(error)
|
||||
results.append(entry)
|
||||
print('QQOFFICIAL_EBA_API', json.dumps(entry, ensure_ascii=False, default=str))
|
||||
|
||||
|
||||
async def run_api(results: list[dict[str, Any]], name: str, func):
|
||||
try:
|
||||
result = await func()
|
||||
record_api(results, name, True, result)
|
||||
return result
|
||||
except Exception as exc:
|
||||
record_api(results, name, False, error=exc)
|
||||
return None
|
||||
|
||||
|
||||
def config_from_env(enable_webhook: bool) -> dict:
|
||||
config = {
|
||||
'appid': os.getenv('QQOFFICIAL_APPID', ''),
|
||||
'secret': os.getenv('QQOFFICIAL_SECRET', ''),
|
||||
'token': os.getenv('QQOFFICIAL_TOKEN', ''),
|
||||
'enable-webhook': enable_webhook,
|
||||
'enable-stream-reply': os.getenv('QQOFFICIAL_ENABLE_STREAM_REPLY', '').lower() in {'1', 'true', 'yes'},
|
||||
}
|
||||
missing = [key for key in ('appid', 'secret', 'token') if not config.get(key)]
|
||||
if missing:
|
||||
raise RuntimeError(f'Missing required QQOfficial env vars for fields: {missing}')
|
||||
return config
|
||||
|
||||
|
||||
async def run_probe(args: argparse.Namespace):
|
||||
adapter = QQOfficialAdapter(config_from_env(args.webhook), ProbeLogger())
|
||||
events: list[platform_events.EBAEvent] = []
|
||||
api_results: list[dict[str, Any]] = []
|
||||
first_message = asyncio.Event()
|
||||
log_path = Path(args.log)
|
||||
log_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
async def listener(event, adapter):
|
||||
events.append(event)
|
||||
summary = summarize_event(event)
|
||||
with log_path.open('a', encoding='utf-8') as fp:
|
||||
fp.write(json.dumps(summary, ensure_ascii=False, default=str) + '\n')
|
||||
print('QQOFFICIAL_EBA_EVENT', json.dumps(summary, ensure_ascii=False, default=str))
|
||||
if isinstance(event, platform_events.MessageReceivedEvent):
|
||||
first_message.set()
|
||||
|
||||
adapter.register_listener(platform_events.EBAEvent, listener)
|
||||
|
||||
server_task = None
|
||||
if args.webhook:
|
||||
app = Quart(__name__)
|
||||
|
||||
@app.route('/callback', methods=['GET', 'POST'])
|
||||
async def callback():
|
||||
return await adapter.handle_unified_webhook('probe', '', request)
|
||||
|
||||
server_task = asyncio.create_task(app.run_task(host=args.host, port=args.port))
|
||||
else:
|
||||
server_task = asyncio.create_task(adapter.run_async())
|
||||
|
||||
try:
|
||||
await asyncio.wait_for(first_message.wait(), timeout=args.timeout)
|
||||
first = next(event for event in events if isinstance(event, platform_events.MessageReceivedEvent))
|
||||
await run_api(api_results, 'reply_message', lambda: adapter.reply_message(first, platform_message.MessageChain([platform_message.Plain(text=args.reply_text)])))
|
||||
await run_api(api_results, 'get_message', lambda: adapter.get_message(first.chat_type.value, first.chat_id, first.message_id))
|
||||
await run_api(api_results, 'get_user_info', lambda: adapter.get_user_info(first.sender.id))
|
||||
await run_api(api_results, 'get_friend_list', adapter.get_friend_list)
|
||||
if getattr(first, 'group', None):
|
||||
await run_api(api_results, 'get_group_info', lambda: adapter.get_group_info(first.group.id))
|
||||
await run_api(api_results, 'get_group_member_info', lambda: adapter.get_group_member_info(first.group.id, first.sender.id))
|
||||
await run_api(api_results, 'get_group_member_list', lambda: adapter.get_group_member_list(first.group.id))
|
||||
await run_api(api_results, 'call_platform_api.get_mode', lambda: adapter.call_platform_api('get_mode', {}))
|
||||
await run_api(api_results, 'call_platform_api.check_access_token', lambda: adapter.call_platform_api('check_access_token', {}))
|
||||
finally:
|
||||
if server_task:
|
||||
server_task.cancel()
|
||||
try:
|
||||
await server_task
|
||||
except asyncio.CancelledError:
|
||||
pass
|
||||
await adapter.kill()
|
||||
|
||||
summary = {
|
||||
'events': [event.type for event in events],
|
||||
'api_results': api_results,
|
||||
'log': str(log_path),
|
||||
}
|
||||
print('QQOFFICIAL_EBA_SUMMARY', json.dumps(summary, ensure_ascii=False, default=str))
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(description='Live QQOfficial EBA adapter probe')
|
||||
parser.add_argument('--host', default='127.0.0.1')
|
||||
parser.add_argument('--port', type=int, default=5312)
|
||||
parser.add_argument('--timeout', type=float, default=300)
|
||||
parser.add_argument('--log', default='data/temp/qqofficial_eba_probe.jsonl')
|
||||
parser.add_argument('--reply-text', default='QQOfficial EBA probe reply')
|
||||
parser.add_argument('--webhook', action='store_true', help='Run a local webhook callback server instead of the WebSocket gateway')
|
||||
args = parser.parse_args()
|
||||
asyncio.run(run_probe(args))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
||||
@@ -0,0 +1,267 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import pathlib
|
||||
import datetime
|
||||
from unittest.mock import AsyncMock, patch
|
||||
|
||||
import pytest
|
||||
import yaml
|
||||
|
||||
from langbot.libs.qq_official_api.qqofficialevent import QQOfficialEvent
|
||||
from langbot.pkg.platform.adapters.qqofficial.adapter import QQOfficialAdapter
|
||||
from langbot.pkg.platform.adapters.qqofficial.errors import NotSupportedError
|
||||
from langbot.pkg.platform.adapters.qqofficial.event_converter import QQOfficialEventConverter
|
||||
from langbot.pkg.platform.adapters.qqofficial.message_converter import QQOfficialMessageConverter
|
||||
from langbot.pkg.platform.adapters.qqofficial.platform_api import PLATFORM_API_MAP
|
||||
from langbot_plugin.api.definition.abstract.platform.event_logger import AbstractEventLogger
|
||||
from langbot_plugin.api.entities.builtin.platform import entities as platform_entities
|
||||
from langbot_plugin.api.entities.builtin.platform import events as platform_events
|
||||
from langbot_plugin.api.entities.builtin.platform import message as platform_message
|
||||
|
||||
|
||||
class DummyLogger(AbstractEventLogger):
|
||||
async def info(self, text, images=None, message_session_id=None, no_throw=True):
|
||||
pass
|
||||
|
||||
async def debug(self, text, images=None, message_session_id=None, no_throw=True):
|
||||
pass
|
||||
|
||||
async def warning(self, text, images=None, message_session_id=None, no_throw=True):
|
||||
pass
|
||||
|
||||
async def error(self, text, images=None, message_session_id=None, no_throw=True):
|
||||
pass
|
||||
|
||||
|
||||
class DummyQQOfficialClient:
|
||||
MEDIA_TYPE_IMAGE = 1
|
||||
MEDIA_TYPE_VOICE = 3
|
||||
MEDIA_TYPE_FILE = 4
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
self.app_id = kwargs['app_id']
|
||||
self.secret = kwargs['secret']
|
||||
self.token = kwargs['token']
|
||||
self.unified_mode = kwargs['unified_mode']
|
||||
self._message_handlers = {}
|
||||
self.sent = []
|
||||
self.access_token = ''
|
||||
self.access_token_expiry_time = None
|
||||
self.handle_unified_webhook = AsyncMock(return_value='success')
|
||||
self.connect_gateway_loop = AsyncMock()
|
||||
|
||||
def on_message(self, msg_type: str):
|
||||
def decorator(func):
|
||||
self._message_handlers.setdefault(msg_type, []).append(func)
|
||||
return func
|
||||
|
||||
return decorator
|
||||
|
||||
async def check_access_token(self):
|
||||
return bool(self.access_token)
|
||||
|
||||
async def get_access_token(self):
|
||||
self.access_token = 'token'
|
||||
self.access_token_expiry_time = 1710003600
|
||||
|
||||
async def get_gateway_url(self):
|
||||
return 'wss://gateway.example.test'
|
||||
|
||||
async def send_private_text_msg(self, user_openid, content, msg_id=None):
|
||||
self.sent.append(('private_text', user_openid, content, msg_id))
|
||||
return {'id': 'sent-private'}
|
||||
|
||||
async def send_group_text_msg(self, group_openid, content, msg_id=None):
|
||||
self.sent.append(('group_text', group_openid, content, msg_id))
|
||||
return {'id': 'sent-group'}
|
||||
|
||||
async def send_channle_group_text_msg(self, channel_id, content, msg_id=None):
|
||||
self.sent.append(('channel_text', channel_id, content, msg_id))
|
||||
return {'id': 'sent-channel'}
|
||||
|
||||
async def send_channle_private_text_msg(self, guild_id, content, msg_id=None):
|
||||
self.sent.append(('dm_text', guild_id, content, msg_id))
|
||||
return {'id': 'sent-dm'}
|
||||
|
||||
async def send_image_msg(self, target_type, target_id, file_url=None, file_data=None, msg_id=None, content=None):
|
||||
self.sent.append(('image', target_type, target_id, file_url, file_data, msg_id))
|
||||
return {'id': 'sent-image'}
|
||||
|
||||
async def send_voice_msg(self, target_type, target_id, file_url=None, file_data=None, msg_id=None):
|
||||
self.sent.append(('voice', target_type, target_id, file_url, file_data, msg_id))
|
||||
return {'id': 'sent-voice'}
|
||||
|
||||
async def send_file_msg(self, target_type, target_id, file_url=None, file_data=None, file_name=None, msg_id=None):
|
||||
self.sent.append(('file', target_type, target_id, file_url, file_data, file_name, msg_id))
|
||||
return {'id': 'sent-file'}
|
||||
|
||||
async def send_stream_msg(self, **kwargs):
|
||||
self.sent.append(('stream', kwargs))
|
||||
return {'id': 'stream-1'}
|
||||
|
||||
|
||||
def manifest() -> dict:
|
||||
manifest_path = (
|
||||
pathlib.Path(__file__).parents[3]
|
||||
/ 'src'
|
||||
/ 'langbot'
|
||||
/ 'pkg'
|
||||
/ 'platform'
|
||||
/ 'adapters'
|
||||
/ 'qqofficial'
|
||||
/ 'manifest.yaml'
|
||||
)
|
||||
return yaml.safe_load(manifest_path.read_text())
|
||||
|
||||
|
||||
def make_adapter(enable_webhook: bool = True) -> QQOfficialAdapter:
|
||||
config = {
|
||||
'appid': 'app-id',
|
||||
'secret': 'secret',
|
||||
'token': 'token',
|
||||
'enable-webhook': enable_webhook,
|
||||
'enable-stream-reply': True,
|
||||
}
|
||||
with patch('langbot.pkg.platform.adapters.qqofficial.adapter.QQOfficialClient', DummyQQOfficialClient):
|
||||
return QQOfficialAdapter(config, DummyLogger())
|
||||
|
||||
|
||||
def qq_event(event_type: str = 'C2C_MESSAGE_CREATE', **overrides) -> QQOfficialEvent:
|
||||
payload = {
|
||||
't': event_type,
|
||||
'user_openid': overrides.get('user_openid', 'user-openid'),
|
||||
'timestamp': overrides.get('timestamp', '2026-06-01T10:00:00+0800'),
|
||||
'd_author_id': overrides.get('author_id', 'author-id'),
|
||||
'content': overrides.get('content', 'hello'),
|
||||
'd_id': overrides.get('message_id', 'msg-1'),
|
||||
'id': overrides.get('event_id', 'event-1'),
|
||||
'channel_id': overrides.get('channel_id', 'channel-1'),
|
||||
'username': overrides.get('username', 'alice'),
|
||||
'guild_id': overrides.get('guild_id', 'guild-1'),
|
||||
'member_openid': overrides.get('member_openid', 'member-openid'),
|
||||
'group_openid': overrides.get('group_openid', 'group-openid'),
|
||||
'image_attachments': overrides.get('image_attachments'),
|
||||
'content_type': overrides.get('content_type', 'image/png'),
|
||||
}
|
||||
return QQOfficialEvent(payload)
|
||||
|
||||
|
||||
def test_qqofficial_supported_events_match_manifest():
|
||||
assert make_adapter().get_supported_events() == manifest()['spec']['supported_events']
|
||||
|
||||
|
||||
def test_qqofficial_supported_apis_match_manifest():
|
||||
supported_apis = make_adapter().get_supported_apis()
|
||||
manifest_apis = manifest()['spec']['supported_apis']
|
||||
|
||||
assert supported_apis == manifest_apis['required'] + manifest_apis['optional']
|
||||
|
||||
|
||||
def test_qqofficial_platform_api_map_matches_manifest():
|
||||
manifest_actions = {item['action'] for item in manifest()['spec']['platform_specific_apis']}
|
||||
|
||||
assert set(PLATFORM_API_MAP) == manifest_actions
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_qqofficial_message_converter_maps_common_components_to_send_payloads():
|
||||
payload = await QQOfficialMessageConverter.yiri2target(
|
||||
platform_message.MessageChain(
|
||||
[
|
||||
platform_message.Source(id='msg-0', time=datetime.datetime.now()),
|
||||
platform_message.Plain(text='hi'),
|
||||
platform_message.At(target='user-1', display='Alice'),
|
||||
platform_message.AtAll(),
|
||||
platform_message.Image(url='https://example.test/a.png'),
|
||||
platform_message.Voice(base64='data:audio/mpeg;base64,AAAA'),
|
||||
platform_message.File(name='a.txt', url='https://example.test/a.txt'),
|
||||
platform_message.Quote(origin=platform_message.MessageChain([platform_message.Plain(text='quoted')])),
|
||||
]
|
||||
)
|
||||
)
|
||||
|
||||
assert {'type': 'text', 'content': 'hi'} in payload
|
||||
assert {'type': 'text', 'content': '@Alice'} in payload
|
||||
assert {'type': 'text', 'content': '@all'} in payload
|
||||
assert any(item['type'] == 'image' and item['url'] == 'https://example.test/a.png' for item in payload)
|
||||
assert any(item['type'] == 'voice' and item['base64'].startswith('data:audio') for item in payload)
|
||||
assert any(item['type'] == 'file' and item['name'] == 'a.txt' for item in payload)
|
||||
assert {'type': 'text', 'content': 'quoted'} in payload
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_qqofficial_event_converter_maps_private_group_and_platform_specific():
|
||||
private_event = await QQOfficialEventConverter().target2yiri(qq_event('C2C_MESSAGE_CREATE'))
|
||||
group_event = await QQOfficialEventConverter().target2yiri(qq_event('GROUP_AT_MESSAGE_CREATE'))
|
||||
channel_event = await QQOfficialEventConverter().target2yiri(qq_event('AT_MESSAGE_CREATE'))
|
||||
platform_event = await QQOfficialEventConverter().target2yiri(qq_event('GUILD_CREATE'))
|
||||
|
||||
assert isinstance(private_event, platform_events.MessageReceivedEvent)
|
||||
assert private_event.adapter_name == 'qqofficial-eba'
|
||||
assert private_event.chat_type == platform_entities.ChatType.PRIVATE
|
||||
assert private_event.chat_id == 'user-openid'
|
||||
assert str(private_event.message_chain) == 'hello'
|
||||
|
||||
assert isinstance(group_event, platform_events.MessageReceivedEvent)
|
||||
assert group_event.chat_type == platform_entities.ChatType.GROUP
|
||||
assert group_event.chat_id == 'group-openid'
|
||||
assert isinstance(group_event.message_chain[1], platform_message.At)
|
||||
|
||||
assert channel_event.chat_id == 'channel-1'
|
||||
assert isinstance(platform_event, platform_events.PlatformSpecificEvent)
|
||||
assert platform_event.action == 'qqofficial.GUILD_CREATE'
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_qqofficial_adapter_dispatches_eba_and_legacy_and_caches_group_event():
|
||||
adapter = make_adapter()
|
||||
eba_calls: list[platform_events.Event] = []
|
||||
legacy_calls: list[platform_events.Event] = []
|
||||
|
||||
async def eba_listener(event, adapter):
|
||||
eba_calls.append(event)
|
||||
|
||||
async def legacy_listener(event, adapter):
|
||||
legacy_calls.append(event)
|
||||
|
||||
adapter.register_listener(platform_events.MessageReceivedEvent, eba_listener)
|
||||
adapter.register_listener(platform_events.GroupMessage, legacy_listener)
|
||||
await adapter._handle_native_event(qq_event('GROUP_AT_MESSAGE_CREATE'))
|
||||
|
||||
assert len(eba_calls) == 1
|
||||
assert len(legacy_calls) == 1
|
||||
received = eba_calls[0]
|
||||
assert await adapter.get_message('group', 'group-openid', 'msg-1') == received
|
||||
assert (await adapter.get_group_info('group-openid')).id == 'group-openid'
|
||||
assert (await adapter.get_group_member_info('group-openid', 'member-openid')).user.id == 'member-openid'
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_qqofficial_send_reply_stream_platform_api_and_unsupported():
|
||||
adapter = make_adapter()
|
||||
message = platform_message.MessageChain(
|
||||
[
|
||||
platform_message.Plain(text='reply'),
|
||||
platform_message.Image(url='https://example.test/a.png'),
|
||||
]
|
||||
)
|
||||
source_event = await QQOfficialEventConverter().target2yiri(qq_event('C2C_MESSAGE_CREATE'))
|
||||
|
||||
reply_result = await adapter.reply_message(source_event, message)
|
||||
assert reply_result.message_id == 'msg-1'
|
||||
assert ('private_text', 'user-openid', 'reply', 'msg-1') in adapter.bot.sent
|
||||
assert any(call[0] == 'image' and call[1] == 'c2c' for call in adapter.bot.sent)
|
||||
|
||||
await adapter.send_message('group', 'group-openid', platform_message.MessageChain([platform_message.Plain(text='hello group')]))
|
||||
assert ('group_text', 'group-openid', 'hello group', None) in adapter.bot.sent
|
||||
|
||||
assert await adapter.call_platform_api('get_mode', {}) == {
|
||||
'webhook': True,
|
||||
'stream_reply': True,
|
||||
'bot_account_id': 'app-id',
|
||||
}
|
||||
await adapter.call_platform_api('refresh_access_token', {})
|
||||
assert adapter.bot.access_token == 'token'
|
||||
|
||||
with pytest.raises(NotSupportedError):
|
||||
await adapter.call_platform_api('missing', {})
|
||||
Reference in New Issue
Block a user