Add refresh buttons to issue and commit messages

Author: object-Object

bot/src/ghutils/cogs/app_commands/context_menus.py

@@ -4,14 +4,15 @@
 from types import MethodType
 from typing import Any, Callable
 
-from discord import Embed, Interaction, Message, app_commands
+from discord import Interaction, Message, app_commands
 from discord.abc import MISSING
 from discord.app_commands import ContextMenu
 from discord.utils import Coro
 
 from ghutils.core.cog import GHUtilsCog
+from ghutils.utils.discord.components import RefreshIssueButton
 from ghutils.utils.discord.embeds import create_issue_embed
-from ghutils.utils.discord.references import IssueReferenceTransformer
+from ghutils.utils.discord.references import IssueReference, IssueReferenceTransformer
 from ghutils.utils.discord.visibility import respond_with_visibility
 
 logger = logging.getLogger(__name__)
@@ -90,37 +91,50 @@ async def show_issues(self, interaction: Interaction, message: Message):
         await interaction.response.defer()
 
         seen = set[str]()
-        embeds = list[Embed]()
+        issues = list[IssueReference]()
         transformer = IssueReferenceTransformer()
 
-        for match in _issue_pattern.finditer(message.content):
-            value = match.group("value")
-            try:
-                repo, issue = await transformer.transform(interaction, value)
-            except Exception:
-                logger.warning(
-                    f"Failed to transform issue reference: {value}", exc_info=True
-                )
-                continue
-
-            if issue.html_url in seen:
-                continue
-            seen.add(issue.html_url)
-
-            embeds.append(create_issue_embed(repo, issue, add_body=False))
-            if len(embeds) >= 10:
-                break
-
-        if not embeds:
-            await respond_with_visibility(
-                interaction,
-                "public",
-                content="No issue references found.",
-            )
-            return
-
-        await respond_with_visibility(
-            interaction,
-            "public",
-            embeds=embeds,
-        )
+        async with self.bot.github_app(interaction) as (github, _):
+            for match in _issue_pattern.finditer(message.content):
+                value = match.group("value")
+                try:
+                    repo, issue = await transformer.transform_with_github(
+                        github, interaction, value
+                    )
+                except Exception:
+                    logger.warning(
+                        f"Failed to transform issue reference: {value}", exc_info=True
+                    )
+                    continue
+
+                if issue.html_url in seen:
+                    continue
+
+                seen.add(issue.html_url)
+                issues.append((repo, issue))
+
+            visibility = "public"
+            match issues:
+                case []:
+                    await respond_with_visibility(
+                        interaction,
+                        visibility,
+                        content="❌ No issue references found.",
+                    )
+                case [reference]:
+                    button = await RefreshIssueButton.from_reference(github, reference)
+                    await respond_with_visibility(
+                        interaction,
+                        visibility,
+                        embed=create_issue_embed(*reference),
+                        items=[button],
+                    )
+                case _:
+                    await respond_with_visibility(
+                        interaction,
+                        visibility,
+                        embeds=[
+                            create_issue_embed(*reference, add_body=False)
+                            for reference in issues
+                        ],
+                    )

bot/src/ghutils/cogs/app_commands/github.py

@@ -5,16 +5,13 @@
 import uuid
 from datetime import datetime
 from pathlib import Path
-from typing import Any
 
 import pfzy
 from discord import Color, Embed, Interaction, app_commands
 from discord.app_commands import Range
 from discord.ext.commands import GroupCog
 from discord.ui import Button, View
-from githubkit import GitHub
-from githubkit.exception import GitHubException, RequestFailed
-from githubkit.rest import SimpleUser
+from githubkit.exception import RequestFailed
 from more_itertools import consecutive_groups, ilen
 from Pylette import extract_colors  # pyright: ignore[reportUnknownVariableType]
 from yarl import URL
@@ -27,23 +24,21 @@
     UserGitHubTokens,
     UserLogin,
 )
-from ghutils.utils.discord.embeds import create_issue_embed, set_embed_author
+from ghutils.utils.discord.components import RefreshCommitButton, RefreshIssueButton
+from ghutils.utils.discord.embeds import (
+    create_commit_embed,
+    create_issue_embed,
+    set_embed_author,
+)
 from ghutils.utils.discord.references import (
     CommitReference,
     IssueReference,
     PRReference,
 )
 from ghutils.utils.discord.transformers import RepositoryOption, UserOption
 from ghutils.utils.discord.visibility import MessageVisibility, respond_with_visibility
-from ghutils.utils.github import (
-    CommitCheckState,
-    RepositoryName,
-    SmartPaginator,
-    gh_request,
-    shorten_sha,
-)
+from ghutils.utils.github import gh_request
 from ghutils.utils.l10n import translate_text
-from ghutils.utils.strings import truncate_str
 
 logger = logging.getLogger(__name__)
 
@@ -61,10 +56,14 @@ async def issue(
         reference: IssueReference,
         visibility: MessageVisibility = "private",
     ):
+        async with self.bot.github_app(interaction) as (github, _):
+            button = await RefreshIssueButton.from_reference(github, reference)
+
         await respond_with_visibility(
             interaction,
             visibility,
             embed=create_issue_embed(*reference),
+            items=[button],
         )
 
     @app_commands.command()
@@ -75,10 +74,14 @@ async def pr(
         reference: PRReference,
         visibility: MessageVisibility = "private",
     ):
+        async with self.bot.github_app(interaction) as (github, _):
+            button = await RefreshIssueButton.from_reference(github, reference)
+
         await respond_with_visibility(
             interaction,
             visibility,
             embed=create_issue_embed(*reference),
+            items=[button],
         )
 
     @app_commands.command()
@@ -89,39 +92,17 @@ async def commit(
         reference: CommitReference,
         visibility: MessageVisibility = "private",
     ):
-        repo, commit = reference
-
         async with self.bot.github_app(interaction) as (github, _):
-            state = await _get_commit_check_state(github, repo, commit.sha)
-
-        short_sha = shorten_sha(commit.sha)
-
-        message = commit.commit.message
-        description = None
-        if "\n" in message:
-            message, description = message.split("\n", maxsplit=1)
-            description = truncate_str(description.strip(), 200)
+            embed = await create_commit_embed(github, *reference)
+            button = await RefreshCommitButton.from_reference(github, reference)
 
-        embed = Embed(
-            title=truncate_str(f"[{short_sha}] {message}", 256),
-            description=description,
-            url=commit.html_url,
-            color=state.color,
-        ).set_footer(
-            text=f"{repo}@{short_sha}",
+        await respond_with_visibility(
+            interaction,
+            visibility,
+            embed=embed,
+            items=[button],
         )
 
-        if (author := commit.commit.author) and author.date:
-            try:
-                embed.timestamp = datetime.fromisoformat(author.date)
-            except ValueError:
-                pass
-
-        if isinstance(commit.author, SimpleUser):
-            set_embed_author(embed, commit.author)
-
-        await respond_with_visibility(interaction, visibility, embed=embed)
-
     @app_commands.command()
     async def repo(
         self,
@@ -476,72 +457,3 @@ def _discord_date(timestamp: int | float | datetime):
         case datetime():
             timestamp = int(timestamp.timestamp())
     return f"<t:{timestamp}:f> (<t:{timestamp}:R>)"
-
-
-# we need to look at both checks and commit statuses
-# https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks#types-of-status-checks-on-github
-# if anything is in progress, return PENDING
-# else if anything failed, return FAILURE
-# else if anything succeeded, return SUCCESS
-# else return PENDING
-async def _get_commit_check_state(
-    github: GitHub[Any],
-    repo: RepositoryName,
-    sha: str,
-) -> CommitCheckState:
-    state = CommitCheckState.NEUTRAL
-
-    # checks
-    try:
-        async for suite in SmartPaginator(
-            github.rest.checks.async_list_suites_for_ref,
-            owner=repo.owner,
-            repo=repo.repo,
-            ref=sha,
-            map_func=lambda resp: resp.parsed_data.check_suites,
-            limit_func=lambda resp: resp.parsed_data.total_count,
-        ):
-            match suite.status:
-                case "queued":
-                    # this is the default status
-                    # it seems to show up for suites that aren't actually in the UI
-                    # so just ignore it
-                    pass
-                case "completed":
-                    match suite.conclusion:
-                        case "success":
-                            if state is not CommitCheckState.FAILURE:
-                                state = CommitCheckState.SUCCESS
-                        case "failure" | "timed_out" | "startup_failure":
-                            state = CommitCheckState.FAILURE
-                        case _:
-                            pass
-                case _:
-                    return CommitCheckState.PENDING
-    except GitHubException:
-        pass
-
-    if state is CommitCheckState.FAILURE:
-        return state
-
-    # commit statuses
-    # if we get to this point, either all checks passed or there are no checks
-    try:
-        combined_status = await gh_request(
-            github.rest.repos.async_get_combined_status_for_ref(
-                owner=repo.owner,
-                repo=repo.repo,
-                ref=sha,
-            )
-        )
-        match combined_status.state:
-            case "success":
-                return CommitCheckState.SUCCESS
-            case "failure":
-                return CommitCheckState.FAILURE
-            case _:
-                pass
-    except GitHubException:
-        pass
-
-    return state

bot/src/ghutils/cogs/events.py

@@ -5,6 +5,7 @@
 
 from ghutils.core.cog import GHUtilsCog
 from ghutils.utils.discord.commands import get_command, print_command
+from ghutils.utils.discord.components import RefreshCommitButton, RefreshIssueButton
 from ghutils.utils.discord.visibility import PermanentDeleteButton
 
 logger = logging.getLogger(__name__)
@@ -16,7 +17,11 @@ class EventsCog(GHUtilsCog):
     @Cog.listener()
     async def on_ready(self):
         logger.info(f"Logged in as {self.bot.user}")
-        self.bot.add_dynamic_items(PermanentDeleteButton)
+        self.bot.add_dynamic_items(
+            PermanentDeleteButton,
+            RefreshCommitButton,
+            RefreshIssueButton,
+        )
         await self.bot.fetch_custom_emojis()
 
     @Cog.listener()

bot/src/ghutils/core/types.py

@@ -10,6 +10,12 @@ class LoginState(Enum):
     LOGGED_OUT = auto()
     EXPIRED = auto()
 
+    def logged_in(self):
+        return self is LoginState.LOGGED_IN
+
+    def logged_out(self):
+        return not self.logged_in()
+
 
 class CustomEmoji(Enum):
     apps_icon = "apps_icon.png"