feat(code-review): Handle issue comment command (#105527)

Handle issue comment including the posting of eyes emoji from within sentry.

This is behind an option for `github.webhook.issue-comment` which decides whether we route flow
through this path or the path that forwards to overwatch.

Note that though in theory overwatch at some point also supported review
(including posting 👀 ) for `pull_request_review` and
`pull_request_review_comment`, I tried out these flows and they don't seem
to be working right now.

I think it's fine to maintain parity and just port over the issue comment which can trigger a review with the on command phrase.

Closes
[CW-10](https://linear.app/getsentry/issue/CW-10/port-emoji-reactions-to-sentry)

---------

Co-authored-by: Armen Zambrano G. <[email protected]>

Author: suejung-sentry

src/sentry/integrations/github/client.py

@@ -3,6 +3,7 @@
 import logging
 from collections.abc import Mapping, Sequence
 from datetime import datetime, timedelta
+from enum import StrEnum
 from typing import Any, TypedDict
 
 import orjson
@@ -59,6 +60,21 @@ def __repr__(self) -> str:
         return f"GithubRateLimitInfo(limit={self.limit},rem={self.remaining},reset={self.reset})"
 
 
+class GitHubReaction(StrEnum):
+    """
+    https://docs.github.com/en/rest/reactions/reactions#about-reactions
+    """
+
+    PLUS_ONE = "+1"
+    MINUS_ONE = "-1"
+    LAUGH = "laugh"
+    CONFUSED = "confused"
+    HEART = "heart"
+    HOORAY = "hooray"
+    ROCKET = "rocket"
+    EYES = "eyes"
+
+
 class GithubSetupApiClient(IntegrationProxyClient):
     """
     API Client that doesn't require an installation.
@@ -585,6 +601,18 @@ def get_comment_reactions(self, repo: str, comment_id: str) -> Any:
         reactions.pop("url", None)
         return reactions
 
+    def create_comment_reaction(self, repo: str, comment_id: str, reaction: GitHubReaction) -> Any:
+        """
+        https://docs.github.com/en/rest/reactions/reactions#create-reaction-for-an-issue-comment
+
+        Args:
+            repo: Repository name in "owner/repo" format
+            comment_id: The ID of the comment
+            reaction: The reaction type
+        """
+        endpoint = f"/repos/{repo}/issues/comments/{comment_id}/reactions"
+        return self.post(endpoint, data={"content": reaction.value})
+
     def get_user(self, gh_username: str) -> Any:
         """
         https://docs.github.com/en/rest/users/users#get-a-user

src/sentry/integrations/github/webhook.py

@@ -177,6 +177,7 @@ def _handle(
                 processor(
                     github_event=github_event,
                     event=event,
+                    integration=integration,
                     organization=organization,
                     repo=repo,
                     **kwargs,
@@ -1016,8 +1017,7 @@ class IssueCommentEventWebhook(GitHubWebhook):
     """
 
     EVENT_TYPE = IntegrationWebhookEventType.ISSUE_COMMENT
-    # XXX: Once we port the Overwatch feature, we can add the processor here.
-    WEBHOOK_EVENT_PROCESSORS = ()
+    WEBHOOK_EVENT_PROCESSORS = (code_review_handle_webhook_event,)
 
 
 @all_silo_endpoint

src/sentry/seer/code_review/utils.py

@@ -6,7 +6,6 @@
 from django.conf import settings
 from urllib3.exceptions import HTTPError
 
-from sentry.integrations.github.webhook_types import GithubWebhookType
 from sentry.models.repository import Repository
 from sentry.net.http import connection_from_url
 from sentry.seer.signed_seer_api import make_signed_seer_api_request
@@ -18,11 +17,10 @@ class ClientError(Exception):
     pass
 
 
+# These values need to match the value defined in the Seer API.
 class SeerEndpoint(StrEnum):
-    # XXX: We will need to either add a new one or re-use the overwatch-request endpoint.
     # https://github.com/getsentry/seer/blob/main/src/seer/routes/automation_request.py#L57
-    SENTRY_REQUEST = "/v1/automation/sentry-request"
-    # This needs to match the value defined in the Seer API:
+    OVERWATCH_REQUEST = "/v1/automation/overwatch-request"
     # https://github.com/getsentry/seer/blob/main/src/seer/routes/codegen.py
     PR_REVIEW_RERUN = "/v1/automation/codegen/pr-review/rerun"
 
@@ -58,8 +56,7 @@ def make_seer_request(path: str, payload: Mapping[str, Any]) -> bytes:
 
 
 # XXX: Do a thorough review of this function and make sure it's correct.
-def _transform_webhook_to_codegen_request(
-    event_type: GithubWebhookType,
+def transform_webhook_to_codegen_request(
     event_payload: Mapping[str, Any],
     organization_id: int,
     repo: Repository,
@@ -68,7 +65,6 @@ def _transform_webhook_to_codegen_request(
     Transform a GitHub webhook payload into CodecovTaskRequest format for Seer.
 
     Args:
-        event_type: The type of GitHub webhook event
         event_payload: The full webhook event payload from GitHub
         organization_id: The Sentry organization ID
 

src/sentry/seer/code_review/webhooks/handlers.py

@@ -2,67 +2,26 @@
 
 import logging
 from collections.abc import Mapping
-from datetime import datetime, timezone
 from typing import TYPE_CHECKING, Any
 
 from sentry.integrations.github.webhook_types import GithubWebhookType
 from sentry.models.organization import Organization
 from sentry.models.repository import Repository
-from sentry.utils import metrics
 
 if TYPE_CHECKING:
     from sentry.integrations.github.webhook import WebhookProcessor
 
-from ..utils import _transform_webhook_to_codegen_request
 from .check_run import handle_check_run_event
+from .issue_comment import handle_issue_comment_event
 
 logger = logging.getLogger(__name__)
 
 METRICS_PREFIX = "seer.code_review.webhook"
 
 
-def handle_other_webhook_event(
-    *,
-    github_event: GithubWebhookType,
-    event: Mapping[str, Any],
-    organization: Organization,
-    repo: Repository,
-    **kwargs: Any,
-) -> None:
-    """
-    Each webhook event type may implement its own handler.
-    This is a generic handler for non-PR-related events (e.g., issue_comment on regular issues).
-    """
-    from .task import process_github_webhook_event
-
-    transformed_event = _transform_webhook_to_codegen_request(
-        github_event, dict(event), organization.id, repo
-    )
-
-    if transformed_event is None:
-        metrics.incr(
-            f"{METRICS_PREFIX}.{github_event.value}.skipped",
-            tags={"reason": "failed_to_transform", "github_event": github_event.value},
-        )
-        return
-
-    process_github_webhook_event.delay(
-        github_event=github_event,
-        event_payload=transformed_event,
-        enqueued_at_str=datetime.now(timezone.utc).isoformat(),
-    )
-    metrics.incr(
-        f"{METRICS_PREFIX}.{github_event.value}.enqueued",
-        tags={"status": "success", "github_event": github_event.value},
-    )
-
-
-EVENT_TYPE_TO_handler: dict[GithubWebhookType, WebhookProcessor] = {
+EVENT_TYPE_TO_HANDLER: dict[GithubWebhookType, WebhookProcessor] = {
     GithubWebhookType.CHECK_RUN: handle_check_run_event,
-    GithubWebhookType.ISSUE_COMMENT: handle_other_webhook_event,
-    GithubWebhookType.PULL_REQUEST: handle_other_webhook_event,
-    GithubWebhookType.PULL_REQUEST_REVIEW: handle_other_webhook_event,
-    GithubWebhookType.PULL_REQUEST_REVIEW_COMMENT: handle_other_webhook_event,
+    GithubWebhookType.ISSUE_COMMENT: handle_issue_comment_event,
 }
 
 
@@ -84,7 +43,7 @@ def handle_webhook_event(
         repo: The repository that the webhook event is for
         **kwargs: Additional keyword arguments including integration
     """
-    handler = EVENT_TYPE_TO_handler.get(github_event)
+    handler = EVENT_TYPE_TO_HANDLER.get(github_event)
     if handler is None:
         logger.warning(
             "github.webhook.handler.not_found",
@@ -99,8 +58,3 @@ def handle_webhook_event(
         repo=repo,
         **kwargs,
     )
-
-
-# Type checks to ensure the functions match WebhookProcessor protocol
-_type_checked_handle_other_webhook_event: WebhookProcessor = handle_other_webhook_event
-_type_checked_handle_check_run_event: WebhookProcessor = handle_check_run_event

src/sentry/seer/code_review/webhooks/issue_comment.py

@@ -0,0 +1,119 @@
+"""
+Handler for GitHub issue_comment webhook events.
+"""
+
+from __future__ import annotations
+
+import enum
+import logging
+from collections.abc import Mapping
+from typing import Any
+
+from sentry import options
+from sentry.integrations.github.client import GitHubReaction
+from sentry.integrations.github.webhook_types import GithubWebhookType
+from sentry.integrations.services.integration import RpcIntegration
+from sentry.models.organization import Organization
+from sentry.models.repository import Repository
+from sentry.utils import metrics
+
+from ..permissions import has_code_review_enabled
+
+logger = logging.getLogger(__name__)
+
+
+class ErrorStatus(enum.StrEnum):
+    MISSING_INTEGRATION = "missing_integration"
+    REACTION_FAILED = "reaction_failed"
+
+
+class Log(enum.StrEnum):
+    MISSING_INTEGRATION = "github.webhook.issue_comment.missing-integration"
+    REACTION_FAILED = "github.webhook.issue_comment.reaction-failed"
+
+
+class Metrics(enum.StrEnum):
+    ERROR = "seer.code_review.webhook.issue_comment.error"
+    OUTCOME = "seer.code_review.webhook.issue_comment.outcome"
+
+
+SENTRY_REVIEW_COMMAND = "@sentry review"
+
+
+def is_pr_review_command(comment_body: str | None) -> bool:
+    if comment_body is None:
+        return False
+    return SENTRY_REVIEW_COMMAND in comment_body.lower()
+
+
+def _add_eyes_reaction_to_comment(
+    integration: RpcIntegration | None,
+    organization: Organization,
+    repo: Repository,
+    comment_id: str,
+) -> None:
+    extra = {"organization_id": organization.id, "repo": repo.name, "comment_id": comment_id}
+
+    if integration is None:
+        metrics.incr(
+            Metrics.ERROR.value,
+            tags={"error_status": ErrorStatus.MISSING_INTEGRATION.value},
+        )
+        logger.warning(
+            Log.MISSING_INTEGRATION.value,
+            extra=extra,
+        )
+        return
+
+    try:
+        client = integration.get_installation(organization_id=organization.id).get_client()
+        client.create_comment_reaction(repo.name, comment_id, GitHubReaction.EYES)
+        metrics.incr(
+            Metrics.OUTCOME.value,
+            tags={"status": "reaction_added"},
+        )
+    except Exception:
+        metrics.incr(
+            Metrics.ERROR.value,
+            tags={"error_status": ErrorStatus.REACTION_FAILED.value},
+        )
+        logger.exception(
+            Log.REACTION_FAILED.value,
+            extra=extra,
+        )
+
+
+def handle_issue_comment_event(
+    *,
+    github_event: GithubWebhookType,
+    event: Mapping[str, Any],
+    organization: Organization,
+    repo: Repository,
+    integration: RpcIntegration | None = None,
+    **kwargs: Any,
+) -> None:
+    """
+    Handle issue_comment webhook events for PR review commands.
+    """
+    comment = event.get("comment", {})
+    comment_id = comment.get("id")
+    comment_body = comment.get("body")
+
+    if not has_code_review_enabled(organization):
+        return
+
+    if not is_pr_review_command(comment_body or ""):
+        return
+
+    if not options.get("github.webhook.issue-comment"):
+        if comment_id:
+            _add_eyes_reaction_to_comment(integration, organization, repo, str(comment_id))
+
+        from .task import schedule_task
+
+        schedule_task(
+            github_event=github_event,
+            event=event,
+            organization=organization,
+            repo=repo,
+        )

src/sentry/seer/code_review/webhooks/task.py

@@ -8,6 +8,9 @@
 from urllib3.exceptions import HTTPError
 
 from sentry.integrations.github.webhook_types import GithubWebhookType
+from sentry.models.organization import Organization
+from sentry.models.repository import Repository
+from sentry.seer.code_review.utils import transform_webhook_to_codegen_request
 from sentry.silo.base import SiloMode
 from sentry.tasks.base import instrumented_task
 from sentry.taskworker.namespaces import seer_code_review_tasks
@@ -25,6 +28,7 @@
 MAX_RETRIES = 3
 DELAY_BETWEEN_RETRIES = 60  # 1 minute
 RETRYABLE_ERRORS = (HTTPError,)
+METRICS_PREFIX = "seer.code_review.task"
 
 
 def _call_seer_request(
@@ -35,7 +39,38 @@ def _call_seer_request(
     """
     assert github_event != GithubWebhookType.CHECK_RUN
     # XXX: Add checking options to prevent sending events to Seer by mistake.
-    make_seer_request(path=SeerEndpoint.SENTRY_REQUEST.value, payload=event_payload)
+    make_seer_request(path=SeerEndpoint.OVERWATCH_REQUEST.value, payload=event_payload)
+
+
+def schedule_task(
+    github_event: GithubWebhookType,
+    event: Mapping[str, Any],
+    organization: Organization,
+    repo: Repository,
+) -> None:
+    """Transform and forward a webhook event to Seer for processing."""
+    from .task import process_github_webhook_event
+
+    transformed_event = transform_webhook_to_codegen_request(
+        event_payload=dict(event), organization_id=organization.id, repo=repo
+    )
+
+    if transformed_event is None:
+        metrics.incr(
+            f"{METRICS_PREFIX}.{github_event.value}.skipped",
+            tags={"reason": "failed_to_transform", "github_event": github_event.value},
+        )
+        return
+
+    process_github_webhook_event.delay(
+        github_event=github_event,
+        event_payload=transformed_event,
+        enqueued_at_str=datetime.now(timezone.utc).isoformat(),
+    )
+    metrics.incr(
+        f"{METRICS_PREFIX}.{github_event.value}.enqueued",
+        tags={"status": "success", "github_event": github_event.value},
+    )
 
 
 EVENT_TYPE_TO_PROCESSOR = {GithubWebhookType.CHECK_RUN: process_check_run_task_event}