✨ Add /tasks patch; return 202 for task actions and updates. (#660)

Adds patch endpoints for:
- /tasks
- /taskgroups

The Update() methods on both Task and Taskgroup support both PUT and
PATCH depending on the http method. They also support delegation from
Submit() which mainly sets the state=Ready.

Updated to return 202 (accepted) on success.
- put /tasks/:id
- patch /tasks/:id
- put /tasks/:id/cancel

BaseHandler.modBody() removed.

Add patch support to binding client.

Adds API test for task patch.

closes: #661 
closes: #662

---------

Signed-off-by: Jeff Ortel <[email protected]>

api/base.go

@@ -1,7 +1,6 @@
 package api
 
 import (
-	"bytes"
 	"database/sql"
 	"encoding/json"
 	"errors"
@@ -99,33 +98,6 @@ func (h *BaseHandler) pk(ctx *gin.Context) (id uint) {
 	return
 }
 
-// modBody updates the body using the `mod` function.
-//  1. read the body.
-//  2. mod()
-//  3. write body.
-func (h *BaseHandler) modBody(
-	ctx *gin.Context,
-	r interface{},
-	mod func(bool) error) (err error) {
-	//
-	withBody := false
-	if ctx.Request.ContentLength > 0 {
-		withBody = true
-		err = h.Bind(ctx, r)
-		if err != nil {
-			return
-		}
-	}
-	err = mod(withBody)
-	if err != nil {
-		return
-	}
-	b, _ := json.Marshal(r)
-	bfr := bytes.NewBuffer(b)
-	ctx.Request.Body = io.NopCloser(bfr)
-	return
-}
-
 // CurrentUser gets username from Keycloak auth token.
 func (h *BaseHandler) CurrentUser(ctx *gin.Context) (user string) {
 	rtx := WithContext(ctx)

api/task.go

@@ -38,7 +38,7 @@ const (
 )
 
 const (
-	LocatorParam = "locator"
+	Submit = "submit"
 )
 
 // TaskHandler handles task routes.
@@ -55,10 +55,11 @@ func (h TaskHandler) AddRoutes(e *gin.Engine) {
 	routeGroup.POST(TasksRoot, h.Create)
 	routeGroup.GET(TaskRoot, h.Get)
 	routeGroup.PUT(TaskRoot, h.Update)
+	routeGroup.PATCH(TaskRoot, Transaction, h.Update)
 	routeGroup.DELETE(TaskRoot, h.Delete)
 	routeGroup.GET(TasksReportQueueRoot, h.Queued)
 	// Actions
-	routeGroup.PUT(TaskSubmitRoot, h.Submit, h.Update)
+	routeGroup.PUT(TaskSubmitRoot, Transaction, h.Submit)
 	routeGroup.PUT(TaskCancelRoot, h.Cancel)
 	// Bucket
 	routeGroup = e.Group("/")
@@ -335,73 +336,66 @@ func (h TaskHandler) Delete(ctx *gin.Context) {
 // @description Update a task.
 // @tags tasks
 // @accept json
-// @success 204
+// @success 202
 // @router /tasks/{id} [put]
 // @param id path int true "Task ID"
 // @param task body Task true "Task data"
 func (h TaskHandler) Update(ctx *gin.Context) {
 	id := h.pk(ctx)
+	m := &model.Task{}
+	err := h.DB(ctx).First(m, id).Error
+	if err != nil {
+		_ = ctx.Error(err)
+		return
+	}
 	r := &Task{}
-	err := h.Bind(ctx, r)
+	if ctx.Request.Method == http.MethodPatch &&
+		ctx.Request.ContentLength > 0 {
+		r.With(m)
+	}
+	err = h.Bind(ctx, r)
 	if err != nil {
+		_ = ctx.Error(err)
 		return
 	}
-	r.ID = id
+	if _, found := ctx.Get(Submit); found {
+		r.State = tasking.Ready
+	}
+	m = r.Model()
+	m.ID = id
+	m.UpdateUser = h.CurrentUser(ctx)
 	rtx := WithContext(ctx)
 	task := &tasking.Task{}
-	task.With(r.Model())
-	task.UpdateUser = h.BaseHandler.CurrentUser(ctx)
+	task.With(m)
 	err = rtx.TaskManager.Update(h.DB(ctx), task)
 	if err != nil {
 		_ = ctx.Error(err)
 		return
 	}
 
-	h.Status(ctx, http.StatusNoContent)
+	h.Status(ctx, http.StatusAccepted)
 }
 
 // Submit godoc
 // @summary Submit a task.
-// @description Submit a task.
+// @description Patch and submit a task.
 // @tags tasks
 // @accept json
-// @success 204
+// @success 202
 // @router /tasks/{id}/submit [put]
 // @param id path int true "Task ID"
 // @param task body Task false "Task data (optional)"
 func (h TaskHandler) Submit(ctx *gin.Context) {
-	id := h.pk(ctx)
-	r := &Task{}
-	err := h.findRefs(ctx, r)
-	if err != nil {
-		_ = ctx.Error(err)
-		return
-	}
-	mod := func(withBody bool) (err error) {
-		if !withBody {
-			m := r.Model()
-			err = h.DB(ctx).First(m, id).Error
-			if err != nil {
-				return
-			}
-			r.With(m)
-		}
-		r.State = tasking.Ready
-		return
-	}
-	err = h.modBody(ctx, r, mod)
-	if err != nil {
-		_ = ctx.Error(err)
-		return
-	}
-	ctx.Next()
+	ctx.Set(Submit, true)
+	ctx.Request.Method = http.MethodPatch
+	h.Update(ctx)
 }
 
 // Cancel godoc
 // @summary Cancel a task.
 // @description Cancel a task.
 // @tags tasks
-// @success 204
+// @success 202
 // @router /tasks/{id}/cancel [put]
 // @param id path int true "Task ID"
 func (h TaskHandler) Cancel(ctx *gin.Context) {
@@ -413,7 +407,7 @@ func (h TaskHandler) Cancel(ctx *gin.Context) {
 		return
 	}
 
-	h.Status(ctx, http.StatusNoContent)
+	h.Status(ctx, http.StatusAccepted)
 }
 
 // BucketGet godoc
@@ -735,7 +729,6 @@ type Task struct {
 	TTL         TTL          `json:"ttl,omitempty" yaml:",omitempty"`
 	Data        any          `json:"data,omitempty" yaml:",omitempty"`
 	Application *Ref         `json:"application,omitempty" yaml:",omitempty"`
-	Actions     []string     `json:"actions,omitempty" yaml:",omitempty"`
 	Bucket      *Ref         `json:"bucket,omitempty" yaml:",omitempty"`
 	Pod         string       `json:"pod,omitempty" yaml:",omitempty"`
 	Retries     int          `json:"retries,omitempty" yaml:",omitempty"`

api/taskgroup.go

@@ -35,8 +35,9 @@ func (h TaskGroupHandler) AddRoutes(e *gin.Engine) {
 	routeGroup.GET(TaskGroupsRoot+"/", h.List)
 	routeGroup.POST(TaskGroupsRoot, h.Create)
 	routeGroup.PUT(TaskGroupRoot, h.Update)
+	routeGroup.PATCH(TaskGroupRoot, Transaction, h.Update)
 	routeGroup.GET(TaskGroupRoot, h.Get)
-	routeGroup.PUT(TaskGroupSubmitRoot, h.Submit, h.Update)
+	routeGroup.PUT(TaskGroupSubmitRoot, Transaction, h.Submit)
 	routeGroup.DELETE(TaskGroupRoot, h.Delete)
 	// Bucket
 	routeGroup = e.Group("/")
@@ -175,18 +176,25 @@ func (h TaskGroupHandler) Create(ctx *gin.Context) {
 // @param task body TaskGroup true "Task data"
 func (h TaskGroupHandler) Update(ctx *gin.Context) {
 	id := h.pk(ctx)
-	updated := &TaskGroup{}
-	err := h.Bind(ctx, updated)
+	m := &model.TaskGroup{}
+	err := h.DB(ctx).First(m, id).Error
 	if err != nil {
+		_ = ctx.Error(err)
 		return
 	}
-	current := &model.TaskGroup{}
-	err = h.DB(ctx).First(current, id).Error
+	r := &TaskGroup{}
+	if ctx.Request.Method == http.MethodPatch &&
+		ctx.Request.ContentLength > 0 {
+		r.With(m)
+	}
+	err = h.Bind(ctx, r)
 	if err != nil {
-		_ = ctx.Error(err)
 		return
 	}
-	err = h.findRefs(ctx, updated)
+	if _, found := ctx.Get(Submit); found {
+		r.State = tasking.Ready
+	}
+	err = h.findRefs(ctx, r)
 	if err != nil {
 		_ = ctx.Error(err)
 		return
@@ -196,10 +204,10 @@ func (h TaskGroupHandler) Update(ctx *gin.Context) {
 		clause.Associations,
 		"BucketID",
 		"Bucket")
-	m := updated.Model()
+	m = r.Model()
 	m.ID = id
-	m.UpdateUser = h.BaseHandler.CurrentUser(ctx)
-	switch updated.State {
+	m.UpdateUser = h.CurrentUser(ctx)
+	switch m.State {
 	case "", tasking.Created:
 		err = db.Save(m).Error
 		if err != nil {
@@ -230,6 +238,7 @@ func (h TaskGroupHandler) Update(ctx *gin.Context) {
 		for i := range m.Tasks {
 			task := &tasking.Task{}
 			task.With(&m.Tasks[i])
+			task.CreateUser = h.CurrentUser(ctx)
 			err = rtx.TaskManager.Create(h.DB(ctx), task)
 			if err != nil {
 				_ = ctx.Error(err)
@@ -284,39 +293,17 @@ func (h TaskGroupHandler) Delete(ctx *gin.Context) {
 
 // Submit godoc
 // @summary Submit a task group.
-// @description Submit a task group.
+// @description Patch and submit a task group.
 // @tags taskgroups
 // @accept json
 // @success 204
 // @router /taskgroups/{id}/submit [put]
 // @param id path int true "TaskGroup ID"
 // @param taskgroup body TaskGroup false "TaskGroup data (optional)"
 func (h TaskGroupHandler) Submit(ctx *gin.Context) {
-	id := h.pk(ctx)
-	r := &TaskGroup{}
-	err := h.findRefs(ctx, r)
-	if err != nil {
-		_ = ctx.Error(err)
-		return
-	}
-	mod := func(withBody bool) (err error) {
-		if !withBody {
-			m := r.Model()
-			err = h.DB(ctx).First(m, id).Error
-			if err != nil {
-				return
-			}
-			r.With(m)
-		}
-		r.State = tasking.Ready
-		return
-	}
-	err = h.modBody(ctx, r, mod)
-	if err != nil {
-		_ = ctx.Error(err)
-		return
-	}
-	ctx.Next()
+	ctx.Set(Submit, true)
+	ctx.Request.Method = http.MethodPatch
+	h.Update(ctx)
 }
 
 // BucketGet godoc

binding/client.go

@@ -172,6 +172,8 @@ func (r *Client) Post(path string, object interface{}) (err error) {
 	}
 	status := response.StatusCode
 	switch status {
+	case http.StatusAccepted:
+	case http.StatusNoContent:
 	case http.StatusOK,
 		http.StatusCreated:
 		var body []byte
@@ -185,7 +187,6 @@ func (r *Client) Post(path string, object interface{}) (err error) {
 			err = liberr.Wrap(err)
 			return
 		}
-	case http.StatusNoContent:
 	default:
 		err = r.restError(response)
 	}
@@ -223,6 +224,60 @@ func (r *Client) Put(path string, object interface{}, params ...Param) (err erro
 	}
 	status := response.StatusCode
 	switch status {
+	case http.StatusAccepted:
+	case http.StatusNoContent:
+	case http.StatusOK,
+		http.StatusCreated:
+		var body []byte
+		body, err = io.ReadAll(response.Body)
+		if err != nil {
+			err = liberr.Wrap(err)
+			return
+		}
+		err = json.Unmarshal(body, object)
+		if err != nil {
+			err = liberr.Wrap(err)
+			return
+		}
+	default:
+		err = r.restError(response)
+	}
+
+	return
+}
+
+// Patch a resource.
+func (r *Client) Patch(path string, object interface{}, params ...Param) (err error) {
+	request := func() (request *http.Request, err error) {
+		bfr, err := json.Marshal(object)
+		if err != nil {
+			err = liberr.Wrap(err)
+			return
+		}
+		reader := bytes.NewReader(bfr)
+		request = &http.Request{
+			Header: http.Header{},
+			Method: http.MethodPatch,
+			Body:   io.NopCloser(reader),
+			URL:    r.join(path),
+		}
+		request.Header.Set(api.Accept, binding.MIMEJSON)
+		if len(params) > 0 {
+			q := request.URL.Query()
+			for _, p := range params {
+				q.Add(p.Key, p.Value)
+			}
+			request.URL.RawQuery = q.Encode()
+		}
+		return
+	}
+	response, err := r.send(request)
+	if err != nil {
+		return
+	}
+	status := response.StatusCode
+	switch status {
+	case http.StatusAccepted:
 	case http.StatusNoContent:
 	case http.StatusOK,
 		http.StatusCreated:

binding/task.go

@@ -37,6 +37,13 @@ func (h *Task) Update(r *api.Task) (err error) {
 	return
 }
 
+// Patch a Task.
+func (h *Task) Patch(id uint, r any) (err error) {
+	path := Path(api.TaskRoot).Inject(Params{api.ID: id})
+	err = h.client.Patch(path, r)
+	return
+}
+
 // Delete a Task.
 func (h *Task) Delete(id uint) (err error) {
 	err = h.client.Delete(Path(api.TaskRoot).Inject(Params{api.ID: id}))