progress: solve status description

crazy-max · crazy-max · commit 6b8fbed01e7b · 2023-02-13T15:55:01.000+01:00
Signed-off-by: CrazyMax &lt;crazy-max@users.noreply.github.com&gt;
diff --git a/examples/build-using-dockerfile/main.go b/examples/build-using-dockerfile/main.go
@@ -107,7 +107,7 @@ func action(clicontext *cli.Context) error {
 			c = cn
 		}
 		// not using shared context to not disrupt display but let is finish reporting errors
-		_, err = progressui.DisplaySolveStatus(context.TODO(), "", c, os.Stdout, ch)
+		_, err = progressui.DisplaySolveStatus(context.TODO(), c, os.Stdout, ch)
 		return err
 	})
 	eg.Go(func() error {
diff --git a/util/progress/progressui/display.go b/util/progress/progressui/display.go
@@ -21,11 +21,37 @@ import (
 	"golang.org/x/time/rate"
 )
 
-func DisplaySolveStatus(ctx context.Context, phase string, c console.Console, w io.Writer, ch chan *client.SolveStatus) ([]client.VertexWarning, error) {
+type displaySolveStatusOpts struct {
+	phase       string
+	textDesc    string
+	consoleDesc string
+}
+
+type DisplaySolveStatusOpt func(b *displaySolveStatusOpts)
+
+func WithPhase(phase string) DisplaySolveStatusOpt {
+	return func(b *displaySolveStatusOpts) {
+		b.phase = phase
+	}
+}
+
+func WithDesc(text string, console string) DisplaySolveStatusOpt {
+	return func(b *displaySolveStatusOpts) {
+		b.textDesc = text
+		b.consoleDesc = console
+	}
+}
+
+func DisplaySolveStatus(ctx context.Context, c console.Console, w io.Writer, ch chan *client.SolveStatus, opts ...DisplaySolveStatusOpt) ([]client.VertexWarning, error) {
 	modeConsole := c != nil
 
-	disp := &display{c: c, phase: phase}
-	printer := &textMux{w: w}
+	dsso := &displaySolveStatusOpts{}
+	for _, opt := range opts {
+		opt(dsso)
+	}
+
+	disp := &display{c: c, phase: dsso.phase, desc: dsso.consoleDesc}
+	printer := &textMux{w: w, desc: dsso.textDesc}
 
 	if disp.phase == "" {
 		disp.phase = "Building"
@@ -711,6 +737,7 @@ func addTime(tm *time.Time, d time.Duration) *time.Time {
 type display struct {
 	c         console.Console
 	phase     string
+	desc      string
 	lineCount int
 	repeated  bool
 }
@@ -784,7 +811,11 @@ func (disp *display) print(d displayInfo, width, height int, all bool) {
 	defer fmt.Fprint(disp.c, aec.Show)
 
 	out := fmt.Sprintf("[+] %s %.1fs (%d/%d) %s", disp.phase, time.Since(d.startTime).Seconds(), d.countCompleted, d.countTotal, statusStr)
-	out = align(out, "", width)
+	if disp.desc != "" {
+		out = align(out, disp.desc, width-1)
+	} else {
+		out = align(out, "", width)
+	}
 	fmt.Fprintln(disp.c, out)
 	lineCount := 0
 	for _, j := range d.jobs {
diff --git a/util/progress/progressui/printer.go b/util/progress/progressui/printer.go
@@ -32,6 +32,7 @@ type textMux struct {
 	last      map[string]lastStatus
 	notFirst  bool
 	nextIndex int
+	desc      string
 }
 
 func (p *textMux) printVtx(t *trace, dgst digest.Digest) {
@@ -63,6 +64,9 @@ func (p *textMux) printVtx(t *trace, dgst digest.Digest) {
 		if p.notFirst {
 			fmt.Fprintln(p.w, "")
 		} else {
+			if p.desc != "" {
+				fmt.Fprintf(p.w, "#0 %s\n\n", p.desc)
+			}
 			p.notFirst = true
 		}
 
diff --git a/util/progress/progresswriter/printer.go b/util/progress/progresswriter/printer.go
@@ -87,7 +87,7 @@ func NewPrinter(ctx context.Context, out console.File, mode string) (Writer, err
 
 	go func() {
 		// not using shared context to not disrupt display but let is finish reporting errors
-		_, pw.err = progressui.DisplaySolveStatus(ctx, "", c, out, statusCh)
+		_, pw.err = progressui.DisplaySolveStatus(ctx, c, out, statusCh)
 		close(doneCh)
 	}()
 	return pw, nil

Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ func action(clicontext *cli.Context) error {`
`107`	`107`	`c = cn`
`108`	`108`	`}`
`109`	`109`	`// not using shared context to not disrupt display but let is finish reporting errors`
`110`		`- _, err = progressui.DisplaySolveStatus(context.TODO(), "", c, os.Stdout, ch)`
	`110`	`+ _, err = progressui.DisplaySolveStatus(context.TODO(), c, os.Stdout, ch)`
`111`	`111`	`return err`
`112`	`112`	`})`
`113`	`113`	`eg.Go(func() error {`