ami/tl-vikunja
1
0
Fork 0
Code Activity

feat(views)!: move task position handling to its own crud entity

Browse Source 
BREAKING CHANGE: the position of tasks now can't be updated anymore via the task update endpoint. Instead, there is a new endpoint which takes the project view into account as well.
This commit is contained in:
kolaente
2024-03-14 22:28:07 +01:00
parent 238baf86f7
commit 2502776460
11 changed files with 375 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
pkg/models/kanban.go
View File

@ -201,7 +201,7 @@ func GetTasksInBucketsForView(s *xorm.Session, view *ProjectView, opts *taskSear
opts.sortby = []*sortParam{
{
orderBy: orderAscending,
sortBy: taskPropertyKanbanPosition,
sortBy: taskPropertyPosition,
},
}

1
pkg/models/task_collection.go
View File

@ -67,7 +67,6 @@ func validateTaskField(fieldName string) error {
taskPropertyCreated,
taskPropertyUpdated,
taskPropertyPosition,
taskPropertyKanbanPosition,
taskPropertyBucketID,
taskPropertyIndex:
return nil

41
pkg/models/task_collection_sort.go
View File

@ -26,27 +26,26 @@ type (
)
const (
taskPropertyID string = "id"
taskPropertyTitle string = "title"
taskPropertyDescription string = "description"
taskPropertyDone string = "done"
taskPropertyDoneAt string = "done_at"
taskPropertyDueDate string = "due_date"
taskPropertyCreatedByID string = "created_by_id"
taskPropertyProjectID string = "project_id"
taskPropertyRepeatAfter string = "repeat_after"
taskPropertyPriority string = "priority"
taskPropertyStartDate string = "start_date"
taskPropertyEndDate string = "end_date"
taskPropertyHexColor string = "hex_color"
taskPropertyPercentDone string = "percent_done"
taskPropertyUID string = "uid"
taskPropertyCreated string = "created"
taskPropertyUpdated string = "updated"
taskPropertyPosition string = "position"
taskPropertyKanbanPosition string = "kanban_position"
taskPropertyBucketID string = "bucket_id"
taskPropertyIndex string = "index"
taskPropertyID string = "id"
taskPropertyTitle string = "title"
taskPropertyDescription string = "description"
taskPropertyDone string = "done"
taskPropertyDoneAt string = "done_at"
taskPropertyDueDate string = "due_date"
taskPropertyCreatedByID string = "created_by_id"
taskPropertyProjectID string = "project_id"
taskPropertyRepeatAfter string = "repeat_after"
taskPropertyPriority string = "priority"
taskPropertyStartDate string = "start_date"
taskPropertyEndDate string = "end_date"
taskPropertyHexColor string = "hex_color"
taskPropertyPercentDone string = "percent_done"
taskPropertyUID string = "uid"
taskPropertyCreated string = "created"
taskPropertyUpdated string = "updated"
taskPropertyPosition string = "position"
taskPropertyBucketID string = "bucket_id"
taskPropertyIndex string = "index"
)
const (

115
pkg/models/task_position.go Normal file
View File

@ -0,0 +1,115 @@
// 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 Licensee 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 Licensee for more details.
//
// You should have received a copy of the GNU Affero General Public Licensee
// along with this program. If not, see <https://www.gnu.org/licenses/>.
package models
import (
"code.vikunja.io/web"
"math"
"xorm.io/xorm"
)
type TaskPosition struct {
// The ID of the task this position is for
TaskID int64 `xorm:"bigint not null index" json:"task_id" param:"task"`
// The project view this task is related to
ProjectViewID int64 `xorm:"bigint not null index" json:"project_view_id"`
// The position of the task - any task project can be sorted as usual by this parameter.
// When accessing tasks via kanban buckets, this is primarily used to sort them based on a range
// We're using a float64 here to make it possible to put any task within any two other tasks (by changing the number).
// You would calculate the new position between two tasks with something like task3.position = (task2.position - task1.position) / 2.
// A 64-Bit float leaves plenty of room to initially give tasks a position with 2^16 difference to the previous task
// which also leaves a lot of room for rearranging and sorting later.
// Positions are always saved per view. They will automatically be set if you request the tasks through a view
// endpoint, otherwise they will always be 0. To update them, take a look at the Task Position endpoint.
Position float64 `xorm:"double not null" json:"position"`
web.CRUDable `xorm:"-" json:"-"`
web.Rights `xorm:"-" json:"-"`
}
func (tp *TaskPosition) TableName() string {
return "task_positions"
}
func (tp *TaskPosition) CanUpdate(s *xorm.Session, a web.Auth) (bool, error) {
pv := &ProjectView{ID: tp.ProjectViewID}
return pv.CanUpdate(s, a)
}
// Update is the handler to update a task position
// @Summary Updates a task position
// @Description Updates a task position.
// @tags task
// @Accept json
// @Produce json
// @Security JWTKeyAuth
// @Param id path int true "Task ID"
// @Param view body models.TaskPosition true "The task position with updated values you want to change."
// @Success 200 {object} models.TaskPosition "The updated task position."
// @Failure 400 {object} web.HTTPError "Invalid task position object provided."
// @Failure 500 {object} models.Message "Internal error"
// @Router /tasks/{id}/position [post]
func (tp *TaskPosition) Update(s *xorm.Session, _ web.Auth) (err error) {
exists, err := s.
Where("task_id = ? AND project_view_id = ?", tp.TaskID, tp.ProjectViewID).
Get(&TaskPosition{})
if err != nil {
return err
}
if !exists {
_, err = s.Insert(tp)
return
}
_, err = s.
Where("task_id = ?", tp.TaskID).
Cols("project_view_id", "position").
Update(tp)
return
}
func RecalculateTaskPositions(s *xorm.Session, view *ProjectView) (err error) {
allTasks := []*Task{}
err = s.
Select("tasks.*, task_positions.position AS position").
Join("LEFT", "task_positions", "task_positions.task_id = tasks.id AND task_positions.project_view_id = ?", view.ID).
Where("project_id = ?", view.ProjectID).
OrderBy("position asc").
Find(&allTasks)
if err != nil {
return
}
maxPosition := math.Pow(2, 32)
newPositions := make([]*TaskPosition, 0, len(allTasks))
for i, task := range allTasks {
currentPosition := maxPosition / float64(len(allTasks)) * (float64(i + 1))
newPositions = append(newPositions, &TaskPosition{
TaskID: task.ID,
ProjectViewID: view.ID,
Position: currentPosition,
})
}
_, err = s.Insert(newPositions)
return
}

51
pkg/models/tasks.go
View File

@ -121,9 +121,9 @@ type Task struct {
// You would calculate the new position between two tasks with something like task3.position = (task2.position - task1.position) / 2.
// A 64-Bit float leaves plenty of room to initially give tasks a position with 2^16 difference to the previous task
// which also leaves a lot of room for rearranging and sorting later.
Position float64 `xorm:"double null" json:"position"`
// The position of tasks in the kanban board. See the docs for the `position` property on how to use this.
KanbanPosition float64 `xorm:"double null" json:"kanban_position"`
// Positions are always saved per view. They will automatically be set if you request the tasks through a view
// endpoint, otherwise they will always be 0. To update them, take a look at the Task Position endpoint.
Position float64 `xorm:"-" json:"position"`
// Reactions on that task.
Reactions ReactionMap `xorm:"-" json:"reactions"`
@ -785,7 +785,6 @@ func createTask(s *xorm.Session, t *Task, a web.Auth, updateAssignees bool) (err
// If no position was supplied, set a default one
t.Position = calculateDefaultPosition(t.Index, t.Position)
t.KanbanPosition = calculateDefaultPosition(t.Index, t.KanbanPosition)
t.HexColor = utils.NormalizeHex(t.HexColor)
@ -912,7 +911,6 @@ func (t *Task) Update(s *xorm.Session, a web.Auth) (err error) {
"bucket_id",
"position",
"repeat_mode",
"kanban_position",
"cover_image_attachment_id",
}
@ -1028,9 +1026,6 @@ func (t *Task) Update(s *xorm.Session, a web.Auth) (err error) {
if t.Position == 0 {
ot.Position = 0
}
if t.KanbanPosition == 0 {
ot.KanbanPosition = 0
}
// Repeat from current date
if t.RepeatMode == TaskRepeatModeDefault {
ot.RepeatMode = TaskRepeatModeDefault
@ -1059,12 +1054,6 @@ func (t *Task) Update(s *xorm.Session, a web.Auth) (err error) {
return err
}
}
if ot.KanbanPosition < 0.1 {
err = recalculateTaskKanbanPositions(s, t.BucketID)
if err != nil {
return err
}
}
// Get the task updated timestamp in a new struct - if we'd just try to put it into t which we already have, it
// would still contain the old updated date.
@ -1075,7 +1064,6 @@ func (t *Task) Update(s *xorm.Session, a web.Auth) (err error) {
}
t.Updated = nt.Updated
t.Position = nt.Position
t.KanbanPosition = nt.KanbanPosition
doer, _ := user.GetFromAuth(a)
err = events.Dispatch(&TaskUpdatedEvent{
@ -1089,39 +1077,6 @@ func (t *Task) Update(s *xorm.Session, a web.Auth) (err error) {
return updateProjectLastUpdated(s, &Project{ID: t.ProjectID})
}
func recalculateTaskKanbanPositions(s *xorm.Session, bucketID int64) (err error) {
allTasks := []*Task{}
err = s.
Where("bucket_id = ?", bucketID).
OrderBy("kanban_position asc").
Find(&allTasks)
if err != nil {
return
}
maxPosition := math.Pow(2, 32)
for i, task := range allTasks {
currentPosition := maxPosition / float64(len(allTasks)) * (float64(i + 1))
// Here we use "NoAutoTime() to prevent the ORM from updating column "updated" automatically.
// Otherwise, this signals to CalDAV clients that the task has changed, which is not the case.
// Consequence: when synchronizing a list of tasks, the first one immediately changes the date of all the
// following ones from the same batch, which are then unable to be updated.
_, err = s.Cols("kanban_position").
Where("id = ?", task.ID).
NoAutoTime().
Update(&Task{KanbanPosition: currentPosition})
if err != nil {
return
}
}
return
}
func recalculateTaskPositions(s *xorm.Session, projectID int64) (err error) {
allTasks := []*Task{}

11
pkg/models/tasks_test.go
View File

@ -253,12 +253,11 @@ func TestTask_Update(t *testing.T) {
defer s.Close()
task := &Task{
ID: 4,
Title: "test10000",
Description: "Lorem Ipsum Dolor",
KanbanPosition: 10,
ProjectID: 1,
BucketID: 2, // Bucket 2 already has 3 tasks and a limit of 3
ID: 4,
Title: "test10000",
Description: "Lorem Ipsum Dolor",
ProjectID: 1,
BucketID: 2, // Bucket 2 already has 3 tasks and a limit of 3
}
err := task.Update(s, u)
require.NoError(t, err)

6
pkg/models/typesense.go
View File

@ -153,10 +153,6 @@ func CreateTypesenseCollections() error {
Name: "position",
Type: "float",
},
{
Name: "kanban_position",
Type: "float",
},
{
Name: "created_by_id",
Type: "int64",
@ -417,7 +413,6 @@ type typesenseTask struct {
Updated int64 `json:"updated"`
BucketID int64 `json:"bucket_id"`
Position float64 `json:"position"`
KanbanPosition float64 `json:"kanban_position"`
CreatedByID int64 `json:"created_by_id"`
Reminders interface{} `json:"reminders"`
Assignees interface{} `json:"assignees"`
@ -451,7 +446,6 @@ func convertTaskToTypesenseTask(task *Task) *typesenseTask {
Updated: task.Updated.UTC().Unix(),
BucketID: task.BucketID,
Position: task.Position,
KanbanPosition: task.KanbanPosition,
CreatedByID: task.CreatedByID,
Reminders: task.Reminders,
Assignees: task.Assignees,