feat: add/improve spinner for build and deploy (#322)

This commit modifies the progress meter so that, by default there is no
step counter. It also modifies the responsibility for calling `Done()`,
making it the job of the command rather than the client. This is because
the client does not know how many commands will be executed and therefore
cannot know when the progress bar is done.

This commit also adds String() to the progress bar, and moves logging
responsibility out of the deployer itself and fully into the client.
Deployer#Deploy() now returns a DeploymentResult.

Fixes: #296

Signed-off-by: Lance Ball <lball@redhat.com>

Author: lance

buildpacks/builder.go

@@ -88,8 +88,11 @@ func (builder *Builder) Build(ctx context.Context, f bosonFunc.Function) (err er
 
 	// Build based using the given builder.
 	if err = packClient.Build(ctx, packOpts); err != nil {
-		// If the builder was not showing logs, embed the full logs in the error.
-		if !builder.Verbose {
+		if ctx.Err() != nil {
+			// received SIGINT
+			return
+		} else if !builder.Verbose {
+			// If the builder was not showing logs, embed the full logs in the error.
 			err = fmt.Errorf("%v\noutput: %s\n", err, logWriter.(*bytes.Buffer).String())
 		}
 	}

client.go

@@ -50,10 +50,23 @@ type Pusher interface {
 	Push(ctx context.Context, f Function) (string, error)
 }
 
+type Status int
+
+const (
+	Failed Status = iota
+	Deployed
+	Updated
+)
+
+type DeploymentResult struct {
+	Status Status
+	URL    string
+}
+
 // Deployer of Function source to running status.
 type Deployer interface {
 	// Deploy a Function of given name, using given backing image.
-	Deploy(context.Context, Function) error
+	Deploy(context.Context, Function) (DeploymentResult, error)
 }
 
 // Runner runs the Function locally.
@@ -370,8 +383,7 @@ func (c *Client) Create(cfg Function) (err error) {
 // Build the Function at path.  Errors if the Function is either unloadable or does
 // not contain a populated Image.
 func (c *Client) Build(ctx context.Context, path string) (err error) {
-
-	fmt.Println("Building function image")
+	c.progressListener.Increment("Building function image")
 
 	f, err := NewFunction(path)
 	if err != nil {
@@ -395,7 +407,8 @@ func (c *Client) Build(ctx context.Context, path string) (err error) {
 
 	// TODO: create a statu structure and return it here for optional
 	// use by the cli for user echo (rather than rely on verbose mode here)
-	fmt.Printf("Function image has been built, image: %v\n", f.Image)
+	message := fmt.Sprintf("🙌 Function image built: %v", f.Image)
+	c.progressListener.Increment(message)
 
 	return
 }
@@ -415,7 +428,7 @@ func (c *Client) Deploy(ctx context.Context, path string) (err error) {
 	}
 
 	// Push the image for the named service to the configured registry
-	fmt.Println("Pushing function image to the registry")
+	c.progressListener.Increment("Pushing function image to the registry")
 	imageDigest, err := c.pusher.Push(ctx, f)
 	if err != nil {
 		return
@@ -428,8 +441,15 @@ func (c *Client) Deploy(ctx context.Context, path string) (err error) {
 	}
 
 	// Deploy a new or Update the previously-deployed Function
-	fmt.Println("Deploying function to the cluster")
-	return c.deployer.Deploy(ctx, f)
+	c.progressListener.Increment("Deploying function to the cluster")
+	result, err := c.deployer.Deploy(ctx, f)
+	if result.Status == Deployed {
+		c.progressListener.Increment(fmt.Sprintf("Function deployed at URL: %v", result.URL))
+	} else if result.Status == Updated {
+		c.progressListener.Increment(fmt.Sprintf("Function updated at URL: %v", result.URL))
+	}
+
+	return err
 }
 
 func (c *Client) Route(path string) (err error) {
@@ -527,7 +547,9 @@ func (n *noopPusher) Push(ctx context.Context, f Function) (string, error) { ret
 
 type noopDeployer struct{ output io.Writer }
 
-func (n *noopDeployer) Deploy(ctx context.Context, _ Function) error { return nil }
+func (n *noopDeployer) Deploy(ctx context.Context, _ Function) (DeploymentResult, error) {
+	return DeploymentResult{}, nil
+}
 
 type noopRunner struct{ output io.Writer }
 

cmd/build.go

@@ -8,6 +8,7 @@ import (
 
 	bosonFunc "github.com/boson-project/func"
 	"github.com/boson-project/func/buildpacks"
+	"github.com/boson-project/func/progress"
 	"github.com/boson-project/func/prompt"
 )
 
@@ -95,12 +96,23 @@ func runBuild(cmd *cobra.Command, _ []string) (err error) {
 	builder := buildpacks.NewBuilder()
 	builder.Verbose = config.Verbose
 
+	listener := progress.New()
+	listener.Verbose = config.Verbose
+	defer listener.Done()
+
+	context := cmd.Context()
+	go func() {
+		<-context.Done()
+		listener.Done()
+	}()
+
 	client := bosonFunc.New(
 		bosonFunc.WithVerbose(config.Verbose),
 		bosonFunc.WithRegistry(config.Registry), // for deriving image name when --image not provided explicitly.
-		bosonFunc.WithBuilder(builder))
+		bosonFunc.WithBuilder(builder),
+		bosonFunc.WithProgressListener(listener))
 
-	return client.Build(cmd.Context(), config.Path)
+	return client.Build(context, config.Path)
 }
 
 type buildConfig struct {

cmd/deploy.go

@@ -121,8 +121,16 @@ func runDeploy(cmd *cobra.Command, _ []string) (err error) {
 	}
 
 	listener := progress.New()
+	defer listener.Done()
 
 	deployer.Verbose = config.Verbose
+	listener.Verbose = config.Verbose
+
+	context := cmd.Context()
+	go func() {
+		<-context.Done()
+		listener.Done()
+	}()
 
 	client := bosonFunc.New(
 		bosonFunc.WithVerbose(config.Verbose),
@@ -133,12 +141,12 @@ func runDeploy(cmd *cobra.Command, _ []string) (err error) {
 		bosonFunc.WithProgressListener(listener))
 
 	if config.Build {
-		if err := client.Build(cmd.Context(), config.Path); err != nil {
+		if err := client.Build(context, config.Path); err != nil {
 			return err
 		}
 	}
 
-	return client.Deploy(cmd.Context(), config.Path)
+	return client.Deploy(context, config.Path)
 
 	// NOTE: Namespace is optional, default is that used by k8s client
 	// (for example kubectl usually uses ~/.kube/config)

cmd/root.go

@@ -7,8 +7,6 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/pkg/errors"
-
 	"github.com/mitchellh/go-homedir"
 	"github.com/ory/viper"
 	"github.com/spf13/cobra"
@@ -79,7 +77,7 @@ func Execute(ctx context.Context) {
 	root.Version = version.String()
 	// Execute the root of the command tree.
 	if err := root.ExecuteContext(ctx); err != nil {
-		if errors.Cause(err) == context.Canceled {
+		if ctx.Err() != nil {
 			os.Exit(130)
 			return
 		}

knative/deployer.go

@@ -16,7 +16,7 @@ import (
 	servingv1 "knative.dev/serving/pkg/apis/serving/v1"
 	v1 "knative.dev/serving/pkg/apis/serving/v1"
 
-	bosonFunc "github.com/boson-project/func"
+	fn "github.com/boson-project/func"
 )
 
 type Deployer struct {
@@ -37,30 +37,26 @@ func NewDeployer(namespaceOverride string) (deployer *Deployer, err error) {
 	return
 }
 
-func (d *Deployer) Deploy(ctx context.Context, f bosonFunc.Function) (err error) {
+func (d *Deployer) Deploy(ctx context.Context, f fn.Function) (result fn.DeploymentResult, err error) {
 
 	client, err := NewServingClient(d.Namespace)
 	if err != nil {
-		return
+		return fn.DeploymentResult{}, err
 	}
 
 	_, err = client.GetService(f.Name)
 	if err != nil {
 		if errors.IsNotFound(err) {
 
-			// Let's create a new Service
-			if d.Verbose {
-				fmt.Printf("Creating Knative Service: %v\n", f.Name)
-			}
 			service, err := generateNewService(f.Name, f.ImageWithDigest(), f.Runtime, f.Env, f.Annotations)
 			if err != nil {
 				err = fmt.Errorf("knative deployer failed to generate the service: %v", err)
-				return err
+				return fn.DeploymentResult{}, err
 			}
 			err = client.CreateService(service)
 			if err != nil {
 				err = fmt.Errorf("knative deployer failed to deploy the service: %v", err)
-				return err
+				return fn.DeploymentResult{}, err
 			}
 
 			if d.Verbose {
@@ -69,39 +65,45 @@ func (d *Deployer) Deploy(ctx context.Context, f bosonFunc.Function) (err error)
 			err, _ = client.WaitForService(f.Name, DefaultWaitingTimeout, wait.NoopMessageCallback())
 			if err != nil {
 				err = fmt.Errorf("knative deployer failed to wait for the service to become ready: %v", err)
-				return err
+				return fn.DeploymentResult{}, err
 			}
 
 			route, err := client.GetRoute(f.Name)
 			if err != nil {
 				err = fmt.Errorf("knative deployer failed to get the route: %v", err)
-				return err
+				return fn.DeploymentResult{}, err
 			}
 
 			fmt.Println("Function deployed at URL: " + route.Status.URL.String())
+			return fn.DeploymentResult{
+				Status: fn.Deployed,
+				URL:    route.Status.URL.String(),
+			}, nil
+			// fmt.Sprintf("Function deployed at URL: %v", route.Status.URL.String()), nil
 
 		} else {
 			err = fmt.Errorf("knative deployer failed to get the service: %v", err)
-			return err
+			return fn.DeploymentResult{}, err
 		}
 	} else {
 		// Update the existing Service
 		err = client.UpdateServiceWithRetry(f.Name, updateService(f.ImageWithDigest(), f.Env, f.Annotations), 3)
 		if err != nil {
 			err = fmt.Errorf("knative deployer failed to update the service: %v", err)
-			return err
+			return fn.DeploymentResult{}, err
 		}
 
 		route, err := client.GetRoute(f.Name)
 		if err != nil {
 			err = fmt.Errorf("knative deployer failed to get the route: %v", err)
-			return err
+			return fn.DeploymentResult{}, err
 		}
 
-		fmt.Println("Function updated at URL: " + route.Status.URL.String())
+		return fn.DeploymentResult{
+			Status: fn.Updated,
+			URL:    route.Status.URL.String(),
+		}, nil
 	}
-
-	return nil
 }
 
 func probeFor(url string) *corev1.Probe {

mock/deployer.go

@@ -2,6 +2,7 @@ package mock
 
 import (
 	"context"
+
 	bosonFunc "github.com/boson-project/func"
 )
 
@@ -16,7 +17,7 @@ func NewDeployer() *Deployer {
 	}
 }
 
-func (i *Deployer) Deploy(ctx context.Context, f bosonFunc.Function) error {
+func (i *Deployer) Deploy(ctx context.Context, f bosonFunc.Function) (bosonFunc.DeploymentResult, error) {
 	i.DeployInvoked = true
-	return i.DeployFn(f)
+	return bosonFunc.DeploymentResult{}, i.DeployFn(f)
 }