e9be35e374
* refactor(doctor): split doctor.go into modular package files Split the 3,171-line doctor.go into logical sub-files within the cmd/bd/doctor/ package, reducing the main file to 834 lines (74% reduction). New package structure: - types.go: DoctorCheck struct and status constants - installation.go: CheckInstallation, CheckMultipleDatabases, CheckPermissions - git.go: CheckGitHooks, CheckMergeDriver, CheckSyncBranch* checks - database.go: CheckDatabaseVersion, CheckSchemaCompatibility, CheckDatabaseJSONLSync - version.go: CheckCLIVersion, CheckMetadataVersionTracking, CompareVersions - integrity.go: CheckIDFormat, CheckDependencyCycles, CheckTombstones - daemon.go: CheckDaemonStatus, CheckVersionMismatch - quick.go: Quick checks for sync-branch and hooks Updated tests to use exported doctor.CheckXxx() functions and doctor.StatusXxx constants. * fix(doctor): suppress gosec G204 false positives Add #nosec G204 comments to exec.Command calls in CheckSyncBranchHealth where variables come from trusted sources (config files or hardcoded values like "main"/"master"/"origin"), not untrusted user input.
504 lines
17 KiB
Go
504 lines
17 KiB
Go
package doctor
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"os/exec"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/steveyegge/beads/cmd/bd/doctor/fix"
|
|
"github.com/steveyegge/beads/internal/git"
|
|
"github.com/steveyegge/beads/internal/syncbranch"
|
|
)
|
|
|
|
// CheckGitHooks verifies that recommended git hooks are installed.
|
|
func CheckGitHooks() DoctorCheck {
|
|
// Check if we're in a git repository using worktree-aware detection
|
|
gitDir, err := git.GetGitDir()
|
|
if err != nil {
|
|
return DoctorCheck{
|
|
Name: "Git Hooks",
|
|
Status: StatusOK,
|
|
Message: "N/A (not a git repository)",
|
|
}
|
|
}
|
|
|
|
// Recommended hooks and their purposes
|
|
recommendedHooks := map[string]string{
|
|
"pre-commit": "Flushes pending bd changes to JSONL before commit",
|
|
"post-merge": "Imports updated JSONL after git pull/merge",
|
|
"pre-push": "Exports database to JSONL before push",
|
|
}
|
|
|
|
hooksDir := filepath.Join(gitDir, "hooks")
|
|
var missingHooks []string
|
|
var installedHooks []string
|
|
|
|
for hookName := range recommendedHooks {
|
|
hookPath := filepath.Join(hooksDir, hookName)
|
|
if _, err := os.Stat(hookPath); os.IsNotExist(err) {
|
|
missingHooks = append(missingHooks, hookName)
|
|
} else {
|
|
installedHooks = append(installedHooks, hookName)
|
|
}
|
|
}
|
|
|
|
if len(missingHooks) == 0 {
|
|
return DoctorCheck{
|
|
Name: "Git Hooks",
|
|
Status: StatusOK,
|
|
Message: "All recommended hooks installed",
|
|
Detail: fmt.Sprintf("Installed: %s", strings.Join(installedHooks, ", ")),
|
|
}
|
|
}
|
|
|
|
hookInstallMsg := "Install hooks with 'bd hooks install'. See https://github.com/steveyegge/beads/tree/main/examples/git-hooks for installation instructions"
|
|
|
|
if len(installedHooks) > 0 {
|
|
return DoctorCheck{
|
|
Name: "Git Hooks",
|
|
Status: StatusWarning,
|
|
Message: fmt.Sprintf("Missing %d recommended hook(s)", len(missingHooks)),
|
|
Detail: fmt.Sprintf("Missing: %s", strings.Join(missingHooks, ", ")),
|
|
Fix: hookInstallMsg,
|
|
}
|
|
}
|
|
|
|
return DoctorCheck{
|
|
Name: "Git Hooks",
|
|
Status: StatusWarning,
|
|
Message: "No recommended git hooks installed",
|
|
Detail: fmt.Sprintf("Recommended: %s", strings.Join([]string{"pre-commit", "post-merge", "pre-push"}, ", ")),
|
|
Fix: hookInstallMsg,
|
|
}
|
|
}
|
|
|
|
// CheckSyncBranchHookCompatibility checks if pre-push hook is compatible with sync-branch mode.
|
|
// When sync-branch is configured, the pre-push hook must have the sync-branch bypass logic
|
|
// (added in version 0.29.0). Without it, users experience circular "bd sync" failures (issue #532).
|
|
func CheckSyncBranchHookCompatibility(path string) DoctorCheck {
|
|
// Check if sync-branch is configured
|
|
syncBranch := syncbranch.GetFromYAML()
|
|
if syncBranch == "" {
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Hook Compatibility",
|
|
Status: StatusOK,
|
|
Message: "N/A (sync-branch not configured)",
|
|
}
|
|
}
|
|
|
|
// sync-branch is configured - check pre-push hook version
|
|
// Get actual git directory (handles worktrees where .git is a file)
|
|
cmd := exec.Command("git", "rev-parse", "--git-dir")
|
|
cmd.Dir = path
|
|
output, err := cmd.Output()
|
|
if err != nil {
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Hook Compatibility",
|
|
Status: StatusOK,
|
|
Message: "N/A (not a git repository)",
|
|
}
|
|
}
|
|
gitDir := strings.TrimSpace(string(output))
|
|
if !filepath.IsAbs(gitDir) {
|
|
gitDir = filepath.Join(path, gitDir)
|
|
}
|
|
|
|
// Check for pre-push hook in standard location or shared hooks location
|
|
var hookPath string
|
|
|
|
// First check if core.hooksPath is configured (shared hooks)
|
|
hooksPathCmd := exec.Command("git", "config", "--get", "core.hooksPath")
|
|
hooksPathCmd.Dir = path
|
|
if hooksPathOutput, err := hooksPathCmd.Output(); err == nil {
|
|
sharedHooksDir := strings.TrimSpace(string(hooksPathOutput))
|
|
if !filepath.IsAbs(sharedHooksDir) {
|
|
sharedHooksDir = filepath.Join(path, sharedHooksDir)
|
|
}
|
|
hookPath = filepath.Join(sharedHooksDir, "pre-push")
|
|
} else {
|
|
// Use standard .git/hooks location
|
|
hookPath = filepath.Join(gitDir, "hooks", "pre-push")
|
|
}
|
|
|
|
hookContent, err := os.ReadFile(hookPath) // #nosec G304 - path is controlled
|
|
if err != nil {
|
|
// No pre-push hook installed - different issue, covered by checkGitHooks
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Hook Compatibility",
|
|
Status: StatusOK,
|
|
Message: "N/A (no pre-push hook installed)",
|
|
}
|
|
}
|
|
|
|
// Check if this is a bd hook and extract version
|
|
hookStr := string(hookContent)
|
|
if !strings.Contains(hookStr, "bd-hooks-version:") {
|
|
// Not a bd hook - can't determine compatibility
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Hook Compatibility",
|
|
Status: StatusWarning,
|
|
Message: "Pre-push hook is not a bd hook",
|
|
Detail: "Cannot verify sync-branch compatibility with custom hooks",
|
|
}
|
|
}
|
|
|
|
// Extract version from hook
|
|
var hookVersion string
|
|
for _, line := range strings.Split(hookStr, "\n") {
|
|
if strings.Contains(line, "bd-hooks-version:") {
|
|
parts := strings.SplitN(line, ":", 2)
|
|
if len(parts) == 2 {
|
|
hookVersion = strings.TrimSpace(parts[1])
|
|
}
|
|
break
|
|
}
|
|
}
|
|
|
|
if hookVersion == "" {
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Hook Compatibility",
|
|
Status: StatusWarning,
|
|
Message: "Could not determine pre-push hook version",
|
|
Detail: "Cannot verify sync-branch compatibility",
|
|
Fix: "Run 'bd hooks install --force' to update hooks",
|
|
}
|
|
}
|
|
|
|
// MinSyncBranchHookVersion added sync-branch bypass logic
|
|
// If hook version < MinSyncBranchHookVersion, it will cause circular "bd sync" failures
|
|
if CompareVersions(hookVersion, MinSyncBranchHookVersion) < 0 {
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Hook Compatibility",
|
|
Status: StatusError,
|
|
Message: fmt.Sprintf("Pre-push hook incompatible with sync-branch mode (version %s)", hookVersion),
|
|
Detail: fmt.Sprintf("Hook version %s lacks sync-branch bypass (requires %s+). This causes circular 'bd sync' failures during push.", hookVersion, MinSyncBranchHookVersion),
|
|
Fix: "Run 'bd hooks install --force' to update hooks",
|
|
}
|
|
}
|
|
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Hook Compatibility",
|
|
Status: StatusOK,
|
|
Message: fmt.Sprintf("Pre-push hook compatible with sync-branch (version %s)", hookVersion),
|
|
}
|
|
}
|
|
|
|
// CheckMergeDriver verifies that the git merge driver is correctly configured.
|
|
func CheckMergeDriver(path string) DoctorCheck {
|
|
// Check if we're in a git repository using worktree-aware detection
|
|
_, err := git.GetGitDir()
|
|
if err != nil {
|
|
return DoctorCheck{
|
|
Name: "Git Merge Driver",
|
|
Status: StatusOK,
|
|
Message: "N/A (not a git repository)",
|
|
}
|
|
}
|
|
|
|
// Get current merge driver configuration
|
|
cmd := exec.Command("git", "config", "merge.beads.driver")
|
|
cmd.Dir = path
|
|
output, err := cmd.Output()
|
|
if err != nil {
|
|
// Merge driver not configured
|
|
return DoctorCheck{
|
|
Name: "Git Merge Driver",
|
|
Status: StatusWarning,
|
|
Message: "Git merge driver not configured",
|
|
Fix: "Run 'bd init' to configure the merge driver, or manually: git config merge.beads.driver \"bd merge %A %O %A %B\"",
|
|
}
|
|
}
|
|
|
|
currentConfig := strings.TrimSpace(string(output))
|
|
correctConfig := "bd merge %A %O %A %B"
|
|
|
|
// Check if using old incorrect placeholders
|
|
if strings.Contains(currentConfig, "%L") || strings.Contains(currentConfig, "%R") {
|
|
return DoctorCheck{
|
|
Name: "Git Merge Driver",
|
|
Status: StatusError,
|
|
Message: fmt.Sprintf("Incorrect merge driver config: %q (uses invalid %%L/%%R placeholders)", currentConfig),
|
|
Detail: "Git only supports %O (base), %A (current), %B (other). Using %L/%R causes merge failures.",
|
|
Fix: "Run 'bd doctor --fix' to update to correct config, or manually: git config merge.beads.driver \"bd merge %A %O %A %B\"",
|
|
}
|
|
}
|
|
|
|
// Check if config is correct
|
|
if currentConfig != correctConfig {
|
|
return DoctorCheck{
|
|
Name: "Git Merge Driver",
|
|
Status: StatusWarning,
|
|
Message: fmt.Sprintf("Non-standard merge driver config: %q", currentConfig),
|
|
Detail: fmt.Sprintf("Expected: %q", correctConfig),
|
|
Fix: fmt.Sprintf("Run 'bd doctor --fix' to update config, or manually: git config merge.beads.driver \"%s\"", correctConfig),
|
|
}
|
|
}
|
|
|
|
return DoctorCheck{
|
|
Name: "Git Merge Driver",
|
|
Status: StatusOK,
|
|
Message: "Correctly configured",
|
|
Detail: currentConfig,
|
|
}
|
|
}
|
|
|
|
// CheckSyncBranchConfig checks if sync-branch is properly configured.
|
|
func CheckSyncBranchConfig(path string) DoctorCheck {
|
|
beadsDir := filepath.Join(path, ".beads")
|
|
|
|
// Skip if .beads doesn't exist
|
|
if _, err := os.Stat(beadsDir); os.IsNotExist(err) {
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Config",
|
|
Status: StatusOK,
|
|
Message: "N/A (no .beads directory)",
|
|
}
|
|
}
|
|
|
|
// Check if we're in a git repository using worktree-aware detection
|
|
_, err := git.GetGitDir()
|
|
if err != nil {
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Config",
|
|
Status: StatusOK,
|
|
Message: "N/A (not a git repository)",
|
|
}
|
|
}
|
|
|
|
// Check sync-branch from config.yaml or environment variable
|
|
// This is the source of truth for multi-clone setups
|
|
syncBranch := syncbranch.GetFromYAML()
|
|
|
|
// Get current branch
|
|
currentBranch := ""
|
|
cmd := exec.Command("git", "symbolic-ref", "--short", "HEAD")
|
|
cmd.Dir = path
|
|
if output, err := cmd.Output(); err == nil {
|
|
currentBranch = strings.TrimSpace(string(output))
|
|
}
|
|
|
|
// CRITICAL: Check if we're on the sync branch - this is a misconfiguration
|
|
// that will cause bd sync to fail trying to create a worktree for a branch
|
|
// that's already checked out
|
|
if syncBranch != "" && currentBranch == syncBranch {
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Config",
|
|
Status: StatusError,
|
|
Message: fmt.Sprintf("On sync branch '%s'", syncBranch),
|
|
Detail: fmt.Sprintf("Currently on branch '%s' which is configured as the sync branch. bd sync cannot create a worktree for a branch that's already checked out.", syncBranch),
|
|
Fix: "Switch to your main working branch: git checkout main",
|
|
}
|
|
}
|
|
|
|
if syncBranch != "" {
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Config",
|
|
Status: StatusOK,
|
|
Message: fmt.Sprintf("Configured (%s)", syncBranch),
|
|
Detail: fmt.Sprintf("Current branch: %s, sync branch: %s", currentBranch, syncBranch),
|
|
}
|
|
}
|
|
|
|
// Not configured - this is optional but recommended for multi-clone setups
|
|
// Check if this looks like a multi-clone setup (has remote)
|
|
hasRemote := false
|
|
cmd = exec.Command("git", "remote")
|
|
cmd.Dir = path
|
|
if output, err := cmd.Output(); err == nil && len(strings.TrimSpace(string(output))) > 0 {
|
|
hasRemote = true
|
|
}
|
|
|
|
if hasRemote {
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Config",
|
|
Status: StatusWarning,
|
|
Message: "sync-branch not configured",
|
|
Detail: "Multi-clone setups should configure sync-branch in config.yaml",
|
|
Fix: "Add 'sync-branch: beads-sync' to .beads/config.yaml",
|
|
}
|
|
}
|
|
|
|
// No remote - probably a local-only repo, sync-branch not needed
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Config",
|
|
Status: StatusOK,
|
|
Message: "N/A (no remote configured)",
|
|
}
|
|
}
|
|
|
|
// CheckSyncBranchHealth detects when the sync branch has diverged from main
|
|
// or from the remote sync branch (after a force-push reset).
|
|
// bd-6rf: Detect and fix stale beads-sync branch
|
|
func CheckSyncBranchHealth(path string) DoctorCheck {
|
|
// Skip if not in a git repo using worktree-aware detection
|
|
_, err := git.GetGitDir()
|
|
if err != nil {
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Health",
|
|
Status: StatusOK,
|
|
Message: "N/A (not a git repository)",
|
|
}
|
|
}
|
|
|
|
// Get configured sync branch
|
|
syncBranch := syncbranch.GetFromYAML()
|
|
if syncBranch == "" {
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Health",
|
|
Status: StatusOK,
|
|
Message: "N/A (no sync branch configured)",
|
|
}
|
|
}
|
|
|
|
// Check if local sync branch exists
|
|
cmd := exec.Command("git", "rev-parse", "--verify", syncBranch) // #nosec G204 - syncBranch from config file
|
|
cmd.Dir = path
|
|
if err := cmd.Run(); err != nil {
|
|
// Local branch doesn't exist - that's fine, bd sync will create it
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Health",
|
|
Status: StatusOK,
|
|
Message: fmt.Sprintf("N/A (local %s branch not created yet)", syncBranch),
|
|
}
|
|
}
|
|
|
|
// Check if remote sync branch exists
|
|
remote := "origin"
|
|
remoteBranch := fmt.Sprintf("%s/%s", remote, syncBranch)
|
|
cmd = exec.Command("git", "rev-parse", "--verify", remoteBranch) // #nosec G204 - remoteBranch from config
|
|
cmd.Dir = path
|
|
if err := cmd.Run(); err != nil {
|
|
// Remote branch doesn't exist - that's fine
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Health",
|
|
Status: StatusOK,
|
|
Message: fmt.Sprintf("N/A (remote %s not found)", remoteBranch),
|
|
}
|
|
}
|
|
|
|
// Check 1: Is local sync branch diverged from remote? (after force-push)
|
|
// If they have no common ancestor in recent history, the remote was likely force-pushed
|
|
cmd = exec.Command("git", "merge-base", syncBranch, remoteBranch) // #nosec G204 - branches from config
|
|
cmd.Dir = path
|
|
mergeBaseOutput, err := cmd.Output()
|
|
if err != nil {
|
|
// No common ancestor - branches have completely diverged
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Health",
|
|
Status: StatusWarning,
|
|
Message: fmt.Sprintf("Local %s diverged from remote", syncBranch),
|
|
Detail: "The remote sync branch was likely reset/force-pushed. Your local branch has orphaned history.",
|
|
Fix: fmt.Sprintf("Reset local branch: git branch -D %s (it will be recreated on next bd sync)", syncBranch),
|
|
}
|
|
}
|
|
|
|
// Check if local is behind remote (needs to fast-forward)
|
|
mergeBase := strings.TrimSpace(string(mergeBaseOutput))
|
|
cmd = exec.Command("git", "rev-parse", syncBranch) // #nosec G204 - syncBranch from config
|
|
cmd.Dir = path
|
|
localHead, _ := cmd.Output()
|
|
localHeadStr := strings.TrimSpace(string(localHead))
|
|
|
|
cmd = exec.Command("git", "rev-parse", remoteBranch) // #nosec G204 - remoteBranch from config
|
|
cmd.Dir = path
|
|
remoteHead, _ := cmd.Output()
|
|
remoteHeadStr := strings.TrimSpace(string(remoteHead))
|
|
|
|
// If merge base equals local but not remote, local is behind
|
|
if mergeBase == localHeadStr && mergeBase != remoteHeadStr {
|
|
// Count how far behind
|
|
cmd = exec.Command("git", "rev-list", "--count", fmt.Sprintf("%s..%s", syncBranch, remoteBranch)) // #nosec G204 - branches from config
|
|
cmd.Dir = path
|
|
countOutput, _ := cmd.Output()
|
|
behindCount := strings.TrimSpace(string(countOutput))
|
|
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Health",
|
|
Status: StatusOK,
|
|
Message: fmt.Sprintf("Local %s is %s commits behind remote (will sync)", syncBranch, behindCount),
|
|
}
|
|
}
|
|
|
|
// Check 2: Is sync branch far behind main on source files?
|
|
// Get the main branch name
|
|
mainBranch := "main"
|
|
cmd = exec.Command("git", "rev-parse", "--verify", "main")
|
|
cmd.Dir = path
|
|
if err := cmd.Run(); err != nil {
|
|
// Try "master" as fallback
|
|
cmd = exec.Command("git", "rev-parse", "--verify", "master")
|
|
cmd.Dir = path
|
|
if err := cmd.Run(); err != nil {
|
|
// Can't determine main branch
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Health",
|
|
Status: StatusOK,
|
|
Message: "OK",
|
|
}
|
|
}
|
|
mainBranch = "master"
|
|
}
|
|
|
|
// Count commits main is ahead of sync branch
|
|
cmd = exec.Command("git", "rev-list", "--count", fmt.Sprintf("%s..%s", syncBranch, mainBranch)) // #nosec G204 - branches from config/hardcoded
|
|
cmd.Dir = path
|
|
aheadOutput, err := cmd.Output()
|
|
if err != nil {
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Health",
|
|
Status: StatusOK,
|
|
Message: "OK",
|
|
}
|
|
}
|
|
aheadCount := strings.TrimSpace(string(aheadOutput))
|
|
|
|
// Check if there are non-.beads/ file differences (stale source code)
|
|
cmd = exec.Command("git", "diff", "--name-only", fmt.Sprintf("%s..%s", syncBranch, mainBranch), "--", ":(exclude).beads/") // #nosec G204 - branches from config/hardcoded
|
|
cmd.Dir = path
|
|
diffOutput, _ := cmd.Output()
|
|
diffFiles := strings.TrimSpace(string(diffOutput))
|
|
|
|
if diffFiles != "" && aheadCount != "0" {
|
|
// Count the number of different files
|
|
fileCount := len(strings.Split(diffFiles, "\n"))
|
|
// Parse ahead count as int for comparison
|
|
aheadCountInt := 0
|
|
_, _ = fmt.Sscanf(aheadCount, "%d", &aheadCountInt)
|
|
|
|
// Only warn if significantly behind (20+ commits AND 50+ source files)
|
|
// Small drift is normal between bd sync operations
|
|
if fileCount > 50 && aheadCountInt > 20 {
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Health",
|
|
Status: StatusWarning,
|
|
Message: fmt.Sprintf("Sync branch %s commits behind %s on source files", aheadCount, mainBranch),
|
|
Detail: fmt.Sprintf("%d source files differ between %s and %s. The sync branch has stale code.", fileCount, syncBranch, mainBranch),
|
|
Fix: fmt.Sprintf("Reset sync branch: git branch -f %s %s && git push --force-with-lease origin %s", syncBranch, mainBranch, syncBranch),
|
|
}
|
|
}
|
|
}
|
|
|
|
return DoctorCheck{
|
|
Name: "Sync Branch Health",
|
|
Status: StatusOK,
|
|
Message: "OK",
|
|
}
|
|
}
|
|
|
|
// FixGitHooks fixes missing or broken git hooks by calling bd hooks install.
|
|
func FixGitHooks(path string) error {
|
|
return fix.GitHooks(path)
|
|
}
|
|
|
|
// FixMergeDriver fixes the git merge driver configuration to use correct placeholders.
|
|
func FixMergeDriver(path string) error {
|
|
return fix.MergeDriver(path)
|
|
}
|
|
|
|
// FixSyncBranchHealth fixes database-JSONL sync issues.
|
|
func FixSyncBranchHealth(path string) error {
|
|
return fix.DBJSONLSync(path)
|
|
}
|