feat: toggle scoreboard support

Author: riflowth

domain/error/code.go

@@ -53,6 +53,7 @@ const (
 	ErrUpdateWorkspace            = 30014
 	ErrDeleteWorkspace            = 30015
 	ErrWorkspaceAlreadyJoin       = 30016
+	ErrToggleScoreboard           = 30017
 
 	ErrCreateInvitation      = 31000
 	ErrGetInvitation         = 31001

domain/workspace.go

@@ -6,17 +6,18 @@ import (
 )
 
 type RawWorkspace struct {
-	Id               int       `json:"id" db:"id"`
-	Name             string    `json:"name" db:"name"`
-	ProfileUrl       string    `json:"profileUrl" db:"profile_url"`
-	CreatedAt        time.Time `json:"createdAt" db:"created_at"`
-	OwnerName        string    `json:"ownerName" db:"owner_name"`
-	OwnerProfileUrl  string    `json:"ownerProfileUrl" db:"owner_profile_url"`
-	ParticipantCount int       `json:"participantCount" db:"participant_count"`
-	TotalAssignment  int       `json:"totalAssignment" db:"total_assignment"`
-	IsArchived       bool      `json:"isArchived" db:"is_archived"`
-	IsOpenScoreboard bool      `json:"-" db:"is_open_scoreboard"`
-	IsDeleted        bool      `json:"-" db:"is_deleted"`
+	Id                  int       `json:"id" db:"id"`
+	Name                string    `json:"name" db:"name"`
+	ProfileUrl          string    `json:"profileUrl" db:"profile_url"`
+	CreatedAt           time.Time `json:"createdAt" db:"created_at"`
+	OwnerName           string    `json:"ownerName" db:"owner_name"`
+	OwnerProfileUrl     string    `json:"ownerProfileUrl" db:"owner_profile_url"`
+	ParticipantCount    int       `json:"participantCount" db:"participant_count"`
+	TotalAssignment     int       `json:"totalAssignment" db:"total_assignment"`
+	IsArchived          bool      `json:"isArchived" db:"is_archived"`
+	IsScoreboardEnabled bool      `json:"is_scoreboard_enabled" db:"is_scoreboard_enabled"`
+	IsOpenScoreboard    bool      `json:"-" db:"is_open_scoreboard"`
+	IsDeleted           bool      `json:"-" db:"is_deleted"`
 }
 
 type Workspace struct {
@@ -100,6 +101,7 @@ type WorkspaceRepository interface {
 	GetRaw(id int) (*RawWorkspace, error)
 	GetRole(userId string, workspaceId int) (*WorkspaceRole, error)
 	GetScoreboard(workspaceId int) ([]WorkspaceRank, error)
+	ToggleScoreboard(workspaceId int, enabled bool) error
 	List(userId string) ([]Workspace, error)
 	ListParticipant(workspaceId int) ([]WorkspaceParticipant, error)
 	Update(userId string, workspace *Workspace) error
@@ -123,6 +125,7 @@ type WorkspaceUsecase interface {
 	GetRaw(id int) (*RawWorkspace, error)
 	GetRole(userId string, workspaceId int) (*WorkspaceRole, error)
 	GetScoreboard(workspaceId int) ([]WorkspaceRank, error)
+	ToggleScoreboard(workspaceId int, enabled bool) error
 	CheckPerm(userId string, workspaceId int) (bool, error)
 	CheckPermRole(userId string, workspaceId int, roles []WorkspaceRole) (bool, error)
 	List(userId string) ([]Workspace, error)

other/db/migrations/000014_add-toggle-scoreboard.down.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `workspace`
+DROP `is_scoreboard_enabled`;

other/db/migrations/000014_add-toggle-scoreboard.up.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `workspace`
+ADD `is_scoreboard_enabled` TINYINT(1) NOT NULL DEFAULT '0' AFTER `profile_url`;

platform/server/controller/workspace.go

@@ -175,6 +175,19 @@ func (c *WorkspaceController) GetScoreboard(ctx *fiber.Ctx) error {
 	return response.NewSuccessResponse(ctx, fiber.StatusOK, scoreboard)
 }
 
+func (c *WorkspaceController) ToggleScoreboard(ctx *fiber.Ctx) error {
+	var pl payload.ToggleScoreboardPayload
+	if ok, err := c.validator.Validate(&pl, ctx); !ok {
+		return err
+	}
+
+	if err := c.workspaceUsecase.ToggleScoreboard(pl.WorkspaceId, pl.Enabled); err != nil {
+		return err
+	}
+
+	return response.NewSuccessResponse(ctx, fiber.StatusOK, nil)
+}
+
 func (c *WorkspaceController) CreateInvitation(ctx *fiber.Ctx) error {
 	var pl payload.CreateInvitationPayload
 	if ok, err := c.validator.Validate(&pl, ctx); !ok {

platform/server/fiber.go

@@ -140,6 +140,7 @@ func (s *FiberServer) applyRoutes() {
 	workspace.Patch("/:workspaceId/participants/:userId", authMiddleware, workspaceMiddleware, workspaceController.UpdateParticipant)
 	workspace.Delete("/:workspaceId/participants/:userId", authMiddleware, workspaceMiddleware, workspaceController.DeleteParticipant)
 	workspace.Get("/:workspaceId/scoreboard", scoreboardMiddleware, cache.New(), workspaceController.GetScoreboard)
+	workspace.Patch("/:workspaceId/scoreboard", authMiddleware, workspaceMiddleware, workspaceController.ToggleScoreboard)
 
 	assignment := workspace.Group("/:workspaceId/assignments")
 	assignment.Get("/", authMiddleware, workspaceMiddleware, assignmentController.List)

platform/server/middleware/scoreboard.go

@@ -34,6 +34,27 @@ func NewScoreboardMiddleware(
 			return errs.New(errs.SameCode, "workspace id %d not found", pl.WorkspaceId)
 		}
 
+		if !workspace.IsScoreboardEnabled {
+			// Bypass for workspace owner and admin
+			sid, _ := validator.ValidateAuth(ctx)
+			if sid != "" {
+				user, err := authUsecase.Authenticate(sid)
+				if err != nil {
+					return errs.New(errs.SameCode, "cannot get user to get scoreboard", err)
+				}
+				role, err := workspaceUsecase.GetRole(user.Id, workspace.Id)
+				if err != nil {
+					return errs.New(errs.SameCode, "cannot get user role to get scoreboard", err)
+				}
+
+				if *role == domain.OwnerRole || *role == domain.AdminRole {
+					return ctx.Next()
+				}
+			}
+
+			return errs.New(errs.ErrGetScoreboard, "scoreboard is disabled")
+		}
+
 		if !workspace.IsOpenScoreboard {
 			sid, err := validator.ValidateAuth(ctx)
 			if sid == "" {

platform/server/payload/workspace.go

@@ -48,3 +48,8 @@ type UpdateParticipantPayload struct {
 	WorkspaceParticipantPath
 	Role string `json:"role" validate:"required"`
 }
+
+type ToggleScoreboardPayload struct {
+	WorkspacePath
+	Enabled bool `json:"enabled"`
+}

repository/workspace.go

@@ -225,6 +225,17 @@ func (r *workspaceRepository) GetScoreboard(workspaceId int) ([]domain.Workspace
 	return scoreboard, nil
 }
 
+func (r *workspaceRepository) ToggleScoreboard(workspaceId int, enabled bool) error {
+	_, err := r.db.Exec(
+		"UPDATE workspace SET is_scoreboard_enabled = ? WHERE id = ?",
+		enabled, workspaceId,
+	)
+	if err != nil {
+		return fmt.Errorf("cannot query to toggle scoreboard: %w", err)
+	}
+	return nil
+}
+
 func (r *workspaceRepository) List(userId string) ([]domain.Workspace, error) {
 	var workspaceIds []int
 

usecase/workspace.go

@@ -235,6 +235,13 @@ func (u *workspaceUsecase) GetScoreboard(workspaceId int) ([]domain.WorkspaceRan
 	return scoreboard, nil
 }
 
+func (u *workspaceUsecase) ToggleScoreboard(workspaceId int, enabled bool) error {
+	if err := u.workspaceRepository.ToggleScoreboard(workspaceId, enabled); err != nil {
+		return errs.New(errs.ErrToggleScoreboard, "cannot toggle scoreboard", err)
+	}
+	return nil
+}
+
 func (u *workspaceUsecase) GetInvitation(id string) (*domain.WorkspaceInvitation, error) {
 	invitation, err := u.workspaceRepository.GetInvitation(id)
 	if err != nil {