Add OneBot-11 protocol support - #9
Conversation
Co-authored-by: Gennadiyev <19852747+Gennadiyev@users.noreply.github.com>
Co-authored-by: Gennadiyev <19852747+Gennadiyev@users.noreply.github.com>
Co-authored-by: Gennadiyev <19852747+Gennadiyev@users.noreply.github.com>
|
No issues found. Checked for bugs and CLAUDE.md compliance. |
There was a problem hiding this comment.
Pull request overview
This PR adds OneBot-11 protocol support to AWA, enabling notifications to be sent via the OneBot-11 HTTP API. This provides indirect support for multiple messaging platforms including QQ, Discord, and Lark through protocol adapters.
Changes:
- Added
OneBotNotifierclass with support for sending messages to groups and private users via HTTP POST - Added configuration schema and examples for OneBot-11 in
config.example.yaml - Added comprehensive documentation in
docs/development.mdincluding setup guide and API references
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| notifier.py | Implements OneBotNotifier class with HTTP-based message delivery, Bearer token authentication, lazy session initialization, and integration with the main notifier system |
| config.example.yaml | Adds OneBot-11 configuration section with URL, access token, and recipient ID lists |
| docs/development.md | Adds OneBot-11 notifier documentation including features, configuration, setup steps, and reference links |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Send private messages to multiple users | ||
| - Authentication via access token | ||
| - Configurable server URL | ||
| - Automatic error handling and retry |
There was a problem hiding this comment.
The documentation at line 158 claims "Automatic error handling and retry" but the implementation only includes error handling (logging errors) without any retry logic. Either implement retry functionality or update the documentation to remove the "and retry" claim.
| - Automatic error handling and retry | |
| - Automatic error handling |
| for group_id in self.to_group_ids: | ||
| payload = {"group_id": group_id, "message": markdown_content} | ||
| try: | ||
| async with self.session.post( | ||
| f"{self.url}/send_group_msg", json=payload, headers=self.headers | ||
| ) as response: | ||
| if response.status != 200: | ||
| text = await response.text() | ||
| logger.error( | ||
| f"Failed to send OneBot group message to {group_id}: {response.status}, {text}" | ||
| ) | ||
| else: | ||
| logger.debug(f"OneBot group notification sent to {group_id}") | ||
| except Exception as e: | ||
| logger.error( | ||
| f"Error sending OneBot group notification to {group_id}: {e}", | ||
| exc_info=True, | ||
| ) | ||
|
|
||
| # Send to all configured friends | ||
| for friend_id in self.to_friend_ids: | ||
| payload = {"user_id": friend_id, "message": markdown_content} | ||
| try: | ||
| async with self.session.post( | ||
| f"{self.url}/send_private_msg", json=payload, headers=self.headers | ||
| ) as response: | ||
| if response.status != 200: | ||
| text = await response.text() | ||
| logger.error( | ||
| f"Failed to send OneBot private message to {friend_id}: {response.status}, {text}" | ||
| ) | ||
| else: | ||
| logger.debug( | ||
| f"OneBot private notification sent to {friend_id}" | ||
| ) | ||
| except Exception as e: | ||
| logger.error( | ||
| f"Error sending OneBot private notification to {friend_id}: {e}", | ||
| exc_info=True, | ||
| ) |
There was a problem hiding this comment.
The PR description claims the notifier "Sends to multiple group_ids and user_ids concurrently" but the implementation sends messages sequentially using for loops. To match the description and improve performance, consider using asyncio.gather() to send all messages concurrently.
Gennadiyev
left a comment
Gennadiyev
left a comment
There was a problem hiding this comment.
Tested OneBot v11 protocol. The code works perfectly.
AWA can now send notifications via OneBot-11 HTTP API, enabling QQ groups/users and indirect support for Discord, Lark, etc. through protocol adapters.
Changes
notifier.py- NewOneBotNotifierclass/send_group_msgand/send_private_msgendpointsconfig.example.yaml- Configuration schemadocs/development.md- Setup guide and API reference linksImplementation Notes
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.