Skip to content

feat: Surface Flow task report on Task API #2288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kunzhao-nv merged 11 commits into from
Jun 9, 2026
Merged

feat: Surface Flow task report on Task API #2288

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4fb8b87
feat(flow): add with_report flag to ListTasks RPC
kunzhao-nv Jun 7, 2026
42d980d
chore(workflow-schema): resync Flow proto mirror
kunzhao-nv Jun 7, 2026
82626a9
feat(rest-api): expose Flow task report on Task endpoints
kunzhao-nv Jun 7, 2026
3aa6e8b
chore(rest-api): regenerate openapi docs + sdk
kunzhao-nv Jun 7, 2026
7eadec9
refactor(rest-api): centralize APIRackTask option building
kunzhao-nv Jun 8, 2026
0f7cb00
refactor(rest-api): rename APIRackTask to APITask
kunzhao-nv Jun 8, 2026
9001abb
refactor(rest-api): rename withReport query param to includeReport
kunzhao-nv Jun 8, 2026
a583f98
feat(rest-api): type the task report as TaskReportV1
kunzhao-nv Jun 8, 2026
35dab00
chore(rest-api): regenerate openapi docs + sdk
kunzhao-nv Jun 8, 2026
7e2d079
refactor(rest-api): address review feedback on Task model
kunzhao-nv Jun 9, 2026
4319353
Merge branch 'main' into feat/rest-api-task-report
kunzhao-nv Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions rest-api/api/pkg/api/handler/task.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ func NewGetTaskHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.Client
// @Param org path string true "Name of NGC organization"
// @Param id path string true "UUID of the Task"
// @Param siteId query string true "ID of the Site"
// @Success 200 {object} model.APIRackTask
// @Success 200 {object} model.APITask
// @Router /v2/org/{org}/nico/rack/task/{id} [get]
func (gth GetTaskHandler) Handle(c echo.Context) error {
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("Task", "Get", c, gth.tracerSpan)
Expand Down Expand Up @@ -183,7 +183,7 @@ func (gth GetTaskHandler) Handle(c echo.Context) error {
return cutil.NewAPIErrorResponse(c, http.StatusNotFound, "Task not found", nil)
}

apiTask := model.NewAPIRackTask(tasks[0])
apiTask := model.NewAPITask(tasks[0], model.WithReport())

logger.Info().Msg("finishing API handler")

Expand Down Expand Up @@ -229,7 +229,7 @@ func NewCancelTaskHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.Cli
// @Param org path string true "Name of NGC organization"
// @Param id path string true "UUID of the Task"
// @Param body body model.APICancelTaskRequest true "Cancel task request"
// @Success 202 {object} model.APIRackTask
// @Success 202 {object} model.APITask
// @Router /v2/org/{org}/nico/rack/task/{id}/cancel [post]
func (cth CancelTaskHandler) Handle(c echo.Context) error {
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("Task", "Cancel", c, cth.tracerSpan)
Expand Down Expand Up @@ -354,7 +354,7 @@ func (cth CancelTaskHandler) Handle(c echo.Context) error {
return cutil.NewAPIErrorResponse(c, code, fmt.Sprintf("Failed to execute Task cancellation workflow on Site: %s", unwrapErr), nil)
}

apiTask := model.NewAPIRackTask(flowResponse.GetTask())
apiTask := model.NewAPITask(flowResponse.GetTask(), model.WithReport())

logger.Info().Msg("finishing API handler")
return c.JSON(http.StatusAccepted, apiTask)
Expand Down Expand Up @@ -393,9 +393,10 @@ func NewGetRackTasksHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.C
// @Param id path string true "UUID of the Rack"
// @Param siteId query string true "ID of the Site"
// @Param activeOnly query boolean false "Restrict to non-terminal Tasks"
// @Param includeReport query boolean false "Include the per-task execution report in each response (default false)"
// @Param pageNumber query integer false "Page number of results returned"
// @Param pageSize query integer false "Number of results per page"
// @Success 200 {array} model.APIRackTask
// @Success 200 {array} model.APITask
// @Router /v2/org/{org}/nico/rack/{id}/task [get]
func (h GetRackTasksHandler) Handle(c echo.Context) error {
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("RackTasks", "List", c, h.tracerSpan)
Expand Down Expand Up @@ -490,6 +491,7 @@ func (h GetRackTasksHandler) Handle(c echo.Context) error {
flowRequest := &flowv1.ListTasksRequest{
RackId: &flowv1.UUID{Id: rackID},
ActiveOnly: apiRequest.ActiveOnly,
WithReport: apiRequest.IncludeReport,
}
if pageRequest.Offset != nil && pageRequest.Limit != nil {
flowRequest.Pagination = &flowv1.Pagination{
Expand Down Expand Up @@ -527,9 +529,10 @@ func (h GetRackTasksHandler) Handle(c echo.Context) error {
return cutil.NewAPIErrorResponse(c, code, fmt.Sprintf("Failed to execute workflow to retrieve all Rack Tasks: %s", unwrapErr), nil)
}

apiTasks := make([]*model.APIRackTask, 0, len(flowResponse.GetTasks()))
taskOpts := model.BuildAPITaskOptions(apiRequest)
apiTasks := make([]*model.APITask, 0, len(flowResponse.GetTasks()))
for _, t := range flowResponse.GetTasks() {
apiTasks = append(apiTasks, model.NewAPIRackTask(t))
apiTasks = append(apiTasks, model.NewAPITask(t, taskOpts...))
}

total := int(flowResponse.GetTotal())
Expand Down Expand Up @@ -576,9 +579,10 @@ func NewGetTrayTasksHandler(dbSession *cdb.Session, tc tClient.Client, scp *sc.C
// @Param id path string true "UUID of the Tray"
// @Param siteId query string true "ID of the Site"
// @Param activeOnly query boolean false "Restrict to non-terminal Tasks"
// @Param includeReport query boolean false "Include the per-task execution report in each response (default false)"
// @Param pageNumber query integer false "Page number of results returned"
// @Param pageSize query integer false "Number of results per page"
// @Success 200 {array} model.APIRackTask
// @Success 200 {array} model.APITask
// @Router /v2/org/{org}/nico/tray/{id}/task [get]
func (h GetTrayTasksHandler) Handle(c echo.Context) error {
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("TrayTasks", "List", c, h.tracerSpan)
Expand Down Expand Up @@ -673,6 +677,7 @@ func (h GetTrayTasksHandler) Handle(c echo.Context) error {
flowRequest := &flowv1.ListTasksRequest{
ComponentId: &flowv1.UUID{Id: trayID},
ActiveOnly: apiRequest.ActiveOnly,
WithReport: apiRequest.IncludeReport,
}
if pageRequest.Offset != nil && pageRequest.Limit != nil {
flowRequest.Pagination = &flowv1.Pagination{
Expand Down Expand Up @@ -710,9 +715,10 @@ func (h GetTrayTasksHandler) Handle(c echo.Context) error {
return cutil.NewAPIErrorResponse(c, code, fmt.Sprintf("Failed to execute workflow to retrieve all Tray Tasks: %s", unwrapErr), nil)
}

apiTasks := make([]*model.APIRackTask, 0, len(flowResponse.GetTasks()))
taskOpts := model.BuildAPITaskOptions(apiRequest)
apiTasks := make([]*model.APITask, 0, len(flowResponse.GetTasks()))
for _, t := range flowResponse.GetTasks() {
apiTasks = append(apiTasks, model.NewAPIRackTask(t))
apiTasks = append(apiTasks, model.NewAPITask(t, taskOpts...))
}

total := int(flowResponse.GetTotal())
Expand Down
6 changes: 3 additions & 3 deletions rest-api/api/pkg/api/handler/task_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ func TestGetTaskHandler_Handle(t *testing.T) {
return
}

var apiTask model.APIRackTask
var apiTask model.APITask
err = json.Unmarshal(rec.Body.Bytes(), &apiTask)
assert.NoError(t, err)
assert.Equal(t, taskUUID, apiTask.ID)
Expand Down Expand Up @@ -264,7 +264,7 @@ func ExecuteGetTasksHandlerTestCases(t *testing.T, pathFmt string, handle func(e
if tt.expectedStatus != http.StatusOK {
return
}
var tasks []model.APIRackTask
var tasks []model.APITask
require.NoError(t, json.Unmarshal(rec.Body.Bytes(), &tasks))
require.Len(t, tasks, len(tt.mockTasks))
require.NotEmpty(t, rec.Header().Get("X-Pagination"), "X-Pagination")
Expand Down Expand Up @@ -580,7 +580,7 @@ func TestCancelTaskHandler_Handle(t *testing.T) {
return
}

var apiTask model.APIRackTask
var apiTask model.APITask
err = json.Unmarshal(rec.Body.Bytes(), &apiTask)
assert.NoError(t, err)
assert.Equal(t, taskUUID, apiTask.ID)
Expand Down
Loading
Loading