Merge pull request #987 from MichaelMure/cache-progress-bar

commands: add a nice terminal progress bar when building the cache

2 files changed, 91 insertions, 49 deletions

diff --git a/cache/repo_cache.go b/cache/repo_cache.go
index 2121d1e4..9e45d1f1 100644
--- a/cache/repo_cache.go
+++ b/cache/repo_cache.go
@@ -30,7 +30,7 @@ var _ repository.RepoKeyring = &RepoCache{}
 type cacheMgmt interface {
 	Typename() string
 	Load() error
-	Build() error
+	Build() <-chan BuildEvent
 	SetCacheSize(size int)
 	RemoveAll() error
 	MergeAll(remote string) <-chan entity.MergeResult
@@ -213,6 +213,7 @@ const (
 	BuildEventCacheIsBuilt
 	BuildEventRemoveLock
 	BuildEventStarted
+	BuildEventProgress
 	BuildEventFinished
 )
 
@@ -224,6 +225,10 @@ type BuildEvent struct {
 	Typename string
 	// Event is the type of the event.
 	Event BuildEventType
+	// Total is the total number of element being built. Set if Event is BuildEventStarted.
+	Total int64
+	// Progress is the current count of processed element. Set if Event is BuildEventProgress.
+	Progress int64
 }
 
 func (c *RepoCache) buildCache(events chan BuildEvent) {
@@ -234,23 +239,13 @@ func (c *RepoCache) buildCache(events chan BuildEvent) {
 		wg.Add(1)
 		go func(subcache cacheMgmt) {
 			defer wg.Done()
-			events <- BuildEvent{
-				Typename: subcache.Typename(),
-				Event:    BuildEventStarted,
-			}
 
-			err := subcache.Build()
-			if err != nil {
-				events <- BuildEvent{
-					Typename: subcache.Typename(),
-					Err:      err,
+			buildEvents := subcache.Build()
+			for buildEvent := range buildEvents {
+				events <- buildEvent
+				if buildEvent.Err != nil {
+					return
 				}
-				return
-			}
-
-			events <- BuildEvent{
-				Typename: subcache.Typename(),
-				Event:    BuildEventFinished,
 			}
 		}(subcache)
 	}
diff --git a/cache/subcache.go b/cache/subcache.go
index aa9ae62d..09e53c23 100644
--- a/cache/subcache.go
+++ b/cache/subcache.go
@@ -186,51 +186,98 @@ func (sc *SubCache[EntityT, ExcerptT, CacheT]) write() error {
 	return f.Close()
 }
 
-func (sc *SubCache[EntityT, ExcerptT, CacheT]) Build() error {
-	sc.excerpts = make(map[entity.Id]ExcerptT)
+func (sc *SubCache[EntityT, ExcerptT, CacheT]) Build() <-chan BuildEvent {
+	out := make(chan BuildEvent)
 
-	allEntities := sc.actions.ReadAllWithResolver(sc.repo, sc.resolvers())
+	go func() {
+		defer close(out)
 
-	index, err := sc.repo.GetIndex(sc.namespace)
-	if err != nil {
-		return err
-	}
+		out <- BuildEvent{
+			Typename: sc.typename,
+			Event:    BuildEventStarted,
+		}
 
-	// wipe the index just to be sure
-	err = index.Clear()
-	if err != nil {
-		return err
-	}
+		sc.excerpts = make(map[entity.Id]ExcerptT)
 
-	indexer, indexEnd := index.IndexBatch()
+		allEntities := sc.actions.ReadAllWithResolver(sc.repo, sc.resolvers())
 
-	for e := range allEntities {
-		if e.Err != nil {
-			return e.Err
+		index, err := sc.repo.GetIndex(sc.namespace)
+		if err != nil {
+			out <- BuildEvent{
+				Typename: sc.typename,
+				Err:      err,
+			}
+			return
 		}
 
-		cached := sc.makeCached(e.Entity, sc.entityUpdated)
-		sc.excerpts[e.Entity.Id()] = sc.makeExcerpt(cached)
-		// might as well keep them in memory
-		sc.cached[e.Entity.Id()] = cached
+		// wipe the index just to be sure
+		err = index.Clear()
+		if err != nil {
+			out <- BuildEvent{
+				Typename: sc.typename,
+				Err:      err,
+			}
+			return
+		}
+
+		indexer, indexEnd := index.IndexBatch()
+
+		for e := range allEntities {
+			if e.Err != nil {
+				out <- BuildEvent{
+					Typename: sc.typename,
+					Err:      e.Err,
+				}
+				return
+			}
+
+			cached := sc.makeCached(e.Entity, sc.entityUpdated)
+			sc.excerpts[e.Entity.Id()] = sc.makeExcerpt(cached)
+			// might as well keep them in memory
+			sc.cached[e.Entity.Id()] = cached
+
+			indexData := sc.makeIndexData(cached)
+			if err := indexer(e.Entity.Id().String(), indexData); err != nil {
+				out <- BuildEvent{
+					Typename: sc.typename,
+					Err:      err,
+				}
+				return
+			}
 
-		indexData := sc.makeIndexData(cached)
-		if err := indexer(e.Entity.Id().String(), indexData); err != nil {
-			return err
+			out <- BuildEvent{
+				Typename: sc.typename,
+				Event:    BuildEventProgress,
+				Progress: e.CurrentEntity,
+				Total:    e.TotalEntities,
+			}
 		}
-	}
 
-	err = indexEnd()
-	if err != nil {
-		return err
-	}
+		err = indexEnd()
+		if err != nil {
+			out <- BuildEvent{
+				Typename: sc.typename,
+				Err:      err,
+			}
+			return
+		}
 
-	err = sc.write()
-	if err != nil {
-		return err
-	}
+		err = sc.write()
+		if err != nil {
+			out <- BuildEvent{
+				Typename: sc.typename,
+				Err:      err,
+			}
+			return
+		}
 
-	return nil
+		out <- BuildEvent{
+			Typename: sc.typename,
+			Event:    BuildEventFinished,
+		}
+	}()
+
+	return out
 }
 
 func (sc *SubCache[EntityT, ExcerptT, CacheT]) SetCacheSize(size int) {