Merge pull request #99 from setlog/quality-happy-path2

Reduce complexity of main function. Eliminates code duplication

Author: MMulthaupt

cmd/launcher/gui/reporting.go

@@ -19,12 +19,6 @@ import (
 	"github.com/setlog/trivrost/cmd/launcher/flags"
 )
 
-func ReportFatalError(fatalError error, launcherFlags *flags.LauncherFlags) {
-	WaitUntilReady()
-	defer Quit()
-	PanicInformatively(fatalError, launcherFlags)
-}
-
 func HandlePanic(launcherFlags *flags.LauncherFlags) {
 	if r := recover(); r != nil {
 		if err, ok := r.(error); ok && errors.Is(err, context.Canceled) {

cmd/launcher/launcher/entry.go

@@ -9,14 +9,9 @@ import (
 	log "github.com/sirupsen/logrus"
 
 	"github.com/setlog/trivrost/cmd/launcher/flags"
-	"github.com/setlog/trivrost/cmd/launcher/gui"
 )
 
 func LauncherMain(ctx context.Context, launcherFlags *flags.LauncherFlags) {
-	gui.WaitUntilReady()
-	defer gui.Quit()
-	defer gui.HandlePanic(launcherFlags)
-
 	places.MakePlaces()
 	defer Linger()
 	locking.AcquireLock(ctx, launcherFlags)

cmd/launcher/launcher/run.go

@@ -27,7 +27,7 @@ func Run(ctx context.Context, launcherFlags *flags.LauncherFlags) {
 	updater.Prepare(resources.LauncherConfig.DeploymentConfigURL)
 
 	if !IsInstanceInstalledInSystemMode() && !launcherFlags.SkipSelfUpdate {
-		updateSelf(updater, launcherFlags)
+		updateLauncherToLatestVersion(updater, launcherFlags)
 	}
 	updateBundles(ctx, updater)
 
@@ -67,9 +67,9 @@ func createUpdater(ctx context.Context, handler *gui.GuiDownloadProgressHandler)
 	return updater
 }
 
-func updateSelf(updater *bundle.Updater, launcherFlags *flags.LauncherFlags) {
-	updater.SetIgnoredSelfUpdateBundleInfoSHAs(resources.LauncherConfig.IgnoreLauncherBundleInfoHashes)
-	if updater.UpdateSelf() {
+func updateLauncherToLatestVersion(updater *bundle.Updater, launcherFlags *flags.LauncherFlags) {
+	updater.SetIgnoredLauncherUpdateBundleInfoSHAs(resources.LauncherConfig.IgnoreLauncherBundleInfoHashes)
+	if updater.UpdateLauncherToLatestVersion() {
 		runPostBinaryUpdateProvisioning()
 		locking.Restart(true, launcherFlags)
 	}

cmd/launcher/main.go

@@ -45,25 +45,12 @@ var gitBranch string
 
 func main() {
 	defer misc.LogPanic()
-	launcherFlags, fatalError := initializeEnvironment()
+	launcherFlags, envErr := initializeEnvironment()
 	ctx, cancelFunc := context.WithCancel(context.Background())
 
-	if fatalError == nil {
-		go launcher.LauncherMain(ctx, launcherFlags)
-	} else {
-		go gui.ReportFatalError(fatalError, launcherFlags)
-	}
-
-	// On MacOS, only the first thread created by the OS is allowed to be the main GUI thread.
-	// Also, on Windows, OLE code needs to run on the main thread, which we rely on when creating shortcuts.
-	runtime.LockOSThread()
+	go runLauncher(ctx, envErr, launcherFlags)
+	runGUI(ctx, cancelFunc, launcherFlags, envErr == nil)
 
-	err := gui.Main(ctx, cancelFunc, resources.LauncherConfig.BrandingName, !launcherFlags.Uninstall && fatalError == nil)
-	if err != nil {
-		log.Fatalf("gui.Main() failed: %v\n", err)
-	}
-
-	log.Info("End of main().")
 	log.Exit(0)
 }
 
@@ -80,6 +67,28 @@ func initializeEnvironment() (*flags.LauncherFlags, error) {
 	return launcherFlags, misc.NewNestedErrorFromFirstCause(argumentError, flagError, pathError, placesError)
 }
 
+func runLauncher(ctx context.Context, fatalError error, launcherFlags *flags.LauncherFlags) {
+	gui.WaitUntilReady()
+	defer gui.Quit()
+	if fatalError != nil {
+		gui.PanicInformatively(fatalError, launcherFlags)
+	}
+	defer gui.HandlePanic(launcherFlags)
+	launcher.LauncherMain(ctx, launcherFlags)
+}
+
+func runGUI(ctx context.Context, cancelFunc context.CancelFunc, launcherFlags *flags.LauncherFlags, showMainWindow bool) {
+	// On MacOS, only the first thread created by the OS is allowed to be the main GUI thread.
+	// Also, on Windows, OLE code needs to run on the main thread, which we rely on when creating shortcuts.
+	runtime.LockOSThread()
+
+	err := gui.Main(ctx, cancelFunc, resources.LauncherConfig.BrandingName, !launcherFlags.Uninstall && showMainWindow)
+	if err != nil {
+		log.Fatalf("gui.Main() failed: %v\n", err)
+	}
+	log.Info("runGUI() terminated.")
+}
+
 func parseEnvironment() (launcherFlags *flags.LauncherFlags, argumentError, flagError, pathError, evalError, placesError error) {
 	launcherFlags = &flags.LauncherFlags{}
 	if len(os.Args) < 1 {

pkg/launcher/bundle/update_self.go

@@ -16,7 +16,7 @@ import (
 	"github.com/setlog/trivrost/pkg/system"
 )
 
-func (u *Updater) UpdateSelf() (needsRestart bool) {
+func (u *Updater) UpdateLauncherToLatestVersion() (madeChanges bool) {
 	if u.deploymentConfig.GetLauncherUpdateConfig() == nil {
 		return false
 	}
@@ -25,7 +25,7 @@ func (u *Updater) UpdateSelf() (needsRestart bool) {
 	return u.updateProgram(programPath)
 }
 
-func (u *Updater) updateProgram(programPath string) (needsRestart bool) {
+func (u *Updater) updateProgram(programPath string) (madeChanges bool) {
 	log.Infof("Calculating local hashes.")
 	u.announceStatus(DetermineLocalLauncherVersion, 20)
 	presentState := hashing.MustHash(u.ctx, programPath)
@@ -97,12 +97,12 @@ func (u *Updater) swapBinary(localBinaryPath string, remoteURL string, newFileIn
 	}
 }
 
-func (u *Updater) SetIgnoredSelfUpdateBundleInfoSHAs(ignoreShas []string) {
-	u.ignoredSelfUpdateBundleInfoSHAs = ignoreShas
+func (u *Updater) SetIgnoredLauncherUpdateBundleInfoSHAs(ignoreShas []string) {
+	u.ignoredLauncherUpdateBundleInfoSHAs = ignoreShas
 }
 
 func (u *Updater) IsShaIgnored(sha string) bool {
-	for _, ignoreSha := range u.ignoredSelfUpdateBundleInfoSHAs {
+	for _, ignoreSha := range u.ignoredLauncherUpdateBundleInfoSHAs {
 		if ignoreSha == sha {
 			return true
 		}

pkg/launcher/bundle/updater.go

@@ -29,8 +29,8 @@ type Updater struct {
 	deploymentConfig *config.DeploymentConfig
 	publicKeys       []*rsa.PublicKey
 
-	bundleUpdateInfos               []*BundleUpdateInfo
-	ignoredSelfUpdateBundleInfoSHAs []string
+	bundleUpdateInfos                   []*BundleUpdateInfo
+	ignoredLauncherUpdateBundleInfoSHAs []string
 
 	userBundlesFolderPath   string
 	systemBundlesFolderPath string
@@ -58,10 +58,6 @@ func (u *Updater) DisableTimestampVerification() {
 	u.timestampFilePath = ""
 }
 
-func (u *Updater) IsTimestampVerificationEnabled() bool {
-	return u.timestampFilePath == ""
-}
-
 func (u *Updater) SetStatusCallback(statusCallback func(UpdaterStatus, uint64)) {
 	u.statusCallback = statusCallback
 }