fix: change session to use the same spinner reference (ignite#2943)

* fix: change session to use the same spinner referece * chore: update changelog Co-authored-by: Alex Johnson <[email protected]>
p0mvn · Oct 19, 2022 · 58725ab · 58725ab
1 parent d2b8344
commit 58725ab
Show file tree

Hide file tree

Showing 13 changed files with 29 additions and 24 deletions.
diff --git a/changelog.md b/changelog.md
@@ -39,6 +39,7 @@
 - Fix config file migration to void leaving end of file content chunks
 - Change session print loop to block until all events are handled.
 - Handle "No records were found in keyring" message when checking keys.
+- [#2941](https://github.com/ignite/cli/issues/2941) Fix session to use the same spinner referece.
 - [#2922](https://github.com/ignite/cli/pull/2922) Network commands check for latest config version before building the chain binary.
 
 ## [`v0.24.1`](https://github.com/ignite/cli/releases/tag/v0.24.1)

diff --git a/ignite/cmd/cmd.go b/ignite/cmd/cmd.go
@@ -303,7 +303,7 @@ https://docs.ignite.com/migration`, sc.Version.String(),
 	return sc, nil
 }
 
-func printSection(session cliui.Session, title string) error {
+func printSection(session *cliui.Session, title string) error {
 	return session.Printf("------\n%s\n------\n\n", title)
 }
 

diff --git a/ignite/cmd/network_campaign_list.go b/ignite/cmd/network_campaign_list.go
@@ -51,7 +51,7 @@ func networkCampaignListHandler(cmd *cobra.Command, _ []string) error {
 }
 
 // renderCampaignSummaries writes into the provided out, the list of summarized campaigns
-func renderCampaignSummaries(campaigns []networktypes.Campaign, session cliui.Session) error {
+func renderCampaignSummaries(campaigns []networktypes.Campaign, session *cliui.Session) error {
 	var campaignEntries [][]string
 
 	for _, c := range campaigns {

diff --git a/ignite/cmd/network_chain_init.go b/ignite/cmd/network_chain_init.go
@@ -157,7 +157,7 @@ func networkChainInitHandler(cmd *cobra.Command, args []string) error {
 }
 
 // askValidatorInfo prompts to the user questions to query validator information
-func askValidatorInfo(cmd *cobra.Command, session cliui.Session, stakeDenom string) (chain.Validator, error) {
+func askValidatorInfo(cmd *cobra.Command, session *cliui.Session, stakeDenom string) (chain.Validator, error) {
 	var (
 		account, _         = cmd.Flags().GetString(flagValidatorAccount)
 		website, _         = cmd.Flags().GetString(flagValidatorWebsite)

diff --git a/ignite/cmd/network_chain_join.go b/ignite/cmd/network_chain_join.go
@@ -162,7 +162,7 @@ func networkChainJoinHandler(cmd *cobra.Command, args []string) error {
 
 // askPublicAddress prepare questions to interactively ask for a publicAddress
 // when peer isn't provided and not running through chisel proxy.
-func askPublicAddress(cmd *cobra.Command, session cliui.Session) (publicAddress string, err error) {
+func askPublicAddress(cmd *cobra.Command, session *cliui.Session) (publicAddress string, err error) {
 	ctx := cmd.Context()
 
 	if gitpod.IsOnGitpod() {

diff --git a/ignite/cmd/network_chain_list.go b/ignite/cmd/network_chain_list.go
@@ -77,7 +77,7 @@ func networkChainListHandler(cmd *cobra.Command, _ []string) error {
 }
 
 // renderLaunchSummaries writes into the provided out, the list of summarized launches
-func renderLaunchSummaries(chainLaunches []networktypes.ChainLaunch, session cliui.Session, advanced bool) error {
+func renderLaunchSummaries(chainLaunches []networktypes.ChainLaunch, session *cliui.Session, advanced bool) error {
 	header := LaunchSummaryHeader
 	if advanced {
 		// advanced information show the campaign ID, type of network and rewards for incentivized testnet

diff --git a/ignite/cmd/network_chain_show.go b/ignite/cmd/network_chain_show.go
@@ -26,7 +26,7 @@ func NewNetworkChainShow() *cobra.Command {
 	return c
 }
 
-func networkChainLaunch(cmd *cobra.Command, args []string, session cliui.Session) (NetworkBuilder, uint64, error) {
+func networkChainLaunch(cmd *cobra.Command, args []string, session *cliui.Session) (NetworkBuilder, uint64, error) {
 	nb, err := newNetworkBuilder(cmd, CollectEvents(session.EventBus()))
 	if err != nil {
 		return nb, 0, err

diff --git a/ignite/cmd/network_request_list.go b/ignite/cmd/network_request_list.go
@@ -62,7 +62,7 @@ func networkRequestListHandler(cmd *cobra.Command, args []string) error {
 // renderRequestSummaries writes into the provided out, the list of summarized requests
 func renderRequestSummaries(
 	requests []networktypes.Request,
-	session cliui.Session,
+	session *cliui.Session,
 	addressPrefix string,
 ) error {
 	requestEntries := make([][]string, 0)

diff --git a/ignite/cmd/network_reward_release.go b/ignite/cmd/network_reward_release.go
@@ -203,7 +203,7 @@ func networkRewardRelease(cmd *cobra.Command, args []string) (err error) {
 func createClient(
 	cmd *cobra.Command,
 	n network.Network,
-	session cliui.Session,
+	session *cliui.Session,
 	launchID uint64,
 	nodeAPI,
 	spnChainID string,
@@ -254,7 +254,7 @@ func createClient(
 	return chainRelayer, spnRelayer, err
 }
 
-func printRelayerOptions(session cliui.Session, obj, chainID, option string) {
+func printRelayerOptions(session *cliui.Session, obj, chainID, option string) {
 	if obj != "" {
 		session.Printf("%s The chain %s already have a %s: %s\n",
 			icons.Bullet,

diff --git a/ignite/cmd/relayer_configure.go b/ignite/cmd/relayer_configure.go
@@ -459,7 +459,7 @@ func relayerConfigureHandler(cmd *cobra.Command, _ []string) (err error) {
 func initChain(
 	cmd *cobra.Command,
 	r relayer.Relayer,
-	session cliui.Session,
+	session *cliui.Session,
 	name,
 	accountName,
 	rpcAddr,

diff --git a/ignite/cmd/scaffold.go b/ignite/cmd/scaffold.go
@@ -181,7 +181,7 @@ func gitChangesConfirmPreRunHandler(cmd *cobra.Command, args []string) error {
 	return confirmWhenUncommittedChanges(session, appPath)
 }
 
-func confirmWhenUncommittedChanges(session cliui.Session, appPath string) error {
+func confirmWhenUncommittedChanges(session *cliui.Session, appPath string) error {
 	cleanState, err := xgit.AreChangesCommitted(appPath)
 	if err != nil {
 		return err

diff --git a/ignite/pkg/cliui/clispinner/clispinner.go b/ignite/pkg/cliui/clispinner/clispinner.go
@@ -7,6 +7,9 @@ import (
 	"github.com/briandowns/spinner"
 )
 
+// DefaultText defines the default spinner text.
+const DefaultText = "Initializing..."
+
 var (
 	refreshRate  = time.Millisecond * 200
 	charset      = spinner.CharSets[4]
@@ -39,17 +42,18 @@ func New(options ...Option) *Spinner {
 		apply(&o)
 	}
 
-	underlyingSpinnerOptions := []spinner.Option{spinner.WithColor(spinnerColor)}
-	if o.writer != nil {
-		underlyingSpinnerOptions = append(underlyingSpinnerOptions, spinner.WithWriter(o.writer))
+	spOptions := []spinner.Option{
+		spinner.WithColor(spinnerColor),
+		spinner.WithSuffix(" " + DefaultText),
 	}
 
-	sp := spinner.New(charset, refreshRate, underlyingSpinnerOptions...)
+	if o.writer != nil {
+		spOptions = append(spOptions, spinner.WithWriter(o.writer))
+	}
 
-	s := &Spinner{
-		sp: sp,
+	return &Spinner{
+		sp: spinner.New(charset, refreshRate, spOptions...),
 	}
-	return s.SetText("Initializing...")
 }
 
 // SetText sets the text for spinner.

diff --git a/ignite/pkg/cliui/cliui.go b/ignite/pkg/cliui/cliui.go
@@ -72,7 +72,7 @@ func StartSpinner() Option {
 }
 
 // New creates a new Session.
-func New(options ...Option) Session {
+func New(options ...Option) *Session {
 	session := Session{
 		ev: events.NewBus(),
 		wg: &sync.WaitGroup{},
@@ -105,9 +105,9 @@ func New(options ...Option) Session {
 	// The main loop that prints the events uses a wait group to block
 	// the session end until all the events are printed.
 	session.wg.Add(1)
-	go session.handleEvents(session.wg)
+	go session.handleEvents()
 
-	return session
+	return &session
 }
 
 // EventBus returns the event bus of the session.
@@ -138,7 +138,7 @@ func (s Session) NewOutput(label string, color uint8) uilog.Output {
 }
 
 // StartSpinner starts the spinner.
-func (s Session) StartSpinner(text string) {
+func (s *Session) StartSpinner(text string) {
 	if s.spinner == nil {
 		s.spinner = clispinner.New(clispinner.WithWriter(s.out.Stdout()))
 	}
@@ -224,8 +224,8 @@ func (s Session) End() {
 	s.wg.Wait()
 }
 
-func (s Session) handleEvents(wg *sync.WaitGroup) {
-	defer wg.Done()
+func (s *Session) handleEvents() {
+	defer s.wg.Done()
 
 	stdout := s.out.Stdout()