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.
96 lines
2.7 KiB
Go
96 lines
2.7 KiB
Go
package config
|
|
|
|
import (
|
|
"errors"
|
|
"reflect"
|
|
"time"
|
|
)
|
|
|
|
// ========== Sources ==========
|
|
|
|
// JSCKSources is the sources section's configuration key.
|
|
const JSCKSources string = "sources"
|
|
|
|
// JSCSources configures each source of opportunities, one field
|
|
// per source. Each field's cfg tag must match the section's JSCK* constant.
|
|
type JSCSources struct {
|
|
FindATender JSCSourceFindATender `cfg:"find_a_tender"`
|
|
FTSMock JSCSourceFTSMock `cfg:"fts_mock"`
|
|
Sleeper JSCSourceSleeper `cfg:"sleeper"`
|
|
}
|
|
|
|
// ---------- Section methods (see Section) ----------
|
|
|
|
// Map implements Section.
|
|
func (c JSCSources) Map() map[string]any { return mapOf(c) }
|
|
|
|
// Flatten implements Section.
|
|
func (c JSCSources) Flatten() map[string]any {
|
|
return flattenOf(JSCKSources, c)
|
|
}
|
|
|
|
// TypeOf implements Section.
|
|
func (c JSCSources) TypeOf(key string) (reflect.Kind, error) {
|
|
return typeOf(c, key)
|
|
}
|
|
|
|
// ValueOf implements Section.
|
|
func (c JSCSources) ValueOf(key string) (any, error) {
|
|
return valueOf(c, key)
|
|
}
|
|
|
|
// SetValue implements Section.
|
|
func (c *JSCSources) SetValue(key string, value any) error {
|
|
return setValue(c, key, value)
|
|
}
|
|
|
|
// ========== Generic source ==========
|
|
|
|
// JSCSourcesSource holds the settings every source has, and is embedded
|
|
// in each source's section. Interval is how often an enabled source fetches;
|
|
// it must be greater than 0 (validate rejects 0 or less: a source is turned
|
|
// off with Enabled, not with its interval).
|
|
type JSCSourcesSource struct {
|
|
Enabled bool `cfg:"enabled"`
|
|
Interval time.Duration `cfg:"interval" default:"10m"`
|
|
}
|
|
|
|
// ---------- Section methods (see Section) ----------
|
|
|
|
// Map implements Section.
|
|
func (c JSCSourcesSource) Map() map[string]any { return mapOf(c) }
|
|
|
|
// Flatten implements Section.
|
|
func (c JSCSourcesSource) Flatten() map[string]any {
|
|
return flattenOf("", c)
|
|
}
|
|
|
|
// TypeOf implements Section.
|
|
func (c JSCSourcesSource) TypeOf(key string) (reflect.Kind, error) {
|
|
return typeOf(c, key)
|
|
}
|
|
|
|
// ValueOf implements Section.
|
|
func (c JSCSourcesSource) ValueOf(key string) (any, error) {
|
|
return valueOf(c, key)
|
|
}
|
|
|
|
// SetValue implements Section.
|
|
func (c *JSCSourcesSource) SetValue(key string, value any) error {
|
|
return setValue(c, key, value)
|
|
}
|
|
|
|
// Keys returns the keys directly in the section.
|
|
func (c *JSCSourcesSource) Keys() []string { return keysOf(c) }
|
|
|
|
// validate checks values before they are stored (see validator); it is
|
|
// promoted to each source's section. interval must be greater than 0.
|
|
func (c *JSCSourcesSource) validate(key string, value any) error {
|
|
if key == "interval" && value.(time.Duration) <= 0 {
|
|
return errors.New(
|
|
"config: interval must be greater than 0; set enabled to false to turn the source off",
|
|
)
|
|
}
|
|
return nil
|
|
}
|