build: fix build details link in experimental mode

Signed-off-by: CrazyMax <[email protected]>
docker · Oct 8, 2024 · a51e219 · a51e219
1 parent d353f5f
commit a51e219
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 18 deletions.
diff --git a/cmd/buildx/main.go b/cmd/buildx/main.go
@@ -6,6 +6,7 @@ import (
 	"os"
 
 	"github.com/docker/buildx/commands"
+	controllererrors "github.com/docker/buildx/controller/errdefs"
 	"github.com/docker/buildx/util/desktop"
 	"github.com/docker/buildx/version"
 	"github.com/docker/cli/cli"
@@ -16,6 +17,7 @@ import (
 	cliflags "github.com/docker/cli/cli/flags"
 	"github.com/moby/buildkit/solver/errdefs"
 	"github.com/moby/buildkit/util/stack"
+	"github.com/pkg/errors"
 	"go.opentelemetry.io/otel"
 
 	//nolint:staticcheck // vendored dependencies may still use this
@@ -106,8 +108,15 @@ func main() {
 	} else {
 		fmt.Fprintf(cmd.Err(), "ERROR: %v\n", err)
 	}
-	if ebr, ok := err.(*desktop.ErrorWithBuildRef); ok {
+
+	var ebr *desktop.ErrorWithBuildRef
+	if errors.As(err, &ebr) {
 		ebr.Print(cmd.Err())
+	} else {
+		var be *controllererrors.BuildError
+		if errors.As(err, &be) {
+			be.PrintBuildDetails(cmd.Err())
+		}
 	}
 
 	os.Exit(1)

diff --git a/controller/errdefs/build.go b/controller/errdefs/build.go
@@ -1,7 +1,10 @@
 package errdefs
 
 import (
+	"io"
+
 	"github.com/containerd/typeurl/v2"
+	"github.com/docker/buildx/util/desktop"
 	"github.com/moby/buildkit/util/grpcerrors"
 )
 
@@ -22,11 +25,22 @@ func (e *BuildError) ToProto() grpcerrors.TypedErrorProto {
 	return e.Build
 }
 
-func WrapBuild(err error, ref string) error {
+func (e *BuildError) PrintBuildDetails(w io.Writer) error {
+	if e.BuildRef == "" {
+		return nil
+	}
+	ebr := &desktop.ErrorWithBuildRef{
+		Ref: e.BuildRef,
+		Err: e.error,
+	}
+	return ebr.Print(w)
+}
+
+func WrapBuild(err error, ref string, buildRef string) error {
 	if err == nil {
 		return nil
 	}
-	return &BuildError{Build: &Build{Ref: ref}, error: err}
+	return &BuildError{Build: &Build{Ref: ref, BuildRef: buildRef}, error: err}
 }
 
 func (b *Build) WrapError(err error) error {

diff --git a/controller/errdefs/errdefs.pb.go b/controller/errdefs/errdefs.pb.go
diff --git a/controller/errdefs/errdefs.proto b/controller/errdefs/errdefs.proto
@@ -6,4 +6,5 @@ option go_package = "github.com/docker/buildx/controller/errdefs";
 
 message Build {
   string Ref = 1;
+  string BuildRef = 2;
 }
diff --git a/controller/local/controller.go b/controller/local/controller.go
@@ -11,6 +11,7 @@ import (
 	controllererrors "github.com/docker/buildx/controller/errdefs"
 	controllerapi "github.com/docker/buildx/controller/pb"
 	"github.com/docker/buildx/controller/processes"
+	"github.com/docker/buildx/util/desktop"
 	"github.com/docker/buildx/util/ioset"
 	"github.com/docker/buildx/util/progress"
 	"github.com/docker/cli/cli/command"
@@ -56,7 +57,12 @@ func (b *localController) Build(ctx context.Context, options *controllerapi.Buil
 			buildOptions: options,
 		}
 		if buildErr != nil {
-			buildErr = controllererrors.WrapBuild(buildErr, b.ref)
+			var buildRef string
+			var ebr *desktop.ErrorWithBuildRef
+			if errors.As(buildErr, &ebr) {
+				buildRef = ebr.Ref
+			}
+			buildErr = controllererrors.WrapBuild(buildErr, b.ref, buildRef)
 		}
 	}
 	if buildErr != nil {

diff --git a/controller/remote/server.go b/controller/remote/server.go
@@ -11,6 +11,7 @@ import (
 	controllererrors "github.com/docker/buildx/controller/errdefs"
 	"github.com/docker/buildx/controller/pb"
 	"github.com/docker/buildx/controller/processes"
+	"github.com/docker/buildx/util/desktop"
 	"github.com/docker/buildx/util/ioset"
 	"github.com/docker/buildx/util/progress"
 	"github.com/docker/buildx/version"
@@ -210,7 +211,12 @@ func (m *Server) Build(ctx context.Context, req *pb.BuildRequest) (*pb.BuildResp
 			s.buildOptions = req.Options
 			m.session[ref] = s
 			if buildErr != nil {
-				buildErr = controllererrors.WrapBuild(buildErr, ref)
+				var buildRef string
+				var ebr *desktop.ErrorWithBuildRef
+				if errors.As(buildErr, &ebr) {
+					buildRef = ebr.Ref
+				}
+				buildErr = controllererrors.WrapBuild(buildErr, ref, buildRef)
 			}
 		}
 	} else {

diff --git a/tests/build.go b/tests/build.go
@@ -492,11 +492,6 @@ RUN echo foo > /bar`)
 	require.NoError(t, err, string(out))
 	require.True(t, buildDetailsPattern.MatchString(string(out)), fmt.Sprintf("expected build details link in output, got %q", out))
 
-	if isExperimental() {
-		// FIXME: https://github.com/docker/buildx/issues/2382
-		t.Skip("build details link not displayed in experimental mode when build fails: https://github.com/docker/buildx/issues/2382")
-	}
-
 	// build erroneous dockerfile
 	dockerfile = []byte(`FROM busybox:latest
 RUN exit 1`)

diff --git a/util/desktop/desktop.go b/util/desktop/desktop.go
@@ -65,7 +65,6 @@ func hyperlink(url string) string {
 type ErrorWithBuildRef struct {
 	Ref string
 	Err error
-	Msg string
 }
 
 func (e *ErrorWithBuildRef) Error() string {