telemetry: track command errors

- command errors are now properly tracked - fixed tracking of user-interruped commands - this change required refactoring CLI commands to return errors instead of throwing fatal errors Signed-off-by: Toma Puljak <[email protected]>
daytonaio · Sep 26, 2024 · cbdee81 · cbdee81
1 parent cfe1803
commit cbdee81
Show file tree

Hide file tree

Showing 80 changed files with 801 additions and 736 deletions.
diff --git a/pkg/cmd/agent/agent.go b/pkg/cmd/agent/agent.go
@@ -26,7 +26,7 @@ var AgentCmd = &cobra.Command{
 	Use:   "agent",
 	Short: "Start the agent process",
 	Args:  cobra.NoArgs,
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
 		setLogLevel()
 
 		agentMode := config.ModeProject
@@ -37,7 +37,7 @@ var AgentCmd = &cobra.Command{
 
 		c, err := config.GetConfig(agentMode)
 		if err != nil {
-			log.Fatal(err)
+			return err
 		}
 		c.ProjectDir = filepath.Join(os.Getenv("HOME"), c.ProjectName)
 
@@ -50,7 +50,7 @@ var AgentCmd = &cobra.Command{
 		if c.LogFilePath != nil {
 			logFile, err := os.OpenFile(*c.LogFilePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
 			if err != nil {
-				log.Fatal(err)
+				return err
 			}
 			defer logFile.Close()
 			gitLogWriter = io.MultiWriter(os.Stdout, logFile)
@@ -91,10 +91,7 @@ var AgentCmd = &cobra.Command{
 			TelemetryEnabled: telemetryEnabled,
 		}
 
-		err = agent.Start()
-		if err != nil {
-			log.Fatal(err)
-		}
+		return agent.Start()
 	},
 }
 

diff --git a/pkg/cmd/agent/logs.go b/pkg/cmd/agent/logs.go
@@ -5,13 +5,13 @@ package agent
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"io"
 	"os"
 
 	"github.com/daytonaio/daytona/internal/util"
 	"github.com/daytonaio/daytona/pkg/agent/config"
-	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -20,16 +20,16 @@ var followFlag bool
 var logsCmd = &cobra.Command{
 	Use:   "logs",
 	Short: "Output Daytona Agent logs",
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
 		logFilePath := config.GetLogFilePath()
 
 		if logFilePath == nil {
-			log.Fatal("Log file path not set")
+			return errors.New("log file path not set")
 		}
 
 		file, err := os.Open(*logFilePath)
 		if err != nil {
-			log.Fatal(err)
+			return err
 		}
 		defer file.Close()
 
@@ -41,13 +41,13 @@ var logsCmd = &cobra.Command{
 		for {
 			select {
 			case <-context.Background().Done():
-				return
+				return nil
 			case err := <-errChan:
 				if err != nil {
 					if err != io.EOF {
-						log.Fatal(err)
+						return err
 					}
-					return
+					return nil
 				}
 			case msg := <-msgChan:
 				fmt.Println(string(msg))

diff --git a/pkg/cmd/apikey/generate.go b/pkg/cmd/apikey/generate.go
@@ -5,8 +5,8 @@ package apikey
 
 import (
 	"context"
+	"errors"
 
-	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 
 	"github.com/daytonaio/daytona/internal/util"
@@ -21,18 +21,18 @@ var GenerateCmd = &cobra.Command{
 	Short:   "Generate a new API key",
 	Aliases: []string{"g", "new"},
 	Args:    cobra.RangeArgs(0, 1),
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
 		ctx := context.Background()
 		var keyName string
 
 		apiClient, err := apiclient_util.GetApiClient(nil)
 		if err != nil {
-			log.Fatal(err)
+			return err
 		}
 
 		apiKeyList, _, err := apiClient.ApiKeyAPI.ListClientApiKeys(ctx).Execute()
 		if err != nil {
-			log.Fatal(apiclient_util.HandleErrorResponse(nil, err))
+			return apiclient_util.HandleErrorResponse(nil, err)
 		}
 
 		if len(args) == 1 {
@@ -43,26 +43,27 @@ var GenerateCmd = &cobra.Command{
 
 		for _, key := range apiKeyList {
 			if key.Name == keyName {
-				log.Fatal("key name already exists, please choose a different one")
+				return errors.New("key name already exists, please choose a different one")
 			}
 		}
 
 		key, _, err := apiClient.ApiKeyAPI.GenerateApiKey(ctx, keyName).Execute()
 		if err != nil {
-			log.Fatal(apiclient_util.HandleErrorResponse(nil, err))
+			return apiclient_util.HandleErrorResponse(nil, err)
 		}
 
 		serverConfig, _, err := apiClient.ServerAPI.GetConfigExecute(apiclient.ApiGetConfigRequest{})
 		if err != nil {
-			log.Fatal(err)
+			return err
 		}
 
 		if serverConfig.Frps == nil {
-			log.Fatal("frps config is missing")
+			return errors.New("frps config is missing")
 		}
 
 		apiUrl := util.GetFrpcApiUrl(serverConfig.Frps.Protocol, serverConfig.Id, serverConfig.Frps.Domain)
 
 		view.Render(key, apiUrl)
+		return nil
 	},
 }
diff --git a/pkg/cmd/apikey/list.go b/pkg/cmd/apikey/list.go
@@ -9,34 +9,34 @@ import (
 	"github.com/daytonaio/daytona/internal/util/apiclient"
 	"github.com/daytonaio/daytona/pkg/cmd/format"
 	"github.com/daytonaio/daytona/pkg/views/server/apikey"
-	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
 var listCmd = &cobra.Command{
 	Use:     "list",
 	Short:   "List API keys",
 	Aliases: []string{"ls"},
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
 		ctx := context.Background()
 
 		apiClient, err := apiclient.GetApiClient(nil)
 		if err != nil {
-			log.Fatal(err)
+			return err
 		}
 
-		apiKeyList, _, err := apiClient.ApiKeyAPI.ListClientApiKeys(ctx).Execute()
+		apiKeyList, res, err := apiClient.ApiKeyAPI.ListClientApiKeys(ctx).Execute()
 		if err != nil {
-			log.Fatal(apiclient.HandleErrorResponse(nil, err))
+			return apiclient.HandleErrorResponse(res, err)
 		}
 
 		if format.FormatFlag != "" {
 			formattedData := format.NewFormatter(apiKeyList)
 			formattedData.Print()
-			return
+			return nil
 		}
 
 		apikey.ListApiKeys(apiKeyList)
+		return nil
 	},
 }
 

diff --git a/pkg/cmd/apikey/revoke.go b/pkg/cmd/apikey/revoke.go
@@ -5,10 +5,10 @@ package apikey
 
 import (
 	"context"
+	"errors"
 	"fmt"
 
 	"github.com/charmbracelet/huh"
-	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 
 	"github.com/daytonaio/daytona/cmd/daytona/config"
@@ -27,29 +27,29 @@ var revokeCmd = &cobra.Command{
 	Short:   "Revoke an API key",
 	Aliases: []string{"r", "rm", "delete"},
 	Args:    cobra.RangeArgs(0, 1),
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
 		ctx := context.Background()
 
 		c, err := config.GetConfig()
 		if err != nil {
-			log.Fatal(err)
+			return err
 		}
 
 		activeProfile, err := c.GetActiveProfile()
 		if err != nil {
-			log.Fatal(err)
+			return err
 		}
 
 		apiClient, err := apiclient_util.GetApiClient(nil)
 		if err != nil {
-			log.Fatal(err)
+			return err
 		}
 
 		var selectedApiKey *apiclient.ApiKey
 
 		apiKeyList, _, err := apiClient.ApiKeyAPI.ListClientApiKeys(ctx).Execute()
 		if err != nil {
-			log.Fatal(apiclient_util.HandleErrorResponse(nil, err))
+			return apiclient_util.HandleErrorResponse(nil, err)
 		}
 
 		if len(args) == 1 {
@@ -63,15 +63,15 @@ var revokeCmd = &cobra.Command{
 			selectedApiKey, err = apikey.GetApiKeyFromPrompt(apiKeyList, "Select an API key to revoke", false)
 			if err != nil {
 				if common.IsCtrlCAbort(err) {
-					return
+					return nil
 				} else {
-					log.Fatal(err)
+					return err
 				}
 			}
 		}
 
 		if selectedApiKey == nil {
-			log.Fatal("No API key selected")
+			return errors.New("No API key selected")
 		}
 
 		if !yesFlag {
@@ -93,20 +93,22 @@ var revokeCmd = &cobra.Command{
 
 			err := form.Run()
 			if err != nil {
-				log.Fatal(err)
+				return err
 			}
 		}
 
 		if yesFlag {
-			_, err = apiClient.ApiKeyAPI.RevokeApiKey(ctx, selectedApiKey.Name).Execute()
+			res, err := apiClient.ApiKeyAPI.RevokeApiKey(ctx, selectedApiKey.Name).Execute()
 			if err != nil {
-				log.Fatal(apiclient_util.HandleErrorResponse(nil, err))
+				return apiclient_util.HandleErrorResponse(res, err)
 			}
 
 			views.RenderInfoMessage("API key revoked")
 		} else {
 			fmt.Println("Operation canceled.")
 		}
+
+		return nil
 	},
 }
 

diff --git a/pkg/cmd/autocomplete.go b/pkg/cmd/autocomplete.go
@@ -16,12 +16,11 @@ var AutoCompleteCmd = &cobra.Command{
 	Use:   "autocomplete [bash|zsh|fish|powershell]",
 	Short: "Adds completion script for your shell enviornment",
 	Args:  cobra.ExactArgs(1),
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
 		shell := args[0]
 		homeDir, err := os.UserHomeDir()
 		if err != nil {
-			fmt.Printf("Error finding user home directory: %s\n", err)
-			return
+			return fmt.Errorf("Error finding user home directory: %s\n", err)
 		}
 
 		var filePath, profilePath string
@@ -39,14 +38,12 @@ var AutoCompleteCmd = &cobra.Command{
 			filePath = filepath.Join(homeDir, "daytona.completion_script.ps1")
 			profilePath = filepath.Join(homeDir, "Documents", "WindowsPowerShell", "Microsoft.PowerShell_profile.ps1")
 		default:
-			fmt.Println("Unsupported shell type. Please use bash, zsh, fish, or powershell.")
-			return
+			return fmt.Errorf("Unsupported shell type. Please use bash, zsh, fish, or powershell.")
 		}
 
 		file, err := os.Create(filePath)
 		if err != nil {
-			fmt.Printf("Error creating completion script file: %s\n", err)
-			return
+			return fmt.Errorf("Error creating completion script file: %s\n", err)
 		}
 		defer file.Close()
 
@@ -62,8 +59,7 @@ var AutoCompleteCmd = &cobra.Command{
 		}
 
 		if err != nil {
-			fmt.Printf("Error generating completion script: %s\n", err)
-			return
+			return fmt.Errorf("Error generating completion script: %s\n", err)
 		}
 
 		sourceCommand := fmt.Sprintf("\nsource %s\n", filePath)
@@ -87,19 +83,19 @@ var AutoCompleteCmd = &cobra.Command{
 			// Append the source command to the shell's profile file if not present
 			profile, err := os.OpenFile(profilePath, os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0644)
 			if err != nil {
-				fmt.Printf("Error opening profile file (%s): %s\n", profilePath, err)
-				return
+				return fmt.Errorf("Error opening profile file (%s): %s\n", profilePath, err)
 			}
 			defer profile.Close()
 
 			if _, err := profile.WriteString(sourceCommand); err != nil {
-				fmt.Printf("Error writing to profile file (%s): %s\n", profilePath, err)
-				return
+				return fmt.Errorf("Error writing to profile file (%s): %s\n", profilePath, err)
 			}
 		}
 
 		fmt.Println("Autocomplete script generated and injected successfully.")
 		fmt.Printf("Please source your %s profile to apply the changes or restart your terminal.\n", shell)
 		fmt.Printf("For manual sourcing, use: source %s\n", profilePath)
+
+		return nil
 	},
 }