Add superfluous key checks in a generalized way to all configs, use t…

…hese in the prerun of each command
DefiantLabs · Oct 16, 2023 · 45f9882 · 45f9882
1 parent 1d107c2
commit 45f9882
Show file tree

Hide file tree

Showing 9 changed files with 177 additions and 1 deletion.
diff --git a/cmd/index.go b/cmd/index.go
@@ -62,6 +62,12 @@ func setupIndex(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	ignoredKeys := config.CheckSuperfluousIndexKeys(viperConf.AllKeys())
+
+	if len(ignoredKeys) > 0 {
+		config.Log.Warnf("Warning, the following invalid keys will be ignored: %v", ignoredKeys)
+	}
+
 	setupLogger(indexer.cfg.Log.Level, indexer.cfg.Log.Path, indexer.cfg.Log.Pretty)
 
 	// 0 is an invalid starting block, set it to 1

diff --git a/cmd/query.go b/cmd/query.go
@@ -75,6 +75,12 @@ func setupQuery(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	ignoredKeys := config.CheckSuperfluousQueryKeys(viperConf.AllKeys())
+
+	if len(ignoredKeys) > 0 {
+		config.Log.Warnf("Warning, the following invalid keys will be ignored: %v", ignoredKeys)
+	}
+
 	setupLogger(queryConfig.Log.Level, queryConfig.Log.Path, queryConfig.Log.Pretty)
 
 	db, err := connectToDBAndMigrate(queryConfig.Database)

diff --git a/cmd/update_denoms.go b/cmd/update_denoms.go
@@ -42,6 +42,12 @@ func setupUpdateDenoms(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	ignoredKeys := config.CheckSuperfluousUpdateDenomsKeys(viperConf.AllKeys())
+
+	if len(ignoredKeys) > 0 {
+		config.Log.Warnf("Warning, the following invalid keys will be ignored: %v", ignoredKeys)
+	}
+
 	setupLogger(updateDenomsConfig.Log.Level, updateDenomsConfig.Log.Path, updateDenomsConfig.Log.Pretty)
 
 	db, err := connectToDBAndMigrate(updateDenomsConfig.Database)

diff --git a/cmd/update_epochs.go b/cmd/update_epochs.go
@@ -44,6 +44,12 @@ func setupUpdateEpochs(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	ignoredKeys := config.CheckSuperfluousUpdateDenomsKeys(viperConf.AllKeys())
+
+	if len(ignoredKeys) > 0 {
+		config.Log.Warnf("Warning, the following invalid keys will be ignored: %v", ignoredKeys)
+	}
+
 	setupLogger(updateEpochsConfig.Log.Level, updateEpochsConfig.Log.Path, updateEpochsConfig.Log.Pretty)
 
 	db, err := connectToDBAndMigrate(updateEpochsConfig.Database)

diff --git a/config/common_configs.go b/config/common_configs.go
@@ -3,6 +3,7 @@ package config
 import (
 	"errors"
 	"fmt"
+	"reflect"
 	"strings"
 
 	"github.com/DefiantLabs/cosmos-indexer/util"
@@ -33,7 +34,7 @@ type lens struct {
 }
 
 type throttlingBase struct {
-	Throttling float64
+	Throttling float64 `mapstructure:"throttling"`
 }
 
 type retryBase struct {
@@ -118,3 +119,47 @@ func validateThrottlingConf(throttlingConf throttlingBase) error {
 	}
 	return nil
 }
+
+// Reads the Viper mapstructure tag to get the valid keys for a given config struct
+func getValidConfigKeys(section any, baseName string) (keys []string) {
+	v := reflect.ValueOf(section)
+	typeOfS := v.Type()
+
+	if baseName == "" {
+		baseName = strings.ToLower(typeOfS.Name())
+	}
+
+	for i := 0; i < v.NumField(); i++ {
+		field := typeOfS.Field(i)
+
+		// Hack to get around the fact that we have embedded struct inside a struct in some of our definitions
+		if !strings.HasPrefix(field.Type.String(), "config.") {
+			name := field.Tag.Get("mapstructure")
+			if name == "" {
+				name = field.Name
+			}
+
+			key := fmt.Sprintf("%v.%v", baseName, strings.ReplaceAll(strings.ToLower(name), " ", ""))
+			keys = append(keys, key)
+		}
+	}
+	return
+}
+
+func addDatabaseConfigKeys(validKeys map[string]struct{}) {
+	for _, key := range getValidConfigKeys(Database{}, "") {
+		validKeys[key] = struct{}{}
+	}
+}
+
+func addLogConfigKeys(validKeys map[string]struct{}) {
+	for _, key := range getValidConfigKeys(log{}, "") {
+		validKeys[key] = struct{}{}
+	}
+}
+
+func addLensConfigKeys(validKeys map[string]struct{}) {
+	for _, key := range getValidConfigKeys(lens{}, "") {
+		validKeys[key] = struct{}{}
+	}
+}
diff --git a/config/index_config.go b/config/index_config.go
@@ -145,3 +145,34 @@ func (conf *IndexConfig) Validate() error {
 
 	return nil
 }
+
+func CheckSuperfluousIndexKeys(keys []string) []string {
+	validKeys := make(map[string]struct{})
+
+	addDatabaseConfigKeys(validKeys)
+	addLogConfigKeys(validKeys)
+	addLensConfigKeys(validKeys)
+
+	// add base keys
+	for _, key := range getValidConfigKeys(indexBase{}, "base") {
+		validKeys[key] = struct{}{}
+	}
+
+	for _, key := range getValidConfigKeys(throttlingBase{}, "base") {
+		validKeys[key] = struct{}{}
+	}
+
+	for _, key := range getValidConfigKeys(retryBase{}, "base") {
+		validKeys[key] = struct{}{}
+	}
+
+	// Check keys
+	ignoredKeys := make([]string, 0)
+	for _, key := range keys {
+		if _, ok := validKeys[key]; !ok {
+			ignoredKeys = append(ignoredKeys, key)
+		}
+	}
+
+	return ignoredKeys
+}
diff --git a/config/query_config.go b/config/query_config.go
@@ -73,3 +73,25 @@ func (conf *QueryConfig) Validate(validCsvParsers []string) error {
 
 	return nil
 }
+
+func CheckSuperfluousQueryKeys(keys []string) []string {
+	validKeys := make(map[string]struct{})
+
+	addDatabaseConfigKeys(validKeys)
+	addLogConfigKeys(validKeys)
+
+	// add base keys
+	for _, key := range getValidConfigKeys(queryBase{}, "base") {
+		validKeys[key] = struct{}{}
+	}
+
+	// Check keys
+	ignoredKeys := make([]string, 0)
+	for _, key := range keys {
+		if _, ok := validKeys[key]; !ok {
+			ignoredKeys = append(ignoredKeys, key)
+		}
+	}
+
+	return ignoredKeys
+}
diff --git a/config/update_denoms_config.go b/config/update_denoms_config.go
@@ -38,3 +38,30 @@ func (conf *UpdateDenomsConfig) Validate() error {
 
 	return nil
 }
+
+func CheckSuperfluousUpdateDenomsKeys(keys []string) []string {
+	validKeys := make(map[string]struct{})
+
+	addDatabaseConfigKeys(validKeys)
+	addLogConfigKeys(validKeys)
+	addLensConfigKeys(validKeys)
+
+	// add base keys
+	for _, key := range getValidConfigKeys(updateDenomsBase{}, "base") {
+		validKeys[key] = struct{}{}
+	}
+
+	for _, key := range getValidConfigKeys(retryBase{}, "base") {
+		validKeys[key] = struct{}{}
+	}
+
+	// Check keys
+	ignoredKeys := make([]string, 0)
+	for _, key := range keys {
+		if _, ok := validKeys[key]; !ok {
+			ignoredKeys = append(ignoredKeys, key)
+		}
+	}
+
+	return ignoredKeys
+}
diff --git a/config/update_epochs_config.go b/config/update_epochs_config.go
@@ -50,3 +50,30 @@ func (conf *UpdateEpochsConfig) Validate() error {
 
 	return nil
 }
+
+func CheckSuperfluousUpdateEpochsKeys(keys []string) []string {
+	validKeys := make(map[string]struct{})
+
+	addDatabaseConfigKeys(validKeys)
+	addLogConfigKeys(validKeys)
+	addLensConfigKeys(validKeys)
+
+	// add base keys
+	for _, key := range getValidConfigKeys(updateEpochsBase{}, "base") {
+		validKeys[key] = struct{}{}
+	}
+
+	for _, key := range getValidConfigKeys(throttlingBase{}, "base") {
+		validKeys[key] = struct{}{}
+	}
+
+	// Check keys
+	ignoredKeys := make([]string, 0)
+	for _, key := range keys {
+		if _, ok := validKeys[key]; !ok {
+			ignoredKeys = append(ignoredKeys, key)
+		}
+	}
+
+	return ignoredKeys
+}