cc8e5ec2af
First migration of an existing built-in platform adapter to the plugin system established by IRC / Teams / LINE / Google Chat. Closes #24325; advances the umbrella refactor in #3823. Matches Teams' shape exactly — adapter under ``plugins/platforms/discord/`` with the standard ``__init__.py`` / ``adapter.py`` / ``plugin.yaml`` shell, ``register(ctx)`` entry point, **no back-compat shim** at the old import path, and full parity for the four hooks Teams uses plus the ``apply_yaml_config_fn`` hook that landed in #25443 (the Discord plugin is the first consumer of that hook): * ``standalone_sender_fn`` — out-of-process cron delivery via REST API * ``setup_fn`` — interactive ``hermes setup gateway`` wizard * ``apply_yaml_config_fn`` — translate ``config.yaml`` ``discord:`` keys into ``DISCORD_*`` env vars (replaces the hardcoded block in ``gateway/config.py``) * ``is_connected`` — declares connection state from ``DISCORD_BOT_TOKEN`` * ``check_fn`` — lazy-installs ``discord.py`` on demand * plus ``allowed_users_env``, ``allow_all_env``, ``cron_deliver_env_var``, ``max_message_length``, ``emoji``, ``required_env``, ``install_hint`` * ``gateway/platforms/discord.py`` (5,101 LOC) → ``plugins/platforms/discord/adapter.py`` (git rename, R090). * New ``plugins/platforms/discord/{__init__.py, plugin.yaml}`` with ``requires_env`` / ``optional_env`` declarations. * Append ``register(ctx)`` block + new hook implementations (``_standalone_send``, ``interactive_setup``, ``_apply_yaml_config``, ``_clean_discord_user_ids``, ``_is_connected``, ``_build_adapter``, plus helpers ``_DISCORD_CHANNEL_TYPE_PROBE_CACHE`` etc.) to the adapter. * Replace the ``Platform.DISCORD elif`` branch in ``GatewayRunner._create_adapter()`` (−9 LOC) with a generic post-creation hook (+6 LOC) in the registry path: any plugin adapter that declares a ``gateway_runner`` attribute now gets it auto-injected. Webhook's built-in branch is unchanged (it doesn't go through the registry path). * Move ``_send_discord`` (190 LOC) and helpers (``_DISCORD_CHANNEL_TYPE_PROBE_CACHE``, ``_remember_channel_is_forum``, ``_probe_is_forum_cached``, ``_derive_forum_thread_name``) from ``tools/send_message_tool.py`` into the plugin as ``_standalone_send``. * Wire via ``standalone_sender_fn=_standalone_send`` (Teams pattern; same gap fixed in #21804 for other plugin platforms). * Replace the Discord ``elif`` in ``tools/send_message_tool.py`` ``_send_to_platform`` with a 10-line registry-hook dispatch. * Drop the ``DiscordAdapter`` import and the ``Platform.DISCORD: DiscordAdapter.MAX_MESSAGE_LENGTH`` ``_MAX_LENGTHS`` entry — the registry's ``max_message_length=2000`` covers it. * Move ``_setup_discord`` and ``_clean_discord_user_ids`` (68 LOC) from ``hermes_cli/setup.py`` into the plugin as ``interactive_setup``. * Wire via ``setup_fn=interactive_setup``. CLI helpers (``prompt``, ``print_info``, etc.) are lazy-imported so the plugin's module-load surface stays minimal. * Remove ``"discord": _s._setup_discord`` from ``hermes_cli/gateway.py::_builtin_setup_fn``. * Remove the entire 32-line ``_PLATFORMS["discord"]`` static dict entry — Discord's setup metadata is now discovered dynamically via ``_all_platforms()`` from the registry entry. * Move the 59-line ``discord_cfg`` YAML→env bridge from ``gateway/config.py::load_gateway_config()`` into the plugin as ``_apply_yaml_config``. Covers ``require_mention``, ``thread_require_mention``, ``free_response_channels``, ``auto_thread``, ``reactions``, ``ignored_channels``, ``allowed_channels``, ``no_thread_channels``, ``allow_mentions.{everyone,roles,users, replied_user}``, and ``reply_to_mode`` (including the YAML 1.1 ``off``-as-False coercion and the ``extra.reply_to_mode`` fallback). * Wire via ``apply_yaml_config_fn=_apply_yaml_config``. * The hook runs BEFORE ``_apply_env_overrides`` and after the generic shared-key loop, exactly as documented in ``website/docs/developer-guide/adding-platform-adapters.md``. * Behavior is preserved exactly — every assignment still uses ``not os.getenv(...)`` guards so env vars take precedence over YAML. All 78 references to the old import path are rewritten — no back-compat shim: * 51 ``from gateway.platforms.discord import X`` → ``from plugins.platforms.discord.adapter import X`` * 5 ``import gateway.platforms.discord as discord_platform`` → ``import plugins.platforms.discord.adapter as discord_platform`` * 1 ``from gateway.platforms import discord as discord_mod`` → ``from plugins.platforms.discord import adapter as discord_mod`` * 21 ``mock.patch("gateway.platforms.discord.X")`` strings → ``mock.patch("plugins.platforms.discord.adapter.X")`` * 1 docstring reference in ``hermes_cli/commands.py`` * 1 import in ``tools/send_message_tool.py`` (now removed entirely) The import-safety test in ``tests/gateway/test_discord_imports.py`` is updated to purge the new canonical module name from ``sys.modules``. **38 files changed, +621 / −473** — net positive due to the YAML hook implementation (89 new LOC in the plugin trading for 59 deleted in core), but every line moved has a clear plugin home now. The git rename is detected at R090 because the adapter gained ~340 LOC of moved-in hook implementations (``_standalone_send`` + ``interactive_setup`` + ``_apply_yaml_config`` + helpers). * All 568 Discord-specific tests pass across 25 ``test_discord_*.py`` files plus voice/send/text-batching/reload-skills/stream-consumer/ integration tests. * All 147 tests in the YAML-touching subset (``test_discord_reply_mode``, ``test_discord_free_response``, ``test_discord_allowed_channels``, ``test_discord_allowed_mentions``, ``test_discord_channel_controls``, ``test_discord_reactions``, ``test_discord_thread_persistence``, ``test_runtime_footer``) pass — this is the strongest signal that the YAML→env hook behaves identically to the legacy block. * Broader gateway/cron/integration sweep (1297 tests) introduces zero new failures vs ``main``. Pre-existing failures in ``tests/gateway/test_tts_media_routing.py`` and ``tests/e2e/test_platform_commands.py`` reproduce identically on the unchanged ``main`` revision. * Plugin discovery sanity check confirms Discord registers alongside the other four platform plugins: Registered platforms: ['discord', 'google_chat', 'irc', 'line', 'teams'] These Discord-shaped tendrils in core were **deliberately not moved** — they are generic platform-registry concerns affecting every platform, not Discord-specific: * ``gateway/config.py:1205`` ``DISCORD_BOT_TOKEN → config.token`` env enablement — same shape Telegram has. The existing ``env_enablement_fn`` registry hook only seeds ``extra``, not ``.token``, so it can't replace this without an adapter refactor to read from ``extra["bot_token"]``. * ``gateway/run.py`` voice-mode hooks (``self.adapters.get(Platform.DISCORD)`` for ``start_voice_mode``/``stop_voice_mode``), role-based auth, ``DISCORD_ALLOW_BOTS`` branch in ``_is_user_authorized``, ``_UPDATE_ALLOWED_PLATFORMS`` frozenset, and the per-platform allowlist maps — generic platform-registry concerns. * ``Platform.DISCORD`` enum literal — stable identifier used as dict keys throughout the codebase; removing it is a separate refactor with no real benefit. * ``tools/discord_tool.py`` and ``tools/environments/local.py`` — first-class agent tools and env-passthrough config, neither is the gateway adapter. Each of these is worth its own scoping issue when the time comes.
100 lines
4.1 KiB
Python
100 lines
4.1 KiB
Python
"""Tests for Discord thread participation persistence.
|
|
|
|
Verifies that _threads (ThreadParticipationTracker) survives adapter restarts by
|
|
being persisted to ~/.hermes/discord_threads.json.
|
|
"""
|
|
|
|
import json
|
|
import os
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
|
|
class TestDiscordThreadPersistence:
|
|
"""Thread IDs are saved to disk and reloaded on init."""
|
|
|
|
def _make_adapter(self, tmp_path):
|
|
"""Build a minimal DiscordAdapter with HERMES_HOME pointed at tmp_path."""
|
|
from gateway.config import PlatformConfig
|
|
from plugins.platforms.discord.adapter import DiscordAdapter
|
|
|
|
config = PlatformConfig(enabled=True, token="test-token")
|
|
with patch.dict(os.environ, {"HERMES_HOME": str(tmp_path)}):
|
|
return DiscordAdapter(config=config)
|
|
|
|
def test_starts_empty_when_no_state_file(self, tmp_path):
|
|
adapter = self._make_adapter(tmp_path)
|
|
assert "$nonexistent" not in adapter._threads
|
|
|
|
def test_track_thread_persists_to_disk(self, tmp_path):
|
|
adapter = self._make_adapter(tmp_path)
|
|
with patch.dict(os.environ, {"HERMES_HOME": str(tmp_path)}):
|
|
adapter._threads.mark("111")
|
|
adapter._threads.mark("222")
|
|
|
|
state_file = tmp_path / "discord_threads.json"
|
|
assert state_file.exists()
|
|
saved = json.loads(state_file.read_text())
|
|
assert set(saved) == {"111", "222"}
|
|
|
|
def test_threads_survive_restart(self, tmp_path):
|
|
"""Threads tracked by one adapter instance are visible to the next."""
|
|
adapter1 = self._make_adapter(tmp_path)
|
|
with patch.dict(os.environ, {"HERMES_HOME": str(tmp_path)}):
|
|
adapter1._threads.mark("aaa")
|
|
adapter1._threads.mark("bbb")
|
|
|
|
adapter2 = self._make_adapter(tmp_path)
|
|
assert "aaa" in adapter2._threads
|
|
assert "bbb" in adapter2._threads
|
|
|
|
def test_duplicate_track_does_not_double_save(self, tmp_path):
|
|
adapter = self._make_adapter(tmp_path)
|
|
with patch.dict(os.environ, {"HERMES_HOME": str(tmp_path)}):
|
|
adapter._threads.mark("111")
|
|
adapter._threads.mark("111") # no-op
|
|
|
|
saved = json.loads((tmp_path / "discord_threads.json").read_text())
|
|
assert saved.count("111") == 1
|
|
|
|
def test_caps_at_max_tracked_threads(self, tmp_path):
|
|
adapter = self._make_adapter(tmp_path)
|
|
adapter._threads._max_tracked = 5
|
|
with patch.dict(os.environ, {"HERMES_HOME": str(tmp_path)}):
|
|
for i in range(10):
|
|
adapter._threads.mark(str(i))
|
|
|
|
saved = json.loads((tmp_path / "discord_threads.json").read_text())
|
|
assert len(saved) == 5
|
|
assert saved == ["5", "6", "7", "8", "9"]
|
|
|
|
def test_capacity_keeps_newest_thread_when_existing_state_is_full(self, tmp_path):
|
|
"""A newly joined thread must not be evicted by unordered set iteration."""
|
|
state_file = tmp_path / "discord_threads.json"
|
|
state_file.write_text(json.dumps(["0", "1", "2", "3", "4"]), encoding="utf-8")
|
|
adapter = self._make_adapter(tmp_path)
|
|
adapter._threads._max_tracked = 5
|
|
|
|
with patch.dict(os.environ, {"HERMES_HOME": str(tmp_path)}):
|
|
adapter._threads.mark("newest")
|
|
|
|
saved = json.loads(state_file.read_text(encoding="utf-8"))
|
|
assert saved == ["1", "2", "3", "4", "newest"]
|
|
assert "newest" in adapter._threads
|
|
|
|
def test_corrupted_state_file_falls_back_to_empty(self, tmp_path):
|
|
state_file = tmp_path / "discord_threads.json"
|
|
state_file.write_text("not valid json{{{")
|
|
adapter = self._make_adapter(tmp_path)
|
|
assert "$nonexistent" not in adapter._threads
|
|
|
|
def test_missing_hermes_home_does_not_crash(self, tmp_path):
|
|
"""Load/save tolerate missing directories."""
|
|
fake_home = tmp_path / "nonexistent" / "deep"
|
|
with patch.dict(os.environ, {"HERMES_HOME": str(fake_home)}):
|
|
from gateway.platforms.helpers import ThreadParticipationTracker
|
|
# ThreadParticipationTracker should return empty set, not crash
|
|
tracker = ThreadParticipationTracker("discord")
|
|
assert "$test" not in tracker
|