ami/tl-vikunja
1
0
Fork 0
Code

feat(views)!: decouple bucket CRUD from projects

Browse Source
This commit is contained in:
kolaente 2024-03-15 10:39:53 +01:00
parent 0a3f45ab11
commit 006f932dc4
No known key found for this signature in database
GPG Key ID: F40E70337AB24C9B
3 changed files with 23 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pkg/models/error.go
View File

@ -1558,7 +1558,7 @@ func (err ErrBucketDoesNotBelongToProject) HTTPError() web.HTTPError {
// ErrCannotRemoveLastBucket represents an error where a kanban bucket is the last on a project and thus cannot be removed. // ErrCannotRemoveLastBucket represents an error where a kanban bucket is the last on a project and thus cannot be removed.
type ErrCannotRemoveLastBucket struct { type ErrCannotRemoveLastBucket struct {
BucketID int64 BucketID int64
ProjectID int64 ProjectViewID int64
} }
// IsErrCannotRemoveLastBucket checks if an error is ErrCannotRemoveLastBucket. // IsErrCannotRemoveLastBucket checks if an error is ErrCannotRemoveLastBucket.
@ -1568,7 +1568,7 @@ func IsErrCannotRemoveLastBucket(err error) bool {
} }
func (err ErrCannotRemoveLastBucket) Error() string { func (err ErrCannotRemoveLastBucket) Error() string {
return fmt.Sprintf("Cannot remove last bucket of project [BucketID: %d, ProjectID: %d]", err.BucketID, err.ProjectID) return fmt.Sprintf("Cannot remove last bucket of project [BucketID: %d, ProjectID: %d]", err.BucketID, err.ProjectViewID)
} }
// ErrCodeCannotRemoveLastBucket holds the unique world-error code of this error // ErrCodeCannotRemoveLastBucket holds the unique world-error code of this error

26
pkg/models/kanban.go
View File

@ -34,7 +34,7 @@ type Bucket struct {
// The title of this bucket. // The title of this bucket.
Title string `xorm:"text not null" valid:"required" minLength:"1" json:"title"` Title string `xorm:"text not null" valid:"required" minLength:"1" json:"title"`
// The project this bucket belongs to. // The project this bucket belongs to.
ProjectID int64 `xorm:"bigint not null" json:"project_id" param:"project"` ProjectID int64 `xorm:"-" json:"-" param:"project"`
// The project view this bucket belongs to. // The project view this bucket belongs to.
ProjectViewID int64 `xorm:"bigint not null" json:"project_view_id" param:"view"` ProjectViewID int64 `xorm:"bigint not null" json:"project_view_id" param:"view"`
// All tasks which belong to this bucket. // All tasks which belong to this bucket.
@ -107,17 +107,18 @@ func getDefaultBucketID(s *xorm.Session, project *Project) (bucketID int64, err
// @Produce json // @Produce json
// @Security JWTKeyAuth // @Security JWTKeyAuth
// @Param id path int true "Project ID" // @Param id path int true "Project ID"
// @Param view path int true "Project view ID"
// @Success 200 {array} models.Bucket "The buckets" // @Success 200 {array} models.Bucket "The buckets"
// @Failure 500 {object} models.Message "Internal server error" // @Failure 500 {object} models.Message "Internal server error"
// @Router /projects/{id}/buckets [get] // @Router /projects/{id}/views/{view}/buckets [get]
func (b *Bucket) ReadAll(s *xorm.Session, auth web.Auth, search string, page int, perPage int) (result interface{}, resultCount int, numberOfTotalItems int64, err error) { func (b *Bucket) ReadAll(s *xorm.Session, auth web.Auth, search string, page int, perPage int) (result interface{}, resultCount int, numberOfTotalItems int64, err error) {
project, err := GetProjectSimpleByID(s, b.ProjectID) view, err := GetProjectViewByID(s, b.ProjectViewID, b.ProjectID)
if err != nil { if err != nil {
return nil, 0, 0, err return nil, 0, 0, err
} }
can, _, err := project.CanRead(s, auth) can, _, err := view.CanRead(s, auth)
if err != nil { if err != nil {
return nil, 0, 0, err return nil, 0, 0, err
} }
@ -127,7 +128,7 @@ func (b *Bucket) ReadAll(s *xorm.Session, auth web.Auth, search string, page int
buckets := []*Bucket{} buckets := []*Bucket{}
err = s. err = s.
Where("project_id = ?", b.ProjectID). Where("project_view_id = ?", b.ProjectViewID).
OrderBy("position"). OrderBy("position").
Find(&buckets) Find(&buckets)
if err != nil { if err != nil {
@ -244,7 +245,7 @@ func GetTasksInBucketsForView(s *xorm.Session, view *ProjectView, opts *taskSear
} }
} }
ts, _, total, err := getRawTasksForProjects(s, []*Project{{ID: bucket.ProjectID}}, auth, opts) ts, _, total, err := getRawTasksForProjects(s, []*Project{{ID: view.ProjectID}}, auth, opts)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@ -287,12 +288,13 @@ func GetTasksInBucketsForView(s *xorm.Session, view *ProjectView, opts *taskSear
// @Produce json // @Produce json
// @Security JWTKeyAuth // @Security JWTKeyAuth
// @Param id path int true "Project Id" // @Param id path int true "Project Id"
// @Param view path int true "Project view ID"
// @Param bucket body models.Bucket true "The bucket object" // @Param bucket body models.Bucket true "The bucket object"
// @Success 200 {object} models.Bucket "The created bucket object." // @Success 200 {object} models.Bucket "The created bucket object."
// @Failure 400 {object} web.HTTPError "Invalid bucket object provided." // @Failure 400 {object} web.HTTPError "Invalid bucket object provided."
// @Failure 404 {object} web.HTTPError "The project does not exist." // @Failure 404 {object} web.HTTPError "The project does not exist."
// @Failure 500 {object} models.Message "Internal error" // @Failure 500 {object} models.Message "Internal error"
// @Router /projects/{id}/buckets [put] // @Router /projects/{id}/views/{view}/buckets [put]
func (b *Bucket) Create(s *xorm.Session, a web.Auth) (err error) { func (b *Bucket) Create(s *xorm.Session, a web.Auth) (err error) {
b.CreatedBy, err = GetUserOrLinkShareUser(s, a) b.CreatedBy, err = GetUserOrLinkShareUser(s, a)
if err != nil { if err != nil {
@ -319,12 +321,13 @@ func (b *Bucket) Create(s *xorm.Session, a web.Auth) (err error) {
// @Security JWTKeyAuth // @Security JWTKeyAuth
// @Param projectID path int true "Project Id" // @Param projectID path int true "Project Id"
// @Param bucketID path int true "Bucket Id" // @Param bucketID path int true "Bucket Id"
// @Param view path int true "Project view ID"
// @Param bucket body models.Bucket true "The bucket object" // @Param bucket body models.Bucket true "The bucket object"
// @Success 200 {object} models.Bucket "The created bucket object." // @Success 200 {object} models.Bucket "The created bucket object."
// @Failure 400 {object} web.HTTPError "Invalid bucket object provided." // @Failure 400 {object} web.HTTPError "Invalid bucket object provided."
// @Failure 404 {object} web.HTTPError "The bucket does not exist." // @Failure 404 {object} web.HTTPError "The bucket does not exist."
// @Failure 500 {object} models.Message "Internal error" // @Failure 500 {object} models.Message "Internal error"
// @Router /projects/{projectID}/buckets/{bucketID} [post] // @Router /projects/{projectID}/views/{view}/buckets/{bucketID} [post]
func (b *Bucket) Update(s *xorm.Session, _ web.Auth) (err error) { func (b *Bucket) Update(s *xorm.Session, _ web.Auth) (err error) {
_, err = s. _, err = s.
Where("id = ?", b.ID). Where("id = ?", b.ID).
@ -346,21 +349,22 @@ func (b *Bucket) Update(s *xorm.Session, _ web.Auth) (err error) {
// @Security JWTKeyAuth // @Security JWTKeyAuth
// @Param projectID path int true "Project Id" // @Param projectID path int true "Project Id"
// @Param bucketID path int true "Bucket Id" // @Param bucketID path int true "Bucket Id"
// @Param view path int true "Project view ID"
// @Success 200 {object} models.Message "Successfully deleted." // @Success 200 {object} models.Message "Successfully deleted."
// @Failure 404 {object} web.HTTPError "The bucket does not exist." // @Failure 404 {object} web.HTTPError "The bucket does not exist."
// @Failure 500 {object} models.Message "Internal error" // @Failure 500 {object} models.Message "Internal error"
// @Router /projects/{projectID}/buckets/{bucketID} [delete] // @Router /projects/{projectID}/views/{view}/buckets/{bucketID} [delete]
func (b *Bucket) Delete(s *xorm.Session, a web.Auth) (err error) { func (b *Bucket) Delete(s *xorm.Session, a web.Auth) (err error) {
// Prevent removing the last bucket // Prevent removing the last bucket
total, err := s.Where("project_id = ?", b.ProjectID).Count(&Bucket{}) total, err := s.Where("project_view_id = ?", b.ProjectViewID).Count(&Bucket{})
if err != nil { if err != nil {
return return
} }
if total <= 1 { if total <= 1 {
return ErrCannotRemoveLastBucket{ return ErrCannotRemoveLastBucket{
BucketID: b.ID, BucketID: b.ID,
ProjectID: b.ProjectID, ProjectViewID: b.ProjectViewID,
} }
} }

8
pkg/routes/routes.go
View File

@ -363,10 +363,10 @@ func registerAPIRoutes(a *echo.Group) {
return &models.Bucket{} return &models.Bucket{}
}, },
} }
a.GET("/projects/:project/buckets", kanbanBucketHandler.ReadAllWeb) a.GET("/projects/:project/views/:view/buckets", kanbanBucketHandler.ReadAllWeb)
a.PUT("/projects/:project/buckets", kanbanBucketHandler.CreateWeb) a.PUT("/projects/:project/views/:view/buckets", kanbanBucketHandler.CreateWeb)
a.POST("/projects/:project/buckets/:bucket", kanbanBucketHandler.UpdateWeb) a.POST("/projects/:project/views/:view/buckets/:bucket", kanbanBucketHandler.UpdateWeb)
a.DELETE("/projects/:project/buckets/:bucket", kanbanBucketHandler.DeleteWeb) a.DELETE("/projects/:project/views/:view/buckets/:bucket", kanbanBucketHandler.DeleteWeb)
projectDuplicateHandler := &handler.WebHandler{ projectDuplicateHandler := &handler.WebHandler{
EmptyStruct: func() handler.CObject { EmptyStruct: func() handler.CObject {