finish config refactor

Author: crimist

cmd/main_test.go

@@ -12,73 +12,61 @@ import (
 func TestMain(m *testing.M) {
 	conf := &config.Configuration{
 		LogLevel: "debug",
-		Debug: struct{ Pprof int }{
-			Pprof: 0,
-		},
+		Debug:    struct{ Pprof int }{},
 		Stats: struct {
 			General  bool
 			IP       bool
 			Interval time.Duration
-		}{
-			General:  false,
-			IP:       false,
-			Interval: 0,
-		},
+		}{},
 		UDP: struct {
-			Enabled bool
-			IP      string
-			Port    int
-			Threads int
-			ConnDB  struct {
+			Port        int
+			IP          string
+			Routines    int
+			Connections struct {
 				Validate bool
-				Size     uint64
-				Trim     time.Duration
+				GC       time.Duration
 				Expiry   time.Duration
 			}
 		}{
-			ConnDB: struct {
+			Connections: struct {
 				Validate bool
-				Size     uint64
-				Trim     time.Duration
+				GC       time.Duration
 				Expiry   time.Duration
 			}{
 				Validate: true,
-				Trim:     1 * time.Hour,
+				GC:       1 * time.Hour,
 				Expiry:   1 * time.Hour,
 			},
-			Enabled: true,
-			Port:    1337,
-			Threads: 1,
+			Port:     1337,
+			Routines: 1,
 		},
 		Announce: struct {
 			Base time.Duration
 			Fuzz time.Duration
 		}{
-			Base: 0,
 			Fuzz: 1 * time.Second,
 		},
 		HTTP: struct {
-			Mode    string
-			IP      string
-			Port    int
-			Timeout struct {
+			Tracker  bool
+			Port     int
+			IP       string
+			Routines int
+			Timeout  struct {
 				Read  time.Duration
 				Write time.Duration
 			}
-			Threads   int
-			ServePath string
+			Serve string
 		}{
-			Mode: "enabled",
-			Port: 1337,
+			Tracker:  true,
+			Port:     1337,
+			Routines: 1,
 			Timeout: struct {
 				Read  time.Duration
 				Write time.Duration
 			}{
 				Read:  2 * time.Second,
 				Write: 2 * time.Second,
 			},
-			Threads:   1,
-			ServePath: "",
 		},
 		Numwant: struct {
 			Default uint
@@ -88,26 +76,15 @@ func TestMain(m *testing.M) {
 			Limit:   100,
 		},
 		DB: struct {
-			Type   string
+			GC     time.Duration
+			Expiry time.Duration
 			Backup struct {
-				Frequency time.Duration
-				Type      string
-				Path      string
+				Interval time.Duration
+				Path     string
 			}
-			Trim   time.Duration
-			Expiry time.Duration
 		}{
-			Type:   "gomap",
-			Trim:   1 * time.Hour,
+			GC:     1 * time.Hour,
 			Expiry: 1 * time.Hour,
-			Backup: struct {
-				Frequency time.Duration
-				Type      string
-				Path      string
-			}{
-				Type:      "none",
-				Frequency: 0,
-			},
 		},
 	}
 

cmd/run.go

@@ -33,26 +33,14 @@ func Run(conf *config.Configuration) {
 
 	zap.L().Debug("Starting Trakx")
 
-	if conf.Stats.General {
-		if conf.Stats.Interval <= 0 {
-			zap.L().Fatal("Invalid configuration: Stats.Interval must be greater than 0 if Stats.General is enabled")
-		}
-
-		zap.L().Info("Collecting statistics", zap.Bool("general", conf.Stats.General), zap.Bool("ip", conf.Stats.IP), zap.Duration("interval", conf.Stats.Interval))
-
-		if conf.HTTP.Mode == config.TrackerModeDisabled {
-			zap.L().Warn("Statistics collection enabled but no HTTP server is enabled to publish them")
-		}
-	}
-
 	// TODO: cache the prev IP collector map size :D
 	collector := stats.NewCollectors(conf.Stats.General, conf.Stats.IP, 0)
 
 	db, err := inmemory.NewInMemory(inmemory.Config{
 		InitalSize:         0, // TODO: cache this on exit and load on startup
 		Persistance:        &inmemory.FilePersistance{},
 		PersistanceAddress: conf.DB.Backup.Path,
-		EvictionFrequency:  conf.DB.Trim,
+		EvictionFrequency:  conf.DB.GC,
 		ExpirationTime:     conf.DB.Expiry,
 		Collector:          collector,
 	})
@@ -63,13 +51,13 @@ func Run(conf *config.Configuration) {
 		zap.L().Info("Initialized database", zap.Int("torrents", db.Torrents()))
 	}
 
-	if conf.UDP.Enabled {
+	if conf.UDP.Port != 0 {
 		zap.L().Info("UDP tracker enabled", zap.String("ip", conf.UDP.IP), zap.Int("port", conf.UDP.Port))
 
-		connectionsDB = connections.NewConnections(0, conf.UDP.ConnDB.Expiry, conf.UDP.ConnDB.Trim)
+		connectionsDB = connections.NewConnections(0, conf.UDP.Connections.Expiry, conf.UDP.Connections.GC)
 
 		trackers = append(trackers, udp.NewTracker(db, connectionsDB, collector, tracker.TrackerConfig{
-			Validate:         conf.UDP.ConnDB.Validate,
+			Validate:         conf.UDP.Connections.Validate,
 			DefaultNumwant:   conf.Numwant.Default,
 			MaximumNumwant:   conf.Numwant.Limit,
 			Interval:         uint(conf.Announce.Base),
@@ -84,19 +72,15 @@ func Run(conf *config.Configuration) {
 		serveConfigs = append(serveConfigs, serveConfig{
 			ip:       ip,
 			port:     conf.UDP.Port,
-			routines: conf.UDP.Threads,
+			routines: conf.UDP.Routines,
 		})
 	}
 
-	// TODO: make http tracker enable based on port with -1 for disabled
-	// info mode will run if stats are enabled and/or fileserver mode and tracker mode is disabled
-	// ah but then how to set port -.- xd
-	if conf.HTTP.Mode == config.TrackerModeEnabled {
+	if conf.HTTP.Tracker {
 		zap.L().Info("HTTP tracker enabled", zap.String("ip", conf.HTTP.IP), zap.Int("port", conf.HTTP.Port))
 
 		// TODO: HTTP serve path in config, also validate it here (ie. dir exists and can access)
-		// docs = leave serve path blank to disable serving files
-		trackers = append(trackers, http.NewTracker(db, "/TODO/", collector, tracker.TrackerConfig{
+		trackers = append(trackers, http.NewTracker(db, conf.HTTP.Serve, collector, tracker.TrackerConfig{
 			DefaultNumwant:   conf.Numwant.Default,
 			MaximumNumwant:   conf.Numwant.Limit,
 			Interval:         uint(conf.Announce.Base),
@@ -113,9 +97,9 @@ func Run(conf *config.Configuration) {
 		serveConfigs = append(serveConfigs, serveConfig{
 			ip:       ip,
 			port:     conf.HTTP.Port,
-			routines: conf.HTTP.Threads,
+			routines: conf.HTTP.Routines,
 		})
-	} else if conf.HTTP.Mode == config.TrackerModeInfo {
+	} else if conf.HTTP.Port != 0 {
 		mux := gohttp.NewServeMux()
 		if conf.Stats.General {
 			mux.HandleFunc("/stats", func(w gohttp.ResponseWriter, r *gohttp.Request) {

config/config.go

@@ -9,6 +9,15 @@ import (
 	"go.uber.org/zap"
 )
 
+type LogLevel string
+
+const (
+	DebugLevel = "debug"
+	InfoLevel  = "info"
+	WarnLevel  = "warn"
+	ErrorLevel = "error"
+)
+
 type Configuration struct {
 	LogLevel LogLevel
 	Cache    string
@@ -25,25 +34,23 @@ type Configuration struct {
 		Fuzz time.Duration
 	}
 	HTTP struct {
-		Mode    string
-		IP      string
-		Port    int
-		Timeout struct {
+		Tracker  bool
+		Port     int
+		IP       string
+		Routines int
+		Timeout  struct {
 			Read  time.Duration
 			Write time.Duration
 		}
-		Threads   int
-		ServePath string
+		Serve string
 	}
 	UDP struct {
-		Enabled bool
-		IP      string
-		Port    int
-		Threads int
-		ConnDB  struct {
+		Port        int
+		IP          string
+		Routines    int
+		Connections struct {
 			Validate bool
-			Size     uint64
-			Trim     time.Duration
+			GC       time.Duration
 			Expiry   time.Duration
 		}
 	}
@@ -52,14 +59,12 @@ type Configuration struct {
 		Limit   uint
 	}
 	DB struct {
-		Type   string
+		GC     time.Duration
+		Expiry time.Duration
 		Backup struct {
-			Frequency time.Duration
-			Type      string
-			Path      string
+			Interval time.Duration
+			Path     string
 		}
-		Trim   time.Duration
-		Expiry time.Duration
 	}
 }
 
@@ -78,14 +83,24 @@ func (conf *Configuration) validate() error {
 		return errors.Errorf("cache '%s' is not a directory", conf.Cache)
 	}
 
-	// potential misconfigurations warnings
-	if !conf.UDP.ConnDB.Validate {
+	if !conf.UDP.Connections.Validate {
 		zap.L().Warn("Configuration warning: UDP connection validation is disabled. Do not expose this service to untrusted networks; it could be abused in UDP based amplification attacks.")
 	}
+
 	if conf.DB.Expiry < conf.Announce.Base+conf.Announce.Fuzz {
 		zap.L().Warn("Configuration warning: Peer expiry time < announce base + fuzz. Peers will expire from the database between announces.")
 	}
 
+	if conf.Stats.General {
+		if conf.Stats.Interval <= 0 {
+			zap.L().Fatal("Invalid configuration: Stats.Interval must be greater than 0 if Stats.General is enabled")
+		}
+
+		if conf.HTTP.Port == 0 {
+			zap.L().Warn("Configuration warning: Statistics collection enabled but no HTTP server is running to publish them")
+		}
+	}
+
 	return nil
 }