Merge pull request #2 from brokenCursor/logging

Added basic logging using x/slog

Author: brokenCursor

config/config.go

@@ -0,0 +1,45 @@
+package config
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/viper"
+)
+
+var config *viper.Viper
+
+func init() {
+	// Get config path
+	dir, err := os.UserConfigDir()
+	if err != nil {
+		panic("failed to get user config dir")
+	}
+
+	// Setup configuration
+	config = viper.New()
+	config.SetConfigName("config")
+	config.SetConfigType("yaml")
+
+	sep := string(os.PathSeparator)
+	config.AddConfigPath(dir + sep + "modem-cli")
+
+	// -- Defaults -- //
+	config.SetDefault("modem.model", "dummy")
+	config.SetDefault("modem.host", "127.0.0.1")
+
+	config.SetDefault("logging.general", "error")
+	config.SetDefault("logging.driver", "error")
+
+	config.SetDefault("driver.cmd_ttl", 10)
+	// -- Defaults -- //
+
+	err = config.ReadInConfig()
+	if err != nil { // Handle errors reading the config file
+		panic(fmt.Errorf("fatal error config file: %w", err))
+	}
+}
+
+func Sub(name string) *viper.Viper {
+	return config.Sub(name)
+}

drivers/8810ft.go

@@ -29,11 +29,9 @@ type (
 	}
 )
 
-var httpClient *http.Client
-
 func init() {
-	httpClient = &http.Client{Timeout: time.Second * 30}
 	registerDriver("ZTE 8810FT", newZTE8810FT)
+	// dLogger.Debug("driver registered")
 }
 
 func newZTE8810FT(host string) BaseModem {
@@ -77,6 +75,8 @@ func (m *zte8810ft) ConnectCell() error {
 	u.RawQuery = query.Encode()
 	request := m.getNewRequest("GET", u, http.Header{})
 
+	dLogger.With("driver", "8810FT").Debug("request", request.URL.String(), nil)
+
 	resp, err := httpClient.Do(request)
 
 	// Process errors
@@ -115,6 +115,8 @@ func (m *zte8810ft) DisconnectCell() error {
 	u.RawQuery = query.Encode()
 	request := m.getNewRequest("GET", u, http.Header{})
 
+	dLogger.With("driver", "8810FT").Debug("request", request.URL.String(), nil)
+
 	resp, err := httpClient.Do(request)
 	// Process errors
 	switch {
@@ -144,9 +146,6 @@ func (m *zte8810ft) DisconnectCell() error {
 }
 
 func (m *zte8810ft) GetCellConnStatus() (*LinkStatus, error) {
-	// Lines 251-258
-	// /goform/goform_get_cmd_process?isTest=False&cmd=ppp_connected,multi_data=1&sms_received_flag_flag=0&sts_received_flag_flag=0&_=<curr_time>
-
 	// Build URL
 	u := m.getBaseURL("/goform/goform_get_cmd_process")
 	query := u.Query()
@@ -160,6 +159,8 @@ func (m *zte8810ft) GetCellConnStatus() (*LinkStatus, error) {
 
 	request := m.getNewRequest("GET", u, http.Header{})
 
+	dLogger.With("driver", "8810FT").Debug("request", request.URL.String(), nil)
+
 	resp, err := httpClient.Do(request)
 
 	// Process errors
@@ -185,13 +186,13 @@ func (m *zte8810ft) GetCellConnStatus() (*LinkStatus, error) {
 	// Process the result
 	switch result.Connected {
 	case "ppp_connected":
-		return &LinkStatus{Up: true}, nil
+		return &LinkStatus{State: 3}, nil
 	case "ppp_connecting":
-		return &LinkStatus{Connecting: true}, nil
+		return &LinkStatus{State: 2}, nil
 	case "ppp_disconnecting":
-		return &LinkStatus{Disconnecting: true}, nil
+		return &LinkStatus{State: 1}, nil
 	case "ppp_disconnected":
-		return &LinkStatus{Down: true}, nil
+		return &LinkStatus{State: 0}, nil
 	default:
 		// Unknown link status occurred
 		return nil, ErrUnknown
@@ -238,10 +239,13 @@ func (m *zte8810ft) SendSMS(phone string, message string) error {
 		"Content-Type": {"application/x-www-form-urlencoded", "charset=UTF-8"}})
 
 	// Some Go-level string manipulation
-	stringReader := strings.NewReader(query.Encode())
+	encoded := query.Encode()
+	stringReader := strings.NewReader(encoded)
 	stringReadCloser := io.NopCloser(stringReader)
 	request.Body = stringReadCloser
 
+	dLogger.With("driver", "8810FT").Debug("url", request.URL.String(), "body", encoded, nil)
+
 	resp, err := httpClient.Do(request)
 
 	// Process errors

drivers/common.go

@@ -1,6 +1,14 @@
 package drivers
 
-import "fmt"
+import (
+	"fmt"
+	"log/slog"
+	"net/http"
+	"time"
+
+	"github.com/brokenCursor/usb-modem-cli/config"
+	"github.com/brokenCursor/usb-modem-cli/logging"
+)
 
 // Modem interfaces
 
@@ -35,14 +43,27 @@ type (
 
 	// Link statuses
 	LinkStatus struct {
-		Up            bool
-		Down          bool
-		Connecting    bool
-		Disconnecting bool
+		State int8
 	}
 )
 
-var drivers map[string]func(host string) BaseModem = map[string]func(host string) BaseModem{}
+var (
+	drivers    map[string]func(host string) BaseModem = map[string]func(host string) BaseModem{}
+	httpClient *http.Client
+
+	logger  *slog.Logger
+	dLogger *slog.Logger
+)
+
+func init() {
+	logger = logging.GetGeneralLogger()
+	// TODO: fix per-driver logging while keeping the dependency three sane-ish
+	dLogger = logging.GetDriverLogger("common")
+
+	driverConfig := config.Sub("driver")
+	// logger.Debug("ttl", driverConfig.GetDuration("cmd_ttl")*time.Second)
+	httpClient = &http.Client{Timeout: driverConfig.GetDuration("cmd_ttl") * time.Second}
+}
 
 func isRegistered(name string) bool {
 	// Check if driver has already been registered
@@ -65,6 +86,7 @@ func GetModemDriver(model string, host string) (BaseModem, error) {
 		return nil, ErrUnknownModel
 	}
 
+	logger.Debug("driver instance created", "driver", model, "host", host)
 	return drivers[model](host), nil
 }
 

drivers/dummy.go

@@ -3,28 +3,28 @@ package drivers
 // DO NOT USE DIRECTLY
 type (
 	dummy struct {
-		ip string
+		host string
 	}
 )
 
 func init() {
 	registerDriver("dummy", newDummy)
+	dLogger.With("driver", "dummy").Debug("dummy driver registered")
 }
 
-func newDummy(ip string) BaseModem {
-	// fmt.Println("Dummy driver enabled!")
-	return &dummy{ip: ip}
+func newDummy(host string) BaseModem {
+	return &dummy{host: host}
 }
 
 func (m *dummy) GetModel() string {
 	return "Dummy"
 }
 
 func (m *dummy) SetHost(ip string) error {
-	m.ip = ip
+	m.host = ip
 	return nil
 }
 
 func (m *dummy) GetHost() string {
-	return m.ip
+	return m.host
 }

logging/logging.go

@@ -0,0 +1,69 @@
+package logging
+
+import (
+	"fmt"
+	"log/slog"
+	"os"
+
+	"github.com/brokenCursor/usb-modem-cli/config"
+)
+
+var (
+	general *slog.Logger
+	driver  *slog.Logger
+)
+
+func init() {
+	logConfig := config.Sub("logging")
+	// Setup levels
+	generalLevel, err := strToLevel(logConfig.GetString("general"))
+	if err != nil {
+		slog.Error("logging.general: ", err.Error(), nil)
+	}
+
+	// Setup levels
+	driverLevel, err := strToLevel(logConfig.GetString("driver"))
+	if err != nil {
+		slog.Error("logging.driver: ", err.Error(), nil)
+	}
+
+	// Setup loggers
+	general = slog.New(slog.NewTextHandler(os.Stdout,
+		&slog.HandlerOptions{
+			Level:     generalLevel,
+			AddSource: false,
+		}))
+
+	driver = slog.New(slog.NewTextHandler(os.Stdout,
+		&slog.HandlerOptions{
+			Level:     driverLevel,
+			AddSource: true,
+		}))
+
+	general.Debug("logging setup done")
+}
+
+func strToLevel(level string) (res slog.Level, err error) {
+	switch level {
+	case "debug":
+		res = slog.LevelDebug
+	case "info":
+		res = slog.LevelInfo
+	case "warn":
+		res = slog.LevelWarn
+	case "error":
+		res = slog.LevelError
+	default:
+		return slog.LevelInfo, fmt.Errorf("no %s logging level", level)
+	}
+
+	return res, nil
+}
+
+func GetGeneralLogger() *slog.Logger {
+	return general
+}
+
+func GetDriverLogger(name string) *slog.Logger {
+	return driver
+}

mcli.go

@@ -1,47 +1,27 @@
 package main
 
 import (
-	"fmt"
+	"log/slog"
 	"os"
 
 	"github.com/alexflint/go-arg"
+	"github.com/brokenCursor/usb-modem-cli/config"
 	"github.com/brokenCursor/usb-modem-cli/drivers"
+	"github.com/brokenCursor/usb-modem-cli/logging"
 	"github.com/go-playground/validator/v10"
 	"github.com/i582/cfmt/cmd/cfmt"
-	"github.com/spf13/viper"
 )
 
 var (
 	validate *validator.Validate
 	args     BaseArgs
-	config   *viper.Viper
+	logger   *slog.Logger
 )
 
 func init() {
 	// Create a single instance of validator
 	validate = validator.New(validator.WithRequiredStructEnabled())
-
-	// Get config path
-	dir, err := os.UserConfigDir()
-	if err != nil {
-		panic("failed to get user config dir")
-	}
-
-	// Setup configuration
-	config = viper.New()
-	config.SetConfigName("config")
-	config.SetConfigType("yaml")
-
-	sep := string(os.PathSeparator)
-	config.AddConfigPath(dir + sep + "modem-cli")
-
-	config.SetDefault("modem.model", "dummy")
-	config.SetDefault("modem.host", "127.0.0.1")
-
-	err = config.ReadInConfig()
-	if err != nil { // Handle errors reading the config file
-		panic(fmt.Errorf("fatal error config file: %w", err))
-	}
+	logger = logging.GetGeneralLogger()
 }
 
 func main() {
@@ -65,11 +45,13 @@ func run() error {
 	}
 
 	if args.DisableColor {
+		logger.Debug("Colored output disabled")
 		cfmt.DisableColors()
 	}
 
 	// If IP has been overridden
 	if len(args.Host) > 0 {
+		logger.Debug("IP has been overridden")
 		ip = args.Host
 	}
 
@@ -93,32 +75,29 @@ func run() error {
 		switch args.Connection.Action {
 		case "up":
 			err := cell.ConnectCell()
-
 			if err != nil {
 				return err
 			}
 		case "down":
 			err := cell.DisconnectCell()
-
 			if err != nil {
 				return err
 			}
 		case "status":
 			status, err := cell.GetCellConnStatus()
-
 			if err != nil {
 				return err
 			}
 
 			// Process and output status
-			switch {
-			case status.Up:
+			switch status.State {
+			case 3:
 				cfmt.Println("Status: {{up}}::green|bold")
-			case status.Down:
+			case 0:
 				cfmt.Println("Status: {{down}}::red|bold")
-			case status.Connecting:
+			case 2:
 				cfmt.Println("Status: {{connecting}}::yellow|bold")
-			case status.Disconnecting:
+			case 1:
 				cfmt.Println("Status: {{disconnecting}}::#FA8100|bold")
 			}
 		}