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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
package ref
import (
"context"
"errors"
"fmt"
"strings"
"gitlab.com/gitlab-org/gitaly/proto/v15/go/gitalypb"
"gitlab.com/gitlab-org/gitaly/v15/internal/git"
"gitlab.com/gitlab-org/gitaly/v15/internal/git/localrepo"
"gitlab.com/gitlab-org/gitaly/v15/internal/git/updateref"
"gitlab.com/gitlab-org/gitaly/v15/internal/gitaly/service"
"gitlab.com/gitlab-org/gitaly/v15/internal/gitaly/transaction"
"gitlab.com/gitlab-org/gitaly/v15/internal/metadata/featureflag"
"gitlab.com/gitlab-org/gitaly/v15/internal/transaction/voting"
)
func (s *server) DeleteRefs(ctx context.Context, in *gitalypb.DeleteRefsRequest) (_ *gitalypb.DeleteRefsResponse, returnedErr error) {
if err := validateDeleteRefRequest(in); err != nil {
return nil, structerr.NewInvalidArgument("%w", err)
}
repo := s.localrepo(in.GetRepository())
refnames, err := s.refsToRemove(ctx, repo, in)
if err != nil {
return nil, structerr.NewInternal("%w", err)
}
updater, err := updateref.New(ctx, repo, updateref.WithNoDeref())
if err != nil {
if errors.Is(err, git.ErrInvalidArg) {
return nil, structerr.NewInvalidArgument("%w", err)
}
return nil, structerr.NewInternal("%w", err)
}
defer func() {
if err := updater.Close(); err != nil && returnedErr == nil {
// Only return the error if the feature flag is active. Traditionally
// the error was packed into the response body so this would start
// returning a real error. With structured errors, an actual error
// is returned so this would not override it.
if featureflag.DeleteRefsStructuredErrors.IsEnabled(ctx) {
returnedErr = fmt.Errorf("close updater: %w", err)
}
}
}()
voteHash := voting.NewVoteHash()
if featureflag.DeleteRefsStructuredErrors.IsEnabled(ctx) {
var invalidRefnames [][]byte
for _, ref := range refnames {
if err := git.ValidateRevision([]byte(ref)); err != nil {
invalidRefnames = append(invalidRefnames, []byte(ref))
}
}
if len(invalidRefnames) > 0 {
return nil, structerr.NewInvalidArgument("invalid references").WithDetail(
&gitalypb.DeleteRefsError{
Error: &gitalypb.DeleteRefsError_InvalidFormat{
InvalidFormat: &gitalypb.InvalidRefFormatError{
Refs: invalidRefnames,
},
},
},
)
}
}
if err := updater.Start(); err != nil {
return nil, structerr.NewInternal("start reference transaction: %w", err)
}
for _, ref := range refnames {
if err := updater.Delete(ref); err != nil {
if featureflag.DeleteRefsStructuredErrors.IsEnabled(ctx) {
return nil, structerr.NewInternal("unable to delete refs: %w", err)
}
return &gitalypb.DeleteRefsResponse{GitError: err.Error()}, nil
}
if _, err := voteHash.Write([]byte(ref.String() + "\n")); err != nil {
return nil, structerr.NewInternal("could not update vote hash: %w", err)
}
}
if err := updater.Prepare(); err != nil {
if featureflag.DeleteRefsStructuredErrors.IsEnabled(ctx) {
var errAlreadyLocked *updateref.ErrAlreadyLocked
if errors.As(err, &errAlreadyLocked) {
return nil, structerr.NewFailedPrecondition("cannot lock references").WithDetail(
&gitalypb.DeleteRefsError{
Error: &gitalypb.DeleteRefsError_ReferencesLocked{
ReferencesLocked: &gitalypb.ReferencesLockedError{
Refs: [][]byte{[]byte(errAlreadyLocked.Ref)},
},
},
},
)
}
return nil, structerr.NewInternal("unable to prepare: %w", err)
}
return &gitalypb.DeleteRefsResponse{
GitError: fmt.Sprintf("unable to delete refs: %s", err.Error()),
}, nil
}
vote, err := voteHash.Vote()
if err != nil {
return nil, structerr.NewInternal("could not compute vote: %w", err)
}
// All deletes we're doing in this RPC are force deletions. Because we're required to filter
// out transactions which only consist of force deletions, we never do any voting via the
// reference-transaction hook here. Instead, we need to resort to a manual vote which is
// simply the concatenation of all reference we're about to delete.
if err := transaction.VoteOnContext(ctx, s.txManager, vote, voting.Prepared); err != nil {
return nil, structerr.NewInternal("preparatory vote: %w", err)
}
if err := updater.Commit(); err != nil {
if featureflag.DeleteRefsStructuredErrors.IsEnabled(ctx) {
return nil, structerr.NewInternal("unable to commit: %w", err)
}
return &gitalypb.DeleteRefsResponse{GitError: fmt.Sprintf("unable to delete refs: %s", err.Error())}, nil
}
if err := transaction.VoteOnContext(ctx, s.txManager, vote, voting.Committed); err != nil {
return nil, structerr.NewInternal("committing vote: %w", err)
}
return &gitalypb.DeleteRefsResponse{}, nil
}
func (s *server) refsToRemove(ctx context.Context, repo *localrepo.Repo, req *gitalypb.DeleteRefsRequest) ([]git.ReferenceName, error) {
if len(req.Refs) > 0 {
refs := make([]git.ReferenceName, len(req.Refs))
for i, ref := range req.Refs {
refs[i] = git.ReferenceName(ref)
}
return refs, nil
}
prefixes := make([]string, len(req.ExceptWithPrefix))
for i, prefix := range req.ExceptWithPrefix {
prefixes[i] = string(prefix)
}
existingRefs, err := repo.GetReferences(ctx)
if err != nil {
return nil, err
}
var refs []git.ReferenceName
for _, existingRef := range existingRefs {
if hasAnyPrefix(existingRef.Name.String(), prefixes) {
continue
}
refs = append(refs, existingRef.Name)
}
return refs, nil
}
func hasAnyPrefix(s string, prefixes []string) bool {
for _, prefix := range prefixes {
if strings.HasPrefix(s, prefix) {
return true
}
}
return false
}
func validateDeleteRefRequest(req *gitalypb.DeleteRefsRequest) error {
if err := service.ValidateRepository(req.GetRepository()); err != nil {
return err
}
if len(req.ExceptWithPrefix) > 0 && len(req.Refs) > 0 {
return errors.New("ExceptWithPrefix and Refs are mutually exclusive")
}
if len(req.ExceptWithPrefix) == 0 && len(req.Refs) == 0 { // You can't delete all refs
return errors.New("empty ExceptWithPrefix and Refs")
}
for _, prefix := range req.ExceptWithPrefix {
if len(prefix) == 0 {
return errors.New("empty prefix for exclusion")
}
}
for _, ref := range req.Refs {
if len(ref) == 0 {
return errors.New("empty ref")
}
}
return nil
}
|
