Update spinner manager to support multiple actions in messages

debricked · May 10, 2023 · 0edbbb7 · 0edbbb7
1 parent bc093ce
commit 0edbbb7
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 17 deletions.
diff --git a/pkg/callgraph/job/job.go b/pkg/callgraph/job/job.go
@@ -4,6 +4,7 @@ import error "github.com/debricked/cli/pkg/io/err"
 
 type IJob interface {
 	GetFiles() []string
+	GetDir() string
 	Errors() error.IErrors
 	Run()
 	ReceiveStatus() chan string

diff --git a/pkg/callgraph/scheduler.go b/pkg/callgraph/scheduler.go
@@ -25,6 +25,8 @@ type Scheduler struct {
 	spinnerManager tui.ISpinnerManager
 }
 
+const callgraph = "Callgraph"
+
 func NewScheduler(workers int) *Scheduler {
 	return &Scheduler{workers: workers, waitGroup: sync.WaitGroup{}}
 }
@@ -38,7 +40,7 @@ func (scheduler *Scheduler) Schedule(jobs []job.IJob) (IGeneration, error) {
 	fmt.Println("Done with spinner start", len(jobs))
 
 	for _, j := range jobs {
-		spinner := scheduler.spinnerManager.AddSpinner("Test")
+		spinner := scheduler.spinnerManager.AddSpinner(callgraph, j.GetDir())
 		scheduler.queue <- queueItem{
 			job:     j,
 			spinner: spinner,
@@ -63,16 +65,16 @@ func (scheduler *Scheduler) Schedule(jobs []job.IJob) (IGeneration, error) {
 func (scheduler *Scheduler) updateStatus(item queueItem) {
 	for {
 		msg := <-item.job.ReceiveStatus()
-		tui.SetSpinnerMessage(item.spinner, "file", msg)
+		tui.SetSpinnerMessage(item.spinner, callgraph, item.job.GetDir(), msg)
 	}
 }
 
 func (scheduler *Scheduler) finish(item queueItem) {
 	if item.job.Errors().HasError() {
-		tui.SetSpinnerMessage(item.spinner, "file", "failed")
+		tui.SetSpinnerMessage(item.spinner, callgraph, item.job.GetDir(), "failed")
 		item.spinner.Error()
 	} else {
-		tui.SetSpinnerMessage(item.spinner, "file", "done")
+		tui.SetSpinnerMessage(item.spinner, callgraph, item.job.GetDir(), "done")
 		item.spinner.Complete()
 	}
 }
diff --git a/pkg/resolution/scheduler.go b/pkg/resolution/scheduler.go
@@ -25,6 +25,8 @@ type Scheduler struct {
 	spinnerManager tui.ISpinnerManager
 }
 
+const resolving = "Resolving"
+
 func NewScheduler(workers int) *Scheduler {
 	return &Scheduler{workers: workers, waitGroup: sync.WaitGroup{}}
 }
@@ -44,7 +46,7 @@ func (scheduler *Scheduler) Schedule(jobs []job.IJob) (IResolution, error) {
 	})
 
 	for _, j := range jobs {
-		spinner := scheduler.spinnerManager.AddSpinner(j.GetFile())
+		spinner := scheduler.spinnerManager.AddSpinner(resolving, j.GetFile())
 		scheduler.queue <- queueItem{
 			job:     j,
 			spinner: spinner,
@@ -75,16 +77,16 @@ func (scheduler *Scheduler) worker() {
 func (scheduler *Scheduler) updateStatus(item queueItem) {
 	for {
 		msg := <-item.job.ReceiveStatus()
-		tui.SetSpinnerMessage(item.spinner, item.job.GetFile(), msg)
+		tui.SetSpinnerMessage(item.spinner, resolving, item.job.GetFile(), msg)
 	}
 }
 
 func (scheduler *Scheduler) finish(item queueItem) {
 	if item.job.Errors().HasError() {
-		tui.SetSpinnerMessage(item.spinner, item.job.GetFile(), "failed")
+		tui.SetSpinnerMessage(item.spinner, resolving, item.job.GetFile(), "failed")
 		item.spinner.Error()
 	} else {
-		tui.SetSpinnerMessage(item.spinner, item.job.GetFile(), "done")
+		tui.SetSpinnerMessage(item.spinner, resolving, item.job.GetFile(), "done")
 		item.spinner.Complete()
 	}
 }
diff --git a/pkg/tui/spinner_manager.go b/pkg/tui/spinner_manager.go
@@ -12,7 +12,7 @@ import (
 )
 
 type ISpinnerManager interface {
-	AddSpinner(file string) *ysmrr.Spinner
+	AddSpinner(action string, file string) *ysmrr.Spinner
 	Start()
 	Stop()
 }
@@ -25,9 +25,9 @@ func NewSpinnerManager() SpinnerManager {
 	return SpinnerManager{ysmrr.NewSpinnerManager(ysmrr.WithSpinnerColor(colors.FgHiBlue))}
 }
 
-func (sm SpinnerManager) AddSpinner(file string) *ysmrr.Spinner {
+func (sm SpinnerManager) AddSpinner(action string, file string) *ysmrr.Spinner {
 	spinner := sm.spinnerManager.AddSpinner("")
-	SetSpinnerMessage(spinner, file, "waiting for worker")
+	SetSpinnerMessage(spinner, action, file, "waiting for worker")
 
 	return spinner
 }
@@ -40,7 +40,7 @@ func (sm SpinnerManager) Stop() {
 	sm.spinnerManager.Stop()
 }
 
-func SetSpinnerMessage(spinner *ysmrr.Spinner, filename string, message string) {
+func SetSpinnerMessage(spinner *ysmrr.Spinner, action string, filename string, message string) {
 	const maxNumberOfChars = 50
 	truncatedFilename := filename
 	if len(truncatedFilename) > maxNumberOfChars {
@@ -60,5 +60,5 @@ func SetSpinnerMessage(spinner *ysmrr.Spinner, filename string, message string)
 
 	}
 	file := color.YellowString(truncatedFilename)
-	spinner.UpdateMessage(fmt.Sprintf("Resolving %s: %s", file, message))
+	spinner.UpdateMessage(fmt.Sprintf("%s %s: %s", action, file, message))
 }
diff --git a/pkg/tui/spinner_manager_test.go b/pkg/tui/spinner_manager_test.go
@@ -9,6 +9,8 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+const resolving = "Resolving"
+
 func TestNewSpinnerManager(t *testing.T) {
 	spinnerManager := NewSpinnerManager()
 	assert.NotNil(t, spinnerManager)
@@ -17,13 +19,27 @@ func TestNewSpinnerManager(t *testing.T) {
 func TestSetSpinnerMessage(t *testing.T) {
 	spinnerManager := NewSpinnerManager()
 	message := "test"
-	spinner := spinnerManager.AddSpinner(message)
+	spinner := spinnerManager.AddSpinner(resolving, message)
 	assert.Contains(t, spinner.GetMessage(), fmt.Sprintf("Resolving %s: waiting for worker", color.YellowString(message)))
 
 	fileName := "file-name"
 	message = "new test message"
 
-	SetSpinnerMessage(spinner, fileName, message)
+	SetSpinnerMessage(spinner, resolving, fileName, message)
+	assert.Contains(t, spinner.GetMessage(), fmt.Sprintf("Resolving %s: %s", color.YellowString(fileName), message))
+}
+
+func TestSetDifferentActionSpinnerMessage(t *testing.T) {
+	spinnerManager := NewSpinnerManager()
+	message := "test"
+	action := "Callgraph"
+	spinner := spinnerManager.AddSpinner(action, message)
+	assert.Contains(t, spinner.GetMessage(), fmt.Sprintf("Callgraph %s: waiting for worker", color.YellowString(message)))
+
+	fileName := "file-name"
+	message = "new test message"
+
+	SetSpinnerMessage(spinner, resolving, fileName, message)
 	assert.Contains(t, spinner.GetMessage(), fmt.Sprintf("Resolving %s: %s", color.YellowString(fileName), message))
 }
 
@@ -36,7 +52,7 @@ func TestSetSpinnerMessageLongFilenameParts(t *testing.T) {
 	}
 	longFileName := filepath.Join(longFilenameParts...)
 
-	spinner := spinnerManager.AddSpinner(longFileName)
+	spinner := spinnerManager.AddSpinner(resolving, longFileName)
 	message := spinner.GetMessage()
 
 	assert.Contains(t, message, longFileName)
@@ -63,7 +79,7 @@ func TestSetSpinnerMessageLongFilenameManyDirs(t *testing.T) {
 		longFilenameParts[len(longFilenameParts)-1],
 	}
 	truncatedFilename := filepath.Join(truncatedFilenameParts...)
-	spinner := spinnerManager.AddSpinner(longFileName)
+	spinner := spinnerManager.AddSpinner(resolving, longFileName)
 	message := spinner.GetMessage()
 
 	assert.Contains(t, message, truncatedFilename)