bwilliams
67215a6aaa
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.
87 lines
2.1 KiB
Go
87 lines
2.1 KiB
Go
package config
|
|
|
|
import (
|
|
"errors"
|
|
"log/slog"
|
|
"reflect"
|
|
)
|
|
|
|
// JSCKLogging is the logging section's configuration key.
|
|
const JSCKLogging string = "logging"
|
|
|
|
// JSCLogging configures logging. Level is one of debug, info,
|
|
// warn or error. File, if set, is where commands that log to a file write;
|
|
// empty means they log to the terminal.
|
|
type JSCLogging struct {
|
|
Level string `cfg:"level" default:"warn"`
|
|
File string `cfg:"file"`
|
|
}
|
|
|
|
// ---------- Section methods (see Section) ----------
|
|
|
|
// Map implements Section.
|
|
func (c JSCLogging) Map() map[string]any { return mapOf(c) }
|
|
|
|
// Flatten implements Section.
|
|
func (c JSCLogging) Flatten() map[string]any {
|
|
return flattenOf(JSCKLogging, c)
|
|
}
|
|
|
|
// TypeOf implements Section.
|
|
func (c JSCLogging) TypeOf(key string) (reflect.Kind, error) {
|
|
return typeOf(c, key)
|
|
}
|
|
|
|
// ValueOf implements Section.
|
|
func (c JSCLogging) ValueOf(key string) (any, error) {
|
|
return valueOf(c, key)
|
|
}
|
|
|
|
// SetValue implements Section.
|
|
func (c *JSCLogging) SetValue(key string, value any) error {
|
|
return setValue(c, key, value)
|
|
}
|
|
|
|
// Keys returns the keys directly in the section.
|
|
func (c *JSCLogging) Keys() []string { return keysOf(c) }
|
|
|
|
// ---------- Section specific methods ----------
|
|
|
|
// validate checks values before they are stored (see validator).
|
|
func (c *JSCLogging) validate(key string, value any) error {
|
|
switch key {
|
|
case "level":
|
|
switch value.(string) {
|
|
case "debug", "info", "warn", "error":
|
|
default:
|
|
return errors.New(
|
|
"config: invalid log level: must be one of debug, info, warn, error",
|
|
)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// LevelToLogLevel converts a configured level name to an slog level. An
|
|
// unknown name gives 99, above every real level, so nothing is logged.
|
|
func LevelToLogLevel(level string) slog.Level {
|
|
switch level {
|
|
case "debug":
|
|
return slog.LevelDebug
|
|
case "info":
|
|
return slog.LevelInfo
|
|
case "warn":
|
|
return slog.LevelWarn
|
|
case "error":
|
|
return slog.LevelError
|
|
default:
|
|
return 99
|
|
}
|
|
}
|
|
|
|
// LogLevel returns the configured level as an slog level. An unknown level
|
|
// gives 99, above every real level, so nothing is logged.
|
|
func (c *JSCLogging) LogLevel() slog.Level {
|
|
return LevelToLogLevel(c.Level)
|
|
}
|