store popup version in state not config so that we never need to write to the user config

docs/Config.md

@@ -57,6 +57,7 @@ Default path for the config file:
   confirmOnQuit: false
   # determines whether hitting 'esc' will quit the application when there is nothing to cancel/close
   quitOnTopLevelReturn: true
+  disableStartupPopups: false
   keybinding:
     universal:
       quit: 'q'

pkg/config/app_config.go

@@ -37,9 +37,7 @@ type AppConfigurer interface {
 	GetUserConfigDir() string
 	GetUserConfigPath() string
 	GetAppState() *AppState
-	WriteToUserConfig(func(*UserConfig) error) error
 	SaveAppState() error
-	LoadAppState() error
 	SetIsNewRepo(bool)
 	GetIsNewRepo() bool
 }
@@ -60,6 +58,11 @@ func NewAppConfig(name, version, commit, date string, buildSource string, debugg
 		debuggingFlag = true
 	}
 
+	appState, err := loadAppState()
+	if err != nil {
+		return nil, err
+	}
+
 	appConfig := &AppConfig{
 		Name:           "lazygit",
 		Version:        version,
@@ -70,14 +73,10 @@ func NewAppConfig(name, version, commit, date string, buildSource string, debugg
 		UserConfig:     userConfig,
 		UserConfigDir:  configDir,
 		UserConfigPath: filepath.Join(configDir, "config.yml"),
-		AppState:       &AppState{},
+		AppState:       appState,
 		IsNewRepo:      false,
 	}
 
-	if err := appConfig.LoadAppState(); err != nil {
-		return nil, err
-	}
-
 	return appConfig, nil
 }
 
@@ -195,28 +194,6 @@ func configFilePath(filename string) (string, error) {
 	return filepath.Join(folder, filename), nil
 }
 
-// WriteToUserConfig allows you to set a value on the user config to be saved
-// note that if you set a zero-value, it may be ignored e.g. a false or 0 or
-// empty string this is because we are using the omitempty yaml directive so
-// that we don't write a heap of zero values to the user's config.yml
-func (c *AppConfig) WriteToUserConfig(updateConfig func(*UserConfig) error) error {
-	userConfig, err := loadUserConfig(c.UserConfigDir, &UserConfig{})
-	if err != nil {
-		return err
-	}
-
-	if err := updateConfig(userConfig); err != nil {
-		return err
-	}
-
-	file, err := os.OpenFile(c.ConfigFilename(), os.O_WRONLY|os.O_CREATE, 0666)
-	if err != nil {
-		return err
-	}
-
-	return yaml.NewEncoder(file).Encode(userConfig)
-}
-
 // ConfigFilename returns the filename of the current config file
 func (c *AppConfig) ConfigFilename() string {
 	return filepath.Join(c.UserConfigDir, "config.yml")
@@ -237,20 +214,29 @@ func (c *AppConfig) SaveAppState() error {
 	return ioutil.WriteFile(filepath, marshalledAppState, 0644)
 }
 
-// LoadAppState loads recorded AppState from file
-func (c *AppConfig) LoadAppState() error {
+// loadAppState loads recorded AppState from file
+func loadAppState() (*AppState, error) {
 	filepath, err := configFilePath("state.yml")
 	if err != nil {
-		return err
+		return nil, err
 	}
+
 	appStateBytes, err := ioutil.ReadFile(filepath)
 	if err != nil {
-		return err
+		return nil, err
 	}
+
 	if len(appStateBytes) == 0 {
-		return yaml.Unmarshal(getDefaultAppState(), c.AppState)
+		return getDefaultAppState(), nil
 	}
-	return yaml.Unmarshal(appStateBytes, c.AppState)
+
+	appState := &AppState{}
+	err = yaml.Unmarshal(appStateBytes, appState)
+	if err != nil {
+		return nil, err
+	}
+
+	return appState, nil
 }
 
 func GetDefaultConfig() *UserConfig {
@@ -314,6 +300,7 @@ reporting: 'undetermined' # one of: 'on' | 'off' | 'undetermined'
 splashUpdatesIndex: 0
 confirmOnQuit: false
 quitOnTopLevelReturn: true
+disableStartupPopups: false
 keybinding:
   universal:
     quit: 'q'
@@ -433,15 +420,17 @@ keybinding:
 // AppState stores data between runs of the app like when the last update check
 // was performed and which other repos have been checked out
 type AppState struct {
-	LastUpdateCheck int64
-	RecentRepos     []string
+	LastUpdateCheck     int64
+	RecentRepos         []string
+	StartupPopupVersion int
 }
 
-func getDefaultAppState() []byte {
-	return []byte(`
-    lastUpdateCheck: 0
-    recentRepos: []
-  `)
+func getDefaultAppState() *AppState {
+	return &AppState{
+		LastUpdateCheck:     0,
+		RecentRepos:         []string{},
+		StartupPopupVersion: 0,
+	}
 }
 
 func LogPath() (string, error) {

pkg/config/user_config.go

@@ -208,8 +208,8 @@ type UserConfig struct {
 		} `yaml:"submodules"`
 	} `yaml:"keybinding"`
 	// OS determines what defaults are set for opening files and links
-	OS                  OSConfig          `yaml:"os,omitempty"`
-	StartupPopupVersion int               `yaml:"startupPopupVersion"`
-	CustomCommands      []CustomCommand   `yaml:"customCommands"`
-	Services            map[string]string `yaml:"services"`
+	OS                   OSConfig          `yaml:"os,omitempty"`
+	DisableStartupPopups bool              `yaml:"disableStartupPopups"`
+	CustomCommands       []CustomCommand   `yaml:"customCommands"`
+	Services             map[string]string `yaml:"services"`
 }

pkg/gui/gui.go

@@ -41,7 +41,7 @@ const (
 	SCREEN_FULL
 )
 
-const StartupPopupVersion = 1
+const StartupPopupVersion = 2
 
 // OverlappingEdges determines if panel edges overlap
 var OverlappingEdges = false
@@ -450,13 +450,14 @@ func (gui *Gui) Run() error {
 		return err
 	}
 
-	popupTasks := []func(chan struct{}) error{}
-	configPopupVersion := gui.Config.GetUserConfig().StartupPopupVersion
-	// -1 means we've disabled these popups
-	if configPopupVersion != -1 && configPopupVersion < StartupPopupVersion {
-		popupTasks = append(popupTasks, gui.showIntroPopupMessage)
+	if !gui.Config.GetUserConfig().DisableStartupPopups {
+		popupTasks := []func(chan struct{}) error{}
+		storedPopupVersion := gui.Config.GetAppState().StartupPopupVersion
+		if storedPopupVersion < StartupPopupVersion {
+			popupTasks = append(popupTasks, gui.showIntroPopupMessage)
+		}
+		gui.showInitialPopups(popupTasks)
 	}
-	gui.showInitialPopups(popupTasks)
 
 	gui.waitForIntro.Add(1)
 	if gui.Config.GetUserConfig().Git.AutoFetch {
@@ -573,10 +574,8 @@ func (gui *Gui) showInitialPopups(tasks []func(chan struct{}) error) {
 func (gui *Gui) showIntroPopupMessage(done chan struct{}) error {
 	onConfirm := func() error {
 		done <- struct{}{}
-		return gui.Config.WriteToUserConfig(func(userConfig *config.UserConfig) error {
-			userConfig.StartupPopupVersion = StartupPopupVersion
-			return nil
-		})
+		gui.Config.GetAppState().StartupPopupVersion = StartupPopupVersion
+		return gui.Config.SaveAppState()
 	}
 
 	return gui.ask(askOpts{