Refactor configuration system with centralized type-safe config package

- Create internal/config package with unified config structs and validation
- Abstract viper dependency behind config.Loader interface for better testability
- Replace manual config parsing and type assertions with type-safe loading
- Consolidate AuthConfig, SiteConfig, and DiscoveryConfig into single package
- Add comprehensive validation with clear error messages
- Remove ~200 lines of duplicate config handling code
- Maintain backward compatibility with existing config files
This commit is contained in:
2025-10-08 17:58:03 +02:00
parent 2959ecedf9
commit 38c2897ece
11 changed files with 550 additions and 332 deletions

View File

@@ -13,6 +13,7 @@ import (
"github.com/coreos/go-oidc/v3/oidc"
"github.com/golang-jwt/jwt/v5"
"github.com/insertr/insertr/internal/config"
"golang.org/x/oauth2"
)
@@ -24,31 +25,10 @@ type UserInfo struct {
Provider string `json:"iss,omitempty"`
}
// AuthConfig holds authentication configuration
type AuthConfig struct {
DevMode bool
Provider string
JWTSecret string
OAuthConfigs map[string]OAuthConfig
OIDC *OIDCConfig
}
// OAuthConfig holds OAuth provider configuration
type OAuthConfig struct {
ClientID string
ClientSecret string
RedirectURL string
Scopes []string
}
// OIDCConfig holds OIDC configuration for Authentik
type OIDCConfig struct {
Endpoint string
ClientID string
ClientSecret string
RedirectURL string
Scopes []string
}
// Type aliases for backward compatibility
type AuthConfig = config.AuthConfig
type OAuthConfig = config.OAuthConfig
type OIDCConfig = config.OIDCConfig
// AuthService handles authentication operations
type AuthService struct {

67
internal/config/config.go Normal file
View File

@@ -0,0 +1,67 @@
package config
type Config struct {
Database DatabaseConfig `yaml:"database" mapstructure:"database"`
API APIConfig `yaml:"api" mapstructure:"api"`
CLI CLIConfig `yaml:"cli" mapstructure:"cli"`
Server ServerConfig `yaml:"server" mapstructure:"server"`
Auth AuthConfig `yaml:"auth" mapstructure:"auth"`
}
type DatabaseConfig struct {
Path string `yaml:"path" mapstructure:"path"`
}
type APIConfig struct {
URL string `yaml:"url" mapstructure:"url"`
Key string `yaml:"key" mapstructure:"key"`
}
type CLIConfig struct {
SiteID string `yaml:"site_id" mapstructure:"site_id"`
}
type ServerConfig struct {
Port int `yaml:"port" mapstructure:"port"`
Host string `yaml:"host" mapstructure:"host"`
Sites []SiteConfig `yaml:"sites" mapstructure:"sites"`
}
type AuthConfig struct {
DevMode bool `yaml:"dev_mode" mapstructure:"dev_mode"`
Provider string `yaml:"provider" mapstructure:"provider"`
JWTSecret string `yaml:"jwt_secret" mapstructure:"jwt_secret"`
OAuthConfigs map[string]OAuthConfig `yaml:"oauth_configs" mapstructure:"oauth_configs"`
OIDC *OIDCConfig `yaml:"oidc" mapstructure:"oidc"`
}
type OAuthConfig struct {
ClientID string `yaml:"client_id" mapstructure:"client_id"`
ClientSecret string `yaml:"client_secret" mapstructure:"client_secret"`
RedirectURL string `yaml:"redirect_url" mapstructure:"redirect_url"`
Scopes []string `yaml:"scopes" mapstructure:"scopes"`
}
type OIDCConfig struct {
Endpoint string `yaml:"endpoint" mapstructure:"endpoint"`
ClientID string `yaml:"client_id" mapstructure:"client_id"`
ClientSecret string `yaml:"client_secret" mapstructure:"client_secret"`
RedirectURL string `yaml:"redirect_url" mapstructure:"redirect_url"`
Scopes []string `yaml:"scopes" mapstructure:"scopes"`
}
type SiteConfig struct {
SiteID string `yaml:"site_id" mapstructure:"site_id"`
Path string `yaml:"path" mapstructure:"path"`
SourcePath string `yaml:"source_path" mapstructure:"source_path"`
Domain string `yaml:"domain" mapstructure:"domain"`
AutoEnhance bool `yaml:"auto_enhance" mapstructure:"auto_enhance"`
Discovery *DiscoveryConfig `yaml:"discovery" mapstructure:"discovery"`
}
type DiscoveryConfig struct {
Enabled bool `yaml:"enabled" mapstructure:"enabled"`
Aggressive bool `yaml:"aggressive" mapstructure:"aggressive"`
Containers bool `yaml:"containers" mapstructure:"containers"`
Individual bool `yaml:"individual" mapstructure:"individual"`
}

106
internal/config/loader.go Normal file
View File

@@ -0,0 +1,106 @@
package config
import (
"fmt"
"github.com/spf13/viper"
)
type Loader interface {
Load(configFile string) (*Config, error)
LoadWithDefaults() (*Config, error)
LoadWithFlags(dbPath, apiURL, apiKey, siteID string) (*Config, error)
}
type viperLoader struct{}
func NewLoader() Loader {
return &viperLoader{}
}
func (l *viperLoader) Load(configFile string) (*Config, error) {
v := viper.New()
if configFile != "" {
v.SetConfigFile(configFile)
} else {
v.AddConfigPath(".")
v.SetConfigName("insertr")
v.SetConfigType("yaml")
}
v.SetEnvPrefix("INSERTR")
v.AutomaticEnv()
if err := v.ReadInConfig(); err != nil {
if _, ok := err.(viper.ConfigFileNotFoundError); !ok {
return nil, fmt.Errorf("failed to read config file: %w", err)
}
}
config := &Config{}
if err := v.Unmarshal(config); err != nil {
return nil, fmt.Errorf("failed to unmarshal config: %w", err)
}
if err := l.setDefaults(config); err != nil {
return nil, err
}
return config, validate(config)
}
func (l *viperLoader) LoadWithDefaults() (*Config, error) {
return l.Load("")
}
func (l *viperLoader) LoadWithFlags(dbPath, apiURL, apiKey, siteID string) (*Config, error) {
config, err := l.LoadWithDefaults()
if err != nil {
return nil, err
}
if dbPath != "" {
config.Database.Path = dbPath
}
if apiURL != "" {
config.API.URL = apiURL
}
if apiKey != "" {
config.API.Key = apiKey
}
if siteID != "" {
config.CLI.SiteID = siteID
}
return config, validate(config)
}
func (l *viperLoader) setDefaults(config *Config) error {
if config.Database.Path == "" {
config.Database.Path = "./insertr.db"
}
if config.CLI.SiteID == "" {
config.CLI.SiteID = "demo"
}
if config.Server.Port == 0 {
config.Server.Port = 8080
}
if config.Server.Host == "" {
config.Server.Host = "localhost"
}
if config.Auth.Provider == "" {
config.Auth.Provider = "mock"
}
if config.Auth.JWTSecret == "" {
config.Auth.JWTSecret = "dev-secret-change-in-production"
config.Auth.DevMode = true
}
return nil
}

View File

@@ -0,0 +1,190 @@
package config
import (
"fmt"
"net/url"
"os"
"path/filepath"
"strings"
)
func validate(config *Config) error {
if err := validateDatabase(config.Database); err != nil {
return fmt.Errorf("database config: %w", err)
}
if err := validateAPI(config.API); err != nil {
return fmt.Errorf("api config: %w", err)
}
if err := validateCLI(config.CLI); err != nil {
return fmt.Errorf("cli config: %w", err)
}
if err := validateServer(config.Server); err != nil {
return fmt.Errorf("server config: %w", err)
}
if err := validateAuth(config.Auth); err != nil {
return fmt.Errorf("auth config: %w", err)
}
return nil
}
func validateDatabase(config DatabaseConfig) error {
if config.Path == "" {
return fmt.Errorf("path is required")
}
if strings.Contains(config.Path, "postgres://") || strings.Contains(config.Path, "postgresql://") {
if _, err := url.Parse(config.Path); err != nil {
return fmt.Errorf("invalid PostgreSQL connection string: %w", err)
}
return nil
}
dir := filepath.Dir(config.Path)
if _, err := os.Stat(dir); os.IsNotExist(err) {
return fmt.Errorf("database directory does not exist: %s", dir)
}
return nil
}
func validateAPI(config APIConfig) error {
if config.URL != "" {
if _, err := url.Parse(config.URL); err != nil {
return fmt.Errorf("invalid URL: %w", err)
}
}
if config.URL != "" && config.Key == "" {
return fmt.Errorf("api key is required when api url is specified")
}
return nil
}
func validateCLI(config CLIConfig) error {
if config.SiteID == "" {
return fmt.Errorf("site_id is required")
}
if strings.TrimSpace(config.SiteID) != config.SiteID {
return fmt.Errorf("site_id cannot have leading or trailing whitespace")
}
return nil
}
func validateServer(config ServerConfig) error {
if config.Port < 1 || config.Port > 65535 {
return fmt.Errorf("port must be between 1 and 65535, got %d", config.Port)
}
if config.Host == "" {
return fmt.Errorf("host is required")
}
siteIDs := make(map[string]bool)
for i, site := range config.Sites {
if err := validateSite(site); err != nil {
return fmt.Errorf("site %d: %w", i, err)
}
if siteIDs[site.SiteID] {
return fmt.Errorf("duplicate site_id: %s", site.SiteID)
}
siteIDs[site.SiteID] = true
}
return nil
}
func validateSite(config SiteConfig) error {
if config.SiteID == "" {
return fmt.Errorf("site_id is required")
}
if config.Path == "" {
return fmt.Errorf("path is required")
}
if config.SourcePath != "" {
if _, err := os.Stat(config.SourcePath); os.IsNotExist(err) {
return fmt.Errorf("source_path does not exist: %s", config.SourcePath)
}
}
if config.Discovery != nil {
if err := validateDiscovery(*config.Discovery); err != nil {
return fmt.Errorf("discovery config: %w", err)
}
}
return nil
}
func validateDiscovery(config DiscoveryConfig) error {
return nil
}
func validateAuth(config AuthConfig) error {
if config.Provider == "" {
return fmt.Errorf("provider is required")
}
validProviders := []string{"mock", "authentik"}
valid := false
for _, provider := range validProviders {
if config.Provider == provider {
valid = true
break
}
}
if !valid {
return fmt.Errorf("invalid provider %q, must be one of: %s", config.Provider, strings.Join(validProviders, ", "))
}
if config.Provider == "authentik" {
if config.OIDC == nil {
return fmt.Errorf("oidc config is required for authentik provider")
}
if err := validateOIDC(*config.OIDC); err != nil {
return fmt.Errorf("oidc config: %w", err)
}
}
if config.JWTSecret == "" {
return fmt.Errorf("jwt_secret is required")
}
return nil
}
func validateOIDC(config OIDCConfig) error {
if config.Endpoint == "" {
return fmt.Errorf("endpoint is required")
}
if _, err := url.Parse(config.Endpoint); err != nil {
return fmt.Errorf("invalid endpoint URL: %w", err)
}
if config.ClientID == "" {
return fmt.Errorf("client_id is required")
}
if config.ClientSecret == "" {
return fmt.Errorf("client_secret is required")
}
if config.RedirectURL != "" {
if _, err := url.Parse(config.RedirectURL); err != nil {
return fmt.Errorf("invalid redirect_url: %w", err)
}
}
return nil
}

View File

@@ -7,6 +7,7 @@ import (
"path/filepath"
"strings"
"github.com/insertr/insertr/internal/config"
"github.com/insertr/insertr/internal/engine"
)
@@ -17,13 +18,8 @@ type EnhancementConfig struct {
GenerateIDs bool
}
// DiscoveryConfig configures element discovery
type DiscoveryConfig struct {
Enabled bool
Aggressive bool
Containers bool
Individual bool
}
// Type alias for backward compatibility
type DiscoveryConfig = config.DiscoveryConfig
// Enhancer combines discovery, ID generation, and content injection in unified pipeline
type Enhancer struct {

View File

@@ -8,18 +8,12 @@ import (
"strings"
"sync"
"github.com/insertr/insertr/internal/config"
"github.com/insertr/insertr/internal/engine"
)
// SiteConfig represents configuration for a registered site
type SiteConfig struct {
SiteID string `yaml:"site_id"`
Path string `yaml:"path"` // Served path (enhanced output)
SourcePath string `yaml:"source_path"` // Source path (for enhancement)
Domain string `yaml:"domain,omitempty"`
AutoEnhance bool `yaml:"auto_enhance"`
Discovery *DiscoveryConfig `yaml:"discovery,omitempty"` // Override discovery settings
}
// Type alias for backward compatibility
type SiteConfig = config.SiteConfig
// SiteManager handles registration and enhancement of static sites
type SiteManager struct {