From 006f932dc4da3a9c83d55c2907927f72b1acf3e0 Mon Sep 17 00:00:00 2001 From: kolaente Date: Fri, 15 Mar 2024 10:39:53 +0100 Subject: [PATCH] feat(views)!: decouple bucket CRUD from projects --- pkg/models/error.go | 6 +++--- pkg/models/kanban.go | 28 ++++++++++++++++------------ pkg/routes/routes.go | 8 ++++---- 3 files changed, 23 insertions(+), 19 deletions(-) diff --git a/pkg/models/error.go b/pkg/models/error.go index f2f05a2d6..e63f6fc00 100644 --- a/pkg/models/error.go +++ b/pkg/models/error.go @@ -1557,8 +1557,8 @@ 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. type ErrCannotRemoveLastBucket struct { - BucketID int64 - ProjectID int64 + BucketID int64 + ProjectViewID int64 } // IsErrCannotRemoveLastBucket checks if an error is ErrCannotRemoveLastBucket. @@ -1568,7 +1568,7 @@ func IsErrCannotRemoveLastBucket(err error) bool { } 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 diff --git a/pkg/models/kanban.go b/pkg/models/kanban.go index 35fe1b087..9769d4904 100644 --- a/pkg/models/kanban.go +++ b/pkg/models/kanban.go @@ -34,7 +34,7 @@ type Bucket struct { // The title of this bucket. Title string `xorm:"text not null" valid:"required" minLength:"1" json:"title"` // 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. ProjectViewID int64 `xorm:"bigint not null" json:"project_view_id" param:"view"` // All tasks which belong to this bucket. @@ -107,17 +107,18 @@ func getDefaultBucketID(s *xorm.Session, project *Project) (bucketID int64, err // @Produce json // @Security JWTKeyAuth // @Param id path int true "Project ID" +// @Param view path int true "Project view ID" // @Success 200 {array} models.Bucket "The buckets" // @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) { - project, err := GetProjectSimpleByID(s, b.ProjectID) + view, err := GetProjectViewByID(s, b.ProjectViewID, b.ProjectID) if err != nil { return nil, 0, 0, err } - can, _, err := project.CanRead(s, auth) + can, _, err := view.CanRead(s, auth) if err != nil { 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{} err = s. - Where("project_id = ?", b.ProjectID). + Where("project_view_id = ?", b.ProjectViewID). OrderBy("position"). Find(&buckets) 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 { return nil, err } @@ -287,12 +288,13 @@ func GetTasksInBucketsForView(s *xorm.Session, view *ProjectView, opts *taskSear // @Produce json // @Security JWTKeyAuth // @Param id path int true "Project Id" +// @Param view path int true "Project view ID" // @Param bucket body models.Bucket true "The bucket object" // @Success 200 {object} models.Bucket "The created bucket object." // @Failure 400 {object} web.HTTPError "Invalid bucket object provided." // @Failure 404 {object} web.HTTPError "The project does not exist." // @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) { b.CreatedBy, err = GetUserOrLinkShareUser(s, a) if err != nil { @@ -319,12 +321,13 @@ func (b *Bucket) Create(s *xorm.Session, a web.Auth) (err error) { // @Security JWTKeyAuth // @Param projectID path int true "Project 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" // @Success 200 {object} models.Bucket "The created bucket object." // @Failure 400 {object} web.HTTPError "Invalid bucket object provided." // @Failure 404 {object} web.HTTPError "The bucket does not exist." // @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) { _, err = s. Where("id = ?", b.ID). @@ -346,21 +349,22 @@ func (b *Bucket) Update(s *xorm.Session, _ web.Auth) (err error) { // @Security JWTKeyAuth // @Param projectID path int true "Project Id" // @Param bucketID path int true "Bucket Id" +// @Param view path int true "Project view ID" // @Success 200 {object} models.Message "Successfully deleted." // @Failure 404 {object} web.HTTPError "The bucket does not exist." // @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) { // 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 { return } if total <= 1 { return ErrCannotRemoveLastBucket{ - BucketID: b.ID, - ProjectID: b.ProjectID, + BucketID: b.ID, + ProjectViewID: b.ProjectViewID, } } diff --git a/pkg/routes/routes.go b/pkg/routes/routes.go index b9bf28961..e6f4e89fc 100644 --- a/pkg/routes/routes.go +++ b/pkg/routes/routes.go @@ -363,10 +363,10 @@ func registerAPIRoutes(a *echo.Group) { return &models.Bucket{} }, } - a.GET("/projects/:project/buckets", kanbanBucketHandler.ReadAllWeb) - a.PUT("/projects/:project/buckets", kanbanBucketHandler.CreateWeb) - a.POST("/projects/:project/buckets/:bucket", kanbanBucketHandler.UpdateWeb) - a.DELETE("/projects/:project/buckets/:bucket", kanbanBucketHandler.DeleteWeb) + a.GET("/projects/:project/views/:view/buckets", kanbanBucketHandler.ReadAllWeb) + a.PUT("/projects/:project/views/:view/buckets", kanbanBucketHandler.CreateWeb) + a.POST("/projects/:project/views/:view/buckets/:bucket", kanbanBucketHandler.UpdateWeb) + a.DELETE("/projects/:project/views/:view/buckets/:bucket", kanbanBucketHandler.DeleteWeb) projectDuplicateHandler := &handler.WebHandler{ EmptyStruct: func() handler.CObject {