Added fetch script for UK Gov FindATender service which is based on OCDS (with issues...)
This commit is contained in:
1 parent
ff33ef082a
commit
e43b7a8370
16 files changed
+744
-11
No files matched your search
@@ -0,0 +1 @@
|
||||
ocds_gen.go
|
||||
@@ -0,0 +1,218 @@
|
||||
/*
|
||||
Copyright © 2026 Craig Williams <craig@avsdev.uk>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Lesser General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
package findATender
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"strconv"
|
||||
"time"
|
||||
|
||||
"git.avsdev.uk/Go/job-search/internal/findATender/ocds"
|
||||
"git.avsdev.uk/Go/job-search/internal/logging"
|
||||
resty "resty.dev/v3"
|
||||
)
|
||||
|
||||
var ErrNoNext = errors.New("no next link")
|
||||
var ErrNoReleases = errors.New("no releases")
|
||||
var ErrRateLimitExceeded = errors.New("rate limit has been exceeded")
|
||||
var ErrFetchCancelled = errors.New("fetch cancelled")
|
||||
|
||||
type RequestOptions struct {
|
||||
Since time.Time
|
||||
Limit int
|
||||
AllowRateLimit bool
|
||||
}
|
||||
|
||||
func rateSleep(ctx context.Context, duration time.Duration) error {
|
||||
timer := time.NewTimer(duration)
|
||||
defer timer.Stop()
|
||||
|
||||
select {
|
||||
case <-timer.C:
|
||||
return nil
|
||||
case <-ctx.Done():
|
||||
return ctx.Err()
|
||||
}
|
||||
}
|
||||
|
||||
func fetchURI(ft *FindATender, uri string) (*resty.Response, error) {
|
||||
withTrace := ft.config.Logging.LogLevel() <= slog.LevelDebug
|
||||
|
||||
slog.Info("findTender.resty", "request_uri", uri)
|
||||
|
||||
ctx := ft.ctx
|
||||
if ctx == nil {
|
||||
ctx = context.Background()
|
||||
}
|
||||
|
||||
req := ft.httpClient.R()
|
||||
req.SetContext(ctx)
|
||||
res, err := req.SetTrace(withTrace).Get(uri)
|
||||
|
||||
if withTrace {
|
||||
if logging.IsJSONHandler(slog.Default().Handler()) {
|
||||
slog.Debug(
|
||||
"Resty",
|
||||
"trace", res.Request.TraceInfo().JSON(),
|
||||
"status", res.Status(),
|
||||
"response", res,
|
||||
)
|
||||
} else {
|
||||
slog.Debug("Resty " + res.Request.TraceInfo().String())
|
||||
slog.Debug("Resty status: " + res.Status())
|
||||
slog.Debug("Resty response: " + res.String())
|
||||
}
|
||||
}
|
||||
|
||||
return res, err
|
||||
}
|
||||
|
||||
func (ft *FindATender) fetchURI(
|
||||
uri string,
|
||||
allowRateLimit bool,
|
||||
) (*resty.Response, error) {
|
||||
res, err := fetchURI(ft, uri)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if ft.ctx == nil {
|
||||
copied := *ft
|
||||
copied.ctx = context.Background()
|
||||
ft = &copied
|
||||
}
|
||||
|
||||
if res.StatusCode() == 429 {
|
||||
if !allowRateLimit {
|
||||
return nil, ErrRateLimitExceeded
|
||||
}
|
||||
|
||||
retrySecStr := res.Header().Get("Retry-After")
|
||||
retrySec, err := strconv.ParseInt(retrySecStr, 10, 32)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unknown retry-after value: %w", err)
|
||||
}
|
||||
|
||||
slog.Warn(fmt.Sprintf(
|
||||
"API rate limit hit, waiting as requested for %d seconds", retrySec,
|
||||
))
|
||||
if rateSleep(ft.ctx, time.Duration(retrySec)*time.Second) != nil {
|
||||
return nil, ErrFetchCancelled
|
||||
}
|
||||
|
||||
res, err = fetchURI(ft, uri)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
|
||||
return res, nil
|
||||
}
|
||||
|
||||
func (ft *FindATender) fetchWithOpts(
|
||||
opts RequestOptions,
|
||||
) (*resty.Response, error) {
|
||||
if opts.Since.IsZero() {
|
||||
opts.Since = time.Now().AddDate(0, 0, 1)
|
||||
}
|
||||
if opts.Limit == 0 {
|
||||
opts.Limit = 100
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(
|
||||
"%s/ocdsReleasePackages?updatedFrom=%s&limit=%d",
|
||||
ft.apiRoot,
|
||||
opts.Since.Format("2006-01-02T15:04:05"),
|
||||
opts.Limit,
|
||||
)
|
||||
|
||||
return ft.fetchURI(uri, opts.AllowRateLimit)
|
||||
}
|
||||
|
||||
func (ft *FindATender) fetchNext(
|
||||
pkg ocds.ReleasePackage,
|
||||
allowRateLimit bool,
|
||||
) (*resty.Response, error) {
|
||||
if pkg.Links == nil || len(pkg.Links.Next) == 0 {
|
||||
return nil, ErrNoNext
|
||||
}
|
||||
return ft.fetchURI(pkg.Links.Next, allowRateLimit)
|
||||
}
|
||||
|
||||
func (ft *FindATender) fetchOnce(opts RequestOptions) ([]ocds.Release, error) {
|
||||
res, err := ft.fetchWithOpts(opts)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
var relPkg ocds.ReleasePackage
|
||||
decoder := json.NewDecoder(NewOCDSStreamCleaner(res.Body))
|
||||
if err := decoder.Decode(&relPkg); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if len(relPkg.Releases) == 0 {
|
||||
return nil, ErrNoReleases
|
||||
}
|
||||
|
||||
return relPkg.Releases, nil
|
||||
}
|
||||
|
||||
func (ft *FindATender) fetchAll(opts RequestOptions) ([]ocds.Release, error) {
|
||||
var releases []ocds.Release
|
||||
|
||||
res, err := ft.fetchWithOpts(opts)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
var relPkg ocds.ReleasePackage
|
||||
decoder := json.NewDecoder(NewOCDSStreamCleaner(res.Body))
|
||||
if err := decoder.Decode(&relPkg); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
releases = append(releases, relPkg.Releases...)
|
||||
|
||||
for true {
|
||||
res, err := ft.fetchNext(relPkg, opts.AllowRateLimit)
|
||||
if err == ErrNoNext {
|
||||
break
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
decoder := json.NewDecoder(NewOCDSStreamCleaner(res.Body))
|
||||
if err := decoder.Decode(&relPkg); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
releases = append(releases, relPkg.Releases...)
|
||||
}
|
||||
|
||||
if len(releases) == 0 {
|
||||
return nil, ErrNoReleases
|
||||
}
|
||||
|
||||
return releases, nil
|
||||
}
|
||||
@@ -0,0 +1,59 @@
|
||||
/*
|
||||
Copyright © 2026 Craig Williams <craig@avsdev.uk>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Lesser General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
package findATender
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"bytes"
|
||||
"io"
|
||||
"regexp"
|
||||
)
|
||||
|
||||
// Global regex to identify and catch date-only fields
|
||||
var invalidDateRegex = regexp.MustCompile(`:\s*"(\d{4}-\d{2}-\d{2})"\s*([,}\s])`)
|
||||
var invalidPublishedDateRegex = regexp.MustCompile(`"publishedDate":\s*""`)
|
||||
|
||||
// The UK Government FindATender service doesn't strictly follow OCDS date
|
||||
// format. Sometimes it provides dates only, sometimes it sends empty strings
|
||||
// instead of nulls.
|
||||
type FindATenderStreamCleaner struct {
|
||||
reader *bufio.Reader
|
||||
buffer bytes.Buffer
|
||||
}
|
||||
|
||||
func NewOCDSStreamCleaner(r io.Reader) *FindATenderStreamCleaner {
|
||||
return &FindATenderStreamCleaner{reader: bufio.NewReader(r)}
|
||||
}
|
||||
|
||||
func (sc *FindATenderStreamCleaner) Read(p []byte) (int, error) {
|
||||
if sc.buffer.Len() == 0 {
|
||||
line, err := sc.reader.ReadBytes('\n')
|
||||
if len(line) > 0 {
|
||||
// Convert "2026-11-16" -> "2026-11-16T00:00:00Z"
|
||||
line = invalidDateRegex.ReplaceAll(line, []byte(`:"$1T00:00:00Z"`))
|
||||
// Convert {publishedDate:""} -> "{publishedDate:null}"
|
||||
line = invalidPublishedDateRegex.ReplaceAll(line, []byte(`"publishedDate":null`))
|
||||
sc.buffer.Write(line)
|
||||
}
|
||||
if err != nil {
|
||||
if sc.buffer.Len() == 0 {
|
||||
return 0, err
|
||||
}
|
||||
}
|
||||
}
|
||||
return sc.buffer.Read(p)
|
||||
}
|
||||
@@ -0,0 +1,91 @@
|
||||
/*
|
||||
Copyright © 2026 Craig Williams <craig@avsdev.uk>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Lesser General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
package findATender
|
||||
|
||||
import (
|
||||
"context"
|
||||
"time"
|
||||
|
||||
"git.avsdev.uk/Go/job-search/internal/config"
|
||||
"git.avsdev.uk/Go/job-search/internal/findATender/ocds"
|
||||
resty "resty.dev/v3"
|
||||
)
|
||||
|
||||
type FindATender struct {
|
||||
httpClient *resty.Client
|
||||
config *config.JobSearchConfig
|
||||
apiRoot string
|
||||
ctx context.Context
|
||||
}
|
||||
|
||||
func New(conf *config.JobSearchConfig, apiRoot string) FindATender {
|
||||
ft := FindATender{
|
||||
config: conf,
|
||||
apiRoot: apiRoot,
|
||||
}
|
||||
ft.httpClient = resty.New().
|
||||
SetTimeout(60 * time.Duration(time.Second)).
|
||||
SetRetryCount(1)
|
||||
return ft
|
||||
}
|
||||
|
||||
func (ft *FindATender) ReloadConfig(conf *config.JobSearchConfig) {
|
||||
ft.config = conf
|
||||
// TODO: any reloading required for configuration change handling
|
||||
}
|
||||
|
||||
func (ft *FindATender) With(ctx context.Context) *FindATender {
|
||||
if ctx == nil {
|
||||
return ft
|
||||
}
|
||||
|
||||
copied := *ft
|
||||
copied.ctx = ctx
|
||||
return &copied
|
||||
}
|
||||
|
||||
func (ft *FindATender) Shutdown() {
|
||||
ft.httpClient.Close()
|
||||
}
|
||||
|
||||
func (ft *FindATender) FetchOnce(
|
||||
since time.Time,
|
||||
allowRateLimit bool,
|
||||
) ([]ocds.Release, error) {
|
||||
reqs, err := ft.fetchOnce(RequestOptions{
|
||||
Since: since,
|
||||
AllowRateLimit: allowRateLimit,
|
||||
})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return reqs, nil
|
||||
}
|
||||
|
||||
func (ft *FindATender) FetchAll(
|
||||
since time.Time,
|
||||
allowRateLimit bool,
|
||||
) ([]ocds.Release, error) {
|
||||
reqs, err := ft.fetchAll(RequestOptions{
|
||||
Since: since,
|
||||
AllowRateLimit: allowRateLimit,
|
||||
})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return reqs, nil
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"releaseSchema": "https://raw.githubusercontent.com/open-contracting/standard/1.1/schema/release-schema.json",
|
||||
"releasePackageSchema": "https://raw.githubusercontent.com/open-contracting/standard/1.1/schema/release-package-schema.json",
|
||||
"extensions": [
|
||||
"https://standard.open-contracting.org/profiles/eu/latest/en/extension.json",
|
||||
"https://raw.githubusercontent.com/open-contracting-extensions/ocds_amendment_rationale_classifications_extension/master/extension.json",
|
||||
"https://raw.githubusercontent.com/open-contracting-extensions/ocds_budget_breakdown_extension/master/extension.json",
|
||||
"https://raw.githubusercontent.com/open-contracting-extensions/ocds_contract_completion_extension/master/extension.json",
|
||||
"https://raw.githubusercontent.com/open-contracting-extensions/ocds_documentation_extension/master/extension.json",
|
||||
"https://raw.githubusercontent.com/open-contracting-extensions/ocds_pagination_extension/master/extension.json",
|
||||
"https://raw.githubusercontent.com/open-contracting-extensions/ocds_suitability_extension/master/extension.json",
|
||||
"https://raw.githubusercontent.com/portaledcahn/ocds_Links_extension/main/extension.json",
|
||||
"https://raw.githubusercontent.com/cabinetoffice/ocds_uk_extension/main/extension.json",
|
||||
"https://raw.githubusercontent.com/open-contracting-extensions/ocds_performance_failures_extension/master/extension.json"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,5 @@
|
||||
// Package full contains OCDS 1.1 types with the full extension set applied:
|
||||
// the EU profile, UK extension, and the other extensions in extensions.json.
|
||||
package ocds
|
||||
|
||||
//go:generate go run git.avsdev.uk/Go/go-ocds/cmd/ocdsgen generate -c extensions.json -o ocds_gen.go -p ocds
|
||||
Reference in new issue
Block a user