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.
Short and single-letter names in application code become full words (tests
keep theirs). Wrapped calls, signatures and composite literals put one item
per line, and one-line function bodies are expanded. Exported names and
groups of constants get doc comments, and comments refer to the renamed
identifiers.
Log messages are lower-case event names with their details as key/value
attributes ("error" for errors), in place of formatted strings.
Loggable package take a WithLogger option as part of their "New*" call,
defaulting to slog.Default(). Each tags its lines with its `component`.
Some debug loggers print directly rather than using slog when in
terminal logging mode.
- a source's interval must be greater than 0: a source is turned off with
enabled, not with a zero interval, so JSCSourcesSource rejects an interval of
0 or less (its validate is promoted to each source's section);
- max_message_size rejects -1: JSCServerWebSocket rejects a max_message_size
of -1 (util.ByteSizeNoLimit), as a client could then exhaust the server's
memory;
- every setting documents what 0 or empty means (zero/none, no limit or a
default).
gci is configured with the sections standard, default and localmodule, and
goimports with the module path as its local prefix, so both formatters
agree.
which runs a plain TCP server for receiving websocket hub clients, with
server config, CSRF and rate limit middleware.
- internal/websocket: Hub pushing messages to WebSocket clients (ServeHTTP,
example.com/ws upgrade with optional CSRF check) and plain TCP clients (ServeTCP,
newline-delimited JSON envelopes); ping/pong keepalive, per-client message
rate limit, slow consumer handling, graceful Shutdown, debug logging of
messages sent and received
- internal/websocket/tcpserver: standalone TCP server for a hub, with accept
back-off, a per-IP connection limit (server.websocket.connection_limit) and
graceful shutdown
- internal/cli/wsserve: `wsserve` command running the TCP server, with
--listen/--host/--port overrides
- internal/middleware: keyed token bucket rate limiter, real client IP from
trusted proxies
- internal/httpx: RFC 9457 problem responses, request IDs in context
- internal/config: server section (host, port, shutdown timeout, rate limiter
idle TTL, websocket); util.ByteSize settings (e.g. "32KiB"); lists of
sections as single keys; empty lists stored as nil; isExplicitlySet for
printLoadedConfig; JobSearchConfigSource renamed to JSCSourcesSource;
TestSections checks every section's methods
- internal/util: ByteSize, parsed and formatted with go-humanize
- Fixed function name typo
- Fetcher/Run now returns a combination of errors if any workers error out. All other workers are ordered to shutdown if any one does error out
- findATender now returns a pointer instead of an instance from New
Fetching:
- Add `fetch service`, which runs a worker per enabled source until
SIGINT/SIGTERM (internal/fetcher)
- Add util.Worker: runs a task on an interval with a since-checkpoint
that only advances on success, and a shutdown timeout for in-flight
work; plus AwaitTask/AwaitTaskE for calls that ignore cancellation
- Add fts_mock and sleeper sources
- Sleeper: sleeps periodically to emulate work being done. Can be
instructed to block the shutdown signal or handle it cleanly
Mock FTS server (cmd/mock-fts, internal/mock/findATender):
- Serves GET /api/1.0/ocdsReleasePackages with FTS paging, query
validation, UK local time handling and per-client rate limiting
- Generates fictional releases from an embedded catalog, moving
procedures through planning, tender and award, and keeps them in a
JSON Lines store that survives restarts
- Add logging.AccessLog for combined/common access logs
- logging: LogToFile shadowed the package-level fileLogger, so
IsFileLogger was always false and Shutdown never closed the file
- logging: replace IsJSONHandler's unsafe reflection into slog
internals with a *slog.JSONHandler type check
- cli: fail if the log file can't be opened instead of silently
logging to the terminal; return the log shutdown error from Finish
- build.sh: -X flags used the wrong module path, so the version, build
time and commit were never stamped
- Convert OCDS releases to types.Opportunity (internal/types); FetchOnce
and FetchAll now return opportunities, built from each ocid's latest
release
- Include each item's main classification as well as its additional ones
- Return ErrUnexpectedStatus for non-200 responses and
ErrRateLimitExceeded for a repeated 429; close discarded bodies
- Stop fetchAll on a repeated next link and close each page's body once
read rather than deferring in the loop
- Default a zero Since to 24 hours ago
- Merge date repair and releaseIDs into api.go
- Filter --planning/--opportunities/--awards on each procedure's current
stage, using OCDS release tags; --opportunities previously matched a
nonexistent "opportunity" tag and returned nothing
- Reject conflicting filters before fetching (cobra flag group)
bwilliams