Add download progress bar (#10)

Part of #4

Author: outcatcher

.gitignore

@@ -24,3 +24,4 @@ go.work.sum
 
 build/*
 
+*.log

Taskfile.yaml

@@ -27,4 +27,4 @@ tasks:
 
   build:
     desc: Build binary
-    cmd: go build -o ./build/hihapu ./cmd/...
+    cmd: go build -o ./build/hihapu ./cmd/main.go

app/app.go

@@ -53,11 +53,27 @@ func New(configPath string) (*Application, error) {
 	app.WithRemote(remote)
 	app.WithFiles(new(local.Files))
 
-	app.logger = slog.Default()
+	app.logger = initLogger()
 
 	return app, nil
 }
 
+// todo: rewrite
+func initLogger() *slog.Logger {
+	logFile, err := os.Create("hipapu.log")
+	if err != nil {
+		return nil
+	}
+
+	fileHandler := slog.NewTextHandler(logFile, &slog.HandlerOptions{Level: slog.LevelDebug})
+
+	logger := slog.New(fileHandler)
+
+	logger.Info("Log started")
+
+	return logger
+}
+
 type cfg interface {
 	// Add adds installation to the list.
 	Add(installation config.Installation) error

app/app_test.go

@@ -82,7 +82,7 @@ func TestAppWorkflow(t *testing.T) {
 			}},
 		}, nil)
 	mockRemote.
-		On("DownloadFile", ctx, expectecdDownloadURL, mock.AnythingOfType("*os.File")).
+		On("DownloadFile", ctx, expectecdDownloadURL, mock.Anything).
 		Return(nil)
 
 	apk.WithRemote(mockRemote)

app/sync.go

@@ -5,12 +5,14 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"io"
 	"os"
 	"path/filepath"
 	"strings"
 	"time"
 
 	"github.com/outcatcher/hipapu/internal/config"
+	"github.com/schollz/progressbar/v3"
 )
 
 // Public sync errors. Self-explanatory.
@@ -19,7 +21,7 @@ var (
 	ErrMissingAsset          = errors.New("no asset with given name found")
 )
 
-// Synchronize downloads all new releases replacing local files.
+// Synchronize runs synchronization of all new releases replacing local files reporting the progress.
 func (a *Application) Synchronize(ctx context.Context) error {
 	installations := a.config.GetInstallations()
 
@@ -31,7 +33,10 @@ func (a *Application) Synchronize(ctx context.Context) error {
 
 	var errs error
 
-	for _, installation := range installations {
+	for i, installation := range installations {
+		// todo: output is a CLI interaction, needs to be moved out to cmd somehow
+		fmt.Printf("Synchronizing installation #%d of %d\n", i+1, len(installations))
+
 		// todo: parrallelize
 		if err := a.syncInstallation(ctx, installation); err != nil {
 			errs = errors.Join(errs, err)
@@ -44,7 +49,9 @@ func (a *Application) Synchronize(ctx context.Context) error {
 }
 
 //nolint:cyclop,funlen  // rewriting makes it less readable
-func (a *Application) syncInstallation(ctx context.Context, installation config.Installation) error {
+func (a *Application) syncInstallation(
+	ctx context.Context, installation config.Installation,
+) error {
 	file, err := a.files.GetFileInfo(installation.LocalPath)
 	if err != nil {
 		return fmt.Errorf("failed to get file info: %w", err)
@@ -53,7 +60,12 @@ func (a *Application) syncInstallation(ctx context.Context, installation config.
 	urlParts := strings.Split(installation.RepoURL, "/")
 	owner, repo := urlParts[len(urlParts)-2], urlParts[len(urlParts)-1]
 
-	a.log().Info("Starting sync of installation", "owner", owner, "repo", repo, "local path", installation.LocalPath)
+	a.log().InfoContext(ctx,
+		"Starting sync of installation",
+		"owner", owner,
+		"repo", repo,
+		"local path", installation.LocalPath,
+	)
 
 	release, err := a.remote.GetLatestRelease(ctx, owner, repo)
 	if err != nil {
@@ -96,7 +108,20 @@ func (a *Application) syncInstallation(ctx context.Context, installation config.
 
 	a.log().Info("Download started", "download URL", downloadURL, "total size, MiB", totalSize/1024/1024) //nolint:mnd
 
-	if err := a.remote.DownloadFile(ctx, downloadURL, tmpFile); err != nil {
+	// todo: progress bar is a CLI interaction, needs to be moved out to cmd somehow
+	bar := progressbar.DefaultBytes(-1, "Downloading to"+tmpFilePath)
+	bar.ChangeMax(totalSize)
+
+	// cleanup on cancel
+	go func() {
+		<-ctx.Done()
+
+		_ = tmpFile.Close()
+	}()
+
+	writer := io.MultiWriter(bar, tmpFile)
+
+	if err := a.remote.DownloadFile(ctx, downloadURL, writer); err != nil {
 		return fmt.Errorf("failed to dowload to tmp file: %w", err)
 	}
 

cmd/actions.go

@@ -0,0 +1,10 @@
+// Copyright (C) 2025  Anton Kachurin
+package handlers
+
+// DefaultCommandName - name of default command.
+const DefaultCommandName = commandNameList
+
+// ActionHandlers handle CLI actions.
+type ActionHandlers struct {
+	filePath, repoPath, configPath string
+}

cmd/handlers/actions.go

@@ -0,0 +1,58 @@
+// Copyright (C) 2025  Anton Kachurin
+package handlers
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/outcatcher/hipapu/app"
+	"github.com/urfave/cli/v3"
+)
+
+const commandNameAdd = "add"
+
+// AddCommand handle 'add' subcommand.
+func (h *ActionHandlers) AddCommand() *cli.Command {
+	return &cli.Command{
+		Name:  commandNameAdd,
+		Usage: "Adds package to the watchlist",
+		Flags: []cli.Flag{
+			&cli.StringFlag{
+				Name:        "path",
+				Usage:       "(required) File to watch. Will be created if doesn't exist.",
+				Required:    true,
+				Destination: &h.filePath,
+				Aliases:     []string{"p"},
+				TakesFile:   true,
+				OnlyOnce:    true,
+			},
+			&cli.StringFlag{
+				Name:        "repo",
+				Usage:       "(required) Repo to watch. Must exist.",
+				Required:    true,
+				Destination: &h.repoPath,
+				Aliases:     []string{"r"},
+				TakesFile:   true,
+				OnlyOnce:    true,
+			},
+		},
+		EnableShellCompletion: true,
+		Action:                h.addHandler,
+		Suggest:               true,
+	}
+}
+
+func (h *ActionHandlers) addHandler(context.Context, *cli.Command) error {
+	application, err := app.New(h.configPath)
+	if err != nil {
+		return fmt.Errorf("failed to start app: %w", err)
+	}
+
+	if err := application.Add(h.repoPath, h.filePath); err != nil {
+		return fmt.Errorf("error during installation addition: %w", err)
+	}
+
+	println("Added!")
+
+	return nil
+}

cmd/handlers/add.go

@@ -0,0 +1,33 @@
+package handlers
+
+import (
+	"os/user"
+
+	"github.com/urfave/cli/v3"
+)
+
+// ConfigFlag - handle '--config' flag.
+func (h *ActionHandlers) ConfigFlag() *cli.StringFlag {
+	return &cli.StringFlag{
+		Name:        "config",
+		Usage:       "Configuration file path",
+		Sources:     cli.ValueSourceChain{},
+		Required:    false,
+		Value:       defaultConfigPath(),
+		Destination: &h.configPath,
+		Aliases:     []string{"c"},
+		TakesFile:   true,
+		OnlyOnce:    true,
+	}
+}
+
+func defaultConfigPath() string {
+	basePath := "."
+
+	usr, _ := user.Current()
+	if usr != nil {
+		basePath = usr.HomeDir
+	}
+
+	return basePath + "/.config/hipapu/config.json"
+}

cmd/handlers/config.go

@@ -0,0 +1,40 @@
+// Copyright (C) 2025  Anton Kachurin
+package handlers
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/outcatcher/hipapu/app"
+	"github.com/urfave/cli/v3"
+)
+
+const commandNameList = "list"
+
+// ListCommand handle 'list' subcommand.
+func (h *ActionHandlers) ListCommand() *cli.Command {
+	return &cli.Command{
+		Name:                  commandNameList,
+		Usage:                 "List existing installations",
+		EnableShellCompletion: true,
+		Action:                h.list,
+		Suggest:               true,
+	}
+}
+
+func (h *ActionHandlers) list(context.Context, *cli.Command) error {
+	application, err := app.New(h.configPath)
+	if err != nil {
+		return fmt.Errorf("failed to start app: %w", err)
+	}
+
+	installations := application.List()
+
+	fmt.Println("Installations:")
+
+	for i, installation := range installations {
+		fmt.Printf("  %d) %s <---> %s\n", i+1, installation.RepoURL, installation.LocalPath)
+	}
+
+	return nil
+}