1
0
mirror of https://github.com/jesseduffield/lazygit.git synced 2025-01-10 04:07:18 +02:00
lazygit/pkg/gui/controllers/branches_controller.go

729 lines
22 KiB
Go
Raw Normal View History

2022-02-06 06:54:26 +02:00
package controllers
import (
"errors"
"fmt"
"strings"
Use first class task objects instead of global counter The global counter approach is easy to understand but it's brittle and depends on implicit behaviour that is not very discoverable. With a global counter, if any goroutine accidentally decrements the counter twice, we'll think lazygit is idle when it's actually busy. Likewise if a goroutine accidentally increments the counter twice we'll think lazygit is busy when it's actually idle. With the new approach we have a map of tasks where each task can either be busy or not. We create a new task and add it to the map when we spawn a worker goroutine (among other things) and we remove it once the task is done. The task can also be paused and continued for situations where we switch back and forth between running a program and asking for user input. In order for this to work with `git push` (and other commands that require credentials) we need to obtain the task from gocui when we create the worker goroutine, and then pass it along to the commands package to pause/continue the task as required. This is MUCH more discoverable than the old approach which just decremented and incremented the global counter from within the commands package, but it's at the cost of expanding some function signatures (arguably a good thing). Likewise, whenever you want to call WithWaitingStatus or WithLoaderPanel the callback will now have access to the task for pausing/ continuing. We only need to actually make use of this functionality in a couple of places so it's a high price to pay, but I don't know if I want to introduce a WithWaitingStatusTask and WithLoaderPanelTask function (open to suggestions).
2023-07-09 03:32:27 +02:00
"github.com/jesseduffield/gocui"
2022-02-06 06:54:26 +02:00
"github.com/jesseduffield/lazygit/pkg/commands/git_commands"
"github.com/jesseduffield/lazygit/pkg/commands/models"
"github.com/jesseduffield/lazygit/pkg/gui/context"
"github.com/jesseduffield/lazygit/pkg/gui/controllers/helpers"
2022-02-06 06:54:26 +02:00
"github.com/jesseduffield/lazygit/pkg/gui/types"
"github.com/jesseduffield/lazygit/pkg/utils"
)
type BranchesController struct {
baseController
2023-03-23 09:47:29 +02:00
c *ControllerCommon
2022-02-06 06:54:26 +02:00
}
var _ types.IController = &BranchesController{}
func NewBranchesController(
2023-03-23 09:47:29 +02:00
common *ControllerCommon,
2022-02-06 06:54:26 +02:00
) *BranchesController {
return &BranchesController{
2023-03-23 09:47:29 +02:00
baseController: baseController{},
c: common,
2022-02-06 06:54:26 +02:00
}
}
func (self *BranchesController) GetKeybindings(opts types.KeybindingsOpts) []*types.Binding {
return []*types.Binding{
{
Key: opts.GetKey(opts.Config.Universal.Select),
2022-02-26 10:06:22 +02:00
Handler: self.checkSelected(self.press),
Description: self.c.Tr.Checkout,
2022-02-06 06:54:26 +02:00
},
2022-02-27 07:21:58 +02:00
{
Key: opts.GetKey(opts.Config.Universal.New),
Handler: self.checkSelected(self.newBranch),
Description: self.c.Tr.NewBranch,
2022-02-27 07:21:58 +02:00
},
2022-02-06 06:54:26 +02:00
{
Key: opts.GetKey(opts.Config.Branches.CreatePullRequest),
2022-02-26 10:06:22 +02:00
Handler: self.checkSelected(self.handleCreatePullRequest),
Description: self.c.Tr.CreatePullRequest,
2022-02-06 06:54:26 +02:00
},
{
Key: opts.GetKey(opts.Config.Branches.ViewPullRequestOptions),
Handler: self.checkSelected(self.handleCreatePullRequestMenu),
Description: self.c.Tr.CreatePullRequestOptions,
2022-02-06 06:54:26 +02:00
OpensMenu: true,
},
{
Key: opts.GetKey(opts.Config.Branches.CopyPullRequestURL),
2022-02-26 10:06:22 +02:00
Handler: self.copyPullRequestURL,
Description: self.c.Tr.CopyPullRequestURL,
2022-02-06 06:54:26 +02:00
},
{
Key: opts.GetKey(opts.Config.Branches.CheckoutBranchByName),
2022-02-26 10:06:22 +02:00
Handler: self.checkoutByName,
Description: self.c.Tr.CheckoutByName,
2022-02-06 06:54:26 +02:00
},
{
Key: opts.GetKey(opts.Config.Branches.ForceCheckoutBranch),
2022-02-26 10:06:22 +02:00
Handler: self.forceCheckout,
Description: self.c.Tr.ForceCheckout,
2022-02-06 06:54:26 +02:00
},
{
Key: opts.GetKey(opts.Config.Universal.Remove),
2022-02-26 10:06:22 +02:00
Handler: self.checkSelectedAndReal(self.delete),
Description: self.c.Tr.ViewDeleteOptions,
OpensMenu: true,
2022-02-06 06:54:26 +02:00
},
{
Key: opts.GetKey(opts.Config.Branches.RebaseBranch),
2022-02-26 10:06:22 +02:00
Handler: opts.Guards.OutsideFilterMode(self.rebase),
Description: self.c.Tr.RebaseBranch,
2022-02-06 06:54:26 +02:00
},
{
Key: opts.GetKey(opts.Config.Branches.MergeIntoCurrentBranch),
2022-02-26 10:06:22 +02:00
Handler: opts.Guards.OutsideFilterMode(self.merge),
Description: self.c.Tr.MergeIntoCurrentBranch,
2022-02-06 06:54:26 +02:00
},
{
Key: opts.GetKey(opts.Config.Branches.FastForward),
2022-02-26 10:06:22 +02:00
Handler: self.checkSelectedAndReal(self.fastForward),
2022-02-06 06:54:26 +02:00
Description: self.c.Tr.FastForward,
},
2023-02-08 15:40:18 +02:00
{
Key: opts.GetKey(opts.Config.Branches.CreateTag),
Handler: self.checkSelected(self.createTag),
Description: self.c.Tr.CreateTag,
2023-02-08 15:40:18 +02:00
},
2022-02-06 06:54:26 +02:00
{
Key: opts.GetKey(opts.Config.Commits.ViewResetOptions),
2022-02-26 10:06:22 +02:00
Handler: self.checkSelected(self.createResetMenu),
Description: self.c.Tr.ViewResetOptions,
2022-02-06 06:54:26 +02:00
OpensMenu: true,
},
{
Key: opts.GetKey(opts.Config.Branches.RenameBranch),
2022-02-26 10:06:22 +02:00
Handler: self.checkSelectedAndReal(self.rename),
Description: self.c.Tr.RenameBranch,
2022-02-06 06:54:26 +02:00
},
{
Key: opts.GetKey(opts.Config.Branches.SetUpstream),
Handler: self.checkSelected(self.setUpstream),
Description: self.c.Tr.ViewBranchUpstreamOptions,
Tooltip: self.c.Tr.ViewBranchUpstreamOptionsTooltip,
OpensMenu: true,
},
2022-02-06 06:54:26 +02:00
}
}
func (self *BranchesController) GetOnRenderToMain() func() error {
return func() error {
2023-03-23 09:47:29 +02:00
return self.c.Helpers().Diff.WithDiffModeCheck(func() error {
var task types.UpdateTask
branch := self.context().GetSelected()
if branch == nil {
task = types.NewRenderStringTask(self.c.Tr.NoBranchesThisRepo)
} else {
cmdObj := self.c.Git().Branch.GetGraphCmdObj(branch.FullRefName())
task = types.NewRunPtyTask(cmdObj.GetCmd())
}
return self.c.RenderToMainViews(types.RefreshMainOpts{
Pair: self.c.MainViewPairs().Normal,
Main: &types.ViewUpdateOpts{
Title: self.c.Tr.LogTitle,
Task: task,
},
})
})
}
}
func (self *BranchesController) setUpstream(selectedBranch *models.Branch) error {
options := []*types.MenuItem{
{
LabelColumns: []string{self.c.Tr.ViewDivergenceFromUpstream},
OnPress: func() error {
branch := self.context().GetSelected()
if branch == nil {
return nil
}
if !branch.RemoteBranchStoredLocally() {
return self.c.ErrorMsg(self.c.Tr.DivergenceNoUpstream)
}
return self.c.Helpers().SubCommits.ViewSubCommits(helpers.ViewSubCommitsOpts{
Ref: branch,
TitleRef: fmt.Sprintf("%s <-> %s", branch.RefName(), branch.ShortUpstreamRefName()),
RefToShowDivergenceFrom: branch.FullUpstreamRefName(),
Context: self.context(),
ShowBranchHeads: false,
})
},
Key: 'v',
},
{
LabelColumns: []string{self.c.Tr.UnsetUpstream},
OnPress: func() error {
if err := self.c.Git().Branch.UnsetUpstream(selectedBranch.Name); err != nil {
return self.c.Error(err)
}
if err := self.c.Refresh(types.RefreshOptions{
Mode: types.SYNC,
Scope: []types.RefreshableView{
types.BRANCHES,
types.COMMITS,
},
}); err != nil {
return self.c.Error(err)
}
return nil
},
Key: 'u',
},
{
LabelColumns: []string{self.c.Tr.SetUpstream},
OnPress: func() error {
return self.c.Helpers().Upstream.PromptForUpstreamWithoutInitialContent(selectedBranch, func(upstream string) error {
upstreamRemote, upstreamBranch, err := self.c.Helpers().Upstream.ParseUpstream(upstream)
if err != nil {
return self.c.Error(err)
}
if err := self.c.Git().Branch.SetUpstream(upstreamRemote, upstreamBranch, selectedBranch.Name); err != nil {
return self.c.Error(err)
}
if err := self.c.Refresh(types.RefreshOptions{
Mode: types.SYNC,
Scope: []types.RefreshableView{
types.BRANCHES,
types.COMMITS,
},
}); err != nil {
return self.c.Error(err)
}
return nil
})
},
Key: 's',
},
}
if selectedBranch.IsTrackingRemote() {
upstream := fmt.Sprintf("%s/%s", selectedBranch.UpstreamRemote, selectedBranch.Name)
upstreamResetOptions := utils.ResolvePlaceholderString(
self.c.Tr.ViewUpstreamResetOptions,
map[string]string{"upstream": upstream},
)
upstreamResetTooltip := utils.ResolvePlaceholderString(
self.c.Tr.ViewUpstreamResetOptionsTooltip,
map[string]string{"upstream": upstream},
)
options = append(options, &types.MenuItem{
LabelColumns: []string{upstreamResetOptions},
OpensMenu: true,
OnPress: func() error {
if selectedBranch.RemoteBranchNotStoredLocally() {
return self.c.ErrorMsg(self.c.Tr.UpstreamNotStoredLocallyError)
}
err := self.c.Helpers().Refs.CreateGitResetMenu(upstream)
if err != nil {
return self.c.Error(err)
}
return nil
},
Tooltip: upstreamResetTooltip,
Key: 'g',
})
} else {
options = append(options, &types.MenuItem{
LabelColumns: []string{self.c.Tr.ViewUpstreamDisabledResetOptions},
OpensMenu: true,
OnPress: func() error {
return self.c.ErrorMsg(self.c.Tr.UpstreamNotSetError)
},
Tooltip: self.c.Tr.UpstreamNotSetError,
Key: 'g',
})
}
return self.c.Menu(types.CreateMenuOptions{
Title: self.c.Tr.BranchUpstreamOptionsTitle,
Items: options,
})
}
2022-02-06 06:54:26 +02:00
func (self *BranchesController) Context() types.Context {
return self.context()
}
func (self *BranchesController) context() *context.BranchesContext {
2023-03-23 04:04:57 +02:00
return self.c.Contexts().Branches
2022-02-06 06:54:26 +02:00
}
2022-02-26 10:06:22 +02:00
func (self *BranchesController) press(selectedBranch *models.Branch) error {
2023-03-23 09:47:29 +02:00
if selectedBranch == self.c.Helpers().Refs.GetCheckedOutRef() {
2022-02-06 06:54:26 +02:00
return self.c.ErrorMsg(self.c.Tr.AlreadyCheckedOutBranch)
}
worktreeForRef, ok := self.worktreeForBranch(selectedBranch)
if ok && !worktreeForRef.IsCurrent {
return self.promptToCheckoutWorktree(worktreeForRef)
}
2022-02-06 06:54:26 +02:00
self.c.LogAction(self.c.Tr.Actions.CheckoutBranch)
2023-03-23 09:47:29 +02:00
return self.c.Helpers().Refs.CheckoutRef(selectedBranch.Name, types.CheckoutRefOptions{})
2022-02-06 06:54:26 +02:00
}
func (self *BranchesController) worktreeForBranch(branch *models.Branch) (*models.Worktree, bool) {
return git_commands.WorktreeForBranch(branch, self.c.Model().Worktrees)
}
func (self *BranchesController) promptToCheckoutWorktree(worktree *models.Worktree) error {
2023-07-28 10:58:19 +02:00
prompt := utils.ResolvePlaceholderString(self.c.Tr.AlreadyCheckedOutByWorktree, map[string]string{
"worktreeName": worktree.Name,
})
return self.c.Confirm(types.ConfirmOpts{
2023-07-28 10:58:19 +02:00
Title: self.c.Tr.SwitchToWorktree,
Prompt: prompt,
HandleConfirm: func() error {
return self.c.Helpers().Worktree.Switch(worktree, context.LOCAL_BRANCHES_CONTEXT_KEY)
},
})
}
2022-02-26 10:06:22 +02:00
func (self *BranchesController) handleCreatePullRequest(selectedBranch *models.Branch) error {
return self.createPullRequest(selectedBranch.Name, "")
2022-02-06 06:54:26 +02:00
}
func (self *BranchesController) handleCreatePullRequestMenu(selectedBranch *models.Branch) error {
2023-03-23 09:47:29 +02:00
checkedOutBranch := self.c.Helpers().Refs.GetCheckedOutRef()
2022-02-06 06:54:26 +02:00
return self.createPullRequestMenu(selectedBranch, checkedOutBranch)
}
2022-02-26 10:06:22 +02:00
func (self *BranchesController) copyPullRequestURL() error {
2022-02-06 06:54:26 +02:00
branch := self.context().GetSelected()
2023-03-23 04:04:57 +02:00
branchExistsOnRemote := self.c.Git().Remote.CheckRemoteBranchExists(branch.Name)
2022-02-06 06:54:26 +02:00
if !branchExistsOnRemote {
return self.c.Error(errors.New(self.c.Tr.NoBranchOnRemote))
}
2023-03-23 09:47:29 +02:00
url, err := self.c.Helpers().Host.GetPullRequestURL(branch.Name, "")
2022-02-06 06:54:26 +02:00
if err != nil {
return self.c.Error(err)
}
self.c.LogAction(self.c.Tr.Actions.CopyPullRequestURL)
2023-03-23 04:04:57 +02:00
if err := self.c.OS().CopyToClipboard(url); err != nil {
2022-02-06 06:54:26 +02:00
return self.c.Error(err)
}
self.c.Toast(self.c.Tr.PullRequestURLCopiedToClipboard)
return nil
}
2022-02-26 10:06:22 +02:00
func (self *BranchesController) forceCheckout() error {
2022-02-06 06:54:26 +02:00
branch := self.context().GetSelected()
message := self.c.Tr.SureForceCheckout
title := self.c.Tr.ForceCheckoutBranch
return self.c.Confirm(types.ConfirmOpts{
2022-02-06 06:54:26 +02:00
Title: title,
Prompt: message,
HandleConfirm: func() error {
self.c.LogAction(self.c.Tr.Actions.ForceCheckoutBranch)
2023-03-23 04:04:57 +02:00
if err := self.c.Git().Branch.Checkout(branch.Name, git_commands.CheckoutOptions{Force: true}); err != nil {
2022-02-06 06:54:26 +02:00
_ = self.c.Error(err)
}
return self.c.Refresh(types.RefreshOptions{Mode: types.ASYNC})
},
})
}
2022-02-26 10:06:22 +02:00
func (self *BranchesController) checkoutByName() error {
2022-02-06 06:54:26 +02:00
return self.c.Prompt(types.PromptOpts{
Title: self.c.Tr.BranchName + ":",
2023-03-23 09:47:29 +02:00
FindSuggestionsFunc: self.c.Helpers().Suggestions.GetRefsSuggestionsFunc(),
2022-02-06 06:54:26 +02:00
HandleConfirm: func(response string) error {
self.c.LogAction("Checkout branch")
2023-03-23 09:47:29 +02:00
return self.c.Helpers().Refs.CheckoutRef(response, types.CheckoutRefOptions{
2022-02-06 06:54:26 +02:00
OnRefNotFound: func(ref string) error {
return self.c.Confirm(types.ConfirmOpts{
2022-02-06 06:54:26 +02:00
Title: self.c.Tr.BranchNotFoundTitle,
Prompt: fmt.Sprintf("%s %s%s", self.c.Tr.BranchNotFoundPrompt, ref, "?"),
HandleConfirm: func() error {
return self.createNewBranchWithName(ref)
},
})
},
})
2022-03-19 00:38:49 +02:00
},
},
2022-02-06 06:54:26 +02:00
)
}
func (self *BranchesController) createNewBranchWithName(newBranchName string) error {
branch := self.context().GetSelected()
if branch == nil {
return nil
}
2023-03-23 04:04:57 +02:00
if err := self.c.Git().Branch.New(newBranchName, branch.FullRefName()); err != nil {
2022-02-06 06:54:26 +02:00
return self.c.Error(err)
}
self.context().SetSelectedLineIdx(0)
return self.c.Refresh(types.RefreshOptions{Mode: types.ASYNC})
}
func (self *BranchesController) checkedOutByOtherWorktree(branch *models.Branch) bool {
return git_commands.CheckedOutByOtherWorktree(branch, self.c.Model().Worktrees)
}
func (self *BranchesController) promptWorktreeBranchDelete(selectedBranch *models.Branch) error {
worktree, ok := self.worktreeForBranch(selectedBranch)
if !ok {
2023-07-28 10:58:19 +02:00
self.c.Log.Error("promptWorktreeBranchDelete out of sync with list of worktrees")
return nil
}
2023-07-28 10:58:19 +02:00
// TODO: i18n
title := utils.ResolvePlaceholderString(self.c.Tr.BranchCheckedOutByWorktree, map[string]string{
"worktreeName": worktree.Name,
"branchName": selectedBranch.Name,
})
return self.c.Menu(types.CreateMenuOptions{
2023-07-28 10:58:19 +02:00
Title: title,
Items: []*types.MenuItem{
{
2023-07-28 10:58:19 +02:00
Label: self.c.Tr.SwitchToWorktree,
OnPress: func() error {
return self.c.Helpers().Worktree.Switch(worktree, context.LOCAL_BRANCHES_CONTEXT_KEY)
},
},
{
2023-07-28 10:58:19 +02:00
Label: self.c.Tr.DetachWorktree,
Tooltip: self.c.Tr.DetachWorktreeTooltip,
OnPress: func() error {
return self.c.Helpers().Worktree.Detach(worktree)
},
},
{
2023-07-28 10:58:19 +02:00
Label: self.c.Tr.RemoveWorktree,
OnPress: func() error {
return self.c.Helpers().Worktree.Remove(worktree, false)
},
},
},
})
}
func (self *BranchesController) localDelete(branch *models.Branch) error {
if self.checkedOutByOtherWorktree(branch) {
return self.promptWorktreeBranchDelete(branch)
2022-02-06 06:54:26 +02:00
}
return self.c.WithWaitingStatus(self.c.Tr.DeletingStatus, func(_ gocui.Task) error {
self.c.LogAction(self.c.Tr.Actions.DeleteLocalBranch)
err := self.c.Git().Branch.LocalDelete(branch.Name, false)
if err != nil && strings.Contains(err.Error(), "git branch -D ") {
return self.forceDelete(branch)
}
if err != nil {
return self.c.Error(err)
}
return self.c.Refresh(types.RefreshOptions{Mode: types.ASYNC, Scope: []types.RefreshableView{types.BRANCHES}})
})
}
func (self *BranchesController) remoteDelete(branch *models.Branch) error {
return self.c.Helpers().BranchesHelper.ConfirmDeleteRemote(branch.UpstreamRemote, branch.Name)
}
func (self *BranchesController) forceDelete(branch *models.Branch) error {
title := self.c.Tr.ForceDeleteBranchTitle
2022-02-06 06:54:26 +02:00
message := utils.ResolvePlaceholderString(
self.c.Tr.ForceDeleteBranchMessage,
2022-02-06 06:54:26 +02:00
map[string]string{
"selectedBranchName": branch.Name,
2022-02-06 06:54:26 +02:00
},
)
return self.c.Confirm(types.ConfirmOpts{
2022-02-06 06:54:26 +02:00
Title: title,
Prompt: message,
HandleConfirm: func() error {
if err := self.c.Git().Branch.LocalDelete(branch.Name, true); err != nil {
return self.c.ErrorMsg(err.Error())
2022-02-06 06:54:26 +02:00
}
return self.c.Refresh(types.RefreshOptions{Mode: types.ASYNC, Scope: []types.RefreshableView{types.BRANCHES}})
},
})
}
func (self *BranchesController) delete(branch *models.Branch) error {
menuItems := []*types.MenuItem{}
checkedOutBranch := self.c.Helpers().Refs.GetCheckedOutRef()
localDeleteItem := &types.MenuItem{
Label: self.c.Tr.DeleteLocalBranch,
Key: 'c',
OnPress: func() error {
return self.localDelete(branch)
},
}
if checkedOutBranch.Name == branch.Name {
localDeleteItem = &types.MenuItem{
Label: self.c.Tr.DeleteLocalBranch,
Key: 'c',
Tooltip: self.c.Tr.CantDeleteCheckOutBranch,
OnPress: func() error {
return self.c.ErrorMsg(self.c.Tr.CantDeleteCheckOutBranch)
},
}
}
menuItems = append(menuItems, localDeleteItem)
if branch.IsTrackingRemote() && !branch.UpstreamGone {
menuItems = append(menuItems, &types.MenuItem{
Label: self.c.Tr.DeleteRemoteBranch,
Key: 'r',
OnPress: func() error {
return self.remoteDelete(branch)
},
})
}
menuTitle := utils.ResolvePlaceholderString(
self.c.Tr.DeleteBranchTitle,
map[string]string{
"selectedBranchName": branch.Name,
},
)
return self.c.Menu(types.CreateMenuOptions{
Title: menuTitle,
Items: menuItems,
})
}
2022-02-26 10:06:22 +02:00
func (self *BranchesController) merge() error {
2022-02-06 06:54:26 +02:00
selectedBranchName := self.context().GetSelected().Name
2023-03-23 09:47:29 +02:00
return self.c.Helpers().MergeAndRebase.MergeRefIntoCheckedOutBranch(selectedBranchName)
2022-02-06 06:54:26 +02:00
}
2022-02-26 10:06:22 +02:00
func (self *BranchesController) rebase() error {
2022-02-06 06:54:26 +02:00
selectedBranchName := self.context().GetSelected().Name
2023-03-23 09:47:29 +02:00
return self.c.Helpers().MergeAndRebase.RebaseOntoRef(selectedBranchName)
2022-02-06 06:54:26 +02:00
}
2022-02-26 10:06:22 +02:00
func (self *BranchesController) fastForward(branch *models.Branch) error {
2022-02-06 06:54:26 +02:00
if !branch.IsTrackingRemote() {
return self.c.ErrorMsg(self.c.Tr.FwdNoUpstream)
}
if !branch.RemoteBranchStoredLocally() {
return self.c.ErrorMsg(self.c.Tr.FwdNoLocalUpstream)
}
if branch.HasCommitsToPush() {
return self.c.ErrorMsg(self.c.Tr.FwdCommitsToPush)
}
action := self.c.Tr.Actions.FastForwardBranch
message := utils.ResolvePlaceholderString(
self.c.Tr.Fetching,
map[string]string{
"from": fmt.Sprintf("%s/%s", branch.UpstreamRemote, branch.UpstreamBranch),
"to": branch.Name,
},
)
return self.c.WithLoaderPanel(message, func(task gocui.Task) error {
2023-07-24 09:16:59 +02:00
worktree, ok := self.worktreeForBranch(branch)
if ok {
2022-02-06 06:54:26 +02:00
self.c.LogAction(action)
2023-07-24 09:16:59 +02:00
worktreeGitDir := ""
// if it is the current worktree path, no need to specify the path
if !worktree.IsCurrent {
2023-07-24 09:16:59 +02:00
worktreeGitDir = worktree.GitDir
}
2023-03-23 04:04:57 +02:00
err := self.c.Git().Sync.Pull(
Use first class task objects instead of global counter The global counter approach is easy to understand but it's brittle and depends on implicit behaviour that is not very discoverable. With a global counter, if any goroutine accidentally decrements the counter twice, we'll think lazygit is idle when it's actually busy. Likewise if a goroutine accidentally increments the counter twice we'll think lazygit is busy when it's actually idle. With the new approach we have a map of tasks where each task can either be busy or not. We create a new task and add it to the map when we spawn a worker goroutine (among other things) and we remove it once the task is done. The task can also be paused and continued for situations where we switch back and forth between running a program and asking for user input. In order for this to work with `git push` (and other commands that require credentials) we need to obtain the task from gocui when we create the worker goroutine, and then pass it along to the commands package to pause/continue the task as required. This is MUCH more discoverable than the old approach which just decremented and incremented the global counter from within the commands package, but it's at the cost of expanding some function signatures (arguably a good thing). Likewise, whenever you want to call WithWaitingStatus or WithLoaderPanel the callback will now have access to the task for pausing/ continuing. We only need to actually make use of this functionality in a couple of places so it's a high price to pay, but I don't know if I want to introduce a WithWaitingStatusTask and WithLoaderPanelTask function (open to suggestions).
2023-07-09 03:32:27 +02:00
task,
2022-02-06 06:54:26 +02:00
git_commands.PullOptions{
RemoteName: branch.UpstreamRemote,
2022-06-01 20:30:13 +02:00
BranchName: branch.UpstreamBranch,
2022-02-06 06:54:26 +02:00
FastForwardOnly: true,
2023-07-24 09:16:59 +02:00
WorktreeGitDir: worktreeGitDir,
2022-02-06 06:54:26 +02:00
},
)
if err != nil {
_ = self.c.Error(err)
}
return self.c.Refresh(types.RefreshOptions{Mode: types.ASYNC})
} else {
self.c.LogAction(action)
2023-07-24 09:16:59 +02:00
err := self.c.Git().Sync.FastForward(
task, branch.Name, branch.UpstreamRemote, branch.UpstreamBranch,
)
2022-02-06 06:54:26 +02:00
if err != nil {
_ = self.c.Error(err)
}
_ = self.c.Refresh(types.RefreshOptions{Mode: types.ASYNC, Scope: []types.RefreshableView{types.BRANCHES}})
}
return nil
})
}
2023-02-08 15:40:18 +02:00
func (self *BranchesController) createTag(branch *models.Branch) error {
return self.c.Helpers().Tags.OpenCreateTagPrompt(branch.FullRefName(), func() {})
2023-02-08 15:40:18 +02:00
}
2022-02-26 10:06:22 +02:00
func (self *BranchesController) createResetMenu(selectedBranch *models.Branch) error {
2023-03-23 09:47:29 +02:00
return self.c.Helpers().Refs.CreateGitResetMenu(selectedBranch.Name)
2022-02-06 06:54:26 +02:00
}
2022-02-26 10:06:22 +02:00
func (self *BranchesController) rename(branch *models.Branch) error {
2022-02-06 06:54:26 +02:00
promptForNewName := func() error {
return self.c.Prompt(types.PromptOpts{
Title: self.c.Tr.NewBranchNamePrompt + " " + branch.Name + ":",
InitialContent: branch.Name,
HandleConfirm: func(newBranchName string) error {
self.c.LogAction(self.c.Tr.Actions.RenameBranch)
if err := self.c.Git().Branch.Rename(branch.Name, helpers.SanitizedBranchName(newBranchName)); err != nil {
2022-02-06 06:54:26 +02:00
return self.c.Error(err)
}
// need to find where the branch is now so that we can re-select it. That means we need to refetch the branches synchronously and then find our branch
2023-07-24 08:36:11 +02:00
_ = self.c.Refresh(types.RefreshOptions{
Mode: types.SYNC,
Scope: []types.RefreshableView{types.BRANCHES, types.WORKTREES},
})
2022-02-06 06:54:26 +02:00
// now that we've got our stuff again we need to find that branch and reselect it.
2023-03-23 04:04:57 +02:00
for i, newBranch := range self.c.Model().Branches {
2022-02-06 06:54:26 +02:00
if newBranch.Name == newBranchName {
self.context().SetSelectedLineIdx(i)
if err := self.context().HandleRender(); err != nil {
return err
}
}
}
return nil
},
})
}
// I could do an explicit check here for whether the branch is tracking a remote branch
// but if we've selected it we'll already know that via Pullables and Pullables.
// Bit of a hack but I'm lazy.
if !branch.IsTrackingRemote() {
return promptForNewName()
}
return self.c.Confirm(types.ConfirmOpts{
Title: self.c.Tr.RenameBranch,
2022-02-06 06:54:26 +02:00
Prompt: self.c.Tr.RenameBranchWarning,
HandleConfirm: promptForNewName,
})
}
2022-02-26 10:06:22 +02:00
func (self *BranchesController) newBranch(selectedBranch *models.Branch) error {
2023-03-23 09:47:29 +02:00
return self.c.Helpers().Refs.NewBranch(selectedBranch.FullRefName(), selectedBranch.RefName(), "")
2022-02-06 06:54:26 +02:00
}
func (self *BranchesController) createPullRequestMenu(selectedBranch *models.Branch, checkedOutBranch *models.Branch) error {
menuItems := make([]*types.MenuItem, 0, 4)
fromToLabelColumns := func(from string, to string) []string {
2022-02-06 06:54:26 +02:00
return []string{fmt.Sprintf("%s → %s", from, to)}
}
menuItemsForBranch := func(branch *models.Branch) []*types.MenuItem {
return []*types.MenuItem{
{
LabelColumns: fromToLabelColumns(branch.Name, self.c.Tr.DefaultBranch),
2022-02-06 06:54:26 +02:00
OnPress: func() error {
return self.createPullRequest(branch.Name, "")
},
},
{
LabelColumns: fromToLabelColumns(branch.Name, self.c.Tr.SelectBranch),
2022-02-06 06:54:26 +02:00
OnPress: func() error {
return self.c.Prompt(types.PromptOpts{
Title: branch.Name + " →",
2023-03-23 09:47:29 +02:00
FindSuggestionsFunc: self.c.Helpers().Suggestions.GetBranchNameSuggestionsFunc(),
2022-02-06 06:54:26 +02:00
HandleConfirm: func(targetBranchName string) error {
return self.createPullRequest(branch.Name, targetBranchName)
2022-03-19 00:38:49 +02:00
},
})
2022-02-06 06:54:26 +02:00
},
},
}
}
if selectedBranch != checkedOutBranch {
menuItems = append(menuItems,
&types.MenuItem{
LabelColumns: fromToLabelColumns(checkedOutBranch.Name, selectedBranch.Name),
2022-02-06 06:54:26 +02:00
OnPress: func() error {
return self.createPullRequest(checkedOutBranch.Name, selectedBranch.Name)
},
},
)
menuItems = append(menuItems, menuItemsForBranch(checkedOutBranch)...)
}
menuItems = append(menuItems, menuItemsForBranch(selectedBranch)...)
return self.c.Menu(types.CreateMenuOptions{Title: fmt.Sprintf(self.c.Tr.CreatePullRequestOptions), Items: menuItems})
}
func (self *BranchesController) createPullRequest(from string, to string) error {
2023-03-23 09:47:29 +02:00
url, err := self.c.Helpers().Host.GetPullRequestURL(from, to)
2022-02-06 06:54:26 +02:00
if err != nil {
return self.c.Error(err)
}
self.c.LogAction(self.c.Tr.Actions.OpenPullRequest)
2023-03-23 04:04:57 +02:00
if err := self.c.OS().OpenLink(url); err != nil {
2022-02-06 06:54:26 +02:00
return self.c.Error(err)
}
return nil
}
func (self *BranchesController) checkSelected(callback func(*models.Branch) error) func() error {
return func() error {
selectedItem := self.context().GetSelected()
if selectedItem == nil {
return nil
}
return callback(selectedItem)
}
}
func (self *BranchesController) checkSelectedAndReal(callback func(*models.Branch) error) func() error {
return func() error {
selectedItem := self.context().GetSelected()
if selectedItem == nil || !selectedItem.IsRealBranch() {
return nil
}
return callback(selectedItem)
}
}