From f17746d877969b532acda96ec2080af9613f1efc Mon Sep 17 00:00:00 2001 From: Jacob Coffee Date: Fri, 13 Nov 2026 13:23:52 -0600 Subject: [PATCH] fix: /item, /achievement and /who replies, auction price-drop DMs and badge announcements put their links in buttons instead of embed text --- src/sidequest_bot/lib/embeds.py | 13 ++++++ src/sidequest_bot/plugins/achievements.py | 48 +++++++++++++++------ src/sidequest_bot/plugins/auctions.py | 16 +++---- src/sidequest_bot/plugins/badges.py | 19 +++++---- src/sidequest_bot/plugins/characters.py | 10 +++-- src/sidequest_bot/plugins/items.py | 48 ++++++++++++++------- tests/test_achievements.py | 44 +++++++++++++++---- tests/test_auctions.py | 14 ++++++- tests/test_badges.py | 22 ++++++---- tests/test_characters.py | 16 ++++++- tests/test_items.py | 51 +++++++++++++++++------ 11 files changed, 224 insertions(+), 77 deletions(-) diff --git a/src/sidequest_bot/lib/embeds.py b/src/sidequest_bot/lib/embeds.py index a94233e..2dab1f3 100644 --- a/src/sidequest_bot/lib/embeds.py +++ b/src/sidequest_bot/lib/embeds.py @@ -69,3 +69,16 @@ def user_line(user: discord.Member | discord.User) -> str: def truncate(text: str, limit: int = 1024) -> str: """Trim ``text`` to fit an embed field (default 1024 chars).""" return text if len(text) <= limit else text[: limit - 1] + "…" + + +def link_button(label: str, url: str) -> discord.ui.Button: + """A link-style button; needs no callback, so it works in views with any timeout, including none.""" + return discord.ui.Button(style=discord.ButtonStyle.link, label=label, url=url) + + +def link_view(*buttons: discord.ui.Button, timeout: float | None = None) -> discord.ui.View: + """A view holding only link buttons, in order.""" + view = discord.ui.View(timeout=timeout) + for button in buttons: + view.add_item(button) + return view diff --git a/src/sidequest_bot/plugins/achievements.py b/src/sidequest_bot/plugins/achievements.py index 34b0ce7..7e453ee 100644 --- a/src/sidequest_bot/plugins/achievements.py +++ b/src/sidequest_bot/plugins/achievements.py @@ -10,7 +10,7 @@ import logging from datetime import datetime, timedelta from http import HTTPStatus -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, cast import discord from discord import app_commands @@ -18,7 +18,7 @@ from sidequest_bot.api_client import APIError, NotFoundError from sidequest_bot.bot import SideQuestBot # noqa: TC001 # discord.py evaluates app-command annotations at runtime -from sidequest_bot.lib.embeds import Colors, make_embed, truncate +from sidequest_bot.lib.embeds import Colors, link_button, link_view, make_embed, truncate if TYPE_CHECKING: from collections.abc import Sequence @@ -29,6 +29,7 @@ logger = logging.getLogger(__name__) ACHIEVEMENT_PAGE_URL = "https://sidequest-guild.com/achievements/detail/?id={achievement_id}" +ACHIEVEMENT_WOWHEAD_URL = "https://www.wowhead.com/forever/achievement={achievement_id}" DESCRIPTION_LIMIT = 4096 MAX_AUTOCOMPLETE_RESULTS = 25 MAX_OTHER_MATCHES = 5 @@ -54,14 +55,22 @@ def build_achievement_embed(achievement: AchievementSchema) -> discord.Embed: embed.add_field(name="Category", value=achievement.category) if achievement.reward_description: embed.add_field(name="Reward", value=truncate(achievement.reward_description), inline=False) - embed.add_field( - name="Site", - value=f"[View on site]({ACHIEVEMENT_PAGE_URL.format(achievement_id=achievement.id)})", - inline=False, - ) return embed +def achievement_link_buttons(achievement_id: int) -> list[discord.ui.Button]: + """Site + Wowhead link buttons for one achievement.""" + return [ + link_button("Site", ACHIEVEMENT_PAGE_URL.format(achievement_id=achievement_id)), + link_button("Wowhead", ACHIEVEMENT_WOWHEAD_URL.format(achievement_id=achievement_id)), + ] + + +def achievement_link_view(achievement_id: int) -> discord.ui.View: + """A view holding just the achievement's link buttons, for replies with no other matches to offer.""" + return link_view(*achievement_link_buttons(achievement_id)) + + def match_option(match: AchievementSummary) -> discord.SelectOption: """One search result as a select option, with its points as the description.""" return discord.SelectOption(label=truncate(match.name, 100), value=str(match.id), description=f"{match.points} pts") @@ -150,16 +159,29 @@ async def callback(self, interaction: discord.Interaction[SideQuestBot]) -> None if isinstance(result, str): await interaction.response.send_message(result, ephemeral=True) return - await interaction.response.edit_message(embed=result, view=self.view) + view = cast("AchievementMatchView", self.view) + view.set_achievement(achievement_id) + await interaction.response.edit_message(embed=result, view=view) class AchievementMatchView(discord.ui.View): - """A select menu of up to :data:`MAX_OTHER_MATCHES` other search matches, swapping the shown embed on pick.""" + """Link buttons for the shown achievement plus a select menu of up to :data:`MAX_OTHER_MATCHES` other matches. - def __init__(self, matches: Sequence[AchievementSummary]) -> None: + Picking another match swaps the shown embed and repoints the link buttons at it. + """ + + def __init__(self, achievement_id: int, matches: Sequence[AchievementSummary]) -> None: super().__init__(timeout=180) + self._site_button, self._wowhead_button = achievement_link_buttons(achievement_id) self._select = _AchievementMatchSelect(matches) self.add_item(self._select) + self.add_item(self._site_button) + self.add_item(self._wowhead_button) + + def set_achievement(self, achievement_id: int) -> None: + """Repoint the link buttons at ``achievement_id``.""" + self._site_button.url = ACHIEVEMENT_PAGE_URL.format(achievement_id=achievement_id) + self._wowhead_button.url = ACHIEVEMENT_WOWHEAD_URL.format(achievement_id=achievement_id) class AchievementsCog(commands.Cog): @@ -179,7 +201,7 @@ async def achievement_command(self, interaction: discord.Interaction[SideQuestBo if isinstance(result, str): await interaction.followup.send(result, ephemeral=True) return - await interaction.followup.send(embed=result) + await interaction.followup.send(embed=result, view=achievement_link_view(int(name))) return try: achievements = await _cache.get(self.bot.api) @@ -205,9 +227,9 @@ async def achievement_command(self, interaction: discord.Interaction[SideQuestBo await interaction.followup.send(result, ephemeral=True) return if others: - await interaction.followup.send(embed=result, view=AchievementMatchView(others)) + await interaction.followup.send(embed=result, view=AchievementMatchView(best.id, others)) else: - await interaction.followup.send(embed=result) + await interaction.followup.send(embed=result, view=achievement_link_view(best.id)) async def setup(bot: SideQuestBot) -> None: diff --git a/src/sidequest_bot/plugins/auctions.py b/src/sidequest_bot/plugins/auctions.py index 8c1c31c..7849021 100644 --- a/src/sidequest_bot/plugins/auctions.py +++ b/src/sidequest_bot/plugins/auctions.py @@ -28,7 +28,7 @@ NotFoundError, ) from sidequest_bot.bot import SideQuestBot # noqa: TC001 # discord.py evaluates app-command annotations at runtime -from sidequest_bot.lib.embeds import Colors, make_embed, truncate +from sidequest_bot.lib.embeds import Colors, link_button, link_view, make_embed, truncate from sidequest_bot.plugins.items import ITEM_PAGE_URL, item_quality_color if TYPE_CHECKING: @@ -94,11 +94,8 @@ def format_price(copper: int) -> str: def build_alert_embed(alert: AuctionAlertSchema) -> discord.Embed: """DM embed for one price alert: item name/link, price vs the member's max, quantity and house.""" name = alert.item_name or f"Item {alert.item_id}" - embed = make_embed( - title=f"{name} is on sale", - description=f"[View on the site]({ITEM_PAGE_URL.format(item_id=alert.item_id)})", - color=Colors.GOLD, - ) + embed = make_embed(title=f"{name} is on sale", color=Colors.GOLD) + embed.url = ITEM_PAGE_URL.format(item_id=alert.item_id) if alert.icon_url: embed.set_thumbnail(url=alert.icon_url) embed.add_field( @@ -109,6 +106,11 @@ def build_alert_embed(alert: AuctionAlertSchema) -> discord.Embed: return embed +def build_alert_view(alert: AuctionAlertSchema) -> discord.ui.View: + """A view holding the DM's "View on the site" link button.""" + return link_view(link_button("View on the site", ITEM_PAGE_URL.format(item_id=alert.item_id))) + + def build_price_embed(item: Item, price: ItemAuctionPrice) -> discord.Embed: """``/price``'s embed: lowest price and where, total listed, per-house lines, and the 14-day low/high.""" embed = make_embed(title=item.name, color=item_quality_color(item.quality)) @@ -227,7 +229,7 @@ async def _send_alert(self, guild: discord.Guild, alert: AuctionAlertSchema) -> logger.info("Could not find Discord user %s for auction alert %s", alert.discord_user_id, alert.id) else: try: - await user.send(embed=build_alert_embed(alert)) + await user.send(embed=build_alert_embed(alert), view=build_alert_view(alert)) except discord.Forbidden: logger.info("Could not DM auction alert to %s: DMs are closed", alert.discord_user_id) except discord.HTTPException: diff --git a/src/sidequest_bot/plugins/badges.py b/src/sidequest_bot/plugins/badges.py index 0df1731..8c9ef3f 100644 --- a/src/sidequest_bot/plugins/badges.py +++ b/src/sidequest_bot/plugins/badges.py @@ -33,7 +33,7 @@ from sidequest_bot.api_client import APIError, NotFoundError from sidequest_bot.bot import SideQuestBot # noqa: TC001 # discord.py evaluates app-command annotations at runtime -from sidequest_bot.lib.embeds import Colors, make_embed +from sidequest_bot.lib.embeds import Colors, link_button, link_view, make_embed from sidequest_bot.lib.roles import grant_block_reason from sidequest_common.schemas import BadgeAck, GuildConfigUpdate from sidequest_common.schemas.badges import BADGE_LIST, BADGES, BadgeDefinition @@ -95,8 +95,8 @@ def badge_grant_reason(badge_id: str) -> str: return f"Earned {name} on sidequest-guild.com" -def build_badge_embed(announcement: PendingBadgeAnnouncement, profile_url: str, *, with_icon: bool) -> discord.Embed: - """Gold embed for one newly earned badge, with a link to the Hall of Heroes. +def build_badge_embed(announcement: PendingBadgeAnnouncement, *, with_icon: bool) -> discord.Embed: + """Gold embed for one newly earned badge. ``with_icon``: the badge's image rides along as an attachment and shows as the thumbnail; otherwise the definition's emoji leads the title. @@ -110,10 +110,14 @@ def build_badge_embed(announcement: PendingBadgeAnnouncement, profile_url: str, ) if with_icon: embed.set_thumbnail(url=f"attachment://{BADGE_ICON_FILENAME}") - embed.add_field(name="Hall of Heroes", value=f"[View the Hall of Heroes]({profile_url})", inline=False) return embed +def build_badge_view(profile_url: str) -> discord.ui.View: + """A view holding the announcement's "Hall of Heroes" link button.""" + return link_view(link_button("Hall of Heroes", profile_url)) + + async def create_badge_role(guild: discord.Guild, badge: BadgeDefinition) -> discord.Role | None: """Create ``badge``'s Discord role: not hoisted, not mentionable, colored per the badge definition. @@ -290,14 +294,13 @@ async def _announce_one( self, guild: discord.Guild, channel: discord.TextChannel, announcement: PendingBadgeAnnouncement ) -> bool: icon = badge_icon(announcement.badge_id) - embed = build_badge_embed( - announcement, hall_of_heroes_url(_web_settings().BASE_URL), with_icon=icon is not None - ) + embed = build_badge_embed(announcement, with_icon=icon is not None) + view = build_badge_view(hall_of_heroes_url(_web_settings().BASE_URL)) mention_target = guild.get_member(announcement.discord_id) or discord.Object(id=announcement.discord_id) allowed = discord.AllowedMentions(users=[mention_target]) files = [discord.File(io.BytesIO(icon), BADGE_ICON_FILENAME)] if icon is not None else [] try: - await channel.send(embed=embed, files=files, allowed_mentions=allowed) + await channel.send(embed=embed, view=view, files=files, allowed_mentions=allowed) except discord.HTTPException: logger.warning( "Failed to post badge announcement for %s in guild %s", diff --git a/src/sidequest_bot/plugins/characters.py b/src/sidequest_bot/plugins/characters.py index 8c65c91..5f627bd 100644 --- a/src/sidequest_bot/plugins/characters.py +++ b/src/sidequest_bot/plugins/characters.py @@ -15,7 +15,7 @@ from sidequest_bot.api_client import APIError, CharacterPage, CharacterSummary, NotFoundError from sidequest_bot.bot import SideQuestBot # noqa: TC001 # discord.py evaluates app-command annotations at runtime -from sidequest_bot.lib.embeds import Colors, make_embed, truncate +from sidequest_bot.lib.embeds import Colors, link_button, link_view, make_embed, truncate if TYPE_CHECKING: from collections.abc import Sequence @@ -161,10 +161,14 @@ def build_character_embed(character: CharacterPage) -> discord.Embed: embed.add_field(name="Gear", value=build_gear_field(character.sheet.gear), inline=False) if character.sheet is not None and character.sheet.hunter_pets: embed.add_field(name="Pets", value=build_pets_field(character.sheet.hunter_pets), inline=False) - embed.add_field(name="Armory", value=f"[View on Armory]({ARMORY_URL.format(slug=character.slug)})", inline=False) return embed +def character_link_view(slug: str) -> discord.ui.View: + """A view holding the character's Armory link button.""" + return link_view(link_button("View on Armory", ARMORY_URL.format(slug=slug))) + + class CharactersCog(commands.Cog): """``/who`` character lookup.""" @@ -195,7 +199,7 @@ async def who_command(self, interaction: discord.Interaction[SideQuestBot], char "Couldn't look up that character right now; try again shortly.", ephemeral=True ) return - await interaction.followup.send(embed=build_character_embed(page)) + await interaction.followup.send(embed=build_character_embed(page), view=character_link_view(page.slug)) async def setup(bot: SideQuestBot) -> None: diff --git a/src/sidequest_bot/plugins/items.py b/src/sidequest_bot/plugins/items.py index 9c94068..b9a17c7 100644 --- a/src/sidequest_bot/plugins/items.py +++ b/src/sidequest_bot/plugins/items.py @@ -8,7 +8,7 @@ import logging import re from http import HTTPStatus -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, cast import discord from discord import app_commands @@ -16,7 +16,7 @@ from sidequest_bot.api_client import APIError, Item, ItemSummary, NotFoundError from sidequest_bot.bot import SideQuestBot # noqa: TC001 # discord.py evaluates app-command annotations at runtime -from sidequest_bot.lib.embeds import Colors, make_embed, truncate +from sidequest_bot.lib.embeds import Colors, link_button, link_view, make_embed, truncate if TYPE_CHECKING: from collections.abc import Sequence @@ -66,15 +66,22 @@ def build_item_embed(item: Item) -> discord.Embed: ) if item.icon_url: embed.set_thumbnail(url=item.icon_url) - embed.add_field( - name="Links", - value=f"[Item page]({ITEM_PAGE_URL.format(item_id=item.item_id)}) • " - f"[Wowhead]({WOWHEAD_URL.format(item_id=item.item_id)})", - inline=False, - ) return embed +def item_link_buttons(item_id: int) -> list[discord.ui.Button]: + """Item page + Wowhead link buttons for one item.""" + return [ + link_button("Item page", ITEM_PAGE_URL.format(item_id=item_id)), + link_button("Wowhead", WOWHEAD_URL.format(item_id=item_id)), + ] + + +def item_link_view(item_id: int) -> discord.ui.View: + """A view holding just the item's link buttons, for replies with no other matches to offer.""" + return link_view(*item_link_buttons(item_id)) + + def match_option(match: ItemSummary) -> discord.SelectOption: """One search result as a select option, with quality/slot/ilvl as its description.""" return discord.SelectOption( @@ -110,16 +117,29 @@ async def callback(self, interaction: discord.Interaction[SideQuestBot]) -> None if isinstance(result, str): await interaction.response.send_message(result, ephemeral=True) return - await interaction.response.edit_message(embed=result, view=self.view) + view = cast("ItemMatchView", self.view) + view.set_item(item_id) + await interaction.response.edit_message(embed=result, view=view) class ItemMatchView(discord.ui.View): - """A select menu of up to :data:`MAX_OTHER_MATCHES` other search matches, swapping the shown embed on pick.""" + """Link buttons for the shown item plus a select menu of up to :data:`MAX_OTHER_MATCHES` other matches. - def __init__(self, matches: Sequence[ItemSummary]) -> None: + Picking another match swaps the shown embed and repoints the link buttons at it. + """ + + def __init__(self, item_id: int, matches: Sequence[ItemSummary]) -> None: super().__init__(timeout=180) + self._item_page_button, self._wowhead_button = item_link_buttons(item_id) self._select = _ItemMatchSelect(matches) self.add_item(self._select) + self.add_item(self._item_page_button) + self.add_item(self._wowhead_button) + + def set_item(self, item_id: int) -> None: + """Repoint the link buttons at ``item_id``.""" + self._item_page_button.url = ITEM_PAGE_URL.format(item_id=item_id) + self._wowhead_button.url = WOWHEAD_URL.format(item_id=item_id) class ItemsCog(commands.Cog): @@ -151,9 +171,9 @@ async def item_command(self, interaction: discord.Interaction[SideQuestBot], nam await interaction.followup.send(result, ephemeral=True) return if others: - await interaction.followup.send(embed=result, view=ItemMatchView(others)) + await interaction.followup.send(embed=result, view=ItemMatchView(best.item_id, others)) else: - await interaction.followup.send(embed=result) + await interaction.followup.send(embed=result, view=item_link_view(best.item_id)) @commands.Cog.listener() async def on_message(self, message: discord.Message) -> None: @@ -176,7 +196,7 @@ async def on_message(self, message: discord.Message) -> None: logger.warning("Item link unfurl failed for %s", item_id, exc_info=True) continue try: - await message.channel.send(embed=build_item_embed(item)) + await message.channel.send(embed=build_item_embed(item), view=item_link_view(item_id)) except discord.HTTPException: logger.warning("Failed to post item unfurl for %s in channel %s", item_id, message.channel.id) diff --git a/tests/test_achievements.py b/tests/test_achievements.py index 1b25650..0475176 100644 --- a/tests/test_achievements.py +++ b/tests/test_achievements.py @@ -17,6 +17,8 @@ AchievementsCog, _AchievementCache, _autocomplete_achievement, + achievement_link_buttons, + achievement_link_view, build_achievement_embed, match_option, ) @@ -112,10 +114,25 @@ def test_omits_reward_when_absent(self) -> None: embed = build_achievement_embed(_achievement(reward_description=None)) assert "Reward" not in [field.name for field in embed.fields] - def test_site_field_links_to_detail_page(self) -> None: + def test_has_no_links_field(self) -> None: embed = build_achievement_embed(_achievement(achievement_id=7)) - field_names = {field.name: field.value for field in embed.fields} - assert "https://sidequest-guild.com/achievements/detail/?id=7" in field_names["Site"] + assert "Site" not in [field.name for field in embed.fields] + + +class TestAchievementLinkButtons: + def test_site_and_wowhead_buttons(self) -> None: + site, wowhead = achievement_link_buttons(7) + assert site.label == "Site" + assert site.url == "https://sidequest-guild.com/achievements/detail/?id=7" + assert wowhead.label == "Wowhead" + assert wowhead.url == "https://www.wowhead.com/forever/achievement=7" + + +class TestAchievementLinkView: + def test_holds_both_link_buttons(self) -> None: + view = achievement_link_view(7) + labels = [button.label for button in view.children] + assert labels == ["Site", "Wowhead"] class TestMatchOption: @@ -241,7 +258,8 @@ async def test_digit_name_fetches_directly(self) -> None: api.get_achievement.assert_awaited_once_with(42) kwargs = interaction.followup.send.await_args.kwargs assert kwargs["embed"].title == "Explorer" - assert "ephemeral" not in kwargs + labels = [button.label for button in kwargs["view"].children] + assert labels == ["Site", "Wowhead"] async def test_digit_name_not_found(self) -> None: api = AsyncMock() @@ -295,7 +313,7 @@ async def test_no_matches_sends_hint(self) -> None: message = interaction.followup.send.await_args.args[0] assert NOT_FOUND_HINT in message - async def test_single_match_sends_embed_without_select(self) -> None: + async def test_single_match_sends_link_buttons_without_select(self) -> None: api = AsyncMock() api.list_achievement_categories.return_value = [AchievementCategoryTree(id=1, name="Root", children=[])] api.get_achievement_category.return_value = AchievementCategorySchema( @@ -309,7 +327,8 @@ async def test_single_match_sends_embed_without_select(self) -> None: kwargs = interaction.followup.send.await_args.kwargs assert kwargs["embed"].title == "Explorer" - assert "view" not in kwargs + labels = [button.label for button in kwargs["view"].children] + assert labels == ["Site", "Wowhead"] async def test_multiple_matches_offers_select_of_others(self) -> None: api = AsyncMock() @@ -344,14 +363,19 @@ async def test_achievement_gone_after_search_reports_gone(self) -> None: class TestAchievementMatchView: def test_options_use_match_names_and_ids(self) -> None: - view = AchievementMatchView([_summary(achievement_id=1, name="A"), _summary(achievement_id=2, name="B")]) + view = AchievementMatchView(1, [_summary(achievement_id=1, name="A"), _summary(achievement_id=2, name="B")]) assert [option.label for option in view._select.options] == ["A", "B"] assert [option.value for option in view._select.options] == ["1", "2"] + def test_link_buttons_point_at_initial_achievement(self) -> None: + view = AchievementMatchView(1, [_summary(achievement_id=2, name="B")]) + assert view._site_button.url == "https://sidequest-guild.com/achievements/detail/?id=1" + assert view._wowhead_button.url == "https://www.wowhead.com/forever/achievement=1" + async def test_select_callback_edits_message_with_chosen_achievement(self) -> None: api = AsyncMock() api.get_achievement.return_value = _achievement(achievement_id=2, name="B") - view = AchievementMatchView([_summary(achievement_id=2, name="B")]) + view = AchievementMatchView(1, [_summary(achievement_id=2, name="B")]) view._select._values = ["2"] interaction = _make_interaction(api=api) @@ -361,11 +385,13 @@ async def test_select_callback_edits_message_with_chosen_achievement(self) -> No kwargs = interaction.response.edit_message.await_args.kwargs assert kwargs["embed"].title == "B" assert kwargs["view"] is view + assert view._site_button.url == "https://sidequest-guild.com/achievements/detail/?id=2" + assert view._wowhead_button.url == "https://www.wowhead.com/forever/achievement=2" async def test_select_callback_reports_error_ephemerally(self) -> None: api = AsyncMock() api.get_achievement.side_effect = NotFoundError(404, "gone") - view = AchievementMatchView([_summary(achievement_id=2)]) + view = AchievementMatchView(1, [_summary(achievement_id=2)]) view._select._values = ["2"] interaction = _make_interaction(api=api) diff --git a/tests/test_auctions.py b/tests/test_auctions.py index 6f94ad7..5523a7c 100644 --- a/tests/test_auctions.py +++ b/tests/test_auctions.py @@ -25,6 +25,7 @@ AuctionsCog, _autocomplete_item, build_alert_embed, + build_alert_view, build_price_embed, format_price, item_choice, @@ -204,7 +205,7 @@ class TestBuildAlertEmbed: def test_title_price_quantity_and_house(self) -> None: embed = build_alert_embed(_alert()) assert embed.title == "Thunderfury is on sale" - assert "sidequest-guild.com/items/detail/?id=19019" in (embed.description or "") + assert embed.url == "https://sidequest-guild.com/items/detail/?id=19019" field_values = {f.name: f.value for f in embed.fields} assert field_values["Price"] == "9s (your max: 10s)" assert field_values["Quantity"] == "3" @@ -215,6 +216,14 @@ def test_missing_item_name_falls_back_to_id(self) -> None: assert embed.title == "Item 19019 is on sale" +class TestBuildAlertView: + def test_view_on_the_site_button(self) -> None: + view = build_alert_view(_alert()) + (button,) = view.children + assert button.label == "View on the site" + assert button.url == "https://sidequest-guild.com/items/detail/?id=19019" + + class TestBuildPriceEmbed: def test_unlisted_item_shows_not_listed_message(self) -> None: embed = build_price_embed(_item(), _price(unit_price=None, houses=[], trend=[])) @@ -353,6 +362,9 @@ async def test_dms_member_and_acks(self) -> None: await cog._send_alert(guild, alert) member.send.assert_awaited_once() + send_kwargs = member.send.await_args.kwargs + (button,) = send_kwargs["view"].children + assert button.label == "View on the site" api.ack_auction_alert.assert_awaited_once_with(guild.id, alert.id) async def test_forbidden_dm_is_still_acked(self) -> None: diff --git a/tests/test_badges.py b/tests/test_badges.py index 000a676..41d4aca 100644 --- a/tests/test_badges.py +++ b/tests/test_badges.py @@ -13,6 +13,7 @@ badge_grant_reason, badge_icon, build_badge_embed, + build_badge_view, create_badge_role, hall_of_heroes_url, plan_badge_role_changes, @@ -136,25 +137,28 @@ def test_no_member_id_in_payload_so_link_is_generic(self) -> None: class TestBuildBadgeEmbed: def test_includes_mention_name_and_description(self) -> None: - embed = build_badge_embed(_announcement(), "https://sidequest-guild.com/heroes/", with_icon=True) + embed = build_badge_embed(_announcement(), with_icon=True) assert "<@1>" in embed.description assert "Raid Regular" in embed.description assert "Attended 10 raids with the guild." in embed.description - def test_includes_hall_of_heroes_link_field(self) -> None: - embed = build_badge_embed(_announcement(), "https://sidequest-guild.com/heroes/", with_icon=True) - link_field = next(f for f in embed.fields if f.name == "Hall of Heroes") - assert "https://sidequest-guild.com/heroes/" in link_field.value - def test_badge_image_is_the_thumbnail_and_replaces_the_emoji(self) -> None: - with_icon = build_badge_embed(_announcement(), "https://x/heroes/", with_icon=True) - without = build_badge_embed(_announcement(), "https://x/heroes/", with_icon=False) + with_icon = build_badge_embed(_announcement(), with_icon=True) + without = build_badge_embed(_announcement(), with_icon=False) assert with_icon.thumbnail.url == f"attachment://{BADGE_ICON_FILENAME}" assert with_icon.title == "Badge earned!" assert without.thumbnail.url is None assert without.title != "Badge earned!" +class TestBuildBadgeView: + def test_hall_of_heroes_button_links_to_profile_url(self) -> None: + view = build_badge_view("https://sidequest-guild.com/heroes/") + (button,) = view.children + assert button.label == "Hall of Heroes" + assert button.url == "https://sidequest-guild.com/heroes/" + + class TestBadgeIcons: PENDING_ICON_BADGE_IDS = frozenset({"party_animal", "party_leader"}) """Badges with no role icon artwork yet; ``badge_icon``/``create_badge_role`` already fall back to no icon.""" @@ -355,6 +359,8 @@ async def test_posts_embed_with_allowed_mentions_scoped_to_the_earner_then_acks( allowed_mentions = send_kwargs["allowed_mentions"] assert allowed_mentions.users == [member] assert [f.filename for f in send_kwargs["files"]] == [BADGE_ICON_FILENAME] + (button,) = send_kwargs["view"].children + assert button.label == "Hall of Heroes" api.ack_badge.assert_awaited_once_with(guild.id, BadgeAck(discord_id=1, badge_id="raid_regular")) async def test_no_channel_configured_skips_posting_and_does_not_ack(self) -> None: diff --git a/tests/test_characters.py b/tests/test_characters.py index 47f5d7a..8bd9f35 100644 --- a/tests/test_characters.py +++ b/tests/test_characters.py @@ -25,6 +25,7 @@ build_gear_field, build_pets_field, character_choice, + character_link_view, class_color, gear_line, guild_value, @@ -218,7 +219,10 @@ def test_includes_optional_fields_when_present(self) -> None: assert "Item level" in field_names assert "Last login" in field_names assert "PvP" in field_names - assert "Armory" in field_names + + def test_has_no_armory_field(self) -> None: + embed = build_character_embed(_page()) + assert "Armory" not in [field.name for field in embed.fields] def test_omits_missing_optional_fields(self) -> None: character = _page(item_level=None, last_login_at=None, honorable_kills=None, pvp_rank=None) @@ -251,6 +255,14 @@ def test_pets_field_present_when_sheet_has_hunter_pets(self) -> None: assert field_names["Pets"] == "Boar (Great Goretusk) 19 · active" +class TestCharacterLinkView: + def test_armory_button(self) -> None: + view = character_link_view("nox-zul") + (button,) = view.children + assert button.label == "View on Armory" + assert button.url == "https://worldofwarcraft.blizzard.com/en-us/forever/us/armory/character/nox-zul" + + class TestAutocomplete: async def test_empty_text_uses_roster(self) -> None: api = AsyncMock() @@ -313,6 +325,8 @@ async def test_success_sends_public_embed(self) -> None: kwargs = interaction.followup.send.await_args.kwargs assert kwargs["embed"].title == "Nox Zul" assert "ephemeral" not in kwargs + (button,) = kwargs["view"].children + assert button.label == "View on Armory" async def test_not_found_sends_api_detail_ephemeral(self) -> None: api = AsyncMock() diff --git a/tests/test_items.py b/tests/test_items.py index 162482f..1ec93db 100644 --- a/tests/test_items.py +++ b/tests/test_items.py @@ -13,6 +13,8 @@ ItemsCog, build_item_embed, format_sell_price, + item_link_buttons, + item_link_view, item_quality_color, ) @@ -115,19 +117,31 @@ def test_description_includes_tooltip_lines_and_sell_price(self) -> None: assert "Unique" in embed.description assert "Sells for 12g 34s 56c." in embed.description - def test_links_field_has_site_and_wowhead(self) -> None: - embed = build_item_embed(_item(item_id=19019)) - assert len(embed.fields) == 1 - value = embed.fields[0].value - assert value is not None - assert "https://sidequest-guild.com/items/detail/?id=19019" in value - assert "https://www.wowhead.com/forever/item=19019" in value + def test_has_no_fields(self) -> None: + embed = build_item_embed(_item()) + assert embed.fields == [] def test_no_icon_leaves_thumbnail_unset(self) -> None: embed = build_item_embed(_item(icon_url=None)) assert embed.thumbnail.url is None +class TestItemLinkButtons: + def test_item_page_and_wowhead_buttons(self) -> None: + item_page, wowhead = item_link_buttons(19019) + assert item_page.label == "Item page" + assert item_page.url == "https://sidequest-guild.com/items/detail/?id=19019" + assert wowhead.label == "Wowhead" + assert wowhead.url == "https://www.wowhead.com/forever/item=19019" + + +class TestItemLinkView: + def test_holds_both_link_buttons(self) -> None: + view = item_link_view(19019) + labels = [button.label for button in view.children] + assert labels == ["Item page", "Wowhead"] + + class TestItemCommand: async def test_no_results_sends_hint_ephemeral(self) -> None: api = AsyncMock() @@ -142,7 +156,7 @@ async def test_no_results_sends_hint_ephemeral(self) -> None: assert NOT_FOUND_HINT in message[0] assert kwargs["ephemeral"] is True - async def test_single_result_sends_embed_without_select(self) -> None: + async def test_single_result_sends_link_buttons_without_select(self) -> None: api = AsyncMock() api.search_items.return_value = SimpleNamespace(results=[_summary(item_id=19019, name="Thunderfury")]) api.get_item.return_value = _item(item_id=19019, name="Thunderfury") @@ -154,7 +168,8 @@ async def test_single_result_sends_embed_without_select(self) -> None: interaction.followup.send.assert_awaited_once() kwargs = interaction.followup.send.await_args.kwargs assert kwargs["embed"].title == "Thunderfury" - assert "view" not in kwargs + labels = [button.label for button in kwargs["view"].children] + assert labels == ["Item page", "Wowhead"] async def test_multiple_results_offers_select_of_others(self) -> None: api = AsyncMock() @@ -206,14 +221,19 @@ async def test_item_gone_after_search_reports_item_gone(self) -> None: class TestItemMatchView: def test_options_use_match_names_and_ids(self) -> None: - view = ItemMatchView([_summary(item_id=1, name="Sword of A"), _summary(item_id=2, name="Sword of B")]) + view = ItemMatchView(1, [_summary(item_id=1, name="Sword of A"), _summary(item_id=2, name="Sword of B")]) assert [o.label for o in view._select.options] == ["Sword of A", "Sword of B"] assert [o.value for o in view._select.options] == ["1", "2"] + def test_link_buttons_point_at_initial_item(self) -> None: + view = ItemMatchView(1, [_summary(item_id=2, name="Sword of B")]) + assert view._item_page_button.url == "https://sidequest-guild.com/items/detail/?id=1" + assert view._wowhead_button.url == "https://www.wowhead.com/forever/item=1" + async def test_select_callback_edits_message_with_chosen_item(self) -> None: api = AsyncMock() api.get_item.return_value = _item(item_id=2, name="Sword of B") - view = ItemMatchView([_summary(item_id=2, name="Sword of B")]) + view = ItemMatchView(1, [_summary(item_id=2, name="Sword of B")]) view._select._values = ["2"] interaction = _make_interaction(api) @@ -223,11 +243,13 @@ async def test_select_callback_edits_message_with_chosen_item(self) -> None: kwargs = interaction.response.edit_message.await_args.kwargs assert kwargs["embed"].title == "Sword of B" assert kwargs["view"] is view + assert view._item_page_button.url == "https://sidequest-guild.com/items/detail/?id=2" + assert view._wowhead_button.url == "https://www.wowhead.com/forever/item=2" async def test_select_callback_reports_error_ephemerally(self) -> None: api = AsyncMock() api.get_item.side_effect = NotFoundError(404, "gone") - view = ItemMatchView([_summary(item_id=2)]) + view = ItemMatchView(1, [_summary(item_id=2)]) view._select._values = ["2"] interaction = _make_interaction(api) @@ -266,7 +288,10 @@ async def test_item_link_posts_its_embed(self) -> None: api.get_item.assert_awaited_once_with(19019) message.channel.send.assert_awaited_once() - assert message.channel.send.await_args.kwargs["embed"].title == "Thunderfury" + send_kwargs = message.channel.send.await_args.kwargs + assert send_kwargs["embed"].title == "Thunderfury" + labels = [button.label for button in send_kwargs["view"].children] + assert labels == ["Item page", "Wowhead"] async def test_unknown_item_link_is_skipped_silently(self) -> None: api = AsyncMock()