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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
|
package operations
import (
"bytes"
"context"
"encoding/base64"
"errors"
"fmt"
"io"
"strings"
"github.com/grpc-ecosystem/go-grpc-middleware/logging/logrus/ctxlogrus"
"github.com/sirupsen/logrus"
"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/remoterepo"
"gitlab.com/gitlab-org/gitaly/v15/internal/git/updateref"
"gitlab.com/gitlab-org/gitaly/v15/internal/git2go"
"gitlab.com/gitlab-org/gitaly/v15/internal/gitaly/service"
"gitlab.com/gitlab-org/gitaly/v15/internal/gitaly/storage"
"gitlab.com/gitlab-org/gitaly/v15/internal/structerr"
"gitlab.com/gitlab-org/gitaly/v15/proto/go/gitalypb"
)
// UserCommitFiles allows for committing from a set of actions. See the protobuf documentation
// for details.
func (s *Server) UserCommitFiles(stream gitalypb.OperationService_UserCommitFilesServer) error {
firstRequest, err := stream.Recv()
if err != nil {
return err
}
header := firstRequest.GetHeader()
if header == nil {
return structerr.NewInvalidArgument("empty UserCommitFilesRequestHeader")
}
if err = validateUserCommitFilesHeader(header); err != nil {
return structerr.NewInvalidArgument("%w", err)
}
ctx := stream.Context()
if err := s.userCommitFiles(ctx, header, stream); err != nil {
ctxlogrus.AddFields(ctx, logrus.Fields{
"repository_storage": header.Repository.StorageName,
"repository_relative_path": header.Repository.RelativePath,
"branch_name": header.BranchName,
"start_branch_name": header.StartBranchName,
"start_sha": header.StartSha,
"force": header.Force,
})
if startRepo := header.GetStartRepository(); startRepo != nil {
ctxlogrus.AddFields(ctx, logrus.Fields{
"start_repository_storage": startRepo.StorageName,
"start_repository_relative_path": startRepo.RelativePath,
})
}
var (
unknownErr git2go.UnknownIndexError
indexErr git2go.IndexError
customHookErr updateref.CustomHookError
)
switch {
case errors.As(err, &unknownErr):
// Problems that occur within git2go itself will still be returned
// as UnknownIndexErrors. The most common case of this would be
// creating an invalid path, e.g. '.git' but there are many other
// potential, if unusual, issues that could occur.
return unknownErr
case errors.As(err, &indexErr):
return indexErr.StructuredError().WithDetail(
&gitalypb.UserCommitFilesError{
Error: &gitalypb.UserCommitFilesError_IndexUpdate{
IndexUpdate: indexErr.Proto(),
},
},
)
case errors.As(err, &customHookErr):
return structerr.NewPermissionDenied("denied by custom hooks").WithDetail(
&gitalypb.UserCommitFilesError{
Error: &gitalypb.UserCommitFilesError_CustomHook{
CustomHook: customHookErr.Proto(),
},
},
)
case errors.As(err, new(git2go.InvalidArgumentError)):
return structerr.NewInvalidArgument("%w", err)
default:
return err
}
}
return nil
}
func validatePath(rootPath, relPath string) (string, error) {
if relPath == "" {
return "", git2go.IndexError{Type: git2go.ErrEmptyPath}
} else if strings.Contains(relPath, "//") {
// This is a workaround to address a quirk in porting the RPC from Ruby to Go.
// GitLab's QA pipeline runs tests with filepath 'invalid://file/name/here'.
// Go's filepath.Clean returns 'invalid:/file/name/here'. The Ruby implementation's
// filepath normalization accepted the path as is. Adding a file with this path to the
// index via Rugged failed with an invalid path error. As Go's cleaning resulted a valid
// filepath, adding the file succeeded, which made the QA pipeline's specs fail.
//
// The Rails code expects to receive an error prefixed with 'invalid path', which is done
// here to retain compatibility.
return "", git2go.IndexError{Type: git2go.ErrInvalidPath, Path: relPath}
}
path, err := storage.ValidateRelativePath(rootPath, relPath)
if err != nil {
if errors.Is(err, storage.ErrRelativePathEscapesRoot) {
return "", git2go.IndexError{Type: git2go.ErrDirectoryTraversal, Path: relPath}
}
return "", err
}
return path, nil
}
func (s *Server) userCommitFiles(ctx context.Context, header *gitalypb.UserCommitFilesRequestHeader, stream gitalypb.OperationService_UserCommitFilesServer) error {
quarantineDir, quarantineRepo, err := s.quarantinedRepo(ctx, header.GetRepository())
if err != nil {
return err
}
repoPath, err := quarantineRepo.Path()
if err != nil {
return err
}
remoteRepo := header.GetStartRepository()
if sameRepository(header.GetRepository(), remoteRepo) {
// Some requests set a StartRepository that refers to the same repository as the target repository.
// This check never works behind Praefect. See: https://gitlab.com/gitlab-org/gitaly/-/issues/3294
// Plain Gitalies still benefit from identifying the case and avoiding unnecessary RPC to resolve the
// branch.
remoteRepo = nil
}
targetBranchName := git.NewReferenceNameFromBranchName(string(header.BranchName))
targetBranchCommit, err := quarantineRepo.ResolveRevision(ctx, targetBranchName.Revision()+"^{commit}")
if err != nil {
if !errors.Is(err, git.ErrReferenceNotFound) {
return fmt.Errorf("resolve target branch commit: %w", err)
}
// the branch is being created
}
var parentCommitOID git.ObjectID
if header.StartSha == "" {
parentCommitOID, err = s.resolveParentCommit(
ctx,
quarantineRepo,
remoteRepo,
targetBranchName,
targetBranchCommit,
string(header.StartBranchName),
)
if err != nil {
return fmt.Errorf("resolve parent commit: %w", err)
}
} else {
parentCommitOID, err = git.ObjectHashSHA1.FromHex(header.StartSha)
if err != nil {
return structerr.NewInvalidArgument("cannot resolve parent commit: %w", err)
}
}
if parentCommitOID != targetBranchCommit {
if err := s.fetchMissingCommit(ctx, quarantineRepo, remoteRepo, parentCommitOID); err != nil {
return fmt.Errorf("fetch missing commit: %w", err)
}
}
type action struct {
header *gitalypb.UserCommitFilesActionHeader
content []byte
}
var pbActions []action
for {
req, err := stream.Recv()
if err != nil {
if errors.Is(err, io.EOF) {
break
}
return fmt.Errorf("receive request: %w", err)
}
switch payload := req.GetAction().GetUserCommitFilesActionPayload().(type) {
case *gitalypb.UserCommitFilesAction_Header:
pbActions = append(pbActions, action{header: payload.Header})
case *gitalypb.UserCommitFilesAction_Content:
if len(pbActions) == 0 {
return errors.New("content sent before action")
}
// append the content to the previous action
content := &pbActions[len(pbActions)-1].content
*content = append(*content, payload.Content...)
default:
return fmt.Errorf("unhandled action payload type: %T", payload)
}
}
actions := make([]git2go.Action, 0, len(pbActions))
for _, pbAction := range pbActions {
if _, ok := gitalypb.UserCommitFilesActionHeader_ActionType_name[int32(pbAction.header.Action)]; !ok {
return structerr.NewInvalidArgument("NoMethodError: undefined method `downcase' for %d:Integer", pbAction.header.Action)
}
path, err := validatePath(repoPath, string(pbAction.header.FilePath))
if err != nil {
return structerr.NewInvalidArgument("validate path: %w", err)
}
content := io.Reader(bytes.NewReader(pbAction.content))
if pbAction.header.Base64Content {
content = base64.NewDecoder(base64.StdEncoding, content)
}
switch pbAction.header.Action {
case gitalypb.UserCommitFilesActionHeader_CREATE:
blobID, err := quarantineRepo.WriteBlob(ctx, path, content)
if err != nil {
return fmt.Errorf("write created blob: %w", err)
}
actions = append(actions, git2go.CreateFile{
OID: blobID.String(),
Path: path,
ExecutableMode: pbAction.header.ExecuteFilemode,
})
case gitalypb.UserCommitFilesActionHeader_CHMOD:
actions = append(actions, git2go.ChangeFileMode{
Path: path,
ExecutableMode: pbAction.header.ExecuteFilemode,
})
case gitalypb.UserCommitFilesActionHeader_MOVE:
prevPath, err := validatePath(repoPath, string(pbAction.header.PreviousPath))
if err != nil {
return structerr.NewInvalidArgument("validate previous path: %w", err)
}
var oid git.ObjectID
if !pbAction.header.InferContent {
var err error
oid, err = quarantineRepo.WriteBlob(ctx, path, content)
if err != nil {
return err
}
}
actions = append(actions, git2go.MoveFile{
Path: prevPath,
NewPath: path,
OID: oid.String(),
})
case gitalypb.UserCommitFilesActionHeader_UPDATE:
oid, err := quarantineRepo.WriteBlob(ctx, path, content)
if err != nil {
return fmt.Errorf("write updated blob: %w", err)
}
actions = append(actions, git2go.UpdateFile{
Path: path,
OID: oid.String(),
})
case gitalypb.UserCommitFilesActionHeader_DELETE:
actions = append(actions, git2go.DeleteFile{
Path: path,
})
case gitalypb.UserCommitFilesActionHeader_CREATE_DIR:
actions = append(actions, git2go.CreateDirectory{
Path: path,
})
}
}
now, err := dateFromProto(header)
if err != nil {
return structerr.NewInvalidArgument("%w", err)
}
committer := git2go.NewSignature(string(header.User.Name), string(header.User.Email), now)
author := committer
if len(header.CommitAuthorName) > 0 && len(header.CommitAuthorEmail) > 0 {
author = git2go.NewSignature(string(header.CommitAuthorName), string(header.CommitAuthorEmail), now)
}
commitID, err := s.git2goExecutor.Commit(ctx, quarantineRepo, git2go.CommitCommand{
Repository: repoPath,
Author: author,
Committer: committer,
Message: string(header.CommitMessage),
Parent: parentCommitOID.String(),
Actions: actions,
})
if err != nil {
return fmt.Errorf("commit: %w", err)
}
hasBranches, err := quarantineRepo.HasBranches(ctx)
if err != nil {
return fmt.Errorf("was repo created: %w", err)
}
var oldRevision git.ObjectID
if expectedOldOID := header.GetExpectedOldOid(); expectedOldOID != "" {
oldRevision, err = git.ObjectHashSHA1.FromHex(expectedOldOID)
if err != nil {
return structerr.NewInvalidArgument("invalid expected old object ID: %w", err).WithMetadata("old_object_id", expectedOldOID)
}
oldRevision, err = s.localrepo(header.GetRepository()).ResolveRevision(
ctx, git.Revision(fmt.Sprintf("%s^{object}", oldRevision)),
)
if err != nil {
return structerr.NewInvalidArgument("cannot resolve expected old object ID: %w", err).
WithMetadata("old_object_id", expectedOldOID)
}
} else {
oldRevision = parentCommitOID
if targetBranchCommit == "" {
oldRevision = git.ObjectHashSHA1.ZeroOID
} else if header.Force {
oldRevision = targetBranchCommit
}
}
if err := s.updateReferenceWithHooks(ctx, header.GetRepository(), header.User, quarantineDir, targetBranchName, commitID, oldRevision); err != nil {
if errors.As(err, &updateref.Error{}) {
return structerr.NewFailedPrecondition("%w", err)
}
return fmt.Errorf("update reference: %w", err)
}
return stream.SendAndClose(&gitalypb.UserCommitFilesResponse{BranchUpdate: &gitalypb.OperationBranchUpdate{
CommitId: commitID.String(),
RepoCreated: !hasBranches,
BranchCreated: git.ObjectHashSHA1.IsZeroOID(oldRevision),
}})
}
func sameRepository(repoA, repoB *gitalypb.Repository) bool {
return repoA.GetStorageName() == repoB.GetStorageName() &&
repoA.GetRelativePath() == repoB.GetRelativePath()
}
func (s *Server) resolveParentCommit(
ctx context.Context,
local git.Repository,
remote *gitalypb.Repository,
targetBranch git.ReferenceName,
targetBranchCommit git.ObjectID,
startBranch string,
) (git.ObjectID, error) {
if remote == nil && startBranch == "" {
return targetBranchCommit, nil
}
repo := local
if remote != nil {
var err error
repo, err = remoterepo.New(ctx, remote, s.conns)
if err != nil {
return "", fmt.Errorf("remote repository: %w", err)
}
}
if hasBranches, err := repo.HasBranches(ctx); err != nil {
return "", fmt.Errorf("has branches: %w", err)
} else if !hasBranches {
// GitLab sends requests to UserCommitFiles where target repository
// and start repository are the same. If the request hits Gitaly directly,
// Gitaly could check if the repos are the same by comparing their storages
// and relative paths and simply resolve the branch locally. When request is proxied
// through Praefect, the start repository's storage is not rewritten, thus Gitaly can't
// identify the repos as being the same.
//
// If the start repository is set, we have to resolve the branch there as it
// might be on a different commit than the local repository. As Gitaly can't identify
// the repositories are the same behind Praefect, it has to perform an RPC to resolve
// the branch. The resolving would fail as the branch does not yet exist in the start
// repository, which is actually the local repository.
//
// Due to this, we check if the remote has any branches. If not, we likely hit this case
// and we're creating the first branch. If so, we'll just return the commit that was
// already resolved locally.
//
// See: https://gitlab.com/gitlab-org/gitaly/-/issues/3294
return targetBranchCommit, nil
}
branch := targetBranch
if startBranch != "" {
branch = git.NewReferenceNameFromBranchName(startBranch)
}
refish := branch + "^{commit}"
commit, err := repo.ResolveRevision(ctx, git.Revision(refish))
if err != nil {
return "", fmt.Errorf("resolving refish %q in %T: %w", refish, repo, err)
}
return commit, nil
}
func (s *Server) fetchMissingCommit(
ctx context.Context,
localRepo *localrepo.Repo,
remoteRepo *gitalypb.Repository,
commit git.ObjectID,
) error {
if _, err := localRepo.ResolveRevision(ctx, commit.Revision()+"^{commit}"); err != nil {
if !errors.Is(err, git.ErrReferenceNotFound) || remoteRepo == nil {
return fmt.Errorf("lookup parent commit: %w", err)
}
if err := localRepo.FetchInternal(
ctx,
remoteRepo,
[]string{commit.String()},
localrepo.FetchOpts{Tags: localrepo.FetchOptsTagsNone},
); err != nil {
return fmt.Errorf("fetch parent commit: %w", err)
}
}
return nil
}
func validateUserCommitFilesHeader(header *gitalypb.UserCommitFilesRequestHeader) error {
if err := service.ValidateRepository(header.GetRepository()); err != nil {
return err
}
if header.GetUser() == nil {
return errors.New("empty User")
}
if len(header.GetCommitMessage()) == 0 {
return errors.New("empty CommitMessage")
}
if len(header.GetBranchName()) == 0 {
return errors.New("empty BranchName")
}
startSha := header.GetStartSha()
if len(startSha) > 0 {
err := git.ObjectHashSHA1.ValidateHex(startSha)
if err != nil {
return err
}
}
return nil
}
|