feat: integrate zerolog for enhanced logging across multiple components

cmd/cbzoptimizer/commands/optimize_command.go

@@ -2,15 +2,17 @@ package commands
 
 import (
 	"fmt"
-	utils2 "github.com/belphemur/CBZOptimizer/v2/internal/utils"
-	"github.com/belphemur/CBZOptimizer/v2/pkg/converter"
-	"github.com/belphemur/CBZOptimizer/v2/pkg/converter/constant"
-	"github.com/spf13/cobra"
-	"github.com/thediveo/enumflag/v2"
 	"os"
 	"path/filepath"
 	"strings"
 	"sync"
+
+	utils2 "github.com/belphemur/CBZOptimizer/v2/internal/utils"
+	"github.com/belphemur/CBZOptimizer/v2/pkg/converter"
+	"github.com/belphemur/CBZOptimizer/v2/pkg/converter/constant"
+	"github.com/rs/zerolog/log"
+	"github.com/spf13/cobra"
+	"github.com/thediveo/enumflag/v2"
 )
 
 var converterType constant.ConversionFormat
@@ -40,44 +42,67 @@ func init() {
 }
 
 func ConvertCbzCommand(cmd *cobra.Command, args []string) error {
+	log.Info().Str("command", "optimize").Msg("Starting optimize command")
+
 	path := args[0]
 	if path == "" {
+		log.Error().Msg("Path argument is required but empty")
 		return fmt.Errorf("path is required")
 	}
 
+	log.Debug().Str("input_path", path).Msg("Validating input path")
 	if !utils2.IsValidFolder(path) {
+		log.Error().Str("input_path", path).Msg("Path validation failed - not a valid folder")
 		return fmt.Errorf("the path needs to be a folder")
 	}
+	log.Debug().Str("input_path", path).Msg("Input path validated successfully")
+
+	log.Debug().Msg("Parsing command-line flags")
 
 	quality, err := cmd.Flags().GetUint8("quality")
 	if err != nil || quality <= 0 || quality > 100 {
+		log.Error().Err(err).Uint8("quality", quality).Msg("Invalid quality value")
 		return fmt.Errorf("invalid quality value")
 	}
+	log.Debug().Uint8("quality", quality).Msg("Quality parameter validated")
 
 	override, err := cmd.Flags().GetBool("override")
 	if err != nil {
+		log.Error().Err(err).Msg("Failed to parse override flag")
 		return fmt.Errorf("invalid quality value")
 	}
+	log.Debug().Bool("override", override).Msg("Override parameter parsed")
 
 	split, err := cmd.Flags().GetBool("split")
 	if err != nil {
+		log.Error().Err(err).Msg("Failed to parse split flag")
 		return fmt.Errorf("invalid split value")
 	}
+	log.Debug().Bool("split", split).Msg("Split parameter parsed")
 
 	parallelism, err := cmd.Flags().GetInt("parallelism")
 	if err != nil || parallelism < 1 {
+		log.Error().Err(err).Int("parallelism", parallelism).Msg("Invalid parallelism value")
 		return fmt.Errorf("invalid parallelism value")
 	}
+	log.Debug().Int("parallelism", parallelism).Msg("Parallelism parameter validated")
 
+	log.Debug().Str("converter_format", converterType.String()).Msg("Initializing converter")
 	chapterConverter, err := converter.Get(converterType)
 	if err != nil {
+		log.Error().Str("converter_format", converterType.String()).Err(err).Msg("Failed to get chapter converter")
 		return fmt.Errorf("failed to get chapterConverter: %v", err)
 	}
+	log.Debug().Str("converter_format", converterType.String()).Msg("Converter initialized successfully")
 
+	log.Debug().Msg("Preparing converter")
 	err = chapterConverter.PrepareConverter()
 	if err != nil {
+		log.Error().Err(err).Msg("Failed to prepare converter")
 		return fmt.Errorf("failed to prepare converter: %v", err)
 	}
+	log.Debug().Msg("Converter prepared successfully")
+
 	// Channel to manage the files to process
 	fileChan := make(chan string)
 	// Channel to collect errors
@@ -87,11 +112,14 @@ func ConvertCbzCommand(cmd *cobra.Command, args []string) error {
 	var wg sync.WaitGroup
 
 	// Start worker goroutines
+	log.Debug().Int("worker_count", parallelism).Msg("Starting worker goroutines")
 	for i := 0; i < parallelism; i++ {
 		wg.Add(1)
-		go func() {
+		go func(workerID int) {
 			defer wg.Done()
+			log.Debug().Int("worker_id", workerID).Msg("Worker started")
 			for path := range fileChan {
+				log.Debug().Int("worker_id", workerID).Str("file_path", path).Msg("Worker processing file")
 				err := utils2.Optimize(&utils2.OptimizeOptions{
 					ChapterConverter: chapterConverter,
 					Path:             path,
@@ -100,22 +128,30 @@ func ConvertCbzCommand(cmd *cobra.Command, args []string) error {
 					Split:            split,
 				})
 				if err != nil {
+					log.Error().Int("worker_id", workerID).Str("file_path", path).Err(err).Msg("Worker encountered error")
 					errorChan <- fmt.Errorf("error processing file %s: %w", path, err)
+				} else {
+					log.Debug().Int("worker_id", workerID).Str("file_path", path).Msg("Worker completed file successfully")
 				}
 			}
-		}()
+			log.Debug().Int("worker_id", workerID).Msg("Worker finished")
+		}(i)
 	}
+	log.Debug().Int("worker_count", parallelism).Msg("All worker goroutines started")
 
 	// Walk the path and send files to the channel
-	err = filepath.WalkDir(path, func(path string, info os.DirEntry, err error) error {
+	log.Debug().Str("search_path", path).Msg("Starting filesystem walk for CBZ/CBR files")
+	err = filepath.WalkDir(path, func(filePath string, info os.DirEntry, err error) error {
 		if err != nil {
+			log.Error().Str("file_path", filePath).Err(err).Msg("Error during filesystem walk")
 			return err
 		}
 
 		if !info.IsDir() {
 			fileName := strings.ToLower(info.Name())
 			if strings.HasSuffix(fileName, ".cbz") || strings.HasSuffix(fileName, ".cbr") {
-				fileChan <- path
+				log.Debug().Str("file_path", filePath).Str("file_name", fileName).Msg("Found CBZ/CBR file")
+				fileChan <- filePath
 			}
 		}
 
@@ -123,21 +159,28 @@ func ConvertCbzCommand(cmd *cobra.Command, args []string) error {
 	})
 
 	if err != nil {
+		log.Error().Str("search_path", path).Err(err).Msg("Filesystem walk failed")
 		return fmt.Errorf("error walking the path: %w", err)
 	}
+	log.Debug().Str("search_path", path).Msg("Filesystem walk completed")
 
-	close(fileChan)  // Close the channel to signal workers to stop
-	wg.Wait()        // Wait for all workers to finish
+	close(fileChan) // Close the channel to signal workers to stop
+	log.Debug().Msg("File channel closed, waiting for workers to complete")
+	wg.Wait() // Wait for all workers to finish
+	log.Debug().Msg("All workers completed")
 	close(errorChan) // Close the error channel
 
 	var errs []error
 	for err := range errorChan {
 		errs = append(errs, err)
+		log.Error().Err(err).Msg("Collected processing error")
 	}
 
 	if len(errs) > 0 {
+		log.Error().Int("error_count", len(errs)).Msg("Command completed with errors")
 		return fmt.Errorf("encountered errors: %v", errs)
 	}
 
+	log.Info().Str("search_path", path).Msg("Optimize command completed successfully")
 	return nil
 }