github.com/keybase/client/go@v0.0.0-20240309051027-028f7c731f8b/kbfs/libgit/autogit_manager.go

// Copyright 2017 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 libgit

import (
	"context"
	"os"
	"sync"

	lru "github.com/hashicorp/golang-lru"
	"github.com/keybase/client/go/kbfs/data"
	"github.com/keybase/client/go/kbfs/libfs"
	"github.com/keybase/client/go/kbfs/libkbfs"
	"github.com/keybase/client/go/kbfs/tlf"
	"github.com/keybase/client/go/kbfs/tlfhandle"
	"github.com/keybase/client/go/logger"
	"github.com/keybase/client/go/protocol/keybase1"
	"github.com/pkg/errors"
	"gopkg.in/src-d/go-git.v4/plumbing"
)

const (
	// Debug tag ID for an individual autogit operation
	ctxAutogitOpID = "AGID"
)

type ctxAutogitTagKey int

const (
	ctxAutogitIDKey ctxAutogitTagKey = iota
)

type browserCacheKey struct {
	fs       *libfs.FS
	repoName string
	branch   plumbing.ReferenceName
	subdir   string
}

type browserCacheValue struct {
	repoFS  *libfs.FS
	browser *Browser
}

// AutogitManager can clone and pull source git repos into a
// destination folder, potentially across different TLFs.  New
// requests for an operation in a destination repo are blocked by any
// ongoing requests for the same folder, and multiple outstanding
// requests for the same destination folder get rolled up into one.
type AutogitManager struct {
	config   libkbfs.Config
	log      logger.Logger
	deferLog logger.Logger

	registryLock           sync.RWMutex
	registeredFBs          map[data.FolderBranch]bool
	repoNodesForWatchedIDs map[libkbfs.NodeID]*repoDirNode
	watchedNodes           []libkbfs.Node // preventing GC on the watched nodes
	deleteCancels          map[string]context.CancelFunc
	shutdown               bool

	sharedInBrowserCache sharedInBrowserCache

	browserLock  sync.Mutex
	browserCache *lru.Cache

	doRemoveSelfCheckouts sync.Once
}

// NewAutogitManager constructs a new AutogitManager instance.
func NewAutogitManager(
	config libkbfs.Config, browserCacheSize int) *AutogitManager {
	log := config.MakeLogger("")
	browserCache, err := lru.New(browserCacheSize)
	if err != nil {
		panic(err.Error())
	}
	sharedCache, err := newLRUSharedInBrowserCache()
	if err != nil {
		panic(err.Error())
	}

	return &AutogitManager{
		config:                 config,
		log:                    log,
		deferLog:               log.CloneWithAddedDepth(1),
		registeredFBs:          make(map[data.FolderBranch]bool),
		repoNodesForWatchedIDs: make(map[libkbfs.NodeID]*repoDirNode),
		deleteCancels:          make(map[string]context.CancelFunc),
		browserCache:           browserCache,
		sharedInBrowserCache:   sharedCache,
	}
}

// Shutdown shuts down this manager.
func (am *AutogitManager) Shutdown() {
	am.registryLock.Lock()
	defer am.registryLock.Unlock()
	am.shutdown = true
	for _, cancel := range am.deleteCancels {
		cancel()
	}
}

func (am *AutogitManager) removeOldCheckoutsForHandle(
	ctx context.Context, h *tlfhandle.Handle, branch data.BranchName) {
	// Make an "unwrapped" FS, so we don't end up recursively entering
	// the virtual autogit nodes again.
	fs, err := libfs.NewUnwrappedFS(
		ctx, am.config, h, branch, "", "", keybase1.MDPriorityNormal)
	if err != nil {
		am.log.CDebugf(ctx, "Error making unwrapped FS for TLF %s: %+v",
			h.GetCanonicalPath(), err)
		return
	}

	fi, err := fs.Stat(AutogitRoot)
	if os.IsNotExist(errors.Cause(err)) {
		// No autogit repos to remove.
		return
	} else if err != nil {
		am.log.CDebugf(ctx,
			"Error checking autogit in unwrapped FS for TLF %s: %+v",
			h.GetCanonicalPath(), err)
		return
	}

	ctx, ok := func() (context.Context, bool) {
		am.registryLock.Lock()
		defer am.registryLock.Unlock()
		if am.shutdown {
			return nil, false
		}
		p := h.GetCanonicalPath()
		if _, ok := am.deleteCancels[p]; ok {
			return nil, false
		}

		ctx, cancel := context.WithCancel(ctx)
		am.deleteCancels[p] = cancel
		return ctx, true
	}()
	if !ok {
		return
	}

	am.log.CDebugf(ctx, "Recursively deleting old autogit data in TLF %s",
		h.GetCanonicalPath())
	defer func() {
		am.log.CDebugf(ctx, "Recursive delete of autogit done: %+v", err)
		am.registryLock.Lock()
		defer am.registryLock.Unlock()
		delete(am.deleteCancels, h.GetCanonicalPath())
	}()
	err = libfs.RecursiveDelete(ctx, fs, fi)
}

func (am *AutogitManager) removeOldCheckouts(node libkbfs.Node) {
	ctx := libkbfs.CtxWithRandomIDReplayable(
		context.Background(), ctxAutogitIDKey, ctxAutogitOpID, am.log)

	h, err := am.config.KBFSOps().GetTLFHandle(ctx, node)
	if err != nil {
		am.log.CDebugf(ctx, "Error getting handle: %+v", err)
		return
	}

	am.removeOldCheckoutsForHandle(ctx, h, node.GetFolderBranch().Branch)
}

func (am *AutogitManager) removeSelfCheckouts() {
	ctx := libkbfs.CtxWithRandomIDReplayable(
		context.Background(), ctxAutogitIDKey, ctxAutogitOpID, am.log)

	session, err := am.config.KBPKI().GetCurrentSession(ctx)
	if err != nil {
		am.log.CDebugf(ctx,
			"Unable to get session; ignoring self-autogit delete: +%v", err)
		return
	}

	h, err := libkbfs.GetHandleFromFolderNameAndType(
		ctx, am.config.KBPKI(), am.config.MDOps(),
		am.config, string(session.Name), tlf.Private)
	if err != nil {
		am.log.CDebugf(ctx,
			"Unable to get private handle; ignoring self-autogit delete: +%v",
			err)
		return
	}

	am.removeOldCheckoutsForHandle(ctx, h, data.MasterBranch)
}

func (am *AutogitManager) registerRepoNode(
	nodeToWatch libkbfs.Node, rdn *repoDirNode) {
	am.registryLock.Lock()
	defer am.registryLock.Unlock()
	am.repoNodesForWatchedIDs[nodeToWatch.GetID()] = rdn
	fb := nodeToWatch.GetFolderBranch()
	if am.registeredFBs[fb] {
		return
	}

	go am.removeOldCheckouts(rdn)
	am.doRemoveSelfCheckouts.Do(func() { go am.removeSelfCheckouts() })
	am.watchedNodes = append(am.watchedNodes, nodeToWatch)
	err := am.config.Notifier().RegisterForChanges(
		[]data.FolderBranch{fb}, am)
	if err != nil {
		am.log.CWarningf(
			context.TODO(), "Error registering %s: +%v", fb.Tlf, err)
		return
	}
	am.registeredFBs[fb] = true
}

// LocalChange implements the libkbfs.Observer interface for AutogitManager.
func (am *AutogitManager) LocalChange(
	ctx context.Context, node libkbfs.Node, wr libkbfs.WriteRange) {
	// Do nothing.
}

func (am *AutogitManager) getNodesToInvalidate(
	affectedNodeIDs []libkbfs.NodeID) (
	nodes []libkbfs.Node, repoNodeIDs []libkbfs.NodeID) {
	am.registryLock.RLock()
	defer am.registryLock.RUnlock()
	for _, nodeID := range affectedNodeIDs {
		node, ok := am.repoNodesForWatchedIDs[nodeID]
		if ok {
			nodes = append(nodes, node)
			repoNodeIDs = append(repoNodeIDs, nodeID)
		}
	}
	return nodes, repoNodeIDs
}

func (am *AutogitManager) clearInvalidatedBrowsers(
	repoNodeIDs []libkbfs.NodeID) {
	am.browserLock.Lock()
	defer am.browserLock.Unlock()

	keys := am.browserCache.Keys()
	for _, k := range keys {
		// Clear all cached browsers associated with
		tmp, ok := am.browserCache.Get(k)
		if !ok {
			continue
		}
		v, ok := tmp.(browserCacheValue)
		if !ok {
			continue
		}
		rootNodeID := v.repoFS.RootNode().GetID()
		// Note that in almost all cases, `repoNodeIDs` should only
		// have one entry (since only one repo is updated in a single
		// metadata update), so iterating here should be cheaper than
		// making a map.
		for _, nodeID := range repoNodeIDs {
			if rootNodeID == nodeID {
				am.log.CDebugf(
					context.TODO(), "Invalidating browser for %s",
					v.repoFS.Root())
				am.browserCache.Remove(k)
				break
			}
		}
	}
}

// BatchChanges implements the libkbfs.Observer interface for AutogitManager.
func (am *AutogitManager) BatchChanges(
	ctx context.Context, _ []libkbfs.NodeChange,
	affectedNodeIDs []libkbfs.NodeID) {
	nodes, repoNodeIDs := am.getNodesToInvalidate(affectedNodeIDs)
	go am.clearInvalidatedBrowsers(repoNodeIDs)
	for _, node := range nodes {
		node := node
		go func() {
			ctx := libkbfs.CtxWithRandomIDReplayable(
				context.Background(), ctxAutogitIDKey, ctxAutogitOpID, am.log)
			err := am.config.KBFSOps().InvalidateNodeAndChildren(ctx, node)
			if err != nil {
				am.log.CDebugf(ctx, "Error invalidating children: %+v", err)
			}
		}()
	}
}

// TlfHandleChange implements the libkbfs.Observer interface for
// AutogitManager.
func (am *AutogitManager) TlfHandleChange(
	ctx context.Context, newHandle *tlfhandle.Handle) {
	// Do nothing.
}

func (am *AutogitManager) getBrowserForRepoLocked(
	ctx context.Context, gitFS *libfs.FS, repoName string,
	branch plumbing.ReferenceName, subdir string) (*libfs.FS, *Browser, error) {
	repoName = normalizeRepoName(repoName)
	key := browserCacheKey{gitFS, repoName, branch, subdir}
	tmp, ok := am.browserCache.Get(key)
	if ok {
		b, ok := tmp.(browserCacheValue)
		if !ok {
			return nil, nil, errors.Errorf("Bad browser in cache: %T", tmp)
		}
		return b.repoFS, b.browser, nil
	}

	// It's kind of dumb to hold the browser lock through all of this,
	// but it doesn't seem worthwhile to build the whole
	// channel/notification system that would be needed to manage
	// multiple concurrent requests for the same repo node.

	am.log.CDebugf(ctx, "Making browser for repo=%s, branch=%s, subdir=%s",
		repoName, branch, subdir)

	// Recurse to get the root browser, and then chroot to the subdir.
	if subdir != "" {
		repoFS, rootB, err := am.getBrowserForRepoLocked(
			ctx, gitFS, repoName, branch, "")
		if err != nil {
			return nil, nil, err
		}

		b, err := rootB.Chroot(subdir)
		if err != nil {
			return nil, nil, err
		}
		browser, ok := b.(*Browser)
		if !ok {
			return nil, nil, errors.Errorf("Bad browser type: %T", b)
		}
		am.browserCache.Add(key, browserCacheValue{repoFS, browser})
		return repoFS, browser, nil
	}

	billyFS, err := gitFS.Chroot(repoName)
	if err != nil {
		return nil, nil, err
	}
	repoFS := billyFS.(*libfs.FS)
	browser, err := NewBrowser(
		repoFS, am.config.Clock(), branch, am.sharedInBrowserCache)
	if err != nil {
		return nil, nil, err
	}
	am.browserCache.Add(key, browserCacheValue{repoFS, browser})
	return repoFS, browser, nil
}

// GetBrowserForRepo returns the root FS for the specified repo and a
// `Browser` for the branch and subdir.
func (am *AutogitManager) GetBrowserForRepo(
	ctx context.Context, gitFS *libfs.FS, repoName string,
	branch plumbing.ReferenceName, subdir string) (*libfs.FS, *Browser, error) {
	am.browserLock.Lock()
	defer am.browserLock.Unlock()
	return am.getBrowserForRepoLocked(ctx, gitFS, repoName, branch, subdir)
}

// StartAutogit launches autogit, and returns a function that should
// be called on shutdown.
func StartAutogit(config libkbfs.Config, browserCacheSize int) func() {
	am := NewAutogitManager(config, browserCacheSize)
	rw := rootWrapper{am}
	config.AddRootNodeWrapper(rw.wrap)
	return am.Shutdown
}