From 5c960fccd5b934d29f0c16b6873e3978b68543a3 Mon Sep 17 00:00:00 2001 From: kolaente Date: Tue, 9 Jun 2026 21:17:11 +0200 Subject: [PATCH] feat(api/v2): add bulk task updates on /api/v2 --- pkg/routes/api/v2/bulk_task.go | 61 ++++++++++++++++++++++++ pkg/webtests/huma_bulk_task_test.go | 74 +++++++++++++++++++++++++++++ 2 files changed, 135 insertions(+) create mode 100644 pkg/routes/api/v2/bulk_task.go create mode 100644 pkg/webtests/huma_bulk_task_test.go diff --git a/pkg/routes/api/v2/bulk_task.go b/pkg/routes/api/v2/bulk_task.go new file mode 100644 index 000000000..be5e4b31e --- /dev/null +++ b/pkg/routes/api/v2/bulk_task.go @@ -0,0 +1,61 @@ +// Vikunja is a to-do list application to facilitate your life. +// Copyright 2018-present Vikunja and contributors. All rights reserved. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package apiv2 + +import ( + "context" + "net/http" + + "code.vikunja.io/api/pkg/models" + "code.vikunja.io/api/pkg/web/handler" + + "github.com/danielgtaylor/huma/v2" +) + +// RegisterBulkTaskRoutes wires the bulk task update action onto the Huma API. +// +// BulkTask is a CRUDable Update, so the handler reuses handler.DoUpdate; its +// CanUpdate fans the write check out across every project the involved tasks +// belong to, so a single project the user can't write to rejects the request. +func RegisterBulkTaskRoutes(api huma.API) { + tags := []string{"tasks"} + + Register(api, huma.Operation{ + OperationID: "tasks-bulk-update", + Summary: "Bulk update tasks", + Description: "Applies the fields named in `fields` from `values` to every task in `task_ids`. The user needs write access to every project the involved tasks belong to; if write is missing on even one, the whole request is rejected and nothing is changed. Returns the updated tasks.", + Method: http.MethodPut, + Path: "/tasks/bulk", + Tags: tags, + }, tasksBulkUpdate) +} + +func init() { AddRouteRegistrar(RegisterBulkTaskRoutes) } + +func tasksBulkUpdate(ctx context.Context, in *struct { + Body models.BulkTask +}) (*singleBody[models.BulkTask], error) { + a, err := authFromCtx(ctx) + if err != nil { + return nil, err + } + bt := &in.Body + if err := handler.DoUpdate(ctx, bt, a); err != nil { + return nil, translateDomainError(err) + } + return &singleBody[models.BulkTask]{Body: bt}, nil +} diff --git a/pkg/webtests/huma_bulk_task_test.go b/pkg/webtests/huma_bulk_task_test.go new file mode 100644 index 000000000..f61141541 --- /dev/null +++ b/pkg/webtests/huma_bulk_task_test.go @@ -0,0 +1,74 @@ +// Vikunja is a to-do list application to facilitate your life. +// Copyright 2018-present Vikunja and contributors. All rights reserved. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package webtests + +import ( + "fmt" + "net/http" + "testing" + + "code.vikunja.io/api/pkg/db" + "code.vikunja.io/api/pkg/models" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +// TestBulkTaskV2 covers PUT /tasks/bulk. It drives the Echo+Huma stack directly +// (humaRequest/humaTokenFor) because webHandlerTestV2's buildURL only models +// base[/{id}] paths, not action sub-paths. +func TestBulkTaskV2(t *testing.T) { + t.Run("updates multiple tasks the user can write", func(t *testing.T) { + e, err := setupTestEnv() + require.NoError(t, err) + token := humaTokenFor(t, &testuser1) + + // Tasks 1 and 2 both live in project 1, which testuser1 owns. + rec := humaRequest(t, e, http.MethodPut, "/api/v2/tasks/bulk", + `{"task_ids":[1,2],"fields":["title"],"values":{"title":"bulkupdated"}}`, token, "") + require.Equal(t, http.StatusOK, rec.Code, "body: %s", rec.Body.String()) + + db.AssertExists(t, "tasks", map[string]interface{}{"id": 1, "title": "bulkupdated"}, false) + db.AssertExists(t, "tasks", map[string]interface{}{"id": 2, "title": "bulkupdated"}, false) + }) + + t.Run("forbidden when missing write on one involved project", func(t *testing.T) { + e, err := setupTestEnv() + require.NoError(t, err) + token := humaTokenFor(t, &testuser1) + + // Task 1 is in project 1 (owned), task 32 in project 3 (read-only share). + // CanUpdate fans the write check across both projects, so the whole + // request is rejected and neither task changes. + rec := humaRequest(t, e, http.MethodPut, "/api/v2/tasks/bulk", + `{"task_ids":[1,32],"fields":["title"],"values":{"title":"shouldnothappen"}}`, token, "") + require.Equal(t, http.StatusForbidden, rec.Code, "body: %s", rec.Body.String()) + + db.AssertMissing(t, "tasks", map[string]interface{}{"title": "shouldnothappen"}) + }) + + t.Run("empty task_ids is rejected", func(t *testing.T) { + e, err := setupTestEnv() + require.NoError(t, err) + token := humaTokenFor(t, &testuser1) + + rec := humaRequest(t, e, http.MethodPut, "/api/v2/tasks/bulk", + `{"task_ids":[],"fields":["title"],"values":{"title":"bulkupdated"}}`, token, "") + require.Equal(t, http.StatusBadRequest, rec.Code, "body: %s", rec.Body.String()) + assert.Contains(t, rec.Body.String(), fmt.Sprintf(`"code":%d`, models.ErrCodeBulkTasksNeedAtLeastOne), "body: %s", rec.Body.String()) + }) +}