github.com/keybase/client/go@v0.0.0-20240309051027-028f7c731f8b/kbfs/libkbfs/journal_md_ops_test.go

// Copyright 2016 Keybase Inc. All rights reserved.
// Use of this source code is governed by a BSD
// license that can be found in the LICENSE file.

package libkbfs

import (
	"os"
	"testing"

	"github.com/keybase/client/go/kbfs/ioutil"
	"github.com/keybase/client/go/kbfs/kbfsmd"
	"github.com/keybase/client/go/kbfs/tlf"
	"github.com/keybase/client/go/kbfs/tlfhandle"
	"github.com/keybase/client/go/protocol/keybase1"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"golang.org/x/net/context"
)

func setupJournalMDOpsTest(t *testing.T) (
	tempdir string, ctx context.Context, cancel context.CancelFunc,
	config *ConfigLocal, oldMDOps MDOps, jManager *JournalManager) {
	tempdir, err := ioutil.TempDir(os.TempDir(), "journal_md_ops")
	require.NoError(t, err)

	// Clean up the tempdir if the rest of the setup fails.
	setupSucceeded := false
	defer func() {
		if !setupSucceeded {
			err := ioutil.RemoveAll(tempdir)
			assert.NoError(t, err)
		}
	}()

	ctx, cancel = context.WithTimeout(
		context.Background(), individualTestTimeout)

	// Clean up the context if the rest of the setup fails.
	defer func() {
		if !setupSucceeded {
			cancel()
		}
	}()

	config = MakeTestConfigOrBust(t, "test_user")

	// Clean up the config if the rest of the setup fails.
	defer func() {
		if !setupSucceeded {
			CheckConfigAndShutdown(ctx, t, config)
		}
	}()

	oldMDOps = config.MDOps()
	err = config.EnableDiskLimiter(tempdir)
	require.NoError(t, err)
	err = config.EnableJournaling(
		ctx, tempdir, TLFJournalBackgroundWorkEnabled)
	require.NoError(t, err)
	jManager, err = GetJournalManager(config)
	// Turn off listeners to avoid background MD pushes for CR.
	jManager.onBranchChange = nil
	jManager.onMDFlush = nil
	require.NoError(t, err)

	// Tests need to explicitly enable journaling, to avoid races
	// where journals are enabled before they can be paused.
	err = jManager.DisableAuto(ctx)
	require.NoError(t, err)

	setupSucceeded = true
	return tempdir, ctx, cancel, config, oldMDOps, jManager
}

func teardownJournalMDOpsTest(
	ctx context.Context, t *testing.T, tempdir string,
	cancel context.CancelFunc, config Config) {
	CheckConfigAndShutdown(ctx, t, config)
	cancel()
	err := ioutil.RemoveAll(tempdir)
	assert.NoError(t, err)
}

func makeMDForJournalMDOpsTest(
	t *testing.T, config Config, tlfID tlf.ID, h *tlfhandle.Handle,
	revision kbfsmd.Revision) *RootMetadata {
	rmd, err := makeInitialRootMetadata(config.MetadataVersion(), tlfID, h)
	require.NoError(t, err)
	rmd.SetRevision(revision)
	ctx := context.Background()
	rekeyDone, _, err := config.KeyManager().Rekey(ctx, rmd, false)
	require.NoError(t, err)
	require.True(t, rekeyDone)
	return rmd
}

// TODO: Clean up the test below.

func TestJournalMDOpsBasics(t *testing.T) {
	tempdir, ctx, cancel, config, oldMDOps, jManager := setupJournalMDOpsTest(t)
	defer teardownJournalMDOpsTest(ctx, t, tempdir, cancel, config)

	session, err := config.KBPKI().GetCurrentSession(ctx)
	require.NoError(t, err)

	// (1) get metadata -- allocates an ID
	bh, err := tlf.MakeHandle(
		[]keybase1.UserOrTeamID{session.UID.AsUserOrTeam()}, nil, nil, nil, nil)
	require.NoError(t, err)

	h, err := tlfhandle.MakeHandle(
		ctx, bh, bh.Type(), config.KBPKI(), config.KBPKI(), nil,
		keybase1.OfflineAvailability_NONE)
	require.NoError(t, err)

	mdOps := jManager.mdOps()

	id, err := mdOps.GetIDForHandle(ctx, h)
	require.NoError(t, err)
	require.NotEqual(t, tlf.NullID, id)
	irmd, err := mdOps.GetForTLF(ctx, id, nil)
	require.NoError(t, err)
	require.Equal(t, ImmutableRootMetadata{}, irmd)
	h.SetTlfID(id)

	err = jManager.Enable(ctx, id, nil, TLFJournalBackgroundWorkPaused)
	require.NoError(t, err)

	rmd := makeMDForJournalMDOpsTest(t, config, id, h, kbfsmd.Revision(1))

	irmd, err = mdOps.Put(
		ctx, rmd, session.VerifyingKey, nil, keybase1.MDPriorityNormal, nil)
	require.NoError(t, err)
	prevRoot := irmd.mdID

	// (2) push some new metadata blocks
	for i := kbfsmd.Revision(2); i < 8; i++ {
		rmd.SetRevision(i)
		rmd.SetPrevRoot(prevRoot)
		irmd, err := mdOps.Put(
			ctx, rmd, session.VerifyingKey, nil, keybase1.MDPriorityNormal, nil)
		require.NoError(t, err, "i=%d", i)
		prevRoot = irmd.mdID
	}

	head, err := mdOps.GetForTLF(ctx, id, nil)
	require.NoError(t, err)
	require.NotEqual(t, ImmutableRootMetadata{}, head)
	require.Equal(t, kbfsmd.Revision(7), head.Revision())

	head, err = oldMDOps.GetForTLF(ctx, id, nil)
	require.NoError(t, err)
	require.Equal(t, ImmutableRootMetadata{}, head)

	err = jManager.Flush(ctx, id)
	require.NoError(t, err)

	head, err = mdOps.GetForTLF(ctx, id, nil)
	require.NoError(t, err)
	require.NotEqual(t, ImmutableRootMetadata{}, head)
	require.Equal(t, kbfsmd.Revision(7), head.Revision())

	head, err = oldMDOps.GetForTLF(ctx, id, nil)
	require.NoError(t, err)
	require.NotEqual(t, ImmutableRootMetadata{}, head)
	require.Equal(t, kbfsmd.Revision(7), head.Revision())

	// (3) trigger a conflict
	rmd.SetRevision(kbfsmd.Revision(8))
	rmd.SetPrevRoot(prevRoot)
	resolveMD, err := rmd.deepCopy(config.Codec())
	require.NoError(t, err)
	_, err = oldMDOps.Put(
		ctx, rmd, session.VerifyingKey, nil, keybase1.MDPriorityNormal, nil)
	require.NoError(t, err)

	for i := kbfsmd.Revision(8); i <= 10; i++ {
		rmd.SetRevision(i)
		rmd.SetPrevRoot(prevRoot)
		irmd, err := mdOps.Put(
			ctx, rmd, session.VerifyingKey, nil, keybase1.MDPriorityNormal, nil)
		require.NoError(t, err, "i=%d", i)
		prevRoot = irmd.mdID
	}

	err = jManager.Flush(ctx, id)
	require.NoError(t, err)

	head, err = mdOps.GetForTLF(ctx, id, nil)
	require.NoError(t, err)
	require.NotEqual(t, ImmutableRootMetadata{}, head)
	require.Equal(t, kbfsmd.Revision(8), head.Revision())

	head, err = oldMDOps.GetForTLF(ctx, id, nil)
	require.NoError(t, err)
	require.NotEqual(t, ImmutableRootMetadata{}, head)
	require.Equal(t, kbfsmd.Revision(8), head.Revision())

	// Find the branch ID.
	tlfJournal, ok := jManager.getTLFJournal(id, nil)
	require.True(t, ok)
	bid := tlfJournal.mdJournal.branchID

	head, err = mdOps.GetUnmergedForTLF(ctx, id, bid)
	require.NoError(t, err)
	require.NotEqual(t, ImmutableRootMetadata{}, head)
	require.Equal(t, kbfsmd.Revision(10), head.Revision())
	require.Equal(t, bid, head.BID())

	// (4) push some new unmerged metadata blocks linking to the
	//     middle merged block.
	for i := kbfsmd.Revision(11); i < 41; i++ {
		rmd.SetRevision(i)
		rmd.SetPrevRoot(prevRoot)
		irmd, err := mdOps.PutUnmerged(ctx, rmd, session.VerifyingKey, nil)
		require.NoError(t, err, "i=%d", i)
		prevRoot = irmd.mdID
		require.Equal(t, bid, rmd.BID())
		bid = rmd.BID()
		require.NoError(t, err)
	}

	// (5) check for proper unmerged head
	head, err = mdOps.GetUnmergedForTLF(ctx, id, bid)
	require.NoError(t, err)
	require.NotEqual(t, ImmutableRootMetadata{}, head)
	require.Equal(t, kbfsmd.Revision(40), head.Revision())

	// (6a) try to get unmerged range
	rmdses, err := mdOps.GetUnmergedRange(ctx, id, bid, 1, 100)
	require.NoError(t, err)
	require.Equal(t, 33, len(rmdses))
	for i := kbfsmd.Revision(8); i < 41; i++ {
		require.Equal(t, i, rmdses[i-8].Revision())
	}

	// (6b) try to get unmerged range subset.
	rmdses, err = mdOps.GetUnmergedRange(ctx, id, bid, 7, 14)
	require.NoError(t, err)
	require.Equal(t, 7, len(rmdses))
	for i := kbfsmd.Revision(8); i <= 14; i++ {
		require.Equal(t, i, rmdses[i-8].Revision())
	}

	// (7) resolve the branch
	_, err = mdOps.ResolveBranch(
		ctx, id, bid, nil, resolveMD, session.VerifyingKey, nil)
	require.NoError(t, err)

	// (8) verify head is pruned
	head, err = mdOps.GetUnmergedForTLF(ctx, id, kbfsmd.NullBranchID)
	require.NoError(t, err)
	require.Equal(t, ImmutableRootMetadata{}, head)

	// (9) verify revision history is pruned
	rmdses, err = mdOps.GetUnmergedRange(ctx, id, kbfsmd.NullBranchID, 1, 100)
	require.NoError(t, err)
	require.Equal(t, 0, len(rmdses))

	// (10) check for proper merged head
	head, err = mdOps.GetForTLF(ctx, id, nil)
	require.NoError(t, err)
	require.NotEqual(t, ImmutableRootMetadata{}, head)
	require.Equal(t, kbfsmd.Revision(8), head.Revision())

	// (11) try to get merged range
	rmdses, err = mdOps.GetRange(ctx, id, 1, 100, nil)
	require.NoError(t, err)
	require.Equal(t, 8, len(rmdses))
	for i := kbfsmd.Revision(1); i <= 8; i++ {
		require.Equal(t, i, rmdses[i-1].Revision())
	}
}

// TODO: Add a test for GetRange where the server has an overlapping
// range with the journal.

func TestJournalMDOpsPutUnmerged(t *testing.T) {
	tempdir, ctx, cancel, config, _, jManager := setupJournalMDOpsTest(t)
	defer teardownJournalMDOpsTest(ctx, t, tempdir, cancel, config)

	session, err := config.KBPKI().GetCurrentSession(ctx)
	require.NoError(t, err)

	bh, err := tlf.MakeHandle(
		[]keybase1.UserOrTeamID{session.UID.AsUserOrTeam()}, nil, nil, nil, nil)
	require.NoError(t, err)

	h, err := tlfhandle.MakeHandle(
		ctx, bh, bh.Type(), config.KBPKI(), config.KBPKI(), nil,
		keybase1.OfflineAvailability_NONE)
	require.NoError(t, err)

	mdOps := jManager.mdOps()

	id, err := mdOps.GetIDForHandle(ctx, h)
	require.NoError(t, err)
	require.NotEqual(t, tlf.NullID, id)
	irmd, err := mdOps.GetForTLF(ctx, id, nil)
	require.NoError(t, err)
	require.Equal(t, ImmutableRootMetadata{}, irmd)

	err = jManager.Enable(ctx, id, nil, TLFJournalBackgroundWorkPaused)
	require.NoError(t, err)

	rmd := makeMDForJournalMDOpsTest(t, config, id, h, kbfsmd.Revision(2))
	rmd.SetPrevRoot(kbfsmd.FakeID(1))
	rmd.SetBranchID(kbfsmd.FakeBranchID(1))

	_, err = mdOps.PutUnmerged(ctx, rmd, session.VerifyingKey, nil)
	require.NoError(t, err)
}

func TestJournalMDOpsPutUnmergedError(t *testing.T) {
	tempdir, ctx, cancel, config, _, jManager := setupJournalMDOpsTest(t)
	defer teardownJournalMDOpsTest(ctx, t, tempdir, cancel, config)

	session, err := config.KBPKI().GetCurrentSession(ctx)
	require.NoError(t, err)

	bh, err := tlf.MakeHandle(
		[]keybase1.UserOrTeamID{session.UID.AsUserOrTeam()}, nil, nil, nil, nil)
	require.NoError(t, err)

	h, err := tlfhandle.MakeHandle(
		ctx, bh, bh.Type(), config.KBPKI(), config.KBPKI(), nil,
		keybase1.OfflineAvailability_NONE)
	require.NoError(t, err)

	mdOps := jManager.mdOps()

	id, err := mdOps.GetIDForHandle(ctx, h)
	require.NoError(t, err)
	require.NotEqual(t, tlf.NullID, id)
	irmd, err := mdOps.GetForTLF(ctx, id, nil)
	require.NoError(t, err)
	require.Equal(t, ImmutableRootMetadata{}, irmd)

	err = jManager.Enable(ctx, id, nil, TLFJournalBackgroundWorkPaused)
	require.NoError(t, err)

	rmd := makeMDForJournalMDOpsTest(t, config, id, h, kbfsmd.Revision(1))

	_, err = mdOps.PutUnmerged(ctx, rmd, session.VerifyingKey, nil)
	require.Error(t, err, "Unmerged put with rmd.BID() == j.branchID == kbfsmd.NullBranchID")
}

func TestJournalMDOpsLocalSquashBranch(t *testing.T) {
	tempdir, ctx, cancel, config, _, jManager := setupJournalMDOpsTest(t)
	defer teardownJournalMDOpsTest(ctx, t, tempdir, cancel, config)

	session, err := config.KBPKI().GetCurrentSession(ctx)
	require.NoError(t, err)

	bh, err := tlf.MakeHandle(
		[]keybase1.UserOrTeamID{session.UID.AsUserOrTeam()}, nil, nil, nil, nil)
	require.NoError(t, err)

	h, err := tlfhandle.MakeHandle(
		ctx, bh, bh.Type(), config.KBPKI(), config.KBPKI(), nil,
		keybase1.OfflineAvailability_NONE)
	require.NoError(t, err)

	mdOps := jManager.mdOps()
	id, err := mdOps.GetIDForHandle(ctx, h)
	require.NoError(t, err)
	irmd, err := mdOps.GetForTLF(ctx, id, nil)
	require.NoError(t, err)
	require.Equal(t, ImmutableRootMetadata{}, irmd)
	err = jManager.Enable(ctx, id, nil, TLFJournalBackgroundWorkPaused)
	require.NoError(t, err)

	tlfJournal, ok := jManager.getTLFJournal(id, nil)
	require.True(t, ok)

	// Prepare the md journal to have a leading local squash revision.
	firstRevision := kbfsmd.Revision(1)
	initialRmd := makeMDForJournalMDOpsTest(t, config, id, h, firstRevision)
	j := tlfJournal.mdJournal
	initialMdID, _, err := j.put(ctx, config.Crypto(), config.KeyManager(),
		config.BlockSplitter(), initialRmd, true)
	require.NoError(t, err)

	mdCount := 10
	rmd := initialRmd
	mdID := initialMdID
	// Put several MDs after a local squash
	for i := 0; i < mdCount; i++ {
		rmd, err = rmd.MakeSuccessor(ctx, config.MetadataVersion(),
			config.Codec(), config.KeyManager(),
			config.KBPKI(), config.KBPKI(), config, mdID, true)
		require.NoError(t, err)
		mdID, _, err = j.put(ctx, config.Crypto(), config.KeyManager(),
			config.BlockSplitter(), rmd, false)
		require.NoError(t, err)
	}

	mdcache := NewMDCacheStandard(10)
	err = j.convertToBranch(
		ctx, kbfsmd.PendingLocalSquashBranchID, config.Crypto(), config.Codec(),
		id, mdcache)
	require.NoError(t, err)

	// The merged head should still be the initial rmd, because we
	// marked it as a squash and it shouldn't have gotten converted.
	irmd, err = mdOps.GetForTLF(ctx, id, nil)
	require.NoError(t, err)
	require.Equal(t, initialMdID, irmd.mdID)
	require.Equal(t, firstRevision, irmd.Revision())

	// The unmerged head should be the last MD we put, converted to a
	// branch.
	irmd, err = mdOps.GetUnmergedForTLF(ctx, id, kbfsmd.PendingLocalSquashBranchID)
	require.NoError(t, err)
	require.Equal(t, rmd.Revision(), irmd.Revision())
	require.Equal(t, kbfsmd.PendingLocalSquashBranchID, irmd.BID())

	// The merged range should just be the initial MD.
	stopRevision := firstRevision + kbfsmd.Revision(mdCount*2)
	irmds, err := mdOps.GetRange(ctx, id, firstRevision, stopRevision, nil)
	require.NoError(t, err)
	require.Len(t, irmds, 1)
	require.Equal(t, initialMdID, irmds[0].mdID)
	require.Equal(t, firstRevision, irmds[0].Revision())

	irmds, err = mdOps.GetUnmergedRange(ctx, id, kbfsmd.PendingLocalSquashBranchID,
		firstRevision, stopRevision)
	require.NoError(t, err)
	require.Len(t, irmds, mdCount)
	require.Equal(t, firstRevision+kbfsmd.Revision(1), irmds[0].Revision())
}