fix(lk): fail early if config file is present and invalid (#570)

Author: rektdeckard

cmd/lk/agent.go

@@ -254,9 +254,9 @@ func createAgentClient(ctx context.Context, cmd *cli.Command) (context.Context,
 	}
 
 	// Verify that the project and agent config match, if it exists.
-	lkConfig, configExists, err := config.LoadTomlFile(workingDir, tomlFilename)
+	lkConfig, configExists, err := config.LoadTOMLFile(workingDir, tomlFilename)
 	if err != nil {
-		fmt.Println(err.Error())
+		return nil, err
 	}
 	if configExists {
 		projectSubdomainMatch := subdomainPattern.FindStringSubmatch(project.URL)
@@ -300,7 +300,7 @@ func createAgent(ctx context.Context, cmd *cli.Command) error {
 	}
 
 	logger.Debugw("Creating agent", "working-dir", workingDir)
-	lkConfig, configExists, err := config.LoadTomlFile(workingDir, tomlFilename)
+	lkConfig, configExists, err := config.LoadTOMLFile(workingDir, tomlFilename)
 	if err != nil && configExists {
 		return err
 	}
@@ -500,8 +500,8 @@ func createAgentConfig(ctx context.Context, cmd *cli.Command) error {
 }
 
 func deployAgent(ctx context.Context, cmd *cli.Command) error {
-	lkConfig, configExists, err := config.LoadTomlFile(workingDir, tomlFilename)
-	if err != nil && configExists {
+	lkConfig, configExists, err := config.LoadTOMLFile(workingDir, tomlFilename)
+	if err != nil {
 		return err
 	}
 	if !configExists {
@@ -616,7 +616,7 @@ func getAgentStatus(ctx context.Context, cmd *cli.Command) error {
 }
 
 func updateAgent(ctx context.Context, cmd *cli.Command) error {
-	lkConfig, configExists, err := config.LoadTomlFile(workingDir, tomlFilename)
+	lkConfig, configExists, err := config.LoadTOMLFile(workingDir, tomlFilename)
 	if err != nil && configExists {
 		return err
 	}
@@ -901,7 +901,7 @@ func updateAgentSecrets(ctx context.Context, cmd *cli.Command) error {
 func getAgentName(cmd *cli.Command, agentDir string, tomlFileName string) (string, error) {
 	agentName := cmd.String("name")
 	if agentName == "" {
-		lkConfig, configExists, err := config.LoadTomlFile(agentDir, tomlFileName)
+		lkConfig, configExists, err := config.LoadTOMLFile(agentDir, tomlFileName)
 		if err != nil && configExists {
 			return "", err
 		}

cmd/lk/app.go

@@ -147,6 +147,9 @@ func requireProject(ctx context.Context, cmd *cli.Command) (context.Context, err
 		return ctx, nil
 	}
 	if project, err = loadProjectDetails(cmd); err != nil {
+		if errors.Is(err, config.ErrInvalidConfig) {
+			return ctx, err
+		}
 		if _, err = loadProjectConfig(ctx, cmd); err != nil {
 			// something is wrong with config file
 			return nil, err

cmd/lk/utils.go

@@ -253,7 +253,10 @@ func loadProjectDetails(c *cli.Command, opts ...loadOption) (*config.ProjectConf
 	}
 
 	// load from config file
-	lkConfig, _, _ := config.LoadTomlFile(workingDir, tomlFilename)
+	lkConfig, _, err := config.LoadTOMLFile(workingDir, tomlFilename)
+	if errors.Is(err, config.ErrInvalidConfig) {
+		return nil, err
+	}
 	if lkConfig != nil {
 		return config.LoadProjectBySubdomain(lkConfig.Project.Subdomain)
 	}

pkg/agentfs/secrets-file.go

@@ -79,7 +79,7 @@ func DetectEnvFile(maybeFile string) (string, map[string]string, error) {
 		return "", nil, nil
 	}
 
-	var selectedFile string
+	var selectedFile string = extantEnvFiles[0]
 	if err := huh.NewForm(
 		huh.NewGroup(
 			huh.NewSelect[string]().

pkg/config/livekit.go

@@ -17,6 +17,7 @@ package config
 import (
 	"errors"
 	"fmt"
+	"io/fs"
 	"os"
 	"path/filepath"
 
@@ -32,15 +33,19 @@ const (
 	clientDefaults_MaxReplicas = 10
 )
 
+var (
+	ErrInvalidConfig       = errors.New("invalid configuration file")
+	ErrInvalidReplicaCount = fmt.Errorf("replicas cannot be greater than max_replicas: %w", ErrInvalidConfig)
+)
+
 // Deprecated: use LiveKitTOML instead
 type AgentTOML struct {
 	ProjectSubdomain string    `toml:"project_subdomain"`
 	Name             string    `toml:"name"`
 	CPU              CPUString `toml:"cpu"`
 	Replicas         int       `toml:"replicas"`
 	MaxReplicas      int       `toml:"max_replicas"`
-
-	Regions []string `toml:"regions"`
+	Regions          []string  `toml:"regions"`
 }
 
 type LiveKitTOML struct {
@@ -57,6 +62,7 @@ type LiveKitTOMLAgentConfig struct {
 	CPU         CPUString `toml:"cpu"`
 	Replicas    int       `toml:"replicas"`
 	MaxReplicas int       `toml:"max_replicas"`
+	Regions     []string  `toml:"regions"`
 }
 
 func NewLiveKitTOML(forSubdomain string) *LiveKitTOML {
@@ -97,15 +103,17 @@ func (c *CPUString) UnmarshalTOML(v interface{}) error {
 	return nil
 }
 
-func LoadTomlFile(dir string, tomlFileName string) (*LiveKitTOML, bool, error) {
+func LoadTOMLFile(dir string, tomlFileName string) (*LiveKitTOML, bool, error) {
 	logger.Debugw(fmt.Sprintf("loading %s file", tomlFileName))
-	var config LiveKitTOML
+	var config *LiveKitTOML = nil
 	var err error
-	var configExists bool = true
+	var configExists bool = false
 
 	tomlFile := filepath.Join(dir, tomlFileName)
 
 	if _, err = os.Stat(tomlFile); err == nil {
+		configExists = true
+
 		_, err = toml.DecodeFile(tomlFile, &config)
 		if config.Project == nil {
 			// Attempt to decode old agent config
@@ -125,17 +133,15 @@ func LoadTomlFile(dir string, tomlFileName string) (*LiveKitTOML, bool, error) {
 			}
 		}
 	} else {
-		if errors.Is(err, os.ErrNotExist) {
-			configExists = false
-		}
+		configExists = !errors.Is(err, fs.ErrNotExist)
 	}
 
 	if configExists {
 		// validate agent config
 		if config.HasAgent() && config.Agent.Replicas > config.Agent.MaxReplicas {
-			return nil, configExists, fmt.Errorf("replicas cannot be greater than max_replicas")
+			return nil, configExists, ErrInvalidReplicaCount
 		}
 	}
 
-	return &config, configExists, err
+	return config, configExists, err
 }