Compare commits
18 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f79fb40bef | |||
| cb162c154b | |||
| 437e318240 | |||
| 2e2fcbabfc | |||
| 8e26c26f5f | |||
| 22b3ce8fef | |||
| 9a6298cc4f | |||
| be68e51898 | |||
| 49db84fb82 | |||
| 08b5d4051b | |||
| d606d0a202 | |||
| b2c83c00bc | |||
| 25cb55449e | |||
| 7e3b6ec8f1 | |||
| a32a5b694b | |||
| 91fba770d9 | |||
| 5252143a33 | |||
| ac6d34f5bd |
+22
-136
@@ -2,7 +2,6 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
|
||||||
"flag"
|
"flag"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
@@ -85,16 +84,9 @@ func main() {
|
|||||||
aicoreAPIURL := flag.String("aicore-api-url", envOrDefault("AICORE_API_URL", ""), "SAP AI Core API URL (for provider=aicore)")
|
aicoreAPIURL := flag.String("aicore-api-url", envOrDefault("AICORE_API_URL", ""), "SAP AI Core API URL (for provider=aicore)")
|
||||||
aicoreResourceGroup := flag.String("aicore-resource-group", envOrDefault("AICORE_RESOURCE_GROUP", "default"), "SAP AI Core resource group (for provider=aicore)")
|
aicoreResourceGroup := flag.String("aicore-resource-group", envOrDefault("AICORE_RESOURCE_GROUP", "default"), "SAP AI Core resource group (for provider=aicore)")
|
||||||
|
|
||||||
// Register --gitea-url as a backward-compatible alias for --vcs-url.
|
// Backward-compatible alias: --gitea-url shares vcsURL's pointer (last flag wins).
|
||||||
// StringVar shares the *string pointer with vcsURL, so whichever flag is
|
// Must use *vcsURL as default: StringVar sets *p=value at registration, so empty
|
||||||
// set last by flag.Parse wins — both point to the same underlying value.
|
// string would overwrite the env-resolved value from the --vcs-url declaration.
|
||||||
// NOTE: If a user passes both --vcs-url and --gitea-url, the last one on
|
|
||||||
// the command line takes effect (standard flag package behavior). This is
|
|
||||||
// acceptable since --gitea-url is deprecated and both serve the same purpose.
|
|
||||||
//
|
|
||||||
// ORDERING: This must remain AFTER vcsURL's flag.String declaration and BEFORE
|
|
||||||
// flag.Parse(). The *vcsURL dereference captures the env-var-resolved default
|
|
||||||
// at registration time; moving flag.Parse() above this line would break it.
|
|
||||||
flag.StringVar(vcsURL, "gitea-url", *vcsURL, "Deprecated: use --vcs-url instead")
|
flag.StringVar(vcsURL, "gitea-url", *vcsURL, "Deprecated: use --vcs-url instead")
|
||||||
|
|
||||||
flag.Parse()
|
flag.Parse()
|
||||||
@@ -110,10 +102,8 @@ func main() {
|
|||||||
slog.Info("review-bot starting", "version", version)
|
slog.Info("review-bot starting", "version", version)
|
||||||
|
|
||||||
// Validate VCS provider
|
// Validate VCS provider
|
||||||
switch *provider {
|
vcsProvider := vcs.VCSProvider(*provider)
|
||||||
case "gitea", "github":
|
if !vcsProvider.Valid() {
|
||||||
// valid
|
|
||||||
default:
|
|
||||||
fmt.Fprintf(os.Stderr, "Error: invalid --provider %q (valid: gitea, github)\n", *provider)
|
fmt.Fprintf(os.Stderr, "Error: invalid --provider %q (valid: gitea, github)\n", *provider)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
@@ -126,7 +116,7 @@ func main() {
|
|||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
// --vcs-url is required only for gitea provider
|
// --vcs-url is required only for gitea provider
|
||||||
if *provider == "gitea" && *vcsURL == "" {
|
if vcsProvider == vcs.ProviderGitea && *vcsURL == "" {
|
||||||
fmt.Fprintf(os.Stderr, "Error: --vcs-url (or --gitea-url) is required for provider=gitea\n")
|
fmt.Fprintf(os.Stderr, "Error: --vcs-url (or --gitea-url) is required for provider=gitea\n")
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
@@ -169,18 +159,16 @@ func main() {
|
|||||||
|
|
||||||
// Initialize VCS client
|
// Initialize VCS client
|
||||||
var client vcs.Client
|
var client vcs.Client
|
||||||
switch *provider {
|
switch vcsProvider {
|
||||||
case "gitea":
|
case vcs.ProviderGitea:
|
||||||
giteaClient := gitea.NewClient(*vcsURL, *reviewerToken)
|
giteaClient := gitea.NewClient(*vcsURL, *reviewerToken)
|
||||||
client = gitea.NewAdapter(giteaClient)
|
client = gitea.NewAdapter(giteaClient)
|
||||||
case "github":
|
case vcs.ProviderGitHub:
|
||||||
ghBaseURL := *baseURL
|
client = github.NewClient(*reviewerToken, *baseURL)
|
||||||
if ghBaseURL == "" {
|
default:
|
||||||
ghBaseURL = "https://api.github.com"
|
panic("unreachable: provider validation should have caught " + vcsProvider.String())
|
||||||
}
|
}
|
||||||
client = github.NewClient(*reviewerToken, ghBaseURL)
|
slog.Info("VCS client initialized", "provider", vcsProvider)
|
||||||
}
|
|
||||||
slog.Info("VCS client initialized", "provider", *provider)
|
|
||||||
|
|
||||||
// Initialize LLM client
|
// Initialize LLM client
|
||||||
llmClient := llm.NewClient(*llmBaseURL, *llmAPIKey, *llmModel)
|
llmClient := llm.NewClient(*llmBaseURL, *llmAPIKey, *llmModel)
|
||||||
@@ -451,7 +439,7 @@ func main() {
|
|||||||
inlineComments = append(inlineComments, vcs.ReviewComment{
|
inlineComments = append(inlineComments, vcs.ReviewComment{
|
||||||
Path: f.File,
|
Path: f.File,
|
||||||
Position: pos,
|
Position: pos,
|
||||||
CommitID: pr.Head.SHA,
|
CommitID: evaluatedSHA,
|
||||||
Body: fmt.Sprintf("**[%s]** %s", f.Severity, f.Finding),
|
Body: fmt.Sprintf("**[%s]** %s", f.Severity, f.Finding),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@@ -497,6 +485,7 @@ func main() {
|
|||||||
reviewReq := vcs.ReviewRequest{
|
reviewReq := vcs.ReviewRequest{
|
||||||
Body: reviewBody,
|
Body: reviewBody,
|
||||||
Event: event,
|
Event: event,
|
||||||
|
CommitID: evaluatedSHA,
|
||||||
Comments: inlineComments,
|
Comments: inlineComments,
|
||||||
}
|
}
|
||||||
posted, err := client.PostReview(ctx, owner, repoName, prNumber, reviewReq)
|
posted, err := client.PostReview(ctx, owner, repoName, prNumber, reviewReq)
|
||||||
@@ -506,12 +495,16 @@ func main() {
|
|||||||
}
|
}
|
||||||
slog.Info("review posted", "review_id", posted.ID, "user", posted.User.Login, "pr", prNumber)
|
slog.Info("review posted", "review_id", posted.ID, "user", posted.User.Login, "pr", prNumber)
|
||||||
|
|
||||||
// Supersede all old reviews
|
// Supersede all old reviews via optional interface
|
||||||
if len(oldReviews) > 0 {
|
if len(oldReviews) > 0 {
|
||||||
if err := supersedeOldReviews(ctx, client, *provider, *vcsURL, owner, repoName, prNumber, oldReviews, posted.ID, sentinel); err != nil {
|
if superseder, ok := client.(vcs.ReviewSuperseder); ok {
|
||||||
|
if err := superseder.SupersedeReviews(ctx, owner, repoName, prNumber, oldReviews, posted.ID, *vcsURL, sentinel); err != nil {
|
||||||
slog.Error("failed to supersede old reviews", "error", err)
|
slog.Error("failed to supersede old reviews", "error", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
} else {
|
||||||
|
slog.Error("provider does not support review superseding", "provider", vcsProvider)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -527,88 +520,6 @@ func verdictToEvent(verdict string) vcs.ReviewEvent {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// supersedeOldReviews marks prior reviews as superseded so only the latest review is visible.
|
|
||||||
// For GitHub: dismisses old reviews (vcsURL is unused in this path).
|
|
||||||
// For Gitea: edits the review body with a link to the new review and resolves inline comments.
|
|
||||||
//
|
|
||||||
// The vcsURL parameter is only used in the Gitea path to construct review permalink URLs;
|
|
||||||
// it is accepted unconditionally to keep the function signature uniform across providers.
|
|
||||||
func supersedeOldReviews(ctx context.Context, client vcs.Client, provider, vcsURL, owner, repoName string, prNumber int, oldReviews []vcs.Review, newReviewID int64, sentinel string) error {
|
|
||||||
switch provider {
|
|
||||||
case "github":
|
|
||||||
// Best-effort dismissal: attempt all reviews, join any errors.
|
|
||||||
var errs []error
|
|
||||||
for _, old := range oldReviews {
|
|
||||||
if err := client.DismissReview(ctx, owner, repoName, prNumber, old.ID, "Superseded by new review"); err != nil {
|
|
||||||
slog.Warn("failed to dismiss review", "id", old.ID, "error", err)
|
|
||||||
errs = append(errs, fmt.Errorf("dismiss review %d: %w", old.ID, err))
|
|
||||||
} else {
|
|
||||||
slog.Info("dismissed old review", "review_id", old.ID, "new_review_id", newReviewID, "pr", prNumber)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return errors.Join(errs...)
|
|
||||||
case "gitea":
|
|
||||||
// Continue to Gitea-specific logic below the switch.
|
|
||||||
default:
|
|
||||||
return fmt.Errorf("supersedeOldReviews: unsupported provider %q", provider)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The type assertion below is guaranteed to succeed: the caller's provider switch
|
|
||||||
// ensures we only reach this point when provider == "gitea", and the gitea provider
|
|
||||||
// always constructs a *gitea.Adapter. The !ok branch guards against future refactors
|
|
||||||
// (e.g. wrapping the adapter in a decorator) that would silently break this path.
|
|
||||||
giteaAdapter, ok := client.(*gitea.Adapter)
|
|
||||||
if !ok {
|
|
||||||
return fmt.Errorf("expected gitea.Adapter for gitea provider, got %T", client)
|
|
||||||
}
|
|
||||||
underlying := giteaAdapter.Underlying()
|
|
||||||
|
|
||||||
// Validate vcsURL scheme before embedding in Markdown link (defense-in-depth).
|
|
||||||
if !strings.HasPrefix(vcsURL, "http://") && !strings.HasPrefix(vcsURL, "https://") {
|
|
||||||
return fmt.Errorf("supersedeOldReviews: vcsURL must have http or https scheme, got %q", vcsURL)
|
|
||||||
}
|
|
||||||
newReviewURL := fmt.Sprintf("%s/%s/%s/pulls/%d#pullrequestreview-%d", strings.TrimRight(vcsURL, "/"), owner, repoName, prNumber, newReviewID)
|
|
||||||
for _, oldReview := range oldReviews {
|
|
||||||
cid, err := underlying.GetTimelineReviewCommentIDForReview(ctx, owner, repoName, prNumber, oldReview.ID)
|
|
||||||
if err != nil {
|
|
||||||
slog.Warn("could not find comment ID for old review", "review_id", oldReview.ID, "error", err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
supersededBody := buildSupersededBody(oldReview.Body, oldReview.CommitID, newReviewURL, sentinel)
|
|
||||||
if err := underlying.EditComment(ctx, owner, repoName, cid, supersededBody); err != nil {
|
|
||||||
slog.Warn("could not mark old review as superseded", "review_id", oldReview.ID, "comment_id", cid, "error", err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
slog.Info("marked old review as superseded", "review_id", oldReview.ID, "new_review_id", newReviewID, "pr", prNumber)
|
|
||||||
|
|
||||||
// Resolve old review's inline comments
|
|
||||||
oldComments, err := underlying.ListReviewComments(ctx, owner, repoName, prNumber, oldReview.ID)
|
|
||||||
if err != nil {
|
|
||||||
slog.Warn("could not list old review comments for resolution", "review_id", oldReview.ID, "error", err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
resolved, failed := 0, 0
|
|
||||||
for _, c := range oldComments {
|
|
||||||
if c.ID == 0 {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if err := underlying.ResolveComment(ctx, owner, repoName, c.ID); err != nil {
|
|
||||||
slog.Debug("could not resolve inline comment", "comment_id", c.ID, "error", err)
|
|
||||||
failed++
|
|
||||||
} else {
|
|
||||||
resolved++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if resolved > 0 {
|
|
||||||
slog.Info("resolved old inline comments", "review_id", oldReview.ID, "count", resolved, "pr", prNumber)
|
|
||||||
}
|
|
||||||
if failed > 0 {
|
|
||||||
slog.Warn("some inline comments could not be resolved", "review_id", oldReview.ID, "failed", failed, "pr", prNumber)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// fetchFileContext fetches the full content of modified files from the PR branch.
|
// fetchFileContext fetches the full content of modified files from the PR branch.
|
||||||
func fetchFileContext(ctx context.Context, client vcs.PRReader, owner, repo, ref string, files []vcs.ChangedFile) string {
|
func fetchFileContext(ctx context.Context, client vcs.PRReader, owner, repo, ref string, files []vcs.ChangedFile) string {
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
@@ -636,7 +547,7 @@ func fetchFileContext(ctx context.Context, client vcs.PRReader, owner, repo, ref
|
|||||||
// patternsRepo is comma-separated list of owner/name repos.
|
// patternsRepo is comma-separated list of owner/name repos.
|
||||||
// patternsFiles is comma-separated list of file paths or directories.
|
// patternsFiles is comma-separated list of file paths or directories.
|
||||||
// If a path ends with / or is a directory, all files within it are fetched recursively.
|
// If a path ends with / or is a directory, all files within it are fetched recursively.
|
||||||
// If patternsFiles is empty, all files from the repo root are fetched.
|
// Empty entries in patternsFiles are skipped (no implicit repo-root fetch).
|
||||||
func fetchPatterns(ctx context.Context, client vcs.FileReader, patternsRepo, patternsFiles string) string {
|
func fetchPatterns(ctx context.Context, client vcs.FileReader, patternsRepo, patternsFiles string) string {
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
|
|
||||||
@@ -812,31 +723,6 @@ func validateWorkspacePath(path, pathName string) (string, error) {
|
|||||||
return resolvedPath, nil
|
return resolvedPath, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// buildSupersededBody creates the body for a superseded review: struck-through banner
|
|
||||||
// with collapsed original content and the commit it was evaluated against.
|
|
||||||
func buildSupersededBody(originalBody, commitSHA, newReviewURL, sentinel string) string {
|
|
||||||
shortSHA := commitSHA
|
|
||||||
if len(shortSHA) > 8 {
|
|
||||||
shortSHA = shortSHA[:8]
|
|
||||||
}
|
|
||||||
var sb strings.Builder
|
|
||||||
sb.WriteString("~~Original review~~\n\n")
|
|
||||||
sb.WriteString("**Superseded** \u2014 [see current review](")
|
|
||||||
sb.WriteString(newReviewURL)
|
|
||||||
sb.WriteString(") for up-to-date findings.\n\n")
|
|
||||||
if shortSHA != "" {
|
|
||||||
sb.WriteString("<details><summary>Previous findings (commit ")
|
|
||||||
sb.WriteString(shortSHA)
|
|
||||||
sb.WriteString(")</summary>\n\n")
|
|
||||||
} else {
|
|
||||||
sb.WriteString("<details><summary>Previous findings</summary>\n\n")
|
|
||||||
}
|
|
||||||
sb.WriteString(originalBody)
|
|
||||||
sb.WriteString("\n\n</details>\n\n")
|
|
||||||
sb.WriteString(sentinel)
|
|
||||||
return sb.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
// hasSharedToken detects if another review-bot role posted under the same
|
// hasSharedToken detects if another review-bot role posted under the same
|
||||||
// VCS user. This indicates misconfiguration where two roles share a token
|
// VCS user. This indicates misconfiguration where two roles share a token
|
||||||
// instead of having separate accounts. Returns true if shared token
|
// instead of having separate accounts. Returns true if shared token
|
||||||
|
|||||||
@@ -162,54 +162,6 @@ func makeReview(id int64, login, state string, stale bool, body string) vcs.Revi
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestBuildSupersededBody(t *testing.T) {
|
|
||||||
original := "# Review\n\nLooks good.\n\n<!-- review-bot:sonnet -->"
|
|
||||||
sentinel := "<!-- review-bot:sonnet -->"
|
|
||||||
newURL := "https://gitea.example.com/owner/repo/pulls/1#pullrequestreview-99"
|
|
||||||
|
|
||||||
result := buildSupersededBody(original, "abcdef1234567890", newURL, sentinel)
|
|
||||||
|
|
||||||
// Should contain the struck-through banner
|
|
||||||
if !strings.Contains(result, "~~Original review~~") {
|
|
||||||
t.Error("missing struck-through banner")
|
|
||||||
}
|
|
||||||
// Should contain superseded notice with link
|
|
||||||
if !strings.Contains(result, "**Superseded**") {
|
|
||||||
t.Error("missing superseded notice")
|
|
||||||
}
|
|
||||||
if !strings.Contains(result, "[see current review]("+newURL+")") {
|
|
||||||
t.Error("missing link to new review")
|
|
||||||
}
|
|
||||||
// Should contain collapsed original
|
|
||||||
if !strings.Contains(result, "<details>") {
|
|
||||||
t.Error("missing details/collapse")
|
|
||||||
}
|
|
||||||
// Should contain short commit SHA
|
|
||||||
if !strings.Contains(result, "abcdef12") {
|
|
||||||
t.Error("missing short SHA")
|
|
||||||
}
|
|
||||||
// Should NOT contain full SHA
|
|
||||||
if strings.Contains(result, "abcdef1234567890") {
|
|
||||||
t.Error("should truncate SHA to 8 chars")
|
|
||||||
}
|
|
||||||
// Should contain the original body inside details
|
|
||||||
if !strings.Contains(result, original) {
|
|
||||||
t.Error("original body not preserved in collapsed section")
|
|
||||||
}
|
|
||||||
// Should end with sentinel
|
|
||||||
if !strings.Contains(result, sentinel) {
|
|
||||||
t.Error("missing sentinel")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestBuildSupersededBodyShortSHA(t *testing.T) {
|
|
||||||
// Short SHA should pass through without panic
|
|
||||||
result := buildSupersededBody("body", "abc", "https://example.com/review", "<!-- review-bot:x -->")
|
|
||||||
if !strings.Contains(result, "abc") {
|
|
||||||
t.Error("short SHA not preserved")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestHasSharedToken(t *testing.T) {
|
func TestHasSharedToken(t *testing.T) {
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
|
|||||||
+81
-4
@@ -3,6 +3,8 @@ package gitea
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"log/slog"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"gitea.weiker.me/rodin/review-bot/vcs"
|
"gitea.weiker.me/rodin/review-bot/vcs"
|
||||||
)
|
)
|
||||||
@@ -168,9 +170,9 @@ func (a *Adapter) PostReview(ctx context.Context, owner, repo string, number int
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("translate position %d in %s: %w", c.Position, c.Path, err)
|
return nil, fmt.Errorf("translate position %d in %s: %w", c.Position, c.Path, err)
|
||||||
}
|
}
|
||||||
// CommitID from vcs.ReviewComment is intentionally not forwarded:
|
// Per-comment CommitID is not forwarded to Gitea inline comments:
|
||||||
// Gitea review comments are pinned to the PR head SHA automatically,
|
// Gitea's CreatePullReview API has no per-comment commit_id field.
|
||||||
// and the CreatePullReview API has no per-comment commit_id field.
|
// The review-level commit anchor is set via req.CommitID instead.
|
||||||
giteaComments = append(giteaComments, ReviewComment{
|
giteaComments = append(giteaComments, ReviewComment{
|
||||||
Path: c.Path,
|
Path: c.Path,
|
||||||
NewPosition: int64(lineNum),
|
NewPosition: int64(lineNum),
|
||||||
@@ -179,7 +181,7 @@ func (a *Adapter) PostReview(ctx context.Context, owner, repo string, number int
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
review, err := a.client.PostReview(ctx, owner, repo, number, event, req.Body, giteaComments)
|
review, err := a.client.PostReview(ctx, owner, repo, number, event, req.Body, req.CommitID, giteaComments)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("post review: %w", err)
|
return nil, fmt.Errorf("post review: %w", err)
|
||||||
}
|
}
|
||||||
@@ -237,3 +239,78 @@ func (a *Adapter) GetAuthenticatedUser(ctx context.Context) (string, error) {
|
|||||||
func (a *Adapter) RequestReviewerSelf(ctx context.Context, owner, repo string, number int, user string) error {
|
func (a *Adapter) RequestReviewerSelf(ctx context.Context, owner, repo string, number int, user string) error {
|
||||||
return a.client.RequestReviewer(ctx, owner, repo, number, user)
|
return a.client.RequestReviewer(ctx, owner, repo, number, user)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Compile-time interface conformance assertion for ReviewSuperseder.
|
||||||
|
var _ vcs.ReviewSuperseder = (*Adapter)(nil)
|
||||||
|
|
||||||
|
// SupersedeReviews marks prior reviews as superseded by editing their body with a
|
||||||
|
// link to the new review and resolving their inline comments. This is Gitea-specific
|
||||||
|
// behavior that has no GitHub equivalent (GitHub uses DismissReview instead).
|
||||||
|
//
|
||||||
|
// baseURL is the Gitea instance URL used to construct review permalink URLs.
|
||||||
|
// sentinel is the HTML comment sentinel that identifies reviews belonging to this reviewer.
|
||||||
|
func (a *Adapter) SupersedeReviews(ctx context.Context, owner, repo string, prNumber int, oldReviews []vcs.Review, newReviewID int64, baseURL, sentinel string) error {
|
||||||
|
// Validate baseURL scheme before embedding in Markdown link (defense-in-depth).
|
||||||
|
if !strings.HasPrefix(baseURL, "http://") && !strings.HasPrefix(baseURL, "https://") {
|
||||||
|
return fmt.Errorf("SupersedeReviews: baseURL must have http or https scheme, got %q", baseURL)
|
||||||
|
}
|
||||||
|
|
||||||
|
underlying := a.client
|
||||||
|
|
||||||
|
newReviewURL := fmt.Sprintf("%s/%s/%s/pulls/%d#pullrequestreview-%d",
|
||||||
|
strings.TrimRight(baseURL, "/"), owner, repo, prNumber, newReviewID)
|
||||||
|
|
||||||
|
for _, oldReview := range oldReviews {
|
||||||
|
cid, err := underlying.GetTimelineReviewCommentIDForReview(ctx, owner, repo, prNumber, oldReview.ID)
|
||||||
|
if err != nil {
|
||||||
|
slog.Warn("could not find comment ID for old review", "review_id", oldReview.ID, "error", err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
supersededBody := buildSupersededBody(oldReview.Body, oldReview.CommitID, newReviewURL, sentinel)
|
||||||
|
if err := underlying.EditComment(ctx, owner, repo, cid, supersededBody); err != nil {
|
||||||
|
slog.Warn("could not mark old review as superseded", "review_id", oldReview.ID, "error", err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Resolve old review's inline comments
|
||||||
|
oldComments, err := underlying.ListReviewComments(ctx, owner, repo, prNumber, oldReview.ID)
|
||||||
|
if err != nil {
|
||||||
|
slog.Warn("could not list old review comments for resolution", "review_id", oldReview.ID, "error", err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, c := range oldComments {
|
||||||
|
if c.ID == 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if err := underlying.ResolveComment(ctx, owner, repo, c.ID); err != nil {
|
||||||
|
slog.Debug("could not resolve inline comment", "comment_id", c.ID, "error", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// buildSupersededBody creates the body for a superseded review: struck-through banner
|
||||||
|
// with collapsed original content and the commit it was evaluated against.
|
||||||
|
func buildSupersededBody(originalBody, commitSHA, newReviewURL, sentinel string) string {
|
||||||
|
shortSHA := commitSHA
|
||||||
|
if len(shortSHA) > 8 {
|
||||||
|
shortSHA = shortSHA[:8]
|
||||||
|
}
|
||||||
|
var sb strings.Builder
|
||||||
|
sb.WriteString("~~Original review~~\n\n")
|
||||||
|
sb.WriteString("**Superseded** \u2014 [see current review](")
|
||||||
|
sb.WriteString(newReviewURL)
|
||||||
|
sb.WriteString(") for up-to-date findings.\n\n")
|
||||||
|
if shortSHA != "" {
|
||||||
|
sb.WriteString("<details><summary>Previous findings (commit ")
|
||||||
|
sb.WriteString(shortSHA)
|
||||||
|
sb.WriteString(")</summary>\n\n")
|
||||||
|
} else {
|
||||||
|
sb.WriteString("<details><summary>Previous findings</summary>\n\n")
|
||||||
|
}
|
||||||
|
sb.WriteString(originalBody)
|
||||||
|
sb.WriteString("\n\n</details>\n\n")
|
||||||
|
sb.WriteString(sentinel)
|
||||||
|
return sb.String()
|
||||||
|
}
|
||||||
|
|||||||
@@ -408,3 +408,73 @@ func TestAdapter_RequestReviewerSelf(t *testing.T) {
|
|||||||
t.Fatalf("RequestReviewerSelf() error = %v", err)
|
t.Fatalf("RequestReviewerSelf() error = %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestAdapter_PostReview_CommitID(t *testing.T) {
|
||||||
|
var gotPayload struct {
|
||||||
|
Body string `json:"body"`
|
||||||
|
Event string `json:"event"`
|
||||||
|
CommitID string `json:"commit_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewDecoder(r.Body).Decode(&gotPayload)
|
||||||
|
json.NewEncoder(w).Encode(map[string]any{
|
||||||
|
"id": 1,
|
||||||
|
"body": "test",
|
||||||
|
"user": map[string]any{"login": "bot"},
|
||||||
|
"commit_id": "abc123def456",
|
||||||
|
})
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := gitea.NewClient(server.URL, "token")
|
||||||
|
adapter := gitea.NewAdapter(client)
|
||||||
|
|
||||||
|
review, err := adapter.PostReview(context.Background(), "owner", "repo", 1, vcs.ReviewRequest{
|
||||||
|
Body: "LGTM",
|
||||||
|
Event: vcs.ReviewEventApprove,
|
||||||
|
CommitID: "abc123def456",
|
||||||
|
// No comments → no diff fetch needed
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if gotPayload.CommitID != "abc123def456" {
|
||||||
|
t.Errorf("commit_id = %q, want %q", gotPayload.CommitID, "abc123def456")
|
||||||
|
}
|
||||||
|
if review.CommitID != "abc123def456" {
|
||||||
|
t.Errorf("review.CommitID = %q, want %q", review.CommitID, "abc123def456")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAdapter_PostReview_EmptyCommitID_Omitted(t *testing.T) {
|
||||||
|
var gotRawPayload map[string]any
|
||||||
|
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewDecoder(r.Body).Decode(&gotRawPayload)
|
||||||
|
json.NewEncoder(w).Encode(map[string]any{
|
||||||
|
"id": 1,
|
||||||
|
"body": "test",
|
||||||
|
"user": map[string]any{"login": "bot"},
|
||||||
|
})
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := gitea.NewClient(server.URL, "token")
|
||||||
|
adapter := gitea.NewAdapter(client)
|
||||||
|
|
||||||
|
_, err := adapter.PostReview(context.Background(), "owner", "repo", 1, vcs.ReviewRequest{
|
||||||
|
Body: "looks good",
|
||||||
|
Event: vcs.ReviewEventComment,
|
||||||
|
// CommitID intentionally empty
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
// With empty CommitID and omitempty tag, the field should not appear in JSON
|
||||||
|
if _, exists := gotRawPayload["commit_id"]; exists {
|
||||||
|
t.Errorf("commit_id should be omitted when empty, but was present: %v", gotRawPayload["commit_id"])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
+6
-2
@@ -186,18 +186,22 @@ func (c *Client) GetFileContentRef(ctx context.Context, owner, repo, filepath, r
|
|||||||
}
|
}
|
||||||
|
|
||||||
// PostReview submits a review to a PR and returns the created review.
|
// PostReview submits a review to a PR and returns the created review.
|
||||||
// event should be "APPROVED" or "REQUEST_CHANGES".
|
// event should be one of "APPROVED", "REQUEST_CHANGES", or "COMMENT".
|
||||||
|
// commitID anchors the review to a specific commit SHA. If empty, Gitea
|
||||||
|
// defaults to the current PR head.
|
||||||
// comments are optional inline comments attached to specific lines.
|
// comments are optional inline comments attached to specific lines.
|
||||||
func (c *Client) PostReview(ctx context.Context, owner, repo string, number int, event, body string, comments []ReviewComment) (*Review, error) {
|
func (c *Client) PostReview(ctx context.Context, owner, repo string, number int, event, body, commitID string, comments []ReviewComment) (*Review, error) {
|
||||||
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d/reviews", c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number)
|
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d/reviews", c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number)
|
||||||
|
|
||||||
payload := struct {
|
payload := struct {
|
||||||
Body string `json:"body"`
|
Body string `json:"body"`
|
||||||
Event string `json:"event"`
|
Event string `json:"event"`
|
||||||
|
CommitID string `json:"commit_id,omitempty"`
|
||||||
Comments []ReviewComment `json:"comments,omitempty"`
|
Comments []ReviewComment `json:"comments,omitempty"`
|
||||||
}{
|
}{
|
||||||
Body: body,
|
Body: body,
|
||||||
Event: event,
|
Event: event,
|
||||||
|
CommitID: commitID,
|
||||||
Comments: comments,
|
Comments: comments,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+101
-2
@@ -135,7 +135,7 @@ func TestPostReview(t *testing.T) {
|
|||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
review, err := client.PostReview(context.Background(), "owner", "repo", 3, "APPROVED", "LGTM", nil)
|
review, err := client.PostReview(context.Background(), "owner", "repo", 3, "APPROVED", "LGTM", "", nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
}
|
}
|
||||||
@@ -147,6 +147,46 @@ func TestPostReview(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestPostReview_CommitID(t *testing.T) {
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != "POST" {
|
||||||
|
t.Fatalf("expected POST, got %s", r.Method)
|
||||||
|
}
|
||||||
|
|
||||||
|
body, _ := io.ReadAll(r.Body)
|
||||||
|
var payload struct {
|
||||||
|
Body string `json:"body"`
|
||||||
|
Event string `json:"event"`
|
||||||
|
CommitID string `json:"commit_id"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(body, &payload); err != nil {
|
||||||
|
t.Fatalf("unmarshal payload: %v", err)
|
||||||
|
}
|
||||||
|
if payload.CommitID != "deadbeef123" {
|
||||||
|
t.Errorf("expected commit_id %q, got %q", "deadbeef123", payload.CommitID)
|
||||||
|
}
|
||||||
|
if payload.Event != "APPROVED" {
|
||||||
|
t.Errorf("expected event APPROVED, got %q", payload.Event)
|
||||||
|
}
|
||||||
|
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
w.Write([]byte(`{"id":101,"user":{"login":"review-bot"},"state":"APPROVED","stale":false,"commit_id":"deadbeef123"}`))
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-token")
|
||||||
|
review, err := client.PostReview(context.Background(), "owner", "repo", 3, "APPROVED", "LGTM", "deadbeef123", nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if review.ID != 101 {
|
||||||
|
t.Errorf("expected review ID 101, got %d", review.ID)
|
||||||
|
}
|
||||||
|
if review.CommitID != "deadbeef123" {
|
||||||
|
t.Errorf("expected commit_id %q, got %q", "deadbeef123", review.CommitID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestGetPullRequest_Non200(t *testing.T) {
|
func TestGetPullRequest_Non200(t *testing.T) {
|
||||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
w.WriteHeader(http.StatusNotFound)
|
w.WriteHeader(http.StatusNotFound)
|
||||||
@@ -182,7 +222,7 @@ func TestPostReview_Non200(t *testing.T) {
|
|||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
_, err := client.PostReview(context.Background(), "owner", "repo", 1, "APPROVED", "test", nil)
|
_, err := client.PostReview(context.Background(), "owner", "repo", 1, "APPROVED", "test", "", nil)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected error for 403, got nil")
|
t.Fatal("expected error for 403, got nil")
|
||||||
}
|
}
|
||||||
@@ -1144,3 +1184,62 @@ func TestSanitizeErrorForLog(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestPostReview_CommitID_InPayload(t *testing.T) {
|
||||||
|
var gotPayload struct {
|
||||||
|
Body string `json:"body"`
|
||||||
|
Event string `json:"event"`
|
||||||
|
CommitID string `json:"commit_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
json.NewDecoder(r.Body).Decode(&gotPayload)
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
w.WriteHeader(200)
|
||||||
|
json.NewEncoder(w).Encode(map[string]any{
|
||||||
|
"id": 200,
|
||||||
|
"body": "LGTM",
|
||||||
|
"user": map[string]any{"login": "bot"},
|
||||||
|
"state": "APPROVED",
|
||||||
|
"commit_id": "deadbeef1234",
|
||||||
|
})
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-token")
|
||||||
|
review, err := client.PostReview(context.Background(), "owner", "repo", 5, "APPROVED", "LGTM", "deadbeef1234", nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if gotPayload.CommitID != "deadbeef1234" {
|
||||||
|
t.Errorf("sent commit_id = %q, want %q", gotPayload.CommitID, "deadbeef1234")
|
||||||
|
}
|
||||||
|
if review.CommitID != "deadbeef1234" {
|
||||||
|
t.Errorf("response commit_id = %q, want %q", review.CommitID, "deadbeef1234")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPostReview_EmptyCommitID_OmittedFromPayload(t *testing.T) {
|
||||||
|
var gotRaw map[string]any
|
||||||
|
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
json.NewDecoder(r.Body).Decode(&gotRaw)
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
w.WriteHeader(200)
|
||||||
|
json.NewEncoder(w).Encode(map[string]any{
|
||||||
|
"id": 201,
|
||||||
|
"body": "ok",
|
||||||
|
"user": map[string]any{"login": "bot"},
|
||||||
|
})
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-token")
|
||||||
|
_, err := client.PostReview(context.Background(), "owner", "repo", 5, "COMMENT", "ok", "", nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if _, exists := gotRaw["commit_id"]; exists {
|
||||||
|
t.Errorf("commit_id should be omitted when empty, but was present: %v", gotRaw["commit_id"])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -37,7 +37,7 @@ func TestPostReview_WithComments(t *testing.T) {
|
|||||||
{Path: "util.go", NewPosition: 10, Body: "[MINOR] Style issue"},
|
{Path: "util.go", NewPosition: 10, Body: "[MINOR] Style issue"},
|
||||||
}
|
}
|
||||||
|
|
||||||
_, err := client.PostReview(context.Background(), "owner", "repo", 1, "REQUEST_CHANGES", "summary", comments)
|
_, err := client.PostReview(context.Background(), "owner", "repo", 1, "REQUEST_CHANGES", "summary", "", comments)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
}
|
}
|
||||||
@@ -72,7 +72,7 @@ func TestPostReview_NilComments(t *testing.T) {
|
|||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
_, err := client.PostReview(context.Background(), "owner", "repo", 1, "APPROVED", "all good", nil)
|
_, err := client.PostReview(context.Background(), "owner", "repo", 1, "APPROVED", "all good", "", nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,54 @@
|
|||||||
|
package gitea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestBuildSupersededBody(t *testing.T) {
|
||||||
|
original := "# Review\n\nLooks good.\n\n<!-- review-bot:sonnet -->"
|
||||||
|
sentinel := "<!-- review-bot:sonnet -->"
|
||||||
|
newURL := "https://gitea.example.com/owner/repo/pulls/1#pullrequestreview-99"
|
||||||
|
|
||||||
|
result := buildSupersededBody(original, "abcdef1234567890", newURL, sentinel)
|
||||||
|
|
||||||
|
// Should contain the struck-through banner
|
||||||
|
if !strings.Contains(result, "~~Original review~~") {
|
||||||
|
t.Error("missing struck-through banner")
|
||||||
|
}
|
||||||
|
// Should contain superseded notice with link
|
||||||
|
if !strings.Contains(result, "**Superseded**") {
|
||||||
|
t.Error("missing superseded notice")
|
||||||
|
}
|
||||||
|
if !strings.Contains(result, "[see current review]("+newURL+")") {
|
||||||
|
t.Error("missing link to new review")
|
||||||
|
}
|
||||||
|
// Should contain collapsed original
|
||||||
|
if !strings.Contains(result, "<details>") {
|
||||||
|
t.Error("missing details/collapse")
|
||||||
|
}
|
||||||
|
// Should contain short commit SHA
|
||||||
|
if !strings.Contains(result, "abcdef12") {
|
||||||
|
t.Error("missing short SHA")
|
||||||
|
}
|
||||||
|
// Should NOT contain full SHA in summary (it's truncated to 8)
|
||||||
|
if strings.Contains(result, "abcdef1234567890") {
|
||||||
|
t.Error("should truncate SHA to 8 chars")
|
||||||
|
}
|
||||||
|
// Should contain the original body inside details
|
||||||
|
if !strings.Contains(result, original) {
|
||||||
|
t.Error("original body not preserved in collapsed section")
|
||||||
|
}
|
||||||
|
// Should end with sentinel
|
||||||
|
if !strings.Contains(result, sentinel) {
|
||||||
|
t.Error("missing sentinel")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildSupersededBodyShortSHA(t *testing.T) {
|
||||||
|
// Short SHA should pass through without panic
|
||||||
|
result := buildSupersededBody("body", "abc", "https://example.com/review", "<!-- review-bot:x -->")
|
||||||
|
if !strings.Contains(result, "abc") {
|
||||||
|
t.Error("short SHA not preserved")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -110,6 +110,11 @@ type Client struct {
|
|||||||
// retryBackoff[i] is the delay before attempt i+1 (after attempt i fails).
|
// retryBackoff[i] is the delay before attempt i+1 (after attempt i fails).
|
||||||
// If nil, defaults to {1s, 2s}. Set to shorter durations in tests via SetRetryBackoff.
|
// If nil, defaults to {1s, 2s}. Set to shorter durations in tests via SetRetryBackoff.
|
||||||
retryBackoff []time.Duration
|
retryBackoff []time.Duration
|
||||||
|
|
||||||
|
// reviewPageSize overrides reviewsPerPage for testing. Zero means use default.
|
||||||
|
reviewPageSize int
|
||||||
|
// reviewMaxPages overrides maxReviewPages for testing. Zero means use default.
|
||||||
|
reviewMaxPages int
|
||||||
}
|
}
|
||||||
|
|
||||||
// defaultCheckRedirect is the redirect policy used by NewClient and SetHTTPClient(nil).
|
// defaultCheckRedirect is the redirect policy used by NewClient and SetHTTPClient(nil).
|
||||||
@@ -194,6 +199,13 @@ func (c *Client) SetRetryBackoff(d []time.Duration) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetReviewPagination overrides the page size and max pages for ListReviews.
|
||||||
|
// Intended for testing only; must be called before any goroutines issue requests.
|
||||||
|
func (c *Client) SetReviewPagination(pageSize, maxPages int) {
|
||||||
|
c.reviewPageSize = pageSize
|
||||||
|
c.reviewMaxPages = maxPages
|
||||||
|
}
|
||||||
|
|
||||||
// requestOptions holds per-request configuration for doRequestCore.
|
// requestOptions holds per-request configuration for doRequestCore.
|
||||||
type requestOptions struct {
|
type requestOptions struct {
|
||||||
// bodyFn returns a fresh io.Reader for the request body on each attempt.
|
// bodyFn returns a fresh io.Reader for the request body on each attempt.
|
||||||
|
|||||||
@@ -9,3 +9,6 @@ import (
|
|||||||
// This verifies github.Client satisfies the full vcs.Client interface
|
// This verifies github.Client satisfies the full vcs.Client interface
|
||||||
// (PRReader, FileReader, Reviewer, Identity).
|
// (PRReader, FileReader, Reviewer, Identity).
|
||||||
var _ vcs.Client = (*github.Client)(nil)
|
var _ vcs.Client = (*github.Client)(nil)
|
||||||
|
|
||||||
|
// Verify github.Client implements ReviewSuperseder.
|
||||||
|
var _ vcs.ReviewSuperseder = (*github.Client)(nil)
|
||||||
|
|||||||
@@ -1,29 +0,0 @@
|
|||||||
package github
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
)
|
|
||||||
|
|
||||||
// userResponse is the GitHub API response for the authenticated user.
|
|
||||||
type userResponse struct {
|
|
||||||
Login string `json:"login"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetAuthenticatedUser returns the login of the currently authenticated user.
|
|
||||||
func (c *Client) GetAuthenticatedUser(ctx context.Context) (string, error) {
|
|
||||||
reqURL := fmt.Sprintf("%s/user", c.baseURL)
|
|
||||||
|
|
||||||
body, err := c.doGet(ctx, reqURL)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("get authenticated user: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var resp userResponse
|
|
||||||
if err := json.Unmarshal(body, &resp); err != nil {
|
|
||||||
return "", fmt.Errorf("parse user response: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return resp.Login, nil
|
|
||||||
}
|
|
||||||
@@ -4,6 +4,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -389,3 +390,288 @@ func TestPostReview_ConflictingCommitIDs(t *testing.T) {
|
|||||||
t.Errorf("expected ErrConflictingCommitIDs, got: %v", err)
|
t.Errorf("expected ErrConflictingCommitIDs, got: %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestPostReview_RequestCommitID_TakesPriority(t *testing.T) {
|
||||||
|
var gotPayload struct {
|
||||||
|
CommitID string `json:"commit_id"`
|
||||||
|
Body string `json:"body"`
|
||||||
|
}
|
||||||
|
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
json.NewDecoder(r.Body).Decode(&gotPayload)
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(map[string]any{
|
||||||
|
"id": 42,
|
||||||
|
"body": "LGTM",
|
||||||
|
"state": "APPROVED",
|
||||||
|
"commit_id": "req-level-sha",
|
||||||
|
"user": map[string]any{"login": "bot"},
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
review, err := c.PostReview(context.Background(), "owner", "repo", 1, vcs.ReviewRequest{
|
||||||
|
Body: "LGTM",
|
||||||
|
Event: vcs.ReviewEventApprove,
|
||||||
|
CommitID: "req-level-sha",
|
||||||
|
Comments: []vcs.ReviewComment{
|
||||||
|
{Path: "a.go", Position: 1, CommitID: "req-level-sha", Body: "looks good"},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if gotPayload.CommitID != "req-level-sha" {
|
||||||
|
t.Errorf("sent commit_id = %q, want %q", gotPayload.CommitID, "req-level-sha")
|
||||||
|
}
|
||||||
|
if review.CommitID != "req-level-sha" {
|
||||||
|
t.Errorf("review.CommitID = %q, want %q", review.CommitID, "req-level-sha")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPostReview_RequestCommitID_ConflictsWithComment(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
t.Fatal("request should not be sent when commit IDs conflict")
|
||||||
|
})
|
||||||
|
|
||||||
|
// req.CommitID is set, and a comment has a different CommitID → conflict
|
||||||
|
_, err := c.PostReview(context.Background(), "owner", "repo", 1, vcs.ReviewRequest{
|
||||||
|
Body: "Review",
|
||||||
|
Event: vcs.ReviewEventComment,
|
||||||
|
CommitID: "req-sha",
|
||||||
|
Comments: []vcs.ReviewComment{
|
||||||
|
{Path: "a.go", Position: 1, CommitID: "different-sha", Body: "nit"},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for conflicting commit IDs")
|
||||||
|
}
|
||||||
|
if !errors.Is(err, ErrConflictingCommitIDs) {
|
||||||
|
t.Errorf("expected ErrConflictingCommitIDs, got: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPostReview_RequestCommitID_FallbackToComment(t *testing.T) {
|
||||||
|
var gotPayload struct {
|
||||||
|
CommitID string `json:"commit_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
json.NewDecoder(r.Body).Decode(&gotPayload)
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(map[string]any{
|
||||||
|
"id": 43,
|
||||||
|
"body": "ok",
|
||||||
|
"state": "COMMENTED",
|
||||||
|
"commit_id": "comment-sha",
|
||||||
|
"user": map[string]any{"login": "bot"},
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
// req.CommitID is empty, so it falls back to the comment's CommitID
|
||||||
|
_, err := c.PostReview(context.Background(), "owner", "repo", 1, vcs.ReviewRequest{
|
||||||
|
Body: "ok",
|
||||||
|
Event: vcs.ReviewEventComment,
|
||||||
|
// CommitID intentionally empty
|
||||||
|
Comments: []vcs.ReviewComment{
|
||||||
|
{Path: "a.go", Position: 1, CommitID: "comment-sha", Body: "note"},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if gotPayload.CommitID != "comment-sha" {
|
||||||
|
t.Errorf("sent commit_id = %q, want %q (fallback from comment)", gotPayload.CommitID, "comment-sha")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- ListReviews pagination tests ---
|
||||||
|
|
||||||
|
func TestListReviews_MultiPage(t *testing.T) {
|
||||||
|
// Test multi-page pagination: 2 full pages + 1 partial page.
|
||||||
|
// pageSize=3, so pages return [3, 3, 2] reviews = 8 total.
|
||||||
|
const pageSize = 3
|
||||||
|
callCount := 0
|
||||||
|
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != "GET" {
|
||||||
|
t.Fatalf("expected GET, got %s", r.Method)
|
||||||
|
}
|
||||||
|
callCount++
|
||||||
|
|
||||||
|
page := r.URL.Query().Get("page")
|
||||||
|
var reviews []map[string]interface{}
|
||||||
|
|
||||||
|
switch page {
|
||||||
|
case "1":
|
||||||
|
for i := 1; i <= pageSize; i++ {
|
||||||
|
reviews = append(reviews, map[string]interface{}{
|
||||||
|
"id": i, "body": fmt.Sprintf("review %d", i),
|
||||||
|
"state": "APPROVED", "commit_id": "sha1",
|
||||||
|
"user": map[string]string{"login": "user1"},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
case "2":
|
||||||
|
for i := pageSize + 1; i <= pageSize*2; i++ {
|
||||||
|
reviews = append(reviews, map[string]interface{}{
|
||||||
|
"id": i, "body": fmt.Sprintf("review %d", i),
|
||||||
|
"state": "COMMENTED", "commit_id": "sha1",
|
||||||
|
"user": map[string]string{"login": "user2"},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
case "3":
|
||||||
|
// Partial page: only 2 reviews (less than pageSize)
|
||||||
|
for i := pageSize*2 + 1; i <= pageSize*2+2; i++ {
|
||||||
|
reviews = append(reviews, map[string]interface{}{
|
||||||
|
"id": i, "body": fmt.Sprintf("review %d", i),
|
||||||
|
"state": "CHANGES_REQUESTED", "commit_id": "sha1",
|
||||||
|
"user": map[string]string{"login": "user3"},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
t.Fatalf("unexpected page: %s", page)
|
||||||
|
}
|
||||||
|
|
||||||
|
json.NewEncoder(w).Encode(reviews)
|
||||||
|
})
|
||||||
|
c.SetReviewPagination(pageSize, 10)
|
||||||
|
|
||||||
|
reviews, err := c.ListReviews(context.Background(), "owner", "repo", 1)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(reviews) != 8 {
|
||||||
|
t.Fatalf("expected 8 reviews, got %d", len(reviews))
|
||||||
|
}
|
||||||
|
if callCount != 3 {
|
||||||
|
t.Errorf("expected 3 API calls, got %d", callCount)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify reviews are correctly concatenated in order
|
||||||
|
for i, r := range reviews {
|
||||||
|
expectedID := int64(i + 1)
|
||||||
|
if r.ID != expectedID {
|
||||||
|
t.Errorf("review[%d]: expected ID %d, got %d", i, expectedID, r.ID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestListReviews_ExactMultipleOfPageSize(t *testing.T) {
|
||||||
|
// When total reviews is an exact multiple of pageSize, an extra request
|
||||||
|
// returning 0 results terminates the loop. No truncation warning.
|
||||||
|
const pageSize = 2
|
||||||
|
callCount := 0
|
||||||
|
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
callCount++
|
||||||
|
page := r.URL.Query().Get("page")
|
||||||
|
|
||||||
|
var reviews []map[string]interface{}
|
||||||
|
switch page {
|
||||||
|
case "1":
|
||||||
|
reviews = []map[string]interface{}{
|
||||||
|
{"id": 1, "body": "r1", "state": "APPROVED", "commit_id": "s1", "user": map[string]string{"login": "u1"}},
|
||||||
|
{"id": 2, "body": "r2", "state": "APPROVED", "commit_id": "s1", "user": map[string]string{"login": "u2"}},
|
||||||
|
}
|
||||||
|
case "2":
|
||||||
|
reviews = []map[string]interface{}{
|
||||||
|
{"id": 3, "body": "r3", "state": "APPROVED", "commit_id": "s1", "user": map[string]string{"login": "u3"}},
|
||||||
|
{"id": 4, "body": "r4", "state": "APPROVED", "commit_id": "s1", "user": map[string]string{"login": "u4"}},
|
||||||
|
}
|
||||||
|
case "3":
|
||||||
|
// Empty page — signals end of data
|
||||||
|
reviews = []map[string]interface{}{}
|
||||||
|
default:
|
||||||
|
t.Fatalf("unexpected page: %s", page)
|
||||||
|
}
|
||||||
|
|
||||||
|
json.NewEncoder(w).Encode(reviews)
|
||||||
|
})
|
||||||
|
c.SetReviewPagination(pageSize, 10)
|
||||||
|
|
||||||
|
reviews, err := c.ListReviews(context.Background(), "owner", "repo", 1)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(reviews) != 4 {
|
||||||
|
t.Fatalf("expected 4 reviews, got %d", len(reviews))
|
||||||
|
}
|
||||||
|
// 3 calls: page 1 (full), page 2 (full), page 3 (empty)
|
||||||
|
if callCount != 3 {
|
||||||
|
t.Errorf("expected 3 API calls, got %d", callCount)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestListReviews_MaxPagesCutoff(t *testing.T) {
|
||||||
|
// When maxPages is hit and the last page is full, results are truncated
|
||||||
|
// and a warning would fire (we verify the reviews are still returned).
|
||||||
|
const pageSize = 2
|
||||||
|
const maxPages = 2
|
||||||
|
callCount := 0
|
||||||
|
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
callCount++
|
||||||
|
page := r.URL.Query().Get("page")
|
||||||
|
|
||||||
|
// Always return a full page (simulating more data exists)
|
||||||
|
var reviews []map[string]interface{}
|
||||||
|
var baseID int
|
||||||
|
switch page {
|
||||||
|
case "1":
|
||||||
|
baseID = 0
|
||||||
|
case "2":
|
||||||
|
baseID = pageSize
|
||||||
|
default:
|
||||||
|
t.Fatalf("unexpected page %s (should not exceed maxPages)", page)
|
||||||
|
}
|
||||||
|
for i := 1; i <= pageSize; i++ {
|
||||||
|
reviews = append(reviews, map[string]interface{}{
|
||||||
|
"id": baseID + i, "body": fmt.Sprintf("r%d", baseID+i),
|
||||||
|
"state": "APPROVED", "commit_id": "sha1",
|
||||||
|
"user": map[string]string{"login": "user"},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
json.NewEncoder(w).Encode(reviews)
|
||||||
|
})
|
||||||
|
c.SetReviewPagination(pageSize, maxPages)
|
||||||
|
|
||||||
|
reviews, err := c.ListReviews(context.Background(), "owner", "repo", 1)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
// Should return all reviews fetched within the cap
|
||||||
|
expectedCount := pageSize * maxPages
|
||||||
|
if len(reviews) != expectedCount {
|
||||||
|
t.Fatalf("expected %d reviews, got %d", expectedCount, len(reviews))
|
||||||
|
}
|
||||||
|
if callCount != maxPages {
|
||||||
|
t.Errorf("expected %d API calls, got %d", maxPages, callCount)
|
||||||
|
}
|
||||||
|
// Verify concatenation order
|
||||||
|
for i, r := range reviews {
|
||||||
|
if r.ID != int64(i+1) {
|
||||||
|
t.Errorf("review[%d]: expected ID %d, got %d", i, i+1, r.ID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestListReviews_EmptyFirstPage(t *testing.T) {
|
||||||
|
// PR with no reviews: first page returns empty array.
|
||||||
|
callCount := 0
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
callCount++
|
||||||
|
json.NewEncoder(w).Encode([]map[string]interface{}{})
|
||||||
|
})
|
||||||
|
c.SetReviewPagination(10, 5)
|
||||||
|
|
||||||
|
reviews, err := c.ListReviews(context.Background(), "owner", "repo", 1)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(reviews) != 0 {
|
||||||
|
t.Fatalf("expected 0 reviews, got %d", len(reviews))
|
||||||
|
}
|
||||||
|
if callCount != 1 {
|
||||||
|
t.Errorf("expected 1 API call, got %d", callCount)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -5,12 +5,21 @@ import (
|
|||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"log/slog"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
|
|
||||||
"gitea.weiker.me/rodin/review-bot/vcs"
|
"gitea.weiker.me/rodin/review-bot/vcs"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// reviewsPerPage is the number of reviews to fetch per API page.
|
||||||
|
reviewsPerPage = 100
|
||||||
|
// maxReviewPages is the maximum number of pages to paginate through
|
||||||
|
// when listing reviews. Acts as a safeguard against infinite pagination.
|
||||||
|
maxReviewPages = 100
|
||||||
|
)
|
||||||
|
|
||||||
// ErrCannotDeleteSubmittedReview is returned when DeleteReview is called on
|
// ErrCannotDeleteSubmittedReview is returned when DeleteReview is called on
|
||||||
// a review that has already been submitted (APPROVED, REQUEST_CHANGES, COMMENT).
|
// a review that has already been submitted (APPROVED, REQUEST_CHANGES, COMMENT).
|
||||||
// GitHub only allows deletion of PENDING reviews. Callers that need to replace
|
// GitHub only allows deletion of PENDING reviews. Callers that need to replace
|
||||||
@@ -54,6 +63,11 @@ type dismissReviewRequest struct {
|
|||||||
Event string `json:"event"`
|
Event string `json:"event"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// userResponse is the GitHub API response for the authenticated user.
|
||||||
|
type userResponse struct {
|
||||||
|
Login string `json:"login"`
|
||||||
|
}
|
||||||
|
|
||||||
// translateGitHubReviewState translates a GitHub API review state to the
|
// translateGitHubReviewState translates a GitHub API review state to the
|
||||||
// canonical vcs.Review.State value.
|
// canonical vcs.Review.State value.
|
||||||
func translateGitHubReviewState(state string) string {
|
func translateGitHubReviewState(state string) string {
|
||||||
@@ -82,9 +96,11 @@ func translateGitHubReviewState(state string) string {
|
|||||||
// (via the omitempty tag on postReviewRequest.Comments).
|
// (via the omitempty tag on postReviewRequest.Comments).
|
||||||
//
|
//
|
||||||
// The GitHub API accepts a single commit_id per review submission. PostReview
|
// The GitHub API accepts a single commit_id per review submission. PostReview
|
||||||
// extracts it from the first comment with a non-empty CommitID. If any subsequent
|
// uses req.CommitID as the primary commit anchor. If req.CommitID is empty,
|
||||||
// comment specifies a different CommitID, PostReview returns ErrConflictingCommitIDs.
|
// it falls back to extracting from the first comment with a non-empty CommitID.
|
||||||
// Comments with an empty CommitID are allowed and inherit the review-level value.
|
// If any subsequent comment specifies a different CommitID, PostReview returns
|
||||||
|
// ErrConflictingCommitIDs. Comments with an empty CommitID are allowed and
|
||||||
|
// inherit the review-level value.
|
||||||
func (c *Client) PostReview(ctx context.Context, owner, repo string, number int, req vcs.ReviewRequest) (*vcs.Review, error) {
|
func (c *Client) PostReview(ctx context.Context, owner, repo string, number int, req vcs.ReviewRequest) (*vcs.Review, error) {
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews",
|
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews",
|
||||||
c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number)
|
c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number)
|
||||||
@@ -92,18 +108,21 @@ func (c *Client) PostReview(ctx context.Context, owner, repo string, number int,
|
|||||||
payload := postReviewRequest{
|
payload := postReviewRequest{
|
||||||
Body: req.Body,
|
Body: req.Body,
|
||||||
Event: string(req.Event),
|
Event: string(req.Event),
|
||||||
|
CommitID: req.CommitID,
|
||||||
}
|
}
|
||||||
|
|
||||||
// Build the payload in one pass. The GitHub API accepts a single commit_id
|
// Build the payload in one pass. The GitHub API accepts a single commit_id
|
||||||
// per review; we extract it from the first comment that supplies one and
|
// per review. req.CommitID is the primary source; if empty, we extract from
|
||||||
// reject the request if any other comment disagrees.
|
// the first comment that supplies one. Reject if any comment disagrees with
|
||||||
|
// the resolved commit_id.
|
||||||
for _, comment := range req.Comments {
|
for _, comment := range req.Comments {
|
||||||
if comment.CommitID != "" {
|
if comment.CommitID != "" {
|
||||||
if payload.CommitID == "" {
|
if payload.CommitID == "" { // only reachable when req.CommitID is empty
|
||||||
payload.CommitID = comment.CommitID
|
payload.CommitID = comment.CommitID
|
||||||
} else if payload.CommitID != comment.CommitID {
|
} else if payload.CommitID != comment.CommitID {
|
||||||
return nil, ErrConflictingCommitIDs
|
return nil, ErrConflictingCommitIDs
|
||||||
}
|
}
|
||||||
|
// else: matching SHA is a no-op by design
|
||||||
}
|
}
|
||||||
payload.Comments = append(payload.Comments, reviewCommentEntry{
|
payload.Comments = append(payload.Comments, reviewCommentEntry{
|
||||||
Path: comment.Path,
|
Path: comment.Path,
|
||||||
@@ -112,12 +131,7 @@ func (c *Client) PostReview(ctx context.Context, owner, repo string, number int,
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
data, err := json.Marshal(payload)
|
body, err := c.doJSONRequest(ctx, http.MethodPost, reqURL, payload)
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("marshal review request: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
body, err := c.doRequestWithBody(ctx, http.MethodPost, reqURL, data)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("post review: %w", err)
|
return nil, fmt.Errorf("post review: %w", err)
|
||||||
}
|
}
|
||||||
@@ -136,15 +150,28 @@ func (c *Client) PostReview(ctx context.Context, owner, repo string, number int,
|
|||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// ListReviews retrieves all reviews for a pull request.
|
// ListReviews retrieves all reviews for a pull request with pagination.
|
||||||
// GitHub review states are translated to canonical vcs values.
|
// GitHub review states are translated to canonical vcs values.
|
||||||
func (c *Client) ListReviews(ctx context.Context, owner, repo string, number int) ([]vcs.Review, error) {
|
func (c *Client) ListReviews(ctx context.Context, owner, repo string, number int) ([]vcs.Review, error) {
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews",
|
perPage := reviewsPerPage
|
||||||
c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number)
|
if c.reviewPageSize > 0 {
|
||||||
|
perPage = c.reviewPageSize
|
||||||
|
}
|
||||||
|
maxPages := maxReviewPages
|
||||||
|
if c.reviewMaxPages > 0 {
|
||||||
|
maxPages = c.reviewMaxPages
|
||||||
|
}
|
||||||
|
|
||||||
|
var allReviews []vcs.Review
|
||||||
|
truncated := false
|
||||||
|
|
||||||
|
for page := 1; page <= maxPages; page++ {
|
||||||
|
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews?per_page=%d&page=%d",
|
||||||
|
c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number, perPage, page)
|
||||||
|
|
||||||
body, err := c.doGet(ctx, reqURL)
|
body, err := c.doGet(ctx, reqURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("list reviews: %w", err)
|
return nil, fmt.Errorf("list reviews page %d: %w", page, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
var responses []reviewResponse
|
var responses []reviewResponse
|
||||||
@@ -152,17 +179,40 @@ func (c *Client) ListReviews(ctx context.Context, owner, repo string, number int
|
|||||||
return nil, fmt.Errorf("parse reviews response: %w", err)
|
return nil, fmt.Errorf("parse reviews response: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
reviews := make([]vcs.Review, len(responses))
|
if len(responses) == 0 {
|
||||||
for i, r := range responses {
|
break
|
||||||
reviews[i] = vcs.Review{
|
}
|
||||||
|
|
||||||
|
for _, r := range responses {
|
||||||
|
allReviews = append(allReviews, vcs.Review{
|
||||||
ID: r.ID,
|
ID: r.ID,
|
||||||
Body: r.Body,
|
Body: r.Body,
|
||||||
User: vcs.UserInfo{Login: r.User.Login},
|
User: vcs.UserInfo{Login: r.User.Login},
|
||||||
State: translateGitHubReviewState(r.State),
|
State: translateGitHubReviewState(r.State),
|
||||||
CommitID: r.CommitID,
|
CommitID: r.CommitID,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(responses) < perPage {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
// Truncation detection: this runs on the final allowed iteration
|
||||||
|
// (page == maxPages) only when the page was full (the len < perPage
|
||||||
|
// early-break above didn't fire). A full final page means additional
|
||||||
|
// reviews likely exist beyond our pagination limit.
|
||||||
|
if page == maxPages {
|
||||||
|
truncated = true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return reviews, nil
|
|
||||||
|
if truncated {
|
||||||
|
slog.Warn("ListReviews hit page limit; results may be truncated",
|
||||||
|
"owner", owner, "repo", repo, "pr", number,
|
||||||
|
"maxPages", maxPages, "reviewsFetched", len(allReviews))
|
||||||
|
}
|
||||||
|
|
||||||
|
return allReviews, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// DeleteReview deletes a pull request review.
|
// DeleteReview deletes a pull request review.
|
||||||
@@ -199,14 +249,36 @@ func (c *Client) DismissReview(ctx context.Context, owner, repo string, number i
|
|||||||
Event: "DISMISS",
|
Event: "DISMISS",
|
||||||
}
|
}
|
||||||
|
|
||||||
data, err := json.Marshal(payload)
|
_, err := c.doJSONRequest(ctx, http.MethodPut, reqURL, payload)
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("marshal dismiss request: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = c.doRequestWithBody(ctx, http.MethodPut, reqURL, data)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("dismiss review: %w", err)
|
return fmt.Errorf("dismiss review: %w", err)
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SupersedeReviews marks prior reviews as superseded by dismissing them.
|
||||||
|
// This implements vcs.ReviewSuperseder for the GitHub adapter.
|
||||||
|
// The baseURL and sentinel parameters are unused for GitHub (dismissal is the mechanism).
|
||||||
|
func (c *Client) SupersedeReviews(ctx context.Context, owner, repo string, prNumber int, oldReviews []vcs.Review, newReviewID int64, _, _ string) error {
|
||||||
|
var errs []error
|
||||||
|
for _, old := range oldReviews {
|
||||||
|
if err := c.DismissReview(ctx, owner, repo, prNumber, old.ID, "Superseded by new review"); err != nil {
|
||||||
|
errs = append(errs, fmt.Errorf("dismiss review %d: %w", old.ID, err))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return errors.Join(errs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetAuthenticatedUser returns the login name of the authenticated user.
|
||||||
|
func (c *Client) GetAuthenticatedUser(ctx context.Context) (string, error) {
|
||||||
|
reqURL := fmt.Sprintf("%s/user", c.baseURL)
|
||||||
|
body, err := c.doGet(ctx, reqURL)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("get authenticated user: %w", err)
|
||||||
|
}
|
||||||
|
var resp userResponse
|
||||||
|
if err := json.Unmarshal(body, &resp); err != nil {
|
||||||
|
return "", fmt.Errorf("parse user response: %w", err)
|
||||||
|
}
|
||||||
|
return resp.Login, nil
|
||||||
|
}
|
||||||
@@ -49,3 +49,12 @@ type Client interface {
|
|||||||
type ReviewerSelfRequester interface {
|
type ReviewerSelfRequester interface {
|
||||||
RequestReviewerSelf(ctx context.Context, owner, repo string, number int, user string) error
|
RequestReviewerSelf(ctx context.Context, owner, repo string, number int, user string) error
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ReviewSuperseder is an optional interface implemented by adapters that support
|
||||||
|
// marking old reviews as superseded. For Gitea this means editing the review body
|
||||||
|
// with a link to the new review and resolving inline comments. For GitHub this
|
||||||
|
// means dismissing old reviews.
|
||||||
|
// Consumers should use interface assertion: if rs, ok := client.(ReviewSuperseder); ok { ... }
|
||||||
|
type ReviewSuperseder interface {
|
||||||
|
SupersedeReviews(ctx context.Context, owner, repo string, prNumber int, oldReviews []Review, newReviewID int64, baseURL, sentinel string) error
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,26 @@
|
|||||||
|
package vcs
|
||||||
|
|
||||||
|
// VCSProvider identifies a VCS platform. Using a typed string instead of bare
|
||||||
|
// strings makes provider values compiler-checkable and prevents typos from
|
||||||
|
// silently passing validation.
|
||||||
|
type VCSProvider string
|
||||||
|
|
||||||
|
const (
|
||||||
|
ProviderGitea VCSProvider = "gitea"
|
||||||
|
ProviderGitHub VCSProvider = "github"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Valid reports whether p is a known VCS provider.
|
||||||
|
func (p VCSProvider) Valid() bool {
|
||||||
|
switch p {
|
||||||
|
case ProviderGitea, ProviderGitHub:
|
||||||
|
return true
|
||||||
|
default:
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// String returns the string representation of the provider.
|
||||||
|
func (p VCSProvider) String() string {
|
||||||
|
return string(p)
|
||||||
|
}
|
||||||
@@ -94,5 +94,10 @@ type ReviewRequest struct {
|
|||||||
Body string `json:"body"`
|
Body string `json:"body"`
|
||||||
// Event is the review action (approve, request changes, or comment).
|
// Event is the review action (approve, request changes, or comment).
|
||||||
Event ReviewEvent `json:"event"`
|
Event ReviewEvent `json:"event"`
|
||||||
|
// CommitID anchors the review to a specific commit SHA.
|
||||||
|
// If empty, the platform defaults to the current PR head.
|
||||||
|
// Adapters use this as the primary commit anchor for the review submission.
|
||||||
|
CommitID string `json:"commit_id,omitempty"`
|
||||||
|
|
||||||
Comments []ReviewComment `json:"comments,omitempty"`
|
Comments []ReviewComment `json:"comments,omitempty"`
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user