add commit message controller

pkg/gui/controllers/commit_message_controller.go

@@ -0,0 +1,79 @@
+package controllers
+
+import (
+	"github.com/jesseduffield/lazygit/pkg/gui/types"
+)
+
+type CommitMessageController struct {
+	baseController
+	*controllerCommon
+
+	getCommitMessage func() string
+	onCommitAttempt  func(message string)
+	onCommitSuccess  func()
+}
+
+var _ types.IController = &CommitMessageController{}
+
+func NewCommitMessageController(
+	common *controllerCommon,
+	getCommitMessage func() string,
+	onCommitAttempt func(message string),
+	onCommitSuccess func(),
+) *CommitMessageController {
+	return &CommitMessageController{
+		baseController:   baseController{},
+		controllerCommon: common,
+
+		getCommitMessage: getCommitMessage,
+		onCommitAttempt:  onCommitAttempt,
+		onCommitSuccess:  onCommitSuccess,
+	}
+}
+
+func (self *CommitMessageController) GetKeybindings(opts types.KeybindingsOpts) []*types.Binding {
+	bindings := []*types.Binding{
+		{
+			Key:     opts.GetKey(opts.Config.Universal.SubmitEditorText),
+			Handler: self.handleCommitConfirm,
+		},
+		{
+			Key:     opts.GetKey(opts.Config.Universal.Return),
+			Handler: self.handleCommitClose,
+		},
+	}
+
+	return bindings
+}
+
+func (self *CommitMessageController) Context() types.Context {
+	return self.context()
+}
+
+// this method is pointless in this context but I'm keeping it consistent
+// with other contexts so that when generics arrive it's easier to refactor
+func (self *CommitMessageController) context() types.Context {
+	return self.contexts.CommitMessage
+}
+
+func (self *CommitMessageController) handleCommitConfirm() error {
+	message := self.getCommitMessage()
+	self.onCommitAttempt(message)
+
+	if message == "" {
+		return self.c.ErrorMsg(self.c.Tr.CommitWithoutMessageErr)
+	}
+
+	cmdObj := self.git.Commit.CommitCmdObj(message)
+	self.c.LogAction(self.c.Tr.Actions.Commit)
+
+	_ = self.c.PopContext()
+	return self.helpers.GPG.WithGpgHandling(cmdObj, self.c.Tr.CommittingStatus, func() error {
+		self.onCommitSuccess()
+		return nil
+	})
+}
+
+func (self *CommitMessageController) handleCommitClose() error {
+	return self.c.PopContext()
+}

pkg/gui/controllers/files_controller.go

@@ -8,7 +8,6 @@ import (
 	"github.com/jesseduffield/gocui"
 	"github.com/jesseduffield/lazygit/pkg/commands/git_commands"
 	"github.com/jesseduffield/lazygit/pkg/commands/models"
-	"github.com/jesseduffield/lazygit/pkg/commands/oscommands"
 	"github.com/jesseduffield/lazygit/pkg/config"
 	"github.com/jesseduffield/lazygit/pkg/gui/context"
 	"github.com/jesseduffield/lazygit/pkg/gui/filetree"
@@ -20,11 +19,10 @@ type FilesController struct {
 	baseController
 	*controllerCommon
 
-	enterSubmodule         func(submodule *models.SubmoduleConfig) error
-	setCommitMessage       func(message string)
-	withGpgHandling        func(cmdObj oscommands.ICmdObj, waitingStatus string, onSuccess func() error) error
-	getFailedCommitMessage func() string
-	switchToMergeFn        func(path string) error
+	enterSubmodule        func(submodule *models.SubmoduleConfig) error
+	setCommitMessage      func(message string)
+	getSavedCommitMessage func() string
+	switchToMergeFn       func(path string) error
 }
 
 var _ types.IController = &FilesController{}
@@ -33,17 +31,15 @@ func NewFilesController(
 	common *controllerCommon,
 	enterSubmodule func(submodule *models.SubmoduleConfig) error,
 	setCommitMessage func(message string),
-	withGpgHandling func(cmdObj oscommands.ICmdObj, waitingStatus string, onSuccess func() error) error,
-	getFailedCommitMessage func() string,
+	getSavedCommitMessage func() string,
 	switchToMergeFn func(path string) error,
 ) *FilesController {
 	return &FilesController{
-		controllerCommon:       common,
-		enterSubmodule:         enterSubmodule,
-		setCommitMessage:       setCommitMessage,
-		withGpgHandling:        withGpgHandling,
-		getFailedCommitMessage: getFailedCommitMessage,
-		switchToMergeFn:        switchToMergeFn,
+		controllerCommon:      common,
+		enterSubmodule:        enterSubmodule,
+		setCommitMessage:      setCommitMessage,
+		getSavedCommitMessage: getSavedCommitMessage,
+		switchToMergeFn:       switchToMergeFn,
 	}
 }
 
@@ -409,9 +405,9 @@ func (self *FilesController) HandleCommitPress() error {
 		return self.promptToStageAllAndRetry(self.HandleCommitPress)
 	}
 
-	failedCommitMessage := self.getFailedCommitMessage()
-	if len(failedCommitMessage) > 0 {
-		self.setCommitMessage(failedCommitMessage)
+	savedCommitMessage := self.getSavedCommitMessage()
+	if len(savedCommitMessage) > 0 {
+		self.setCommitMessage(savedCommitMessage)
 	} else {
 		commitPrefixConfig := self.commitPrefixConfigForRepo()
 		if commitPrefixConfig != nil {
@@ -470,7 +466,7 @@ func (self *FilesController) handleAmendCommitPress() error {
 		HandleConfirm: func() error {
 			cmdObj := self.git.Commit.AmendHeadCmdObj()
 			self.c.LogAction(self.c.Tr.Actions.AmendCommit)
-			return self.withGpgHandling(cmdObj, self.c.Tr.AmendingStatus, nil)
+			return self.helpers.GPG.WithGpgHandling(cmdObj, self.c.Tr.AmendingStatus, nil)
 		},
 	})
 }

pkg/gui/controllers/helpers/gpg_helper.go

@@ -0,0 +1,74 @@
+package helpers
+
+import (
+	"fmt"
+
+	"github.com/jesseduffield/lazygit/pkg/commands"
+	"github.com/jesseduffield/lazygit/pkg/commands/oscommands"
+	"github.com/jesseduffield/lazygit/pkg/gui/types"
+)
+
+type GpgHelper struct {
+	c   *types.HelperCommon
+	os  *oscommands.OSCommand
+	git *commands.GitCommand
+}
+
+func NewGpgHelper(
+	c *types.HelperCommon,
+	os *oscommands.OSCommand,
+	git *commands.GitCommand,
+) *GpgHelper {
+	return &GpgHelper{
+		c:   c,
+		os:  os,
+		git: git,
+	}
+}
+
+// Currently there is a bug where if we switch to a subprocess from within
+// WithWaitingStatus we get stuck there and can't return to lazygit. We could
+// fix this bug, or just stop running subprocesses from within there, given that
+// we don't need to see a loading status if we're in a subprocess.
+// TODO: we shouldn't need to use a shell here, but looks like that NewShell function contains some windows specific quoting stuff. We should centralise that.
+func (self *GpgHelper) WithGpgHandling(cmdObj oscommands.ICmdObj, waitingStatus string, onSuccess func() error) error {
+	useSubprocess := self.git.Config.UsingGpg()
+	if useSubprocess {
+		success, err := self.c.RunSubprocess(self.os.Cmd.NewShell(cmdObj.ToString()))
+		if success && onSuccess != nil {
+			if err := onSuccess(); err != nil {
+				return err
+			}
+		}
+		if err := self.c.Refresh(types.RefreshOptions{Mode: types.ASYNC}); err != nil {
+			return err
+		}
+
+		return err
+	} else {
+		return self.runAndStream(cmdObj, waitingStatus, onSuccess)
+	}
+}
+
+func (self *GpgHelper) runAndStream(cmdObj oscommands.ICmdObj, waitingStatus string, onSuccess func() error) error {
+	cmdObj = self.os.Cmd.NewShell(cmdObj.ToString())
+
+	return self.c.WithWaitingStatus(waitingStatus, func() error {
+		if err := cmdObj.StreamOutput().Run(); err != nil {
+			_ = self.c.Refresh(types.RefreshOptions{Mode: types.ASYNC})
+			return self.c.Error(
+				fmt.Errorf(
+					self.c.Tr.GitCommandFailed, self.c.UserConfig.Keybinding.Universal.ExtrasMenu,
+				),
+			)
+		}
+
+		if onSuccess != nil {
+			if err := onSuccess(); err != nil {
+				return err
+			}
+		}
+
+		return self.c.Refresh(types.RefreshOptions{Mode: types.ASYNC})
+	})
+}

pkg/gui/controllers/helpers/helpers.go

@@ -11,6 +11,7 @@ type Helpers struct {
 	CherryPick     *CherryPickHelper
 	Host           *HostHelper
 	PatchBuilding  *PatchBuildingHelper
+	GPG            *GpgHelper
 }
 
 func NewStubHelpers() *Helpers {
@@ -25,5 +26,6 @@ func NewStubHelpers() *Helpers {
 		CherryPick:     &CherryPickHelper{},
 		Host:           &HostHelper{},
 		PatchBuilding:  &PatchBuildingHelper{},
+		GPG:            &GpgHelper{},
 	}
 }