feat: add progress notification to download

cmd/install.go

@@ -12,6 +12,7 @@ import (
 	"github.com/dpastoor/qvm/internal/pipeline"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
 )
 
 type installCmd struct {
@@ -20,6 +21,7 @@ type installCmd struct {
 }
 
 type installOpts struct {
+	progress bool
 }
 
 func newInstall(installOpts installOpts, release string) error {
@@ -41,7 +43,7 @@ func newInstall(installOpts installOpts, release string) error {
 		return nil
 	}
 	log.Info("attempting to install quarto version: ", release)
-	res, err := pipeline.DownloadReleaseVersion(release, runtime.GOOS)
+	res, err := pipeline.DownloadReleaseVersion(release, runtime.GOOS, installOpts.progress)
 	if err != nil {
 		return err
 	}
@@ -51,7 +53,7 @@ func newInstall(installOpts installOpts, release string) error {
 }
 
 func setInstallOpts(installOpts *installOpts) {
-
+	installOpts.progress = !viper.GetBool("no-progress")
 }
 
 func (opts *installOpts) Validate() error {
@@ -100,6 +102,8 @@ func newInstallCmd() *installCmd {
 			return nil
 		},
 	}
+	cmd.Flags().BoolP("no-progress", "", false, "do not print download progress")
+	viper.BindPFlag("no-progress", cmd.Flags().Lookup("no-progress"))
 	root.cmd = cmd
 	return root
 }

go.mod

@@ -4,6 +4,7 @@ go 1.18
 
 require (
 	github.com/adrg/xdg v0.4.0
+	github.com/dustin/go-humanize v1.0.0
 	github.com/google/go-github/v44 v44.1.0
 	github.com/mholt/archiver/v4 v4.0.0-alpha.6.0.20220421032531-8a97d87612e9
 	github.com/muesli/mango-cobra v1.1.0

go.sum

@@ -57,6 +57,8 @@ github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs
 github.com/dsnet/compress v0.0.1 h1:PlZu0n3Tuv04TzpfPbrnI0HW/YwodEXDS+oPKahKF0Q=
 github.com/dsnet/compress v0.0.1/go.mod h1:Aw8dCMJ7RioblQeTqt88akK31OvO8Dhf5JflhBbQEHo=
 github.com/dsnet/golib v0.0.0-20171103203638-1ea166775780/go.mod h1:Lj+Z9rebOhdfkVLjJ8T6VcRQv3SXugXy999NBtR9aFY=
+github.com/dustin/go-humanize v1.0.0 h1:VSnTsYCnlFHaM2/igO1h6X3HA71jcobQuxemgkq4zYo=
+github.com/dustin/go-humanize v1.0.0/go.mod h1:HtrtbFcZ19U5GC7JDqmcUSB87Iq5E25KnS6fMYU6eOk=
 github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
 github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
 github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98=

internal/gh/assets.go

@@ -10,6 +10,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/dustin/go-humanize"
 	"github.com/google/go-github/v44/github"
 	log "github.com/sirupsen/logrus"
 )
@@ -49,10 +50,30 @@ func (o osAssetSuffix) String() string {
 	}
 }
 
+type WriteCounter struct {
+	Written  int
+	Total    int
+	Label    string
+	nWrites  int
+	progress bool
+}
+
+func (wc *WriteCounter) Write(p []byte) (int, error) {
+	n := len(p)
+	wc.Written += n
+	wc.nWrites++
+	if wc.progress && wc.nWrites%200 == 0 {
+		log.Infof("downloading quarto version %s ... (%s/%s)", wc.Label,
+			humanize.Bytes(uint64(wc.Written)),
+			humanize.Bytes(uint64(wc.Total)))
+	}
+	return n, nil
+}
+
 // DownloadReleaseAsset downloads the release asset for a given platform to a temp
 // file and returns the path to the written file.
 // targetOs should be "windows", "darwin", "linux"
-func DownloadReleaseAsset(client *github.Client, tag string, targetOs string) (string, error) {
+func DownloadReleaseAsset(client *github.Client, tag string, targetOs string, progress bool) (string, error) {
 	switch targetOs {
 	case "windows", "darwin", "linux":
 		break
@@ -83,7 +104,8 @@ func DownloadReleaseAsset(client *github.Client, tag string, targetOs string) (s
 	defer tmpFile.Close()
 	log.Tracef("starting to copy release asset to %s\n", tmpFile.Name())
 	start = time.Now()
-	wb, err := io.Copy(tmpFile, rc)
+	counter := &WriteCounter{Total: asset.GetSize(), Label: tag, progress: progress}
+	wb, err := io.Copy(tmpFile, io.TeeReader(rc, counter))
 	log.Tracef("done copying release asset in %s\n", time.Since(start))
 	if err != nil {
 		return tmpFile.Name(), err

internal/pipeline/download.go

@@ -11,9 +11,9 @@ import (
 
 // DownloadReleaseVersion downloads the appropriate tarball for a given platform
 // platform should be windows | linux | darwin
-func DownloadReleaseVersion(release string, platform string) (string, error) {
+func DownloadReleaseVersion(release string, platform string, progress bool) (string, error) {
 	client := gh.NewClient(os.Getenv("GITHUB_PAT"))
-	dlPath, err := gh.DownloadReleaseAsset(client, release, platform)
+	dlPath, err := gh.DownloadReleaseAsset(client, release, platform, progress)
 	if err != nil {
 		return "", err
 	}