diff --git a/pyproject.toml b/pyproject.toml index abba6e25..f8311dd2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -58,6 +58,7 @@ dev = [ "ipdb>=0.13.13,<0.14.0", "aioresponses>=0.7.4,<0.8.0", "pytest-mock>=3.10.0,<4.0.0", + "httpx>=0.27,<1.0", ] [tool.taskipy.tasks] diff --git a/src/webhooks/handlers/mp.py b/src/webhooks/handlers/mp.py index 17d2de5c..a539186d 100644 --- a/src/webhooks/handlers/mp.py +++ b/src/webhooks/handlers/mp.py @@ -1,10 +1,15 @@ from discord import Bot, Member, Role +from fastapi import HTTPException from typing import Literal +from src.database.models.dynamic_role import RoleCategory from src.webhooks.handlers.base import BaseHandler from src.webhooks.types import WebhookBody, WebhookEvent +# Plan names (casefolded) that carry no Discord role. +_NO_ROLE_SUBSCRIPTIONS = frozenset({"free"}) + class MPHandler(BaseHandler): async def handle(self, body: WebhookBody, bot: Bot): @@ -29,18 +34,36 @@ async def _handle_subscription_change(self, body: WebhookBody, bot: Bot) -> dict """ Handles the subscription change event. """ - discord_id, _ = self.validate_common_properties(body) + discord_id, account_id = self.validate_common_properties(body) subscription_name = self.validate_property( body.properties.get("subscription_name"), "subscription_name" ) - member = await self.get_guild_member(discord_id, bot) + name = str(subscription_name).strip() + labs = RoleCategory.SUBSCRIPTION_LABS.value + role_group = bot.role_manager.get_group_ids(labs) + + # A plan with no Discord role: drop whatever subscription role the member holds. + if name.casefold() in _NO_ROLE_SUBSCRIPTIONS: + member = await self.get_guild_member(discord_id, bot) + await self.swap_role_in_group( + member, None, role_group, bot, allow_no_role=True + ) + return self.success() - subscription_id = bot.role_manager.get_post_or_rank(subscription_name) + subscription_id = bot.role_manager.get_role_id(labs, name) if not subscription_id: - raise ValueError(f"Invalid subscription name: {subscription_name}") + # 4xx, not 500: the sender must not retry an event that can never succeed. + self.logger.warning( + "No role configured for subscription name '%s'", + name, + extra={"account_id": account_id, "discord_id": discord_id}, + ) + raise HTTPException( + status_code=422, detail=f"Unknown subscription name: {name}" + ) - role_group = bot.role_manager.get_group_ids("subscription_labs") + member = await self.get_guild_member(discord_id, bot) await self.swap_role_in_group(member, subscription_id, role_group, bot) return self.success() diff --git a/tests/src/webhooks/handlers/test_mp.py b/tests/src/webhooks/handlers/test_mp.py index 37d291ce..d7ba36ef 100644 --- a/tests/src/webhooks/handlers/test_mp.py +++ b/tests/src/webhooks/handlers/test_mp.py @@ -1,4 +1,5 @@ import pytest +from fastapi import HTTPException from unittest.mock import AsyncMock, MagicMock from src.webhooks.handlers.mp import MPHandler @@ -50,7 +51,7 @@ async def test_handle_subscription_change_success(self, bot): handler.get_guild_member = AsyncMock(return_value=mock_member) bot.role_manager = _make_role_manager( - get_post_or_rank=lambda what: 555, + get_role_id=lambda category, key: 555, get_group_ids=lambda cat: [555, 666, 777], ) mock_role = MagicMock() @@ -84,9 +85,14 @@ async def test_handle_subscription_change_invalid_role(self, bot): handler.validate_property = MagicMock(return_value=subscription_name) handler.get_guild_member = AsyncMock(return_value=mock_member) - bot.role_manager = _make_role_manager(get_post_or_rank=lambda what: None) - with pytest.raises(ValueError, match="Invalid subscription name"): + bot.role_manager = _make_role_manager( + get_role_id=lambda category, key: None, + get_group_ids=lambda cat: [], + ) + with pytest.raises(HTTPException) as exc_info: await handler._handle_subscription_change(body, bot) + assert exc_info.value.status_code == 422 + handler.get_guild_member.assert_not_awaited() @pytest.mark.asyncio async def test_handle_hof_change_success_top1(self, bot): diff --git a/tests/src/webhooks/test_subscription_change_webhook.py b/tests/src/webhooks/test_subscription_change_webhook.py new file mode 100644 index 00000000..ea022c6b --- /dev/null +++ b/tests/src/webhooks/test_subscription_change_webhook.py @@ -0,0 +1,138 @@ +"""End-to-end tests for the SubscriptionChange webhook (issue #205). + +Each test sends a signed SubscriptionChange webhook through the real FastAPI app, the real +MPHandler and a real RoleManager filled from the env-var fallback roles (the +`vip` / `dedivip` keys). Only Discord itself is mocked. +""" +import hashlib +import hmac +import json +from unittest.mock import AsyncMock, MagicMock, patch + +import httpx +import pytest + +from src.core import settings +from src.database.models.dynamic_role import DynamicRole, RoleCategory +from src.services.role_manager import RoleManager +from src.webhooks import handlers, server +from src.webhooks.types import Platform + + +def _role(role_id: int) -> MagicMock: + role = MagicMock() + role.id = role_id + return role + + +@pytest.fixture +def fake_bot(monkeypatch): + """A bot whose guild has the VIP and VIP+ roles and one member holding no subscription role.""" + role_manager = RoleManager(fallback_roles=settings.roles) + roles: dict = {} + role_manager._apply_fallbacks(roles) # same code path load() uses when the DB has no row + role_manager._roles = roles + + guild_roles = {rid: _role(rid) for rid in role_manager.get_group_ids("subscription_labs")} + + member = MagicMock() + member.roles = [] + member.add_roles = AsyncMock() + member.remove_roles = AsyncMock() + + guild = MagicMock() + guild.get_role.side_effect = guild_roles.get + guild.fetch_member = AsyncMock(return_value=member) + + bot = MagicMock() + bot.role_manager = role_manager + bot.guilds = [guild] + bot.fetch_guild = AsyncMock(return_value=guild) + bot.member = member + bot.bot_fetch_guild = bot.fetch_guild + + monkeypatch.setattr(server, "bot", bot) + return bot + + +async def _post(subscription_name: str) -> httpx.Response: + raw = json.dumps( + { + "platform": "mp", + "event": "SubscriptionChange", + "properties": { + "discord_id": 123456789, + "account_id": 987654321, + "subscription_name": subscription_name, + }, + } + ).encode() + signature = hmac.new(settings.WEBHOOK_TOKEN.encode(), raw, hashlib.sha1).hexdigest() + transport = httpx.ASGITransport(app=server.app) + async with httpx.AsyncClient(transport=transport, base_url="http://test") as client: + return await client.post( + "/webhook", content=raw, headers={"X-Signature": signature, "Content-Type": "application/json"} + ) + + +@pytest.mark.asyncio +@pytest.mark.parametrize("name", ["vip", "dedivip"]) +async def test_known_subscription_names_grant_the_role(fake_bot, name): + response = await _post(name) + assert response.status_code == 200 + fake_bot.member.add_roles.assert_awaited_once() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("name", ["Free", "free"]) +async def test_free_removes_the_subscription_role(fake_bot, name): + vip_id = fake_bot.role_manager.get_role_id("subscription_labs", "vip") + vip_role = fake_bot.guilds[0].get_role(vip_id) + fake_bot.member.roles = [vip_role] + + response = await _post(name) + + assert response.status_code == 200 + fake_bot.member.remove_roles.assert_awaited_once_with(vip_role, atomic=True) + fake_bot.member.add_roles.assert_not_awaited() + + +@pytest.mark.asyncio +async def test_free_without_a_subscription_role_changes_nothing(fake_bot): + response = await _post("Free") + assert response.status_code == 200 + fake_bot.member.remove_roles.assert_not_awaited() + fake_bot.member.add_roles.assert_not_awaited() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("name", ["Pro", "Hacker", "nonsense"]) +async def test_name_without_a_role_returns_422_and_warns(fake_bot, name): + """`Hacker` is a rank key: it must not resolve to a role outside the subscription group.""" + mp_logger = handlers.handlers[Platform.MAIN].__self__.logger + with patch.object(mp_logger, "warning") as warning, patch.object(server.logger, "error") as error: + response = await _post(name) + + assert response.status_code == 422 + assert response.json() == {"detail": f"Unknown subscription name: {name}"} + warning.assert_called_once() + assert name in warning.call_args.args + error.assert_not_called() + fake_bot.bot_fetch_guild.assert_not_awaited() + fake_bot.member.add_roles.assert_not_awaited() + fake_bot.member.remove_roles.assert_not_awaited() + + +@pytest.mark.asyncio +async def test_pro_grants_its_role_once_one_is_configured(fake_bot): + pro = DynamicRole() + pro.key, pro.discord_role_id, pro.category, pro.display_name = "Pro", 4242, RoleCategory.SUBSCRIPTION_LABS, "Pro" + fake_bot.role_manager._roles["subscription_labs"]["Pro"] = pro + pro_role = _role(4242) + known = fake_bot.guilds[0].get_role.side_effect + fake_bot.guilds[0].get_role.side_effect = lambda rid: pro_role if rid == 4242 else known(rid) + + response = await _post("Pro") + + assert response.status_code == 200 + fake_bot.member.add_roles.assert_awaited_once_with(pro_role, atomic=True) diff --git a/uv.lock b/uv.lock index d8ddb3d0..1d39d147 100644 --- a/uv.lock +++ b/uv.lock @@ -789,6 +789,7 @@ dev = [ { name = "flake8-string-format" }, { name = "flake8-tidy-imports" }, { name = "flake8-todo" }, + { name = "httpx" }, { name = "ipdb" }, { name = "ipython" }, { name = "pep8-naming" }, @@ -836,6 +837,7 @@ dev = [ { name = "flake8-string-format", specifier = ">=0.3.0,<0.4.0" }, { name = "flake8-tidy-imports", specifier = ">=4.8.0,<5.0.0" }, { name = "flake8-todo", specifier = ">=0.7,<0.8.0" }, + { name = "httpx", specifier = ">=0.27,<1.0" }, { name = "ipdb", specifier = ">=0.13.13,<0.14.0" }, { name = "ipython", specifier = ">=8.12.0,<9.0.0" }, { name = "pep8-naming", specifier = ">=0.13,<1.0.0" }, @@ -854,6 +856,34 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/07/c6/80c95b1b2b94682a72cbdbfb85b81ae2daffa4291fbfa1b1464502ede10d/hpack-4.1.0-py3-none-any.whl", hash = "sha256:157ac792668d995c657d93111f46b4535ed114f0c9c8d672271bbec7eae1b496", size = 34357, upload-time = "2025-01-22T21:44:56.92Z" }, ] +[[package]] +name = "httpcore" +version = "1.0.9" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "certifi" }, + { name = "h11" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/06/94/82699a10bca87a5556c9c59b5963f2d039dbd239f25bc2a63907a05a14cb/httpcore-1.0.9.tar.gz", hash = "sha256:6e34463af53fd2ab5d807f399a9b45ea31c3dfa2276f15a2c3f00afff6e176e8", size = 85484, upload-time = "2025-04-24T22:06:22.219Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/7e/f5/f66802a942d491edb555dd61e3a9961140fd64c90bce1eafd741609d334d/httpcore-1.0.9-py3-none-any.whl", hash = "sha256:2d400746a40668fc9dec9810239072b40b4484b640a8c38fd654a024c7a1bf55", size = 78784, upload-time = "2025-04-24T22:06:20.566Z" }, +] + +[[package]] +name = "httpx" +version = "0.28.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "anyio" }, + { name = "certifi" }, + { name = "httpcore" }, + { name = "idna" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/b1/df/48c586a5fe32a0f01324ee087459e112ebb7224f646c0b5023f5e79e9956/httpx-0.28.1.tar.gz", hash = "sha256:75e98c5f16b0f35b567856f597f06ff2270a374470a5c2392242528e3e3e42fc", size = 141406, upload-time = "2024-12-06T15:37:23.222Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/2a/39/e50c7c3a983047577ee07d2a9e53faf5a69493943ec3f6a384bdc792deb2/httpx-0.28.1-py3-none-any.whl", hash = "sha256:d909fcccc110f8c7faf814ca82a9a4d816bc5a6dbfea25d6591d6985b8ba59ad", size = 73517, upload-time = "2024-12-06T15:37:21.509Z" }, +] + [[package]] name = "hypercorn" version = "0.17.3"