1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
package housekeeping
import (
"bytes"
"context"
"errors"
"fmt"
"io/fs"
"os"
"path/filepath"
"strings"
"time"
"gitlab.com/gitlab-org/gitaly/v16/internal/command"
"gitlab.com/gitlab-org/gitaly/v16/internal/git"
"gitlab.com/gitlab-org/gitaly/v16/internal/git/localrepo"
"gitlab.com/gitlab-org/gitaly/v16/internal/structerr"
)
const (
worktreePrefix = "gitlab-worktree"
)
// CleanupWorktrees cleans up stale and disconnected worktrees for the given repository.
func CleanupWorktrees(ctx context.Context, repo *localrepo.Repo) error {
if _, err := repo.Path(); err != nil {
return err
}
worktreeThreshold := time.Now().Add(-6 * time.Hour)
if err := cleanStaleWorktrees(ctx, repo, worktreeThreshold); err != nil {
return structerr.NewInternal("cleanStaleWorktrees: %w", err)
}
if err := cleanDisconnectedWorktrees(ctx, repo); err != nil {
return structerr.NewInternal("cleanDisconnectedWorktrees: %w", err)
}
return nil
}
func cleanStaleWorktrees(ctx context.Context, repo *localrepo.Repo, threshold time.Time) error {
repoPath, err := repo.Path()
if err != nil {
return err
}
worktreePath := filepath.Join(repoPath, worktreePrefix)
dirInfo, err := os.Stat(worktreePath)
if err != nil {
if os.IsNotExist(err) || !dirInfo.IsDir() {
return nil
}
return err
}
worktreeEntries, err := os.ReadDir(worktreePath)
if err != nil {
return err
}
for _, entry := range worktreeEntries {
if !entry.IsDir() || (entry.Type()&fs.ModeSymlink != 0) {
continue
}
info, err := entry.Info()
if err != nil {
// It's fine if the entry has disappeared meanwhile, we wanted to remove it
// anyway.
if errors.Is(err, fs.ErrNotExist) {
continue
}
return fmt.Errorf("statting worktree: %w", err)
}
if info.ModTime().Before(threshold) {
err := removeWorktree(ctx, repo, info.Name())
switch {
case errors.Is(err, errUnknownWorktree):
// if git doesn't recognise the worktree then we can safely remove it
if err := os.RemoveAll(filepath.Join(worktreePath, info.Name())); err != nil {
return fmt.Errorf("worktree remove dir: %w", err)
}
case err != nil:
return err
}
}
}
return nil
}
// errUnknownWorktree indicates that git does not recognise the worktree
var errUnknownWorktree = errors.New("unknown worktree")
func removeWorktree(ctx context.Context, repo *localrepo.Repo, name string) error {
var stderr bytes.Buffer
err := repo.ExecAndWait(ctx, git.Command{
Name: "worktree",
Action: "remove",
Flags: []git.Option{git.Flag{Name: "--force"}},
Args: []string{name},
},
git.WithRefTxHook(repo),
git.WithStderr(&stderr),
)
if isExitWithCode(err, 128) && strings.HasPrefix(stderr.String(), "fatal: '"+name+"' is not a working tree") {
return errUnknownWorktree
} else if err != nil {
return fmt.Errorf("remove worktree: %w, stderr: %q", err, stderr.String())
}
return nil
}
func isExitWithCode(err error, code int) bool {
actual, ok := command.ExitStatus(err)
if !ok {
return false
}
return code == actual
}
func cleanDisconnectedWorktrees(ctx context.Context, repo *localrepo.Repo) error {
repoPath, err := repo.Path()
if err != nil {
return err
}
// Spawning a command is expensive. We thus try to avoid the overhead by first
// determining if there could possibly be any work to be done by git-worktree(1). We do so
// by reading the directory in which worktrees are stored, and if it's empty then we know
// that there aren't any worktrees in the first place.
worktreeEntries, err := os.ReadDir(filepath.Join(repoPath, "worktrees"))
if err != nil {
if errors.Is(err, os.ErrNotExist) {
return nil
}
}
hasWorktrees := false
for _, worktreeEntry := range worktreeEntries {
if !worktreeEntry.IsDir() {
continue
}
if worktreeEntry.Name() == "." || worktreeEntry.Name() == ".." {
continue
}
hasWorktrees = true
break
}
// There are no worktrees, so let's avoid spawning the Git command.
if !hasWorktrees {
return nil
}
return repo.ExecAndWait(ctx, git.Command{
Name: "worktree",
Action: "prune",
}, git.WithRefTxHook(repo))
}
|
