Skip to content

Git designed for AI agents.

6.1 KB
Raw Blame
package localrepo

import (
	"bytes"
	"context"
	"errors"
	"fmt"
	"io"
	"os"
	"path/filepath"
	"regexp"

	"github.com/feder-cr/git-ai/internal/archive"
	"github.com/feder-cr/git-ai/internal/git"
	"github.com/feder-cr/git-ai/internal/structerr"
)

var objectFiles = []*regexp.Regexp{
	// Patterns for loose objects and packfiles in SHA1 repository.
	regexp.MustCompile(`/[[:xdigit:]]{2}/[[:xdigit:]]{38}\z`),
	regexp.MustCompile(`/pack/pack\-[[:xdigit:]]{40}\.(pack|idx)\z`),
	// Patterns for loose objects and packfiles in SHA256 repository.
	regexp.MustCompile(`/[[:xdigit:]]{2}/[[:xdigit:]]{62}\z`),
	regexp.MustCompile(`/pack/pack\-[[:xdigit:]]{64}\.(pack|idx)\z`),
}

// ErrSnapshotAlternates is returned when an alternates file cannot be read.
var ErrSnapshotAlternates = errors.New("error getting alternate object directories")

// CreateSnapshot creates a tar archive of the repository. This archive may be
// corrupt if created during concurrent writes.
func (repo *Repo) CreateSnapshot(ctx context.Context, out io.Writer) error {
	path, err := repo.locator.GetRepoPath(ctx, repo)
	if err != nil {
		return err
	}
	storageRoot, err := repo.locator.GetStorageByName(ctx, repo.GetStorageName())
	if err != nil {
		return fmt.Errorf("get storage path: %w", err)
	}

	// Building a raw archive may race with `git push`, but GitLab can enforce
	// concurrency control if necessary. Using `TarBuilder` means we can keep
	// going even if some files are added or removed during the operation.
	builder := archive.NewTarBuilder(path, out)

	// Pick files directly by filename so we can get a snapshot even if the
	// repository is corrupted. https://gitirc.eu/gitrepository-layout.html
	// documents the various files and directories. We exclude the following
	// on purpose:
	//
	//   * branches - legacy, not replicated by git fetch
	//   * commondir - may differ between sites
	//   * custom-hooks - GitLab-specific, no supported in Geo, may differ between sites
	//   * hooks - symlink, may differ between sites
	//   * {shared,}index[.*] - not found in bare repositories
	//   * info/{attributes,exclude,grafts} - not replicated by git fetch
	//   * info/refs - dumb protocol only
	//   * logs/* - not replicated by git fetch
	//   * modules/* - not replicated by git fetch
	//   * objects/info/* - unneeded (dumb protocol) or to do with alternates
	//   * worktrees/* - not replicated by git fetch

	// References
	_ = builder.FileIfExist("HEAD")
	_ = builder.FileIfExist("packed-refs")
	// Only include core.repositoryFormatVersion and extensions.* from the config file
	_ = builder.FileWithEdit("config", false, filterGitConfig)
	_ = builder.RecursiveDirIfExist("refs")
	_ = builder.RecursiveDirIfExist("reftable")
	_ = builder.RecursiveDirIfExist("branches")

	// The MVCC manifest pointer, manifests, and artifacts.
	_ = builder.FileIfExist("mvcc/manifest")
	_ = builder.RecursiveDirIfExist("mvcc/manifests")
	_ = builder.RecursiveDirIfExist("mvcc/refs")
	_ = builder.RecursiveDirIfExist("mvcc/pack")

	// The packfiles + any loose objects.
	_ = builder.RecursiveDirIfExist("objects", objectFiles...)

	// In case this repository is a shallow clone. Seems unlikely, but better
	// safe than sorry.
	_ = builder.FileIfExist("shallow")

	if err := repo.addAlternateFiles(ctx, builder, storageRoot, path); err != nil {
		return structerr.NewInternal("add alternates: %w", err)
	}

	if err := builder.Close(); err != nil {
		return structerr.NewInternal("building snapshot failed: %w", err)
	}

	return nil
}

// filterGitConfig filters the config file to only include
// core.repositoryFormatVersion and extensions.* sections. These are the
// entries which indicate the object format (SHA-1 vs SHA-256) and any other
// custom attributes.
func filterGitConfig(data []byte) ([]byte, error) {
	var result [][]byte
	var currentSection string

	for _, line := range bytes.Split(data, []byte("\n")) {
		trimmed := bytes.TrimSpace(line)

		// Look for [section] headers
		if len(trimmed) > 0 && trimmed[0] == '[' {
			end := bytes.IndexByte(trimmed, ']')
			if end != -1 {
				currentSection = string(bytes.ToLower(trimmed[1:end]))
				// Treat [extensions "foo"] like [extensions]
				if space := bytes.IndexByte(trimmed[1:end], ' '); space != -1 {
					currentSection = string(bytes.ToLower(trimmed[1 : 1+space]))
				}
			}
		}

		switch currentSection {
		case "core":
			// Only include repositoryformatversion from [core].
			if bytes.HasPrefix(trimmed, []byte("[")) || bytes.Contains(bytes.ToLower(trimmed), []byte("repositoryformatversion")) {
				result = append(result, line)
			}
		case "extensions":
			// Include the entire [extensions] section.
			result = append(result, line)
		}
	}

	if len(result) == 0 {
		return nil, nil
	}

	return append(bytes.Join(result, []byte("\n")), '\n'), nil
}

func (repo *Repo) addAlternateFiles(ctx context.Context, builder *archive.TarBuilder, storageRoot, repoPath string) error {
	altObjDirs, err := git.AlternateObjectDirectories(ctx, repo.logger, storageRoot, repoPath)
	if err != nil {
		return fmt.Errorf("%w: %w", ErrSnapshotAlternates, err)
	}

	for _, altObjDir := range altObjDirs {
		if err := walkAndAddToBuilder(altObjDir, builder); err != nil {
			return fmt.Errorf("walking alternates file: %w", err)
		}
	}

	return nil
}

func walkAndAddToBuilder(alternateObjDir string, builder *archive.TarBuilder) error {
	matchWalker := archive.NewMatchWalker(objectFiles, func(path string, info os.FileInfo, err error) error {
		if err != nil {
			return fmt.Errorf("error walking %v: %w", path, err)
		}

		relPath, err := filepath.Rel(alternateObjDir, path)
		if err != nil {
			return fmt.Errorf("alternative object directory path: %w", err)
		}

		file, err := os.Open(path)
		if err != nil {
			return fmt.Errorf("opening file %s: %w", path, err)
		}
		defer file.Close()

		objectPath := filepath.Join("objects", relPath)

		if err := builder.VirtualFileWithContents(objectPath, file); err != nil {
			return fmt.Errorf("expected file %v to exist: %w", path, err)
		}

		return nil
	})

	if err := filepath.Walk(alternateObjDir, matchWalker.Walk); err != nil {
		return fmt.Errorf("error when traversing: %w", err)
	}

	return nil
}