feat(whatsapp): add dm_policy and group_policy parity with WeCom/Weixin/QQ adapters
Add dm_policy and group_policy to the WhatsApp adapter, bringing parity with WeCom/Weixin/QQ. Allows independent control of DM and group access: disable DMs entirely, allowlist specific senders/groups, or keep open. - dm_policy: open (default) | allowlist | disabled - group_policy: open (default) | allowlist | disabled - Config bridging for YAML → env vars - 22 tests covering all policy combinations Backward compatible — defaults preserve existing behavior. Cherry-picked from PR #11597 by @MassiveMassimo. Dropped the run.py group auth bypass (would have skipped user auth for ALL platforms, not just WhatsApp).
This commit is contained in:
MassiveMassimo
@@ -4,7 +4,8 @@ from unittest.mock import AsyncMock
|
||||
from gateway.config import Platform, PlatformConfig, load_gateway_config
|
||||
|
||||
|
||||
def _make_adapter(require_mention=None, mention_patterns=None, free_response_chats=None):
|
||||
def _make_adapter(require_mention=None, mention_patterns=None, free_response_chats=None,
|
||||
dm_policy=None, allow_from=None, group_policy=None, group_allow_from=None):
|
||||
from gateway.platforms.whatsapp import WhatsAppAdapter
|
||||
|
||||
extra = {}
|
||||
@@ -14,12 +15,25 @@ def _make_adapter(require_mention=None, mention_patterns=None, free_response_cha
|
||||
extra["mention_patterns"] = mention_patterns
|
||||
if free_response_chats is not None:
|
||||
extra["free_response_chats"] = free_response_chats
|
||||
if dm_policy is not None:
|
||||
extra["dm_policy"] = dm_policy
|
||||
if allow_from is not None:
|
||||
extra["allow_from"] = allow_from
|
||||
if group_policy is not None:
|
||||
extra["group_policy"] = group_policy
|
||||
if group_allow_from is not None:
|
||||
extra["group_allow_from"] = group_allow_from
|
||||
|
||||
adapter = object.__new__(WhatsAppAdapter)
|
||||
adapter.platform = Platform.WHATSAPP
|
||||
adapter.config = PlatformConfig(enabled=True, extra=extra)
|
||||
adapter._message_handler = AsyncMock()
|
||||
adapter._dm_policy = str(extra.get("dm_policy", "open")).strip().lower()
|
||||
adapter._allow_from = WhatsAppAdapter._coerce_allow_list(extra.get("allow_from"))
|
||||
adapter._group_policy = str(extra.get("group_policy", "open")).strip().lower()
|
||||
adapter._group_allow_from = WhatsAppAdapter._coerce_allow_list(extra.get("group_allow_from"))
|
||||
adapter._mention_patterns = adapter._compile_mention_patterns()
|
||||
adapter._free_response_chats = adapter._whatsapp_free_response_chats()
|
||||
return adapter
|
||||
|
||||
|
||||
@@ -36,6 +50,21 @@ def _group_message(body="hello", **overrides):
|
||||
return data
|
||||
|
||||
|
||||
def _dm_message(body="hello", **overrides):
|
||||
data = {
|
||||
"isGroup": False,
|
||||
"body": body,
|
||||
"senderId": "6281234567890@s.whatsapp.net",
|
||||
"from": "6281234567890@s.whatsapp.net",
|
||||
"botIds": [],
|
||||
"mentionedIds": [],
|
||||
}
|
||||
data.update(overrides)
|
||||
return data
|
||||
|
||||
|
||||
# --- Existing tests (unchanged logic, updated helper) ---
|
||||
|
||||
def test_group_messages_can_be_opened_via_config():
|
||||
adapter = _make_adapter(require_mention=False)
|
||||
|
||||
@@ -118,10 +147,10 @@ def test_free_response_chats_does_not_bypass_other_groups():
|
||||
assert adapter._should_process_message(_group_message("hello everyone")) is False
|
||||
|
||||
|
||||
def test_dm_always_passes_even_with_require_mention():
|
||||
def test_dm_passes_with_default_open_policy():
|
||||
adapter = _make_adapter(require_mention=True)
|
||||
|
||||
dm = {"isGroup": False, "body": "hello", "botIds": [], "mentionedIds": []}
|
||||
dm = _dm_message("hello")
|
||||
assert adapter._should_process_message(dm) is True
|
||||
|
||||
|
||||
@@ -140,3 +169,130 @@ def test_mention_stripping_preserves_body_when_no_mention():
|
||||
data = _group_message("just a normal message")
|
||||
cleaned = adapter._clean_bot_mention_text(data["body"], data)
|
||||
assert cleaned == "just a normal message"
|
||||
|
||||
|
||||
# --- New dm_policy tests ---
|
||||
|
||||
def test_dm_policy_disabled_blocks_all_dms():
|
||||
adapter = _make_adapter(dm_policy="disabled")
|
||||
|
||||
assert adapter._should_process_message(_dm_message("hello")) is False
|
||||
|
||||
|
||||
def test_dm_policy_disabled_still_allows_groups():
|
||||
adapter = _make_adapter(dm_policy="disabled", require_mention=False)
|
||||
|
||||
assert adapter._should_process_message(_group_message("hello")) is True
|
||||
|
||||
|
||||
def test_dm_policy_allowlist_blocks_unlisted_sender():
|
||||
adapter = _make_adapter(dm_policy="allowlist", allow_from=["6289999999999@s.whatsapp.net"])
|
||||
|
||||
assert adapter._should_process_message(_dm_message("hello")) is False
|
||||
|
||||
|
||||
def test_dm_policy_allowlist_allows_listed_sender():
|
||||
adapter = _make_adapter(dm_policy="allowlist", allow_from=["6281234567890@s.whatsapp.net"])
|
||||
|
||||
assert adapter._should_process_message(_dm_message("hello")) is True
|
||||
|
||||
|
||||
def test_dm_policy_open_allows_all_dms():
|
||||
adapter = _make_adapter(dm_policy="open")
|
||||
|
||||
assert adapter._should_process_message(_dm_message("hello")) is True
|
||||
|
||||
|
||||
# --- New group_policy tests ---
|
||||
|
||||
def test_group_policy_disabled_blocks_all_groups():
|
||||
adapter = _make_adapter(group_policy="disabled", require_mention=False)
|
||||
|
||||
assert adapter._should_process_message(_group_message("hello")) is False
|
||||
|
||||
|
||||
def test_group_policy_disabled_still_allows_dms():
|
||||
adapter = _make_adapter(group_policy="disabled")
|
||||
|
||||
assert adapter._should_process_message(_dm_message("hello")) is True
|
||||
|
||||
|
||||
def test_group_policy_allowlist_blocks_unlisted_group():
|
||||
adapter = _make_adapter(group_policy="allowlist", group_allow_from=["999999999999@g.us"])
|
||||
|
||||
assert adapter._should_process_message(_group_message("agus test")) is False
|
||||
|
||||
|
||||
def test_group_policy_allowlist_allows_listed_group():
|
||||
adapter = _make_adapter(
|
||||
group_policy="allowlist",
|
||||
group_allow_from=["120363001234567890@g.us"],
|
||||
require_mention=True,
|
||||
mention_patterns=[r"^\s*(?:(?:@)?(?:agus|Augustus))\b"],
|
||||
)
|
||||
|
||||
# Listed group — passes the allowlist gate, mention still required
|
||||
assert adapter._should_process_message(_group_message("hello")) is False
|
||||
assert adapter._should_process_message(_group_message("agus test")) is True
|
||||
|
||||
|
||||
def test_group_policy_open_allows_all_groups():
|
||||
adapter = _make_adapter(group_policy="open", require_mention=True)
|
||||
|
||||
# Open policy — all groups pass the gate (mention still needed)
|
||||
assert adapter._should_process_message(_group_message("hello")) is False
|
||||
assert adapter._should_process_message(_group_message("/status")) is True
|
||||
|
||||
|
||||
# --- Config bridging tests ---
|
||||
|
||||
def test_config_bridges_whatsapp_dm_and_group_policy(monkeypatch, tmp_path):
|
||||
hermes_home = tmp_path / ".hermes"
|
||||
hermes_home.mkdir()
|
||||
(hermes_home / "config.yaml").write_text(
|
||||
"whatsapp:\n"
|
||||
" dm_policy: disabled\n"
|
||||
" group_policy: allowlist\n"
|
||||
" group_allow_from:\n"
|
||||
" - \"120363001234567890@g.us\"\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
monkeypatch.setenv("HERMES_HOME", str(hermes_home))
|
||||
monkeypatch.delenv("WHATSAPP_DM_POLICY", raising=False)
|
||||
monkeypatch.delenv("WHATSAPP_GROUP_POLICY", raising=False)
|
||||
monkeypatch.delenv("WHATSAPP_GROUP_ALLOWED_USERS", raising=False)
|
||||
|
||||
config = load_gateway_config()
|
||||
|
||||
assert config is not None
|
||||
assert config.platforms[Platform.WHATSAPP].extra["dm_policy"] == "disabled"
|
||||
assert config.platforms[Platform.WHATSAPP].extra["group_policy"] == "allowlist"
|
||||
assert config.platforms[Platform.WHATSAPP].extra["group_allow_from"] == ["120363001234567890@g.us"]
|
||||
assert __import__("os").environ["WHATSAPP_DM_POLICY"] == "disabled"
|
||||
assert __import__("os").environ["WHATSAPP_GROUP_POLICY"] == "allowlist"
|
||||
assert __import__("os").environ["WHATSAPP_GROUP_ALLOWED_USERS"] == "120363001234567890@g.us"
|
||||
|
||||
|
||||
def test_config_bridges_whatsapp_allow_from(monkeypatch, tmp_path):
|
||||
hermes_home = tmp_path / ".hermes"
|
||||
hermes_home.mkdir()
|
||||
(hermes_home / "config.yaml").write_text(
|
||||
"whatsapp:\n"
|
||||
" dm_policy: allowlist\n"
|
||||
" allow_from:\n"
|
||||
" - \"6281234567890@s.whatsapp.net\"\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
monkeypatch.setenv("HERMES_HOME", str(hermes_home))
|
||||
monkeypatch.delenv("WHATSAPP_DM_POLICY", raising=False)
|
||||
monkeypatch.delenv("WHATSAPP_ALLOWED_USERS", raising=False)
|
||||
|
||||
config = load_gateway_config()
|
||||
|
||||
assert config is not None
|
||||
assert config.platforms[Platform.WHATSAPP].extra["dm_policy"] == "allowlist"
|
||||
assert config.platforms[Platform.WHATSAPP].extra["allow_from"] == ["6281234567890@s.whatsapp.net"]
|
||||
assert __import__("os").environ["WHATSAPP_DM_POLICY"] == "allowlist"
|
||||
assert __import__("os").environ["WHATSAPP_ALLOWED_USERS"] == "6281234567890@s.whatsapp.net"
|
||||
|
||||
Reference in New Issue
Block a user