DELETE: no document in docs/architecture/ or docs/prds/ specifies a production consumer for forge.IssueForge.CreateIssue. It has no production caller -- the remaining repo matches are the GitHub CreateIssueReaction and Gitea CreateIssueComment SDK methods. Removing the interface method and the GitHub/Gitea/Noop implementations; the other fakes that still define CreateIssue are test-only and out of lane ownership, and an interface with one fewer method keeps them satisfying. RepliesAfter and forge.Reply are untouched (a parallel FLAG record).
408 lines
13 KiB
Go
408 lines
13 KiB
Go
// Package forge wraps the GitHub API surface archied needs: polling
|
|
// labelled issues, accepting collaborator invitations, commenting, and
|
|
// opening pull requests. Gitea support later lands as a second
|
|
// implementation behind the same methods.
|
|
package forge
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"log/slog"
|
|
"strings"
|
|
"sync"
|
|
|
|
"github.com/google/go-github/v78/github"
|
|
)
|
|
|
|
// GitHubClient implements Forge against the GitHub API.
|
|
type GitHubClient struct {
|
|
gh *github.Client
|
|
log *slog.Logger
|
|
|
|
labelMu sync.Mutex
|
|
labelsEnsured map[string]bool
|
|
}
|
|
|
|
// NewGitHub creates a GitHub-backed Forge implementation. Non-github.com
|
|
// hosts are configured using GitHub Enterprise's API and upload URL conventions.
|
|
func NewGitHub(token, host string, log *slog.Logger) (Forge, error) {
|
|
client := github.NewClient(nil)
|
|
if strings.TrimRight(host, "/") != "https://github.com" {
|
|
var err error
|
|
client, err = client.WithEnterpriseURLs(host, host)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("configure GitHub host %q: %w", host, err)
|
|
}
|
|
}
|
|
return &GitHubClient{gh: client.WithAuthToken(token), log: log}, nil
|
|
}
|
|
|
|
// AcceptInvitations auto-accepts pending repository invitations so
|
|
// adding archie as a collaborator is all a human has to do.
|
|
func (c *GitHubClient) AcceptInvitations(ctx context.Context) error {
|
|
invites, _, err := c.gh.Users.ListInvitations(ctx, nil)
|
|
if err != nil {
|
|
return fmt.Errorf("list invitations: %w", err)
|
|
}
|
|
for _, inv := range invites {
|
|
if _, err := c.gh.Users.AcceptInvitation(ctx, inv.GetID()); err != nil {
|
|
c.log.Warn("accept invitation failed", "repo", inv.GetRepo().GetFullName(), "err", err)
|
|
continue
|
|
}
|
|
c.log.Info("accepted repository invitation", "repo", inv.GetRepo().GetFullName())
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// AssignedIssues returns open issues assigned to the given user,
|
|
// excluding PRs. Assigning an issue to the bot is how work is handed to
|
|
// archie (tink-bot style); labels only influence workflow routing.
|
|
func (c *GitHubClient) AssignedIssues(ctx context.Context, owner, repo, assignee string) ([]Issue, error) {
|
|
var out []Issue
|
|
opts := &github.IssueListByRepoOptions{
|
|
State: "open",
|
|
Assignee: assignee,
|
|
ListOptions: github.ListOptions{PerPage: 50},
|
|
}
|
|
for {
|
|
issues, resp, err := c.gh.Issues.ListByRepo(ctx, owner, repo, opts)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("list issues %s/%s: %w", owner, repo, err)
|
|
}
|
|
for _, is := range issues {
|
|
if !is.IsPullRequest() {
|
|
out = append(out, Issue{
|
|
Number: is.GetNumber(),
|
|
Title: is.GetTitle(),
|
|
Body: is.GetBody(),
|
|
Labels: labelNames(is),
|
|
})
|
|
}
|
|
}
|
|
if resp.NextPage == 0 {
|
|
break
|
|
}
|
|
opts.ListOptions.Page = resp.NextPage
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
// labelNames extracts label names without flattening them, preserving
|
|
// valid label names that contain commas or leading/trailing whitespace.
|
|
func labelNames(is *github.Issue) []string {
|
|
var names []string
|
|
for _, l := range is.Labels {
|
|
names = append(names, l.GetName())
|
|
}
|
|
return names
|
|
}
|
|
|
|
// IssuesWithLabel returns open issues matching the given label, excluding
|
|
// PRs. Used when Dispatch.Trigger is "label" or "either" -- no assignee
|
|
// required, just the label.
|
|
func (c *GitHubClient) IssuesWithLabel(ctx context.Context, owner, repo, label string) ([]Issue, error) {
|
|
var out []Issue
|
|
opts := &github.IssueListByRepoOptions{
|
|
State: "open",
|
|
Labels: []string{label},
|
|
ListOptions: github.ListOptions{PerPage: 50},
|
|
}
|
|
for {
|
|
issues, resp, err := c.gh.Issues.ListByRepo(ctx, owner, repo, opts)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("list issues %s/%s: %w", owner, repo, err)
|
|
}
|
|
for _, is := range issues {
|
|
if !is.IsPullRequest() {
|
|
out = append(out, Issue{
|
|
Number: is.GetNumber(),
|
|
Title: is.GetTitle(),
|
|
Body: is.GetBody(),
|
|
Labels: labelNames(is),
|
|
})
|
|
}
|
|
}
|
|
if resp.NextPage == 0 {
|
|
break
|
|
}
|
|
opts.ListOptions.Page = resp.NextPage
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
// Comment posts an issue (or PR) comment and returns its id, so a
|
|
// workflow can watch for replies that come after it.
|
|
func (c *GitHubClient) Comment(ctx context.Context, owner, repo string, number int, body string) (int64, error) {
|
|
cm, _, err := c.gh.Issues.CreateComment(ctx, owner, repo, number,
|
|
&github.IssueComment{Body: new(body)})
|
|
if err != nil {
|
|
return 0, err
|
|
}
|
|
return cm.GetID(), nil
|
|
}
|
|
|
|
// Reply is a human comment on a watched issue.
|
|
type Reply struct {
|
|
ID int64
|
|
User string
|
|
Body string
|
|
}
|
|
|
|
// RepliesAfter returns comments on the issue with id > afterID that were
|
|
// not written by exclude (the bot) -- the human side of waiting_human.
|
|
func (c *GitHubClient) RepliesAfter(ctx context.Context, owner, repo string, number int, afterID int64, exclude string) ([]Reply, error) {
|
|
comments, _, err := c.gh.Issues.ListComments(ctx, owner, repo, number,
|
|
&github.IssueListCommentsOptions{PerPage: 50})
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
var out []Reply
|
|
for _, cm := range comments {
|
|
if cm.GetID() <= afterID || cm.GetUser().GetLogin() == exclude {
|
|
continue
|
|
}
|
|
out = append(out, Reply{ID: cm.GetID(), User: cm.GetUser().GetLogin(), Body: cm.GetBody()})
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
// CreatePR opens a pull request and returns its number.
|
|
func (c *GitHubClient) CreatePR(ctx context.Context, owner, repo, title, head, base, body string) (int, error) {
|
|
pr, _, err := c.gh.PullRequests.Create(ctx, owner, repo, &github.NewPullRequest{
|
|
Title: new(title),
|
|
Head: new(head),
|
|
Base: new(base),
|
|
Body: new(body),
|
|
})
|
|
if err != nil {
|
|
return 0, fmt.Errorf("create PR %s/%s: %w", owner, repo, err)
|
|
}
|
|
return pr.GetNumber(), nil
|
|
}
|
|
|
|
// PRState returns "open", "merged", or "closed" for a PR.
|
|
func (c *GitHubClient) PRState(ctx context.Context, owner, repo string, number int) (string, error) {
|
|
pr, _, err := c.gh.PullRequests.Get(ctx, owner, repo, number)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
if pr.GetMerged() {
|
|
return "merged", nil
|
|
}
|
|
return pr.GetState(), nil
|
|
}
|
|
|
|
// GetPullRequest returns the forge-neutral metadata for an existing PR.
|
|
func (c *GitHubClient) GetPullRequest(ctx context.Context, owner, repo string, number int) (PullRequest, error) {
|
|
pr, _, err := c.gh.PullRequests.Get(ctx, owner, repo, number)
|
|
if err != nil {
|
|
return PullRequest{}, fmt.Errorf("get pull request %s/%s#%d: %w", owner, repo, number, err)
|
|
}
|
|
state := pr.GetState()
|
|
if pr.GetMerged() {
|
|
state = "merged"
|
|
}
|
|
return PullRequest{
|
|
Number: pr.GetNumber(),
|
|
Title: pr.GetTitle(),
|
|
Body: pr.GetBody(),
|
|
HeadRef: pr.GetHead().GetRef(),
|
|
BaseRef: pr.GetBase().GetRef(),
|
|
HeadSHA: pr.GetHead().GetSHA(),
|
|
BaseSHA: pr.GetBase().GetSHA(),
|
|
State: state,
|
|
}, nil
|
|
}
|
|
|
|
// ListReviews returns the reviews on a PR with ID > sinceID.
|
|
func (c *GitHubClient) ListReviews(ctx context.Context, owner, repo string, number int, sinceID int64) ([]Review, error) {
|
|
var out []Review
|
|
opts := &github.ListOptions{PerPage: 100}
|
|
for {
|
|
reviews, resp, err := c.gh.PullRequests.ListReviews(ctx, owner, repo, number, opts)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("list reviews %s/%s#%d: %w", owner, repo, number, err)
|
|
}
|
|
for _, r := range reviews {
|
|
if r.GetID() <= sinceID {
|
|
continue
|
|
}
|
|
out = append(out, Review{
|
|
ID: r.GetID(),
|
|
Author: r.GetUser().GetLogin(),
|
|
State: normalizeReviewState(r.GetState()),
|
|
SubmittedAt: r.GetSubmittedAt().Time,
|
|
})
|
|
}
|
|
if resp.NextPage == 0 {
|
|
break
|
|
}
|
|
opts.Page = resp.NextPage
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
// ListReviewComments returns the review comments on a PR with ID > sinceID.
|
|
func (c *GitHubClient) ListReviewComments(ctx context.Context, owner, repo string, number int, sinceID int64) ([]ReviewComment, error) {
|
|
var out []ReviewComment
|
|
opts := &github.PullRequestListCommentsOptions{PerPage: 100}
|
|
for {
|
|
comments, resp, err := c.gh.PullRequests.ListComments(ctx, owner, repo, number, opts)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("list review comments %s/%s#%d: %w", owner, repo, number, err)
|
|
}
|
|
for _, cm := range comments {
|
|
if cm.GetID() <= sinceID {
|
|
continue
|
|
}
|
|
line := cm.GetOriginalLine()
|
|
if line == 0 {
|
|
line = cm.GetLine()
|
|
}
|
|
out = append(out, ReviewComment{
|
|
ID: cm.GetID(),
|
|
Author: cm.GetUser().GetLogin(),
|
|
Body: cm.GetBody(),
|
|
Path: cm.GetPath(),
|
|
Line: line,
|
|
InReplyTo: cm.GetInReplyTo(),
|
|
CreatedAt: cm.GetCreatedAt().Time,
|
|
})
|
|
}
|
|
if resp.NextPage == 0 {
|
|
break
|
|
}
|
|
opts.Page = resp.NextPage
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
// ReplyToReview posts a reply to an existing review comment.
|
|
func (c *GitHubClient) ReplyToReview(ctx context.Context, owner, repo string, number int, commentID int64, body string) error {
|
|
if _, _, err := c.gh.PullRequests.CreateCommentInReplyTo(ctx, owner, repo, number, body, commentID); err != nil {
|
|
return fmt.Errorf("reply to review comment %d on %s/%s#%d: %w", commentID, owner, repo, number, err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// CloseIssue closes an issue with a final comment (feasibility "won't do").
|
|
func (c *GitHubClient) CloseIssue(ctx context.Context, owner, repo string, number int, comment string) error {
|
|
if comment != "" {
|
|
if _, err := c.Comment(ctx, owner, repo, number, comment); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
_, _, err := c.gh.Issues.Edit(ctx, owner, repo, number,
|
|
&github.IssueRequest{State: new("closed")})
|
|
return err
|
|
}
|
|
|
|
// LinkBranch associates a branch with an issue (GitHub stub -- Gitea is primary).
|
|
func (c *GitHubClient) LinkBranch(ctx context.Context, owner, repo string, issueNumber int, branch string) error {
|
|
return nil
|
|
}
|
|
|
|
// State labels mirror the task lifecycle onto the forge so archie's
|
|
// status is visible at a glance. SQLite remains the source of truth;
|
|
// labels are the human-facing projection -- and removing the parked
|
|
// label is the forge-native retry trigger.
|
|
// Label strings are configured via [dispatch.labels]; these are the
|
|
// built-in defaults used as a fallback when config is absent.
|
|
|
|
// stateLabelColors maps label name → colour for on-demand creation.
|
|
var stateLabelColors = map[string]string{
|
|
"archie:queued": "bfd4f2", // grey-blue
|
|
"archie:working": "1d76db", // blue
|
|
"archie:waiting": "fbca04", // yellow
|
|
"archie:pr": "0e8a16", // green
|
|
"archie:parked": "d93f0b", // orange-red
|
|
}
|
|
|
|
// defaultLabelColor is used for custom labels not in stateLabelColors.
|
|
const defaultLabelColor = "bfd4f2"
|
|
|
|
// React adds an emoji reaction to an issue -- the instant "received"
|
|
// acknowledgement on pickup.
|
|
func (c *GitHubClient) React(ctx context.Context, owner, repo string, number int, reaction string) error {
|
|
_, _, err := c.gh.Reactions.CreateIssueReaction(ctx, owner, repo, number, reaction)
|
|
return err
|
|
}
|
|
|
|
// ensureLabel creates the state label in the repo if it doesn't exist.
|
|
func (c *GitHubClient) ensureLabel(ctx context.Context, owner, repo, name string) {
|
|
key := owner + "/" + repo + "/" + name
|
|
c.labelMu.Lock()
|
|
seen := c.labelsEnsured[key]
|
|
c.labelMu.Unlock()
|
|
if seen {
|
|
return
|
|
}
|
|
color := stateLabelColors[name]
|
|
if color == "" {
|
|
color = defaultLabelColor
|
|
}
|
|
_, _, err := c.gh.Issues.CreateLabel(ctx, owner, repo, &github.Label{
|
|
Name: new(name),
|
|
Color: new(color),
|
|
Description: new("archie task state (managed automatically)"),
|
|
})
|
|
// 422 = already exists; both outcomes mean the label is available.
|
|
if err != nil && !strings.Contains(err.Error(), "already_exists") {
|
|
c.log.Warn("create label failed", "label", name, "err", err)
|
|
return
|
|
}
|
|
c.labelMu.Lock()
|
|
if c.labelsEnsured == nil {
|
|
c.labelsEnsured = map[string]bool{}
|
|
}
|
|
c.labelsEnsured[key] = true
|
|
c.labelMu.Unlock()
|
|
}
|
|
|
|
// SetStateLabel makes label the issue's only state label, removing any
|
|
// other label found in knownLabels first. An empty label clears all
|
|
// state labels (terminal states).
|
|
func (c *GitHubClient) SetStateLabel(ctx context.Context, owner, repo string, number int, label string, knownLabels []string) {
|
|
known := make(map[string]bool, len(knownLabels))
|
|
for _, l := range knownLabels {
|
|
known[l] = true
|
|
}
|
|
issue, _, err := c.gh.Issues.Get(ctx, owner, repo, number)
|
|
if err != nil {
|
|
c.log.Warn("set state label: get issue failed", "issue", number, "err", err)
|
|
return
|
|
}
|
|
for _, l := range issue.Labels {
|
|
name := l.GetName()
|
|
if name != label && known[name] {
|
|
if _, err := c.gh.Issues.RemoveLabelForIssue(ctx, owner, repo, number, name); err != nil {
|
|
c.log.Warn("remove state label failed", "label", name, "err", err)
|
|
}
|
|
}
|
|
if name == label {
|
|
label = "" // already present; nothing to add
|
|
}
|
|
}
|
|
if label == "" {
|
|
return
|
|
}
|
|
c.ensureLabel(ctx, owner, repo, label)
|
|
if _, _, err := c.gh.Issues.AddLabelsToIssue(ctx, owner, repo, number, []string{label}); err != nil {
|
|
c.log.Warn("add state label failed", "label", label, "err", err)
|
|
}
|
|
}
|
|
|
|
// VerifyPush confirms the token can push to the repo (permission check
|
|
// at startup so misconfiguration surfaces before any work is claimed).
|
|
func (c *GitHubClient) VerifyPush(ctx context.Context, owner, repo string) error {
|
|
r, _, err := c.gh.Repositories.Get(ctx, owner, repo)
|
|
if err != nil {
|
|
return fmt.Errorf("get repo %s/%s: %w", owner, repo, err)
|
|
}
|
|
perms := r.GetPermissions()
|
|
if !perms["push"] {
|
|
return fmt.Errorf("no push permission on %s/%s", owner, repo)
|
|
}
|
|
return nil
|
|
}
|