beads/internal/github/tracker_test.go
Kevin Glynn 9827c66319
fix(github): content-based dedup on push to stop re-PATCHing every issue (#4214) (#4329)
* fix(github): content-based dedup on push to stop re-PATCHing every issue

GitHub sync never wired engine.PushHooks, so `doPush` fell back to
timestamp-only dedup. Because linking and any local write bump a beads
issue's updated_at past GitHub's second-granularity updated_at, every
`github sync --push-only` / `github push` reconciled and PATCHed the
entire backlog on every run — O(N) REST calls that drain the shared
installation's primary rate limit even when nothing changed.

Add github.PushFieldsEqual, comparing only the fields a push mutates
(title, body, state, and the label set BeadsIssueToGitHubFields sends,
order-insensitive). Wire a ContentEqual push hook (buildGitHubPushHooks)
into both runGitHubSync and runGitHubPush so the engine skips issues
already in sync — mirroring the existing Linear/Jira push hooks.

Dry-run still makes 0 REST calls (unchanged); this targets the live
re-PATCH storm. A push-side incremental cursor to also avoid the
per-issue fetch is a noted follow-up.

Fixes #4214

Co-authored-by: Cursor <cursoragent@cursor.com>

* perf(sync): skip per-issue fetch on no-op push via persisted content hash

The ContentEqual hook added for #4214 stops the redundant PATCH but still
fetches every linked issue (one GET each), so a no-op `github sync --push-only`
still drains the REST rate limit. Add a ContentHash push hook: the engine
persists each issue's pushed content hash in the dolt-ignored local_metadata
table and consults it before FetchIssue. When the local content is unchanged
since the last push, the fetch and update are skipped entirely.

Also record the hash when ContentEqual reports a match (so the first
post-restart pass repopulates hashes) and consult it in dry-run, so an
unchanged issue previews as a skip instead of always reporting "Would update".

Refs gastownhall/beads#4214

Co-authored-by: Cursor <cursoragent@cursor.com>

* shrink(github): simplify PushContentHash framing and labelSetsEqual

Replace length-prefix binary framing in PushContentHash with NUL-separated
fields — the hash is only self-compared, so the simpler scheme is sufficient.
Replace hand-rolled counting map in labelSetsEqual with slices.Sort +
slices.Equal. Drop unused encoding/binary, strconv, sort imports in favor
of slices.

Agent-Signature: cursor-opus-4.6-unknown-reasoning on behalf of kevglynn
Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(sync): bind push cache to remote target

Agent-Signature: codex-gpt-5.6-sol-medium on behalf of matt wilkie

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: matt wilkie <maphew@gmail.com>
2026-08-02 22:53:06 -07:00

379 lines
11 KiB
Go

package github
import (
"context"
"os"
"path/filepath"
"strconv"
"testing"
"time"
"github.com/steveyegge/beads/internal/config"
"github.com/steveyegge/beads/internal/tracker"
"github.com/steveyegge/beads/internal/types"
)
func TestRegistered(t *testing.T) {
factory := tracker.Get("github")
if factory == nil {
t.Fatal("github tracker not registered")
}
tr := factory()
if tr.Name() != "github" {
t.Errorf("Name() = %q, want %q", tr.Name(), "github")
}
if tr.DisplayName() != "GitHub" {
t.Errorf("DisplayName() = %q, want %q", tr.DisplayName(), "GitHub")
}
if tr.ConfigPrefix() != "github" {
t.Errorf("ConfigPrefix() = %q, want %q", tr.ConfigPrefix(), "github")
}
}
func TestPushTargetScope(t *testing.T) {
tr := &Tracker{client: &Client{
BaseURL: "HTTPS://GHE.Example.Test/Api/v3///",
Owner: "Acme",
Repo: "Widgets",
}}
if got, want := tr.PushTargetScope(), "https://ghe.example.test/Api/v3/repos/acme/widgets"; got != want {
t.Fatalf("PushTargetScope() = %q, want %q", got, want)
}
equivalent := &Tracker{client: &Client{
BaseURL: "https://ghe.example.test/Api/v3",
Owner: "acme",
Repo: "widgets",
}}
if got, want := equivalent.PushTargetScope(), tr.PushTargetScope(); got != want {
t.Fatalf("equivalent PushTargetScope() = %q, want %q", got, want)
}
malformed := &Tracker{client: &Client{
BaseURL: "://GHE.Example.Test/Api/ ",
Owner: "ACME",
Repo: "WIDGETS",
}}
if got, want := malformed.PushTargetScope(), "://GHE.Example.Test/Api/repos/acme/widgets"; got != want {
t.Fatalf("malformed PushTargetScope() = %q, want deterministic fallback %q", got, want)
}
if got := (&Tracker{}).PushTargetScope(); got != "" {
t.Fatalf("uninitialized PushTargetScope() = %q, want empty", got)
}
}
func TestIsExternalRef(t *testing.T) {
tr := &Tracker{}
tests := []struct {
ref string
want bool
}{
{"https://github.com/org/repo/issues/42", true},
{"https://github.com/team/project/issues/123", true},
{"https://gitlab.com/group/project/-/issues/42", false},
{"https://linear.app/team/issue/PROJ-123", false},
{"", false},
// Shorthand format produced by BuildExternalRef
{"github:681509", true},
{"github:1", true},
{"github:abc", false},
{"github:123/extra", false},
{"github:0", false},
}
for _, tt := range tests {
if got := tr.IsExternalRef(tt.ref); got != tt.want {
t.Errorf("IsExternalRef(%q) = %v, want %v", tt.ref, got, tt.want)
}
}
}
func TestExtractIdentifier(t *testing.T) {
tr := &Tracker{}
tests := []struct {
ref string
want string
}{
{"https://github.com/org/repo/issues/42", "42"},
{"https://github.com/team/project/issues/123", "123"},
{"not-a-url", ""},
// Shorthand format
{"github:681509", "681509"},
{"github:1", "1"},
{"github:abc", ""},
}
for _, tt := range tests {
if got := tr.ExtractIdentifier(tt.ref); got != tt.want {
t.Errorf("ExtractIdentifier(%q) = %q, want %q", tt.ref, got, tt.want)
}
}
}
func TestBuildExternalRef(t *testing.T) {
tr := &Tracker{}
ti := &tracker.TrackerIssue{
URL: "https://github.com/org/repo/issues/42",
Identifier: "42",
}
ref := tr.BuildExternalRef(ti)
if ref != ti.URL {
t.Errorf("BuildExternalRef() = %q, want %q", ref, ti.URL)
}
// Without URL, should use fallback
ti2 := &tracker.TrackerIssue{
Identifier: "42",
}
ref2 := tr.BuildExternalRef(ti2)
if ref2 != "github:42" {
t.Errorf("BuildExternalRef() = %q, want %q", ref2, "github:42")
}
}
func TestFieldMapperStatus(t *testing.T) {
m := &githubFieldMapper{config: DefaultMappingConfig()}
if got := m.StatusToBeads("open"); got != types.StatusOpen {
t.Errorf("StatusToBeads(open) = %q, want %q", got, types.StatusOpen)
}
if got := m.StatusToBeads("closed"); got != types.StatusClosed {
t.Errorf("StatusToBeads(closed) = %q, want %q", got, types.StatusClosed)
}
}
func TestFieldMapperPriority(t *testing.T) {
m := &githubFieldMapper{config: DefaultMappingConfig()}
if got := m.PriorityToBeads("critical"); got != 0 {
t.Errorf("PriorityToBeads(critical) = %d, want 0", got)
}
if got := m.PriorityToBeads("high"); got != 1 {
t.Errorf("PriorityToBeads(high) = %d, want 1", got)
}
if got := m.PriorityToBeads("low"); got != 3 {
t.Errorf("PriorityToBeads(low) = %d, want 3", got)
}
}
func TestFieldMapperType(t *testing.T) {
m := &githubFieldMapper{config: DefaultMappingConfig()}
if got := m.TypeToBeads("bug"); got != types.TypeBug {
t.Errorf("TypeToBeads(bug) = %q, want %q", got, types.TypeBug)
}
if got := m.TypeToBeads("feature"); got != types.TypeFeature {
t.Errorf("TypeToBeads(feature) = %q, want %q", got, types.TypeFeature)
}
if got := m.TypeToBeads("unknown"); got != types.TypeTask {
t.Errorf("TypeToBeads(unknown) = %q, want %q (default)", got, types.TypeTask)
}
}
func TestGitHubToTrackerIssue(t *testing.T) {
now := time.Now()
gh := &Issue{
ID: 100,
Number: 42,
Title: "Fix pipeline",
Body: "CI is broken",
State: "open",
HTMLURL: "https://github.com/org/repo/issues/42",
Labels: []Label{
{Name: "bug"},
{Name: "priority::high"},
},
CreatedAt: &now,
UpdatedAt: &now,
Assignee: &User{ID: 5, Login: "bob"},
}
ti := githubToTrackerIssue(gh)
if ti.ID != "100" {
t.Errorf("ID = %q, want %q", ti.ID, "100")
}
if ti.Identifier != "42" {
t.Errorf("Identifier = %q, want %q", ti.Identifier, "42")
}
if ti.Assignee != "bob" {
t.Errorf("Assignee = %q, want %q", ti.Assignee, "bob")
}
if ti.AssigneeID != strconv.Itoa(5) {
t.Errorf("AssigneeID = %q, want %q", ti.AssigneeID, "5")
}
if ti.Raw != gh {
t.Error("Raw should reference original github.Issue")
}
if len(ti.Labels) != 2 {
t.Errorf("Labels count = %d, want 2", len(ti.Labels))
}
if ti.URL != "https://github.com/org/repo/issues/42" {
t.Errorf("URL = %q, want GitHub URL", ti.URL)
}
}
func TestGitHubToTrackerIssue_ClosedWithTimestamp(t *testing.T) {
now := time.Now()
closedAt := now.Add(-time.Hour)
gh := &Issue{
ID: 200,
Number: 99,
Title: "Closed issue",
State: "closed",
CreatedAt: &now,
UpdatedAt: &now,
ClosedAt: &closedAt,
HTMLURL: "https://github.com/org/repo/issues/99",
}
ti := githubToTrackerIssue(gh)
if ti.CompletedAt == nil {
t.Fatal("CompletedAt is nil for closed issue, want non-nil")
}
if !ti.CompletedAt.Equal(closedAt) {
t.Errorf("CompletedAt = %v, want %v", ti.CompletedAt, closedAt)
}
}
func TestFieldMapperIssueToBeads(t *testing.T) {
m := &githubFieldMapper{config: DefaultMappingConfig()}
now := time.Now()
gh := &Issue{
ID: 100,
Number: 42,
Title: "Test issue",
Body: "Test body",
State: "open",
Labels: []Label{
{Name: "type::bug"},
{Name: "priority::high"},
},
CreatedAt: &now,
UpdatedAt: &now,
HTMLURL: "https://github.com/org/repo/issues/42",
}
ti := &tracker.TrackerIssue{
ID: "100",
Identifier: "42",
Title: "Test issue",
Raw: gh,
}
conv := m.IssueToBeads(ti)
if conv == nil {
t.Fatal("IssueToBeads returned nil")
}
if conv.Issue == nil {
t.Fatal("IssueToBeads returned nil issue")
}
if conv.Issue.Title != "Test issue" {
t.Errorf("Issue.Title = %q, want %q", conv.Issue.Title, "Test issue")
}
if conv.Issue.IssueType != types.TypeBug {
t.Errorf("Issue.IssueType = %q, want %q", conv.Issue.IssueType, types.TypeBug)
}
}
func TestFieldMapperIssueToBeads_NilRaw(t *testing.T) {
m := &githubFieldMapper{config: DefaultMappingConfig()}
ti := &tracker.TrackerIssue{
ID: "100",
Raw: nil, // Not a *github.Issue
}
conv := m.IssueToBeads(ti)
if conv != nil {
t.Error("IssueToBeads with nil Raw should return nil")
}
}
// TestGetConfig_YamlOnlyKeyBypassesStore is a regression test for the bug where
// `bd github sync` errored "GitHub token not configured" even though the token
// was set in .beads/config.yaml. The github tracker's getConfig used to read
// every key from the Dolt store, but github.token is a yaml-only secret key
// (never written to the DB). The fix routes yaml-only keys through config.yaml
// and env var, skipping the store entirely.
//
// We verify the store-bypass by passing a nil store: before the fix this would
// panic on the store deref; after the fix it falls through to GITHUB_TOKEN.
func TestGetConfig_YamlOnlyKeyBypassesStore(t *testing.T) {
ctx := context.Background()
tr := &Tracker{store: nil}
t.Run("falls back to env var", func(t *testing.T) {
t.Setenv("GITHUB_TOKEN", "env-token-value")
got := tr.getConfig(ctx, "github.token", "GITHUB_TOKEN")
if got != "env-token-value" {
t.Errorf("getConfig(github.token) = %q, want %q", got, "env-token-value")
}
})
t.Run("returns empty when no value is set", func(t *testing.T) {
t.Setenv("GITHUB_TOKEN", "")
got := tr.getConfig(ctx, "github.token", "GITHUB_TOKEN")
if got != "" {
t.Errorf("getConfig(github.token) = %q, want empty", got)
}
})
}
// TestGetConfig_YamlOnlyKeyReadsFromYaml is the positive case for the fix:
// when github.token is present in .beads/config.yaml, getConfig must return
// that value (and not depend on GITHUB_TOKEN being set). This is the primary
// behavior the PR restores; the BypassesStore test only proves the env-var
// fallback path. Together they cover both branches of the yaml-only handler.
func TestGetConfig_YamlOnlyKeyReadsFromYaml(t *testing.T) {
const wantToken = "yaml-config-token-value"
tmpDir := t.TempDir()
beadsDir := filepath.Join(tmpDir, ".beads")
if err := os.MkdirAll(beadsDir, 0o750); err != nil {
t.Fatalf("mkdir .beads: %v", err)
}
yamlBody := "github.token: \"" + wantToken + "\"\n"
if err := os.WriteFile(filepath.Join(beadsDir, "config.yaml"), []byte(yamlBody), 0o600); err != nil {
t.Fatalf("write config.yaml: %v", err)
}
// Isolate from the developer's environment so we read only the temp yaml.
t.Setenv("GITHUB_TOKEN", "")
t.Setenv("BEADS_DIR", "")
t.Setenv("BEADS_TEST_IGNORE_REPO_CONFIG", "1")
t.Setenv("HOME", filepath.Join(tmpDir, "home"))
t.Setenv("XDG_CONFIG_HOME", filepath.Join(tmpDir, "xdg"))
t.Chdir(tmpDir)
config.ResetForTesting()
t.Cleanup(config.ResetForTesting)
if err := config.Initialize(); err != nil {
t.Fatalf("config.Initialize: %v", err)
}
// Sanity-check that the yaml actually loaded — otherwise a getConfig
// failure could be mistaken for a tracker bug.
if got := config.GetString("github.token"); got != wantToken {
t.Fatalf("config.GetString(github.token) = %q, want %q (yaml not loaded?)", got, wantToken)
}
tr := &Tracker{store: nil}
got := tr.getConfig(context.Background(), "github.token", "GITHUB_TOKEN")
if got != wantToken {
t.Errorf("getConfig(github.token) = %q, want %q (yaml value)", got, wantToken)
}
}
func TestValidate(t *testing.T) {
tr := &Tracker{}
if err := tr.Validate(); err == nil {
t.Error("Validate() on uninitialized tracker should return error")
}
tr.client = &Client{} // Set client
if err := tr.Validate(); err != nil {
t.Errorf("Validate() on initialized tracker returned error: %v", err)
}
}