From f76dfc9af11d7b010950b302425d757cf89b81a3 Mon Sep 17 00:00:00 2001 From: "A.Unger" Date: Mon, 8 Nov 2021 12:25:15 +0100 Subject: [PATCH] normalize thumbnails --- store/pkg/command/root.go | 16 +---- thumbnails/pkg/command/root.go | 26 +------- thumbnails/pkg/command/server.go | 8 +-- thumbnails/pkg/config/config.go | 62 +++---------------- thumbnails/pkg/config/{env.go => mappings.go} | 14 +++-- 5 files changed, 22 insertions(+), 104 deletions(-) rename thumbnails/pkg/config/{env.go => mappings.go} (82%) diff --git a/store/pkg/command/root.go b/store/pkg/command/root.go index 115660b73f..07425fa54f 100644 --- a/store/pkg/command/root.go +++ b/store/pkg/command/root.go @@ -84,11 +84,7 @@ type SutureService struct { // NewSutureService creates a new store.SutureService func NewSutureService(cfg *ociscfg.Config) suture.Service { - inheritLogging(cfg) - if cfg.Mode == 0 { - cfg.Store.Supervised = true - } - cfg.Store.Log.File = cfg.Log.File + cfg.Store.Log = cfg.Log return SutureService{ cfg: cfg.Store, } @@ -102,13 +98,3 @@ func (s SutureService) Serve(ctx context.Context) error { return nil } - -// inheritLogging is a poor man's global logging state tip-toeing around circular dependencies. It sets the logging -// of the service to whatever is in the higher config (in this case coming from ocis.yaml) and sets them as defaults, -// being overwritten when the extension parses its config file / env variables. -func inheritLogging(cfg *ociscfg.Config) { - cfg.Store.Log.File = cfg.Log.File - cfg.Store.Log.Color = cfg.Log.Color - cfg.Store.Log.Pretty = cfg.Log.Pretty - cfg.Store.Log.Level = cfg.Log.Level -} diff --git a/thumbnails/pkg/command/root.go b/thumbnails/pkg/command/root.go index 4ebc5e413f..b32d6b9b4f 100644 --- a/thumbnails/pkg/command/root.go +++ b/thumbnails/pkg/command/root.go @@ -70,15 +70,9 @@ func ParseConfig(c *cli.Context, cfg *config.Config) error { if err != nil { return err } - - // load all env variables relevant to the config in the current context. conf.LoadOSEnv(config.GetEnv(), false) - - if err = cfg.UnmapEnv(conf); err != nil { - return err - } - - return nil + bindings := config.StructMappings(cfg) + return ociscfg.BindEnv(conf, bindings) } // SutureService allows for the thumbnails command to be embedded and supervised by a suture supervisor tree. @@ -88,11 +82,7 @@ type SutureService struct { // NewSutureService creates a new thumbnails.SutureService func NewSutureService(cfg *ociscfg.Config) suture.Service { - inheritLogging(cfg) - if cfg.Mode == 0 { - cfg.Thumbnails.Supervised = true - } - cfg.Thumbnails.Log.File = cfg.Log.File + cfg.Thumbnails.Log = cfg.Log return SutureService{ cfg: cfg.Thumbnails, } @@ -106,13 +96,3 @@ func (s SutureService) Serve(ctx context.Context) error { return nil } - -// inheritLogging is a poor man's global logging state tip-toeing around circular dependencies. It sets the logging -// of the service to whatever is in the higher config (in this case coming from ocis.yaml) and sets them as defaults, -// being overwritten when the extension parses its config file / env variables. -func inheritLogging(cfg *ociscfg.Config) { - cfg.Thumbnails.Log.File = cfg.Log.File - cfg.Thumbnails.Log.Color = cfg.Log.Color - cfg.Thumbnails.Log.Pretty = cfg.Log.Pretty - cfg.Thumbnails.Log.Level = cfg.Log.Level -} diff --git a/thumbnails/pkg/command/server.go b/thumbnails/pkg/command/server.go index 4a96c12e52..8225495413 100644 --- a/thumbnails/pkg/command/server.go +++ b/thumbnails/pkg/command/server.go @@ -20,13 +20,7 @@ func Server(cfg *config.Config) *cli.Command { Name: "server", Usage: "Start integrated server", Before: func(ctx *cli.Context) error { - if err := ParseConfig(ctx, cfg); err != nil { - return err - } - - logger := NewLogger(cfg) - logger.Debug().Str("service", "thumbnails").Msg("ignoring config file parsing when running supervised") - return nil + return ParseConfig(ctx, cfg) }, Action: func(c *cli.Context) error { logger := NewLogger(cfg) diff --git a/thumbnails/pkg/config/config.go b/thumbnails/pkg/config/config.go index 5706956984..d8cb7bd48e 100644 --- a/thumbnails/pkg/config/config.go +++ b/thumbnails/pkg/config/config.go @@ -2,23 +2,12 @@ package config import ( "context" - "fmt" "path" - "reflect" - - gofig "github.com/gookit/config/v2" "github.com/owncloud/ocis/ocis-pkg/config/defaults" + "github.com/owncloud/ocis/ocis-pkg/shared" ) -// Log defines the available logging configuration. -type Log struct { - Level string `mapstructure:"level"` - Pretty bool `mapstructure:"pretty"` - Color bool `mapstructure:"color"` - File string `mapstructure:"file"` -} - // Debug defines the available debug configuration. type Debug struct { Addr string `mapstructure:"addr"` @@ -46,12 +35,12 @@ type Tracing struct { // Config combines all available configuration parts. type Config struct { - File string `mapstructure:"file"` - Log Log `mapstructure:"log"` - Debug Debug `mapstructure:"debug"` - Server Server `mapstructure:"server"` - Tracing Tracing `mapstructure:"tracing"` - Thumbnail Thumbnail `mapstructure:"thumbnail"` + File string `mapstructure:"file"` + Log shared.Log `mapstructure:"log"` + Debug Debug `mapstructure:"debug"` + Server Server `mapstructure:"server"` + Tracing Tracing `mapstructure:"tracing"` + Thumbnail Thumbnail `mapstructure:"thumbnail"` Context context.Context Supervised bool @@ -83,7 +72,7 @@ func New() *Config { func DefaultConfig() *Config { return &Config{ - Log: Log{}, + Log: shared.Log{}, Debug: Debug{ Addr: "127.0.0.1:9189", Token: "", @@ -124,38 +113,3 @@ func GetEnv() []string { return r } - -// UnmapEnv loads values from the gooconf.Config argument and sets them in the expected destination. -func (c *Config) UnmapEnv(gooconf *gofig.Config) error { - vals := structMappings(c) - for i := range vals { - for j := range vals[i].EnvVars { - // we need to guard against v != "" because this is the condition that checks that the value is set from the environment. - // the `ok` guard is not enough, apparently. - if v, ok := gooconf.GetValue(vals[i].EnvVars[j]); ok && v != "" { - - // get the destination type from destination - switch reflect.ValueOf(vals[i].Destination).Type().String() { - case "*bool": - r := gooconf.Bool(vals[i].EnvVars[j]) - *vals[i].Destination.(*bool) = r - case "*string": - r := gooconf.String(vals[i].EnvVars[j]) - *vals[i].Destination.(*string) = r - case "*int": - r := gooconf.Int(vals[i].EnvVars[j]) - *vals[i].Destination.(*int) = r - case "*float64": - // defaults to float64 - r := gooconf.Float(vals[i].EnvVars[j]) - *vals[i].Destination.(*float64) = r - default: - // it is unlikely we will ever get here. Let this serve more as a runtime check for when debugging. - return fmt.Errorf("invalid type for env var: `%v`", vals[i].EnvVars[j]) - } - } - } - } - - return nil -} diff --git a/thumbnails/pkg/config/env.go b/thumbnails/pkg/config/mappings.go similarity index 82% rename from thumbnails/pkg/config/env.go rename to thumbnails/pkg/config/mappings.go index 7c012b6917..9c44c5c812 100644 --- a/thumbnails/pkg/config/env.go +++ b/thumbnails/pkg/config/mappings.go @@ -1,13 +1,17 @@ package config -type mapping struct { - EnvVars []string // name of the EnvVars var. - Destination interface{} // memory address of the original config value to modify. +import "github.com/owncloud/ocis/ocis-pkg/shared" + +// StructMappings binds a set of environment variables to a destination on cfg. Iterating over this set and editing the +// Destination value of a binding will alter the original value, as it is a pointer to its memory address. This lets +// us propagate changes easier. +func StructMappings(cfg *Config) []shared.EnvBinding { + return structMappings(cfg) } // structMappings binds a set of environment variables to a destination on cfg. -func structMappings(cfg *Config) []mapping { - return []mapping{ +func structMappings(cfg *Config) []shared.EnvBinding { + return []shared.EnvBinding{ { EnvVars: []string{"THUMBNAILS_LOG_FILE", "OCIS_LOG_FILE"}, Destination: &cfg.Log.File,