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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
package repository
import (
"context"
"encoding/binary"
"errors"
"fmt"
"io"
"io/fs"
"os"
"path/filepath"
"github.com/grpc-ecosystem/go-grpc-middleware/logging/logrus/ctxlogrus"
"gitlab.com/gitlab-org/gitaly/v15/internal/command"
"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/safe"
"gitlab.com/gitlab-org/gitaly/v15/internal/structerr"
"gitlab.com/gitlab-org/gitaly/v15/internal/transaction/txinfo"
"gitlab.com/gitlab-org/gitaly/v15/internal/transaction/voting"
"gitlab.com/gitlab-org/gitaly/v15/proto/go/gitalypb"
"gitlab.com/gitlab-org/gitaly/v15/streamio"
)
func (s *server) RestoreCustomHooks(stream gitalypb.RepositoryService_RestoreCustomHooksServer) error {
if featureflag.TransactionalRestoreCustomHooks.IsEnabled(stream.Context()) {
return s.restoreCustomHooksWithVoting(stream)
}
firstRequest, err := stream.Recv()
if err != nil {
return structerr.NewInternal("first request failed %w", err)
}
repository := firstRequest.GetRepository()
if err := service.ValidateRepository(repository); err != nil {
return structerr.NewInvalidArgument("%w", err)
}
reader := streamio.NewReader(func() ([]byte, error) {
if firstRequest != nil {
data := firstRequest.GetData()
firstRequest = nil
return data, nil
}
request, err := stream.Recv()
return request.GetData(), err
})
repoPath, err := s.locator.GetPath(repository)
if err != nil {
return structerr.NewInternal("getting repo path failed %w", err)
}
cmdArgs := []string{
"-xf",
"-",
"-C",
repoPath,
customHooksDir,
}
ctx := stream.Context()
cmd, err := command.New(ctx, append([]string{"tar"}, cmdArgs...), command.WithStdin(reader))
if err != nil {
return structerr.NewInternal("Could not untar custom hooks tar %w", err)
}
if err := cmd.Wait(); err != nil {
return structerr.NewInternal("cmd wait failed: %w", err)
}
return stream.SendAndClose(&gitalypb.RestoreCustomHooksResponse{})
}
func (s *server) restoreCustomHooksWithVoting(stream gitalypb.RepositoryService_RestoreCustomHooksServer) error {
firstRequest, err := stream.Recv()
if err != nil {
return structerr.NewInternal("first request failed %w", err)
}
ctx := stream.Context()
repository := firstRequest.GetRepository()
if err := service.ValidateRepository(repository); err != nil {
return structerr.NewInvalidArgument("%w", err)
}
repoPath, err := s.locator.GetRepoPath(repository)
if err != nil {
return structerr.NewInternal("RestoreCustomHooks: getting repo path failed %w", err)
}
customHooksPath := filepath.Join(repoPath, customHooksDir)
if err = os.MkdirAll(customHooksPath, os.ModePerm); err != nil {
return structerr.NewInternal("making custom hooks directory %w", err)
}
lockDir, err := safe.NewLockingDirectory(repoPath, customHooksDir)
if err != nil {
return structerr.NewInternal("RestoreCustomHooks: creating locking directory: %w", err)
}
if err := lockDir.Lock(); err != nil {
return structerr.NewInternal("locking directory failed: %w", err)
}
defer func() {
if !lockDir.IsLocked() {
return
}
if err := lockDir.Unlock(); err != nil {
ctxlogrus.Extract(ctx).WithError(err).Warn("could not unlock directory")
}
}()
preparedVote := voting.NewVoteHash()
if err := voteCustomHooks(ctx, s.txManager, &preparedVote, voting.Prepared); err != nil {
return structerr.NewInternal("casting prepared vote: %w", err)
}
reader := streamio.NewReader(func() ([]byte, error) {
if firstRequest != nil {
data := firstRequest.GetData()
firstRequest = nil
return data, nil
}
request, err := stream.Recv()
return request.GetData(), err
})
cmdArgs := []string{
"-xf",
"-",
"-C",
repoPath,
customHooksDir,
}
cmd, err := command.New(ctx, append([]string{"tar"}, cmdArgs...), command.WithStdin(reader))
if err != nil {
return structerr.NewInternal("Could not untar custom hooks tar %w", err)
}
if err := cmd.Wait(); err != nil {
return structerr.NewInternal("cmd wait failed: %w", err)
}
committedVote, err := newDirectoryVote(customHooksPath)
if err != nil {
return structerr.NewInternal("generating committed vote: %w", err)
}
if err := voteCustomHooks(ctx, s.txManager, committedVote, voting.Committed); err != nil {
return structerr.NewInternal("casting committed vote: %w", err)
}
if err := lockDir.Unlock(); err != nil {
return structerr.NewInternal("committing lock dir %w", err)
}
return stream.SendAndClose(&gitalypb.RestoreCustomHooksResponse{})
}
// newDirectoryVote creates a voting.VoteHash by walking the specified path and
// generating a hash based on file name, permissions, and data.
func newDirectoryVote(basePath string) (*voting.VoteHash, error) {
voteHash := voting.NewVoteHash()
if err := filepath.WalkDir(basePath, func(path string, entry fs.DirEntry, err error) error {
if err != nil {
return err
}
// Write file name to hash. Since `WalkDir()` output is deterministic
// based on lexical order, the path does not need to be included with
// the name written to the hash. Any change to the entry's path will
// result in a different hash due to the change in walked order.
_, _ = voteHash.Write([]byte(entry.Name()))
info, err := entry.Info()
if err != nil {
return fmt.Errorf("getting file info: %w", err)
}
// Write file permissions to hash.
permBytes := make([]byte, 4)
binary.BigEndian.PutUint32(permBytes, uint32(info.Mode()))
_, _ = voteHash.Write(permBytes)
if entry.IsDir() {
return nil
}
file, err := os.Open(path)
if err != nil {
return fmt.Errorf("opening file: %w", err)
}
defer file.Close()
// Copy file data to hash.
if _, err = io.Copy(voteHash, file); err != nil {
return fmt.Errorf("copying file to hash: %w", err)
}
return nil
}); err != nil {
return nil, fmt.Errorf("walking directory: %w", err)
}
return &voteHash, nil
}
func voteCustomHooks(
ctx context.Context,
txManager transaction.Manager,
v *voting.VoteHash,
phase voting.Phase,
) error {
tx, err := txinfo.TransactionFromContext(ctx)
if errors.Is(err, txinfo.ErrTransactionNotFound) {
return nil
} else if err != nil {
return err
}
vote, err := v.Vote()
if err != nil {
return err
}
if err := txManager.Vote(ctx, tx, vote, phase); err != nil {
return fmt.Errorf("vote failed: %w", err)
}
return nil
}
|