Merge pull request moby#5108 from sipsma/op-error-metadata

solver: include vertex Description in OpError

Author: sipsma

solver/errdefs/errdefs.pb.go

@@ -30,6 +30,8 @@ message Solve {
 		FileAction file = 4;
 		ContentCache cache = 5;
 	}
+
+	map<string, string> description = 6;
 }
 
 message FileAction {

solver/errdefs/errdefs.proto

@@ -4,17 +4,18 @@ import "github.com/moby/buildkit/solver/pb"
 
 type OpError struct {
 	error
-	Op *pb.Op
+	Op          *pb.Op
+	Description map[string]string
 }
 
 func (e *OpError) Unwrap() error {
 	return e.error
 }
 
-func WithOp(err error, iface interface{}) error {
-	op, ok := iface.(*pb.Op)
+func WithOp(err error, anyOp interface{}, opDesc map[string]string) error {
+	op, ok := anyOp.(*pb.Op)
 	if err == nil || !ok {
 		return err
 	}
-	return &OpError{error: err, Op: op}
+	return &OpError{error: err, Op: op, Description: opDesc}
 }

solver/errdefs/op.go

@@ -41,19 +41,22 @@ func WithSolveError(err error, subject IsSolve_Subject, inputIDs, mountIDs []str
 		return nil
 	}
 	var (
-		oe *OpError
-		op *pb.Op
+		oe          *OpError
+		op          *pb.Op
+		description map[string]string
 	)
 	if errors.As(err, &oe) {
 		op = oe.Op
+		description = oe.Description
 	}
 	return &SolveError{
 		Err: err,
 		Solve: Solve{
-			InputIDs: inputIDs,
-			MountIDs: mountIDs,
-			Op:       op,
-			Subject:  subject,
+			InputIDs:    inputIDs,
+			MountIDs:    mountIDs,
+			Op:          op,
+			Subject:     subject,
+			Description: description,
 		},
 	}
 }

solver/errdefs/solve.go

@@ -912,7 +912,7 @@ func (s *sharedOp) LoadCache(ctx context.Context, rec *CacheRecord) (Result, err
 func (s *sharedOp) CalcSlowCache(ctx context.Context, index Index, p PreprocessFunc, f ResultBasedCacheFunc, res Result) (dgst digest.Digest, err error) {
 	defer func() {
 		err = WrapSlowCache(err, index, NewSharedResult(res).Clone())
-		err = errdefs.WithOp(err, s.st.vtx.Sys())
+		err = errdefs.WithOp(err, s.st.vtx.Sys(), s.st.vtx.Options().Description)
 		err = errdefs.WrapVertex(err, s.st.origDigest)
 	}()
 	flightControlKey := fmt.Sprintf("slow-compute-%d", index)
@@ -989,7 +989,7 @@ func (s *sharedOp) CalcSlowCache(ctx context.Context, index Index, p PreprocessF
 
 func (s *sharedOp) CacheMap(ctx context.Context, index int) (resp *cacheMapResp, err error) {
 	defer func() {
-		err = errdefs.WithOp(err, s.st.vtx.Sys())
+		err = errdefs.WithOp(err, s.st.vtx.Sys(), s.st.vtx.Options().Description)
 		err = errdefs.WrapVertex(err, s.st.origDigest)
 	}()
 	op, err := s.getOp()
@@ -1062,7 +1062,7 @@ func (s *sharedOp) CacheMap(ctx context.Context, index int) (resp *cacheMapResp,
 
 func (s *sharedOp) Exec(ctx context.Context, inputs []Result) (outputs []Result, exporters []ExportableCacheKey, err error) {
 	defer func() {
-		err = errdefs.WithOp(err, s.st.vtx.Sys())
+		err = errdefs.WithOp(err, s.st.vtx.Sys(), s.st.vtx.Options().Description)
 		err = errdefs.WrapVertex(err, s.st.origDigest)
 	}()
 	op, err := s.getOp()