feat: add wait print function

Author: zhufuyi

cmd/sponge/commands/generate/common.go

@@ -4,6 +4,7 @@ package generate
 import (
 	"bufio"
 	"bytes"
+	"context"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -1054,3 +1055,30 @@ func getGRPCServiceFields() []replacer.Field {
 		},
 	}
 }
+
+func clearCurrentLine() {
+	fmt.Print("\033[2K\r")
+}
+
+func PrintWaiting(ctx context.Context, runningTip string, finishTip string) {
+	defer func() {
+		clearCurrentLine()
+		fmt.Println(finishTip)
+	}()
+	symbols := []string{runningTip + ".", runningTip + "..", runningTip + "...", runningTip + "....", runningTip + ".....", runningTip + "......"}
+	index := 0
+	fmt.Printf("\r%s", symbols[index])
+	for {
+		select {
+		case <-ctx.Done():
+			return
+		case <-time.After(500 * time.Millisecond):
+			index++
+			if index >= len(symbols) {
+				index = 0
+				clearCurrentLine()
+			}
+			fmt.Printf("\r%s", symbols[index])
+		}
+	}
+}

cmd/sponge/commands/init.go

@@ -1,8 +1,6 @@
 package commands
 
 import (
-	"fmt"
-
 	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 )
@@ -20,8 +18,6 @@ func InitCommand() *cobra.Command {
 		SilenceErrors: true,
 		SilenceUsage:  true,
 		RunE: func(cmd *cobra.Command, args []string) error {
-			fmt.Println("initializing sponge, please wait a moment ......")
-
 			targetVersion := latestVersion
 			// download sponge template code
 			_, err := runUpgrade(targetVersion)

cmd/sponge/commands/plugins.go

@@ -115,31 +115,31 @@ func showDependencyPlugins(installedNames []string, lackNames []string) {
 	var content string
 
 	if len(installedNames) > 0 {
-		content = "Installed dependency plugins:\n"
+		content = "installed dependency plugins:\n"
 		for _, name := range installedNames {
 			content += "    " + installedSymbol + " " + name + "\n"
 		}
 	}
 
 	if len(lackNames) > 0 {
-		content += "\nUninstalled dependency plugins:\n"
+		content += "\nuninstalled dependency plugins:\n"
 		for _, name := range lackNames {
 			content += "    " + lackSymbol + " " + name + "\n"
 		}
-		content += "\nInstalling dependency plugins using the command: sponge plugins --install\n"
+		content += "\ninstalling dependency plugins using the command: sponge plugins --install\n"
 	} else {
-		content += "\nAll dependency plugins installed.\n"
+		content += "\nall dependency plugins installed.\n"
 	}
 
 	fmt.Println(content)
 }
 
 func installPlugins(lackNames []string) {
 	if len(lackNames) == 0 {
-		fmt.Printf("\n    All dependency plugins installed.\n\n")
+		fmt.Printf("\n    all dependency plugins installed.\n\n")
 		return
 	}
-	fmt.Printf("install a total of %d dependency plugins, need to wait a little time.\n\n", len(lackNames))
+	fmt.Printf("\ninstalling %d dependency plugins, please wait a moment.\n\n", len(lackNames))
 
 	var wg = &sync.WaitGroup{}
 	var manuallyNames []string

cmd/sponge/commands/upgrade.go

@@ -32,7 +32,6 @@ func UpgradeCommand() *cobra.Command {
 		SilenceErrors: true,
 		SilenceUsage:  true,
 		RunE: func(cmd *cobra.Command, args []string) error {
-			fmt.Println("upgrading sponge, please wait a moment ......")
 			if targetVersion == "" {
 				targetVersion = latestVersion
 			}
@@ -50,24 +49,41 @@ func UpgradeCommand() *cobra.Command {
 }
 
 func runUpgrade(targetVersion string) (string, error) {
+	runningTip := "upgrading sponge binary "
+	finishTip := "upgrade sponge binary done " + installedSymbol
+	failTip := "upgrade sponge binary failed " + lackSymbol
+	p := utils.NewWaitPrinter(time.Millisecond * 500)
+	p.LoopPrint(runningTip)
 	err := runUpgradeCommand(targetVersion)
 	if err != nil {
-		fmt.Println(lackSymbol + "upgrade sponge binary.")
+		p.StopPrint(failTip)
 		return "", err
 	}
-	fmt.Println(installedSymbol + "upgraded sponge binary.")
+	p.StopPrint(finishTip)
+
+	runningTip = "upgrading template code "
+	finishTip = "upgrade template code done " + installedSymbol
+	failTip = "upgrade template code failed " + lackSymbol
+	p = utils.NewWaitPrinter(time.Millisecond * 500)
+	p.LoopPrint(runningTip)
 	ver, err := copyToTempDir(targetVersion)
 	if err != nil {
-		fmt.Println(lackSymbol + "upgrade template code.")
+		p.StopPrint(failTip)
 		return "", err
 	}
-	fmt.Println(installedSymbol + "upgraded template code.")
+	p.StopPrint(finishTip)
+
+	runningTip = "upgrading the built-in plugins of sponge "
+	finishTip = "upgrade the built-in plugins of sponge done " + installedSymbol
+	failTip = "upgrade the built-in plugins of sponge failed " + lackSymbol
+	p = utils.NewWaitPrinter(time.Millisecond * 500)
+	p.LoopPrint(runningTip)
 	err = updateSpongeInternalPlugin(ver)
 	if err != nil {
-		fmt.Println(lackSymbol + "upgrade protoc plugins.")
+		p.StopPrint(failTip)
 		return "", err
 	}
-	fmt.Println(installedSymbol + "upgraded protoc plugins.")
+	p.StopPrint(finishTip)
 	return ver, nil
 }
 

pkg/utils/wait_print.go

@@ -0,0 +1,79 @@
+package utils
+
+import (
+	"context"
+	"fmt"
+	"time"
+)
+
+// WaitPrinter is a waiting printer.
+type WaitPrinter struct {
+	ctx            context.Context
+	cancel         context.CancelFunc
+	printFrequency time.Duration
+}
+
+// NewWaitPrinter create a new WaitPrinter instance.
+func NewWaitPrinter(interval time.Duration) *WaitPrinter {
+	ctx, cancel := context.WithCancel(context.Background())
+	if interval < time.Millisecond*100 || interval > time.Second*5 {
+		interval = time.Millisecond * 500
+	}
+	return &WaitPrinter{
+		ctx:            ctx,
+		cancel:         cancel,
+		printFrequency: interval,
+	}
+}
+
+// LoopPrint start the waiting loop and print the running tip message.
+func (p *WaitPrinter) LoopPrint(runningTip string) {
+	if p == nil {
+		return
+	}
+	go func() {
+		symbols := []string{runningTip + ".", runningTip + "..", runningTip +
+			"...", runningTip + "....", runningTip + ".....", runningTip + "......"}
+		index := 0
+		fmt.Printf("\r%s", symbols[index])
+
+		ticker := time.NewTicker(p.printFrequency)
+		defer ticker.Stop()
+
+		for {
+			select {
+			case <-p.ctx.Done():
+				return
+			case <-ticker.C:
+				index++
+				if index >= len(symbols) {
+					index = 0
+					p.clearCurrentLine()
+				}
+				fmt.Printf("\r%s", symbols[index])
+			}
+		}
+	}()
+}
+
+// StopPrint stop the waiting loop and print the tip message.
+func (p *WaitPrinter) StopPrint(tip string) {
+	if p == nil {
+		return
+	}
+
+	defer func() {
+		recover()
+	}()
+
+	p.cancel()
+	p.clearCurrentLine()
+	if tip == "" {
+		return
+	}
+	fmt.Println(tip)
+}
+
+func (p *WaitPrinter) clearCurrentLine() {
+	fmt.Print("\033[2K\r")
+}

pkg/utils/wait_print_test.go

@@ -0,0 +1,23 @@
+package utils
+
+import (
+	"testing"
+	"time"
+)
+
+func TestLoopPrint(t *testing.T) {
+	runningTip := "upgrading sponge binary "
+	finishTip := "upgrade sponge binary successfully"
+	failedTip := "failed to upgrade sponge binary "
+
+	p := NewWaitPrinter(time.Millisecond * 100)
+	p.LoopPrint(runningTip)
+	time.Sleep(time.Millisecond * 1000)
+	p.StopPrint(finishTip)
+
+	p = NewWaitPrinter(0)
+	p.LoopPrint(runningTip)
+	time.Sleep(time.Millisecond * 1100)
+	p.StopPrint(failedTip)
+	time.Sleep(time.Millisecond * 100)
+}