fix(cli): improve PR review comment webhook diagnostics

Author: rtzll

cmd/rascal/repo.go

@@ -3,13 +3,22 @@ package main
 import (
 	"context"
 	"os"
+	"slices"
 	"strings"
 	"time"
 
 	ghapi "github.com/rtzll/rascal/internal/github"
 	"github.com/spf13/cobra"
 )
 
+var requiredWebhookEvents = []string{
+	"issues",
+	"issue_comment",
+	"pull_request_review",
+	"pull_request_review_comment",
+	"pull_request",
+}
+
 func (a *app) newRepoCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "repo",
@@ -174,11 +183,18 @@ func (a *app) newRepoStatusCmd() *cobra.Command {
 			if err != nil {
 				return &cliError{Code: exitRuntime, Message: "failed to check webhook", Cause: err}
 			}
+			missingEvents := []string{}
+			if hook != nil {
+				missingEvents = missingRequiredWebhookEvents(hook.Events)
+			}
 			out := map[string]any{
-				"repo":         repo,
-				"label_exists": labelExists,
-				"webhook_url":  webhookURL,
-				"webhook":      hook,
+				"repo":                   repo,
+				"label_exists":           labelExists,
+				"webhook_url":            webhookURL,
+				"webhook":                hook,
+				"required_events":        requiredWebhookEvents,
+				"missing_events":         missingEvents,
+				"webhook_events_healthy": hook != nil && len(missingEvents) == 0,
 			}
 			return a.emit(out, func() error {
 				a.println("repo: %s", repo)
@@ -191,6 +207,9 @@ func (a *app) newRepoStatusCmd() *cobra.Command {
 				if len(hook.Events) > 0 {
 					a.println("events: %s", strings.Join(hook.Events, ","))
 				}
+				if len(missingEvents) > 0 {
+					a.println("warning: webhook missing required events: %s", strings.Join(missingEvents, ","))
+				}
 				return nil
 			})
 		},
@@ -207,3 +226,22 @@ func resolveRepoArg(args []string, def string) string {
 	}
 	return strings.TrimSpace(def)
 }
+
+func missingRequiredWebhookEvents(events []string) []string {
+	normalized := make([]string, 0, len(events))
+	for _, event := range events {
+		event = strings.ToLower(strings.TrimSpace(event))
+		if event == "" || slices.Contains(normalized, event) {
+			continue
+		}
+		normalized = append(normalized, event)
+	}
+
+	missing := make([]string, 0)
+	for _, want := range requiredWebhookEvents {
+		if !slices.Contains(normalized, want) {
+			missing = append(missing, want)
+		}
+	}
+	return missing
+}

cmd/rascal/repo_test.go

@@ -0,0 +1,44 @@
+package main
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestMissingRequiredWebhookEvents(t *testing.T) {
+	t.Run("all required events present", func(t *testing.T) {
+		events := []string{
+			"pull_request_review",
+			"pull_request_review_comment",
+			"issue_comment",
+			"issues",
+			"pull_request",
+		}
+		if missing := missingRequiredWebhookEvents(events); len(missing) != 0 {
+			t.Fatalf("expected no missing events, got %v", missing)
+		}
+	})
+
+	t.Run("normalizes case and trims", func(t *testing.T) {
+		events := []string{
+			" Issues ",
+			"ISSUE_COMMENT",
+			"pull_request_review",
+			"pull_request_review_comment",
+			"pull_request",
+			"pull_request",
+		}
+		if missing := missingRequiredWebhookEvents(events); len(missing) != 0 {
+			t.Fatalf("expected no missing events, got %v", missing)
+		}
+	})
+
+	t.Run("returns missing events in required order", func(t *testing.T) {
+		events := []string{"issues", "issue_comment", "pull_request"}
+		want := []string{"pull_request_review", "pull_request_review_comment"}
+		got := missingRequiredWebhookEvents(events)
+		if !reflect.DeepEqual(got, want) {
+			t.Fatalf("missing = %v, want %v", got, want)
+		}
+	})
+}

cmd/rascal/webhook.go

@@ -26,6 +26,7 @@ var webhookTestEvents = []string{
 	"issues",
 	"issue_comment",
 	"pull_request_review",
+	"pull_request_review_comment",
 	"pull_request",
 }
 
@@ -212,7 +213,7 @@ func (a *app) newWebhookTestCmd() *cobra.Command {
 
 	cmd.Flags().StringVar(&webhookSecret, "webhook-secret", "", "GitHub webhook secret (or RASCAL_GITHUB_WEBHOOK_SECRET)")
 	cmd.Flags().StringVar(&repo, "repo", "", "repository in OWNER/REPO form")
-	cmd.Flags().StringVar(&event, "event", webhookTestDefaultEvent, "event template: issues|issue_comment|pull_request_review|pull_request")
+	cmd.Flags().StringVar(&event, "event", webhookTestDefaultEvent, "event template: issues|issue_comment|pull_request_review|pull_request_review_comment|pull_request")
 	cmd.Flags().BoolVar(&dryRun, "dry-run", false, "print payload/signature without sending")
 	cmd.Flags().BoolVar(&verbose, "verbose", false, "print full request/response")
 	return cmd
@@ -372,6 +373,26 @@ func buildWebhookTestEvent(event, repo string) (any, error) {
 			Repository:  ghapi.Repository{FullName: repo},
 			Sender:      ghapi.User{Login: actorLogin},
 		}, nil
+	case "pull_request_review_comment":
+		pr := ghapi.PullRequest{Number: prNumber, Merged: false}
+		pr.Base.Ref = baseBranch
+		pr.Head.Ref = headBranch
+		line := 42
+		startLine := 40
+		return ghapi.PullRequestReviewCommentEvent{
+			Action: "created",
+			Comment: ghapi.ReviewComment{
+				ID:        commentID,
+				Body:      "Synthetic inline review comment from rascal webhook test.",
+				Path:      "cmd/rascald/main.go",
+				Line:      &line,
+				StartLine: &startLine,
+				User:      ghapi.User{Login: actorLogin},
+			},
+			PullRequest: pr,
+			Repository:  ghapi.Repository{FullName: repo},
+			Sender:      ghapi.User{Login: actorLogin},
+		}, nil
 	case "pull_request":
 		pr := ghapi.PullRequest{Number: prNumber, Merged: false}
 		pr.Base.Ref = baseBranch

cmd/rascal/webhook_test.go

@@ -116,6 +116,33 @@ func TestBuildWebhookTestPayloadTemplates(t *testing.T) {
 				}
 			},
 		},
+		{
+			event: "pull_request_review_comment",
+			check: func(t *testing.T, payload []byte) {
+				var ev ghapi.PullRequestReviewCommentEvent
+				if err := json.Unmarshal(payload, &ev); err != nil {
+					t.Fatalf("unmarshal pull_request_review_comment: %v", err)
+				}
+				if ev.Action != "created" {
+					t.Fatalf("unexpected action: %q", ev.Action)
+				}
+				if ev.Comment.ID == 0 {
+					t.Fatal("expected review comment id")
+				}
+				if ev.Comment.Path == "" {
+					t.Fatal("expected review comment path")
+				}
+				if ev.Comment.Line == nil || *ev.Comment.Line <= 0 {
+					t.Fatal("expected review comment line")
+				}
+				if ev.PullRequest.Number == 0 {
+					t.Fatal("expected pull request number")
+				}
+				if ev.Repository.FullName != repo {
+					t.Fatalf("unexpected repo: %q", ev.Repository.FullName)
+				}
+			},
+		},
 		{
 			event: "pull_request",
 			check: func(t *testing.T, payload []byte) {