split off discord specific reporter stuff

Author: ngc92

src/discord-cluster-manager/api/utils.py

@@ -12,23 +12,10 @@
     CLI_TOKEN_URL,
 )
 from fastapi import HTTPException
-from report import RunProgressReporterAPI
+from report import Log, RunProgressReporter, RunResultReport, Text
 from submission import SubmissionRequest, prepare_submission
 
 
-class MockProgressReporter:
-    """Class that pretends to be a progress reporter,
-    is used to avoid errors when running submission,
-    because runners report progress via discord interactions
-    """
-
-    async def push(self, message: str):
-        pass
-
-    async def update(self, message: str):
-        pass
-
-
 async def _handle_discord_oauth(code: str, redirect_uri: str) -> tuple[str, str]:
     """Handles the Discord OAuth code exchange and user info retrieval."""
     client_id = CLI_DISCORD_CLIENT_ID
@@ -221,3 +208,20 @@ def add_reporter(title: str):
             db.mark_submission_done(sub_id)
 
     return results, [rep.get_message() + "\n" + rep.long_report for rep in reporters]
+
+
+class RunProgressReporterAPI(RunProgressReporter):
+    def __init__(self, title: str):
+        super().__init__(title=title)
+        self.long_report = ""
+
+    async def _update_message(self):
+        pass
+
+    async def display_report(self, title: str, report: RunResultReport):
+        for part in report.data:
+            if isinstance(part, Text):
+                self.long_report += part.text
+            elif isinstance(part, Log):
+                self.long_report += f"\n\n## {part.header}:\n"
+                self.long_report += f"```\n{part.content}```"

src/discord-cluster-manager/cogs/leaderboard_cog.py

@@ -10,6 +10,7 @@
 )
 from discord import app_commands
 from discord.ext import commands
+from discord_reporter import MultiProgressReporter
 from discord_utils import (
     get_user_from_id,
     leaderboard_name_autocomplete,
@@ -22,7 +23,6 @@
     RunItem,
     SubmissionItem,
 )
-from report import MultiProgressReporter
 from submission import SubmissionRequest, prepare_submission
 from ui.misc import GPUSelectionView
 from ui.table import create_table

src/discord-cluster-manager/cogs/submit_cog.py

@@ -11,9 +11,9 @@
 from consts import GPU, GPU_TO_SM, RankCriterion, SubmissionMode, get_gpu_by_name
 from discord import app_commands
 from discord.ext import commands
+from discord_reporter import MultiProgressReporter
 from discord_utils import send_discord_message, with_error_handling
 from report import (
-    MultiProgressReporter,
     RunProgressReporter,
     generate_report,
     make_short_report,

src/discord-cluster-manager/cogs/verify_run_cog.py

@@ -14,9 +14,9 @@
 from discord import app_commands
 from discord.app_commands import Choice
 from discord.ext import commands
+from discord_reporter import MultiProgressReporter
 from discord_utils import send_discord_message, with_error_handling
 from leaderboard_db import RunItem, SubmissionItem
-from report import MultiProgressReporter
 from task import make_task
 from utils import setup_logging
 

src/discord-cluster-manager/discord_reporter.py

@@ -0,0 +1,68 @@
+import discord
+from discord_utils import _send_split_log
+from report import Log, RunProgressReporter, RunResultReport, Text
+
+
+class MultiProgressReporter:
+    def __init__(self, interaction: discord.Interaction, header: str):
+        self.header = header
+        self.runs = []
+        self.interaction = interaction
+
+    async def show(self):
+        await self._update_message()
+
+    def add_run(self, title: str) -> "RunProgressReporter":
+        rpr = RunProgressReporterDiscord(self, self.interaction, title)
+        self.runs.append(rpr)
+        return rpr
+
+    def make_message(self):
+        formatted_runs = []
+        for run in self.runs:
+            formatted_runs.append(run.get_message())
+
+        return str.join("\n\n", [f"# {self.header}"] + formatted_runs)
+
+    async def _update_message(self):
+        if self.interaction is None:
+            return
+
+        await self.interaction.edit_original_response(content=self.make_message(), view=None)
+
+
+class RunProgressReporterDiscord(RunProgressReporter):
+    def __init__(
+        self,
+        root: MultiProgressReporter,
+        interaction: discord.Interaction,
+        title: str,
+    ):
+        super().__init__(title=title)
+        self.root = root
+        self.interaction = interaction
+
+    async def _update_message(self):
+        await self.root._update_message()
+
+    async def display_report(self, title: str, report: RunResultReport):
+        thread = await self.interaction.channel.create_thread(
+            name=title,
+            type=discord.ChannelType.private_thread,
+            auto_archive_duration=1440,
+        )
+        await thread.add_user(self.interaction.user)
+        message = ""
+        for part in report.data:
+            if isinstance(part, Text):
+                if len(message) + len(part.text) > 1900:
+                    await thread.send(message)
+                    message = ""
+                message += part.text
+            elif isinstance(part, Log):
+                message = await _send_split_log(thread, message, part.header, part.content)
+
+        if len(message) > 0:
+            await thread.send(message)
+
+        await self.push(f"See results at {thread.jump_url}")

src/discord-cluster-manager/discord_utils.py

@@ -2,7 +2,7 @@
 import logging
 
 import discord
-from utils import KernelBotError, setup_logging
+from utils import KernelBotError, limit_length, setup_logging
 
 logger = setup_logging(__name__)
 
@@ -103,3 +103,35 @@ async def leaderboard_name_autocomplete(
     except Exception as e:
         logger.exception("Error in leaderboard autocomplete", exc_info=e)
         return []
+
+
+async def _send_split_log(thread: discord.Thread, partial_message: str, header: str, log: str):
+    if len(partial_message) + len(log) + len(header) < 1900:
+        partial_message += f"\n\n## {header}:\n"
+        partial_message += f"```\n{log}```"
+        return partial_message
+    else:
+        # send previous chunk
+        if len(partial_message) > 0:
+            await thread.send(partial_message)
+        lines = log.splitlines()
+        chunks = []
+        partial_message = ""
+        for line in lines:
+            if len(partial_message) + len(line) < 1900:
+                partial_message += line + "\n"
+            else:
+                if partial_message != "":
+                    chunks.append(partial_message)
+                partial_message = line
+
+        if partial_message != "":
+            chunks.append(partial_message)
+
+        # now, format the chunks
+        for i, chunk in enumerate(chunks):
+            partial_message = f"\n\n## {header} ({i+1}/{len(chunks)}):\n"
+            partial_message += f"```\n{limit_length(chunk, 1900)}```"
+            await thread.send(partial_message)
+
+        return ""

src/discord-cluster-manager/report.py

@@ -4,48 +4,8 @@
 from typing import List
 
 import consts
-import discord
 from run_eval import CompileResult, EvalResult, FullResult, RunResult, SystemInfo
-from utils import format_time
-
-
-def _limit_length(text: str, maxlen: int):
-    if len(text) > maxlen:
-        return text[: maxlen - 6] + " [...]"
-    else:
-        return text
-
-
-async def _send_split_log(thread: discord.Thread, partial_message: str, header: str, log: str):
-    if len(partial_message) + len(log) + len(header) < 1900:
-        partial_message += f"\n\n## {header}:\n"
-        partial_message += f"```\n{log}```"
-        return partial_message
-    else:
-        # send previous chunk
-        if len(partial_message) > 0:
-            await thread.send(partial_message)
-        lines = log.splitlines()
-        chunks = []
-        partial_message = ""
-        for line in lines:
-            if len(partial_message) + len(line) < 1900:
-                partial_message += line + "\n"
-            else:
-                if partial_message != "":
-                    chunks.append(partial_message)
-                partial_message = line
-
-        if partial_message != "":
-            chunks.append(partial_message)
-
-        # now, format the chunks
-        for i, chunk in enumerate(chunks):
-            partial_message = f"\n\n## {header} ({i+1}/{len(chunks)}):\n"
-            partial_message += f"```\n{_limit_length(chunk, 1900)}```"
-            await thread.send(partial_message)
-
-        return ""
+from utils import format_time, limit_length
 
 
 @dataclasses.dataclass
@@ -95,7 +55,7 @@ def _generate_compile_report(reporter: "RunResultReport", comp: CompileResult):
     # ok, we found nvcc
     message += "# Compilation failed\n"
     message += "Command "
-    message += f"```bash\n>{_limit_length(comp.command, 1000)}```\n"
+    message += f"```bash\n>{limit_length(comp.command, 1000)}```\n"
     message += f"exited with code **{comp.exit_code}**."
     reporter.add_text(message)
 
@@ -108,7 +68,7 @@ def _generate_compile_report(reporter: "RunResultReport", comp: CompileResult):
 def _generate_crash_report(reporter: "RunResultReport", run: RunResult):
     message = "# Running failed\n"
     message += "Command "
-    message += f"```bash\n{_limit_length(run.command, 1000)}```\n"
+    message += f"```bash\n{limit_length(run.command, 1000)}```\n"
     if run.exit_code == consts.ExitCode.TIMEOUT_EXPIRED:
         message += f"**timed out** after {float(run.duration):.2f} seconds."
     else:
@@ -127,7 +87,7 @@ def _generate_crash_report(reporter: "RunResultReport", run: RunResult):
 def _generate_test_report(reporter: "RunResultReport", run: RunResult):
     message = "# Testing failed\n"
     message += "Command "
-    message += f"```bash\n{_limit_length(run.command, 1000)}```\n"
+    message += f"```bash\n{limit_length(run.command, 1000)}```\n"
     message += f"ran successfully in {run.duration:.2f} seconds, but did not pass all tests.\n"
     reporter.add_text(message)
 
@@ -392,7 +352,7 @@ def generate_report(result: FullResult) -> RunResultReport:  # noqa: C901
         # OK, we were successful
         message = "# Success!\n"
         message += "Command "
-        message += f"```bash\n{_limit_length(run.command, 1000)}```\n"
+        message += f"```bash\n{limit_length(run.command, 1000)}```\n"
         message += f"ran successfully in {run.duration:.2f} seconds.\n"
         report.add_text(message)
 
@@ -407,34 +367,6 @@ def generate_report(result: FullResult) -> RunResultReport:  # noqa: C901
     return report
 
 
-class MultiProgressReporter:
-    def __init__(self, interaction: discord.Interaction, header: str):
-        self.header = header
-        self.runs = []
-        self.interaction = interaction
-
-    async def show(self):
-        await self._update_message()
-
-    def add_run(self, title: str) -> "RunProgressReporter":
-        rpr = RunProgressReporterDiscord(self, self.interaction, title)
-        self.runs.append(rpr)
-        return rpr
-
-    def make_message(self):
-        formatted_runs = []
-        for run in self.runs:
-            formatted_runs.append(run.get_message())
-
-        return str.join("\n\n", [f"# {self.header}"] + formatted_runs)
-
-    async def _update_message(self):
-        if self.interaction is None:
-            return
-
-        await self.interaction.edit_original_response(content=self.make_message(), view=None)
-
-
 class RunProgressReporter:
     def __init__(self, title: str):
         # short report
@@ -465,57 +397,3 @@ async def display_report(self, title: str, report: RunResultReport):
 
     async def _update_message(self):
         raise NotImplementedError()
-
-
-class RunProgressReporterDiscord(RunProgressReporter):
-    def __init__(
-        self,
-        root: MultiProgressReporter,
-        interaction: discord.Interaction,
-        title: str,
-    ):
-        super().__init__(title=title)
-        self.root = root
-        self.interaction = interaction
-
-    async def _update_message(self):
-        await self.root._update_message()
-
-    async def display_report(self, title: str, report: RunResultReport):
-        thread = await self.interaction.channel.create_thread(
-            name=title,
-            type=discord.ChannelType.private_thread,
-            auto_archive_duration=1440,
-        )
-        await thread.add_user(self.interaction.user)
-        message = ""
-        for part in report.data:
-            if isinstance(part, Text):
-                if len(message) + len(part.text) > 1900:
-                    await thread.send(message)
-                    message = ""
-                message += part.text
-            elif isinstance(part, Log):
-                message = await _send_split_log(thread, message, part.header, part.content)
-
-        if len(message) > 0:
-            await thread.send(message)
-
-        await self.push(f"See results at {thread.jump_url}")
-
-
-class RunProgressReporterAPI(RunProgressReporter):
-    def __init__(self, title: str):
-        super().__init__(title=title)
-        self.long_report = ""
-
-    async def _update_message(self):
-        pass
-
-    async def display_report(self, title: str, report: RunResultReport):
-        for part in report.data:
-            if isinstance(part, Text):
-                self.long_report += part.text
-            elif isinstance(part, Log):
-                self.long_report += f"\n\n## {part.header}:\n"
-                self.long_report += f"```\n{part.content}```"

src/discord-cluster-manager/utils.py

@@ -135,3 +135,10 @@ def format_time(value: float | str, err: Optional[float | str] = None, scale=Non
             return f"{value:.0f} ± {err:.1f} {unit}"
         else:
             return f"{value:.0f} {unit}"
+
+
+def limit_length(text: str, maxlen: int):
+    if len(text) > maxlen:
+        return text[: maxlen - 6] + " [...]"
+    else:
+        return text