Move LocalBranchSortOrder and RemoteBranchSortOrder to user config

At the same time, we change the defaults for both of them to "date" (they were
"recency" and "alphabetical", respectively, before). This is the reason we need
to touch so many integration tests. For some of them I decided to adapt the test
assertions to the changed sort order; for others, I added a SetupConfig step to
set the order back to "recency" so that I don't have to change what the test
does (e.g. how many SelectNextItem() calls are needed to get to a certain
branch).

Author: stefanhaller

docs/Config.md

@@ -399,6 +399,16 @@ git:
     # displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)
     showWholeGraph: false
 
+  # How branches are sorted in the local branches view.
+  # One of: 'date' (default) | 'recency' | 'alphabetical'
+  # Can be changed from within Lazygit with the Sort Order menu (`s`) in the branches panel.
+  localBranchSortOrder: date
+
+  # How branches are sorted in the remote branches view.
+  # One of: 'date' (default) | 'alphabetical'
+  # Can be changed from within Lazygit with the Sort Order menu (`s`) in the remote branches panel.
+  remoteBranchSortOrder: date
+
   # When copying commit hashes to the clipboard, truncate them to this
   # length. Set to 40 to disable truncation.
   truncateCopiedCommitHashesTo: 12

pkg/commands/git_commands/branch_loader.go

@@ -74,7 +74,7 @@ func (self *BranchLoader) Load(reflogCommits []*models.Commit,
 ) ([]*models.Branch, error) {
 	branches := self.obtainBranches()
 
-	if self.AppState.LocalBranchSortOrder == "recency" {
+	if self.UserConfig().Git.LocalBranchSortOrder == "recency" {
 		reflogBranches := self.obtainReflogBranches(reflogCommits)
 		// loop through reflog branches. If there is a match, merge them, then remove it from the branches and keep it in the reflog branches
 		branchesWithRecency := make([]*models.Branch, 0)
@@ -254,7 +254,7 @@ func (self *BranchLoader) obtainBranches() []*models.Branch {
 			return nil, false
 		}
 
-		storeCommitDateAsRecency := self.AppState.LocalBranchSortOrder != "recency"
+		storeCommitDateAsRecency := self.UserConfig().Git.LocalBranchSortOrder != "recency"
 		return obtainBranch(split, storeCommitDateAsRecency), true
 	})
 }
@@ -268,7 +268,7 @@ func (self *BranchLoader) getRawBranches() (string, error) {
 	)
 
 	var sortOrder string
-	switch strings.ToLower(self.AppState.LocalBranchSortOrder) {
+	switch strings.ToLower(self.UserConfig().Git.LocalBranchSortOrder) {
 	case "recency", "date":
 		sortOrder = "-committerdate"
 	case "alphabetical":

pkg/commands/git_commands/remote_loader.go

@@ -85,7 +85,7 @@ func (self *RemoteLoader) getRemoteBranchesByRemoteName() (map[string][]*models.
 	remoteBranchesByRemoteName := make(map[string][]*models.RemoteBranch)
 
 	var sortOrder string
-	switch strings.ToLower(self.AppState.RemoteBranchSortOrder) {
+	switch strings.ToLower(self.UserConfig().Git.RemoteBranchSortOrder) {
 	case "alphabetical":
 		sortOrder = "refname"
 	case "date":

pkg/config/app_config.go

@@ -676,9 +676,7 @@ type AppState struct {
 	// For backwards compatibility we keep the old name in yaml files.
 	ShellCommandsHistory []string `yaml:"customcommandshistory"`
 
-	HideCommandLog        bool
-	LocalBranchSortOrder  string
-	RemoteBranchSortOrder string
+	HideCommandLog bool
 
 	// One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'
 	// 'topo-order' makes it easier to read the git log graph, but commits may not
@@ -692,14 +690,12 @@ type AppState struct {
 
 func getDefaultAppState() *AppState {
 	return &AppState{
-		LastUpdateCheck:       0,
-		RecentRepos:           []string{},
-		StartupPopupVersion:   0,
-		LastVersion:           "",
-		LocalBranchSortOrder:  "recency",
-		RemoteBranchSortOrder: "alphabetical",
-		GitLogOrder:           "", // should be "topo-order" eventually
-		GitLogShowGraph:       "", // should be "always" eventually
+		LastUpdateCheck:     0,
+		RecentRepos:         []string{},
+		StartupPopupVersion: 0,
+		LastVersion:         "",
+		GitLogOrder:         "", // should be "topo-order" eventually
+		GitLogShowGraph:     "", // should be "always" eventually
 	}
 }
 

pkg/config/user_config.go

@@ -285,6 +285,14 @@ type GitConfig struct {
 	ParseEmoji bool `yaml:"parseEmoji"`
 	// Config for showing the log in the commits view
 	Log LogConfig `yaml:"log"`
+	// How branches are sorted in the local branches view.
+	// One of: 'date' (default) | 'recency' | 'alphabetical'
+	// Can be changed from within Lazygit with the Sort Order menu (`s`) in the branches panel.
+	LocalBranchSortOrder string `yaml:"localBranchSortOrder" jsonschema:"enum=date,enum=recency,enum=alphabetical"`
+	// How branches are sorted in the remote branches view.
+	// One of: 'date' (default) | 'alphabetical'
+	// Can be changed from within Lazygit with the Sort Order menu (`s`) in the remote branches panel.
+	RemoteBranchSortOrder string `yaml:"remoteBranchSortOrder" jsonschema:"enum=date,enum=alphabetical"`
 	// When copying commit hashes to the clipboard, truncate them to this
 	// length. Set to 40 to disable truncation.
 	TruncateCopiedCommitHashesTo int `yaml:"truncateCopiedCommitHashesTo"`
@@ -805,6 +813,8 @@ func GetDefaultConfig() *UserConfig {
 				ShowGraph:      "always",
 				ShowWholeGraph: false,
 			},
+			LocalBranchSortOrder:         "date",
+			RemoteBranchSortOrder:        "date",
 			SkipHookPrefix:               "WIP",
 			MainBranches:                 []string{"master", "main"},
 			AutoFetch:                    true,

pkg/config/user_config_validation.go

@@ -23,6 +23,14 @@ func (config *UserConfig) Validate() error {
 		[]string{"none", "onlyMainBranches", "allBranches"}); err != nil {
 		return err
 	}
+	if err := validateEnum("git.localBranchSortOrder", config.Git.LocalBranchSortOrder,
+		[]string{"date", "recency", "alphabetical"}); err != nil {
+		return err
+	}
+	if err := validateEnum("git.remoteBranchSortOrder", config.Git.RemoteBranchSortOrder,
+		[]string{"date", "alphabetical"}); err != nil {
+		return err
+	}
 	if err := validateKeybindings(config.Keybinding); err != nil {
 		return err
 	}

pkg/config/user_config_validation_test.go

@@ -56,6 +56,32 @@ func TestUserConfigValidate_enums(t *testing.T) {
 				{value: "invalid_value", valid: false},
 			},
 		},
+		{
+			name: "Git.LocalBranchSortOrder",
+			setup: func(config *UserConfig, value string) {
+				config.Git.LocalBranchSortOrder = value
+			},
+			testCases: []testCase{
+				{value: "date", valid: true},
+				{value: "recency", valid: true},
+				{value: "alphabetical", valid: true},
+				{value: "", valid: false},
+				{value: "invalid_value", valid: false},
+			},
+		},
+		{
+			name: "Git.RemoteBranchSortOrder",
+			setup: func(config *UserConfig, value string) {
+				config.Git.RemoteBranchSortOrder = value
+			},
+			testCases: []testCase{
+				{value: "date", valid: true},
+				{value: "recency", valid: false},
+				{value: "alphabetical", valid: true},
+				{value: "", valid: false},
+				{value: "invalid_value", valid: false},
+			},
+		},
 		{
 			name: "Keybindings",
 			setup: func(config *UserConfig, value string) {

pkg/gui/controllers/branches_controller.go

@@ -674,16 +674,15 @@ func (self *BranchesController) createTag(branch *models.Branch) error {
 
 func (self *BranchesController) createSortMenu() error {
 	return self.c.Helpers().Refs.CreateSortOrderMenu([]string{"recency", "alphabetical", "date"}, func(sortOrder string) error {
-		if self.c.GetAppState().LocalBranchSortOrder != sortOrder {
-			self.c.GetAppState().LocalBranchSortOrder = sortOrder
-			self.c.SaveAppStateAndLogError()
+		if self.c.UserConfig().Git.LocalBranchSortOrder != sortOrder {
+			self.c.UserConfig().Git.LocalBranchSortOrder = sortOrder
 			self.c.Contexts().Branches.SetSelection(0)
 			self.c.Refresh(types.RefreshOptions{Mode: types.ASYNC, Scope: []types.RefreshableView{types.BRANCHES}})
 			return nil
 		}
 		return nil
 	},
-		self.c.GetAppState().LocalBranchSortOrder)
+		self.c.UserConfig().Git.LocalBranchSortOrder)
 }
 
 func (self *BranchesController) createResetMenu(selectedBranch *models.Branch) error {

pkg/gui/controllers/helpers/refresh_helper.go

@@ -125,7 +125,7 @@ func (self *RefreshHelper) Refresh(options types.RefreshOptions) {
 			refresh("commits and commit files", self.refreshCommitsAndCommitFiles)
 
 			includeWorktreesWithBranches = scopeSet.Includes(types.WORKTREES)
-			if self.c.AppState.LocalBranchSortOrder == "recency" {
+			if self.c.UserConfig().Git.LocalBranchSortOrder == "recency" {
 				refresh("reflog and branches", func() { self.refreshReflogAndBranches(includeWorktreesWithBranches, options.KeepBranchSelectionIndex) })
 			} else {
 				refresh("branches", func() { self.refreshBranches(includeWorktreesWithBranches, options.KeepBranchSelectionIndex, true) })
@@ -446,7 +446,7 @@ func (self *RefreshHelper) refreshBranches(refreshWorktrees bool, keepBranchSele
 	defer self.c.Mutexes().RefreshingBranchesMutex.Unlock()
 
 	reflogCommits := self.c.Model().FilteredReflogCommits
-	if self.c.Modes().Filtering.Active() && self.c.AppState.LocalBranchSortOrder == "recency" {
+	if self.c.Modes().Filtering.Active() && self.c.UserConfig().Git.LocalBranchSortOrder == "recency" {
 		// in filter mode we filter our reflog commits to just those containing the path
 		// however we need all the reflog entries to populate the recencies of our branches
 		// which allows us to order them correctly. So if we're filtering we'll just

pkg/gui/controllers/remote_branches_controller.go

@@ -146,15 +146,14 @@ func (self *RemoteBranchesController) rebase(selectedBranch *models.RemoteBranch
 
 func (self *RemoteBranchesController) createSortMenu() error {
 	return self.c.Helpers().Refs.CreateSortOrderMenu([]string{"alphabetical", "date"}, func(sortOrder string) error {
-		if self.c.GetAppState().RemoteBranchSortOrder != sortOrder {
-			self.c.GetAppState().RemoteBranchSortOrder = sortOrder
-			self.c.SaveAppStateAndLogError()
+		if self.c.UserConfig().Git.RemoteBranchSortOrder != sortOrder {
+			self.c.UserConfig().Git.RemoteBranchSortOrder = sortOrder
 			self.c.Contexts().RemoteBranches.SetSelection(0)
 			self.c.Refresh(types.RefreshOptions{Mode: types.ASYNC, Scope: []types.RefreshableView{types.REMOTES}})
 		}
 		return nil
 	},
-		self.c.GetAppState().RemoteBranchSortOrder)
+		self.c.UserConfig().Git.RemoteBranchSortOrder)
 }
 
 func (self *RemoteBranchesController) createResetMenu(selectedBranch *models.RemoteBranch) error {