Add new Maintenance category to bd doctor with checks for: - Stale closed issues (older than 30 days) - Expired tombstones (older than TTL) - Compaction candidates (info only) Add fix handlers for cleanup and tombstone pruning via bd doctor --fix. Add deprecation hints to cleanup, compact, and detect-pollution commands suggesting users try bd doctor instead. This consolidation reduces cognitive load - users just need to remember 'bd doctor' for health checks and 'bd doctor --fix' for maintenance. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
227 lines
5.9 KiB
Go
227 lines
5.9 KiB
Go
package doctor
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"time"
|
|
|
|
"github.com/steveyegge/beads/internal/beads"
|
|
"github.com/steveyegge/beads/internal/configfile"
|
|
"github.com/steveyegge/beads/internal/storage/sqlite"
|
|
"github.com/steveyegge/beads/internal/types"
|
|
)
|
|
|
|
// DefaultCleanupAgeDays is the default age threshold for cleanup suggestions
|
|
const DefaultCleanupAgeDays = 30
|
|
|
|
// CheckStaleClosedIssues detects closed issues that could be cleaned up.
|
|
// This consolidates the cleanup command into doctor checks.
|
|
func CheckStaleClosedIssues(path string) DoctorCheck {
|
|
beadsDir := filepath.Join(path, ".beads")
|
|
|
|
// Check metadata.json first for custom database name
|
|
var dbPath string
|
|
if cfg, err := configfile.Load(beadsDir); err == nil && cfg != nil && cfg.Database != "" {
|
|
dbPath = cfg.DatabasePath(beadsDir)
|
|
} else {
|
|
dbPath = filepath.Join(beadsDir, beads.CanonicalDatabaseName)
|
|
}
|
|
|
|
if _, err := os.Stat(dbPath); os.IsNotExist(err) {
|
|
return DoctorCheck{
|
|
Name: "Stale Closed Issues",
|
|
Status: StatusOK,
|
|
Message: "N/A (no database)",
|
|
Category: CategoryMaintenance,
|
|
}
|
|
}
|
|
|
|
ctx := context.Background()
|
|
store, err := sqlite.New(ctx, dbPath)
|
|
if err != nil {
|
|
return DoctorCheck{
|
|
Name: "Stale Closed Issues",
|
|
Status: StatusOK,
|
|
Message: "N/A (unable to open database)",
|
|
Category: CategoryMaintenance,
|
|
}
|
|
}
|
|
defer func() { _ = store.Close() }()
|
|
|
|
// Find closed issues older than threshold
|
|
cutoff := time.Now().AddDate(0, 0, -DefaultCleanupAgeDays)
|
|
statusClosed := types.StatusClosed
|
|
filter := types.IssueFilter{
|
|
Status: &statusClosed,
|
|
ClosedBefore: &cutoff,
|
|
}
|
|
|
|
issues, err := store.SearchIssues(ctx, "", filter)
|
|
if err != nil {
|
|
return DoctorCheck{
|
|
Name: "Stale Closed Issues",
|
|
Status: StatusOK,
|
|
Message: "N/A (query failed)",
|
|
Category: CategoryMaintenance,
|
|
}
|
|
}
|
|
|
|
// Filter out pinned issues
|
|
var cleanable int
|
|
for _, issue := range issues {
|
|
if !issue.Pinned {
|
|
cleanable++
|
|
}
|
|
}
|
|
|
|
if cleanable == 0 {
|
|
return DoctorCheck{
|
|
Name: "Stale Closed Issues",
|
|
Status: StatusOK,
|
|
Message: "No stale closed issues",
|
|
Category: CategoryMaintenance,
|
|
}
|
|
}
|
|
|
|
return DoctorCheck{
|
|
Name: "Stale Closed Issues",
|
|
Status: StatusWarning,
|
|
Message: fmt.Sprintf("%d closed issue(s) older than %d days", cleanable, DefaultCleanupAgeDays),
|
|
Detail: "These issues can be cleaned up to reduce database size",
|
|
Fix: "Run 'bd doctor --fix' to cleanup, or 'bd cleanup --force' for more options",
|
|
Category: CategoryMaintenance,
|
|
}
|
|
}
|
|
|
|
// CheckExpiredTombstones detects tombstones that have exceeded their TTL.
|
|
func CheckExpiredTombstones(path string) DoctorCheck {
|
|
beadsDir := filepath.Join(path, ".beads")
|
|
jsonlPath := filepath.Join(beadsDir, "issues.jsonl")
|
|
|
|
if _, err := os.Stat(jsonlPath); os.IsNotExist(err) {
|
|
return DoctorCheck{
|
|
Name: "Expired Tombstones",
|
|
Status: StatusOK,
|
|
Message: "N/A (no JSONL file)",
|
|
Category: CategoryMaintenance,
|
|
}
|
|
}
|
|
|
|
// Read JSONL and count expired tombstones
|
|
file, err := os.Open(jsonlPath) // #nosec G304 - path constructed safely
|
|
if err != nil {
|
|
return DoctorCheck{
|
|
Name: "Expired Tombstones",
|
|
Status: StatusOK,
|
|
Message: "N/A (unable to read JSONL)",
|
|
Category: CategoryMaintenance,
|
|
}
|
|
}
|
|
defer file.Close()
|
|
|
|
var expiredCount int
|
|
decoder := json.NewDecoder(file)
|
|
ttl := types.DefaultTombstoneTTL
|
|
|
|
for {
|
|
var issue types.Issue
|
|
if err := decoder.Decode(&issue); err != nil {
|
|
break
|
|
}
|
|
issue.SetDefaults()
|
|
if issue.IsExpired(ttl) {
|
|
expiredCount++
|
|
}
|
|
}
|
|
|
|
if expiredCount == 0 {
|
|
return DoctorCheck{
|
|
Name: "Expired Tombstones",
|
|
Status: StatusOK,
|
|
Message: "No expired tombstones",
|
|
Category: CategoryMaintenance,
|
|
}
|
|
}
|
|
|
|
ttlDays := int(ttl.Hours() / 24)
|
|
return DoctorCheck{
|
|
Name: "Expired Tombstones",
|
|
Status: StatusWarning,
|
|
Message: fmt.Sprintf("%d tombstone(s) older than %d days", expiredCount, ttlDays),
|
|
Detail: "Expired tombstones can be pruned to reduce JSONL file size",
|
|
Fix: "Run 'bd doctor --fix' to prune, or 'bd cleanup --force' for more options",
|
|
Category: CategoryMaintenance,
|
|
}
|
|
}
|
|
|
|
// CheckCompactionCandidates detects issues eligible for compaction.
|
|
func CheckCompactionCandidates(path string) DoctorCheck {
|
|
beadsDir := filepath.Join(path, ".beads")
|
|
|
|
// Check metadata.json first for custom database name
|
|
var dbPath string
|
|
if cfg, err := configfile.Load(beadsDir); err == nil && cfg != nil && cfg.Database != "" {
|
|
dbPath = cfg.DatabasePath(beadsDir)
|
|
} else {
|
|
dbPath = filepath.Join(beadsDir, beads.CanonicalDatabaseName)
|
|
}
|
|
|
|
if _, err := os.Stat(dbPath); os.IsNotExist(err) {
|
|
return DoctorCheck{
|
|
Name: "Compaction Candidates",
|
|
Status: StatusOK,
|
|
Message: "N/A (no database)",
|
|
Category: CategoryMaintenance,
|
|
}
|
|
}
|
|
|
|
ctx := context.Background()
|
|
store, err := sqlite.New(ctx, dbPath)
|
|
if err != nil {
|
|
return DoctorCheck{
|
|
Name: "Compaction Candidates",
|
|
Status: StatusOK,
|
|
Message: "N/A (unable to open database)",
|
|
Category: CategoryMaintenance,
|
|
}
|
|
}
|
|
defer func() { _ = store.Close() }()
|
|
|
|
tier1, err := store.GetTier1Candidates(ctx)
|
|
if err != nil {
|
|
return DoctorCheck{
|
|
Name: "Compaction Candidates",
|
|
Status: StatusOK,
|
|
Message: "N/A (query failed)",
|
|
Category: CategoryMaintenance,
|
|
}
|
|
}
|
|
|
|
if len(tier1) == 0 {
|
|
return DoctorCheck{
|
|
Name: "Compaction Candidates",
|
|
Status: StatusOK,
|
|
Message: "No compaction candidates",
|
|
Category: CategoryMaintenance,
|
|
}
|
|
}
|
|
|
|
// Calculate total size
|
|
var totalSize int
|
|
for _, c := range tier1 {
|
|
totalSize += c.OriginalSize
|
|
}
|
|
|
|
return DoctorCheck{
|
|
Name: "Compaction Candidates",
|
|
Status: StatusOK, // Info only, not a warning
|
|
Message: fmt.Sprintf("%d issue(s) eligible for compaction (%d bytes)", len(tier1), totalSize),
|
|
Detail: "Compaction requires agent review; not auto-fixable",
|
|
Fix: "Run 'bd compact --analyze' to review candidates",
|
|
Category: CategoryMaintenance,
|
|
}
|
|
}
|