User setting to sort comments #2307

andileni · 2024-04-27T12:03:35Z

andileni commented

2024-04-27 12:03:35 +00:00

First-time contributor

Following the discussion here https://community.vikunja.io/t/add-option-to-sort-comments/2286/8 this implements the needed functionality.
I tested it on my end as good as I could, but no guarantee.
Please have a look and point out any issues which must be fixed before merging.

Thanks and kind regards
Andreas

Following the discussion here https://community.vikunja.io/t/add-option-to-sort-comments/2286/8 this implements the needed functionality. I tested it on my end as good as I could, but no guarantee. Please have a look and point out any issues which must be fixed before merging. Thanks and kind regards Andreas

andileni added 3 commits 2024-04-27 12:03:38 +00:00

d1799ff980 add user setting for comment ordering

74f7b5bdba orderBy in task_comments.go

continuous-integration/drone/pr Build is failing Details

918c49648b pass orderBy as parameter to taskCommentService in comments.vue

konrad requested changes 2024-05-05 13:46:12 +00:00

konrad left a comment

Please also check why the CI fails and make it pass.

pkg/models/task_comments.go

						
				@ -38,2 +39,4 @@

					TaskID   int64      `xorm:"not null" json:"-" param:"task"`

					// The query parameter to order the items by. This can be either asc or desc, with asc being the default.

					OrderBy    []string `query:"order_by" json:"order_by"`

konrad commented

2024-05-05 13:43:22 +00:00

There should be a SortBy as well for the property to sort comments by. "Order asc / desc" does not tell you which property the sorting is using. Similar to how sorting is done in the TaskCollection.

No need to implement any other property than created in this PR but it should be extendable without breaking changes in the future.

Please exclude this from json as it's not used in the actual comment and document this as query parameter in the swagger annotation comment.

There should be a `SortBy` as well for the property to sort comments by. "Order asc / desc" does not tell you which property the sorting is using. Similar to how sorting is done in the `TaskCollection`. No need to implement any other property than `created` in this PR but it should be extendable without breaking changes in the future. Please exclude this from `json` as it's not used in the actual comment and document this as query parameter in the swagger annotation comment.

pkg/models/task_comments.go

						
				@ -271,3 +275,3 @@

						Where(builder.And(where...)).

						Join("LEFT", "users", "users.id = task_comments.author_id").

						OrderBy("task_comments.created asc")

						OrderBy(fmt.Sprintf("task_comments.created %s", tc.OrderBy[0]))

konrad commented

2024-05-05 13:45:57 +00:00

Please use "task_comments.created " + orderBy and make sure the property to order is defined. With this approach, the api will crash when you do not pass an order parameter.

Please use `"task_comments.created " + orderBy` and make sure the property to order is defined. With this approach, the api will crash when you do not pass an order parameter.