fd79d6170f
* feat(tasks): multi-branch tasks — N (repo, branch) pairs per task Extends multi-repo into multi-branch so a single task can hold multiple worktrees on the same repo (one per branch). Sibling worktrees layout at <task>/<repo>/ + <task>/<repo>-<slug>/, dedicated PRWatch per branch, live agentctl tracker rescan + frontend store updates so the UI splits PRs / files / commits per branch without a session restart. MCP add_branch_to_task_kandev tool is shielded to the worktree executor. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * fix(web): unify multi-branch repo label as <repo> · <branch> across panels PR Changes and Commits panels rendered repo labels differently for multi-branch tasks — Commits showed "kandev · feature/x" while PR Changes leaked the raw "kandev-feature-x" agentctl tracker tag. Reformat tracker-tagged repo names via formatRepoLabel using the longest known-repo prefix so kandev-cli-* doesn't collapse to kandev · cli-*. * fix(tasks): address multi-branch PR review — data races, slug collisions, MCP error codes Backend - agentctl process.Manager: add repoTrackersMu RWMutex guarding repoTrackers + workspaceTracker. Reads snapshot under RLock; RescanRepositories builds trackers first, takes Lock for swap/append. Validates newWorkDir via os.Stat before publishing cfg.WorkDir. - worktree.Manager: reject invalid explicit BranchSlug up-front; cache key uses sanitized wt.BranchSlug so read/write paths are symmetric. - worktree.store: narrow isDuplicateColumnError to "duplicate column name". - task service AddBranchToTask: slug-collision guard rejects feat/a vs feat-a. - orchestrator resolvePushRepo: two-pass exact-name match before subdir prefix fallback so "backend" doesn't swallow pushes for "backend-admin". - executor buildRepoSpecs: duplicate repos always get a non-empty BranchSlug (falls back to branch-N when both branch fields sanitize to empty). - MCP handler: classifyAddBranchError maps service errors to NOT_FOUND / CONFLICT / VALIDATION_ERROR; add ErrorCodeConflict constant. - MCP server: extract registerAddBranchToTaskTool, register in task mode only (external mode contract: config tools + create_task_kandev). - workspace_rescan handler: reject malformed JSON with 400 instead of silently rescanning the current root. - branch_materializer: split MaterializeBranch into prepare + finalize helpers to satisfy the 80-line cap. Frontend - existingPrUrl returns undefined when a task has >1 PR so per-repo View PR buttons take over (no silent linking to a sibling). - formatRepoLabel checks exact known-repo match before prefix splitting so "kandev-cli" isn't mislabeled as "kandev · cli". - Repo chip key now includes base_branch so siblings differing only on base render as distinct chips. Docs - multi-branch spec uniqueness wording aligned with the canonical 4-column key (task_id, repository_id, base_branch, checkout_branch). - worktree.CreateRequest.BranchSlug doc describes the sibling layout (<repo>-<slug>) instead of the obsolete nested form. * fix(tasks): scope slug-collision check to repo only + use errors.Is for ErrTaskNotFound - service_branches: drop base_branch from the slug-collision check. Worktree path is (repo, slug); two rows on the same repo cut from different bases still collide on disk. - service_branches: prepareBranchAdd wraps taskrepo.ErrTaskNotFound via fmt.Errorf with %w so classifiers don't have to substring-match the formatted task UUID. - mcp handlers: classifyAddBranchError uses errors.Is(err, ErrTaskNotFound). * fix(agentctl): sanitize rescan work_dir before os.Stat to clear CodeQL path-injection CodeQL flagged the rescan endpoint as a path-injection sink (the HTTP-supplied work_dir flowed straight into os.Stat and downstream scanRepositorySubdirs). Add validateRescanPath which: - requires the input to be a clean absolute path with no ".." segments - rejects anything that isn't equal to or an ancestor of the current cfg.WorkDir — the only legitimate use case is the branch materializer promoting <task>/<repo>/ to <task>/ Defense in depth: agentctl binds to localhost, but any colocated process could otherwise direct it at /etc or the user's home by POSTing /api/v1/workspace/rescan. * fix(agentctl): tighten validateRescanPath, close TOCTOU on existingTrackers, add tests - Drop the strings.Contains(clean, "..") guard. filepath.Clean already resolves traversal; the substring check rejects legitimate names like /home/u/..hidden without adding defense (the ancestor check via filepath.Rel is the real boundary). - Drop the rel == "." branch in the ancestor check — early return for clean == currentClean already covers identity. - Read existingTrackers inside the write-lock section (not under RLock then re-Lock) so two concurrent rescans can't both see 0 trackers and double-bootstrap the multi-repo set. - Add table-driven TestValidateRescanPath covering rejection paths (relative, descendant, sibling, traversal-cleaned, empty input), legitimate ancestor promotion, exact match, no-anchor first-launch, and a /home/u/..hidden dotted-segment case. * fix(agentctl): break taint flow into os.Stat — derive rescan path from cfg, not HTTP body CodeQL's go/path-injection trace still flagged manager_rescan.go after the prior sanitizer because the user-supplied newWorkDir flowed (after validation) into os.Stat and then into cfg.WorkDir → tracker paths → workspace_monitor os.Stat sinks. Replace validateRescanPath with resolveRescanPath: it returns a path DERIVED from currentWorkDir (no-op = currentClean, promotion = filepath.Dir(currentClean)) and uses newPath only for comparison, never as a source for the returned string. os.Stat now receives a path whose provenance is trusted manager config. Functionally the legitimate caller (branch materializer promoting <task>/<repo>/ to <task>/) is unchanged. * test(agentctl): make TestResolveRescanPath windows-portable The Linux Backend Tests job passed but the Backend (windows) job rejected every "absolute" case because filepath.IsAbs("/task/repo") is false on Windows (no volume letter). Build inputs via filepath.Join against absRoot() (filepath.Abs of "/" / "\\") so the same table covers POSIX (`/...`) and Windows (`C:\...`) without per-OS branches. Keep the traversal-after-Clean case POSIX-only since filepath.Clean is the shared primitive and that input form needs a volume to be considered absolute on Windows anyway. * fix(agentctl): serialize RescanRepositories + re-check trackers under write lock Two concurrent RescanRepositories calls could both observe an empty tracker set (between the snapshot read and the bootstrap branch) and both enter transitionToMultiRepoMode, leaking a duplicate bare-root tracker and duplicate per-repo trackers. Same race in appendNewRepoTrackers would double-append the same new child across both callers. Fix: - Add rescanMu sync.Mutex on Manager. Acquired for the full body of RescanRepositories so the snapshot → branch → mutate sequence is serialized. repoTrackersMu still guards individual field reads from unrelated goroutines (subscribe/unsubscribe/poll-mode). - appendNewRepoTrackers re-checks membership inside the write-lock before appending and drops already-present trackers (Stop + detach outside the lock). Defense in depth. - Test: add `dotted segment is legal as promotion` case so the ..hidden-segment promotion path stays exercised. --------- Co-authored-by: Kandev Agent <agent@kandev.dev> Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
295 lines
9.7 KiB
Go
295 lines
9.7 KiB
Go
package worktree
|
|
|
|
import (
|
|
"crypto/rand"
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"regexp"
|
|
"strings"
|
|
"unicode"
|
|
)
|
|
|
|
// Config holds configuration for the worktree manager.
|
|
type Config struct {
|
|
// Enabled controls whether worktree mode is active.
|
|
Enabled bool `mapstructure:"enabled"`
|
|
|
|
// TasksBasePath is the base directory for per-task worktree storage.
|
|
// Each task gets a subdirectory containing one repo worktree (future: multiple).
|
|
// Supports ~ expansion for home directory.
|
|
// Default: ~/.kandev/tasks
|
|
TasksBasePath string `mapstructure:"tasks_base_path"`
|
|
|
|
// BranchPrefix is the prefix used for worktree branch names.
|
|
// Default: feature/
|
|
BranchPrefix string `mapstructure:"branch_prefix"`
|
|
|
|
// FetchTimeoutSeconds is the timeout for pre-worktree git fetch.
|
|
// If <= 0, manager default is used.
|
|
FetchTimeoutSeconds int `mapstructure:"fetch_timeout_seconds"`
|
|
|
|
// PullTimeoutSeconds is the timeout for pre-worktree git pull.
|
|
// If <= 0, manager default is used.
|
|
PullTimeoutSeconds int `mapstructure:"pull_timeout_seconds"`
|
|
}
|
|
|
|
// DefaultBranchPrefix is used when no repository-specific prefix is provided.
|
|
const DefaultBranchPrefix = "feature/"
|
|
|
|
// Validate validates the configuration and returns an error if invalid.
|
|
func (c *Config) Validate() error {
|
|
if c.BranchPrefix == "" {
|
|
c.BranchPrefix = DefaultBranchPrefix
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// SetTasksBasePathFallback sets the TasksBasePath from the data directory if not already configured.
|
|
func (c *Config) SetTasksBasePathFallback(dataDir string) {
|
|
if c.TasksBasePath == "" && dataDir != "" {
|
|
c.TasksBasePath = filepath.Join(dataDir, "tasks")
|
|
}
|
|
}
|
|
|
|
// ExpandedTasksBasePath returns the tasks base path with ~ expanded to the user's home directory.
|
|
func (c *Config) ExpandedTasksBasePath() (string, error) {
|
|
path := c.TasksBasePath
|
|
if strings.HasPrefix(path, "~/") {
|
|
home, err := os.UserHomeDir()
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
path = filepath.Join(home, path[2:])
|
|
}
|
|
return path, nil
|
|
}
|
|
|
|
// TaskWorktreePath returns the full path for a worktree inside a task directory.
|
|
//
|
|
// Layout:
|
|
// - branchSlug == "" → {tasksBase}/{taskDirName}/{repoName} (legacy single-branch path)
|
|
// - branchSlug != "" → {tasksBase}/{taskDirName}/{repoName}-{slug} (sibling at task root)
|
|
//
|
|
// Additional branches sit as siblings of the primary worktree under the task
|
|
// root instead of nesting inside it. Nesting (e.g. `<task>/<repo>/<slug>/`)
|
|
// places the second worktree INSIDE the first worktree's working tree, which
|
|
// pollutes the primary's git scope (file scans, status, etc.) and surfaces a
|
|
// surprise subdirectory to the agent working in the primary.
|
|
func (c *Config) TaskWorktreePath(taskDirName, repoName, branchSlug string) (string, error) {
|
|
basePath, err := c.ExpandedTasksBasePath()
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
if branchSlug == "" {
|
|
return filepath.Join(basePath, taskDirName, repoName), nil
|
|
}
|
|
return filepath.Join(basePath, taskDirName, repoName+"-"+branchSlug), nil
|
|
}
|
|
|
|
// BranchName returns the branch name for a given task ID and suffix.
|
|
// Format: {prefix}{taskID}-{suffix} e.g. feature/abc123-xyz
|
|
func (c *Config) BranchName(taskID, suffix string) string {
|
|
return c.BranchPrefix + taskID + "-" + suffix
|
|
}
|
|
|
|
// SemanticBranchName returns a branch name using a semantic name derived from task title.
|
|
// Format: {prefix}{semanticName}-{suffix} e.g. feature/fix-login-bug-abc
|
|
func (c *Config) SemanticBranchName(semanticName, suffix string) string {
|
|
return c.BranchPrefix + semanticName + "-" + suffix
|
|
}
|
|
|
|
// isASCIIAlphaNum reports whether r is an ASCII letter or digit. Restricting
|
|
// to ASCII (rather than the broader unicode.IsLetter/IsDigit) keeps branch
|
|
// and worktree-directory names usable across tools and filesystems — Unicode
|
|
// letters such as CJK ideographs, Cyrillic, or Arabic characters are valid
|
|
// git refs but break many downstream consumers (see issue #1081).
|
|
func isASCIIAlphaNum(r rune) bool {
|
|
return (r >= 'a' && r <= 'z') || (r >= 'A' && r <= 'Z') || (r >= '0' && r <= '9')
|
|
}
|
|
|
|
// SanitizeForBranch converts a task title into a valid git branch name component.
|
|
// It:
|
|
// - Converts to lowercase
|
|
// - Replaces spaces and non-ASCII-alphanumeric characters with hyphens
|
|
// - Removes consecutive hyphens
|
|
// - Truncates to maxLen characters
|
|
// - Removes leading/trailing hyphens
|
|
func SanitizeForBranch(title string, maxLen int) string {
|
|
if title == "" {
|
|
return ""
|
|
}
|
|
|
|
// Convert to lowercase
|
|
result := strings.ToLower(title)
|
|
|
|
// Replace any character that's not ASCII-alphanumeric with a hyphen.
|
|
// Git branch names allow a broader character set, but we restrict to ASCII
|
|
// alphanumerics + hyphens for cleaner, portable names.
|
|
var sb strings.Builder
|
|
for _, r := range result {
|
|
if isASCIIAlphaNum(r) {
|
|
sb.WriteRune(r)
|
|
} else {
|
|
sb.WriteRune('-')
|
|
}
|
|
}
|
|
result = sb.String()
|
|
|
|
// Remove consecutive hyphens
|
|
result = repoDirHyphenRun.ReplaceAllString(result, "-")
|
|
|
|
// Remove leading and trailing hyphens
|
|
result = strings.Trim(result, "-")
|
|
|
|
// Truncate to maxLen
|
|
if len(result) > maxLen {
|
|
result = result[:maxLen]
|
|
// Remove trailing hyphen after truncation
|
|
result = strings.TrimRight(result, "-")
|
|
}
|
|
|
|
return result
|
|
}
|
|
|
|
// NormalizeBranchPrefix trims and falls back to the default prefix.
|
|
func NormalizeBranchPrefix(prefix string) string {
|
|
trimmed := strings.TrimSpace(prefix)
|
|
if trimmed == "" {
|
|
return DefaultBranchPrefix
|
|
}
|
|
return trimmed
|
|
}
|
|
|
|
// TaskBranchNameWithSuffix builds the per-task branch name from a caller-supplied suffix.
|
|
// The caller is responsible for generating the suffix (e.g. SmallSuffix(3)) so that
|
|
// naming is deterministic when the suffix is derived externally.
|
|
func TaskBranchNameWithSuffix(taskTitle, taskID, prefix, suffix string) string {
|
|
sanitized := SanitizeForBranch(taskTitle, 20)
|
|
if sanitized == "" {
|
|
sanitized = SanitizeForBranch(taskID, 20)
|
|
}
|
|
if sanitized == "" {
|
|
sanitized = "task"
|
|
}
|
|
return NormalizeBranchPrefix(prefix) + sanitized + "-" + suffix
|
|
}
|
|
|
|
// ValidateBranchPrefix ensures a prefix contains only safe branch characters.
|
|
func ValidateBranchPrefix(prefix string) error {
|
|
trimmed := strings.TrimSpace(prefix)
|
|
if trimmed == "" {
|
|
return nil
|
|
}
|
|
for _, r := range trimmed {
|
|
if unicode.IsLetter(r) || unicode.IsDigit(r) || r == '/' || r == '-' || r == '_' || r == '.' {
|
|
continue
|
|
}
|
|
return fmt.Errorf("invalid branch prefix")
|
|
}
|
|
if strings.Contains(trimmed, "..") || strings.Contains(trimmed, "@{") {
|
|
return fmt.Errorf("invalid branch prefix")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
const branchSuffixAlphabet = "abcdefghijklmnopqrstuvwxyz0123456789"
|
|
|
|
// SmallSuffix returns a random suffix capped at 3 characters.
|
|
func SmallSuffix(maxLen int) string {
|
|
if maxLen <= 0 {
|
|
return ""
|
|
}
|
|
if maxLen > 3 {
|
|
maxLen = 3
|
|
}
|
|
buf := make([]byte, maxLen)
|
|
if _, err := rand.Read(buf); err != nil {
|
|
return strings.Repeat("x", maxLen)
|
|
}
|
|
for i := range buf {
|
|
buf[i] = branchSuffixAlphabet[int(buf[i])%len(branchSuffixAlphabet)]
|
|
}
|
|
return string(buf)
|
|
}
|
|
|
|
// SanitizeRepoDirName converts a repository display name into a single,
|
|
// filesystem-safe path segment. Path separators and other unsafe characters
|
|
// are replaced with hyphens, runs of hyphens are collapsed, and surrounding
|
|
// hyphens/dots are trimmed. Returns an empty string when the input has no
|
|
// usable characters.
|
|
//
|
|
// This guards against names like "owner/repo" producing nested subdirectories
|
|
// when used as the worktree directory under a multi-repo task root — the
|
|
// extra path level breaks sibling-repo detection in agentctl.
|
|
//
|
|
// Limitation: distinct names that differ only in unsafe characters (e.g.
|
|
// "acme/widget-config" and "acme-widget-config") collapse to the same
|
|
// segment. Two such repos in one task would collide on `git worktree add`.
|
|
// Acceptable in practice — provider repos (the common case) are uniquely
|
|
// identified by owner/name and won't collide with each other.
|
|
func SanitizeRepoDirName(name string) string {
|
|
if name == "" {
|
|
return ""
|
|
}
|
|
var sb strings.Builder
|
|
sb.Grow(len(name))
|
|
for _, r := range name {
|
|
switch {
|
|
case isASCIIAlphaNum(r):
|
|
sb.WriteRune(r)
|
|
case r == '_', r == '.', r == '-':
|
|
sb.WriteRune(r)
|
|
default:
|
|
sb.WriteRune('-')
|
|
}
|
|
}
|
|
result := repoDirHyphenRun.ReplaceAllString(sb.String(), "-")
|
|
return strings.Trim(result, "-.")
|
|
}
|
|
|
|
var repoDirHyphenRun = regexp.MustCompile(`-+`)
|
|
|
|
// SanitizeBranchSlug converts a git branch name into a filesystem-safe single
|
|
// path segment for use under the per-repo worktree directory. Forward slashes
|
|
// (common in branch names like "feature/foo") collapse to hyphens so the slug
|
|
// never introduces extra path levels. Returns the empty string when the input
|
|
// has no usable characters — callers MUST treat that as "no nesting" rather
|
|
// than as an empty path segment.
|
|
//
|
|
// Determinism: same branch name always produces the same slug. Two branches
|
|
// that differ only in unsafe characters (e.g. "feat/a" and "feat-a") collapse
|
|
// to the same slug and would collide on disk; the service layer should reject
|
|
// such duplicates before reaching the worktree manager.
|
|
func SanitizeBranchSlug(branch string) string {
|
|
if branch == "" {
|
|
return ""
|
|
}
|
|
var sb strings.Builder
|
|
sb.Grow(len(branch))
|
|
for _, r := range branch {
|
|
switch {
|
|
case isASCIIAlphaNum(r):
|
|
sb.WriteRune(r)
|
|
case r == '_', r == '.', r == '-':
|
|
sb.WriteRune(r)
|
|
default:
|
|
sb.WriteRune('-')
|
|
}
|
|
}
|
|
result := repoDirHyphenRun.ReplaceAllString(sb.String(), "-")
|
|
return strings.Trim(result, "-.")
|
|
}
|
|
|
|
// SemanticWorktreeName generates a semantic worktree directory name from a task title.
|
|
// Format: {sanitizedTitle}_{suffix} e.g. fix-login-bug_ab12cd34
|
|
// The title is truncated to 20 characters before adding the suffix.
|
|
func SemanticWorktreeName(taskTitle, suffix string) string {
|
|
semanticName := SanitizeForBranch(taskTitle, 20)
|
|
if semanticName == "" {
|
|
// Fallback to just suffix if title is empty or all special chars
|
|
return suffix
|
|
}
|
|
return semanticName + "_" + suffix
|
|
}
|