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
|
package backup
import (
"bufio"
"bytes"
"context"
"errors"
"fmt"
"io"
"gitlab.com/gitlab-org/gitaly/v16/internal/git"
"gitlab.com/gitlab-org/gitaly/v16/internal/git/localrepo"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/repoutil"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/storage"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/transaction"
"gitlab.com/gitlab-org/gitaly/v16/internal/helper/chunk"
"gitlab.com/gitlab-org/gitaly/v16/internal/structerr"
"gitlab.com/gitlab-org/gitaly/v16/proto/go/gitalypb"
"gitlab.com/gitlab-org/gitaly/v16/streamio"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)
// remoteRepository implements git repository access over GRPC
type remoteRepository struct {
repo *gitalypb.Repository
conn *grpc.ClientConn
}
func newRemoteRepository(repo *gitalypb.Repository, conn *grpc.ClientConn) *remoteRepository {
return &remoteRepository{
repo: repo,
conn: conn,
}
}
// IsEmpty returns true if the repository has no branches.
func (rr *remoteRepository) IsEmpty(ctx context.Context) (bool, error) {
client := rr.newRepoClient()
hasLocalBranches, err := client.HasLocalBranches(ctx, &gitalypb.HasLocalBranchesRequest{
Repository: rr.repo,
})
switch {
case status.Code(err) == codes.NotFound:
return true, nil
case err != nil:
return false, fmt.Errorf("remote repository: is empty: %w", err)
}
return !hasLocalBranches.GetValue(), nil
}
// ListRefs fetches the full set of refs and targets for the repository
func (rr *remoteRepository) ListRefs(ctx context.Context) ([]git.Reference, error) {
refClient := rr.newRefClient()
stream, err := refClient.ListRefs(ctx, &gitalypb.ListRefsRequest{
Repository: rr.repo,
Head: true,
Patterns: [][]byte{[]byte("refs/")},
})
if err != nil {
return nil, fmt.Errorf("remote repository: list refs: %w", err)
}
var refs []git.Reference
for {
resp, err := stream.Recv()
if errors.Is(err, io.EOF) {
break
} else if err != nil {
return nil, fmt.Errorf("remote repository: list refs: %w", err)
}
for _, ref := range resp.GetReferences() {
refs = append(refs, git.NewReference(git.ReferenceName(ref.GetName()), ref.GetTarget()))
}
}
return refs, nil
}
// GetCustomHooks fetches the custom hooks archive.
func (rr *remoteRepository) GetCustomHooks(ctx context.Context, out io.Writer) error {
repoClient := rr.newRepoClient()
stream, err := repoClient.GetCustomHooks(ctx, &gitalypb.GetCustomHooksRequest{Repository: rr.repo})
if err != nil {
return fmt.Errorf("remote repository: get custom hooks: %w", err)
}
hooks := streamio.NewReader(func() ([]byte, error) {
resp, err := stream.Recv()
return resp.GetData(), err
})
if _, err := io.Copy(out, hooks); err != nil {
return fmt.Errorf("remote repository: get custom hooks: %w", err)
}
return nil
}
// CreateBundle fetches a bundle that contains refs matching patterns.
func (rr *remoteRepository) CreateBundle(ctx context.Context, out io.Writer, patterns io.Reader) error {
repoClient := rr.newRepoClient()
stream, err := repoClient.CreateBundleFromRefList(ctx)
if err != nil {
return fmt.Errorf("remote repository: create bundle: %w", err)
}
c := chunk.New(&createBundleFromRefListSender{
stream: stream,
})
buf := bufio.NewReader(patterns)
for {
line, err := buf.ReadBytes('\n')
if errors.Is(err, io.EOF) {
break
} else if err != nil {
return fmt.Errorf("remote repository: create bundle: %w", err)
}
line = bytes.TrimSuffix(line, []byte("\n"))
if err := c.Send(&gitalypb.CreateBundleFromRefListRequest{
Repository: rr.repo,
Patterns: [][]byte{line},
}); err != nil {
return fmt.Errorf("remote repository: create bundle: %w", err)
}
}
if err := c.Flush(); err != nil {
return fmt.Errorf("remote repository: create bundle: %w", err)
}
if err := stream.CloseSend(); err != nil {
return fmt.Errorf("remote repository: create bundle: %w", err)
}
bundle := streamio.NewReader(func() ([]byte, error) {
resp, err := stream.Recv()
if structerr.GRPCCode(err) == codes.FailedPrecondition {
err = localrepo.ErrEmptyBundle
}
return resp.GetData(), err
})
if _, err := io.Copy(out, bundle); err != nil {
return fmt.Errorf("remote repository: create bundle: %w", err)
}
return nil
}
// Remove removes the repository. Does not return an error if the repository
// cannot be found.
func (rr *remoteRepository) Remove(ctx context.Context) error {
repoClient := rr.newRepoClient()
_, err := repoClient.RemoveRepository(ctx, &gitalypb.RemoveRepositoryRequest{
Repository: rr.repo,
})
switch {
case status.Code(err) == codes.NotFound:
return nil
case err != nil:
return fmt.Errorf("remote repository: remove: %w", err)
}
return nil
}
// Create creates the repository.
func (rr *remoteRepository) Create(ctx context.Context) error {
repoClient := rr.newRepoClient()
if _, err := repoClient.CreateRepository(ctx, &gitalypb.CreateRepositoryRequest{Repository: rr.repo}); err != nil {
return fmt.Errorf("remote repository: create: %w", err)
}
return nil
}
// FetchBundle fetches references from a bundle. Refs will be mirrored to the
// repository.
func (rr *remoteRepository) FetchBundle(ctx context.Context, reader io.Reader) error {
repoClient := rr.newRepoClient()
stream, err := repoClient.FetchBundle(ctx)
if err != nil {
return fmt.Errorf("remote repository: fetch bundle: %w", err)
}
request := &gitalypb.FetchBundleRequest{Repository: rr.repo, UpdateHead: true}
bundle := streamio.NewWriter(func(p []byte) error {
request.Data = p
if err := stream.Send(request); err != nil {
return err
}
// Only set `Repository` on the first `Send` of the stream
request = &gitalypb.FetchBundleRequest{}
return nil
})
if _, err := io.Copy(bundle, reader); err != nil {
return fmt.Errorf("remote repository: fetch bundle: %w", err)
}
if _, err = stream.CloseAndRecv(); err != nil {
return fmt.Errorf("remote repository: fetch bundle: %w", err)
}
return nil
}
// SetCustomHooks updates the custom hooks for the repository.
func (rr *remoteRepository) SetCustomHooks(ctx context.Context, reader io.Reader) error {
repoClient := rr.newRepoClient()
stream, err := repoClient.SetCustomHooks(ctx)
if err != nil {
return fmt.Errorf("remote repository: set custom hooks: %w", err)
}
request := &gitalypb.SetCustomHooksRequest{Repository: rr.repo}
bundle := streamio.NewWriter(func(p []byte) error {
request.Data = p
if err := stream.Send(request); err != nil {
return err
}
// Only set `Repository` on the first `Send` of the stream
request = &gitalypb.SetCustomHooksRequest{}
return nil
})
if _, err := io.Copy(bundle, reader); err != nil {
return fmt.Errorf("remote repository: set custom hooks: %w", err)
}
if _, err = stream.CloseAndRecv(); err != nil {
return fmt.Errorf("remote repository: set custom hooks: %w", err)
}
return nil
}
func (rr *remoteRepository) newRepoClient() gitalypb.RepositoryServiceClient {
return gitalypb.NewRepositoryServiceClient(rr.conn)
}
func (rr *remoteRepository) newRefClient() gitalypb.RefServiceClient {
return gitalypb.NewRefServiceClient(rr.conn)
}
type localRepository struct {
locator storage.Locator
gitCmdFactory git.CommandFactory
txManager transaction.Manager
repo *localrepo.Repo
}
func newLocalRepository(
locator storage.Locator,
gitCmdFactory git.CommandFactory,
txManager transaction.Manager,
repo *localrepo.Repo,
) *localRepository {
return &localRepository{
locator: locator,
gitCmdFactory: gitCmdFactory,
txManager: txManager,
repo: repo,
}
}
// IsEmpty returns true if the repository has no branches.
func (r *localRepository) IsEmpty(ctx context.Context) (bool, error) {
if err := r.locator.ValidateRepository(r.repo); err != nil {
if errors.Is(err, storage.ErrRepositoryNotFound) {
// Backups do not currently differentiate between non-existent and
// empty. See https://gitlab.com/gitlab-org/gitlab/-/issues/357044
return true, nil
}
return false, fmt.Errorf("local repository: verifying repository: %w", err)
}
hasBranches, err := r.repo.HasBranches(ctx)
if err != nil {
return false, fmt.Errorf("local repository: is empty: %w", err)
}
return !hasBranches, nil
}
// ListRefs fetches the full set of refs and targets for the repository.
func (r *localRepository) ListRefs(ctx context.Context) ([]git.Reference, error) {
refs, err := r.repo.GetReferences(ctx, "refs/")
if err != nil {
return nil, fmt.Errorf("local repository: list refs: %w", err)
}
headOID, err := r.repo.ResolveRevision(ctx, git.Revision("HEAD"))
switch {
case errors.Is(err, git.ErrReferenceNotFound):
// Nothing to add
case err != nil:
return nil, structerr.NewInternal("local repository: list refs: %w", err)
default:
head := git.NewReference("HEAD", headOID.String())
refs = append([]git.Reference{head}, refs...)
}
return refs, nil
}
// GetCustomHooks fetches the custom hooks archive.
func (r *localRepository) GetCustomHooks(ctx context.Context, out io.Writer) error {
if err := repoutil.GetCustomHooks(ctx, r.locator, out, r.repo); err != nil {
return fmt.Errorf("local repository: get custom hooks: %w", err)
}
return nil
}
// CreateBundle fetches a bundle that contains refs matching patterns.
func (r *localRepository) CreateBundle(ctx context.Context, out io.Writer, patterns io.Reader) error {
err := r.repo.CreateBundle(ctx, out, &localrepo.CreateBundleOpts{
Patterns: patterns,
})
if err != nil {
return fmt.Errorf("local repository: create bundle: %w", err)
}
return nil
}
// Remove removes the repository. Does not return an error if the repository
// cannot be found.
func (r *localRepository) Remove(ctx context.Context) error {
err := repoutil.Remove(ctx, r.locator, r.txManager, r.repo)
switch {
case status.Code(err) == codes.NotFound:
return nil
case err != nil:
return fmt.Errorf("local repository: remove: %w", err)
}
return nil
}
// Create creates the repository.
func (r *localRepository) Create(ctx context.Context) error {
if err := repoutil.Create(
ctx,
r.locator,
r.gitCmdFactory,
r.txManager,
r.repo,
func(repository *gitalypb.Repository) error { return nil },
); err != nil {
return fmt.Errorf("local repository: create: %w", err)
}
return nil
}
// FetchBundle fetches references from a bundle. Refs will be mirrored to the
// repository.
func (r *localRepository) FetchBundle(ctx context.Context, reader io.Reader) error {
err := r.repo.FetchBundle(ctx, r.txManager, reader, &localrepo.FetchBundleOpts{
UpdateHead: true,
})
if err != nil {
return fmt.Errorf("local repository: fetch bundle: %w", err)
}
return nil
}
// SetCustomHooks updates the custom hooks for the repository.
func (r *localRepository) SetCustomHooks(ctx context.Context, reader io.Reader) error {
if err := repoutil.SetCustomHooks(
ctx,
r.locator,
r.txManager,
reader,
r.repo,
); err != nil {
return fmt.Errorf("local repository: set custom hooks: %w", err)
}
return nil
}
|