Merge pull request #130 from whyrusleeping/feat/better-ui

improve install UI a bit

Author: whyrusleeping

gxutil/pm.go

@@ -14,6 +14,7 @@ import (
 
 	sh "github.com/ipfs/go-ipfs-api"
 	mh "github.com/multiformats/go-multihash"
+	prog "github.com/whyrusleeping/progmeter"
 	. "github.com/whyrusleeping/stump"
 )
 
@@ -32,6 +33,8 @@ type PM struct {
 
 	cfg *Config
 
+	ProgMeter *prog.ProgMeter
+
 	global bool
 
 	// hash of the 'empty' ipfs dir to avoid extra calls to object new
@@ -150,29 +153,46 @@ func (pm *PM) InstallDeps(pkg *Package, location string) error {
 	return pm.installDeps(pkg, location, make(map[string]bool))
 }
 
+func (pm *PM) SetProgMeter(meter *prog.ProgMeter) {
+	pm.ProgMeter = meter
+}
+
+func padRight(s string, w int) string {
+	if len(s) < w {
+		return s + strings.Repeat(" ", len(s)-w)
+	}
+	return s
+}
+
 func (pm *PM) installDeps(pkg *Package, location string, complete map[string]bool) error {
-	VLog("installing package: %s-%s", pkg.Name, pkg.Version)
+	//VLog("installing package: %s-%s", pkg.Name, pkg.Version)
 
 	packages := make([]*Package, len(pkg.Dependencies))
 	pkgdirs := make([]string, len(pkg.Dependencies))
 	done := make(chan *Dependency)
 	errs := make(chan error)
+	ratelim := make(chan struct{}, 2)
 	var count int
+	pm.ProgMeter.AddTodos(len(pkg.Dependencies) * 2)
 	for i, dep := range pkg.Dependencies {
 		if complete[dep.Hash] {
+			pm.ProgMeter.MarkDone()
 			continue
 		}
 
 		count++
 
 		go func(i int, dep *Dependency) {
+			ratelim <- struct{}{}
+			defer func() { <-ratelim }()
 			hash := dep.Hash
 			pkgdir := filepath.Join(location, "gx", "ipfs", hash)
 			cpkg := new(Package)
 
 			err := FindPackageInDir(cpkg, pkgdir)
 			if err != nil {
 				VLog("  - %s not found locally, fetching into %s", hash, pkgdir)
+				pm.ProgMeter.AddEntry(dep.Hash, "[fetch]   "+dep.Name, dep.Hash)
 				var final error
 				for i := 0; i < 4; i++ {
 					cpkg, final = pm.GetPackageTo(hash, pkgdir)
@@ -187,9 +207,11 @@ func (pm *PM) installDeps(pkg *Package, location string, complete map[string]boo
 					time.Sleep(time.Millisecond * 200 * time.Duration(i+1))
 				}
 				if final != nil {
+					pm.ProgMeter.Error(dep.Hash, final.Error())
 					errs <- fmt.Errorf("failed to fetch package: %s: %s", hash, final)
 					return
 				}
+				pm.ProgMeter.Finish(dep.Hash)
 				VLog("  - fetch %s complete!", hash)
 			}
 
@@ -218,21 +240,27 @@ func (pm *PM) installDeps(pkg *Package, location string, complete map[string]boo
 	for i, dep := range pkg.Dependencies {
 		cpkg := packages[i]
 		if cpkg == nil {
+			pm.ProgMeter.MarkDone()
 			continue
 		}
 		VLog("  - %s depends on %s (%s)", pkg.Name, dep.Name, dep.Hash)
 		err := pm.installDeps(cpkg, location, complete)
 		if err != nil {
+			pm.ProgMeter.Error(dep.Hash, err.Error())
 			return err
 		}
 
 		complete[dep.Hash] = true
 
+		pm.ProgMeter.AddEntry(dep.Hash, "[install] "+dep.Name, dep.Hash)
+		pm.ProgMeter.Working(dep.Hash, "work")
 		if err := maybeRunPostInstall(cpkg, pkgdirs[i], pm.global); err != nil {
+			pm.ProgMeter.Error(dep.Hash, err.Error())
 			return err
 		}
+		pm.ProgMeter.Finish(dep.Hash)
 	}
-	Log("installation of dep %s complete!", pkg.Name)
+	//Log("installation of dep %s complete!", pkg.Name)
 	return nil
 }
 

main.go

@@ -16,6 +16,7 @@ import (
 	"github.com/blang/semver"
 	cli "github.com/codegangsta/cli"
 	gx "github.com/whyrusleeping/gx/gxutil"
+	progmeter "github.com/whyrusleeping/progmeter"
 	log "github.com/whyrusleeping/stump"
 
 	"github.com/whyrusleeping/json-filter"
@@ -246,7 +247,7 @@ EXAMPLE
 	},
 	Action: func(c *cli.Context) error {
 		if len(c.Args()) == 0 {
-			return fmt.Errorf("import requires a package name")
+			return fmt.Errorf("import requires a package reference")
 		}
 
 		global := c.BoolT("global")
@@ -282,6 +283,8 @@ EXAMPLE
 			return fmt.Errorf("(install):", err)
 		}
 
+		pm.ProgMeter.Stop()
+
 		if pkg.FindDep(npkg.Name) != nil {
 			s := fmt.Sprintf("package with name %s already imported, continue?", npkg.Name)
 			if !yesNoPrompt(s, false) {
@@ -329,6 +332,10 @@ var InstallCommand = cli.Command{
 			Name:  "save",
 			Usage: "write installed packages as deps in package.json",
 		},
+		cli.BoolFlag{
+			Name:  "nofancy",
+			Usage: "write minimal output",
+		},
 	},
 	Action: func(c *cli.Context) error {
 		pkg, err := LoadPackageFile(PkgFileName)
@@ -345,6 +352,8 @@ var InstallCommand = cli.Command{
 
 		pm.SetGlobal(global)
 
+		pm.ProgMeter = progmeter.NewProgMeter(c.Bool("nofancy"))
+
 		if len(c.Args()) == 0 {
 			cwd, err := os.Getwd()
 			if err != nil {

tests/t0030-import.sh

@@ -70,18 +70,16 @@ test_expect_success "importing c brought along a and b" '
 '
 
 test_expect_success "install d works" '
-	pkg_run d gx --verbose install > install_out
+	pkg_run d gx --verbose install --nofancy > install_out
 '
 
 test_expect_success "install output looks good" '
-	grep "installing package: d-0.0.0" install_out &&
-	grep "installing package: c-0.0.0" install_out &&
-	grep "installing package: a-0.0.0" install_out &&
-	grep "installing package: b-0.0.0" install_out &&
-	grep "installation of dep a complete!" install_out &&
-	grep "installation of dep b complete!" install_out &&
-	grep "installation of dep c complete!" install_out &&
-	grep "installation of dep d complete!" install_out
+	grep "\[get \] \[install\] a" install_out &&
+	grep "\[get \] \[install\] b" install_out &&
+	grep "\[get \] \[install\] c" install_out &&
+	grep "\[done\] \[install\] a" install_out &&
+	grep "\[done\] \[install\] b" install_out &&
+	grep "\[done\] \[install\] c" install_out
 '
 
 test_expect_success "deps look correct" '