builder: add graceful cancellation endpoint

tonistiigi · tonistiigi · commit 0bddd4ccfee5 · 2018-06-10T10:05:26.000-07:00
Signed-off-by: Tonis Tiigi &lt;tonistiigi@gmail.com&gt;
diff --git a/api/server/backend/build/backend.go b/api/server/backend/build/backend.go
@@ -79,8 +79,10 @@ func (b *Backend) Build(ctx context.Context, config backend.BuildConfig) (string
 		}
 	}
 
-	stdout := config.ProgressWriter.StdoutFormatter
-	fmt.Fprintf(stdout, "Successfully built %s\n", stringid.TruncateID(imageID))
+	if !useBuildKit {
+		stdout := config.ProgressWriter.StdoutFormatter
+		fmt.Fprintf(stdout, "Successfully built %s\n", stringid.TruncateID(imageID))
+	}
 	err = tagger.TagImages(image.ID(imageID))
 	return imageID, err
 }
@@ -94,6 +96,10 @@ func (b *Backend) PruneCache(ctx context.Context) (*types.BuildCachePruneReport,
 	return &types.BuildCachePruneReport{SpaceReclaimed: size}, nil
 }
 
+func (b *Backend) Cancel(ctx context.Context, id string) error {
+	return b.buildkit.Cancel(ctx, id)
+}
+
 func squashBuild(build *builder.Result, imageComponent ImageComponent) (string, error) {
 	var fromID string
 	if build.FromImage != nil {
diff --git a/api/server/router/build/backend.go b/api/server/router/build/backend.go
@@ -15,6 +15,8 @@ type Backend interface {
 
 	// Prune build cache
 	PruneCache(context.Context) (*types.BuildCachePruneReport, error)
+
+	Cancel(context.Context, string) error
 }
 
 type experimentalProvider interface {
diff --git a/api/server/router/build/build.go b/api/server/router/build/build.go
@@ -25,5 +25,6 @@ func (r *buildRouter) initRoutes() {
 	r.routes = []router.Route{
 		router.NewPostRoute("/build", r.postBuild, router.WithCancel),
 		router.NewPostRoute("/build/prune", r.postPrune, router.WithCancel),
+		router.NewPostRoute("/build/cancel", r.postCancel),
 	}
 }
diff --git a/api/server/router/build/build_routes.go b/api/server/router/build/build_routes.go
@@ -145,6 +145,7 @@ func newImageBuildOptions(ctx context.Context, r *http.Request) (*types.ImageBui
 		options.CacheFrom = cacheFrom
 	}
 	options.SessionID = r.FormValue("session")
+	options.BuildID = r.FormValue("buildid")
 
 	return options, nil
 }
@@ -157,6 +158,17 @@ func (br *buildRouter) postPrune(ctx context.Context, w http.ResponseWriter, r *
 	return httputils.WriteJSON(w, http.StatusOK, report)
 }
 
+func (br *buildRouter) postCancel(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
+	w.Header().Set("Content-Type", "application/json")
+
+	id := r.FormValue("id")
+	if id == "" {
+		return errors.Errorf("build ID not provided")
+	}
+
+	return br.backend.Cancel(ctx, id)
+}
+
 func (br *buildRouter) postBuild(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
 	var (
 		notVerboseBuffer = bytes.NewBuffer(nil)
diff --git a/api/types/client.go b/api/types/client.go
@@ -181,6 +181,7 @@ type ImageBuildOptions struct {
 	Target      string
 	SessionID   string
 	Platform    string
+	BuildID     string
 }
 
 // ImageBuildResponse holds information
diff --git a/builder/builder-next/builder.go b/builder/builder-next/builder.go
@@ -59,6 +59,9 @@ type Opt struct {
 type Builder struct {
 	controller *control.Controller
 	results    *results
+
+	mu   sync.Mutex
+	jobs map[string]func()
 }
 
 func New(opt Opt) (*Builder, error) {
@@ -71,11 +74,30 @@ func New(opt Opt) (*Builder, error) {
 	b := &Builder{
 		controller: c,
 		results:    results,
+		jobs:       map[string]func(){},
 	}
 	return b, nil
 }
 
+func (b *Builder) Cancel(ctx context.Context, id string) error {
+	b.mu.Lock()
+	if cancel, ok := b.jobs[id]; ok {
+		cancel()
+	}
+	b.mu.Unlock()
+	return nil
+}
+
 func (b *Builder) Build(ctx context.Context, opt backend.BuildConfig) (*builder.Result, error) {
+	if buildID := opt.Options.BuildID; buildID != "" {
+		b.mu.Lock()
+		ctx, b.jobs[buildID] = context.WithCancel(ctx)
+		b.mu.Unlock()
+		defer func() {
+			delete(b.jobs, buildID)
+		}()
+	}
+
 	id := identity.NewID()
 
 	attrs := map[string]string{
diff --git a/client/build_cancel.go b/client/build_cancel.go
@@ -0,0 +1,21 @@
+package client // import "github.com/docker/docker/client"
+
+import (
+	"net/url"
+
+	"golang.org/x/net/context"
+)
+
+// BuildCancel requests the daemon to cancel ongoing build request
+func (cli *Client) BuildCancel(ctx context.Context, id string) error {
+	query := url.Values{}
+	query.Set("id", id)
+
+	serverResp, err := cli.post(ctx, "/build/cancel", query, nil, nil)
+	if err != nil {
+		return err
+	}
+	defer ensureReaderClosed(serverResp)
+
+	return nil
+}
diff --git a/client/image_build.go b/client/image_build.go
@@ -133,5 +133,8 @@ func (cli *Client) imageBuildOptionsToQuery(options types.ImageBuildOptions) (ur
 	if options.Platform != "" {
 		query.Set("platform", strings.ToLower(options.Platform))
 	}
+	if options.BuildID != "" {
+		query.Set("buildid", options.BuildID)
+	}
 	return query, nil
 }
diff --git a/client/interface.go b/client/interface.go
@@ -86,6 +86,7 @@ type DistributionAPIClient interface {
 type ImageAPIClient interface {
 	ImageBuild(ctx context.Context, context io.Reader, options types.ImageBuildOptions) (types.ImageBuildResponse, error)
 	BuildCachePrune(ctx context.Context) (*types.BuildCachePruneReport, error)
+	BuildCancel(ctx context.Context, id string) error
 	ImageCreate(ctx context.Context, parentReference string, options types.ImageCreateOptions) (io.ReadCloser, error)
 	ImageHistory(ctx context.Context, image string) ([]image.HistoryResponseItem, error)
 	ImageImport(ctx context.Context, source types.ImageImportSource, ref string, options types.ImageImportOptions) (io.ReadCloser, error)

Original file line number	Diff line number	Diff line change
`@@ -79,8 +79,10 @@ func (b *Backend) Build(ctx context.Context, config backend.BuildConfig) (string`
`79`	`79`	`}`
`80`	`80`	`}`
`81`	`81`
`82`		`- stdout := config.ProgressWriter.StdoutFormatter`
`83`		`- fmt.Fprintf(stdout, "Successfully built %s\n", stringid.TruncateID(imageID))`
	`82`	`+ if !useBuildKit {`
	`83`	`+ stdout := config.ProgressWriter.StdoutFormatter`
	`84`	`+ fmt.Fprintf(stdout, "Successfully built %s\n", stringid.TruncateID(imageID))`
	`85`	`+ }`
`84`	`86`	`err = tagger.TagImages(image.ID(imageID))`
`85`	`87`	`return imageID, err`
`86`	`88`	`}`
`@@ -94,6 +96,10 @@ func (b Backend) PruneCache(ctx context.Context) (types.BuildCachePruneReport,`
`94`	`96`	`return &types.BuildCachePruneReport{SpaceReclaimed: size}, nil`
`95`	`97`	`}`
`96`	`98`
	`99`	`+func (b *Backend) Cancel(ctx context.Context, id string) error {`
	`100`	`+ return b.buildkit.Cancel(ctx, id)`
	`101`	`+}`
	`102`	`+`
`97`	`103`	`func squashBuild(build *builder.Result, imageComponent ImageComponent) (string, error) {`
`98`	`104`	`var fromID string`
`99`	`105`	`if build.FromImage != nil {`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@ type Backend interface {`
`15`	`15`
`16`	`16`	`// Prune build cache`
`17`	`17`	`PruneCache(context.Context) (*types.BuildCachePruneReport, error)`
	`18`	`+`
	`19`	`+ Cancel(context.Context, string) error`
`18`	`20`	`}`
`19`	`21`
`20`	`22`	`type experimentalProvider interface {`
Original file line number	Diff line number	Diff line change
`@@ -25,5 +25,6 @@ func (r *buildRouter) initRoutes() {`
`25`	`25`	`r.routes = []router.Route{`
`26`	`26`	`router.NewPostRoute("/build", r.postBuild, router.WithCancel),`
`27`	`27`	`router.NewPostRoute("/build/prune", r.postPrune, router.WithCancel),`
	`28`	`+ router.NewPostRoute("/build/cancel", r.postCancel),`
`28`	`29`	`}`
`29`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -181,6 +181,7 @@ type ImageBuildOptions struct {`
`181`	`181`	`Target string`
`182`	`182`	`SessionID string`
`183`	`183`	`Platform string`
	`184`	`+ BuildID string`
`184`	`185`	`}`
`185`	`186`
`186`	`187`	`// ImageBuildResponse holds information`
Original file line number	Diff line number	Diff line change
`@@ -133,5 +133,8 @@ func (cli *Client) imageBuildOptionsToQuery(options types.ImageBuildOptions) (ur`
`133`	`133`	`if options.Platform != "" {`
`134`	`134`	`query.Set("platform", strings.ToLower(options.Platform))`
`135`	`135`	`}`
	`136`	`+ if options.BuildID != "" {`
	`137`	`+ query.Set("buildid", options.BuildID)`
	`138`	`+ }`
`136`	`139`	`return query, nil`
`137`	`140`	`}`