Files
larksuite-cli/shortcuts/task/task_update.go
evandance 8c3cba17b2 feat(task): emit typed error envelopes across the task domain (#1231)
Task commands now return structured, typed errors instead of the legacy
exit-code envelope: every failure carries a stable category, subtype, and
recovery hint, so callers can branch on the error class instead of parsing
messages. Exit codes derive from the error category — input validation exits 2,
a permission denial exits 3, other API errors exit 1.

Batch operations (adding tasks to a tasklist, creating a tasklist with tasks)
now report partial failure honestly: the per-item successes and failures stay
on stdout and the command exits non-zero instead of masking failures as a
success.
2026-06-05 22:30:45 +08:00

163 lines
4.7 KiB
Go

// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package task
import (
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"strings"
"github.com/larksuite/cli/errs"
"github.com/larksuite/cli/internal/output"
"github.com/larksuite/cli/shortcuts/common"
)
var UpdateTask = common.Shortcut{
Service: "task",
Command: "+update",
Description: "update task attributes",
Risk: "write",
Scopes: []string{"task:task:write"},
AuthTypes: []string{"user", "bot"},
HasFormat: true,
Flags: []common.Flag{
{Name: "task-id", Desc: "task id (comma-separated for multiple)", Required: true},
{Name: "summary", Desc: "task title"},
{Name: "description", Desc: "task description"},
{Name: "due", Desc: "due date (ISO 8601 / date:YYYY-MM-DD / relative:+2d / ms timestamp)"},
{Name: "data", Desc: "JSON payload for task object"},
},
DryRun: func(ctx context.Context, runtime *common.RuntimeContext) *common.DryRunAPI {
body, err := buildTaskUpdateBody(runtime)
if err != nil {
return common.NewDryRunAPI().Set("error", err.Error())
}
taskIds := strings.Split(runtime.Str("task-id"), ",")
taskId := url.PathEscape(strings.TrimSpace(taskIds[0]))
return common.NewDryRunAPI().
PATCH("/open-apis/task/v2/tasks/" + taskId).
Params(map[string]interface{}{"user_id_type": "open_id"}).
Body(body)
},
Execute: func(ctx context.Context, runtime *common.RuntimeContext) error {
body, err := buildTaskUpdateBody(runtime)
if err != nil {
// buildTaskUpdateBody already returns a typed validation error;
// propagate it directly instead of re-wrapping as an API error.
return err
}
taskIds := strings.Split(runtime.Str("task-id"), ",")
var updatedTasks []map[string]interface{}
for _, taskId := range taskIds {
taskId = strings.TrimSpace(taskId)
if taskId == "" {
continue
}
params := map[string]interface{}{"user_id_type": "open_id"}
data, err := callTaskAPITyped(runtime, http.MethodPatch, "/open-apis/task/v2/tasks/"+url.PathEscape(taskId), params, body)
if err != nil {
return err
}
taskObj, _ := data["task"].(map[string]interface{})
if taskObj != nil {
updatedTasks = append(updatedTasks, taskObj)
}
}
var tasks []map[string]interface{}
for _, task := range updatedTasks {
guid, _ := task["guid"].(string)
urlVal, _ := task["url"].(string)
urlVal = truncateTaskURL(urlVal)
tasks = append(tasks, map[string]interface{}{
"guid": guid,
"url": urlVal,
})
}
// Standardized write output: return resource identifiers
outData := map[string]interface{}{
"tasks": tasks,
}
runtime.OutFormat(outData, &output.Meta{Count: len(updatedTasks)}, func(w io.Writer) {
for _, task := range updatedTasks {
guid, _ := task["guid"].(string)
summary, _ := task["summary"].(string)
urlVal, _ := task["url"].(string)
urlVal = truncateTaskURL(urlVal)
fmt.Fprintf(w, "✅ Task updated successfully!\n")
fmt.Fprintf(w, "Task ID: %s\n", guid)
if summary != "" {
fmt.Fprintf(w, "Summary: %s\n", summary)
}
if urlVal != "" {
fmt.Fprintf(w, "Task URL: %s\n", urlVal)
}
fmt.Fprintln(w, strings.Repeat("-", 20))
}
})
return nil
},
}
func buildTaskUpdateBody(runtime *common.RuntimeContext) (map[string]interface{}, error) {
taskObj := make(map[string]interface{})
var updateFields []string
if dataStr := runtime.Str("data"); dataStr != "" {
if err := json.Unmarshal([]byte(dataStr), &taskObj); err != nil {
return nil, errs.NewValidationError(errs.SubtypeInvalidArgument, "--data must be a valid JSON object: %v", err).WithParam("--data")
}
// If data is provided, assume keys are update fields
for k := range taskObj {
updateFields = append(updateFields, k)
}
}
if summary := runtime.Str("summary"); summary != "" {
taskObj["summary"] = summary
if !contains(updateFields, "summary") {
updateFields = append(updateFields, "summary")
}
}
if desc := runtime.Str("description"); desc != "" {
taskObj["description"] = desc
if !contains(updateFields, "description") {
updateFields = append(updateFields, "description")
}
}
if dueStr := runtime.Str("due"); dueStr != "" {
dueObj, err := parseTaskTime(dueStr)
if err != nil {
return nil, errs.NewValidationError(errs.SubtypeInvalidArgument, "failed to parse due time: %v", err).WithParam("--due")
}
taskObj["due"] = dueObj
if !contains(updateFields, "due") {
updateFields = append(updateFields, "due")
}
}
if len(updateFields) == 0 {
return nil, errs.NewValidationError(errs.SubtypeInvalidArgument, "no fields to update")
}
return map[string]interface{}{
"task": taskObj,
"update_fields": updateFields,
}, nil
}