feat: add feature flags

Author: riflowth

domain/domain.go

@@ -21,6 +21,7 @@ type Repository struct {
 	Workspace  WorkspaceRepository
 	Assignment AssignmentRepository
 	Survey     SurveyRepository
+	Misc       MiscRepository
 }
 
 type Usecase struct {
@@ -31,6 +32,7 @@ type Usecase struct {
 	Workspace  WorkspaceUsecase
 	Assignment AssignmentUsecase
 	Survey     SurveyUsecase
+	Misc       MiscUsecase
 }
 
 type Publisher struct {

domain/misc.go

@@ -0,0 +1,9 @@
+package domain
+
+type MiscRepository interface {
+	GetFeatureFlag(feature string) (bool, error)
+}
+
+type MiscUsecase interface {
+	GetFeatureFlag(feature string) (bool, error)
+}

main.go

@@ -142,6 +142,7 @@ func initRepository(mysql *platform.MySql) *domain.Repository {
 		Workspace:  repository.NewWorkspaceRepository(mysql),
 		Assignment: repository.NewAssignmentRepository(mysql),
 		Survey:     repository.NewSurveyRepository(mysql),
+		Misc:       repository.NewMiscRepsitory(mysql),
 	}
 }
 
@@ -152,6 +153,7 @@ func initUsecase(
 	repository *domain.Repository,
 	publisher *domain.Publisher,
 ) *domain.Usecase {
+	miscUsecase := usecase.NewMiscUsecase(repository.Misc)
 	googleUsecase := usecase.NewGoogleUsecase(cfg)
 	sessionUsecase := usecase.NewSessionUsecase(cfg, repository.Session)
 	userUsecase := usecase.NewUserUsecase(platform.SeaweedFs, repository.User, sessionUsecase)
@@ -168,6 +170,7 @@ func initUsecase(
 		Workspace:  workspaceUsecase,
 		Assignment: assignmentUsecase,
 		Survey:     surveyUsecase,
+		Misc:       miscUsecase,
 	}
 }
 

other/db/migrations/000013_add-ff.down.sql

@@ -0,0 +1 @@
+DROP TABLE IF EXISTS `feature_flag`;

other/db/migrations/000013_add-ff.up.sql

@@ -0,0 +1,4 @@
+CREATE TABLE IF NOT EXISTS `feature_flag` (
+  `feature` VARCHAR(255) NOT NULL,
+  `enabled` BOOLEAN NOT NULL
+)

platform/server/fiber.go

@@ -97,7 +97,7 @@ func (s *FiberServer) applyRoutes() {
 	authMiddleware := middleware.NewAuthMiddleware(validator, s.usecase.Auth)
 	publishableWorkspaceMiddleware := middleware.NewPublishableWorkspaceMiddleware(validator, s.usecase.Auth, s.usecase.Workspace)
 	workspaceMiddleware := middleware.NewWorkspaceMiddleware(validator, s.usecase.Workspace)
-	scoreboardMiddleware := middleware.NewScoreboardMiddleware(validator, s.usecase.Auth, s.usecase.Workspace)
+	scoreboardMiddleware := middleware.NewScoreboardMiddleware(validator, s.usecase.Auth, s.usecase.Workspace, s.usecase.Misc)
 
 	// Initialize Controllers
 	healtController := controller.NewHealthController(s.cfg)

platform/server/middleware/scoreboard.go

@@ -11,8 +11,17 @@ func NewScoreboardMiddleware(
 	validator domain.PayloadValidator,
 	authUsecase domain.AuthUsecase,
 	workspaceUsecase domain.WorkspaceUsecase,
+	miscUsecase domain.MiscUsecase,
 ) fiber.Handler {
 	return func(ctx *fiber.Ctx) error {
+		enabled, err := miscUsecase.GetFeatureFlag("scoreboard")
+		if err != nil {
+			return errs.New(errs.ErrGetScoreboard, "error get scoreboard ff", err)
+		}
+		if !enabled {
+			return errs.New(errs.ErrGetScoreboard, "scoreboard feature is disabled")
+		}
+
 		var pl payload.WorkspacePath
 		if ok, err := validator.Validate(&pl, ctx); !ok {
 			return err

repository/misc.go

@@ -0,0 +1,27 @@
+package repository
+
+import (
+	"database/sql"
+
+	"github.com/codern-org/codern/domain"
+	"github.com/codern-org/codern/platform"
+)
+
+type miscRepository struct {
+	db *platform.MySql
+}
+
+func NewMiscRepsitory(db *platform.MySql) domain.MiscRepository {
+	return &miscRepository{db: db}
+}
+
+func (r *miscRepository) GetFeatureFlag(feature string) (bool, error) {
+	var enabled bool
+	err := r.db.Get(&enabled, "SELECT enabled FROM feature_flag WHERE feature = ?", feature)
+	if err == sql.ErrNoRows {
+		return false, nil
+	} else if err != nil {
+		return false, err
+	}
+	return enabled, nil
+}

usecase/misc.go

@@ -0,0 +1,15 @@
+package usecase
+
+import "github.com/codern-org/codern/domain"
+
+type miscUsecase struct {
+	miscRepository domain.MiscRepository
+}
+
+func NewMiscUsecase(miscRepository domain.MiscRepository) domain.MiscUsecase {
+	return &miscUsecase{miscRepository: miscRepository}
+}
+
+func (u *miscUsecase) GetFeatureFlag(feature string) (bool, error) {
+	return u.miscRepository.GetFeatureFlag(feature)
+}