Update support for environment-based config flags (#1239)

* set config options from env vars * clean-ups * clean-ups, add comments * clean-ups, add comments * clean-ups, add comments * update hit proxy script * Fix test and a few more clean-ups * fix: fixing flashlight checksum mismatch --------- Co-authored-by: WendelHime <[email protected]>
getlantern · Dec 3, 2024 · 21d6069 · 21d6069
1 parent d3ab3c3
commit 21d6069
Show file tree

Hide file tree

Showing 6 changed files with 104 additions and 69 deletions.
diff --git a/desktop/app/app.go b/desktop/app/app.go
@@ -16,6 +16,7 @@ import (
 
 	"github.com/getsentry/sentry-go"
 
+	"github.com/getlantern/appdir"
 	"github.com/getlantern/errors"
 	"github.com/getlantern/eventual"
 	"github.com/getlantern/flashlight/v7"
@@ -99,7 +100,21 @@ type App struct {
 }
 
 // NewApp creates a new desktop app that initializes the app and acts as a moderator between all desktop components.
-func NewApp(flags flashlight.Flags, configDir string) *App {
+func NewApp() *App {
+	// initialize app config and flags based on environment variables
+	flags, err := initializeAppConfig()
+	if err != nil {
+		log.Fatalf("failed to initialize app config: %w", err)
+	}
+	return NewAppWithFlags(flags, flags.ConfigDir)
+}
+
+// NewAppWithFlags creates a new instance of App initialized with the given flags and configDir
+func NewAppWithFlags(flags flashlight.Flags, configDir string) *App {
+	if configDir == "" {
+		log.Debug("Config directory is empty, using default location")
+		configDir = appdir.General(common.DefaultAppName)
+	}
 	ss := settings.LoadSettings(configDir)
 	statsTracker := NewStatsTracker()
 	app := &App{

diff --git a/desktop/app/config.go b/desktop/app/config.go
@@ -3,17 +3,25 @@ package app
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 	"os"
+	"path/filepath"
 	"strconv"
 	"sync"
 
+	"github.com/getlantern/appdir"
+	"github.com/getlantern/flashlight/v7"
 	fcommon "github.com/getlantern/flashlight/v7/common"
 	"github.com/getlantern/flashlight/v7/config"
 	"github.com/getlantern/lantern-client/desktop/ws"
 	"github.com/getlantern/lantern-client/internalsdk/common"
 	"github.com/getlantern/lantern-client/internalsdk/protos"
 )
 
+const (
+	defaultConfigDirPerm = 0750
+)
+
 type configService struct {
 	service     *ws.Service
 	listeners   []func(ConfigOptions)
@@ -107,3 +115,52 @@ func (app *App) sendConfigOptions() {
 		},
 	})
 }
+
+// initializeAppConfig initializes application configuration and flags based on environment variables
+func initializeAppConfig() (flashlight.Flags, error) {
+	flags := flashlight.ParseFlags()
+	if flags.Pprof {
+		go startPprof("localhost:6060")
+	}
+	parseBoolEnv := func(key string, defaultValue bool) bool {
+		val := os.Getenv(key)
+		parsedValue, err := strconv.ParseBool(val)
+		if err != nil {
+			return defaultValue
+		}
+		return parsedValue
+	}
+
+	// helper to resolve CONFIG_DIR to an absolute path
+	resolveConfigDir := func(dir string) string {
+		if filepath.IsAbs(dir) {
+			return dir
+		}
+		absPath, err := filepath.Abs(dir)
+		if err != nil {
+			return dir
+		}
+		return absPath
+	}
+
+	// Parse environment-based flags
+	stickyConfig := parseBoolEnv("STICKY_CONFIG", false)
+	readableConfig := parseBoolEnv("READABLE_CONFIG", true)
+	configDir := os.Getenv("CONFIG_DIR")
+	if configDir == "" {
+		configDir = appdir.General(common.DefaultAppName)
+		log.Debugf("CONFIG_DIR not set. Using default: %s", configDir)
+	} else {
+		configDir = resolveConfigDir(configDir)
+	}
+	if err := createDirIfNotExists(configDir, defaultConfigDirPerm); err != nil {
+		return flags, fmt.Errorf("Unable to create config directory %s: %v", configDir, err)
+	}
+	flags.StickyConfig = stickyConfig
+	flags.ReadableConfig = readableConfig
+	flags.ConfigDir = configDir
+
+	log.Debugf("Config options: directory %v sticky %v readable %v", configDir,
+		stickyConfig, readableConfig)
+	return flags, nil
+}
diff --git a/desktop/app/integration_test.go b/desktop/app/integration_test.go
@@ -190,7 +190,7 @@ func startApp(t *testing.T, helper *integrationtest.Helper) (*App, error) {
 		Timeout:            time.Duration(0),
 	}
 	ss := settings.EmptySettings()
-	a := NewApp(flags, helper.ConfigDir)
+	a := NewAppWithFlags(flags, helper.ConfigDir)
 	id := ss.GetUserID()
 	if id == 0 {
 		ss.SetUserIDAndToken(1, "token")

diff --git a/desktop/app/util.go b/desktop/app/util.go
@@ -0,0 +1,26 @@
+package app
+
+import (
+	"net/http"
+	"os"
+)
+
+// createDirIfNotExists checks that a directory exists, creating it if necessary
+func createDirIfNotExists(dir string, perm os.FileMode) error {
+	if _, err := os.Stat(dir); err != nil {
+		if os.IsNotExist(err) {
+			return os.MkdirAll(dir, perm)
+		}
+		return err
+	}
+	return nil
+}
+
+// startPprof starts a pprof server at the given address
+func startPprof(addr string) {
+	log.Debugf("Starting pprof server at %s (http://%s/debug/pprof)", addr)
+	srv := &http.Server{Addr: addr}
+	if err := srv.ListenAndServe(); err != nil {
+		log.Errorf("Error starting pprof server: %v", err)
+	}
+}
diff --git a/desktop/lib.go b/desktop/lib.go
@@ -4,16 +4,13 @@ package main
 import (
 	"context"
 	"encoding/json"
-	"net/http"
-	"os"
 	"runtime/debug"
 	"strconv"
 	"strings"
 	"time"
 
 	"github.com/getlantern/appdir"
 	"github.com/getlantern/errors"
-	"github.com/getlantern/flashlight/v7"
 	"github.com/getlantern/flashlight/v7/issue"
 	"github.com/getlantern/flashlight/v7/logging"
 	"github.com/getlantern/flashlight/v7/ops"
@@ -83,24 +80,8 @@ func start() *C.char {
 		})
 	}
 	golog.SetPrepender(logging.Timestamped)
-	flags := flashlight.ParseFlags()
-	if flags.Pprof {
-		addr := "localhost:6060"
-		go func() {
-			log.Debugf("Starting pprof page at http://%s/debug/pprof", addr)
-			srv := &http.Server{
-				Addr: addr,
-			}
-			if err := srv.ListenAndServe(); err != nil {
-				log.Error(err)
-			}
-		}()
-	}
-
-	// i18nInit(a)
-	configDir := configDir(&flags)
 
-	a = app.NewApp(flags, configDir)
+	a = app.NewApp()
 	a.Run(context.Background())
 
 	return C.CString("")
@@ -447,7 +428,7 @@ func reportIssue(email, issueType, description *C.char) *C.char {
 //export checkUpdates
 func checkUpdates() *C.char {
 	log.Debug("Checking for updates")
-	ss := settings.LoadSettings(configDir(nil))
+	ss := settings.LoadSettings("")
 	userID := ss.GetUserID()
 	deviceID := ss.GetDeviceID()
 	op := ops.Begin("check_update").
@@ -464,23 +445,6 @@ func checkUpdates() *C.char {
 	return C.CString(updateURL)
 }
 
-func configDir(flags *flashlight.Flags) string {
-	cdir := appdir.General(common.DefaultAppName)
-	if flags != nil && flags.ConfigDir != "" {
-		cdir = flags.ConfigDir
-	}
-	log.Debugf("Using config dir %v", cdir)
-	if _, err := os.Stat(cdir); err != nil {
-		if os.IsNotExist(err) {
-			// Create config dir
-			if err := os.MkdirAll(cdir, 0750); err != nil {
-				log.Errorf("Unable to create configdir at %s: %s", configDir, err)
-			}
-		}
-	}
-	return cdir
-}
-
 // useOSLocale detect OS locale for current user and let i18n to use it
 func useOSLocale() (string, error) {
 	userLocale, err := jibber_jabber.DetectIETF()
@@ -493,28 +457,6 @@ func useOSLocale() (string, error) {
 	return userLocale, nil
 }
 
-//Do not need to call this function
-// Since localisation is happing on client side
-// func i18nInit(a *app.App) {
-// 	i18n.SetMessagesFunc(func(filename string) ([]byte, error) {
-// 		return a.GetTranslations(filename)
-// 	})
-// 	locale := a.GetLanguage()
-// 	log.Debugf("Using locale: %v", locale)
-// 	if _, err := i18n.SetLocale(locale); err != nil {
-// 		log.Debugf("i18n.SetLocale(%s) failed, fallback to OS default: %q", locale, err)
-
-// 		// On startup GetLanguage will return '' We use the OS locale instead and make sure the language is
-// 		// populated.
-// 		if locale, err := useOSLocale(); err != nil {
-// 			log.Debugf("i18n.UseOSLocale: %q", err)
-// 			a.SetLanguage(defaultLocale)
-// 		} else {
-// 			a.SetLanguage(locale)
-// 		}
-// 	}
-// }
-
 // clearLocalUserData clears the local user data from the settings
 func clearLocalUserData() {
 	setting := a.Settings()

diff --git a/hit_proxy.bash b/hit_proxy.bash
@@ -25,10 +25,5 @@ else
 	echo $OUTPUT > $OUTFILE
 fi
 
-make darwin ffigen
-LANTERN_CONFIGDIR=$TMPDIR \
-LANTERN_STICKYCONFIG=true \
-LANTERN_READABLECONFIG=true \
-LANTERN_PROXYALL=true \
-LANTERN_STARTUP=false \
-flutter run -d macOS
+make macos ffigen
+CONFIG_DIR=$TMPDIR READABLE_CONFIG=true STICKY_CONFIG=true flutter run -d macOS