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.
119 lines
2.8 KiB
Go
119 lines
2.8 KiB
Go
package fetcher
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"log/slog"
|
|
"sync"
|
|
"time"
|
|
|
|
"git.avsdev.uk/Go/job-search/internal/config"
|
|
"git.avsdev.uk/Go/job-search/internal/util"
|
|
)
|
|
|
|
// ErrNoNewReleases is returned by a source's task when there was nothing new
|
|
// to fetch; it wraps util.ErrWorkerNoWork.
|
|
var ErrNoNewReleases = fmt.Errorf("%w: no new releases", util.ErrWorkerNoWork)
|
|
|
|
// Option configures Run.
|
|
type Option func(*options)
|
|
|
|
// options holds the settings Options change.
|
|
type options struct {
|
|
log *slog.Logger
|
|
}
|
|
|
|
// WithLogger makes Run, its workers and their clients log to logger instead
|
|
// of slog.Default().
|
|
func WithLogger(logger *slog.Logger) Option {
|
|
return func(opts *options) {
|
|
opts.log = logger
|
|
}
|
|
}
|
|
|
|
// logger returns the logger Run logs to: the given one, or slog.Default().
|
|
// It isn't tagged here, as it is also given to the clients the workers
|
|
// create, which add their own component; see tagged.
|
|
func (opts options) logger() *slog.Logger {
|
|
if opts.log == nil {
|
|
return slog.Default()
|
|
}
|
|
return opts.log
|
|
}
|
|
|
|
// tagged returns logger tagged with the fetcher's component, for the lines
|
|
// Run and its workers log themselves.
|
|
func tagged(logger *slog.Logger) *slog.Logger {
|
|
return logger.With("component", "fetcher")
|
|
}
|
|
|
|
// runFunc runs one source's worker until ctx is cancelled. logger is
|
|
// untagged: the worker tags its own lines with tagged, and passes logger as
|
|
// it is to any client it creates.
|
|
type runFunc func(
|
|
ctx context.Context,
|
|
logger *slog.Logger,
|
|
conf *config.JobSearchConfig,
|
|
since time.Time,
|
|
) error
|
|
|
|
// Run starts a worker for each enabled source and blocks until every worker
|
|
// has stopped. Workers stop when ctx is cancelled, or when any worker stops
|
|
// with an error, which starts a shutdown of all of them. The errors are
|
|
// logged as they happen and returned joined; nil means a clean shutdown. It
|
|
// logs to slog.Default() unless given WithLogger.
|
|
func Run(
|
|
ctx context.Context,
|
|
conf *config.JobSearchConfig,
|
|
since time.Time,
|
|
opts ...Option,
|
|
) error {
|
|
ctx, cancel := context.WithCancel(ctx)
|
|
defer cancel()
|
|
|
|
var settings options
|
|
for _, opt := range opts {
|
|
opt(&settings)
|
|
}
|
|
logger := settings.logger()
|
|
|
|
var (
|
|
wg sync.WaitGroup
|
|
mu sync.Mutex
|
|
errs []error
|
|
)
|
|
|
|
start := func(name string, run runFunc) {
|
|
wg.Add(1)
|
|
go func() {
|
|
defer wg.Done()
|
|
if err := run(ctx, logger, conf, since); err != nil {
|
|
tagged(logger).Error(
|
|
"source stopped, shutting down",
|
|
"source", name,
|
|
"error", err,
|
|
)
|
|
mu.Lock()
|
|
errs = append(errs, fmt.Errorf("%s: %w", name, err))
|
|
mu.Unlock()
|
|
cancel()
|
|
}
|
|
}()
|
|
}
|
|
|
|
if conf.Sources.FindATender.Enabled {
|
|
start("FindATender", runFindAOpportunity)
|
|
}
|
|
if conf.Sources.FTSMock.Enabled {
|
|
start("FTSMock", runFTSMock)
|
|
}
|
|
if conf.Sources.Sleeper.Enabled {
|
|
start("Sleeper", runSleeper)
|
|
}
|
|
|
|
wg.Wait()
|
|
|
|
return errors.Join(errs...)
|
|
}
|