build: display build details link

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

Author: crazy-max

build/build.go

@@ -26,6 +26,7 @@ import (
 	"github.com/docker/buildx/builder"
 	"github.com/docker/buildx/driver"
 	"github.com/docker/buildx/localstate"
+	"github.com/docker/buildx/util/desktop"
 	"github.com/docker/buildx/util/dockerutil"
 	"github.com/docker/buildx/util/imagetools"
 	"github.com/docker/buildx/util/progress"
@@ -822,6 +823,7 @@ func BuildWithResultHandler(ctx context.Context, nodes []builder.Node, opt map[s
 
 			for i, dp := range dps {
 				i, dp, so := i, dp, *dp.so
+				node := nodes[dp.driverIndex]
 				if multiDriver {
 					for i, e := range so.Exports {
 						switch e.Type {
@@ -940,6 +942,16 @@ func BuildWithResultHandler(ctx context.Context, nodes []builder.Node, opt map[s
 							return res, nil
 						}
 					}, ch)
+					if node.Driver.Features(ctx)[driver.HistoryAPI] && desktop.BuildBackendEnabled() {
+						buildRef := fmt.Sprintf("%s/%s/%s", node.Builder, node.Name, so.Ref)
+						if err != nil {
+							return &ErrorWithBuildRef{
+								Ref: buildRef,
+								Err: err,
+							}
+						}
+						progress.WriteBuildRef(w, k, buildRef)
+					}
 					if err != nil {
 						return err
 					}
@@ -1689,3 +1701,16 @@ func ReadSourcePolicy() (*spb.Policy, error) {
 
 	return &pol, nil
 }
+
+type ErrorWithBuildRef struct {
+	Ref string
+	Err error
+}
+
+func (e *ErrorWithBuildRef) Error() string {
+	return e.Err.Error()
+}
+
+func (e *ErrorWithBuildRef) Unwrap() error {
+	return e.Err
+}

commands/bake.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/containerd/console"
 	"github.com/containerd/containerd/platforms"
 	"github.com/docker/buildx/bake"
 	"github.com/docker/buildx/build"
@@ -117,8 +118,17 @@ func runBake(dockerCli command.Cli, targets []string, in bakeOptions, cFlags com
 		progressTextDesc = fmt.Sprintf("building with %q instance using %s driver", b.Name, b.Driver)
 	}
 
-	printer, err := progress.NewPrinter(ctx2, os.Stderr, os.Stderr, cFlags.progress,
+	var isTerminal bool
+	if _, err := console.ConsoleFromFile(os.Stdout); err == nil {
+		isTerminal = true
+	}
+
+	var printer *progress.Printer
+	printer, err = progress.NewPrinter(ctx2, os.Stderr, os.Stderr, cFlags.progress,
 		progress.WithDesc(progressTextDesc, progressConsoleDesc),
+		progress.WithOnClose(func() {
+			printBuildDetails(os.Stderr, printer.BuildRefs(), isTerminal, cFlags.progress)
+		}),
 	)
 	if err != nil {
 		return err
@@ -193,7 +203,7 @@ func runBake(dockerCli command.Cli, targets []string, in bakeOptions, cFlags com
 
 	resp, err := build.Build(ctx, nodes, bo, dockerutil.NewClient(dockerCli), confutil.ConfigDir(dockerCli), printer)
 	if err != nil {
-		return wrapBuildError(err, true)
+		return wrapBuildError(err, isTerminal, true)
 	}
 
 	if len(in.metadataFile) > 0 {

commands/build.go

@@ -238,6 +238,11 @@ func runBuild(dockerCli command.Cli, options buildOptions) (err error) {
 		return err
 	}
 
+	var isTerminal bool
+	if _, err := console.ConsoleFromFile(os.Stdout); err == nil {
+		isTerminal = true
+	}
+
 	ctx2, cancel := context.WithCancel(context.TODO())
 	defer cancel()
 	progressMode, err := options.toProgress()
@@ -252,6 +257,7 @@ func runBuild(dockerCli command.Cli, options buildOptions) (err error) {
 		),
 		progress.WithOnClose(func() {
 			printWarnings(os.Stderr, printer.Warnings(), progressMode)
+			printBuildDetails(os.Stderr, printer.BuildRefs(), isTerminal, progressMode)
 		}),
 	)
 	if err != nil {
@@ -270,7 +276,7 @@ func runBuild(dockerCli command.Cli, options buildOptions) (err error) {
 		retErr = err
 	}
 	if retErr != nil {
-		return retErr
+		return wrapBuildError(retErr, isTerminal, false)
 	}
 
 	if options.quiet {
@@ -614,10 +620,15 @@ func decodeExporterResponse(exporterResponse map[string]string) map[string]inter
 	return out
 }
 
-func wrapBuildError(err error, bake bool) error {
+func wrapBuildError(err error, term bool, bake bool) error {
 	if err == nil {
 		return nil
 	}
+	if ebr, ok := err.(*build.ErrorWithBuildRef); ok {
+		return errors.Errorf("%v\n\n%s", ebr.Err, buildDetailsOutput(map[string]string{
+			"default": ebr.Ref,
+		}, term, progress.PrinterModeAuto))
+	}
 	st, ok := grpcerrors.AsGRPCStatus(err)
 	if ok {
 		if st.Code() == codes.Unimplemented && strings.Contains(st.Message(), "unsupported frontend capability moby.buildkit.frontend.contexts") {
@@ -843,3 +854,37 @@ func printValue(printer printFunc, version string, format string, res map[string
 	}
 	return printer([]byte(res["result.json"]), os.Stdout)
 }
+
+func buildDetailsOutput(refs map[string]string, term bool, mode string) string {
+	if len(refs) == 0 || mode == progress.PrinterModeQuiet {
+		return ""
+	}
+	refURL := func(ref string) string {
+		return fmt.Sprintf("docker-desktop://dashboard/build/%s", ref)
+	}
+	var out bytes.Buffer
+	out.WriteString("View build details: ")
+	multiTargets := len(refs) > 1
+	for target, ref := range refs {
+		if multiTargets {
+			out.WriteString(fmt.Sprintf("\n  %s: ", target))
+		}
+		if term {
+			out.WriteString(hyperlink(refURL(ref)))
+		} else {
+			out.WriteString(refURL(ref))
+		}
+	}
+	return out.String()
+}
+
+func hyperlink(url string) string {
+	// create an escape sequence using the OSC 8 format: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
+	return fmt.Sprintf("\033]8;;%s\033\\%s\033]8;;\033\\", url, url)
+}
+
+func printBuildDetails(w io.Writer, refs map[string]string, term bool, mode string) {
+	if out := buildDetailsOutput(refs, term, mode); out != "" {
+		fmt.Fprintf(w, "\n%s\n", out)
+	}
+}

controller/pb/progress.go

@@ -19,6 +19,10 @@ func (w *writer) Write(status *client.SolveStatus) {
 	w.ch <- ToControlStatus(status)
 }
 
+func (w *writer) WriteBuildRef(target string, ref string) {
+	return
+}
+
 func (w *writer) ValidateLogSource(digest.Digest, interface{}) bool {
 	return true
 }

util/desktop/desktop.go

@@ -0,0 +1,24 @@
+package desktop
+
+import (
+	"os"
+	"path/filepath"
+	"sync"
+)
+
+var (
+	bbEnabledOnce sync.Once
+	bbEnabled     bool
+)
+
+func BuildBackendEnabled() bool {
+	bbEnabledOnce.Do(func() {
+		home, err := os.UserHomeDir()
+		if err != nil {
+			return
+		}
+		_, err = os.Stat(filepath.Join(home, ".docker", "desktop-build", ".lastaccess"))
+		bbEnabled = err == nil
+	})
+	return bbEnabled
+}

util/progress/printer.go

@@ -33,6 +33,11 @@ type Printer struct {
 	warnings     []client.VertexWarning
 	logMu        sync.Mutex
 	logSourceMap map[digest.Digest]interface{}
+
+	// TODO: remove once we can use result context to pass build ref
+	//  see https://github.com/docker/buildx/pull/1861
+	buildRefsMu sync.Mutex
+	buildRefs   map[string]string
 }
 
 func (p *Printer) Wait() error {
@@ -143,6 +148,19 @@ func NewPrinter(ctx context.Context, w io.Writer, out console.File, mode string,
 	return pw, nil
 }
 
+func (p *Printer) WriteBuildRef(target string, ref string) {
+	p.buildRefsMu.Lock()
+	defer p.buildRefsMu.Unlock()
+	if p.buildRefs == nil {
+		p.buildRefs = map[string]string{}
+	}
+	p.buildRefs[target] = ref
+}
+
+func (p *Printer) BuildRefs() map[string]string {
+	return p.buildRefs
+}
+
 type printerOpts struct {
 	displayOpts []progressui.DisplaySolveStatusOpt
 

util/progress/writer.go

@@ -10,6 +10,7 @@ import (
 
 type Writer interface {
 	Write(*client.SolveStatus)
+	WriteBuildRef(string, string)
 	ValidateLogSource(digest.Digest, interface{}) bool
 	ClearLogSource(interface{})
 }
@@ -41,6 +42,10 @@ func Write(w Writer, name string, f func() error) {
 	})
 }
 
+func WriteBuildRef(w Writer, target string, ref string) {
+	w.WriteBuildRef(target, ref)
+}
+
 func NewChannel(w Writer) (chan *client.SolveStatus, chan struct{}) {
 	ch := make(chan *client.SolveStatus)
 	done := make(chan struct{})