Skip to content

Disable automatic Git maintenance in cloner #4554

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
winor30 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Disable automatic Git maintenance in cloner #4554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 25 additions & 9 deletions private/pkg/git/cloner.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"errors"
"fmt"
"log/slog"
"slices"
"strconv"
"strings"

Expand All @@ -37,6 +38,21 @@ type cloner struct {
options ClonerOptions
}

// gitConfigNoAutoMaintenanceArgs prevents background Git tasks from racing with
// storage.Copy over files in the cloned .git directory.
var gitConfigNoAutoMaintenanceArgs = []string{
"-c",
"maintenance.auto=false",
"-c",
"maintenance.autoDetach=false",
"-c",
"gc.auto=0",
"-c",
"gc.autoDetach=false",
"-c",
"fetch.writeCommitGraph=false",
}

func newCloner(
logger *slog.Logger,
storageosProvider storageos.Provider,
Expand Down Expand Up @@ -118,15 +134,15 @@ func (c *cloner) CloneToBucket(
return newGitCommandError(err, buffer)
}

var gitConfigAuthArgs []string
gitConfigArgs := slices.Clone(gitConfigNoAutoMaintenanceArgs)
if strings.HasPrefix(url, "https://") {
// These extraArgs MUST be first, as the -c flag potentially produced
// is only a flag on the parent git command, not on git fetch.
// These extraArgs MUST be before the sub-command, as the -c flag potentially
// produced is only a flag on the parent git command, not on git fetch.
extraArgs, err := c.getArgsForHTTPSCommand(envContainer)
if err != nil {
return err
}
gitConfigAuthArgs = append(gitConfigAuthArgs, extraArgs...)
gitConfigArgs = append(gitConfigArgs, extraArgs...)
}

if strings.HasPrefix(url, "ssh://") {
Expand All @@ -138,7 +154,7 @@ func (c *cloner) CloneToBucket(

// Build the args for the fetch command.
fetchArgs := []string{}
fetchArgs = append(fetchArgs, gitConfigAuthArgs...)
fetchArgs = append(fetchArgs, gitConfigArgs...)
fetchArgs = append(
fetchArgs,
"fetch",
Expand Down Expand Up @@ -191,7 +207,7 @@ func (c *cloner) CloneToBucket(
if err := xexec.Run(
ctx,
"git",
xexec.WithArgs(append(gitConfigAuthArgs, "sparse-checkout", "set", options.SubDir)...),
xexec.WithArgs(append(gitConfigArgs, "sparse-checkout", "set", options.SubDir)...),
xexec.WithEnv(app.Environ(envContainer)),
xexec.WithStderr(buffer),
xexec.WithDir(baseDir.Path()),
Expand All @@ -206,7 +222,7 @@ func (c *cloner) CloneToBucket(
if err := xexec.Run(
ctx,
"git",
xexec.WithArgs(append(gitConfigAuthArgs, "checkout", "--force", "FETCH_HEAD")...),
xexec.WithArgs(append(gitConfigArgs, "checkout", "--force", "FETCH_HEAD")...),
xexec.WithEnv(app.Environ(envContainer)),
xexec.WithStderr(buffer),
xexec.WithDir(baseDir.Path()),
Expand All @@ -220,7 +236,7 @@ func (c *cloner) CloneToBucket(
if err := xexec.Run(
ctx,
"git",
xexec.WithArgs(append(gitConfigAuthArgs, "checkout", "--force", checkoutRef)...),
xexec.WithArgs(append(gitConfigArgs, "checkout", "--force", checkoutRef)...),
xexec.WithEnv(app.Environ(envContainer)),
xexec.WithStderr(buffer),
xexec.WithDir(baseDir.Path()),
Expand All @@ -235,7 +251,7 @@ func (c *cloner) CloneToBucket(
ctx,
"git",
xexec.WithArgs(append(
gitConfigAuthArgs,
gitConfigArgs,
"submodule",
"update",
"--init",
Expand Down
47 changes: 47 additions & 0 deletions private/pkg/git/git_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ package git

import (
"context"
"encoding/json"
"errors"
"fmt"
"io/fs"
Expand All @@ -24,6 +25,7 @@ import (
"os"
"os/exec"
"path/filepath"
"slices"
"strings"
"testing"

Expand Down Expand Up @@ -70,6 +72,51 @@ func TestGitCloner(t *testing.T) {
assert.Equal(t, "// submodule", string(content))
})

t.Run("auto_maintenance_disabled", func(t *testing.T) {
t.Parallel()

tracePath := filepath.Join(t.TempDir(), "git-trace.json")
readBucketForName(ctx, t, workDir, readBucketForNameOptions{
recurseSubmodules: true,
envOverrides: map[string]string{
"GIT_TRACE2_EVENT": tracePath,
},
})

traceData, err := os.ReadFile(tracePath)
require.NoError(t, err)

var gitArgvs [][]string
for line := range strings.SplitSeq(string(traceData), "\n") {
if line == "" {
continue
}
var event struct {
Event string `json:"event"`
Argv []string `json:"argv"`
}
require.NoError(t, json.Unmarshal([]byte(line), &event))
if event.Event == "start" && len(event.Argv) > 0 {
gitArgvs = append(gitArgvs, event.Argv)
}
}

for _, subcommand := range []string{"fetch", "checkout", "submodule"} {
var found bool
for _, argv := range gitArgvs {
subcommandIndex := slices.Index(argv, subcommand)
if subcommandIndex < 0 {
continue
}
require.GreaterOrEqual(t, subcommandIndex, len(gitConfigNoAutoMaintenanceArgs))
assert.Equal(t, gitConfigNoAutoMaintenanceArgs, argv[subcommandIndex-len(gitConfigNoAutoMaintenanceArgs):subcommandIndex])
found = true
break
}
require.Truef(t, found, "missing git %q invocation", subcommand)
}
})

t.Run("main", func(t *testing.T) {
t.Parallel()
readBucket := readBucketForName(ctx, t, workDir, readBucketForNameOptions{name: NewBranchName("main")})
Expand Down
Loading