From 99fd575add366b26e428f8532c77950eac4f660a Mon Sep 17 00:00:00 2001 From: Lars Bahner Date: Fri, 15 Mar 2024 19:53:42 +0100 Subject: [PATCH] Remove unneeded config complexity --- config/actor.go | 8 -------- config/db/db.go | 10 ++++------ config/generate.go | 21 ++++++++++++--------- config/logging.go | 8 ++++---- config/p2p.go | 42 ++++++++++++++++-------------------------- config/ui.go | 5 ----- p2p/connmgr/gater.go | 4 ++-- ui/events.go | 3 +-- ui/ui.go | 17 ++++++----------- 9 files changed, 45 insertions(+), 73 deletions(-) diff --git a/config/actor.go b/config/actor.go index 08c69ce..ec4e67c 100644 --- a/config/actor.go +++ b/config/actor.go @@ -1,7 +1,6 @@ package config import ( - "context" "fmt" "os" @@ -201,10 +200,3 @@ func initActorKeyset() { } } - -func docPublishOptions() *doc.PublishOptions { - return &doc.PublishOptions{ - Ctx: context.Background(), - Force: forceFlag(), - } -} diff --git a/config/db/db.go b/config/db/db.go index 4c1cd05..d22eeaa 100644 --- a/config/db/db.go +++ b/config/db/db.go @@ -15,7 +15,7 @@ import ( const ( dbMaxConnections = 1 // Required for serialized access to the database defaultDBFilename = "ma.db" - defaultDbTimeout = 10000 + DB_TIMEOUT = 10000 ) var ( @@ -26,11 +26,9 @@ var ( func init() { - pflag.String("db-file", defaultDbFile, "File to *write* node peers and entities to. If the file does not exist, it will be created.") - pflag.Int("db-timeout", defaultDbTimeout, "Timeout for serialized access to the database in milliseconds.") + pflag.String("db", defaultDbFile, "File for sqlite database.") - viper.BindPFlag("db.file", pflag.Lookup("db-file")) - viper.BindPFlag("db.timeout", pflag.Lookup("db-timeout")) + viper.BindPFlag("db.file", pflag.Lookup("db")) } @@ -93,7 +91,7 @@ func Get() (*sql.DB, error) { return Init() } -// Returns expanded path to the db-file file +// Returns expanded path to the dbfile file // If the expansion fails it returns an empty string func dbfile() (string, error) { diff --git a/config/generate.go b/config/generate.go index 969e9f7..22b1cb0 100644 --- a/config/generate.go +++ b/config/generate.go @@ -45,9 +45,10 @@ func generateActorConfigFile(identity string, node string) { "grace-period": P2PConnMgrGracePeriod(), }, "discovery": map[string]interface{}{ - "advertise-ttl": P2PDiscoveryAdvertiseTTL(), - "advertise-limit": P2PDiscoveryAdvertiseLimit(), - "allow-all": DEFAULT_ALLOW_ALL, + "advertise-ttl": P2PDiscoveryAdvertiseTTL(), + "advertise-limit": P2PDiscoveryAdvertiseLimit(), + "advertise-interval": P2PDiscoveryAdvertiseInterval(), + "allow-all": ALLOW_ALL_PEERS, }, }, } @@ -135,9 +136,10 @@ func generatePongConfigFile(identity string, node string) { "grace-period": P2PConnMgrGracePeriod(), }, "discovery": map[string]interface{}{ - "advertise-ttl": P2PDiscoveryAdvertiseTTL(), - "advertise-limit": P2PDiscoveryAdvertiseLimit(), - "allow-all": DEFAULT_ALLOW_ALL, + "advertise-ttl": P2PDiscoveryAdvertiseTTL(), + "advertise-limit": P2PDiscoveryAdvertiseLimit(), + "advertise-interval": P2PDiscoveryAdvertiseInterval(), + "allow-all": ALLOW_ALL_PEERS, }, }, "mode": map[string]interface{}{ @@ -185,9 +187,10 @@ func generateRelayConfigFile(node string) { "grace-period": P2PConnMgrGracePeriod(), }, "discovery": map[string]interface{}{ - "advertise-ttl": P2PDiscoveryAdvertiseTTL(), - "advertise-limit": P2PDiscoveryAdvertiseLimit(), - "allow-all": DEFAULT_ALLOW_ALL, + "advertise-ttl": P2PDiscoveryAdvertiseTTL(), + "advertise-interval": P2PDiscoveryAdvertiseInterval(), + "advertise-limit": P2PDiscoveryAdvertiseLimit(), + "allow-all": ALLOW_ALL_PEERS, }, }, } diff --git a/config/logging.go b/config/logging.go index 7921e24..f6e6e76 100644 --- a/config/logging.go +++ b/config/logging.go @@ -21,11 +21,11 @@ var defaultLogfile string = NormalisePath(dataHome + defaultNick + ".log") func init() { - pflag.String("log-level", defaultLogLevel, "Loglevel to use for application.") - pflag.String("log-file", defaultLogfile, "Logfile to use for application. Accepts 'STDERR' and 'STDOUT' as such.") + pflag.String("loglevel", defaultLogLevel, "Loglevel to use for application.") + pflag.String("logfile", defaultLogfile, "Logfile to use for application. Accepts 'STDERR' and 'STDOUT' as such.") - viper.BindPFlag("log.file", pflag.Lookup("log-file")) - viper.BindPFlag("log.level", pflag.Lookup("log-level")) + viper.BindPFlag("log.file", pflag.Lookup("logfile")) + viper.BindPFlag("log.level", pflag.Lookup("loglevel")) viper.SetDefault("log.level", defaultLogLevel) diff --git a/config/p2p.go b/config/p2p.go index b4b5641..709bc2e 100644 --- a/config/p2p.go +++ b/config/p2p.go @@ -16,7 +16,8 @@ const ( defaultDiscoveryAdvertiseInterval time.Duration = time.Minute * 5 defaultDiscoveryAdvertiseTTL time.Duration = time.Minute * 60 defaultDiscoveryAdvertiseLimit int = 100 - DEFAULT_ALLOW_ALL bool = true // Allow all peers by default. This is the norm for now. Use connmgr threshold and protection instead. + + ALLOW_ALL_PEERS bool = true // Allow all peers by default. This is the norm for now. Use connmgr threshold and protection instead. defaultListenPort int = 0 fakeP2PIdentity string = "NO_DEFAULT_NODE_IDENITY" @@ -27,37 +28,34 @@ func init() { // P2P Settings // CONNMGR - pflag.Duration("p2p-connmgr-grace-period", defaultConnmgrGracePeriod, "Grace period for connection manager.") - pflag.Int("p2p-connmgr-high-watermark", defaultConnmgrHighWatermark, "High watermark for peer discovery.") - pflag.Int("p2p-connmgr-low-watermark", defaultConnmgrLowWatermark, "Low watermark for peer discovery.") + pflag.Duration("connmgr-grace-period", defaultConnmgrGracePeriod, "Grace period for connection manager.") + pflag.Int("connmgr-high-watermark", defaultConnmgrHighWatermark, "High watermark for peer discovery.") + pflag.Int("connmgr-low-watermark", defaultConnmgrLowWatermark, "Low watermark for peer discovery.") - viper.BindPFlag("p2p.connmgr.grace-period", pflag.Lookup("p2p-connmgr-grace-period")) - viper.BindPFlag("p2p.connmgr.high-watermark", pflag.Lookup("p2p-connmgr-high-watermark")) - viper.BindPFlag("p2p.connmgr.low-watermark", pflag.Lookup("p2p-connmgr-low-watermark")) + viper.BindPFlag("p2p.connmgr.grace-period", pflag.Lookup("connmgr-grace-period")) + viper.BindPFlag("p2p.connmgr.high-watermark", pflag.Lookup("connmgr-high-watermark")) + viper.BindPFlag("p2p.connmgr.low-watermark", pflag.Lookup("connmgr-low-watermark")) viper.SetDefault("p2p.connmgr.grace-period", defaultConnmgrGracePeriod) viper.SetDefault("p2p.connmgr.high-watermark", defaultConnmgrHighWatermark) viper.SetDefault("p2p.connmgr.low-watermark", defaultConnmgrLowWatermark) // DISCOVERY - pflag.Int("p2p-discovery-advertise-limit", defaultDiscoveryAdvertiseLimit, "Limit for advertising peer discovery.") - pflag.Duration("p2p-discovery-advertise-ttl", defaultDiscoveryAdvertiseTTL, "Hint of TimeToLive for advertising peer discovery.") - pflag.Duration("p2p-discovery-advertise-interval", defaultDiscoveryAdvertiseInterval, "How often to advertise our presence to libp2p") - pflag.Bool("p2p-discovery-allow-all", DEFAULT_ALLOW_ALL, "Number of concurrent peer discovery routines.") + pflag.Int("discovery-advertise-limit", defaultDiscoveryAdvertiseLimit, "Limit for advertising peer discovery.") + pflag.Duration("discovery-advertise-ttl", defaultDiscoveryAdvertiseTTL, "Hint of TimeToLive for advertising peer discovery.") + pflag.Duration("discovery-advertise-interval", defaultDiscoveryAdvertiseInterval, "How often to advertise our presence to libp2p") - viper.BindPFlag("p2p.discovery.advetise-interval", pflag.Lookup("p2p-discovery-advertise-interval")) - viper.BindPFlag("p2p.discovery.advertise-limit", pflag.Lookup("p2p-discovery-advertise-limit")) - viper.BindPFlag("p2p.discovery.advertise-ttl", pflag.Lookup("p2p-discovery-advertise-ttl")) - viper.BindPFlag("p2p.discovery.allow-all", pflag.Lookup("p2p-discovery-allow-all")) + viper.BindPFlag("p2p.discovery.advertise-interval", pflag.Lookup("discovery-advertise-interval")) + viper.BindPFlag("p2p.discovery.advertise-limit", pflag.Lookup("discovery-advertise-limit")) + viper.BindPFlag("p2p.discovery.advertise-ttl", pflag.Lookup("discovery-advertise-ttl")) viper.SetDefault("p2p.discovery.advertise-interval", defaultDiscoveryAdvertiseInterval) viper.SetDefault("p2p.discovery.advertise-limit", defaultDiscoveryAdvertiseLimit) viper.SetDefault("p2p.discovery.advertise-ttl", defaultDiscoveryAdvertiseTTL) - viper.SetDefault("p2p.discovery.allow-all", DEFAULT_ALLOW_ALL) // Port - pflag.Int("p2p-port", defaultListenPort, "Port for libp2p node to listen on.") - viper.BindPFlag("p2p.port", pflag.Lookup("p2p-port")) + pflag.Int("port", defaultListenPort, "Port for libp2p node to listen on.") + viper.BindPFlag("p2p.port", pflag.Lookup("port")) viper.SetDefault("p2p.port", defaultListenPort) // Identity @@ -84,10 +82,6 @@ func P2PDiscoveryAdvertiseLimit() int { return viper.GetInt("p2p.discovery.advertise-limit") } -func P2PDiscoveryAllowAll() bool { - return viper.GetBool("p2p.discovery.allow-all") -} - func P2PConnmgrLowWatermark() int { return viper.GetInt("p2p.connmgr.low-watermark") } @@ -104,10 +98,6 @@ func P2PPort() int { return viper.GetInt("p2p.port") } -func P2PDiscoveryRetryInterval() time.Duration { - return viper.GetDuration("p2p.discovery.retry") -} - // String functions func P2PPortString() string { diff --git a/config/ui.go b/config/ui.go index 3d8f01c..a2b4f10 100644 --- a/config/ui.go +++ b/config/ui.go @@ -1,14 +1,9 @@ package config import ( - "time" - "github.com/spf13/viper" ) func UIPeerslistWidth() int { return viper.GetInt("ui.peerslist-width") } -func UIPeersRefreshInterval() time.Duration { - return viper.GetDuration("ui.refresh") -} diff --git a/p2p/connmgr/gater.go b/p2p/connmgr/gater.go index 2126f98..52c6c28 100644 --- a/p2p/connmgr/gater.go +++ b/p2p/connmgr/gater.go @@ -20,7 +20,7 @@ type ConnectionGater struct { // New creates a new CustomConnectionGater instance. func NewConnectionGater(connMgr *p2pConnmgr.BasicConnMgr) *ConnectionGater { return &ConnectionGater{ - AllowAll: config.P2PDiscoveryAllowAll(), // Here we use a lookup, not the constant + AllowAll: config.ALLOW_ALL_PEERS, // Here we use a lookup, not the constant ConnMgr: connMgr, } } @@ -67,7 +67,7 @@ func (cg *ConnectionGater) InterceptUpgraded(_ network.Conn) (allow bool, reason func (cg *ConnectionGater) isAllowed(p p2peer.ID) bool { - if config.P2PDiscoveryAllowAll() || cg.AllowAll { // This is an appriprotiate place to use the function + if cg.AllowAll { return true } diff --git a/ui/events.go b/ui/events.go index 804f1c4..0803325 100644 --- a/ui/events.go +++ b/ui/events.go @@ -6,7 +6,6 @@ import ( "time" "github.com/bahner/go-ma" - "github.com/bahner/go-ma-actor/config" log "github.com/sirupsen/logrus" ) @@ -31,7 +30,7 @@ func (ui *ChatUI) displayDebugMessage(m string) { // refreshes the list of peers in the UI. func (ui *ChatUI) handleEvents() { - peerRefreshTicker := time.NewTicker(config.UIPeersRefreshInterval()) + peerRefreshTicker := time.NewTicker(time.Second) defer peerRefreshTicker.Stop() for { diff --git a/ui/ui.go b/ui/ui.go index ef1f85f..e87b2fd 100644 --- a/ui/ui.go +++ b/ui/ui.go @@ -4,7 +4,6 @@ import ( "context" "fmt" "io" - "time" "github.com/bahner/go-ma-actor/entity" "github.com/bahner/go-ma-actor/entity/actor" @@ -22,9 +21,8 @@ const ( defaultLimbo = "closet" - defaultPeerslistWidth = 10 - defaultPeerslistRefresh = time.Second * 3 - defaultHistorySize = 50 + defaultPeerslistWidth = 10 + defaultHistorySize = 50 separator = " " ) @@ -32,14 +30,11 @@ const ( func init() { // UI - pflag.Int("ui-peerslist-width", defaultPeerslistWidth, "Sets the width of the peerslist pane in the UI") - viper.BindPFlag("ui.peerslist-width", pflag.Lookup("ui-peerslist-width")) + pflag.Int("peerslist-width", defaultPeerslistWidth, "Sets the width of the peerslist pane in the UI") + viper.BindPFlag("ui.peerslist-width", pflag.Lookup("peerslist-width")) - pflag.Duration("ui-refresh", defaultPeerslistRefresh, "Sets the update frequency of the peerslist pane in the UI") - viper.BindPFlag("ui.refresh", pflag.Lookup("ui-refresh")) - - pflag.Int("ui-history-size", defaultHistorySize, "Sets the update frequency of the peerslist pane in the UI") - viper.BindPFlag("ui.history-size", pflag.Lookup("ui-history-size")) + pflag.Int("history-size", defaultHistorySize, "Sets the size of the history buffer in the UI.") + viper.BindPFlag("ui.history-size", pflag.Lookup("history-size")) }