Added normalization completed to all the config values and adjusted logger initilization in main.go

Author: PythonHacker24

cmd/laclm/main.go

@@ -28,12 +28,6 @@ func exec() error {
 
 	/* exec() wraps run() protecting it with user interrupts  */
 
-	utils.InitLogger(true)
-
-	/* zap.L() can be used all over the code for global level logging */
-
-	zap.L().Info("Logger Initiated ...")
-	
 	/* setting up cobra for cli interactions */
 	var(
 		configPath string
@@ -59,9 +53,7 @@ func exec() error {
 
 	/* Execute the command */
 	if err := rootCmd.Execute(); err != nil {
-		zap.L().Error("arguements error",
-			zap.Error(err),
-		)
+		fmt.Printf("arguements error: %s", err.Error())
 		os.Exit(1)
 	}
 
@@ -76,8 +68,16 @@ func exec() error {
 		if there is an error or environment variables are not set, then it will exit with code 1
 	*/
 	config.LoadEnv()
+	
+	/* 
+		true for production, false for development mode 
+		logger is only for http server and core components (after this step)
+		using logger for cli issues doesn't make sense
+	*/
+	utils.InitLogger(!config.BackendConfig.AppInfo.DebugMode)
 
-	/* true for production, false for development mode */
+	/* zap.L() can be used all over the code for global level logging */
+	zap.L().Info("Logger Initiated ...")
 
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()

config.yaml

@@ -4,7 +4,7 @@
 app:
   name: laclm-dev
   version: v1.1
-  environment: development
+  debug_mode: development
 
 # backend server deployment configs
 server:

config/app.go

@@ -2,7 +2,25 @@ package config
 
 /* app parameters */
 type App struct {
-Name        string `yaml:"name"`
-Version     string `yaml:"version"`
-Environment string `yaml:"environment"`
+	Name        string `yaml:"name"`
+	Version     string `yaml:"version"`
+	DebugMode   bool   `yaml:"debug_mode"`
+}
+
+/* normalization function */
+func (a *App) Normalize() error {
+	if a.Name == "" {
+		a.Name = "laclm"
+	}
+
+	if a.Version == "" {
+		a.Name = "v1.1"
+	}
+
+	/* 
+		if debug_mode is not provided, it's false 
+		we want production to be true
+	*/
+
+	return nil 
 }

config/backend_security.go

@@ -4,3 +4,12 @@ package config
 type BackendSecurity struct {
 	JWTExpiry int `yaml:"jwt_expiry"`
 }
+
+/* normalization function */
+func (b *BackendSecurity) Normalize() error {
+	if b.JWTExpiry == 0 {
+		b.JWTExpiry = 1
+	}
+
+	return nil
+}

config/config.go

@@ -1,5 +1,7 @@
 package config
 
+import "fmt"
+
 /* globally accessible yaml config */
 var BackendConfig Config
 
@@ -20,3 +22,34 @@ type Config struct {
 type EnvironmentConfig struct {
 	JWTSecret string
 }
+
+/* complete config normalizer function */
+func (c *Config) Normalize() error {
+	if err := c.AppInfo.Normalize(); err != nil {
+		return fmt.Errorf("app configuration error: %w", err)	
+	}
+
+	if err := c.Server.Normalize(); err != nil {
+		return fmt.Errorf("server configuration error: %w", err)
+	}
+
+	if err := c.Database.Normalize(); err != nil {
+		return fmt.Errorf("database configuration error: %w", err)
+	}
+
+	if err := c.Logging.Normalize(); err != nil {
+		return fmt.Errorf("logging configuration error: %w", err)
+	}
+
+	for i := range c.FileSystemServers {
+		if err := c.FileSystemServers[i].Normalize(); err != nil {
+			return fmt.Errorf("file system server [%d] error: %w", i, err)
+		}	
+	}
+
+	if err := c.BackendSecurity.Normalize(); err != nil {
+		return fmt.Errorf("backend security configuration error: %w", err) 
+	}
+
+	return nil
+}

config/database.go

@@ -1,5 +1,11 @@
 package config
 
+import (
+	"errors"
+
+	"github.com/MakeNowJust/heredoc"
+)
+
 /* database parameters */
 type Database struct {
 	TransactionLogRedis TransactionLogRedis `yaml:"transaction_log_redis"`
@@ -11,3 +17,24 @@ type TransactionLogRedis struct {
 	Password string `yaml:"password"`
 	DB       string `yaml:"db"`
 }
+
+/* normalization function */
+func (d *Database) Normalize() error {
+	return d.TransactionLogRedis.Normalize()
+}
+
+func (r *TransactionLogRedis) Normalize() error {
+	if r.Address == "" {
+		return errors.New(heredoc.Doc(`
+			Transaction Log Redis Address is not specified in the configuration file. 
+
+			Please check the docs for more information: 
+		`))
+	}
+
+	if r.DB == "" {
+		r.DB = "0"
+	}
+
+	return nil
+}

config/filesystem.go

@@ -1,14 +1,61 @@
 package config
 
+import (
+	"errors"
+
+	"github.com/MakeNowJust/heredoc"
+)
+
 /* file system server parameters */
 type FileSystemServers struct {
-	Remote *Remote `yaml:"remote,omitempty"`
 	Path   string  `yaml:"path"`
 	Method string  `yaml:"method"`
+	Remote *Remote `yaml:"remote,omitempty"`
 }
 
 /* remote parameters for file system server with laclm daemons installed */
 type Remote struct {
 	Host string `yaml:"host"`
 	Port int    `yaml:"port"`
 }
+
+/* normalization function */
+func (f *FileSystemServers) Normalize() error {
+	if f.Path == "" {
+		return errors.New(heredoc.Doc(`
+			Remote server file path not specified in the configuration file. 
+
+			Please check the docs for more information: 
+		`))	
+	}
+
+	if f.Method == "" {
+		f.Method = "local"
+	}
+	
+	if f.Method == "remote" {
+		if f.Remote == nil {
+			return errors.New(heredoc.Doc(`
+			
+			`))
+		}
+		
+		if f.Remote.Host == "" {
+			return errors.New(heredoc.Doc(`
+				Address not provided for remote file server
+				
+				Please check the docs for more information: 
+			`))
+		} 
+
+		if f.Remote.Port == 0 {
+			return errors.New(heredoc.Doc(`
+				Port not provided for remote file server 	
+
+				Please check the docs for more information: 
+			`))
+		}
+	}
+
+	return nil
+}

config/loader.go

@@ -31,6 +31,8 @@ func LoadConfig(path string) {
 			zap.Error(err),
 		)
     }
+	
+	BackendConfig.Normalize()
 }
 
 /* loads environment variables */

config/logging.go

@@ -8,3 +8,22 @@ type Logging struct {
 	MaxAge     int    `yaml:"max_age"`
 	Compress   bool   `yaml:"compress"`
 }
+
+/* normalization function */
+func (l *Logging) Normalize() error {
+	if l.File == "" {
+		l.File = "log/app.log"
+	}
+
+	if l.MaxSize == 0 {
+		l.MaxSize = 100
+	}
+
+	if l.MaxBackups == 0 {
+		l.MaxBackups = 3
+	}
+	
+	/* let compression remain false by default */
+
+	return nil
+}

config/server.go

@@ -5,3 +5,16 @@ type Server struct {
 	Host string `yaml:"host"`
 	Port int    `yaml:"port"`
 }
+
+/* normalization function */
+func (s *Server) Normalize() error {
+	if s.Host == "" {
+		s.Host = "localhost"
+	}
+
+	if s.Port == 0 {
+		s.Port = 8080
+	}
+
+	return nil
+}