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 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
|
package backup
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"gitlab.com/gitlab-org/gitaly/v16/client"
"gitlab.com/gitlab-org/gitaly/v16/internal/git"
"gitlab.com/gitlab-org/gitaly/v16/internal/git/catfile"
"gitlab.com/gitlab-org/gitaly/v16/internal/git/localrepo"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/storage"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/transaction"
"gitlab.com/gitlab-org/gitaly/v16/proto/go/gitalypb"
"google.golang.org/protobuf/proto"
)
var (
// ErrSkipped means the repository was skipped because there was nothing to backup
ErrSkipped = errors.New("repository skipped")
// ErrDoesntExist means that the data was not found.
ErrDoesntExist = errors.New("doesn't exist")
)
// Sink is an abstraction over the real storage used for storing/restoring backups.
type Sink interface {
// GetWriter saves the written data to relativePath. It is the callers
// responsibility to call Close and check any subsequent errors.
GetWriter(ctx context.Context, relativePath string) (io.WriteCloser, error)
// GetReader returns a reader that servers the data stored by relativePath.
// If relativePath doesn't exists the ErrDoesntExist will be returned.
GetReader(ctx context.Context, relativePath string) (io.ReadCloser, error)
}
// Backup represents all the information needed to restore a backup for a repository
type Backup struct {
// Steps are the ordered list of steps required to restore this backup
Steps []Step
}
// Step represents an incremental step that makes up a complete backup for a repository
type Step struct {
// BundlePath is the path of the bundle
BundlePath string
// SkippableOnNotFound defines if the bundle can be skipped when it does
// not exist. This allows us to maintain legacy behaviour where we always
// check a specific location for a bundle without knowing if it exists.
SkippableOnNotFound bool
// RefPath is the path of the ref file
RefPath string
// PreviousRefPath is the path of the previous ref file
PreviousRefPath string
// CustomHooksPath is the path of the custom hooks archive
CustomHooksPath string
}
// Locator finds sink backup paths for repositories
type Locator interface {
// BeginFull returns a tentative first step needed to create a new full backup.
BeginFull(ctx context.Context, repo *gitalypb.Repository, backupID string) *Step
// BeginIncremental returns a tentative step needed to create a new incremental backup.
BeginIncremental(ctx context.Context, repo *gitalypb.Repository, backupID string) (*Step, error)
// Commit persists the step so that it can be looked up by FindLatest
Commit(ctx context.Context, step *Step) error
// FindLatest returns the latest backup that was written by Commit
FindLatest(ctx context.Context, repo *gitalypb.Repository) (*Backup, error)
}
// Repository abstracts git access required to make a repository backup
type Repository interface {
// IsEmpty returns true if the repository has no branches.
IsEmpty(ctx context.Context) (bool, error)
// ListRefs fetches the full set of refs and targets for the repository.
ListRefs(ctx context.Context) ([]git.Reference, error)
// GetCustomHooks fetches the custom hooks archive.
GetCustomHooks(ctx context.Context, out io.Writer) error
// CreateBundle fetches a bundle that contains refs matching patterns.
CreateBundle(ctx context.Context, out io.Writer, patterns io.Reader) error
// Remove removes the repository. Does not return an error if the
// repository cannot be found.
Remove(ctx context.Context) error
// Create creates the repository.
Create(ctx context.Context) error
// FetchBundle fetches references from a bundle. Refs will be mirrored to
// the repository.
FetchBundle(ctx context.Context, reader io.Reader) error
// SetCustomHooks updates the custom hooks for the repository.
SetCustomHooks(ctx context.Context, reader io.Reader) error
}
// ResolveLocator returns a locator implementation based on a locator identifier.
func ResolveLocator(layout string, sink Sink) (Locator, error) {
legacy := LegacyLocator{}
switch layout {
case "legacy":
return legacy, nil
case "pointer":
return PointerLocator{
Sink: sink,
Fallback: legacy,
}, nil
default:
return nil, fmt.Errorf("unknown layout: %q", layout)
}
}
// Manager manages process of the creating/restoring backups.
type Manager struct {
sink Sink
conns *client.Pool
locator Locator
// backupID allows setting the same full backup ID for every repository at
// once. We may use this to make it easier to specify a backup to restore
// from, rather than always selecting the latest.
backupID string
// repositoryFactory returns an abstraction over git repositories in order
// to create and restore backups.
repositoryFactory func(ctx context.Context, repo *gitalypb.Repository, server storage.ServerInfo) (Repository, error)
}
// NewManager creates and returns initialized *Manager instance.
func NewManager(sink Sink, locator Locator, pool *client.Pool, backupID string) *Manager {
return &Manager{
sink: sink,
conns: pool,
locator: locator,
backupID: backupID,
repositoryFactory: func(ctx context.Context, repo *gitalypb.Repository, server storage.ServerInfo) (Repository, error) {
if err := setContextServerInfo(ctx, &server, repo.GetStorageName()); err != nil {
return nil, err
}
conn, err := pool.Dial(ctx, server.Address, server.Token)
if err != nil {
return nil, err
}
return newRemoteRepository(repo, conn), nil
},
}
}
// NewManagerLocal creates and returns a *Manager instance for operating on local repositories.
func NewManagerLocal(
sink Sink,
locator Locator,
storageLocator storage.Locator,
gitCmdFactory git.CommandFactory,
catfileCache catfile.Cache,
txManager transaction.Manager,
backupID string,
) *Manager {
return &Manager{
sink: sink,
conns: nil, // Will be removed once the restore operations are part of the Repository interface.
locator: locator,
backupID: backupID,
repositoryFactory: func(ctx context.Context, repo *gitalypb.Repository, server storage.ServerInfo) (Repository, error) {
localRepo := localrepo.New(storageLocator, gitCmdFactory, catfileCache, repo)
return newLocalRepository(storageLocator, gitCmdFactory, txManager, localRepo), nil
},
}
}
// RemoveAllRepositoriesRequest is the request to remove all repositories in the specified
// storage name.
type RemoveAllRepositoriesRequest struct {
Server storage.ServerInfo
StorageName string
}
// RemoveAllRepositories removes all repositories in the specified storage name.
func (mgr *Manager) RemoveAllRepositories(ctx context.Context, req *RemoveAllRepositoriesRequest) error {
if err := setContextServerInfo(ctx, &req.Server, req.StorageName); err != nil {
return fmt.Errorf("manager: %w", err)
}
repoClient, err := mgr.newRepoClient(ctx, req.Server)
if err != nil {
return fmt.Errorf("manager: %w", err)
}
_, err = repoClient.RemoveAll(ctx, &gitalypb.RemoveAllRequest{StorageName: req.StorageName})
if err != nil {
return fmt.Errorf("manager: %w", err)
}
return nil
}
// CreateRequest is the request to create a backup
type CreateRequest struct {
Server storage.ServerInfo
Repository *gitalypb.Repository
Incremental bool
}
// Create creates a repository backup.
func (mgr *Manager) Create(ctx context.Context, req *CreateRequest) error {
repo, err := mgr.repositoryFactory(ctx, req.Repository, req.Server)
if err != nil {
return fmt.Errorf("manager: %w", err)
}
if isEmpty, err := repo.IsEmpty(ctx); err != nil {
return fmt.Errorf("manager: %w", err)
} else if isEmpty {
return fmt.Errorf("manager: repository empty: %w", ErrSkipped)
}
var step *Step
if req.Incremental {
var err error
step, err = mgr.locator.BeginIncremental(ctx, req.Repository, mgr.backupID)
if err != nil {
return fmt.Errorf("manager: %w", err)
}
} else {
step = mgr.locator.BeginFull(ctx, req.Repository, mgr.backupID)
}
refs, err := repo.ListRefs(ctx)
if err != nil {
return fmt.Errorf("manager: %w", err)
}
if err := mgr.writeRefs(ctx, step.RefPath, refs); err != nil {
return fmt.Errorf("manager: %w", err)
}
if err := mgr.writeBundle(ctx, repo, step, refs); err != nil {
return fmt.Errorf("manager: %w", err)
}
if err := mgr.writeCustomHooks(ctx, repo, step.CustomHooksPath); err != nil {
return fmt.Errorf("manager: %w", err)
}
if err := mgr.locator.Commit(ctx, step); err != nil {
return fmt.Errorf("manager: %w", err)
}
return nil
}
// RestoreRequest is the request to restore from a backup
type RestoreRequest struct {
Server storage.ServerInfo
Repository *gitalypb.Repository
AlwaysCreate bool
}
// Restore restores a repository from a backup.
func (mgr *Manager) Restore(ctx context.Context, req *RestoreRequest) error {
repo, err := mgr.repositoryFactory(ctx, req.Repository, req.Server)
if err != nil {
return fmt.Errorf("manager: %w", err)
}
if err := repo.Remove(ctx); err != nil {
return fmt.Errorf("manager: %w", err)
}
backup, err := mgr.locator.FindLatest(ctx, req.Repository)
if err != nil {
return fmt.Errorf("manager: %w", err)
}
if err := repo.Create(ctx); err != nil {
return fmt.Errorf("manager: %w", err)
}
for _, step := range backup.Steps {
if err := mgr.restoreBundle(ctx, repo, step.BundlePath); err != nil {
if step.SkippableOnNotFound && errors.Is(err, ErrDoesntExist) {
// For compatibility with existing backups we need to make sure the
// repository exists even if there's no bundle for project
// repositories (not wiki or snippet repositories). Gitaly does
// not know which repository is which type so here we accept a
// parameter to tell us to employ this behaviour. Since the
// repository has already been created, we simply skip cleaning up.
if req.AlwaysCreate {
return nil
}
if err := repo.Remove(ctx); err != nil {
return fmt.Errorf("manager: remove on skipped: %w", err)
}
return fmt.Errorf("manager: %w: %s", ErrSkipped, err.Error())
}
}
if err := mgr.restoreCustomHooks(ctx, repo, step.CustomHooksPath); err != nil {
return fmt.Errorf("manager: %w", err)
}
}
return nil
}
// setContextServerInfo overwrites server with gitaly connection info from ctx metadata when server is zero.
func setContextServerInfo(ctx context.Context, server *storage.ServerInfo, storageName string) error {
if !server.Zero() {
return nil
}
var err error
*server, err = storage.ExtractGitalyServer(ctx, storageName)
if err != nil {
return fmt.Errorf("set context server info: %w", err)
}
return nil
}
func (mgr *Manager) writeBundle(ctx context.Context, repo Repository, step *Step, refs []git.Reference) (returnErr error) {
negatedRefs, err := mgr.negatedKnownRefs(ctx, step)
if err != nil {
return fmt.Errorf("write bundle: %w", err)
}
defer func() {
if err := negatedRefs.Close(); err != nil && returnErr == nil {
returnErr = fmt.Errorf("write bundle: %w", err)
}
}()
patternReader, patternWriter := io.Pipe()
defer func() {
if err := patternReader.Close(); err != nil && returnErr == nil {
returnErr = fmt.Errorf("write bundle: %w", err)
}
}()
go func() {
defer patternWriter.Close()
for _, ref := range refs {
_, err := fmt.Fprintln(patternWriter, ref.Name)
if err != nil {
_ = patternWriter.CloseWithError(err)
return
}
}
}()
w := NewLazyWriter(func() (io.WriteCloser, error) {
return mgr.sink.GetWriter(ctx, step.BundlePath)
})
defer func() {
if err := w.Close(); err != nil && returnErr == nil {
returnErr = fmt.Errorf("write bundle: %w", err)
}
}()
if err := repo.CreateBundle(ctx, w, io.MultiReader(negatedRefs, patternReader)); err != nil {
if errors.Is(err, localrepo.ErrEmptyBundle) {
return fmt.Errorf("write bundle: %w: no changes to bundle", ErrSkipped)
}
return fmt.Errorf("write bundle: %w", err)
}
return nil
}
func (mgr *Manager) negatedKnownRefs(ctx context.Context, step *Step) (io.ReadCloser, error) {
if len(step.PreviousRefPath) == 0 {
return io.NopCloser(new(bytes.Reader)), nil
}
r, w := io.Pipe()
go func() {
defer w.Close()
reader, err := mgr.sink.GetReader(ctx, step.PreviousRefPath)
if err != nil {
_ = w.CloseWithError(err)
return
}
defer reader.Close()
d := git.NewShowRefDecoder(reader)
for {
var ref git.Reference
if err := d.Decode(&ref); err == io.EOF {
break
} else if err != nil {
_ = w.CloseWithError(err)
return
}
if _, err := fmt.Fprintf(w, "^%s\n", ref.Target); err != nil {
_ = w.CloseWithError(err)
return
}
}
}()
return r, nil
}
type createBundleFromRefListSender struct {
stream gitalypb.RepositoryService_CreateBundleFromRefListClient
chunk gitalypb.CreateBundleFromRefListRequest
}
// Reset should create a fresh response message.
func (s *createBundleFromRefListSender) Reset() {
s.chunk = gitalypb.CreateBundleFromRefListRequest{}
}
// Append should append the given item to the slice in the current response message
func (s *createBundleFromRefListSender) Append(msg proto.Message) {
req := msg.(*gitalypb.CreateBundleFromRefListRequest)
s.chunk.Repository = req.GetRepository()
s.chunk.Patterns = append(s.chunk.Patterns, req.Patterns...)
}
// Send should send the current response message
func (s *createBundleFromRefListSender) Send() error {
return s.stream.Send(&s.chunk)
}
func (mgr *Manager) restoreBundle(ctx context.Context, repo Repository, path string) error {
reader, err := mgr.sink.GetReader(ctx, path)
if err != nil {
return fmt.Errorf("restore bundle: %q: %w", path, err)
}
defer reader.Close()
if err := repo.FetchBundle(ctx, reader); err != nil {
return fmt.Errorf("restore bundle: %q: %w", path, err)
}
return nil
}
func (mgr *Manager) writeCustomHooks(ctx context.Context, repo Repository, path string) (returnErr error) {
w := NewLazyWriter(func() (io.WriteCloser, error) {
return mgr.sink.GetWriter(ctx, path)
})
defer func() {
if err := w.Close(); err != nil && returnErr == nil {
returnErr = fmt.Errorf("write custom hooks: %w", err)
}
}()
if err := repo.GetCustomHooks(ctx, w); err != nil {
return fmt.Errorf("write custom hooks: %w", err)
}
return nil
}
func (mgr *Manager) restoreCustomHooks(ctx context.Context, repo Repository, path string) error {
reader, err := mgr.sink.GetReader(ctx, path)
if err != nil {
if errors.Is(err, ErrDoesntExist) {
return nil
}
return fmt.Errorf("restore custom hooks: %w", err)
}
defer reader.Close()
if err := repo.SetCustomHooks(ctx, reader); err != nil {
return fmt.Errorf("restore custom hooks, %q: %w", path, err)
}
return nil
}
// writeRefs writes the previously fetched list of refs in the same output
// format as `git-show-ref(1)`
func (mgr *Manager) writeRefs(ctx context.Context, path string, refs []git.Reference) (returnErr error) {
w, err := mgr.sink.GetWriter(ctx, path)
if err != nil {
return fmt.Errorf("write refs: %w", err)
}
defer func() {
if err := w.Close(); err != nil && returnErr == nil {
returnErr = fmt.Errorf("write refs: %w", err)
}
}()
for _, ref := range refs {
_, err = fmt.Fprintf(w, "%s %s\n", ref.Target, ref.Name)
if err != nil {
return fmt.Errorf("write refs: %w", err)
}
}
return nil
}
func (mgr *Manager) newRepoClient(ctx context.Context, server storage.ServerInfo) (gitalypb.RepositoryServiceClient, error) {
conn, err := mgr.conns.Dial(ctx, server.Address, server.Token)
if err != nil {
return nil, err
}
return gitalypb.NewRepositoryServiceClient(conn), nil
}
|