mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-02 02:01:47 +00:00
feat(telegram): Private Chat Topics with functional skill binding (#2598)
Salvages PR #3005 by web3blind. Cherry-picked onto current main with functional skill binding and docs added. - DM topic creation via createForumTopic (Bot API 9.4, Feb 2026) - Config-driven topics with thread_id persistence across restarts - Session isolation via existing build_session_key thread_id support - auto_skill field on MessageEvent for topic-skill bindings - Gateway auto-loads bound skill on new sessions (same as /skill commands) - Docs: full Private Chat Topics section in Telegram messaging guide - 20 tests (17 original + 3 for auto_skill) Closes #2598 Co-authored-by: web3blind <web3blind@users.noreply.github.com>
This commit is contained in:
parent
43af094ae3
commit
36af1f3baf
5 changed files with 872 additions and 4 deletions
|
|
@ -133,6 +133,10 @@ class TelegramAdapter(BasePlatformAdapter):
|
|||
self._polling_conflict_count: int = 0
|
||||
self._polling_network_error_count: int = 0
|
||||
self._polling_error_callback_ref = None
|
||||
# DM Topics: map of topic_name -> message_thread_id (populated at startup)
|
||||
self._dm_topics: Dict[str, int] = {}
|
||||
# DM Topics config from extra.dm_topics
|
||||
self._dm_topics_config: List[Dict[str, Any]] = self.config.extra.get("dm_topics", [])
|
||||
|
||||
@staticmethod
|
||||
def _looks_like_polling_conflict(error: Exception) -> bool:
|
||||
|
|
@ -273,6 +277,162 @@ class TelegramAdapter(BasePlatformAdapter):
|
|||
logger.warning("[%s] Failed stopping Telegram polling after conflict: %s", self.name, stop_error, exc_info=True)
|
||||
await self._notify_fatal_error()
|
||||
|
||||
async def _create_dm_topic(
|
||||
self,
|
||||
chat_id: int,
|
||||
name: str,
|
||||
icon_color: Optional[int] = None,
|
||||
icon_custom_emoji_id: Optional[str] = None,
|
||||
) -> Optional[int]:
|
||||
"""Create a forum topic in a private (DM) chat.
|
||||
|
||||
Uses Bot API 9.4's createForumTopic which now works for 1-on-1 chats.
|
||||
Returns the message_thread_id on success, None on failure.
|
||||
"""
|
||||
if not self._bot:
|
||||
return None
|
||||
try:
|
||||
kwargs: Dict[str, Any] = {"chat_id": chat_id, "name": name}
|
||||
if icon_color is not None:
|
||||
kwargs["icon_color"] = icon_color
|
||||
if icon_custom_emoji_id:
|
||||
kwargs["icon_custom_emoji_id"] = icon_custom_emoji_id
|
||||
|
||||
topic = await self._bot.create_forum_topic(**kwargs)
|
||||
thread_id = topic.message_thread_id
|
||||
logger.info(
|
||||
"[%s] Created DM topic '%s' in chat %s -> thread_id=%s",
|
||||
self.name, name, chat_id, thread_id,
|
||||
)
|
||||
return thread_id
|
||||
except Exception as e:
|
||||
error_text = str(e).lower()
|
||||
# If topic already exists, try to find it via getForumTopicIconStickers
|
||||
# or we just log and skip — Telegram doesn't provide a "list topics" API
|
||||
if "topic_name_duplicate" in error_text or "already" in error_text:
|
||||
logger.info(
|
||||
"[%s] DM topic '%s' already exists in chat %s (will be mapped from incoming messages)",
|
||||
self.name, name, chat_id,
|
||||
)
|
||||
else:
|
||||
logger.warning(
|
||||
"[%s] Failed to create DM topic '%s' in chat %s: %s",
|
||||
self.name, name, chat_id, e,
|
||||
)
|
||||
return None
|
||||
|
||||
def _persist_dm_topic_thread_id(self, chat_id: int, topic_name: str, thread_id: int) -> None:
|
||||
"""Save a newly created thread_id back into config.yaml so it persists across restarts."""
|
||||
try:
|
||||
config_path = _Path.home() / ".hermes" / "config.yaml"
|
||||
if not config_path.exists():
|
||||
logger.warning("[%s] Config file not found at %s, cannot persist thread_id", self.name, config_path)
|
||||
return
|
||||
|
||||
import yaml as _yaml
|
||||
with open(config_path, "r") as f:
|
||||
config = _yaml.safe_load(f) or {}
|
||||
|
||||
# Navigate to platforms.telegram.extra.dm_topics
|
||||
dm_topics = (
|
||||
config.get("platforms", {})
|
||||
.get("telegram", {})
|
||||
.get("extra", {})
|
||||
.get("dm_topics", [])
|
||||
)
|
||||
if not dm_topics:
|
||||
return
|
||||
|
||||
changed = False
|
||||
for chat_entry in dm_topics:
|
||||
if int(chat_entry.get("chat_id", 0)) != int(chat_id):
|
||||
continue
|
||||
for t in chat_entry.get("topics", []):
|
||||
if t.get("name") == topic_name and not t.get("thread_id"):
|
||||
t["thread_id"] = thread_id
|
||||
changed = True
|
||||
break
|
||||
|
||||
if changed:
|
||||
with open(config_path, "w") as f:
|
||||
_yaml.dump(config, f, default_flow_style=False, sort_keys=False)
|
||||
logger.info(
|
||||
"[%s] Persisted thread_id=%s for topic '%s' in config.yaml",
|
||||
self.name, thread_id, topic_name,
|
||||
)
|
||||
except Exception as e:
|
||||
logger.warning("[%s] Failed to persist thread_id to config: %s", self.name, e, exc_info=True)
|
||||
|
||||
async def _setup_dm_topics(self) -> None:
|
||||
"""Load or create configured DM topics for specified chats.
|
||||
|
||||
Reads config.extra['dm_topics'] — a list of dicts:
|
||||
[
|
||||
{
|
||||
"chat_id": 123456789,
|
||||
"topics": [
|
||||
{"name": "General", "icon_color": 7322096, "thread_id": 100},
|
||||
{"name": "Accessibility Auditor", "icon_color": 9367192, "skill": "accessibility-auditor"}
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
If a topic already has a thread_id in the config (persisted from a previous
|
||||
creation), it is loaded into the cache without calling createForumTopic.
|
||||
Only topics without a thread_id are created via the API, and their thread_id
|
||||
is then saved back to config.yaml for future restarts.
|
||||
"""
|
||||
if not self._dm_topics_config:
|
||||
return
|
||||
|
||||
for chat_entry in self._dm_topics_config:
|
||||
chat_id = chat_entry.get("chat_id")
|
||||
topics = chat_entry.get("topics", [])
|
||||
if not chat_id or not topics:
|
||||
continue
|
||||
|
||||
logger.info(
|
||||
"[%s] Setting up %d DM topic(s) for chat %s",
|
||||
self.name, len(topics), chat_id,
|
||||
)
|
||||
|
||||
for topic_conf in topics:
|
||||
topic_name = topic_conf.get("name")
|
||||
if not topic_name:
|
||||
continue
|
||||
|
||||
cache_key = f"{chat_id}:{topic_name}"
|
||||
|
||||
# If thread_id is already persisted in config, just load into cache
|
||||
existing_thread_id = topic_conf.get("thread_id")
|
||||
if existing_thread_id:
|
||||
self._dm_topics[cache_key] = int(existing_thread_id)
|
||||
logger.info(
|
||||
"[%s] DM topic loaded from config: %s -> thread_id=%s",
|
||||
self.name, cache_key, existing_thread_id,
|
||||
)
|
||||
continue
|
||||
|
||||
# No persisted thread_id — create the topic via API
|
||||
icon_color = topic_conf.get("icon_color")
|
||||
icon_emoji = topic_conf.get("icon_custom_emoji_id")
|
||||
|
||||
thread_id = await self._create_dm_topic(
|
||||
chat_id=int(chat_id),
|
||||
name=topic_name,
|
||||
icon_color=icon_color,
|
||||
icon_custom_emoji_id=icon_emoji,
|
||||
)
|
||||
|
||||
if thread_id:
|
||||
self._dm_topics[cache_key] = thread_id
|
||||
logger.info(
|
||||
"[%s] DM topic cached: %s -> thread_id=%s",
|
||||
self.name, cache_key, thread_id,
|
||||
)
|
||||
# Persist thread_id to config so we don't recreate on next restart
|
||||
self._persist_dm_topic_thread_id(int(chat_id), topic_name, thread_id)
|
||||
|
||||
async def connect(self) -> bool:
|
||||
"""Connect to Telegram and start polling for updates."""
|
||||
if not TELEGRAM_AVAILABLE:
|
||||
|
|
@ -390,6 +550,18 @@ class TelegramAdapter(BasePlatformAdapter):
|
|||
|
||||
self._mark_connected()
|
||||
logger.info("[%s] Connected and polling for Telegram updates", self.name)
|
||||
|
||||
# Set up DM topics (Bot API 9.4 — Private Chat Topics)
|
||||
# Runs after connection is established so the bot can call createForumTopic.
|
||||
# Failures here are non-fatal — the bot works fine without topics.
|
||||
try:
|
||||
await self._setup_dm_topics()
|
||||
except Exception as topics_err:
|
||||
logger.warning(
|
||||
"[%s] DM topics setup failed (non-fatal): %s",
|
||||
self.name, topics_err, exc_info=True,
|
||||
)
|
||||
|
||||
return True
|
||||
|
||||
except Exception as e:
|
||||
|
|
@ -1514,6 +1686,99 @@ class TelegramAdapter(BasePlatformAdapter):
|
|||
emoji, set_name,
|
||||
)
|
||||
|
||||
def _reload_dm_topics_from_config(self) -> None:
|
||||
"""Re-read dm_topics from config.yaml and load any new thread_ids into cache.
|
||||
|
||||
This allows topics created externally (e.g. by the agent via API) to be
|
||||
recognized without a gateway restart.
|
||||
"""
|
||||
try:
|
||||
config_path = _Path.home() / ".hermes" / "config.yaml"
|
||||
if not config_path.exists():
|
||||
return
|
||||
|
||||
import yaml as _yaml
|
||||
with open(config_path, "r") as f:
|
||||
config = _yaml.safe_load(f) or {}
|
||||
|
||||
dm_topics = (
|
||||
config.get("platforms", {})
|
||||
.get("telegram", {})
|
||||
.get("extra", {})
|
||||
.get("dm_topics", [])
|
||||
)
|
||||
if not dm_topics:
|
||||
return
|
||||
|
||||
# Update in-memory config and cache any new thread_ids
|
||||
self._dm_topics_config = dm_topics
|
||||
for chat_entry in dm_topics:
|
||||
cid = chat_entry.get("chat_id")
|
||||
if not cid:
|
||||
continue
|
||||
for t in chat_entry.get("topics", []):
|
||||
tid = t.get("thread_id")
|
||||
name = t.get("name")
|
||||
if tid and name:
|
||||
cache_key = f"{cid}:{name}"
|
||||
if cache_key not in self._dm_topics:
|
||||
self._dm_topics[cache_key] = int(tid)
|
||||
logger.info(
|
||||
"[%s] Hot-loaded DM topic from config: %s -> thread_id=%s",
|
||||
self.name, cache_key, tid,
|
||||
)
|
||||
except Exception as e:
|
||||
logger.debug("[%s] Failed to reload dm_topics from config: %s", self.name, e)
|
||||
|
||||
def _get_dm_topic_info(self, chat_id: str, thread_id: Optional[str]) -> Optional[Dict[str, Any]]:
|
||||
"""Look up DM topic config by chat_id and thread_id.
|
||||
|
||||
Returns the topic config dict (name, skill, etc.) if this thread_id
|
||||
matches a known DM topic, or None.
|
||||
"""
|
||||
if not thread_id:
|
||||
return None
|
||||
|
||||
thread_id_int = int(thread_id)
|
||||
|
||||
# Check cached topics first (created by us or loaded at startup)
|
||||
for key, cached_tid in self._dm_topics.items():
|
||||
if cached_tid == thread_id_int and key.startswith(f"{chat_id}:"):
|
||||
topic_name = key.split(":", 1)[1]
|
||||
# Find the full config for this topic
|
||||
for chat_entry in self._dm_topics_config:
|
||||
if str(chat_entry.get("chat_id")) == chat_id:
|
||||
for t in chat_entry.get("topics", []):
|
||||
if t.get("name") == topic_name:
|
||||
return t
|
||||
return {"name": topic_name}
|
||||
|
||||
# Not in cache — hot-reload config in case topics were added externally
|
||||
self._reload_dm_topics_from_config()
|
||||
|
||||
# Check cache again after reload
|
||||
for key, cached_tid in self._dm_topics.items():
|
||||
if cached_tid == thread_id_int and key.startswith(f"{chat_id}:"):
|
||||
topic_name = key.split(":", 1)[1]
|
||||
for chat_entry in self._dm_topics_config:
|
||||
if str(chat_entry.get("chat_id")) == chat_id:
|
||||
for t in chat_entry.get("topics", []):
|
||||
if t.get("name") == topic_name:
|
||||
return t
|
||||
return {"name": topic_name}
|
||||
|
||||
return None
|
||||
|
||||
def _cache_dm_topic_from_message(self, chat_id: str, thread_id: str, topic_name: str) -> None:
|
||||
"""Cache a thread_id -> topic_name mapping discovered from an incoming message."""
|
||||
cache_key = f"{chat_id}:{topic_name}"
|
||||
if cache_key not in self._dm_topics:
|
||||
self._dm_topics[cache_key] = int(thread_id)
|
||||
logger.info(
|
||||
"[%s] Cached DM topic from message: %s -> thread_id=%s",
|
||||
self.name, cache_key, thread_id,
|
||||
)
|
||||
|
||||
def _build_message_event(self, message: Message, msg_type: MessageType) -> MessageEvent:
|
||||
"""Build a MessageEvent from a Telegram message."""
|
||||
chat = message.chat
|
||||
|
|
@ -1525,7 +1790,27 @@ class TelegramAdapter(BasePlatformAdapter):
|
|||
chat_type = "group"
|
||||
elif chat.type == ChatType.CHANNEL:
|
||||
chat_type = "channel"
|
||||
|
||||
|
||||
# Resolve DM topic name and skill binding
|
||||
thread_id_raw = message.message_thread_id
|
||||
thread_id_str = str(thread_id_raw) if thread_id_raw else None
|
||||
chat_topic = None
|
||||
topic_skill = None
|
||||
|
||||
if chat_type == "dm" and thread_id_str:
|
||||
topic_info = self._get_dm_topic_info(str(chat.id), thread_id_str)
|
||||
if topic_info:
|
||||
chat_topic = topic_info.get("name")
|
||||
topic_skill = topic_info.get("skill")
|
||||
|
||||
# Also check forum_topic_created service message for topic discovery
|
||||
if hasattr(message, "forum_topic_created") and message.forum_topic_created:
|
||||
created_name = message.forum_topic_created.name
|
||||
if created_name:
|
||||
self._cache_dm_topic_from_message(str(chat.id), thread_id_str, created_name)
|
||||
if not chat_topic:
|
||||
chat_topic = created_name
|
||||
|
||||
# Build source
|
||||
source = self.build_source(
|
||||
chat_id=str(chat.id),
|
||||
|
|
@ -1533,7 +1818,8 @@ class TelegramAdapter(BasePlatformAdapter):
|
|||
chat_type=chat_type,
|
||||
user_id=str(user.id) if user else None,
|
||||
user_name=user.full_name if user else None,
|
||||
thread_id=str(message.message_thread_id) if message.message_thread_id else None,
|
||||
thread_id=thread_id_str,
|
||||
chat_topic=chat_topic,
|
||||
)
|
||||
|
||||
# Extract reply context if this message is a reply
|
||||
|
|
@ -1551,5 +1837,6 @@ class TelegramAdapter(BasePlatformAdapter):
|
|||
message_id=str(message.message_id),
|
||||
reply_to_message_id=reply_to_id,
|
||||
reply_to_text=reply_to_text,
|
||||
auto_skill=topic_skill,
|
||||
timestamp=message.date,
|
||||
)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue