CODE_CONVENTIONS.md sets out the conventions for Go code in this repository: naming, layout, comments, errors, logging, configuration and tests. .golangci.json enables the linters that check the parts that can be checked (each limited to the rules the conventions use); the rest is applied by hand. Applied across the codebase: - Naming: full-word names in application code, initialisms in one case (BuyerID, PrintJSON, PrintYAML, ocdsGetBuyerID), no names shadowing built-ins (min/max are minGap/maxGap), mustRaw renamed rawJSON as it returns nil rather than panicking, and config.ConfigLevelToLogLevel renamed LevelToLogLevel. - Layout: lines kept to 80 characters where possible, assignments taken out of if and for statements that don't fit, wrapped arguments all on one line or one per line, steps separated by blank lines, no else after a return, function and struct literals wrapped. - Comments: doc comments on every exported name (including each section's Map, Flatten, TypeOf, ValueOf and SetValue), section banners, British spelling. - Errors: a created error starts with its package name, a wrapping error adds only what was being done, sentinels in one commented var block, errors.Is and errors.As in place of == and type assertions, and no err := shadowing of a named result. That fixes the mock server losing its access log's close error. - Logging: the fetcher passes its workers an untagged logger, so findatender's lines are tagged with their own component rather than with fetcher's as well; cmd/mock-fts logs "stopped" with slog. - Configuration: util.WithTimeout (moved from the websocket package) applies a timeout of 0 or less as no limit, used for the websocket write and ping, TCP close and tcpserver shutdown timeouts; every setting documents what 0 or empty means, including the rate limit rule's keys in internal/config/README.md. - Tests: related tests merged into table-driven ones with named cases. Separately from CODE_CONVENTIONS.md, internal/store/README.md gains a soft SQL style convention for the queries in internal/store/queries.go, and the queries are reformatted to follow it.
128 lines
3.3 KiB
Go
128 lines
3.3 KiB
Go
package config
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"reflect"
|
|
"strconv"
|
|
|
|
"github.com/spf13/viper"
|
|
)
|
|
|
|
// StoreValue parses value as the type of key, checks conf accepts it, sets it
|
|
// in conf and Viper and writes it to the config file Viper is using. Only the
|
|
// file's own settings are written back, not defaults or environment
|
|
// variables. It returns the stored value (as ValueOf gives it) and its kind.
|
|
func StoreValue(
|
|
conf *JobSearchConfig, key, value string,
|
|
) (any, reflect.Kind, error) {
|
|
return storeValue(conf, key, value)
|
|
}
|
|
|
|
// storeValue is StoreValue for any section, so key types that
|
|
// JobSearchConfig doesn't have yet can be tested.
|
|
func storeValue(
|
|
section Section, key, value string,
|
|
) (any, reflect.Kind, error) {
|
|
confType, err := section.TypeOf(key)
|
|
if err != nil {
|
|
return nil, confType, err
|
|
}
|
|
|
|
// Check the value is of the right kind first, for a clearer error than
|
|
// SetValue gives.
|
|
if _, err := parseValue(confType, value); err != nil {
|
|
return nil, confType, fmt.Errorf(
|
|
"config: value type not accepted, expected <%s>", confType,
|
|
)
|
|
}
|
|
|
|
// SetValue parses the string into the field's own type (e.g. int8,
|
|
// float32 or time.Duration) and rejects values the configuration itself
|
|
// would not accept, e.g. an unknown log level or an unparseable duration.
|
|
if err := section.SetValue(key, value); err != nil {
|
|
return nil, confType, err
|
|
}
|
|
confValue, err := section.ValueOf(key)
|
|
if err != nil {
|
|
return nil, confType, err
|
|
}
|
|
|
|
viper.Set(key, confValue)
|
|
file, err := readUsedConfigFile()
|
|
if err != nil {
|
|
return nil, confType, err
|
|
}
|
|
file.Set(key, confValue)
|
|
if err := file.WriteConfig(); err != nil {
|
|
return nil, confType, err
|
|
}
|
|
|
|
return confValue, confType, nil
|
|
}
|
|
|
|
// parseValue parses value as a value of kind, returning
|
|
// errors.ErrUnsupported for a kind it can't parse.
|
|
func parseValue(kind reflect.Kind, value string) (any, error) {
|
|
switch kind {
|
|
case reflect.Bool:
|
|
return strconv.ParseBool(value)
|
|
case reflect.String:
|
|
return value, nil
|
|
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
|
return strconv.ParseInt(value, 10, 64)
|
|
case reflect.Uint,
|
|
reflect.Uint8,
|
|
reflect.Uint16,
|
|
reflect.Uint32,
|
|
reflect.Uint64:
|
|
return strconv.ParseUint(value, 10, 64)
|
|
case reflect.Float32, reflect.Float64:
|
|
return strconv.ParseFloat(value, 64)
|
|
case reflect.Slice:
|
|
return splitList(value), nil
|
|
}
|
|
return nil, errors.ErrUnsupported
|
|
}
|
|
|
|
// PurgeValue rewrites the config file Viper is using without key. The
|
|
// file's other settings are kept as they are; defaults and environment
|
|
// variables are not written to it.
|
|
func PurgeValue(conf *JobSearchConfig, key string) error {
|
|
if _, err := conf.TypeOf(key); err != nil {
|
|
return err
|
|
}
|
|
|
|
file, err := readUsedConfigFile()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
out := viper.New()
|
|
out.SetConfigFile(file.ConfigFileUsed())
|
|
for _, fileKey := range file.AllKeys() {
|
|
if fileKey != key {
|
|
out.Set(fileKey, file.Get(fileKey))
|
|
}
|
|
}
|
|
|
|
return out.WriteConfig()
|
|
}
|
|
|
|
// readUsedConfigFile reads the config file Viper is using into a new Viper, so
|
|
// it holds only the file's settings.
|
|
func readUsedConfigFile() (*viper.Viper, error) {
|
|
path := viper.ConfigFileUsed()
|
|
if path == "" {
|
|
return nil, errors.New("config: no configuration file in use")
|
|
}
|
|
|
|
file := viper.New()
|
|
file.SetConfigFile(path)
|
|
if err := file.ReadInConfig(); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return file, nil
|
|
}
|