ref: refactoring cli log system

Author: mirkoCrobu

cmd/arduino-app-cli/app/start.go

@@ -46,6 +46,8 @@ func startHandler(ctx context.Context, app app.ArduinoApp) error {
 		switch message.GetType() {
 		case orchestrator.ProgressType:
 			feedback.Progress(message.GetProgress().Progress)
+		case orchestrator.MinimalType:
+			feedback.Minimal(message.GetData())
 		case orchestrator.InfoType:
 			feedback.Info(message.GetData())
 		case orchestrator.DebugType:

cmd/arduino-app-cli/main.go

@@ -2,9 +2,7 @@ package main
 
 import (
 	"context"
-	"fmt"
 	"log/slog"
-	"strings"
 
 	"github.com/spf13/cobra"
 	"go.bug.st/cleanup"
@@ -26,7 +24,8 @@ import (
 // Version will be set a build time with -ldflags
 var Version string = "0.0.0-dev"
 var format string
-var logLevel string
+var quiet bool
+var verbose int
 
 func run() error {
 	defer func() { _ = servicelocator.CloseDockerClient() }()
@@ -36,27 +35,38 @@ func run() error {
 		Short: "A CLI to manage the Python app",
 		PersistentPreRun: func(cmd *cobra.Command, args []string) {
 
-			level, ok := feedback.ParseLogLevel(logLevel)
-			if !ok {
-				feedback.Fatal(i18n.Tr("Invalid log level : %s", logLevel), feedback.ErrBadArgument)
+			if quiet {
+				feedback.SetLogLevel(feedback.LogLevelQuiet)
+				slog.SetLogLoggerLevel(slog.LevelError)
+			} else {
+				switch verbose {
+				case 0:
+					feedback.SetLogLevel(feedback.LogLevelMinimal)
+					slog.SetLogLoggerLevel(slog.LevelInfo)
+				case 1:
+					feedback.SetLogLevel(feedback.LogLevelInfo)
+					slog.SetLogLoggerLevel(slog.LevelInfo)
+				default:
+					feedback.SetLogLevel(feedback.LogLevelDebug)
+					slog.SetLogLoggerLevel(slog.LevelDebug)
+				}
 			}
-			feedback.SetLogLevel(level)
 
 			format, ok := feedback.ParseOutputFormat(format)
 			if !ok {
 				feedback.Fatal(i18n.Tr("Invalid output format: %s", format), feedback.ErrBadArgument)
 			}
 			feedback.SetFormat(format)
 
-			ConfigureSLogger(logLevel)
-
 		},
 		SilenceUsage:  true,
 		SilenceErrors: true,
 	}
 
 	rootCmd.PersistentFlags().StringVar(&format, "format", "text", "Output format (text, json)")
-	rootCmd.PersistentFlags().StringVar(&logLevel, "log-level", "info", "Set log level (quiet, info, debug/verbose)")
+	rootCmd.PersistentFlags().BoolVarP(&quiet, "quiet", "q", false, "Suppress all logs")
+	rootCmd.PersistentFlags().CountVarP(&verbose, "verbose", "v", "Enable verbose logging (-v for info, -vv for debug)")
+	rootCmd.MarkFlagsMutuallyExclusive("quiet", "verbose")
 
 	rootCmd.AddCommand(
 		app.NewAppCmd(),
@@ -84,26 +94,3 @@ func main() {
 		feedback.FatalError(err, 1)
 	}
 }
-
-func ParseLogLevel(level string) (slog.Level, error) {
-	var l slog.Level
-	err := l.UnmarshalText([]byte(level))
-	if err != nil {
-		return 0, fmt.Errorf("invalid log level: %w", err)
-	}
-	return l, nil
-}
-
-func ConfigureSLogger(levelStr string) {
-	var slogLevel slog.Level
-
-	switch strings.ToLower(levelStr) {
-	case "quiet":
-		slogLevel = slog.LevelError
-	case "debug", "verbose":
-		slogLevel = slog.LevelDebug
-	default:
-		slogLevel = slog.LevelInfo
-	}
-	slog.SetLogLoggerLevel(slogLevel)
-}

cmd/feedback/feedback.go

@@ -235,11 +235,12 @@ type LogLevel int
 
 const (
 	LogLevelQuiet LogLevel = iota
+	LogLevelMinimal
 	LogLevelInfo
 	LogLevelDebug
 )
 
-var logLevel LogLevel = LogLevelInfo
+var logLevel LogLevel = LogLevelMinimal
 
 func SetLogLevel(level LogLevel) {
 	logLevel = level
@@ -249,33 +250,42 @@ func ParseLogLevel(levelStr string) (LogLevel, bool) {
 	switch strings.ToLower(levelStr) {
 	case "quiet":
 		return LogLevelQuiet, true
+	case "minimal":
+		return LogLevelMinimal, true
 	case "info":
 		return LogLevelInfo, true
 	case "debug", "verbose":
 		return LogLevelDebug, true
 	}
-	return LogLevelInfo, false
+	return LogLevelMinimal, false
+}
+
+func Minimal(message string) {
+	if logLevel < LogLevelMinimal {
+		return
+	}
+	printLogMessage("step", message)
 }
 
 func Info(message string) {
 	if logLevel < LogLevelInfo {
 		return
 	}
-	printLogMessage("[INFO]", message)
+	printLogMessage("info", message)
 }
 
 func Debug(message string) {
 	if logLevel < LogLevelDebug {
 		return
 	}
-	printLogMessage("[DEBUG]", message)
+	printLogMessage("debug", message)
 }
 
 func Warning(message string) {
 	if logLevel < LogLevelInfo {
 		return
 	}
-	printLogMessage("[WARNING]", message)
+	printLogMessage("warning", message)
 }
 
 func printLogMessage(level string, message string) {
@@ -288,7 +298,7 @@ func printLogMessage(level string, message string) {
 		output, _ := json.Marshal(logMsg{Level: level, Message: message})
 		fmt.Fprintln(feedbackOut, string(output))
 	default: // Text
-		fmt.Fprintf(feedbackErr, "%s %s\n", level, message)
+		fmt.Fprintf(feedbackErr, "%s %s\n", "["+strings.ToUpper(level)+"]", message)
 	}
 }
 

internal/orchestrator/orchestrator.go

@@ -66,6 +66,7 @@ type MessageType string
 const (
 	UnknownType  MessageType = ""
 	ProgressType MessageType = "progress"
+	MinimalType  MessageType = "minimal"
 	InfoType     MessageType = "info"
 	DebugType    MessageType = "debug"
 	WarningType  MessageType = "warning"
@@ -84,6 +85,7 @@ type Progress struct {
 	Progress float32
 }
 
+func (p *StreamMessage) IsMinimal() bool        { return p.Type == MinimalType }
 func (p *StreamMessage) IsInfo() bool           { return p.Type == InfoType }
 func (p *StreamMessage) IsDebug() bool          { return p.Type == DebugType }
 func (p *StreamMessage) IsWarning() bool        { return p.Type == WarningType }
@@ -101,7 +103,7 @@ func StartApp(ctx context.Context, docker *dockerClient.Client, provisioner *Pro
 		ctx, cancel := context.WithCancel(ctx)
 		defer cancel()
 
-		if !yield(StreamMessage{Type: DebugType, data: "Checking for already running apps..."}) {
+		if !yield(StreamMessage{Type: MinimalType, data: "Checking for already running apps..."}) {
 			cancel()
 			return
 		}
@@ -124,7 +126,7 @@ func StartApp(ctx context.Context, docker *dockerClient.Client, provisioner *Pro
 		})
 
 		if app.MainSketchPath != nil {
-			if !yield(StreamMessage{Type: InfoType, data: "Compiling and updating sketch..."}) {
+			if !yield(StreamMessage{Type: MinimalType, data: "Compiling and updating sketch..."}) {
 				cancel()
 				return
 			}
@@ -134,7 +136,7 @@ func StartApp(ctx context.Context, docker *dockerClient.Client, provisioner *Pro
 			}
 		}
 		if app.MainPythonFile != nil {
-			if !yield(StreamMessage{Type: InfoType, data: "Provisioning app..."}) {
+			if !yield(StreamMessage{Type: MinimalType, data: "Provisioning app..."}) {
 				cancel()
 				return
 			}
@@ -143,7 +145,7 @@ func StartApp(ctx context.Context, docker *dockerClient.Client, provisioner *Pro
 				return
 			}
 
-			if !yield(StreamMessage{Type: InfoType, data: "Starting app..."}) {
+			if !yield(StreamMessage{Type: MinimalType, data: "Starting app..."}) {
 				cancel()
 				return
 			}
@@ -216,7 +218,7 @@ func StopApp(ctx context.Context, app app.ArduinoApp) iter.Seq[StreamMessage] {
 		}
 
 		if app.MainPythonFile != nil {
-			if !yield(StreamMessage{Type: InfoType, data: "stopping the app..."}) {
+			if !yield(StreamMessage{Type: MinimalType, data: "stopping the app..."}) {
 				cancel()
 				return
 			}
@@ -244,7 +246,7 @@ func StopApp(ctx context.Context, app app.ArduinoApp) iter.Seq[StreamMessage] {
 					yield(StreamMessage{Type: ErrorType, error: err})
 					return
 				}
-			} else if !yield(StreamMessage{Type: InfoType, data: "App not running, nothing to stop."}) {
+			} else if !yield(StreamMessage{Type: MinimalType, data: "App not running, nothing to stop."}) {
 				return
 			}
 		}