feat: migrate workspace user to api v1

This commit is contained in:
Steven
2023-06-20 17:37:50 +08:00
parent 24d42694c8
commit 44ef82fb4a
8 changed files with 113 additions and 418 deletions

View File

@ -1,10 +1,25 @@
package api
import (
"fmt"
"net/mail"
// Role is the type of a role.
type Role string
const (
// RoleAdmin is the ADMIN role.
RoleAdmin Role = "ADMIN"
// RoleUser is the USER role.
RoleUser Role = "USER"
)
func (e Role) String() string {
switch e {
case RoleAdmin:
return "ADMIN"
case RoleUser:
return "USER"
}
return "USER"
}
type User struct {
ID int `json:"id"`
@ -29,57 +44,3 @@ type UserCreate struct {
OpenID string `json:"-"`
Role Role `json:"-"`
}
func (create UserCreate) Validate() error {
if len(create.Email) < 3 {
return fmt.Errorf("email is too short, minimum length is 6")
}
if !validateEmail(create.Email) {
return fmt.Errorf("invalid email format")
}
if len(create.Password) < 3 {
return fmt.Errorf("password is too short, minimum length is 6")
}
return nil
}
type UserPatch struct {
ID int
// Standard fields
RowStatus *RowStatus `json:"rowStatus"`
// Domain specific fields
Email *string `json:"email"`
DisplayName *string `json:"displayName"`
Password *string `json:"password"`
ResetOpenID *bool `json:"resetOpenId"`
PasswordHash *string `json:"-"`
OpenID *string `json:"-"`
}
type UserFind struct {
ID *int `json:"id"`
// Standard fields
RowStatus *RowStatus `json:"rowStatus"`
// Domain specific fields
Email *string `json:"email"`
DisplayName *string `json:"displayName"`
OpenID *string `json:"openId"`
Role *Role `json:"-"`
}
type UserDelete struct {
ID int
}
// validateEmail validates the email.
func validateEmail(email string) bool {
if _, err := mail.ParseAddress(email); err != nil {
return false
}
return true
}

View File

@ -24,4 +24,5 @@ func (s *APIV1Service) Start(apiV1Group *echo.Group, secret string) {
s.registerAuthRoutes(apiV1Group, secret)
s.registerUserRoutes(apiV1Group)
s.registerWorkspaceRoutes(apiV1Group)
s.registerWorkspaceUserRoutes(apiV1Group)
}

213
api/v1/workspace_user.go Normal file
View File

@ -0,0 +1,213 @@
package v1
import (
"context"
"encoding/json"
"fmt"
"net/http"
"strconv"
"github.com/boojack/shortify/store"
"github.com/labstack/echo/v4"
)
type WorkspaceUser struct {
WorkspaceID int `json:"workspaceId"`
UserID int `json:"userId"`
Role Role `json:"role"`
// Related fields
Username string `json:"username"`
Nickname string `json:"nickname"`
}
type UpsertWorkspaceUserRequest struct {
WorkspaceID int `json:"workspaceId"`
UserID int `json:"userId"`
Role Role `json:"role"`
}
func (s *APIV1Service) registerWorkspaceUserRoutes(g *echo.Group) {
g.POST("/workspace/:id/user", func(c echo.Context) error {
ctx := c.Request().Context()
userID, ok := c.Get(getUserIDContextKey()).(int)
if !ok {
return echo.NewHTTPError(http.StatusUnauthorized, "Missing auth session")
}
workspaceID, err := strconv.Atoi(c.Param("id"))
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, "Malformatted workspace id").SetInternal(err)
}
currentWorkspaceUser, err := s.Store.GetWorkspaceUser(ctx, &store.FindWorkspaceUser{
WorkspaceID: &workspaceID,
UserID: &userID,
})
if err != nil {
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to find workspace user").SetInternal(err)
}
if currentWorkspaceUser.Role != store.RoleAdmin {
return echo.NewHTTPError(http.StatusForbidden, "Access forbidden to add workspace user").SetInternal(err)
}
upsert := &UpsertWorkspaceUserRequest{
WorkspaceID: workspaceID,
}
if err := json.NewDecoder(c.Request().Body).Decode(upsert); err != nil {
return echo.NewHTTPError(http.StatusBadRequest, "Malformatted post workspace user request").SetInternal(err)
}
workspaceUser, err := s.Store.UpsertWorkspaceUserV1(ctx, &store.WorkspaceUser{
WorkspaceID: upsert.WorkspaceID,
UserID: upsert.UserID,
Role: convertRoleToStore(upsert.Role),
})
if err != nil {
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to upsert workspace user").SetInternal(err)
}
composedWorkspaceUser, err := s.composeWorkspaceUser(ctx, workspaceUser)
if err != nil {
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to compose workspace user").SetInternal(err)
}
return c.JSON(http.StatusOK, composedWorkspaceUser)
})
g.GET("/workspace/:id/user", func(c echo.Context) error {
ctx := c.Request().Context()
workspaceID, err := strconv.Atoi(c.Param("id"))
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, "Malformatted workspace id").SetInternal(err)
}
workspaceUserList, err := s.Store.ListWorkspaceUsers(ctx, &store.FindWorkspaceUser{
WorkspaceID: &workspaceID,
})
if err != nil {
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to find workspace user list").SetInternal(err)
}
composedList := make([]*WorkspaceUser, 0, len(workspaceUserList))
for _, workspaceUser := range workspaceUserList {
composedWorkspaceUser, err := s.composeWorkspaceUser(ctx, workspaceUser)
if err != nil {
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to compose workspace user").SetInternal(err)
}
composedList = append(composedList, composedWorkspaceUser)
}
return c.JSON(http.StatusOK, composedList)
})
g.GET("/workspace/:workspaceId/user/:userId", func(c echo.Context) error {
ctx := c.Request().Context()
workspaceID, err := strconv.Atoi(c.Param("workspaceId"))
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, "Malformatted workspace id").SetInternal(err)
}
userID, err := strconv.Atoi(c.Param("userId"))
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, "Malformatted user id").SetInternal(err)
}
workspaceUser, err := s.Store.GetWorkspaceUser(ctx, &store.FindWorkspaceUser{
WorkspaceID: &workspaceID,
UserID: &userID,
})
if err != nil {
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to find workspace user").SetInternal(err)
}
composedWorkspaceUser, err := s.composeWorkspaceUser(ctx, workspaceUser)
if err != nil {
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to compose workspace user").SetInternal(err)
}
return c.JSON(http.StatusOK, composedWorkspaceUser)
})
g.DELETE("/workspace/:workspaceId/user/:userId", func(c echo.Context) error {
ctx := c.Request().Context()
currentUserID, ok := c.Get(getUserIDContextKey()).(int)
if !ok {
return echo.NewHTTPError(http.StatusUnauthorized, "Missing auth session")
}
workspaceID, err := strconv.Atoi(c.Param("workspaceId"))
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, "Malformatted workspace id").SetInternal(err)
}
userID, err := strconv.Atoi(c.Param("userId"))
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, "Malformatted user id").SetInternal(err)
}
currentWorkspaceUser, err := s.Store.GetWorkspaceUser(ctx, &store.FindWorkspaceUser{
WorkspaceID: &workspaceID,
UserID: &currentUserID,
})
if err != nil {
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to find workspace user").SetInternal(err)
}
if currentUserID != userID && currentWorkspaceUser.Role != store.RoleAdmin {
return echo.NewHTTPError(http.StatusForbidden, "Access forbidden to delete workspace user").SetInternal(err)
}
if err := s.Store.DeleteWorkspaceUserV1(ctx, &store.DeleteWorkspaceUser{
WorkspaceID: workspaceID,
UserID: userID,
}); err != nil {
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to delete workspace user").SetInternal(err)
}
return c.JSON(http.StatusOK, true)
})
}
func convertRoleToStore(role Role) store.Role {
switch role {
case RoleAdmin:
return store.RoleAdmin
case RoleUser:
return store.RoleUser
default:
return store.RoleUser
}
}
func convertRoleFromStore(role store.Role) Role {
switch role {
case store.RoleAdmin:
return RoleAdmin
case store.RoleUser:
return RoleUser
default:
return RoleUser
}
}
func (s *APIV1Service) composeWorkspaceUser(ctx context.Context, workspaceUser *store.WorkspaceUser) (*WorkspaceUser, error) {
user, err := s.Store.GetUser(ctx, &store.FindUser{
ID: &workspaceUser.UserID,
})
if err != nil {
return nil, err
}
if user == nil {
return nil, fmt.Errorf("Failed to find user %d", workspaceUser.UserID)
}
composedWorkspaceUser := &WorkspaceUser{
WorkspaceID: workspaceUser.WorkspaceID,
UserID: workspaceUser.UserID,
Role: convertRoleFromStore(workspaceUser.Role),
Username: user.Username,
Nickname: user.Nickname,
}
return composedWorkspaceUser, nil
}

View File

@ -1,56 +0,0 @@
package api
type Workspace struct {
ID int `json:"id"`
// Standard fields
CreatorID int `json:"creatorId"`
CreatedTs int64 `json:"createdTs"`
UpdatedTs int64 `json:"updatedTs"`
RowStatus RowStatus `json:"rowStatus"`
// Domain specific fields
Name string `json:"name"`
Title string `json:"title"`
Description string `json:"description"`
// Related fields
WorkspaceUserList []*WorkspaceUser `json:"workspaceUserList"`
}
type WorkspaceCreate struct {
CreatorID int
Name string `json:"name"`
Title string `json:"title"`
Description string `json:"description"`
}
type WorkspacePatch struct {
ID int
// Standard fields
RowStatus *RowStatus `json:"rowStatus"`
// Domain specific fields
Name *string `json:"name"`
Title *string `json:"title"`
Description *string `json:"description"`
}
type WorkspaceFind struct {
ID *int `json:"id"`
// Standard fields
RowStatus *RowStatus `json:"rowStatus"`
// Domain specific fields
Name *string `json:"name"`
// Related fields
MemberID *int
}
type WorkspaceDelete struct {
ID int
}

View File

@ -1,48 +0,0 @@
package api
// Role is the type of a role.
type Role string
const (
// RoleAdmin is the ADMIN role.
RoleAdmin Role = "ADMIN"
// RoleUser is the USER role.
RoleUser Role = "USER"
)
func (e Role) String() string {
switch e {
case RoleAdmin:
return "ADMIN"
case RoleUser:
return "USER"
}
return "USER"
}
type WorkspaceUser struct {
WorkspaceID int `json:"workspaceId"`
UserID int `json:"userId"`
Role Role `json:"role"`
// Related fields
Email string `json:"email"`
DisplayName string `json:"displayName"`
}
type WorkspaceUserUpsert struct {
WorkspaceID int `json:"workspaceId"`
UserID int `json:"userId"`
Role Role `json:"role"`
UpdatedTs *int64 `json:"updatedTs"`
}
type WorkspaceUserFind struct {
WorkspaceID *int
UserID *int
}
type WorkspaceUserDelete struct {
WorkspaceID int
UserID int
}