perf: use comment of the zip to know if it's converted instead of txt file

chore(deps): update actions/upload-artifact action to v4

.github/workflows/test.yml

@@ -28,7 +28,17 @@ jobs:
           mv go-junit-report /usr/local/bin/
 
       - name: Run tests
-        run: go test -v 2>&1 ./... -coverprofile=coverage.txt | go-junit-report -set-exit-code > junit.xml
+        run: |
+          set -o pipefail
+          go test -v 2>&1 ./... -coverprofile=coverage.txt | tee test-results.txt
+      - name: Analyse test results
+        run: go-junit-report < test-results.txt > report.xml
+      - name: Upload test result artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results
+          path: test-results.txt
+          retention-days: 7
       - name: Upload results to Codecov
         uses: codecov/codecov-action@v4
         with:

Dockerfile

@@ -3,13 +3,13 @@ LABEL authors="Belphemur"
 ENV USER=abc
 ENV CONFIG_FOLDER=/config
 ENV PUID=99
-RUN mkdir -p "${CONFIG_FOLDER}" && adduser \
+RUN adduser \
     --disabled-password \
     --gecos "" \
     --home "$(pwd)" \
     --ingroup "users" \
-    --no-create-home \
     --uid "${PUID}" \
+    --home "${CONFIG_FOLDER}" \
     "${USER}" && \
     chown ${PUID}:${GUID} "${CONFIG_FOLDER}"
 
@@ -17,5 +17,6 @@ COPY CBZOptimizer /usr/local/bin/CBZOptimizer
 
 RUN apk add --no-cache inotify-tools bash-completion  && chmod +x /usr/local/bin/CBZOptimizer && /usr/local/bin/CBZOptimizer completion bash > /etc/bash_completion.d/CBZOptimizer
 
+VOLUME ${CONFIG_FOLDER}
 USER ${USER}
 ENTRYPOINT ["/usr/local/bin/CBZOptimizer"]

cbz/cbz_creator.go

@@ -18,7 +18,6 @@ func WriteChapterToCBZ(chapter *manga.Chapter, outputFilePath string) error {
 
 	// Create a new ZIP writer
 	zipWriter := zip.NewWriter(zipFile)
-	err = zipWriter.SetComment("Created by CBZOptimizer")
 	if err != nil {
 		return err
 	}
@@ -71,18 +70,11 @@ func WriteChapterToCBZ(chapter *manga.Chapter, outputFilePath string) error {
 	}
 
 	if chapter.IsConverted {
-		convertedWriter, err := zipWriter.CreateHeader(&zip.FileHeader{
-			Name:     "Converted.txt",
-			Method:   zip.Deflate,
-			Modified: time.Now(),
-		})
-		if err != nil {
-			return fmt.Errorf("failed to create Converted.txt in .cbz: %w", err)
-		}
 
-		_, err = convertedWriter.Write([]byte(fmt.Sprintf("%s\nThis chapter has been converted by CBZOptimizer.", chapter.ConvertedTime)))
+		convertedString := fmt.Sprintf("%s\nThis chapter has been converted by CBZOptimizer.", chapter.ConvertedTime)
+		err = zipWriter.SetComment(convertedString)
 		if err != nil {
-			return fmt.Errorf("failed to write Converted.txt contents: %w", err)
+			return fmt.Errorf("failed to write comment: %w", err)
 		}
 	}
 

cbz/cbz_creator_test.go

@@ -3,6 +3,7 @@ package cbz
 import (
 	"archive/zip"
 	"bytes"
+	"fmt"
 	"github.com/belphemur/CBZOptimizer/manga"
 	"os"
 	"testing"
@@ -10,11 +11,14 @@ import (
 )
 
 func TestWriteChapterToCBZ(t *testing.T) {
+	currentTime := time.Now()
+
 	// Define test cases
 	testCases := []struct {
-		name          string
-		chapter       *manga.Chapter
-		expectedFiles []string
+		name            string
+		chapter         *manga.Chapter
+		expectedFiles   []string
+		expectedComment string
 	}{
 		//test case where there is only one page and ComicInfo and the chapter is converted
 		{
@@ -29,9 +33,10 @@ func TestWriteChapterToCBZ(t *testing.T) {
 				},
 				ComicInfoXml:  "<Series>Boundless Necromancer</Series>",
 				IsConverted:   true,
-				ConvertedTime: time.Now(),
+				ConvertedTime: currentTime,
 			},
-			expectedFiles: []string{"0000.jpg", "ComicInfo.xml", "Converted.txt"},
+			expectedFiles:   []string{"0000.jpg", "ComicInfo.xml"},
+			expectedComment: fmt.Sprintf("%s\nThis chapter has been converted by CBZOptimizer.", currentTime),
 		},
 		//test case where there is only one page and no
 		{
@@ -125,6 +130,10 @@ func TestWriteChapterToCBZ(t *testing.T) {
 				}
 			}
 
+			if tc.expectedComment != "" && r.Comment != tc.expectedComment {
+				t.Errorf("Expected comment %s, but found %s", tc.expectedComment, r.Comment)
+			}
+
 			// Check if there are no unexpected files
 			if len(filesInArchive) != len(tc.expectedFiles) {
 				t.Errorf("Expected %d files, but found %d", len(tc.expectedFiles), len(filesInArchive))

cbz/cbz_loader.go

@@ -23,6 +23,17 @@ func LoadChapter(filePath string) (*manga.Chapter, error) {
 	chapter := &manga.Chapter{
 		FilePath: filePath,
 	}
+	// Check for comment
+	if r.Comment != "" {
+		scanner := bufio.NewScanner(strings.NewReader(r.Comment))
+		if scanner.Scan() {
+			convertedTime := scanner.Text()
+			chapter.ConvertedTime, err = dateparse.ParseAny(convertedTime)
+			if err == nil {
+				chapter.IsConverted = true
+			}
+		}
+	}
 
 	for _, f := range r.File {
 		if f.FileInfo().IsDir() {
@@ -45,7 +56,7 @@ func LoadChapter(filePath string) (*manga.Chapter, error) {
 				return nil, fmt.Errorf("failed to read ComicInfo.xml content: %w", err)
 			}
 			chapter.ComicInfoXml = string(xmlContent)
-		} else if ext == ".txt" && strings.ToLower(filepath.Base(f.Name)) == "converted.txt" {
+		} else if !chapter.IsConverted && ext == ".txt" && strings.ToLower(filepath.Base(f.Name)) == "converted.txt" {
 			textContent, err := io.ReadAll(rc)
 			if err != nil {
 				rc.Close()

cmd/watch_command.go

@@ -116,7 +116,7 @@ func WatchCommand(_ *cobra.Command, args []string) error {
 				case inotifywaitgo.CLOSE_WRITE, inotifywaitgo.MOVE:
 					err := utils.Optimize(&utils.OptimizeOptions{
 						ChapterConverter: chapterConverter,
-						Path:             path,
+						Path:             event.Filename,
 						Quality:          quality,
 						Override:         override,
 						Split:            split,

converter/converter.go

@@ -12,6 +12,9 @@ import (
 type Converter interface {
 	// Format of the converter
 	Format() (format constant.ConversionFormat)
+	// ConvertChapter converts a manga chapter to the specified format.
+	//
+	// Returns partial success where some pages are converted and some are not.
 	ConvertChapter(chapter *manga.Chapter, quality uint8, split bool, progress func(message string, current uint32, total uint32)) (*manga.Chapter, error)
 	PrepareConverter() error
 }

converter/converter_test.go

@@ -2,7 +2,9 @@ package converter
 
 import (
 	"bytes"
+	"github.com/belphemur/CBZOptimizer/converter/constant"
 	"github.com/belphemur/CBZOptimizer/manga"
+	"golang.org/x/exp/slices"
 	"image"
 	"image/jpeg"
 	"os"
@@ -12,29 +14,46 @@ import (
 func TestConvertChapter(t *testing.T) {
 
 	testCases := []struct {
-		name           string
-		genTestChapter func(path string) (*manga.Chapter, error)
-		split          bool
+		name                 string
+		genTestChapter       func(path string) (*manga.Chapter, error)
+		split                bool
+		expectFailure        []constant.ConversionFormat
+		expectPartialSuccess []constant.ConversionFormat
 	}{
 		{
-			name:           "All split pages",
-			genTestChapter: genBigPages,
-			split:          true,
+			name:                 "All split pages",
+			genTestChapter:       genHugePage,
+			split:                true,
+			expectFailure:        []constant.ConversionFormat{},
+			expectPartialSuccess: []constant.ConversionFormat{},
 		},
 		{
-			name:           "Big Pages, no split",
-			genTestChapter: genBigPages,
-			split:          false,
+			name:                 "Big Pages, no split",
+			genTestChapter:       genHugePage,
+			split:                false,
+			expectFailure:        []constant.ConversionFormat{constant.WebP},
+			expectPartialSuccess: []constant.ConversionFormat{},
 		},
 		{
-			name:           "No split pages",
-			genTestChapter: genSmallPages,
-			split:          false,
+			name:                 "No split pages",
+			genTestChapter:       genSmallPages,
+			split:                false,
+			expectFailure:        []constant.ConversionFormat{},
+			expectPartialSuccess: []constant.ConversionFormat{},
 		},
 		{
-			name:           "Mix of split and no split pages",
-			genTestChapter: genMixSmallBig,
-			split:          true,
+			name:                 "Mix of split and no split pages",
+			genTestChapter:       genMixSmallBig,
+			split:                true,
+			expectFailure:        []constant.ConversionFormat{},
+			expectPartialSuccess: []constant.ConversionFormat{},
+		},
+		{
+			name:                 "Mix of Huge and small page",
+			genTestChapter:       genMixSmallHuge,
+			split:                false,
+			expectFailure:        []constant.ConversionFormat{},
+			expectPartialSuccess: []constant.ConversionFormat{constant.WebP},
 		},
 	}
 	// Load test genTestChapter from testdata
@@ -63,15 +82,29 @@ func TestConvertChapter(t *testing.T) {
 						t.Log(msg)
 					}
 
-					convertedChapter, err := converter.ConvertChapter(chapter, quality, false, progress)
+					convertedChapter, err := converter.ConvertChapter(chapter, quality, tc.split, progress)
 					if err != nil {
+						if convertedChapter != nil && slices.Contains(tc.expectPartialSuccess, converter.Format()) {
+							t.Logf("Partial success to convert genTestChapter: %v", err)
+							return
+						}
+						if slices.Contains(tc.expectFailure, converter.Format()) {
+							t.Logf("Expected failure to convert genTestChapter: %v", err)
+							return
+						}
 						t.Fatalf("failed to convert genTestChapter: %v", err)
+					} else if slices.Contains(tc.expectFailure, converter.Format()) {
+						t.Fatalf("expected failure to convert genTestChapter didn't happen")
 					}
 
 					if len(convertedChapter.Pages) == 0 {
 						t.Fatalf("no pages were converted")
 					}
 
+					if len(convertedChapter.Pages) != len(chapter.Pages) {
+						t.Fatalf("converted chapter has different number of pages")
+					}
+
 					for _, page := range convertedChapter.Pages {
 						if page.Extension != ".webp" {
 							t.Errorf("page %d was not converted to webp format", page.Index)
@@ -83,7 +116,7 @@ func TestConvertChapter(t *testing.T) {
 	}
 }
 
-func genBigPages(path string) (*manga.Chapter, error) {
+func genHugePage(path string) (*manga.Chapter, error) {
 	file, err := os.Open(path)
 	if err != nil {
 		return nil, err
@@ -91,8 +124,8 @@ func genBigPages(path string) (*manga.Chapter, error) {
 	defer file.Close()
 
 	var pages []*manga.Page
-	for i := 0; i < 5; i++ { // Assuming there are 5 pages for the test
-		img := image.NewRGBA(image.Rect(0, 0, 300, 17000))
+	for i := 0; i < 1; i++ { // Assuming there are 5 pages for the test
+		img := image.NewRGBA(image.Rect(0, 0, 1, 17000))
 		buf := new(bytes.Buffer)
 		err := jpeg.Encode(buf, img, nil)
 		if err != nil {
@@ -169,3 +202,32 @@ func genMixSmallBig(path string) (*manga.Chapter, error) {
 		Pages:    pages,
 	}, nil
 }
+
+func genMixSmallHuge(path string) (*manga.Chapter, error) {
+	file, err := os.Open(path)
+	if err != nil {
+		return nil, err
+	}
+	defer file.Close()
+
+	var pages []*manga.Page
+	for i := 0; i < 10; i++ { // Assuming there are 5 pages for the test
+		img := image.NewRGBA(image.Rect(0, 0, 1, 2000*(i+1)))
+		buf := new(bytes.Buffer)
+		err := jpeg.Encode(buf, img, nil)
+		if err != nil {
+			return nil, err
+		}
+		page := &manga.Page{
+			Index:     uint16(i),
+			Contents:  buf,
+			Extension: ".jpg",
+		}
+		pages = append(pages, page)
+	}
+
+	return &manga.Chapter{
+		FilePath: path,
+		Pages:    pages,
+	}, nil
+}

converter/errors/converter_errors.go

@@ -0,0 +1,13 @@
+package errors
+
+type PageIgnoredError struct {
+	s string
+}
+
+func (e *PageIgnoredError) Error() string {
+	return e.s
+}
+
+func NewPageIgnored(text string) error {
+	return &PageIgnoredError{text}
+}

converter/webp/webp_converter.go

@@ -2,8 +2,10 @@ package webp
 
 import (
 	"bytes"
+	"errors"
 	"fmt"
 	"github.com/belphemur/CBZOptimizer/converter/constant"
+	converterrors "github.com/belphemur/CBZOptimizer/converter/errors"
 	"github.com/belphemur/CBZOptimizer/manga"
 	"github.com/oliamb/cutter"
 	"golang.org/x/exp/slices"
@@ -106,22 +108,25 @@ func (converter *Converter) ConvertChapter(chapter *manga.Chapter, quality uint8
 		go func(page *manga.Page) {
 			defer wgPages.Done()
 
-			splitNeeded, img, format, err := converter.checkPageNeedsSplit(page)
-			// Respect choice to split or not
-			splitNeeded = split && splitNeeded
+			splitNeeded, img, format, err := converter.checkPageNeedsSplit(page, split)
 			if err != nil {
-				errChan <- fmt.Errorf("error checking if page %d of genTestChapter %s needs split: %v", page.Index, chapter.FilePath, err)
+				errChan <- err
+				// Partial error in this case, we want the page, but not converting it
+				if img != nil {
+					wgConvertedPages.Add(1)
+					pagesChan <- manga.NewContainer(page, img, format, false)
+				}
 				return
 			}
 
 			if !splitNeeded {
 				wgConvertedPages.Add(1)
-				pagesChan <- manga.NewContainer(page, img, format)
+				pagesChan <- manga.NewContainer(page, img, format, true)
 				return
 			}
 			images, err := converter.cropImage(img)
 			if err != nil {
-				errChan <- fmt.Errorf("error converting page %d of genTestChapter %s to webp: %v", page.Index, chapter.FilePath, err)
+				errChan <- err
 				return
 			}
 
@@ -129,7 +134,7 @@ func (converter *Converter) ConvertChapter(chapter *manga.Chapter, quality uint8
 			for i, img := range images {
 				page := &manga.Page{Index: page.Index, IsSplitted: true, SplitPartIndex: uint16(i)}
 				wgConvertedPages.Add(1)
-				pagesChan <- manga.NewContainer(page, img, "N/A")
+				pagesChan <- manga.NewContainer(page, img, "N/A", true)
 			}
 		}(page)
 	}
@@ -144,8 +149,9 @@ func (converter *Converter) ConvertChapter(chapter *manga.Chapter, quality uint8
 		errList = append(errList, err)
 	}
 
+	var aggregatedError error = nil
 	if len(errList) > 0 {
-		return nil, fmt.Errorf("encountered errors: %v", errList)
+		aggregatedError = errors.Join(errList...)
 	}
 
 	slices.SortFunc(pages, func(a, b *manga.Page) int {
@@ -158,7 +164,7 @@ func (converter *Converter) ConvertChapter(chapter *manga.Chapter, quality uint8
 
 	runtime.GC()
 
-	return chapter, nil
+	return chapter, aggregatedError
 }
 
 func (converter *Converter) cropImage(img image.Image) ([]image.Image, error) {
@@ -194,7 +200,7 @@ func (converter *Converter) cropImage(img image.Image) ([]image.Image, error) {
 	return parts, nil
 }
 
-func (converter *Converter) checkPageNeedsSplit(page *manga.Page) (bool, image.Image, string, error) {
+func (converter *Converter) checkPageNeedsSplit(page *manga.Page, splitRequested bool) (bool, image.Image, string, error) {
 	reader := io.Reader(bytes.NewBuffer(page.Contents.Bytes()))
 	img, format, err := image.Decode(reader)
 	if err != nil {
@@ -204,16 +210,19 @@ func (converter *Converter) checkPageNeedsSplit(page *manga.Page) (bool, image.I
 	bounds := img.Bounds()
 	height := bounds.Dy()
 
-	if height >= webpMaxHeight {
-		return false, img, format, fmt.Errorf("page[%d] height %d exceeds maximum height %d of webp format", page.Index, height, webpMaxHeight)
+	if height >= webpMaxHeight && !splitRequested {
+		return false, img, format, converterrors.NewPageIgnored(fmt.Sprintf("page %d is too tall [max: %dpx] to be converted to webp format", page.Index, webpMaxHeight))
 	}
-	return height >= converter.maxHeight, img, format, nil
+	return height >= converter.maxHeight && splitRequested, img, format, nil
 }
 
 func (converter *Converter) convertPage(container *manga.PageContainer, quality uint8) (*manga.PageContainer, error) {
 	if container.Format == "webp" {
 		return container, nil
 	}
+	if !container.IsToBeConverted {
+		return container, nil
+	}
 	converted, err := converter.convert(container.Image, uint(quality))
 	if err != nil {
 		return nil, err

manga/page_container.go

@@ -10,8 +10,10 @@ type PageContainer struct {
 	Image image.Image
 	// Format is a string representing the format of the image (e.g., "png", "jpeg", "webp").
 	Format string
+	// IsToBeConverted is a boolean flag indicating whether the image needs to be converted to another format.
+	IsToBeConverted bool
 }
 
-func NewContainer(Page *Page, img image.Image, format string) *PageContainer {
-	return &PageContainer{Page: Page, Image: img, Format: format}
+func NewContainer(Page *Page, img image.Image, format string, isToBeConverted bool) *PageContainer {
+	return &PageContainer{Page: Page, Image: img, Format: format, IsToBeConverted: isToBeConverted}
 }

utils/optimize.go

@@ -1,9 +1,11 @@
 package utils
 
 import (
+	"errors"
 	"fmt"
 	"github.com/belphemur/CBZOptimizer/cbz"
 	"github.com/belphemur/CBZOptimizer/converter"
+	errors2 "github.com/belphemur/CBZOptimizer/converter/errors"
 	"log"
 	"strings"
 )
@@ -38,8 +40,15 @@ func Optimize(options *OptimizeOptions) error {
 		}
 	})
 	if err != nil {
-		return fmt.Errorf("failed to convert chapter: %v", err)
+		var pageIgnoredError *errors2.PageIgnoredError
+		if !errors.As(err, &pageIgnoredError) {
+			return fmt.Errorf("failed to convert chapter: %v", err)
+		}
 	}
+	if convertedChapter == nil {
+		return fmt.Errorf("failed to convert chapter")
+	}
+
 	convertedChapter.SetConverted()
 
 	// Write the converted chapter back to a CBZ file