Merge branch 'refactor'

internal/config/cli.go

@@ -0,0 +1,17 @@
+package config
+
+import (
+	"path"
+
+	"github.com/spf13/pflag"
+)
+
+// Read cli flag values into the config
+func (cfg *Config) ReadCliFlags(flags *pflag.FlagSet) error {
+	logFile, _ := flags.GetString("log")
+	if len(logFile) > 0 {
+		cfg.Log.Directory = path.Dir(logFile)
+		cfg.Log.Filename = path.Base(logFile)
+	}
+	return nil
+}

internal/config/config.go

@@ -0,0 +1,85 @@
+package config
+
+import (
+	"reflect"
+	"time"
+
+	"github.com/eosswedenorg/thalos/internal/log"
+
+	shipclient "github.com/eosswedenorg-go/antelope-ship-client"
+)
+
+type RedisConfig struct {
+	Addr     string `yaml:"addr"`
+	User     string `yaml:"user"`
+	Password string `yaml:"password"`
+	DB       int    `yaml:"db"`
+	Prefix   string `yaml:"prefix"`
+}
+
+type TelegramConfig struct {
+	Id      string `yaml:"id" mapstructure:"id"`
+	Channel int64  `yaml:"channel" mapstructure:"channel"`
+}
+
+type ShipConfig struct {
+	Url                 string `yaml:"url" mapstructure:"url"`
+	IrreversibleOnly    bool   `yaml:"irreversible_only" mapstructure:"irreversible_only"`
+	MaxMessagesInFlight uint32 `yaml:"max_messages_in_flight" mapstructure:"max_messages_in_flight"`
+	StartBlockNum       uint32 `yaml:"start_block_num" mapstructure:"start_block_num"`
+	EndBlockNum         uint32 `yaml:"end_block_num" mapstructure:"end_block_num"`
+	Chain               string `yaml:"chain" mapstructure:"chain"`
+}
+
+type Config struct {
+	Name string     `yaml:"name" mapstructure:"name"`
+	Ship ShipConfig `yaml:"ship" mapstructure:"ship"`
+	Api  string     `yaml:"api" mapstructure:"api"`
+
+	Log log.Config `yaml:"log" mapstructure:"log"`
+
+	Redis        RedisConfig `yaml:"redis" mapstructure:"redis"`
+	MessageCodec string      `yaml:"message_codec" mapstructure:"message_codec"`
+
+	Telegram TelegramConfig `yaml:"telegram" mapstructure:"telegram"`
+}
+
+// Create a new Config object with default values
+func New() Config {
+	return Config{
+		MessageCodec: "json",
+		Log: log.Config{
+			MaxFileSize: 10 * 1000 * 1000, // 10 mb
+			MaxTime:     time.Hour * 24,
+		},
+		Ship: defaultShipConfig(""),
+		Redis: RedisConfig{
+			Addr:   "localhost:6379",
+			Prefix: "ship",
+		},
+	}
+}
+
+func defaultShipConfig(url string) ShipConfig {
+	return ShipConfig{
+		Url:                 url,
+		StartBlockNum:       shipclient.NULL_BLOCK_NUMBER,
+		EndBlockNum:         shipclient.NULL_BLOCK_NUMBER,
+		MaxMessagesInFlight: 10,
+		IrreversibleOnly:    false,
+	}
+}
+
+// mapstructure DecodeHook that can parse a shorthand ship config (only string instead of struct.)
+func decodeShorthandShipConfig(from reflect.Value, to reflect.Value) (interface{}, error) {
+	shipType := reflect.TypeOf(ShipConfig{})
+
+	// If to is a struct and is assignable to a ShipConfig and from is a string.
+	// Then we treat the from value as ShipConfig.Url
+	if to.Kind() == reflect.Struct && to.Type().AssignableTo(shipType) && from.Kind() == reflect.String {
+		return defaultShipConfig(from.String()), nil
+	}
+
+	// If not, decode as normal.
+	return from.Interface(), nil
+}

internal/config/config_test.go

@@ -0,0 +1,148 @@
+package config
+
+import (
+	"testing"
+	"time"
+
+	"github.com/eosswedenorg/thalos/internal/log"
+	"github.com/stretchr/testify/require"
+
+	shipclient "github.com/eosswedenorg-go/antelope-ship-client"
+)
+
+func TestNew(t *testing.T) {
+	expected := Config{
+		MessageCodec: "json",
+
+		Log: log.Config{
+			MaxFileSize: 10 * 1000 * 1000, // 10 mb
+			MaxTime:     time.Hour * 24,
+		},
+
+		Ship: ShipConfig{
+			StartBlockNum:       shipclient.NULL_BLOCK_NUMBER,
+			EndBlockNum:         shipclient.NULL_BLOCK_NUMBER,
+			MaxMessagesInFlight: 10,
+			IrreversibleOnly:    false,
+		},
+
+		Redis: RedisConfig{
+			Addr:     "localhost:6379",
+			Password: "",
+			DB:       0,
+			Prefix:   "ship",
+		},
+	}
+
+	require.Equal(t, expected, New())
+}
+
+func TestRead(t *testing.T) {
+	expected := Config{
+		Name:         "ship-reader-1",
+		Api:          "http://127.0.0.1:8080",
+		MessageCodec: "mojibake",
+		Log: log.Config{
+			Filename:    "some_file.log",
+			Directory:   "/path/to/whatever",
+			MaxFileSize: 200,
+			MaxTime:     30 * time.Minute,
+		},
+		Ship: ShipConfig{
+			Url:                 "127.0.0.1:8089",
+			StartBlockNum:       23671836,
+			EndBlockNum:         23872222,
+			IrreversibleOnly:    true,
+			MaxMessagesInFlight: 1337,
+		},
+		Telegram: TelegramConfig{
+			Id:      "110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw",
+			Channel: -123456789,
+		},
+		Redis: RedisConfig{
+			Addr:     "localhost:6379",
+			User:     "myuser",
+			Password: "passwd",
+			DB:       4,
+			Prefix:   "some::ship",
+		},
+	}
+
+	cfg := Config{}
+	err := cfg.Read([]byte(`
+name: "ship-reader-1"
+api: "http://127.0.0.1:8080"
+message_codec: "mojibake"
+log:
+  filename: some_file.log
+  directory: /path/to/whatever
+  maxtime: 30m
+  maxfilesize: 200b
+ship:
+  url: "127.0.0.1:8089"
+  irreversible_only: true
+  max_messages_in_flight: 1337
+  start_block_num: 23671836
+  end_block_num: 23872222
+telegram:
+  id: "110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw"
+  channel: -123456789
+redis:
+  addr: "localhost:6379"
+  user: "myuser"
+  password: "passwd"
+  db: 4
+  prefix: "some::ship"
+`))
+
+	require.NoError(t, err)
+	require.Equal(t, expected, cfg)
+}
+
+func TestReadShorthandShipUrl(t *testing.T) {
+	expected := Config{
+		Name:         "ship-reader-1",
+		Api:          "http://127.0.0.1:8080",
+		MessageCodec: "json",
+		Log: log.Config{
+			MaxFileSize: 10 * 1000 * 1000, // 10 mb
+			MaxTime:     time.Hour * 24,
+		},
+		Ship: ShipConfig{
+			Url:                 "127.0.0.1:8089",
+			StartBlockNum:       shipclient.NULL_BLOCK_NUMBER,
+			EndBlockNum:         shipclient.NULL_BLOCK_NUMBER,
+			MaxMessagesInFlight: 10,
+			IrreversibleOnly:    false,
+		},
+		Telegram: TelegramConfig{
+			Id:      "110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw",
+			Channel: -123456789,
+		},
+		Redis: RedisConfig{
+			Addr:     "localhost:6379",
+			Password: "passwd",
+			DB:       4,
+			Prefix:   "some::ship",
+		},
+	}
+
+	cfg := New()
+
+	err := cfg.Read([]byte(`
+name: "ship-reader-1"
+api: "http://127.0.0.1:8080"
+ship: "127.0.0.1:8089"
+telegram:
+  id: "110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw"
+  channel: -123456789
+redis:
+  addr: "localhost:6379"
+  password: "passwd"
+  db: 4
+  prefix: "some::ship"
+`))
+
+	require.NoError(t, err)
+	require.Equal(t, expected, cfg)
+}

internal/config/file.go

@@ -0,0 +1,37 @@
+package config
+
+import (
+	"bytes"
+	"os"
+
+	"github.com/mitchellh/mapstructure"
+	"github.com/spf13/viper"
+)
+
+// Read values from file
+func (cfg *Config) ReadFile(filename string) error {
+	bytes, err := os.ReadFile(filename)
+	if err != nil {
+		return err
+	}
+
+	return cfg.Read(bytes)
+}
+
+func (cfg *Config) Read(in []byte) error {
+	v := viper.New()
+	v.SetConfigType("yaml")
+
+	if err := v.ReadConfig(bytes.NewBuffer(in)); err != nil {
+		return err
+	}
+
+	decoders := mapstructure.ComposeDecodeHookFunc(
+		mapstructure.TextUnmarshallerHookFunc(),
+		mapstructure.StringToTimeDurationHookFunc(),
+		mapstructure.StringToSliceHookFunc(","),
+		decodeShorthandShipConfig,
+	)
+
+	return v.Unmarshal(cfg, viper.DecodeHook(decoders))
+}