Auto-disable daemon in git worktrees for safety (#567)
* feat: auto-disable daemon in git worktrees for safety Implement worktree daemon compatibility as proposed in the analysis. The daemon is now automatically disabled when running in a git worktree unless sync-branch is configured. Git worktrees share the same .beads directory, and the daemon commits to whatever branch its working directory has checked out. This causes commits to go to the wrong branch when using daemon in worktrees. - Add shouldDisableDaemonForWorktree() helper that checks: 1. If current directory is a git worktree (via git rev-parse) 2. If sync-branch is configured (env var or config.yaml) - Modify shouldAutoStartDaemon() to call the helper - Modify daemon connection logic in main.go to skip connection - Add FallbackWorktreeSafety constant for daemon status reporting - Update warnWorktreeDaemon() to skip warning when sync-branch configured - In worktree WITHOUT sync-branch: daemon auto-disabled, direct mode used - In worktree WITH sync-branch: daemon enabled (commits go to dedicated branch) - In regular repo: no change (daemon works as before) - Added comprehensive unit tests for shouldDisableDaemonForWorktree() - Added integration tests for shouldAutoStartDaemon() in worktree contexts - Manual E2E testing verified correct behavior - Updated WORKTREES.md with new automatic safety behavior - Updated DAEMON.md with Git Worktrees section * feat: check database config for sync-branch in worktree safety logic Previously, the worktree daemon safety check only looked at: - BEADS_SYNC_BRANCH environment variable - sync-branch in config.yaml This meant users who configured sync-branch via `bd config set sync-branch` (which stores in the database) would still have daemon disabled in worktrees. Now the check also reads sync.branch from the database config table, making daemon work in worktrees when sync-branch is configured via any method. Changes: - Add IsConfiguredWithDB() function that checks env, config.yaml, AND database - Add findBeadsDB() to locate database (worktree-aware via git-common-dir) - Add getMainRepoRoot() helper using git rev-parse - Add getConfigFromDB() for lightweight database reads - Update shouldDisableDaemonForWorktree() to use IsConfiguredWithDB() - Update warnWorktreeDaemon() to use IsConfiguredWithDB() - Add test case for database config path * refactor: use existing beads.FindDatabasePath() instead of duplicating code Remove duplicate getMainRepoRoot() and findBeadsDB() functions from syncbranch.go and use the existing beads.FindDatabasePath() which is already worktree-aware. Changes: - Replace custom findBeadsDB() with beads.FindDatabasePath() - Remove duplicate getMainRepoRoot() (git.GetMainRepoRoot() exists) - Remove unused imports (exec, strings, filepath) - Clean up debug logging in tests --------- Co-authored-by: Charles P. Cross <cpdata@users.noreply.github.com>
This commit is contained in:
@@ -9,6 +9,7 @@ import (
|
||||
|
||||
"github.com/steveyegge/beads/internal/beads"
|
||||
"github.com/steveyegge/beads/internal/git"
|
||||
"github.com/steveyegge/beads/internal/syncbranch"
|
||||
)
|
||||
|
||||
// isGitWorktree detects if the current directory is in a git worktree.
|
||||
@@ -17,6 +18,37 @@ func isGitWorktree() bool {
|
||||
return git.IsWorktree()
|
||||
}
|
||||
|
||||
// shouldDisableDaemonForWorktree returns true if daemon should be disabled
|
||||
// due to being in a git worktree without sync-branch configured.
|
||||
//
|
||||
// The daemon is unsafe in worktrees because all worktrees share the same
|
||||
// .beads directory, and the daemon commits to whatever branch its working
|
||||
// directory has checked out - which can cause commits to go to the wrong branch.
|
||||
//
|
||||
// However, when sync-branch is configured, the daemon commits to a dedicated
|
||||
// branch (e.g., "beads-metadata") using an internal worktree, so the user's
|
||||
// current branch is never affected. This makes daemon mode safe in worktrees.
|
||||
//
|
||||
// Returns:
|
||||
// - true: Disable daemon (in worktree without sync-branch)
|
||||
// - false: Allow daemon (not in worktree, or sync-branch is configured)
|
||||
func shouldDisableDaemonForWorktree() bool {
|
||||
// If not in a worktree, daemon is safe
|
||||
if !isGitWorktree() {
|
||||
return false
|
||||
}
|
||||
|
||||
// In a worktree - check if sync-branch is configured
|
||||
// IsConfiguredWithDB checks env var, config.yaml, AND database config
|
||||
if syncbranch.IsConfiguredWithDB("") {
|
||||
// Sync-branch is configured, daemon is safe (commits go to dedicated branch)
|
||||
return false
|
||||
}
|
||||
|
||||
// In worktree without sync-branch - daemon is unsafe, disable it
|
||||
return true
|
||||
}
|
||||
|
||||
// gitRevParse runs git rev-parse with the given flag and returns the trimmed output.
|
||||
// This is a helper for CLI utilities that need git command execution.
|
||||
func gitRevParse(flag string) string {
|
||||
@@ -37,12 +69,24 @@ func getWorktreeGitDir() string {
|
||||
return gitDir
|
||||
}
|
||||
|
||||
// warnWorktreeDaemon prints a warning if using daemon with worktrees
|
||||
// Call this only when daemon mode is actually active (connected)
|
||||
// warnWorktreeDaemon prints a warning if using daemon with worktrees without sync-branch.
|
||||
// Call this only when daemon mode is actually active (connected).
|
||||
//
|
||||
// With the new worktree safety logic, this warning should rarely appear because:
|
||||
// - Daemon is auto-disabled in worktrees without sync-branch
|
||||
// - When sync-branch is configured, daemon is safe (commits go to dedicated branch)
|
||||
//
|
||||
// This warning is kept as a safety net for edge cases where daemon might still
|
||||
// be connected in a worktree (e.g., daemon started in main repo, then user cd's to worktree).
|
||||
func warnWorktreeDaemon(dbPathForWarning string) {
|
||||
if !isGitWorktree() {
|
||||
return
|
||||
}
|
||||
|
||||
// If sync-branch is configured, daemon is safe in worktrees - no warning needed
|
||||
if syncbranch.IsConfiguredWithDB("") {
|
||||
return
|
||||
}
|
||||
|
||||
gitDir := getWorktreeGitDir()
|
||||
beadsDir := filepath.Dir(dbPathForWarning)
|
||||
@@ -61,11 +105,9 @@ func warnWorktreeDaemon(dbPathForWarning string) {
|
||||
fmt.Fprintf(os.Stderr, "║ Worktree git dir: %-54s ║\n", truncateForBox(gitDir, 54))
|
||||
fmt.Fprintln(os.Stderr, "║ ║")
|
||||
fmt.Fprintln(os.Stderr, "║ RECOMMENDED SOLUTIONS: ║")
|
||||
fmt.Fprintln(os.Stderr, "║ 1. Use --no-daemon flag: bd --no-daemon <command> ║")
|
||||
fmt.Fprintln(os.Stderr, "║ 2. Disable daemon mode: export BEADS_NO_DAEMON=1 ║")
|
||||
fmt.Fprintln(os.Stderr, "║ ║")
|
||||
fmt.Fprintln(os.Stderr, "║ Note: BEADS_AUTO_START_DAEMON=false only prevents auto-start; ║")
|
||||
fmt.Fprintln(os.Stderr, "║ you can still connect to a running daemon. ║")
|
||||
fmt.Fprintln(os.Stderr, "║ 1. Configure sync-branch: bd config set sync-branch beads-metadata ║")
|
||||
fmt.Fprintln(os.Stderr, "║ 2. Use --no-daemon flag: bd --no-daemon <command> ║")
|
||||
fmt.Fprintln(os.Stderr, "║ 3. Disable daemon mode: export BEADS_NO_DAEMON=1 ║")
|
||||
fmt.Fprintln(os.Stderr, "╚══════════════════════════════════════════════════════════════════════════╝")
|
||||
fmt.Fprintln(os.Stderr)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user