Skip to content

Modern Docker Management, Designed for Everyone

refactor: use constant type for config values

Kyle Mendelle13c3c7172a7
diff --git a/backend/internal/api/oidc_handler.go b/backend/internal/api/oidc_handler.go
index d1c9c6379..f59011713 100644
--- a/backend/internal/api/oidc_handler.go
+++ b/backend/internal/api/oidc_handler.go
@@ -5,7 +5,6 @@ import (
"time"
"github.com/gin-gonic/gin"
- "github.com/ofkm/arcane-backend/internal/config"
"github.com/ofkm/arcane-backend/internal/dto"
"github.com/ofkm/arcane-backend/internal/services"
"github.com/ofkm/arcane-backend/internal/utils/cookie"
@@ -14,12 +13,11 @@ import (
type OidcHandler struct {
authService *services.AuthService
oidcService *services.OidcService
- appConfig *config.Config
}
-func NewOidcHandler(group *gin.RouterGroup, authService *services.AuthService, oidcService *services.OidcService, appConfig *config.Config) {
+func NewOidcHandler(group *gin.RouterGroup, authService *services.AuthService, oidcService *services.OidcService) {
- handler := &OidcHandler{authService: authService, oidcService: oidcService, appConfig: appConfig}
+ handler := &OidcHandler{authService: authService, oidcService: oidcService}
apiGroup := group.Group("/oidc")
{
@@ -140,7 +138,7 @@ func (h *OidcHandler) GetOidcConfig(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{
"clientId": config.ClientID,
- "redirectUri": h.appConfig.GetOidcRedirectURI(),
+ "redirectUri": h.oidcService.GetOidcRedirectURL(),
"issuerUrl": config.IssuerURL,
"authorizationEndpoint": config.AuthorizationEndpoint,
"tokenEndpoint": config.TokenEndpoint,
diff --git a/backend/internal/bootstrap/db_bootstrap.go b/backend/internal/bootstrap/db_bootstrap.go
index 338105ca4..8c165a861 100644
--- a/backend/internal/bootstrap/db_bootstrap.go
+++ b/backend/internal/bootstrap/db_bootstrap.go
@@ -9,7 +9,7 @@ import (
)
func initializeDBAndMigrate(cfg *config.Config) (*database.DB, error) {
- db, err := database.Initialize(cfg.DatabaseURL, cfg.Environment)
+ db, err := database.Initialize(cfg.DatabaseURL)
if err != nil {
return nil, fmt.Errorf("failed to initialize database: %w", err)
}
diff --git a/backend/internal/bootstrap/router_bootstrap.go b/backend/internal/bootstrap/router_bootstrap.go
index abb91c1ee..3f00df087 100644
--- a/backend/internal/bootstrap/router_bootstrap.go
+++ b/backend/internal/bootstrap/router_bootstrap.go
@@ -77,7 +77,7 @@ func setupRouter(cfg *config.Config, appServices *Services) *gin.Engine {
api.NewVersionHandler(apiGroup, appServices.Version)
api.NewAuthHandler(apiGroup, appServices.User, appServices.Auth, appServices.Oidc, authMiddleware)
api.NewEventHandler(apiGroup, appServices.Event, authMiddleware)
- api.NewOidcHandler(apiGroup, appServices.Auth, appServices.Oidc, cfg)
+ api.NewOidcHandler(apiGroup, appServices.Auth, appServices.Oidc)
api.NewEnvironmentHandler(apiGroup, appServices.Environment, appServices.Settings, authMiddleware, cfg)
api.NewContainerRegistryHandler(apiGroup, appServices.ContainerRegistry, authMiddleware)
api.NewTemplateHandler(apiGroup, appServices.Template, authMiddleware)
diff --git a/backend/internal/config/config.go b/backend/internal/config/config.go
index 0c524115c..33dc4b279 100644
--- a/backend/internal/config/config.go
+++ b/backend/internal/config/config.go
@@ -6,15 +6,20 @@ import (
"strings"
)
+type AppEnvironment string
+
const (
- defaultSqliteString string = "file:data/arcane.db?_pragma=journal_mode(WAL)&_pragma=busy_timeout(2500)&_txlock=immediate"
+ AppEnvironmentProduction AppEnvironment = "production"
+ AppEnvironmentDevelopment AppEnvironment = "development"
+ AppEnvironmentTest AppEnvironment = "test"
+ defaultSqliteString string = "file:data/arcane.db?_pragma=journal_mode(WAL)&_pragma=busy_timeout(2500)&_txlock=immediate"
)
type Config struct {
AppUrl string
DatabaseURL string
Port string
- Environment string
+ Environment AppEnvironment
JWTSecret string
EncryptionKey string
@@ -42,7 +47,7 @@ func Load() *Config {
AppUrl: getEnvOrDefault("APP_URL", "http://localhost:3552"),
DatabaseURL: getEnvOrDefault("DATABASE_URL", defaultSqliteString),
Port: getEnvOrDefault("PORT", "3552"),
- Environment: getEnvOrDefault("ENVIRONMENT", "production"),
+ Environment: getEnvOrDefault("ENVIRONMENT", AppEnvironmentProduction),
JWTSecret: getEnvOrDefault("JWT_SECRET", "default-jwt-secret-change-me"),
EncryptionKey: getEnvOrDefault("ENCRYPTION_KEY", "arcane-dev-key-32-characters!!!"),
@@ -66,18 +71,21 @@ func Load() *Config {
}
}
-func (c *Config) GetOidcRedirectURI() string {
- baseUrl := strings.TrimSuffix(c.AppUrl, "/")
- return baseUrl + "/auth/oidc/callback"
-}
-
-func getEnvOrDefault(key, defaultValue string) string {
+func getEnvOrDefault[T interface{ ~string }](key string, defaultValue T) T {
if value := os.Getenv(key); value != "" {
- return value
+ return T(value)
}
return defaultValue
}
+func (a AppEnvironment) IsProdEnvironment() bool {
+ return a == AppEnvironmentProduction
+}
+
+func (a AppEnvironment) IsTestEnvironment() bool {
+ return a == AppEnvironmentTest
+}
+
func getBoolEnvOrDefault(key string, defaultValue bool) bool {
if v, ok := os.LookupEnv(key); ok && v != "" {
if b, err := strconv.ParseBool(v); err == nil {
diff --git a/backend/internal/database/database.go b/backend/internal/database/database.go
index 8a2c67f11..accd5195c 100644
--- a/backend/internal/database/database.go
+++ b/backend/internal/database/database.go
@@ -35,8 +35,8 @@ func SetGormLogger(l logger.Interface) {
customGormLogger = l
}
-func Initialize(databaseURL string, environment string) (*DB, error) {
- db, err := connectDatabase(databaseURL, environment)
+func Initialize(databaseURL string) (*DB, error) {
+ db, err := connectDatabase(databaseURL)
if err != nil {
return nil, fmt.Errorf("failed to connect to database: %w", err)
}
@@ -86,7 +86,7 @@ func Initialize(databaseURL string, environment string) (*DB, error) {
return db, nil
}
-func connectDatabase(databaseURL string, environment string) (*DB, error) {
+func connectDatabase(databaseURL string) (*DB, error) {
var dialector gorm.Dialector
switch {
diff --git a/backend/internal/job/analytics_job.go b/backend/internal/job/analytics_job.go
index 3ca04e0ee..19fbfc3f3 100644
--- a/backend/internal/job/analytics_job.go
+++ b/backend/internal/job/analytics_job.go
@@ -49,7 +49,7 @@ func NewAnalyticsJob(
}
func (j *AnalyticsJob) Register(ctx context.Context) error {
- if j.cfg.AnalyticsDisabled || !j.isProduction() {
+ if j.cfg.AnalyticsDisabled || !j.cfg.Environment.IsProdEnvironment() {
slog.InfoContext(ctx, "analytics disabled or not in production; heartbeat job not registered",
"analyticsDisabled", j.cfg.AnalyticsDisabled, "env", j.cfg.Environment)
return nil
@@ -71,7 +71,7 @@ func (j *AnalyticsJob) Register(ctx context.Context) error {
}
func (j *AnalyticsJob) Execute(parentCtx context.Context) error {
- if j.cfg.AnalyticsDisabled || !j.isProduction() {
+ if j.cfg.AnalyticsDisabled || !j.cfg.Environment.IsProdEnvironment() {
slog.InfoContext(parentCtx, "analytics disabled or not in production; skipping heartbeat",
"analyticsDisabled", j.cfg.AnalyticsDisabled, "env", j.cfg.Environment)
return nil
@@ -131,11 +131,6 @@ func (j *AnalyticsJob) Execute(parentCtx context.Context) error {
return nil
}
-func (j *AnalyticsJob) isProduction() bool {
- env := strings.ToLower(strings.TrimSpace(j.cfg.Environment))
- return env == "production" || env == "prod"
-}
-
func getVersion() string {
if v := strings.TrimSpace(config.Version); v != "" && v != "dev" {
return v
diff --git a/backend/internal/services/oidc_service.go b/backend/internal/services/oidc_service.go
index cd34a8485..b6dc126d7 100644
--- a/backend/internal/services/oidc_service.go
+++ b/backend/internal/services/oidc_service.go
@@ -102,7 +102,7 @@ func (s *OidcService) GenerateAuthURL(ctx context.Context, redirectTo string) (s
ClientID: config.ClientID,
ClientSecret: config.ClientSecret,
Endpoint: provider.Endpoint(),
- RedirectURL: s.config.GetOidcRedirectURI(),
+ RedirectURL: s.GetOidcRedirectURL(),
Scopes: scopes,
}
@@ -130,6 +130,11 @@ func (s *OidcService) GenerateAuthURL(ctx context.Context, redirectTo string) (s
return authURL, encodedState, nil
}
+func (s *OidcService) GetOidcRedirectURL() string {
+ baseUrl := strings.TrimSuffix(s.config.AppUrl, "/")
+ return baseUrl + "/auth/oidc/callback"
+}
+
func (s *OidcService) getOrDiscoverProvider(ctx context.Context, issuer string) (*oidc.Provider, error) {
s.providerMutex.RLock()
if s.providerCache != nil && s.cachedIssuer == issuer {
@@ -171,7 +176,7 @@ func (s *OidcService) exchangeToken(ctx context.Context, cfg *models.OidcConfig,
ClientID: cfg.ClientID,
ClientSecret: cfg.ClientSecret,
Endpoint: provider.Endpoint(),
- RedirectURL: s.config.GetOidcRedirectURI(),
+ RedirectURL: s.GetOidcRedirectURL(),
Scopes: scopes,
}
@@ -385,7 +390,7 @@ func (s *OidcService) RefreshToken(ctx context.Context, refreshToken string) (*d
ClientID: cfg.ClientID,
ClientSecret: cfg.ClientSecret,
Endpoint: provider.Endpoint(),
- RedirectURL: s.config.GetOidcRedirectURI(),
+ RedirectURL: s.GetOidcRedirectURL(),
Scopes: scopes,
}