Files
archie/internal/forge/review_writer_test.go
T
sam 4750ac097b feat(workflow): post line-anchored review comments with suggested fixes (#891)
* feat(workflow): post line-anchored review comments with suggested fixes

Bead archie-core-q9au (docs/prds/inline-review.md). A review's findings reached
the operator only as a flat list in the PR body, so the author had to map every
finding back to its line by hand and apply mechanical fixes by hand. Now the
line-anchored findings are also posted as inline review comments, carrying a
one-click suggestion when the reviewer could state the fix.

Domain (internal/domain/workflow):
- ReviewFinding gains Suggestion; Validate rejects one on anything but a
  confirmed finding, so the agent's record_finding call is refused with
  something it can act on. Validate splits into validateAnchor /
  validateClassification / validateDisposition, which also brings it back under
  the cyclop limit the gate enforces.
- StagePostReviewComments runs after StageOpenPR in the implement workflow. It
  posts only line-anchored findings (Line > 0); a whole-file finding has no line
  to attach to and stays in the body list, which remains the complete record.
  It is best-effort: the PR is open and the body already lists every finding, so
  a failed comment is logged, never a park -- the same reasoning as OpenPR's
  existing best-effort LinkBranch call.
- The suggestion fence is gated on Verdict == confirmed where the fence is
  written, because it is a one-click apply: a wrong suggestion breaks the code
  and the author has to notice.

Forge (internal/forge): ReviewCommentWriter + GitHub/Gitea implementations,
type-asserted like PullRequestReader so a forge that cannot is skipped rather
than faked (NoopForge is pinned as not satisfying it). GitHub loops one
CreateComment per comment and joins the failures, so one refused anchor cannot
drop the rest; Gitea carries them on a single COMMENT-state review.

Two deliberate departures from the PRD's sketch, both recorded in it:
- The interface is batch (CreateReviewComments), not one call per comment:
  Gitea's only inline shape is one submitted review, and the set then crosses
  NATS once instead of once per finding.
- The head SHA is resolved inside each forge implementation rather than by the
  caller. The stage runs in archie-agent, which holds no forge credentials and
  has no PullRequestReader; the daemon-side forgerpc handler is the only place
  that does.

Transport (internal/forgerpc): workflow.Forger gains the method, so the agent
reaches the daemon over the new create_review_comments subject; the server
type-asserts the writer and answers an incapable forge with an error the stage
logs. This is the one proxied method whose absence on an image skew does not
park a task.

The reviewer prompt and record_finding schema ask for a suggestion on a
confirmed, mechanically fixable defect only.

Regenerating the wfextract symbol table -- the documented way a new exported
workflow symbol reaches interpreted stage plugins -- also picked up symbols that
were missing from the committed table (the Status* and Source* constants,
ReviewCheck, Store, Task, and the _Store wrapper). Nil-guards were re-applied to
every wrapper afterwards, as that file's header requires.

Evidence: task check exit 0 (incl. 229 UI tests). Three mutations of the new
stage logic each fail a test that names the behaviour -- dropping the
confirmed-only gate, dropping the Line > 0 filter, and letting a posting failure
escape -- so the tests discriminate rather than passing vacuously.

* fix(build): drop the Dockerfile pin assertion

The guard fetched golangci-lint's go.mod at image build time to fail the build
when GOLANGCI_LINT_VERSION and GOFUMPT_VERSION disagreed. It only ever tripped
on self-inflicted pin drift, but it added a network fetch and a new failure
mode to the release build, which is not where that belongs.

The pins stay correct (golangci-lint 2.13.2, whose vendored gofumpt v0.11.0
equals GOFUMPT_VERSION) and the comment above them still states the invariant,
so the reasoning survives without the build-time machinery. The pin change
itself reaches the agent image through the normal release path: CI rebuilds
and pushes archie-agent on an archie/vX.Y.Z release, and a gateway-only
release deliberately does not.

* feat(workflow): add the remediate workflow for PR review remediation

Implements step 5 of docs/prds/pr-review-remediation.md: a remediate
workflow that resumes the task's existing worktree onto its PR branch
(worktree.Manager.Resume, not Prepare's refresh), runs a builder agent
against the review's actionable comments, commits and pushes to the
same branch, and replies via the forge's ReplyToReview. Task.RetryCount
doubles as the remediation round counter, capped by the repo's
max_retries; the round-cap stage parks the task and posts one comment
when it's hit.

Task gains a ReviewPayload field (JSON-encoded review unit) with full
store/proto/staterpc plumbing. workflow.Forger gains Comment and
ReplyToReview, proxied to archie-agent via a new forgerpc RPC. Resume
and its Dir lookup are added as an unexported optional Trees capability
rather than widening the exported interface, which is already at
golangci-lint's interfacebloat cap and is projected into wfextract's
Yaegi symbol table for repository-authored stage plugins.

The daemon-side reaction consumer that dispatches into this workflow
(subscribing ARCHIE_REACTIONS, grouping comments by review, enforcing
per-task serialization) is tracked separately in archie-core-8li9.4.

* feat(messaging): extract standalone messaging service binary and process composition

* feat(messaging): adapt channel frontends to consume Gateway ChatContract

* feat(messaging): remove in-process channels and Router from daemon bootstrap

Telegram, email and webhook now run only in the Messaging Service, which
reaches this process through the Gateway's ChatContract. The daemon builds
no channel and no gateway.Router, so the wiring that existed only to serve
them goes with it: setupGateways, setupEmailGateway, setupWebhookGateway,
setupTelegramGateway, buildTelegramRouter, makeTelegramReload and the
release-announcement path helper.

The seams those paths owned move to where they can still be honoured:

- Channel ValidateConfig runs in archiemessaging.compose, which now returns
  an error, so a configured-but-invalid front-end fails the service rather
  than being dropped silently.
- The inbound rate limiter moves to the Gateway process, which owns the only
  Router and therefore the only place a per-sender budget applies to every
  channel's turns.
- The daemon's gateway readiness probe becomes a ContractProbe against the
  Gateway. It cannot observe a channel lifecycle it no longer runs, and a
  channel-count probe would have reported every daemon degraded.
- telegramSetup is now chatSetup (in chat_setup.go), trimmed to the fields a
  chat turn runner actually reads.

Telegram operator features that were wired only in the daemon (/update,
release announcements, version reporting, SIGHUP reload) are not yet wired
in the Messaging Service: archie-core-8cda.6.6. Channel lifecycle reporting:
archie-core-8cda.6.8. The Gateway process builds no worktree manager, so
review_pr is unadvertised on every channel: archie-core-8cda.6.7.

* feat(messaging): re-wire the Telegram operator surface in the Messaging Service

setupTelegramGateway satisfied eight telegram.Gateway seams from the daemon's
own process. Each is resolved by where the fact it needs is owned, not by
where it used to be built; the decision table is in
docs/architecture/migration-decisions.md.

Wired here: /update (built from this service's own [chat.telegram] check and
install commands), the update-report relay (same sha256(bot_user)[:8] path the
daemon wrote, so a pending report is found rather than written afresh),
show_tool_calls, and /restart's config reload, which re-resolves the token and
allowlist from this service's own file and refuses a reload that resolves to
an empty token.

/version is sourced from the Gateway: ChatSnapshot gains a Version field
carrying the Gateway's rendered build block, read per call and bounded by the
dependency timeout. cmd/archie-messaging deliberately takes no version
ldflags, so it cannot report a partial upgrade as a matched one.

RunningVersions and ReleaseAnnouncements stay nil. Both need a component's
real running version, and the only versions this process can obtain are a
different binary's stamps -- reporting them would manufacture exactly the
false success the update check exists to catch, and the announcer without
parseable versions is a no-op that reads as configured. archie-core-8cda.6.9
carries the contract that unblocks them. Dangerous stays nil: no composition
has ever supplied a command authority.

Enrich is dropped from the update service: componentInstallTypeEnricher read
[nats], which this service must not decode, so the check command's own
reported install type stands.

* fix(workflow): guard inline review comments against head drift

Two findings from the review of q9au.

A comment's line numbers describe exactly one revision of the branch, but the
forge resolved the pull request's head at posting time -- after the review had
already read the worktree. A push in that window (a collaborator, a retry) meant
the findings were anchored to whatever now occupied those lines, mislabelling
instead of failing. The revision the review measured now travels with the
comment set: OpenPR records it from the same worktree read it already performs
(TaskContext.ReviewedHeadSHA), StagePostReviewComments threads it through
Forger to forgerpc, and the forge refuses the whole set once the head it reads
has moved off it -- which the best-effort stage logs, the PR body remaining the
record. An unmeasured revision posts unverified rather than dropping every
finding, so a worktree that cannot report one degrades instead of regressing.

Suggestion was documented single-line only, because GitHub applies a suggestion
fence up to its first line and a multi-line replacement would silently corrupt
the file. Only the verdict was validated, so a multi-line suggestion reached the
renderer and posted as that truncated fence. Validate now rejects an embedded
newline, which makes record_finding refuse it with feedback the model can act on
instead of the reviewer discovering the corruption later.
2026-09-19 23:37:23 +10:00

262 lines
10 KiB
Go

package forge
import (
"context"
"encoding/json"
"net/http"
"strings"
"testing"
)
func TestGitHubCreateReviewComments(t *testing.T) {
c, mux := newTestClient(t)
// The head SHA is deliberately not "headsha": the comments are anchored to
// the revision the forge reports for the pull request, never to a value the
// caller supplied. The caller's reviewed revision gates the posting, it is
// not the anchor itself.
mux.HandleFunc("GET /repos/o/r/pulls/7", func(w http.ResponseWriter, r *http.Request) {
writeJSON(t, w, map[string]any{
"number": 7, "title": "Add widget", "state": "open",
"head": map[string]any{"ref": "feature/widget", "sha": "pulled-head-sha"},
"base": map[string]any{"ref": "main", "sha": "basesha"},
})
})
var got []map[string]any
mux.HandleFunc("POST /repos/o/r/pulls/7/comments", func(w http.ResponseWriter, r *http.Request) {
var body map[string]any
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
t.Fatal(err)
}
got = append(got, body)
writeJSON(t, w, map[string]any{"id": 1})
})
comments := []InlineReviewComment{
{Path: "a.go", Line: 12, Body: "nil deref"},
{Path: "b.go", Line: 3, Body: "```suggestion\nfixed\n```"},
}
if err := c.CreateReviewComments(t.Context(), "o", "r", 7, "pulled-head-sha", comments); err != nil {
t.Fatal(err)
}
if len(got) != 2 {
t.Fatalf("posted %d comments, want 2", len(got))
}
if got[0]["path"] != "a.go" || got[0]["line"] != float64(12) || got[0]["side"] != "RIGHT" {
t.Errorf("comment[0] = %v, want path=a.go line=12 side=RIGHT", got[0])
}
if got[0]["commit_id"] != "pulled-head-sha" {
t.Errorf("comment[0].commit_id = %v, want the head pull requests.Get reported", got[0]["commit_id"])
}
if got[1]["body"] != "```suggestion\nfixed\n```" {
t.Errorf("comment[1].body = %v, want the suggestion block preserved", got[1]["body"])
}
}
// TestGitHubCreateReviewCommentsKeepsGoingAfterARefusal pins that one comment
// GitHub will not accept -- a line outside the diff, a file the push renamed --
// cannot silently drop the comments after it.
func TestGitHubCreateReviewCommentsKeepsGoingAfterARefusal(t *testing.T) {
c, mux := newTestClient(t)
mux.HandleFunc("GET /repos/o/r/pulls/7", func(w http.ResponseWriter, r *http.Request) {
writeJSON(t, w, map[string]any{
"number": 7, "state": "open",
"head": map[string]any{"ref": "f", "sha": "headsha"},
"base": map[string]any{"ref": "main", "sha": "basesha"},
})
})
attempts := 0
mux.HandleFunc("POST /repos/o/r/pulls/7/comments", func(w http.ResponseWriter, r *http.Request) {
attempts++
if attempts == 1 {
w.WriteHeader(http.StatusUnprocessableEntity)
return
}
writeJSON(t, w, map[string]any{"id": 2})
})
err := c.CreateReviewComments(t.Context(), "o", "r", 7, "headsha", []InlineReviewComment{
{Path: "a.go", Line: 1, Body: "refused"},
{Path: "b.go", Line: 2, Body: "accepted"},
})
if err == nil {
t.Error("CreateReviewComments error = nil, want the refused comment surfaced")
}
if attempts != 2 {
t.Errorf("attempted %d comments, want 2: a refusal must not abandon the rest", attempts)
}
}
// TestGitHubCreateReviewCommentsRefusesAnEmptyHeadSHA guards the anchor itself.
// An empty commit_id makes GitHub reject every comment with nothing that says
// why, so it fails before the first request instead.
func TestGitHubCreateReviewCommentsRefusesAnEmptyHeadSHA(t *testing.T) {
c, mux := newTestClient(t)
mux.HandleFunc("GET /repos/o/r/pulls/7", func(w http.ResponseWriter, r *http.Request) {
writeJSON(t, w, map[string]any{
"number": 7, "state": "open",
"head": map[string]any{"ref": "f"}, "base": map[string]any{"ref": "main", "sha": "basesha"},
})
})
posted := false
mux.HandleFunc("POST /repos/o/r/pulls/7/comments", func(w http.ResponseWriter, r *http.Request) {
posted = true
writeJSON(t, w, map[string]any{"id": 1})
})
err := c.CreateReviewComments(t.Context(), "o", "r", 7, "reviewed-sha", []InlineReviewComment{{Path: "a.go", Line: 1, Body: "x"}})
if err == nil {
t.Fatal("CreateReviewComments error = nil, want a missing-head-sha error")
}
if posted {
t.Error("a comment was posted despite no head sha to anchor it to")
}
}
// TestGitHubCreateReviewCommentsRefusesAMovedHead is the q9au drift guard. The
// line numbers in a finding describe one revision; if the pull request's head
// has moved since the review, GitHub anchors a line number against the CURRENT
// file and attaches the comment to whatever now occupies that line rather than
// failing. So the set is refused before the first comment is attempted, and the
// PR body remains the record.
func TestGitHubCreateReviewCommentsRefusesAMovedHead(t *testing.T) {
c, mux := newTestClient(t)
mux.HandleFunc("GET /repos/o/r/pulls/7", func(w http.ResponseWriter, r *http.Request) {
writeJSON(t, w, map[string]any{
"number": 7, "state": "open",
"head": map[string]any{"ref": "f", "sha": "moved-head-sha"},
"base": map[string]any{"ref": "main", "sha": "basesha"},
})
})
posted := false
mux.HandleFunc("POST /repos/o/r/pulls/7/comments", func(w http.ResponseWriter, r *http.Request) {
posted = true
writeJSON(t, w, map[string]any{"id": 1})
})
err := c.CreateReviewComments(t.Context(), "o", "r", 7, "reviewed-sha", []InlineReviewComment{{Path: "a.go", Line: 12, Body: "nil deref"}})
if err == nil {
t.Fatal("CreateReviewComments error = nil, want a refusal for a head that moved off the reviewed revision")
}
if !strings.Contains(err.Error(), "reviewed-sha") || !strings.Contains(err.Error(), "moved-head-sha") {
t.Errorf("error = %v, want it to name both revisions so an operator can tell what moved", err)
}
if posted {
t.Error("a comment was anchored to a revision its line numbers were not measured on")
}
}
func TestGiteaCreateReviewComments(t *testing.T) {
c, mux := newTestGiteaClient(t)
mux.HandleFunc("GET /api/v1/repos/o/r/pulls/7", func(w http.ResponseWriter, r *http.Request) {
writeJSON(t, w, map[string]any{
"number": 7, "title": "Add widget", "state": "open", "merged": false,
"head": map[string]any{"ref": "feature/widget", "sha": "pulled-head-sha"},
"base": map[string]any{"ref": "main", "sha": "basesha"},
})
})
var got map[string]any
mux.HandleFunc("POST /api/v1/repos/o/r/pulls/7/reviews", func(w http.ResponseWriter, r *http.Request) {
if err := json.NewDecoder(r.Body).Decode(&got); err != nil {
t.Fatal(err)
}
writeJSON(t, w, map[string]any{"id": 1})
})
comments := []InlineReviewComment{
{Path: "a.go", Line: 12, Body: "nil deref"},
{Path: "b.go", Line: 3, Body: "race"},
}
if err := c.CreateReviewComments(t.Context(), "o", "r", 7, "pulled-head-sha", comments); err != nil {
t.Fatal(err)
}
// Gitea carries inline comments on one COMMENT-state review.
if got["event"] != "COMMENT" || got["commit_id"] != "pulled-head-sha" {
t.Errorf("review = %v, want event=COMMENT and the reported head sha", got)
}
posted, _ := got["comments"].([]any)
if len(posted) != 2 {
t.Fatalf("review carried %d comments, want 2", len(posted))
}
first, _ := posted[0].(map[string]any)
if first["path"] != "a.go" || first["new_position"] != float64(12) {
t.Errorf("comments[0] = %v, want path=a.go new_position=12", first)
}
}
func TestGiteaCreateReviewCommentsRefusesAnEmptyHeadSHA(t *testing.T) {
c, mux := newTestGiteaClient(t)
mux.HandleFunc("GET /api/v1/repos/o/r/pulls/7", func(w http.ResponseWriter, r *http.Request) {
writeJSON(t, w, map[string]any{
"number": 7, "state": "open", "merged": false,
"head": map[string]any{"ref": "f"}, "base": map[string]any{"ref": "main", "sha": "basesha"},
})
})
reviewed := false
mux.HandleFunc("POST /api/v1/repos/o/r/pulls/7/reviews", func(w http.ResponseWriter, r *http.Request) {
reviewed = true
writeJSON(t, w, map[string]any{"id": 1})
})
err := c.CreateReviewComments(t.Context(), "o", "r", 7, "reviewed-sha", []InlineReviewComment{{Path: "a.go", Line: 1, Body: "x"}})
if err == nil {
t.Fatal("CreateReviewComments error = nil, want a missing-head-sha error")
}
if reviewed {
t.Error("a review was submitted despite no head sha to anchor it to")
}
}
// TestGiteaCreateReviewCommentsRefusesAMovedHead is the Gitea half of the q9au
// drift guard: the same refusal, reached before the review is submitted, because
// Gitea's inline comments live on that one review and a wrong line is applied
// with one click.
func TestGiteaCreateReviewCommentsRefusesAMovedHead(t *testing.T) {
c, mux := newTestGiteaClient(t)
mux.HandleFunc("GET /api/v1/repos/o/r/pulls/7", func(w http.ResponseWriter, r *http.Request) {
writeJSON(t, w, map[string]any{
"number": 7, "state": "open", "merged": false,
"head": map[string]any{"ref": "f", "sha": "moved-head-sha"},
"base": map[string]any{"ref": "main", "sha": "basesha"},
})
})
reviewed := false
mux.HandleFunc("POST /api/v1/repos/o/r/pulls/7/reviews", func(w http.ResponseWriter, r *http.Request) {
reviewed = true
writeJSON(t, w, map[string]any{"id": 1})
})
err := c.CreateReviewComments(t.Context(), "o", "r", 7, "reviewed-sha", []InlineReviewComment{{Path: "a.go", Line: 12, Body: "nil deref"}})
if err == nil {
t.Fatal("CreateReviewComments error = nil, want a refusal for a head that moved off the reviewed revision")
}
if reviewed {
t.Error("a review was submitted against a revision its line numbers were not measured on")
}
}
// TestReviewCommentWriterIsOptional pins the degrade path the forgerpc server
// relies on: a forge that cannot post inline comments must not satisfy the
// interface, so the caller is told rather than handed a silent no-op.
func TestReviewCommentWriterIsOptional(t *testing.T) {
if _, ok := any(&NoopForge{}).(ReviewCommentWriter); ok {
t.Error("NoopForge satisfies ReviewCommentWriter; the capability must be absent, not faked")
}
for _, c := range []any{&GitHubClient{}, &GiteaClient{}} {
if _, ok := c.(ReviewCommentWriter); !ok {
t.Errorf("%T does not satisfy ReviewCommentWriter", c)
}
}
}
// Compile-time guard: the workflow stage reaches this through a Forger whose
// signature carries the domain's own comment value, so the conversion is the
// caller's. The interface carries the revision the caller MEASURED, never a
// commit to anchor to: the anchor stays a per-forge detail (GitHub pins
// commit_id, Gitea anchors the review), while the caller's revision is only ever
// compared against the head the forge reads for itself.
var _ = func(ctx context.Context, c ReviewCommentWriter) error {
return c.CreateReviewComments(ctx, "o", "r", 1, "reviewed-sha", nil)
}