Skip to content

Git designed for AI agents.

13.8 KB
Raw Blame
package catfile

import (
	"context"
	"fmt"
	"io"
	"os"
	"strings"
	"testing"
	"unsafe"

	"github.com/feder-cr/git-ai/internal/git"
	"github.com/feder-cr/git-ai/internal/git/gitcmd"
	"github.com/feder-cr/git-ai/internal/git/gittest"
	"github.com/feder-cr/git-ai/internal/gitaly/config"
	"github.com/feder-cr/git-ai/internal/log"
	"github.com/feder-cr/git-ai/internal/structerr"
	"github.com/feder-cr/git-ai/internal/testhelper"
	"github.com/feder-cr/git-ai/internal/testhelper/testcfg"
	"github.com/stretchr/testify/require"
)

func TestRequestQueue_ReadObject(t *testing.T) {
	t.Parallel()

	ctx := testhelper.Context(t)
	cfg := testcfg.Build(t)

	oid := git.ObjectID(strings.Repeat("1", gittest.DefaultObjectHash.EncodedLen()))
	lineEnding := "\\x00"

	t.Run("read without request", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, `#!/usr/bin/env bash
			IFS= read -r -d ''
		`)
		_, err := queue.ReadObject(ctx)
		require.Equal(t, fmt.Errorf("no outstanding request"), err)
	})

	t.Run("read on closed reader", func(t *testing.T) {
		reader, queue := newInterceptedQueue(t, ctx, cfg, `#!/usr/bin/env bash
			IFS= read -r -d ''
		`)

		require.NoError(t, queue.RequestObject(ctx, "foo"))
		require.True(t, queue.isDirty())

		reader.close()
		require.True(t, queue.isDirty())

		_, err := queue.ReadObject(ctx)
		require.Equal(t, fmt.Errorf("cannot read object info: %w", fmt.Errorf("file already closed")), err)
	})

	t.Run("read with unconsumed object", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, fmt.Sprintf(`#!/usr/bin/env bash
			printf "%s commit 464%s"
		`, oid, lineEnding))

		// We queue two revisions...
		require.NoError(t, queue.RequestObject(ctx, "foo"))
		require.NoError(t, queue.RequestObject(ctx, "foo"))

		// .. and only unqueue one object. This object isn't read though, ...
		_, err := queue.ReadObject(ctx)
		require.NoError(t, err)

		// ... which means that trying to read the second object should fail now.
		_, err = queue.ReadObject(ctx)
		require.Equal(t, fmt.Errorf("current object has not been fully read"), err)

		require.True(t, queue.isDirty())
	})

	t.Run("read with invalid object header", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, fmt.Sprintf(`#!/usr/bin/env bash
			printf "something something%s"
		`, lineEnding))

		require.NoError(t, queue.RequestObject(ctx, "foo"))

		_, err := queue.ReadObject(ctx)
		require.Equal(t, fmt.Errorf("invalid info line: %q", "something something"), err)

		// The queue must be dirty when we failed due to an unexpected error.
		require.True(t, queue.isDirty())
	})

	t.Run("invalid request", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, `#!/usr/bin/env bash
			false
		`)

		require.Equal(t, structerr.NewInvalidArgument("revision must not contain NUL bytes"), queue.RequestObject(ctx, "foo\000bar"))
		require.False(t, queue.isDirty())
	})

	t.Run("read with unexpected exit", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, `#!/usr/bin/env bash
			exit 1
		`)

		require.NoError(t, queue.RequestObject(ctx, "foo"))

		_, err := queue.ReadObject(ctx)
		require.Equal(t, fmt.Errorf("read info line: %w", io.EOF), err)

		// The queue must be dirty when we failed due to an unexpected error.
		require.True(t, queue.isDirty())
	})

	t.Run("read with missing object", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, fmt.Sprintf(`#!/usr/bin/env bash
			printf "%s missing%s"
		`, oid, lineEnding))

		require.NoError(t, queue.RequestObject(ctx, "foo"))

		_, err := queue.ReadObject(ctx)
		require.Equal(t, NotFoundError{oid.String()}, err)

		// The queue must be empty even if the object wasn't found: this is a graceful
		// failure that we should handle alright.
		require.False(t, queue.isDirty())
	})

	t.Run("read single object", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, fmt.Sprintf(`#!/usr/bin/env bash
			printf "%[1]s blob 10%[2]s"
			printf "1234567890%[2]s"
		`, oid, lineEnding))

		require.NoError(t, queue.RequestObject(ctx, "foo"))
		require.True(t, queue.isDirty())

		object, err := queue.ReadObject(ctx)
		require.NoError(t, err)
		require.Equal(t, ObjectInfo{
			Oid:    oid,
			Type:   "blob",
			Size:   10,
			Format: gittest.DefaultObjectHash.Format,
		}, object.ObjectInfo)

		data, err := io.ReadAll(object)
		require.NoError(t, err)
		require.Equal(t, "1234567890", string(data))

		require.False(t, queue.isDirty())
	})

	t.Run("read multiple objects", func(t *testing.T) {
		secondOID := git.ObjectID(strings.Repeat("2", gittest.DefaultObjectHash.EncodedLen()))

		_, queue := newInterceptedQueue(t, ctx, cfg, fmt.Sprintf(`#!/usr/bin/env bash
			printf "%[1]s blob 10%[3]s"
			printf "1234567890%[3]s"
			printf "%[2]s commit 10%[3]s"
			printf "0987654321%[3]s"
		`, oid, secondOID, lineEnding))

		require.NoError(t, queue.RequestObject(ctx, "foo"))
		require.NoError(t, queue.RequestObject(ctx, "foo"))
		require.True(t, queue.isDirty())

		for _, expectedObject := range []struct {
			info ObjectInfo
			data string
		}{
			{
				info: ObjectInfo{
					Oid:    oid,
					Type:   "blob",
					Size:   10,
					Format: gittest.DefaultObjectHash.Format,
				},
				data: "1234567890",
			},
			{
				info: ObjectInfo{
					Oid:    secondOID,
					Type:   "commit",
					Size:   10,
					Format: gittest.DefaultObjectHash.Format,
				},
				data: "0987654321",
			},
		} {
			require.True(t, queue.isDirty())

			object, err := queue.ReadObject(ctx)
			require.NoError(t, err)
			require.Equal(t, expectedObject.info, object.ObjectInfo)

			data, err := io.ReadAll(object)
			require.NoError(t, err)
			require.Equal(t, expectedObject.data, string(data))
		}

		require.False(t, queue.isDirty())
	})

	t.Run("truncated object", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, fmt.Sprintf(`#!/usr/bin/env bash
			printf "%s blob 10%s"
			printf "123"
		`, oid, lineEnding))

		require.NoError(t, queue.RequestObject(ctx, "foo"))
		require.True(t, queue.isDirty())

		object, err := queue.ReadObject(ctx)
		require.NoError(t, err)
		require.Equal(t, ObjectInfo{
			Oid:    oid,
			Type:   "blob",
			Size:   10,
			Format: gittest.DefaultObjectHash.Format,
		}, object.ObjectInfo)

		// The first read will succeed and return the prefix.
		var buf [10]byte
		n, err := object.Read(buf[:])
		require.NoError(t, err)
		require.Equal(t, 3, n)
		require.Equal(t, "123", string(buf[:n]))

		// But the second read must fail and give us a hint that the read had been
		// truncated. Note that we explicitly expect to not see an io.EOF here,
		// which might indicate success to the caller.
		_, err = object.Read(buf[:])
		require.Equal(t, fmt.Errorf("discard newline: %w", io.EOF), err)

		require.True(t, queue.isDirty())
	})
}

func TestRequestQueue_RequestObject(t *testing.T) {
	t.Parallel()

	ctx := testhelper.Context(t)
	cfg := testcfg.Build(t)

	oid := git.ObjectID(strings.Repeat("1", gittest.DefaultObjectHash.EncodedLen()))
	lineEnding := "\\x00"

	requireRevision := func(t *testing.T, queue *requestQueue, rev git.Revision) {
		object, err := queue.ReadObject(ctx)
		require.NoError(t, err)

		data, err := io.ReadAll(object)
		require.NoError(t, err)
		require.Equal(t, rev, git.Revision(data))
	}

	t.Run("requesting revision on closed queue", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, "#!/usr/bin/env bash")
		queue.close()

		require.Equal(t, fmt.Errorf("cannot request revision: %w", os.ErrClosed), queue.RequestObject(ctx, "foo"))
	})

	t.Run("requesting revision on closed process", func(t *testing.T) {
		process, queue := newInterceptedQueue(t, ctx, cfg, "#!/usr/bin/env bash")

		process.close()

		require.Equal(t, fmt.Errorf("cannot request revision: %w", os.ErrClosed), queue.RequestObject(ctx, "foo"))
	})

	t.Run("single request", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, fmt.Sprintf(`#!/usr/bin/env bash
			IFS= read -r -d '' revision
			printf "%[1]s blob ${#revision}%[2]s"
			printf "${revision}%[2]s"
		`, oid, lineEnding))

		require.NoError(t, queue.RequestObject(ctx, "foo"))
		require.NoError(t, queue.Flush(ctx))

		requireRevision(t, queue, "contents foo")
	})

	t.Run("multiple request", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, fmt.Sprintf(`#!/usr/bin/env bash
			while IFS= read -r -d '' revision
			do
				printf "%[1]s blob ${#revision}%[2]s"
				printf "${revision}%[2]s"
			done
		`, oid, lineEnding))

		require.NoError(t, queue.RequestObject(ctx, "foo"))
		require.NoError(t, queue.RequestObject(ctx, "bar"))
		require.NoError(t, queue.RequestObject(ctx, "baz"))
		require.NoError(t, queue.RequestObject(ctx, "qux"))
		require.NoError(t, queue.Flush(ctx))

		requireRevision(t, queue, "contents foo")
		requireRevision(t, queue, "contents bar")
		requireRevision(t, queue, "contents baz")
		requireRevision(t, queue, "contents qux")
	})

	t.Run("multiple request with intermediate flushing", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, fmt.Sprintf(`#!/usr/bin/env bash
			while IFS= read -r -d '' revision
			do
				IFS= read -r -d '' flush
				if test "$flush" != "flush"
				then
					echo "expected a flush"
					exit 1
				fi

				printf "%[1]s blob ${#revision}%[2]s"
				printf "${revision}%[2]s"
			done
		`, oid, lineEnding))

		for _, revision := range []git.Revision{
			"foo",
			"bar",
			"foo",
			"qux",
		} {
			require.NoError(t, queue.RequestObject(ctx, revision))
			require.NoError(t, queue.Flush(ctx))
			requireRevision(t, queue, git.Revision(fmt.Sprintf("contents %s", revision)))
		}
	})
}

func TestRequestQueue_RequestInfo(t *testing.T) {
	t.Parallel()

	ctx := testhelper.Context(t)
	cfg := testcfg.Build(t)

	oid := git.ObjectID(strings.Repeat("1", gittest.DefaultObjectHash.EncodedLen()))
	expectedInfo := &ObjectInfo{oid, "blob", 955, gittest.DefaultObjectHash.Format}

	lineEnding := "\\x00"

	requireRevision := func(t *testing.T, queue *requestQueue) {
		info, err := queue.ReadInfo(ctx)
		require.NoError(t, err)

		require.NoError(t, err)
		require.Equal(t, info, expectedInfo)
	}

	t.Run("requesting revision on closed queue", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, "#!/usr/bin/env bash")
		queue.close()

		require.Equal(t, fmt.Errorf("cannot request revision: %w", os.ErrClosed), queue.RequestInfo(ctx, "foo"))
	})

	t.Run("requesting revision on closed process", func(t *testing.T) {
		process, queue := newInterceptedQueue(t, ctx, cfg, "#!/usr/bin/env bash")

		process.close()

		require.Equal(t, fmt.Errorf("cannot request revision: %w", os.ErrClosed), queue.RequestInfo(ctx, "foo"))
	})

	t.Run("single request", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, fmt.Sprintf(`#!/usr/bin/env bash
			IFS= read -r -d '' revision
			printf "%[1]s blob 955%[2]s"
		`, oid, lineEnding))

		require.NoError(t, queue.RequestInfo(ctx, "foo"))
		require.NoError(t, queue.Flush(ctx))

		requireRevision(t, queue)
	})

	t.Run("multiple request", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, fmt.Sprintf(`#!/usr/bin/env bash
			while IFS= read -r -d '' revision
			do
				printf "%s blob 955%s"
			done
		`, oid, lineEnding))

		require.NoError(t, queue.RequestInfo(ctx, "foo"))
		require.NoError(t, queue.RequestInfo(ctx, "bar"))
		require.NoError(t, queue.RequestInfo(ctx, "baz"))
		require.NoError(t, queue.RequestInfo(ctx, "qux"))
		require.NoError(t, queue.Flush(ctx))

		requireRevision(t, queue)
		requireRevision(t, queue)
		requireRevision(t, queue)
		requireRevision(t, queue)
	})

	t.Run("multiple request with intermediate flushing", func(t *testing.T) {
		_, queue := newInterceptedQueue(t, ctx, cfg, fmt.Sprintf(`#!/usr/bin/env bash
			while IFS= read -r -d '' revision
			do
				IFS= read -r -d '' flush
				if test "$flush" != "flush"
				then
					echo "expected a flush"
					exit 1
				fi

				printf "%s blob 955%s"
			done
		`, oid, lineEnding))

		for _, revision := range []git.Revision{
			"foo",
			"bar",
			"foo",
			"qux",
		} {
			require.NoError(t, queue.RequestInfo(ctx, revision))
			require.NoError(t, queue.Flush(ctx))
			requireRevision(t, queue)
		}
	})
}

func TestRequestQueue_CommandStats(t *testing.T) {
	t.Parallel()

	ctx := testhelper.Context(t)
	ctx = log.InitContextCustomFields(ctx)
	cfg := testcfg.Build(t)

	oid := git.ObjectID(strings.Repeat("1", gittest.DefaultObjectHash.EncodedLen()))
	lineEnding := "\\x00"

	_, queue := newInterceptedQueue(t, ctx, cfg, fmt.Sprintf(`#!/usr/bin/env bash
			IFS= read -r -d '' revision
			printf "%[1]s blob ${#revision}%[2]s"
			printf "${revision}%[2]s"
		`, oid, lineEnding))

	require.NoError(t, queue.RequestObject(ctx, "foo"))
	require.NoError(t, queue.Flush(ctx))
	_, err := queue.ReadObject(ctx)
	require.NoError(t, err)

	customFields := log.CustomFieldsFromContext(ctx)
	fields := customFields.Fields()
	require.Contains(t, fields, "catfile.request_object_count")
	require.Contains(t, fields, "catfile.request_object_ms")
	require.Contains(t, fields, "catfile.flush_count")
	require.Contains(t, fields, "catfile.flush_ms")
	require.Contains(t, fields, "catfile.read_object_count")
	require.Contains(t, fields, "catfile.read_object_ms")
	require.Contains(t, fields, "catfile.duration_ms")
}

func TestRequestQueueCounters64BitAlignment(t *testing.T) {
	require.Equal(t, 0, int(unsafe.Sizeof(requestQueue{}.counters))%8)
}

func newInterceptedQueue(t *testing.T, ctx context.Context, cfg config.Cfg, script string) (ObjectReader, *requestQueue) {
	repo, _ := gittest.CreateRepository(t, ctx, cfg, gittest.CreateRepositoryConfig{
		SkipCreationViaService: true,
	})

	commandFactory := gittest.NewInterceptingCommandFactory(t, ctx, cfg, func(execEnv gitcmd.ExecutionEnvironment) string {
		return script
	})
	repoExecutor := repoExecutor{
		Repository:    repo,
		gitCmdFactory: commandFactory,
	}

	reader, err := newObjectReader(ctx, &repoExecutor, nil)
	require.NoError(t, err)
	t.Cleanup(reader.close)

	queue, cleanup, err := reader.queue(ctx, "trace")
	require.NoError(t, err)
	t.Cleanup(cleanup)

	return reader, queue
}