ref(source_code_management): Make Open PR Comment Workflow generic (#90762)

Make Open PR Comment Workflow generic.

Moved github task to
`sentry.integrations.source_code_management.tasks.open_pr_comment_workflow`
which can be used by other integrations.

Author: jianyuan

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

@@ -1,26 +1,14 @@
 from __future__ import annotations
 
-import itertools
 import logging
-from typing import Any
 
-from sentry.constants import EXTENSION_LANGUAGE_MAP, ObjectStatus
-from sentry.integrations.services.integration import integration_service
-from sentry.integrations.source_code_management.commit_context import (
-    OPEN_PR_METRICS_BASE,
-    CommitContextIntegration,
-    _open_pr_comment_log,
+from sentry.integrations.source_code_management.tasks import (
+    open_pr_comment_workflow as real_open_pr_comment_workflow,
 )
-from sentry.integrations.source_code_management.language_parsers import PATCH_PARSERS
-from sentry.models.organization import Organization
-from sentry.models.pullrequest import CommentType, PullRequest
-from sentry.models.repository import Repository
-from sentry.shared_integrations.exceptions import ApiError
 from sentry.silo.base import SiloMode
 from sentry.tasks.base import instrumented_task
 from sentry.taskworker.config import TaskworkerConfig
 from sentry.taskworker.namespaces import integrations_tasks
-from sentry.utils import metrics
 
 logger = logging.getLogger(__name__)
 
@@ -33,247 +21,6 @@
     ),
 )
 def open_pr_comment_workflow(pr_id: int) -> None:
-    # TODO(jianyuan): Move this to source code management tasks
-    integration_name = "github"
-
-    logger.info(_open_pr_comment_log(integration_name=integration_name, suffix="start_workflow"))
-
-    # CHECKS
-    # check PR exists to get PR key
-    try:
-        pull_request = PullRequest.objects.get(id=pr_id)
-    except PullRequest.DoesNotExist:
-        logger.info(_open_pr_comment_log(integration_name=integration_name, suffix="pr_missing"))
-        metrics.incr(
-            OPEN_PR_METRICS_BASE.format(integration=integration_name, key="error"),
-            tags={"type": "missing_pr"},
-        )
-        return
-
-    # check org option
-    org_id = pull_request.organization_id
-    try:
-        organization = Organization.objects.get_from_cache(id=org_id)
-        assert isinstance(organization, Organization)
-    except Organization.DoesNotExist:
-        logger.exception(
-            _open_pr_comment_log(integration_name=integration_name, suffix="org_missing")
-        )
-        metrics.incr(
-            OPEN_PR_METRICS_BASE.format(integration=integration_name, key="error"),
-            tags={"type": "missing_org"},
-        )
-        return
-
-    # check PR repo exists to get repo name
-    try:
-        repo = Repository.objects.get(id=pull_request.repository_id)
-    except Repository.DoesNotExist:
-        logger.info(
-            _open_pr_comment_log(integration_name=integration_name, suffix="repo_missing"),
-            extra={"organization_id": organization.id},
-        )
-        metrics.incr(
-            OPEN_PR_METRICS_BASE.format(integration=integration_name, key="error"),
-            tags={"type": "missing_repo"},
-        )
-        return
-
-    # check integration exists to hit Github API with client
-    integration = integration_service.get_integration(
-        integration_id=repo.integration_id, status=ObjectStatus.ACTIVE
-    )
-    if not integration:
-        logger.info(
-            _open_pr_comment_log(integration_name=integration_name, suffix="integration_missing"),
-            extra={"organization_id": organization.id},
-        )
-        metrics.incr(
-            OPEN_PR_METRICS_BASE.format(integration=integration_name, key="error"),
-            tags={"type": "missing_integration"},
-        )
-        return
-
-    installation = integration.get_installation(organization_id=organization.id)
-    assert isinstance(installation, CommitContextIntegration)
-
-    # TODO(jianyuan): Remove this once we have implemented the new open_pr_comment_workflow for GH Enterprise
-    try:
-        open_pr_comment_workflow = installation.get_open_pr_comment_workflow()
-    except NotImplementedError:
-        logger.info(
-            _open_pr_comment_log(integration_name=integration_name, suffix="not_implemented")
-        )
-        return
-
-    # CREATING THE COMMENT
-
-    # fetch the files in the PR and determine if it is safe to comment
-    pullrequest_files = open_pr_comment_workflow.get_pr_files_safe_for_comment(
-        repo=repo, pr=pull_request
-    )
-
-    issue_table_contents = {}
-    top_issues_per_file = []
-
-    patch_parsers = PATCH_PARSERS
-    # NOTE: if we are testing beta patch parsers, add check here
-
-    file_extensions = set()
-    # fetch issues related to the files
-    for file in pullrequest_files:
-        projects, sentry_filenames = (
-            open_pr_comment_workflow.get_projects_and_filenames_from_source_file(
-                organization=organization, repo=repo, pr_filename=file.filename
-            )
-        )
-        if not len(projects) or not len(sentry_filenames):
-            continue
-
-        file_extension = file.filename.split(".")[-1]
-        logger.info(
-            _open_pr_comment_log(integration_name=integration_name, suffix="file_extension"),
-            extra={
-                "organization_id": org_id,
-                "repository_id": repo.id,
-                "extension": file_extension,
-            },
-        )
-
-        language_parser = patch_parsers.get(file.filename.split(".")[-1], None)
-        if not language_parser:
-            logger.info(
-                _open_pr_comment_log(integration_name=integration_name, suffix="missing_parser"),
-                extra={"extension": file_extension},
-            )
-            metrics.incr(
-                OPEN_PR_METRICS_BASE.format(integration=integration_name, key="missing_parser"),
-                tags={"extension": file_extension},
-            )
-            continue
-
-        function_names = language_parser.extract_functions_from_patch(file.patch)
-
-        if file_extension in ["js", "jsx"]:
-            logger.info(
-                _open_pr_comment_log(integration_name=integration_name, suffix="javascript"),
-                extra={
-                    "organization_id": org_id,
-                    "repository_id": repo.id,
-                    "extension": file_extension,
-                    "has_function_names": bool(function_names),
-                },
-            )
-
-        if file_extension == ["php"]:
-            logger.info(
-                _open_pr_comment_log(integration_name=integration_name, suffix="php"),
-                extra={
-                    "organization_id": org_id,
-                    "repository_id": repo.id,
-                    "extension": file_extension,
-                    "has_function_names": bool(function_names),
-                },
-            )
-
-        if file_extension == ["rb"]:
-            logger.info(
-                _open_pr_comment_log(integration_name=integration_name, suffix="ruby"),
-                extra={
-                    "organization_id": org_id,
-                    "repository_id": repo.id,
-                    "extension": file_extension,
-                    "has_function_names": bool(function_names),
-                },
-            )
-
-        if not len(function_names):
-            continue
-
-        top_issues = open_pr_comment_workflow.get_top_5_issues_by_count_for_file(
-            projects=list(projects),
-            sentry_filenames=list(sentry_filenames),
-            function_names=list(function_names),
-        )
-        if not len(top_issues):
-            continue
-
-        top_issues_per_file.append(top_issues)
-        file_extensions.add(file_extension)
-
-        issue_table_contents[file.filename] = open_pr_comment_workflow.get_issue_table_contents(
-            top_issues
-        )
-
-    if not len(issue_table_contents):
-        logger.info(_open_pr_comment_log(integration_name=integration_name, suffix="no_issues"))
-        # don't leave a comment if no issues for files in PR
-        metrics.incr(OPEN_PR_METRICS_BASE.format(integration=integration_name, key="no_issues"))
-        return
-
-    # format issues per file into comment
-    issue_tables = []
-    first_table = True
-    for file in pullrequest_files:
-        pr_filename = file.filename
-        issue_table_content = issue_table_contents.get(pr_filename, None)
-
-        if issue_table_content is None:
-            continue
-
-        if first_table:
-            issue_table = open_pr_comment_workflow.format_issue_table(
-                diff_filename=pr_filename,
-                issues=issue_table_content,
-                patch_parsers=patch_parsers,
-                toggle=False,
-            )
-            first_table = False
-        else:
-            # toggle all tables but the first one
-            issue_table = open_pr_comment_workflow.format_issue_table(
-                diff_filename=pr_filename,
-                issues=issue_table_content,
-                patch_parsers=patch_parsers,
-                toggle=True,
-            )
-
-        issue_tables.append(issue_table)
-
-    comment_body = open_pr_comment_workflow.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))
-    issue_id_list: list[int] = [issue["group_id"] for issue in issue_list]
-
-    # pick one language from the list of languages in the PR for analytics
-    languages = [
-        EXTENSION_LANGUAGE_MAP[extension]
-        for extension in file_extensions
-        if extension in EXTENSION_LANGUAGE_MAP
-    ]
-    language = languages[0] if len(languages) else "not found"
-
-    comment_data = open_pr_comment_workflow.get_comment_data(comment_body=comment_body)
-
-    try:
-        installation.create_or_update_comment(
-            repo=repo,
-            pr=pull_request,
-            comment_data=comment_data,
-            issue_list=issue_id_list,
-            comment_type=CommentType.OPEN_PR,
-            metrics_base=OPEN_PR_METRICS_BASE,
-            language=language,
-        )
-    except ApiError as e:
-        if installation.on_create_or_update_comment_error(
-            api_error=e, metrics_base=OPEN_PR_METRICS_BASE
-        ):
-            return
-
-        metrics.incr(
-            OPEN_PR_METRICS_BASE.format(integration=integration_name, key="error"),
-            tags={"type": "api_error"},
-        )
-        raise
+    # TODO(jianyuan): Using `sentry.integrations.source_code_management.tasks.open_pr_comment_workflow` now.
+    # Keep this task temporarily to avoid breaking changes.
+    real_open_pr_comment_workflow(pr_id)

src/sentry/integrations/github/webhook.py

@@ -24,11 +24,11 @@
 from sentry.constants import EXTENSION_LANGUAGE_MAP, ObjectStatus
 from sentry.identity.services.identity.service import identity_service
 from sentry.integrations.base import IntegrationDomain
-from sentry.integrations.github.tasks.open_pr_comment import open_pr_comment_workflow
 from sentry.integrations.pipeline import ensure_integration
 from sentry.integrations.services.integration.model import RpcIntegration
 from sentry.integrations.services.integration.service import integration_service
 from sentry.integrations.services.repository.service import repository_service
+from sentry.integrations.source_code_management.tasks import open_pr_comment_workflow
 from sentry.integrations.source_code_management.webhook import SCMWebhook
 from sentry.integrations.utils.metrics import IntegrationWebhookEvent, IntegrationWebhookEventType
 from sentry.integrations.utils.scope import clear_tags_and_context