Merge pull request #29078 from vbotbuildovich/backport-pr-29060-v25.3.x-930

[v25.3.x] [UX-755] rpk: add spinner for long-running operations

Author: r-vasquez

MODULE.bazel

@@ -258,6 +258,7 @@ use_repo(
     "com_github_avast_retry_go",
     "com_github_aws_aws_sdk_go",
     "com_github_beevik_ntp",
+    "com_github_briandowns_spinner",
     "com_github_bufbuild_protocompile",
     "com_github_cespare_xxhash",
     "com_github_containerd_errdefs",

src/go/rpk/go.mod

@@ -20,6 +20,7 @@ require (
 	github.com/avast/retry-go v3.0.0+incompatible
 	github.com/aws/aws-sdk-go v1.55.6
 	github.com/beevik/ntp v1.5.0
+	github.com/briandowns/spinner v1.23.2
 	github.com/bufbuild/protocompile v0.14.1
 	github.com/cespare/xxhash v1.1.0
 	github.com/containerd/errdefs v1.0.0

src/go/rpk/go.sum

@@ -44,6 +44,8 @@ github.com/bahlo/generic-list-go v0.2.0 h1:5sz/EEAK+ls5wF+NeqDpk5+iNdMDXrh3z3nPn
 github.com/bahlo/generic-list-go v0.2.0/go.mod h1:2KvAjgMlE5NNynlg/5iLrrCCZ2+5xWbdbCW3pNTGyYg=
 github.com/beevik/ntp v1.5.0 h1:y+uj/JjNwlY2JahivxYvtmv4ehfi3h74fAuABB9ZSM4=
 github.com/beevik/ntp v1.5.0/go.mod h1:mJEhBrwT76w9D+IfOEGvuzyuudiW9E52U2BaTrMOYow=
+github.com/briandowns/spinner v1.23.2 h1:Zc6ecUnI+YzLmJniCfDNaMbW0Wid1d5+qcTq4L2FW8w=
+github.com/briandowns/spinner v1.23.2/go.mod h1:LaZeM4wm2Ywy6vO571mvhQNRcWfRUnXOs0RcKV0wYKM=
 github.com/bufbuild/protocompile v0.14.1 h1:iA73zAf/fyljNjQKwYzUHD6AD4R8KMasmwa/FBatYVw=
 github.com/bufbuild/protocompile v0.14.1/go.mod h1:ppVdAIhbr2H8asPk6k4pY7t9zB1OU5DoEw9xY/FUi1c=
 github.com/buger/jsonparser v1.1.1 h1:2PnMjfWD7wBILjqQbt530v576A/cAbQvEW9gGIpYMUs=

src/go/rpk/pkg/cli/shadow/create.go

@@ -13,6 +13,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"os"
 	"strings"
 
 	"buf.build/gen/go/redpandadata/cloud/connectrpc/go/redpanda/api/controlplane/v1/controlplanev1connect"
@@ -86,7 +87,6 @@ Create a Shadow Link without confirmation prompt:
 					out.Exit("Shadow Link creation cancelled")
 				}
 			}
-			fmt.Println()
 
 			successMsgTmpl := "Successfully created shadow link %q with ID %q. To query the status, run:\n  'rpk shadow status %[1]v'"
 			if prof.CheckFromCloud() {
@@ -103,24 +103,31 @@ Create a Shadow Link without confirmation prompt:
 				}))
 				out.MaybeDie(err, "unable to create Shadow Link: %v", err)
 
+				spinner := out.NewSpinner(cmd.Context(), "Creating Shadow Link...", out.WithElapsedTime())
 				isComplete, err := waitForOperation(cmd.Context(), cloudClient, op.Msg.GetOperation().GetId())
 				if err != nil {
 					if oErr := new(OperationFailedError); errors.As(err, &oErr) {
-						out.Die(tryShadowLinkErrReason(cmd.Context(), cloudClient.ShadowLink, oErr))
+						spinner.Fail(tryShadowLinkErrReason(cmd.Context(), cloudClient.ShadowLink, oErr))
+						os.Exit(1)
 					}
-					out.Die("unable to confirm Shadow Link creation: %v", err)
+					spinner.Fail(fmt.Sprintf("unable to confirm Shadow Link creation: %v", err))
+					os.Exit(1)
 				}
 				if isComplete {
-					out.Exit(successMsgTmpl, slCfg.Name, op.Msg.GetOperation().GetResourceId())
+					spinner.Success(fmt.Sprintf(successMsgTmpl, slCfg.Name, op.Msg.GetOperation().GetResourceId()))
+					os.Exit(0)
 				}
+				spinner.Stop()
 				out.Exit("Shadow link creation is taking longer than expected. Please check the state of the shadow link using 'rpk shadow describe %v' and 'rpk shadow status %v'", slCfg.Name, slCfg.Name)
 			}
 			cl, err := adminapi.NewClient(cmd.Context(), fs, prof)
 			out.MaybeDie(err, "unable to initialize admin client: %v", err)
 
+			spinner := out.NewSpinner(cmd.Context(), "Creating Shadow Link...")
 			link, err := cl.ShadowLinkService().CreateShadowLink(cmd.Context(), connect.NewRequest(&adminv2.CreateShadowLinkRequest{
 				ShadowLink: shadowLinkConfigToProto(slCfg),
 			}))
+			spinner.Stop()
 			out.MaybeDie(err, "unable to create shadow link: %v", handleConnectError(err, "create", slCfg.Name))
 
 			out.Exit(successMsgTmpl, link.Msg.GetShadowLink().GetName(), link.Msg.GetShadowLink().GetUid())

src/go/rpk/pkg/cli/shadow/delete.go

@@ -11,6 +11,7 @@ package shadow
 
 import (
 	"fmt"
+	"os"
 	"strings"
 
 	controlplanev1 "buf.build/gen/go/redpandadata/cloud/protocolbuffers/go/redpanda/api/controlplane/v1"
@@ -100,28 +101,35 @@ Force delete a Shadow Link with active shadow topics:
 				}))
 				out.MaybeDie(err, "unable to delete Shadow Link: %v", err)
 
+				spinner := out.NewSpinner(cmd.Context(), "Deleting Shadow Link...", out.WithElapsedTime())
 				isComplete, err := waitForOperation(cmd.Context(), cloudClient, op.Msg.GetOperation().GetId())
-				out.MaybeDie(err, "unable to confirm Shadow Link deletion: %v", err)
+				if err != nil {
+					spinner.Fail(fmt.Sprintf("unable to confirm Shadow Link deletion: %v", err))
+					os.Exit(1)
+				}
 				if !isComplete {
+					spinner.Stop()
 					out.Exit("Shadow link deletion is taking longer than expected. Please check the status of the shadow link using 'rpk shadow status %q'", linkName)
 				}
-			} else {
-				cl, err := adminapi.NewClient(cmd.Context(), fs, prof)
-				out.MaybeDie(err, "unable to initialize admin client: %v", err)
-
-				link, err := cl.ShadowLinkService().GetShadowLink(cmd.Context(), connect.NewRequest(&adminv2.GetShadowLinkRequest{
-					Name: linkName,
-				}))
-				out.MaybeDie(err, "unable to get Redpanda Shadow Link information: %v", handleConnectError(err, "get", linkName))
-				printShadowLinkInfo(link.Msg.GetShadowLink())
-				promptConfirm(false)
-
-				_, err = cl.ShadowLinkService().DeleteShadowLink(cmd.Context(), connect.NewRequest(&adminv2.DeleteShadowLinkRequest{
-					Name:  linkName,
-					Force: forceDelete,
-				}))
-				out.MaybeDie(err, "unable to delete Redpanda Shadow Link %q: %v", linkName, handleConnectError(err, "delete", linkName))
+				spinner.Success(fmt.Sprintf("Shadow Link %q deleted successfully", linkName))
+				os.Exit(0)
 			}
+			// Self-hosted path
+			cl, err := adminapi.NewClient(cmd.Context(), fs, prof)
+			out.MaybeDie(err, "unable to initialize admin client: %v", err)
+
+			link, err := cl.ShadowLinkService().GetShadowLink(cmd.Context(), connect.NewRequest(&adminv2.GetShadowLinkRequest{
+				Name: linkName,
+			}))
+			out.MaybeDie(err, "unable to get Redpanda Shadow Link information: %v", handleConnectError(err, "get", linkName))
+			printShadowLinkInfo(link.Msg.GetShadowLink())
+			promptConfirm(false)
+
+			_, err = cl.ShadowLinkService().DeleteShadowLink(cmd.Context(), connect.NewRequest(&adminv2.DeleteShadowLinkRequest{
+				Name:  linkName,
+				Force: forceDelete,
+			}))
+			out.MaybeDie(err, "unable to delete Redpanda Shadow Link %q: %v", linkName, handleConnectError(err, "delete", linkName))
 
 			fmt.Printf("Shadow Link %q deleted successfully\n", linkName)
 		},

src/go/rpk/pkg/cli/shadow/update.go

@@ -11,6 +11,7 @@ package shadow
 
 import (
 	"fmt"
+	"os"
 	"reflect"
 	"strings"
 
@@ -142,23 +143,30 @@ Update a Shadow Link configuration:
 					UpdateMask: fm,
 				}))
 				out.MaybeDie(err, "unable to update Shadow Link: %v", handleConnectError(err, "update", linkName))
+				spinner := out.NewSpinner(cmd.Context(), "Updating Shadow Link...")
 				isComplete, err := waitForOperation(cmd.Context(), cloudClient, op.Msg.GetOperation().GetId())
-				out.MaybeDie(err, "unable to confirm Shadow Link update: %v", err)
+				if err != nil {
+					spinner.Fail(fmt.Sprintf("unable to confirm Shadow Link update: %v", err))
+					os.Exit(1)
+				}
 				if !isComplete {
+					spinner.Stop()
 					out.Exit("Shadow link update is taking longer than expected. Please check the status of the shadow link using 'rpk shadow status %q'", linkName)
 				}
-			} else {
-				updatedSL := shadowLinkConfigToProto(updatedCfg)
-				fm, err := fieldmaskpb.New(updatedSL, diff...)
-				out.MaybeDie(err, "unrecognized changed fields: %v; please report this with Redpanda Support", err)
-
-				zap.L().Sugar().Debugf("Requesting configuration update for: %v", strings.Join(diff, ", "))
-				_, err = adminClient.ShadowLinkService().UpdateShadowLink(cmd.Context(), connect.NewRequest(&adminv2.UpdateShadowLinkRequest{
-					ShadowLink: updatedSL,
-					UpdateMask: fm,
-				}))
-				out.MaybeDie(err, "unable to update Shadow Link: %v", handleConnectError(err, "update", linkName))
+				spinner.Success(fmt.Sprintf("Successfully updated shadow link %q", linkName))
+				os.Exit(0)
 			}
+			// Self-hosted path
+			updatedSL := shadowLinkConfigToProto(updatedCfg)
+			fm, err := fieldmaskpb.New(updatedSL, diff...)
+			out.MaybeDie(err, "unrecognized changed fields: %v; please report this with Redpanda Support", err)
+
+			zap.L().Sugar().Debugf("Requesting configuration update for: %v", strings.Join(diff, ", "))
+			_, err = adminClient.ShadowLinkService().UpdateShadowLink(cmd.Context(), connect.NewRequest(&adminv2.UpdateShadowLinkRequest{
+				ShadowLink: updatedSL,
+				UpdateMask: fm,
+			}))
+			out.MaybeDie(err, "unable to update Shadow Link: %v", handleConnectError(err, "update", linkName))
 			fmt.Printf("Successfully updated shadow link %q.\n", linkName)
 		},
 	}

src/go/rpk/pkg/out/BUILD

@@ -6,12 +6,15 @@ go_library(
         "color.go",
         "in.go",
         "out.go",
+        "spinner.go",
     ],
     importpath = "github.com/redpanda-data/redpanda/src/go/rpk/pkg/out",
     visibility = ["//visibility:public"],
     deps = [
         "@com_github_alecaivazis_survey_v2//:survey",
+        "@com_github_briandowns_spinner//:spinner",
         "@com_github_fatih_color//:color",
+        "@com_github_mattn_go_isatty//:go-isatty",
         "@com_github_spf13_afero//:afero",
         "@com_github_twmb_franz_go_pkg_kadm//:kadm",
         "@in_gopkg_yaml_v3//:yaml_v3",
@@ -24,6 +27,7 @@ go_test(
     srcs = [
         "in_test.go",
         "out_test.go",
+        "spinner_test.go",
     ],
     embed = [":out"],
     deps = [