Made the fetcher a Fetcher type with per-source config, and ran it in job-search serve

fetcher.Run(ctx, conf, since) becomes New(&conf.Sources, opts...) and
Run(ctx, since). Each worker now takes only its own source's config, and
Run starts each one through a closure that binds it. Cancelling ctx stops
the workers through the Fetcher's background context, and Run always waits
for every worker before returning their joined errors.

The findatender client no longer holds the configuration: New takes only
the API root, ReloadConfig is gone, and request tracing follows
logging.IsDebugEnabled(). The FindAOpportunity worker is now FindATender.

job-search serve runs the fetcher alongside the HTTP server. A source that
fails stops the server, and the server stopping stops the sources; with no
sources enabled the server keeps running. fetcher service and fetcher
fts-once use the new APIs.
This commit is contained in:
bwilliams committed 2026-10-16 10:44:38 +01:00
1 parent f0c171c8a8
commit 18db462d89
12 files changed
+269 -214

No files matched your search

+1 -1
View File
@@ -79,7 +79,7 @@ func commandFTSOnce(opts *cli.Options) *cobra.Command {
if conf.Sources.FindATender.APIRoot == "" { if conf.Sources.FindATender.APIRoot == "" {
return errors.New("sources.find_a_tender.api_root is not set") return errors.New("sources.find_a_tender.api_root is not set")
} }
findATender := findatender.New(conf, conf.Sources.FindATender.APIRoot) findATender := findatender.New(conf.Sources.FindATender.APIRoot)
defer findATender.Shutdown() defer findATender.Shutdown()
ignoreRateLimit, _ := cmd.Flags().GetBool("ignore-rate-limit") ignoreRateLimit, _ := cmd.Flags().GetBool("ignore-rate-limit")
+1 -1
View File
@@ -53,7 +53,7 @@ func commandService(opts *cli.Options) *cobra.Command {
stop() stop()
}() }()
return fetcher.Run(ctx, conf, since) return fetcher.New(&conf.Sources).Run(ctx, since)
}, },
} }
cmd.Flags().Time( cmd.Flags().Time(
+31 -6
View File
@@ -11,22 +11,27 @@ import (
"strconv" "strconv"
"strings" "strings"
"syscall" "syscall"
"time"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"git.avsdev.uk/Go/job-search/internal/cli" "git.avsdev.uk/Go/job-search/internal/cli"
"git.avsdev.uk/Go/job-search/internal/fetcher"
"git.avsdev.uk/Go/job-search/internal/logging" "git.avsdev.uk/Go/job-search/internal/logging"
"git.avsdev.uk/Go/job-search/internal/server" "git.avsdev.uk/Go/job-search/internal/server"
) )
// NewCommand returns the serve command, which serves the frontend, the REST // NewCommand returns the serve command, which serves the REST API and the
// API and the WebSocket endpoint. // WebSocket endpoint, and runs a worker for every enabled source.
func NewCommand(opts *cli.Options) *cobra.Command { func NewCommand(opts *cli.Options) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "serve", Use: "serve",
Short: "Serve the frontend (/), REST API (/api) and WebSocket (/ws)", Short: "Serve the REST API (/api) and WebSocket (/ws), and fetch from sources",
Long: `Serve the embedded Vite frontend, the REST API under /api and the Long: `Serve the REST API under /api and the WebSocket endpoint under /ws.
WebSocket endpoint under /ws.`,
It also runs a worker for every enabled source, as fetcher service does. A
source that stops with an error stops the server too, and the server
stopping stops the sources.`,
PersistentPreRun: func(cmd *cobra.Command, args []string) { PersistentPreRun: func(cmd *cobra.Command, args []string) {
slog.Debug("command persistent pre-run", "command", "serve") slog.Debug("command persistent pre-run", "command", "serve")
}, },
@@ -108,7 +113,27 @@ WebSocket endpoint under /ws.`,
return err return err
} }
return appServer.Run(ctx) // runCtx stops whichever of the server and the sources is still
// running once the other has stopped.
runCtx, cancelRun := context.WithCancel(ctx)
defer cancelRun()
sourceFetcher := fetcher.New(&conf.Sources)
fetcherDone := make(chan error, 1)
go func() {
fetchErr := sourceFetcher.Run(runCtx, time.Time{})
// Only a failure stops the server: with no sources enabled, Run
// returns nil straight away.
if fetchErr != nil {
cancelRun()
}
fetcherDone <- fetchErr
}()
serverErr := appServer.Run(runCtx)
cancelRun()
return errors.Join(serverErr, <-fetcherDone)
}, },
} }
+68 -45
View File
@@ -16,30 +16,25 @@ import (
// to fetch; it wraps util.ErrWorkerNoWork. // to fetch; it wraps util.ErrWorkerNoWork.
var ErrNoNewReleases = fmt.Errorf("%w: no new releases", util.ErrWorkerNoWork) var ErrNoNewReleases = fmt.Errorf("%w: no new releases", util.ErrWorkerNoWork)
// Option configures Run. // Option configures a Fetcher.
type Option func(*options) type Option func(*Fetcher)
// options holds the settings Options change.
type options struct {
log *slog.Logger
}
// WithLogger makes Run, its workers and their clients log to logger instead // WithLogger makes Run, its workers and their clients log to logger instead
// of slog.Default(). // of slog.Default().
func WithLogger(logger *slog.Logger) Option { func WithLogger(logger *slog.Logger) Option {
return func(opts *options) { return func(f *Fetcher) {
opts.log = logger f.log = logger
} }
} }
// logger returns the logger Run logs to: the given one, or slog.Default(). // 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 // It isn't tagged here, as it is also given to the clients the workers
// create, which add their own component; see tagged. // create, which add their own component; see tagged.
func (opts options) logger() *slog.Logger { func (f *Fetcher) logger() *slog.Logger {
if opts.log == nil { if f.log == nil {
return slog.Default() return slog.Default()
} }
return opts.log return f.log
} }
// tagged returns logger tagged with the fetcher's component, for the lines // tagged returns logger tagged with the fetcher's component, for the lines
@@ -48,35 +43,52 @@ func tagged(logger *slog.Logger) *slog.Logger {
return logger.With("component", "fetcher") return logger.With("component", "fetcher")
} }
// runFunc runs one source's worker until ctx is cancelled. logger is // Fetcher runs a worker for each enabled source. Create it with New and
// untagged: the worker tags its own lines with tagged, and passes logger as // start it with Run.
// it is to any client it creates. type Fetcher struct {
type runFunc func( conf *config.JSCSources
ctx context.Context, log *slog.Logger
logger *slog.Logger, started time.Time
conf *config.JobSearchConfig,
since time.Time, // backgroundCtx is the context the workers run under. backgroundCancel
) error // stops them: Run calls it when its ctx is cancelled, when a worker
// fails, and as it returns.
backgroundCtx context.Context
backgroundCancel context.CancelFunc
}
// New returns a Fetcher for the sources conf configures. It logs to
// slog.Default() unless given WithLogger.
func New(conf *config.JSCSources, opts ...Option) *Fetcher {
fetcher := &Fetcher{
conf: conf,
started: time.Now(),
}
for _, option := range opts {
option(fetcher)
}
fetcher.backgroundCtx, fetcher.backgroundCancel = context.WithCancel(
context.Background(),
)
return fetcher
}
// Run starts a worker for each enabled source and blocks until every worker // 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 // 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 // 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 // logged as they happen and returned joined; nil means a clean shutdown. Run
// logs to slog.Default() unless given WithLogger. // cancels the Fetcher's background context as it returns, so it can only be
func Run( // called once.
ctx context.Context, func (f *Fetcher) Run(ctx context.Context, since time.Time) error {
conf *config.JobSearchConfig, defer f.backgroundCancel()
since time.Time,
opts ...Option,
) error {
ctx, cancel := context.WithCancel(ctx)
defer cancel()
var settings options // Cancelling ctx stops the workers, through the background context.
for _, opt := range opts { stopAfter := context.AfterFunc(ctx, f.backgroundCancel)
opt(&settings) defer stopAfter()
}
logger := settings.logger() logger := f.logger()
var ( var (
wg sync.WaitGroup wg sync.WaitGroup
@@ -84,11 +96,14 @@ func Run(
errs []error errs []error
) )
start := func(name string, run runFunc) { // start runs one source's worker until f.backgroundCtx is cancelled. Each
// worker is given logger untagged: it tags its own lines with tagged, and
// passes logger as it is to any client it creates.
start := func(name string, run func(ctx context.Context) error) {
wg.Add(1) wg.Add(1)
go func() { go func() {
defer wg.Done() defer wg.Done()
if err := run(ctx, logger, conf, since); err != nil { if err := run(f.backgroundCtx); err != nil {
tagged(logger).Error( tagged(logger).Error(
"source stopped, shutting down", "source stopped, shutting down",
"source", name, "source", name,
@@ -97,21 +112,29 @@ func Run(
mu.Lock() mu.Lock()
errs = append(errs, fmt.Errorf("%s: %w", name, err)) errs = append(errs, fmt.Errorf("%s: %w", name, err))
mu.Unlock() mu.Unlock()
cancel() f.backgroundCancel()
} }
}() }()
} }
if conf.Sources.FindATender.Enabled { if f.conf.FindATender.Enabled {
start("FindATender", runFindAOpportunity) start("FindATender", func(ctx context.Context) error {
return runFindATender(ctx, logger, &f.conf.FindATender, since)
})
} }
if conf.Sources.FTSMock.Enabled { if f.conf.FTSMock.Enabled {
start("FTSMock", runFTSMock) start("FTSMock", func(ctx context.Context) error {
return runFTSMock(ctx, logger, &f.conf.FTSMock, since)
})
} }
if conf.Sources.Sleeper.Enabled { if f.conf.Sleeper.Enabled {
start("Sleeper", runSleeper) start("Sleeper", func(ctx context.Context) error {
return runSleeper(ctx, logger, &f.conf.Sleeper, since)
})
} }
// Every worker has stopped once Wait returns, so errs is no longer
// written.
wg.Wait() wg.Wait()
return errors.Join(errs...) return errors.Join(errs...)
+107 -78
View File
@@ -58,18 +58,22 @@ func ftsServer(
return srv, &hits return srv, &hits
} }
func confFor(apiRoot string) *config.JobSearchConfig { // fetchFunc fetches from one source at apiRoot.
conf := &config.JobSearchConfig{} type fetchFunc func(ctx context.Context, apiRoot string, since time.Time) error
conf.Sources.FindATender.APIRoot = apiRoot
conf.Sources.FTSMock.APIRoot = apiRoot // fetchers are the sources' fetch functions, each given only its API root.
return conf var fetchers = map[string]fetchFunc{
"FindATender": func(ctx context.Context, apiRoot string, since time.Time) error {
conf := &config.JSCSourceFindATender{APIRoot: apiRoot}
return fetchFindATender(ctx, slog.Default(), conf, since)
},
"FTSMock": func(ctx context.Context, apiRoot string, since time.Time) error {
conf := &config.JSCSourceFTSMock{APIRoot: apiRoot}
return fetchFTSMock(ctx, slog.Default(), conf, since)
},
} }
func TestFetchFunctions(t *testing.T) { func TestFetchFunctions(t *testing.T) {
fetchers := map[string]runFunc{
"FindAOpportunity": fetchFindAOpportunity,
"FTSMock": fetchFTSMock,
}
tests := []struct { tests := []struct {
name string name string
status int status int
@@ -99,10 +103,7 @@ func TestFetchFunctions(t *testing.T) {
t.Run(fname+"/"+tc.name, func(t *testing.T) { t.Run(fname+"/"+tc.name, func(t *testing.T) {
srv, hits := ftsServer(t, tc.status, tc.body) srv, hits := ftsServer(t, tc.status, tc.body)
err := fetch( err := fetch(
context.Background(), context.Background(), srv.URL, time.Now().Add(-time.Hour),
slog.Default(),
confFor(srv.URL),
time.Now().Add(-time.Hour),
) )
if !tc.check(err) { if !tc.check(err) {
t.Fatalf("err = %v, want %s", err, tc.wantErr) t.Fatalf("err = %v, want %s", err, tc.wantErr)
@@ -115,23 +116,44 @@ func TestFetchFunctions(t *testing.T) {
} }
} }
func TestFetchUsesConfiguredAPIRoot(t *testing.T) { // Run gives each worker its own source's configuration: with only one source
fat, fatHits := ftsServer(t, http.StatusOK, emptyPackage) // enabled, only its API root is called.
mock, mockHits := ftsServer(t, http.StatusOK, emptyPackage) func TestRunUsesEachSourcesAPIRoot(t *testing.T) {
conf := &config.JobSearchConfig{} for _, enabled := range []string{"FindATender", "FTSMock"} {
conf.Sources.FindATender.APIRoot = fat.URL fat, fatHits := ftsServer(t, http.StatusOK, emptyPackage)
conf.Sources.FTSMock.APIRoot = mock.URL mock, mockHits := ftsServer(t, http.StatusOK, emptyPackage)
sources := &config.JSCSources{}
sources.FindATender.APIRoot = fat.URL
sources.FindATender.Interval = time.Hour
sources.FTSMock.APIRoot = mock.URL
sources.FTSMock.Interval = time.Hour
wanted, other := fatHits, mockHits
if enabled == "FindATender" {
sources.FindATender.Enabled = true
} else {
sources.FTSMock.Enabled = true
wanted, other = mockHits, fatHits
}
fetchFindAOpportunity(context.Background(), slog.Default(), conf, time.Time{}) ctx, cancel := context.WithCancel(context.Background())
if fatHits.Load() != 1 || mockHits.Load() != 0 { done := make(chan error, 1)
t.Fatalf( go func() {
"FindAOpportunity hits: fat=%d mock=%d", fatHits.Load(), mockHits.Load(), done <- New(sources).Run(ctx, time.Time{})
) }()
}
fetchFTSMock(context.Background(), slog.Default(), conf, time.Time{}) deadline := time.Now().Add(5 * time.Second)
if fatHits.Load() != 1 || mockHits.Load() != 1 { for wanted.Load() == 0 && time.Now().Before(deadline) {
t.Fatalf("FTSMock hits: fat=%d mock=%d", fatHits.Load(), mockHits.Load()) time.Sleep(5 * time.Millisecond)
}
cancel()
<-done
if wanted.Load() == 0 || other.Load() != 0 {
t.Errorf(
"%s enabled: its root hit %d times, the other's %d; want >0 and 0",
enabled, wanted.Load(), other.Load(),
)
}
} }
} }
@@ -139,9 +161,8 @@ func TestFetchCancelled(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
cancel() cancel()
// Unroutable root: the request should never be waited on. // Unroutable root: the request should never be waited on.
conf := confFor("http://192.0.2.1:9")
start := time.Now() start := time.Now()
err := fetchFTSMock(ctx, slog.Default(), conf, time.Time{}) err := fetchers["FTSMock"](ctx, "http://192.0.2.1:9", time.Time{})
if !errors.Is(err, context.Canceled) { if !errors.Is(err, context.Canceled) {
t.Fatalf("err = %v, want context.Canceled", err) t.Fatalf("err = %v, want context.Canceled", err)
} }
@@ -175,9 +196,8 @@ func TestSleepCompletes(t *testing.T) {
// one holds shutdown open until the worker's shutdown timeout. // one holds shutdown open until the worker's shutdown timeout.
func TestRunSleeperShutdown(t *testing.T) { func TestRunSleeperShutdown(t *testing.T) {
for _, block := range []bool{false, true} { for _, block := range []bool{false, true} {
conf := &config.JobSearchConfig{} conf := &config.JSCSourceSleeper{BlockShutdown: block}
conf.Sources.Sleeper.Interval = time.Hour conf.Interval = time.Hour
conf.Sources.Sleeper.BlockShutdown = block
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
done := make(chan struct{}) done := make(chan struct{})
@@ -202,17 +222,24 @@ func TestRunSleeperShutdown(t *testing.T) {
} }
func TestRunWorkersRejectZeroInterval(t *testing.T) { func TestRunWorkersRejectZeroInterval(t *testing.T) {
conf := &config.JobSearchConfig{} ctx, logger := context.Background(), slog.Default()
runs := map[string]runFunc{ runs := map[string]func() error{
"FindAOpportunity": runFindAOpportunity, "FindATender": func() error {
"FTSMock": runFTSMock, conf := &config.JSCSourceFindATender{APIRoot: "http://127.0.0.1:1"}
"Sleeper": runSleeper, return runFindATender(ctx, logger, conf, time.Time{})
},
"FTSMock": func() error {
conf := &config.JSCSourceFTSMock{APIRoot: "http://127.0.0.1:1"}
return runFTSMock(ctx, logger, conf, time.Time{})
},
"Sleeper": func() error {
return runSleeper(ctx, logger, &config.JSCSourceSleeper{}, time.Time{})
},
} }
for name, run := range runs { for name, run := range runs {
if err := run( err := run()
context.Background(), slog.Default(), conf, time.Time{}, if err == nil || !strings.Contains(err.Error(), "interval") {
); err == nil { t.Errorf("%s: err = %v; want an error for a zero interval", name, err)
t.Errorf("%s: expected an error for a zero interval", name)
} }
} }
} }
@@ -227,13 +254,13 @@ func TestRunLogsSourceErrors(t *testing.T) {
}) })
// A zero interval makes each worker fail straight away. // A zero interval makes each worker fail straight away.
conf := &config.JobSearchConfig{} sources := &config.JSCSources{}
conf.Sources.FindATender.Enabled = true sources.FindATender.Enabled = true
conf.Sources.FindATender.APIRoot = "http://127.0.0.1:1" sources.FindATender.APIRoot = "http://127.0.0.1:1"
conf.Sources.FTSMock.Enabled = true sources.FTSMock.Enabled = true
conf.Sources.FTSMock.APIRoot = "http://127.0.0.1:1" sources.FTSMock.APIRoot = "http://127.0.0.1:1"
conf.Sources.Sleeper.Enabled = true sources.Sleeper.Enabled = true
err := Run(context.Background(), conf, time.Time{}) err := New(sources).Run(context.Background(), time.Time{})
for _, name := range []string{"FindATender", "FTSMock", "Sleeper"} { for _, name := range []string{"FindATender", "FTSMock", "Sleeper"} {
if !strings.Contains(buf.String(), "source="+name) { if !strings.Contains(buf.String(), "source="+name) {
@@ -256,24 +283,26 @@ func TestRunMissingAPIRoot(t *testing.T) {
quiet := slog.New(slog.DiscardHandler) quiet := slog.New(slog.DiscardHandler)
tests := []struct { tests := []struct {
name string name string
enable func(*config.JobSearchConfig) enable func(*config.JSCSources)
key string key string
}{ }{
{"find_a_tender", func(conf *config.JobSearchConfig) { {"find_a_tender", func(sources *config.JSCSources) {
conf.Sources.FindATender.Enabled = true sources.FindATender.Enabled = true
conf.Sources.FindATender.Interval = time.Hour sources.FindATender.Interval = time.Hour
}, "sources.find_a_tender.api_root"}, }, "sources.find_a_tender.api_root"},
{"fts_mock", func(conf *config.JobSearchConfig) { {"fts_mock", func(sources *config.JSCSources) {
conf.Sources.FTSMock.Enabled = true sources.FTSMock.Enabled = true
conf.Sources.FTSMock.Interval = time.Hour sources.FTSMock.Interval = time.Hour
}, "sources.fts_mock.api_root"}, }, "sources.fts_mock.api_root"},
} }
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
conf := &config.JobSearchConfig{} sources := &config.JSCSources{}
tt.enable(conf) tt.enable(sources)
err := Run(context.Background(), conf, time.Time{}, WithLogger(quiet)) err := New(sources, WithLogger(quiet)).Run(
context.Background(), time.Time{},
)
if err == nil || !strings.Contains(err.Error(), tt.key) { if err == nil || !strings.Contains(err.Error(), tt.key) {
t.Errorf("Run = %v; want an error naming %s", err, tt.key) t.Errorf("Run = %v; want an error naming %s", err, tt.key)
} }
@@ -284,9 +313,8 @@ func TestRunMissingAPIRoot(t *testing.T) {
func TestRunNoSourcesEnabled(t *testing.T) { func TestRunNoSourcesEnabled(t *testing.T) {
done := make(chan struct{}) done := make(chan struct{})
go func() { go func() {
if err := Run( err := New(&config.JSCSources{}).Run(context.Background(), time.Time{})
context.Background(), &config.JobSearchConfig{}, time.Time{}, if err != nil {
); err != nil {
t.Errorf("Run = %v; want nil", err) t.Errorf("Run = %v; want nil", err)
} }
close(done) close(done)
@@ -303,16 +331,16 @@ func TestRunNoSourcesEnabled(t *testing.T) {
// cancelled. // cancelled.
func TestRunShutsDownOnWorkerError(t *testing.T) { func TestRunShutsDownOnWorkerError(t *testing.T) {
mock, mockHits := ftsServer(t, http.StatusOK, emptyPackage) mock, mockHits := ftsServer(t, http.StatusOK, emptyPackage)
conf := &config.JobSearchConfig{} sources := &config.JSCSources{}
conf.Sources.FTSMock.Enabled = true sources.FTSMock.Enabled = true
conf.Sources.FTSMock.Interval = time.Hour sources.FTSMock.Interval = time.Hour
conf.Sources.FTSMock.APIRoot = mock.URL sources.FTSMock.APIRoot = mock.URL
// The sleeper fails straight away: a zero interval is invalid. // The sleeper fails straight away: a zero interval is invalid.
conf.Sources.Sleeper.Enabled = true sources.Sleeper.Enabled = true
done := make(chan error, 1) done := make(chan error, 1)
go func() { go func() {
done <- Run(context.Background(), conf, time.Now().Add(-time.Hour)) done <- New(sources).Run(context.Background(), time.Now().Add(-time.Hour))
}() }()
select { select {
@@ -337,20 +365,21 @@ func TestRunShutsDownOnWorkerError(t *testing.T) {
func TestRunEnabledSources(t *testing.T) { func TestRunEnabledSources(t *testing.T) {
fat, fatHits := ftsServer(t, http.StatusOK, onePackage) fat, fatHits := ftsServer(t, http.StatusOK, onePackage)
mock, mockHits := ftsServer(t, http.StatusOK, emptyPackage) mock, mockHits := ftsServer(t, http.StatusOK, emptyPackage)
conf := &config.JobSearchConfig{} sources := &config.JSCSources{}
conf.Sources.FindATender.Enabled = true sources.FindATender.Enabled = true
conf.Sources.FindATender.Interval = time.Hour sources.FindATender.Interval = time.Hour
conf.Sources.FindATender.APIRoot = fat.URL sources.FindATender.APIRoot = fat.URL
conf.Sources.FTSMock.Enabled = true sources.FTSMock.Enabled = true
conf.Sources.FTSMock.Interval = time.Hour sources.FTSMock.Interval = time.Hour
conf.Sources.FTSMock.APIRoot = mock.URL sources.FTSMock.APIRoot = mock.URL
conf.Sources.Sleeper.Enabled = true sources.Sleeper.Enabled = true
conf.Sources.Sleeper.Interval = time.Hour sources.Sleeper.Interval = time.Hour
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
done := make(chan struct{}) done := make(chan struct{})
go func() { go func() {
if err := Run(ctx, conf, time.Now().Add(-time.Hour)); err != nil { err := New(sources).Run(ctx, time.Now().Add(-time.Hour))
if err != nil {
t.Errorf("Run = %v; want nil after cancellation", err) t.Errorf("Run = %v; want nil after cancellation", err)
} }
close(done) close(done)
+11 -11
View File
@@ -12,43 +12,43 @@ import (
"git.avsdev.uk/Go/job-search/internal/util" "git.avsdev.uk/Go/job-search/internal/util"
) )
// runFindAOpportunity polls Find a Tender every configured interval until ctx // runFindATender polls Find a Tender every configured interval until ctx
// is cancelled. // is cancelled.
func runFindAOpportunity( func runFindATender(
ctx context.Context, ctx context.Context,
logger *slog.Logger, logger *slog.Logger,
conf *config.JobSearchConfig, conf *config.JSCSourceFindATender,
since time.Time, since time.Time,
) error { ) error {
if conf.Sources.FindATender.APIRoot == "" { if conf.APIRoot == "" {
return errors.New("fetcher: sources.find_a_tender.api_root is not set") return errors.New("fetcher: sources.find_a_tender.api_root is not set")
} }
worker := util.Worker{ worker := util.Worker{
Logger: tagged(logger), Logger: tagged(logger),
Name: "FindAOpportunity", Name: "FindATender",
Interval: conf.Sources.FindATender.Interval, Interval: conf.Interval,
Task: func(ctx context.Context, since time.Time) error { Task: func(ctx context.Context, since time.Time) error {
return fetchFindAOpportunity(ctx, logger, conf, since) return fetchFindATender(ctx, logger, conf, since)
}, },
} }
return worker.Run(ctx, since) return worker.Run(ctx, since)
} }
// fetchFindAOpportunity fetches everything updated since since from Find a // fetchFindATender fetches everything updated since since from Find a
// Tender. Finding nothing returns ErrNoNewReleases, so the worker still moves // Tender. Finding nothing returns ErrNoNewReleases, so the worker still moves
// its checkpoint on. // its checkpoint on.
func fetchFindAOpportunity( func fetchFindATender(
ctx context.Context, ctx context.Context,
logger *slog.Logger, logger *slog.Logger,
conf *config.JobSearchConfig, conf *config.JSCSourceFindATender,
since time.Time, since time.Time,
) error { ) error {
opportunities, err := util.AwaitTask( opportunities, err := util.AwaitTask(
ctx, ctx,
func() ([]*types.Opportunity, error) { func() ([]*types.Opportunity, error) {
findATender := findatender.New( findATender := findatender.New(
conf, conf.Sources.FindATender.APIRoot, findatender.WithLogger(logger), conf.APIRoot, findatender.WithLogger(logger),
) )
defer findATender.Shutdown() defer findATender.Shutdown()
return findATender.With(ctx).FetchAll(since, true) return findATender.With(ctx).FetchAll(since, true)
+5 -5
View File
@@ -17,17 +17,17 @@ import (
func runFTSMock( func runFTSMock(
ctx context.Context, ctx context.Context,
logger *slog.Logger, logger *slog.Logger,
conf *config.JobSearchConfig, conf *config.JSCSourceFTSMock,
since time.Time, since time.Time,
) error { ) error {
if conf.Sources.FTSMock.APIRoot == "" { if conf.APIRoot == "" {
return errors.New("fetcher: sources.fts_mock.api_root is not set") return errors.New("fetcher: sources.fts_mock.api_root is not set")
} }
worker := util.Worker{ worker := util.Worker{
Logger: tagged(logger), Logger: tagged(logger),
Name: "FTSMock", Name: "FTSMock",
Interval: conf.Sources.FTSMock.Interval, Interval: conf.Interval,
Task: func(ctx context.Context, since time.Time) error { Task: func(ctx context.Context, since time.Time) error {
return fetchFTSMock(ctx, logger, conf, since) return fetchFTSMock(ctx, logger, conf, since)
}, },
@@ -41,14 +41,14 @@ func runFTSMock(
func fetchFTSMock( func fetchFTSMock(
ctx context.Context, ctx context.Context,
logger *slog.Logger, logger *slog.Logger,
conf *config.JobSearchConfig, conf *config.JSCSourceFTSMock,
since time.Time, since time.Time,
) error { ) error {
opportunities, err := util.AwaitTask( opportunities, err := util.AwaitTask(
ctx, ctx,
func() ([]*types.Opportunity, error) { func() ([]*types.Opportunity, error) {
findATender := findatender.New( findATender := findatender.New(
conf, conf.Sources.FTSMock.APIRoot, findatender.WithLogger(logger), conf.APIRoot, findatender.WithLogger(logger),
) )
defer findATender.Shutdown() defer findATender.Shutdown()
return findATender.With(ctx).FetchAll(since, true) return findATender.With(ctx).FetchAll(since, true)
+3 -3
View File
@@ -17,14 +17,14 @@ const sleepDuration = 60 * time.Second
func runSleeper( func runSleeper(
ctx context.Context, ctx context.Context,
logger *slog.Logger, logger *slog.Logger,
conf *config.JobSearchConfig, conf *config.JSCSourceSleeper,
since time.Time, since time.Time,
) error { ) error {
blockShutdown := conf.Sources.Sleeper.BlockShutdown blockShutdown := conf.BlockShutdown
worker := util.Worker{ worker := util.Worker{
Logger: tagged(logger), Logger: tagged(logger),
Name: "Sleeper", Name: "Sleeper",
Interval: conf.Sources.Sleeper.Interval, Interval: conf.Interval,
Task: func(taskCtx context.Context, since time.Time) error { Task: func(taskCtx context.Context, since time.Time) error {
if blockShutdown { if blockShutdown {
return sleep(taskCtx, true, sleepDuration) return sleep(taskCtx, true, sleepDuration)
+3 -3
View File
@@ -307,10 +307,10 @@ func closeBody(res *resty.Response) {
} }
// fetchURI performs a single GET of uri, using findATender's context, and // fetchURI performs a single GET of uri, using findATender's context, and
// traces it at debug level. Unlike the method of the same name it does not // traces it when debug logging is on (logging.IsDebugEnabled). Unlike the
// check the response status. // method of the same name it does not check the response status.
func fetchURI(findATender *FindATender, uri string) (*resty.Response, error) { func fetchURI(findATender *FindATender, uri string) (*resty.Response, error) {
withTrace := findATender.config.Logging.LogLevel() <= slog.LevelDebug withTrace := logging.IsDebugEnabled()
logger := findATender.logger() logger := findATender.logger()
logger.Info("fetching", "uri", uri) logger.Info("fetching", "uri", uri)
+31 -31
View File
@@ -17,18 +17,10 @@ import (
resty "resty.dev/v3" resty "resty.dev/v3"
"git.avsdev.uk/Go/job-search/internal/config"
"git.avsdev.uk/Go/job-search/internal/findatender/ocds" "git.avsdev.uk/Go/job-search/internal/findatender/ocds"
"git.avsdev.uk/Go/job-search/internal/logging"
) )
func testConfig(level string) *config.JobSearchConfig {
return &config.JobSearchConfig{
Logging: config.JSCLogging{
Level: level,
},
}
}
// quietLogs discards slog output for the duration of the test, or sends it // quietLogs discards slog output for the duration of the test, or sends it
// through h when given. // through h when given.
func quietLogs(t *testing.T, h slog.Handler) { func quietLogs(t *testing.T, h slog.Handler) {
@@ -44,16 +36,24 @@ func quietLogs(t *testing.T, h slog.Handler) {
} }
// newTestFT starts h on a test server and returns a FindATender pointed at it. // newTestFT starts h on a test server and returns a FindATender pointed at it.
// With debug, the logging level is debug for the test, so requests are
// traced.
func newTestFT( func newTestFT(
t *testing.T, level string, h http.HandlerFunc, t *testing.T, debug bool, h http.HandlerFunc,
) (*FindATender, *httptest.Server) { ) (*FindATender, *httptest.Server) {
t.Helper() t.Helper()
quietLogs(t, nil) quietLogs(t, nil)
if debug {
logging.SetLevel(slog.LevelDebug)
t.Cleanup(func() {
logging.SetLevel(slog.LevelInfo)
})
}
srv := httptest.NewServer(h) srv := httptest.NewServer(h)
t.Cleanup(srv.Close) t.Cleanup(srv.Close)
ft := New(testConfig(level), srv.URL) ft := New(srv.URL)
t.Cleanup(ft.Shutdown) t.Cleanup(ft.Shutdown)
return ft, srv return ft, srv
@@ -97,7 +97,7 @@ func TestRateSleep(t *testing.T) {
func TestFetchWithOptsBuildsURI(t *testing.T) { func TestFetchWithOptsBuildsURI(t *testing.T) {
var gotPath, gotQuery string var gotPath, gotQuery string
ft, _ := newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, _ := newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
gotPath, gotQuery = r.URL.Path, r.URL.RawQuery gotPath, gotQuery = r.URL.Path, r.URL.RawQuery
io.WriteString(w, packageJSON("")) io.WriteString(w, packageJSON(""))
}) })
@@ -133,7 +133,7 @@ func TestFetchWithOptsBuildsURI(t *testing.T) {
// A zero Since defaults to 24 hours ago. // A zero Since defaults to 24 hours ago.
func TestFetchWithOptsDefaultSince(t *testing.T) { func TestFetchWithOptsDefaultSince(t *testing.T) {
var gotQuery string var gotQuery string
ft, _ := newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, _ := newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
gotQuery = r.URL.Query().Get("updatedFrom") gotQuery = r.URL.Query().Get("updatedFrom")
io.WriteString(w, packageJSON("")) io.WriteString(w, packageJSON(""))
}) })
@@ -188,7 +188,7 @@ func TestFetchURIRateLimit(t *testing.T) {
var hits atomic.Int32 var hits atomic.Int32
ft, srv := newTestFT( ft, srv := newTestFT(
t, t,
"warn", false,
func(w http.ResponseWriter, r *http.Request) { func(w http.ResponseWriter, r *http.Request) {
if hits.Add(1) == 1 { if hits.Add(1) == 1 {
if tt.retryAfter != "" { if tt.retryAfter != "" {
@@ -228,7 +228,7 @@ func TestFetchURIRateLimit(t *testing.T) {
} }
func TestFetchURIRateLimitCancelled(t *testing.T) { func TestFetchURIRateLimitCancelled(t *testing.T) {
ft, srv := newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, srv := newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Retry-After", "3600") w.Header().Set("Retry-After", "3600")
w.WriteHeader(http.StatusTooManyRequests) w.WriteHeader(http.StatusTooManyRequests)
}) })
@@ -252,7 +252,7 @@ func TestFetchURIRateLimitCancelled(t *testing.T) {
func TestFetchURIRateLimitTwice(t *testing.T) { func TestFetchURIRateLimitTwice(t *testing.T) {
// A second 429 after waiting is reported as ErrRateLimitExceeded. // A second 429 after waiting is reported as ErrRateLimitExceeded.
var hits atomic.Int32 var hits atomic.Int32
ft, srv := newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, srv := newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
hits.Add(1) hits.Add(1)
w.Header().Set("Retry-After", "0") w.Header().Set("Retry-After", "0")
w.WriteHeader(http.StatusTooManyRequests) w.WriteHeader(http.StatusTooManyRequests)
@@ -274,7 +274,7 @@ func TestFetchURIUnexpectedStatus(t *testing.T) {
t.Run(http.StatusText(status), func(t *testing.T) { t.Run(http.StatusText(status), func(t *testing.T) {
ft, srv := newTestFT( ft, srv := newTestFT(
t, t,
"warn", false,
func(w http.ResponseWriter, r *http.Request) { func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(status) w.WriteHeader(status)
io.WriteString(w, packageJSON("", releaseJSON("ocds-1", "1"))) io.WriteString(w, packageJSON("", releaseJSON("ocds-1", "1")))
@@ -294,7 +294,7 @@ func TestFetchURIUnexpectedStatus(t *testing.T) {
// A non-2xx after waiting out a 429 is reported as ErrUnexpectedStatus. // A non-2xx after waiting out a 429 is reported as ErrUnexpectedStatus.
func TestFetchURIRateLimitThenError(t *testing.T) { func TestFetchURIRateLimitThenError(t *testing.T) {
var hits atomic.Int32 var hits atomic.Int32
ft, srv := newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, srv := newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
if hits.Add(1) == 1 { if hits.Add(1) == 1 {
w.Header().Set("Retry-After", "0") w.Header().Set("Retry-After", "0")
w.WriteHeader(http.StatusTooManyRequests) w.WriteHeader(http.StatusTooManyRequests)
@@ -309,7 +309,7 @@ func TestFetchURIRateLimitThenError(t *testing.T) {
} }
func TestFetchURIConnectionError(t *testing.T) { func TestFetchURIConnectionError(t *testing.T) {
ft, srv := newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, srv := newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
}) })
srv.Close() srv.Close()
ft.httpClient.SetRetryCount(0) ft.httpClient.SetRetryCount(0)
@@ -319,7 +319,7 @@ func TestFetchURIConnectionError(t *testing.T) {
} }
func TestFetchURICancelledContext(t *testing.T) { func TestFetchURICancelledContext(t *testing.T) {
ft, srv := newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, srv := newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
io.WriteString(w, packageJSON("")) io.WriteString(w, packageJSON(""))
}) })
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
@@ -346,7 +346,7 @@ func TestFetchURIDebugTrace(t *testing.T) {
t.Run(name, func(t *testing.T) { t.Run(name, func(t *testing.T) {
ft, _ := newTestFT( ft, _ := newTestFT(
t, t,
"debug", true,
func(w http.ResponseWriter, r *http.Request) { func(w http.ResponseWriter, r *http.Request) {
io.WriteString(w, packageJSON("", releaseJSON("ocds-1", "1"))) io.WriteString(w, packageJSON("", releaseJSON("ocds-1", "1")))
}, },
@@ -379,7 +379,7 @@ func TestFetchURIDebugTrace(t *testing.T) {
func TestFetchURIDebugTraceConnectionError(t *testing.T) { func TestFetchURIDebugTraceConnectionError(t *testing.T) {
ft, srv := newTestFT( ft, srv := newTestFT(
t, t,
"debug", true,
func(w http.ResponseWriter, r *http.Request) { func(w http.ResponseWriter, r *http.Request) {
}, },
) )
@@ -392,7 +392,7 @@ func TestFetchURIDebugTraceConnectionError(t *testing.T) {
func TestFetchNext(t *testing.T) { func TestFetchNext(t *testing.T) {
var gotPath string var gotPath string
ft, srv := newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, srv := newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
gotPath = r.URL.Path gotPath = r.URL.Path
io.WriteString(w, packageJSON("")) io.WriteString(w, packageJSON(""))
}) })
@@ -428,7 +428,7 @@ func TestFetchNext(t *testing.T) {
// responseFor fetches body from a test server so it can be unpacked. // responseFor fetches body from a test server so it can be unpacked.
func responseFor(t *testing.T, body string) *resty.Response { func responseFor(t *testing.T, body string) *resty.Response {
t.Helper() t.Helper()
ft, srv := newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, srv := newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
io.WriteString(w, body) io.WriteString(w, body)
}) })
res, err := ft.fetchURI(srv.URL, false) res, err := ft.fetchURI(srv.URL, false)
@@ -551,7 +551,7 @@ func pagedServer(
t.Helper() t.Helper()
var hits atomic.Int32 var hits atomic.Int32
var srvURL string var srvURL string
ft, srv := newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, srv := newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
hits.Add(1) hits.Add(1)
i := 0 i := 0
@@ -598,7 +598,7 @@ func TestFetchOnceErrors(t *testing.T) {
t.Errorf("empty page: err = %v, want ErrNoReleases", err) t.Errorf("empty page: err = %v, want ErrNoReleases", err)
} }
ft, _ = newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, _ = newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
io.WriteString(w, "not json") io.WriteString(w, "not json")
}) })
if _, err := ft.fetchOnce(RequestOptions{ if _, err := ft.fetchOnce(RequestOptions{
@@ -607,7 +607,7 @@ func TestFetchOnceErrors(t *testing.T) {
t.Error("bad body: expected an error") t.Error("bad body: expected an error")
} }
ft, _ = newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, _ = newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusTooManyRequests) w.WriteHeader(http.StatusTooManyRequests)
}) })
if _, err := ft.fetchOnce( if _, err := ft.fetchOnce(
@@ -655,7 +655,7 @@ func TestFetchAllErrors(t *testing.T) {
} }
// First page fails. // First page fails.
ft, _ = newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, _ = newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusTooManyRequests) w.WriteHeader(http.StatusTooManyRequests)
}) })
if _, err := ft.fetchAll( if _, err := ft.fetchAll(
@@ -666,7 +666,7 @@ func TestFetchAllErrors(t *testing.T) {
t.Errorf("first page rate limited: err = %v", err) t.Errorf("first page rate limited: err = %v", err)
} }
ft, _ = newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, _ = newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
io.WriteString(w, "not json") io.WriteString(w, "not json")
}) })
if _, err := ft.fetchAll(RequestOptions{ if _, err := ft.fetchAll(RequestOptions{
@@ -688,7 +688,7 @@ func TestFetchAllErrors(t *testing.T) {
var srvURL string var srvURL string
ft, srv := newTestFT( ft, srv := newTestFT(
t, t,
"warn", false,
func(w http.ResponseWriter, r *http.Request) { func(w http.ResponseWriter, r *http.Request) {
if r.URL.Query().Get("page") == "" { if r.URL.Query().Get("page") == "" {
io.WriteString( io.WriteString(
@@ -730,7 +730,7 @@ func TestFetchAllRepeatedNextLink(t *testing.T) {
var srvURL string var srvURL string
ft, srv := newTestFT( ft, srv := newTestFT(
t, t,
"error", false,
func(w http.ResponseWriter, r *http.Request) { func(w http.ResponseWriter, r *http.Request) {
if hits.Add(1) > 10 { if hits.Add(1) > 10 {
t.Error("fetchAll did not stop following next links") t.Error("fetchAll did not stop following next links")
+1 -12
View File
@@ -7,7 +7,6 @@ import (
resty "resty.dev/v3" resty "resty.dev/v3"
"git.avsdev.uk/Go/job-search/internal/config"
"git.avsdev.uk/Go/job-search/internal/types" "git.avsdev.uk/Go/job-search/internal/types"
) )
@@ -15,7 +14,6 @@ import (
// server). Create it with New and call Shutdown when finished with it. // server). Create it with New and call Shutdown when finished with it.
type FindATender struct { type FindATender struct {
httpClient *resty.Client httpClient *resty.Client
config *config.JobSearchConfig
apiRoot string apiRoot string
ctx context.Context ctx context.Context
log *slog.Logger log *slog.Logger
@@ -34,11 +32,8 @@ func WithLogger(logger *slog.Logger) Option {
// New returns a client for the OCDS API at apiRoot. Requests time out after // New returns a client for the OCDS API at apiRoot. Requests time out after
// 60 seconds and are retried once. Call Shutdown when finished with it. It // 60 seconds and are retried once. Call Shutdown when finished with it. It
// logs to slog.Default() unless given WithLogger. // logs to slog.Default() unless given WithLogger.
func New( func New(apiRoot string, opts ...Option) *FindATender {
conf *config.JobSearchConfig, apiRoot string, opts ...Option,
) *FindATender {
findATender := &FindATender{ findATender := &FindATender{
config: conf,
apiRoot: apiRoot, apiRoot: apiRoot,
} }
for _, opt := range opts { for _, opt := range opts {
@@ -61,12 +56,6 @@ func (ft *FindATender) logger() *slog.Logger {
return log.With("component", "findatender") return log.With("component", "findatender")
} }
// ReloadConfig replaces the configuration the client reads, such as the log
// level. The HTTP client and API root set by New are not changed.
func (ft *FindATender) ReloadConfig(conf *config.JobSearchConfig) {
ft.config = conf
}
// With returns a copy of the client whose requests use ctx, so they stop // With returns a copy of the client whose requests use ctx, so they stop
// when it is cancelled. A nil ctx returns the client unchanged. // when it is cancelled. A nil ctx returns the client unchanged.
func (ft *FindATender) With(ctx context.Context) *FindATender { func (ft *FindATender) With(ctx context.Context) *FindATender {
+7 -18
View File
@@ -14,12 +14,11 @@ import (
) )
func TestNew(t *testing.T) { func TestNew(t *testing.T) {
conf := testConfig("warn") ft := New("https://example/api")
ft := New(conf, "https://example/api")
defer ft.Shutdown() defer ft.Shutdown()
if ft.config != conf || ft.apiRoot != "https://example/api" { if ft.apiRoot != "https://example/api" {
t.Errorf("New did not keep its arguments: %+v", ft) t.Errorf("New did not keep its API root: %+v", ft)
} }
if ft.httpClient == nil { if ft.httpClient == nil {
t.Fatal("no http client") t.Fatal("no http client")
@@ -37,18 +36,8 @@ func TestNew(t *testing.T) {
} }
} }
func TestReloadConfig(t *testing.T) {
ft := New(testConfig("warn"), "")
defer ft.Shutdown()
conf := testConfig("debug")
ft.ReloadConfig(conf)
if ft.config != conf {
t.Error("config not replaced")
}
}
func TestWith(t *testing.T) { func TestWith(t *testing.T) {
ft := New(testConfig("warn"), "") ft := New("")
defer ft.Shutdown() defer ft.Shutdown()
// Passing nil on purpose to test that case. // Passing nil on purpose to test that case.
@@ -69,8 +58,8 @@ func TestWith(t *testing.T) {
if ft.ctx != nil { if ft.ctx != nil {
t.Error("With changed the original") t.Error("With changed the original")
} }
if got.httpClient != ft.httpClient || got.config != ft.config { if got.httpClient != ft.httpClient {
t.Error("copy should share the client and config") t.Error("copy should share the client")
} }
} }
@@ -128,7 +117,7 @@ func TestFetchAllPublic(t *testing.T) {
} }
} }
ft, _ = newTestFT(t, "warn", func(w http.ResponseWriter, r *http.Request) { ft, _ = newTestFT(t, false, func(w http.ResponseWriter, r *http.Request) {
io.WriteString(w, "not json") io.WriteString(w, "not json")
}) })
if _, err := ft.FetchAll(time.Now(), false); err == nil { if _, err := ft.FetchAll(time.Now(), false); err == nil {