fix(#86): make terminal formatter comments not truncated, and add suggestions (#114)

Author: scastlara

scripts/evaluate_review_quality.py

@@ -7,12 +7,14 @@
 
 import click
 import gitlab
+import httpx
 from lgtm_ai.ai.agent import get_ai_model, get_reviewer_agent_with_settings, get_summarizing_agent_with_settings
 from lgtm_ai.ai.schemas import Review, SupportedAIModels, SupportedAIModelsList
 from lgtm_ai.config.handler import ResolvedConfig
 from lgtm_ai.formatters.markdown import MarkDownFormatter
 from lgtm_ai.git_client.gitlab import GitlabClient
 from lgtm_ai.review import CodeReviewer
+from lgtm_ai.review.context import ContextRetriever
 from lgtm_ai.validators import parse_pr_url
 from rich.logging import RichHandler
 
@@ -93,11 +95,15 @@ def perform_review(
     output_dir: str, pr_url: str, pr_name: str, sample: int, model: SupportedAIModels, git_api_key: str, ai_api_key: str
 ) -> None:
     url = parse_pr_url(mock.Mock(), "pr_url", pr_url)
+    git_client = GitlabClient(client=gitlab.Gitlab(private_token=git_api_key), formatter=MarkDownFormatter())
     code_reviewer = CodeReviewer(
         reviewer_agent=get_reviewer_agent_with_settings(),
         summarizing_agent=get_summarizing_agent_with_settings(),
         model=get_ai_model(model_name=model, api_key=ai_api_key),
-        git_client=GitlabClient(gitlab.Gitlab(private_token=git_api_key), formatter=MarkDownFormatter()),
+        git_client=git_client,
+        context_retriever=ContextRetriever(
+            git_client=git_client, issues_client=git_client, httpx_client=httpx.Client(timeout=3)
+        ),
         config=ResolvedConfig(model=model, technologies=("Python", "Django", "FastAPI")),
     )
     review = code_reviewer.review_pull_request(pr_url=url)

src/lgtm_ai/__main__.py

@@ -6,7 +6,6 @@
 
 import click
 import httpx
-import rich
 from lgtm_ai.ai.agent import (
     get_ai_model,
     get_guide_agent_with_settings,
@@ -284,7 +283,8 @@ def _set_logging_level(logger: logging.Logger, verbose: int) -> None:
 def _get_formatter_and_printer(output_format: OutputFormat) -> tuple[Formatter[Any], Callable[[Any], None]]:
     """Get the formatter and the print method based on the output format."""
     if output_format == OutputFormat.pretty:
-        return PrettyFormatter(), rich.print
+        console = Console()
+        return PrettyFormatter(), console.print
     elif output_format == OutputFormat.markdown:
         return MarkDownFormatter(), print
     elif output_format == OutputFormat.json:

src/lgtm_ai/formatters/pretty.py

@@ -12,7 +12,7 @@
 logger = logging.getLogger("lgtm")
 
 
-class PrettyFormatter(Formatter[Panel | Layout]):
+class PrettyFormatter(Formatter[Panel | Layout | Group]):
     def format_review_summary_section(self, review: Review, comments: list[ReviewComment] | None = None) -> Panel:
         if comments:
             logger.warning("Comments are not supported in the terminal formatter summary section")
@@ -26,24 +26,38 @@ def format_review_summary_section(self, review: Review, comments: list[ReviewCom
             subtitle=f"Score: {review.review_response.score} {SCORE_MAP[review.review_response.score]}",
         )
 
-    def format_review_comments_section(self, comments: list[ReviewComment]) -> Layout:
+    def format_review_comments_section(self, comments: list[ReviewComment]) -> Group:
         panels = [self.format_review_comment(comment) for comment in comments]
-        layout = Layout()
-        layout.split_column(*panels)
-        return layout
+        return Group(*panels)
 
     def format_review_comment(self, comment: ReviewComment, *, with_footer: bool = True) -> Panel:
         content: Text | Group
         if comment.quote_snippet:
-            snippet_panel = Panel(
-                comment.quote_snippet,
-                style="dim",
-                title="Code Snippet",
-                title_align="left",
-                padding=(1, 1),
-            )
-            content = Group(snippet_panel, Text(comment.comment))
-            # TODO: add code suggestions
+            elements: list[Panel | Markdown | Group | Text] = [
+                Panel(
+                    comment.quote_snippet,
+                    style="dim",
+                    title="Code Snippet",
+                    title_align="left",
+                    padding=(1, 1),
+                ),
+                Text(""),
+                Markdown(comment.comment),
+            ]
+            if comment.suggestion:
+                elements.extend(
+                    [
+                        Text(""),
+                        Panel(
+                            comment.suggestion.snippet,
+                            style="dim green",
+                            title="Code Suggestion",
+                            title_align="left",
+                            padding=(1, 1),
+                        ),
+                    ]
+                )
+            content = Group(*elements)
         else:
             content = Text(comment.comment)
 

tests/formatters/test_terminal.py

@@ -42,14 +42,13 @@ def test_format_comments_section() -> None:
     ]
 
     formatter = PrettyFormatter()
-    layout = formatter.format_review_comments_section(comments)
-    assert len(layout.children) == 3
-    child_panels = [child._renderable for child in layout.children]
-    assert all(isinstance(child, rich.panel.Panel) for child in child_panels)
-    assert all(cast(rich.panel.Panel, child).title == "test.py:1" for child in child_panels)
+    group = formatter.format_review_comments_section(comments)
+    assert len(group.renderables) == 3
+    assert all(isinstance(child, rich.panel.Panel) for child in group.renderables)
+    assert all(cast(rich.panel.Panel, child).title == "test.py:1" for child in group.renderables)
 
 
 def test_format_comments_section_no_comments() -> None:
     formatter = PrettyFormatter()
-    layout = formatter.format_review_comments_section([])
-    assert len(layout.children) == 0
+    group = formatter.format_review_comments_section([])
+    assert len(group.renderables) == 0