Add support for progress groups.

This allows clients to specify that LLB states should be grouped in
progress output under a custom name. Status updates for all vertexes in
the group will show up under a single vertex in the output.

The intended use cases are for Dockerfile COPY's that use MergeOp as a
backend and for grouping some other internal vertexes during frontend
builds.

Signed-off-by: Erik Sipsma <erik@sipsma.dev>

api/services/control/control.proto

@@ -115,6 +115,7 @@ message Vertex {
 	google.protobuf.Timestamp started = 5 [(gogoproto.stdtime) = true ];
 	google.protobuf.Timestamp completed = 6 [(gogoproto.stdtime) = true ];
 	string error = 7; // typed errors?
+	pb.ProgressGroup progressGroup = 8;
 }
 
 message VertexStatus {

cache/manager.go

@@ -725,6 +725,7 @@ func (cm *cacheManager) createMergeRef(ctx context.Context, parents parentRefs,
 	}
 	if len(parents.mergeParents) == 1 {
 		// merge of 1 thing is that thing
+		parents.mergeParents[0].progress = pg
 		return parents.mergeParents[0], nil
 	}
 

client/graph.go

@@ -8,13 +8,14 @@ import (
 )
 
 type Vertex struct {
-	Digest    digest.Digest
-	Inputs    []digest.Digest
-	Name      string
-	Started   *time.Time
-	Completed *time.Time
-	Cached    bool
-	Error     string
+	Digest        digest.Digest
+	Inputs        []digest.Digest
+	Name          string
+	Started       *time.Time
+	Completed     *time.Time
+	Cached        bool
+	Error         string
+	ProgressGroup *pb.ProgressGroup
 }
 
 type VertexStatus struct {

client/llb/state.go

@@ -505,6 +505,10 @@ func mergeMetadata(m1, m2 pb.OpMetadata) pb.OpMetadata {
 		m1.Caps[k] = true
 	}
 
+	if m2.ProgressGroup != nil {
+		m1.ProgressGroup = m2.ProgressGroup
+	}
+
 	return m1
 }
 
@@ -594,6 +598,12 @@ func LocalUniqueID(v string) ConstraintsOpt {
 	})
 }
 
+func ProgressGroup(id, name string) ConstraintsOpt {
+	return constraintsOptFunc(func(c *Constraints) {
+		c.Metadata.ProgressGroup = &pb.ProgressGroup{Id: id, Name: name}
+	})
+}
+
 var (
 	LinuxAmd64   = Platform(ocispecs.Platform{OS: "linux", Architecture: "amd64"})
 	LinuxArmhf   = Platform(ocispecs.Platform{OS: "linux", Architecture: "arm", Variant: "v7"})

client/solve.go

@@ -263,13 +263,14 @@ func (c *Client) solve(ctx context.Context, def *llb.Definition, runGateway runG
 			s := SolveStatus{}
 			for _, v := range resp.Vertexes {
 				s.Vertexes = append(s.Vertexes, &Vertex{
-					Digest:    v.Digest,
-					Inputs:    v.Inputs,
-					Name:      v.Name,
-					Started:   v.Started,
-					Completed: v.Completed,
-					Error:     v.Error,
-					Cached:    v.Cached,
+					Digest:        v.Digest,
+					Inputs:        v.Inputs,
+					Name:          v.Name,
+					Started:       v.Started,
+					Completed:     v.Completed,
+					Error:         v.Error,
+					Cached:        v.Cached,
+					ProgressGroup: v.ProgressGroup,
 				})
 			}
 			for _, v := range resp.Statuses {

control/control.go

@@ -338,13 +338,14 @@ func (c *Controller) Status(req *controlapi.StatusRequest, stream controlapi.Con
 				sr := controlapi.StatusResponse{}
 				for _, v := range ss.Vertexes {
 					sr.Vertexes = append(sr.Vertexes, &controlapi.Vertex{
-						Digest:    v.Digest,
-						Inputs:    v.Inputs,
-						Name:      v.Name,
-						Started:   v.Started,
-						Completed: v.Completed,
-						Error:     v.Error,
-						Cached:    v.Cached,
+						Digest:        v.Digest,
+						Inputs:        v.Inputs,
+						Name:          v.Name,
+						Started:       v.Started,
+						Completed:     v.Completed,
+						Error:         v.Error,
+						Cached:        v.Cached,
+						ProgressGroup: v.ProgressGroup,
 					})
 				}
 				for _, v := range ss.Statuses {

solver/jobs.go

@@ -889,9 +889,10 @@ func initClientVertex(v Vertex) client.Vertex {
 		inputDigests = append(inputDigests, inp.Vertex.Digest())
 	}
 	return client.Vertex{
-		Inputs: inputDigests,
-		Name:   v.Name(),
-		Digest: v.Digest(),
+		Inputs:        inputDigests,
+		Name:          v.Name(),
+		Digest:        v.Digest(),
+		ProgressGroup: v.Options().ProgressGroup,
 	}
 }
 

solver/llbsolver/ops/diff.go

@@ -71,6 +71,7 @@ func (d *diffOp) CacheMap(ctx context.Context, group session.Group, index int) (
 		WriterFactory: progress.FromContext(ctx),
 		Digest:        d.vtx.Digest(),
 		Name:          d.vtx.Name(),
+		ProgressGroup: d.vtx.Options().ProgressGroup,
 	}
 	cm.Opts[cache.ProgressKey{}] = d.pg
 

solver/llbsolver/ops/merge.go

@@ -63,6 +63,7 @@ func (m *mergeOp) CacheMap(ctx context.Context, group session.Group, index int)
 		WriterFactory: progress.FromContext(ctx),
 		Digest:        m.vtx.Digest(),
 		Name:          m.vtx.Name(),
+		ProgressGroup: m.vtx.Options().ProgressGroup,
 	}
 	cm.Opts[cache.ProgressKey{}] = m.pg
 

solver/llbsolver/vertex.go

@@ -162,6 +162,7 @@ func newVertex(dgst digest.Digest, op *pb.Op, opMeta *pb.OpMetadata, load func(d
 		if opMeta.ExportCache != nil {
 			opt.ExportCache = &opMeta.ExportCache.Value
 		}
+		opt.ProgressGroup = opMeta.ProgressGroup
 	}
 	for _, fn := range opts {
 		if err := fn(op, opMeta, &opt); err != nil {