ref: move formatting functions

Author: jianyuan

src/sentry/integrations/github/integration.py

@@ -36,6 +36,7 @@
     CommitContextOrganizationOptionKeys,
     CommitContextReferrerIds,
     CommitContextReferrers,
+    PullRequestIssue,
 )
 from sentry.integrations.source_code_management.repo_trees import RepoTreesIntegration
 from sentry.integrations.source_code_management.repository import RepositoryIntegration
@@ -53,6 +54,7 @@
 from sentry.shared_integrations.constants import ERR_INTERNAL, ERR_UNAUTHORIZED
 from sentry.shared_integrations.exceptions import ApiError, IntegrationError
 from sentry.snuba.referrer import Referrer
+from sentry.templatetags.sentry_helpers import small_count
 from sentry.types.referrer_ids import GITHUB_OPEN_PR_BOT_REFERRER, GITHUB_PR_BOT_REFERRER
 from sentry.utils import metrics
 from sentry.utils.http import absolute_uri
@@ -389,6 +391,80 @@ def on_create_or_update_comment_error(self, api_error: ApiError, metrics_base: s
 
         return False
 
+    def format_open_pr_comment(self, issue_tables: list[str]) -> str:
+        comment_body_template = """\
+## 🔍 Existing Issues For Review
+Your pull request is modifying functions with the following pre-existing issues:
+
+{issue_tables}
+---
+
+<sub>Did you find this useful? React with a 👍 or 👎</sub>"""
+
+        return comment_body_template.format(issue_tables="\n".join(issue_tables))
+
+    def format_issue_table(
+        self,
+        diff_filename: str,
+        issues: list[PullRequestIssue],
+        patch_parsers: dict[str, Any],
+        toggle: bool,
+    ) -> str:
+        description_length = 52
+
+        issue_table_template = """\
+📄 File: **{filename}**
+
+| Function | Unhandled Issue |
+| :------- | :----- |
+{issue_rows}"""
+
+        issue_table_toggle_template = """\
+<details>
+<summary><b>📄 File: {filename} (Click to Expand)</b></summary>
+
+| Function | Unhandled Issue |
+| :------- | :----- |
+{issue_rows}
+</details>"""
+
+        def format_subtitle(title_length: int, subtitle: str) -> str:
+            # the title length + " " + subtitle should be <= 52
+            subtitle_length = description_length - title_length - 1
+            return (
+                subtitle[: subtitle_length - 3] + "..."
+                if len(subtitle) > subtitle_length
+                else subtitle
+            )
+
+        language_parser = patch_parsers.get(diff_filename.split(".")[-1], None)
+
+        if not language_parser:
+            return ""
+
+        issue_row_template = language_parser.issue_row_template
+
+        issue_rows = "\n".join(
+            [
+                issue_row_template.format(
+                    title=issue.title,
+                    subtitle=format_subtitle(len(issue.title), issue.subtitle),
+                    url=self.format_comment_url(
+                        issue.url, referrer=self.commit_context_referrer_ids.open_pr_bot
+                    ),
+                    event_count=small_count(issue.event_count),
+                    function_name=issue.function_name,
+                    affected_users=small_count(issue.affected_users),
+                )
+                for issue in issues
+            ]
+        )
+
+        if toggle:
+            return issue_table_toggle_template.format(filename=diff_filename, issue_rows=issue_rows)
+
+        return issue_table_template.format(filename=diff_filename, issue_rows=issue_rows)
+
 
 class GitHubIntegrationProvider(IntegrationProvider):
     key = "github"

src/sentry/integrations/github/tasks/open_pr_comment.py

@@ -15,7 +15,6 @@
     OPEN_PR_METRICS_BASE,
     CommitContextIntegration,
     PullRequestFile,
-    PullRequestIssue,
 )
 from sentry.integrations.source_code_management.language_parsers import PATCH_PARSERS
 from sentry.models.organization import Organization
@@ -26,90 +25,11 @@
 from sentry.tasks.base import instrumented_task
 from sentry.taskworker.config import TaskworkerConfig
 from sentry.taskworker.namespaces import integrations_tasks
-from sentry.templatetags.sentry_helpers import small_count
-from sentry.types.referrer_ids import GITHUB_OPEN_PR_BOT_REFERRER
 from sentry.utils import metrics
 
 logger = logging.getLogger(__name__)
 
 
-OPEN_PR_COMMENT_BODY_TEMPLATE = """\
-## 🔍 Existing Issues For Review
-Your pull request is modifying functions with the following pre-existing issues:
-
-{issue_tables}
----
-
-<sub>Did you find this useful? React with a 👍 or 👎</sub>"""
-
-OPEN_PR_ISSUE_TABLE_TEMPLATE = """\
-📄 File: **{filename}**
-
-| Function | Unhandled Issue |
-| :------- | :----- |
-{issue_rows}"""
-
-OPEN_PR_ISSUE_TABLE_TOGGLE_TEMPLATE = """\
-<details>
-<summary><b>📄 File: {filename} (Click to Expand)</b></summary>
-
-| Function | Unhandled Issue |
-| :------- | :----- |
-{issue_rows}
-</details>"""
-
-OPEN_PR_ISSUE_DESCRIPTION_LENGTH = 52
-
-MAX_RECENT_ISSUES = 5000
-
-
-def format_comment_url(url, referrer):
-    return url + "?referrer=" + referrer
-
-
-def format_open_pr_comment(issue_tables: list[str]) -> str:
-    return OPEN_PR_COMMENT_BODY_TEMPLATE.format(issue_tables="\n".join(issue_tables))
-
-
-def format_open_pr_comment_subtitle(title_length, subtitle):
-    # the title length + " " + subtitle should be <= 52
-    subtitle_length = OPEN_PR_ISSUE_DESCRIPTION_LENGTH - title_length - 1
-    return subtitle[: subtitle_length - 3] + "..." if len(subtitle) > subtitle_length else subtitle
-
-
-# for a single file, create a table
-def format_issue_table(
-    diff_filename: str, issues: list[PullRequestIssue], patch_parsers: dict[str, Any], toggle: bool
-) -> str:
-    language_parser = patch_parsers.get(diff_filename.split(".")[-1], None)
-
-    if not language_parser:
-        return ""
-
-    issue_row_template = language_parser.issue_row_template
-
-    issue_rows = "\n".join(
-        [
-            issue_row_template.format(
-                title=issue.title,
-                subtitle=format_open_pr_comment_subtitle(len(issue.title), issue.subtitle),
-                url=format_comment_url(issue.url, GITHUB_OPEN_PR_BOT_REFERRER),
-                event_count=small_count(issue.event_count),
-                function_name=issue.function_name,
-                affected_users=small_count(issue.affected_users),
-            )
-            for issue in issues
-        ]
-    )
-
-    if toggle:
-        return OPEN_PR_ISSUE_TABLE_TOGGLE_TEMPLATE.format(
-            filename=diff_filename, issue_rows=issue_rows
-        )
-
-    return OPEN_PR_ISSUE_TABLE_TEMPLATE.format(filename=diff_filename, issue_rows=issue_rows)
-
-
 # TODO(cathy): Change the client typing to allow for multiple SCM Integrations
 def safe_for_comment(
     gh_client: GitHubApiClient, repository: Repository, pull_request: PullRequest
@@ -374,19 +294,19 @@ def open_pr_comment_workflow(pr_id: int) -> None:
             continue
 
         if first_table:
-            issue_table = format_issue_table(
+            issue_table = installation.format_issue_table(
                 pr_filename, issue_table_content, patch_parsers, toggle=False
             )
             first_table = False
         else:
             # toggle all tables but the first one
-            issue_table = format_issue_table(
+            issue_table = installation.format_issue_table(
                 pr_filename, issue_table_content, patch_parsers, toggle=True
             )
 
         issue_tables.append(issue_table)
 
-    comment_body = format_open_pr_comment(issue_tables)
+    comment_body = installation.format_open_pr_comment(issue_tables)
 
     # list all issues in the comment
     issue_list: list[dict[str, Any]] = list(itertools.chain.from_iterable(top_issues_per_file))

src/sentry/integrations/github_enterprise/integration.py

@@ -29,6 +29,7 @@
     CommitContextOrganizationOptionKeys,
     CommitContextReferrerIds,
     CommitContextReferrers,
+    PullRequestIssue,
 )
 from sentry.integrations.source_code_management.repository import RepositoryIntegration
 from sentry.models.organization import Organization
@@ -271,6 +272,18 @@ def queue_comment_task(self, pullrequest_id: int, project_id: int) -> None:
     def on_create_or_update_comment_error(self, api_error: ApiError, metrics_base: str) -> bool:
         raise NotImplementedError
 
+    def format_open_pr_comment(self, issue_tables: list[str]) -> str:
+        raise NotImplementedError
+
+    def format_issue_table(
+        self,
+        diff_filename: str,
+        issues: list[PullRequestIssue],
+        patch_parsers: dict[str, Any],
+        toggle: bool,
+    ) -> str:
+        raise NotImplementedError
+
 
 class InstallationForm(forms.Form):
     url = forms.CharField(

src/sentry/integrations/gitlab/integration.py

@@ -25,6 +25,7 @@
     CommitContextOrganizationOptionKeys,
     CommitContextReferrerIds,
     CommitContextReferrers,
+    PullRequestIssue,
 )
 from sentry.integrations.source_code_management.repository import RepositoryIntegration
 from sentry.models.organization import Organization
@@ -203,6 +204,18 @@ def queue_comment_task(self, pullrequest_id: int, project_id: int) -> None:
     def on_create_or_update_comment_error(self, api_error: ApiError, metrics_base: str) -> bool:
         raise NotImplementedError
 
+    def format_open_pr_comment(self, issue_tables: list[str]) -> str:
+        raise NotImplementedError
+
+    def format_issue_table(
+        self,
+        diff_filename: str,
+        issues: list[PullRequestIssue],
+        patch_parsers: dict[str, Any],
+        toggle: bool,
+    ) -> str:
+        raise NotImplementedError
+
     # Gitlab only functions
 
     def get_group_id(self):

src/sentry/integrations/source_code_management/commit_context.py

@@ -5,7 +5,7 @@
 from collections.abc import Sequence
 from dataclasses import dataclass
 from datetime import UTC, datetime, timedelta, timezone
-from typing import Any, TypedDict
+from typing import Any
 
 import sentry_sdk
 from django.db import connection
@@ -157,19 +157,6 @@ class PullRequestFile:
     patch: str
 
 
-class IssueCount(TypedDict):
-    group_id: int
-    event_count: int
-
-
-class IssueCountForFile(TypedDict):
-    title: str
-    culprit: str
-    function_name: str
-    group_id: int
-    event_count: int
-
-
 class CommitContextIntegration(ABC):
     """
     Base class for integrations that include commit context features: suspect commits, suspect PR comments
@@ -544,7 +531,9 @@ def get_issue_ids_from_pr(
             )
             return [issue_id for (issue_id,) in cursor.fetchall()]
 
-    def get_top_5_issues_by_count(self, issue_ids: list[int], project: Project) -> list[IssueCount]:
+    def get_top_5_issues_by_count(
+        self, issue_ids: list[int], project: Project
+    ) -> list[dict[str, Any]]:
         """Given a list of issue group ids, return a sublist of the top 5 ordered by event count"""
         request = SnubaRequest(
             dataset=Dataset.Events.value,
@@ -655,9 +644,23 @@ def run_pr_comment_workflow(
 
     # Open PR Comment Workflow
 
+    @abstractmethod
+    def format_open_pr_comment(self, issue_tables: list[str]) -> str:
+        raise NotImplementedError
+
+    @abstractmethod
+    def format_issue_table(
+        self,
+        diff_filename: str,
+        issues: list[PullRequestIssue],
+        patch_parsers: dict[str, Any],
+        toggle: bool,
+    ) -> str:
+        raise NotImplementedError
+
     def get_top_5_issues_by_count_for_file(
         self, projects: list[Project], sentry_filenames: list[str], function_names: list[str]
-    ) -> list[IssueCountForFile]:
+    ) -> list[dict[str, Any]]:
         """
         Given a list of projects, filenames reverse-codemapped into filenames in Sentry,
         and function names representing the list of functions changed in a PR file, return a
@@ -798,9 +801,7 @@ def get_top_5_issues_by_count_for_file(
             )
             return []
 
-    def get_issue_table_contents(
-        self, issue_list: list[IssueCountForFile]
-    ) -> list[PullRequestIssue]:
+    def get_issue_table_contents(self, issue_list: list[dict[str, Any]]) -> list[PullRequestIssue]:
         group_id_to_info = {}
         for issue in issue_list:
             group_id = issue["group_id"]