conduit/config/config.go

package config

import (
	"encoding/json"
	"errors"
	"fmt"
	"net/url"
	"os"
	"path/filepath"
	"reflect"
	"strings"

	"github.com/spf13/pflag"
)

var version string = "develop"

type ConfigDef struct {
	Key         string
	Env         string
	Default     string
	Description string
}

type BaseConfig struct {
	ServerAddress string `json:"server" description:"Conduit server address" default:"http://localhost:8080"`
	APIKey        string `json:"api_key" description:"API Key for the conduit API"`
	LogLevel      string `json:"log_level" default:"info" description:"Log level"`
	LogFormat     string `json:"log_format" default:"text" description:"Log format - text or json"`
}

func (c *BaseConfig) Validate() error {
	if c.APIKey == "" {
		return errors.New("api_key is required")
	}
	if c.ServerAddress == "" {
		return errors.New("server is required")
	}
	if _, err := url.Parse(c.ServerAddress); err != nil {
		return fmt.Errorf("server is invalid: %w", err)
	}
	if c.LogFormat != "text" && c.LogFormat != "json" {
		return fmt.Errorf("log format must be 'text' or 'json'")
	}
	return nil
}

type ServerConfig struct {
	BaseConfig
	BindAddress string `json:"bind" default:"0.0.0.0:8080" description:"Address the conduit server listens on"`
}

type ClientConfig struct {
	BaseConfig
	TunnelName   string `json:"name" description:"Tunnel name"`
	TunnelTarget string `json:"target" description:"Tunnel target address"`
}

func (c *ClientConfig) Validate() error {
	if err := c.BaseConfig.Validate(); err != nil {
		return err
	}
	if c.TunnelTarget == "" {
		return fmt.Errorf("target is required")
	}
	return nil
}

func GetServerConfig(cmdFlags *pflag.FlagSet) (*ServerConfig, error) {
	defs := GetConfigDefs[ServerConfig]()

	cfgValues := make(map[string]string)
	for _, def := range defs {
		cfgValues[def.Key] = getConfigValue(cmdFlags, nil, def)
	}

	cfg := &ServerConfig{
		BaseConfig:  getBaseConfig(cfgValues),
		BindAddress: cfgValues["bind"],
	}

	// Initialize Logger
	initLogger(cfg.BaseConfig)

	return cfg, cfg.Validate()
}

func GetClientConfig(cmdFlags *pflag.FlagSet) (*ClientConfig, error) {
	defs := GetConfigDefs[ClientConfig]()

	// Load Client Config File
	fileValues, err := getClientConfigFileValues()
	if err != nil {
		return nil, err
	}

	cfgValues := make(map[string]string)
	for _, def := range defs {
		cfgValues[def.Key] = getConfigValue(cmdFlags, fileValues, def)
	}

	cfg := &ClientConfig{
		BaseConfig:   getBaseConfig(cfgValues),
		TunnelName:   cfgValues["name"],
		TunnelTarget: cfgValues["target"],
	}

	// Initialize Logger
	initLogger(cfg.BaseConfig)

	return cfg, cfg.Validate()
}

func GetConfigDefs[T ServerConfig | ClientConfig]() []ConfigDef {
	var defs []ConfigDef
	processFields(reflect.TypeFor[T](), &defs)
	return defs
}

func GetVersion() string {
	return version
}

func getBaseConfig(cfgValues map[string]string) BaseConfig {
	return BaseConfig{
		ServerAddress: cfgValues["server"],
		APIKey:        cfgValues["api_key"],
		LogLevel:      cfgValues["log_level"],
		LogFormat:     cfgValues["log_format"],
	}
}

func getClientConfigFileValues() (map[string]string, error) {
	path, err := findConfigFile()
	if err != nil {
		return nil, err
	}
	if path == "" {
		return nil, nil
	}

	// Load Config File
	values, err := loadConfigFile(path)
	if err != nil {
		return nil, err
	}

	// Keep Client File Settings Explicit - Tunnel name and target are intentionally
	// not read from the config file because they should be provided per invocation.
	clientValues := make(map[string]string)
	for key, value := range values {
		if isClientFileConfigKey(key) {
			clientValues[key] = value
		}
	}
	return clientValues, nil
}

func getConfigValue(cmdFlags *pflag.FlagSet, fileValues map[string]string, def ConfigDef) string {
	// 1. Get Flags First
	if cmdFlags != nil {
		if val, err := cmdFlags.GetString(def.Key); err == nil && val != "" && val != def.Default {
			return val
		}
	}

	// 2. Environment Variables Next
	if envVal := os.Getenv(def.Env); envVal != "" {
		return envVal
	}

	// 3. Config File Next
	if fileValues != nil {
		if val := fileValues[def.Key]; val != "" {
			return val
		}
	}

	// 4. Defaults Last
	return def.Default
}

func findConfigFile() (string, error) {
	// Check Project Config
	localPath := "conduit.json"
	if _, err := os.Stat(localPath); err == nil {
		return localPath, nil
	} else if !errors.Is(err, os.ErrNotExist) {
		return "", err
	}

	// Check User Config
	configDir, err := os.UserConfigDir()
	if err != nil {
		return "", nil
	}
	userPath := filepath.Join(configDir, "conduit", "config.json")
	if _, err := os.Stat(userPath); err == nil {
		return userPath, nil
	} else if !errors.Is(err, os.ErrNotExist) {
		return "", err
	}

	return "", nil
}

func loadConfigFile(path string) (map[string]string, error) {
	// Read Config File
	data, err := os.ReadFile(path)
	if err != nil {
		return nil, err
	}

	// Decode Config File
	values := make(map[string]string)
	if err := json.Unmarshal(data, &values); err != nil {
		return nil, fmt.Errorf("failed to parse config file %s: %w", path, err)
	}
	return values, nil
}

func isClientFileConfigKey(key string) bool {
	switch key {
	case "server", "api_key", "log_level", "log_format":
		return true
	default:
		return false
	}
}

func processFields(t reflect.Type, defs *[]ConfigDef) {
	for i := 0; i < t.NumField(); i++ {
		field := t.Field(i)

		// Process Embedded (BaseConfig)
		if field.Anonymous {
			processFields(field.Type, defs)
			continue
		}

		// Extract Struct Tags
		jsonTag := field.Tag.Get("json")
		defaultTag := field.Tag.Get("default")
		descriptionTag := field.Tag.Get("description")

		// Skip JSON Fields
		if jsonTag == "" {
			continue
		}

		// Get Key & Env
		key := strings.Split(jsonTag, ",")[0]
		env := "CONDUIT_" + strings.ToUpper(key)

		*defs = append(*defs, ConfigDef{
			Key:         key,
			Env:         env,
			Default:     defaultTag,
			Description: descriptionTag,
		})
	}
}