Compare commits
141 Commits
d90801cff5
...
v0.10.1
| Author | SHA1 | Date | |
|---|---|---|---|
| 114f7f5f85 | |||
| 328c7a5693 | |||
| fe176a2abc | |||
| ab9218b124 | |||
| 8d6ab0eb56 | |||
| 76cd399c76 | |||
| bf1746a756 | |||
| 28bdc04fba | |||
| b67fae886e | |||
| 71a2eae87b | |||
| bd34ec57f8 | |||
| 97215ddb9b | |||
| dd7881acfb | |||
| ece31567b8 | |||
| 7ffc3dc603 | |||
| 4bdba6f2b7 | |||
| b184ca7cbd | |||
| 62a12dd661 | |||
| ac8d618111 | |||
| 5ddd3ee19c | |||
| 8be9b020d4 | |||
| 7f5a9c0357 | |||
| 7d591487e4 | |||
| 1250247986 | |||
| 117c5336ba | |||
| c5ec4f83b2 | |||
| 39c097a710 | |||
| 993120a9f2 | |||
| c20e285d5f | |||
| acbe22dcad | |||
| cc97ae186c | |||
| 51c35f7c22 | |||
| f014a078ee | |||
| 8c19ad763b | |||
| 2dbba36bf0 | |||
| f302581722 | |||
| cf82633ab7 | |||
| 8d8cdbf3c5 | |||
| a206979307 | |||
| a6515c0e56 | |||
| 41df5058ba | |||
| e1bc174ea9 | |||
| 34c395d7e5 | |||
| 870b54a4a0 | |||
| 25782447eb | |||
| b96f40e5ca | |||
| 2c68d0a85f | |||
| a6d11c01e8 | |||
| 06b26d5e88 | |||
| 9a17a8de93 | |||
| 6064af2295 | |||
| a52a6ed22a | |||
| b0b703eab4 | |||
| e4e824ed41 | |||
| d5fcbfd20c | |||
| 2e0fb65a8b | |||
| 5e96790d85 | |||
| 35f4f82e94 | |||
| b605596bcb | |||
| 9303502b32 | |||
| f9eef80233 | |||
| c6f8570474 | |||
| 1130d807dc | |||
| ff2e664c62 | |||
| 2f3558cf33 | |||
| 154d31c3e8 | |||
| 6b1ff862f3 | |||
| 0c27fab384 | |||
| ad3b788f8c | |||
| 82acb8dc1a | |||
| 3aaddda676 | |||
| 7f989839cd | |||
| 27506168f8 | |||
| dc11e08e22 | |||
| fdddb5f08d | |||
| f78186b020 | |||
| 8dd604afb4 | |||
| 52bb17c8fa | |||
| 7952e4fb25 | |||
| 0281327365 | |||
| bf76eae301 | |||
| 0d47662cf9 | |||
| f4f009b904 | |||
| 3c1b753952 | |||
| bdbab48d10 | |||
| 16cc4b3f63 | |||
| 0ef861ed8f | |||
| 6ae7eb44cf | |||
| 8f6aa8aa8b | |||
| b8e889ad13 | |||
| 15ee4af1a1 | |||
| 4c606eb39f | |||
| 8d2ac163ae | |||
| 8709b5f4d8 | |||
| fd48ebecb8 | |||
| 021e5dd8b1 | |||
| 7adf5e1b08 | |||
| 455cc67d4c | |||
| dd3133ee2a | |||
| b3637cddd6 | |||
| 662db5e511 | |||
| 2ef91cf1b1 | |||
| 1d2f176977 | |||
| 2b3bcdd4f1 | |||
| a82f03feb8 | |||
| f1d4e38414 | |||
| 32060bd370 | |||
| 133f83f4ce | |||
| 42f0e16b02 | |||
| a2f0a2fc36 | |||
| 9f552cff6b | |||
| b913194fb4 | |||
| 3eccafad6b | |||
| a9d87bdbaa | |||
| 6f9255105d | |||
| c04e3c5599 | |||
| f15315f1b9 | |||
| 0ef6cd567e | |||
| b308ff4d6b | |||
| 5ecbc06c85 | |||
| 21e97f5d4e | |||
| 3900b3313b | |||
| 5d416cfc4a | |||
| 6532e8824a | |||
| d321492995 | |||
| b57110e5c8 | |||
| 482e83903c | |||
| 21a7748b2c | |||
| b36e198bfe | |||
| f9d6d42b1b | |||
| d9ab1e47ec | |||
| 4f755704d9 | |||
| a13f04fce5 | |||
| 1f5b347cd2 | |||
| 3639636813 | |||
| ca27d81163 | |||
| d74ba0f259 | |||
| 121f28fd29 | |||
| e3bcecc5c1 | |||
| 0884eb0ce5 | |||
| a27e870522 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,6 +1,5 @@
|
|||||||
# Compiled application binary and testing workspace
|
# Compiled application binary
|
||||||
/weatherreporter
|
/weatherreporter
|
||||||
/workspace
|
|
||||||
|
|
||||||
# ---> Go
|
# ---> Go
|
||||||
# If you prefer the allow list template instead of the deny list, see community template:
|
# If you prefer the allow list template instead of the deny list, see community template:
|
||||||
|
|||||||
@@ -2,8 +2,50 @@ when:
|
|||||||
- event: tag
|
- event: tag
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
|
- name: validate-release
|
||||||
|
image: golang:1.26.5
|
||||||
|
commands:
|
||||||
|
- |
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
version="$CI_COMMIT_TAG"
|
||||||
|
release_note="docs/releases/$version.md"
|
||||||
|
|
||||||
|
if ! printf '%s\n' "$version" |
|
||||||
|
grep -Eq '^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$'
|
||||||
|
then
|
||||||
|
printf '%s\n' "invalid release tag: $version" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
test -s "$release_note"
|
||||||
|
test -z "$(git ls-files go.work go.work.sum)"
|
||||||
|
test ! -e vendor
|
||||||
|
if grep -Eq '^[[:space:]]*replace([[:space:]]|\()' go.mod
|
||||||
|
then
|
||||||
|
printf '%s\n' 'go.mod contains a replacement' >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
GOWORK=off go test -count=1 ./...
|
||||||
|
GOWORK=off go test -race -count=1 ./...
|
||||||
|
GOWORK=off go vet ./...
|
||||||
|
GOWORK=off go build ./...
|
||||||
|
GOWORK=off go mod tidy -diff
|
||||||
|
|
||||||
|
unformatted=$(
|
||||||
|
git ls-files '*.go' |
|
||||||
|
while IFS= read -r go_file
|
||||||
|
do
|
||||||
|
gofmt -l "$go_file"
|
||||||
|
done
|
||||||
|
)
|
||||||
|
test -z "$unformatted"
|
||||||
|
git diff --check
|
||||||
|
|
||||||
- name: build-release-assets
|
- name: build-release-assets
|
||||||
image: golang:1.25
|
image: golang:1.26.5
|
||||||
|
depends_on:
|
||||||
|
- validate-release
|
||||||
commands:
|
commands:
|
||||||
- |
|
- |
|
||||||
set -eu
|
set -eu
|
||||||
@@ -33,8 +75,11 @@ steps:
|
|||||||
build_binary windows amd64 ".exe"
|
build_binary windows amd64 ".exe"
|
||||||
build_binary windows arm64 ".exe"
|
build_binary windows arm64 ".exe"
|
||||||
|
|
||||||
|
host_binary="$dist/weatherreporter-$version-$(go env GOOS)-$(go env GOARCH)"
|
||||||
|
test "$("$host_binary" --version)" = "weatherreporter $version"
|
||||||
|
|
||||||
- name: publish-release
|
- name: publish-release
|
||||||
image: woodpeckerci/plugin-release
|
image: woodpeckerci/plugin-release:0.3.1
|
||||||
depends_on:
|
depends_on:
|
||||||
- build-release-assets
|
- build-release-assets
|
||||||
settings:
|
settings:
|
||||||
@@ -42,6 +87,8 @@ steps:
|
|||||||
from_secret: GITEA_RELEASE_TOKEN
|
from_secret: GITEA_RELEASE_TOKEN
|
||||||
files:
|
files:
|
||||||
- dist/weatherreporter-*
|
- dist/weatherreporter-*
|
||||||
|
title: Weatherreporter ${CI_COMMIT_TAG}
|
||||||
|
note: docs/releases/${CI_COMMIT_TAG}.md
|
||||||
checksum: sha256
|
checksum: sha256
|
||||||
checksum-file: SHA256SUMS
|
checksum-file: SHA256SUMS
|
||||||
checksum-flatten: true
|
checksum-flatten: true
|
||||||
|
|||||||
@@ -1,4 +1 @@
|
|||||||
Please carefully review the documents in `docs/policy` before making any changes to this repository.
|
Please review `docs/development.md` for initial orientation in this repository and follow its task-specific reading guide.
|
||||||
- `architecture.md` provides the canonical high-level architecture policy for this repository.
|
|
||||||
- `development.md` provides more granular development policy for this repository.
|
|
||||||
- `documentation.md` provides the canonical documentation policy for this repository.
|
|
||||||
|
|||||||
21
README.md
21
README.md
@@ -1,22 +1,27 @@
|
|||||||
# weatherreporter
|
# weatherreporter
|
||||||
|
|
||||||
`weatherreporter` is a Go application for preparing human-facing weather
|
Weatherreporter is a Go CLI that turns normalized weather data into
|
||||||
reports from normalized forecast data. It builds JSON module snapshots, passes
|
human-facing Markdown reports.
|
||||||
YAML prompt data packages to `scriptorium`, and keeps inspectable artifacts
|
|
||||||
under a local workspace. It can also upload successfully generated managed
|
It produces a Markdown report at an operator-owned destination and can upload
|
||||||
Markdown reports to a configured `distributor` HTTP upload endpoint.
|
the completed output through Distributor.
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
weatherreporter generate today --out ./today.md
|
weatherreporter generate today
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Configure a Weather API endpoint first; see the
|
||||||
|
[configuration reference](docs/config.md). The report is written to
|
||||||
|
`today.md` in the current directory; use `--out` to choose another destination.
|
||||||
|
See the [CLI reference](docs/cli.md) and [operations guide](docs/operations.md)
|
||||||
|
for command and operating details.
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
- [CLI reference](docs/cli.md)
|
- [CLI reference](docs/cli.md)
|
||||||
- [Configuration reference](docs/config.md)
|
- [Configuration reference](docs/config.md)
|
||||||
- [Operations guide](docs/operations.md)
|
- [Operations guide](docs/operations.md)
|
||||||
- [Troubleshooting](docs/troubleshooting.md)
|
- [Development guide](docs/development.md)
|
||||||
- [Architecture policy](docs/policy/architecture.md)
|
- [Architecture policy](docs/policy/architecture.md)
|
||||||
- [Development policy](docs/policy/development.md)
|
|
||||||
|
|||||||
100
docs/adr/0001-stateless-execution.md
Normal file
100
docs/adr/0001-stateless-execution.md
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
# 0001: Make Weatherreporter Execution Stateless
|
||||||
|
|
||||||
|
Status: Accepted
|
||||||
|
|
||||||
|
Date: 2026-08-01
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Weather reports are ephemeral products. Forecasts and current conditions change
|
||||||
|
continuously, so the useful response to an old, failed, or superseded report is
|
||||||
|
normally a new generation rather than replaying or inspecting a prior run.
|
||||||
|
|
||||||
|
The existing run-addressed workspace retains module snapshots, prompt inputs,
|
||||||
|
execution receipts, generated text, rendered reports, metadata, and
|
||||||
|
notification receipts. That provenance store accumulates operational history
|
||||||
|
whose recovery and compatibility obligations are disproportionate to the value
|
||||||
|
of an ephemeral weather report. It also exists solely to support local Recent
|
||||||
|
Changes comparison for a rarely used report section.
|
||||||
|
|
||||||
|
The temporary roadmap that defined the feature scope and implementation plan
|
||||||
|
has been retired under the repository's documentation lifecycle. The
|
||||||
|
[architecture policy](../policy/architecture.md) defines the resulting system
|
||||||
|
invariants; this decision records their durable rationale.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Weatherreporter will operate as a stateless transformation pipeline:
|
||||||
|
|
||||||
|
```text
|
||||||
|
Weather API input
|
||||||
|
-> deterministic facts and modules
|
||||||
|
-> Promptkit data package and generated text
|
||||||
|
-> repository-owned Markdown rendering
|
||||||
|
-> operator-owned report output
|
||||||
|
-> optional Distributor upload
|
||||||
|
```
|
||||||
|
|
||||||
|
Ordinary invocations will retain intermediate values only for the active
|
||||||
|
process and will publish one operator-owned Markdown output atomically. A
|
||||||
|
failed or canceled generation must not truncate or partially replace an
|
||||||
|
existing selected output. Single-report Distributor notification follows
|
||||||
|
successful publication; batch notification follows successful publication of
|
||||||
|
every planned report.
|
||||||
|
|
||||||
|
Weatherreporter will remove local Recent Changes comparison instead of
|
||||||
|
retaining application state to support it. It will remove run-addressed
|
||||||
|
workspace artifacts, historical inspection, and backward-compatible workspace
|
||||||
|
decoding. RunIDs may remain active correlation and Distributor idempotency
|
||||||
|
values, but will not identify retained application history.
|
||||||
|
|
||||||
|
Explicit `--llm-debug-dir` capture remains the sole diagnostic-file exception.
|
||||||
|
The operator selects and manages that secure location; ordinary execution does
|
||||||
|
not create an implicit debug location or a general logging store, and debug
|
||||||
|
capture must continue to exclude credentials.
|
||||||
|
|
||||||
|
Any future forecast comparison must use a structured product supplied by the
|
||||||
|
Weather API rather than local Weatherreporter history. The proposed
|
||||||
|
[Upstream Forecast Change Product](../roadmap/future.md#upstream-forecast-change-product)
|
||||||
|
defines the required upstream direction. A future integration must not add a
|
||||||
|
local snapshot fallback.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
### Retain The Bounded Current-State Design
|
||||||
|
|
||||||
|
Retaining a managed workspace with current metadata, receipts, and snapshots
|
||||||
|
would preserve inspection and local comparison, but keeps an application-owned
|
||||||
|
history subsystem, artifact compatibility burden, and recovery surface that do
|
||||||
|
not match the report lifecycle.
|
||||||
|
|
||||||
|
### Time-Based Retention
|
||||||
|
|
||||||
|
Expiring workspace material after a fixed period reduces accumulation but still
|
||||||
|
requires retention policy, cleanup behavior, failure handling, and historical
|
||||||
|
format support. It does not remove the mismatch between retained provenance and
|
||||||
|
ephemeral report products.
|
||||||
|
|
||||||
|
### Bounded Run History
|
||||||
|
|
||||||
|
Keeping only a fixed number of prior runs limits storage volume but still makes
|
||||||
|
Weatherreporter responsible for run selection, comparison, inspection, and
|
||||||
|
state migration. It also creates arbitrary history gaps without establishing an
|
||||||
|
authoritative forecast baseline.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
The CLI, configuration, prompt-input, workspace, and inspection contracts will
|
||||||
|
change together. Legacy workspace material will not be migrated, decoded, or
|
||||||
|
automatically deleted; operators remain responsible for any desired cleanup.
|
||||||
|
|
||||||
|
Current action results will carry active identity, selected profile, safe
|
||||||
|
effective model information, output location, notification result, and safe
|
||||||
|
errors instead of historical artifact paths. Tests will protect atomic output,
|
||||||
|
batch and notification ordering, explicit secure debug capture, and the
|
||||||
|
absence of ordinary application-managed state.
|
||||||
|
|
||||||
|
This decision deliberately leaves the Weather API responsible for any future
|
||||||
|
forecast-history comparison. It avoids a cache, archive, retention engine,
|
||||||
|
manifest, resume mechanism, or replacement inspection surface in
|
||||||
|
Weatherreporter.
|
||||||
207
docs/cli.md
207
docs/cli.md
@@ -1,119 +1,138 @@
|
|||||||
# Weatherreporter CLI
|
# Weatherreporter CLI
|
||||||
|
|
||||||
`weatherreporter` generates Markdown weather reports, runs scheduled report
|
`weatherreporter` generates Markdown weather reports and runs report batches.
|
||||||
batches, and inspects stored artifacts.
|
It has no command for inspecting prior runs or application-owned state.
|
||||||
|
|
||||||
## Shortest Useful Command
|
## Shortest Useful Command
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
weatherreporter generate today --out ./today.md
|
weatherreporter generate today
|
||||||
```
|
```
|
||||||
|
|
||||||
This loads configuration, fetches weather data, writes managed workspace
|
The command uses the configured Weather API and writes an atomically replaced
|
||||||
artifacts, runs `scriptorium render` as a preflight check, runs structured
|
`today.md` in the current directory. See the [configuration reference](config.md)
|
||||||
`scriptorium run`, validates generated text, renders the embedded Today
|
to supply the required Weather API endpoint.
|
||||||
template, and writes an extra Markdown copy to `./today.md`. If distributor
|
|
||||||
notification is enabled in configuration, the command also uploads the managed
|
|
||||||
Markdown report after final metadata is saved.
|
|
||||||
|
|
||||||
## Commands
|
## Commands And Usage
|
||||||
|
|
||||||
```text
|
```text
|
||||||
weatherreporter --help
|
weatherreporter --help
|
||||||
weatherreporter generate daily --date YYYY-MM-DD [--config PATH] [--units VALUE] [--tz NAME] [--out PATH]
|
weatherreporter --version
|
||||||
weatherreporter generate today [--config PATH] [--units VALUE] [--tz NAME] [--out PATH] [--date YYYY-MM-DD]
|
weatherreporter generate daily --date YYYY-MM-DD [--config PATH] [--units VALUE] [--tz NAME] [--out PATH] [--llm-debug-dir PATH] [--quiet]
|
||||||
weatherreporter generate tomorrow [--config PATH] [--units VALUE] [--tz NAME] [--out PATH]
|
weatherreporter generate today [--config PATH] [--units VALUE] [--tz NAME] [--out PATH] [--date YYYY-MM-DD] [--llm-debug-dir PATH] [--quiet]
|
||||||
weatherreporter generate hourly [--config PATH] [--units VALUE] [--tz NAME] [--out PATH]
|
weatherreporter generate tomorrow [--config PATH] [--units VALUE] [--tz NAME] [--out PATH] [--llm-debug-dir PATH] [--quiet]
|
||||||
weatherreporter generate three-day [--config PATH] [--units VALUE] [--tz NAME] [--out PATH]
|
weatherreporter generate hourly [--config PATH] [--units VALUE] [--tz NAME] [--out PATH] [--llm-debug-dir PATH] [--quiet]
|
||||||
weatherreporter generate weekend [--config PATH] [--units VALUE] [--tz NAME] [--out PATH]
|
weatherreporter run morning [--config PATH] [--units VALUE] [--tz NAME] [--out-dir PATH] [--llm-debug-dir PATH] [--quiet]
|
||||||
weatherreporter generate storm [--config PATH] [--units VALUE] [--tz NAME] [--out PATH] --start TIME --end TIME
|
weatherreporter run evening [--config PATH] [--units VALUE] [--tz NAME] [--out-dir PATH] [--llm-debug-dir PATH] [--quiet]
|
||||||
weatherreporter run morning [--config PATH] [--units VALUE] [--tz NAME] [--out-dir PATH]
|
|
||||||
weatherreporter run evening [--config PATH] [--units VALUE] [--tz NAME] [--out-dir PATH]
|
|
||||||
weatherreporter inspect reports [--config PATH] [--limit N]
|
|
||||||
weatherreporter inspect metadata [--config PATH] RUN_ID
|
|
||||||
weatherreporter inspect modules [--config PATH] RUN_ID
|
|
||||||
weatherreporter inspect data-package [--config PATH] RUN_ID
|
|
||||||
weatherreporter inspect prior [--config PATH] RUN_ID
|
|
||||||
weatherreporter inspect sources [--config PATH] RUN_ID
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Implemented `generate` commands write a JSON module snapshot, YAML data package,
|
`weatherreporter --version` prints the version embedded in the executable.
|
||||||
preflight artifact, managed Markdown report, and metadata under the configured
|
Tagged release binaries report their semantic version tag; ordinary local
|
||||||
workspace. `--out` writes an extra Markdown copy for the operator; distributor
|
builds report `development`.
|
||||||
notification uses the managed report path, not the extra copy. `generate daily`,
|
|
||||||
`generate today`, `generate tomorrow`, and `generate hourly` write managed
|
|
||||||
generated-text artifacts, validate structured text from Scriptorium, and render
|
|
||||||
the managed Markdown report from embedded templates. `generate daily` requires
|
|
||||||
`--date YYYY-MM-DD` for the selected local civil day; omitting `--date` is a
|
|
||||||
command error and stops before weather data is fetched. `generate hourly`
|
|
||||||
covers the next six hours in the effective report timezone and does not accept
|
|
||||||
date or event window flags. `generate storm` requires explicit event-window
|
|
||||||
bounds with `--start` and `--end`.
|
|
||||||
|
|
||||||
`run morning` generates Today Report and the 3-Day Outlook, plus Weekend Outlook
|
| Command | Contract |
|
||||||
except on Sunday. `run evening` generates the Tomorrow Report. Batch
|
| --- | --- |
|
||||||
runs continue independent reports after a failure, print a JSON summary to
|
| `generate daily` | Requires `--date YYYY-MM-DD`; the date is interpreted in the effective report timezone. Its default filename is `daily-YYYY-MM-DD.md`. |
|
||||||
stdout, write compact status lines to stderr, and return nonzero when any report
|
| `generate today` | Accepts an optional `--date YYYY-MM-DD`; without it, the current local date in the effective report timezone is used. Its default filename is `today.md`. |
|
||||||
failed. `--out-dir` writes extra Markdown copies for the operator; distributor
|
| `generate tomorrow` | Uses the next local civil day and writes `tomorrow.md` by default. |
|
||||||
notification uses each managed report path, not the extra copies. When
|
| `generate hourly` | Covers the next six hours in the effective report timezone and writes `hourly.md` by default. It does not accept `--date`, `--hours`, or `--duration`. |
|
||||||
notification is enabled, batch summaries and status lines include notification
|
| `run morning` and `run evening` | Run their defined report batches and write each selected report beneath the current directory unless `--out-dir` selects another directory. `--out` is not accepted. |
|
||||||
status, accepted distributor run ID, or notification error fields for each
|
|
||||||
attempted report.
|
|
||||||
|
|
||||||
Hourly Report is explicit only; it is not included in `run morning` or `run
|
`generate` accepts the four report command names shown above. `run` accepts
|
||||||
evening`.
|
only `morning` and `evening`. Batch membership and notification ordering are
|
||||||
|
described in the [operations guide](operations.md).
|
||||||
|
|
||||||
`inspect` commands read existing workspace artifacts and emit JSON to stdout.
|
## Output, Errors, And Quiet Mode
|
||||||
They do not fetch weather data or invoke `scriptorium`.
|
|
||||||
|
|
||||||
## Flags
|
For `generate`, the default output is the report's filename in the current
|
||||||
|
directory. `--out PATH` selects one output file instead. A relative path is
|
||||||
|
resolved from the current directory; an absolute path is used as given. For a
|
||||||
|
batch, the equivalent default is the current directory and `--out-dir PATH`
|
||||||
|
selects its output directory. Successful summaries always report the resulting
|
||||||
|
absolute `outputPath` values.
|
||||||
|
|
||||||
- `-h`, `--help`: show help.
|
Outputs are written atomically. A generation, rendering, write, or cancellation
|
||||||
- `--config PATH`: load configuration from `PATH` instead of `/usr/local/etc/weatherreporter/config.yml`.
|
failure before publication leaves an existing destination unchanged. A
|
||||||
- `--units VALUE`: override configured Weather API units for `generate` and `run`.
|
notification failure occurs after publication, so the newly written output
|
||||||
- `--tz NAME`: override configured Weather API timezone for `generate` and `run`.
|
remains available.
|
||||||
- `--out PATH`: write an extra Markdown report copy where supported by the `generate` command.
|
|
||||||
- `--out-dir PATH`: write extra Markdown report copies for `run morning` and `run evening`.
|
|
||||||
- `--date YYYY-MM-DD`: required date for `generate daily`; optional date for `generate today`, defaulting to the current local date in the configured timezone.
|
|
||||||
- `--start TIME`: required start time for `generate storm`.
|
|
||||||
- `--end TIME`: required end time for `generate storm`.
|
|
||||||
- `--limit N`: maximum records for `inspect reports`; defaults to `20`, and `0` means no limit.
|
|
||||||
|
|
||||||
Storm times accept `YYYY-MM-DDTHH:MM` in the configured timezone or RFC3339
|
Action commands (`generate` and `run`) write a JSON summary to stdout unless
|
||||||
timestamps with explicit offsets.
|
`--quiet` is set. `run` also writes compact per-report and batch status lines
|
||||||
|
to stderr. A pre-run error, such as an invalid flag, missing required argument,
|
||||||
|
or configuration-load failure, produces no partial JSON summary. When an
|
||||||
|
action fails after it has produced a result, its summary has `"status": "failed"`
|
||||||
|
and an `error` field.
|
||||||
|
|
||||||
Distributor notification is configured only through `notify.distributor`; there
|
`--quiet` is supported by action commands only. It suppresses action summaries
|
||||||
are no distributor-specific CLI flags.
|
and routine batch status output; it does not suppress command errors.
|
||||||
|
|
||||||
## Common Workflows
|
### Generate Summary
|
||||||
|
|
||||||
|
A generate summary identifies the command, report, run, generation time, valid
|
||||||
|
period, prompt version, timezone, and status. Successful output has an absolute
|
||||||
|
`outputPath`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"command": "generate",
|
||||||
|
"reportId": "today",
|
||||||
|
"promptId": "weather.today_generated_text",
|
||||||
|
"promptVersion": "2.0.0",
|
||||||
|
"runId": "20260529T120000.000000000Z_today",
|
||||||
|
"status": "succeeded",
|
||||||
|
"timezone": "America/Chicago",
|
||||||
|
"outputPath": "/srv/weather/today.md"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
When available, the summary also includes the effective `profileId`,
|
||||||
|
`backendId`, `modelName`, `sourceWarnings`, `validationStatus`, requested
|
||||||
|
`llmDebugPath`, and compact Distributor `notification` result. It does not
|
||||||
|
include historical or transient artifact paths such as metadata, prompt input,
|
||||||
|
raw generated text, render context, or notification receipts.
|
||||||
|
|
||||||
|
### Run Summary And Stderr
|
||||||
|
|
||||||
|
A run summary contains `command`, `batch`, `status`, `startedAt`, `finishedAt`,
|
||||||
|
`total`, `succeeded`, `failed`, and a `reports` array. Each report item includes
|
||||||
|
its identity, status, effective profile and model details when available,
|
||||||
|
source warnings, validation status, and absolute `outputPath` after publication.
|
||||||
|
The top-level summary may also contain a batch `notification` object and
|
||||||
|
`error`. Batch status is `failed` if any report or the batch notification fails.
|
||||||
|
The `total`, `succeeded`, and `failed` counters describe report items only, so
|
||||||
|
a failed batch notification can leave `failed` at `0` while the top-level
|
||||||
|
notification and action status are `failed`.
|
||||||
|
|
||||||
|
Without `--quiet`, batch status lines use this form:
|
||||||
|
|
||||||
|
```text
|
||||||
|
report=today status=succeeded output="/srv/weather/reports/today.md"
|
||||||
|
batch=morning total=2 succeeded=2 failed=0
|
||||||
|
```
|
||||||
|
|
||||||
|
## Flag Reference
|
||||||
|
|
||||||
|
| Flag | Accepted by | Meaning |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `-h`, `--help` | top level | Show help. |
|
||||||
|
| `--config PATH` | all commands | Load `PATH` instead of `/usr/local/etc/weatherreporter/config.yml`. |
|
||||||
|
| `--units VALUE` | `generate`, `run` | Override `weather_api.units` for this command. |
|
||||||
|
| `--tz NAME` | `generate`, `run` | Override `weather_api.timezone` for this command. |
|
||||||
|
| `--out PATH` | every `generate` command | Write the report to this file instead of its current-directory default. |
|
||||||
|
| `--llm-debug-dir PATH` | every `generate` and `run` command | Write requested sensitive prompt diagnostics under this absolute path. |
|
||||||
|
| `--out-dir PATH` | `run morning`, `run evening` | Write batch reports beneath this directory instead of the current directory. |
|
||||||
|
| `--quiet` | `generate`, `run` | Suppress action summaries and routine batch status output. |
|
||||||
|
| `--date YYYY-MM-DD` | `generate daily`, `generate today` | Required for Daily; optional for Today. |
|
||||||
|
|
||||||
|
Distributor notification is configured through `notify.distributor`; there are
|
||||||
|
no Distributor-specific CLI flags. See the [configuration reference](config.md).
|
||||||
|
|
||||||
|
## Invocation Examples
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
weatherreporter generate today --out ./today.md
|
weatherreporter generate daily --date 2026-05-29
|
||||||
weatherreporter generate daily --date 2026-05-29 --out ./daily.md
|
weatherreporter generate today --out ./reports/today.md
|
||||||
weatherreporter generate tomorrow --out ./tomorrow.md
|
weatherreporter generate hourly --out /srv/weather/hourly.md
|
||||||
weatherreporter generate hourly
|
weatherreporter generate today --llm-debug-dir /var/tmp/weatherreporter-debug
|
||||||
weatherreporter generate three-day --out ./three-day.md
|
weatherreporter run morning --out-dir ./reports --llm-debug-dir /var/tmp/weatherreporter-debug
|
||||||
weatherreporter generate weekend --out ./weekend.md
|
|
||||||
weatherreporter generate storm --start 2026-05-29T18:00 --end 2026-05-30T06:00 --out ./storm.md
|
|
||||||
weatherreporter run morning --out-dir ./reports
|
|
||||||
weatherreporter run evening --out-dir ./reports
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Inspection
|
|
||||||
|
|
||||||
```sh
|
|
||||||
weatherreporter inspect reports --limit 10
|
|
||||||
weatherreporter inspect metadata 20260529T100000.000000000Z_today
|
|
||||||
weatherreporter inspect modules 20260529T100000.000000000Z_today
|
|
||||||
weatherreporter inspect data-package 20260529T100000.000000000Z_today
|
|
||||||
weatherreporter inspect prior 20260529T100000.000000000Z_today
|
|
||||||
weatherreporter inspect sources 20260529T100000.000000000Z_today
|
|
||||||
weatherreporter inspect metadata 20260529T100000.000000000Z_daily
|
|
||||||
```
|
|
||||||
|
|
||||||
`inspect reports` lists recent generated runs with artifact paths and source
|
|
||||||
warning counts. The other inspect commands require a RunID. `inspect modules`
|
|
||||||
returns the persisted ordered module snapshot for a run. `inspect prior`
|
|
||||||
returns the prior comparable snapshot metadata selected from stored metadata, or
|
|
||||||
`null` when none exists. `inspect sources` shows source provenance and source
|
|
||||||
warnings without dumping full weather payloads.
|
|
||||||
|
|||||||
360
docs/config.md
360
docs/config.md
@@ -1,276 +1,208 @@
|
|||||||
# Weatherreporter Configuration
|
# Weatherreporter Configuration
|
||||||
|
|
||||||
Configuration is YAML. By default, `weatherreporter` reads:
|
Weatherreporter reads YAML configuration. The default path is:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
/usr/local/etc/weatherreporter/config.yml
|
/usr/local/etc/weatherreporter/config.yml
|
||||||
```
|
```
|
||||||
|
|
||||||
Use `--config PATH` to load a different file. If the default file is absent,
|
If the default file is absent, Weatherreporter uses built-in defaults. An
|
||||||
built-in defaults are used. If `--config PATH` points to a missing file, loading
|
explicit `--config PATH` must exist. Values are applied in this order:
|
||||||
fails.
|
|
||||||
|
|
||||||
Precedence is:
|
1. built-in defaults;
|
||||||
|
2. the configuration file, when present; and
|
||||||
|
3. the `--units` and `--tz` command-line overrides.
|
||||||
|
|
||||||
1. CLI flags
|
Environment variables do not override configuration fields. Output flags select
|
||||||
2. configuration file
|
operator-owned destinations for one command and do not change configuration.
|
||||||
3. built-in defaults
|
|
||||||
|
|
||||||
The CLI configuration overrides are `--units` and `--tz`. Output flags control
|
## Maintained Examples
|
||||||
report copies for the current command but do not change configuration files.
|
|
||||||
Environment variables do not override configuration fields.
|
|
||||||
|
|
||||||
## Minimal Config
|
- [minimal-config.yml](../examples/minimal-config.yml) is the smallest useful
|
||||||
|
collection and generation configuration.
|
||||||
|
- [config.yml](../examples/config.yml) is a representative production-oriented
|
||||||
|
configuration using synthetic endpoints and no credentials.
|
||||||
|
- [weather-light-local-profile.yml](../examples/weather-light-local-profile.yml)
|
||||||
|
is a complete endpoint-only override for the embedded `weather-light`
|
||||||
|
profile.
|
||||||
|
|
||||||
See [examples/minimal-config.yml](../examples/minimal-config.yml).
|
The configuration examples are loaded by the configuration test suite. The
|
||||||
|
profile example is inspected through the Promptkit adapter test suite.
|
||||||
|
|
||||||
|
## Minimal Configuration
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
weather_api:
|
weather_api:
|
||||||
base_url: https://weather.api.example.com/
|
base_url: https://weather.api.example.com/
|
||||||
```
|
```
|
||||||
|
|
||||||
`weather_api.base_url` is required for commands that fetch weather data. Other
|
`weather_api.base_url` is required for workflows that collect weather data.
|
||||||
fields fall back to defaults.
|
All omitted fields use their built-in defaults.
|
||||||
|
|
||||||
## Production-Oriented Config
|
|
||||||
|
|
||||||
See [examples/config.yml](../examples/config.yml). The example is loaded by the
|
|
||||||
config test suite.
|
|
||||||
|
|
||||||
## Field Reference
|
## Field Reference
|
||||||
|
|
||||||
### `weather_api`
|
### `weather_api`
|
||||||
|
|
||||||
- `base_url`: absolute base URL for the Weather API. Required for generation and fetch workflows.
|
| Field | Default | Rules |
|
||||||
- `timeout`: HTTP timeout duration. Default: `10s`.
|
| --- | --- | --- |
|
||||||
- `precision`: numeric precision query value. Default: `1`.
|
| `base_url` | empty | Absolute Weather API URL. Required for collection and generation. |
|
||||||
- `units`: Weather API units query value. Default: `us`.
|
| `timeout` | `10s` | Must be greater than zero. |
|
||||||
- `timezone`: report timezone and Weather API timezone query value where supported. Default: `America/Chicago`.
|
| `precision` | `0` | Must be zero or greater. Sent as the Weather API precision query value. |
|
||||||
- `format`: Weather API response format. Must be `json`. Default: `json`.
|
| `units` | `us` | Required Weather API units query value; `--units` overrides it for one command. |
|
||||||
|
| `timezone` | `America/Chicago` | Required report and Weather API timezone; `--tz` overrides it for one command. |
|
||||||
|
| `format` | `json` | Required and must be `json`. |
|
||||||
|
|
||||||
Timezone values may be IANA names, configured aliases such as `Chicago` and
|
Timezone values may be IANA names, configured aliases such as `Chicago` and
|
||||||
`Stl`, US timezone abbreviations, or UTC offsets such as `-5` and `+09:30`.
|
`Stl`, US timezone abbreviations, or UTC offsets such as `-5` and `+09:30`.
|
||||||
|
|
||||||
### `location`
|
### `location`
|
||||||
|
|
||||||
`location` is descriptive prompt context included in module metadata and
|
`location` supplies descriptive prompt context; it does not choose a Weather
|
||||||
Scriptorium data packages. It does not select a Weather API endpoint or enable
|
API endpoint or configure multiple forecast locations.
|
||||||
multiple configured forecast locations.
|
|
||||||
|
|
||||||
- `id`: short local identifier. Default: `home`.
|
| Field | Default |
|
||||||
- `name`: human-readable location name. Default: `Brentwood`.
|
| --- | --- |
|
||||||
- `region`: broader forecast area context. Default: `St. Louis Metro`.
|
| `id` | `home` |
|
||||||
|
| `name` | `Brentwood` |
|
||||||
|
| `region` | `St. Louis Metro` |
|
||||||
|
|
||||||
The prompt-facing location object also includes `timezone`, derived from the
|
The prompt-facing location timezone is derived from the effective
|
||||||
effective `weather_api.timezone` after CLI overrides such as `--tz`.
|
`weather_api.timezone` after command-line overrides.
|
||||||
|
|
||||||
### `secrets`
|
### `secrets`
|
||||||
|
|
||||||
- `directory`: optional directory of file-backed environment secrets. Default:
|
`secrets.directory` defaults to empty, which disables secret loading. When it
|
||||||
empty, which disables secret loading.
|
is set, every regular file directly in that directory is loaded after the file
|
||||||
|
and command-line overrides. A file basename must match
|
||||||
|
`[A-Za-z_][A-Za-z0-9_]*`; it becomes an environment variable name, and the
|
||||||
|
file contents replace any existing value. One trailing LF or CRLF is removed.
|
||||||
|
|
||||||
When configured, each regular file directly under `secrets.directory` is loaded
|
Missing directories, unreadable files, subdirectories, symlinks, non-regular
|
||||||
after config file parsing and CLI overrides. The file basename must be a valid
|
files, and invalid names fail configuration loading. Put only secret values in
|
||||||
environment variable name matching `[A-Za-z_][A-Za-z0-9_]*`; the file contents
|
this directory, never in the YAML file.
|
||||||
become the environment variable value and overwrite any existing value. One
|
|
||||||
trailing LF or CRLF is stripped. Subdirectories, symlinks, invalid filenames,
|
|
||||||
missing directories, and unreadable files fail config loading.
|
|
||||||
|
|
||||||
### `notify`
|
### `notify.distributor`
|
||||||
|
|
||||||
`notify.distributor` controls distributor notification after successful report
|
Distributor notification is disabled by default. Its fields are:
|
||||||
generation. It is disabled by default and does not add CLI flags. When enabled,
|
|
||||||
weatherreporter uploads one distributor bundle per generated report after
|
|
||||||
report rendering succeeds and final metadata is saved.
|
|
||||||
|
|
||||||
- `enabled`: whether distributor notification config is active. Default:
|
| Field | Default | Rules when notification is enabled |
|
||||||
`false`.
|
| --- | --- | --- |
|
||||||
- `endpoint`: absolute distributor endpoint URL. Required when enabled.
|
| `enabled` | `false` | Activates Distributor notification validation. |
|
||||||
Default: `https://distributor.example.com`.
|
| `endpoint` | `https://distributor.example.com` | Must be an absolute URL. |
|
||||||
- `token_env`: environment variable name that will contain the distributor
|
| `token_env` | `DISTRIBUTOR_UPLOAD_TOKEN` | Must name a valid environment variable. |
|
||||||
upload token. Required when enabled. Default: `DISTRIBUTOR_UPLOAD_TOKEN`.
|
| `timeout` | `30s` | Must be greater than zero. |
|
||||||
- `timeout`: distributor operation timeout. Must be greater than zero when
|
| `failure_policy` | `error` | Must be `error`. |
|
||||||
enabled. Default: `30s`.
|
| `pipeline_id_template` | empty | Required single-report pipeline ID template. |
|
||||||
- `failure_policy`: must be `error` when enabled. Default: `error`.
|
| `bundle_id_template` | `weatherreporter.{location_id}.{report_id}` | Required single-report bundle ID template. |
|
||||||
- `pipeline_id_template`: template for the distributor pipeline ID. Required
|
| `idempotency_key_template` | `{bundle_id}.{run_id}` | Required single-report idempotency-key template. |
|
||||||
when enabled. Default: empty.
|
| `batch.enabled` | `true` | Activates batch notification validation when Distributor notification is enabled. |
|
||||||
- `bundle_id_template`: template for distributor bundle IDs. Default:
|
| `batch.pipeline_id_template` | `weatherreporter` | Required when batch notification is enabled. |
|
||||||
`weatherreporter.{location_id}.{report_id}`.
|
| `batch.bundle_id_template` | `weatherreporter.{location_id}.{batch}` | Required when batch notification is enabled. |
|
||||||
- `idempotency_key_template`: template for distributor idempotency keys.
|
| `batch.idempotency_key_template` | `{bundle_id}.{batch_run_id}` | Required when batch notification is enabled. |
|
||||||
Default: `{bundle_id}.{run_id}`.
|
|
||||||
- `report_path_templates`: ordered list of templates for Markdown report paths
|
|
||||||
inside the distributor bundle. Each rendered path maps to the same managed
|
|
||||||
Markdown report source. Default:
|
|
||||||
```yaml
|
|
||||||
- "{valid_start_date}/{artifact_group}/{valid_start_date}-{artifact_group}-{run_id}.md"
|
|
||||||
```
|
|
||||||
|
|
||||||
Supported template variables are `location_id`, `report_id`, `run_id`,
|
The upload token is read from the environment variable named by `token_env`.
|
||||||
|
Use `secrets.directory` when a file-backed secret is appropriate.
|
||||||
|
|
||||||
|
Single-report bundle templates accept `location_id`, `report_id`, `run_id`,
|
||||||
`artifact_group`, `batch_output_name`, `valid_start_date`, `valid_end_date`,
|
`artifact_group`, `batch_output_name`, `valid_start_date`, `valid_end_date`,
|
||||||
`valid_start_time`, `valid_end_time`, `valid_start_stamp`, and
|
`valid_start_time`, `valid_end_time`, `valid_start_stamp`, `valid_end_stamp`,
|
||||||
`valid_end_stamp`. Date values use `YYYY-MM-DD`, time values use `HHMM`, and
|
Pipeline and idempotency-key templates may also use `bundle_id`. Dates use
|
||||||
stamp values use `YYYY-MM-DDTHHMM` in the effective report timezone.
|
`YYYY-MM-DD`; times use `HHMM`; and stamps use `YYYY-MM-DDTHHMM` in the
|
||||||
`pipeline_id_template` and `idempotency_key_template` may also use `bundle_id`.
|
effective report timezone.
|
||||||
|
|
||||||
The rendered pipeline ID selects the configured distributor `http_upload`
|
Batch bundle and pipeline templates accept `location_id`, `batch`,
|
||||||
workflow. The rendered bundle ID is the stable logical source identity for the
|
`batch_run_id`, and `batch_started_date`; batch idempotency-key templates may
|
||||||
report stream. The rendered idempotency key is the per-run retry identity.
|
also use `bundle_id`. `batch_started_date` is the batch start date in the
|
||||||
|
effective report timezone.
|
||||||
|
|
||||||
Rendered report paths must be unique relative paths with `/` separators. They
|
`reports.<report>.distributor.path_templates` overrides the default ordered
|
||||||
must not contain backslashes, empty path segments, `.`, `..`, `manifest.json`,
|
Distributor paths for that report. Each rendered path must be a unique relative
|
||||||
or `.distributor.json`.
|
path with `/` separators. Backslashes, empty segments, `.` and `..` segments,
|
||||||
|
`manifest.json`, and the reserved Distributor sidecar basename are rejected.
|
||||||
|
The default paths are:
|
||||||
|
|
||||||
The upload token is read from the environment variable named by `token_env`
|
| Report | Paths |
|
||||||
after config loading and `secrets.directory` processing. Config files should
|
| --- | --- |
|
||||||
name the variable only; they should not contain the token value.
|
| `hourly` | `hourly/index.md` |
|
||||||
|
| `daily` | `daily/{valid_start_date}/{run_id}.md`, `daily/{valid_start_date}/index.md` |
|
||||||
|
| `today` | `daily/{valid_start_date}/{run_id}.md`, `daily/{valid_start_date}/index.md`, `today/index.md` |
|
||||||
|
| `tomorrow` | `daily/{valid_start_date}/{run_id}.md`, `daily/{valid_start_date}/index.md`, `tomorrow/index.md` |
|
||||||
|
|
||||||
|
See the [operations guide](operations.md) for notification timing, uploaded
|
||||||
|
output selection, and failure handling.
|
||||||
|
|
||||||
### `missing_source`
|
### `missing_source`
|
||||||
|
|
||||||
- `default`: missing-source behavior for optional sources. One of `error`, `warn`, or `none`. Default: `warn`.
|
`missing_source.default` defaults to `warn` and accepts `error`, `warn`, or
|
||||||
- `sources`: optional map of source-specific overrides, using the same policy values.
|
`none`. `missing_source.sources` optionally overrides that policy by source.
|
||||||
|
Hourly forecast data is required for generated reports. Supported optional
|
||||||
|
source keys are `observations`, `current`, `narrative`, `alerts`, `discussion`,
|
||||||
|
`weather_story`, and `spc_convective_outlooks`.
|
||||||
|
|
||||||
Hourly forecast data is required for generated reports. Optional sources use
|
### `promptkit`
|
||||||
the missing-source policy. Source override keys include `observations`,
|
|
||||||
`current`, `narrative`, `alerts`, `discussion`, `weather_story`, and
|
|
||||||
`spc_convective_outlooks`.
|
|
||||||
|
|
||||||
### `scriptorium`
|
Promptkit configuration selects the executor and prompt/profile checks for
|
||||||
|
every `generate` and `run` command. A top-level `scriptorium:` configuration
|
||||||
|
key is rejected with a migration error; it is not translated or ignored.
|
||||||
|
|
||||||
- `binary`: `scriptorium` executable name or path. Default: `scriptorium`.
|
Prompt debug capture has no YAML setting. Use `--llm-debug-dir PATH` on an
|
||||||
- `config_path`: optional Scriptorium config path passed to the adapter.
|
individual `generate` or `run` command when explicitly needed.
|
||||||
- `profile`: optional Scriptorium profile passed to the adapter.
|
|
||||||
- `timeout`: subprocess timeout. Default: `2m`.
|
|
||||||
- `extra_args`: optional additional arguments passed to Scriptorium commands.
|
|
||||||
|
|
||||||
### `workspace`
|
| Field | Default | Rules |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `profile` | empty | Optional global profile selection for every report in one command. When empty, each exact prompt version selects its declared default. |
|
||||||
|
| `profile_file` | empty | Optional external Promptkit profile file. It cannot be combined with `profile_dir`. A same-ID profile completely replaces Weatherreporter's embedded definition. |
|
||||||
|
| `profile_dir` | empty | Optional external Promptkit profile directory. It cannot be combined with `profile_file`. A same-ID profile completely replaces Weatherreporter's embedded definition. |
|
||||||
|
| `timeout` | `2m` | Must be greater than zero. |
|
||||||
|
| `local.endpoint` | empty | Optional absolute URL for the conventional local backend. A blank endpoint leaves it unregistered. |
|
||||||
|
| `local.concurrency_limit` | `1` | Maximum local backend concurrency. `0` is unlimited; negative values are invalid. |
|
||||||
|
|
||||||
- `root`: workspace root for managed artifacts. Default: `workspace`.
|
`profile` selects an ID; `profile_file` and `profile_dir` supply definitions.
|
||||||
- `snapshots_dir`: module snapshot and metadata directory under `workspace.root`. Default: `snapshots`.
|
They are separate decisions. An explicit `profile` applies to every selected
|
||||||
- `reports_dir`: managed Markdown report directory under `workspace.root`. Default: `reports`.
|
report. Otherwise Hourly selects `weather-light`, while Daily, Today, and
|
||||||
- `data_packages_dir`: prompt input package directory under `workspace.root`. Default: `data-packages`.
|
Tomorrow select `weather-balanced` through their exact `2.0.0` prompt
|
||||||
- `preflight_dir`: Scriptorium render output directory under `workspace.root`. Default: `preflight`.
|
definitions.
|
||||||
- `notifications_dir`: distributor notification debug artifact directory under `workspace.root`. Default: `notifications`.
|
|
||||||
|
|
||||||
Workspace subdirectories must be relative paths that stay inside
|
Promptkit resolves a selected profile definition from a test or embedding
|
||||||
`workspace.root`.
|
consumer's explicit in-memory profile, then the configured `profile_file` or
|
||||||
|
`profile_dir`, then Weatherreporter's embedded catalog, and finally Promptkit's
|
||||||
|
built-in catalog. Sources provide complete definitions; fields are never
|
||||||
|
merged. A matching malformed external profile fails rather than using the
|
||||||
|
embedded definition. The [Promptkit integration guide](integrations/promptkit.md)
|
||||||
|
owns the catalog and precedence details.
|
||||||
|
|
||||||
|
To replace the default Hourly definition with a local OpenAI-compatible
|
||||||
|
endpoint, set `profile_file` to a copy of
|
||||||
|
[weather-light-local-profile.yml](../examples/weather-light-local-profile.yml).
|
||||||
|
The example has no credential and should be edited for the local endpoint and
|
||||||
|
model before use. An alternative profile may use `backend: local`; in that
|
||||||
|
case `promptkit.local.endpoint` supplies the conventional local backend
|
||||||
|
endpoint.
|
||||||
|
|
||||||
### `dayparts`
|
### `dayparts`
|
||||||
|
|
||||||
`dayparts` is a list of named local-time windows used by forecast derivation.
|
`dayparts` is a non-empty list of named local-time windows used in forecast
|
||||||
Each entry has:
|
derivation. Every item needs `name`, `start`, and `end`; start and end use
|
||||||
|
`HH:MM`. Defaults are `overnight` (`00:00`–`06:00`), `morning`
|
||||||
- `name`
|
(`06:00`–`10:00`), `midday` (`10:00`–`15:00`), `afternoon`
|
||||||
- `start`
|
(`15:00`–`17:00`), and `evening` (`17:00`–`24:00`).
|
||||||
- `end`
|
|
||||||
|
|
||||||
`start` and `end` use `HH:MM`. The default entries are overnight, morning,
|
|
||||||
midday, afternoon, and evening.
|
|
||||||
|
|
||||||
### `recent_change`
|
|
||||||
|
|
||||||
- `temperature_degrees`: temperature change threshold. Default: `5`.
|
|
||||||
- `precip_probability_points`: precipitation probability threshold. Default: `20`.
|
|
||||||
- `wind_gust_miles_per_hour`: wind gust change threshold. Default: `10`.
|
|
||||||
- `precip_timing_shift_minutes`: precipitation timing shift threshold. Default: `120`.
|
|
||||||
|
|
||||||
Recent Changes are added to prompt input when a prior comparable module
|
|
||||||
snapshot exists and a threshold is crossed.
|
|
||||||
|
|
||||||
### `reports`
|
### `reports`
|
||||||
|
|
||||||
`reports` optionally overrides the ordered deterministic modules declared by
|
`reports` optionally overrides a report's ordered deterministic modules and
|
||||||
report definitions. Omit a report entry to use its default module order.
|
Distributor path templates. Omit a report entry to retain its defaults.
|
||||||
|
|
||||||
Supported report keys are `daily`, `today`, `tomorrow`, `hourly`,
|
Supported report keys are `daily`, `today`, `tomorrow`, and `hourly`; hyphens
|
||||||
`three_day`, `weekend`, and `storm`. Canonical report IDs and accepted aliases
|
and underscores are equivalent.
|
||||||
are also valid, including `three_day_outlook`, `weekend_outlook`, and
|
|
||||||
`storm_report`. Hyphens and underscores are treated equivalently in report
|
|
||||||
keys. Retired report keys are not supported.
|
|
||||||
|
|
||||||
`reports.today` applies only to the Today Report. `reports.daily` applies only
|
Each report entry can contain:
|
||||||
to the dated Daily Report.
|
|
||||||
|
|
||||||
Each report entry supports:
|
- `deterministic_modules`: an ordered list of module IDs, or objects with `id`
|
||||||
|
and optional `options`.
|
||||||
|
- `distributor.path_templates`: an optional, non-empty ordered list of
|
||||||
|
Distributor paths for that report.
|
||||||
|
|
||||||
- `deterministic_modules`: ordered module list. Entries may be string module
|
Unknown reports and modules, duplicate modules, incompatible report-module
|
||||||
IDs or objects with `id` and optional `options`.
|
combinations, duplicate stanza names, invalid path templates, and invalid
|
||||||
|
module options fail configuration loading. The accepted module IDs and module
|
||||||
Example:
|
option contracts are documented in the [module contract internals](internal/module.md).
|
||||||
|
|
||||||
```yaml
|
|
||||||
reports:
|
|
||||||
daily:
|
|
||||||
deterministic_modules:
|
|
||||||
- metadata
|
|
||||||
- current_conditions
|
|
||||||
- narrative_forecast
|
|
||||||
- alert_digest
|
|
||||||
- spc_convective_outlooks
|
|
||||||
- id: area_forecast_discussion
|
|
||||||
options:
|
|
||||||
sections:
|
|
||||||
- short_term
|
|
||||||
- spc_convective_discussion
|
|
||||||
- daily_planning
|
|
||||||
- hourly_forecast
|
|
||||||
today:
|
|
||||||
deterministic_modules:
|
|
||||||
- metadata
|
|
||||||
- current_conditions
|
|
||||||
- narrative_forecast
|
|
||||||
- derived_daily_summary
|
|
||||||
- derived_daypart_summaries
|
|
||||||
- precip_timing
|
|
||||||
- alert_digest
|
|
||||||
- spc_convective_outlooks
|
|
||||||
- area_forecast_discussion
|
|
||||||
- spc_convective_discussion
|
|
||||||
- weather_story
|
|
||||||
- outdoor_windows
|
|
||||||
- hourly_forecast
|
|
||||||
- today_planning
|
|
||||||
hourly:
|
|
||||||
deterministic_modules:
|
|
||||||
- metadata
|
|
||||||
- current_conditions
|
|
||||||
- hourly_forecast
|
|
||||||
- precip_timing
|
|
||||||
- alert_digest
|
|
||||||
- spc_convective_outlooks
|
|
||||||
- id: area_forecast_discussion
|
|
||||||
options:
|
|
||||||
sections:
|
|
||||||
- key_messages
|
|
||||||
- short_term
|
|
||||||
- spc_convective_discussion
|
|
||||||
- weather_story
|
|
||||||
```
|
|
||||||
|
|
||||||
Unknown reports, unknown modules, duplicate modules, incompatible report/module
|
|
||||||
combinations, duplicate stanza names, and invalid options fail config loading.
|
|
||||||
`area_forecast_discussion.options.sections` may contain `product`,
|
|
||||||
`key_messages`, `short_term`, and `long_term`. Empty or omitted `sections`
|
|
||||||
includes all available AFD sections.
|
|
||||||
|
|
||||||
The module registry accepts all module IDs documented in
|
|
||||||
[Module Contract Internals](internal/module.md). Unknown or unimplemented
|
|
||||||
module IDs fail validation instead of being skipped.
|
|
||||||
|
|
||||||
## Secrets
|
|
||||||
|
|
||||||
Configuration files should not contain raw secrets. Use `secrets.directory` to
|
|
||||||
load secret values from files into environment variables for integrations that
|
|
||||||
read credentials from the environment. Secret file names become environment
|
|
||||||
variable names, and secret file contents become values. For distributor
|
|
||||||
notification, this allows a file such as
|
|
||||||
`<secrets.directory>/DISTRIBUTOR_UPLOAD_TOKEN` to supply the token referenced by
|
|
||||||
`notify.distributor.token_env`.
|
|
||||||
|
|
||||||
## Maintained Examples
|
|
||||||
|
|
||||||
- [examples/minimal-config.yml](../examples/minimal-config.yml): smallest
|
|
||||||
useful config for generation and fetching.
|
|
||||||
- [examples/config.yml](../examples/config.yml): production-oriented config
|
|
||||||
covering maintained fields.
|
|
||||||
|
|
||||||
Both example files are loaded by the config test suite.
|
|
||||||
|
|||||||
86
docs/development.md
Normal file
86
docs/development.md
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
# Development
|
||||||
|
|
||||||
|
This is the first-read guide for people and coding agents working on
|
||||||
|
Weatherreporter. It provides a concise repository orientation and routes each
|
||||||
|
kind of change to its canonical documentation.
|
||||||
|
|
||||||
|
Weatherreporter is a Go CLI that collects normalized weather data, derives
|
||||||
|
deterministic report facts and module snapshots, executes Promptkit for
|
||||||
|
single-report generated text, renders Markdown reports, and can upload completed
|
||||||
|
operator-owned outputs through Distributor. Start with the [README](../README.md) for product
|
||||||
|
context and the [architecture policy](policy/architecture.md) for system
|
||||||
|
boundaries and invariants.
|
||||||
|
|
||||||
|
## What To Read
|
||||||
|
|
||||||
|
| When working on | Read | Why |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Product behavior or the shortest useful workflow | [README](../README.md), [CLI reference](cli.md), and [operations guide](operations.md) | These own product orientation, invocation, and normal operation. |
|
||||||
|
| Application shape, package boundaries, dependency direction, safety properties, or architectural invariants | [Architecture policy](policy/architecture.md) and relevant ADRs under `docs/adr/`, when present | Architecture defines the intended system; ADRs preserve significant decision rationale. |
|
||||||
|
| Any documentation addition, revision, move, or removal | [Documentation policy](policy/documentation.md) | It defines canonical owners, audience boundaries, current-state rules, and document lifecycle. |
|
||||||
|
| Adding, changing, reviewing, or deleting tests | [Testing policy](policy/testing.md) and focused package tests | The policy defines risk-based sufficiency, durable test boundaries, doubles, and test-maintenance criteria. |
|
||||||
|
| CLI commands, flags, output, quiet mode, or command wiring | [CLI reference](cli.md) and [CLI internals](internal/cli.md) | The reference owns the user contract; the internal guide owns command composition and output flow. |
|
||||||
|
| Configuration fields, defaults, loading, overrides, validation, or secrets | [Configuration reference](config.md), [architecture policy](policy/architecture.md), and tests under `internal/config` | These separate the user-visible contract, architectural rules, and executable behavior. |
|
||||||
|
| Top-level generation, batch, collection, output publication, or notification workflow | [App orchestration internals](internal/app-orchestration.md) | It owns workflow ordering, output publication, failure propagation, and orchestration invariants. |
|
||||||
|
| Weather API transport, source envelopes, source warnings, or collection | [Weather API integration](integrations/weatherapi.md), [weather-data internals](internal/weather-data.md), and [collection internals](internal/collect.md) | These separate the external contract, normalized source facts, and app-facing collection behavior. |
|
||||||
|
| Forecast periods, weather derivation, collected facts, or derived facts | [Forecast derivation internals](internal/forecast-derivation.md) and [fact contracts](internal/facts.md) | They own deterministic derivation and the fact boundaries used by reports. |
|
||||||
|
| Report definitions, valid periods, report IDs, output naming, or batch composition | [Report registry internals](internal/report-registry.md) and [app orchestration internals](internal/app-orchestration.md) | Report definitions own selection and period rules; orchestration owns execution. |
|
||||||
|
| Module IDs, module composition, briefing values, or prompt-facing exports | [Module contract internals](internal/module.md), [module builder internals](internal/briefing.md), and [prompt-input internals](internal/prompt-input.md) | These own module contracts, value construction, and the curated prompt-package boundary. |
|
||||||
|
| Prompt execution, profiles, prompt inputs, or result handling | `internal/promptexec`, the Promptkit adapter, and [prompt-input internals](internal/prompt-input.md) | These separate the executor contract and input construction. |
|
||||||
|
| Generated-text schemas, validation, render contexts, templates, or Markdown rendering | [Generated-text internals](internal/generatedtext.md), [report-template internals](internal/reporttemplate.md), and [report template guide](templates.md) | These own structured text, renderer implementation, and the maintainer-facing template surface. |
|
||||||
|
| Output destinations, atomic publication, prompt diagnosis, or legacy cleanup | [Operations guide](operations.md) and [App orchestration internals](internal/app-orchestration.md) | Operations owns operator workflows; app internals owns the implementation boundary. |
|
||||||
|
| Distributor bundles, uploads, notification results, or failures | [Distributor adapter internals](internal/distributor-adapter.md), [Distributor integration contracts](integrations/distributor/), and [operations guide](operations.md) | These separate adapter behavior, external contracts, and operational lifecycle. |
|
||||||
|
| Maintained example configuration | [Configuration reference](config.md) and files under `examples/` | The reference owns field meaning; examples own complete copyable files. |
|
||||||
|
| Release preparation, tagging, publication, or verification | [Release procedure](release.md) | It owns version selection, release-note preparation, candidate validation, tag publication, CI behavior, and post-publication checks. |
|
||||||
|
| Proposed, deferred, or unimplemented work | Documents under `docs/roadmap/` | Future behavior and implementation status belong only in roadmaps until implemented. |
|
||||||
|
|
||||||
|
For an existing subsystem, inspect its focused internal document, package-local
|
||||||
|
types, and tests before changing behavior. Use the package boundaries already
|
||||||
|
present before introducing a new package or abstraction.
|
||||||
|
|
||||||
|
## Repository Map
|
||||||
|
|
||||||
|
| Area | Responsibility |
|
||||||
|
| --- | --- |
|
||||||
|
| `cmd/weatherreporter` | Binary entry point. |
|
||||||
|
| `internal/cli` | Command parsing, flags, help, output, and command wiring. |
|
||||||
|
| `internal/app` | Stateless generation, batches, collection coordination, output publication, and notification. |
|
||||||
|
| `internal/config` | Configuration defaults, loading, precedence, secrets, and validation. |
|
||||||
|
| `internal/adapters` | Weather API, Promptkit, and Distributor boundaries. |
|
||||||
|
| `internal/weatherdata`, `internal/forecast`, `internal/facts` | Normalized source facts and deterministic derivation. |
|
||||||
|
| `internal/report`, `internal/module`, `internal/briefing` | Report registry plus module and briefing contracts. |
|
||||||
|
| `internal/promptinput`, `internal/generatedtext`, `internal/reporttemplate` | Prompt packages, generated-text validation, render contexts, and Markdown templates. |
|
||||||
|
| `internal/fileutil`, `internal/timeutil` | Atomic output operations, clocks, dates, timezones, and periods. |
|
||||||
|
| `docs` | User, operator, integration, internal, policy, and roadmap documentation. |
|
||||||
|
| `examples` | Maintained copyable configuration. |
|
||||||
|
|
||||||
|
The [architecture policy](policy/architecture.md) is authoritative for
|
||||||
|
normative boundaries. Focused documents under `docs/internal/` own detailed
|
||||||
|
implemented subsystem behavior.
|
||||||
|
|
||||||
|
## Contributor Workflow
|
||||||
|
|
||||||
|
1. Read the documents and focused tests identified by the task guide.
|
||||||
|
2. Use focused package checks while iterating.
|
||||||
|
3. Run `gofmt -w` on changed Go files.
|
||||||
|
4. Update the canonical documentation and maintained examples in the same
|
||||||
|
change when behavior changes.
|
||||||
|
5. Run repository-wide validation before considering the work complete.
|
||||||
|
|
||||||
|
Preserve actionable error context, keep secrets out of logs and fixtures, and
|
||||||
|
avoid validation that requires live Weather API, Promptkit providers, or Distributor
|
||||||
|
services. The architecture and testing policies own the detailed rules.
|
||||||
|
|
||||||
|
## Baseline Validation
|
||||||
|
|
||||||
|
Run:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go test ./...
|
||||||
|
go run ./cmd/weatherreporter --help
|
||||||
|
git diff --check
|
||||||
|
```
|
||||||
|
|
||||||
|
Use focused package tests during development and add broader or race-enabled
|
||||||
|
checks when required by the [testing policy](policy/testing.md) and the risks of
|
||||||
|
the change.
|
||||||
@@ -1,136 +1,70 @@
|
|||||||
# Upstream Producer Integration
|
# Distributor HTTP Upload Contract
|
||||||
|
|
||||||
Audience: developers and LLM coding agents adding `distributor` support to an upstream Go producer application.
|
Weatherreporter integrates with the HTTP upload API provided by
|
||||||
|
`gitea.maximumdirect.net/eric/distributor v0.5.0`. It submits source bundles to
|
||||||
|
a configured pipeline and reads the resulting run status. Configuration fields
|
||||||
|
and notification lifecycle are documented in the [configuration reference](../../config.md)
|
||||||
|
and [operations guide](../../operations.md).
|
||||||
|
|
||||||
This document is the copyable implementation guide for submitting producer outputs to a `distributor` pipeline whose source backend is `http_upload`.
|
## Upload Admission
|
||||||
|
|
||||||
## Required Inputs
|
Weatherreporter uses an absolute HTTP(S) endpoint as a base URL. The client
|
||||||
|
posts a gzip-compressed source bundle to:
|
||||||
|
|
||||||
The upstream application needs these values from deployment or operator configuration:
|
```text
|
||||||
|
POST /v1/pipelines/<pipeline_id>/upload
|
||||||
- distributor endpoint: the HTTP server base URL, such as `https://distributor.example.com`;
|
Authorization: Bearer <token>
|
||||||
- upload token: bearer token that authenticates the producer;
|
Content-Type: application/gzip
|
||||||
- pipeline id: configured `http_upload` pipeline that should process this upload;
|
Idempotency-Key: <key>
|
||||||
- generated files: regular local files to include in the source bundle;
|
|
||||||
- bundle id: stable identifier for the logical report stream or artifact;
|
|
||||||
- idempotency key: unique key for one producer run, reused only when retrying that same run.
|
|
||||||
|
|
||||||
Do not put destination routing, public URLs, transform settings, or credentials in the source manifest. Those belong in the `distributor` pipeline configuration.
|
|
||||||
|
|
||||||
The token, pipeline id, bundle id, and idempotency key have different jobs. The token authenticates the producer. The pipeline id selects the configured distributor workflow, including destinations and publishing policy. The bundle id tells `distributor` whether a new upload is a newer version of the same source; keep it stable across runs that should replace the same managed destination artifact. The idempotency key tells `distributor` whether an upload request is a retry; change it for each distinct producer run so new content is enqueued.
|
|
||||||
|
|
||||||
## Recommended Workflow
|
|
||||||
|
|
||||||
Use `gitea.maximumdirect.net/eric/distributor/pkg/upload`.
|
|
||||||
|
|
||||||
For most producers, use `UploadFiles`. It accepts producer-generated files, builds a temporary valid source bundle with `pkg/bundle`, uploads a gzip-compressed tar archive, and removes temporary files when the call returns.
|
|
||||||
|
|
||||||
Use `UploadBundle` only when the producer already assembled a complete bundle directory containing `manifest.json`.
|
|
||||||
|
|
||||||
Add the dependency from the upstream application:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
go get gitea.maximumdirect.net/eric/distributor
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Minimal Go Example
|
The authenticated token must be allowed to use the selected upload pipeline.
|
||||||
|
A successful response is `202 Accepted` with JSON containing `run_id` and
|
||||||
|
`status`. Acceptance means Distributor staged and validated the source bundle;
|
||||||
|
it does not mean downstream destinations have published it.
|
||||||
|
|
||||||
```go
|
The adapter requires a pipeline ID, bundle ID, idempotency key, and at least one
|
||||||
package reports
|
source-file mapping before calling Distributor. It reads the bearer token from
|
||||||
|
the configured environment variable and redacts that value from errors. Request
|
||||||
|
construction and timeout handling belong to the [Distributor adapter](../../internal/distributor-adapter.md).
|
||||||
|
|
||||||
import (
|
## Idempotency
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/distributor/pkg/bundle"
|
Distributor scopes idempotency to the token, pipeline ID, and key. Keys must be
|
||||||
"gitea.maximumdirect.net/eric/distributor/pkg/upload"
|
non-empty ASCII values of at most 128 bytes using letters, digits, `.`, `_`,
|
||||||
)
|
`-`, and `:`. Weatherreporter always supplies a rendered key; it does not rely
|
||||||
|
on the client library's generated-key fallback.
|
||||||
|
|
||||||
func SubmitReport(reportPath, summaryPath string) error {
|
Reusing a key for the same normalized source manifest returns the original
|
||||||
endpoint := os.Getenv("DISTRIBUTOR_UPLOAD_ENDPOINT")
|
accepted run. Reusing it for different content returns `409 Conflict`, which
|
||||||
token := os.Getenv("DISTRIBUTOR_UPLOAD_TOKEN")
|
the adapter exposes as a Weatherreporter idempotency-conflict error. A distinct
|
||||||
if endpoint == "" || token == "" {
|
report or batch run therefore needs a distinct key; reuse a key only when
|
||||||
return fmt.Errorf("distributor endpoint and token are required")
|
retrying that same upload.
|
||||||
}
|
|
||||||
|
|
||||||
pipelineID := "weather-hourly"
|
## Run Status And Retention
|
||||||
reportID := "weather.hourly.brentwood"
|
|
||||||
runID := time.Now().UTC().Format("20060102T150405.000000000Z")
|
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
client, err := upload.NewClient(upload.ClientOptions{
|
After acceptance, Weatherreporter reads:
|
||||||
Endpoint: endpoint,
|
|
||||||
Token: token,
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
result, err := client.UploadFiles(ctx, upload.UploadFilesOptions{
|
```text
|
||||||
PipelineID: pipelineID,
|
GET /runs/<run_id>
|
||||||
ID: reportID,
|
Authorization: Bearer <token>
|
||||||
IdempotencyKey: reportID + "." + runID,
|
|
||||||
Files: []bundle.BundleFile{
|
|
||||||
{SourcePath: reportPath, Path: "report.md"},
|
|
||||||
{SourcePath: summaryPath, Path: "summary.txt"},
|
|
||||||
},
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
var conflict *upload.IdempotencyConflictError
|
|
||||||
if errors.As(err, &conflict) {
|
|
||||||
return fmt.Errorf("idempotency key was reused for different bundle content: %w", err)
|
|
||||||
}
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
fmt.Printf("distributor accepted run %s\n", result.RunID)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Producer Responsibilities
|
The status record provides `run_id`, `pipeline_id`, status timestamps, optional
|
||||||
|
JSON `report`, and an `error` for failures. Statuses are `accepted`, `queued`,
|
||||||
|
`running`, `succeeded`, and `failed`. A terminal `failed` status makes the
|
||||||
|
notification fail; the adapter preserves the returned status details for the
|
||||||
|
application to record.
|
||||||
|
|
||||||
- Use a stable bundle id for the logical producer output that should replace the same destination artifact, such as `weather.hourly.brentwood`.
|
Run and idempotency records are in-memory. Completed records expire according
|
||||||
- Set `PipelineID` to the configured upload pipeline that should process the bundle.
|
to Distributor's `server.http.retention`, and a Distributor restart removes
|
||||||
- Do not include per-run timestamps, random values, or job ids in the bundle id unless each run should be treated as a different source.
|
retained status and idempotency state. Status polling decisions are internal
|
||||||
- Use an idempotency key that changes for every distinct producer run, such as `<bundle-id>.<run-id>`.
|
orchestration behavior; see the
|
||||||
- Reuse the same idempotency key only when retrying the exact same producer run with the same source manifest.
|
[Distributor adapter](../../internal/distributor-adapter.md) and
|
||||||
- Map each generated file to a clean slash-separated bundle path, such as `report.md` or `assets/chart.png`.
|
[application orchestration](../../internal/app-orchestration.md).
|
||||||
- Include only regular files. Symlinks, directories as files, devices, FIFOs, and sockets are rejected.
|
|
||||||
- Keep file contents stable after upload inputs are selected. Bundle digests are calculated from file bytes.
|
|
||||||
- Treat upload success as admission only. `UploadFiles` and `UploadBundle` return after the server accepts and validates the upload, not after all destinations publish.
|
|
||||||
|
|
||||||
Valid bundle paths are relative slash paths. They must not be empty, absolute, contain backslashes, contain `.` or `..` path segments, contain empty path segments, or use reserved basenames `manifest.json` or `.distributor.json`.
|
## Compatibility Reference
|
||||||
|
|
||||||
## Idempotency And Status
|
The upstream canonical HTTP wire contract is
|
||||||
|
`docs/integrations/http-upload.md` in the Distributor repository. This page
|
||||||
`pkg/upload` sends `Idempotency-Key` on every upload. If the caller omits one, the package generates a random key for that call and reuses it for in-process retries. That is enough for transient network retry within one process, but it does not give cross-process retry identity.
|
documents only the portion exercised by Weatherreporter.
|
||||||
|
|
||||||
For producer jobs that may retry after process restart, supply a key derived from the producer run, such as `<bundle-id>.<run-id>`. Reusing the same key with the same token, pipeline id, and normalized source manifest returns the original accepted run. Reusing the same key with different source content in that scope returns a conflict. Reusing one key across multiple distinct report generations prevents those generations from being treated as new uploads.
|
|
||||||
|
|
||||||
`Status` polls `/runs/<run-id>` while the distributor server retains the in-memory status record. Status values are `accepted`, `queued`, `running`, `succeeded`, and `failed`. Completed records expire according to the server's `server.http.retention` setting, and server restart clears status and idempotency records.
|
|
||||||
|
|
||||||
Optional status check:
|
|
||||||
|
|
||||||
```go
|
|
||||||
status, err := client.Status(ctx, result.RunID)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if status.Status == "failed" {
|
|
||||||
return fmt.Errorf("distributor run failed: %s", status.Error)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## References
|
|
||||||
|
|
||||||
In the `distributor` source tree:
|
|
||||||
|
|
||||||
- `docs/consumers/pkg-upload.md`: Go upload package workflow.
|
|
||||||
- `docs/consumers/pkg-bundle.md`: Go bundle package workflow.
|
|
||||||
- `docs/integrations/http-upload.md`: canonical HTTP upload wire contract.
|
|
||||||
- `docs/integrations/source-bundle.md`: canonical source bundle file-format contract.
|
|
||||||
|
|||||||
@@ -1,90 +1,36 @@
|
|||||||
# `pkg/bundle`
|
# Distributor Source Bundle Mapping
|
||||||
|
|
||||||
Audience: upstream Go producer developers and LLM coding agents using `distributor` source bundle helpers.
|
Weatherreporter uses the source-bundle format through Distributor's
|
||||||
|
`pkg/upload.UploadFiles` helper. It does not create bundle directories or call
|
||||||
|
`pkg/bundle` directly. The helper creates a temporary bundle, writes and
|
||||||
|
validates `manifest.json`, archives it, and removes the temporary bundle when
|
||||||
|
the upload call returns.
|
||||||
|
|
||||||
Import path:
|
## File Mappings
|
||||||
|
|
||||||
```go
|
Every mapping pairs an operator-owned Markdown output with one bundle-relative
|
||||||
import "gitea.maximumdirect.net/eric/distributor/pkg/bundle"
|
path. A single-report notification maps its published output to each rendered
|
||||||
```
|
path configured for that report. A batch notification combines mappings for
|
||||||
|
every included published output and rejects duplicate bundle paths.
|
||||||
|
|
||||||
`pkg/bundle` builds, writes, parses, and validates local source bundles. Use it directly when a producer writes bundles for `distributor` to discover, or when a producer wants to assemble and validate a bundle before using another transport.
|
The report source is the output selected for that command; the application does
|
||||||
|
not scan local directories. It renders notification paths after publication;
|
||||||
|
see the [operations guide](../../operations.md) and the
|
||||||
|
[Distributor adapter](../../internal/distributor-adapter.md) for the boundary.
|
||||||
|
|
||||||
The canonical source bundle file-format contract is [Source Bundle Contract](../integrations/source-bundle.md).
|
Bundle paths must be clean, relative, slash-separated paths. They cannot be
|
||||||
|
empty or absolute, contain backslashes, empty segments, `.` or `..`, or use
|
||||||
|
`manifest.json` or `.distributor.json` as a basename. The mapped source must be
|
||||||
|
a regular file. File mapping order is preserved and affects the bundle digest.
|
||||||
|
|
||||||
## Preferred Complete-Bundle Workflow
|
The bundle manifest uses schema version `1`, carries the rendered bundle ID and
|
||||||
|
creation time, and records each mapped file's path, SHA-256 digest, and size.
|
||||||
|
Destination routing, publication, and Distributor-managed destination state are
|
||||||
|
not source-bundle fields.
|
||||||
|
|
||||||
Use `WriteBundle` when producer-generated files live outside the final bundle root.
|
## Compatibility Reference
|
||||||
|
|
||||||
```go
|
The upstream canonical file-format contract is
|
||||||
manifest, err := bundle.WriteBundle(bundle.WriteBundleOptions{
|
`docs/integrations/source-bundle.md` in the Distributor repository. It defines
|
||||||
Root: "/var/spool/distributor/weather/hourly-2026-06-07T15",
|
the complete manifest and archive format; this page records only the mapping and
|
||||||
ID: "weather.hourly.brentwood",
|
path constraints Weatherreporter relies on.
|
||||||
Files: []bundle.BundleFile{
|
|
||||||
{SourcePath: "/tmp/weather/report.md", Path: "report.md"},
|
|
||||||
{SourcePath: "/tmp/weather/summary.txt", Path: "summary.txt"},
|
|
||||||
},
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
_ = manifest
|
|
||||||
```
|
|
||||||
|
|
||||||
`WriteBundle` copies each source file into a staged bundle root, writes `manifest.json`, validates the staged bundle, and promotes it into place. Set `Overwrite: true` only when the producer intentionally replaces an existing bundle root.
|
|
||||||
|
|
||||||
## Existing Bundle Root Workflow
|
|
||||||
|
|
||||||
Use `BuildManifest` and `WriteManifest` when files are already staged under the final bundle root.
|
|
||||||
|
|
||||||
```go
|
|
||||||
root := "/var/spool/distributor/weather/hourly-2026-06-07T15"
|
|
||||||
manifest, err := bundle.BuildManifest(bundle.BuildOptions{
|
|
||||||
Root: root,
|
|
||||||
ID: "weather.hourly.brentwood",
|
|
||||||
Files: []string{"report.md", "summary.txt"},
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if err := bundle.WriteManifest(root, manifest, bundle.WriteManifestOptions{}); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if err := bundle.ValidateBundle(root, manifest); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Use `Scan: true` instead of `Files` only when every valid regular file under the root should be included. Scan mode includes dotfiles, skips reserved metadata files, rejects symlinks, and sorts paths lexically.
|
|
||||||
|
|
||||||
## Paths And Ordering
|
|
||||||
|
|
||||||
Bundle paths are slash-separated paths relative to the bundle root.
|
|
||||||
|
|
||||||
Invalid paths include:
|
|
||||||
|
|
||||||
- empty paths;
|
|
||||||
- absolute paths;
|
|
||||||
- paths containing backslashes;
|
|
||||||
- `.` or `..` path segments;
|
|
||||||
- empty path segments;
|
|
||||||
- any basename of `manifest.json` or `.distributor.json`.
|
|
||||||
|
|
||||||
Explicit file lists preserve caller order. File order is part of the bundle digest, so producers should choose it deliberately and keep it stable.
|
|
||||||
|
|
||||||
The manifest `ID` is the logical source identity used by `distributor` destination comparison. Keep it stable for runs that should replace the same managed destination artifact. If every run uses a different manifest `ID`, `distributor` treats those runs as different sources and may report a destination conflict instead of replacing older output.
|
|
||||||
|
|
||||||
## Validation And Digest Helpers
|
|
||||||
|
|
||||||
Use `ValidateBundle` before handing an existing local bundle to another process. It verifies manifest semantics, file existence, regular-file type, file size, per-file SHA-256 digests, and bundle digest.
|
|
||||||
|
|
||||||
Useful helpers:
|
|
||||||
|
|
||||||
- `LoadManifest`: read `manifest.json` from a bundle root.
|
|
||||||
- `ParseManifest` and `MarshalManifest`: parse or write manifest bytes.
|
|
||||||
- `ValidateManifest`: validate manifest-only semantics.
|
|
||||||
- `FileDigest`, `BundleDigest`, and `ValidateDigest`: digest helpers for diagnostics and tests.
|
|
||||||
|
|
||||||
## Boundaries
|
|
||||||
|
|
||||||
`pkg/bundle` does not upload bundles, publish destinations, transform Markdown, select pipelines, configure credentials, or write destination state. Those concerns belong to `pkg/upload` or the `distributor` application.
|
|
||||||
|
|||||||
@@ -1,122 +1,51 @@
|
|||||||
# `pkg/upload`
|
# Distributor Upload Client Contract
|
||||||
|
|
||||||
Audience: upstream Go producer developers and LLM coding agents submitting bundles to `distributor serve`.
|
Weatherreporter uses `gitea.maximumdirect.net/eric/distributor/pkg/upload` at
|
||||||
|
the pinned module version `v0.5.0`. It constructs one client per notification
|
||||||
|
attempt and calls `UploadFiles`, followed by `Status` for the accepted run.
|
||||||
|
|
||||||
Import path:
|
## Client And Upload
|
||||||
|
|
||||||
```go
|
The adapter constructs the client with the configured endpoint, bearer token,
|
||||||
import "gitea.maximumdirect.net/eric/distributor/pkg/upload"
|
and an HTTP client whose timeout is the configured Distributor timeout. It
|
||||||
```
|
passes no custom retry options, so the pinned client's defaults apply: three
|
||||||
|
attempts, 100 ms base delay, and one-second maximum delay.
|
||||||
|
|
||||||
`pkg/upload` is the producer-facing HTTP upload client. It builds on `pkg/bundle`, packages valid source bundles as gzip-compressed tar archives, sends bearer authentication, routes uploads to a configured pipeline, includes idempotency keys, and exposes a status polling helper.
|
For each notification, Weatherreporter calls `UploadFiles` with:
|
||||||
|
|
||||||
`UploadFiles` examples also use:
|
- the rendered pipeline ID;
|
||||||
|
- the rendered bundle ID as the source manifest ID;
|
||||||
|
- the report or batch generation time as `Created`;
|
||||||
|
- the published-output-to-bundle-path mappings described in the
|
||||||
|
[bundle mapping contract](pkg-bundle.md); and
|
||||||
|
- a rendered idempotency key.
|
||||||
|
|
||||||
```go
|
It leaves bundle validation enabled. `UploadFiles` creates the temporary source
|
||||||
import "gitea.maximumdirect.net/eric/distributor/pkg/bundle"
|
bundle and sends it as a gzip-compressed tar archive; Weatherreporter does not
|
||||||
```
|
call `UploadBundle` or submit prebuilt bundle roots.
|
||||||
|
|
||||||
The canonical HTTP wire contract is [HTTP Upload API Contract](../integrations/http-upload.md).
|
## Retry, Conflict, And Status
|
||||||
|
|
||||||
## Client Construction
|
The pinned upload client retries only `503 Service Unavailable` and retryable
|
||||||
|
network failures. It does not retry successful `202` responses or other HTTP
|
||||||
|
errors. Because every Weatherreporter request supplies an idempotency key, a
|
||||||
|
retry keeps the same upload identity.
|
||||||
|
|
||||||
```go
|
The client decodes the accepted upload result (`run_id`, `status`) and the run
|
||||||
client, err := upload.NewClient(upload.ClientOptions{
|
status record. A `409` response is an upstream idempotency conflict; the
|
||||||
Endpoint: "https://distributor.example.com",
|
adapter translates it to its own conflict error without exposing the token.
|
||||||
Token: token,
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
`Endpoint` is the distributor server base URL. The client derives `/v1/pipelines/<pipeline-id>/upload` and `/runs/<run-id>`. `Token` is required and is sent as `Authorization: Bearer <token>`. Token values are redacted from client errors.
|
The adapter then calls `Status` for the accepted run. A terminal `failed`
|
||||||
|
status is a notification failure. A status lookup failure or a timeout before a
|
||||||
|
terminal status remains attached to the otherwise accepted upload as diagnostic
|
||||||
|
status information. Polling cadence, final failure handling, and redaction are
|
||||||
|
internal behavior documented in the
|
||||||
|
[Distributor adapter](../../internal/distributor-adapter.md) and
|
||||||
|
[application orchestration](../../internal/app-orchestration.md).
|
||||||
|
|
||||||
`HTTPClient` and `Retry` are optional. Defaults use a 30 second HTTP timeout and safe retry settings.
|
## Compatibility Reference
|
||||||
|
|
||||||
## Upload Producer Files
|
The upstream package workflow is documented in
|
||||||
|
`docs/consumers/pkg-upload.md` in the Distributor repository. Weatherreporter
|
||||||
Use `UploadFiles` when the producer has generated output files but has not assembled a bundle directory.
|
uses only the client construction, `UploadFiles`, retry/conflict behavior, and
|
||||||
|
`Status` operations described here.
|
||||||
```go
|
|
||||||
result, err := client.UploadFiles(ctx, upload.UploadFilesOptions{
|
|
||||||
PipelineID: "weather-hourly",
|
|
||||||
ID: "weather.hourly.brentwood",
|
|
||||||
IdempotencyKey: "weather.hourly.brentwood.20260607T150000Z",
|
|
||||||
Files: []bundle.BundleFile{
|
|
||||||
{SourcePath: "/tmp/weather/report.md", Path: "report.md"},
|
|
||||||
{SourcePath: "/tmp/weather/summary.txt", Path: "summary.txt"},
|
|
||||||
},
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
_ = result.RunID
|
|
||||||
```
|
|
||||||
|
|
||||||
`PipelineID` is required and selects the configured distributor workflow for this upload. `ID` is the source manifest id and identifies the logical artifact inside that workflow. `UploadFiles` creates a temporary bundle, writes and validates a manifest, uploads the archive, and removes temporary files when the call returns. It does not write into producer source directories.
|
|
||||||
|
|
||||||
## Upload An Existing Bundle
|
|
||||||
|
|
||||||
Use `UploadBundle` when the producer already has a complete local bundle root containing `manifest.json`.
|
|
||||||
|
|
||||||
```go
|
|
||||||
result, err := client.UploadBundle(ctx, upload.UploadBundleOptions{
|
|
||||||
PipelineID: "weather-hourly",
|
|
||||||
Root: "/var/spool/weather/hourly-2026-06-07T15",
|
|
||||||
IdempotencyKey: "weather.hourly.brentwood.20260607T150000Z",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
_ = result.RunID
|
|
||||||
```
|
|
||||||
|
|
||||||
`PipelineID` is required for existing bundles too. `UploadBundle` validates the local bundle by default and uploads only `manifest.json` plus manifest-listed files. Unlisted files are not uploaded.
|
|
||||||
|
|
||||||
## Result And Status
|
|
||||||
|
|
||||||
Upload success means the server returned `202 Accepted` after staging and validating the upload. It does not mean all configured destinations have published.
|
|
||||||
|
|
||||||
Poll status while the server retains the in-memory run record:
|
|
||||||
|
|
||||||
```go
|
|
||||||
status, err := client.Status(ctx, result.RunID)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if status.Status == "failed" {
|
|
||||||
return fmt.Errorf("distributor run failed: %s", status.Error)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Status values are `accepted`, `queued`, `running`, `succeeded`, and `failed`. Completed records expire according to `server.http.retention`; server restart clears run status and idempotency records.
|
|
||||||
|
|
||||||
## Idempotency And Retry
|
|
||||||
|
|
||||||
Every upload request includes `Idempotency-Key`.
|
|
||||||
|
|
||||||
If `IdempotencyKey` is omitted, the client generates a random 128-bit lowercase hexadecimal key for that upload operation and reuses it for retries within the same call. For cross-process retry safety, producers should pass a key derived from the producer run, such as `<bundle-id>.<run-id>`.
|
|
||||||
|
|
||||||
Do not reuse the same idempotency key for multiple distinct report generations. Reuse it only when retrying the exact same run with the same token, pipeline id, and source manifest. A repeated key with the same manifest in that scope returns the original accepted run instead of enqueueing another run; a repeated key with different content returns an idempotency conflict.
|
|
||||||
|
|
||||||
The client retries only safe cases:
|
|
||||||
|
|
||||||
- `503 Service Unavailable`;
|
|
||||||
- temporary network errors;
|
|
||||||
- ambiguous mid-upload failures.
|
|
||||||
|
|
||||||
It does not retry after `202 Accepted` and does not retry `400`, `401`, `403`, `404`, `409`, `413`, or `415`.
|
|
||||||
|
|
||||||
Detect conflicting key reuse with `errors.As`:
|
|
||||||
|
|
||||||
```go
|
|
||||||
var conflict *upload.IdempotencyConflictError
|
|
||||||
if errors.As(err, &conflict) {
|
|
||||||
return fmt.Errorf("idempotency key was reused for different bundle content: %w", err)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Boundaries
|
|
||||||
|
|
||||||
`pkg/upload` does not configure server pipelines, choose destinations, wait for publication completion automatically, persist client queues, provide durable idempotency across server restarts, or expose destination state. It submits complete source bundles to the configured HTTP upload API.
|
|
||||||
|
|||||||
34
docs/integrations/promptkit.md
Normal file
34
docs/integrations/promptkit.md
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
# Promptkit Integration
|
||||||
|
|
||||||
|
Weatherreporter uses Promptkit for all generated-text reports. The four logical prompts are `weather.daily_generated_text`, `weather.today_generated_text`, `weather.tomorrow_generated_text`, and `weather.hourly_generated_text`, each at version `2.0.0`. Their prompt assets, generated-text JSON Schemas, and Weatherreporter profile catalog are embedded by `internal/promptassets`.
|
||||||
|
|
||||||
|
## Logical Profile Catalog
|
||||||
|
|
||||||
|
Prompt definitions select a stable Weatherreporter profile ID. The embedded definitions currently use Promptkit's `openrouter` backend:
|
||||||
|
|
||||||
|
| Profile ID | Model | Reasoning effort | Timeout | Service tier | Default reports |
|
||||||
|
| --- | --- | --- | --- | --- | --- |
|
||||||
|
| `weather-light` | `deepseek/deepseek-v4-flash` | Provider default | 180 seconds | `flex` | Hourly |
|
||||||
|
| `weather-balanced` | `~google/gemini-flash-latest` | `high` | 240 seconds | `flex` | Daily, Today, Tomorrow |
|
||||||
|
| `weather-deep` | `~anthropic/claude-sonnet-latest` | `high` | 240 seconds | `flex` | None |
|
||||||
|
|
||||||
|
The `~` prefix is part of each OpenRouter rolling-alias model ID. The embedded profiles intentionally omit endpoints, credentials, temperature, `top_p`, and output-token limits.
|
||||||
|
|
||||||
|
## Selection And Active Execution
|
||||||
|
|
||||||
|
Before weather collection, Weatherreporter validates the exact prompt version, output contract, and selected profile. A nonblank `promptkit.profile` selects one profile ID for every report in the command; otherwise the prompt's declared default selects it. Promptkit resolves the selected definition in this order:
|
||||||
|
|
||||||
|
1. explicit in-memory profiles used by an embedding consumer or test;
|
||||||
|
2. the configured `profile_file` or `profile_dir`;
|
||||||
|
3. Weatherreporter's embedded fallback profiles; and
|
||||||
|
4. Promptkit's built-in catalog.
|
||||||
|
|
||||||
|
A source falls through only when the selected ID is absent. Each source supplies a complete definition, so profile fields are not merged. A malformed matching operator definition is an error and does not fall back.
|
||||||
|
|
||||||
|
Profiles that require a direct API key are unsupported; a profile that reports `APIKeyEnv` requires a nonblank value in that environment variable. Active results retain the selected logical profile ID and resolved backend and model. Ordinary errors, summaries, logs, and outputs exclude endpoints, credentials, rendered messages, schemas, request bodies, response bodies, and complete parameter maps.
|
||||||
|
|
||||||
|
Promptkit receives the YAML data package as an inline input and returns structured JSON that Weatherreporter validates before rendering its own Markdown template. Safe active provenance remains in memory. Content-rich diagnostics are opt-in through `--llm-debug-dir`; see [operations](../operations.md) for retention and permissions.
|
||||||
|
|
||||||
|
The generated-text schemas require `summary`, `forecast_discussion`, and `precipitation_timing`, and reject additional properties. Prompts return an empty string for `precipitation_timing` when the deterministic package contains no precipitation windows.
|
||||||
|
|
||||||
|
Prompt/profile configuration and the maintained local override example are owned by the [configuration reference](../config.md). Adapter construction and mapping are documented in the [Promptkit adapter internals](../internal/promptkit-adapter.md).
|
||||||
@@ -1,118 +0,0 @@
|
|||||||
# Scriptorium Integration
|
|
||||||
|
|
||||||
This document describes the external Scriptorium CLI contract used by
|
|
||||||
`weatherreporter`.
|
|
||||||
|
|
||||||
## Purpose
|
|
||||||
|
|
||||||
`weatherreporter` invokes Scriptorium as a subprocess to preflight prompt input
|
|
||||||
and generate report artifacts. This page documents the CLI surface the adapter
|
|
||||||
uses, not the full Scriptorium product.
|
|
||||||
|
|
||||||
## Commands Used
|
|
||||||
|
|
||||||
Render preflight:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
scriptorium render \
|
|
||||||
--prompt <prompt_id> \
|
|
||||||
--input data_package=<path> \
|
|
||||||
--format json
|
|
||||||
```
|
|
||||||
|
|
||||||
Report generation:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
scriptorium run \
|
|
||||||
--prompt <prompt_id> \
|
|
||||||
--input data_package=<path> \
|
|
||||||
--out <artifact_path>
|
|
||||||
```
|
|
||||||
|
|
||||||
Structured generated-text report generation uses the same command shape:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
scriptorium run \
|
|
||||||
--prompt <prompt_id> \
|
|
||||||
--input data_package=<path> \
|
|
||||||
--out <generated_text_raw_path>
|
|
||||||
```
|
|
||||||
|
|
||||||
`weatherreporter` always passes prompt input as
|
|
||||||
`--input data_package=<path>`. The data package is structured YAML created by
|
|
||||||
`internal/promptinput`; module snapshots remain separate JSON artifacts for
|
|
||||||
inspection and Recent Changes.
|
|
||||||
|
|
||||||
For generated-text reports, Scriptorium selects the structured output schema
|
|
||||||
from the prompt configuration associated with the prompt ID. `weatherreporter`
|
|
||||||
does not pass `--format`, schema path, or JSON Schema flags for structured
|
|
||||||
generation.
|
|
||||||
|
|
||||||
## Configured Arguments
|
|
||||||
|
|
||||||
The adapter can prepend configured flags before prompt-specific arguments:
|
|
||||||
|
|
||||||
- `--config <path>` from `scriptorium.config_path`
|
|
||||||
- `--profile <profile>` from `scriptorium.profile`
|
|
||||||
|
|
||||||
It appends `scriptorium.extra_args` after the built-in arguments. Extra
|
|
||||||
arguments are passed directly as argv items.
|
|
||||||
|
|
||||||
`scriptorium.binary` selects the executable name or path. If unset inside the
|
|
||||||
adapter, it falls back to `scriptorium`.
|
|
||||||
|
|
||||||
## Execution Behavior
|
|
||||||
|
|
||||||
The adapter runs Scriptorium without shell interpolation. Arguments are passed
|
|
||||||
through `exec.CommandContext`.
|
|
||||||
|
|
||||||
`scriptorium.timeout` limits each subprocess call when configured. Context
|
|
||||||
cancellation or timeout returns an execution error.
|
|
||||||
|
|
||||||
Stdout and stderr are captured separately. Each stream is capped at 1 MiB and
|
|
||||||
the result records whether truncation occurred.
|
|
||||||
|
|
||||||
## Results
|
|
||||||
|
|
||||||
Render results include:
|
|
||||||
|
|
||||||
- full argv recorded as `command`
|
|
||||||
- stdout
|
|
||||||
- stderr
|
|
||||||
- exit code
|
|
||||||
- truncation flags when applicable
|
|
||||||
|
|
||||||
Run results include the same fields plus the requested output path. Structured
|
|
||||||
generated-text run results use the same captured fields and output-path
|
|
||||||
recording, with the output path pointing at the raw generated-text JSON
|
|
||||||
artifact.
|
|
||||||
|
|
||||||
`weatherreporter` persists render preflight JSON when orchestration reaches the
|
|
||||||
preflight save point. For direct Markdown reports, Scriptorium writes the
|
|
||||||
managed Markdown artifact to the `--out` path. For generated-text-template
|
|
||||||
reports, Scriptorium writes raw JSON to the `--out` path; later
|
|
||||||
weatherreporter workflow steps validate those bytes and render Markdown from an
|
|
||||||
embedded template.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
The adapter validates required request fields before starting Scriptorium:
|
|
||||||
|
|
||||||
- prompt ID
|
|
||||||
- data package path
|
|
||||||
- output path for `run` and structured generated-text `run`
|
|
||||||
|
|
||||||
Nonzero exits return both the captured result and an error containing the exit
|
|
||||||
code and stderr. A `run` exit code such as `2` is still treated as an error by
|
|
||||||
the adapter, even if Scriptorium wrote output to the requested artifact path.
|
|
||||||
|
|
||||||
Subprocess start failures, context cancellation, and timeouts return errors
|
|
||||||
without fabricating a successful result.
|
|
||||||
|
|
||||||
## Security Notes
|
|
||||||
|
|
||||||
- The adapter does not invoke a shell.
|
|
||||||
- Generated artifacts, rendered prompt context, stdout, and stderr can contain
|
|
||||||
operationally sensitive data.
|
|
||||||
- API keys should be provided through the Scriptorium environment or
|
|
||||||
Scriptorium configuration, not through `weatherreporter` CLI arguments.
|
|
||||||
@@ -1,26 +1,51 @@
|
|||||||
# Weather API Integration
|
# Weather API Integration
|
||||||
|
|
||||||
This document describes the external Weather API contract used by
|
Weatherreporter fetches normalized weather inputs from a configured Weather API
|
||||||
`weatherreporter`.
|
base URL. This guide defines the HTTP contract the service must satisfy; it is
|
||||||
|
not a general Weather API reference. Configuration values are defined in the
|
||||||
|
[configuration reference](../config.md). Normalization and collection behavior
|
||||||
|
are documented in [Weather data internals](../internal/weather-data.md) and
|
||||||
|
[Collection internals](../internal/collect.md).
|
||||||
|
|
||||||
## Purpose
|
## Base URL And Requests
|
||||||
|
|
||||||
`weatherreporter` uses a configured Weather API base URL to fetch normalized
|
`weather_api.base_url` must be an absolute URL. Weatherreporter joins each
|
||||||
weather source data and assemble a `weatherdata.Bundle`. This is an integration
|
endpoint path to the configured base URL path, so a service hosted under a path
|
||||||
contract for the project adapter, not a complete public API reference for the
|
prefix must keep that prefix available. Requests use `GET` and carry the
|
||||||
upstream service.
|
configured timeout on every HTTP attempt.
|
||||||
|
|
||||||
## Base URL
|
Every request sends `format` and, except where noted below, `units`. The
|
||||||
|
configured format must be `json`.
|
||||||
|
|
||||||
`weather_api.base_url` must be an absolute URL. Adapter requests join this base
|
Before retrieving sources, Weatherreporter warms up
|
||||||
URL with the endpoint paths listed below. Generation and explicit bundle fetches
|
`/conditions/current` with the same `format`, `units`, and `precision` query
|
||||||
fail before any HTTP request when the base URL is empty or not absolute.
|
parameters used for current conditions. The warmup only requires a readable
|
||||||
|
2xx response; its body is not decoded. Failure after its internal retry budget
|
||||||
|
stops the fetch before source requests begin.
|
||||||
|
|
||||||
The HTTP client uses `weather_api.timeout`.
|
## Endpoints And Query Parameters
|
||||||
|
|
||||||
|
The adapter makes one source request for each endpoint after a successful
|
||||||
|
warmup, subject to retry on transient failures.
|
||||||
|
|
||||||
|
| Source | Endpoint | Query parameters | Availability |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| Observations | `/observations` | `format`, `units`, `precision` | Optional |
|
||||||
|
| Current conditions | `/conditions/current` | `format`, `units`, `precision` | Optional |
|
||||||
|
| Hourly forecast | `/forecast/hourly` | `format`, `units`, `precision`, `tz` | Required |
|
||||||
|
| Narrative forecast | `/forecast/narrative` | `format`, `units`, `precision`, `tz` | Optional |
|
||||||
|
| Active alerts | `/alerts/active` | `format`, `units` | Optional; `data: null` means checked with no active alerts |
|
||||||
|
| Forecast discussion | `/discussion` | `format`, `units`, `tz` | Optional |
|
||||||
|
| Weather story | `/weatherstories/latest` | `format` | Optional |
|
||||||
|
| SPC convective outlooks | `/outlooks/convective` | `format`, `tz` | Optional; non-null empty lists are checked empty data |
|
||||||
|
|
||||||
|
`precision` comes from `weather_api.precision`; `tz` comes from
|
||||||
|
`weather_api.timezone`. Weatherreporter does not call day-slice forecast or
|
||||||
|
discussion-subsection endpoints.
|
||||||
|
|
||||||
## Response Envelope
|
## Response Envelope
|
||||||
|
|
||||||
Every response used by the adapter must be JSON with a top-level `data` field:
|
Each endpoint response must be JSON with a top-level `data` member:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -28,171 +53,95 @@ Every response used by the adapter must be JSON with a top-level `data` field:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
For most sources, `data: null` is treated as a missing source. Missing optional
|
An absent `data` member is treated as a missing source. For ordinary sources,
|
||||||
sources follow the configured missing-source policy. Missing hourly forecast
|
`data: null` is also missing. The active-alert exception is listed above: its
|
||||||
data fails bundle fetching because hourly periods are required for report
|
explicit `null` payload represents an empty alert result.
|
||||||
generation.
|
|
||||||
|
|
||||||
`/alerts/active` is the exception: a successful response with `data: null`
|
Hourly forecast data must be present and contain at least one `period`; a
|
||||||
means the endpoint was checked and there are no current active alerts. The
|
missing, malformed, or empty hourly product fails collection. The remaining
|
||||||
adapter records a non-missing alerts source and an empty alert run.
|
sources follow the configured missing-source policy. Under `error`, collection
|
||||||
|
fails; under `warn`, the source is omitted and an inspectable warning is
|
||||||
|
recorded; under `none`, the source is omitted without a warning. A per-source
|
||||||
|
policy overrides the default. See [Configuration](../config.md) for policy
|
||||||
|
settings and [Weather data internals](../internal/weather-data.md) for recorded
|
||||||
|
source metadata.
|
||||||
|
|
||||||
For `/outlooks/convective`, `data: null` means no latest run is available and
|
Malformed top-level JSON envelopes and HTTP failures are direct request errors.
|
||||||
follows missing-source policy. A non-null run with empty `outlooks` and
|
Malformed `data` for an optional source follows its missing-source policy.
|
||||||
`discussions` arrays is checked empty data, not a missing source.
|
|
||||||
|
|
||||||
Malformed JSON envelopes, non-2xx statuses, and response read failures include
|
## Payload Fields Used
|
||||||
endpoint context in returned errors. Decode errors include source context when
|
|
||||||
they fail the fetch; optional malformed sources follow the missing-source policy.
|
|
||||||
|
|
||||||
## Query Parameters
|
Weatherreporter decodes only the fields below; additional upstream fields are
|
||||||
|
ignored. Timestamps must be JSON values accepted by Go's `time.Time` decoder.
|
||||||
|
|
||||||
The adapter sends these query parameters:
|
### Observations And Current Conditions
|
||||||
|
|
||||||
- `format`: from `weather_api.format`; configuration validation requires `json`
|
`/observations` uses `stationId`, `stationName`, `timestamp`, `conditionCode`,
|
||||||
- `units`: from `weather_api.units`
|
`isDay`, `textDescription`, `temperatureC`, `temperatureF`, `dewpointC`,
|
||||||
- `precision`: from `weather_api.precision` on observations, current
|
`dewpointF`, `windSpeedKmh`, `windSpeedMph`, `windGustKmh`, `windGustMph`,
|
||||||
conditions, hourly forecast, and narrative forecast requests
|
`windDirectionDegrees`, `barometricPressurePa`, `barometricPressureInHg`,
|
||||||
- `tz`: from `weather_api.timezone` on hourly forecast, narrative forecast,
|
`visibilityMeters`, `visibilityMiles`, `relativeHumidityPercent`,
|
||||||
discussion, and SPC convective outlook requests
|
`apparentTemperatureC`, `apparentTemperatureF`, and `presentWeather`.
|
||||||
|
|
||||||
Alerts do not receive `precision` or `tz`. Weather story requests receive only
|
`/conditions/current` uses `conditionText`, `isDay`,
|
||||||
`format=json`. SPC convective outlook requests receive only `format=json` and
|
`relativeHumidityPercent`, `windDirectionDegrees`, `temperatureC`,
|
||||||
`tz`; they do not receive `units` or `precision`.
|
`temperatureF`, `apparentTemperatureC`, `apparentTemperatureF`, `dewpointC`,
|
||||||
|
`dewpointF`, `windSpeedKmh`, and `windSpeedMph`.
|
||||||
|
|
||||||
## SPC Convective Outlooks
|
### Hourly And Narrative Forecasts
|
||||||
|
|
||||||
The adapter fetches SPC convective outlook data from:
|
Both forecast endpoints use run-level `locationId`, `locationName`, `issuedAt`,
|
||||||
|
`updatedAt`, `product`, `latitude`, `longitude`, `elevationMeters`,
|
||||||
|
`elevationFeet`, and `periods`.
|
||||||
|
|
||||||
```text
|
Each `periods` item uses `startTime`, `endTime`, `name`, `isDay`,
|
||||||
GET /outlooks/convective?format=json&tz=<weather_api.timezone>
|
`conditionCode`, `textDescription`, `temperatureC`, `temperatureF`,
|
||||||
```
|
`temperatureCMin`, `temperatureFMin`, `temperatureCMax`, `temperatureFMax`,
|
||||||
|
`dewpointC`, `dewpointF`, `windSpeedKmh`, `windSpeedMph`, `windGustKmh`,
|
||||||
|
`windGustMph`, `windDirectionDegrees`, `barometricPressurePa`,
|
||||||
|
`barometricPressureInHg`, `visibilityMeters`, `visibilityMiles`,
|
||||||
|
`apparentTemperatureC`, `apparentTemperatureF`, `cloudCoverPercent`,
|
||||||
|
`probabilityOfPrecipitationPercent`, `precipitationAmountMm`,
|
||||||
|
`precipitationAmountIn`, `snowfallDepthMM`, `snowfallDepthIn`, `uvIndex`, and
|
||||||
|
`relativeHumidityPercent`.
|
||||||
|
|
||||||
The response uses the standard `data` envelope. `data: null` means no latest
|
### Alerts, Discussion, And Weather Story
|
||||||
run is available and follows missing-source policy. A non-null object with
|
|
||||||
empty `outlooks` and `discussions` arrays is accepted as checked empty data.
|
|
||||||
|
|
||||||
Run fields consumed by weatherreporter:
|
`/alerts/active` uses the `asOf` timestamp and keeps each item in `alerts` as
|
||||||
|
an alert payload. Weatherreporter does not require a separate alert-item schema
|
||||||
|
at this integration boundary.
|
||||||
|
|
||||||
- `locationId`
|
`/discussion` uses `officeId`, `officeName`, `product`, `issuedAt`,
|
||||||
- `locationName`
|
`updatedAt`, `keyMessages`, and the `shortTerm` and `longTerm` sections. Each
|
||||||
- `asOf`
|
section uses `qualifier`, `text`, and `issuedAt`.
|
||||||
- `issuedAt`
|
|
||||||
- `updatedAt`
|
|
||||||
- `product`
|
|
||||||
- `outlooks`
|
|
||||||
- `discussions`
|
|
||||||
|
|
||||||
Outlook fields consumed:
|
`/weatherstories/latest` uses `officeId`, `startTime`, `endTime`, `updatedAt`,
|
||||||
|
`title`, `description`, `altText`, `priority`, `order`, and `downloadUrl`.
|
||||||
|
|
||||||
- `id`
|
### SPC Convective Outlooks
|
||||||
- `provider`
|
|
||||||
- `product`
|
|
||||||
- `day`
|
|
||||||
- `outlookType`
|
|
||||||
- `label`
|
|
||||||
- `labelText`
|
|
||||||
- `forecaster`
|
|
||||||
- `severityRank`
|
|
||||||
- `validFrom`
|
|
||||||
- `validTo`
|
|
||||||
- `issuedAt`
|
|
||||||
- `expiresAt`
|
|
||||||
- `sourceUrl`
|
|
||||||
- `imageUrl`
|
|
||||||
- `containsLocation`
|
|
||||||
- `geometry`
|
|
||||||
|
|
||||||
Discussion fields consumed:
|
`/outlooks/convective` uses run-level `locationId`, `locationName`, `asOf`,
|
||||||
|
`issuedAt`, `updatedAt`, `product`, `outlooks`, and `discussions`.
|
||||||
|
|
||||||
- `day`
|
Each outlook uses `id`, `provider`, `product`, `day`, `outlookType`, `label`,
|
||||||
- `headline`
|
`labelText`, `forecaster`, `severityRank`, `validFrom`, `validTo`, `issuedAt`,
|
||||||
- `summary`
|
`expiresAt`, `sourceUrl`, `imageUrl`, `containsLocation`, and GeoJSON
|
||||||
- `discussion`
|
`geometry`. Each discussion uses `day`, `headline`, `summary`, `discussion`,
|
||||||
- `updatedAt`
|
and `updatedAt`.
|
||||||
|
|
||||||
GeoJSON `geometry` is decoded into collected weather facts and persisted in
|
## Timeouts, Retries, And Failures
|
||||||
bundle/debug artifacts, but prompt-facing SPC module output omits geometry.
|
|
||||||
|
|
||||||
## Endpoints Used
|
The configured Weather API timeout applies to each warmup and source HTTP
|
||||||
|
attempt. Weatherreporter retries transient transport and response-read failures
|
||||||
|
and these response statuses: `408`, `429`, `500`, `502`, `503`, and `504`.
|
||||||
|
It does not retry other HTTP statuses, malformed envelopes, missing data, or
|
||||||
|
payload decoding failures. A canceled context also stops an in-progress retry
|
||||||
|
delay.
|
||||||
|
|
||||||
The adapter fetches these endpoints once per bundle:
|
The adapter reads at most 10 MiB from one response body. A non-2xx response,
|
||||||
|
request construction failure, read failure, or decode failure includes endpoint
|
||||||
|
context in its error.
|
||||||
|
|
||||||
- `/observations`
|
Retry counts and delays are adapter behavior rather than Weather API request
|
||||||
- `/conditions/current`
|
parameters. Do not depend on a particular attempt count when implementing the
|
||||||
- `/forecast/hourly`
|
service.
|
||||||
- `/forecast/narrative`
|
|
||||||
- `/alerts/active`
|
|
||||||
- `/discussion`
|
|
||||||
- `/weatherstories/latest`
|
|
||||||
- `/outlooks/convective`
|
|
||||||
|
|
||||||
`weatherreporter` does not call day-slice forecast endpoints or discussion
|
|
||||||
subsection endpoints. Report-period selection and daypart summarization happen
|
|
||||||
inside Go after the full hourly and narrative products are fetched.
|
|
||||||
|
|
||||||
## Required And Optional Sources
|
|
||||||
|
|
||||||
Hourly forecast is required:
|
|
||||||
|
|
||||||
- `data: null` for `/forecast/hourly` fails the fetch.
|
|
||||||
- an hourly forecast with no `periods` fails the fetch.
|
|
||||||
- malformed hourly data fails the fetch.
|
|
||||||
|
|
||||||
Other fetched sources are optional and follow `missing_source.default` or a
|
|
||||||
source-specific `missing_source.sources` policy:
|
|
||||||
|
|
||||||
- `observations` for `/observations`
|
|
||||||
- `current` for `/conditions/current`
|
|
||||||
- `narrative` for `/forecast/narrative`
|
|
||||||
- `alerts` for `/alerts/active`
|
|
||||||
- `discussion` for `/discussion`
|
|
||||||
- `weather_story` for `/weatherstories/latest`
|
|
||||||
- `spc_convective_outlooks` for `/outlooks/convective`
|
|
||||||
|
|
||||||
Policy behavior:
|
|
||||||
|
|
||||||
- `error`: fail the fetch for that source
|
|
||||||
- `warn`: omit the source data, add a warning, and continue
|
|
||||||
- `none`: omit the source data and continue without a warning
|
|
||||||
|
|
||||||
For `/alerts/active`, an HTTP error or missing `data` field still fails or
|
|
||||||
follows the relevant error path, but explicit `data: null` is not a
|
|
||||||
missing-source condition.
|
|
||||||
|
|
||||||
For `/outlooks/convective`, a non-null data object with empty outlook and
|
|
||||||
discussion arrays is accepted as checked empty data.
|
|
||||||
|
|
||||||
## Source Identity
|
|
||||||
|
|
||||||
For source payloads accepted into the bundle, including the explicit `null`
|
|
||||||
alerts payload, the adapter records:
|
|
||||||
|
|
||||||
- source name
|
|
||||||
- endpoint path
|
|
||||||
- query parameters sent
|
|
||||||
- fetch time
|
|
||||||
- source issue and update timestamps when present in the payload
|
|
||||||
- SHA-256 hash of the compact raw `data` JSON
|
|
||||||
|
|
||||||
Warnings are recorded both on the affected source and on the bundle-level
|
|
||||||
warnings list.
|
|
||||||
|
|
||||||
## Compatibility Assumptions
|
|
||||||
|
|
||||||
The adapter expects payload fields compatible with the internal weather data
|
|
||||||
bundle types in `internal/weatherdata/bundle.go`, including:
|
|
||||||
|
|
||||||
- observation timestamps and observation values
|
|
||||||
- current condition values
|
|
||||||
- forecast run metadata and `periods`
|
|
||||||
- active alert run data
|
|
||||||
- discussion metadata, key messages, and short/long-term section text
|
|
||||||
- latest weather story title, description, timing, priority, order, alt text,
|
|
||||||
and download URL
|
|
||||||
- SPC convective outlook run metadata, outlooks, discussions, and GeoJSON
|
|
||||||
geometry
|
|
||||||
|
|
||||||
The adapter intentionally keeps upstream transport and envelope details inside
|
|
||||||
`internal/adapters/weatherapi`; downstream packages consume the normalized
|
|
||||||
bundle.
|
|
||||||
|
|||||||
@@ -1,190 +1,27 @@
|
|||||||
# App Orchestration Internals
|
# Application Orchestration Internals
|
||||||
|
|
||||||
This document describes the workflow coordinator in `internal/app`.
|
`internal/app` owns stateless report generation, batch execution, atomic output publication, and notification coordination after `internal/cli` has parsed arguments and loaded configuration. The user contract is owned by the [CLI reference](../cli.md) and [operations guide](../operations.md).
|
||||||
|
|
||||||
## Purpose
|
## Single-Report Flow
|
||||||
|
|
||||||
`internal/app` coordinates the top-level use cases after CLI parsing and config
|
`GenerateDetailed` resolves the requested report and output destination, then initializes an optional explicit debug writer. It validates the exact Promptkit prompt and selected profile before collecting weather data. The resolved profile, backend, and model are carried in the active result.
|
||||||
loading are complete. It resolves report definitions, fetches weather data,
|
|
||||||
builds collected and derived facts, builds module snapshots and prompt-input
|
|
||||||
artifacts, invokes Scriptorium through the adapter boundary, optionally
|
|
||||||
notifies distributor through an app-owned notifier boundary, persists managed
|
|
||||||
state, runs batches, and reads existing artifacts for inspection.
|
|
||||||
|
|
||||||
## Inputs And Outputs
|
The workflow builds facts, a module snapshot, briefing metadata, and the YAML prompt package in memory. It executes Promptkit, validates the returned generated text, builds a render context, and renders Markdown. `fileutil` atomically writes the completed Markdown to the selected output path. Only after that write succeeds does single-report notification run.
|
||||||
|
|
||||||
Inputs:
|
Failures return an active partial result with safe identity, profile, warning, validation, debug, and output information when available. After rendering and immediately before publication, the workflow checks for cancellation or deadline expiry. Any failure before publication leaves an existing destination unchanged. A notification failure retains the newly published output.
|
||||||
|
|
||||||
- `GenerateRequest` for one report command
|
## Batches
|
||||||
- `BatchRequest` for morning or evening batch commands
|
|
||||||
- `FetchBundleRequest` for explicit bundle fetch and save workflows
|
|
||||||
- `ReportRequest` for single-report generation
|
|
||||||
- resolved report definitions from `internal/report`
|
|
||||||
- weather data bundles from `internal/adapters/weatherapi`
|
|
||||||
- prior snapshots loaded from `internal/state`
|
|
||||||
- optional renderer, notifier, and state-store fakes for tests
|
|
||||||
|
|
||||||
Outputs:
|
`RunBatchDetailed` captures one output directory, creates at most one explicit debug writer, and uses one executor. Before collection it validates the prompt and profile candidates for the selected batch. It collects once, calculates the data-dependent plan, then validates and retains the final output path for every planned report before invoking the same generation core sequentially.
|
||||||
|
|
||||||
- generated report results with JSON module snapshot, YAML data package,
|
Each item has an independent result. A failed item does not stop later items; successful items retain their published output paths. Per-report notification is suppressed during a batch. Batch notification runs only after every planned report has published successfully. It is skipped when any item failed. Batch result counters count report items only; a batch notification failure is represented by the top-level notification result and still produces a failed batch outcome.
|
||||||
preflight, report, metadata, prior snapshot, Recent Changes, Scriptorium
|
|
||||||
result details, generated-text artifact paths when applicable, and
|
|
||||||
notification result when attempted
|
|
||||||
- batch summaries with per-report status, artifact paths, error text, and
|
|
||||||
notification outcome when attempted
|
|
||||||
- saved Weather API bundle JSON for fetch workflows
|
|
||||||
- inspection JSON values for reports, metadata, module snapshots, data
|
|
||||||
packages, prior snapshots, and source provenance
|
|
||||||
|
|
||||||
## Boundaries
|
## Boundaries And Verification
|
||||||
|
|
||||||
`internal/app` owns workflow order and request composition. It does not parse
|
The package does not parse flags, load YAML, implement transport, construct provider SDKs, or define report-period policy. Prompt, profile, weather, and Distributor implementations remain behind project-owned contracts.
|
||||||
CLI flags, load YAML files directly, implement HTTP transport, own fact
|
|
||||||
derivation algorithms, define report periods, compare rendered Markdown, or
|
|
||||||
construct Scriptorium argv.
|
|
||||||
|
|
||||||
Report selection and report identity policy come from `internal/report`.
|
Focused checks:
|
||||||
Collected and derived fact contracts come from `internal/facts`.
|
|
||||||
Weather API transport stays in `internal/adapters/weatherapi`. Scriptorium
|
|
||||||
subprocess behavior stays in `internal/adapters/scriptorium`. Distributor
|
|
||||||
upload behavior stays in `internal/adapters/distributor`. Filesystem layout and
|
|
||||||
persisted metadata stay in `internal/state`.
|
|
||||||
|
|
||||||
## Data Flow Terms
|
```sh
|
||||||
|
go test ./internal/app ./internal/collect
|
||||||
- `CollectedFacts` are normalized source facts fetched once from Weather API
|
```
|
||||||
and made available to derivation and module builders.
|
|
||||||
- `DerivedFacts` are deterministic calculations over collected facts, the
|
|
||||||
resolved valid period, daypart configuration, and report-specific windows.
|
|
||||||
- `module.Output` values are ordered deterministic stanzas built from collected
|
|
||||||
and derived facts for prompt input and inspection.
|
|
||||||
- `GeneratedText` is structured prose returned by Scriptorium for
|
|
||||||
generated-text-template reports and validated by `internal/generatedtext`.
|
|
||||||
- `RenderContext` is the typed template input built from report metadata,
|
|
||||||
module outputs, and validated generated text before Markdown rendering.
|
|
||||||
|
|
||||||
## Config Fields Used
|
|
||||||
|
|
||||||
- `weather_api.*` for Weather API client construction and module metadata
|
|
||||||
- `scriptorium.*` for renderer construction
|
|
||||||
- `workspace.*` for filesystem state
|
|
||||||
- `dayparts` for daily and outlook summarization
|
|
||||||
- `recent_change.*` for structured Recent Changes thresholds
|
|
||||||
- `notify.distributor.*` for optional notification after report generation
|
|
||||||
|
|
||||||
Output copy flags are command request fields. They are not configuration
|
|
||||||
defaults.
|
|
||||||
|
|
||||||
## Generation Workflow
|
|
||||||
|
|
||||||
Single-report generation shares this setup:
|
|
||||||
|
|
||||||
1. Resolve the command report to a `report.Resolved` value.
|
|
||||||
2. Create or use a filesystem store.
|
|
||||||
3. Locate any prior compatible snapshot through `internal/state`.
|
|
||||||
4. Fetch a Weather API bundle.
|
|
||||||
5. Build collected and derived facts once.
|
|
||||||
6. Execute configured modules and save the module snapshot.
|
|
||||||
7. Compute Recent Changes from structured prior and current module snapshots.
|
|
||||||
8. Build and save the YAML Scriptorium `data_package`.
|
|
||||||
9. Run Scriptorium render preflight.
|
|
||||||
10. Save preflight JSON when a render result is available.
|
|
||||||
11. Save metadata for inspection.
|
|
||||||
|
|
||||||
For `scriptorium_markdown` reports, generation then:
|
|
||||||
|
|
||||||
12. Runs Scriptorium report generation to the managed report path.
|
|
||||||
|
|
||||||
For `generated_text_template` reports, generation then:
|
|
||||||
|
|
||||||
12. Looks up the generated-text catalog entry for the report schema/template
|
|
||||||
IDs.
|
|
||||||
13. Runs structured Scriptorium generation to the raw generated-text JSON path.
|
|
||||||
14. Saves the structured Scriptorium run result.
|
|
||||||
15. Validates and saves normalized generated text.
|
|
||||||
16. Builds and saves a typed render context.
|
|
||||||
17. Renders Markdown from the embedded template to the managed report path.
|
|
||||||
|
|
||||||
After either mode has produced a managed Markdown report, shared finalization:
|
|
||||||
|
|
||||||
1. Copies the managed report to the requested `--out` or `--out-dir` path when
|
|
||||||
provided.
|
|
||||||
2. Saves final metadata with the managed report path and any generated-text
|
|
||||||
artifact paths already produced.
|
|
||||||
3. If distributor notification is enabled, notifies using the managed report
|
|
||||||
path as the source file.
|
|
||||||
4. Saves a distributor notification debug artifact and updates metadata with
|
|
||||||
its path.
|
|
||||||
|
|
||||||
If render preflight returns both a result and an error, preflight JSON and
|
|
||||||
metadata are persisted before the error is returned. If Scriptorium report
|
|
||||||
generation returns an error after writing output, the managed report and
|
|
||||||
metadata remain inspectable. Notification is not attempted after Weather API,
|
|
||||||
module snapshot, prompt input, render, Scriptorium run, or metadata-save
|
|
||||||
failures.
|
|
||||||
Generated-text report failures are returned with report ID, RunID, and the
|
|
||||||
failed operation. When available, the app preserves the latest generated-text
|
|
||||||
artifacts already reached by the workflow: preflight output, structured run
|
|
||||||
result, raw generated text, validated generated text, and render context.
|
|
||||||
When notification is attempted, the debug artifact records request identity,
|
|
||||||
including rendered pipeline ID, bundle paths, accepted upload fields,
|
|
||||||
distributor status fields, raw status report JSON when available, and redacted
|
|
||||||
failure context.
|
|
||||||
`--out` copies are never used as notification source files.
|
|
||||||
|
|
||||||
## Batch Workflow
|
|
||||||
|
|
||||||
`run morning` resolves Today Report, 3-Day Outlook, and Weekend Outlook except
|
|
||||||
on Sunday. `run evening` resolves Tomorrow Report. Daily Report is generated
|
|
||||||
only through `generate daily --date YYYY-MM-DD`; it is not part of scheduled
|
|
||||||
batches. Batch output copy names come from report definitions. Batch generation
|
|
||||||
continues independent reports after a failure, records each result, writes
|
|
||||||
compact status lines to stderr, emits a JSON summary to stdout, and returns an
|
|
||||||
aggregate error when any report failed. When notification is enabled, each
|
|
||||||
successfully generated report is notified independently. Notification failure
|
|
||||||
marks that report failed, records notification fields in the batch result, and
|
|
||||||
does not stop later reports. `--out-dir` copies are never used as notification
|
|
||||||
source files.
|
|
||||||
|
|
||||||
## Inspection Workflow
|
|
||||||
|
|
||||||
Inspection workflows load existing filesystem state only. They do not fetch
|
|
||||||
weather data or invoke Scriptorium. Run-specific inspect commands share the same
|
|
||||||
store and metadata lookup path, then load the requested artifact or derived
|
|
||||||
inspection view.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
- Resolve errors stop the requested workflow before fetching weather data.
|
|
||||||
- Weather API and module execution errors stop that report before Scriptorium
|
|
||||||
runs.
|
|
||||||
- Prompt input validation fails before render preflight.
|
|
||||||
- Render and run errors preserve Scriptorium stderr and exit-code context.
|
|
||||||
- Generated-text report errors preserve available intermediate artifacts and do
|
|
||||||
not create extra output copies.
|
|
||||||
- Notification errors are wrapped with report ID, RunID, and managed report path
|
|
||||||
context and are recorded separately in batch results.
|
|
||||||
- Metadata and artifact path errors include filesystem context.
|
|
||||||
- Batch failures are recorded per report and surfaced through an aggregate
|
|
||||||
batch error.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Inspect:
|
|
||||||
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
- `internal/cli/root_test.go`
|
|
||||||
- `internal/state/filesystem_test.go`
|
|
||||||
|
|
||||||
## Invariants
|
|
||||||
|
|
||||||
- Report behavior is resolved through `internal/report`.
|
|
||||||
- Generated reports use the same app request and result types regardless of
|
|
||||||
report ID.
|
|
||||||
- Render preflight precedes Scriptorium report generation.
|
|
||||||
- Generated-text reports render Markdown from a curated render context, not from
|
|
||||||
a raw data package.
|
|
||||||
- Recent Changes are computed from structured module snapshots.
|
|
||||||
- Metadata links artifacts produced for a run.
|
|
||||||
- Distributor notification maps the managed Markdown report path to configured
|
|
||||||
bundle paths; extra output copies are not upload sources.
|
|
||||||
|
|||||||
@@ -1,158 +1,69 @@
|
|||||||
# Module Builder Internals
|
# Module Builder Internals
|
||||||
|
|
||||||
This document describes module builder behavior in `internal/briefing`.
|
`internal/briefing` builds typed module outputs from resolved report context,
|
||||||
|
collected facts, and derived facts. It owns the module registry, including
|
||||||
|
module support, fact requirements, option types, missing-data policy, builders,
|
||||||
|
and prompt-export hooks. It does not collect data, derive periods, write a
|
||||||
|
snapshot, construct YAML, invoke Promptkit, or render a report.
|
||||||
|
|
||||||
## Purpose
|
## Registry and construction
|
||||||
|
|
||||||
`internal/briefing` turns report metadata, collected weather data, and derived
|
Every `ModuleDefinition` declares an ID, stanza name, default option value,
|
||||||
forecast facts into prompt-facing module outputs. The package also owns the
|
required collected and derived facts, supported report IDs, missing-data
|
||||||
module registry used to validate report composition and config overrides.
|
behavior, duplicate policy, builder, and optional prompt exporter.
|
||||||
|
|
||||||
Module outputs are structured prompt inputs. They are not rendered report prose
|
`BuildModule` first verifies the requested module, report compatibility, and
|
||||||
and they are not persisted by this package.
|
option shape. It then applies the declared missing-data behavior:
|
||||||
|
|
||||||
## Inputs And Outputs
|
- `omit` returns no output for unavailable optional facts;
|
||||||
|
- `error` returns the missing fact requirements; and
|
||||||
|
- `empty` allows the builder to emit an explicit checked-empty value.
|
||||||
|
|
||||||
Inputs:
|
Unsupported `warn` behavior, missing builders, duplicate registry IDs or
|
||||||
|
stanza names, output ID or stanza mismatches, and exporter failures all return
|
||||||
|
errors with module context. A successful builder gets a pass-through prompt
|
||||||
|
value unless its definition supplies an exporter.
|
||||||
|
|
||||||
- resolved report definition, generation time, timezone, and valid period
|
## Built value families
|
||||||
- collected facts built from `weatherdata.Bundle`
|
|
||||||
- derived daily, daypart, precipitation, alert, and storm-window facts where
|
|
||||||
required
|
|
||||||
- configured units, timezone, and descriptive location context
|
|
||||||
- typed module options from report defaults or config overrides
|
|
||||||
|
|
||||||
Outputs:
|
Source-oriented builders shape report metadata, current conditions, narrative
|
||||||
|
and hourly forecasts, alert digest, SPC outlooks and discussion, area forecast
|
||||||
|
discussion, and weather story. Derived builders shape daily and daypart
|
||||||
|
summaries, precipitation timing, outdoor windows, and the report-specific
|
||||||
|
Daily, Today, and Tomorrow planning values.
|
||||||
|
|
||||||
- `ModuleDefinition` values with module ID, stanza name, option type,
|
The module registry preserves rich values for templates and snapshots while
|
||||||
supported reports, fact requirements, missing-data behavior, and builder
|
curating prompt exports where needed. In particular, source warnings are a
|
||||||
- `module.Output` values for source-oriented stanzas:
|
metadata summary, checked-empty alerts and SPC outlooks remain distinct from
|
||||||
`metadata`, `current_conditions`, `narrative_forecast`, `hourly_forecast`,
|
missing sources, and prompt-safe SPC values omit geometry and other
|
||||||
`alert_digest`, `spc_convective_outlooks`,
|
template-only or source details. The complete module composition is in
|
||||||
`area_forecast_discussion`, `spc_convective_discussion`, and
|
[module internals](module.md); fact derivation is in [fact contracts](facts.md).
|
||||||
`weather_story`
|
|
||||||
- `module.Output` values for derived stanzas:
|
|
||||||
`derived_daily_summary`, `derived_daypart_summaries`, `precip_timing`,
|
|
||||||
`outdoor_windows`, `today_planning`, `tomorrow_planning`, and
|
|
||||||
`daily_planning`
|
|
||||||
|
|
||||||
Every registered composition entry has a builder. Unknown or unimplemented
|
`area_forecast_discussion` accepts an optional typed section filter. Planning
|
||||||
module IDs fail validation instead of being skipped.
|
modules are report-specific: `daily_planning` supports Daily,
|
||||||
|
`today_planning` supports Today, and `tomorrow_planning` supports Tomorrow.
|
||||||
|
|
||||||
Daily Report supports the Daily-style civil-day modules plus `daily_planning`
|
## Missing data and boundaries
|
||||||
and `hourly_forecast`; those outputs feed the dated Daily GeneratedText prompt
|
|
||||||
package and embedded Markdown template.
|
|
||||||
|
|
||||||
Tomorrow Report supports the Daily-style civil-day modules plus
|
Optional current conditions, narrative products, discussions, and weather
|
||||||
`tomorrow_planning` and `hourly_forecast`; those outputs feed the Tomorrow
|
stories may be omitted. Required derived modules fail when their declared facts
|
||||||
GeneratedText prompt package and embedded Markdown template.
|
are unavailable. Empty alert and outlook runs can still produce checked-empty
|
||||||
|
modules. SPC discussion is omitted unless a retained categorical outlook meets
|
||||||
|
the package's severity criterion and matching discussion text exists.
|
||||||
|
|
||||||
Today Report supports the Daily-style civil-day modules plus `today_planning`
|
Effective units, timezone, and location context arrive in `ModuleContext` from
|
||||||
and `hourly_forecast`; those outputs feed the Today GeneratedText prompt
|
configuration and resolved report metadata. Field defaults are owned by
|
||||||
package and embedded Markdown template.
|
[configuration](../config.md), and prompt-package layout is owned by
|
||||||
|
[prompt input](prompt-input.md).
|
||||||
|
|
||||||
`today_planning` is a Today-specific deterministic planning stanza with
|
## Verification and invariants
|
||||||
morning readiness, commute/school/workday concerns, outdoor planning, and
|
|
||||||
late-day change-watch fields. It is compatible with `report.Today` only.
|
|
||||||
|
|
||||||
`daily_planning` is a dated Daily deterministic planning stanza with morning
|
Focused tests cover source and derived values, registry validation, option
|
||||||
readiness, commute/school/workday concerns, and overnight change-watch fields.
|
handling, prompt exporters, support rules, and missing-data behavior:
|
||||||
It is compatible only with the `daily` report ID value. The default Daily
|
|
||||||
Report composition includes it.
|
|
||||||
|
|
||||||
Hourly Report supports source and valid-period modules that operate over its
|
```sh
|
||||||
rolling six-hour period: `metadata`, `current_conditions`, `hourly_forecast`,
|
go test ./internal/briefing
|
||||||
`precip_timing`, `alert_digest`, `spc_convective_outlooks`,
|
```
|
||||||
`area_forecast_discussion`, `spc_convective_discussion`, and `weather_story`.
|
|
||||||
It does not support daily/daypart-only modules such as
|
|
||||||
`derived_daily_summary`, `derived_daypart_summaries`, `outdoor_windows`,
|
|
||||||
`today_planning`, `tomorrow_planning`, or `daily_planning`.
|
|
||||||
|
|
||||||
Prompt-facing module values use local, human-readable date and time labels
|
Builders emit structured facts, never report prose. The app collects their
|
||||||
where the LLM is expected to reason about report content. Canonical timestamps
|
outputs into an in-memory module snapshot for prompt input and rendering.
|
||||||
remain in report metadata, source provenance, and integration artifacts.
|
|
||||||
|
|
||||||
## Boundaries
|
|
||||||
|
|
||||||
- This package selects and shapes already-collected weather facts for prompts.
|
|
||||||
- It validates module composition against report compatibility and option
|
|
||||||
types.
|
|
||||||
- It does not fetch weather data, compare prior snapshots, write module
|
|
||||||
snapshots, build YAML data packages, invoke Scriptorium, or write workflow
|
|
||||||
metadata.
|
|
||||||
|
|
||||||
## Config Fields Used
|
|
||||||
|
|
||||||
The app layer passes effective units, timezone, and location context into the
|
|
||||||
module context. `internal/facts` consumes daypart configuration before module
|
|
||||||
builders run. Configured `location` values are prompt context only; Weather API
|
|
||||||
`sourceLocationId` and `sourceLocation` remain source provenance.
|
|
||||||
|
|
||||||
`area_forecast_discussion` uses optional `sections` configuration to include a
|
|
||||||
subset of discussion fields. Hourly Report defaults this module to
|
|
||||||
`key_messages` and `short_term`.
|
|
||||||
|
|
||||||
`spc_convective_outlooks` uses collected SPC run metadata and derived
|
|
||||||
report-period outlooks. It emits `checked: true` for a successfully fetched
|
|
||||||
empty run, reports `outlook_count`, and includes prompt-facing outlook fields
|
|
||||||
such as risk label, `period_begins`, `period_ends`, image URL, and whether the
|
|
||||||
outlook contains the configured location. It does not emit GeoJSON geometry,
|
|
||||||
source URL, expiration time, or severity rank.
|
|
||||||
|
|
||||||
Prompt-facing module intervals use friendly local `period_begins` and
|
|
||||||
`period_ends` labels. Canonical report metadata, source provenance,
|
|
||||||
`issued_at`, `updated_at`, and point-in-time fields remain separate.
|
|
||||||
|
|
||||||
`spc_convective_discussion` uses the same derived report-period outlooks and
|
|
||||||
discussion records. It is omitted unless at least one retained categorical
|
|
||||||
outlook for the same SPC day has severity rank `3` or higher and matching
|
|
||||||
discussion text exists.
|
|
||||||
|
|
||||||
## External Adapters Used
|
|
||||||
|
|
||||||
None directly.
|
|
||||||
|
|
||||||
## State Or Manifest Behavior
|
|
||||||
|
|
||||||
None. `internal/app` collects module outputs into a `module.Snapshot`, and
|
|
||||||
`internal/state` persists that snapshot.
|
|
||||||
|
|
||||||
## Skip And Resume Behavior
|
|
||||||
|
|
||||||
None. Builders either emit a module output, omit optional unavailable data, or
|
|
||||||
return an error for invalid required inputs.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
- Required derived modules return errors when their dependent facts are not
|
|
||||||
available.
|
|
||||||
- Module registry construction rejects duplicate module IDs and duplicate
|
|
||||||
stanza names.
|
|
||||||
- Composition validation rejects unknown modules, duplicate modules,
|
|
||||||
incompatible report/module combinations, duplicate stanza names, and invalid
|
|
||||||
option shapes.
|
|
||||||
- Source-oriented module builders omit missing optional current conditions,
|
|
||||||
forecast discussion, and weather story stanzas.
|
|
||||||
- Alert digest output distinguishes checked empty alert data from missing alert
|
|
||||||
source data.
|
|
||||||
- SPC convective outlook output distinguishes checked empty outlook data from
|
|
||||||
missing outlook source data and omits GeoJSON geometry from prompt-facing
|
|
||||||
fields.
|
|
||||||
- SPC convective discussion output is omitted unless a retained outlook has
|
|
||||||
severity rank `3` or higher and matching discussion text is available.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Inspect:
|
|
||||||
|
|
||||||
- `internal/briefing/base_modules_test.go`
|
|
||||||
- `internal/briefing/derived_modules_test.go`
|
|
||||||
- `internal/briefing/modules_test.go`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
|
|
||||||
## Invariants
|
|
||||||
|
|
||||||
- Module outputs contain structured weather facts and source context.
|
|
||||||
- Common metadata includes RunID, report ID, prompt ID, valid period, source
|
|
||||||
provenance, source hashes, source warnings, and configured prompt location.
|
|
||||||
- Prompt input packaging and Scriptorium execution remain outside this package.
|
|
||||||
|
|||||||
@@ -1,75 +0,0 @@
|
|||||||
# Changes Internals
|
|
||||||
|
|
||||||
This document describes structured Recent Changes comparison.
|
|
||||||
|
|
||||||
## Purpose
|
|
||||||
|
|
||||||
`internal/changes` compares current and prior module snapshots and emits
|
|
||||||
compact change records for prompt input data packages.
|
|
||||||
|
|
||||||
## Inputs And Outputs
|
|
||||||
|
|
||||||
Inputs:
|
|
||||||
|
|
||||||
- prior module snapshot
|
|
||||||
- current module snapshot
|
|
||||||
- comparison thresholds from configuration
|
|
||||||
|
|
||||||
Outputs:
|
|
||||||
|
|
||||||
- ordered `changes.Change` items with type, message, previous value, and current
|
|
||||||
value where useful
|
|
||||||
|
|
||||||
## Boundaries
|
|
||||||
|
|
||||||
- This package compares structured module snapshot data only.
|
|
||||||
- It does not read filesystem state, find prior snapshots, render Markdown,
|
|
||||||
invoke Scriptorium, or compare generated report text.
|
|
||||||
|
|
||||||
## Config Fields Used
|
|
||||||
|
|
||||||
The app maps these fields into comparison thresholds:
|
|
||||||
|
|
||||||
- `recent_change.temperature_degrees`
|
|
||||||
- `recent_change.precip_probability_points`
|
|
||||||
- `recent_change.wind_gust_miles_per_hour`
|
|
||||||
- `recent_change.precip_timing_shift_minutes`
|
|
||||||
|
|
||||||
## External Adapters Used
|
|
||||||
|
|
||||||
None.
|
|
||||||
|
|
||||||
## State Or Manifest Behavior
|
|
||||||
|
|
||||||
None directly. The app loads prior module snapshots through `internal/state`
|
|
||||||
before calling comparison functions.
|
|
||||||
|
|
||||||
## Skip And Resume Behavior
|
|
||||||
|
|
||||||
No resume behavior. When the app has no prior comparable snapshot, it sends an
|
|
||||||
empty Recent Changes list without calling a comparison function.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
- Daily comparison requires `derived_daily_summary` and
|
|
||||||
`derived_daypart_summaries` stanzas. It also uses `alert_digest` and
|
|
||||||
`precip_timing` when present.
|
|
||||||
- 3-Day comparison requires `derived_daypart_summaries`.
|
|
||||||
- Weekend comparison requires `derived_daypart_summaries`.
|
|
||||||
- Storm Report comparison returns no changes.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Inspect:
|
|
||||||
|
|
||||||
- `internal/changes/daily_test.go`
|
|
||||||
- `internal/changes/three_day_test.go`
|
|
||||||
- `internal/changes/weekend_test.go`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
|
|
||||||
## Invariants
|
|
||||||
|
|
||||||
- Recent Changes are based on structured snapshots, not Markdown report text.
|
|
||||||
- Report compatibility is determined outside this package by report definitions
|
|
||||||
and state lookup.
|
|
||||||
- Output stays compact enough for prompt input.
|
|
||||||
15
docs/internal/cli.md
Normal file
15
docs/internal/cli.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# CLI Internals
|
||||||
|
|
||||||
|
`internal/cli` parses terminal arguments, loads configuration, constructs app requests, and translates app results to bounded JSON summaries. The public contract belongs in the [CLI reference](../cli.md).
|
||||||
|
|
||||||
|
The root `--version` flag reports the build version supplied by `internal/buildinfo`. Tagged release builds replace its development default at link time.
|
||||||
|
|
||||||
|
For each `generate` or `run` action, `Runner` constructs one project-owned Promptkit executor after configuration loads. It captures an absolute working directory, resolves a relative output override against it, and passes the working directory, resolved override, and any `--llm-debug-dir` request to the app. With no override, the app derives the report filename in that working directory. `run` uses the same resolution rule for `--out-dir`.
|
||||||
|
|
||||||
|
The CLI dispatches only generation and batch actions. It has no persisted-run or inspection dispatch. Summaries include report identity, status, output path, effective profile/backend/model, source warnings, validation, requested debug path, and notification result when available. They intentionally exclude prompt input, raw generated text, render context, endpoints, credentials, and full Distributor payloads. A failed action with a partial result still emits its safe summary before its error is returned.
|
||||||
|
|
||||||
|
CLI code owns no report policy, weather collection, output publication, provider execution, or notification policy. Focused checks:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go test ./internal/cli
|
||||||
|
```
|
||||||
43
docs/internal/collect.md
Normal file
43
docs/internal/collect.md
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
# Collection Internals
|
||||||
|
|
||||||
|
`internal/collect` is the application-facing boundary for collecting the
|
||||||
|
normalized Weather API bundle. The external HTTP contract belongs in the
|
||||||
|
[Weather API integration guide](../integrations/weatherapi.md); normalized data
|
||||||
|
semantics belong in [weather-data internals](weather-data.md).
|
||||||
|
|
||||||
|
## Contract
|
||||||
|
|
||||||
|
`Run` accepts a `context.Context` and a `Request` containing effective
|
||||||
|
`config.Config`. It constructs the Weather API adapter from that configuration,
|
||||||
|
calls `FetchBundle`, and returns `Result{Bundle: *weatherdata.Bundle}`.
|
||||||
|
|
||||||
|
The package wraps adapter construction failures as weather-collection setup
|
||||||
|
errors and fetch failures as bundle-collection errors. It does not retry,
|
||||||
|
persist, select reports, derive facts, build modules, invoke Promptkit, or
|
||||||
|
notify Distributor.
|
||||||
|
|
||||||
|
## Application Composition
|
||||||
|
|
||||||
|
`internal/app` owns the narrow `Collector` interface used by workflow tests;
|
||||||
|
the production implementation delegates to `collect.Run`. Generation, batch
|
||||||
|
execution, and explicit bundle fetching all use this boundary. Application
|
||||||
|
orchestration rejects a nil collector result or a nil bundle before report work
|
||||||
|
can continue.
|
||||||
|
|
||||||
|
Single-report generation and a batch each collect once. A batch passes the same
|
||||||
|
normalized collection to planning and to every report it generates. Collection
|
||||||
|
failure prevents later workflow work for that request.
|
||||||
|
|
||||||
|
## Boundaries And Invariants
|
||||||
|
|
||||||
|
Collection owns adapter creation and retrieval of one normalized bundle. It
|
||||||
|
must not make report, period, batch, prompt, module, filesystem, or notification
|
||||||
|
decisions.
|
||||||
|
|
||||||
|
- App-facing Weather API collection always passes through this package.
|
||||||
|
- The returned value is normalized source data, not facts or prompt input.
|
||||||
|
- Context cancellation is passed to the Weather API adapter.
|
||||||
|
- Errors retain whether setup or fetching failed.
|
||||||
|
|
||||||
|
Focused tests are in `internal/collect/collect_test.go`; orchestration use is
|
||||||
|
also covered by `internal/app/app_test.go`.
|
||||||
@@ -1,123 +1,63 @@
|
|||||||
# Distributor Adapter Internals
|
# Distributor Adapter Internals
|
||||||
|
|
||||||
This document describes the distributor upload adapter in
|
`internal/adapters/distributor` translates a local delivery request into the
|
||||||
`internal/adapters/distributor`.
|
Distributor Go client's upload and status calls, then returns a local delivery
|
||||||
|
result. The external API, authentication, and idempotency contract is owned by
|
||||||
|
the [Distributor API guide](../integrations/distributor/api.md) and
|
||||||
|
[Distributor bundle guide](../integrations/distributor/pkg-bundle.md).
|
||||||
|
|
||||||
## Purpose
|
## Client construction
|
||||||
|
|
||||||
The adapter submits generated weatherreporter Markdown reports to a configured
|
`Client` holds the endpoint, the name of the environment variable containing
|
||||||
distributor HTTP upload endpoint. It isolates distributor package types,
|
the token, an optional timeout, and an injectable upstream-client factory.
|
||||||
token-env lookup, upload client construction, source-bundle file mapping,
|
`New` validates its configuration before creating the adapter. For each upload,
|
||||||
timeout handling, status polling, and upload error wrapping from app
|
the adapter reads the token from the configured environment variable and builds
|
||||||
orchestration.
|
the upstream client with that endpoint, token, and an HTTP client whose timeout
|
||||||
|
matches the local positive timeout.
|
||||||
|
|
||||||
## Inputs And Outputs
|
The upstream client is an implementation dependency, not a source of
|
||||||
|
application configuration: retry ownership, pipeline selection, path
|
||||||
|
templates, and report rendering are defined by
|
||||||
|
[configuration](../config.md) and [application orchestration](app-orchestration.md).
|
||||||
|
|
||||||
Inputs:
|
## Upload translation
|
||||||
|
|
||||||
- distributor endpoint URL
|
Before calling the dependency, `Upload` validates the endpoint and token
|
||||||
- token environment variable name
|
configuration plus the local pipeline ID, bundle ID, idempotency key, and every
|
||||||
- upload timeout
|
file's source and bundle paths. It maps the request as follows:
|
||||||
- pipeline ID
|
|
||||||
- bundle ID
|
|
||||||
- idempotency key
|
|
||||||
- source Markdown report path and bundle-relative path mappings
|
|
||||||
- bundle created timestamp
|
|
||||||
- context for cancellation
|
|
||||||
|
|
||||||
Outputs:
|
| Local request | Distributor client value |
|
||||||
|
| --- | --- |
|
||||||
|
| Pipeline ID | Upload pipeline identifier |
|
||||||
|
| Bundle ID | Bundle identifier |
|
||||||
|
| Idempotency key | Upload idempotency key |
|
||||||
|
| File source and bundle paths | Bundle file entries |
|
||||||
|
| Creation timestamp | Bundle creation time |
|
||||||
|
|
||||||
- accepted distributor run ID
|
The call inherits the caller's context and applies the configured positive
|
||||||
- accepted distributor upload status
|
timeout. The adapter does not read report files, construct bundle layouts, or
|
||||||
- distributor run status, status polling error, and raw run report JSON when available
|
persist notification artifacts.
|
||||||
- weatherreporter-owned idempotency conflict error when applicable
|
|
||||||
|
|
||||||
## Boundaries
|
## Status and errors
|
||||||
|
|
||||||
`internal/adapters/distributor` is the only weatherreporter package that imports
|
An accepted upload is followed by one status request. When a timeout is
|
||||||
`gitea.maximumdirect.net/eric/distributor/pkg/upload` or
|
configured, a nonterminal result is polled until `succeeded` or `failed`, or
|
||||||
`gitea.maximumdirect.net/eric/distributor/pkg/bundle`.
|
until the context ends. The translated `UploadResult` contains the run ID,
|
||||||
|
status, and `RunStatus`, including pipeline ID, lifecycle timestamps, report,
|
||||||
|
and remote error details.
|
||||||
|
|
||||||
The app layer passes weatherreporter-owned request values to the adapter. The
|
Status lookup or polling errors are preserved in `UploadResult.StatusError` so
|
||||||
adapter does not choose report types, render templates, select output copies,
|
the caller can report an accepted-but-unconfirmed delivery. A terminal failed
|
||||||
configure destinations, wait for downstream publication, transform Markdown, or
|
run returns that result and an error. Upload failures return no result. Upstream
|
||||||
persist notification state.
|
idempotency conflicts become the local `IdempotencyConflictError`, which adds
|
||||||
|
endpoint, pipeline, bundle, idempotency, and file-path context while redacting
|
||||||
|
the token.
|
||||||
|
|
||||||
Full upstream distributor package and HTTP contract details stay under
|
## Verification
|
||||||
`docs/integrations/distributor/`.
|
|
||||||
|
|
||||||
## Config Fields Used
|
Focused tests cover configuration validation, request mapping, timeouts and
|
||||||
|
polling, status translation, conflict handling, and token redaction:
|
||||||
|
|
||||||
The adapter is built from `notify.distributor` config:
|
```sh
|
||||||
|
go test ./internal/adapters/distributor
|
||||||
- `endpoint`
|
```
|
||||||
- `token_env`
|
|
||||||
- `timeout`
|
|
||||||
|
|
||||||
The app layer renders pipeline ID, bundle ID, idempotency key, and bundle paths
|
|
||||||
from:
|
|
||||||
|
|
||||||
- `pipeline_id_template`
|
|
||||||
- `bundle_id_template`
|
|
||||||
- `idempotency_key_template`
|
|
||||||
- `report_path_templates`
|
|
||||||
|
|
||||||
The token value is read from the environment variable named by `token_env`
|
|
||||||
after config loading and `secrets.directory` processing.
|
|
||||||
|
|
||||||
## Upload Behavior
|
|
||||||
|
|
||||||
The adapter calls distributor `UploadFiles` with one or more file mappings:
|
|
||||||
|
|
||||||
- pipeline ID: the rendered distributor workflow selector
|
|
||||||
- source path: the managed Markdown report path selected by app orchestration
|
|
||||||
- bundle paths: rendered bundle-relative report paths
|
|
||||||
- created: the report generation timestamp
|
|
||||||
|
|
||||||
The adapter creates a distributor upload client with the configured endpoint,
|
|
||||||
bearer token, and timeout-backed HTTP client. It also wraps the upload context
|
|
||||||
with the configured timeout when the timeout is greater than zero.
|
|
||||||
|
|
||||||
After upload acceptance, the adapter polls distributor `Status` for the accepted
|
|
||||||
run ID until the run reaches `succeeded` or `failed`, or until the configured
|
|
||||||
timeout expires. It returns the latest status, error text, and raw report JSON in
|
|
||||||
weatherreporter-owned types so app orchestration can persist them in the
|
|
||||||
notification debug artifact. Status lookup failures or timeout before a terminal
|
|
||||||
state are kept as debug status errors on an otherwise accepted upload. A
|
|
||||||
terminal distributor run status of `failed` is returned as a notification failure
|
|
||||||
with the status report preserved.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
The adapter validates required endpoint, token env name, token value, pipeline
|
|
||||||
ID, bundle ID, idempotency key, upload files, source paths, bundle paths, and
|
|
||||||
upload client inputs before uploading.
|
|
||||||
|
|
||||||
Upload failures include endpoint, pipeline ID, bundle ID, idempotency key,
|
|
||||||
source paths, and bundle paths context. Token values are redacted from adapter
|
|
||||||
errors.
|
|
||||||
|
|
||||||
Distributor idempotency conflicts are exposed as a weatherreporter-owned
|
|
||||||
`IdempotencyConflictError`, so callers do not depend on upstream distributor
|
|
||||||
types.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Inspect:
|
|
||||||
|
|
||||||
- `internal/adapters/distributor/client_test.go`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
- `internal/cli/root_test.go`
|
|
||||||
|
|
||||||
Adapter tests use a fake upload client factory and do not require a live
|
|
||||||
distributor service.
|
|
||||||
|
|
||||||
## Invariants
|
|
||||||
|
|
||||||
- Distributor package types do not leak outside the adapter.
|
|
||||||
- Only the managed Markdown report is uploaded.
|
|
||||||
- The adapter never scans the workspace.
|
|
||||||
- Token values are not included in errors, CLI output, metadata, docs, or
|
|
||||||
examples.
|
|
||||||
- Destination routing and Markdown-to-HTML transformation belong to
|
|
||||||
distributor, not weatherreporter.
|
|
||||||
|
|||||||
@@ -1,94 +1,64 @@
|
|||||||
# Fact Contracts Internals
|
# Fact Contracts Internals
|
||||||
|
|
||||||
This document describes the fact contract boundary.
|
`internal/facts` is the deterministic boundary between a collected weather
|
||||||
|
bundle and report-scoped facts. It preserves normalized source values and then
|
||||||
|
selects and summarizes the values needed for one resolved report. Provider
|
||||||
|
transport and normalized bundle semantics belong to
|
||||||
|
[weather-data internals](weather-data.md); report identity and valid-period
|
||||||
|
selection belong to [report registry internals](report-registry.md).
|
||||||
|
|
||||||
## Purpose
|
## Collected facts
|
||||||
|
|
||||||
`internal/facts` separates normalized upstream facts collected for a report run
|
`BuildCollected` projects a `weatherdata.Bundle` into `CollectedFacts`. It
|
||||||
from conservative report-scoped facts derived from them. The package gives app
|
retains the fetched timestamp and every normalized product: observations,
|
||||||
orchestration one place to build reusable facts before module execution.
|
current conditions, hourly, narrative, alerts, discussion, daily, weather
|
||||||
|
story, and convective outlook data. Source provenance and warnings are copied
|
||||||
|
into their own slices so downstream consumers can inspect data completeness
|
||||||
|
without treating it as an ordinary weather fact.
|
||||||
|
|
||||||
## Inputs And Outputs
|
A nil bundle produces an empty collected value. Collection itself, missing
|
||||||
|
source policy, and source hashes are outside this package.
|
||||||
|
|
||||||
Inputs:
|
## Report-scoped derivation
|
||||||
|
|
||||||
- `weatherdata.Bundle` from the Weather API adapter
|
`BuildDerived` requires a valid resolved period and a valid report timezone. It
|
||||||
- resolved report definition and valid period
|
uses half-open period overlap to select hourly, narrative, daily, and alert
|
||||||
- report timezone
|
data; it also derives precipitation timing. Convective outlooks are retained
|
||||||
- configured daypart definitions
|
only when their valid interval overlaps the report period, with discussions
|
||||||
|
kept for represented outlook days. Both collections are sorted deterministically.
|
||||||
|
|
||||||
Outputs:
|
Report identity controls the summary shape:
|
||||||
|
|
||||||
- `facts.CollectedFacts` with normalized source facts plus separate source
|
| Report family | Derived summary |
|
||||||
provenance and warnings. SPC convective outlook source data is carried
|
| --- | --- |
|
||||||
through when present in the bundle, including upstream geometry and source
|
| Hourly | Rolling-period selections and precipitation timing; no daily or daypart summary |
|
||||||
provenance.
|
| Daily, Today, Tomorrow | One local civil-day summary and its dayparts |
|
||||||
- `facts.DerivedFacts` with valid-period forecast slices, alert overlaps,
|
|
||||||
report-period SPC convective outlooks and discussions, daily summaries,
|
|
||||||
daypart summaries, and Storm Report window summary
|
|
||||||
|
|
||||||
Hourly Report uses the generic valid-period hourly and narrative selection
|
`DaypartSummaries` is collected from the resulting daily summaries.
|
||||||
for its rolling six-hour window. Its derived facts include precipitation timing
|
The detailed grouping, daypart-window, and alert rules are owned by
|
||||||
from the selected hourly periods, alert overlaps for the six-hour period, and
|
[forecast derivation](forecast-derivation.md).
|
||||||
SPC outlooks/discussions overlapping that period. It does not build daily
|
|
||||||
summaries, daypart summaries, or a storm-window summary.
|
|
||||||
|
|
||||||
## Boundaries
|
## Missing data and failures
|
||||||
|
|
||||||
- This package owns fact assembly and reusable deterministic derivation for a
|
Optional normalized products remain nil or yield empty selections; the package
|
||||||
report run.
|
does not create substitute values. A present convective-outlook run with no
|
||||||
- SPC convective outlook derivation selects already-collected outlooks whose
|
matching outlooks produces non-nil empty outlook and discussion slices, while
|
||||||
half-open valid intervals overlap the resolved report period and retains
|
a missing run produces nil slices.
|
||||||
discussions for represented outlook days.
|
|
||||||
- Derived SPC outlook records preserve the collected outlook fields, including
|
|
||||||
geometry, for downstream components that need source-level facts. Prompt
|
|
||||||
modules decide which fields are exposed to Scriptorium.
|
|
||||||
- It does not fetch upstream data, build prompt wording, compare prior
|
|
||||||
snapshots, write workflow state, invoke Scriptorium, or define modules.
|
|
||||||
|
|
||||||
## Config Fields Used
|
Derivation fails for an invalid report period, invalid timezone, unsupported
|
||||||
|
report ID, or when a requested daily summary has no hourly forecast data.
|
||||||
|
Invalid daypart definitions surface from forecast derivation. The package does
|
||||||
|
not access the CLI, filesystem, subprocesses, or network.
|
||||||
|
|
||||||
- `dayparts[].name`
|
## Verification and invariants
|
||||||
- `dayparts[].start`
|
|
||||||
- `dayparts[].end`
|
|
||||||
- `weather_api.timezone`
|
|
||||||
|
|
||||||
## External Adapters Used
|
Focused tests cover collected-fact separation, report-period selection,
|
||||||
|
hourly behavior, daily summaries, and convective outlook selection:
|
||||||
|
|
||||||
None directly. Collected facts are built from `weatherdata.Bundle`.
|
```sh
|
||||||
|
go test ./internal/facts
|
||||||
|
```
|
||||||
|
|
||||||
## State Or Manifest Behavior
|
Facts are derived once for a resolved report from already collected data.
|
||||||
|
They remain reusable structured values for prompt input and template
|
||||||
None. Source provenance and warnings remain data fields for downstream metadata
|
presentation, which are owned elsewhere.
|
||||||
and inspection.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
- Invalid or missing report valid periods return an error.
|
|
||||||
- Invalid timezone names return an error.
|
|
||||||
- Missing required hourly forecast data returns the underlying forecast
|
|
||||||
derivation error for reports that require daily summaries.
|
|
||||||
- Hourly Report can derive its default module facts without daily or
|
|
||||||
daypart summaries.
|
|
||||||
- Missing optional narrative, alert, discussion, daily, or weather story data
|
|
||||||
produces empty or nil derived fields.
|
|
||||||
- Missing optional SPC convective outlook data produces a nil collected field.
|
|
||||||
- A present SPC convective outlook source with no report-period matches
|
|
||||||
produces non-nil empty derived outlook and discussion slices.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Inspect:
|
|
||||||
|
|
||||||
- `internal/facts/facts_test.go`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
|
|
||||||
## Invariants
|
|
||||||
|
|
||||||
- Collected facts are built once from a fetched bundle.
|
|
||||||
- Derived facts are scoped to one resolved report.
|
|
||||||
- SPC convective outlook selection uses the resolved report period and the
|
|
||||||
already-collected outlook run.
|
|
||||||
- Source provenance and warnings stay separate from ordinary fact fields.
|
|
||||||
- Prompt-specific wording and one-off presentation decisions stay outside this
|
|
||||||
package.
|
|
||||||
|
|||||||
@@ -1,76 +1,61 @@
|
|||||||
# Forecast Derivation Internals
|
# Forecast Derivation Internals
|
||||||
|
|
||||||
This document describes deterministic forecast summarization in
|
`internal/forecast` deterministically selects and summarizes normalized
|
||||||
`internal/forecast`.
|
forecast data. It has no transport, filesystem, CLI, subprocess, or report
|
||||||
|
registry dependency. Its summaries are consumed by
|
||||||
|
[fact contracts](facts.md) and later module builders.
|
||||||
|
|
||||||
## Purpose
|
## Period and daypart semantics
|
||||||
|
|
||||||
`internal/forecast` converts normalized weather data into daily and period
|
Selections use `timeutil.Period` half-open overlap: a value is selected only
|
||||||
summaries used by fact builders and module builders.
|
when both intervals share time. `BuildDailySummary` creates one local civil
|
||||||
|
day; `BuildPeriodDailySummaries` intersects every local civil day with the
|
||||||
|
requested period, preserving partial first and last days.
|
||||||
|
|
||||||
## Inputs And Outputs
|
`ResolveDayparts` converts each configured name, start clock, and end clock
|
||||||
|
into a local window. An end clock at or before its start clock wraps into the
|
||||||
|
next civil day. The daypart and timezone defaults are defined in the
|
||||||
|
[configuration reference](../config.md), not here.
|
||||||
|
|
||||||
Inputs:
|
## Deterministic summaries
|
||||||
|
|
||||||
- `weatherdata.Bundle`
|
`BuildDailySummary` requires an hourly run with at least one period. It adds
|
||||||
- local date or resolved report period
|
the selected narrative periods, discussion, alert overlaps, source provenance,
|
||||||
- timezone
|
source warnings, and one `DaypartSummary` per resolved window. A daypart keeps
|
||||||
- configured daypart definitions
|
its selected hourly periods and derives temperature and apparent-temperature
|
||||||
|
ranges, timed precipitation and wind maxima, dominant and notable conditions,
|
||||||
|
and weather indicators.
|
||||||
|
|
||||||
Outputs:
|
Indicators are deterministic checks over normalized values and condition text:
|
||||||
|
heat, cold, and wind use package-owned numeric cutoffs; snow, ice, fog, and
|
||||||
|
wind text are detected from the forecast description. `BuildPrecipTiming`
|
||||||
|
sorts periods, records the maximum and first precipitation, groups contiguous
|
||||||
|
periods at or above its package-owned probability threshold, and records
|
||||||
|
thunder mentions.
|
||||||
|
|
||||||
- `forecast.DailySummary` for one local civil day
|
Alert overlap parsing supports the normalized alert payload's available timing
|
||||||
- one clipped daily summary per local day or partial day from
|
fields. Unparseable alerts and invalid intervals are ignored; valid overlaps
|
||||||
`BuildPeriodDailySummaries`
|
are clipped to the requested period and ordered by alert start time.
|
||||||
- daypart summaries with selected hourly periods, ranges, timed maximums,
|
|
||||||
conditions, indicators, and alert overlaps
|
|
||||||
|
|
||||||
## Boundaries
|
## Missing data and failures
|
||||||
|
|
||||||
- This package groups, selects, and summarizes already-normalized forecast
|
Empty selections yield empty summary fields rather than generated prose.
|
||||||
data.
|
Direct daily or period-summary calls fail when their required bundle, valid
|
||||||
- It does not perform HTTP calls, parse CLI flags, resolve report definitions,
|
period, hourly data, or daypart definitions are invalid. A nil location uses
|
||||||
compare prior snapshots, build prompt input packages, or invoke Scriptorium.
|
UTC when these APIs are called directly. Optional narrative, discussion, and
|
||||||
|
alerts remain absent when their normalized products are absent.
|
||||||
|
|
||||||
## Config Fields Used
|
Forecast thresholds used for brief indicators and precipitation timing are
|
||||||
|
implementation rules.
|
||||||
|
|
||||||
- `dayparts[].name`
|
## Verification and invariants
|
||||||
- `dayparts[].start`
|
|
||||||
- `dayparts[].end`
|
|
||||||
|
|
||||||
Threshold constants for basic indicators live in forecast code rather than
|
Focused tests cover local civil days, clipped periods, daypart resolution,
|
||||||
configuration.
|
summary metrics, precipitation windows, threshold helpers, and alert overlap:
|
||||||
|
|
||||||
## External Adapters Used
|
```sh
|
||||||
|
go test ./internal/forecast ./internal/timeutil
|
||||||
|
```
|
||||||
|
|
||||||
None directly. Forecast data arrives through `weatherdata.Bundle`.
|
The package preserves normalized inputs as inspectable structured values and
|
||||||
|
never decides report identity, delivery, or presentation wording.
|
||||||
## State Or Manifest Behavior
|
|
||||||
|
|
||||||
None. Source warnings and provenance from the bundle are carried into summaries
|
|
||||||
for later metadata and module output.
|
|
||||||
|
|
||||||
## Skip And Resume Behavior
|
|
||||||
|
|
||||||
None. Missing optional source context can produce empty selections, but missing
|
|
||||||
required hourly data fails summarization.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
- A nil bundle or missing hourly forecast data returns an error.
|
|
||||||
- Invalid daypart definitions return parse errors with context.
|
|
||||||
- Alert records without parseable RFC3339 timing are skipped.
|
|
||||||
- Empty selected periods produce empty summaries rather than generated prose.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Inspect:
|
|
||||||
|
|
||||||
- `internal/forecast/derive_test.go`
|
|
||||||
- `internal/timeutil/periods_test.go`
|
|
||||||
|
|
||||||
## Invariants
|
|
||||||
|
|
||||||
- Go owns report-period selection and meteorological summarization.
|
|
||||||
- Weather facts come from normalized source data.
|
|
||||||
- Outputs remain JSON-inspectable and independent of CLI, state, and adapters.
|
|
||||||
|
|||||||
@@ -1,140 +1,52 @@
|
|||||||
# Generated Text Internals
|
# Generated Text Internals
|
||||||
|
|
||||||
This document describes structured generated-text handling in
|
`internal/generatedtext` validates the structured prose produced for generated-
|
||||||
`internal/generatedtext`.
|
text reports and turns validated prose plus rich module values into typed render
|
||||||
|
contexts. It owns the catalog that pairs a generated-text report definition
|
||||||
|
with its validator, schema ID, template ID, and context builder. The complete
|
||||||
|
maintainer-facing context fields belong to [report templates](../templates.md).
|
||||||
|
|
||||||
## Purpose
|
## Catalog and validation
|
||||||
|
|
||||||
`internal/generatedtext` validates structured text returned for
|
The Daily, Today, Tomorrow, and Hourly report definitions each use structured
|
||||||
generated-text-template reports and builds curated render contexts for
|
generated text. `LookupDefinition` rejects unknown schema or template IDs and
|
||||||
templates. It also owns the generated-text catalog that connects report
|
unsupported schema/template pairs before the run begins. A handler validates raw JSON, returns a typed
|
||||||
definitions to validators, render-context builders, schema assets, and template
|
value and canonical normalized JSON, loads its canonical schema through
|
||||||
assets. The implemented contracts are Daily render context, Today Report,
|
`internal/promptassets`, builds a render context, and renders through
|
||||||
Tomorrow Report, and Hourly Report.
|
`internal/reporttemplate`.
|
||||||
|
|
||||||
## Inputs And Outputs
|
Daily, Today, and Tomorrow use a day-style value with required trimmed summary
|
||||||
|
and one or more nonblank discussion paragraphs. Hourly requires trimmed summary
|
||||||
|
and a single trimmed discussion string. Every form also requires the
|
||||||
|
`precipitation_timing` field; an empty string means there is no supported timing
|
||||||
|
prose to render. Typed decoding rejects missing required fields and unknown JSON
|
||||||
|
fields; no general-purpose JSON Schema engine is used at runtime.
|
||||||
|
|
||||||
Inputs:
|
## Render contexts
|
||||||
|
|
||||||
- raw GeneratedText JSON for Daily, Today, Tomorrow Report, or Hourly Report
|
The catalog's report-specific builders receive briefing metadata, a rich module
|
||||||
- report metadata from `internal/briefing`
|
snapshot, collected facts, derived facts, and the matching validated generated
|
||||||
- a module snapshot from `internal/module`
|
text. They decode the module stanzas needed by the template and build typed
|
||||||
- validated generated text
|
Daily, Today, Tomorrow, or Hourly contexts. Context construction validates
|
||||||
|
metadata and periods, preserves rich module values, and uses ordered slices for
|
||||||
|
template iteration rather than maps.
|
||||||
|
|
||||||
Outputs:
|
Optional source stanzas become nil or fallback context fields. Missing required
|
||||||
|
stanzas, type-decoding failures, invalid metadata, or a generated-text type
|
||||||
|
that does not match the chosen handler fail before template execution. Prompt
|
||||||
|
packages, raw Promptkit output handling, and template asset lookup remain
|
||||||
|
outside this package.
|
||||||
|
|
||||||
- typed `Daily` generated text
|
## Verification and invariants
|
||||||
- typed `Today` generated text
|
|
||||||
- typed `Tomorrow` generated text
|
|
||||||
- typed `Hourly` generated text
|
|
||||||
- normalized stable JSON for validated generated text
|
|
||||||
- typed `DailyRenderContext` values for `internal/reporttemplate`
|
|
||||||
- typed `TodayRenderContext` values for `internal/reporttemplate`
|
|
||||||
- typed `TomorrowRenderContext` values for `internal/reporttemplate`
|
|
||||||
- typed `HourlyRenderContext` values for `internal/reporttemplate`
|
|
||||||
- generated-text catalog handlers for report definitions that use
|
|
||||||
`generated_text_template`
|
|
||||||
|
|
||||||
The Daily generated text JSON accepts the same public fields and validation
|
Focused tests cover the catalog, each report-specific validator, normalization,
|
||||||
rules as Tomorrow. Its catalog entry is selected through schema ID `daily` and
|
schema/template mismatches, context construction, optional modules, and typed
|
||||||
template ID `daily`, with prompt ID `weather.daily_generated_text`.
|
stanza errors:
|
||||||
|
|
||||||
```json
|
```sh
|
||||||
{
|
go test ./internal/generatedtext
|
||||||
"summary": "string",
|
|
||||||
"forecast_discussion": ["string"],
|
|
||||||
"precipitation_timing": "string",
|
|
||||||
"confidence": "string"
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The hourly generated text JSON accepts:
|
Generated text supplies prose slots only; deterministic weather facts remain in
|
||||||
|
module and fact values. Every report definition must resolve to exactly one
|
||||||
```json
|
supported catalog pair.
|
||||||
{
|
|
||||||
"summary": "string",
|
|
||||||
"forecast_discussion": "string",
|
|
||||||
"precipitation_timing": "string",
|
|
||||||
"confidence": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
`summary` and `forecast_discussion` are required after trimming whitespace.
|
|
||||||
`precipitation_timing` and `confidence` are optional and omitted from normalized
|
|
||||||
JSON when blank.
|
|
||||||
|
|
||||||
The Today generated text JSON accepts the same public fields and validation
|
|
||||||
rules as Tomorrow. It is selected by the active Today report definition through
|
|
||||||
schema ID `today`, template ID `today`, and prompt ID
|
|
||||||
`weather.today_generated_text`:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"summary": "string",
|
|
||||||
"forecast_discussion": ["string"],
|
|
||||||
"precipitation_timing": "string",
|
|
||||||
"confidence": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The Tomorrow generated text JSON accepts:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"summary": "string",
|
|
||||||
"forecast_discussion": ["string"],
|
|
||||||
"precipitation_timing": "string",
|
|
||||||
"confidence": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
`summary` is required after trimming whitespace. `forecast_discussion` must
|
|
||||||
contain at least one nonblank paragraph after trimming blank items.
|
|
||||||
`precipitation_timing` and `confidence` are optional and omitted from normalized
|
|
||||||
JSON when blank.
|
|
||||||
|
|
||||||
## Boundaries
|
|
||||||
|
|
||||||
- This package owns typed generated-text validation and render-context shaping.
|
|
||||||
- It owns generated-text catalog lookup for schema/template combinations.
|
|
||||||
- It uses typed module snapshot decoding through `module.StanzaValue`.
|
|
||||||
- It does not invoke Scriptorium, write state artifacts, choose report
|
|
||||||
definitions, compare snapshots, or own embedded template/schema files.
|
|
||||||
- It renders through `internal/reporttemplate`; embedded asset lookup remains
|
|
||||||
in `internal/reporttemplate`.
|
|
||||||
- It does not use a Go JSON Schema dependency; schema enforcement in Go is
|
|
||||||
limited to typed JSON decoding, unknown-field rejection, and required-field
|
|
||||||
checks.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
- Malformed generated-text JSON fails with decode context.
|
|
||||||
- Unknown generated-text JSON fields fail during decoding.
|
|
||||||
- Empty required fields fail after trimming whitespace.
|
|
||||||
- Daily, Today, and Tomorrow forecast discussion fails when no nonblank
|
|
||||||
paragraphs remain.
|
|
||||||
- Missing optional render-context stanzas become nil module pointers.
|
|
||||||
- Invalid render metadata, including missing timezone, missing generated time,
|
|
||||||
or invalid valid period, fails before template rendering.
|
|
||||||
- Unsupported generated-text schema IDs, template IDs, or schema/template
|
|
||||||
combinations fail during catalog lookup with report ID context.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Inspect:
|
|
||||||
|
|
||||||
- `internal/generatedtext/hourly_test.go`
|
|
||||||
- `internal/generatedtext/daily_test.go`
|
|
||||||
- `internal/generatedtext/today_test.go`
|
|
||||||
- `internal/generatedtext/tomorrow_test.go`
|
|
||||||
- `internal/generatedtext/catalog_test.go`
|
|
||||||
- `internal/generatedtext/render_context_test.go`
|
|
||||||
|
|
||||||
## Invariants
|
|
||||||
|
|
||||||
- Render contexts are curated structs, not raw prompt-input packages.
|
|
||||||
- Required generated text is normalized before downstream artifact storage.
|
|
||||||
- Generated-text-template reports must have one catalog entry matching their
|
|
||||||
report definition schema and template IDs.
|
|
||||||
- Missing optional weather narrative stanzas produce empty or fallback render
|
|
||||||
context fields rather than forcing raw module data into templates.
|
|
||||||
|
|||||||
@@ -1,280 +1,66 @@
|
|||||||
# Module Contract Internals
|
# Module Contract Internals
|
||||||
|
|
||||||
This document describes the module contract in `internal/module`.
|
`internal/module` defines the stable envelope between report composition,
|
||||||
|
module builders, in-memory snapshots, templates, and prompt packages. It
|
||||||
|
does not define a report, execute a builder, or choose prompt-export policy;
|
||||||
|
those responsibilities belong to [report registry](report-registry.md) and
|
||||||
|
[briefing](briefing.md).
|
||||||
|
|
||||||
## Purpose
|
## Outputs and snapshots
|
||||||
|
|
||||||
`internal/module` defines the shared identifiers and data envelopes used for
|
Each `Output` has a module ID, stanza name, rich `Value`, and runtime-only
|
||||||
report modules. Report definitions use module IDs for composition, module
|
`PromptValue`. `DataPackageValue` returns the prompt value when present and
|
||||||
builders produce rich outputs with stanza names, prompt input packages consume
|
otherwise the rich value. This permits custom prompt exports without shrinking
|
||||||
runtime prompt export values, and Recent Changes compares snapshot stanzas.
|
the template value.
|
||||||
|
|
||||||
## Inputs And Outputs
|
`NewSnapshot` builds the ordered `weatherreporter.modules.v1` snapshot and
|
||||||
|
validates it. Its JSON representation contains IDs, stanza names, and rich values only;
|
||||||
|
`PromptValue` is deliberately excluded. `StanzaValue` decodes a named rich
|
||||||
|
stanza into a caller-supplied type, reporting a missing stanza separately from
|
||||||
|
a decoding error.
|
||||||
|
|
||||||
Inputs:
|
Snapshots reject missing schema versions, empty IDs or stanza names, and
|
||||||
|
duplicate IDs or stanza names. Output order is caller-owned and preserved.
|
||||||
|
|
||||||
- ordered `module.ConfigItem` values from report definitions or config
|
## Registered IDs and default composition
|
||||||
overrides
|
|
||||||
- `module.Output` values produced by module builders
|
|
||||||
|
|
||||||
Outputs:
|
The registered IDs are `metadata`, `current_conditions`,
|
||||||
|
`narrative_forecast`, `hourly_forecast`, `derived_daily_summary`,
|
||||||
|
`derived_daypart_summaries`, `precip_timing`, `alert_digest`,
|
||||||
|
`spc_convective_outlooks`, `area_forecast_discussion`,
|
||||||
|
`spc_convective_discussion`, `weather_story`, `outdoor_windows`,
|
||||||
|
`today_planning`, `tomorrow_planning`, and `daily_planning`.
|
||||||
|
|
||||||
- stable `module.ID` constants
|
The registry declares these ordered default compositions:
|
||||||
- typed option structs for registered modules
|
|
||||||
- `module.Snapshot` with schema version `weatherreporter.modules.v1`
|
|
||||||
- ordered snapshot outputs with module ID, stanza name, and typed value
|
|
||||||
- runtime-only prompt export values on module outputs
|
|
||||||
- `module.Output.DataPackageValue`, which selects the prompt export value and
|
|
||||||
falls back to the rich value for hand-built or loaded snapshots
|
|
||||||
- typed stanza lookup through `module.StanzaValue`
|
|
||||||
|
|
||||||
## Rich Values And Prompt Exports
|
| Report | Ordered modules |
|
||||||
|
| --- | --- |
|
||||||
|
| Daily | metadata, current conditions, narrative forecast, daily summary, daypart summaries, precipitation timing, alert digest, SPC outlooks, AFD (long term), SPC discussion, weather story, outdoor windows, daily planning, hourly forecast |
|
||||||
|
| Today | metadata, current conditions, narrative forecast, daily summary, daypart summaries, precipitation timing, alert digest, SPC outlooks, AFD, SPC discussion, weather story, outdoor windows, hourly forecast, today planning |
|
||||||
|
| Tomorrow | metadata, current conditions, narrative forecast, daily summary, daypart summaries, precipitation timing, alert digest, SPC outlooks, AFD, SPC discussion, weather story, outdoor windows, tomorrow planning, hourly forecast |
|
||||||
|
| Hourly | metadata, current conditions, hourly forecast, precipitation timing, alert digest, SPC outlooks, AFD (key messages and short term), SPC discussion, weather story |
|
||||||
|
|
||||||
Each `module.Output` has two value surfaces:
|
The only non-empty default option is the AFD section selection. It accepts a
|
||||||
|
`sections` list; omitted or empty selects all available sections. Report
|
||||||
|
definitions may narrow it as shown above. Option shape and report compatibility
|
||||||
|
are validated by the briefing registry.
|
||||||
|
|
||||||
- `Value`: the rich module value used by templates, module snapshots,
|
## Rich and prompt-facing values
|
||||||
inspection, Recent Changes, and render contexts.
|
|
||||||
- `PromptValue`: the runtime-only prompt export used when building Scriptorium
|
|
||||||
data packages.
|
|
||||||
|
|
||||||
`PromptValue` is deliberately excluded from module snapshot JSON. Persisted
|
Rich values remain available to module snapshots and render contexts.
|
||||||
module snapshots keep only the rich `value` field so inspection and
|
Briefing attaches custom prompt exports only for current conditions, hourly
|
||||||
render-context reconstruction keep the full deterministic template surface.
|
forecast, and derived daypart summaries; all other current builders use
|
||||||
|
pass-through values. The prompt package owns how exported stanzas are grouped
|
||||||
|
and serialized; see [prompt input](prompt-input.md).
|
||||||
|
|
||||||
The `internal/briefing` module registry attaches prompt export values when it
|
## Verification and invariants
|
||||||
builds module outputs. Modules without a custom exporter use default
|
|
||||||
pass-through behavior, so their prompt value is the same as their rich value.
|
|
||||||
Modules that need cleanup own typed prompt export structs near the module
|
|
||||||
builder. Current custom prompt exports are:
|
|
||||||
|
|
||||||
- `current_conditions`
|
Focused tests cover snapshot validation and order, typed stanza lookup, and
|
||||||
- `hourly_forecast`
|
prompt-value fallback:
|
||||||
- `derived_daypart_summaries`
|
|
||||||
|
|
||||||
Custom exporters remove template-only helpers or confusing duplicates from the
|
```sh
|
||||||
data package without shrinking the rich module structs used by templates.
|
go test ./internal/module
|
||||||
Exporter failures include module ID and stanza context.
|
|
||||||
|
|
||||||
## Registered Module IDs
|
|
||||||
|
|
||||||
The registry recognizes these IDs:
|
|
||||||
|
|
||||||
- `metadata`
|
|
||||||
- `current_conditions`
|
|
||||||
- `narrative_forecast`
|
|
||||||
- `hourly_forecast`
|
|
||||||
- `derived_daily_summary`
|
|
||||||
- `derived_daypart_summaries`
|
|
||||||
- `precip_timing`
|
|
||||||
- `alert_digest`
|
|
||||||
- `spc_convective_outlooks`
|
|
||||||
- `area_forecast_discussion`
|
|
||||||
- `spc_convective_discussion`
|
|
||||||
- `weather_story`
|
|
||||||
- `outdoor_windows`
|
|
||||||
- `today_planning`
|
|
||||||
- `tomorrow_planning`
|
|
||||||
- `daily_planning`
|
|
||||||
|
|
||||||
Every registered module has a builder. Report composition entries that refer to
|
|
||||||
unknown or unimplemented module IDs fail validation instead of being skipped.
|
|
||||||
|
|
||||||
## Daily Composition
|
|
||||||
|
|
||||||
The default Daily Report module order is:
|
|
||||||
|
|
||||||
1. `metadata`
|
|
||||||
2. `current_conditions`
|
|
||||||
3. `narrative_forecast`
|
|
||||||
4. `derived_daily_summary`
|
|
||||||
5. `derived_daypart_summaries`
|
|
||||||
6. `precip_timing`
|
|
||||||
7. `alert_digest`
|
|
||||||
8. `spc_convective_outlooks`
|
|
||||||
9. `area_forecast_discussion`
|
|
||||||
10. `spc_convective_discussion`
|
|
||||||
11. `weather_story`
|
|
||||||
12. `outdoor_windows`
|
|
||||||
13. `daily_planning`
|
|
||||||
14. `hourly_forecast`
|
|
||||||
|
|
||||||
The embedded Daily template uses selected deterministic fields from these
|
|
||||||
module outputs after GeneratedText validation.
|
|
||||||
|
|
||||||
## Today Composition
|
|
||||||
|
|
||||||
The default Today Report module order is:
|
|
||||||
|
|
||||||
1. `metadata`
|
|
||||||
2. `current_conditions`
|
|
||||||
3. `narrative_forecast`
|
|
||||||
4. `derived_daily_summary`
|
|
||||||
5. `derived_daypart_summaries`
|
|
||||||
6. `precip_timing`
|
|
||||||
7. `alert_digest`
|
|
||||||
8. `spc_convective_outlooks`
|
|
||||||
9. `area_forecast_discussion`
|
|
||||||
10. `spc_convective_discussion`
|
|
||||||
11. `weather_story`
|
|
||||||
12. `outdoor_windows`
|
|
||||||
13. `hourly_forecast`
|
|
||||||
14. `today_planning`
|
|
||||||
|
|
||||||
The embedded Today template uses selected deterministic fields from these
|
|
||||||
module outputs after GeneratedText validation.
|
|
||||||
|
|
||||||
## Tomorrow Composition
|
|
||||||
|
|
||||||
The default Tomorrow Report module order is:
|
|
||||||
|
|
||||||
1. `metadata`
|
|
||||||
2. `current_conditions`
|
|
||||||
3. `narrative_forecast`
|
|
||||||
4. `derived_daily_summary`
|
|
||||||
5. `derived_daypart_summaries`
|
|
||||||
6. `precip_timing`
|
|
||||||
7. `alert_digest`
|
|
||||||
8. `spc_convective_outlooks`
|
|
||||||
9. `area_forecast_discussion`
|
|
||||||
10. `spc_convective_discussion`
|
|
||||||
11. `weather_story`
|
|
||||||
12. `outdoor_windows`
|
|
||||||
13. `tomorrow_planning`
|
|
||||||
14. `hourly_forecast`
|
|
||||||
|
|
||||||
The embedded Tomorrow template uses selected deterministic fields from these
|
|
||||||
module outputs after GeneratedText validation.
|
|
||||||
|
|
||||||
## Daily Planning
|
|
||||||
|
|
||||||
`daily_planning` emits dated daily planning facts for the `daily` report ID.
|
|
||||||
Its output stanza is also named `daily_planning`. The module is supported only
|
|
||||||
by that report ID and depends on daily summaries for the selected local civil
|
|
||||||
day. The default Daily Report composition includes it.
|
|
||||||
|
|
||||||
The output uses this shape:
|
|
||||||
|
|
||||||
- `morning_readiness`
|
|
||||||
- `commute_school_workday_concerns`
|
|
||||||
- `overnight_change_watch`
|
|
||||||
|
|
||||||
The type is `briefing.DailyPlanningModule`; it is independent from
|
|
||||||
`briefing.TomorrowPlanningModule`.
|
|
||||||
|
|
||||||
## Today Planning
|
|
||||||
|
|
||||||
`today_planning` emits current-day planning facts for Today Report. Its output
|
|
||||||
stanza is also named `today_planning`. The module is supported only by Today
|
|
||||||
Report and depends on daily and daypart summaries for the current local civil
|
|
||||||
day.
|
|
||||||
|
|
||||||
The output uses this shape:
|
|
||||||
|
|
||||||
- `morning_readiness`
|
|
||||||
- `commute_school_workday_concerns`
|
|
||||||
- `outdoor_planning`
|
|
||||||
- `late_day_change_watch`
|
|
||||||
|
|
||||||
The type is `briefing.TodayPlanningModule`; it is independent from
|
|
||||||
`briefing.TomorrowPlanningModule`.
|
|
||||||
|
|
||||||
## Hourly Composition
|
|
||||||
|
|
||||||
The default Hourly Report module order is:
|
|
||||||
|
|
||||||
1. `metadata`
|
|
||||||
2. `current_conditions`
|
|
||||||
3. `hourly_forecast`
|
|
||||||
4. `precip_timing`
|
|
||||||
5. `alert_digest`
|
|
||||||
6. `spc_convective_outlooks`
|
|
||||||
7. `area_forecast_discussion`
|
|
||||||
8. `spc_convective_discussion`
|
|
||||||
9. `weather_story`
|
|
||||||
|
|
||||||
Hourly Report does not include daily or daypart summary modules by default.
|
|
||||||
Its `area_forecast_discussion` item is configured to include only
|
|
||||||
`key_messages` and `short_term`.
|
|
||||||
|
|
||||||
## Options
|
|
||||||
|
|
||||||
Most modules use an empty options struct, including
|
|
||||||
`spc_convective_outlooks` and `spc_convective_discussion`.
|
|
||||||
`area_forecast_discussion` accepts:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
sections:
|
|
||||||
- product
|
|
||||||
- key_messages
|
|
||||||
- short_term
|
|
||||||
- long_term
|
|
||||||
```
|
```
|
||||||
|
|
||||||
An omitted or empty `sections` list includes all available discussion sections.
|
Module IDs and stanza names are stable, every emitted output has one of each,
|
||||||
Invalid option shapes fail during config normalization or composition
|
and this package never imports the report registry.
|
||||||
validation.
|
|
||||||
|
|
||||||
## SPC Convective Module Outputs
|
|
||||||
|
|
||||||
`spc_convective_outlooks` emits a risk-product stanza with:
|
|
||||||
|
|
||||||
- `checked`
|
|
||||||
- `as_of`
|
|
||||||
- `issued_at`
|
|
||||||
- `location_id`
|
|
||||||
- `location_name`
|
|
||||||
- `outlook_count`
|
|
||||||
- `outlooks`
|
|
||||||
|
|
||||||
Each outlook entry may include `day`, `outlook_type`, `label`, `label_text`,
|
|
||||||
`period_begins`, `period_ends`, `issued_at`, `contains_location`, and
|
|
||||||
`image_url`. It omits GeoJSON geometry, source URL, expiration time, and
|
|
||||||
severity rank.
|
|
||||||
|
|
||||||
`spc_convective_discussion` emits a narrative stanza only when a retained
|
|
||||||
report-period categorical outlook has severity rank `3` or higher and matching
|
|
||||||
discussion text is available. Its output includes `included_because` and
|
|
||||||
`discussions`; each discussion may include `day`, `period_begins`,
|
|
||||||
`period_ends`, `headline`, `summary`, `discussion`, and `updated_at`.
|
|
||||||
Discussions are included only for SPC days whose retained categorical outlooks
|
|
||||||
meet the severity threshold.
|
|
||||||
|
|
||||||
## Boundaries
|
|
||||||
|
|
||||||
- This package owns module identifiers, config item envelopes, output
|
|
||||||
envelopes, snapshot validation, and typed stanza lookup.
|
|
||||||
- It does not define report IDs, execute builders, fetch weather data, derive
|
|
||||||
forecast facts, write state, or invoke Scriptorium.
|
|
||||||
|
|
||||||
## State Or Manifest Behavior
|
|
||||||
|
|
||||||
`module.Snapshot` values are persisted by `internal/state` as JSON. Snapshot
|
|
||||||
validation rejects missing schema version, missing module IDs, missing stanza
|
|
||||||
names, duplicate module outputs, and duplicate stanza names while preserving
|
|
||||||
output order. Snapshot JSON contains rich module values only; runtime prompt
|
|
||||||
export values are not persisted.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
- Snapshot construction fails for duplicate module outputs or duplicate stanza
|
|
||||||
names.
|
|
||||||
- Typed stanza lookup returns `found=false` for missing stanzas.
|
|
||||||
- Typed stanza lookup wraps JSON marshal/decode failures with stanza context.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Inspect:
|
|
||||||
|
|
||||||
- `internal/module/module_test.go`
|
|
||||||
- `internal/briefing/modules_test.go`
|
|
||||||
- `internal/report/period_test.go`
|
|
||||||
|
|
||||||
## Invariants
|
|
||||||
|
|
||||||
- `internal/module` does not import `internal/report`.
|
|
||||||
- Module IDs are stable strings.
|
|
||||||
- Each emitted module output has exactly one stanza name and one rich typed
|
|
||||||
value.
|
|
||||||
- Built module outputs have a data-package value, either from a custom prompt
|
|
||||||
exporter or from default pass-through behavior.
|
|
||||||
- Snapshot output order is caller-owned and preserved.
|
|
||||||
|
|||||||
@@ -1,177 +1,28 @@
|
|||||||
# Prompt Input Internals
|
# Prompt Input Internals
|
||||||
|
|
||||||
This document describes YAML prompt data package construction in
|
`internal/promptinput` converts report metadata, an ordered module snapshot, and source warnings into the YAML `data_package` supplied inline to Promptkit. It owns the package schema, grouping, serialization, loading, and validation; it does not choose an output destination, collect weather, execute a provider, or retain packages after a command ends.
|
||||||
`internal/promptinput`.
|
|
||||||
|
|
||||||
## Purpose
|
## Package Construction
|
||||||
|
|
||||||
`internal/promptinput` converts report metadata, ordered module outputs, Recent
|
`Build` produces `weatherreporter.data_package.v4`. It copies the run ID; report ID, variant, prompt ID, generation time, timezone, local current date, and valid period; ordered briefing stanzas; and source warnings. Prompt input contains no historical comparison section.
|
||||||
Changes, and source warnings into the `data_package` file passed to
|
|
||||||
Scriptorium.
|
|
||||||
|
|
||||||
The persisted data package is YAML with schema version
|
Briefing is a flat ordered set of stanza values. `Build` uses each output's `DataPackageValue`, so curated prompt exports take precedence and rich values are used only as a fallback. Prompt exports are selected by the [briefing registry](briefing.md), while the rich-versus-prompt contract is in [module internals](module.md).
|
||||||
`weatherreporter.data_package.v3`. It is separate from the JSON module snapshot
|
|
||||||
used for inspection and comparison. Data packages serialize each module
|
|
||||||
output's prompt export value, not necessarily the full rich module value saved
|
|
||||||
in the module snapshot.
|
|
||||||
|
|
||||||
## Inputs And Outputs
|
## YAML Ordering And Validation
|
||||||
|
|
||||||
Inputs:
|
Serialization keeps `metadata` directly under `briefing`. Every other known stanza is placed in one category and emitted in category order while preserving its original module order:
|
||||||
|
|
||||||
- report metadata from app/state orchestration
|
| Category | Current stanzas |
|
||||||
- `module.Snapshot`
|
| --- | --- |
|
||||||
- optional `[]changes.Change`
|
| `applicable_risk_products` | alert digest, SPC convective outlooks |
|
||||||
|
| `derived_summaries` | deterministic summaries, precipitation timing, outdoor windows, and planning values |
|
||||||
|
| `narrative_products` | narrative forecast, discussions, and weather story |
|
||||||
|
| `raw_data` | current conditions and hourly forecast |
|
||||||
|
|
||||||
Outputs:
|
`LoadYAML` accepts this layout and reconstructs the flat order and values. It rejects misplaced, duplicate, unknown, or uncategorized stanzas. `Validate` requires the v4 schema version, report identity and period fields, and at least one ordered briefing stanza. `MarshalYAML` and `LoadYAML` validate their result. `Save` remains a reusable atomic-file helper for callers that explicitly need one; normal application execution passes marshalled YAML directly to Promptkit.
|
||||||
|
|
||||||
- `promptinput.Package` with schema version, RunID, report metadata, named
|
Focused tests cover construction, curated exports, category ordering, YAML round trips, invalid layout, validation, and atomic saves:
|
||||||
module stanzas grouped for prompt presentation, Recent Changes, and source
|
|
||||||
warnings
|
|
||||||
- YAML bytes from `promptinput.MarshalYAML`
|
|
||||||
- YAML file written atomically by `promptinput.Save`
|
|
||||||
|
|
||||||
The YAML shape includes:
|
```sh
|
||||||
|
go test ./internal/promptinput
|
||||||
```yaml
|
|
||||||
schema_version: weatherreporter.data_package.v3
|
|
||||||
run_id: <run_id>
|
|
||||||
report:
|
|
||||||
id: <report_id>
|
|
||||||
prompt_id: <prompt_id>
|
|
||||||
briefing:
|
|
||||||
metadata: {}
|
|
||||||
applicable_risk_products:
|
|
||||||
alert_digest: {}
|
|
||||||
spc_convective_outlooks: {}
|
|
||||||
derived_summaries:
|
|
||||||
derived_daily_summary: {}
|
|
||||||
derived_daypart_summaries: {}
|
|
||||||
precip_timing: {}
|
|
||||||
outdoor_windows: {}
|
|
||||||
narrative_products:
|
|
||||||
narrative_forecast: {}
|
|
||||||
area_forecast_discussion: {}
|
|
||||||
spc_convective_discussion: {}
|
|
||||||
weather_story: {}
|
|
||||||
raw_data:
|
|
||||||
current_conditions: {}
|
|
||||||
hourly_forecast: {}
|
|
||||||
recent_changes:
|
|
||||||
items: []
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The `briefing` mapping keeps `metadata` directly under `briefing` and groups
|
|
||||||
weather module stanzas under prompt-facing categories. This grouping is a YAML
|
|
||||||
presentation concern only: module snapshots remain flat, and loaded
|
|
||||||
`promptinput.Package` values expose flat stanza names in `Briefing.Values`.
|
|
||||||
Within each category, stanza order follows the module snapshot output order.
|
|
||||||
Prompt-facing module intervals use local `period_begins` and `period_ends`
|
|
||||||
labels; canonical report metadata and source timestamps remain structured
|
|
||||||
timestamps where applicable.
|
|
||||||
|
|
||||||
## Module Export Boundary
|
|
||||||
|
|
||||||
Data packages are curated prompt inputs. They are not full template render
|
|
||||||
contexts and should not be treated as a dump of every field available to Go
|
|
||||||
templates.
|
|
||||||
|
|
||||||
When module outputs are built by `internal/briefing`, the registry attaches a
|
|
||||||
runtime prompt export value. `internal/promptinput` serializes
|
|
||||||
`output.DataPackageValue()` for each stanza. That helper prefers the runtime
|
|
||||||
prompt export and falls back to the rich `Value` when no prompt export is set,
|
|
||||||
which keeps loaded snapshots and hand-built tests usable.
|
|
||||||
|
|
||||||
Modules without custom export policy use pass-through behavior. Modules with
|
|
||||||
custom exports currently include:
|
|
||||||
|
|
||||||
- `current_conditions`: omits lower-case condition text and duplicate
|
|
||||||
wind-direction text.
|
|
||||||
- `hourly_forecast`: omits hour labels, lower-case description text, and the
|
|
||||||
template precipitation-mention helper while keeping forecast facts.
|
|
||||||
- `derived_daypart_summaries`: omits deterministic sentence-construction
|
|
||||||
helpers while keeping daypart period, condition, temperature trend,
|
|
||||||
precipitation, wind, notable-condition, hazard, and alert-relevance facts.
|
|
||||||
|
|
||||||
The rich module snapshot and generated-template render context still contain
|
|
||||||
the helper fields used by deterministic Markdown templates.
|
|
||||||
|
|
||||||
Daily Report, Today Report, Tomorrow Report, and Hourly Report module snapshots
|
|
||||||
use the same package schema and categories when converted into prompt input.
|
|
||||||
The default hourly module list places
|
|
||||||
`precip_timing` under `derived_summaries`, alert and SPC outlooks under
|
|
||||||
`applicable_risk_products`, AFD/SPC discussion/weather story under
|
|
||||||
`narrative_products`, and current/hourly data under `raw_data`. It does not
|
|
||||||
include civil-day summary stanzas. Generated-text and render context artifacts
|
|
||||||
are produced later in app orchestration and are not part of the YAML data
|
|
||||||
package.
|
|
||||||
|
|
||||||
The default Daily, Today, and Tomorrow module lists include civil-day summary
|
|
||||||
stanzas, planning stanzas, and `hourly_forecast` in the data package before
|
|
||||||
structured GeneratedText is requested from Scriptorium. Daily uses
|
|
||||||
`daily_planning`, Today uses `today_planning`, and Tomorrow uses
|
|
||||||
`tomorrow_planning`.
|
|
||||||
|
|
||||||
Current categories are:
|
|
||||||
|
|
||||||
- `applicable_risk_products`: location-applicable alerts, warnings, outlooks,
|
|
||||||
and similar risk products. Current stanzas include `alert_digest` and
|
|
||||||
`spc_convective_outlooks`.
|
|
||||||
- `derived_summaries`: deterministic summaries and calculated report facts.
|
|
||||||
- `narrative_products`: official narrative text products and forecast stories.
|
|
||||||
Current stanzas include `narrative_forecast`,
|
|
||||||
`area_forecast_discussion`, `spc_convective_discussion`, and
|
|
||||||
`weather_story`.
|
|
||||||
- `raw_data`: minimally transformed underlying weather data.
|
|
||||||
|
|
||||||
## Boundaries
|
|
||||||
|
|
||||||
- This package owns prompt package schema, YAML marshaling, YAML loading, and
|
|
||||||
validation.
|
|
||||||
- It does not fetch weather data, derive forecast summaries, execute modules,
|
|
||||||
choose module prompt export shapes, find prior snapshots, compare changes,
|
|
||||||
choose artifact paths, or invoke Scriptorium.
|
|
||||||
|
|
||||||
## Config Fields Used
|
|
||||||
|
|
||||||
None directly. Config-derived values such as timezone, units, and prompt
|
|
||||||
location are already present in report metadata and module stanzas before this
|
|
||||||
package runs.
|
|
||||||
|
|
||||||
## External Adapters Used
|
|
||||||
|
|
||||||
None.
|
|
||||||
|
|
||||||
## State Or Manifest Behavior
|
|
||||||
|
|
||||||
`promptinput.Save` writes YAML atomically. Managed workspace paths are owned by
|
|
||||||
`internal/state`.
|
|
||||||
|
|
||||||
## Skip And Resume Behavior
|
|
||||||
|
|
||||||
None. Recent Changes is always present as an `items` list and may be empty.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
Validation fails before render preflight when required top-level fields are
|
|
||||||
missing or inconsistent, when the valid period is invalid, or when no module
|
|
||||||
stanzas are present. Save failures include filesystem operation and path
|
|
||||||
context.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Inspect:
|
|
||||||
|
|
||||||
- `internal/promptinput/package_test.go`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
|
|
||||||
## Invariants
|
|
||||||
|
|
||||||
- Scriptorium receives structured YAML through `--input data_package=<path>`.
|
|
||||||
- Module stanza order is deterministic within each prompt-facing category.
|
|
||||||
- Every non-metadata module stanza has exactly one prompt-input category.
|
|
||||||
- Data-package stanzas use curated module prompt exports when present and rich
|
|
||||||
values only as pass-through or fallback values.
|
|
||||||
- Data packages are narrower than generated-template render contexts.
|
|
||||||
- Recent Changes are provided by `internal/changes`; this package does not
|
|
||||||
infer changes from rendered report text.
|
|
||||||
|
|||||||
17
docs/internal/promptkit-adapter.md
Normal file
17
docs/internal/promptkit-adapter.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# Promptkit Adapter Internals
|
||||||
|
|
||||||
|
`internal/adapters/promptkit` maps Weatherreporter's project-owned executor contract to Promptkit. The CLI maps `promptkit` configuration to a `PromptExecutorConfig` and constructs one executor per action. Promptkit dependency types do not escape the adapter.
|
||||||
|
|
||||||
|
The adapter supplies Weatherreporter's embedded prompt, schema, and fallback profile filesystems to each engine. Promptkit resolves configured operator profile sources, the embedded fallback catalog, and its built-in catalog; the adapter does not parse profile YAML, merge sources, or probe endpoints.
|
||||||
|
|
||||||
|
The adapter exposes exact prompt and profile validation plus prepared execution. It maps safe prompt identity, logical profile, effective backend/model, preparation, execution, validation, and optional debug values into `promptexec`. `Execute` passes the YAML package as an inline Promptkit input; it does not construct a filesystem URI or write a package file.
|
||||||
|
|
||||||
|
The application uses the preparation callback to record active safe provenance in memory and optionally writes content-rich diagnostics only through an explicit debug writer. The adapter returns raw output for application validation and rendering. It does not retain application state, render Markdown, choose report definitions, or send Distributor notifications.
|
||||||
|
|
||||||
|
Focused tests:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go test ./internal/adapters/promptkit ./internal/cli ./internal/app
|
||||||
|
```
|
||||||
|
|
||||||
|
The public logical prompt/profile/schema contract is owned by the [Promptkit integration guide](../integrations/promptkit.md).
|
||||||
@@ -1,137 +1,30 @@
|
|||||||
# Report Registry Internals
|
# Report Registry Internals
|
||||||
|
|
||||||
This document describes report identity, valid-period resolution, batch
|
`internal/report` owns report identities, valid-period resolution, exact prompt identity and version, output names, default module composition, and Distributor path declarations. Public command syntax belongs in the [CLI reference](../cli.md); configuration aliases and overrides belong in the [configuration reference](../config.md).
|
||||||
membership, output naming, artifact grouping, and comparison declarations in
|
|
||||||
`internal/report`.
|
|
||||||
|
|
||||||
## Purpose
|
## Definitions And Resolution
|
||||||
|
|
||||||
`internal/report` is the canonical source for report definitions, public
|
Each `Definition` declares a stable ID and display name, prompt ID and version, template and generated-text schema IDs, valid-period resolver, default output name, Distributor path templates, module list, and fixed batch eligibility. `Resolved` combines a definition with one valid period and run identity.
|
||||||
command names, config-key aliases, and batch command names. App, config, state,
|
|
||||||
module building, and CLI wiring consume report-owned helpers and resolved
|
|
||||||
definitions instead of owning report identity policy themselves.
|
|
||||||
|
|
||||||
## Definition Fields
|
| Report ID | Prompt version | Default profile | Period policy | Fixed batch flag | Default output |
|
||||||
|
| --- | --- | --- | --- | --- | --- |
|
||||||
|
| `daily` | `2.0.0` | `weather-balanced` | Explicit local civil day | Dynamic Daily inclusion is app-owned | `daily-YYYY-MM-DD.md` |
|
||||||
|
| `today` | `2.0.0` | `weather-balanced` | Selected or current local civil day | Morning | `today.md` |
|
||||||
|
| `tomorrow` | `2.0.0` | `weather-balanced` | Next local civil day | Evening | `tomorrow.md` |
|
||||||
|
| `hourly` | `2.0.0` | `weather-light` | Rolling six-hour interval | — | `hourly.md` |
|
||||||
|
|
||||||
Each report definition declares:
|
Daily derives its filename from the resolved valid-period start in the effective timezone, so multiple Daily items have distinct destinations. Exact template fields and schema assets belong to [report templates](../templates.md) and [generated-text internals](generatedtext.md). Prompt assets own default profile selection; the registry stores no provider setting.
|
||||||
|
|
||||||
- report ID and display name
|
## Collaborators And Boundaries
|
||||||
- Scriptorium prompt ID
|
|
||||||
- generation mode
|
|
||||||
- valid-period resolver
|
|
||||||
- comparison strategy
|
|
||||||
- managed artifact group
|
|
||||||
- batch output copy filename
|
|
||||||
- generated-report eligibility
|
|
||||||
- prior-report compatibility list
|
|
||||||
- morning or evening batch membership
|
|
||||||
- default ordered module composition
|
|
||||||
|
|
||||||
Report-owned helpers map public command names and config keys to report IDs.
|
`DefaultRegistry`, `Lookup`, `Resolve`, and report-name helpers prevent callers from duplicating report identity rules. Registry overrides clone a recognized definition and replace its module list. `DistributorPathTemplates` are consumed by app orchestration; their rendered external bundle-path contract is documented in the [Distributor bundle guide](../integrations/distributor/pkg-bundle.md).
|
||||||
The generate command names are `daily`, `today`, `tomorrow`, `hourly`,
|
|
||||||
`three-day`, `weekend`, and `storm`. Config keys also accept selected
|
|
||||||
underscore and descriptive aliases such as `three_day_outlook`,
|
|
||||||
`weekend_outlook`, and `storm_report`.
|
|
||||||
|
|
||||||
`daily` resolves to the dated Daily Report ID `daily`. `today` resolves to the
|
`morning` and `evening` are registry-owned batch names. Fixed flags declare Today and Tomorrow eligibility; app orchestration determines data-dependent Daily membership and the actual batch plan.
|
||||||
independent Today report ID `today`. `reports.today` is not an alias for
|
|
||||||
`reports.daily`, and retired report keys are not supported.
|
|
||||||
|
|
||||||
Markdown report definitions use the `scriptorium_markdown` generation mode.
|
The registry never collects weather data, parses CLI flags, writes output, executes Promptkit, or delivers a report.
|
||||||
Their template and structured-text schema identifiers are empty. Daily Report,
|
|
||||||
Today Report, Tomorrow Report, and Hourly Report declare
|
|
||||||
`generated_text_template`; the app uses their template and schema identifiers
|
|
||||||
to validate generated text and render embedded Markdown templates.
|
|
||||||
|
|
||||||
## Reports
|
Focused tests cover definition completeness, command and alias lookup, period resolution, run IDs, output names, composition defaults, and override validation:
|
||||||
|
|
||||||
| Report | ID | Prompt | Generation mode | Artifact group | Batch copy | Prior compatibility |
|
```sh
|
||||||
| --- | --- | --- | --- | --- | --- | --- |
|
go test ./internal/report
|
||||||
| Daily Report | `daily` | `weather.daily_generated_text` | `generated_text_template` | `daily` | `daily.md` | Daily Report |
|
```
|
||||||
| Today Report | `today` | `weather.today_generated_text` | `generated_text_template` | `today` | `today.md` | Today Report |
|
|
||||||
| Tomorrow Report | `tomorrow` | `weather.tomorrow_generated_text` | `generated_text_template` | `tomorrow` | `tomorrow.md` | Tomorrow Report |
|
|
||||||
| Hourly Report | `hourly` | `weather.hourly_generated_text` | `generated_text_template` | `hourly` | `hourly.md` | Hourly Report |
|
|
||||||
| 3-Day Outlook | `three_day` | `weather.three_day_outlook` | `scriptorium_markdown` | `three-day` | `three-day.md` | 3-Day Outlook |
|
|
||||||
| Weekend Outlook | `weekend` | `weather.weekend_outlook` | `scriptorium_markdown` | `weekend` | `weekend.md` | Weekend Outlook |
|
|
||||||
| Storm Report | `storm` | `weather.storm_report` | `scriptorium_markdown` | `storm` | `storm.md` | Storm Report |
|
|
||||||
|
|
||||||
All report definitions are eligible for generation.
|
|
||||||
|
|
||||||
## Valid Periods
|
|
||||||
|
|
||||||
- Daily Report covers the selected local civil day and requires an explicit
|
|
||||||
date.
|
|
||||||
- Today Report covers the selected local civil day, or the current local civil
|
|
||||||
day when no date override is supplied.
|
|
||||||
- Tomorrow Report covers the next local civil day from generation time.
|
|
||||||
- Hourly Report covers the half-open six-hour period from generation time in
|
|
||||||
the effective report timezone. The duration is an internal report constant,
|
|
||||||
not a configuration field.
|
|
||||||
- 3-Day Outlook covers the interval from generation time through local midnight
|
|
||||||
three days later.
|
|
||||||
- Weekend Outlook covers the upcoming weekend window and is not scheduled for
|
|
||||||
Sunday morning batch resolution.
|
|
||||||
- Storm Report covers an explicit event window supplied by the caller.
|
|
||||||
|
|
||||||
Storm event windows can be parsed from local `YYYY-MM-DDTHH:MM` timestamps in
|
|
||||||
the configured timezone or RFC3339 timestamps with explicit offsets. End time
|
|
||||||
must be after start time.
|
|
||||||
|
|
||||||
## Boundaries
|
|
||||||
|
|
||||||
`internal/report` defines report metadata, public report names, batch command
|
|
||||||
names, and time coverage. It does not fetch weather data, build module values,
|
|
||||||
compare snapshot contents, write state, parse CLI flags, or invoke Scriptorium.
|
|
||||||
|
|
||||||
The CLI parses flags and command structure, then uses report-owned helpers for
|
|
||||||
report and batch command names. Config loading uses report-owned helpers for
|
|
||||||
report override keys.
|
|
||||||
|
|
||||||
## Config Fields Used
|
|
||||||
|
|
||||||
The app supplies `weather_api.timezone` as a loaded `time.Location`. Batch
|
|
||||||
output path copying uses batch output names from report definitions. Report
|
|
||||||
module overrides can use short keys such as `daily`, `today`, `tomorrow`, and
|
|
||||||
`hourly`, or descriptive names such as `three_day_outlook`.
|
|
||||||
|
|
||||||
## Batch Membership
|
|
||||||
|
|
||||||
Morning batches include Today Report, 3-Day Outlook, and Weekend Outlook
|
|
||||||
except on Sunday. Evening batches include Tomorrow Report. Daily Report and
|
|
||||||
Hourly Report are not part of a scheduled batch.
|
|
||||||
|
|
||||||
## State And App Usage
|
|
||||||
|
|
||||||
- State paths use `ArtifactGroup`.
|
|
||||||
- Batch output copies use `BatchOutputName`.
|
|
||||||
- Generation checks `Generated`.
|
|
||||||
- Module composition defaults use `Modules`.
|
|
||||||
- Prior lookup checks `CompatiblePriorIDs` and the comparison strategy.
|
|
||||||
- RunIDs include the resolved report ID.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
- Unknown report IDs and batch names return actionable errors.
|
|
||||||
- Weekend Outlook resolution returns an error when resolved directly on Sunday.
|
|
||||||
- Storm Report resolution requires start and end, with end after start.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Inspect:
|
|
||||||
|
|
||||||
- `internal/report/period_test.go`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
- `internal/cli/root_test.go`
|
|
||||||
|
|
||||||
## Invariants
|
|
||||||
|
|
||||||
- Report selection goes through the registry.
|
|
||||||
- Public command names, config-key aliases, and batch command names are owned
|
|
||||||
by `internal/report`.
|
|
||||||
- Direct Markdown reports have empty template and generated-text schema IDs.
|
|
||||||
- Generated-text-template reports declare prompt, template, and schema IDs in
|
|
||||||
their report definition.
|
|
||||||
- Valid periods are half-open intervals independent of rendered report text.
|
|
||||||
- Artifact grouping, batch output filenames, generated-report eligibility,
|
|
||||||
default module composition, comparison compatibility, and comparison strategy
|
|
||||||
are declared by report definition.
|
|
||||||
|
|||||||
@@ -1,113 +1,51 @@
|
|||||||
# Report Template Internals
|
# Report Template Internals
|
||||||
|
|
||||||
This document describes embedded Markdown templates and GeneratedText schemas
|
`internal/reporttemplate` embeds and renders the repository's native Markdown
|
||||||
in `internal/reporttemplate`.
|
templates. The current template IDs are `daily`, `today`, `tomorrow`, and
|
||||||
|
`hourly`. The template files, partials, and complete render-context field
|
||||||
|
reference are maintained in
|
||||||
|
[report templates](../templates.md).
|
||||||
|
|
||||||
## Purpose
|
## Assets and lookup
|
||||||
|
|
||||||
`internal/reporttemplate` owns repository-native report templates and companion
|
The package embeds top-level templates and shared partials. `Template` returns
|
||||||
GeneratedText JSON schemas. The implemented template assets are Daily, Today,
|
the requested embedded template and fails with the requested ID when it is
|
||||||
Tomorrow, and Hourly.
|
unknown or unreadable.
|
||||||
|
|
||||||
The package embeds assets from:
|
Generated-text schemas and Promptkit definitions are owned by
|
||||||
|
`internal/promptassets`; report-template owns Markdown source only. Report
|
||||||
|
definitions select IDs, while [generated-text internals](generatedtext.md)
|
||||||
|
verifies the supported schema/template pairing.
|
||||||
|
|
||||||
- `internal/reporttemplate/templates/*.md.tmpl`
|
## Rendering
|
||||||
- `internal/reporttemplate/schemas/*.schema.json`
|
|
||||||
|
|
||||||
Generated-text prompt source files live under
|
`Render` loads the top-level template, creates a `text/template` with helper
|
||||||
`internal/reporttemplate/prompts/`. They are repository assets for prompt
|
functions and `missingkey=error`, parses the template, parses every shared
|
||||||
registration, not embedded lookup APIs.
|
partial, and executes the result against the typed render context. This makes
|
||||||
|
missing context fields, bad template syntax, unreadable partials, and execution
|
||||||
|
failures actionable with template or partial context.
|
||||||
|
|
||||||
## Inputs And Outputs
|
Top-level templates decide which shared partials they invoke. The current
|
||||||
|
partials cover daypart forecast variants, alert digest, and precipitation
|
||||||
|
timing. Template code receives curated typed contexts rather than raw data
|
||||||
|
packages, and it must not reimplement weather selection or generated-text
|
||||||
|
validation.
|
||||||
|
|
||||||
Inputs:
|
## Boundaries and verification
|
||||||
|
|
||||||
- template ID from a report definition
|
This package does not collect weather data, build modules, validate generated
|
||||||
- typed render context built by `internal/generatedtext`
|
text, construct contexts, resolve report definitions, write state, execute
|
||||||
|
Promptkit, or upload reports. It produces Markdown bytes for application
|
||||||
|
orchestration to persist.
|
||||||
|
|
||||||
Outputs:
|
Focused tests cover template lookup, rendering, partial
|
||||||
|
behavior, missing keys, and malformed context:
|
||||||
|
|
||||||
- template source for inspection and tests
|
```sh
|
||||||
- GeneratedText schema bytes for prompt/schema configuration
|
go test ./internal/reporttemplate
|
||||||
- rendered Markdown bytes for app orchestration to persist
|
```
|
||||||
|
|
||||||
The implemented template IDs are `daily`, `today`, `tomorrow`, and `hourly`.
|
Embedded templates stay as separate files and shared fragments stay under the
|
||||||
The implemented schema IDs are also `daily`, `today`, `tomorrow`, and
|
partial directory. Generated-text schemas are embedded separately by
|
||||||
`hourly`, backed by matching `*.generated_text.schema.json` files.
|
`internal/promptassets` and describe prose slots rather than deterministic
|
||||||
|
weather facts.
|
||||||
Generated-text prompt sources are maintained under
|
|
||||||
`internal/reporttemplate/prompts/`, including Daily's
|
|
||||||
`daily.generated_text.md` source for prompt ID `weather.daily_generated_text`.
|
|
||||||
|
|
||||||
## Boundaries
|
|
||||||
|
|
||||||
This package owns embedded asset lookup, Go template parsing, and Markdown
|
|
||||||
template execution. It does not fetch weather data, build module outputs,
|
|
||||||
validate GeneratedText, construct render contexts, choose report definitions,
|
|
||||||
write artifacts, invoke Scriptorium, or notify distributor.
|
|
||||||
|
|
||||||
GeneratedText validation is owned by `internal/generatedtext`. App
|
|
||||||
orchestration uses `internal/generatedtext` catalog lookup to connect
|
|
||||||
`internal/report` definition schema/template IDs to the matching validator,
|
|
||||||
render-context builder, and embedded assets.
|
|
||||||
|
|
||||||
## Template Contracts
|
|
||||||
|
|
||||||
Daily, Today, Tomorrow, and Hourly rendering use typed render contexts with:
|
|
||||||
|
|
||||||
- report metadata labels such as title, location, valid period, and generation
|
|
||||||
time
|
|
||||||
- validated GeneratedText prose slots
|
|
||||||
- deterministic labels derived from module outputs, including current
|
|
||||||
conditions, hourly forecast rows, precipitation timing, alerts, SPC outlooks,
|
|
||||||
forecast discussion, SPC discussion, and weather story
|
|
||||||
|
|
||||||
Daily, Today, and Tomorrow additionally expose forecast-date labels, ordered
|
|
||||||
daypart forecast rows, daily/daypart summaries, planning facts, and a
|
|
||||||
multi-paragraph forecast discussion generated-text slot. The ordered daypart
|
|
||||||
slice is built in Go so templates do not range over maps.
|
|
||||||
|
|
||||||
The Daily template asset uses the same Markdown structure as Tomorrow's
|
|
||||||
template and renders from `generatedtext.DailyRenderContext`.
|
|
||||||
|
|
||||||
Templates use `text/template` with `missingkey=error`, so missing context fields
|
|
||||||
fail rendering instead of producing incomplete Markdown.
|
|
||||||
|
|
||||||
## Schema Contract
|
|
||||||
|
|
||||||
The GeneratedText schemas describe the structured prose Scriptorium is expected
|
|
||||||
to write for each generated-text prompt. Hourly requires:
|
|
||||||
|
|
||||||
- `summary`
|
|
||||||
- `forecast_discussion`
|
|
||||||
|
|
||||||
Daily, Today, and Tomorrow require `summary` and a nonempty
|
|
||||||
`forecast_discussion` array. All generated-text schemas allow optional
|
|
||||||
`precipitation_timing` and `confidence`, and reject additional properties.
|
|
||||||
Weather truth remains in module outputs; GeneratedText is limited to prose
|
|
||||||
slots consumed by the template.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
- Unknown template IDs return actionable lookup errors.
|
|
||||||
- Unknown schema IDs return actionable lookup errors.
|
|
||||||
- Template parse errors include the template ID.
|
|
||||||
- Template execution errors include the template ID and usually identify the
|
|
||||||
missing context field.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Inspect:
|
|
||||||
|
|
||||||
- `internal/reporttemplate/reporttemplate_test.go`
|
|
||||||
- `internal/generatedtext/render_context_test.go`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
- `internal/cli/root_test.go`
|
|
||||||
|
|
||||||
## Invariants
|
|
||||||
|
|
||||||
- Embedded templates and schemas live as separate files, not inline Go strings.
|
|
||||||
- Report definitions select templates by ID.
|
|
||||||
- Templates render from curated render contexts, not raw data packages.
|
|
||||||
- GeneratedText schemas describe LLM prose slots, not deterministic weather
|
|
||||||
facts.
|
|
||||||
|
|||||||
@@ -1,110 +0,0 @@
|
|||||||
# Scriptorium Adapter Internals
|
|
||||||
|
|
||||||
This document describes the subprocess adapter in
|
|
||||||
`internal/adapters/scriptorium`.
|
|
||||||
|
|
||||||
## Purpose
|
|
||||||
|
|
||||||
The adapter runs `scriptorium render` for prompt preflight and `scriptorium run`
|
|
||||||
for Markdown report generation or structured generated-text output. It isolates
|
|
||||||
subprocess execution, argv construction, timeout handling, output capture, and
|
|
||||||
exit-code interpretation from app and domain packages.
|
|
||||||
|
|
||||||
## Inputs And Outputs
|
|
||||||
|
|
||||||
Inputs:
|
|
||||||
|
|
||||||
- prompt ID
|
|
||||||
- YAML prompt input data package path
|
|
||||||
- report output path for `run`
|
|
||||||
- raw generated-text output path for structured `run`
|
|
||||||
- configured binary, config path, profile, timeout, and extra arguments
|
|
||||||
- context for cancellation
|
|
||||||
|
|
||||||
Outputs:
|
|
||||||
|
|
||||||
- argv used for execution
|
|
||||||
- captured stdout and stderr
|
|
||||||
- truncation flags for captured output
|
|
||||||
- exit code
|
|
||||||
- report output path for `run`
|
|
||||||
- raw generated-text output path for structured `run`
|
|
||||||
|
|
||||||
## Boundaries
|
|
||||||
|
|
||||||
`internal/adapters/scriptorium` owns Scriptorium command construction and
|
|
||||||
subprocess execution. It does not choose report types, build prompt input,
|
|
||||||
fetch weather data, decide workflow order, or persist workflow metadata.
|
|
||||||
|
|
||||||
The adapter exposes request and result structs for render, Markdown run, and
|
|
||||||
structured generated-text run operations. State persistence uses state-owned
|
|
||||||
artifact shapes; app orchestration converts adapter results before saving.
|
|
||||||
|
|
||||||
## Config Fields Used
|
|
||||||
|
|
||||||
- `scriptorium.binary`
|
|
||||||
- `scriptorium.config_path`
|
|
||||||
- `scriptorium.profile`
|
|
||||||
- `scriptorium.timeout`
|
|
||||||
- `scriptorium.extra_args`
|
|
||||||
|
|
||||||
## Commands
|
|
||||||
|
|
||||||
Render preflight argv starts with:
|
|
||||||
|
|
||||||
```text
|
|
||||||
scriptorium render --prompt <prompt_id> --input data_package=<path> --format json
|
|
||||||
```
|
|
||||||
|
|
||||||
Report generation argv starts with:
|
|
||||||
|
|
||||||
```text
|
|
||||||
scriptorium run --prompt <prompt_id> --input data_package=<path> --out <path>
|
|
||||||
```
|
|
||||||
|
|
||||||
Structured generated-text argv uses the same `scriptorium run` form, with the
|
|
||||||
`--out` value set to the raw generated-text JSON artifact path. The adapter
|
|
||||||
does not add `--format`, schema path, or JSON Schema flags for structured
|
|
||||||
generation; Scriptorium selects the structured output schema from prompt
|
|
||||||
configuration.
|
|
||||||
|
|
||||||
Configured `--config` and `--profile` flags are inserted after the subcommand
|
|
||||||
and before prompt-specific arguments. Extra arguments are appended after the
|
|
||||||
built-in arguments.
|
|
||||||
|
|
||||||
## Execution Behavior
|
|
||||||
|
|
||||||
The adapter runs commands without shell interpolation. The same private
|
|
||||||
execution path is used by render, Markdown run, and structured run after
|
|
||||||
command-specific request validation and argv construction.
|
|
||||||
|
|
||||||
When `scriptorium.timeout` is greater than zero, each subprocess call uses a
|
|
||||||
context with that timeout. Stdout and stderr are captured separately, capped at
|
|
||||||
1 MiB each, and marked as truncated when the cap is reached.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
- Missing prompt ID or data package path returns an error before subprocess
|
|
||||||
execution.
|
|
||||||
- Missing run output path returns an error before subprocess execution.
|
|
||||||
- Subprocess start errors, context cancellation, and timeouts are wrapped with
|
|
||||||
operation context by the caller-facing method.
|
|
||||||
- Nonzero render, Markdown run, and structured run exits return the captured
|
|
||||||
result plus an error containing the exit code and stderr.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Inspect:
|
|
||||||
|
|
||||||
- `internal/adapters/scriptorium/runner_test.go`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
- `internal/cli/root_test.go`
|
|
||||||
|
|
||||||
## Invariants
|
|
||||||
|
|
||||||
- No shell interpolation is used.
|
|
||||||
- The Scriptorium input name is `data_package`.
|
|
||||||
- The file at the data package path is YAML produced by `internal/promptinput`.
|
|
||||||
- Render, Markdown run, and structured run preserve command-specific result
|
|
||||||
structs.
|
|
||||||
- Scriptorium-specific flags stay inside adapter and config boundaries.
|
|
||||||
@@ -1,148 +0,0 @@
|
|||||||
# State Internals
|
|
||||||
|
|
||||||
This document describes filesystem state in `internal/state`.
|
|
||||||
|
|
||||||
## Purpose
|
|
||||||
|
|
||||||
`internal/state` owns managed workspace paths, atomic JSON writes, persisted
|
|
||||||
metadata, prior snapshot lookup, and read-only artifact inspection helpers.
|
|
||||||
|
|
||||||
## Inputs And Outputs
|
|
||||||
|
|
||||||
Inputs:
|
|
||||||
|
|
||||||
- workspace configuration
|
|
||||||
- resolved report definition and valid period
|
|
||||||
- module snapshot
|
|
||||||
- prompt input data package
|
|
||||||
- preflight artifact
|
|
||||||
- generated-text raw, run-result, validated text, and render-context artifacts
|
|
||||||
- rendered report path preparation request
|
|
||||||
- RunID for inspection lookups
|
|
||||||
|
|
||||||
Outputs:
|
|
||||||
|
|
||||||
- module snapshot JSON path
|
|
||||||
- prompt input data package YAML path
|
|
||||||
- render preflight JSON path
|
|
||||||
- generated-text raw JSON path
|
|
||||||
- generated-text run-result JSON path
|
|
||||||
- validated generated-text JSON path
|
|
||||||
- render context JSON path
|
|
||||||
- managed Markdown report path
|
|
||||||
- metadata JSON path
|
|
||||||
- prior comparable snapshot metadata
|
|
||||||
- loaded module snapshot, data package, generated text, generated-text run
|
|
||||||
result, or render context
|
|
||||||
- recent report records for inspection
|
|
||||||
|
|
||||||
## Boundaries
|
|
||||||
|
|
||||||
`internal/state` owns local filesystem layout, path validation, durable writes,
|
|
||||||
metadata reads, prior lookup, and report listing. It does not fetch weather
|
|
||||||
data, derive forecasts, build prompt input content, compare module contents,
|
|
||||||
invoke Scriptorium, import adapter result types, or parse CLI flags.
|
|
||||||
|
|
||||||
Preflight persistence uses the state-owned `PreflightArtifact` shape. The app
|
|
||||||
converts adapter render results into that shape before saving.
|
|
||||||
|
|
||||||
## Config Fields Used
|
|
||||||
|
|
||||||
- `workspace.root`
|
|
||||||
- `workspace.snapshots_dir`
|
|
||||||
- `workspace.reports_dir`
|
|
||||||
- `workspace.data_packages_dir`
|
|
||||||
- `workspace.preflight_dir`
|
|
||||||
- `workspace.notifications_dir`
|
|
||||||
|
|
||||||
Workspace subdirectories must be relative paths that stay under
|
|
||||||
`workspace.root`.
|
|
||||||
|
|
||||||
## Managed Layout
|
|
||||||
|
|
||||||
Paths are derived from the resolved report definition's artifact group, the
|
|
||||||
valid-period start date for dated artifacts, and the RunID.
|
|
||||||
|
|
||||||
```text
|
|
||||||
<workspace.root>/
|
|
||||||
snapshots/<artifact_group>/<YYYY-MM-DD>/<run_id>.modules.json
|
|
||||||
snapshots/<artifact_group>/<YYYY-MM-DD>/<run_id>.metadata.json
|
|
||||||
snapshots/<artifact_group>/<YYYY-MM-DD>/<run_id>.generated_text.raw.json
|
|
||||||
snapshots/<artifact_group>/<YYYY-MM-DD>/<run_id>.generated_text.run.json
|
|
||||||
snapshots/<artifact_group>/<YYYY-MM-DD>/<run_id>.generated_text.json
|
|
||||||
snapshots/<artifact_group>/<YYYY-MM-DD>/<run_id>.render_context.json
|
|
||||||
data-packages/<artifact_group>/<YYYY-MM-DD>/<run_id>.data_package.yaml
|
|
||||||
preflight/<artifact_group>/<YYYY-MM-DD>/<run_id>.render.json
|
|
||||||
notifications/<artifact_group>/<YYYY-MM-DD>/<run_id>.distributor.json
|
|
||||||
reports/<artifact_group>/<run_id>.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Metadata is stored beside module snapshots and links the module snapshot, data
|
|
||||||
package, preflight, report paths, notification path when attempted, and
|
|
||||||
configured prompt location. For generated-text-template reports, metadata also
|
|
||||||
records the generated text schema ID and links the raw generated text,
|
|
||||||
Scriptorium run result, validated generated text, and render context artifacts.
|
|
||||||
Markdown-report metadata omits those generated-text fields. Report listing
|
|
||||||
walks metadata files under the snapshots directory.
|
|
||||||
|
|
||||||
## Prior Lookup
|
|
||||||
|
|
||||||
Prior snapshot lookup reads stored metadata through the shared lookup path and
|
|
||||||
selects the latest earlier snapshot whose report ID is compatible with the
|
|
||||||
current report definition.
|
|
||||||
|
|
||||||
- Daily Report compares with prior Daily Report snapshots for the same valid
|
|
||||||
local date.
|
|
||||||
- Today Report compares with prior Today Report snapshots for the same valid
|
|
||||||
local date.
|
|
||||||
- Tomorrow Report compares with prior Tomorrow Report snapshots for the same
|
|
||||||
valid local date.
|
|
||||||
- 3-Day Outlook compares with prior 3-Day snapshots for the same valid local
|
|
||||||
date.
|
|
||||||
- Weekend Outlook compares with prior Weekend snapshots for the same weekend
|
|
||||||
window.
|
|
||||||
- Hourly Report uses the rolling-window comparison strategy and currently
|
|
||||||
returns no prior snapshot from filesystem lookup.
|
|
||||||
- Storm Report has no prior lookup because explicit event-window comparison is
|
|
||||||
not searched by the filesystem store.
|
|
||||||
|
|
||||||
## Writes And Inspection
|
|
||||||
|
|
||||||
Durable JSON writes use shared atomic file helpers. Generated-text raw and
|
|
||||||
validated JSON artifacts are written atomically as bytes; generated-text run
|
|
||||||
result and render context artifacts are written atomically as JSON. Managed
|
|
||||||
Markdown reports are prepared by creating their parent directory; Scriptorium
|
|
||||||
writes the report body to the prepared path. Extra Markdown copies are handled
|
|
||||||
by app orchestration. Distributor notification debug artifacts are written
|
|
||||||
atomically when notification is attempted and include rendered distributor
|
|
||||||
pipeline ID, bundle ID, idempotency key, bundle paths, upload status, latest
|
|
||||||
run status, and redacted errors.
|
|
||||||
|
|
||||||
Inspection helpers read existing metadata, module snapshot, data package,
|
|
||||||
generated text, generated-text run result, and render context files. Missing
|
|
||||||
metadata directories return no inspection records or no prior snapshot rather
|
|
||||||
than creating state.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
- Invalid workspace paths return validation errors.
|
|
||||||
- Missing required metadata fields prevent metadata writes.
|
|
||||||
- JSON writes use a temporary file followed by rename where practical.
|
|
||||||
- Read and decode failures include path context.
|
|
||||||
- Unknown RunIDs produce an actionable lookup error.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Inspect:
|
|
||||||
|
|
||||||
- `internal/state/filesystem_test.go`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
|
|
||||||
## Invariants
|
|
||||||
|
|
||||||
- Managed paths stay under the configured workspace root.
|
|
||||||
- Artifact grouping comes from report definitions.
|
|
||||||
- Metadata links artifacts produced for a run.
|
|
||||||
- Generated-text artifacts live under the snapshots tree beside module
|
|
||||||
snapshots and metadata.
|
|
||||||
- Prior lookup is based on structured metadata, not rendered report text.
|
|
||||||
@@ -1,101 +1,68 @@
|
|||||||
# Weather Data Internals
|
# Weather Data Internals
|
||||||
|
|
||||||
This document describes Weather API ingestion into `weatherdata.Bundle`.
|
`internal/weatherdata` owns the normalized, wire-independent weather bundle
|
||||||
|
that passes from collection through rendering. The Weather API
|
||||||
|
adapter translates provider responses into these types; its request, response,
|
||||||
|
and availability contract is documented in the
|
||||||
|
[Weather API integration guide](../integrations/weatherapi.md).
|
||||||
|
|
||||||
## Purpose
|
## Bundle contract
|
||||||
|
|
||||||
`internal/adapters/weatherapi` fetches normalized weather data from the
|
`Bundle` has a collection timestamp (`FetchedAt`), source provenance
|
||||||
configured Weather API and assembles the bundle consumed by forecast derivation
|
(`Sources`), and collection-level warnings (`Warnings`). Its product fields are
|
||||||
and module builders. Module builders expose normalized current conditions and
|
optional so an allowed missing source can be represented without manufacturing
|
||||||
weather story context when those sources are available.
|
weather data.
|
||||||
|
|
||||||
## Inputs And Outputs
|
| Field | Normalized product |
|
||||||
|
| --- | --- |
|
||||||
|
| `Observation` | Station observation |
|
||||||
|
| `Current` | Current conditions |
|
||||||
|
| `Hourly` | Hourly forecast periods |
|
||||||
|
| `Narrative` | Narrative forecast |
|
||||||
|
| `Alerts` | Active-alert check, including an explicitly empty result |
|
||||||
|
| `Discussion` | Forecast discussion and its time-range sections |
|
||||||
|
| `Daily` | Daily forecast periods when supplied |
|
||||||
|
| `WeatherStory` | Latest weather story |
|
||||||
|
| `SPCConvectiveOutlooks` | Convective outlook run, discussions, and GeoJSON geometry |
|
||||||
|
|
||||||
Inputs:
|
The bundle carries values rather than provider request details. Consumers use
|
||||||
|
it to construct report facts and data packages; they should not infer a
|
||||||
|
provider endpoint or retry policy from the normalized types. See
|
||||||
|
[collection](collect.md) for assembly and
|
||||||
|
[report templates](../templates.md) for the values exposed to authors.
|
||||||
|
|
||||||
- `config.Config` with Weather API URL, timeout, format, units, timezone,
|
## Source provenance
|
||||||
precision, and missing-source policy
|
|
||||||
- HTTP responses using the Weather API `data` envelope
|
|
||||||
|
|
||||||
Outputs:
|
Every checked source is represented by a `Source` entry. The record identifies
|
||||||
|
the source (`Name`), request location and query (`Endpoint`, `Query`), fetch
|
||||||
|
time, provider issue and update times when available, a SHA-256 digest of the
|
||||||
|
source data, and whether the source was unavailable (`Missing`). Its warnings
|
||||||
|
stay with that source in addition to the bundle-level warning list.
|
||||||
|
|
||||||
- `weatherdata.Bundle` with observation, current conditions, hourly forecast,
|
An empty product can be meaningful checked data. For example, an explicit
|
||||||
narrative forecast, active alerts, discussion, latest weather story, source
|
empty alerts result is not missing and retains its source hash. A source is
|
||||||
records, source warnings, and typed SPC convective outlook data when that
|
marked missing only when the adapter's missing-source policy treats the
|
||||||
optional source is available
|
response or parsing failure as unavailable. The policy itself belongs to the
|
||||||
- optional saved bundle JSON through app fetch helpers
|
[configuration reference](../config.md).
|
||||||
|
|
||||||
## Boundaries
|
## Warning semantics
|
||||||
|
|
||||||
- The adapter owns HTTP calls, response-envelope handling, source hashing, and
|
`SourceWarning` has a source name, stable code, severity, explanatory message,
|
||||||
decoding into internal bundle types.
|
endpoint, and `CompletenessImpact`. When collection proceeds with a warning,
|
||||||
- It does not derive dayparts, resolve report periods, build module values, compare
|
the same warning appears in `Source.Warnings` and `Bundle.Warnings` so both
|
||||||
snapshots, write report state, or invoke Scriptorium.
|
local provenance and whole-run consumers see it. A policy that treats a missing
|
||||||
|
source as an error returns no partial bundle.
|
||||||
|
|
||||||
## Config Fields Used
|
Warnings describe data completeness, not rendering or delivery failures.
|
||||||
|
Those failures are reported by [application orchestration](app-orchestration.md).
|
||||||
|
|
||||||
- `weather_api.base_url`
|
## Boundaries and verification
|
||||||
- `weather_api.timeout`
|
|
||||||
- `weather_api.format`
|
|
||||||
- `weather_api.units`
|
|
||||||
- `weather_api.timezone`
|
|
||||||
- `weather_api.precision`
|
|
||||||
- `missing_source.default`
|
|
||||||
- `missing_source.sources`
|
|
||||||
|
|
||||||
## External Adapters Used
|
This package defines data shapes and has no HTTP client, configuration loader,
|
||||||
|
filesystem access, or template behavior. Focused tests cover the normalized
|
||||||
|
types and the Weather API adapter verifies translation into them:
|
||||||
|
|
||||||
- Weather API HTTP service
|
```sh
|
||||||
|
go test ./internal/weatherdata
|
||||||
See [Weather API integration](../integrations/weatherapi.md) for the external
|
go test ./internal/adapters/weatherapi
|
||||||
contract used by this project.
|
```
|
||||||
|
|
||||||
## State Or Manifest Behavior
|
|
||||||
|
|
||||||
The adapter records source name, endpoint, query, fetch time, source timestamps
|
|
||||||
when available, SHA-256 hash over compact raw `data` JSON, missing status, and
|
|
||||||
source warnings. Successful `data: null` responses from `/alerts/active`
|
|
||||||
represent a checked empty active-alert list, not a missing source. Successful
|
|
||||||
non-null `/outlooks/convective` responses with empty outlook and discussion
|
|
||||||
arrays represent checked empty outlook data.
|
|
||||||
`app.FetchAndSaveBundle` can write bundle JSON atomically for inspection.
|
|
||||||
|
|
||||||
SPC convective outlook data is stored on
|
|
||||||
`weatherdata.Bundle.SPCConvectiveOutlooks`. The collected run keeps upstream
|
|
||||||
run metadata, location identifiers, ordered outlook records, discussion
|
|
||||||
records, and each outlook's raw GeoJSON geometry. Source provenance for this
|
|
||||||
payload uses the `spc_convective_outlooks` source name, endpoint
|
|
||||||
`/outlooks/convective`, the query sent by the adapter, timestamps, and a hash
|
|
||||||
of the raw `data` object.
|
|
||||||
|
|
||||||
## Skip And Resume Behavior
|
|
||||||
|
|
||||||
No resume behavior. Optional missing or malformed sources may be omitted,
|
|
||||||
warned, or treated as errors according to missing-source policy. Hourly forecast
|
|
||||||
data is required and cannot be skipped.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
- Missing or invalid `weather_api.base_url` prevents client construction.
|
|
||||||
- HTTP errors, response read failures, and envelope decode failures include
|
|
||||||
endpoint context.
|
|
||||||
- Missing hourly data or hourly forecasts with no periods fail bundle fetch.
|
|
||||||
- Optional sources follow missing-source policy.
|
|
||||||
- Explicit `data: null` from `/alerts/active` produces an empty, non-missing
|
|
||||||
alert run.
|
|
||||||
- Explicit `data: null` from `/outlooks/convective` follows optional
|
|
||||||
missing-source policy.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Inspect:
|
|
||||||
|
|
||||||
- `internal/adapters/weatherapi/client_test.go`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
|
|
||||||
## Invariants
|
|
||||||
|
|
||||||
- Weather facts come from normalized source data.
|
|
||||||
- Full hourly and narrative products are fetched; Go owns report-period
|
|
||||||
selection.
|
|
||||||
- Source provenance and warnings remain inspectable downstream.
|
|
||||||
|
|||||||
@@ -1,347 +1,126 @@
|
|||||||
# Weatherreporter Operations
|
# Weatherreporter Operations
|
||||||
|
|
||||||
This guide covers normal operation, generated artifacts, inspection, recovery,
|
This guide covers normal output handling, Distributor notification, secure
|
||||||
and operational caveats. For symptom-specific diagnosis, see
|
prompt diagnostics, and cleanup of legacy application state. See the [CLI
|
||||||
[Troubleshooting](troubleshooting.md).
|
reference](cli.md) for command syntax and the [configuration reference](config.md)
|
||||||
|
for fields, defaults, and notification templates.
|
||||||
|
|
||||||
## Normal Workflow
|
## Normal Operation
|
||||||
|
|
||||||
Generation commands:
|
After configuring a Weather API endpoint, generate one report:
|
||||||
|
|
||||||
```text
|
```sh
|
||||||
weatherreporter generate daily --date 2026-05-29
|
|
||||||
weatherreporter generate today
|
weatherreporter generate today
|
||||||
weatherreporter generate tomorrow
|
|
||||||
weatherreporter generate hourly
|
|
||||||
weatherreporter generate three-day
|
|
||||||
weatherreporter generate weekend
|
|
||||||
weatherreporter generate storm --start 2026-05-29T18:00 --end 2026-05-30T06:00
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Generation commands resolve a report period, fetch a Weather API bundle, build
|
The command writes `today.md` in the current directory. Choose a different
|
||||||
a rich JSON module snapshot, build a curated YAML prompt input data package, run
|
operator-owned file with `--out`; a relative path is resolved from the current
|
||||||
`scriptorium render`, and write managed artifacts under the configured
|
directory and an absolute path is used directly. Weatherreporter renders in
|
||||||
workspace. Markdown-path reports then run `scriptorium run` directly to the
|
memory and atomically replaces the selected destination only after generation
|
||||||
managed Markdown report path.
|
and rendering succeed. It does not create a default workspace, metadata,
|
||||||
|
receipts, or intermediate output files.
|
||||||
|
|
||||||
`generate daily`, `generate today`, `generate tomorrow`, and `generate hourly`
|
Before a destination is published, provider, validation, rendering, write, and
|
||||||
use the generated-text-template workflow. They run structured `scriptorium run`
|
cancellation failures leave an existing report unchanged. A notification
|
||||||
to raw GeneratedText JSON, validate the structured text, save a render context,
|
failure happens after publication, so retain and use the completed Markdown
|
||||||
and render the managed Markdown report from embedded templates. `generate
|
file while resolving the delivery error. The JSON result identifies the
|
||||||
daily` requires `--date YYYY-MM-DD` for the selected local civil day.
|
absolute output path and active profile, backend, model, warnings, validation,
|
||||||
`generate today` covers the selected or current local civil day. `generate
|
debug, and notification information; see the [CLI reference](cli.md) for its
|
||||||
hourly` covers the six-hour rolling period from generation time in the
|
exact fields.
|
||||||
effective report timezone and is not part of scheduled morning or evening
|
|
||||||
batches.
|
|
||||||
|
|
||||||
When distributor notification is enabled, weatherreporter uploads the managed
|
## Batch Outputs And Distributor Notification
|
||||||
Markdown report after report rendering succeeds and final metadata is saved.
|
|
||||||
`--out PATH` writes an extra Markdown copy for generated reports; it is not used
|
|
||||||
as the distributor upload source.
|
|
||||||
|
|
||||||
Batch commands:
|
Run a scheduled batch with an explicit output directory when appropriate:
|
||||||
|
|
||||||
```text
|
```sh
|
||||||
weatherreporter run morning
|
weatherreporter run morning --out-dir ./reports
|
||||||
weatherreporter run evening
|
|
||||||
```
|
```
|
||||||
|
|
||||||
`run morning` generates Today Report and the 3-Day Outlook, plus Weekend Outlook
|
Without `--out-dir`, batch reports are written beneath the current directory.
|
||||||
except on Sunday. `run evening` generates the Tomorrow Report. Batch
|
Morning runs Today, Tomorrow, and every eligible dated Daily Report; evening
|
||||||
commands print a JSON summary to stdout, write compact per-report status lines
|
runs Tomorrow and the same eligible Daily Reports. Eligible Daily dates begin
|
||||||
to stderr, continue independent reports after one report fails, and return
|
after tomorrow and require complete hourly coverage for their local civil day.
|
||||||
nonzero when any report failed. When notification is configured, the summary and
|
A batch collects once, determines the complete report set, and validates every
|
||||||
status lines include notification status, accepted distributor run ID, or
|
final output destination before executing its first report prompt. A destination
|
||||||
notification error fields for each attempted report. `--out-dir PATH` writes
|
collision, such as a directory named `tomorrow.md`, stops the batch before any
|
||||||
extra Markdown copies using report default filenames such as `today.md`,
|
report output is created or replaced. After successful validation, each selected
|
||||||
`three-day.md`, `weekend.md`, and `tomorrow.md`; these copies are not used as
|
report processes independently and successful outputs remain available if
|
||||||
distributor upload sources.
|
another report fails.
|
||||||
|
|
||||||
## Filesystem Layout
|
When `notify.distributor.enabled` and batch notification are enabled,
|
||||||
|
Weatherreporter sends one Distributor upload only after every selected output
|
||||||
|
exists. If an item fails, the batch notification is skipped and successful
|
||||||
|
files remain at their selected destinations. A batch notification failure also
|
||||||
|
leaves all successfully published report files in place. Distributor source
|
||||||
|
files are those operator-owned Markdown outputs; rendered bundle paths and
|
||||||
|
delivery status appear in the result, not in a local notification receipt.
|
||||||
|
Report counters count report items only. A batch notification failure therefore
|
||||||
|
returns a failed batch status even when all report counters show success; the
|
||||||
|
top-level notification result contains the delivery diagnostic.
|
||||||
|
|
||||||
The default workspace root is `workspace`.
|
For a single report, Distributor notification follows the atomic output write.
|
||||||
|
See the [configuration reference](config.md) for pipeline, bundle,
|
||||||
|
idempotency-key, and per-report path templates.
|
||||||
|
|
||||||
```text
|
## Local Prompt Profile Override
|
||||||
workspace/
|
|
||||||
snapshots/
|
Hourly normally selects the embedded `weather-light` profile. To use a local
|
||||||
daily/
|
OpenAI-compatible model without changing prompts or application code, copy
|
||||||
YYYY-MM-DD/
|
[weather-light-local-profile.yml](../examples/weather-light-local-profile.yml),
|
||||||
<run_id>.modules.json
|
set its `endpoint` and `model` for the local server, and configure the copy as
|
||||||
<run_id>.metadata.json
|
`promptkit.profile_file`. The profile file's `weather-light` definition
|
||||||
<run_id>.generated_text.raw.json
|
completely replaces the embedded definition; it does not affect a report that
|
||||||
<run_id>.generated_text.run.json
|
selects another profile ID.
|
||||||
<run_id>.generated_text.json
|
|
||||||
<run_id>.render_context.json
|
Prompt and profile validation occurs before weather collection. A malformed
|
||||||
today/
|
profile file, missing required credential, or unsupported selected backend
|
||||||
YYYY-MM-DD/
|
stops the command before collection. A reachable profile can still fail later
|
||||||
<run_id>.modules.json
|
if its local model endpoint is unavailable; Weatherreporter does not switch to
|
||||||
<run_id>.metadata.json
|
a remote profile.
|
||||||
<run_id>.generated_text.raw.json
|
|
||||||
<run_id>.generated_text.run.json
|
## Optional Prompt Debug Capture
|
||||||
<run_id>.generated_text.json
|
|
||||||
<run_id>.render_context.json
|
Use `--llm-debug-dir` only when content-rich prompt diagnostics are required:
|
||||||
three-day/
|
|
||||||
YYYY-MM-DD/
|
```sh
|
||||||
<run_id>.modules.json
|
weatherreporter generate today --llm-debug-dir /var/tmp/weatherreporter-debug
|
||||||
<run_id>.metadata.json
|
|
||||||
weekend/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.modules.json
|
|
||||||
<run_id>.metadata.json
|
|
||||||
hourly/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.modules.json
|
|
||||||
<run_id>.metadata.json
|
|
||||||
<run_id>.generated_text.raw.json
|
|
||||||
<run_id>.generated_text.run.json
|
|
||||||
<run_id>.generated_text.json
|
|
||||||
<run_id>.render_context.json
|
|
||||||
tomorrow/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.modules.json
|
|
||||||
<run_id>.metadata.json
|
|
||||||
<run_id>.generated_text.raw.json
|
|
||||||
<run_id>.generated_text.run.json
|
|
||||||
<run_id>.generated_text.json
|
|
||||||
<run_id>.render_context.json
|
|
||||||
storm/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.modules.json
|
|
||||||
<run_id>.metadata.json
|
|
||||||
data-packages/
|
|
||||||
daily/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.data_package.yaml
|
|
||||||
today/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.data_package.yaml
|
|
||||||
three-day/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.data_package.yaml
|
|
||||||
weekend/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.data_package.yaml
|
|
||||||
hourly/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.data_package.yaml
|
|
||||||
tomorrow/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.data_package.yaml
|
|
||||||
storm/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.data_package.yaml
|
|
||||||
preflight/
|
|
||||||
daily/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.render.json
|
|
||||||
today/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.render.json
|
|
||||||
three-day/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.render.json
|
|
||||||
weekend/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.render.json
|
|
||||||
hourly/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.render.json
|
|
||||||
tomorrow/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.render.json
|
|
||||||
storm/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.render.json
|
|
||||||
notifications/
|
|
||||||
daily/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.distributor.json
|
|
||||||
today/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.distributor.json
|
|
||||||
three-day/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.distributor.json
|
|
||||||
weekend/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.distributor.json
|
|
||||||
hourly/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.distributor.json
|
|
||||||
tomorrow/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.distributor.json
|
|
||||||
storm/
|
|
||||||
YYYY-MM-DD/
|
|
||||||
<run_id>.distributor.json
|
|
||||||
reports/
|
|
||||||
daily/
|
|
||||||
<run_id>.md
|
|
||||||
today/
|
|
||||||
<run_id>.md
|
|
||||||
three-day/
|
|
||||||
<run_id>.md
|
|
||||||
weekend/
|
|
||||||
<run_id>.md
|
|
||||||
hourly/
|
|
||||||
<run_id>.md
|
|
||||||
tomorrow/
|
|
||||||
<run_id>.md
|
|
||||||
storm/
|
|
||||||
<run_id>.md
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Managed artifact filenames use the RunID, so repeated runs for the same valid
|
The directory must be absolute. Requested captures are written with restrictive
|
||||||
period do not overwrite each other.
|
permissions beneath the supplied directory, organized by report and run. They
|
||||||
|
can contain rendered prompts and generated output, so limit access to trusted
|
||||||
|
operators and remove the captures when they are no longer needed. Normal output,
|
||||||
|
summaries, and routine logs omit that sensitive content. Debug capture is never
|
||||||
|
created for an ordinary command without `--llm-debug-dir`.
|
||||||
|
|
||||||
## RunID And Metadata
|
If capture creation or writing fails, the affected run fails rather than
|
||||||
|
silently continuing without the requested diagnostics.
|
||||||
|
|
||||||
RunIDs are based on generation time plus report ID:
|
## Diagnosing Failures
|
||||||
|
|
||||||
```text
|
Start with the command error and JSON summary. For a report generation failure,
|
||||||
20260529T100000.123456789Z_daily
|
the selected destination was not replaced; for a notification failure, inspect
|
||||||
20260529T100000.123456789Z_today
|
the completed destination and the notification result. For a batch failure,
|
||||||
|
use the per-report statuses and retain successful output files. Enable explicit
|
||||||
|
debug capture only when content-rich Promptkit diagnostics are necessary.
|
||||||
|
|
||||||
|
Weatherreporter does not retain runs for later inspection, resume failed work,
|
||||||
|
or provide automatic cleanup, archival, remote state, daemon operation, or
|
||||||
|
automatic storm monitoring.
|
||||||
|
|
||||||
|
## Manual Cleanup Of Legacy Workspaces
|
||||||
|
|
||||||
|
Older installations may have a directory named `workspace` containing reports,
|
||||||
|
snapshots, prompt inputs, or notification records from previous versions.
|
||||||
|
Current commands neither read nor update it. After confirming that no separate
|
||||||
|
retention requirement applies, remove that specific legacy directory manually;
|
||||||
|
do not use a broad cleanup command that could remove current operator outputs.
|
||||||
|
|
||||||
|
For example, from the directory that contains the old directory:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
rm -rf ./workspace
|
||||||
```
|
```
|
||||||
|
|
||||||
Each generated report writes metadata that links:
|
This removal cannot be recovered by Weatherreporter. Keep or archive any
|
||||||
|
historical files that are still needed before deleting them.
|
||||||
- RunID, report ID, variant, and prompt ID
|
|
||||||
- generation time, timezone, and valid period
|
|
||||||
- source location, source hashes, and source warnings
|
|
||||||
- module snapshot path
|
|
||||||
- prompt input data package path
|
|
||||||
- preflight output path
|
|
||||||
- managed Markdown report path
|
|
||||||
- generated text schema ID and generated-text artifact paths for
|
|
||||||
generated-text-template reports
|
|
||||||
- distributor notification debug artifact path, when notification is attempted
|
|
||||||
|
|
||||||
Batch summaries include report status, error text when applicable, notification
|
|
||||||
outcome when attempted, valid period, and known artifact paths for each
|
|
||||||
attempted report. Notification fields are `notificationStatus`,
|
|
||||||
`notificationRunId`, and `notificationError`.
|
|
||||||
|
|
||||||
## Distributor Notification
|
|
||||||
|
|
||||||
Distributor notification is configured with `notify.distributor` and is
|
|
||||||
disabled by default. When enabled, weatherreporter uploads the managed Markdown
|
|
||||||
report path recorded in the report result and metadata. That single source file
|
|
||||||
can be mapped to one or more configured bundle paths. By default, it is mapped
|
|
||||||
to one dated report path. Extra copies written by `--out` or `--out-dir` are
|
|
||||||
operator conveniences only.
|
|
||||||
|
|
||||||
The rendered pipeline ID selects the configured distributor `http_upload`
|
|
||||||
workflow. The default bundle ID is a stable logical source identity derived from
|
|
||||||
producer name, location ID, and report ID:
|
|
||||||
|
|
||||||
```text
|
|
||||||
weatherreporter.{location_id}.{report_id}
|
|
||||||
```
|
|
||||||
|
|
||||||
The default idempotency key appends RunID to the rendered bundle ID so each
|
|
||||||
report generation has a distinct retry identity. The default bundle path uses
|
|
||||||
the valid-period start date, artifact group, and RunID. Distributor owns
|
|
||||||
destination merge, retention, and derived snapshot behavior such as `latest`.
|
|
||||||
For Daily, the default report ID and artifact group values are both `daily`,
|
|
||||||
and the default output filename value is `daily.md`.
|
|
||||||
For Today, the default report ID and artifact group values are both `today`,
|
|
||||||
and the batch output filename value is `today.md`.
|
|
||||||
|
|
||||||
Notification happens after final metadata save for generated reports. Weather
|
|
||||||
API, module snapshot, data-package, render preflight, Scriptorium run,
|
|
||||||
generated-text validation, template rendering, and metadata-save failures do
|
|
||||||
not trigger notification. A notification failure fails that report.
|
|
||||||
In a batch, other reports continue, the failed report includes notification
|
|
||||||
fields in the JSON summary, and the batch returns nonzero.
|
|
||||||
|
|
||||||
Each notification attempt writes a debug artifact under `notifications/`. The
|
|
||||||
artifact records the rendered pipeline ID, bundle ID, idempotency key, managed
|
|
||||||
source path, bundle-relative paths, bundle created timestamp, accepted upload
|
|
||||||
response, and the latest distributor run status response when available.
|
|
||||||
Weatherreporter polls status until distributor reports `succeeded` or `failed`,
|
|
||||||
or until the configured notification timeout expires. The run status includes
|
|
||||||
the distributor status, error text, and raw run report JSON, which can show
|
|
||||||
actions such as `replace_older`, `skip_same`, `skip_destination_newer`, or
|
|
||||||
`failed`. Token values are not written.
|
|
||||||
|
|
||||||
Weatherreporter is responsible for selecting the managed Markdown report,
|
|
||||||
constructing a source bundle, and submitting it to the configured distributor
|
|
||||||
HTTP endpoint. Distributor remains responsible for destination routing,
|
|
||||||
publication, and any downstream Markdown-to-HTML transformation. Distributor
|
|
||||||
leaves destination files alone when they are not tracked by a newly uploaded
|
|
||||||
bundle, so existing uploaded dated report paths can remain available.
|
|
||||||
|
|
||||||
## Inspection
|
|
||||||
|
|
||||||
Inspection commands read existing workspace artifacts and emit JSON to stdout.
|
|
||||||
They do not fetch weather data or run `scriptorium`.
|
|
||||||
|
|
||||||
```text
|
|
||||||
weatherreporter inspect reports --limit 10
|
|
||||||
weatherreporter inspect metadata RUN_ID
|
|
||||||
weatherreporter inspect modules RUN_ID
|
|
||||||
weatherreporter inspect data-package RUN_ID
|
|
||||||
weatherreporter inspect prior RUN_ID
|
|
||||||
weatherreporter inspect sources RUN_ID
|
|
||||||
```
|
|
||||||
|
|
||||||
Use `inspect reports` to find RunIDs and artifact paths. Use
|
|
||||||
`inspect metadata` to see the artifact links recorded for a run. Use
|
|
||||||
`inspect modules` to review the persisted ordered module snapshot with rich
|
|
||||||
template-facing values, and `inspect data-package` to review the curated prompt
|
|
||||||
package passed to Scriptorium. Use `inspect prior` to see the prior comparable
|
|
||||||
snapshot selected for Recent Changes, or `null` when none exists. Use
|
|
||||||
`inspect sources` to review source provenance and warnings without dumping full
|
|
||||||
weather payloads.
|
|
||||||
|
|
||||||
## Recent Changes
|
|
||||||
|
|
||||||
Recent Changes are computed from structured module snapshots, not rendered
|
|
||||||
Markdown or YAML text.
|
|
||||||
|
|
||||||
Daily Report compares with prior Daily Report snapshots for the same valid
|
|
||||||
local date. Today Report compares with prior Today Report snapshots for the
|
|
||||||
same valid local date. Tomorrow Report compares with prior Tomorrow Report
|
|
||||||
snapshots for the same valid local date. 3-Day Outlook compares with prior
|
|
||||||
compatible 3-Day snapshots for the same valid local date. Weekend Outlook
|
|
||||||
compares with prior compatible Weekend snapshots for the same weekend window.
|
|
||||||
Hourly Report and Storm Report leave Recent Changes empty.
|
|
||||||
|
|
||||||
When no prior comparable snapshot exists, or no configured threshold is crossed,
|
|
||||||
`recentChanges.items` is empty.
|
|
||||||
|
|
||||||
## Recovery
|
|
||||||
|
|
||||||
A failed generation run may still leave useful artifacts:
|
|
||||||
|
|
||||||
- If `scriptorium render` returns a result with a nonzero exit code, the
|
|
||||||
preflight JSON and metadata are written for inspection.
|
|
||||||
- If `scriptorium run` exits nonzero after writing a report, the managed report
|
|
||||||
and metadata remain available.
|
|
||||||
- Generated-text failures for Daily, Today, Tomorrow, and Hourly reports preserve
|
|
||||||
available intermediate artifacts, such as the structured run result, raw
|
|
||||||
generated-text JSON, validated generated text, and render context. Metadata
|
|
||||||
links those paths when it can be safely written.
|
|
||||||
- If distributor notification fails, report artifacts and final metadata remain
|
|
||||||
available, but the report or batch command returns nonzero.
|
|
||||||
- For batch commands, inspect the stdout JSON summary first, then inspect the
|
|
||||||
artifact paths for each failed report.
|
|
||||||
|
|
||||||
For a bad report, start with:
|
|
||||||
|
|
||||||
```text
|
|
||||||
weatherreporter inspect metadata RUN_ID
|
|
||||||
weatherreporter inspect sources RUN_ID
|
|
||||||
weatherreporter inspect modules RUN_ID
|
|
||||||
weatherreporter inspect data-package RUN_ID
|
|
||||||
weatherreporter inspect prior RUN_ID
|
|
||||||
```
|
|
||||||
|
|
||||||
## Operational Caveats
|
|
||||||
|
|
||||||
- The application uses one configured Weather API endpoint.
|
|
||||||
- The application writes local filesystem state only.
|
|
||||||
- The application does not implement resume, cleanup, archive, remote storage,
|
|
||||||
daemon operation, or automatic storm monitoring.
|
|
||||||
- Generated reports and Scriptorium stderr can contain sensitive operational
|
|
||||||
context. Store workspace artifacts with appropriate filesystem permissions.
|
|
||||||
|
|||||||
@@ -1,125 +1,77 @@
|
|||||||
# Architecture
|
# Architecture Policy
|
||||||
|
|
||||||
This document defines the development principles for this Go project. It is inward-facing: developers and LLM coding agents should use it to preserve the project’s shape, boundaries, and invariants as the code evolves.
|
## Purpose
|
||||||
|
|
||||||
## weatherreporter
|
This policy defines Weatherreporter's system shape, ownership, dependency direction,
|
||||||
`weatherreporter` is a deterministic weather briefing and report-preparation application. It consumes normalized weather data from the internal weatherfeeder-backed API, derives report-specific module snapshots and prompt packages, compares module snapshots against prior runs, and invokes an external prompt runner to produce human-facing reports.
|
and safety invariants. The [development guide](../development.md) owns the
|
||||||
|
package inventory; focused documents in `docs/internal/` own implementation detail.
|
||||||
|
|
||||||
The application should keep meteorological data selection, daypart grouping, threshold detection, forecast-period resolution, and recent-change comparison inside Go domain packages. LLM prompts should receive curated module-based prompt packages rather than raw unbounded source payloads wherever practical.
|
## System Shape
|
||||||
|
|
||||||
Report types must be defined through a registry or equivalent mechanism. Each report definition should declare its report ID, prompt ID, valid-period resolver, module composition, comparison strategy, and output naming behavior. Avoid scattering report-type conditionals across CLI and orchestration code.
|
Weatherreporter is a deterministic weather-report CLI. It collects normalized
|
||||||
|
weather data, derives facts and modules, builds a curated YAML data package,
|
||||||
|
executes exact-version Promptkit prompts, validates structured generated prose,
|
||||||
|
and renders repository-owned Markdown in memory. Completed Markdown is
|
||||||
|
atomically published to an operator-owned output destination and may then be
|
||||||
|
uploaded through Distributor.
|
||||||
|
|
||||||
Generated reports must be associated with explicit metadata, including report type, location, generation time, valid period, source product timestamps or hashes, module snapshot path, and output path. Recent Changes must be based on structured snapshot comparison rather than comparison of rendered Markdown report text.
|
The supported report products are Daily, Today, Tomorrow, and Hourly. A batch
|
||||||
|
collects once, validates its complete candidate prompt/profile set before
|
||||||
|
collection, then determines and validates every planned output destination
|
||||||
|
before executing reports sequentially with one executor. It continues after
|
||||||
|
independent report failures and sends a batch notification only after every
|
||||||
|
planned report succeeds.
|
||||||
|
|
||||||
`scriptorium` is an external adapter, not domain logic. Subprocess execution must be isolated under `internal/adapters/scriptorium`, use context-aware execution, avoid shell interpolation, capture actionable stderr, and keep scriptorium-specific flags from leaking into domain packages.
|
## Ownership And Boundaries
|
||||||
|
|
||||||
`distributor` is also an external adapter. Upload behavior must be isolated
|
- `internal/cli` owns command parsing, help, summaries, and one executor
|
||||||
under `internal/adapters/distributor`, dependency types from the distributor
|
construction per action.
|
||||||
module must not leak outside that adapter, and the selected upload source must
|
- `internal/config` owns defaults, loading, validation, and secret loading.
|
||||||
be the managed Markdown report rather than optional output copies or broad
|
- `internal/app` owns in-memory workflow order, partial results, atomic output
|
||||||
workspace scans.
|
publication, and notification coordination through project-owned contracts.
|
||||||
|
- Deterministic domain packages own weather derivation, report periods, modules,
|
||||||
|
generated-text validation, and template contexts.
|
||||||
|
- `internal/adapters/weatherapi`, `internal/adapters/promptkit`, and
|
||||||
|
`internal/adapters/distributor` own their external dependency mechanics.
|
||||||
|
|
||||||
## Project Shape
|
Dependency-specific Promptkit types remain inside its adapter. The application
|
||||||
|
does not parse flags, construct provider clients, or render provider output
|
||||||
|
directly.
|
||||||
|
|
||||||
Default to a small, explicit, dependency-light Go application. Keep the design modular enough to test and change safely, but do not add abstraction unless it protects a real boundary or enables a real extension point.
|
## Prompt Execution Invariants
|
||||||
|
|
||||||
Business/domain logic should live outside CLI, transport, and external-adapter packages.
|
- Prompts receive curated module packages, never unbounded raw weather payloads.
|
||||||
|
- Every execution validates the exact prompt version and output contract before
|
||||||
|
collection. The selected profile is configured explicitly or declared by the
|
||||||
|
prompt; unsupported direct-key profiles and missing reported credentials fail
|
||||||
|
before collection.
|
||||||
|
- Prompt and profile validation completes before weather collection. Raw output
|
||||||
|
is validated before template rendering.
|
||||||
|
- Generated text fills defined prose slots only. Deterministic facts remain
|
||||||
|
authoritative and repository-owned templates produce all Markdown output.
|
||||||
|
- Sensitive rendered prompts, schemas, input bodies, provider endpoints, and
|
||||||
|
credentials never enter normal summaries or logs. They are written only to
|
||||||
|
an explicit secure debug root when requested.
|
||||||
|
|
||||||
## Dependency Policy
|
## Output, Notification, And Testing Invariants
|
||||||
|
|
||||||
Prefer the Go standard library where practical.
|
- Normal execution is stateless: it keeps weather data, prompt input, generated
|
||||||
|
text, and render context in memory and creates no application-owned durable
|
||||||
|
state.
|
||||||
|
- Markdown writes are atomic at an operator-selected destination. A
|
||||||
|
pre-publication failure, including cancellation observed immediately before
|
||||||
|
publication, does not replace an existing destination; a notification failure
|
||||||
|
does not remove a newly published output.
|
||||||
|
- Distributor uploads use only the published Markdown output, never a scan of
|
||||||
|
local files. Single notification follows publication; batch notification
|
||||||
|
follows publication of every selected report. Batch counters describe report
|
||||||
|
outcomes only; a failed batch notification is represented separately at the
|
||||||
|
batch level.
|
||||||
|
- Default tests are deterministic, offline, and use Promptkit/provider fakes
|
||||||
|
rather than live provider calls. See the [testing policy](testing.md).
|
||||||
|
|
||||||
Use external dependencies only when justified by correctness, security, interoperability, or substantial complexity reduction. Good reasons include complex security-sensitive behavior, such as HTML sanitization, or widely used de facto standards, such as YAML parsing.
|
## Non-Goals
|
||||||
|
|
||||||
Avoid dependencies for small conveniences. Do not let external dependency types leak across internal package boundaries unless the dependency is itself the explicit public contract of that package.
|
Weatherreporter is not a weather-data ingestion service, general LLM
|
||||||
|
orchestration framework, plugin platform, HTTP service, multi-user job system,
|
||||||
## Package Layout
|
or a replacement for Promptkit or Distributor.
|
||||||
|
|
||||||
Use this layout unless the project has a documented reason to differ:
|
|
||||||
|
|
||||||
- `internal/app`: application orchestration and top-level use cases.
|
|
||||||
- `internal/cli`: CLI command definitions, flags, argument parsing, and command wiring.
|
|
||||||
- `internal/config`: configuration structs, defaults, loading, precedence, and validation.
|
|
||||||
- `internal/adapters/<name>`: adapters for external CLIs, APIs, databases, object stores, or libraries.
|
|
||||||
- `internal/api`: HTTP API handlers and request/response types, when the application exposes an HTTP API.
|
|
||||||
- `internal/transport/http`: HTTP client code, when the application calls HTTP services.
|
|
||||||
|
|
||||||
Package-private implementation constants may live near the package that owns them, preferably in `constants.go` when useful.
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Centralize configuration loading, processing, precedence, defaults, and validation in `internal/config`.
|
|
||||||
|
|
||||||
The goal is to make configuration discoverable and avoid implicit or hidden operational values. User-visible defaults and cross-package operational defaults should be defined in `internal/config/defaults.go`.
|
|
||||||
|
|
||||||
Configuration precedence is:
|
|
||||||
|
|
||||||
1. CLI flags
|
|
||||||
2. configuration file
|
|
||||||
3. built-in defaults
|
|
||||||
|
|
||||||
Prefer YAML configuration unless the project has a strong reason to use another format. Config files should be discovered at `/usr/local/etc/<app_name>/config.yml`, with a CLI override via `--config`.
|
|
||||||
|
|
||||||
Configuration files should not contain raw secrets unless the application is explicitly designed for that. Prefer environment variables or secret files for secrets. File-backed secrets are loaded through `secrets.directory`; secret values must not be logged, persisted, or included in user-facing output.
|
|
||||||
|
|
||||||
## Adapters and External Integrations
|
|
||||||
|
|
||||||
Use a hexagonal architecture style for external integrations.
|
|
||||||
|
|
||||||
External adapters belong under `internal/adapters/<name>`. If an adapter uses an external dependency, that dependency’s interface must not leak outside the adapter package. Other packages should interact only with the adapter’s API, so the dependency can be swapped, upgraded, or removed without touching unrelated code.
|
|
||||||
|
|
||||||
Adapters should be thin. Domain decisions belong in application/domain packages, not inside adapter glue.
|
|
||||||
|
|
||||||
## Components and Registries
|
|
||||||
|
|
||||||
When the application has major workflow components, each component should live
|
|
||||||
near the package that owns its contract and have explicit inputs and outputs.
|
|
||||||
|
|
||||||
The orchestrator should compose components in an explicit order using a default
|
|
||||||
sequence, dependency graph, or documented orchestration rule.
|
|
||||||
|
|
||||||
If users can select components, validators, renderers, or adapters, selection
|
|
||||||
should go through a registry or equivalent mechanism rather than scattered
|
|
||||||
conditionals.
|
|
||||||
|
|
||||||
## Embedded Assets
|
|
||||||
|
|
||||||
Store embedded JSON schemas, Markdown prompts, templates, and similar assets as separate files, not inline string literals, unless there is a strong reason otherwise.
|
|
||||||
|
|
||||||
## Errors and Logging
|
|
||||||
|
|
||||||
Errors should be actionable and preserve context. Wrap errors with operation and path/resource context. CLI code should convert internal errors into concise user-facing messages.
|
|
||||||
|
|
||||||
Errors and logs must not expose secrets.
|
|
||||||
|
|
||||||
Use structured logging where practical. Logs should describe operations, paths, external calls, retries, and failure causes, but should not include large user data by default.
|
|
||||||
|
|
||||||
## Context, Timeouts, and Cancellation
|
|
||||||
|
|
||||||
Long-running operations should accept `context.Context`. External calls,
|
|
||||||
subprocesses, HTTP requests, storage operations, and multi-step workflows should
|
|
||||||
respect cancellation and timeouts.
|
|
||||||
|
|
||||||
## State, Files, and Safety
|
|
||||||
|
|
||||||
If the application writes durable state, writes should be atomic where
|
|
||||||
practical. Multi-step workflows should preserve enough state to support
|
|
||||||
inspection and retry diagnosis after failure.
|
|
||||||
|
|
||||||
Code that deletes, moves, or overwrites files must use narrow, explicit paths. Avoid broad parent-directory operations. Cleanup that can cause data loss must be opt-in.
|
|
||||||
|
|
||||||
## Testing
|
|
||||||
|
|
||||||
Core logic should be testable without real external services. Use fakes, fixtures, or local test doubles for adapters where practical.
|
|
||||||
|
|
||||||
Config examples should be load-tested. Important CLI workflows should have
|
|
||||||
parser or command tests. Component contracts should have focused tests that do
|
|
||||||
not require running the full application unless end-to-end coverage is
|
|
||||||
intentional.
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
Documentation should follow the project documentation policy. Keep user docs focused on implemented behavior. Put future, planned, or aspirational work only under `docs/roadmap/`.
|
|
||||||
|
|
||||||
When changing architecture, config, CLI behavior, adapters, or component
|
|
||||||
contracts, update the relevant docs and examples in the same change.
|
|
||||||
|
|||||||
@@ -1,204 +0,0 @@
|
|||||||
# Development Policy
|
|
||||||
|
|
||||||
This document is the contributor workflow policy for `weatherreporter`.
|
|
||||||
Developers and LLM coding agents should use it with
|
|
||||||
`docs/policy/architecture.md` and `docs/policy/documentation.md`.
|
|
||||||
|
|
||||||
## Repository Layout
|
|
||||||
|
|
||||||
- `cmd/weatherreporter`: binary entry point.
|
|
||||||
- `internal/app`: orchestration for generation, batches, fetch helpers, and
|
|
||||||
inspection.
|
|
||||||
- `internal/cli`: command parsing, flag handling, help text, and JSON output.
|
|
||||||
- `internal/config`: configuration structs, defaults, loading, overrides, and
|
|
||||||
validation.
|
|
||||||
- `internal/fileutil`: shared atomic filesystem write and copy helpers.
|
|
||||||
- `internal/adapters/distributor`: Distributor upload adapter.
|
|
||||||
- `internal/adapters/weatherapi`: Weather API HTTP adapter.
|
|
||||||
- `internal/adapters/scriptorium`: Scriptorium subprocess adapter.
|
|
||||||
- `internal/weatherdata`: normalized weather source facts, source metadata, and
|
|
||||||
source warnings.
|
|
||||||
- `internal/forecast`: deterministic forecast derivation.
|
|
||||||
- `internal/facts`: collected and derived report fact contracts.
|
|
||||||
- `internal/module`: module IDs, config items, output envelopes, and snapshots.
|
|
||||||
- `internal/report`: report definitions, valid periods, batches, output names,
|
|
||||||
and comparison declarations.
|
|
||||||
- `internal/briefing`: prompt-facing module value builders and module registry.
|
|
||||||
- `internal/changes`: structured Recent Changes comparison.
|
|
||||||
- `internal/promptinput`: Scriptorium `data_package` construction and
|
|
||||||
validation.
|
|
||||||
- `internal/state`: filesystem paths, atomic JSON writes, metadata, lookup, and
|
|
||||||
inspection support.
|
|
||||||
- `internal/timeutil`: clock, date, timezone, and period helpers.
|
|
||||||
- `docs`: user, operator, developer, integration, internal, policy, and roadmap
|
|
||||||
documentation.
|
|
||||||
- `examples`: maintained copyable examples.
|
|
||||||
|
|
||||||
## Local Validation
|
|
||||||
|
|
||||||
Use focused checks while editing and broader checks before committing:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go test ./...
|
|
||||||
go run ./cmd/weatherreporter --help
|
|
||||||
git diff --check
|
|
||||||
```
|
|
||||||
|
|
||||||
Useful focused checks:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go test ./internal/cli ./internal/config
|
|
||||||
go test ./internal/app ./internal/state
|
|
||||||
go test ./internal/adapters/distributor ./internal/adapters/weatherapi ./internal/adapters/scriptorium
|
|
||||||
go test ./internal/forecast ./internal/report ./internal/briefing ./internal/changes ./internal/promptinput
|
|
||||||
```
|
|
||||||
|
|
||||||
Run `gofmt -w` on changed Go files before committing.
|
|
||||||
|
|
||||||
## Coding Conventions
|
|
||||||
|
|
||||||
- Keep domain logic out of `cmd`, `internal/cli`, and adapter packages.
|
|
||||||
- Prefer small explicit structs and functions over broad framework-style
|
|
||||||
abstractions.
|
|
||||||
- Keep package APIs narrow and named around implemented behavior.
|
|
||||||
- Return errors with operation, path, endpoint, report, or RunID context.
|
|
||||||
- Do not log or expose secrets.
|
|
||||||
- Use `context.Context` for external calls, subprocesses, and orchestrated
|
|
||||||
workflows that may be canceled.
|
|
||||||
- Use atomic writes for durable JSON artifacts where practical.
|
|
||||||
- Keep report selection and prompt IDs centralized in `internal/report`.
|
|
||||||
- Keep Scriptorium argv construction inside `internal/adapters/scriptorium`.
|
|
||||||
- Keep distributor package types and upload-client construction inside
|
|
||||||
`internal/adapters/distributor`.
|
|
||||||
- Keep Weather API transport and envelope handling inside
|
|
||||||
`internal/adapters/weatherapi`.
|
|
||||||
|
|
||||||
## Dependency Policy
|
|
||||||
|
|
||||||
Prefer the Go standard library. Add dependencies only when they materially
|
|
||||||
improve correctness, interoperability, security, or maintainability.
|
|
||||||
|
|
||||||
Current external dependencies:
|
|
||||||
|
|
||||||
- `gitea.maximumdirect.net/eric/distributor` for distributor source bundle
|
|
||||||
construction and HTTP upload client behavior.
|
|
||||||
- `gopkg.in/yaml.v3` for YAML configuration parsing.
|
|
||||||
|
|
||||||
When adding a dependency:
|
|
||||||
|
|
||||||
- explain why the standard library is not enough;
|
|
||||||
- keep dependency types from leaking across unrelated package boundaries;
|
|
||||||
- add tests for the behavior the dependency supports;
|
|
||||||
- update this policy if the dependency becomes part of contributor workflow.
|
|
||||||
|
|
||||||
## Configuration Changes
|
|
||||||
|
|
||||||
Configuration is owned by `internal/config`.
|
|
||||||
|
|
||||||
When adding or changing a field:
|
|
||||||
|
|
||||||
- update `Config` and the nested config struct in `config.go`;
|
|
||||||
- add or adjust defaults in `defaults.go` when the field has a safe default;
|
|
||||||
- update loading or CLI override behavior in `load.go` only when needed;
|
|
||||||
- validate required values and accepted ranges in `validate.go`;
|
|
||||||
- add or update config tests;
|
|
||||||
- update `docs/config.md` and maintained examples when the field is user
|
|
||||||
visible;
|
|
||||||
- keep secrets out of example config files.
|
|
||||||
|
|
||||||
Configuration precedence is:
|
|
||||||
|
|
||||||
1. CLI overrides supported by `config.LoadOptions`;
|
|
||||||
2. configuration file values;
|
|
||||||
3. built-in defaults.
|
|
||||||
|
|
||||||
The default config path is `/usr/local/etc/weatherreporter/config.yml`.
|
|
||||||
|
|
||||||
## CLI Changes
|
|
||||||
|
|
||||||
The CLI is owned by `internal/cli`.
|
|
||||||
|
|
||||||
When adding or changing a command or flag:
|
|
||||||
|
|
||||||
- update help text and parser behavior together;
|
|
||||||
- convert parsed values into app-layer request structs;
|
|
||||||
- keep domain decisions in `internal/app` or domain packages;
|
|
||||||
- add parser or command tests in `internal/cli`;
|
|
||||||
- update `docs/cli.md`;
|
|
||||||
- update `docs/operations.md` or `docs/troubleshooting.md` when behavior affects
|
|
||||||
operators.
|
|
||||||
|
|
||||||
CLI commands should return concise actionable errors and avoid printing partial
|
|
||||||
JSON when command construction fails.
|
|
||||||
|
|
||||||
## Components And Adapters
|
|
||||||
|
|
||||||
Use existing package boundaries before adding a package.
|
|
||||||
|
|
||||||
Add a new internal component only when it owns a distinct implemented contract.
|
|
||||||
Define its inputs, outputs, state behavior, failure behavior, tests, and
|
|
||||||
invariants in `docs/internal/`.
|
|
||||||
|
|
||||||
Adapters should stay thin:
|
|
||||||
|
|
||||||
- HTTP adapters own transport, request construction, envelope handling, and
|
|
||||||
decode boundaries.
|
|
||||||
- subprocess adapters own argv construction, timeout handling, stdout/stderr
|
|
||||||
capture, and exit-code interpretation.
|
|
||||||
- adapter packages should not own report selection, forecast summarization,
|
|
||||||
Recent Changes, or prompt input schema decisions.
|
|
||||||
|
|
||||||
When an external contract changes, update the matching file under
|
|
||||||
`docs/integrations/`.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Core tests must not require live Weather API, Scriptorium, or distributor
|
|
||||||
services.
|
|
||||||
|
|
||||||
Preferred test patterns:
|
|
||||||
|
|
||||||
- fake command runners for subprocess behavior;
|
|
||||||
- `httptest.Server` for Weather API behavior;
|
|
||||||
- fake distributor upload clients for notification behavior;
|
|
||||||
- filesystem temp directories for state behavior;
|
|
||||||
- deterministic clocks for report periods and RunIDs;
|
|
||||||
- table tests for config validation, CLI parsing, period resolution, and
|
|
||||||
threshold behavior.
|
|
||||||
|
|
||||||
Add focused tests near the package that owns the behavior. Use app-level tests
|
|
||||||
for workflow ordering, persistence, and cross-package contracts.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
Examples under `examples/` must be real, maintained, and free of secrets.
|
|
||||||
|
|
||||||
When updating examples:
|
|
||||||
|
|
||||||
- use implemented config fields only;
|
|
||||||
- avoid private endpoints and credentials;
|
|
||||||
- keep comments short and operationally useful;
|
|
||||||
- add or update validation coverage when a new example file is introduced;
|
|
||||||
- link maintained examples from `docs/config.md`.
|
|
||||||
|
|
||||||
Do not add generated report examples unless they can be kept current without
|
|
||||||
live external services.
|
|
||||||
|
|
||||||
## Documentation Checklist
|
|
||||||
|
|
||||||
Documentation updates are part of behavior changes.
|
|
||||||
|
|
||||||
Update:
|
|
||||||
|
|
||||||
- `README.md` for project orientation or quickstart changes;
|
|
||||||
- `docs/cli.md` for command and flag changes;
|
|
||||||
- `docs/config.md` for config fields, defaults, and precedence changes;
|
|
||||||
- `docs/operations.md` for state, artifact, batch, inspection, and recovery
|
|
||||||
behavior;
|
|
||||||
- `docs/troubleshooting.md` for recurring operator-facing failure modes;
|
|
||||||
- `docs/internal/` for component contracts and invariants;
|
|
||||||
- `docs/integrations/` for external Weather API, Scriptorium, or distributor
|
|
||||||
contract changes;
|
|
||||||
- `docs/roadmap/` only for unimplemented or deferred work.
|
|
||||||
|
|
||||||
Non-roadmap docs must describe implemented behavior only.
|
|
||||||
@@ -1,356 +1,230 @@
|
|||||||
# Go Project Documentation Policy
|
# Documentation Policy
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
Project documentation must help four audiences:
|
This policy assigns each Weatherreporter documentation topic to one canonical
|
||||||
|
owner. Its goal is to keep documentation accurate, concise, discoverable, and
|
||||||
1. users who need to run the application;
|
resistant to drift for users, operators, developers, integrators, maintainers,
|
||||||
2. administrators/operators who need to configure and operate it;
|
and coding agents.
|
||||||
3. developers who need to understand and change it safely;
|
|
||||||
4. LLM coding agents that need clear scope, boundaries, and invariants.
|
|
||||||
|
|
||||||
Docs should be accurate, concise, task-oriented, and organized by audience. Prefer links to canonical docs over repetition.
|
|
||||||
|
|
||||||
## Core Rules
|
## Core Rules
|
||||||
|
|
||||||
### 1. Keep docs concise
|
### One Canonical Documentation Owner
|
||||||
|
|
||||||
Each document should cover a defined scope and only the essentials for that scope.
|
Each authoritative fact belongs in one canonical document or documentation
|
||||||
|
area. A non-owning document may give a short, stable summary for orientation,
|
||||||
Avoid:
|
but it must link to the canonical owner instead of maintaining a second
|
||||||
- long background explanations;
|
definition.
|
||||||
- repeated reference material;
|
|
||||||
- implementation detail in user-facing docs;
|
Volatile details include commands, flags, configuration fields and defaults,
|
||||||
- aspirational language outside roadmap docs;
|
report and module IDs, schemas, file names, paths, status and exit behavior,
|
||||||
- verbose examples where one minimal example is clearer.
|
retry behavior, and runtime guarantees. If readers could reasonably treat a
|
||||||
|
statement as a contract, its exact documentation belongs with the owner named
|
||||||
### 2. Document only implemented behavior outside roadmap files
|
in this policy.
|
||||||
|
|
||||||
Unimplemented, planned, aspirational, experimental, or future work may be described only under:
|
Executable sources of truth and documentation owners serve different purposes.
|
||||||
|
Code, schemas, and embedded assets determine runtime behavior. The canonical
|
||||||
- `docs/roadmap/`
|
document owns the corresponding explanation or reference for readers. Both may
|
||||||
|
necessarily express the same contract, but other documentation should summarize
|
||||||
No other documentation file, including `README.md`, should describe code, features, modules, stages, commands, config fields, or behaviors that do not currently exist.
|
and link rather than create another complete reference. When implementation and
|
||||||
|
documentation disagree, verify the intended behavior and update them together.
|
||||||
If a feature is partial, non-roadmap docs may describe only the implemented portion and its current boundary.
|
|
||||||
|
### Current State, Decisions, And Future Work
|
||||||
### 3. Use canonical homes
|
|
||||||
|
Outside `docs/roadmap/`, documentation describes implemented behavior only.
|
||||||
Each type of information should have one canonical location.
|
Partial features may be described only to their implemented boundary.
|
||||||
|
|
||||||
Canonical homes:
|
An accepted architecture decision may describe an approved direction before it
|
||||||
|
is implemented, but acceptance is not evidence that the behavior exists.
|
||||||
- project purpose and quickstart: `README.md`
|
Current-state documents change when the implementation lands. Temporary
|
||||||
- development principles: `docs/policy/architecture.md`
|
roadmaps own future work, sequencing, and implementation status; they do not
|
||||||
- configuration reference: `docs/config.md`
|
replace durable policies, decisions, or current contracts.
|
||||||
- CLI reference: `docs/cli.md`
|
|
||||||
- operations and recovery: `docs/operations.md`
|
### Audience And Detail
|
||||||
- troubleshooting: `docs/troubleshooting.md`
|
|
||||||
- implemented internals: `docs/internal/`
|
Write for the document's stated audience and include only the detail needed for
|
||||||
- future work: `docs/roadmap/`
|
its owned topic. User and operator documentation should not expose incidental
|
||||||
- contributor workflow: `docs/policy/development.md`
|
implementation detail. Developer documentation should link to user-facing and
|
||||||
- copyable examples: `examples/`
|
external contracts instead of restating them.
|
||||||
|
|
||||||
Other files should summarize briefly and link to the canonical source.
|
### Links
|
||||||
|
|
||||||
### 4. Keep examples real
|
Use descriptive link text and repository-relative links for repository
|
||||||
|
documents. Link to the canonical owner rather than to a duplicate summary.
|
||||||
Examples should be valid, maintained, and free of secrets.
|
Check every added or changed link, and repair or remove links when their target
|
||||||
|
moves or is retired.
|
||||||
Where practical:
|
|
||||||
- example configs should load successfully;
|
### Examples And Code Fences
|
||||||
- example commands should match real CLI syntax;
|
|
||||||
- important examples should be covered by tests.
|
Complete copyable files belong in `examples/` when maintained examples exist.
|
||||||
|
Documentation may use the smallest illustrative snippet needed for its owned
|
||||||
## Documentation Profiles
|
topic, but should link to a maintained example instead of embedding a second
|
||||||
|
complete copy.
|
||||||
All projects require:
|
|
||||||
|
Examples must be valid, secret-free, and tested where practical. Commands,
|
||||||
- `README.md`
|
flags, configuration, imports, and Go snippets must match implemented behavior.
|
||||||
- `docs/policy/architecture.md`
|
Use a language tag on fenced code blocks, and identify fragments that are
|
||||||
|
illustrative rather than directly runnable.
|
||||||
Additional docs depend on the project.
|
|
||||||
|
### Security And Privacy
|
||||||
### Small library
|
|
||||||
|
Documentation and examples must not contain real credentials, private keys,
|
||||||
Recommended:
|
private environment dumps, sensitive source material, or private
|
||||||
- `docs/policy/development.md`, if contributor conventions are non-obvious
|
infrastructure details unless intentionally public. Document secret-handling
|
||||||
|
mechanisms, not secret values.
|
||||||
### Simple CLI
|
|
||||||
|
## Canonical Ownership
|
||||||
Required:
|
|
||||||
- `docs/cli.md`
|
| Topic | Canonical owner | Owned content | Content owned elsewhere |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
Recommended:
|
| Product orientation and minimal quickstart | `README.md` | What Weatherreporter is, why it is useful, one shortest successful invocation, and links onward. | Complete command reference, configuration reference, operational procedures, architecture, and implementation detail. |
|
||||||
- `docs/policy/development.md`
|
| Contributor workflow and package inventory | `docs/development.md` | Repository layout, local workflow, validation commands, coding conventions, task-specific change guidance, dependency workflow, and repository hygiene. | Architectural invariants, user-facing contracts, detailed subsystem behavior, and future work. |
|
||||||
|
| Current application architecture | `docs/policy/architecture.md` | System shape, normative ownership, dependency direction, package boundaries, invariants, safety properties, and non-goals. | Concrete implementation mechanics, contributor procedures, decision history, and future work. |
|
||||||
### Config-driven CLI
|
| Documentation organization | `docs/policy/documentation.md` | Documentation ownership, audience boundaries, maintenance rules, and document lifecycle. | Application architecture and runtime behavior. |
|
||||||
|
| Testing policy | `docs/policy/testing.md` | Test philosophy, risk-based sufficiency, stable test boundaries, doubles, coverage guidance, regression policy, and criteria for adding, rewriting, or deleting tests. | Subsystem behavior, application contracts, subsystem-specific test inventories, and implementation plans. |
|
||||||
Required:
|
| Release procedure | `docs/release.md` | Version policy, release preparation, validation, tagging, automated publication, verification, failure handling, and release ordering. | General contributor workflow, product contracts, release-specific change summaries, and implementation history. |
|
||||||
- `docs/cli.md`
|
| Release notes | `docs/releases/` | One versioned, changelog-style summary for each release, including compatibility and operator action. The file at the tagged commit supplies the corresponding Gitea release body. | Current CLI, configuration, operations, integration, architecture, and internal contracts; release procedure; implementation plans. |
|
||||||
- `docs/config.md`
|
| CLI contract | `docs/cli.md` | Commands, arguments, flags, invocation semantics, stdout and stderr behavior, summaries, and exit behavior. | Configuration field definitions, complete operating procedures, runtime filesystem layout, and command implementation. |
|
||||||
|
| Configuration contract | `docs/config.md` | Discovery and precedence, fields, defaults, secrets, validation rules, and user-selectable values. | Complete example files, CLI syntax, output lifecycle, and loading implementation. |
|
||||||
Recommended:
|
| Operations | `docs/operations.md` | Normal output handling, atomic replacement, notification behavior, diagnosis, explicit debug capture, manual legacy-workspace cleanup, permissions, and operational caveats. | Complete CLI syntax, configuration field definitions, logical external contracts, and implementation mechanics. |
|
||||||
- `examples/`
|
| Report template surface | `docs/templates.md` | Implemented template files and partials, render-context fields, editing rules, and maintainer-facing template examples. | Weather derivation, module implementation, generated-text validation internals, and operator procedures. |
|
||||||
- `docs/policy/development.md`
|
| External and durable integration contracts | `docs/integrations/` | Weather API, Promptkit, Distributor, external formats and protocols, durable logical paths and schemas, compatibility behavior, and upstream or downstream responsibilities. | Physical runtime placement and lifecycle, internal transformations, CLI syntax, and configuration defaults. |
|
||||||
|
| Internal subsystem behavior | `docs/internal/` | Implementation flow, internal collaborators and state transitions, package-local guarantees and failures, and relevant tests. | Global architecture invariants, user-facing contracts, external schemas, operator procedures, and future package plans. |
|
||||||
### Stateful or operator-facing application
|
| Architectural decision history | `docs/adr/`, when repository-local decisions require records | Significant decisions, context, alternatives, rationale, consequences, and supersession history. | Current behavior reference, implementation status, and task sequencing. |
|
||||||
|
| Temporary feature roadmaps | `docs/roadmap/`, while planned work needs coordination | Proposed, accepted, deferred, or rejected work; sequencing; gates; implementation status; and task breakdowns. | Implemented behavior reference and durable decision rationale. |
|
||||||
Required:
|
| Complete copyable artifacts | `examples/` | Maintained configuration and other files intended to be copied or run. | Field-by-field reference, command reference, and prose explanation. |
|
||||||
- `docs/cli.md`, if CLI-based
|
|
||||||
- `docs/config.md`, if config-driven
|
Conditional owners do not require placeholder files or directories. If
|
||||||
- `docs/operations.md`
|
Weatherreporter introduces a new public API, consumer interface, release
|
||||||
|
process, or other durable documentation responsibility, update this policy to
|
||||||
Recommended:
|
assign its canonical owner when that responsibility is introduced.
|
||||||
- `docs/troubleshooting.md`
|
|
||||||
- `examples/`
|
## Boundary Rules
|
||||||
- `docs/policy/development.md`
|
|
||||||
|
### Orientation, Architecture, And Internals
|
||||||
### Modular, staged, service-oriented, or orchestration application
|
|
||||||
|
The README owns product orientation. The development policy routes contributors
|
||||||
Required:
|
and owns the concise current package inventory. Architecture owns normative
|
||||||
- `docs/cli.md`, if CLI-based
|
structure and invariants. Focused internal documents own implementation
|
||||||
- `docs/config.md`, if config-driven
|
behavior. These documents may link to one another but must not maintain
|
||||||
- `docs/operations.md`
|
parallel package or behavior references.
|
||||||
- `docs/internal/`
|
|
||||||
- `docs/policy/development.md`
|
### Commands, Configuration, And Operations
|
||||||
|
|
||||||
Recommended:
|
CLI documentation answers how to invoke Weatherreporter and what its command
|
||||||
- `docs/troubleshooting.md`
|
interface does. Configuration documentation answers what settings mean.
|
||||||
- validated examples under `examples/`
|
Operations answers how to handle operator-owned outputs and runtime failures,
|
||||||
|
including diagnosis, explicit debug capture, and safe legacy cleanup.
|
||||||
## Required Documents
|
|
||||||
|
When a workflow crosses these topics, place the complete procedure with the
|
||||||
### README.md
|
document that owns the task and link to the other contracts. Do not duplicate
|
||||||
|
complete flag, field, or path references to make a workflow self-contained.
|
||||||
**Audience:** users, administrators, operators
|
|
||||||
|
### Templates, Integrations, And Implementation
|
||||||
The README is the outward-facing project orientation page.
|
|
||||||
|
Template documentation defines the maintainer-facing rendering surface.
|
||||||
It should include, in order:
|
Integration documentation defines externally observable shapes, logical paths,
|
||||||
|
protocols, and compatibility behavior. Internal documentation explains how
|
||||||
1. concise description;
|
Weatherreporter produces, transforms, or consumes those contracts.
|
||||||
2. elevator pitch;
|
|
||||||
3. shortest useful command or usage example;
|
Internal documents may name a command, field, template value, path, or protocol
|
||||||
4. links to targeted docs.
|
to identify a dependency, but must link to its canonical documentation for the
|
||||||
|
complete definition.
|
||||||
The README should be short. It is not a manual.
|
|
||||||
|
### Release Procedure And Release Notes
|
||||||
The “shortest useful command” means the simplest command that performs the project’s core use case. (It does not mean `app --help`.)
|
|
||||||
|
The release procedure owns how a maintainer prepares, publishes, verifies, and
|
||||||
### docs/policy/architecture.md
|
recovers from a Weatherreporter release. Release notes under `docs/releases/`
|
||||||
|
own the concise historical summary for one version and are the checked-in
|
||||||
**Audience:** developers, LLM coding agents
|
source for its generated Gitea release body.
|
||||||
|
|
||||||
`docs/policy/architecture.md` is required for every project.
|
Release notes are not current-state reference documents. They may summarize
|
||||||
|
what changed and link to durable documentation, but they must not become a
|
||||||
It is an inward-facing development policy document. It should describe how the project is intended to be built and changed.
|
second command, configuration, operations, integration, architecture, or
|
||||||
|
internal reference. Correct the applicable canonical owner in the same change
|
||||||
It should include:
|
when a release changes an implemented contract.
|
||||||
|
|
||||||
- project shape;
|
The release note at a published tag and the Gitea release generated from it are
|
||||||
- core design principles;
|
historical records. Later corrections on `main` do not rewrite that published
|
||||||
- package and boundary philosophy;
|
record. Material release errors require the failure handling defined by the
|
||||||
- state/persistence philosophy, if applicable;
|
release procedure rather than moving a published tag or overwriting its
|
||||||
- external integration philosophy, if applicable;
|
release.
|
||||||
- error-handling and logging principles;
|
|
||||||
- testing expectations;
|
### Executable Authority
|
||||||
- documentation expectations;
|
|
||||||
- architectural invariants;
|
CLI parsing and help generation are the executable authority for accepted
|
||||||
- explicit non-goals, if useful.
|
commands and flags. Configuration structs, defaults, loading, and validation
|
||||||
|
are the executable authority for configuration behavior. Schemas and embedded
|
||||||
For small projects, this file may be brief. It may simply state that the project is intentionally narrow, monolithic, and dependency-light.
|
assets are the executable authority for validated formats and template
|
||||||
|
execution. Tests protect selected contracts and invariants but do not become a
|
||||||
### docs/policy/development.md
|
second documentation reference merely by asserting them.
|
||||||
|
|
||||||
**Audience:** developers, LLM coding agents
|
Canonical documentation must be checked against these authorities whenever the
|
||||||
|
corresponding behavior changes.
|
||||||
Required for projects maintained by humans and LLM coding agents.
|
|
||||||
|
### Security Topics
|
||||||
It should include:
|
|
||||||
|
This policy owns what documentation and examples may contain. Architecture owns
|
||||||
- repository layout;
|
application security boundaries and invariants. Configuration owns
|
||||||
- build/test commands;
|
credential-supply mechanisms. Operations owns permissions and handling of
|
||||||
- coding conventions;
|
sensitive runtime artifacts. Integration documents own consumer-visible
|
||||||
- dependency policy;
|
security contracts. Internal documents own implementation mechanisms only.
|
||||||
- how to add config fields;
|
|
||||||
- how to add CLI flags;
|
## Architecture Decision Records
|
||||||
- how to add stages/modules/adapters, if applicable;
|
|
||||||
- how to update examples;
|
Use sequentially numbered ADR filenames such as
|
||||||
- documentation update expectations.
|
`0001-record-architecture-decisions.md`. Follow the lightweight Nygard format:
|
||||||
|
|
||||||
### docs/config.md
|
1. title;
|
||||||
|
2. status;
|
||||||
**Audience:** administrators, operators, advanced users
|
3. date;
|
||||||
|
4. context;
|
||||||
Required for applications with configuration files.
|
5. decision;
|
||||||
|
6. alternatives considered;
|
||||||
It should include, in order:
|
7. consequences.
|
||||||
|
|
||||||
1. config file locations and discovery precedence;
|
Use one of these statuses:
|
||||||
2. minimal working config;
|
|
||||||
3. production-oriented config;
|
- **Proposed:** the decision is under consideration and may change;
|
||||||
4. full configuration reference;
|
- **Accepted:** the decision is approved, whether or not implementation is
|
||||||
5. secrets handling, if applicable;
|
complete;
|
||||||
6. links to maintained examples.
|
- **Rejected:** the proposed decision was considered and not adopted;
|
||||||
|
- **Superseded:** a later accepted ADR replaces the accepted decision.
|
||||||
The full configuration reference should be canonical.
|
|
||||||
|
A proposed ADR transitions to Accepted or Rejected. An Accepted ADR transitions
|
||||||
### docs/cli.md
|
to Superseded only when a later Accepted ADR replaces it. An ADR may be created
|
||||||
|
as Accepted when the decision has already been made.
|
||||||
**Audience:** users, administrators, operators
|
|
||||||
|
Treat the decision content of an Accepted ADR as immutable. A changed decision
|
||||||
Required for CLI applications.
|
requires a later ADR rather than a rewrite of the accepted record. A Superseded
|
||||||
|
ADR must link to its replacement, and the replacement must link back. Rejected
|
||||||
It should include, in order:
|
architectural alternatives belong in the ADR; rejected feature ideas belong in
|
||||||
|
a roadmap when they need to be retained.
|
||||||
1. shortest useful command;
|
|
||||||
2. command overview;
|
## Document Lifecycle
|
||||||
3. complete flag reference;
|
|
||||||
4. common workflows;
|
Create durable current-state documentation with the implementation it
|
||||||
5. diagnostic or recovery commands, if applicable.
|
describes. Update its canonical owner in the same change when behavior changes.
|
||||||
|
If ownership moves, remove the old definition and leave a link where navigation
|
||||||
Explain when commands are useful, not just their syntax.
|
remains useful.
|
||||||
|
|
||||||
### docs/operations.md
|
Roadmaps are temporary coordination documents. When their work is complete,
|
||||||
|
record completion, move any still-useful decisions or contracts to their
|
||||||
**Audience:** administrators, operators
|
durable owners, update incoming links, and archive or remove the roadmap
|
||||||
|
according to repository practice. Do not preserve completed roadmaps as a
|
||||||
Required for applications that maintain state, support resume behavior, run multiple stages, write durable artifacts, use remote storage, or require recovery procedures.
|
second current-state reference.
|
||||||
|
|
||||||
It should cover:
|
Release notes are durable historical summaries rather than temporary roadmaps.
|
||||||
|
Keep them concise, retain them after publication, and keep current contracts in
|
||||||
- normal workflow;
|
their canonical owners.
|
||||||
- filesystem layout;
|
|
||||||
- remote storage layout, if applicable;
|
Before completing documentation work:
|
||||||
- logs and manifests;
|
|
||||||
- resume/retry behavior;
|
- verify affected behavior and examples;
|
||||||
- cleanup behavior;
|
- check commands, flags, fields, defaults, schemas, paths, and identifiers
|
||||||
- archive/backup behavior;
|
against their implementation;
|
||||||
- safe recovery procedures;
|
- keep unimplemented behavior in a roadmap, subject to the ADR exception;
|
||||||
- operational caveats.
|
- validate links and fenced examples;
|
||||||
|
- confirm non-owning documents summarize and link rather than redefine;
|
||||||
### docs/troubleshooting.md
|
- remove stale or unsupported claims; and
|
||||||
|
- confirm that no secrets or sensitive private data were added.
|
||||||
**Audience:** administrators, operators
|
|
||||||
|
|
||||||
Recommended once recurring failure modes exist.
|
|
||||||
|
|
||||||
Each entry should include:
|
|
||||||
|
|
||||||
- symptom;
|
|
||||||
- likely cause;
|
|
||||||
- diagnostic command or inspection step;
|
|
||||||
- safe fix;
|
|
||||||
- relevant links.
|
|
||||||
|
|
||||||
### docs/internal/
|
|
||||||
|
|
||||||
**Audience:** developers, LLM coding agents
|
|
||||||
|
|
||||||
Required for modular, staged, service-oriented, or orchestration projects.
|
|
||||||
|
|
||||||
This directory describes implemented internal components. It is not the roadmap.
|
|
||||||
|
|
||||||
Use one file per major component where useful.
|
|
||||||
|
|
||||||
Each component doc should include:
|
|
||||||
|
|
||||||
1. purpose;
|
|
||||||
2. inputs and outputs;
|
|
||||||
3. boundaries;
|
|
||||||
4. config fields used;
|
|
||||||
5. external adapters used;
|
|
||||||
6. state or manifest behavior, if applicable;
|
|
||||||
7. skip/resume behavior, if applicable;
|
|
||||||
8. failure behavior;
|
|
||||||
9. tests to inspect before changing;
|
|
||||||
10. architectural invariants.
|
|
||||||
|
|
||||||
### docs/roadmap/
|
|
||||||
|
|
||||||
**Audience:** maintainers, developers, LLM coding agents
|
|
||||||
|
|
||||||
This is the only place for planned, future, aspirational, experimental, or unimplemented work.
|
|
||||||
|
|
||||||
Roadmap docs should clearly distinguish:
|
|
||||||
|
|
||||||
- proposed work;
|
|
||||||
- accepted plans;
|
|
||||||
- deferred ideas;
|
|
||||||
- rejected ideas;
|
|
||||||
- implementation prompts or task breakdowns, if useful.
|
|
||||||
|
|
||||||
Roadmap docs should not be confused with current behavior.
|
|
||||||
|
|
||||||
### docs/integrations/
|
|
||||||
|
|
||||||
**Audience:** developers, LLM coding agents
|
|
||||||
|
|
||||||
Required for projects that depend on external CLIs, APIs, services, protocols, or file formats where the integration contract is important to maintain.
|
|
||||||
|
|
||||||
This directory contains concise, versioned reference notes for external integration contracts. It should document only the parts of the external system that this project actually uses.
|
|
||||||
|
|
||||||
Use one file per integration where useful.
|
|
||||||
|
|
||||||
## Examples Directory
|
|
||||||
|
|
||||||
Projects with non-trivial configuration or workflows should include `examples/`.
|
|
||||||
|
|
||||||
Useful examples include:
|
|
||||||
|
|
||||||
- minimal working config;
|
|
||||||
- production-oriented config;
|
|
||||||
- full annotated config;
|
|
||||||
- local development config;
|
|
||||||
- remote/object-storage config;
|
|
||||||
- minimal session/input file.
|
|
||||||
|
|
||||||
Examples should be valid, maintained, tested when practical, and linked from relevant docs.
|
|
||||||
|
|
||||||
## Security and Privacy
|
|
||||||
|
|
||||||
Docs and examples must not include:
|
|
||||||
|
|
||||||
- real API keys;
|
|
||||||
- tokens;
|
|
||||||
- passwords;
|
|
||||||
- private keys;
|
|
||||||
- private environment dumps;
|
|
||||||
- sensitive user data;
|
|
||||||
- raw private transcripts;
|
|
||||||
- private infrastructure details unless intentionally public.
|
|
||||||
|
|
||||||
Document secret-handling mechanisms, not actual secret values.
|
|
||||||
|
|
||||||
## Maintenance Rules
|
|
||||||
|
|
||||||
When docs change, verify the affected behavior.
|
|
||||||
|
|
||||||
Where practical:
|
|
||||||
|
|
||||||
- load example config files in tests;
|
|
||||||
- test CLI examples or command parser behavior;
|
|
||||||
- validate documented flags against real flags;
|
|
||||||
- remove stale references;
|
|
||||||
- update links after renames;
|
|
||||||
- keep roadmap content out of non-roadmap docs.
|
|
||||||
|
|
||||||
If documentation and code disagree, fix the documentation and/or open a roadmap item; do not leave aspirational behavior in current-behavior docs.
|
|
||||||
|
|
||||||
Documentation is complete only when it matches the current code.
|
|
||||||
|
|
||||||
## Documentation Change Checklist
|
|
||||||
|
|
||||||
Before merging documentation changes, verify:
|
|
||||||
|
|
||||||
- README is concise and orientation-focused.
|
|
||||||
- `docs/policy/architecture.md` describes development principles.
|
|
||||||
- Future work appears only under `docs/roadmap/`.
|
|
||||||
- User-facing docs avoid unnecessary internals.
|
|
||||||
- Developer-facing docs preserve boundaries and invariants.
|
|
||||||
- Config examples match the schema.
|
|
||||||
- CLI examples match real commands and flags.
|
|
||||||
- Defaults appear in the canonical config reference.
|
|
||||||
- No secrets or private data are included.
|
|
||||||
- Links are accurate.
|
|
||||||
|
|||||||
337
docs/policy/testing.md
Normal file
337
docs/policy/testing.md
Normal file
@@ -0,0 +1,337 @@
|
|||||||
|
# Testing Policy
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Our tests exist to make **incorrect changes expensive and correct changes
|
||||||
|
cheap**.
|
||||||
|
|
||||||
|
We do not optimize for test count, line coverage, exhaustive isolation, or the
|
||||||
|
fewest possible tests. We optimize for sufficient confidence in important
|
||||||
|
behavior while imposing as little unnecessary friction as possible on future
|
||||||
|
development.
|
||||||
|
|
||||||
|
## Every Test Has A Cost
|
||||||
|
|
||||||
|
Every test has an immediate cost and a continuing lifetime cost. It must be
|
||||||
|
written, reviewed, executed, understood, diagnosed when it fails, updated when
|
||||||
|
legitimate behavior changes, and maintained as fixtures and dependencies
|
||||||
|
evolve.
|
||||||
|
|
||||||
|
Tests also create cognitive and architectural friction. They can constrain
|
||||||
|
refactoring, duplicate policy, slow feedback, add noise to failures, and cause
|
||||||
|
harmless implementation changes to require unrelated suite edits.
|
||||||
|
|
||||||
|
A test is warranted when the confidence it provides justifies those costs.
|
||||||
|
Apply that judgment at two levels:
|
||||||
|
|
||||||
|
1. **Per test:** What realistic defect does this test detect, how consequential
|
||||||
|
would it be, and is that protection worth the test's lifetime cost?
|
||||||
|
2. **Across the suite:** Does this collection provide materially more
|
||||||
|
confidence than a smaller, simpler suite would?
|
||||||
|
|
||||||
|
Prefer a lean suite that provides sufficient confidence in the risks that
|
||||||
|
matter without redundant or low-value tests. Some friction is intentional:
|
||||||
|
tests should make dangerous changes, such as corrupting state, breaking
|
||||||
|
compatibility, violating security boundaries, or reintroducing subtle defects,
|
||||||
|
require deliberate review. They should not make ordinary internal changes
|
||||||
|
needlessly expensive.
|
||||||
|
|
||||||
|
Maintenance cost is not a reason to omit testing by default. When omitting a
|
||||||
|
plausible test, be able to explain why the protected failure is low-risk,
|
||||||
|
already covered, obvious, reversible, or cheaper to detect elsewhere. Favor
|
||||||
|
testing when failure would be consequential, subtle, or difficult to observe.
|
||||||
|
|
||||||
|
## Default Testing Style
|
||||||
|
|
||||||
|
Use a classical or Detroit-style approach:
|
||||||
|
|
||||||
|
- Test observable behavior, resulting state, contracts, and invariants.
|
||||||
|
- Use real internal collaborators when they are fast and deterministic.
|
||||||
|
- Use fakes, stubs, or mocks primarily at expensive, nondeterministic,
|
||||||
|
destructive, or external boundaries.
|
||||||
|
- Prefer package-level behavioral tests over tests coupled to private helpers
|
||||||
|
or internal call sequences.
|
||||||
|
- Test exact collaborator interactions only when the interaction itself is a
|
||||||
|
requirement.
|
||||||
|
|
||||||
|
Weatherreporter's important seams include clocks, Promptkit executors, HTTP
|
||||||
|
services, Distributor uploads, filesystem roots, environment-backed secrets, and any
|
||||||
|
future source of randomness or nondeterminism.
|
||||||
|
|
||||||
|
## Execution Requirements
|
||||||
|
|
||||||
|
The [development guide](../development.md) owns baseline repository validation.
|
||||||
|
The default test suite is:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go test ./...
|
||||||
|
```
|
||||||
|
|
||||||
|
Run race-enabled tests when a change affects concurrent execution, goroutine
|
||||||
|
lifecycle, shared mutable state, or cancellation coordination. Use a focused
|
||||||
|
package command while iterating and `go test -race ./...` when the risk crosses
|
||||||
|
package boundaries.
|
||||||
|
|
||||||
|
Tests in the default suite must be deterministic, offline, and independent of
|
||||||
|
real credentials. They must not invoke live Weather API, Promptkit providers, or
|
||||||
|
Distributor services or depend on other mutable external infrastructure.
|
||||||
|
Tests that require live infrastructure must be explicitly opt-in and clearly
|
||||||
|
separated from the default suite.
|
||||||
|
|
||||||
|
Control clocks, environment variables, filesystem roots, and machine-specific
|
||||||
|
state when they affect behavior. Tests must be safe to repeat and must not
|
||||||
|
depend on execution order or state left by an earlier test. Tests that modify
|
||||||
|
process-global state may remain serial; use `t.Parallel()` only when the test
|
||||||
|
and its collaborators are actually safe to run concurrently.
|
||||||
|
|
||||||
|
## Test Types And Assets
|
||||||
|
|
||||||
|
Use each test type where it protects a distinct risk:
|
||||||
|
|
||||||
|
- Unit and package tests protect focused domain behavior and invariants through
|
||||||
|
the narrowest stable boundary.
|
||||||
|
- Contract tests protect CLI behavior, configuration, durable artifacts,
|
||||||
|
schemas, templates, integration formats, compatibility, and stable error
|
||||||
|
identity.
|
||||||
|
- Integration tests use real deterministic collaborators when correctness
|
||||||
|
depends on their interaction, while replacing live or nondeterministic
|
||||||
|
external boundaries.
|
||||||
|
- App and CLI tests protect representative assembled generation, batch, atomic
|
||||||
|
output, and notification workflows.
|
||||||
|
- Fixtures must be minimal, synthetic, versioned with the behavior they
|
||||||
|
exercise, and free of credentials or private data.
|
||||||
|
- Golden files are appropriate only when the complete output is intentionally
|
||||||
|
stable and semantic review of updates is practical.
|
||||||
|
- Failure-path tests should cover consequential malformed input, dependency
|
||||||
|
failure, cancellation, partial results, and recovery behavior.
|
||||||
|
|
||||||
|
## What Deserves Tests
|
||||||
|
|
||||||
|
Prioritize tests for:
|
||||||
|
|
||||||
|
1. CLI, configuration, artifact, template, integration, and package contracts.
|
||||||
|
2. Meteorological domain rules and important invariants.
|
||||||
|
3. Boundary conditions and malformed input.
|
||||||
|
4. Failure handling, cancellation, retries, recovery, and partial success.
|
||||||
|
5. Serialization, schemas, compatibility, and round trips.
|
||||||
|
6. Previously observed or plausible regressions.
|
||||||
|
7. Representative app and CLI workflows.
|
||||||
|
|
||||||
|
A package-level contract is behavior relied upon by another package or major
|
||||||
|
collaborator, not every observable implementation detail.
|
||||||
|
|
||||||
|
For data integrity, destructive operations, compatibility, security,
|
||||||
|
concurrency, idempotency, or recovery, presume that durable tests are required
|
||||||
|
unless the behavior is already credibly protected at another layer.
|
||||||
|
|
||||||
|
Do not add tests merely because a function, branch, or line exists. Do not add
|
||||||
|
a test when the same meaningful risk is already adequately protected
|
||||||
|
elsewhere.
|
||||||
|
|
||||||
|
## Choose The Right Boundary
|
||||||
|
|
||||||
|
Test through the narrowest stable boundary that expresses the behavior clearly.
|
||||||
|
That may be:
|
||||||
|
|
||||||
|
- a small pure function when dense domain logic is clearest there;
|
||||||
|
- a package operation when several internal collaborators jointly produce the
|
||||||
|
behavior; or
|
||||||
|
- a larger integration or app boundary when correctness emerges from
|
||||||
|
interaction.
|
||||||
|
|
||||||
|
Do not force every behavior through oversized workflow tests. Do not test every
|
||||||
|
private helper merely because it exists. Choose the boundary that provides
|
||||||
|
durable confidence with the least incidental coupling.
|
||||||
|
|
||||||
|
## Test Behavior, Not Implementation
|
||||||
|
|
||||||
|
A test should protect a decision, contract, or invariant, not memorialize the
|
||||||
|
current implementation. Before adding or retaining a test, ask:
|
||||||
|
|
||||||
|
> What realistic defect would this test catch?
|
||||||
|
|
||||||
|
A test is suspect when its main purpose is to detect that someone changed a
|
||||||
|
private constant, renamed or split a helper, reordered equivalent operations,
|
||||||
|
changed incidental formatting, replaced one correct algorithm with another, or
|
||||||
|
refactored private structure without changing behavior.
|
||||||
|
|
||||||
|
Refactoring should normally require no test edits unless the changed structure
|
||||||
|
is itself contractual. A test can be factually correct and still have negative
|
||||||
|
value when the behavior it protects is too incidental to justify its future
|
||||||
|
cost.
|
||||||
|
|
||||||
|
Use these expectations when evaluating failures:
|
||||||
|
|
||||||
|
| Change | Expected effect on tests |
|
||||||
|
| --- | --- |
|
||||||
|
| Internal refactor that preserves behavior | Existing tests should normally remain unchanged and pass. |
|
||||||
|
| Internal default change with no contractual significance | Tests should normally derive expectations from configuration or relationships rather than duplicate the old value. |
|
||||||
|
| Intentional change to user-visible behavior, policy, schema, or compatibility | Relevant tests should be reviewed and changed deliberately. |
|
||||||
|
| Accidental contract or invariant violation | Tests should fail; fix production code rather than rewriting tests to accept the defect. |
|
||||||
|
|
||||||
|
A failing test is not necessarily a test that should be edited. Many tests may
|
||||||
|
correctly fail because of one production defect. The maintenance smell is a
|
||||||
|
correct internal change that requires unrelated expectation changes throughout
|
||||||
|
the suite.
|
||||||
|
|
||||||
|
## Separate Mechanism From Policy
|
||||||
|
|
||||||
|
Do not duplicate configurable thresholds and defaults throughout the suite.
|
||||||
|
Test mechanisms relationally: a configured valid value is accepted, a value
|
||||||
|
outside the permitted relationship is rejected, and runtime behavior respects
|
||||||
|
the configured value.
|
||||||
|
|
||||||
|
Test an exact default when its literal value is itself a documented user,
|
||||||
|
operational, safety, protocol, or compatibility contract. The same distinction
|
||||||
|
applies to timeouts, capacities, retry counts, ranges, thresholds, and output
|
||||||
|
limits.
|
||||||
|
|
||||||
|
When concurrency limits are introduced, distinguish configuration enforcement
|
||||||
|
from runtime enforcement. Validate accepted and rejected settings separately
|
||||||
|
from measuring whether observed peak concurrency respects the configured
|
||||||
|
limit.
|
||||||
|
|
||||||
|
## Avoid Semantic Duplication
|
||||||
|
|
||||||
|
Each behavior should have a clear test owner:
|
||||||
|
|
||||||
|
- CLI parser tests own arguments, flags, and command construction.
|
||||||
|
- Config tests own loading, precedence, defaults, secrets, and validation.
|
||||||
|
- Domain tests own weather transformations and invariants.
|
||||||
|
- Adapter tests own HTTP, Promptkit/provider, and upload boundaries.
|
||||||
|
- Orchestrator tests own workflow ordering, output publication, partial success,
|
||||||
|
and failure propagation.
|
||||||
|
- Filesystem tests own atomic writes and destination-preservation behavior.
|
||||||
|
- Template and generated-text tests own schemas, render contexts, and rendered
|
||||||
|
output contracts.
|
||||||
|
|
||||||
|
Higher-level tests should not repeat every lower-level case. Tests that are
|
||||||
|
individually reasonable may still be collectively redundant; assess the
|
||||||
|
marginal protection of each additional test.
|
||||||
|
|
||||||
|
## Use Test Doubles Deliberately
|
||||||
|
|
||||||
|
Choose the least elaborate double that provides the required control or
|
||||||
|
observation:
|
||||||
|
|
||||||
|
1. Prefer real collaborators when they are fast and deterministic.
|
||||||
|
2. Use small in-memory fakes when realistic stateful behavior helps.
|
||||||
|
3. Use stubs when a dependency only needs controlled responses.
|
||||||
|
4. Use mocks when the interaction itself is contractual.
|
||||||
|
|
||||||
|
Mocks are appropriate for requirements such as uploading exactly once,
|
||||||
|
notifying only after output publication, propagating cancellation to Promptkit, or
|
||||||
|
avoiding an external call after an earlier workflow failure. Do not use mocks
|
||||||
|
merely to isolate every object or reproduce the implementation's call graph.
|
||||||
|
|
||||||
|
## Go-Specific Guidance
|
||||||
|
|
||||||
|
Use:
|
||||||
|
|
||||||
|
- table-driven tests for meaningful behavioral categories and boundaries;
|
||||||
|
- `t.TempDir()` for real filesystem behavior;
|
||||||
|
- `httptest.Server` for realistic Weather API interactions;
|
||||||
|
- test-controlled clocks for periods and RunIDs;
|
||||||
|
- fake Promptkit executors or provider clients for Promptkit behavior;
|
||||||
|
- fake upload clients for Distributor behavior;
|
||||||
|
- fuzz tests when parsers, normalization, or path handling have a broad and
|
||||||
|
consequential input space;
|
||||||
|
- golden files only when complete output stability is intentional; and
|
||||||
|
- a small number of representative app and CLI workflow tests.
|
||||||
|
|
||||||
|
Avoid exact error-string assertions unless wording is contractual. Prefer
|
||||||
|
`errors.Is`, `errors.As`, typed errors, structured fields, or the smallest
|
||||||
|
stable semantic fragment that identifies the failure. At CLI boundaries,
|
||||||
|
prefer structured summaries, exit behavior, and stable classifications over
|
||||||
|
snapshots of complete diagnostic wording.
|
||||||
|
|
||||||
|
Golden-file updates must require an explicit local flag. Ordinary validation
|
||||||
|
must never update golden files automatically, and maintainers must inspect the
|
||||||
|
semantic diff before accepting an update.
|
||||||
|
|
||||||
|
Keep tests readable and direct. Helpers and fixture frameworks must earn their
|
||||||
|
maintenance cost; do not build elaborate infrastructure for small or isolated
|
||||||
|
needs.
|
||||||
|
|
||||||
|
## Coverage
|
||||||
|
|
||||||
|
Coverage is a diagnostic, not a target. Use it to find untested critical
|
||||||
|
branches and unexpectedly weak packages. Do not write low-value tests solely
|
||||||
|
to increase a percentage or infer quality from coverage alone.
|
||||||
|
|
||||||
|
Pure domain logic will often warrant higher coverage than CLI wiring or thin
|
||||||
|
external adapters. Uneven coverage is acceptable when it reflects risk.
|
||||||
|
|
||||||
|
## Regression Tests
|
||||||
|
|
||||||
|
A bug fix should normally include a regression test that fails before the fix
|
||||||
|
and passes afterward. Prefer the narrowest durable test of the violated
|
||||||
|
contract or invariant.
|
||||||
|
|
||||||
|
Retain the test when the defect could realistically recur and its consequences
|
||||||
|
justify the ongoing cost. Remove or consolidate it if the design makes
|
||||||
|
recurrence implausible or a stronger invariant test subsumes it.
|
||||||
|
|
||||||
|
## Deleting Or Rewriting Tests
|
||||||
|
|
||||||
|
Tests are maintained code, not permanent historical artifacts. Delete or
|
||||||
|
rewrite a test when its maintenance cost exceeds the confidence it provides.
|
||||||
|
Candidates include tests that:
|
||||||
|
|
||||||
|
- require edits after harmless internal changes;
|
||||||
|
- assert private constants without protecting a real contract;
|
||||||
|
- duplicate the same policy across several layers;
|
||||||
|
- verify mock choreography rather than outcomes;
|
||||||
|
- snapshot large amounts of incidental output;
|
||||||
|
- protect risks already covered more effectively elsewhere; or
|
||||||
|
- are flaky, misleading, obsolete, or no longer correspond to a plausible
|
||||||
|
failure.
|
||||||
|
|
||||||
|
Test removal must be deliberate and within the scope of the change. Identify
|
||||||
|
the behavior the test protected and show that the behavior is covered more
|
||||||
|
effectively elsewhere or that the failure is no longer plausible enough to
|
||||||
|
justify durable coverage. Replace several brittle tests with one stronger
|
||||||
|
behavior or invariant test when appropriate.
|
||||||
|
|
||||||
|
Do not delete or weaken a test merely because it fails after a production
|
||||||
|
change. First determine whether the failure exposes an accidental regression,
|
||||||
|
an intentional contract change, or an implementation-coupled assertion.
|
||||||
|
|
||||||
|
## Reviewing A Proposed Test
|
||||||
|
|
||||||
|
When a proposed test's value or durability is not self-evident, ask:
|
||||||
|
|
||||||
|
1. What realistic defect would it catch, and how consequential is that defect?
|
||||||
|
2. Is the behavior already protected elsewhere?
|
||||||
|
3. Which layer should own the test?
|
||||||
|
4. Does it assert a durable contract or incidental implementation detail?
|
||||||
|
5. What should cause it to fail, and what legitimate changes should not?
|
||||||
|
6. Could a smaller or more direct test protect the same risk?
|
||||||
|
7. What ongoing maintenance, execution, and diagnostic cost will it impose?
|
||||||
|
|
||||||
|
Written answers are not required for every routine test. Do not add a test when
|
||||||
|
its expected lifetime cost exceeds its expected protective value.
|
||||||
|
|
||||||
|
## Definition Of Sufficient
|
||||||
|
|
||||||
|
A suite is sufficient when:
|
||||||
|
|
||||||
|
- important contracts and invariants are protected;
|
||||||
|
- meaningful boundaries and failure modes are exercised;
|
||||||
|
- consequential regressions are credibly protected against silent recurrence;
|
||||||
|
- data integrity, destructive operations, compatibility, security,
|
||||||
|
concurrency, idempotency, and recovery receive risk-appropriate protection;
|
||||||
|
- external boundaries have realistic local integration coverage;
|
||||||
|
- representative complete workflows are tested;
|
||||||
|
- failures provide useful signal rather than redundant noise; and
|
||||||
|
- legitimate internal changes usually do not require test edits.
|
||||||
|
|
||||||
|
Sufficiency is a risk judgment, not a coverage percentage or test count.
|
||||||
|
Reassess it as Weatherreporter, its users, and the consequences of failure
|
||||||
|
evolve.
|
||||||
|
|
||||||
|
The governing rule is:
|
||||||
|
|
||||||
|
> Test heavily where failure is consequential, subtle, or difficult to detect
|
||||||
|
> after the fact. Test lightly where failure is obvious, reversible, and
|
||||||
|
> inexpensive.
|
||||||
269
docs/release.md
Normal file
269
docs/release.md
Normal file
@@ -0,0 +1,269 @@
|
|||||||
|
# Release Procedure
|
||||||
|
|
||||||
|
## Release Model
|
||||||
|
|
||||||
|
Weatherreporter publishes executable binaries through tagged commits on
|
||||||
|
`main`. Releases use stable semantic-version tags in the form
|
||||||
|
`vMAJOR.MINOR.PATCH`. The current pipeline does not publish prereleases.
|
||||||
|
|
||||||
|
Every release has one nonempty, version-matched note at
|
||||||
|
`docs/releases/<tag>.md`. After the tag is pushed, the Woodpecker release
|
||||||
|
pipeline validates the tagged source, builds six binaries, creates SHA-256
|
||||||
|
checksums, and creates the corresponding Gitea release. The pipeline uses the
|
||||||
|
checked-in release note as the Gitea release body and does not overwrite an
|
||||||
|
existing release.
|
||||||
|
|
||||||
|
Before `v1.0.0`, a minor release may deliberately change user-facing
|
||||||
|
interfaces when its release note explains the compatibility impact and
|
||||||
|
required operator action. Patch releases must not intentionally break the
|
||||||
|
documented CLI, configuration, durable artifact, or integration contracts in
|
||||||
|
their minor line.
|
||||||
|
|
||||||
|
Published tags and their generated releases are immutable. Never move, reuse,
|
||||||
|
or delete a published tag, and never manually overwrite the release produced
|
||||||
|
from it.
|
||||||
|
|
||||||
|
## Select The Version And Write The Release Note
|
||||||
|
|
||||||
|
Choose an unpublished version and export it as `RELEASE_VERSION`. Run the
|
||||||
|
commands in this procedure from the Weatherreporter repository root in one
|
||||||
|
POSIX shell:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
export RELEASE_VERSION=vMAJOR.MINOR.PATCH
|
||||||
|
```
|
||||||
|
|
||||||
|
Create `docs/releases/$RELEASE_VERSION.md` with this structure:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# Weatherreporter vMAJOR.MINOR.PATCH
|
||||||
|
|
||||||
|
This release ...
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Summarize the release's purpose and most important outcomes.
|
||||||
|
|
||||||
|
## Compatibility
|
||||||
|
|
||||||
|
State compatibility with the preceding release and identify any changed CLI,
|
||||||
|
configuration, durable artifact, integration, or operating contract.
|
||||||
|
|
||||||
|
## Upgrade
|
||||||
|
|
||||||
|
State the operator actions required to upgrade, or state that no special
|
||||||
|
action is required.
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
Describe the material user-visible, operational, and maintainer-visible
|
||||||
|
changes. Link to canonical documentation for exact current contracts.
|
||||||
|
```
|
||||||
|
|
||||||
|
The note is a concise changelog and adoption aid, not a replacement for current
|
||||||
|
documentation. Update every affected canonical document in the same candidate
|
||||||
|
commit. Do not include credentials, private infrastructure details, or claims
|
||||||
|
that are not true of the candidate.
|
||||||
|
|
||||||
|
Require the version, path, heading, and minimum sections before continuing:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
: "${RELEASE_VERSION:?export an unpublished vMAJOR.MINOR.PATCH version}"
|
||||||
|
if ! printf '%s\n' "$RELEASE_VERSION" |
|
||||||
|
grep -Eq '^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$'
|
||||||
|
then
|
||||||
|
printf '%s\n' "invalid release version: $RELEASE_VERSION" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
RELEASE_NOTE="docs/releases/$RELEASE_VERSION.md"
|
||||||
|
export RELEASE_NOTE
|
||||||
|
|
||||||
|
test -s "$RELEASE_NOTE"
|
||||||
|
grep -Fx "# Weatherreporter $RELEASE_VERSION" "$RELEASE_NOTE"
|
||||||
|
grep -Fx '## Summary' "$RELEASE_NOTE"
|
||||||
|
grep -Fx '## Compatibility' "$RELEASE_NOTE"
|
||||||
|
grep -Fx '## Upgrade' "$RELEASE_NOTE"
|
||||||
|
grep -Fx '## Changes' "$RELEASE_NOTE"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Validate The Candidate
|
||||||
|
|
||||||
|
Run the same substantive checks enforced by the tag pipeline before committing
|
||||||
|
the release note:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
test -z "$(git ls-files go.work go.work.sum)"
|
||||||
|
test ! -e vendor
|
||||||
|
if grep -Eq '^[[:space:]]*replace([[:space:]]|\()' go.mod
|
||||||
|
then
|
||||||
|
printf '%s\n' 'go.mod contains a replacement' >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
GOWORK=off go test -count=1 ./...
|
||||||
|
GOWORK=off go test -race -count=1 ./...
|
||||||
|
GOWORK=off go vet ./...
|
||||||
|
GOWORK=off go build ./...
|
||||||
|
GOWORK=off go mod tidy -diff
|
||||||
|
|
||||||
|
unformatted=$(
|
||||||
|
git ls-files '*.go' |
|
||||||
|
while IFS= read -r go_file
|
||||||
|
do
|
||||||
|
gofmt -l "$go_file"
|
||||||
|
done
|
||||||
|
)
|
||||||
|
test -z "$unformatted"
|
||||||
|
git diff --check
|
||||||
|
git diff --cached --check
|
||||||
|
```
|
||||||
|
|
||||||
|
Follow every added or changed Markdown link and confirm that its local target
|
||||||
|
exists. Review the candidate for generated binaries, test output, credentials,
|
||||||
|
temporary files, replacements, vendored dependencies, and other files that do
|
||||||
|
not belong in source control.
|
||||||
|
|
||||||
|
## Publish The Candidate Commit
|
||||||
|
|
||||||
|
Commit the release note and any final current-state documentation updates, then
|
||||||
|
push `main` through the ordinary repository workflow:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git add "$RELEASE_NOTE"
|
||||||
|
git commit -m "Document Weatherreporter $RELEASE_VERSION"
|
||||||
|
git push origin main
|
||||||
|
```
|
||||||
|
|
||||||
|
Do not tag an uncommitted or unpushed candidate. Record and export the exact
|
||||||
|
candidate commit after the push:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
RELEASE_COMMIT=$(git rev-parse --verify 'HEAD^{commit}')
|
||||||
|
export RELEASE_COMMIT
|
||||||
|
```
|
||||||
|
|
||||||
|
## Guard And Tag The Candidate
|
||||||
|
|
||||||
|
Run this guard immediately before creating the tag. It requires a clean
|
||||||
|
checkout on synchronized `main`, valid module hygiene, the version-matched
|
||||||
|
release note, and an unpublished local and remote tag:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
check_release_candidate() {
|
||||||
|
test "$(git branch --show-current)" = main
|
||||||
|
test -z "$(git status --porcelain)"
|
||||||
|
|
||||||
|
gowork_value=$(go env GOWORK)
|
||||||
|
case "$gowork_value" in
|
||||||
|
''|off) ;;
|
||||||
|
*)
|
||||||
|
printf '%s\n' "active Go workspace: $gowork_value" >&2
|
||||||
|
return 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
test -z "$(git ls-files go.work go.work.sum)"
|
||||||
|
test ! -e vendor
|
||||||
|
if grep -Eq '^[[:space:]]*replace([[:space:]]|\()' go.mod
|
||||||
|
then
|
||||||
|
printf '%s\n' 'go.mod contains a replacement' >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
test -s "$RELEASE_NOTE"
|
||||||
|
grep -Fx "# Weatherreporter $RELEASE_VERSION" "$RELEASE_NOTE"
|
||||||
|
|
||||||
|
git fetch origin main --tags
|
||||||
|
test "$RELEASE_COMMIT" = \
|
||||||
|
"$(git rev-parse --verify 'refs/remotes/origin/main^{commit}')"
|
||||||
|
|
||||||
|
if git show-ref --verify --quiet "refs/tags/$RELEASE_VERSION"
|
||||||
|
then
|
||||||
|
printf '%s\n' "local tag already exists: $RELEASE_VERSION" >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
if test -n "$(
|
||||||
|
git ls-remote --tags origin \
|
||||||
|
"refs/tags/$RELEASE_VERSION" \
|
||||||
|
"refs/tags/$RELEASE_VERSION^{}"
|
||||||
|
)"
|
||||||
|
then
|
||||||
|
printf '%s\n' "remote tag already exists: $RELEASE_VERSION" >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
check_release_candidate
|
||||||
|
```
|
||||||
|
|
||||||
|
Create a lightweight tag, matching Weatherreporter's existing release tags,
|
||||||
|
and bind it explicitly to the guarded commit:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git tag "$RELEASE_VERSION" "$RELEASE_COMMIT"
|
||||||
|
test "$(git cat-file -t "refs/tags/$RELEASE_VERSION")" = commit
|
||||||
|
test "$(git rev-parse --verify "refs/tags/$RELEASE_VERSION^{commit}")" = \
|
||||||
|
"$RELEASE_COMMIT"
|
||||||
|
git show --no-patch --decorate "refs/tags/$RELEASE_VERSION"
|
||||||
|
```
|
||||||
|
|
||||||
|
If inspection finds an error, delete the unpublished local tag, correct the
|
||||||
|
candidate, and repeat the procedure. Once the tag is pushed, it is immutable.
|
||||||
|
|
||||||
|
## Publish And Verify The Release
|
||||||
|
|
||||||
|
Push only the selected tag ref. Do not use `git push --tags`:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git push origin \
|
||||||
|
"refs/tags/$RELEASE_VERSION:refs/tags/$RELEASE_VERSION"
|
||||||
|
```
|
||||||
|
|
||||||
|
The tag event starts the release pipeline. Its validation step rejects a
|
||||||
|
non-stable semantic tag, a missing release note, module or repository hygiene
|
||||||
|
violations, and any failing test, race test, vet, build, module-tidiness,
|
||||||
|
formatting, or whitespace check. Its build step also verifies that the host
|
||||||
|
binary reports `weatherreporter $RELEASE_VERSION`.
|
||||||
|
|
||||||
|
Wait for the pipeline to succeed, then confirm that the Gitea release:
|
||||||
|
|
||||||
|
- targets `RELEASE_COMMIT` through `RELEASE_VERSION`;
|
||||||
|
- is titled `Weatherreporter $RELEASE_VERSION`;
|
||||||
|
- uses `RELEASE_NOTE` from the tagged commit as its body;
|
||||||
|
- contains `SHA256SUMS`; and
|
||||||
|
- contains Linux, macOS, and Windows binaries for both `amd64` and `arm64`,
|
||||||
|
named `weatherreporter-$RELEASE_VERSION-<os>-<arch>` with `.exe` on Windows.
|
||||||
|
|
||||||
|
Compare the remote tag with the guarded commit:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
remote_commit=$(
|
||||||
|
git ls-remote --tags origin "refs/tags/$RELEASE_VERSION" |
|
||||||
|
awk 'NR == 1 { print $1 }'
|
||||||
|
)
|
||||||
|
test "$remote_commit" = "$RELEASE_COMMIT"
|
||||||
|
```
|
||||||
|
|
||||||
|
Download `SHA256SUMS` and every release binary into a new temporary directory,
|
||||||
|
run `sha256sum --check SHA256SUMS`, and execute the binary for the maintainer's
|
||||||
|
host platform with `--version`. It must print exactly:
|
||||||
|
|
||||||
|
```text
|
||||||
|
weatherreporter vMAJOR.MINOR.PATCH
|
||||||
|
```
|
||||||
|
|
||||||
|
## Failed Publication And Corrections
|
||||||
|
|
||||||
|
If the tag pipeline fails after publication, preserve the tag and diagnose the
|
||||||
|
failure from the pipeline logs. Fix the cause on `main`, select a new patch
|
||||||
|
version, prepare a new release note, and repeat the complete procedure. Do not
|
||||||
|
move or recreate the failed published tag.
|
||||||
|
|
||||||
|
Do not manually edit an automatically generated Gitea release or republish its
|
||||||
|
assets. A wording-only correction may be committed to the historical document
|
||||||
|
on `main`, with an explicit correction note, but it does not alter the file at
|
||||||
|
the tag or the generated release. Publish a new patch release when the error is
|
||||||
|
material to installation, compatibility, security, or operation.
|
||||||
140
docs/releases/v0.10.0.md
Normal file
140
docs/releases/v0.10.0.md
Normal file
@@ -0,0 +1,140 @@
|
|||||||
|
# Weatherreporter v0.10.0
|
||||||
|
|
||||||
|
Weatherreporter `v0.10.0` makes report execution stateless, adds stable
|
||||||
|
weather-specific Promptkit profiles, and turns every successful generation
|
||||||
|
into one atomic operator-owned Markdown output.
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
- Ordinary generation no longer creates or depends on a managed workspace,
|
||||||
|
historical run artifacts, metadata, receipts, or prior snapshots.
|
||||||
|
- `generate` and `run` now publish directly to operator-selected paths, with
|
||||||
|
useful current-directory defaults when output flags are omitted.
|
||||||
|
- Local Recent Changes comparison and the historical `inspect` command family
|
||||||
|
have been removed.
|
||||||
|
- Promptkit `v0.5.0` and three embedded logical profiles provide a stable model
|
||||||
|
ladder with complete file- or directory-based overrides.
|
||||||
|
- Prompt input and generated-text contracts have been tightened, and output,
|
||||||
|
cancellation, batch preflight, notification, and partial-failure behavior
|
||||||
|
have focused offline coverage.
|
||||||
|
|
||||||
|
## Compatibility
|
||||||
|
|
||||||
|
This pre-`v1` minor release intentionally breaks CLI, configuration,
|
||||||
|
prompt-input, action-summary, and workspace contracts from `v0.9.0`.
|
||||||
|
|
||||||
|
- The `workspace:` and `recent_change:` configuration sections are no longer
|
||||||
|
supported. Strict configuration loading rejects them.
|
||||||
|
- The `inspect reports`, `inspect metadata`, `inspect modules`,
|
||||||
|
`inspect data-package`, `inspect prior`, and `inspect sources` commands have
|
||||||
|
been removed. Weatherreporter no longer reads V1 or V2 run metadata or other
|
||||||
|
historical workspace artifacts.
|
||||||
|
- Every successful `generate` writes exactly one Markdown file. Without
|
||||||
|
`--out`, Daily writes `daily-YYYY-MM-DD.md` and Today, Tomorrow, and Hourly
|
||||||
|
write `today.md`, `tomorrow.md`, and `hourly.md` in the invocation's current
|
||||||
|
directory. `--out` selects that file rather than creating an extra copy of a
|
||||||
|
separately managed report.
|
||||||
|
- `run` writes selected outputs beneath the current directory unless
|
||||||
|
`--out-dir` selects another directory. Successful items remain available
|
||||||
|
when another batch item fails.
|
||||||
|
- Action summaries no longer expose managed report, metadata, snapshot, data
|
||||||
|
package, prompt preparation, prompt execution, generated-text, render-context,
|
||||||
|
or notification-receipt paths. They retain the final `outputPath`, optional
|
||||||
|
`llmDebugPath`, safe effective profile/backend/model details, validation,
|
||||||
|
warnings, notification status, and safe errors.
|
||||||
|
- Batch report items no longer contain per-report notification fields. Batch
|
||||||
|
notification is represented once at the top level. The `total`, `succeeded`,
|
||||||
|
and `failed` counters describe reports only, so notification failure can
|
||||||
|
produce a failed action while `failed` remains `0`.
|
||||||
|
- The prompt data package advances from `weatherreporter.data_package.v3` to
|
||||||
|
`weatherreporter.data_package.v4` and removes `recent_changes`. All four
|
||||||
|
embedded prompts advance from `1.1.0` to `2.0.0`.
|
||||||
|
- Generated-text schemas now require string-valued `precipitation_timing`; the
|
||||||
|
model returns an empty string when there is no timing text. The unused
|
||||||
|
`confidence` field has been removed and is rejected as an unknown field.
|
||||||
|
|
||||||
|
Existing operator-owned Markdown files remain valid. Existing workspace trees
|
||||||
|
are ignored rather than migrated or deleted. Distributor continues to receive
|
||||||
|
the completed Markdown report, but its source is now the selected operator
|
||||||
|
output rather than a managed report copy.
|
||||||
|
|
||||||
|
## Upgrade
|
||||||
|
|
||||||
|
Before replacing `v0.9.0`:
|
||||||
|
|
||||||
|
1. Remove `workspace:` and `recent_change:` from configuration files.
|
||||||
|
2. Give scheduled commands a predictable working directory or explicit
|
||||||
|
`--out` or `--out-dir` destination. Confirm that these selected files may be
|
||||||
|
atomically replaced on later successful runs.
|
||||||
|
3. Remove historical `inspect` invocations and update action-summary consumers
|
||||||
|
to use `outputPath` and the remaining active-workflow fields.
|
||||||
|
4. Decide whether old workspace contents have any external retention value.
|
||||||
|
Weatherreporter no longer reads them; after review, they may be removed
|
||||||
|
manually using the narrowly scoped procedure in the operations guide.
|
||||||
|
5. Review Promptkit profile selection and credentials. Hourly defaults to
|
||||||
|
`weather-light`; Daily, Today, and Tomorrow default to `weather-balanced`.
|
||||||
|
A configured `promptkit.profile` still overrides every report in one action.
|
||||||
|
|
||||||
|
The embedded logical profiles are:
|
||||||
|
|
||||||
|
| Profile | OpenRouter model | Default use |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `weather-light` | `deepseek/deepseek-v4-flash` | Hourly |
|
||||||
|
| `weather-balanced` | `~google/gemini-flash-latest` | Daily, Today, Tomorrow |
|
||||||
|
| `weather-deep` | `~anthropic/claude-sonnet-latest` | Explicit selection |
|
||||||
|
|
||||||
|
Override a complete same-ID definition through `promptkit.profile_file` or
|
||||||
|
`promptkit.profile_dir` to use different models or a local OpenAI-compatible
|
||||||
|
endpoint. Definitions are replaced rather than field-merged, and a malformed
|
||||||
|
matching override fails instead of silently falling back.
|
||||||
|
|
||||||
|
See the [CLI reference](../cli.md), [configuration
|
||||||
|
reference](../config.md), [operations guide](../operations.md), and [Promptkit
|
||||||
|
integration](../integrations/promptkit.md) for the exact current contracts.
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
### Stateless Execution And Operator-Owned Outputs
|
||||||
|
|
||||||
|
- Removed local forecast-change comparison, prior-snapshot selection, durable
|
||||||
|
module and prompt artifacts, managed reports, metadata compatibility, run
|
||||||
|
discovery, notification receipts, and the complete `internal/state`
|
||||||
|
subsystem.
|
||||||
|
- Added an Accepted architecture decision recording the stateless
|
||||||
|
transformation pipeline and operator-owned output boundary.
|
||||||
|
- Kept weather, facts, modules, prompt input, generated text, and render context
|
||||||
|
in memory during ordinary execution.
|
||||||
|
- Made output publication atomic and ensured cancellation or deadline expiry
|
||||||
|
observed before publication leaves an existing destination unchanged.
|
||||||
|
- Added complete batch-destination preflight before the first report prompt,
|
||||||
|
so a structural collision cannot leave an unreported partial batch.
|
||||||
|
- Preserved successful outputs after report or Distributor failure. Batch
|
||||||
|
notification runs only after every selected report succeeds.
|
||||||
|
|
||||||
|
### Promptkit Profiles And Prompt Contracts
|
||||||
|
|
||||||
|
- Upgraded Promptkit from `v0.4.0` to `v0.5.0`.
|
||||||
|
- Added embedded `weather-light`, `weather-balanced`, and `weather-deep`
|
||||||
|
profiles and mapped each exact prompt to its logical default.
|
||||||
|
- Added embedded-profile fallback after configured `profile_file` or
|
||||||
|
`profile_dir` lookup, allowing operators to replace a logical profile without
|
||||||
|
changing report definitions.
|
||||||
|
- Added a maintained local-endpoint example for replacing `weather-light`.
|
||||||
|
- Advanced the four prompt definitions to `2.0.0` and the curated data package
|
||||||
|
to v4 after removing Recent Changes.
|
||||||
|
- Required `precipitation_timing`, normalized whitespace-only timing to an
|
||||||
|
empty string, and removed the unused confidence value.
|
||||||
|
|
||||||
|
### CLI, Reliability, Documentation, And Testing
|
||||||
|
|
||||||
|
- Simplified action summaries to active workflow identity, output, model,
|
||||||
|
validation, warning, debug, notification, and safe error information.
|
||||||
|
- Made batch counters report-only while retaining failed action status and
|
||||||
|
non-zero exit behavior for batch notification failure.
|
||||||
|
- Kept prompt and profile inspection ahead of weather collection and validated
|
||||||
|
every batch candidate before collecting once.
|
||||||
|
- Replaced state-oriented workflow fixtures with focused generation, batch,
|
||||||
|
output, cancellation, profile-resolution, Distributor, and CLI coverage.
|
||||||
|
- Reconciled user, operator, integration, internal, policy, and ADR
|
||||||
|
documentation around the implemented stateless architecture and removed
|
||||||
|
completed temporary roadmaps.
|
||||||
33
docs/releases/v0.10.1.md
Normal file
33
docs/releases/v0.10.1.md
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
# Weatherreporter v0.10.1
|
||||||
|
|
||||||
|
This release repairs release validation after the `v0.10.0` pipeline failed in
|
||||||
|
its privileged build container. Application behavior is unchanged from
|
||||||
|
`v0.10.0`.
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
The unreadable-secret configuration test now verifies that its process is
|
||||||
|
actually subject to file permission bits before asserting that a mode-`000`
|
||||||
|
file cannot be read. This keeps the test meaningful for ordinary users while
|
||||||
|
allowing the release suite to run correctly in privileged containers.
|
||||||
|
|
||||||
|
## Compatibility
|
||||||
|
|
||||||
|
This patch release makes no changes to Weatherreporter's CLI, configuration,
|
||||||
|
report output, integrations, prompts, profiles, or operating behavior. It is
|
||||||
|
fully compatible with `v0.10.0`.
|
||||||
|
|
||||||
|
## Upgrade
|
||||||
|
|
||||||
|
No special operator action is required. Use `v0.10.1` in place of `v0.10.0`;
|
||||||
|
the `v0.10.0` tag remains immutable, but its failed pipeline did not publish
|
||||||
|
release binaries.
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
- Made the unreadable-secret test capability-aware when the test process can
|
||||||
|
bypass filesystem permission bits.
|
||||||
|
- Preserved the production contract that genuinely unreadable secret files
|
||||||
|
fail configuration loading.
|
||||||
|
- Restored portable release validation in Woodpecker's privileged Go
|
||||||
|
container.
|
||||||
134
docs/releases/v0.9.0.md
Normal file
134
docs/releases/v0.9.0.md
Normal file
@@ -0,0 +1,134 @@
|
|||||||
|
# Weatherreporter v0.9.0
|
||||||
|
|
||||||
|
Weatherreporter `v0.9.0` replaces its external Scriptorium execution path with
|
||||||
|
an in-process Promptkit integration and makes prompt preparation, execution,
|
||||||
|
validation, and failure artifacts first-class parts of each report run.
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
- Promptkit `v0.4.0` now executes all generated text for Daily, Today,
|
||||||
|
Tomorrow, and Hourly reports.
|
||||||
|
- The four exact-version prompts and their JSON Schemas are embedded in the
|
||||||
|
Weatherreporter binary.
|
||||||
|
- Prompt preparation and execution have separate durable, redacted provenance
|
||||||
|
records, while sensitive prompt debugging is explicit and stored outside the
|
||||||
|
managed workspace.
|
||||||
|
- Weather API collection now performs a warmup request and retries transient
|
||||||
|
transport, read, and selected HTTP failures.
|
||||||
|
- Release binaries now report their embedded version and are published with
|
||||||
|
checksums through a guarded Woodpecker pipeline.
|
||||||
|
|
||||||
|
## Compatibility
|
||||||
|
|
||||||
|
This pre-`v1` minor release contains intentional configuration, CLI, and
|
||||||
|
artifact changes that require review when upgrading from `v0.8.0`.
|
||||||
|
|
||||||
|
- The `scriptorium:` configuration section is no longer supported. A file that
|
||||||
|
contains it fails with a migration error instead of silently ignoring it.
|
||||||
|
Use `promptkit:` configuration instead.
|
||||||
|
- The previously exposed but unfinished three-day, weekend, and storm report
|
||||||
|
surfaces have been removed. Supported report IDs and `generate` commands are
|
||||||
|
`daily`, `today`, `tomorrow`, and `hourly`. The retired `storm_id`
|
||||||
|
Distributor template variable is also no longer accepted.
|
||||||
|
- Generate and batch result items now expose `preparationPath` and
|
||||||
|
`executionPath` instead of the Scriptorium-oriented `preflightPath` and
|
||||||
|
`generatedTextResultPath`. An opt-in prompt capture may also add
|
||||||
|
`llmDebugPath`.
|
||||||
|
- New runs write `weatherreporter.metadata.v2`, which records Promptkit
|
||||||
|
preparation and execution paths. Inspection and prior-run lookup continue to
|
||||||
|
read existing `weatherreporter.metadata.v1` records.
|
||||||
|
- The built-in `weather_api.precision` default changed from `1` to `0`.
|
||||||
|
Configurations that explicitly set a value retain that value.
|
||||||
|
- Report prose may differ because the embedded prompt corpus, structured
|
||||||
|
output path, alert presentation, and SPC background context have changed.
|
||||||
|
|
||||||
|
The documented Go version remains 1.26. Distributor integration remains at
|
||||||
|
`v0.5.0`. Existing managed workspaces do not require conversion.
|
||||||
|
|
||||||
|
## Upgrade
|
||||||
|
|
||||||
|
Replace the old Scriptorium block in the Weatherreporter configuration. The
|
||||||
|
smallest equivalent Promptkit block is:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
promptkit:
|
||||||
|
timeout: 2m
|
||||||
|
```
|
||||||
|
|
||||||
|
The embedded prompts default to the Promptkit `gemini-flash-latest` profile.
|
||||||
|
Ensure that the selected profile's credential environment variable is present,
|
||||||
|
or configure `promptkit.profile`, an external `profile_file` or `profile_dir`,
|
||||||
|
or the optional `promptkit.local` backend. Direct per-request API keys are not
|
||||||
|
supported by Weatherreporter.
|
||||||
|
|
||||||
|
Before upgrading automation or downstream processing:
|
||||||
|
|
||||||
|
1. remove any `three-day`, `weekend`, or `storm` command, report override, and
|
||||||
|
`storm_id` template usage;
|
||||||
|
2. update consumers of action-summary JSON to use the new preparation and
|
||||||
|
execution path fields;
|
||||||
|
3. decide whether to retain the new precision default or explicitly configure
|
||||||
|
the previous value; and
|
||||||
|
4. preserve the existing workspace if historical V1 runs must remain
|
||||||
|
inspectable.
|
||||||
|
|
||||||
|
Scriptorium, its executable configuration, and its external prompt corpus are
|
||||||
|
no longer needed by Weatherreporter. See the
|
||||||
|
[configuration reference](../config.md), [CLI reference](../cli.md), and
|
||||||
|
[Promptkit integration](../integrations/promptkit.md) for the current
|
||||||
|
contracts.
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
### Prompt Execution And Artifacts
|
||||||
|
|
||||||
|
- Added a project-owned Promptkit adapter with exact prompt and profile
|
||||||
|
inspection, prepare-once execution, error classification, and bounded
|
||||||
|
execution timeouts.
|
||||||
|
- Embedded version `1.0.0` of the Daily, Today, Tomorrow, and Hourly prompts and
|
||||||
|
their private generated-text schemas.
|
||||||
|
- Added durable preparation and execution receipts with prompt, profile,
|
||||||
|
backend, model, hashes, timings, validation status, classified failures, and
|
||||||
|
paths to every artifact reached during the run. Credentials, endpoints,
|
||||||
|
rendered messages, request parameters, and generated content are excluded
|
||||||
|
from these managed records.
|
||||||
|
- Added `--llm-debug-dir` for explicitly requested content-rich diagnostics.
|
||||||
|
Debug output must use an absolute path outside the managed workspace and is
|
||||||
|
written with restrictive filesystem permissions.
|
||||||
|
- Preflight now validates each exact prompt and selected profile before weather
|
||||||
|
collection. Batch execution validates every candidate first, collects once,
|
||||||
|
and retains independent report progress and failure artifacts.
|
||||||
|
|
||||||
|
See the [operations guide](../operations.md) for artifact layout, inspection,
|
||||||
|
debug handling, and recovery.
|
||||||
|
|
||||||
|
### Weather Collection And Report Content
|
||||||
|
|
||||||
|
- Added a `/conditions/current` warmup before source collection and automatic
|
||||||
|
retry for transient transport and response-read failures and HTTP `408`,
|
||||||
|
`429`, `500`, `502`, `503`, and `504` responses.
|
||||||
|
- Changed the default upstream precision query value to `0`.
|
||||||
|
- Added embedded background definitions for recognized SPC categorical,
|
||||||
|
tornado, wind, and hail outlook products.
|
||||||
|
- Made the Alert Digest more concise: alert descriptions are omitted, and an
|
||||||
|
SPC-only digest is rendered only for Enhanced, Moderate, or High categorical
|
||||||
|
risk.
|
||||||
|
- Removed duplicated alert detail from the prompt-facing metadata module; the
|
||||||
|
alert digest remains its single prompt-facing owner.
|
||||||
|
|
||||||
|
See the [Weather API integration](../integrations/weatherapi.md) for the request,
|
||||||
|
retry, and response contract.
|
||||||
|
|
||||||
|
### CLI, Documentation, Testing, And Releases
|
||||||
|
|
||||||
|
- Added `weatherreporter --version`; tagged binaries report `v0.9.0`, while
|
||||||
|
ordinary local builds report `development`.
|
||||||
|
- Reworked CLI summaries and inspection coverage around the Promptkit artifact
|
||||||
|
lifecycle and retained partial-result behavior.
|
||||||
|
- Reorganized contributor, policy, user, operator, integration, template, and
|
||||||
|
internal documentation around explicit canonical owners.
|
||||||
|
- Added focused single-report, batch, CLI, Promptkit adapter, durable-state,
|
||||||
|
and artifact-path coverage while simplifying orchestration internals.
|
||||||
|
- Added guarded tag validation and reproducible release builds for Linux,
|
||||||
|
macOS, and Windows on `amd64` and `arm64`, with SHA-256 checksums and
|
||||||
|
changelog-backed Gitea releases.
|
||||||
@@ -1,348 +0,0 @@
|
|||||||
# Daily Report Roadmap
|
|
||||||
|
|
||||||
## Purpose
|
|
||||||
|
|
||||||
This roadmap defines the target state and policy choices for replacing the
|
|
||||||
existing `daily` report with a new generated-text-template `daily` report.
|
|
||||||
|
|
||||||
The new report is not implemented yet. Current report behavior remains
|
|
||||||
documented outside `docs/roadmap/`.
|
|
||||||
|
|
||||||
## Intent
|
|
||||||
|
|
||||||
Daily should be an independent generated-text-template report for a user-chosen
|
|
||||||
local civil day. Its rendered Markdown should initially match the Tomorrow
|
|
||||||
Report format exactly, but its identity, prompt, template, schema, valid-period
|
|
||||||
resolver, config key, and planning module should be separate from Tomorrow from
|
|
||||||
the start.
|
|
||||||
|
|
||||||
The important distinction is date selection:
|
|
||||||
|
|
||||||
- `tomorrow` always targets the next local civil day.
|
|
||||||
- `daily` targets the local civil day explicitly supplied by the user with
|
|
||||||
`--date YYYY-MM-DD`.
|
|
||||||
|
|
||||||
This is a clean breaking replacement of the current Daily implementation:
|
|
||||||
|
|
||||||
- The existing direct-Markdown `daily` report is removed.
|
|
||||||
- The legacy `daily_today` report ID is removed from active report definitions.
|
|
||||||
- `weatherreporter generate daily` remains the public command name, but it now
|
|
||||||
runs the new generated-text-template Daily report.
|
|
||||||
- `weatherreporter generate daily` requires `--date YYYY-MM-DD`.
|
|
||||||
- Existing historical `daily_today` workspace artifacts do not need migration.
|
|
||||||
|
|
||||||
## Locked Decisions
|
|
||||||
|
|
||||||
- New report ID: `daily`.
|
|
||||||
- Public command: `generate daily`.
|
|
||||||
- `generate daily` must require `--date YYYY-MM-DD`.
|
|
||||||
- The provided date is interpreted as a civil date in the effective report
|
|
||||||
timezone.
|
|
||||||
- The valid period is the selected local civil day, `[00:00, next 00:00)`.
|
|
||||||
- Daily should not be an alias for Today or Tomorrow.
|
|
||||||
- Today remains the current-day scheduled morning product.
|
|
||||||
- Tomorrow remains the next-day scheduled evening product.
|
|
||||||
- Daily is manually targeted by date and is not added to morning or evening
|
|
||||||
batch membership in this roadmap.
|
|
||||||
- Daily must have its own template, generated-text schema, prompt asset,
|
|
||||||
render-context type, and planning module.
|
|
||||||
- Daily may share private helper functions with Tomorrow where mechanics are
|
|
||||||
identical, but it must not expose Tomorrow-specific public types or stanzas.
|
|
||||||
- The initial Daily output format should match Tomorrow's rendered Markdown
|
|
||||||
format.
|
|
||||||
|
|
||||||
## Target Report Shape
|
|
||||||
|
|
||||||
Daily should render the same Markdown structure as Tomorrow:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
# Monday's Weather
|
|
||||||
|
|
||||||
**Forecast date:** Monday, June 15, 2026
|
|
||||||
**Updated:** Sunday, June 14, 2026 at 9:14 AM
|
|
||||||
|
|
||||||
<GeneratedText summary>
|
|
||||||
|
|
||||||
## Daypart Forecast
|
|
||||||
|
|
||||||
- **Morning:** <deterministic daypart line>
|
|
||||||
- **Midday:** <deterministic daypart line>
|
|
||||||
- **Afternoon:** <deterministic daypart line>
|
|
||||||
- **Evening:** <deterministic daypart line>
|
|
||||||
|
|
||||||
## Precipitation Timing
|
|
||||||
|
|
||||||
- **1:00 PM** to **5:00 PM**: Precipitation is expected during this period.
|
|
||||||
The peak precipitation chance is 59% at 2:00 PM.
|
|
||||||
- <optional GeneratedText precipitation_timing>
|
|
||||||
|
|
||||||
## Forecast Discussion
|
|
||||||
|
|
||||||
<GeneratedText forecast_discussion paragraphs>
|
|
||||||
```
|
|
||||||
|
|
||||||
The precipitation section should render only when precipitation windows exist
|
|
||||||
for the selected valid period.
|
|
||||||
|
|
||||||
The title should follow Tomorrow's day-name style, for example:
|
|
||||||
|
|
||||||
- `Monday's Weather`
|
|
||||||
- `Tuesday's Weather`
|
|
||||||
- `Sunday's Weather`
|
|
||||||
|
|
||||||
## Report Identity
|
|
||||||
|
|
||||||
Replace the existing active Daily report with:
|
|
||||||
|
|
||||||
- report ID: `daily`
|
|
||||||
- public generate command: `daily`
|
|
||||||
- prompt ID: `weather.daily_generated_text`
|
|
||||||
- generation mode: `generated_text_template`
|
|
||||||
- template ID: `daily`
|
|
||||||
- generated-text schema ID: `daily`
|
|
||||||
- artifact group: `daily`
|
|
||||||
- batch output name: `daily.md`
|
|
||||||
- prior compatibility: Daily only
|
|
||||||
- comparison strategy: same valid local date
|
|
||||||
- valid period: selected local civil day in the effective report timezone,
|
|
||||||
`[00:00, next 00:00)`
|
|
||||||
|
|
||||||
Remove the legacy active report identity:
|
|
||||||
|
|
||||||
- remove active report ID `daily_today`
|
|
||||||
- remove prompt ID `weather.daily_report` from the current Daily path
|
|
||||||
- remove direct-Markdown generation mode from the Daily report definition
|
|
||||||
- remove `daily_today` config-key support unless a separate migration roadmap
|
|
||||||
explicitly reintroduces it
|
|
||||||
|
|
||||||
Historical artifacts with `daily_today` metadata may remain on disk. Do not
|
|
||||||
migrate or rewrite old workspace files in this feature.
|
|
||||||
|
|
||||||
## CLI Behavior
|
|
||||||
|
|
||||||
`weatherreporter generate daily` should require:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
weatherreporter generate daily --date YYYY-MM-DD
|
|
||||||
```
|
|
||||||
|
|
||||||
Rules:
|
|
||||||
|
|
||||||
- `--date` is required for `generate daily`.
|
|
||||||
- `--date` accepts only `YYYY-MM-DD`.
|
|
||||||
- The date is interpreted in the effective report timezone after config and
|
|
||||||
`--tz` overrides are applied.
|
|
||||||
- Omitting `--date` is an error.
|
|
||||||
- A malformed date is an error.
|
|
||||||
- The command should continue supporting the existing global generation flags:
|
|
||||||
`--config`, `--units`, `--tz`, and `--out`.
|
|
||||||
- Do not default `daily` to today or tomorrow.
|
|
||||||
|
|
||||||
## Batch Behavior
|
|
||||||
|
|
||||||
Daily should not be added to scheduled batches in this roadmap.
|
|
||||||
|
|
||||||
Current intended scheduled behavior:
|
|
||||||
|
|
||||||
- Morning batch: `today`, `three_day`, and conditional `weekend`.
|
|
||||||
- Evening batch: `tomorrow`.
|
|
||||||
|
|
||||||
Daily is a manually targeted report. A future roadmap may add scheduled Daily
|
|
||||||
behavior if a concrete operational need appears.
|
|
||||||
|
|
||||||
## GeneratedText Contract
|
|
||||||
|
|
||||||
Daily should use the same structured prose shape as Tomorrow:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"summary": "string",
|
|
||||||
"forecast_discussion": ["string"],
|
|
||||||
"precipitation_timing": "string",
|
|
||||||
"confidence": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Required:
|
|
||||||
|
|
||||||
- `summary`
|
|
||||||
- `forecast_discussion`
|
|
||||||
|
|
||||||
Optional:
|
|
||||||
|
|
||||||
- `precipitation_timing`
|
|
||||||
- `confidence`
|
|
||||||
|
|
||||||
Validation should match Tomorrow semantics:
|
|
||||||
|
|
||||||
- reject malformed JSON and unknown fields
|
|
||||||
- reject trailing JSON values
|
|
||||||
- trim `summary`, `precipitation_timing`, and `confidence`
|
|
||||||
- trim each `forecast_discussion` paragraph
|
|
||||||
- drop blank discussion paragraphs
|
|
||||||
- require at least one nonblank discussion paragraph
|
|
||||||
- return canonical normalized JSON with the same public field names
|
|
||||||
|
|
||||||
Add a dedicated prompt asset:
|
|
||||||
|
|
||||||
- `internal/reporttemplate/prompts/daily.generated_text.md`
|
|
||||||
|
|
||||||
Scriptorium registration remains out of band. Weatherreporter should invoke the
|
|
||||||
Daily prompt by prompt ID and pass the data package as it does for other
|
|
||||||
generated-text reports.
|
|
||||||
|
|
||||||
## Template Context
|
|
||||||
|
|
||||||
Add dedicated Daily types under `internal/generatedtext`, rather than reusing
|
|
||||||
Tomorrow types directly:
|
|
||||||
|
|
||||||
```go
|
|
||||||
type DailyRenderContext struct {
|
|
||||||
Report DailyReportContext
|
|
||||||
GeneratedText Daily
|
|
||||||
Modules DailyTemplateModules
|
|
||||||
Collected facts.CollectedFacts
|
|
||||||
Derived facts.DerivedFacts
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
`DailyReportContext` should include:
|
|
||||||
|
|
||||||
- `Title`, for example `Monday's Weather`
|
|
||||||
- `ForecastDate`
|
|
||||||
- `ForecastDateLabel`, for example `Monday, June 15, 2026`
|
|
||||||
- `ForecastDayName`, for example `Monday`
|
|
||||||
- `GeneratedAt`
|
|
||||||
- `GeneratedAtLabel`
|
|
||||||
- `ValidPeriod`
|
|
||||||
- `Timezone`
|
|
||||||
|
|
||||||
`DailyTemplateModules` should expose the same categories the Daily template
|
|
||||||
needs:
|
|
||||||
|
|
||||||
- `Metadata`
|
|
||||||
- `CurrentConditions`
|
|
||||||
- `HourlyForecast`
|
|
||||||
- `DerivedDailySummary`
|
|
||||||
- `DerivedDaypartSummaries`
|
|
||||||
- ordered daypart rows
|
|
||||||
- `PrecipTiming`
|
|
||||||
- `AlertDigest`
|
|
||||||
- `SPCConvectiveOutlooks`
|
|
||||||
- `AreaForecastDiscussion`
|
|
||||||
- `SPCConvectiveDiscussion`
|
|
||||||
- `WeatherStory`
|
|
||||||
- `OutdoorWindows`
|
|
||||||
- `DailyPlanning`
|
|
||||||
|
|
||||||
Daily may share private helper functions with Tomorrow render-context
|
|
||||||
construction when the helper represents identical mechanics. Do not expose
|
|
||||||
Tomorrow-specific types through the Daily template context.
|
|
||||||
|
|
||||||
## Module Composition
|
|
||||||
|
|
||||||
The default module composition should initially mirror Tomorrow where the same
|
|
||||||
facts are useful for a dated daily report, with a Daily-specific planning
|
|
||||||
module:
|
|
||||||
|
|
||||||
- `metadata`
|
|
||||||
- `current_conditions`
|
|
||||||
- `narrative_forecast`
|
|
||||||
- `derived_daily_summary`
|
|
||||||
- `derived_daypart_summaries`
|
|
||||||
- `precip_timing`
|
|
||||||
- `alert_digest`
|
|
||||||
- `spc_convective_outlooks`
|
|
||||||
- `area_forecast_discussion`
|
|
||||||
- `spc_convective_discussion`
|
|
||||||
- `weather_story`
|
|
||||||
- `outdoor_windows`
|
|
||||||
- `daily_planning`
|
|
||||||
- `hourly_forecast`
|
|
||||||
|
|
||||||
The module order should match the intended data-package order unless tests show
|
|
||||||
a stronger reason to mirror Tomorrow's exact current order.
|
|
||||||
|
|
||||||
## Daily Planning Module
|
|
||||||
|
|
||||||
Add a Daily-specific deterministic planning module:
|
|
||||||
|
|
||||||
- module ID: `daily_planning`
|
|
||||||
- stanza name: `daily_planning`
|
|
||||||
- options type: `DailyPlanningOptions`
|
|
||||||
- output type: `DailyPlanningModule`
|
|
||||||
- supported report: `daily`
|
|
||||||
|
|
||||||
The module should be initially equivalent to `TomorrowPlanning`, but independent
|
|
||||||
from it:
|
|
||||||
|
|
||||||
- do not reuse the public `TomorrowPlanningModule` type
|
|
||||||
- do not emit the `tomorrow_planning` stanza
|
|
||||||
- do not use `module.TomorrowPlanning` in the Daily default composition
|
|
||||||
|
|
||||||
Recommended initial fields should match Tomorrow planning:
|
|
||||||
|
|
||||||
- `morning_readiness`
|
|
||||||
- `commute_school_workday_concerns`
|
|
||||||
- `overnight_change_watch`
|
|
||||||
|
|
||||||
Private helper functions may be shared with Tomorrow planning when the
|
|
||||||
underlying logic is truly identical.
|
|
||||||
|
|
||||||
## Acceptance Criteria
|
|
||||||
|
|
||||||
The feature is complete when:
|
|
||||||
|
|
||||||
- `weatherreporter generate daily --date YYYY-MM-DD` runs the new Daily report.
|
|
||||||
- `weatherreporter generate daily` without `--date` fails with an actionable
|
|
||||||
error.
|
|
||||||
- `daily` report metadata, RunID content, artifact paths, data-package paths,
|
|
||||||
distributor template variables, generated-text assets, and rendered Markdown
|
|
||||||
all use report ID `daily`.
|
|
||||||
- The active report registry includes `daily` and does not include
|
|
||||||
`daily_today`.
|
|
||||||
- `reports.daily` is the implemented config override key for Daily.
|
|
||||||
- `reports.daily_today` is rejected rather than treated as an alias.
|
|
||||||
- Daily uses generated-text-template generation with prompt ID
|
|
||||||
`weather.daily_generated_text`.
|
|
||||||
- Daily uses dedicated schema, prompt, template, generated-text type,
|
|
||||||
render-context type, and planning-module surfaces.
|
|
||||||
- Daily rendered Markdown initially matches Tomorrow's report format.
|
|
||||||
- Daily data packages include `daily_planning`, not `tomorrow_planning`.
|
|
||||||
- Daily Recent Changes compare against prior Daily snapshots for the same valid
|
|
||||||
local date.
|
|
||||||
- Daily is not included in morning or evening scheduled batches.
|
|
||||||
- Existing Today and Tomorrow report semantics remain unchanged.
|
|
||||||
- Historical `daily_today` workspace artifacts are left untouched.
|
|
||||||
- Non-roadmap documentation is updated after implementation to describe only
|
|
||||||
implemented Daily behavior.
|
|
||||||
|
|
||||||
## Implementation Plan Reference
|
|
||||||
|
|
||||||
Use `docs/roadmap/implementation.md` for the staged implementation plan. This
|
|
||||||
feature roadmap intentionally does not define implementation stages, file-by-file
|
|
||||||
work packages, or validation commands so that implementing agents have a single
|
|
||||||
sequencing authority.
|
|
||||||
|
|
||||||
## Ambiguities Addressed
|
|
||||||
|
|
||||||
- Replacement scope: new `daily` replaces and removes old active
|
|
||||||
`daily_today`.
|
|
||||||
- Date behavior: `--date` is required; no default date is used.
|
|
||||||
- Output format: initial rendered Markdown matches Tomorrow.
|
|
||||||
- Internal separation: Daily has its own template, schema, prompt, generated
|
|
||||||
text type, render context, and planning module.
|
|
||||||
- Batch behavior: Daily is not scheduled; Today remains the morning current-day
|
|
||||||
scheduled product.
|
|
||||||
- Historical artifacts: old `daily_today` workspace files are not migrated.
|
|
||||||
|
|
||||||
## Open Decisions
|
|
||||||
|
|
||||||
No open decisions remain that block implementation.
|
|
||||||
|
|
||||||
Future decisions that should not be resolved in this roadmap:
|
|
||||||
|
|
||||||
- Whether Daily should eventually support recurring scheduled generation.
|
|
||||||
- Whether Daily should diverge from Tomorrow's template or planning logic.
|
|
||||||
- Whether old `daily_today` workspace artifacts should ever receive a migration
|
|
||||||
or inspection compatibility layer.
|
|
||||||
@@ -1,361 +0,0 @@
|
|||||||
# Data Package Export Roadmap
|
|
||||||
|
|
||||||
## Purpose
|
|
||||||
|
|
||||||
This roadmap defines the target state for cleaning up module fields exposed in
|
|
||||||
YAML data packages. The goal is to keep report templates composable while making
|
|
||||||
LLM prompt inputs concise, readable, and free of template-only helper fields.
|
|
||||||
|
|
||||||
This feature is implemented. Current data-package behavior is documented in
|
|
||||||
`docs/internal/prompt-input.md`; the rich module and template boundary is
|
|
||||||
documented in `docs/internal/module.md` and `docs/templates.md`.
|
|
||||||
|
|
||||||
## Problem
|
|
||||||
|
|
||||||
Module output structs currently serve two different consumers:
|
|
||||||
|
|
||||||
- deterministic report templates, which benefit from presentation helpers such
|
|
||||||
as lower-case text, display labels, trend phrases, and hour labels;
|
|
||||||
- Scriptorium data packages, which should expose the clearest useful weather
|
|
||||||
facts to the LLM with minimal redundancy.
|
|
||||||
|
|
||||||
Those consumers now need different surfaces. Examples include:
|
|
||||||
|
|
||||||
- `current_conditions` exposes both `condition_text` and
|
|
||||||
`condition_text_lower`, plus both abbreviated and long-form wind-direction
|
|
||||||
fields.
|
|
||||||
- `hourly_forecast.periods[]` exposes both `period_begins` and `hour_label`,
|
|
||||||
and both `text_description` and `text_description_lower`.
|
|
||||||
- `derived_daypart_summaries` exposes numerous temperature and condition phrase
|
|
||||||
fields that are useful for deterministic template wording but noisy in the
|
|
||||||
prompt data package.
|
|
||||||
|
|
||||||
The cleanup should not weaken template composability. Templates should still be
|
|
||||||
able to use rich module values and helper fields.
|
|
||||||
|
|
||||||
The cleanup applies to every report that consumes these modules, including the
|
|
||||||
generated-template `today`, `tomorrow`, and `daily` reports. The same
|
|
||||||
`derived_daypart_summaries` prompt export should serve all three reports while
|
|
||||||
their templates continue to use rich daypart helper fields.
|
|
||||||
|
|
||||||
## Intent
|
|
||||||
|
|
||||||
Data packages should be curated prompt inputs, not a raw dump of every field
|
|
||||||
available to Go templates.
|
|
||||||
|
|
||||||
The intended architecture is:
|
|
||||||
|
|
||||||
- module builders produce rich internal/template module values;
|
|
||||||
- each module may define a prompt-facing export value for data-package use;
|
|
||||||
- prompt input construction serializes the prompt-facing export value;
|
|
||||||
- template rendering continues to use the full rich module value.
|
|
||||||
|
|
||||||
The result should let `weatherreporter` optimize separately for:
|
|
||||||
|
|
||||||
- precise deterministic Markdown rendering;
|
|
||||||
- compact, readable LLM input;
|
|
||||||
- stable internal module contracts.
|
|
||||||
|
|
||||||
## Locked Decisions
|
|
||||||
|
|
||||||
- Do not make the existing module structs smaller solely to clean up data
|
|
||||||
packages.
|
|
||||||
- Do not use per-module string field allowlists as the primary mechanism.
|
|
||||||
- Do not rely on reflection-heavy field filtering for nested module shapes.
|
|
||||||
- Do not use `json:"-"` or `yaml:"-"` on rich template fields as the main
|
|
||||||
boundary.
|
|
||||||
- Keep rich module outputs available for template rendering, inspection, tests,
|
|
||||||
and internal use.
|
|
||||||
- Add an explicit prompt/data-package export layer for module outputs.
|
|
||||||
- Simple modules may use default pass-through export behavior.
|
|
||||||
- No compatibility aliases are needed for removed prompt-facing fields because
|
|
||||||
the prompt schema is still pre-release.
|
|
||||||
- Bump the data-package schema version when implementing this change.
|
|
||||||
- Compute prompt export values during module snapshot construction and store the
|
|
||||||
runtime-only prompt value on `module.Output` alongside the rich `Value`.
|
|
||||||
- Do not persist prompt export values in module snapshot JSON; module snapshots
|
|
||||||
should continue to preserve rich module values.
|
|
||||||
|
|
||||||
## Target Architecture
|
|
||||||
|
|
||||||
Each module definition should be able to declare how its output is represented
|
|
||||||
in prompt data packages.
|
|
||||||
|
|
||||||
A possible shape is:
|
|
||||||
|
|
||||||
```go
|
|
||||||
type ModuleDefinition struct {
|
|
||||||
// existing fields...
|
|
||||||
PromptExporter ModulePromptExporter
|
|
||||||
}
|
|
||||||
|
|
||||||
type ModulePromptExporter func(value any) (any, error)
|
|
||||||
```
|
|
||||||
|
|
||||||
The exact API may differ if implementation discovers a cleaner fit, but the
|
|
||||||
contract should preserve these properties:
|
|
||||||
|
|
||||||
- the exporter is owned near the module definition or module builder;
|
|
||||||
- the exporter receives the rich module value and returns a prompt-facing value;
|
|
||||||
- missing exporters default to pass-through for modules whose rich value is
|
|
||||||
already prompt-appropriate;
|
|
||||||
- exporter errors include module ID and stanza context;
|
|
||||||
- promptinput uses exported prompt values instead of rich values;
|
|
||||||
- render contexts and templates continue using rich values.
|
|
||||||
|
|
||||||
The preferred implementation should avoid making `internal/promptinput` import
|
|
||||||
`internal/briefing` directly. If prompt export needs registry knowledge, either:
|
|
||||||
|
|
||||||
- record the prompt-facing value in `module.Output` when the module snapshot is
|
|
||||||
built; or
|
|
||||||
- pass an explicit export map/registry into prompt-input construction without
|
|
||||||
creating a package cycle.
|
|
||||||
|
|
||||||
The implementation should keep package boundaries consistent with existing
|
|
||||||
architecture: module output policy belongs with module definitions, and data
|
|
||||||
package serialization belongs in `internal/promptinput`.
|
|
||||||
|
|
||||||
## Prompt Export Contract
|
|
||||||
|
|
||||||
A module prompt export should be:
|
|
||||||
|
|
||||||
- **curated:** include fields useful to the LLM, omit fields used only for
|
|
||||||
deterministic sentence construction;
|
|
||||||
- **typed:** use small prompt-facing structs for modules that need reshaping;
|
|
||||||
- **stable:** keep field names intentional and avoid duplicating equivalent
|
|
||||||
facts under multiple names;
|
|
||||||
- **readable:** prefer fields that explain themselves in YAML;
|
|
||||||
- **loss-aware:** do not omit facts that the LLM needs to reason about timing,
|
|
||||||
severity, uncertainty, or practical impact;
|
|
||||||
- **module-owned:** keep each module responsible for its own prompt-facing
|
|
||||||
contract.
|
|
||||||
|
|
||||||
Prompt-facing structs may live next to the module that owns them, for example:
|
|
||||||
|
|
||||||
```go
|
|
||||||
type CurrentConditionsPromptExport struct {
|
|
||||||
ConditionText string `json:"condition_text,omitempty"`
|
|
||||||
TemperatureF *int `json:"temperature_f,omitempty"`
|
|
||||||
ApparentTemperatureF *int `json:"apparent_temperature_f,omitempty"`
|
|
||||||
RelativeHumidityPercent *int `json:"relative_humidity_percent,omitempty"`
|
|
||||||
WindSpeedMph *int `json:"wind_speed_mph,omitempty"`
|
|
||||||
WindDirection string `json:"wind_direction,omitempty"`
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The names do not need to include `PromptExport` if implementation finds a
|
|
||||||
clearer convention, but they should distinguish data-package shape from
|
|
||||||
template-rendering shape.
|
|
||||||
|
|
||||||
## Initial Cleanup Targets
|
|
||||||
|
|
||||||
### Current Conditions
|
|
||||||
|
|
||||||
Keep prompt-facing fields that express current observed conditions directly:
|
|
||||||
|
|
||||||
- `condition_text`
|
|
||||||
- `is_day`
|
|
||||||
- temperature fields
|
|
||||||
- apparent temperature fields
|
|
||||||
- dewpoint fields
|
|
||||||
- relative humidity
|
|
||||||
- wind speed
|
|
||||||
- one wind direction field
|
|
||||||
|
|
||||||
Remove prompt-facing fields that are template-only duplicates:
|
|
||||||
|
|
||||||
- `condition_text_lower`
|
|
||||||
- duplicate wind-direction text when an equivalent `wind_direction` field is
|
|
||||||
present
|
|
||||||
|
|
||||||
The template surface may keep those helper fields.
|
|
||||||
|
|
||||||
### Hourly Forecast
|
|
||||||
|
|
||||||
Keep prompt-facing period fields that carry facts:
|
|
||||||
|
|
||||||
- `period_begins`
|
|
||||||
- `period_ends`
|
|
||||||
- `name`
|
|
||||||
- `is_day`
|
|
||||||
- condition code, if useful
|
|
||||||
- `text_description`
|
|
||||||
- temperature fields
|
|
||||||
- dewpoint, apparent temperature, humidity, wind, gust, pressure, visibility,
|
|
||||||
cloud cover, precipitation probability, precipitation amount, snowfall depth,
|
|
||||||
and UV index when provided by upstream data
|
|
||||||
|
|
||||||
Remove prompt-facing fields that duplicate or encode template logic:
|
|
||||||
|
|
||||||
- `hour_label`, because `period_begins` already gives the time in a friendly
|
|
||||||
local label;
|
|
||||||
- `text_description_lower`, because the LLM can interpret
|
|
||||||
`text_description`;
|
|
||||||
- `mention_precipitation`, because it is a template threshold helper when the
|
|
||||||
underlying precipitation probability is present.
|
|
||||||
|
|
||||||
The template surface may keep these helper fields.
|
|
||||||
|
|
||||||
### Derived Daypart Summaries
|
|
||||||
|
|
||||||
Keep prompt-facing fields that describe the daypart:
|
|
||||||
|
|
||||||
- `date`
|
|
||||||
- `display_name`
|
|
||||||
- `period_begins`
|
|
||||||
- `period_ends`
|
|
||||||
- temperature range or the best single temperature phrase
|
|
||||||
- apparent temperature range when useful
|
|
||||||
- maximum precipitation probability and time
|
|
||||||
- maximum wind gust and time
|
|
||||||
- dominant condition
|
|
||||||
- temperature trend
|
|
||||||
- notable conditions
|
|
||||||
- weather indicator booleans
|
|
||||||
- relevant alert count
|
|
||||||
|
|
||||||
Remove prompt-facing fields that mainly support deterministic sentence
|
|
||||||
construction:
|
|
||||||
|
|
||||||
- duplicate lower-case/display variants of the same dominant condition;
|
|
||||||
- multiple temperature phrase fragments when a smaller set can express the same
|
|
||||||
trend;
|
|
||||||
- duplicate time labels where one friendly time field is enough.
|
|
||||||
|
|
||||||
The exact retained daypart temperature fields should be chosen during
|
|
||||||
implementation with template needs and LLM readability in mind. The prompt
|
|
||||||
export should preserve the facts needed to understand whether temperatures are
|
|
||||||
rising, falling, peaking, or steady, but it does not need every phrase fragment
|
|
||||||
used by the Markdown template.
|
|
||||||
|
|
||||||
### Other Modules
|
|
||||||
|
|
||||||
Most existing modules may initially use pass-through export unless they expose
|
|
||||||
clear template-only helpers. During implementation, review at least:
|
|
||||||
|
|
||||||
- `narrative_forecast`
|
|
||||||
- `precip_timing`
|
|
||||||
- `outdoor_windows`
|
|
||||||
- `alert_digest`
|
|
||||||
- `spc_convective_outlooks`
|
|
||||||
- `spc_convective_discussion`
|
|
||||||
- `area_forecast_discussion`
|
|
||||||
- `weather_story`
|
|
||||||
- planning modules
|
|
||||||
|
|
||||||
Do not remove fields merely because they are verbose. Remove or reshape fields
|
|
||||||
when they are redundant, template-specific, or confusing in the context of LLM
|
|
||||||
input.
|
|
||||||
|
|
||||||
## Data Package Behavior
|
|
||||||
|
|
||||||
After implementation:
|
|
||||||
|
|
||||||
- saved YAML data packages should use prompt-facing module exports;
|
|
||||||
- saved module snapshots should continue preserving rich module output values;
|
|
||||||
- generated-text render contexts should continue preserving rich module values;
|
|
||||||
- Recent Changes should continue using structured module snapshots unless a
|
|
||||||
specific comparison should intentionally move to prompt-facing fields;
|
|
||||||
- inspection commands should make clear whether they are showing rich module
|
|
||||||
snapshots or prompt data packages.
|
|
||||||
- generated-template reports, including `today`, `tomorrow`, and `daily`, should
|
|
||||||
continue rendering from rich module values.
|
|
||||||
|
|
||||||
This roadmap does not require changing source warnings, report metadata,
|
|
||||||
collected facts, derived facts, or generated report artifacts.
|
|
||||||
|
|
||||||
## Schema And Versioning
|
|
||||||
|
|
||||||
This is a prompt-input schema cleanup. Because the project is pre-release, the
|
|
||||||
implementation may make a clean break in data-package field names without
|
|
||||||
compatibility aliases.
|
|
||||||
|
|
||||||
The data-package schema version should be bumped when this feature is
|
|
||||||
implemented because persisted data-package fields will be removed or renamed.
|
|
||||||
This makes artifact shape changes explicit and helps inspection tooling
|
|
||||||
distinguish old and new data packages.
|
|
||||||
|
|
||||||
## Documentation Guidance
|
|
||||||
|
|
||||||
After implementation, update implemented documentation only:
|
|
||||||
|
|
||||||
- `docs/internal/module.md`: describe the distinction between rich module output
|
|
||||||
and prompt-facing export values.
|
|
||||||
- `docs/internal/prompt-input.md`: document that data packages use curated
|
|
||||||
prompt exports, not full template module structs.
|
|
||||||
- `docs/templates.md`: clarify that templates may have richer fields than the
|
|
||||||
data package.
|
|
||||||
- Any module field examples in implemented docs should match the new
|
|
||||||
prompt-facing data package shape.
|
|
||||||
|
|
||||||
Do not document future module fields or unimplemented exporters outside
|
|
||||||
`docs/roadmap/`.
|
|
||||||
|
|
||||||
## Acceptance Criteria
|
|
||||||
|
|
||||||
The feature is complete when:
|
|
||||||
|
|
||||||
- prompt data packages serialize curated module exports instead of blindly
|
|
||||||
serializing rich module values;
|
|
||||||
- templates still render from rich module values without losing helper fields;
|
|
||||||
- `current_conditions` no longer exposes lower-case condition text or duplicate
|
|
||||||
wind-direction fields in data packages;
|
|
||||||
- `hourly_forecast.periods[]` no longer exposes `hour_label`,
|
|
||||||
`text_description_lower`, or `mention_precipitation` in data packages;
|
|
||||||
- `derived_daypart_summaries` no longer exposes redundant condition and
|
|
||||||
temperature phrase variants in data packages;
|
|
||||||
- `today`, `tomorrow`, and `daily` rendered reports continue to have access to
|
|
||||||
rich daypart helper fields for deterministic template wording;
|
|
||||||
- simple modules that do not need cleanup still export correctly through default
|
|
||||||
pass-through behavior;
|
|
||||||
- exporter errors include module/stanza context;
|
|
||||||
- YAML category ordering remains unchanged;
|
|
||||||
- module snapshot artifacts remain rich enough for templates, inspection, and
|
|
||||||
regression diagnosis;
|
|
||||||
- tests prove that removed prompt-facing fields are absent from saved YAML data
|
|
||||||
packages and still available to templates where needed.
|
|
||||||
|
|
||||||
## Testing Expectations
|
|
||||||
|
|
||||||
Implementation should add or update focused tests for:
|
|
||||||
|
|
||||||
- module registry validation for prompt exporters, if exporters are registered
|
|
||||||
there;
|
|
||||||
- promptinput construction using exported prompt values;
|
|
||||||
- pass-through behavior for simple modules;
|
|
||||||
- custom exports for current conditions, hourly forecast, and daypart summaries;
|
|
||||||
- data-package YAML output rejecting stale fields;
|
|
||||||
- template render tests proving template-only helper fields remain available for
|
|
||||||
`today`, `tomorrow`, and `daily`;
|
|
||||||
- app workflow tests proving saved data packages use curated exports while
|
|
||||||
render contexts keep rich values.
|
|
||||||
|
|
||||||
Suggested validation after implementation:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
go test ./internal/module ./internal/briefing ./internal/promptinput
|
|
||||||
go test ./internal/generatedtext ./internal/reporttemplate ./internal/app
|
|
||||||
go test ./...
|
|
||||||
go run ./cmd/weatherreporter --help
|
|
||||||
git diff --check
|
|
||||||
```
|
|
||||||
|
|
||||||
## Deferred Work
|
|
||||||
|
|
||||||
Do not include these in the initial cleanup unless implementation reveals they
|
|
||||||
are necessary:
|
|
||||||
|
|
||||||
- user-configurable data-package field selection;
|
|
||||||
- per-prompt custom field profiles;
|
|
||||||
- reflection-based generic include/exclude lists;
|
|
||||||
- automatic schema generation for data-package exports;
|
|
||||||
- changing collected facts or derived facts contracts;
|
|
||||||
- changing Scriptorium invocation behavior;
|
|
||||||
- changing generated Markdown templates beyond preserving their current output.
|
|
||||||
|
|
||||||
## Open Questions
|
|
||||||
|
|
||||||
No open questions block implementation.
|
|
||||||
|
|
||||||
The implementation plan in `docs/roadmap/implementation.md` is the sequencing
|
|
||||||
authority for this feature.
|
|
||||||
@@ -1,25 +1,57 @@
|
|||||||
# Future Roadmap
|
# Future Roadmap
|
||||||
|
|
||||||
This roadmap contains project work that is not implemented. Current behavior is
|
This roadmap contains future work only. Each section identifies its planning
|
||||||
documented outside `docs/roadmap/`.
|
status; current behavior is documented outside `docs/roadmap/`.
|
||||||
|
|
||||||
|
## Upstream Forecast Change Product
|
||||||
|
|
||||||
|
Status: Proposed upstream feature request; unimplemented.
|
||||||
|
|
||||||
|
Weatherreporter's local Recent Changes feature was removed by the accepted
|
||||||
|
[stateless execution decision](../adr/0001-stateless-execution.md). Forecast
|
||||||
|
version history and comparison are better owned by the Weather API, where the
|
||||||
|
underlying forecast issuances can be retained and compared consistently for
|
||||||
|
all consumers.
|
||||||
|
|
||||||
|
A future Weather API feature should expose a structured change product with:
|
||||||
|
|
||||||
|
- explicit current and baseline forecast issuance timestamps or identifiers;
|
||||||
|
- documented baseline selection, such as a requested comparison timestamp,
|
||||||
|
preceding issuance, or fixed rolling period;
|
||||||
|
- location, timezone, and half-open valid-period identity;
|
||||||
|
- typed changed values with previous and current values and units;
|
||||||
|
- stable change categories for temperature, precipitation probability and
|
||||||
|
timing, wind gusts, alerts, and aggregate hazards;
|
||||||
|
- an API-owned significance classification or enough structured information
|
||||||
|
for a stateless consumer to apply a documented presentation threshold; and
|
||||||
|
- deterministic ordering, missing-baseline behavior, and source metadata.
|
||||||
|
|
||||||
|
The API should compare forecast versions, not track a Weatherreporter client's
|
||||||
|
"previous run." It should not require consumer identity, mutable cursors, or
|
||||||
|
Weatherreporter-managed history. A missing baseline should be a normal empty
|
||||||
|
result rather than an error.
|
||||||
|
|
||||||
|
Once a stable upstream contract exists, a separate Weatherreporter roadmap may
|
||||||
|
reintroduce change commentary by collecting that product and mapping it into a
|
||||||
|
curated prompt-facing module. There must be no local snapshot fallback. The
|
||||||
|
ordinary Weatherreporter process must remain stateless, and the upstream
|
||||||
|
feature should have deterministic fixtures before adoption.
|
||||||
|
|
||||||
## Automatic Storm Monitoring
|
## Automatic Storm Monitoring
|
||||||
|
|
||||||
Manual Storm Report generation is available through:
|
Status: Proposed and unimplemented.
|
||||||
|
|
||||||
```sh
|
Storm reporting, whether manual or automatic, is unimplemented.
|
||||||
weatherreporter generate storm --start TIME --end TIME
|
|
||||||
```
|
|
||||||
|
|
||||||
Automatic storm-event evaluation is not implemented.
|
|
||||||
|
|
||||||
Possible direction:
|
Possible direction:
|
||||||
|
|
||||||
1. Detect candidate storm events from alerts, forecast discussion, weather
|
1. Detect candidate storm events from alerts, forecast discussion, weather
|
||||||
story context, hourly thresholds, and material forecast changes.
|
story context, hourly thresholds, and material forecast changes.
|
||||||
2. Evaluate candidates through Scriptorium or another narrow evaluator adapter.
|
2. Evaluate candidates through Promptkit or another narrow evaluator adapter.
|
||||||
3. Persist storm lifecycle state.
|
3. Keep any required storm lifecycle state in the upstream service or another
|
||||||
4. Generate or update Storm Reports only when a meaningful event is present.
|
explicitly designed external owner rather than silently reintroducing a
|
||||||
|
Weatherreporter workspace.
|
||||||
|
4. Generate or update a storm report only when a meaningful event is present.
|
||||||
5. Suppress ordinary low-impact thunder or rain chances.
|
5. Suppress ordinary low-impact thunder or rain chances.
|
||||||
|
|
||||||
Possible lifecycle states:
|
Possible lifecycle states:
|
||||||
@@ -32,11 +64,13 @@ Possible lifecycle states:
|
|||||||
- `resolved`
|
- `resolved`
|
||||||
|
|
||||||
Before implementation, the design must preserve scheduled report behavior,
|
Before implementation, the design must preserve scheduled report behavior,
|
||||||
manual Storm Report generation, inspectable evaluator failures, and fixture
|
inspectable evaluator failures, and fixture coverage for deterministic
|
||||||
coverage for deterministic candidate detection.
|
candidate detection.
|
||||||
|
|
||||||
## Future Report Types
|
## Future Report Types
|
||||||
|
|
||||||
|
Status: Proposed and unimplemented.
|
||||||
|
|
||||||
Possible future report types:
|
Possible future report types:
|
||||||
|
|
||||||
- a short-fuse planning report distinct from the implemented Hourly Report, if
|
- a short-fuse planning report distinct from the implemented Hourly Report, if
|
||||||
@@ -46,20 +80,20 @@ Possible future report types:
|
|||||||
- archive-focused report variants if generated report history becomes a
|
- archive-focused report variants if generated report history becomes a
|
||||||
first-class product
|
first-class product
|
||||||
|
|
||||||
New reports should keep report identity, prompt IDs, templates, valid-period
|
New reports should preserve the boundaries documented in the [report registry
|
||||||
resolution, artifact grouping, batch output names, and comparison policy inside
|
internals](../internal/report-registry.md).
|
||||||
`internal/report`.
|
|
||||||
|
|
||||||
## Future Modules
|
## Future Modules
|
||||||
|
|
||||||
|
Status: Proposed and unimplemented.
|
||||||
|
|
||||||
Possible future modules:
|
Possible future modules:
|
||||||
|
|
||||||
- `hourly_table` for compact valid-period hourly facts
|
- `hourly_table` for compact valid-period hourly facts
|
||||||
- `forecast_delta` if a separate stanza is useful beyond current Recent
|
- `forecast_delta` after an upstream forecast-change product exists
|
||||||
Changes
|
|
||||||
- `weekend_planning` if weekend-specific planning guidance needs a dedicated
|
- `weekend_planning` if weekend-specific planning guidance needs a dedicated
|
||||||
deterministic stanza
|
deterministic stanza
|
||||||
- `storm_window_summary` if manual or automatic Storm Reports need a dedicated
|
- `storm_window_summary` if manual or automatic storm reports need a dedicated
|
||||||
prompt-facing storm-window module
|
prompt-facing storm-window module
|
||||||
- separate AFD section aliases, such as `afd_key_messages`,
|
- separate AFD section aliases, such as `afd_key_messages`,
|
||||||
`afd_short_term_text`, and `afd_long_term_text`, if separate stanzas prove
|
`afd_short_term_text`, and `afd_long_term_text`, if separate stanzas prove
|
||||||
@@ -71,26 +105,30 @@ QPF fields such as `measurable_qpf_total_in` and `max_hourly_qpf_in` should
|
|||||||
remain omitted until a real upstream quantitative precipitation source is
|
remain omitted until a real upstream quantitative precipitation source is
|
||||||
represented in `CollectedFacts`.
|
represented in `CollectedFacts`.
|
||||||
|
|
||||||
Future module work should preserve these boundaries:
|
Future module work should preserve the boundaries documented in [fact
|
||||||
|
contracts](../internal/facts.md), [module internals](../internal/module.md), and
|
||||||
|
[briefing internals](../internal/briefing.md):
|
||||||
|
|
||||||
- collect upstream facts once per report run
|
- keep upstream collection in app orchestration
|
||||||
- keep upstream fetching out of modules
|
- keep upstream collection out of modules
|
||||||
- keep broad reusable calculations in `DerivedFacts`
|
- keep broad reusable calculations in `DerivedFacts`
|
||||||
- keep prompt-facing field shape inside module builders
|
- keep prompt-facing field shape inside module builders
|
||||||
- use typed options for configurable module behavior
|
- use typed options for configurable module behavior
|
||||||
- keep module snapshots structured and deterministic for Recent Changes
|
- keep module output structured and deterministic
|
||||||
|
|
||||||
## Distributor Notification Enhancements
|
## Distributor Notification Enhancements
|
||||||
|
|
||||||
Distributor notification uploads one managed Markdown report per successful
|
Status: Proposed and unimplemented.
|
||||||
generated report through the configured HTTP upload pipeline. The following
|
|
||||||
enhancements are not implemented:
|
Single-report and batch Distributor notification are implemented. Current
|
||||||
|
behavior is documented in the [Distributor adapter guide](../internal/distributor-adapter.md),
|
||||||
|
[Distributor integration guides](../integrations/distributor/), and
|
||||||
|
[operations guide](../operations.md). The following enhancements remain
|
||||||
|
unimplemented:
|
||||||
|
|
||||||
- `failure_policy: warn`
|
- `failure_policy: warn`
|
||||||
- uploading metadata, module snapshots, data packages, or preflight artifacts
|
|
||||||
- durable upload retry queues
|
- durable upload retry queues
|
||||||
- distributor-specific CLI flags
|
- distributor-specific CLI flags
|
||||||
- distributor workspace scanning
|
|
||||||
- destination routing, Markdown-to-HTML transformation, public URLs, or nginx
|
- destination routing, Markdown-to-HTML transformation, public URLs, or nginx
|
||||||
layout inside weatherreporter
|
layout inside weatherreporter
|
||||||
|
|
||||||
@@ -100,7 +138,9 @@ while distributor owns destination routing and publication behavior.
|
|||||||
|
|
||||||
## Alternate Runtime Integrations
|
## Alternate Runtime Integrations
|
||||||
|
|
||||||
These ideas are not implemented:
|
Status: Proposed and unimplemented.
|
||||||
|
|
||||||
|
These ideas remain unimplemented:
|
||||||
|
|
||||||
- native LLM client inside `weatherreporter`
|
- native LLM client inside `weatherreporter`
|
||||||
- database-backed state
|
- database-backed state
|
||||||
@@ -119,6 +159,8 @@ must not describe these as available behavior.
|
|||||||
|
|
||||||
## Deferred Refactors
|
## Deferred Refactors
|
||||||
|
|
||||||
|
Status: Deferred.
|
||||||
|
|
||||||
These refactors should remain deferred until new requirements or recurring
|
These refactors should remain deferred until new requirements or recurring
|
||||||
maintenance costs make the added abstraction worthwhile:
|
maintenance costs make the added abstraction worthwhile:
|
||||||
|
|
||||||
@@ -129,6 +171,7 @@ maintenance costs make the added abstraction worthwhile:
|
|||||||
- global test helper package
|
- global test helper package
|
||||||
- logging subsystem
|
- logging subsystem
|
||||||
|
|
||||||
Any future implementation should preserve the existing public CLI, artifact
|
Any future implementation should preserve the public CLI, report-output
|
||||||
paths, report identities, module boundaries, and adapter boundaries unless a
|
contract, report identities, module boundaries, and adapter boundaries in
|
||||||
separate roadmap explicitly changes them.
|
effect when that work begins unless a separate roadmap explicitly changes
|
||||||
|
them.
|
||||||
|
|||||||
@@ -1,657 +0,0 @@
|
|||||||
# Data Package Export Implementation Roadmap
|
|
||||||
|
|
||||||
## Purpose
|
|
||||||
|
|
||||||
This roadmap defines the staged implementation plan for
|
|
||||||
`docs/roadmap/data-package-exports.md`. It is written for an LLM coding agent
|
|
||||||
that will implement the curated data-package export feature in order.
|
|
||||||
|
|
||||||
The goal is to separate rich module values used by templates from curated
|
|
||||||
prompt-facing values serialized into Scriptorium data packages. The change
|
|
||||||
should make YAML data packages smaller and clearer without reducing deterministic
|
|
||||||
template composability.
|
|
||||||
|
|
||||||
This is a planning document only. It may describe unimplemented behavior because
|
|
||||||
it lives under `docs/roadmap/`.
|
|
||||||
|
|
||||||
## Source Roadmap
|
|
||||||
|
|
||||||
Use `docs/roadmap/data-package-exports.md` as the feature roadmap and target
|
|
||||||
state authority. That document defines the user intent, module/export boundary,
|
|
||||||
initial cleanup targets, and non-goals.
|
|
||||||
|
|
||||||
If this implementation plan and the feature roadmap conflict, update the feature
|
|
||||||
roadmap first so it remains the conceptual source of truth, then update this
|
|
||||||
file.
|
|
||||||
|
|
||||||
## Locked Decisions
|
|
||||||
|
|
||||||
- Keep rich module values available for templates, module snapshots, inspection,
|
|
||||||
Recent Changes, and render contexts.
|
|
||||||
- Serialize curated prompt-facing module values into data packages.
|
|
||||||
- Store prompt-facing values on `module.Output` as runtime-only values.
|
|
||||||
- Do not persist prompt-facing values in module snapshot JSON.
|
|
||||||
- Keep `internal/promptinput` independent from `internal/briefing`.
|
|
||||||
- Add prompt export behavior to the module registry/definition path where module
|
|
||||||
output policy already lives.
|
|
||||||
- Default modules without custom exporters to pass-through prompt values.
|
|
||||||
- Bump the data-package schema version from `weatherreporter.data_package.v2` to
|
|
||||||
`weatherreporter.data_package.v3`.
|
|
||||||
- No compatibility aliases are required for removed prompt-facing fields.
|
|
||||||
- Do not add user-configurable field selection, field allowlists, reflection
|
|
||||||
filters, or prompt-specific field profiles in this implementation.
|
|
||||||
|
|
||||||
## Implementation Principles
|
|
||||||
|
|
||||||
- Preserve existing generated Markdown output.
|
|
||||||
- Preserve existing template render-context richness.
|
|
||||||
- Preserve existing module snapshot richness and JSON shape except for any
|
|
||||||
unavoidable schema-version-only change. The preferred approach is to omit
|
|
||||||
prompt values from module snapshot JSON entirely.
|
|
||||||
- Keep exporter code near the module that owns the shape.
|
|
||||||
- Use typed prompt-facing structs for modules that need reshaping.
|
|
||||||
- Keep simple modules on default pass-through behavior.
|
|
||||||
- Make exporter errors actionable and include module ID/stanza context.
|
|
||||||
- Keep YAML category ordering unchanged.
|
|
||||||
- Treat generated-template `today`, `tomorrow`, and `daily` reports as equal
|
|
||||||
consumers of rich template module values.
|
|
||||||
- Update implemented docs only after code behavior exists.
|
|
||||||
|
|
||||||
## Stage 1: Runtime Prompt Value Contract
|
|
||||||
|
|
||||||
### Goal
|
|
||||||
|
|
||||||
Add a runtime-only prompt value to module outputs while preserving rich module
|
|
||||||
snapshot persistence.
|
|
||||||
|
|
||||||
### Files To Inspect
|
|
||||||
|
|
||||||
- `internal/module/module.go`
|
|
||||||
- `internal/module/module_test.go`
|
|
||||||
- `internal/state/filesystem.go`
|
|
||||||
- `internal/state/filesystem_test.go`
|
|
||||||
- `internal/app/app.go`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
|
|
||||||
### Implementation
|
|
||||||
|
|
||||||
- Add a runtime-only field to `module.Output`, for example:
|
|
||||||
|
|
||||||
```go
|
|
||||||
type Output struct {
|
|
||||||
ID ID `json:"id"`
|
|
||||||
StanzaName string `json:"stanzaName"`
|
|
||||||
Value any `json:"value"`
|
|
||||||
PromptValue any `json:"-"`
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- Add a small helper in `internal/module`, for example:
|
|
||||||
|
|
||||||
```go
|
|
||||||
func (o Output) DataPackageValue() any
|
|
||||||
```
|
|
||||||
|
|
||||||
The helper should return `PromptValue` when non-nil and fall back to `Value`
|
|
||||||
otherwise. This fallback keeps tests and any manually built snapshots simple.
|
|
||||||
|
|
||||||
- Do not require `PromptValue` in `Snapshot.Validate`.
|
|
||||||
- Do not persist `PromptValue` to module snapshot JSON.
|
|
||||||
- Do not change `StanzaValue`; it should continue decoding rich `Value`.
|
|
||||||
|
|
||||||
### Acceptance Criteria
|
|
||||||
|
|
||||||
- Module snapshots still serialize rich module values under `value`.
|
|
||||||
- Module snapshots do not serialize `promptValue` or any equivalent field.
|
|
||||||
- Existing rich-module snapshot lookup and `StanzaValue` behavior remain
|
|
||||||
unchanged.
|
|
||||||
- Code has a single helper for choosing the data-package value from an output.
|
|
||||||
|
|
||||||
### Tests
|
|
||||||
|
|
||||||
- Add module tests proving:
|
|
||||||
- `DataPackageValue` uses `PromptValue` when set;
|
|
||||||
- `DataPackageValue` falls back to `Value`;
|
|
||||||
- marshaled snapshot JSON omits `PromptValue`;
|
|
||||||
- `StanzaValue` continues decoding rich `Value`.
|
|
||||||
|
|
||||||
Suggested focused command:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
go test ./internal/module ./internal/state
|
|
||||||
```
|
|
||||||
|
|
||||||
### Prompt Size
|
|
||||||
|
|
||||||
Small enough for one implementation prompt.
|
|
||||||
|
|
||||||
## Stage 2: Module Registry Prompt Exporters
|
|
||||||
|
|
||||||
### Goal
|
|
||||||
|
|
||||||
Teach the module registry to attach prompt-facing values to outputs as modules
|
|
||||||
are built.
|
|
||||||
|
|
||||||
### Files To Inspect
|
|
||||||
|
|
||||||
- `internal/briefing/modules.go`
|
|
||||||
- `internal/briefing/modules_test.go`
|
|
||||||
- `internal/briefing/*_module.go`
|
|
||||||
- `internal/module/module.go`
|
|
||||||
|
|
||||||
### Implementation
|
|
||||||
|
|
||||||
- Add a prompt exporter type in `internal/briefing`, for example:
|
|
||||||
|
|
||||||
```go
|
|
||||||
type ModulePromptExporter func(value any) (any, error)
|
|
||||||
```
|
|
||||||
|
|
||||||
- Add `PromptExporter ModulePromptExporter` to `ModuleDefinition`.
|
|
||||||
- In `ModuleRegistry.BuildModule`, after builder output ID and stanza validation:
|
|
||||||
- if `PromptExporter` is nil, set `output.PromptValue = output.Value`;
|
|
||||||
- if `PromptExporter` is present, call it with `output.Value`;
|
|
||||||
- set `output.PromptValue` to the returned value;
|
|
||||||
- wrap exporter errors with module ID and stanza context.
|
|
||||||
- Add a typed exporter helper if it keeps module exporters concise, for example:
|
|
||||||
|
|
||||||
```go
|
|
||||||
func promptExporter[T any](fn func(T) (any, error)) ModulePromptExporter
|
|
||||||
```
|
|
||||||
|
|
||||||
The helper should convert `any` through JSON marshal/unmarshal or direct type
|
|
||||||
assertion only if it meaningfully reduces boilerplate without hiding errors.
|
|
||||||
|
|
||||||
- Do not make `internal/promptinput` import `internal/briefing`.
|
|
||||||
- Do not move module-specific export policy into `internal/promptinput`.
|
|
||||||
|
|
||||||
### Acceptance Criteria
|
|
||||||
|
|
||||||
- Every built module output has a non-nil data-package value.
|
|
||||||
- Modules without custom exporters pass through rich values.
|
|
||||||
- Custom exporter errors identify the module and stanza.
|
|
||||||
- Registry validation remains focused on definitions, duplicate IDs/stanzas,
|
|
||||||
supported reports, options, builders, and missing-data policy.
|
|
||||||
|
|
||||||
### Tests
|
|
||||||
|
|
||||||
- Add or update module registry tests for:
|
|
||||||
- default pass-through prompt values;
|
|
||||||
- custom exporter prompt values;
|
|
||||||
- exporter error wrapping;
|
|
||||||
- output ID/stanza validation still runs before or around export behavior;
|
|
||||||
- output `PromptValue` is not persisted in snapshot JSON.
|
|
||||||
|
|
||||||
Suggested focused command:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
go test ./internal/briefing ./internal/module
|
|
||||||
```
|
|
||||||
|
|
||||||
### Prompt Size
|
|
||||||
|
|
||||||
Small enough for one implementation prompt.
|
|
||||||
|
|
||||||
## Stage 3: Promptinput Uses Exported Values And Schema V3
|
|
||||||
|
|
||||||
### Goal
|
|
||||||
|
|
||||||
Make data-package construction serialize prompt-facing values and bump the data
|
|
||||||
package schema version.
|
|
||||||
|
|
||||||
### Files To Inspect
|
|
||||||
|
|
||||||
- `internal/promptinput/package.go`
|
|
||||||
- `internal/promptinput/package_test.go`
|
|
||||||
- `internal/state/filesystem_test.go`
|
|
||||||
- `internal/app/app.go`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
- `docs/roadmap/data-package-exports.md`
|
|
||||||
|
|
||||||
### Implementation
|
|
||||||
|
|
||||||
- Change `promptinput.SchemaVersion` to:
|
|
||||||
|
|
||||||
```go
|
|
||||||
const SchemaVersion = "weatherreporter.data_package.v3"
|
|
||||||
```
|
|
||||||
|
|
||||||
- Update `stanzasFromSnapshot` to use `output.DataPackageValue()` rather than
|
|
||||||
`output.Value`.
|
|
||||||
- Keep `BriefingStanzas` category grouping and ordering unchanged.
|
|
||||||
- Keep `LoadYAML` validation strict for the current schema version.
|
|
||||||
- Update tests and fixtures that assert `weatherreporter.data_package.v2`.
|
|
||||||
|
|
||||||
### Acceptance Criteria
|
|
||||||
|
|
||||||
- Saved data packages use schema version `weatherreporter.data_package.v3`.
|
|
||||||
- Data package stanzas use `PromptValue` when present.
|
|
||||||
- Data package stanzas fall back to rich `Value` when `PromptValue` is absent,
|
|
||||||
which keeps hand-built test snapshots and loaded rich snapshots usable.
|
|
||||||
- YAML category ordering remains unchanged.
|
|
||||||
- Module snapshots remain rich and unaffected by prompt export serialization.
|
|
||||||
|
|
||||||
### Tests
|
|
||||||
|
|
||||||
- Update promptinput tests for:
|
|
||||||
- schema version `v3`;
|
|
||||||
- prompt value preferred over rich value;
|
|
||||||
- fallback to rich value;
|
|
||||||
- deterministic categorized YAML output unchanged apart from stanza values and
|
|
||||||
schema version;
|
|
||||||
- unknown/uncategorized stanza behavior unchanged.
|
|
||||||
- Update state tests that load data packages.
|
|
||||||
|
|
||||||
Suggested focused command:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
go test ./internal/promptinput ./internal/state
|
|
||||||
```
|
|
||||||
|
|
||||||
### Prompt Size
|
|
||||||
|
|
||||||
Small enough for one implementation prompt.
|
|
||||||
|
|
||||||
## Stage 4: Current Conditions And Hourly Forecast Exports
|
|
||||||
|
|
||||||
### Goal
|
|
||||||
|
|
||||||
Add custom prompt exports for the clearest noisy raw-data modules:
|
|
||||||
`current_conditions` and `hourly_forecast`.
|
|
||||||
|
|
||||||
### Files To Inspect
|
|
||||||
|
|
||||||
- `internal/briefing/current_conditions_module.go`
|
|
||||||
- `internal/briefing/hourly_forecast_module.go`
|
|
||||||
- `internal/briefing/base_modules_test.go`
|
|
||||||
- `internal/generatedtext/render_context.go`
|
|
||||||
- `internal/reporttemplate/templates/*.md.tmpl`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
|
|
||||||
### Current Conditions Export Shape
|
|
||||||
|
|
||||||
The prompt-facing `current_conditions` export should keep:
|
|
||||||
|
|
||||||
- `condition_text`
|
|
||||||
- `is_day`
|
|
||||||
- `temperature_c`
|
|
||||||
- `temperature_f`
|
|
||||||
- `apparent_temperature_c`
|
|
||||||
- `apparent_temperature_f`
|
|
||||||
- `dewpoint_c`
|
|
||||||
- `dewpoint_f`
|
|
||||||
- `relative_humidity_percent`
|
|
||||||
- `wind_speed_kmh`
|
|
||||||
- `wind_speed_mph`
|
|
||||||
- `wind_direction`
|
|
||||||
|
|
||||||
It should remove:
|
|
||||||
|
|
||||||
- `condition_text_lower`
|
|
||||||
- `wind_direction_text`
|
|
||||||
|
|
||||||
The rich `CurrentConditionsModule` should keep those helper fields for
|
|
||||||
templates.
|
|
||||||
|
|
||||||
### Hourly Forecast Export Shape
|
|
||||||
|
|
||||||
The prompt-facing `hourly_forecast` export should keep module-level fields:
|
|
||||||
|
|
||||||
- `product`
|
|
||||||
- `issued_at`
|
|
||||||
- `updated_at`
|
|
||||||
- `source_location`
|
|
||||||
- `source_location_id`
|
|
||||||
- `periods`
|
|
||||||
|
|
||||||
Each prompt-facing hourly period should keep:
|
|
||||||
|
|
||||||
- `period_begins`
|
|
||||||
- `period_ends`
|
|
||||||
- `name`
|
|
||||||
- `is_day`
|
|
||||||
- `condition_code`
|
|
||||||
- `text_description`
|
|
||||||
- temperature fields
|
|
||||||
- dewpoint fields
|
|
||||||
- wind speed and gust fields
|
|
||||||
- `wind_direction`
|
|
||||||
- pressure fields
|
|
||||||
- visibility fields
|
|
||||||
- apparent temperature fields
|
|
||||||
- `cloud_cover_percent`
|
|
||||||
- `probability_of_precipitation_percent`
|
|
||||||
- precipitation amount fields
|
|
||||||
- snowfall depth fields
|
|
||||||
- `uv_index`
|
|
||||||
- `relative_humidity_percent`
|
|
||||||
|
|
||||||
Each prompt-facing hourly period should remove:
|
|
||||||
|
|
||||||
- `hour_label`
|
|
||||||
- `text_description_lower`
|
|
||||||
- `mention_precipitation`
|
|
||||||
|
|
||||||
The rich `HourlyForecastPeriod` should keep those helper fields for templates.
|
|
||||||
|
|
||||||
### Implementation
|
|
||||||
|
|
||||||
- Add prompt export structs near each module.
|
|
||||||
- Add exporter functions near each module.
|
|
||||||
- Register exporters in the default module definitions.
|
|
||||||
- Prefer straightforward field copying over reflection.
|
|
||||||
- Preserve `omitempty` behavior.
|
|
||||||
|
|
||||||
### Acceptance Criteria
|
|
||||||
|
|
||||||
- Saved data packages no longer include removed fields for current conditions or
|
|
||||||
hourly forecast.
|
|
||||||
- Rich module snapshots and render contexts still include template helper
|
|
||||||
fields.
|
|
||||||
- Existing hourly, today, tomorrow, and daily template output remains unchanged
|
|
||||||
wherever those templates consume current conditions or hourly forecast values.
|
|
||||||
|
|
||||||
### Tests
|
|
||||||
|
|
||||||
- Update module tests to prove prompt exports omit stale fields and keep
|
|
||||||
expected factual fields.
|
|
||||||
- Update template/render-context tests to prove helper fields remain available
|
|
||||||
to templates.
|
|
||||||
- Update app workflow tests to inspect saved YAML and reject:
|
|
||||||
- `condition_text_lower`;
|
|
||||||
- `wind_direction_text`;
|
|
||||||
- `hour_label`;
|
|
||||||
- `text_description_lower`;
|
|
||||||
- `mention_precipitation`.
|
|
||||||
|
|
||||||
Suggested focused command:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
go test ./internal/briefing ./internal/generatedtext ./internal/reporttemplate ./internal/app
|
|
||||||
```
|
|
||||||
|
|
||||||
### Prompt Size
|
|
||||||
|
|
||||||
Medium. Suitable for one implementation prompt.
|
|
||||||
|
|
||||||
## Stage 5: Derived Daypart Summary Export
|
|
||||||
|
|
||||||
### Goal
|
|
||||||
|
|
||||||
Add a curated prompt export for `derived_daypart_summaries` while preserving the
|
|
||||||
rich daypart fields used by Daily, Today, and Tomorrow templates.
|
|
||||||
|
|
||||||
### Files To Inspect
|
|
||||||
|
|
||||||
- `internal/briefing/derived_daypart_summaries_module.go`
|
|
||||||
- `internal/briefing/derived_modules_test.go`
|
|
||||||
- `internal/generatedtext/render_context.go`
|
|
||||||
- `internal/reporttemplate/templates/daily.md.tmpl`
|
|
||||||
- `internal/reporttemplate/templates/today.md.tmpl`
|
|
||||||
- `internal/reporttemplate/templates/tomorrow.md.tmpl`
|
|
||||||
- `internal/reporttemplate/reporttemplate_test.go`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
|
|
||||||
### Export Shape
|
|
||||||
|
|
||||||
For each daypart, the prompt-facing export should keep:
|
|
||||||
|
|
||||||
- `date`
|
|
||||||
- `display_name`
|
|
||||||
- `period_begins`
|
|
||||||
- `period_ends`
|
|
||||||
- `temp_range_f`
|
|
||||||
- `apparent_temp_range_f`
|
|
||||||
- `max_pop_percent`
|
|
||||||
- `max_pop_time`
|
|
||||||
- `mention_precipitation`
|
|
||||||
- `max_wind_gust_mph`
|
|
||||||
- `max_wind_gust_time`
|
|
||||||
- `dominant_condition`
|
|
||||||
- `temperature_trend`
|
|
||||||
- `temperature_start_phrase_f`
|
|
||||||
- `temperature_end_phrase_f`
|
|
||||||
- `temperature_peak_phrase_f`
|
|
||||||
- `temperature_steady_phrase_f`
|
|
||||||
- `notable_conditions`
|
|
||||||
- `snow`
|
|
||||||
- `ice`
|
|
||||||
- `fog`
|
|
||||||
- `heat`
|
|
||||||
- `cold`
|
|
||||||
- `wind`
|
|
||||||
- `relevant_alert_count`
|
|
||||||
|
|
||||||
The prompt-facing export should remove:
|
|
||||||
|
|
||||||
- `temperature_phrase_f`
|
|
||||||
- `dominant_condition_lower`
|
|
||||||
- `dominant_condition_display`
|
|
||||||
- `max_pop_time_label`
|
|
||||||
|
|
||||||
For `max_pop_time`, use the most readable existing time label. Prefer
|
|
||||||
`MaxPopTimeLabel` when present, falling back to `MaxPopTime`, while keeping the
|
|
||||||
prompt-facing field name `max_pop_time`.
|
|
||||||
|
|
||||||
Keep the temperature trend phrase fields even though only some are populated for
|
|
||||||
each trend. They are not duplicates when used according to the trend:
|
|
||||||
|
|
||||||
- rising/falling use start and end phrases;
|
|
||||||
- peaking uses peak phrase;
|
|
||||||
- steady uses steady phrase.
|
|
||||||
|
|
||||||
### Implementation
|
|
||||||
|
|
||||||
- Add prompt export structs near the daypart module.
|
|
||||||
- Add an exporter for the `map[string]DerivedDaypartSummaryModule` value.
|
|
||||||
- Preserve map keys and values for all emitted dayparts.
|
|
||||||
- Register the exporter in the default module definitions.
|
|
||||||
- Do not alter rich `DerivedDaypartSummaryModule` fields used by templates.
|
|
||||||
|
|
||||||
### Acceptance Criteria
|
|
||||||
|
|
||||||
- Saved data packages no longer include the removed daypart fields.
|
|
||||||
- The prompt-facing daypart export still gives the LLM enough information to
|
|
||||||
understand condition, temperature trend, precipitation, wind, notable
|
|
||||||
conditions, and alert relevance.
|
|
||||||
- Daily, Today, and Tomorrow template output remains unchanged.
|
|
||||||
- Render contexts still expose rich daypart helper fields.
|
|
||||||
|
|
||||||
### Tests
|
|
||||||
|
|
||||||
- Update daypart module tests for:
|
|
||||||
- prompt export field presence;
|
|
||||||
- removed field absence;
|
|
||||||
- rising, falling, peaking, and steady trend values;
|
|
||||||
- max PoP time using the friendly label under the stable `max_pop_time` key.
|
|
||||||
- Update template tests to prove rich helper fields still render Daily, Today,
|
|
||||||
and Tomorrow daypart wording.
|
|
||||||
- Update app data-package tests to reject stale daypart fields.
|
|
||||||
|
|
||||||
Suggested focused command:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
go test ./internal/briefing ./internal/generatedtext ./internal/reporttemplate ./internal/app
|
|
||||||
```
|
|
||||||
|
|
||||||
### Prompt Size
|
|
||||||
|
|
||||||
Medium. Suitable for one implementation prompt.
|
|
||||||
|
|
||||||
## Stage 6: Pass-Through Review And Workflow Regression Tests
|
|
||||||
|
|
||||||
### Goal
|
|
||||||
|
|
||||||
Confirm all other modules export correctly through pass-through behavior and add
|
|
||||||
workflow-level coverage proving the new boundary.
|
|
||||||
|
|
||||||
### Files To Inspect
|
|
||||||
|
|
||||||
- `internal/briefing/*_module.go`
|
|
||||||
- `internal/briefing/modules.go`
|
|
||||||
- `internal/promptinput/package_test.go`
|
|
||||||
- `internal/app/app_test.go`
|
|
||||||
- `internal/generatedtext/render_context_test.go`
|
|
||||||
- `internal/reporttemplate/reporttemplate_test.go`
|
|
||||||
|
|
||||||
### Implementation
|
|
||||||
|
|
||||||
- Review remaining modules:
|
|
||||||
- `metadata`
|
|
||||||
- `narrative_forecast`
|
|
||||||
- `derived_daily_summary`
|
|
||||||
- `precip_timing`
|
|
||||||
- `outdoor_windows`
|
|
||||||
- `alert_digest`
|
|
||||||
- `spc_convective_outlooks`
|
|
||||||
- `spc_convective_discussion`
|
|
||||||
- `area_forecast_discussion`
|
|
||||||
- `weather_story`
|
|
||||||
- planning modules
|
|
||||||
- Keep pass-through behavior for modules that are already prompt-appropriate.
|
|
||||||
- Add custom exporters only if a module contains clear template-only helpers or
|
|
||||||
confusing duplicate fields.
|
|
||||||
- Do not broaden this stage into a general prompt-schema redesign.
|
|
||||||
- Add workflow assertions that:
|
|
||||||
- module snapshots contain rich values;
|
|
||||||
- render contexts contain rich values;
|
|
||||||
- data packages contain curated values;
|
|
||||||
- Scriptorium receives the curated data package path exactly as before.
|
|
||||||
- Include workflow coverage for generated-template `today`, `tomorrow`, and
|
|
||||||
`daily` reports when asserting daypart and render-context behavior.
|
|
||||||
|
|
||||||
### Acceptance Criteria
|
|
||||||
|
|
||||||
- Every default module either has a custom exporter or intentionally uses
|
|
||||||
pass-through.
|
|
||||||
- App workflow tests prove saved data packages omit the cleaned fields.
|
|
||||||
- App workflow tests prove rich helper fields remain available where templates
|
|
||||||
use them.
|
|
||||||
- App workflow or render-context tests include `daily` alongside `today` and
|
|
||||||
`tomorrow` for daypart helper coverage.
|
|
||||||
- Existing report generation behavior remains unchanged except for data-package
|
|
||||||
YAML content and schema version.
|
|
||||||
|
|
||||||
### Tests
|
|
||||||
|
|
||||||
Suggested focused command:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
go test ./internal/briefing ./internal/promptinput ./internal/generatedtext ./internal/reporttemplate ./internal/app
|
|
||||||
```
|
|
||||||
|
|
||||||
### Prompt Size
|
|
||||||
|
|
||||||
Small to medium. Suitable for one implementation prompt.
|
|
||||||
|
|
||||||
## Stage 7: Documentation And Final Validation
|
|
||||||
|
|
||||||
### Goal
|
|
||||||
|
|
||||||
Update implemented documentation after the code exists and run full validation.
|
|
||||||
|
|
||||||
### Files To Inspect
|
|
||||||
|
|
||||||
- `docs/internal/module.md`
|
|
||||||
- `docs/internal/prompt-input.md`
|
|
||||||
- `docs/templates.md`
|
|
||||||
- `docs/operations.md`
|
|
||||||
- `docs/troubleshooting.md`
|
|
||||||
- `docs/roadmap/data-package-exports.md`
|
|
||||||
- tests that assert documentation examples or data-package snippets
|
|
||||||
|
|
||||||
### Implementation
|
|
||||||
|
|
||||||
- Update `docs/internal/module.md` to describe:
|
|
||||||
- rich module output;
|
|
||||||
- runtime prompt export values;
|
|
||||||
- pass-through exporters;
|
|
||||||
- module-owned prompt export policy.
|
|
||||||
- Update `docs/internal/prompt-input.md` to document:
|
|
||||||
- schema version `weatherreporter.data_package.v3`;
|
|
||||||
- curated module export behavior;
|
|
||||||
- category ordering unchanged;
|
|
||||||
- data packages are not full template render contexts.
|
|
||||||
- Update `docs/templates.md` to clarify that templates can use richer fields
|
|
||||||
than the data package exposes.
|
|
||||||
- Update any Daily template-variable documentation alongside Today and Tomorrow
|
|
||||||
references where the same module fields are discussed.
|
|
||||||
- Update any implemented docs containing stale examples of removed data-package
|
|
||||||
fields.
|
|
||||||
- Do not document deferred configurable field profiles or reflection filters as
|
|
||||||
implemented behavior.
|
|
||||||
|
|
||||||
### Acceptance Criteria
|
|
||||||
|
|
||||||
- Non-roadmap docs describe only implemented data-package export behavior.
|
|
||||||
- Docs do not imply data packages contain template-only helper fields.
|
|
||||||
- Examples and snippets use schema version `v3` when they show data packages.
|
|
||||||
|
|
||||||
### Validation Commands
|
|
||||||
|
|
||||||
```sh
|
|
||||||
go test ./internal/module ./internal/briefing ./internal/promptinput
|
|
||||||
go test ./internal/generatedtext ./internal/reporttemplate ./internal/app
|
|
||||||
go test ./...
|
|
||||||
go run ./cmd/weatherreporter --help
|
|
||||||
git diff --check
|
|
||||||
```
|
|
||||||
|
|
||||||
### Stale Field Greps
|
|
||||||
|
|
||||||
Run focused checks against docs and expected saved data-package fixtures/snippets:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
rg -n "condition_text_lower|wind_direction_text|hour_label|text_description_lower|mention_precipitation|dominant_condition_lower|dominant_condition_display|max_pop_time_label|temperature_phrase_f" docs internal/*/*_test.go
|
|
||||||
```
|
|
||||||
|
|
||||||
Review matches manually. Some matches should remain in rich module structs,
|
|
||||||
template tests, and render-context tests; they should not remain as expected
|
|
||||||
data-package fields.
|
|
||||||
|
|
||||||
### Prompt Size
|
|
||||||
|
|
||||||
Medium. Suitable for one implementation prompt.
|
|
||||||
|
|
||||||
## Deferred Work
|
|
||||||
|
|
||||||
Do not include these in this implementation sequence:
|
|
||||||
|
|
||||||
- user-configurable data-package field selection;
|
|
||||||
- per-prompt custom field profiles;
|
|
||||||
- reflection-based generic include/exclude lists;
|
|
||||||
- automatic schema generation for data-package exports;
|
|
||||||
- changing collected facts or derived facts contracts;
|
|
||||||
- changing Scriptorium invocation behavior;
|
|
||||||
- changing generated Markdown templates beyond preserving their output;
|
|
||||||
- migrating old workspace data-package artifacts.
|
|
||||||
|
|
||||||
## Open Questions
|
|
||||||
|
|
||||||
No open questions block implementation.
|
|
||||||
|
|
||||||
The implementation plan intentionally locks in the recommended choices from the
|
|
||||||
feature roadmap: schema version bump to `weatherreporter.data_package.v3`, and
|
|
||||||
runtime-only prompt export values stored on `module.Output`.
|
|
||||||
|
|
||||||
## Global Validation Checklist
|
|
||||||
|
|
||||||
- `go test ./...` passes.
|
|
||||||
- `go run ./cmd/weatherreporter --help` is accurate.
|
|
||||||
- `git diff --check` passes.
|
|
||||||
- Saved data packages use schema version `weatherreporter.data_package.v3`.
|
|
||||||
- Saved data packages serialize prompt-facing module exports.
|
|
||||||
- Saved module snapshots serialize rich module values and do not persist
|
|
||||||
prompt-facing values.
|
|
||||||
- Render contexts continue to expose rich module values.
|
|
||||||
- Hourly, Today, Tomorrow, and Daily templates continue to render the same
|
|
||||||
Markdown output.
|
|
||||||
- YAML briefing category order remains unchanged.
|
|
||||||
- `current_conditions` data packages omit `condition_text_lower` and
|
|
||||||
`wind_direction_text`.
|
|
||||||
- `hourly_forecast.periods[]` data packages omit `hour_label`,
|
|
||||||
`text_description_lower`, and `mention_precipitation`.
|
|
||||||
- `derived_daypart_summaries` data packages omit `temperature_phrase_f`,
|
|
||||||
`dominant_condition_lower`, `dominant_condition_display`, and
|
|
||||||
`max_pop_time_label`.
|
|
||||||
- Non-roadmap docs describe only implemented behavior.
|
|
||||||
@@ -1,405 +1,178 @@
|
|||||||
# Report Templates
|
# Report Templates
|
||||||
|
|
||||||
## Purpose
|
This guide is for maintainers editing Weatherreporter's embedded Markdown
|
||||||
|
templates. Templates format already validated report inputs; they do not select
|
||||||
|
sources, derive weather facts, or validate generated prose. For those details,
|
||||||
|
see [Generated Text internals](internal/generatedtext.md) and [Report Template
|
||||||
|
internals](internal/reporttemplate.md).
|
||||||
|
|
||||||
This guide describes the implemented Markdown report template surface for
|
## Template Assets
|
||||||
`weatherreporter`. It is for maintainers editing embedded report templates,
|
|
||||||
especially generated-text-template reports.
|
|
||||||
|
|
||||||
Templates are Go `text/template` files. The current implemented templates are:
|
Only the generated-text reports use repository-native Markdown templates.
|
||||||
|
Each report has one matching template ID, generated-text schema ID, and prompt
|
||||||
|
source:
|
||||||
|
|
||||||
- `internal/reporttemplate/templates/daily.md.tmpl`
|
| Report | Template | Schema | Prompt ID and source |
|
||||||
- `internal/reporttemplate/templates/today.md.tmpl`
|
| --- | --- | --- | --- |
|
||||||
- `internal/reporttemplate/templates/tomorrow.md.tmpl`
|
| Daily | `templates/daily.md.tmpl` (`daily`) | `daily` | `weather.daily_generated_text`; `internal/promptassets/assets/prompts/daily/` |
|
||||||
- `internal/reporttemplate/templates/hourly.md.tmpl`
|
| Today | `templates/today.md.tmpl` (`today`) | `today` | `weather.today_generated_text`; `internal/promptassets/assets/prompts/today/` |
|
||||||
|
| Tomorrow | `templates/tomorrow.md.tmpl` (`tomorrow`) | `tomorrow` | `weather.tomorrow_generated_text`; `internal/promptassets/assets/prompts/tomorrow/` |
|
||||||
|
| Hourly | `templates/hourly.md.tmpl` (`hourly`) | `hourly` | `weather.hourly_generated_text`; `internal/promptassets/assets/prompts/hourly/` |
|
||||||
|
|
||||||
Templates are rendered from structured contexts such as `DailyRenderContext`,
|
The matching schemas and Promptkit definitions are embedded by
|
||||||
`TodayRenderContext`, `TomorrowRenderContext`, and `HourlyRenderContext`.
|
`internal/promptassets`. The generated-text catalog pairs each schema ID with
|
||||||
Weather data collection, derivation, module execution, generated text
|
its template ID; keep the matching prompt definition aligned with that pair.
|
||||||
validation, and artifact paths are handled before template rendering.
|
|
||||||
|
Shared partials are under `internal/reporttemplate/templates/partials/`:
|
||||||
|
|
||||||
|
| Partial | Used by |
|
||||||
|
| --- | --- |
|
||||||
|
| `alert_digest.md.tmpl` | Daily, Today, Tomorrow, and Hourly |
|
||||||
|
| `precipitation_timing.md.tmpl` | Daily, Today, Tomorrow, and Hourly |
|
||||||
|
| `daypart_forecast.md.tmpl` | Daily and Tomorrow |
|
||||||
|
| `today_daypart_forecast.md.tmpl` | Today |
|
||||||
|
|
||||||
|
All shared partials are parsed whenever any top-level template is rendered. A
|
||||||
|
syntax error in a partial can therefore prevent every generated-text report
|
||||||
|
from rendering.
|
||||||
|
|
||||||
## Editing Rules
|
## Editing Rules
|
||||||
|
|
||||||
- Use Go `text/template` syntax.
|
- Use Go `text/template` syntax and keep changes to Markdown structure,
|
||||||
- Keep templates focused on Markdown layout, headings, ordering, and simple
|
ordering, and display conditions.
|
||||||
conditional display.
|
- Templates use `missingkey=error`; reference only documented fields and guard
|
||||||
- Do not put weather derivation, source selection, or path construction logic in
|
optional module pointers with `with` or `if`.
|
||||||
templates.
|
- Prefer `.Modules` for deterministic display values. Do not add weather
|
||||||
- Missing template keys are errors. A misspelled variable will fail rendering.
|
calculations, source selection, or prompt-input shaping to a template.
|
||||||
- No custom template functions are currently registered.
|
- Keep generated prose in `.GeneratedText`; do not restate deterministic facts
|
||||||
- Optional module stanzas are pointers and should be guarded with
|
in generated prose merely to compensate for a template change.
|
||||||
`{{ with .Modules.WeatherStory }}...{{ end }}`.
|
- When changing the generated-prose contract, update the matching prompt,
|
||||||
- Slices can be rendered with `{{ range .Items }}...{{ else }}...{{ end }}`.
|
schema, validator, render context, and template together. The validation and
|
||||||
|
catalog rules are owned by [Generated Text internals](internal/generatedtext.md).
|
||||||
|
- Use `.Modules.Dayparts` for ordered daypart output. Do not range over
|
||||||
|
`.Modules.DerivedDaypartSummaries`, which is a map.
|
||||||
|
|
||||||
## Hourly Context
|
Minimal optional-value pattern:
|
||||||
|
|
||||||
The hourly template receives five top-level values:
|
|
||||||
|
|
||||||
| Variable | Type | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `.Report` | HourlyReportContext | Display metadata and friendly labels for the rendered report. |
|
|
||||||
| `.GeneratedText` | Hourly | Structured text returned by Scriptorium. |
|
|
||||||
| `.Modules` | HourlyTemplateModules | Preferred deterministic template surface, keyed by module purpose. |
|
|
||||||
| `.Collected` | facts.CollectedFacts | Normalized upstream facts for advanced template use. |
|
|
||||||
| `.Derived` | facts.DerivedFacts | Shared derived facts for advanced template use. |
|
|
||||||
|
|
||||||
Prefer `.Modules` for normal template edits. `.Collected` and `.Derived` are
|
|
||||||
available when a template needs lower-level facts, but templates should still
|
|
||||||
avoid nontrivial derivation.
|
|
||||||
|
|
||||||
## Report
|
|
||||||
|
|
||||||
| Variable | Type | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `.Report.Title` | string | Display title. Currently `Hourly Report`. |
|
|
||||||
| `.Report.LocationName` | string | Prompt/report location label, such as `Brentwood, MO`. |
|
|
||||||
| `.Report.GeneratedAt` | time.Time | Canonical generation timestamp. |
|
|
||||||
| `.Report.GeneratedAtLabel` | string | Friendly local generation time label. |
|
|
||||||
| `.Report.ValidPeriod` | timeutil.Period | Canonical valid period. |
|
|
||||||
| `.Report.ValidPeriodLabel` | string | Friendly local valid period label, such as `2026-05-29 at 8:30 AM to 2026-05-29 at 2:30 PM`. |
|
|
||||||
| `.Report.Timezone` | string | Effective report timezone. |
|
|
||||||
|
|
||||||
## GeneratedText
|
|
||||||
|
|
||||||
These fields are written by Scriptorium as structured JSON, validated by
|
|
||||||
weatherreporter, and then inserted into the render context.
|
|
||||||
|
|
||||||
| Variable | Type | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `.GeneratedText.Summary` | string | Required short prose summary. |
|
|
||||||
| `.GeneratedText.ForecastDiscussion` | string | Required prose for the Forecast Discussion section. |
|
|
||||||
| `.GeneratedText.PrecipitationTiming` | string | Optional prose rendered after deterministic precipitation windows. |
|
|
||||||
| `.GeneratedText.Confidence` | string | Optional confidence or uncertainty note. Empty when omitted by the LLM; not rendered by the current hourly template. |
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```gotemplate
|
|
||||||
{{ .GeneratedText.Summary }}
|
|
||||||
|
|
||||||
## Forecast Discussion
|
|
||||||
|
|
||||||
{{ .GeneratedText.ForecastDiscussion }}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Tomorrow Context
|
|
||||||
|
|
||||||
The Tomorrow template receives five top-level values:
|
|
||||||
|
|
||||||
| Variable | Type | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `.Report` | TomorrowReportContext | Display metadata and friendly labels for the rendered report. |
|
|
||||||
| `.GeneratedText` | Tomorrow | Structured text returned by Scriptorium. |
|
|
||||||
| `.Modules` | TomorrowTemplateModules | Preferred deterministic template surface, keyed by module purpose. |
|
|
||||||
| `.Collected` | facts.CollectedFacts | Normalized upstream facts for advanced template use. |
|
|
||||||
| `.Derived` | facts.DerivedFacts | Shared derived facts for advanced template use. |
|
|
||||||
|
|
||||||
Tomorrow report metadata includes `.Report.Title`, `.Report.ForecastDate`,
|
|
||||||
`.Report.ForecastDateLabel`, `.Report.ForecastDayName`,
|
|
||||||
`.Report.GeneratedAt`, `.Report.GeneratedAtLabel`, `.Report.ValidPeriod`, and
|
|
||||||
`.Report.Timezone`.
|
|
||||||
|
|
||||||
Tomorrow generated text uses the same `.GeneratedText.Summary`,
|
|
||||||
`.GeneratedText.PrecipitationTiming`, and `.GeneratedText.Confidence` fields as
|
|
||||||
Hourly. `.GeneratedText.ForecastDiscussion` is a slice of paragraphs and should
|
|
||||||
be rendered with `range`.
|
|
||||||
|
|
||||||
Tomorrow modules include the Hourly module fields plus:
|
|
||||||
|
|
||||||
| Variable | Type | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `.Modules.DerivedDailySummary` | *briefing.DerivedDailySummaryModule | Daily summary facts for the forecast date. |
|
|
||||||
| `.Modules.DerivedDaypartSummaries` | *map[string]briefing.DerivedDaypartSummaryModule | Raw daypart summary map, when direct keyed access is needed. |
|
|
||||||
| `.Modules.Dayparts` | []generatedtext.TomorrowDaypartContext | Ordered daypart summaries for deterministic template rendering. |
|
|
||||||
| `.Modules.TomorrowPlanning` | *briefing.TomorrowPlanningModule | Planning facts for the next local civil day. |
|
|
||||||
|
|
||||||
Prefer `.Modules.Dayparts` over ranging through
|
|
||||||
`.Modules.DerivedDaypartSummaries`; it follows configured daypart order and
|
|
||||||
falls back to sorted keys for any unmatched entries.
|
|
||||||
|
|
||||||
## Daily Context
|
|
||||||
|
|
||||||
The Daily template receives the same five top-level values as Tomorrow, using
|
|
||||||
`DailyReportContext`, `Daily`, and `DailyTemplateModules`.
|
|
||||||
|
|
||||||
Daily report metadata includes `.Report.Title`, `.Report.ForecastDate`,
|
|
||||||
`.Report.ForecastDateLabel`, `.Report.ForecastDayName`,
|
|
||||||
`.Report.GeneratedAt`, `.Report.GeneratedAtLabel`, `.Report.ValidPeriod`, and
|
|
||||||
`.Report.Timezone`.
|
|
||||||
|
|
||||||
Daily generated text uses `.GeneratedText.Summary`,
|
|
||||||
`.GeneratedText.ForecastDiscussion`, `.GeneratedText.PrecipitationTiming`, and
|
|
||||||
`.GeneratedText.Confidence`. Forecast discussion is a slice of paragraphs and
|
|
||||||
should be rendered with `range`.
|
|
||||||
|
|
||||||
Daily uses template ID `daily`, generated-text schema ID `daily`, and prompt
|
|
||||||
source `internal/reporttemplate/prompts/daily.generated_text.md`.
|
|
||||||
|
|
||||||
Daily modules include the Hourly module fields plus:
|
|
||||||
|
|
||||||
| Variable | Type | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `.Modules.DerivedDailySummary` | *briefing.DerivedDailySummaryModule | Daily summary facts for the forecast date. |
|
|
||||||
| `.Modules.DerivedDaypartSummaries` | *map[string]briefing.DerivedDaypartSummaryModule | Raw daypart summary map, when direct keyed access is needed. |
|
|
||||||
| `.Modules.Dayparts` | []generatedtext.DailyDaypartContext | Ordered daypart summaries for deterministic template rendering. |
|
|
||||||
| `.Modules.DailyPlanning` | *briefing.DailyPlanningModule | Planning facts for the selected local civil day. |
|
|
||||||
|
|
||||||
Prefer `.Modules.Dayparts` over ranging through
|
|
||||||
`.Modules.DerivedDaypartSummaries`; it follows configured daypart order and
|
|
||||||
falls back to sorted keys for any unmatched entries.
|
|
||||||
|
|
||||||
## Today Context
|
|
||||||
|
|
||||||
The Today template receives the same five top-level values as Tomorrow, using
|
|
||||||
`TodayReportContext`, `Today`, and `TodayTemplateModules`.
|
|
||||||
|
|
||||||
Today report metadata includes `.Report.Title`, `.Report.ForecastDate`,
|
|
||||||
`.Report.ForecastDateLabel`, `.Report.ForecastDayName`,
|
|
||||||
`.Report.GeneratedAt`, `.Report.GeneratedAtLabel`, `.Report.ValidPeriod`, and
|
|
||||||
`.Report.Timezone`.
|
|
||||||
|
|
||||||
Today generated text uses `.GeneratedText.Summary`,
|
|
||||||
`.GeneratedText.ForecastDiscussion`, `.GeneratedText.PrecipitationTiming`, and
|
|
||||||
`.GeneratedText.Confidence`. Forecast discussion is a slice of paragraphs and
|
|
||||||
should be rendered with `range`.
|
|
||||||
|
|
||||||
Today uses template ID `today`, generated-text schema ID `today`, and prompt
|
|
||||||
source `internal/reporttemplate/prompts/today.generated_text.md`.
|
|
||||||
|
|
||||||
Today modules include the Hourly module fields plus:
|
|
||||||
|
|
||||||
| Variable | Type | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `.Modules.DerivedDailySummary` | *briefing.DerivedDailySummaryModule | Daily summary facts for the forecast date. |
|
|
||||||
| `.Modules.DerivedDaypartSummaries` | *map[string]briefing.DerivedDaypartSummaryModule | Raw daypart summary map, when direct keyed access is needed. |
|
|
||||||
| `.Modules.Dayparts` | []generatedtext.TodayDaypartContext | Ordered daypart summaries for deterministic template rendering. |
|
|
||||||
| `.Modules.TodayPlanning` | *briefing.TodayPlanningModule | Planning facts for the current local civil day. |
|
|
||||||
|
|
||||||
Prefer `.Modules.Dayparts` over ranging through
|
|
||||||
`.Modules.DerivedDaypartSummaries`; it follows configured daypart order and
|
|
||||||
falls back to sorted keys for any unmatched entries.
|
|
||||||
|
|
||||||
## Modules
|
|
||||||
|
|
||||||
`.Modules` exposes typed outputs from the same module pipeline used for the
|
|
||||||
prompt data package. Module fields are pointers because missing-data policy may
|
|
||||||
omit a stanza.
|
|
||||||
|
|
||||||
Templates render from rich module values, not from the curated YAML data
|
|
||||||
package. Some fields documented below are deterministic wording helpers for
|
|
||||||
Markdown templates and are intentionally omitted from data packages passed to
|
|
||||||
Scriptorium. The data package is a prompt input, while the render context is the
|
|
||||||
template surface.
|
|
||||||
|
|
||||||
| Variable | Type | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `.Modules.Metadata` | *briefing.MetadataModule | Report metadata module output, when present. |
|
|
||||||
| `.Modules.CurrentConditions` | *briefing.CurrentConditionsModule | Current conditions from `/conditions/current`. |
|
|
||||||
| `.Modules.HourlyForecast` | *briefing.HourlyForecastModule | Hourly forecast periods overlapping the report valid period. |
|
|
||||||
| `.Modules.PrecipTiming` | *briefing.PrecipTimingModule | Derived precipitation timing facts and threshold windows. |
|
|
||||||
| `.Modules.AlertDigest` | *briefing.AlertDigestModule | Active alert status and relevant alert overlaps. |
|
|
||||||
| `.Modules.SPCConvectiveOutlooks` | *briefing.SPCConvectiveOutlooksModule | SPC outlooks that overlap the report valid period. |
|
|
||||||
| `.Modules.AreaForecastDiscussion` | *briefing.AreaForecastDiscussionModule | AFD key messages and configured discussion sections. |
|
|
||||||
| `.Modules.SPCConvectiveDiscussion` | *briefing.SPCConvectiveDiscussionModule | SPC discussions retained for qualifying overlapping categorical risk days. |
|
|
||||||
| `.Modules.WeatherStory` | *briefing.WeatherStoryModule | Latest NWS weather story, when available. |
|
|
||||||
|
|
||||||
### Current Conditions
|
|
||||||
|
|
||||||
Common fields:
|
|
||||||
|
|
||||||
| Variable | Type | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `.Modules.CurrentConditions.ConditionText` | string | Current condition text. |
|
|
||||||
| `.Modules.CurrentConditions.ConditionTextLower` | string | Lower-case current condition text for inline sentences. |
|
|
||||||
| `.Modules.CurrentConditions.TemperatureF` | *int | Rounded current temperature. |
|
|
||||||
| `.Modules.CurrentConditions.ApparentTemperatureF` | *int | Rounded apparent temperature. |
|
|
||||||
| `.Modules.CurrentConditions.RelativeHumidityPercent` | *int | Rounded relative humidity. |
|
|
||||||
| `.Modules.CurrentConditions.WindDirection` | string | 16-point compass wind direction. |
|
|
||||||
| `.Modules.CurrentConditions.WindDirectionText` | string | Lower-case full wind direction text, such as `northwest`. |
|
|
||||||
| `.Modules.CurrentConditions.WindSpeedMph` | *int | Rounded wind speed. |
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```gotemplate
|
```gotemplate
|
||||||
{{ with .Modules.CurrentConditions }}
|
{{ with .Modules.CurrentConditions }}
|
||||||
{{ .ConditionText }}{{ with .TemperatureF }}; {{ . }} F{{ end }}{{ with .WindDirection }}; wind {{ . }}{{ end }}{{ with .WindSpeedMph }} {{ . }} mph{{ end }}
|
Currently, it is {{ with .TemperatureF }}{{ . }}°F{{ end }}.
|
||||||
{{ else }}
|
{{ else }}
|
||||||
No current conditions available.
|
Current conditions are unavailable.
|
||||||
{{ end }}
|
{{ end }}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Hourly Forecast
|
Minimal list pattern:
|
||||||
|
|
||||||
Common period fields:
|
|
||||||
|
|
||||||
| Variable | Type | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `.Modules.HourlyForecast.Periods` | []briefing.HourlyForecastPeriod | Ordered periods for the hourly report valid period. |
|
|
||||||
| `.Modules.HourlyForecast.Periods[].HourLabel` | string | Friendly hour label such as `4:00 PM`. |
|
|
||||||
| `.Modules.HourlyForecast.Periods[].PeriodBegins` | string | Friendly local period start label. |
|
|
||||||
| `.Modules.HourlyForecast.Periods[].PeriodEnds` | string | Friendly local period end label. |
|
|
||||||
| `.Modules.HourlyForecast.Periods[].Name` | string | Source period name. |
|
|
||||||
| `.Modules.HourlyForecast.Periods[].TextDescription` | string | Hourly forecast text. |
|
|
||||||
| `.Modules.HourlyForecast.Periods[].TextDescriptionLower` | string | Lower-case hourly forecast text for inline sentences. |
|
|
||||||
| `.Modules.HourlyForecast.Periods[].TemperatureF` | *float64 | Forecast temperature. |
|
|
||||||
| `.Modules.HourlyForecast.Periods[].ProbabilityOfPrecipitationPercent` | *float64 | Forecast precipitation probability. |
|
|
||||||
| `.Modules.HourlyForecast.Periods[].MentionPrecipitation` | bool | True when precipitation probability meets the hourly mention threshold. |
|
|
||||||
| `.Modules.HourlyForecast.Periods[].WindDirection` | string | 16-point compass wind direction. |
|
|
||||||
| `.Modules.HourlyForecast.Periods[].WindSpeedMph` | *float64 | Wind speed. |
|
|
||||||
| `.Modules.HourlyForecast.Periods[].WindGustMph` | *float64 | Wind gust. |
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```gotemplate
|
```gotemplate
|
||||||
{{ with .Modules.HourlyForecast }}{{ range .Periods }}
|
{{ range .GeneratedText.ForecastDiscussion }}
|
||||||
- **{{ .HourLabel }}:**{{ with .TemperatureF }} {{ . }}°F{{ end }} and {{ .TextDescriptionLower }}.{{ if .MentionPrecipitation }}{{ with .ProbabilityOfPrecipitationPercent }} Probability of precipitation is {{ . }}%.{{ end }}{{ end }}
|
{{ . }}
|
||||||
{{ else }}
|
{{ end }}
|
||||||
- No hourly forecast rows available.
|
|
||||||
{{ end }}{{ end }}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Precipitation Timing
|
## Registered Functions
|
||||||
|
|
||||||
Common fields:
|
Templates have these helpers in addition to Go template built-ins:
|
||||||
|
|
||||||
| Variable | Type | Description |
|
| Function | Accepts | Returns true when |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `.Modules.PrecipTiming.MaxPopPercent` | *int | Highest hourly precipitation probability in the valid period. |
|
| `hasRelevantAlerts` | an alert-digest value or pointer | its `Relevant` slice is nonempty |
|
||||||
| `.Modules.PrecipTiming.MaxPopTime` | string | Friendly local time for the highest hourly precipitation probability. |
|
| `hasEnhancedOrHigherSPCRisk` | an SPC outlook value or pointer | its `RiskDigest` contains an Enhanced, Moderate, or High Risk entry |
|
||||||
| `.Modules.PrecipTiming.ProbabilityThreshold` | float64 | Threshold used to define precipitation windows. |
|
| `isEnhancedOrHigherSPCRisk` | one SPC risk-digest entry | its `LabelText`, or fallback `RiskLabel`, is Enhanced, Moderate, or High Risk |
|
||||||
| `.Modules.PrecipTiming.PrecipitationWindows` | []briefing.PrecipitationWindowModule | One or more threshold precipitation windows. |
|
|
||||||
| `.Modules.PrecipTiming.PrecipitationWindows[].PeriodBegins` | string | Friendly local window start. |
|
|
||||||
| `.Modules.PrecipTiming.PrecipitationWindows[].PeriodBeginsHourLabel` | string | Friendly window start hour, such as `4:00 PM`. |
|
|
||||||
| `.Modules.PrecipTiming.PrecipitationWindows[].PeriodEnds` | string | Friendly local window end; omitted for open windows. |
|
|
||||||
| `.Modules.PrecipTiming.PrecipitationWindows[].PeriodEndsHourLabel` | string | Friendly window end hour; omitted for open windows. |
|
|
||||||
| `.Modules.PrecipTiming.PrecipitationWindows[].MaxPopPercent` | *int | Highest precipitation probability inside the window. |
|
|
||||||
| `.Modules.PrecipTiming.PrecipitationWindows[].MaxPopTime` | string | Friendly local time for the window maximum. |
|
|
||||||
| `.Modules.PrecipTiming.PrecipitationWindows[].MaxPopHourLabel` | string | Friendly hour label for the window maximum. |
|
|
||||||
| `.Modules.PrecipTiming.ThunderMentioned` | bool | Whether thunder is mentioned in the forecast text. |
|
|
||||||
|
|
||||||
### Daypart Summaries
|
For example, the alert partial uses the first two functions to decide whether
|
||||||
|
to render the section:
|
||||||
|
|
||||||
Daily, Today, and Tomorrow templates should use `.Modules.Dayparts` for
|
```gotemplate
|
||||||
ordered daypart rendering. Each item has `Key` and `Summary`; `Summary` is a
|
{{ if hasRelevantAlerts .Modules.AlertDigest }}
|
||||||
rich `briefing.DerivedDaypartSummaryModule`.
|
## Alert Digest
|
||||||
|
{{ end }}
|
||||||
|
```
|
||||||
|
|
||||||
Common rich daypart fields:
|
## Render Context
|
||||||
|
|
||||||
| Variable | Type | Description |
|
Every rendered template receives one typed context with these five top-level
|
||||||
| --- | --- | --- |
|
fields:
|
||||||
| `.Modules.Dayparts[].Summary.DisplayName` | string | Human-readable daypart label. |
|
|
||||||
| `.Modules.Dayparts[].Summary.PeriodBegins` | string | Friendly local daypart start. |
|
|
||||||
| `.Modules.Dayparts[].Summary.PeriodEnds` | string | Friendly local daypart end. |
|
|
||||||
| `.Modules.Dayparts[].Summary.TempRangeF` | string | Rounded temperature range or single temperature. |
|
|
||||||
| `.Modules.Dayparts[].Summary.TemperaturePhraseF` | string | Temperature phrase used for steady template wording. |
|
|
||||||
| `.Modules.Dayparts[].Summary.TemperatureTrend` | string | Trend category such as `rising`, `falling`, `peaking`, or `steady`. |
|
|
||||||
| `.Modules.Dayparts[].Summary.TemperatureStartPhraseF` | string | Starting temperature phrase for rising/falling wording. |
|
|
||||||
| `.Modules.Dayparts[].Summary.TemperatureEndPhraseF` | string | Ending temperature phrase for rising/falling wording. |
|
|
||||||
| `.Modules.Dayparts[].Summary.TemperaturePeakPhraseF` | string | Peak temperature phrase for peaking wording. |
|
|
||||||
| `.Modules.Dayparts[].Summary.TemperatureSteadyPhraseF` | string | Steady temperature phrase. |
|
|
||||||
| `.Modules.Dayparts[].Summary.MaxPopPercent` | *int | Highest precipitation probability in the daypart. |
|
|
||||||
| `.Modules.Dayparts[].Summary.MaxPopTime` | string | Friendly local time for the highest precipitation probability. |
|
|
||||||
| `.Modules.Dayparts[].Summary.MaxPopTimeLabel` | string | Clock-style label for deterministic precipitation timing text. |
|
|
||||||
| `.Modules.Dayparts[].Summary.MentionPrecipitation` | bool | True when precipitation probability should be mentioned by the template. |
|
|
||||||
| `.Modules.Dayparts[].Summary.DominantCondition` | string | Dominant condition text. |
|
|
||||||
| `.Modules.Dayparts[].Summary.DominantConditionLower` | string | Lower-case condition text for inline sentences. |
|
|
||||||
| `.Modules.Dayparts[].Summary.DominantConditionDisplay` | string | Display-case condition text for bullet starts. |
|
|
||||||
| `.Modules.Dayparts[].Summary.NotableConditions` | []string | Notable condition labels retained for the daypart. |
|
|
||||||
|
|
||||||
Template-only daypart helpers such as `TemperaturePhraseF`,
|
| Field | Purpose |
|
||||||
`DominantConditionLower`, `DominantConditionDisplay`, and `MaxPopTimeLabel`
|
| --- | --- |
|
||||||
remain available here even though they are not serialized into data-package
|
| `.Report` | Display labels and canonical report timing metadata. |
|
||||||
YAML.
|
| `.GeneratedText` | Validated prose supplied by Promptkit. |
|
||||||
|
| `.Modules` | Deterministic, typed values prepared for Markdown rendering. |
|
||||||
|
| `.Collected` | Normalized upstream facts for advanced use. |
|
||||||
|
| `.Derived` | Shared calculated facts for advanced use. |
|
||||||
|
|
||||||
### Alert Digest
|
`.Collected` and `.Derived` are available for an exceptional display need, but
|
||||||
|
they are lower-level contracts. Keep reusable weather derivation in Go and use
|
||||||
|
the module surface for normal template work.
|
||||||
|
|
||||||
| Variable | Type | Description |
|
### Report Metadata
|
||||||
| --- | --- | --- |
|
|
||||||
| `.Modules.AlertDigest.Checked` | bool | Whether alert data was checked successfully. |
|
|
||||||
| `.Modules.AlertDigest.ActiveCount` | int | Active alert count from the source. |
|
|
||||||
| `.Modules.AlertDigest.RelevantCount` | int | Alert count overlapping the report period. |
|
|
||||||
| `.Modules.AlertDigest.Missing` | bool | True when alert data is unavailable. |
|
|
||||||
| `.Modules.AlertDigest.Relevant` | []briefing.AlertSummary | Relevant alert summaries. |
|
|
||||||
| `.Modules.AlertDigest.Relevant[].Event` | string | Alert event name. |
|
|
||||||
| `.Modules.AlertDigest.Relevant[].Headline` | string | Alert headline. |
|
|
||||||
| `.Modules.AlertDigest.Relevant[].Severity` | string | Alert severity. |
|
|
||||||
|
|
||||||
### SPC Outlooks And Discussion
|
All contexts provide `.Report.Title`, `.Report.GeneratedAt`,
|
||||||
|
`.Report.GeneratedAtLabel`, `.Report.ValidPeriod`, and `.Report.Timezone`.
|
||||||
|
|
||||||
| Variable | Type | Description |
|
Hourly additionally provides `.Report.LocationName` and
|
||||||
| --- | --- | --- |
|
`.Report.ValidPeriodLabel`.
|
||||||
| `.Modules.SPCConvectiveOutlooks.Checked` | bool | Whether SPC outlook data was checked successfully. |
|
|
||||||
| `.Modules.SPCConvectiveOutlooks.AsOf` | string | Friendly source as-of time. |
|
|
||||||
| `.Modules.SPCConvectiveOutlooks.IssuedAt` | string | Friendly source issue time. |
|
|
||||||
| `.Modules.SPCConvectiveOutlooks.Outlooks` | []briefing.SPCConvectiveOutlookRecord | Overlapping outlook records. |
|
|
||||||
| `.Modules.SPCConvectiveOutlooks.Outlooks[].Day` | int | SPC day number. |
|
|
||||||
| `.Modules.SPCConvectiveOutlooks.Outlooks[].OutlookType` | string | Outlook type, such as `categorical`. |
|
|
||||||
| `.Modules.SPCConvectiveOutlooks.Outlooks[].Label` | string | Short outlook label. |
|
|
||||||
| `.Modules.SPCConvectiveOutlooks.Outlooks[].LabelText` | string | Human-readable outlook label. |
|
|
||||||
| `.Modules.SPCConvectiveOutlooks.Outlooks[].PeriodBegins` | string | Friendly outlook period start. |
|
|
||||||
| `.Modules.SPCConvectiveOutlooks.Outlooks[].PeriodEnds` | string | Friendly outlook period end. |
|
|
||||||
| `.Modules.SPCConvectiveOutlooks.Outlooks[].ImageURL` | string | Source image URL. |
|
|
||||||
| `.Modules.SPCConvectiveDiscussion.IncludedBecause` | string | Criterion used to include discussions. |
|
|
||||||
| `.Modules.SPCConvectiveDiscussion.Discussions` | []briefing.SPCConvectiveDiscussionRecord | Retained discussion records. |
|
|
||||||
| `.Modules.SPCConvectiveDiscussion.Discussions[].Headline` | string | Discussion headline. |
|
|
||||||
| `.Modules.SPCConvectiveDiscussion.Discussions[].Summary` | string | Discussion summary. |
|
|
||||||
| `.Modules.SPCConvectiveDiscussion.Discussions[].Discussion` | string | Full discussion text. |
|
|
||||||
|
|
||||||
### Area Forecast Discussion
|
Daily, Today, and Tomorrow additionally provide `.Report.ForecastDate`,
|
||||||
|
`.Report.ForecastDateLabel`, and `.Report.ForecastDayName`. Their valid-period
|
||||||
|
field remains canonical timing data; use the supplied display labels instead
|
||||||
|
of formatting timestamps in a template.
|
||||||
|
|
||||||
| Variable | Type | Description |
|
### Validated GeneratedText Prose
|
||||||
| --- | --- | --- |
|
|
||||||
| `.Modules.AreaForecastDiscussion.Product` | string | Source product identifier. |
|
|
||||||
| `.Modules.AreaForecastDiscussion.KeyMessages` | []string | AFD key messages. |
|
|
||||||
| `.Modules.AreaForecastDiscussion.ShortTerm` | string | AFD short-term section text. |
|
|
||||||
| `.Modules.AreaForecastDiscussion.LongTerm` | string | AFD long-term section text. |
|
|
||||||
|
|
||||||
### Weather Story
|
GeneratedText is prose returned by Promptkit and validated before rendering.
|
||||||
|
It is not a source for deterministic weather facts.
|
||||||
|
|
||||||
| Variable | Type | Description |
|
| Field | Hourly type | Daily, Today, and Tomorrow type | Notes |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| `.Modules.WeatherStory.Available` | bool | True when a story is available. |
|
| `.GeneratedText.Summary` | `string` | `string` | Required. |
|
||||||
| `.Modules.WeatherStory.OfficeID` | string | Source office ID. |
|
| `.GeneratedText.ForecastDiscussion` | `string` | `[]string` | Required; range over the day-style paragraph slice. |
|
||||||
| `.Modules.WeatherStory.PeriodBegins` | string | Friendly story period start. |
|
| `.GeneratedText.PrecipitationTiming` | `string` | `string` | Required field; an empty string represents no supported prose. The precipitation partial uses nonempty prose only when deterministic windows exist. |
|
||||||
| `.Modules.WeatherStory.PeriodEnds` | string | Friendly story period end. |
|
|
||||||
| `.Modules.WeatherStory.UpdatedAt` | *time.Time | Canonical update timestamp. |
|
|
||||||
| `.Modules.WeatherStory.Title` | string | Story title. |
|
|
||||||
| `.Modules.WeatherStory.Description` | string | Story description. |
|
|
||||||
| `.Modules.WeatherStory.AltText` | string | Story image alt text. |
|
|
||||||
| `.Modules.WeatherStory.Priority` | bool | Source priority flag. |
|
|
||||||
| `.Modules.WeatherStory.Order` | int | Source order. |
|
|
||||||
| `.Modules.WeatherStory.DownloadURL` | string | Source download URL. |
|
|
||||||
|
|
||||||
## Collected And Derived Facts
|
The JSON schema rejects unknown properties and defines the required fields, but
|
||||||
|
the schema body and validation behavior are documented in [Generated Text
|
||||||
|
internals](internal/generatedtext.md).
|
||||||
|
|
||||||
The template also receives the full `facts.CollectedFacts` and
|
### Deterministic Module Values
|
||||||
`facts.DerivedFacts` structs:
|
|
||||||
|
|
||||||
- `.Collected` contains normalized source data and provenance from upstream
|
Module values are deterministic outputs built from collected and derived facts.
|
||||||
Weather API fetches.
|
Module pointers can be nil when their source or policy permits omission.
|
||||||
- `.Derived` contains shared slices and calculations used across modules, such
|
|
||||||
as valid-period hourly periods, precipitation timing, alert overlaps, and SPC
|
|
||||||
filtering inputs.
|
|
||||||
|
|
||||||
These values are intentionally lower-level than `.Modules`. Use them when a
|
| Module field | Available in |
|
||||||
template needs a specific field that is not exposed by a module, but keep
|
| --- | --- |
|
||||||
calculation-heavy changes in Go.
|
| `.Modules.Metadata`, `.Modules.CurrentConditions`, `.Modules.HourlyForecast`, `.Modules.PrecipTiming`, `.Modules.AlertDigest`, `.Modules.SPCConvectiveOutlooks`, `.Modules.AreaForecastDiscussion`, `.Modules.SPCConvectiveDiscussion`, `.Modules.WeatherStory` | All four contexts |
|
||||||
|
| `.Modules.DerivedDailySummary`, `.Modules.DerivedDaypartSummaries`, `.Modules.Dayparts` | Daily, Today, Tomorrow |
|
||||||
|
| `.Modules.OutdoorWindows`, `.Modules.DailyPlanning` | Daily |
|
||||||
|
| `.Modules.TodayPlanning` | Today |
|
||||||
|
| `.Modules.TomorrowPlanning` | Tomorrow |
|
||||||
|
|
||||||
## Validation
|
The repository templates currently use the following nested display values.
|
||||||
|
They are the preferred surface for comparable edits:
|
||||||
|
|
||||||
After editing a template, run:
|
| Area | Values |
|
||||||
|
| --- | --- |
|
||||||
|
| Current conditions | `.TemperatureF`, `.ConditionText`, `.ConditionTextLower`, `.ApparentTemperatureF`, `.RelativeHumidityPercent`, `.WindDirectionText`, `.WindSpeedMph` |
|
||||||
|
| Hourly periods | `.Periods`, `.HourLabel`, `.Name`, `.TemperatureF`, `.TextDescription`, `.TextDescriptionLower`, `.MentionPrecipitation`, `.ProbabilityOfPrecipitationPercent` |
|
||||||
|
| Dayparts | `.Dayparts[].Key` and `.Dayparts[].Summary` fields `DisplayName`, `DominantCondition`, `DominantConditionDisplay`, `TemperatureTrend`, `TemperatureStartPhraseF`, `TemperatureEndPhraseF`, `TemperaturePeakPhraseF`, `TemperatureSteadyPhraseF`, `TemperaturePhraseF`, `MentionPrecipitation`, and `MaxPopPercent` |
|
||||||
|
| Precipitation timing | `.PrecipitationWindows`, plus each window's `PeriodBegins`, `PeriodBeginsHourLabel`, `PeriodEnds`, `PeriodEndsHourLabel`, `ExpectationPhrase`, `MaxPopPercent`, `MaxPopTime`, and `MaxPopHourLabel` |
|
||||||
|
| Alert digest | `.AlertDigest.Relevant` entries' `Event`, `Headline`, `PeriodBegins`, and `PeriodEnds` |
|
||||||
|
| SPC risk digest | `.SPCConvectiveOutlooks.RiskDigest` entries' `LabelText`, `RiskLabel`, `PeriodBegins`, and `PeriodEnds` |
|
||||||
|
|
||||||
```bash
|
Other fields on these typed modules remain available when a template has a
|
||||||
|
well-defined display need. Their module contracts and weather derivation belong
|
||||||
|
to [Module contract internals](internal/module.md), [Module builder
|
||||||
|
internals](internal/briefing.md), and [Forecast derivation
|
||||||
|
internals](internal/forecast-derivation.md).
|
||||||
|
|
||||||
|
## Validate Changes
|
||||||
|
|
||||||
|
Run the focused checks after editing templates, partials, prompts, or schemas:
|
||||||
|
|
||||||
|
```sh
|
||||||
go test ./internal/reporttemplate ./internal/generatedtext ./internal/app
|
go test ./internal/reporttemplate ./internal/generatedtext ./internal/app
|
||||||
```
|
|
||||||
|
|
||||||
For a full check, run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go test ./...
|
|
||||||
go run ./cmd/weatherreporter --help
|
|
||||||
git diff --check
|
git diff --check
|
||||||
```
|
```
|
||||||
|
|
||||||
Template render tests exercise the Daily, Today, Tomorrow, and Hourly
|
The render-context and template tests cover Daily, Today, Tomorrow, and Hourly
|
||||||
templates through `internal/generatedtext/render_context_test.go` and
|
contexts. Run the repository-wide test suite before merging a broader change.
|
||||||
`internal/reporttemplate/reporttemplate_test.go`.
|
|
||||||
|
|||||||
@@ -1,386 +0,0 @@
|
|||||||
# Weatherreporter Troubleshooting
|
|
||||||
|
|
||||||
This guide lists recurring failures with likely causes, diagnostics, and safe
|
|
||||||
fixes. See [CLI reference](cli.md), [Configuration reference](config.md), and
|
|
||||||
[Operations guide](operations.md) for normal usage.
|
|
||||||
|
|
||||||
## `weather_api.base_url is required`
|
|
||||||
|
|
||||||
Symptom: a generation command fails before fetching weather data.
|
|
||||||
|
|
||||||
Likely cause: no Weather API base URL is configured.
|
|
||||||
|
|
||||||
Diagnostic:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
weatherreporter generate daily --config ./config.yml --date 2026-05-29
|
|
||||||
```
|
|
||||||
|
|
||||||
Safe fix: add `weather_api.base_url` to the config file, or pass the intended
|
|
||||||
config path with `--config`.
|
|
||||||
|
|
||||||
Relevant docs: [Configuration reference](config.md).
|
|
||||||
|
|
||||||
## `weather_api.base_url must be an absolute URL`
|
|
||||||
|
|
||||||
Symptom: config loading fails with a base URL validation error.
|
|
||||||
|
|
||||||
Likely cause: `weather_api.base_url` is missing a scheme or host.
|
|
||||||
|
|
||||||
Diagnostic: inspect the configured value in the file passed to `--config`.
|
|
||||||
|
|
||||||
Safe fix: use an absolute URL such as `https://weather.api.example.com/`.
|
|
||||||
|
|
||||||
Relevant docs: [Configuration reference](config.md).
|
|
||||||
|
|
||||||
## Invalid Timezone
|
|
||||||
|
|
||||||
Symptom: config loading fails with `weather_api.timezone` context, or a CLI
|
|
||||||
timezone override fails.
|
|
||||||
|
|
||||||
Likely cause: `weather_api.timezone` or `--tz` is not recognized.
|
|
||||||
|
|
||||||
Diagnostic:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
weatherreporter generate daily --tz America/Chicago --date 2026-05-29
|
|
||||||
```
|
|
||||||
|
|
||||||
Safe fix: use an accepted timezone value, such as an IANA timezone name,
|
|
||||||
`Chicago`, `Stl`, a US timezone abbreviation, or a UTC offset.
|
|
||||||
|
|
||||||
Relevant docs: [Configuration reference](config.md).
|
|
||||||
|
|
||||||
## Storm Command Rejects Time Bounds
|
|
||||||
|
|
||||||
Symptom: `generate storm` fails with `requires --start`, `requires --end`, or
|
|
||||||
`requires --end after --start`.
|
|
||||||
|
|
||||||
Likely cause: the manual event window is missing or invalid.
|
|
||||||
|
|
||||||
Diagnostic:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
weatherreporter generate storm --start 2026-05-29T18:00 --end 2026-05-30T06:00
|
|
||||||
```
|
|
||||||
|
|
||||||
Safe fix: provide both bounds. Use `YYYY-MM-DDTHH:MM` in the configured
|
|
||||||
timezone, or RFC3339 timestamps with explicit offsets.
|
|
||||||
|
|
||||||
Relevant docs: [CLI reference](cli.md).
|
|
||||||
|
|
||||||
## Weather API Fetch Fails
|
|
||||||
|
|
||||||
Symptom: generation fails with `fetch /...`, an HTTP status, or request context.
|
|
||||||
|
|
||||||
Likely cause: the configured Weather API endpoint is unreachable, returned a
|
|
||||||
non-2xx response, or returned an invalid response envelope.
|
|
||||||
|
|
||||||
Diagnostic:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
weatherreporter generate daily --config ./config.yml --date 2026-05-29
|
|
||||||
```
|
|
||||||
|
|
||||||
Safe fix: verify `weather_api.base_url`, network access, and the Weather API
|
|
||||||
service response. The adapter fetches `/observations`, `/conditions/current`,
|
|
||||||
`/forecast/hourly`, `/forecast/narrative`, `/alerts/active`, and `/discussion`.
|
|
||||||
|
|
||||||
Relevant docs: [Configuration reference](config.md).
|
|
||||||
|
|
||||||
## Hourly Forecast Is Missing
|
|
||||||
|
|
||||||
Symptom: generation fails with hourly forecast context, such as missing hourly
|
|
||||||
data or an hourly forecast containing no periods.
|
|
||||||
|
|
||||||
Likely cause: hourly forecast data is required for generated reports.
|
|
||||||
|
|
||||||
Diagnostic: check the Weather API response for `/forecast/hourly`.
|
|
||||||
|
|
||||||
Safe fix: restore hourly forecast data at the Weather API. Missing-source
|
|
||||||
policy cannot make hourly optional.
|
|
||||||
|
|
||||||
Relevant docs: [Configuration reference](config.md), [Operations guide](operations.md).
|
|
||||||
|
|
||||||
## Source Warnings Appear
|
|
||||||
|
|
||||||
Symptom: generation succeeds, but metadata or `inspect sources` shows source
|
|
||||||
warnings.
|
|
||||||
|
|
||||||
Likely cause: an optional source was missing or malformed under a warning
|
|
||||||
missing-source policy.
|
|
||||||
|
|
||||||
Diagnostic:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
weatherreporter inspect sources RUN_ID
|
|
||||||
weatherreporter inspect metadata RUN_ID
|
|
||||||
```
|
|
||||||
|
|
||||||
Safe fix: inspect the warning `source`, `code`, `message`, and `endpoint`. Fix
|
|
||||||
the upstream optional source, or intentionally change the relevant
|
|
||||||
`missing_source` policy.
|
|
||||||
|
|
||||||
Relevant docs: [Configuration reference](config.md), [Operations guide](operations.md).
|
|
||||||
|
|
||||||
## `scriptorium` Is Not Found Or Cannot Start
|
|
||||||
|
|
||||||
Symptom: generation fails with `run scriptorium render` or `run scriptorium`
|
|
||||||
and an executable or OS error.
|
|
||||||
|
|
||||||
Likely cause: the configured Scriptorium binary is unavailable or not
|
|
||||||
executable.
|
|
||||||
|
|
||||||
Diagnostic: check `scriptorium.binary` in config and run the same binary outside
|
|
||||||
`weatherreporter`.
|
|
||||||
|
|
||||||
Safe fix: install Scriptorium, update `scriptorium.binary`, or fix executable
|
|
||||||
permissions.
|
|
||||||
|
|
||||||
Relevant docs: [Configuration reference](config.md),
|
|
||||||
[Scriptorium integration](integrations/scriptorium.md).
|
|
||||||
|
|
||||||
## Render Preflight Fails
|
|
||||||
|
|
||||||
Symptom: generation fails with `scriptorium render exited with code ...`.
|
|
||||||
|
|
||||||
Likely cause: Scriptorium rejected the prompt, config, profile, or
|
|
||||||
`data_package` input before report generation.
|
|
||||||
|
|
||||||
Diagnostic:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
weatherreporter inspect metadata RUN_ID
|
|
||||||
weatherreporter inspect data-package RUN_ID
|
|
||||||
```
|
|
||||||
|
|
||||||
Then read the preflight path from metadata. It contains captured stdout, stderr,
|
|
||||||
exit code, and command.
|
|
||||||
|
|
||||||
Safe fix: fix the Scriptorium configuration, prompt ID, profile, or data package
|
|
||||||
input indicated by stderr.
|
|
||||||
|
|
||||||
Relevant docs: [Operations guide](operations.md),
|
|
||||||
[Scriptorium integration](integrations/scriptorium.md).
|
|
||||||
|
|
||||||
## Scriptorium Run Fails
|
|
||||||
|
|
||||||
Symptom: generation fails with `scriptorium run exited with code ...`.
|
|
||||||
|
|
||||||
Likely cause: Scriptorium failed during report generation or validation.
|
|
||||||
|
|
||||||
Diagnostic:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
weatherreporter inspect metadata RUN_ID
|
|
||||||
weatherreporter inspect data-package RUN_ID
|
|
||||||
```
|
|
||||||
|
|
||||||
If metadata includes a rendered report path, inspect that report as well. A
|
|
||||||
nonzero run can still leave a managed report artifact.
|
|
||||||
|
|
||||||
Safe fix: use the captured stderr and data package to fix the Scriptorium
|
|
||||||
prompt, profile, model configuration, or validation issue.
|
|
||||||
|
|
||||||
Relevant docs: [Operations guide](operations.md),
|
|
||||||
[Scriptorium integration](integrations/scriptorium.md).
|
|
||||||
|
|
||||||
## Generated Text Validation Fails
|
|
||||||
|
|
||||||
Symptom: Daily, Today, Tomorrow, or Hourly generation fails with generated-text
|
|
||||||
decode, unknown-field, required-field, or multiple-JSON-values context.
|
|
||||||
|
|
||||||
Likely cause: Scriptorium wrote structured JSON that does not match the
|
|
||||||
GeneratedText contract for the selected report.
|
|
||||||
|
|
||||||
Diagnostic:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
weatherreporter inspect metadata RUN_ID
|
|
||||||
```
|
|
||||||
|
|
||||||
Then inspect the generated-text raw path recorded in metadata, if present.
|
|
||||||
|
|
||||||
Safe fix: update the Scriptorium prompt or schema configuration so the prompt
|
|
||||||
writes the expected structured JSON for the report.
|
|
||||||
|
|
||||||
Relevant docs: [Operations guide](operations.md),
|
|
||||||
[Generated Text internals](internal/generatedtext.md),
|
|
||||||
[Scriptorium integration](integrations/scriptorium.md).
|
|
||||||
|
|
||||||
## Template Rendering Fails
|
|
||||||
|
|
||||||
Symptom: Daily, Today, Tomorrow, or Hourly generation fails with report template
|
|
||||||
parsing or execution context after generated text validation succeeds.
|
|
||||||
|
|
||||||
Likely cause: an embedded template references a missing context field or
|
|
||||||
receives a value shape that does not match its typed render context.
|
|
||||||
|
|
||||||
Diagnostic:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
weatherreporter inspect metadata RUN_ID
|
|
||||||
```
|
|
||||||
|
|
||||||
If metadata records generated-text and render-context paths, inspect those
|
|
||||||
artifacts along with the template named by the report definition.
|
|
||||||
|
|
||||||
Safe fix: update the embedded template or render-context builder so the
|
|
||||||
template uses the implemented typed context.
|
|
||||||
|
|
||||||
Relevant docs: [Report Templates](templates.md),
|
|
||||||
[Report Template internals](internal/reporttemplate.md).
|
|
||||||
|
|
||||||
## Batch Command Returns Nonzero
|
|
||||||
|
|
||||||
Symptom: `run morning` or `run evening` returns nonzero.
|
|
||||||
|
|
||||||
Likely cause: at least one report in the batch failed.
|
|
||||||
|
|
||||||
Diagnostic: inspect stdout for the JSON summary and stderr for compact status
|
|
||||||
lines.
|
|
||||||
|
|
||||||
Safe fix: use the failed report's artifact paths from the summary, then inspect
|
|
||||||
metadata, sources, module snapshot, and data package for that RunID.
|
|
||||||
|
|
||||||
Relevant docs: [CLI reference](cli.md), [Operations guide](operations.md).
|
|
||||||
|
|
||||||
## Invalid Secrets Directory
|
|
||||||
|
|
||||||
Symptom: config loading fails with `read secrets directory`, `secret file`, or
|
|
||||||
environment variable name context.
|
|
||||||
|
|
||||||
Likely cause: `secrets.directory` points to a missing directory or contains an
|
|
||||||
invalid entry. Secret entries must be regular files directly under the
|
|
||||||
configured directory, and file basenames must match
|
|
||||||
`[A-Za-z_][A-Za-z0-9_]*`.
|
|
||||||
|
|
||||||
Diagnostic: list the configured directory and inspect entry names and file
|
|
||||||
types. Do not print secret file contents.
|
|
||||||
|
|
||||||
Safe fix: create the directory, remove subdirectories or symlinks, fix invalid
|
|
||||||
filenames, and ensure the weatherreporter process can read each secret file.
|
|
||||||
|
|
||||||
Relevant docs: [Configuration reference](config.md).
|
|
||||||
|
|
||||||
## Distributor Token Is Missing
|
|
||||||
|
|
||||||
Symptom: notification fails with a message that the distributor token
|
|
||||||
environment variable is not set.
|
|
||||||
|
|
||||||
Likely cause: `notify.distributor.enabled` is true, but the environment
|
|
||||||
variable named by `notify.distributor.token_env` was not populated directly or
|
|
||||||
through `secrets.directory`.
|
|
||||||
|
|
||||||
Diagnostic: check `notify.distributor.token_env`, then verify a matching secret
|
|
||||||
file exists under `secrets.directory` or that the process environment includes
|
|
||||||
the variable. Do not print the token value.
|
|
||||||
|
|
||||||
Safe fix: create a readable secret file whose basename matches `token_env`, or
|
|
||||||
set the environment variable through the service manager.
|
|
||||||
|
|
||||||
Relevant docs: [Configuration reference](config.md),
|
|
||||||
[Operations guide](operations.md).
|
|
||||||
|
|
||||||
## Distributor Upload Conflict
|
|
||||||
|
|
||||||
Symptom: notification fails with idempotency conflict context.
|
|
||||||
|
|
||||||
Likely cause: the same idempotency key was reused for different bundle content
|
|
||||||
within the same distributor token and pipeline. By default the bundle ID is a
|
|
||||||
stable report-stream identity and the idempotency key appends RunID.
|
|
||||||
|
|
||||||
Diagnostic: inspect the failed batch JSON or stderr line for pipeline, bundle,
|
|
||||||
and idempotency context. Compare the configured templates with the report RunID
|
|
||||||
and report path.
|
|
||||||
|
|
||||||
Also inspect the notification artifact linked from metadata. It records the
|
|
||||||
rendered pipeline ID, bundle ID, idempotency key, upload result, distributor run
|
|
||||||
status, status error, and raw run report JSON when available.
|
|
||||||
|
|
||||||
Safe fix: keep idempotency templates stable for retries of the same generated
|
|
||||||
report, but do not reuse the same rendered key for different generated report
|
|
||||||
content.
|
|
||||||
|
|
||||||
Relevant docs: [Operations guide](operations.md),
|
|
||||||
[Distributor adapter internals](internal/distributor-adapter.md).
|
|
||||||
|
|
||||||
## Distributor Upload Rejected
|
|
||||||
|
|
||||||
Symptom: notification fails with distributor upload rejection, HTTP status, or
|
|
||||||
bundle validation context.
|
|
||||||
|
|
||||||
Likely cause: the distributor endpoint rejected the token, pipeline ID, bundle
|
|
||||||
ID, idempotency key, source file, or one of the rendered bundle paths.
|
|
||||||
|
|
||||||
Diagnostic: inspect stdout JSON or stderr status lines for
|
|
||||||
`notificationError`. Confirm `notify.distributor.endpoint`,
|
|
||||||
`notify.distributor.pipeline_id_template`,
|
|
||||||
`notify.distributor.report_path_templates`, and token configuration. Token
|
|
||||||
values are redacted from weatherreporter errors.
|
|
||||||
|
|
||||||
If the upload was accepted but destination output did not change, inspect the
|
|
||||||
notification artifact's `runStatus.report`. Distributor actions such as
|
|
||||||
`replace_older`, `skip_same`, `skip_destination_newer`, or `failed` explain how
|
|
||||||
the destination handled the uploaded bundle.
|
|
||||||
|
|
||||||
Safe fix: fix the endpoint, token, templates, or distributor-side upload
|
|
||||||
configuration. The weatherreporter upload source is the managed Markdown report,
|
|
||||||
not `--out` or `--out-dir` copies.
|
|
||||||
|
|
||||||
Relevant docs: [Configuration reference](config.md),
|
|
||||||
[Operations guide](operations.md),
|
|
||||||
[Distributor adapter internals](internal/distributor-adapter.md).
|
|
||||||
|
|
||||||
## Distributor Unavailable
|
|
||||||
|
|
||||||
Symptom: notification fails with network, timeout, or service unavailable
|
|
||||||
context.
|
|
||||||
|
|
||||||
Likely cause: the configured distributor endpoint is unreachable, slow, or
|
|
||||||
temporarily unavailable.
|
|
||||||
|
|
||||||
Diagnostic: check network access from the weatherreporter host to
|
|
||||||
`notify.distributor.endpoint`. For batch runs, inspect which reports have
|
|
||||||
`notificationStatus: "failed"`.
|
|
||||||
|
|
||||||
Safe fix: restore distributor service availability and rerun the affected
|
|
||||||
report or batch. Stable idempotency keys make retrying the same generated report
|
|
||||||
safe unless the distributor reports a conflict.
|
|
||||||
|
|
||||||
Relevant docs: [Operations guide](operations.md).
|
|
||||||
|
|
||||||
## Unknown RunID
|
|
||||||
|
|
||||||
Symptom: an inspect command fails with `metadata for run id ... was not found`.
|
|
||||||
|
|
||||||
Likely cause: the RunID is mistyped or the command is reading a different
|
|
||||||
workspace.
|
|
||||||
|
|
||||||
Diagnostic:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
weatherreporter inspect reports --config ./config.yml --limit 20
|
|
||||||
```
|
|
||||||
|
|
||||||
Safe fix: copy a RunID from `inspect reports`, or use the same `--config` and
|
|
||||||
workspace that generated the report.
|
|
||||||
|
|
||||||
Relevant docs: [Operations guide](operations.md).
|
|
||||||
|
|
||||||
## Workspace Path Error
|
|
||||||
|
|
||||||
Symptom: startup or inspection fails with workspace path validation or
|
|
||||||
filesystem read/write context.
|
|
||||||
|
|
||||||
Likely cause: a workspace subdirectory is absolute, escapes `workspace.root`, or
|
|
||||||
the process cannot read or write the configured path.
|
|
||||||
|
|
||||||
Diagnostic: review `workspace.root`, `workspace.snapshots_dir`,
|
|
||||||
`workspace.reports_dir`, `workspace.data_packages_dir`, and
|
|
||||||
`workspace.preflight_dir`.
|
|
||||||
|
|
||||||
Safe fix: keep workspace subdirectories relative to `workspace.root`, and grant
|
|
||||||
the process appropriate filesystem permissions.
|
|
||||||
|
|
||||||
Relevant docs: [Configuration reference](config.md), [Operations guide](operations.md).
|
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
weather_api:
|
weather_api:
|
||||||
base_url: https://weather.api.rakestrawhome.com/
|
base_url: https://weather.api.example.com/
|
||||||
timeout: 15s
|
timeout: 15s
|
||||||
precision: 1
|
precision: 0
|
||||||
units: us
|
units: us
|
||||||
timezone: "America/Chicago"
|
timezone: "America/Chicago"
|
||||||
format: json
|
format: json
|
||||||
@@ -24,25 +24,21 @@ notify:
|
|||||||
pipeline_id_template: "weatherreporter.{report_id}"
|
pipeline_id_template: "weatherreporter.{report_id}"
|
||||||
bundle_id_template: "weatherreporter.{location_id}.{report_id}"
|
bundle_id_template: "weatherreporter.{location_id}.{report_id}"
|
||||||
idempotency_key_template: "{bundle_id}.{run_id}"
|
idempotency_key_template: "{bundle_id}.{run_id}"
|
||||||
report_path_templates:
|
batch:
|
||||||
- "{valid_start_date}/{artifact_group}/{valid_start_date}-{artifact_group}-{run_id}.md"
|
enabled: true
|
||||||
|
pipeline_id_template: "weatherreporter"
|
||||||
|
bundle_id_template: "weatherreporter.{location_id}.{batch}"
|
||||||
|
idempotency_key_template: "{bundle_id}.{batch_run_id}"
|
||||||
|
|
||||||
missing_source:
|
missing_source:
|
||||||
default: warn
|
default: warn
|
||||||
sources:
|
sources:
|
||||||
alerts: none
|
alerts: none
|
||||||
|
|
||||||
scriptorium:
|
promptkit:
|
||||||
binary: scriptorium
|
|
||||||
timeout: 2m
|
timeout: 2m
|
||||||
|
local:
|
||||||
workspace:
|
concurrency_limit: 1
|
||||||
root: workspace
|
|
||||||
snapshots_dir: snapshots
|
|
||||||
reports_dir: reports
|
|
||||||
data_packages_dir: data-packages
|
|
||||||
preflight_dir: preflight
|
|
||||||
notifications_dir: notifications
|
|
||||||
|
|
||||||
dayparts:
|
dayparts:
|
||||||
- name: overnight
|
- name: overnight
|
||||||
@@ -61,14 +57,12 @@ dayparts:
|
|||||||
start: "17:00"
|
start: "17:00"
|
||||||
end: "24:00"
|
end: "24:00"
|
||||||
|
|
||||||
recent_change:
|
|
||||||
temperature_degrees: 5
|
|
||||||
precip_probability_points: 20
|
|
||||||
wind_gust_miles_per_hour: 10
|
|
||||||
precip_timing_shift_minutes: 120
|
|
||||||
|
|
||||||
reports:
|
reports:
|
||||||
daily:
|
daily:
|
||||||
|
distributor:
|
||||||
|
path_templates:
|
||||||
|
- "daily/{valid_start_date}/{run_id}.md"
|
||||||
|
- "daily/{valid_start_date}/index.md"
|
||||||
deterministic_modules:
|
deterministic_modules:
|
||||||
- metadata
|
- metadata
|
||||||
- current_conditions
|
- current_conditions
|
||||||
@@ -81,9 +75,6 @@ reports:
|
|||||||
- id: area_forecast_discussion
|
- id: area_forecast_discussion
|
||||||
options:
|
options:
|
||||||
sections:
|
sections:
|
||||||
- product
|
|
||||||
- key_messages
|
|
||||||
- short_term
|
|
||||||
- long_term
|
- long_term
|
||||||
- spc_convective_discussion
|
- spc_convective_discussion
|
||||||
- weather_story
|
- weather_story
|
||||||
|
|||||||
4
examples/weather-light-local-profile.yml
Normal file
4
examples/weather-light-local-profile.yml
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
id: weather-light
|
||||||
|
endpoint: http://127.0.0.1:11434/v1
|
||||||
|
model: weather-local
|
||||||
|
timeout_seconds: 180
|
||||||
10
go.mod
10
go.mod
@@ -4,4 +4,12 @@ go 1.26
|
|||||||
|
|
||||||
require gopkg.in/yaml.v3 v3.0.1
|
require gopkg.in/yaml.v3 v3.0.1
|
||||||
|
|
||||||
require gitea.maximumdirect.net/eric/distributor v0.5.0
|
require (
|
||||||
|
gitea.maximumdirect.net/eric/distributor v0.5.0
|
||||||
|
gitea.maximumdirect.net/eric/promptkit v0.5.0
|
||||||
|
)
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 // indirect
|
||||||
|
golang.org/x/text v0.14.0 // indirect
|
||||||
|
)
|
||||||
|
|||||||
8
go.sum
8
go.sum
@@ -1,5 +1,7 @@
|
|||||||
gitea.maximumdirect.net/eric/distributor v0.5.0 h1:+al7Bw+kMv6V35a3Sm5rUtCTQhwOn5b9x3RsclPMKJk=
|
gitea.maximumdirect.net/eric/distributor v0.5.0 h1:+al7Bw+kMv6V35a3Sm5rUtCTQhwOn5b9x3RsclPMKJk=
|
||||||
gitea.maximumdirect.net/eric/distributor v0.5.0/go.mod h1:G03FCFZPHpsUKC6SeMgTdbfNRpPQBdyTtDUj04e1Tu8=
|
gitea.maximumdirect.net/eric/distributor v0.5.0/go.mod h1:G03FCFZPHpsUKC6SeMgTdbfNRpPQBdyTtDUj04e1Tu8=
|
||||||
|
gitea.maximumdirect.net/eric/promptkit v0.5.0 h1:jnpazLyyNhWrB2xzwwtUkNUfktkTdkENTwuSPnKiYrc=
|
||||||
|
gitea.maximumdirect.net/eric/promptkit v0.5.0/go.mod h1:R95NM6fbMDGDC0/UomgnSBP6ui2ns+8SZb8bESNvrDQ=
|
||||||
github.com/aws/aws-sdk-go-v2 v1.41.9 h1:/rYeyO2+HrMztAmxAq9++XJtFMqSIpSsNA0yDGALYq4=
|
github.com/aws/aws-sdk-go-v2 v1.41.9 h1:/rYeyO2+HrMztAmxAq9++XJtFMqSIpSsNA0yDGALYq4=
|
||||||
github.com/aws/aws-sdk-go-v2 v1.41.9/go.mod h1:+HsoOEX80qAVUitj1A2DhCNTjmb3edVyuDypb6LNEeo=
|
github.com/aws/aws-sdk-go-v2 v1.41.9/go.mod h1:+HsoOEX80qAVUitj1A2DhCNTjmb3edVyuDypb6LNEeo=
|
||||||
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.11 h1:h5+3VT69KUBK24grGuuA5saDJTj2IIjLb9au668Fo5I=
|
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.11 h1:h5+3VT69KUBK24grGuuA5saDJTj2IIjLb9au668Fo5I=
|
||||||
@@ -36,16 +38,22 @@ github.com/aws/aws-sdk-go-v2/service/sts v1.42.3 h1:ErklX/7uhSbkAAeyQD/Y1OoQ9hO3
|
|||||||
github.com/aws/aws-sdk-go-v2/service/sts v1.42.3/go.mod h1:ULe4HCzfKPiR6R3HEurE3b1upEkuk8AkMrOKtaOxKO8=
|
github.com/aws/aws-sdk-go-v2/service/sts v1.42.3/go.mod h1:ULe4HCzfKPiR6R3HEurE3b1upEkuk8AkMrOKtaOxKO8=
|
||||||
github.com/aws/smithy-go v1.26.0 h1:9ouqbi+NyKP7fV3Te7UElCwdAb6Y8uk7LGwPE5tVe/s=
|
github.com/aws/smithy-go v1.26.0 h1:9ouqbi+NyKP7fV3Te7UElCwdAb6Y8uk7LGwPE5tVe/s=
|
||||||
github.com/aws/smithy-go v1.26.0/go.mod h1:YE2RhdIuDbA5E5bTdciG9KrW3+TiEONeUWCqxX9i1Fc=
|
github.com/aws/smithy-go v1.26.0/go.mod h1:YE2RhdIuDbA5E5bTdciG9KrW3+TiEONeUWCqxX9i1Fc=
|
||||||
|
github.com/dlclark/regexp2 v1.11.0 h1:G/nrcoOa7ZXlpoa/91N3X7mM3r8eIlMBBJZvsz/mxKI=
|
||||||
|
github.com/dlclark/regexp2 v1.11.0/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8=
|
||||||
github.com/kr/fs v0.1.0 h1:Jskdu9ieNAYnjxsi0LbQp1ulIKZV1LAFgK1tWhpZgl8=
|
github.com/kr/fs v0.1.0 h1:Jskdu9ieNAYnjxsi0LbQp1ulIKZV1LAFgK1tWhpZgl8=
|
||||||
github.com/kr/fs v0.1.0/go.mod h1:FFnZGqtBN9Gxj7eW1uZ42v5BccTP0vu6NEaFoC2HwRg=
|
github.com/kr/fs v0.1.0/go.mod h1:FFnZGqtBN9Gxj7eW1uZ42v5BccTP0vu6NEaFoC2HwRg=
|
||||||
github.com/pkg/sftp v1.13.10 h1:+5FbKNTe5Z9aspU88DPIKJ9z2KZoaGCu6Sr6kKR/5mU=
|
github.com/pkg/sftp v1.13.10 h1:+5FbKNTe5Z9aspU88DPIKJ9z2KZoaGCu6Sr6kKR/5mU=
|
||||||
github.com/pkg/sftp v1.13.10/go.mod h1:bJ1a7uDhrX/4OII+agvy28lzRvQrmIQuaHrcI1HbeGA=
|
github.com/pkg/sftp v1.13.10/go.mod h1:bJ1a7uDhrX/4OII+agvy28lzRvQrmIQuaHrcI1HbeGA=
|
||||||
|
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 h1:KRzFb2m7YtdldCEkzs6KqmJw4nqEVZGK7IN2kJkjTuQ=
|
||||||
|
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2/go.mod h1:JXeL+ps8p7/KNMjDQk3TCwPpBy0wYklyWTfbkIzdIFU=
|
||||||
github.com/yuin/goldmark v1.8.2 h1:kEGpgqJXdgbkhcOgBxkC0X0PmoPG1ZyoZ117rDVp4zE=
|
github.com/yuin/goldmark v1.8.2 h1:kEGpgqJXdgbkhcOgBxkC0X0PmoPG1ZyoZ117rDVp4zE=
|
||||||
github.com/yuin/goldmark v1.8.2/go.mod h1:ip/1k0VRfGynBgxOz0yCqHrbZXhcjxyuS66Brc7iBKg=
|
github.com/yuin/goldmark v1.8.2/go.mod h1:ip/1k0VRfGynBgxOz0yCqHrbZXhcjxyuS66Brc7iBKg=
|
||||||
golang.org/x/crypto v0.52.0 h1:RMs7fP2rXdep0CftQlK8Uf+kibLm7qkCcradZWYz988=
|
golang.org/x/crypto v0.52.0 h1:RMs7fP2rXdep0CftQlK8Uf+kibLm7qkCcradZWYz988=
|
||||||
golang.org/x/crypto v0.52.0/go.mod h1:1QgfPxDqh0T2M/elOJtp9RvuR95kVjir0e6/BvEmGbc=
|
golang.org/x/crypto v0.52.0/go.mod h1:1QgfPxDqh0T2M/elOJtp9RvuR95kVjir0e6/BvEmGbc=
|
||||||
golang.org/x/sys v0.45.0 h1:dO4czNzziLiiXplLQgBCEpCvXQ3dnkn0SdaZSYdQ+FY=
|
golang.org/x/sys v0.45.0 h1:dO4czNzziLiiXplLQgBCEpCvXQ3dnkn0SdaZSYdQ+FY=
|
||||||
golang.org/x/sys v0.45.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
golang.org/x/sys v0.45.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||||
|
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
|
||||||
|
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||||
|
|||||||
319
internal/adapters/promptkit/adapter.go
Normal file
319
internal/adapters/promptkit/adapter.go
Normal file
@@ -0,0 +1,319 @@
|
|||||||
|
// Package promptkitadapter implements promptexec with Promptkit.
|
||||||
|
package promptkitadapter
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
promptkit "gitea.maximumdirect.net/eric/promptkit"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/promptassets"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/promptexec"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Config selects the Promptkit sources and optional local backend for one engine.
|
||||||
|
type Config struct {
|
||||||
|
ProfileDirectory string
|
||||||
|
ProfileFile string
|
||||||
|
LocalEndpoint string
|
||||||
|
LocalConcurrencyLimit int
|
||||||
|
Timeout time.Duration
|
||||||
|
}
|
||||||
|
|
||||||
|
// Adapter owns one Promptkit engine and its opaque prepared execution handles.
|
||||||
|
type Adapter struct {
|
||||||
|
engine *promptkit.Engine
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ promptexec.Executor = (*Adapter)(nil)
|
||||||
|
|
||||||
|
// New constructs a Promptkit-backed executor from Weatherreporter-owned settings.
|
||||||
|
func New(config Config) (*Adapter, error) {
|
||||||
|
return newAdapter(config)
|
||||||
|
}
|
||||||
|
|
||||||
|
func newAdapter(config Config, additionalOptions ...promptkit.Option) (*Adapter, error) {
|
||||||
|
if config.ProfileDirectory != "" && config.ProfileFile != "" {
|
||||||
|
return nil, promptexec.NewError(promptexec.InvalidConfiguration, "profile directory and profile file cannot both be configured", nil)
|
||||||
|
}
|
||||||
|
if config.LocalEndpoint == "" && config.LocalConcurrencyLimit != 0 {
|
||||||
|
return nil, promptexec.NewError(promptexec.InvalidConfiguration, "local concurrency requires a local endpoint", nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
options := []promptkit.Option{
|
||||||
|
promptkit.WithPromptFS(promptassets.PromptFS(), "."),
|
||||||
|
promptkit.WithSchemaFS(promptassets.SchemaFS(), "."),
|
||||||
|
promptkit.WithFallbackProfileFS(promptassets.ProfileFS(), "."),
|
||||||
|
}
|
||||||
|
if config.ProfileFile != "" {
|
||||||
|
options = append(options, promptkit.WithProfileFile(config.ProfileFile))
|
||||||
|
}
|
||||||
|
if config.LocalEndpoint != "" {
|
||||||
|
options = append(options, promptkit.WithBackend(promptkit.LocalBackend(config.LocalEndpoint, config.LocalConcurrencyLimit)))
|
||||||
|
}
|
||||||
|
options = append(options, additionalOptions...)
|
||||||
|
engine, err := promptkit.NewEngine(promptkit.Config{
|
||||||
|
ProfileDir: config.ProfileDirectory,
|
||||||
|
Timeout: config.Timeout,
|
||||||
|
}, options...)
|
||||||
|
if err != nil {
|
||||||
|
return nil, classifyConfigurationError(err)
|
||||||
|
}
|
||||||
|
return &Adapter{engine: engine}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func newAdapterForTest(config Config, client promptkit.LLMClient) (*Adapter, error) {
|
||||||
|
return newAdapter(config, promptkit.WithLLMClient(client))
|
||||||
|
}
|
||||||
|
|
||||||
|
// InspectPrompt maps an exact Promptkit prompt inspection into project-owned values.
|
||||||
|
func (adapter *Adapter) InspectPrompt(ctx context.Context, promptID string, promptVersion string) (promptexec.PromptInspection, error) {
|
||||||
|
if adapter == nil || adapter.engine == nil {
|
||||||
|
return promptexec.PromptInspection{}, promptexec.NewError(promptexec.InvalidConfiguration, "prompt executor is not configured", nil)
|
||||||
|
}
|
||||||
|
inspection, err := adapter.engine.InspectPrompt(ctx, promptID, promptVersion)
|
||||||
|
if err != nil {
|
||||||
|
return promptexec.PromptInspection{}, classifyError(err)
|
||||||
|
}
|
||||||
|
inputs := make([]promptexec.InputDefinition, len(inspection.Inputs))
|
||||||
|
for index, input := range inspection.Inputs {
|
||||||
|
inputs[index] = promptexec.InputDefinition{
|
||||||
|
Name: input.Name,
|
||||||
|
Required: input.Required,
|
||||||
|
ContentType: input.ContentType,
|
||||||
|
Description: input.Description,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return promptexec.PromptInspection{
|
||||||
|
PromptID: inspection.PromptID,
|
||||||
|
PromptVersion: inspection.PromptVersion,
|
||||||
|
PromptHash: inspection.PromptHash,
|
||||||
|
DefaultProfileID: inspection.DefaultProfileID,
|
||||||
|
Inputs: inputs,
|
||||||
|
Output: outputContract(inspection.OutputContract),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// InspectProfile maps one explicit Promptkit profile inspection into safe values.
|
||||||
|
func (adapter *Adapter) InspectProfile(ctx context.Context, profileID string) (promptexec.ProfileInspection, error) {
|
||||||
|
if adapter == nil || adapter.engine == nil {
|
||||||
|
return promptexec.ProfileInspection{}, promptexec.NewError(promptexec.InvalidConfiguration, "prompt executor is not configured", nil)
|
||||||
|
}
|
||||||
|
inspection, err := adapter.engine.InspectProfile(ctx, profileID)
|
||||||
|
if err != nil {
|
||||||
|
return promptexec.ProfileInspection{}, classifyError(err)
|
||||||
|
}
|
||||||
|
return promptexec.ProfileInspection{
|
||||||
|
ProfileID: inspection.ProfileID,
|
||||||
|
BackendID: inspection.EffectiveModelParams.BackendID,
|
||||||
|
ModelName: inspection.EffectiveModelParams.Model,
|
||||||
|
CredentialRequired: inspection.APIKeyRequired,
|
||||||
|
APIKeyEnv: inspection.EffectiveModelParams.APIKeyEnv,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Execute prepares one exact inline data package, invokes prepared after a
|
||||||
|
// successful preparation, and then runs the same opaque prepared handle.
|
||||||
|
func (adapter *Adapter) Execute(ctx context.Context, request promptexec.ExecuteRequest, preparedCallback promptexec.PreparationCallback) (*promptexec.Execution, error) {
|
||||||
|
if adapter == nil || adapter.engine == nil {
|
||||||
|
return nil, promptexec.NewError(promptexec.InvalidConfiguration, "prompt executor is not configured", nil)
|
||||||
|
}
|
||||||
|
prepared, err := adapter.engine.PrepareExecution(ctx, promptkit.RunRequest{
|
||||||
|
PromptID: request.PromptID,
|
||||||
|
PromptVersion: request.PromptVersion,
|
||||||
|
ProfileID: request.ProfileID,
|
||||||
|
Inputs: map[string]promptkit.ArtifactRef{"data_package": promptkit.Inline(string(append([]byte(nil), request.DataPackage...)))},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return nil, classifyError(err)
|
||||||
|
}
|
||||||
|
defer prepared.Discard()
|
||||||
|
|
||||||
|
details := prepared.Details()
|
||||||
|
preparation, debug := preparationValues(details, request.CaptureDebug)
|
||||||
|
if preparedCallback != nil {
|
||||||
|
if err := preparedCallback(preparation, debug); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
result, err := adapter.engine.RunPrepared(ctx, prepared)
|
||||||
|
if err != nil {
|
||||||
|
return nil, classifyError(err)
|
||||||
|
}
|
||||||
|
return executionValue(result, request.CaptureDebug), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func outputContract(value promptkit.OutputContract) promptexec.OutputContract {
|
||||||
|
return promptexec.OutputContract{
|
||||||
|
Format: string(value.Format),
|
||||||
|
ValidationMode: string(value.ValidationMode),
|
||||||
|
SchemaPath: value.SchemaPath,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func preparationValues(value promptkit.PreparedRun, captureDebug bool) (promptexec.Preparation, *promptexec.PreparationDebug) {
|
||||||
|
preparation := promptexec.Preparation{
|
||||||
|
PromptID: value.PromptID,
|
||||||
|
PromptVersion: value.PromptVersion,
|
||||||
|
PromptHash: value.PromptHash,
|
||||||
|
RenderedPromptHash: value.RenderedPromptHash,
|
||||||
|
InputHashes: copyInputHashes(value.InputHashes),
|
||||||
|
ProfileID: value.SelectedProfileID,
|
||||||
|
BackendID: value.SelectedBackendID,
|
||||||
|
ModelName: value.EffectiveModelParams.Model,
|
||||||
|
Output: outputContract(value.OutputContract),
|
||||||
|
StartedAt: value.StartTime,
|
||||||
|
EndedAt: value.EndTime,
|
||||||
|
Duration: time.Duration(value.DurationMS) * time.Millisecond,
|
||||||
|
}
|
||||||
|
if !captureDebug {
|
||||||
|
return preparation, nil
|
||||||
|
}
|
||||||
|
debug := &promptexec.PreparationDebug{
|
||||||
|
RenderedMessages: renderedMessages(value.Messages),
|
||||||
|
Endpoint: value.EffectiveModelParams.Endpoint,
|
||||||
|
ParametersJSON: marshalDebugParameters(value.EffectiveModelParams),
|
||||||
|
}
|
||||||
|
if value.StructuredOutput != nil && value.StructuredOutput.JSONSchema != nil {
|
||||||
|
debug.StructuredSchema, _ = json.Marshal(value.StructuredOutput.JSONSchema.Schema)
|
||||||
|
}
|
||||||
|
return preparation, debug
|
||||||
|
}
|
||||||
|
|
||||||
|
func executionValue(value *promptkit.RunResult, captureDebug bool) *promptexec.Execution {
|
||||||
|
if value == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
validation := promptexec.NewValidation(
|
||||||
|
promptexec.ValidationStatus(value.Validation.Status),
|
||||||
|
string(value.Validation.Mode),
|
||||||
|
value.Validation.SchemaPath,
|
||||||
|
value.Validation.Errors,
|
||||||
|
)
|
||||||
|
execution := &promptexec.Execution{
|
||||||
|
RunID: value.RunID,
|
||||||
|
PromptID: value.PromptID,
|
||||||
|
PromptVersion: value.PromptVersion,
|
||||||
|
PromptHash: value.PromptHash,
|
||||||
|
RenderedPromptHash: value.RenderedPromptHash,
|
||||||
|
InputHashes: copyInputHashes(value.InputHashes),
|
||||||
|
ProfileID: value.SelectedProfileID,
|
||||||
|
BackendID: value.SelectedBackendID,
|
||||||
|
ModelName: value.ModelName,
|
||||||
|
GeneratedHash: value.Artifact.Hash,
|
||||||
|
Usage: promptexec.TokenUsage{
|
||||||
|
PromptTokens: value.Usage.PromptTokens,
|
||||||
|
CompletionTokens: value.Usage.CompletionTokens,
|
||||||
|
TotalTokens: value.Usage.TotalTokens,
|
||||||
|
CachedTokens: value.Usage.CachedTokens,
|
||||||
|
CacheWriteTokens: value.Usage.CacheWriteTokens,
|
||||||
|
},
|
||||||
|
StartedAt: value.StartTime,
|
||||||
|
EndedAt: value.EndTime,
|
||||||
|
Duration: value.Duration,
|
||||||
|
Validation: validation,
|
||||||
|
RawOutput: []byte(value.RawOutput),
|
||||||
|
}
|
||||||
|
if captureDebug {
|
||||||
|
execution.Debug = &promptexec.ExecutionDebug{
|
||||||
|
RawOutput: append([]byte(nil), value.RawOutput...),
|
||||||
|
ValidationDiagnostics: append([]string(nil), validation.Diagnostics...),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return execution
|
||||||
|
}
|
||||||
|
|
||||||
|
func renderedMessages(values []promptkit.RenderedMessage) []promptexec.RenderedMessage {
|
||||||
|
messages := make([]promptexec.RenderedMessage, len(values))
|
||||||
|
for index, value := range values {
|
||||||
|
messages[index] = promptexec.RenderedMessage{Role: value.Role, Content: value.Content}
|
||||||
|
}
|
||||||
|
return messages
|
||||||
|
}
|
||||||
|
|
||||||
|
func copyInputHashes(values map[string]string) map[string]string {
|
||||||
|
if values == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
copy := make(map[string]string, len(values))
|
||||||
|
for key, value := range values {
|
||||||
|
copy[key] = value
|
||||||
|
}
|
||||||
|
return copy
|
||||||
|
}
|
||||||
|
|
||||||
|
func marshalDebugParameters(value promptkit.ExecutionTarget) []byte {
|
||||||
|
parameters := struct {
|
||||||
|
Temperature float64 `json:"temperature"`
|
||||||
|
MaxTokens int `json:"max_tokens"`
|
||||||
|
TopP float64 `json:"top_p"`
|
||||||
|
TimeoutSeconds int `json:"timeout_seconds"`
|
||||||
|
ServiceTier string `json:"service_tier"`
|
||||||
|
ReasoningEffort string `json:"reasoning_effort"`
|
||||||
|
ExtraParams map[string]any `json:"extra_params"`
|
||||||
|
}{
|
||||||
|
Temperature: value.Temperature,
|
||||||
|
MaxTokens: value.MaxTokens,
|
||||||
|
TopP: value.TopP,
|
||||||
|
TimeoutSeconds: value.TimeoutSeconds,
|
||||||
|
ServiceTier: value.ServiceTier,
|
||||||
|
ReasoningEffort: value.ReasoningEffort,
|
||||||
|
ExtraParams: value.ExtraParams,
|
||||||
|
}
|
||||||
|
data, _ := json.Marshal(parameters)
|
||||||
|
return data
|
||||||
|
}
|
||||||
|
|
||||||
|
func classifyConfigurationError(err error) error {
|
||||||
|
if err == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return promptexec.NewError(promptexec.InvalidConfiguration, "prompt executor configuration is invalid", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func classifyError(err error) error {
|
||||||
|
if err == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if errors.Is(err, context.Canceled) {
|
||||||
|
return promptexec.NewError(promptexec.Canceled, "prompt operation was canceled", err)
|
||||||
|
}
|
||||||
|
if errors.Is(err, context.DeadlineExceeded) {
|
||||||
|
return promptexec.NewError(promptexec.DeadlineExceeded, "prompt operation exceeded its deadline", err)
|
||||||
|
}
|
||||||
|
var capacityError *promptkit.CapacityError
|
||||||
|
if errors.As(err, &capacityError) {
|
||||||
|
return promptexec.NewCapacityError(capacityError.BackendID, "prompt backend capacity is unavailable", err)
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case errors.Is(err, promptkit.ErrInvalidConfig):
|
||||||
|
return promptexec.NewError(promptexec.InvalidConfiguration, "prompt executor configuration is invalid", err)
|
||||||
|
case errors.Is(err, promptkit.ErrPromptNotFound):
|
||||||
|
return promptexec.NewError(promptexec.PromptNotFound, "prompt definition was not found", err)
|
||||||
|
case errors.Is(err, promptkit.ErrPromptLoad):
|
||||||
|
return promptexec.NewError(promptexec.PromptLoad, "prompt definition could not be loaded", err)
|
||||||
|
case errors.Is(err, promptkit.ErrProfileNotFound):
|
||||||
|
return promptexec.NewError(promptexec.ProfileNotFound, "execution profile was not found", err)
|
||||||
|
case errors.Is(err, promptkit.ErrProfileLoad):
|
||||||
|
return promptexec.NewError(promptexec.ProfileLoad, "execution profile could not be loaded", err)
|
||||||
|
case errors.Is(err, promptkit.ErrAPIKeyEnvMissing):
|
||||||
|
return promptexec.NewError(promptexec.MissingCredential, "execution credential is unavailable", err)
|
||||||
|
case errors.Is(err, promptkit.ErrArtifactLoad):
|
||||||
|
return promptexec.NewError(promptexec.ArtifactLoad, "prompt input could not be loaded", err)
|
||||||
|
case errors.Is(err, promptkit.ErrPromptRender):
|
||||||
|
return promptexec.NewError(promptexec.PromptRender, "prompt could not be rendered", err)
|
||||||
|
case errors.Is(err, promptkit.ErrCapacityExceeded):
|
||||||
|
return promptexec.NewCapacityError("", "prompt backend capacity is unavailable", err)
|
||||||
|
case errors.Is(err, promptkit.ErrLLMGenerate):
|
||||||
|
return promptexec.NewError(promptexec.Generation, "prompt generation failed", err)
|
||||||
|
case errors.Is(err, promptkit.ErrValidation):
|
||||||
|
return promptexec.NewError(promptexec.OperationalValidation, "prompt output validation could not be completed", err)
|
||||||
|
case errors.Is(err, promptkit.ErrInvalidRequest), errors.Is(err, promptkit.ErrProfileRequired):
|
||||||
|
return promptexec.NewError(promptexec.InvalidRequest, "prompt execution request is invalid", err)
|
||||||
|
default:
|
||||||
|
return promptexec.NewError(promptexec.Generation, "prompt operation failed", fmt.Errorf("%w", err))
|
||||||
|
}
|
||||||
|
}
|
||||||
548
internal/adapters/promptkit/adapter_test.go
Normal file
548
internal/adapters/promptkit/adapter_test.go
Normal file
@@ -0,0 +1,548 @@
|
|||||||
|
package promptkitadapter
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
promptkit "gitea.maximumdirect.net/eric/promptkit"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/promptexec"
|
||||||
|
)
|
||||||
|
|
||||||
|
type fakeClient struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
response *promptkit.GenerateResponse
|
||||||
|
err error
|
||||||
|
calls int
|
||||||
|
requests []promptkit.GenerateRequest
|
||||||
|
block bool
|
||||||
|
}
|
||||||
|
|
||||||
|
type recordingReader struct {
|
||||||
|
ref promptkit.ArtifactRef
|
||||||
|
}
|
||||||
|
|
||||||
|
func (reader *recordingReader) Read(_ context.Context, ref promptkit.ArtifactRef) (*promptkit.Artifact, error) {
|
||||||
|
reader.ref = ref
|
||||||
|
return &promptkit.Artifact{
|
||||||
|
Name: "data_package",
|
||||||
|
ContentType: "application/yaml",
|
||||||
|
Body: []byte(ref.Body),
|
||||||
|
URI: ref.URI,
|
||||||
|
Hash: "input-hash",
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (client *fakeClient) Generate(ctx context.Context, request promptkit.GenerateRequest) (*promptkit.GenerateResponse, error) {
|
||||||
|
client.mu.Lock()
|
||||||
|
client.calls++
|
||||||
|
client.requests = append(client.requests, request)
|
||||||
|
block := client.block
|
||||||
|
response := client.response
|
||||||
|
err := client.err
|
||||||
|
client.mu.Unlock()
|
||||||
|
if block {
|
||||||
|
<-ctx.Done()
|
||||||
|
return nil, ctx.Err()
|
||||||
|
}
|
||||||
|
return response, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (client *fakeClient) callCount() int {
|
||||||
|
client.mu.Lock()
|
||||||
|
defer client.mu.Unlock()
|
||||||
|
return client.calls
|
||||||
|
}
|
||||||
|
|
||||||
|
func (client *fakeClient) request() promptkit.GenerateRequest {
|
||||||
|
client.mu.Lock()
|
||||||
|
defer client.mu.Unlock()
|
||||||
|
return client.requests[0]
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInspectPromptAndProfile(t *testing.T) {
|
||||||
|
adapter := newTestAdapter(t, &fakeClient{})
|
||||||
|
inspection, err := adapter.InspectPrompt(context.Background(), "weather.daily_generated_text", "2.0.0")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("InspectPrompt() error = %v", err)
|
||||||
|
}
|
||||||
|
if inspection.PromptID != "weather.daily_generated_text" || inspection.PromptVersion != "2.0.0" || inspection.DefaultProfileID != "weather-balanced" {
|
||||||
|
t.Fatalf("inspection = %#v", inspection)
|
||||||
|
}
|
||||||
|
if len(inspection.Inputs) != 1 || inspection.Inputs[0].Name != "data_package" || !inspection.Inputs[0].Required || inspection.Inputs[0].ContentType != "application/yaml" {
|
||||||
|
t.Fatalf("inputs = %#v", inspection.Inputs)
|
||||||
|
}
|
||||||
|
if inspection.Output.Format != "json" || inspection.Output.ValidationMode != "json_schema" || inspection.Output.SchemaPath != "daily.generated_text.schema.json" {
|
||||||
|
t.Fatalf("output = %#v", inspection.Output)
|
||||||
|
}
|
||||||
|
|
||||||
|
profile, err := adapter.InspectProfile(context.Background(), "test-profile")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("InspectProfile() error = %v", err)
|
||||||
|
}
|
||||||
|
if profile.ProfileID != "test-profile" || profile.BackendID != "" || profile.ModelName != "test-model" || profile.CredentialRequired {
|
||||||
|
t.Fatalf("profile = %#v", profile)
|
||||||
|
}
|
||||||
|
if strings.Contains(fmt.Sprintf("%#v", profile), "https://profile.example") {
|
||||||
|
t.Fatalf("profile leaks endpoint: %#v", profile)
|
||||||
|
}
|
||||||
|
|
||||||
|
builtin, err := adapter.InspectProfile(context.Background(), "gemini-flash-latest")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("InspectProfile(builtin) error = %v", err)
|
||||||
|
}
|
||||||
|
if builtin.ProfileID != "gemini-flash-latest" || builtin.ModelName == "" {
|
||||||
|
t.Fatalf("builtin profile = %#v", builtin)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEmbeddedProfilesAreAvailableToProductionAndTestAdapters(t *testing.T) {
|
||||||
|
adapter, err := New(Config{})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("New() error = %v", err)
|
||||||
|
}
|
||||||
|
for _, want := range []struct {
|
||||||
|
id string
|
||||||
|
backend string
|
||||||
|
model string
|
||||||
|
}{
|
||||||
|
{"weather-light", "openrouter", "deepseek/deepseek-v4-flash"},
|
||||||
|
{"weather-balanced", "openrouter", "~google/gemini-flash-latest"},
|
||||||
|
{"weather-deep", "openrouter", "~anthropic/claude-sonnet-latest"},
|
||||||
|
} {
|
||||||
|
t.Run(want.id, func(t *testing.T) {
|
||||||
|
assertProfile(t, adapter, want.id, want.backend, want.model)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
testAdapter, err := newAdapterForTest(Config{}, &fakeClient{})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("newAdapterForTest() error = %v", err)
|
||||||
|
}
|
||||||
|
assertProfile(t, testAdapter, "weather-light", "openrouter", "deepseek/deepseek-v4-flash")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfiguredProfilesOverrideEmbeddedFallbacks(t *testing.T) {
|
||||||
|
file := writeProfileFile(t, `id: weather-light
|
||||||
|
endpoint: https://local-file.example/v1
|
||||||
|
model: file-light
|
||||||
|
`)
|
||||||
|
fileAdapter, err := New(Config{ProfileFile: file})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("New(profile file) error = %v", err)
|
||||||
|
}
|
||||||
|
assertProfile(t, fileAdapter, "weather-light", "", "file-light")
|
||||||
|
|
||||||
|
directory := testProfileDirectory(t, `id: weather-light
|
||||||
|
backend: local
|
||||||
|
model: directory-light
|
||||||
|
`)
|
||||||
|
directoryAdapter, err := New(Config{ProfileDirectory: directory, LocalEndpoint: "https://local-directory.example/v1"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("New(profile directory) error = %v", err)
|
||||||
|
}
|
||||||
|
assertProfile(t, directoryAdapter, "weather-light", promptkit.BackendLocal, "directory-light")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMaintainedWeatherLightLocalProfileExampleInspectsOffline(t *testing.T) {
|
||||||
|
adapter, err := New(Config{ProfileFile: filepath.Join("..", "..", "..", "examples", "weather-light-local-profile.yml")})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("New() error = %v", err)
|
||||||
|
}
|
||||||
|
assertProfile(t, adapter, "weather-light", "", "weather-local")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProfileResolutionFallsThroughOnlyWhenTheConfiguredIDIsAbsent(t *testing.T) {
|
||||||
|
absentAdapter, err := New(Config{ProfileDirectory: testProfileDirectory(t, `id: other-profile
|
||||||
|
backend: openrouter
|
||||||
|
model: other-model
|
||||||
|
`)})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("New(absent profile) error = %v", err)
|
||||||
|
}
|
||||||
|
assertProfile(t, absentAdapter, "weather-light", "openrouter", "deepseek/deepseek-v4-flash")
|
||||||
|
|
||||||
|
malformedAdapter, err := New(Config{ProfileDirectory: testProfileDirectory(t, `id: weather-light
|
||||||
|
backend: openrouter
|
||||||
|
`)})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("New(malformed profile) error = %v", err)
|
||||||
|
}
|
||||||
|
if _, err := malformedAdapter.InspectProfile(context.Background(), "weather-light"); err == nil {
|
||||||
|
t.Fatal("InspectProfile() error = nil, want malformed configured profile error")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProfileResolutionPreservesBuiltInAndExplicitPrecedence(t *testing.T) {
|
||||||
|
adapter, err := New(Config{})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("New() error = %v", err)
|
||||||
|
}
|
||||||
|
builtin, err := adapter.InspectProfile(context.Background(), "gemini-flash-latest")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("InspectProfile(builtin) error = %v", err)
|
||||||
|
}
|
||||||
|
if builtin.ProfileID != "gemini-flash-latest" || builtin.BackendID != "openrouter" || builtin.ModelName == "" {
|
||||||
|
t.Fatalf("builtin profile = %#v", builtin)
|
||||||
|
}
|
||||||
|
|
||||||
|
explicit, err := newAdapter(Config{}, promptkit.WithProfiles(promptkit.Profile{
|
||||||
|
ID: "weather-light",
|
||||||
|
Endpoint: "https://explicit.example/v1",
|
||||||
|
Model: "explicit-light",
|
||||||
|
}))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("newAdapter(explicit profile) error = %v", err)
|
||||||
|
}
|
||||||
|
assertProfile(t, explicit, "weather-light", "", "explicit-light")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecuteUsesPreparedInlineDataPackage(t *testing.T) {
|
||||||
|
client := &fakeClient{response: validResponse()}
|
||||||
|
adapter := newTestAdapter(t, client)
|
||||||
|
request := testExecuteRequest()
|
||||||
|
callbackCalls := 0
|
||||||
|
result, err := adapter.Execute(context.Background(), request, func(preparation promptexec.Preparation, debug *promptexec.PreparationDebug) error {
|
||||||
|
callbackCalls++
|
||||||
|
if preparation.PromptID != request.PromptID || preparation.PromptVersion != request.PromptVersion || preparation.ModelName != "test-model" {
|
||||||
|
t.Fatalf("preparation = %#v", preparation)
|
||||||
|
}
|
||||||
|
if debug != nil {
|
||||||
|
t.Fatalf("debug = %#v, want nil", debug)
|
||||||
|
}
|
||||||
|
if client.callCount() != 0 {
|
||||||
|
t.Fatal("provider called before preparation callback")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Execute() error = %v", err)
|
||||||
|
}
|
||||||
|
if callbackCalls != 1 || client.callCount() != 1 {
|
||||||
|
t.Fatalf("callback/provider calls = %d/%d, want 1/1", callbackCalls, client.callCount())
|
||||||
|
}
|
||||||
|
if result == nil || result.Validation.Status != promptexec.ValidationPassed || string(result.RawOutput) != client.response.Content {
|
||||||
|
t.Fatalf("result = %#v", result)
|
||||||
|
}
|
||||||
|
if result.Debug != nil {
|
||||||
|
t.Fatalf("debug = %#v, want nil", result.Debug)
|
||||||
|
}
|
||||||
|
providerRequest := client.request()
|
||||||
|
if providerRequest.Target.Model != "test-model" || providerRequest.Target.Endpoint != "https://profile.example/v1" {
|
||||||
|
t.Fatalf("provider target = %#v", providerRequest.Target)
|
||||||
|
}
|
||||||
|
if len(providerRequest.Prompt.Messages) == 0 || !strings.Contains(providerRequest.Prompt.Messages[2].Content, string(request.DataPackage)) {
|
||||||
|
t.Fatalf("rendered messages do not contain exact data package: %#v", providerRequest.Prompt.Messages)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecuteEmbeddedHourlyProfileThroughPreparedPath(t *testing.T) {
|
||||||
|
t.Setenv("OPENROUTER_API_KEY", "test-openrouter-key")
|
||||||
|
client := &fakeClient{response: hourlyValidResponse()}
|
||||||
|
adapter, err := newAdapter(Config{}, promptkit.WithLLMClient(client))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("newAdapter() error = %v", err)
|
||||||
|
}
|
||||||
|
request := promptexec.ExecuteRequest{
|
||||||
|
PromptID: "weather.hourly_generated_text",
|
||||||
|
PromptVersion: "2.0.0",
|
||||||
|
ProfileID: "weather-light",
|
||||||
|
DataPackage: []byte("report:\n id: hourly\nbriefing: {}\n"),
|
||||||
|
}
|
||||||
|
var preparation promptexec.Preparation
|
||||||
|
prepared := false
|
||||||
|
result, err := adapter.Execute(context.Background(), request, func(value promptexec.Preparation, _ *promptexec.PreparationDebug) error {
|
||||||
|
if client.callCount() != 0 {
|
||||||
|
t.Fatal("provider was called before preparation completed")
|
||||||
|
}
|
||||||
|
preparation = value
|
||||||
|
prepared = true
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Execute() error = %v", err)
|
||||||
|
}
|
||||||
|
if !prepared || preparation.ProfileID != "weather-light" || preparation.BackendID != "openrouter" || preparation.ModelName != "deepseek/deepseek-v4-flash" {
|
||||||
|
t.Fatalf("preparation = %#v", preparation)
|
||||||
|
}
|
||||||
|
if result == nil || result.ProfileID != "weather-light" || result.BackendID != "openrouter" || result.ModelName != "deepseek/deepseek-v4-flash" || result.Validation.Status != promptexec.ValidationPassed {
|
||||||
|
t.Fatalf("execution = %#v", result)
|
||||||
|
}
|
||||||
|
if client.callCount() != 1 || client.request().Target.Model != "deepseek/deepseek-v4-flash" {
|
||||||
|
t.Fatalf("provider calls/request = %d/%#v", client.callCount(), client.request())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecuteUsesExactInlineDataPackageProvenance(t *testing.T) {
|
||||||
|
client := &fakeClient{response: validResponse()}
|
||||||
|
reader := &recordingReader{}
|
||||||
|
adapter := newTestAdapterWithOptions(t, client, promptkit.WithArtifactReader(reader))
|
||||||
|
request := testExecuteRequest()
|
||||||
|
if _, err := adapter.Execute(context.Background(), request, nil); err != nil {
|
||||||
|
t.Fatalf("Execute() error = %v", err)
|
||||||
|
}
|
||||||
|
if reader.ref.Type != promptkit.ArtifactRefInline || reader.ref.URI != "" || reader.ref.Body != string(request.DataPackage) {
|
||||||
|
t.Fatalf("artifact ref = %#v, want exact inline data package provenance", reader.ref)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecuteCapturesSensitiveDebugOnlyWhenRequested(t *testing.T) {
|
||||||
|
client := &fakeClient{response: validResponse()}
|
||||||
|
adapter := newTestAdapter(t, client)
|
||||||
|
request := testExecuteRequest()
|
||||||
|
request.CaptureDebug = true
|
||||||
|
var preparationDebug *promptexec.PreparationDebug
|
||||||
|
result, err := adapter.Execute(context.Background(), request, func(preparation promptexec.Preparation, debug *promptexec.PreparationDebug) error {
|
||||||
|
preparationDebug = debug
|
||||||
|
if strings.Contains(fmt.Sprintf("%#v", preparation), "https://profile.example") || strings.Contains(fmt.Sprintf("%#v", preparation), string(request.DataPackage)) {
|
||||||
|
t.Fatalf("safe preparation leaks sensitive content: %#v", preparation)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Execute() error = %v", err)
|
||||||
|
}
|
||||||
|
if preparationDebug == nil || preparationDebug.Endpoint != "https://profile.example/v1" || len(preparationDebug.RenderedMessages) == 0 || len(preparationDebug.StructuredSchema) == 0 || len(preparationDebug.ParametersJSON) == 0 {
|
||||||
|
t.Fatalf("preparation debug = %#v", preparationDebug)
|
||||||
|
}
|
||||||
|
if result.Debug == nil || string(result.Debug.RawOutput) != client.response.Content {
|
||||||
|
t.Fatalf("execution debug = %#v", result.Debug)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecuteCallbackFailurePreventsGeneration(t *testing.T) {
|
||||||
|
client := &fakeClient{response: validResponse()}
|
||||||
|
adapter := newTestAdapter(t, client)
|
||||||
|
callbackError := errors.New("save preparation")
|
||||||
|
result, err := adapter.Execute(context.Background(), testExecuteRequest(), func(promptexec.Preparation, *promptexec.PreparationDebug) error {
|
||||||
|
return callbackError
|
||||||
|
})
|
||||||
|
if result != nil || !errors.Is(err, callbackError) || client.callCount() != 0 {
|
||||||
|
t.Fatalf("result/error/provider calls = %#v/%v/%d", result, err, client.callCount())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecuteReturnsCompletedValidationRejection(t *testing.T) {
|
||||||
|
client := &fakeClient{response: &promptkit.GenerateResponse{Content: `{"summary":42}`, Usage: promptkit.TokenUsage{TotalTokens: 5}}}
|
||||||
|
adapter := newTestAdapter(t, client)
|
||||||
|
result, err := adapter.Execute(context.Background(), testExecuteRequest(), nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Execute() error = %v", err)
|
||||||
|
}
|
||||||
|
if result == nil || result.Validation.Status != promptexec.ValidationFailed || len(result.Validation.Diagnostics) == 0 || string(result.RawOutput) != client.response.Content {
|
||||||
|
t.Fatalf("result = %#v", result)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecuteClassifiesOperationalFailures(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
client *fakeClient
|
||||||
|
context func() (context.Context, context.CancelFunc)
|
||||||
|
category promptexec.ErrorCategory
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "generation",
|
||||||
|
client: &fakeClient{err: errors.New("provider response body")},
|
||||||
|
context: func() (context.Context, context.CancelFunc) {
|
||||||
|
return context.WithCancel(context.Background())
|
||||||
|
},
|
||||||
|
category: promptexec.Generation,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "canceled",
|
||||||
|
client: &fakeClient{block: true},
|
||||||
|
context: func() (context.Context, context.CancelFunc) {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
return ctx, func() {}
|
||||||
|
},
|
||||||
|
category: promptexec.Canceled,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "deadline",
|
||||||
|
client: &fakeClient{block: true},
|
||||||
|
context: func() (context.Context, context.CancelFunc) {
|
||||||
|
return context.WithTimeout(context.Background(), time.Nanosecond)
|
||||||
|
},
|
||||||
|
category: promptexec.DeadlineExceeded,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, test := range tests {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
adapter := newTestAdapter(t, test.client)
|
||||||
|
ctx, cancel := test.context()
|
||||||
|
defer cancel()
|
||||||
|
result, err := adapter.Execute(ctx, testExecuteRequest(), nil)
|
||||||
|
if result != nil || err == nil || promptexec.CategoryOf(err) != test.category {
|
||||||
|
t.Fatalf("result/error/category = %#v/%v/%q, want %q", result, err, promptexec.CategoryOf(err), test.category)
|
||||||
|
}
|
||||||
|
if strings.Contains(err.Error(), "provider response body") {
|
||||||
|
t.Fatalf("error leaks provider detail: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestClassifyPromptkitErrors(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
err error
|
||||||
|
category promptexec.ErrorCategory
|
||||||
|
}{
|
||||||
|
{promptkit.ErrInvalidConfig, promptexec.InvalidConfiguration},
|
||||||
|
{promptkit.ErrInvalidRequest, promptexec.InvalidRequest},
|
||||||
|
{promptkit.ErrPromptNotFound, promptexec.PromptNotFound},
|
||||||
|
{promptkit.ErrPromptLoad, promptexec.PromptLoad},
|
||||||
|
{promptkit.ErrProfileNotFound, promptexec.ProfileNotFound},
|
||||||
|
{promptkit.ErrProfileLoad, promptexec.ProfileLoad},
|
||||||
|
{promptkit.ErrAPIKeyEnvMissing, promptexec.MissingCredential},
|
||||||
|
{promptkit.ErrArtifactLoad, promptexec.ArtifactLoad},
|
||||||
|
{promptkit.ErrPromptRender, promptexec.PromptRender},
|
||||||
|
{promptkit.ErrLLMGenerate, promptexec.Generation},
|
||||||
|
{promptkit.ErrValidation, promptexec.OperationalValidation},
|
||||||
|
{&promptkit.CapacityError{BackendID: "local"}, promptexec.Capacity},
|
||||||
|
}
|
||||||
|
for _, test := range tests {
|
||||||
|
t.Run(string(test.category), func(t *testing.T) {
|
||||||
|
got := classifyError(test.err)
|
||||||
|
if promptexec.CategoryOf(got) != test.category {
|
||||||
|
t.Fatalf("category = %q, want %q", promptexec.CategoryOf(got), test.category)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewValidatesConfiguration(t *testing.T) {
|
||||||
|
if _, err := New(Config{ProfileDirectory: "profiles", ProfileFile: "profile.yml"}); promptexec.CategoryOf(err) != promptexec.InvalidConfiguration {
|
||||||
|
t.Fatalf("profile source error = %v", err)
|
||||||
|
}
|
||||||
|
if _, err := New(Config{LocalConcurrencyLimit: 1}); promptexec.CategoryOf(err) != promptexec.InvalidConfiguration {
|
||||||
|
t.Fatalf("local concurrency error = %v", err)
|
||||||
|
}
|
||||||
|
if _, err := New(Config{LocalEndpoint: "not a URL"}); promptexec.CategoryOf(err) != promptexec.InvalidConfiguration {
|
||||||
|
t.Fatalf("local endpoint error = %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLocalBackendAndMissingCredentialBehavior(t *testing.T) {
|
||||||
|
profiles := testProfileDirectory(t, `id: local-profile
|
||||||
|
backend: local
|
||||||
|
model: local-model
|
||||||
|
`)
|
||||||
|
adapter, err := newAdapterForTest(Config{
|
||||||
|
ProfileDirectory: profiles,
|
||||||
|
LocalEndpoint: "https://local.example/v1",
|
||||||
|
LocalConcurrencyLimit: 1,
|
||||||
|
}, &fakeClient{})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("newAdapterForTest(local) error = %v", err)
|
||||||
|
}
|
||||||
|
profile, err := adapter.InspectProfile(context.Background(), "local-profile")
|
||||||
|
if err != nil || profile.BackendID != promptkit.BackendLocal || profile.ModelName != "local-model" {
|
||||||
|
t.Fatalf("local profile/error = %#v/%v", profile, err)
|
||||||
|
}
|
||||||
|
if got := classifyError(&promptkit.CapacityError{BackendID: promptkit.BackendLocal}); promptexec.CategoryOf(got) != promptexec.Capacity {
|
||||||
|
t.Fatalf("capacity classification = %v", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
credentialProfiles := testProfileDirectory(t, `id: credential-profile
|
||||||
|
endpoint: https://profile.example/v1
|
||||||
|
model: test-model
|
||||||
|
api_key_env: WEATHERREPORTER_TEST_MISSING_KEY
|
||||||
|
`)
|
||||||
|
client := &fakeClient{response: validResponse()}
|
||||||
|
credentialAdapter, err := newAdapterForTest(Config{ProfileDirectory: credentialProfiles}, client)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("newAdapterForTest(credential) error = %v", err)
|
||||||
|
}
|
||||||
|
credentialProfile, err := credentialAdapter.InspectProfile(context.Background(), "credential-profile")
|
||||||
|
if err != nil || credentialProfile.CredentialRequired || credentialProfile.APIKeyEnv != "WEATHERREPORTER_TEST_MISSING_KEY" {
|
||||||
|
t.Fatalf("credential profile/error = %#v/%v", credentialProfile, err)
|
||||||
|
}
|
||||||
|
request := testExecuteRequest()
|
||||||
|
request.ProfileID = "credential-profile"
|
||||||
|
result, err := credentialAdapter.Execute(context.Background(), request, nil)
|
||||||
|
if result != nil || promptexec.CategoryOf(err) != promptexec.MissingCredential || client.callCount() != 0 {
|
||||||
|
t.Fatalf("credential result/category/calls = %#v/%q/%d", result, promptexec.CategoryOf(err), client.callCount())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func newTestAdapter(t *testing.T, client promptkit.LLMClient) *Adapter {
|
||||||
|
return newTestAdapterWithOptions(t, client)
|
||||||
|
}
|
||||||
|
|
||||||
|
func assertProfile(t *testing.T, adapter *Adapter, id string, backend string, model string) {
|
||||||
|
t.Helper()
|
||||||
|
profile, err := adapter.InspectProfile(context.Background(), id)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("InspectProfile(%q) error = %v", id, err)
|
||||||
|
}
|
||||||
|
if profile.ProfileID != id || profile.BackendID != backend || profile.ModelName != model {
|
||||||
|
t.Fatalf("profile = %#v, want %q with backend/model %q/%q", profile, id, backend, model)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func newTestAdapterWithOptions(t *testing.T, client promptkit.LLMClient, options ...promptkit.Option) *Adapter {
|
||||||
|
t.Helper()
|
||||||
|
profiles := testProfileDirectory(t, `id: test-profile
|
||||||
|
endpoint: https://profile.example/v1
|
||||||
|
model: test-model
|
||||||
|
temperature: 0.2
|
||||||
|
max_tokens: 300
|
||||||
|
top_p: 1
|
||||||
|
timeout_seconds: 30
|
||||||
|
`)
|
||||||
|
options = append(options, promptkit.WithLLMClient(client))
|
||||||
|
adapter, err := newAdapter(Config{ProfileDirectory: profiles, Timeout: time.Second}, options...)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("newAdapter() error = %v", err)
|
||||||
|
}
|
||||||
|
return adapter
|
||||||
|
}
|
||||||
|
|
||||||
|
func testProfileDirectory(t *testing.T, profile string) string {
|
||||||
|
t.Helper()
|
||||||
|
profiles := t.TempDir()
|
||||||
|
if err := os.WriteFile(filepath.Join(profiles, "profile.yml"), []byte(profile), 0o600); err != nil {
|
||||||
|
t.Fatalf("write profile: %v", err)
|
||||||
|
}
|
||||||
|
return profiles
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeProfileFile(t *testing.T, profile string) string {
|
||||||
|
t.Helper()
|
||||||
|
path := filepath.Join(t.TempDir(), "profile.yml")
|
||||||
|
if err := os.WriteFile(path, []byte(profile), 0o600); err != nil {
|
||||||
|
t.Fatalf("write profile: %v", err)
|
||||||
|
}
|
||||||
|
return path
|
||||||
|
}
|
||||||
|
|
||||||
|
func testExecuteRequest() promptexec.ExecuteRequest {
|
||||||
|
return promptexec.ExecuteRequest{
|
||||||
|
PromptID: "weather.daily_generated_text",
|
||||||
|
PromptVersion: "2.0.0",
|
||||||
|
ProfileID: "test-profile",
|
||||||
|
DataPackage: []byte("report:\n id: daily\nbriefing: {}\n"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func validResponse() *promptkit.GenerateResponse {
|
||||||
|
return &promptkit.GenerateResponse{
|
||||||
|
Content: `{"summary":"A quiet day is expected.","forecast_discussion":["High pressure keeps conditions settled."],"precipitation_timing":""}`,
|
||||||
|
Usage: promptkit.TokenUsage{PromptTokens: 12, CompletionTokens: 8, TotalTokens: 20},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func hourlyValidResponse() *promptkit.GenerateResponse {
|
||||||
|
return &promptkit.GenerateResponse{
|
||||||
|
Content: `{"summary":"A quiet hour is expected.","forecast_discussion":"Conditions remain settled.","precipitation_timing":""}`,
|
||||||
|
Usage: promptkit.TokenUsage{PromptTokens: 12, CompletionTokens: 8, TotalTokens: 20},
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,301 +0,0 @@
|
|||||||
// Package scriptorium adapts the external scriptorium CLI.
|
|
||||||
package scriptorium
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"os/exec"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
const maxCapturedOutputBytes = 1024 * 1024
|
|
||||||
|
|
||||||
type CommandRunner interface {
|
|
||||||
Run(ctx context.Context, name string, args []string, timeout time.Duration) (CommandResult, error)
|
|
||||||
}
|
|
||||||
|
|
||||||
type CommandResult struct {
|
|
||||||
Stdout []byte
|
|
||||||
Stderr []byte
|
|
||||||
StdoutTruncated bool
|
|
||||||
StderrTruncated bool
|
|
||||||
ExitCode int
|
|
||||||
}
|
|
||||||
|
|
||||||
type ExecRunner struct{}
|
|
||||||
|
|
||||||
func (ExecRunner) Run(ctx context.Context, name string, args []string, timeout time.Duration) (CommandResult, error) {
|
|
||||||
runCtx := ctx
|
|
||||||
cancel := func() {}
|
|
||||||
if timeout > 0 {
|
|
||||||
runCtx, cancel = context.WithTimeout(ctx, timeout)
|
|
||||||
}
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
cmd := exec.CommandContext(runCtx, name, args...)
|
|
||||||
stdout := &limitedBuffer{limit: maxCapturedOutputBytes}
|
|
||||||
stderr := &limitedBuffer{limit: maxCapturedOutputBytes}
|
|
||||||
cmd.Stdout = stdout
|
|
||||||
cmd.Stderr = stderr
|
|
||||||
err := cmd.Run()
|
|
||||||
result := CommandResult{
|
|
||||||
Stdout: stdout.Bytes(),
|
|
||||||
Stderr: stderr.Bytes(),
|
|
||||||
StdoutTruncated: stdout.Truncated(),
|
|
||||||
StderrTruncated: stderr.Truncated(),
|
|
||||||
ExitCode: 0,
|
|
||||||
}
|
|
||||||
if err == nil {
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
if runCtx.Err() != nil {
|
|
||||||
return result, runCtx.Err()
|
|
||||||
}
|
|
||||||
if exitErr, ok := err.(*exec.ExitError); ok {
|
|
||||||
result.ExitCode = exitErr.ExitCode()
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
return result, err
|
|
||||||
}
|
|
||||||
|
|
||||||
type Runner struct {
|
|
||||||
Binary string
|
|
||||||
ConfigPath string
|
|
||||||
Profile string
|
|
||||||
Timeout time.Duration
|
|
||||||
ExtraArgs []string
|
|
||||||
Commands CommandRunner
|
|
||||||
}
|
|
||||||
|
|
||||||
type RenderRequest struct {
|
|
||||||
PromptID string
|
|
||||||
DataPackagePath string
|
|
||||||
}
|
|
||||||
|
|
||||||
type RunRequest struct {
|
|
||||||
PromptID string
|
|
||||||
DataPackagePath string
|
|
||||||
OutputPath string
|
|
||||||
}
|
|
||||||
|
|
||||||
type StructuredRunRequest struct {
|
|
||||||
PromptID string
|
|
||||||
DataPackagePath string
|
|
||||||
OutputPath string
|
|
||||||
}
|
|
||||||
|
|
||||||
type RenderResult struct {
|
|
||||||
Command []string `json:"command"`
|
|
||||||
Stdout string `json:"stdout"`
|
|
||||||
Stderr string `json:"stderr"`
|
|
||||||
StdoutTruncated bool `json:"stdoutTruncated,omitempty"`
|
|
||||||
StderrTruncated bool `json:"stderrTruncated,omitempty"`
|
|
||||||
ExitCode int `json:"exitCode"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type RunResult struct {
|
|
||||||
Command []string `json:"command"`
|
|
||||||
Stdout string `json:"stdout"`
|
|
||||||
Stderr string `json:"stderr"`
|
|
||||||
StdoutTruncated bool `json:"stdoutTruncated,omitempty"`
|
|
||||||
StderrTruncated bool `json:"stderrTruncated,omitempty"`
|
|
||||||
ExitCode int `json:"exitCode"`
|
|
||||||
OutputPath string `json:"outputPath"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type StructuredRunResult struct {
|
|
||||||
Command []string `json:"command"`
|
|
||||||
Stdout string `json:"stdout"`
|
|
||||||
Stderr string `json:"stderr"`
|
|
||||||
StdoutTruncated bool `json:"stdoutTruncated,omitempty"`
|
|
||||||
StderrTruncated bool `json:"stderrTruncated,omitempty"`
|
|
||||||
ExitCode int `json:"exitCode"`
|
|
||||||
OutputPath string `json:"outputPath"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r Runner) Render(ctx context.Context, req RenderRequest) (*RenderResult, error) {
|
|
||||||
if req.PromptID == "" {
|
|
||||||
return nil, fmt.Errorf("prompt id is required")
|
|
||||||
}
|
|
||||||
if req.DataPackagePath == "" {
|
|
||||||
return nil, fmt.Errorf("data package path is required")
|
|
||||||
}
|
|
||||||
execution, err := r.execute(ctx, r.renderArgs(req))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("run scriptorium render: %w", err)
|
|
||||||
}
|
|
||||||
result := &RenderResult{
|
|
||||||
Command: execution.argv(),
|
|
||||||
Stdout: string(execution.result.Stdout),
|
|
||||||
Stderr: string(execution.result.Stderr),
|
|
||||||
StdoutTruncated: execution.result.StdoutTruncated,
|
|
||||||
StderrTruncated: execution.result.StderrTruncated,
|
|
||||||
ExitCode: execution.result.ExitCode,
|
|
||||||
}
|
|
||||||
if execution.result.ExitCode != 0 {
|
|
||||||
return result, fmt.Errorf("scriptorium render exited with code %d: %s", execution.result.ExitCode, result.Stderr)
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r Runner) Run(ctx context.Context, req RunRequest) (*RunResult, error) {
|
|
||||||
if req.PromptID == "" {
|
|
||||||
return nil, fmt.Errorf("prompt id is required")
|
|
||||||
}
|
|
||||||
if req.DataPackagePath == "" {
|
|
||||||
return nil, fmt.Errorf("data package path is required")
|
|
||||||
}
|
|
||||||
if req.OutputPath == "" {
|
|
||||||
return nil, fmt.Errorf("output path is required")
|
|
||||||
}
|
|
||||||
execution, err := r.execute(ctx, r.runArgs(req))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("run scriptorium: %w", err)
|
|
||||||
}
|
|
||||||
result := &RunResult{
|
|
||||||
Command: execution.argv(),
|
|
||||||
Stdout: string(execution.result.Stdout),
|
|
||||||
Stderr: string(execution.result.Stderr),
|
|
||||||
StdoutTruncated: execution.result.StdoutTruncated,
|
|
||||||
StderrTruncated: execution.result.StderrTruncated,
|
|
||||||
ExitCode: execution.result.ExitCode,
|
|
||||||
OutputPath: req.OutputPath,
|
|
||||||
}
|
|
||||||
if execution.result.ExitCode != 0 {
|
|
||||||
return result, fmt.Errorf("scriptorium run exited with code %d: %s", execution.result.ExitCode, result.Stderr)
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r Runner) StructuredRun(ctx context.Context, req StructuredRunRequest) (*StructuredRunResult, error) {
|
|
||||||
if req.PromptID == "" {
|
|
||||||
return nil, fmt.Errorf("prompt id is required")
|
|
||||||
}
|
|
||||||
if req.DataPackagePath == "" {
|
|
||||||
return nil, fmt.Errorf("data package path is required")
|
|
||||||
}
|
|
||||||
if req.OutputPath == "" {
|
|
||||||
return nil, fmt.Errorf("output path is required")
|
|
||||||
}
|
|
||||||
execution, err := r.execute(ctx, r.structuredRunArgs(req))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("run scriptorium structured output: %w", err)
|
|
||||||
}
|
|
||||||
result := &StructuredRunResult{
|
|
||||||
Command: execution.argv(),
|
|
||||||
Stdout: string(execution.result.Stdout),
|
|
||||||
Stderr: string(execution.result.Stderr),
|
|
||||||
StdoutTruncated: execution.result.StdoutTruncated,
|
|
||||||
StderrTruncated: execution.result.StderrTruncated,
|
|
||||||
ExitCode: execution.result.ExitCode,
|
|
||||||
OutputPath: req.OutputPath,
|
|
||||||
}
|
|
||||||
if execution.result.ExitCode != 0 {
|
|
||||||
return result, fmt.Errorf("scriptorium structured run exited with code %d: %s", execution.result.ExitCode, result.Stderr)
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
type execution struct {
|
|
||||||
binary string
|
|
||||||
args []string
|
|
||||||
result CommandResult
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r Runner) execute(ctx context.Context, args []string) (execution, error) {
|
|
||||||
binary := r.Binary
|
|
||||||
if binary == "" {
|
|
||||||
binary = "scriptorium"
|
|
||||||
}
|
|
||||||
commands := r.Commands
|
|
||||||
if commands == nil {
|
|
||||||
commands = ExecRunner{}
|
|
||||||
}
|
|
||||||
result, err := commands.Run(ctx, binary, args, r.Timeout)
|
|
||||||
if err != nil {
|
|
||||||
return execution{}, err
|
|
||||||
}
|
|
||||||
return execution{binary: binary, args: args, result: result}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e execution) argv() []string {
|
|
||||||
return append([]string{e.binary}, e.args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r Runner) renderArgs(req RenderRequest) []string {
|
|
||||||
args := []string{"render"}
|
|
||||||
if r.ConfigPath != "" {
|
|
||||||
args = append(args, "--config", r.ConfigPath)
|
|
||||||
}
|
|
||||||
if r.Profile != "" {
|
|
||||||
args = append(args, "--profile", r.Profile)
|
|
||||||
}
|
|
||||||
args = append(args,
|
|
||||||
"--prompt", req.PromptID,
|
|
||||||
"--input", "data_package="+req.DataPackagePath,
|
|
||||||
"--format", "json",
|
|
||||||
)
|
|
||||||
args = append(args, r.ExtraArgs...)
|
|
||||||
return args
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r Runner) runArgs(req RunRequest) []string {
|
|
||||||
args := []string{"run"}
|
|
||||||
if r.ConfigPath != "" {
|
|
||||||
args = append(args, "--config", r.ConfigPath)
|
|
||||||
}
|
|
||||||
if r.Profile != "" {
|
|
||||||
args = append(args, "--profile", r.Profile)
|
|
||||||
}
|
|
||||||
args = append(args,
|
|
||||||
"--prompt", req.PromptID,
|
|
||||||
"--input", "data_package="+req.DataPackagePath,
|
|
||||||
"--out", req.OutputPath,
|
|
||||||
)
|
|
||||||
args = append(args, r.ExtraArgs...)
|
|
||||||
return args
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r Runner) structuredRunArgs(req StructuredRunRequest) []string {
|
|
||||||
return r.runArgs(RunRequest{
|
|
||||||
PromptID: req.PromptID,
|
|
||||||
DataPackagePath: req.DataPackagePath,
|
|
||||||
OutputPath: req.OutputPath,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
type limitedBuffer struct {
|
|
||||||
data []byte
|
|
||||||
limit int
|
|
||||||
truncated bool
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b *limitedBuffer) Write(p []byte) (int, error) {
|
|
||||||
if b.limit <= 0 {
|
|
||||||
b.truncated = true
|
|
||||||
return len(p), nil
|
|
||||||
}
|
|
||||||
remaining := b.limit - len(b.data)
|
|
||||||
if remaining <= 0 {
|
|
||||||
b.truncated = true
|
|
||||||
return len(p), nil
|
|
||||||
}
|
|
||||||
if len(p) > remaining {
|
|
||||||
b.data = append(b.data, p[:remaining]...)
|
|
||||||
b.truncated = true
|
|
||||||
return len(p), nil
|
|
||||||
}
|
|
||||||
b.data = append(b.data, p...)
|
|
||||||
return len(p), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b *limitedBuffer) Bytes() []byte {
|
|
||||||
return append([]byte{}, b.data...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b *limitedBuffer) Truncated() bool {
|
|
||||||
return b.truncated
|
|
||||||
}
|
|
||||||
|
|
||||||
var _ io.Writer = (*limitedBuffer)(nil)
|
|
||||||
@@ -1,315 +0,0 @@
|
|||||||
package scriptorium
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"reflect"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestRenderConstructsCommand(t *testing.T) {
|
|
||||||
commands := &fakeCommands{result: CommandResult{Stdout: []byte(`{"ok":true}`)}}
|
|
||||||
runner := Runner{
|
|
||||||
Binary: "/usr/local/bin/scriptorium",
|
|
||||||
ConfigPath: "/etc/scriptorium.yml",
|
|
||||||
Profile: "weather",
|
|
||||||
Timeout: time.Minute,
|
|
||||||
Commands: commands,
|
|
||||||
}
|
|
||||||
|
|
||||||
result, err := runner.Render(context.Background(), RenderRequest{
|
|
||||||
PromptID: "weather.markdown_report",
|
|
||||||
DataPackagePath: "/tmp/data_package.yaml",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Render() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
wantArgs := []string{
|
|
||||||
"render",
|
|
||||||
"--config", "/etc/scriptorium.yml",
|
|
||||||
"--profile", "weather",
|
|
||||||
"--prompt", "weather.markdown_report",
|
|
||||||
"--input", "data_package=/tmp/data_package.yaml",
|
|
||||||
"--format", "json",
|
|
||||||
}
|
|
||||||
if commands.name != "/usr/local/bin/scriptorium" {
|
|
||||||
t.Fatalf("command name = %q, want custom binary", commands.name)
|
|
||||||
}
|
|
||||||
if !reflect.DeepEqual(commands.args, wantArgs) {
|
|
||||||
t.Fatalf("args = %#v, want %#v", commands.args, wantArgs)
|
|
||||||
}
|
|
||||||
if !reflect.DeepEqual(result.Command, append([]string{"/usr/local/bin/scriptorium"}, wantArgs...)) {
|
|
||||||
t.Fatalf("result command = %#v, want full argv", result.Command)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRenderReturnsResultForNonzeroExit(t *testing.T) {
|
|
||||||
runner := Runner{
|
|
||||||
Commands: &fakeCommands{
|
|
||||||
result: CommandResult{
|
|
||||||
Stderr: []byte("missing input"),
|
|
||||||
ExitCode: 1,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
result, err := runner.Render(context.Background(), RenderRequest{
|
|
||||||
PromptID: "weather.markdown_report",
|
|
||||||
DataPackagePath: "/tmp/data_package.yaml",
|
|
||||||
})
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("Render() error = nil, want nonzero exit error")
|
|
||||||
}
|
|
||||||
if result == nil {
|
|
||||||
t.Fatal("Render() result = nil, want captured result")
|
|
||||||
}
|
|
||||||
if result.ExitCode != 1 {
|
|
||||||
t.Fatalf("ExitCode = %d, want 1", result.ExitCode)
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "missing input") {
|
|
||||||
t.Fatalf("error = %q, want stderr context", err.Error())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRunConstructsCommand(t *testing.T) {
|
|
||||||
commands := &fakeCommands{result: CommandResult{Stderr: []byte("wrote report")}}
|
|
||||||
runner := Runner{
|
|
||||||
Binary: "/usr/local/bin/scriptorium",
|
|
||||||
ConfigPath: "/etc/scriptorium.yml",
|
|
||||||
Profile: "weather",
|
|
||||||
Timeout: 45 * time.Second,
|
|
||||||
Commands: commands,
|
|
||||||
}
|
|
||||||
|
|
||||||
result, err := runner.Run(context.Background(), RunRequest{
|
|
||||||
PromptID: "weather.markdown_report",
|
|
||||||
DataPackagePath: "/tmp/data_package.yaml",
|
|
||||||
OutputPath: "/tmp/daily.md",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Run() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
wantArgs := []string{
|
|
||||||
"run",
|
|
||||||
"--config", "/etc/scriptorium.yml",
|
|
||||||
"--profile", "weather",
|
|
||||||
"--prompt", "weather.markdown_report",
|
|
||||||
"--input", "data_package=/tmp/data_package.yaml",
|
|
||||||
"--out", "/tmp/daily.md",
|
|
||||||
}
|
|
||||||
if commands.name != "/usr/local/bin/scriptorium" {
|
|
||||||
t.Fatalf("command name = %q, want custom binary", commands.name)
|
|
||||||
}
|
|
||||||
if !reflect.DeepEqual(commands.args, wantArgs) {
|
|
||||||
t.Fatalf("args = %#v, want %#v", commands.args, wantArgs)
|
|
||||||
}
|
|
||||||
if commands.timeout != 45*time.Second {
|
|
||||||
t.Fatalf("timeout = %s, want 45s", commands.timeout)
|
|
||||||
}
|
|
||||||
if !reflect.DeepEqual(result.Command, append([]string{"/usr/local/bin/scriptorium"}, wantArgs...)) {
|
|
||||||
t.Fatalf("result command = %#v, want full argv", result.Command)
|
|
||||||
}
|
|
||||||
if result.OutputPath != "/tmp/daily.md" {
|
|
||||||
t.Fatalf("OutputPath = %q, want /tmp/daily.md", result.OutputPath)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRunReturnsResultForValidationExit(t *testing.T) {
|
|
||||||
runner := Runner{
|
|
||||||
Commands: &fakeCommands{
|
|
||||||
result: CommandResult{
|
|
||||||
Stdout: []byte("# Daily Report\n"),
|
|
||||||
Stderr: []byte("validation failed"),
|
|
||||||
ExitCode: 2,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
result, err := runner.Run(context.Background(), RunRequest{
|
|
||||||
PromptID: "weather.markdown_report",
|
|
||||||
DataPackagePath: "/tmp/data_package.yaml",
|
|
||||||
OutputPath: "/tmp/daily.md",
|
|
||||||
})
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("Run() error = nil, want nonzero exit error")
|
|
||||||
}
|
|
||||||
if result == nil {
|
|
||||||
t.Fatal("Run() result = nil, want captured result")
|
|
||||||
}
|
|
||||||
if result.ExitCode != 2 {
|
|
||||||
t.Fatalf("ExitCode = %d, want 2", result.ExitCode)
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "validation failed") {
|
|
||||||
t.Fatalf("error = %q, want stderr context", err.Error())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStructuredRunConstructsCommandWithoutSchemaFlags(t *testing.T) {
|
|
||||||
commands := &fakeCommands{result: CommandResult{
|
|
||||||
Stdout: []byte(`{"summary":"ok"}`),
|
|
||||||
Stderr: []byte("wrote generated text"),
|
|
||||||
StdoutTruncated: true,
|
|
||||||
}}
|
|
||||||
runner := Runner{
|
|
||||||
Binary: "/usr/local/bin/scriptorium",
|
|
||||||
ConfigPath: "/etc/scriptorium.yml",
|
|
||||||
Profile: "weather",
|
|
||||||
Timeout: 30 * time.Second,
|
|
||||||
Commands: commands,
|
|
||||||
}
|
|
||||||
|
|
||||||
result, err := runner.StructuredRun(context.Background(), StructuredRunRequest{
|
|
||||||
PromptID: "weather.hourly_generated_text",
|
|
||||||
DataPackagePath: "/tmp/hourly.data_package.yaml",
|
|
||||||
OutputPath: "/tmp/hourly.generated_text.raw.json",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("StructuredRun() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
wantArgs := []string{
|
|
||||||
"run",
|
|
||||||
"--config", "/etc/scriptorium.yml",
|
|
||||||
"--profile", "weather",
|
|
||||||
"--prompt", "weather.hourly_generated_text",
|
|
||||||
"--input", "data_package=/tmp/hourly.data_package.yaml",
|
|
||||||
"--out", "/tmp/hourly.generated_text.raw.json",
|
|
||||||
}
|
|
||||||
if commands.name != "/usr/local/bin/scriptorium" {
|
|
||||||
t.Fatalf("command name = %q, want custom binary", commands.name)
|
|
||||||
}
|
|
||||||
if !reflect.DeepEqual(commands.args, wantArgs) {
|
|
||||||
t.Fatalf("args = %#v, want %#v", commands.args, wantArgs)
|
|
||||||
}
|
|
||||||
for _, disallowed := range []string{"--format", "--schema", "--schema-path", "--json-schema"} {
|
|
||||||
if containsArg(commands.args, disallowed) {
|
|
||||||
t.Fatalf("args = %#v, should not include %q", commands.args, disallowed)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if commands.timeout != 30*time.Second {
|
|
||||||
t.Fatalf("timeout = %s, want 30s", commands.timeout)
|
|
||||||
}
|
|
||||||
if !reflect.DeepEqual(result.Command, append([]string{"/usr/local/bin/scriptorium"}, wantArgs...)) {
|
|
||||||
t.Fatalf("result command = %#v, want full argv", result.Command)
|
|
||||||
}
|
|
||||||
if result.Stdout != `{"summary":"ok"}` || result.Stderr != "wrote generated text" || !result.StdoutTruncated {
|
|
||||||
t.Fatalf("result = %#v, want captured output and truncation flags", result)
|
|
||||||
}
|
|
||||||
if result.OutputPath != "/tmp/hourly.generated_text.raw.json" {
|
|
||||||
t.Fatalf("OutputPath = %q, want generated text raw path", result.OutputPath)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStructuredRunReturnsResultForNonzeroExit(t *testing.T) {
|
|
||||||
runner := Runner{
|
|
||||||
Commands: &fakeCommands{
|
|
||||||
result: CommandResult{
|
|
||||||
Stdout: []byte(`{"summary":"partial"}`),
|
|
||||||
Stderr: []byte("structured output failed"),
|
|
||||||
ExitCode: 3,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
result, err := runner.StructuredRun(context.Background(), StructuredRunRequest{
|
|
||||||
PromptID: "weather.hourly_generated_text",
|
|
||||||
DataPackagePath: "/tmp/hourly.data_package.yaml",
|
|
||||||
OutputPath: "/tmp/hourly.generated_text.raw.json",
|
|
||||||
})
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("StructuredRun() error = nil, want nonzero exit error")
|
|
||||||
}
|
|
||||||
if result == nil {
|
|
||||||
t.Fatal("StructuredRun() result = nil, want captured result")
|
|
||||||
}
|
|
||||||
if result.ExitCode != 3 {
|
|
||||||
t.Fatalf("ExitCode = %d, want 3", result.ExitCode)
|
|
||||||
}
|
|
||||||
if result.Stdout != `{"summary":"partial"}` || result.OutputPath != "/tmp/hourly.generated_text.raw.json" {
|
|
||||||
t.Fatalf("result = %#v, want captured result fields", result)
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "structured output failed") {
|
|
||||||
t.Fatalf("error = %q, want stderr context", err.Error())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStructuredRunValidatesRequiredFieldsBeforeExecution(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
req StructuredRunRequest
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "prompt id",
|
|
||||||
req: StructuredRunRequest{
|
|
||||||
DataPackagePath: "/tmp/hourly.data_package.yaml",
|
|
||||||
OutputPath: "/tmp/hourly.generated_text.raw.json",
|
|
||||||
},
|
|
||||||
want: "prompt id is required",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "data package path",
|
|
||||||
req: StructuredRunRequest{
|
|
||||||
PromptID: "weather.hourly_generated_text",
|
|
||||||
OutputPath: "/tmp/hourly.generated_text.raw.json",
|
|
||||||
},
|
|
||||||
want: "data package path is required",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "output path",
|
|
||||||
req: StructuredRunRequest{
|
|
||||||
PromptID: "weather.hourly_generated_text",
|
|
||||||
DataPackagePath: "/tmp/hourly.data_package.yaml",
|
|
||||||
},
|
|
||||||
want: "output path is required",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
for _, test := range tests {
|
|
||||||
t.Run(test.name, func(t *testing.T) {
|
|
||||||
commands := &fakeCommands{}
|
|
||||||
runner := Runner{Commands: commands}
|
|
||||||
result, err := runner.StructuredRun(context.Background(), test.req)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("StructuredRun() error = nil, want validation error")
|
|
||||||
}
|
|
||||||
if result != nil {
|
|
||||||
t.Fatalf("StructuredRun() result = %#v, want nil", result)
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), test.want) {
|
|
||||||
t.Fatalf("StructuredRun() error = %v, want %q", err, test.want)
|
|
||||||
}
|
|
||||||
if commands.calls != 0 {
|
|
||||||
t.Fatalf("commands calls = %d, want no subprocess execution", commands.calls)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type fakeCommands struct {
|
|
||||||
name string
|
|
||||||
args []string
|
|
||||||
timeout time.Duration
|
|
||||||
result CommandResult
|
|
||||||
err error
|
|
||||||
calls int
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *fakeCommands) Run(_ context.Context, name string, args []string, timeout time.Duration) (CommandResult, error) {
|
|
||||||
f.calls++
|
|
||||||
f.name = name
|
|
||||||
f.args = append([]string{}, args...)
|
|
||||||
f.timeout = timeout
|
|
||||||
return f.result, f.err
|
|
||||||
}
|
|
||||||
|
|
||||||
func containsArg(args []string, want string) bool {
|
|
||||||
for _, arg := range args {
|
|
||||||
if arg == want {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
@@ -24,6 +24,12 @@ import (
|
|||||||
const (
|
const (
|
||||||
convectiveOutlooksEndpoint = "/outlooks/convective"
|
convectiveOutlooksEndpoint = "/outlooks/convective"
|
||||||
sourceSPCConvectiveOutlooks = "spc_convective_outlooks"
|
sourceSPCConvectiveOutlooks = "spc_convective_outlooks"
|
||||||
|
|
||||||
|
defaultWarmupEndpoint = "/conditions/current"
|
||||||
|
defaultWarmupAttempts = 3
|
||||||
|
defaultWarmupDelay = time.Second
|
||||||
|
defaultFetchAttempts = 2
|
||||||
|
defaultFetchRetryDelay = time.Second
|
||||||
)
|
)
|
||||||
|
|
||||||
type Client struct {
|
type Client struct {
|
||||||
@@ -35,6 +41,12 @@ type Client struct {
|
|||||||
precision int
|
precision int
|
||||||
missingSource config.MissingSourceConfig
|
missingSource config.MissingSourceConfig
|
||||||
now func() time.Time
|
now func() time.Time
|
||||||
|
|
||||||
|
warmupEndpoint string
|
||||||
|
warmupAttempts int
|
||||||
|
warmupDelay time.Duration
|
||||||
|
fetchAttempts int
|
||||||
|
fetchRetryDelay time.Duration
|
||||||
}
|
}
|
||||||
|
|
||||||
type Option func(*Client)
|
type Option func(*Client)
|
||||||
@@ -81,6 +93,11 @@ func New(cfg config.Config, opts ...Option) (*Client, error) {
|
|||||||
Sources: cfg.MissingSource.Sources,
|
Sources: cfg.MissingSource.Sources,
|
||||||
},
|
},
|
||||||
now: time.Now,
|
now: time.Now,
|
||||||
|
warmupEndpoint: defaultWarmupEndpoint,
|
||||||
|
warmupAttempts: defaultWarmupAttempts,
|
||||||
|
warmupDelay: defaultWarmupDelay,
|
||||||
|
fetchAttempts: defaultFetchAttempts,
|
||||||
|
fetchRetryDelay: defaultFetchRetryDelay,
|
||||||
}
|
}
|
||||||
for _, opt := range opts {
|
for _, opt := range opts {
|
||||||
opt(client)
|
opt(client)
|
||||||
@@ -89,6 +106,10 @@ func New(cfg config.Config, opts ...Option) (*Client, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (c *Client) FetchBundle(ctx context.Context) (*weatherdata.Bundle, error) {
|
func (c *Client) FetchBundle(ctx context.Context) (*weatherdata.Bundle, error) {
|
||||||
|
if err := c.warmup(ctx); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
fetchedAt := c.now()
|
fetchedAt := c.now()
|
||||||
builder := bundleBuilder{
|
builder := bundleBuilder{
|
||||||
client: c,
|
client: c,
|
||||||
@@ -397,24 +418,9 @@ type envelope struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (c *Client) fetch(ctx context.Context, sourceName string, endpoint string, opts queryOptions) (json.RawMessage, weatherdata.Source, error) {
|
func (c *Client) fetch(ctx context.Context, sourceName string, endpoint string, opts queryOptions) (json.RawMessage, weatherdata.Source, error) {
|
||||||
reqURL := c.endpointURL(endpoint, opts)
|
reqURL, body, err := c.fetchHTTP(ctx, endpoint, opts)
|
||||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, reqURL.String(), nil)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, weatherdata.Source{}, fmt.Errorf("create request for %s: %w", endpoint, err)
|
return nil, weatherdata.Source{}, err
|
||||||
}
|
|
||||||
|
|
||||||
resp, err := c.httpClient.Do(req)
|
|
||||||
if err != nil {
|
|
||||||
return nil, weatherdata.Source{}, fmt.Errorf("fetch %s: %w", endpoint, err)
|
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
|
|
||||||
body, err := io.ReadAll(io.LimitReader(resp.Body, 10<<20))
|
|
||||||
if err != nil {
|
|
||||||
return nil, weatherdata.Source{}, fmt.Errorf("read %s response: %w", endpoint, err)
|
|
||||||
}
|
|
||||||
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
|
||||||
return nil, weatherdata.Source{}, fmt.Errorf("fetch %s: unexpected HTTP status %d: %s", endpoint, resp.StatusCode, strings.TrimSpace(string(body)))
|
|
||||||
}
|
}
|
||||||
|
|
||||||
var env envelope
|
var env envelope
|
||||||
@@ -440,6 +446,169 @@ func (c *Client) fetch(ctx context.Context, sourceName string, endpoint string,
|
|||||||
return env.Data, source, nil
|
return env.Data, source, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (c *Client) warmup(ctx context.Context) error {
|
||||||
|
endpoint := c.warmupEndpoint
|
||||||
|
if strings.TrimSpace(endpoint) == "" {
|
||||||
|
endpoint = defaultWarmupEndpoint
|
||||||
|
}
|
||||||
|
attempts := positiveAttemptCount(c.warmupAttempts)
|
||||||
|
var lastErr error
|
||||||
|
for attempt := 1; attempt <= attempts; attempt++ {
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return fmt.Errorf("warm up weather API via %s: %w", endpoint, err)
|
||||||
|
}
|
||||||
|
if err := c.warmupOnce(ctx, endpoint); err != nil {
|
||||||
|
lastErr = err
|
||||||
|
} else {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if attempt == attempts {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if err := waitForRetry(ctx, c.warmupDelay); err != nil {
|
||||||
|
return fmt.Errorf("warm up weather API via %s after %d attempt(s): %w", endpoint, attempt, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return fmt.Errorf("warm up weather API via %s failed after %d attempts: %w", endpoint, attempts, lastErr)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) warmupOnce(ctx context.Context, endpoint string) error {
|
||||||
|
reqURL := c.endpointURL(endpoint, queryOptions{precision: true})
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodGet, reqURL.String(), nil)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("create request for %s: %w", endpoint, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := c.httpClient.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("fetch %s: %w", endpoint, err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
body, err := io.ReadAll(io.LimitReader(resp.Body, 10<<20))
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("read %s response: %w", endpoint, err)
|
||||||
|
}
|
||||||
|
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
||||||
|
return fmt.Errorf("fetch %s: unexpected HTTP status %d: %s", endpoint, resp.StatusCode, strings.TrimSpace(string(body)))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) fetchHTTP(ctx context.Context, endpoint string, opts queryOptions) (*url.URL, []byte, error) {
|
||||||
|
attempts := positiveAttemptCount(c.fetchAttempts)
|
||||||
|
var lastErr error
|
||||||
|
var lastRetryable bool
|
||||||
|
for attempt := 1; attempt <= attempts; attempt++ {
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return nil, nil, fmt.Errorf("fetch %s: %w", endpoint, err)
|
||||||
|
}
|
||||||
|
reqURL, body, err := c.fetchHTTPOnce(ctx, endpoint, opts)
|
||||||
|
if err == nil {
|
||||||
|
return reqURL, body, nil
|
||||||
|
}
|
||||||
|
lastErr = err
|
||||||
|
lastRetryable = isRetryableRequestError(err)
|
||||||
|
if !lastRetryable || attempt == attempts {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if err := waitForRetry(ctx, c.fetchRetryDelay); err != nil {
|
||||||
|
return nil, nil, fmt.Errorf("fetch %s retry delay after attempt %d: %w", endpoint, attempt, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if lastRetryable {
|
||||||
|
return nil, nil, fmt.Errorf("fetch %s failed after %d attempts: %w", endpoint, attempts, lastErr)
|
||||||
|
}
|
||||||
|
return nil, nil, lastErr
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) fetchHTTPOnce(ctx context.Context, endpoint string, opts queryOptions) (*url.URL, []byte, error) {
|
||||||
|
reqURL := c.endpointURL(endpoint, opts)
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodGet, reqURL.String(), nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, fmt.Errorf("create request for %s: %w", endpoint, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := c.httpClient.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
err = fmt.Errorf("fetch %s: %w", endpoint, err)
|
||||||
|
if ctx.Err() != nil {
|
||||||
|
return reqURL, nil, err
|
||||||
|
}
|
||||||
|
return reqURL, nil, retryableRequestError{err: err}
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
body, err := io.ReadAll(io.LimitReader(resp.Body, 10<<20))
|
||||||
|
if err != nil {
|
||||||
|
err = fmt.Errorf("read %s response: %w", endpoint, err)
|
||||||
|
if ctx.Err() != nil {
|
||||||
|
return reqURL, nil, err
|
||||||
|
}
|
||||||
|
return reqURL, nil, retryableRequestError{err: err}
|
||||||
|
}
|
||||||
|
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
||||||
|
err := fmt.Errorf("fetch %s: unexpected HTTP status %d: %s", endpoint, resp.StatusCode, strings.TrimSpace(string(body)))
|
||||||
|
if isRetryableHTTPStatus(resp.StatusCode) {
|
||||||
|
return reqURL, nil, retryableRequestError{err: err}
|
||||||
|
}
|
||||||
|
return reqURL, nil, err
|
||||||
|
}
|
||||||
|
return reqURL, body, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type retryableRequestError struct {
|
||||||
|
err error
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e retryableRequestError) Error() string {
|
||||||
|
return e.err.Error()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e retryableRequestError) Unwrap() error {
|
||||||
|
return e.err
|
||||||
|
}
|
||||||
|
|
||||||
|
func isRetryableRequestError(err error) bool {
|
||||||
|
_, ok := err.(retryableRequestError)
|
||||||
|
return ok
|
||||||
|
}
|
||||||
|
|
||||||
|
func isRetryableHTTPStatus(status int) bool {
|
||||||
|
switch status {
|
||||||
|
case http.StatusRequestTimeout,
|
||||||
|
http.StatusTooManyRequests,
|
||||||
|
http.StatusInternalServerError,
|
||||||
|
http.StatusBadGateway,
|
||||||
|
http.StatusServiceUnavailable,
|
||||||
|
http.StatusGatewayTimeout:
|
||||||
|
return true
|
||||||
|
default:
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func waitForRetry(ctx context.Context, delay time.Duration) error {
|
||||||
|
if delay <= 0 {
|
||||||
|
return ctx.Err()
|
||||||
|
}
|
||||||
|
timer := time.NewTimer(delay)
|
||||||
|
defer timer.Stop()
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return ctx.Err()
|
||||||
|
case <-timer.C:
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func positiveAttemptCount(attempts int) int {
|
||||||
|
if attempts < 1 {
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
return attempts
|
||||||
|
}
|
||||||
|
|
||||||
func isJSONNull(raw json.RawMessage) bool {
|
func isJSONNull(raw json.RawMessage) bool {
|
||||||
return bytes.Equal(bytes.TrimSpace(raw), []byte("null"))
|
return bytes.Equal(bytes.TrimSpace(raw), []byte("null"))
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -80,8 +80,11 @@ func TestFetchBundleFromFixtures(t *testing.T) {
|
|||||||
"/weatherstories/latest",
|
"/weatherstories/latest",
|
||||||
convectiveOutlooksEndpoint,
|
convectiveOutlooksEndpoint,
|
||||||
}
|
}
|
||||||
if len(requested) != len(wantPaths) {
|
if len(requested) != len(wantPaths)+1 {
|
||||||
t.Fatalf("requested paths = %v, want %d source endpoints", requested, len(wantPaths))
|
t.Fatalf("requested paths = %v, want warmup plus %d source endpoints", requested, len(wantPaths))
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(requested[0], defaultWarmupEndpoint+"?") && requested[0] != defaultWarmupEndpoint {
|
||||||
|
t.Fatalf("first requested path = %q, want warmup endpoint %s", requested[0], defaultWarmupEndpoint)
|
||||||
}
|
}
|
||||||
for _, want := range wantPaths {
|
for _, want := range wantPaths {
|
||||||
if !containsPath(requested, want) {
|
if !containsPath(requested, want) {
|
||||||
@@ -132,9 +135,15 @@ func TestFetchBundleBuildsExpectedQueries(t *testing.T) {
|
|||||||
t.Fatalf("request %q missing units=us", rawURL)
|
t.Fatalf("request %q missing units=us", rawURL)
|
||||||
}
|
}
|
||||||
if strings.HasPrefix(rawURL, "/forecast/") {
|
if strings.HasPrefix(rawURL, "/forecast/") {
|
||||||
if !strings.Contains(rawURL, "precision=1") || !strings.Contains(rawURL, "tz=America%2FChicago") {
|
if !strings.Contains(rawURL, "precision=0") || !strings.Contains(rawURL, "tz=America%2FChicago") {
|
||||||
t.Fatalf("forecast request %q missing precision or tz", rawURL)
|
t.Fatalf("forecast request %q missing precision or tz", rawURL)
|
||||||
}
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if rawURL == defaultWarmupEndpoint || strings.HasPrefix(rawURL, defaultWarmupEndpoint+"?") || strings.HasPrefix(rawURL, "/observations?") {
|
||||||
|
if !strings.Contains(rawURL, "precision=0") {
|
||||||
|
t.Fatalf("request %q missing precision=0", rawURL)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -186,7 +195,7 @@ func TestFetchBundleRecordsSourceHash(t *testing.T) {
|
|||||||
|
|
||||||
func TestHTTPErrorIsActionable(t *testing.T) {
|
func TestHTTPErrorIsActionable(t *testing.T) {
|
||||||
server := fixtureServer(t, map[string]handlerOverride{
|
server := fixtureServer(t, map[string]handlerOverride{
|
||||||
"/conditions/current": {status: http.StatusBadGateway, body: `upstream failed`},
|
"/forecast/hourly": {status: http.StatusBadGateway, body: `upstream failed`},
|
||||||
}, nil)
|
}, nil)
|
||||||
client := newTestClient(t, server.URL+"/", nil)
|
client := newTestClient(t, server.URL+"/", nil)
|
||||||
|
|
||||||
@@ -194,15 +203,140 @@ func TestHTTPErrorIsActionable(t *testing.T) {
|
|||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("FetchBundle() error = nil, want HTTP error")
|
t.Fatal("FetchBundle() error = nil, want HTTP error")
|
||||||
}
|
}
|
||||||
if !strings.Contains(err.Error(), "/conditions/current") || !strings.Contains(err.Error(), "502") {
|
if !strings.Contains(err.Error(), "/forecast/hourly") || !strings.Contains(err.Error(), "502") {
|
||||||
t.Fatalf("error = %q, want endpoint and status", err.Error())
|
t.Fatalf("error = %q, want endpoint and status", err.Error())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestWarmupRetriesBeforeFetchBundle(t *testing.T) {
|
||||||
|
var requested []string
|
||||||
|
var warmupCalls int
|
||||||
|
server := fixtureServer(t, map[string]handlerOverride{
|
||||||
|
defaultWarmupEndpoint: {handler: func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
warmupCalls++
|
||||||
|
if warmupCalls == 1 {
|
||||||
|
w.WriteHeader(http.StatusBadGateway)
|
||||||
|
_, _ = w.Write([]byte("vpn waking up"))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
http.ServeFile(w, r, filepath.Join("testdata", "current.json"))
|
||||||
|
}},
|
||||||
|
}, &requested)
|
||||||
|
client := newTestClient(t, server.URL+"/", nil)
|
||||||
|
|
||||||
|
bundle, err := client.FetchBundle(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("FetchBundle() error = %v", err)
|
||||||
|
}
|
||||||
|
if bundle.Current == nil {
|
||||||
|
t.Fatal("Current = nil, want successful fetch after warmup retry")
|
||||||
|
}
|
||||||
|
if warmupCalls != 3 {
|
||||||
|
t.Fatalf("conditions/current calls = %d, want failed warmup, successful warmup, and current source fetch", warmupCalls)
|
||||||
|
}
|
||||||
|
if len(requested) < 2 || !containsPath(requested[:2], defaultWarmupEndpoint) {
|
||||||
|
t.Fatalf("initial requests = %v, want warmup endpoint retries", requested)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWarmupFailureStopsBeforeSourceFetches(t *testing.T) {
|
||||||
|
var requested []string
|
||||||
|
server := fixtureServer(t, map[string]handlerOverride{
|
||||||
|
defaultWarmupEndpoint: {status: http.StatusBadGateway, body: `vpn unavailable`},
|
||||||
|
}, &requested)
|
||||||
|
client := newTestClient(t, server.URL+"/", nil)
|
||||||
|
client.warmupAttempts = 2
|
||||||
|
|
||||||
|
_, err := client.FetchBundle(context.Background())
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("FetchBundle() error = nil, want warmup failure")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "warm up weather API") ||
|
||||||
|
!strings.Contains(err.Error(), defaultWarmupEndpoint) ||
|
||||||
|
!strings.Contains(err.Error(), "2 attempts") ||
|
||||||
|
!strings.Contains(err.Error(), "502") {
|
||||||
|
t.Fatalf("error = %q, want warmup endpoint, attempts, and status", err.Error())
|
||||||
|
}
|
||||||
|
if got := countPath(requested, defaultWarmupEndpoint); got != 2 {
|
||||||
|
t.Fatalf("warmup requests = %d, want 2; all requests = %v", got, requested)
|
||||||
|
}
|
||||||
|
if containsPath(requested, "/observations") {
|
||||||
|
t.Fatalf("requested paths = %v, want warmup failure before source fetches", requested)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFetchRetriesRetryableStatus(t *testing.T) {
|
||||||
|
var hourlyCalls int
|
||||||
|
server := fixtureServer(t, map[string]handlerOverride{
|
||||||
|
"/forecast/hourly": {handler: func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
hourlyCalls++
|
||||||
|
if hourlyCalls == 1 {
|
||||||
|
w.WriteHeader(http.StatusBadGateway)
|
||||||
|
_, _ = w.Write([]byte("temporary upstream failure"))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
http.ServeFile(w, r, filepath.Join("testdata", "hourly.json"))
|
||||||
|
}},
|
||||||
|
}, nil)
|
||||||
|
client := newTestClient(t, server.URL+"/", nil)
|
||||||
|
|
||||||
|
bundle, err := client.FetchBundle(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("FetchBundle() error = %v", err)
|
||||||
|
}
|
||||||
|
if bundle.Hourly == nil {
|
||||||
|
t.Fatal("Hourly = nil, want successful fetch after retry")
|
||||||
|
}
|
||||||
|
if hourlyCalls != 2 {
|
||||||
|
t.Fatalf("hourly calls = %d, want 2", hourlyCalls)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFetchDoesNotRetryNonRetryableStatus(t *testing.T) {
|
||||||
|
var hourlyCalls int
|
||||||
|
server := fixtureServer(t, map[string]handlerOverride{
|
||||||
|
"/forecast/hourly": {handler: func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
hourlyCalls++
|
||||||
|
w.WriteHeader(http.StatusNotFound)
|
||||||
|
_, _ = w.Write([]byte("not found"))
|
||||||
|
}},
|
||||||
|
}, nil)
|
||||||
|
client := newTestClient(t, server.URL+"/", nil)
|
||||||
|
|
||||||
|
_, err := client.FetchBundle(context.Background())
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("FetchBundle() error = nil, want non-retryable status error")
|
||||||
|
}
|
||||||
|
if hourlyCalls != 1 {
|
||||||
|
t.Fatalf("hourly calls = %d, want no retry", hourlyCalls)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFetchDoesNotRetryMalformedEnvelope(t *testing.T) {
|
||||||
|
var hourlyCalls int
|
||||||
|
server := fixtureServer(t, map[string]handlerOverride{
|
||||||
|
"/forecast/hourly": {handler: func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
hourlyCalls++
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
_, _ = w.Write([]byte(`not-json`))
|
||||||
|
}},
|
||||||
|
}, nil)
|
||||||
|
client := newTestClient(t, server.URL+"/", nil)
|
||||||
|
|
||||||
|
_, err := client.FetchBundle(context.Background())
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("FetchBundle() error = nil, want envelope decode error")
|
||||||
|
}
|
||||||
|
if hourlyCalls != 1 {
|
||||||
|
t.Fatalf("hourly calls = %d, want no retry", hourlyCalls)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestRequiredHourlyForecast(t *testing.T) {
|
func TestRequiredHourlyForecast(t *testing.T) {
|
||||||
|
var requested []string
|
||||||
server := fixtureServer(t, map[string]handlerOverride{
|
server := fixtureServer(t, map[string]handlerOverride{
|
||||||
"/forecast/hourly": {status: http.StatusOK, body: `{"data": null}`},
|
"/forecast/hourly": {status: http.StatusOK, body: `{"data": null}`},
|
||||||
}, nil)
|
}, &requested)
|
||||||
client := newTestClient(t, server.URL+"/", nil)
|
client := newTestClient(t, server.URL+"/", nil)
|
||||||
|
|
||||||
_, err := client.FetchBundle(context.Background())
|
_, err := client.FetchBundle(context.Background())
|
||||||
@@ -212,6 +346,9 @@ func TestRequiredHourlyForecast(t *testing.T) {
|
|||||||
if !strings.Contains(err.Error(), "hourly forecast data") {
|
if !strings.Contains(err.Error(), "hourly forecast data") {
|
||||||
t.Fatalf("error = %q, want hourly context", err.Error())
|
t.Fatalf("error = %q, want hourly context", err.Error())
|
||||||
}
|
}
|
||||||
|
if got := countPath(requested, "/forecast/hourly"); got != 1 {
|
||||||
|
t.Fatalf("hourly requests = %d, want no retry; all requests = %v", got, requested)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestNullAlertsMeansNoActiveAlerts(t *testing.T) {
|
func TestNullAlertsMeansNoActiveAlerts(t *testing.T) {
|
||||||
@@ -420,6 +557,43 @@ func TestContextCancellation(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestRetryDelayRespectsContextCancellation(t *testing.T) {
|
||||||
|
var cancel context.CancelFunc
|
||||||
|
var hourlyCalls int
|
||||||
|
server := fixtureServer(t, map[string]handlerOverride{
|
||||||
|
"/forecast/hourly": {handler: func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
hourlyCalls++
|
||||||
|
if cancel != nil {
|
||||||
|
cancel()
|
||||||
|
}
|
||||||
|
w.WriteHeader(http.StatusBadGateway)
|
||||||
|
_, _ = w.Write([]byte("temporary upstream failure"))
|
||||||
|
}},
|
||||||
|
}, nil)
|
||||||
|
client := newTestClient(t, server.URL+"/", nil)
|
||||||
|
client.fetchRetryDelay = time.Hour
|
||||||
|
|
||||||
|
ctx, cancelFunc := context.WithCancel(context.Background())
|
||||||
|
cancel = cancelFunc
|
||||||
|
defer cancelFunc()
|
||||||
|
|
||||||
|
start := time.Now()
|
||||||
|
_, err := client.FetchBundle(ctx)
|
||||||
|
elapsed := time.Since(start)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("FetchBundle() error = nil, want cancellation during retry delay")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), context.Canceled.Error()) {
|
||||||
|
t.Fatalf("error = %q, want context cancellation", err.Error())
|
||||||
|
}
|
||||||
|
if elapsed > time.Second {
|
||||||
|
t.Fatalf("FetchBundle() elapsed = %s, want prompt cancellation", elapsed)
|
||||||
|
}
|
||||||
|
if hourlyCalls != 1 {
|
||||||
|
t.Fatalf("hourly calls = %d, want retry delay cancellation before second attempt", hourlyCalls)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestHTTPTimeout(t *testing.T) {
|
func TestHTTPTimeout(t *testing.T) {
|
||||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
time.Sleep(50 * time.Millisecond)
|
time.Sleep(50 * time.Millisecond)
|
||||||
@@ -432,12 +606,14 @@ func TestHTTPTimeout(t *testing.T) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("New() error = %v", err)
|
t.Fatalf("New() error = %v", err)
|
||||||
}
|
}
|
||||||
|
client.warmupDelay = 0
|
||||||
|
client.fetchRetryDelay = 0
|
||||||
|
|
||||||
_, err = client.FetchBundle(context.Background())
|
_, err = client.FetchBundle(context.Background())
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("FetchBundle() error = nil, want timeout error")
|
t.Fatal("FetchBundle() error = nil, want timeout error")
|
||||||
}
|
}
|
||||||
if !strings.Contains(err.Error(), "/observations") {
|
if !strings.Contains(err.Error(), defaultWarmupEndpoint) {
|
||||||
t.Fatalf("error = %q, want endpoint context", err.Error())
|
t.Fatalf("error = %q, want endpoint context", err.Error())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -466,6 +642,7 @@ func TestSaveBundle(t *testing.T) {
|
|||||||
type handlerOverride struct {
|
type handlerOverride struct {
|
||||||
status int
|
status int
|
||||||
body string
|
body string
|
||||||
|
handler http.HandlerFunc
|
||||||
}
|
}
|
||||||
|
|
||||||
func fixtureServer(t *testing.T, overrides map[string]handlerOverride, requested *[]string) *httptest.Server {
|
func fixtureServer(t *testing.T, overrides map[string]handlerOverride, requested *[]string) *httptest.Server {
|
||||||
@@ -485,6 +662,10 @@ func fixtureServer(t *testing.T, overrides map[string]handlerOverride, requested
|
|||||||
*requested = append(*requested, r.URL.String())
|
*requested = append(*requested, r.URL.String())
|
||||||
}
|
}
|
||||||
if override, ok := overrides[r.URL.Path]; ok {
|
if override, ok := overrides[r.URL.Path]; ok {
|
||||||
|
if override.handler != nil {
|
||||||
|
override.handler(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
w.WriteHeader(override.status)
|
w.WriteHeader(override.status)
|
||||||
_, _ = w.Write([]byte(override.body))
|
_, _ = w.Write([]byte(override.body))
|
||||||
return
|
return
|
||||||
@@ -510,6 +691,8 @@ func newTestClient(t *testing.T, baseURL string, sourcePolicies map[string]confi
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("New() error = %v", err)
|
t.Fatalf("New() error = %v", err)
|
||||||
}
|
}
|
||||||
|
client.warmupDelay = 0
|
||||||
|
client.fetchRetryDelay = 0
|
||||||
return client
|
return client
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -532,6 +715,16 @@ func containsPath(requested []string, path string) bool {
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func countPath(requested []string, path string) int {
|
||||||
|
var count int
|
||||||
|
for _, rawURL := range requested {
|
||||||
|
if strings.HasPrefix(rawURL, path+"?") || rawURL == path {
|
||||||
|
count++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return count
|
||||||
|
}
|
||||||
|
|
||||||
func sourceByName(t *testing.T, sources []weatherdata.Source, name string) weatherdata.Source {
|
func sourceByName(t *testing.T, sources []weatherdata.Source, name string) weatherdata.Source {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
for _, source := range sources {
|
for _, source := range sources {
|
||||||
|
|||||||
1072
internal/app/app.go
1072
internal/app/app.go
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
142
internal/app/batch_generation_test.go
Normal file
142
internal/app/batch_generation_test.go
Normal file
@@ -0,0 +1,142 @@
|
|||||||
|
package app
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestRunBatchDetailedKeepsSuccessfulOutputAndSkipsNotificationAfterPartialFailure(t *testing.T) {
|
||||||
|
bundle := generationBundle(t)
|
||||||
|
bundle.Hourly.Periods = bundle.Hourly.Periods[:1]
|
||||||
|
notifier := &generationNotifier{}
|
||||||
|
executor := &generationExecutor{failedPrompt: generationDefinitionForPrompt("weather.tomorrow_generated_text").PromptID}
|
||||||
|
result, err := RunBatchDetailed(context.Background(), BatchRequest{
|
||||||
|
Config: generationDistributorConfig(), Batch: BatchMorning,
|
||||||
|
Now: generationTime("2026-05-29T08:30:00-05:00"), WorkingDir: t.TempDir(), OutputDir: t.TempDir(),
|
||||||
|
Collector: &generationCollector{bundle: &bundle}, Executor: executor, Notifier: notifier,
|
||||||
|
})
|
||||||
|
if err != nil || result == nil || result.Total != 2 || result.Succeeded != 1 || result.Failed != 1 || result.Notification == nil || result.Notification.Status != "skipped" || notifier.batchCalls != 0 {
|
||||||
|
t.Fatalf("RunBatchDetailed() result/error/notifier = %#v/%v/%#v", result, err, notifier)
|
||||||
|
}
|
||||||
|
if result.Reports[0].Status != "succeeded" || result.Reports[0].OutputPath == "" || result.Reports[1].Status != "failed" || result.Reports[1].OutputPath != "" {
|
||||||
|
t.Fatalf("report results = %#v", result.Reports)
|
||||||
|
}
|
||||||
|
if data, readErr := os.ReadFile(result.Reports[0].OutputPath); readErr != nil || len(data) == 0 {
|
||||||
|
t.Fatalf("successful output = %q, error = %v", data, readErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunBatchDetailedNotifiesOnlyAfterAllOutputsExist(t *testing.T) {
|
||||||
|
bundle := generationBundle(t)
|
||||||
|
bundle.Hourly.Periods = bundle.Hourly.Periods[:1]
|
||||||
|
outputDir := t.TempDir()
|
||||||
|
notifier := &generationNotifier{}
|
||||||
|
result, err := RunBatchDetailed(context.Background(), BatchRequest{
|
||||||
|
Config: generationDistributorConfig(), Batch: BatchMorning,
|
||||||
|
Now: generationTime("2026-05-29T08:30:00-05:00"), WorkingDir: t.TempDir(), OutputDir: outputDir,
|
||||||
|
Collector: &generationCollector{bundle: &bundle}, Executor: &generationExecutor{}, Notifier: notifier,
|
||||||
|
})
|
||||||
|
if err != nil || result == nil || result.Total != 2 || result.Succeeded != 2 || result.Failed != 0 || notifier.batchCalls != 1 || result.Notification == nil || result.Notification.Status != "succeeded" {
|
||||||
|
t.Fatalf("RunBatchDetailed() result/error/notifier = %#v/%v/%#v", result, err, notifier)
|
||||||
|
}
|
||||||
|
if len(notifier.batchRequest.Files) < 2 || len(notifier.batchRequest.IncludedReports) != 2 {
|
||||||
|
t.Fatalf("batch notification = %#v", notifier.batchRequest)
|
||||||
|
}
|
||||||
|
if result.Reports[0].OutputPath == result.Reports[1].OutputPath {
|
||||||
|
t.Fatalf("batch reports share output path %q", result.Reports[0].OutputPath)
|
||||||
|
}
|
||||||
|
for _, file := range notifier.batchRequest.Files {
|
||||||
|
if filepath.Dir(file.SourcePath) != outputDir || file.BundlePath == "" {
|
||||||
|
t.Fatalf("notification file = %#v", file)
|
||||||
|
}
|
||||||
|
if _, statErr := os.Stat(file.SourcePath); statErr != nil {
|
||||||
|
t.Fatalf("notification source %q: %v", file.SourcePath, statErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunBatchDetailedPreflightsAllOutputPaths(t *testing.T) {
|
||||||
|
bundle := generationBundle(t)
|
||||||
|
bundle.Hourly.Periods = bundle.Hourly.Periods[:1]
|
||||||
|
outputDir := t.TempDir()
|
||||||
|
if err := os.Mkdir(filepath.Join(outputDir, "tomorrow.md"), 0o700); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
todayPath := filepath.Join(outputDir, "today.md")
|
||||||
|
const previousReport = "previous report"
|
||||||
|
if err := os.WriteFile(todayPath, []byte(previousReport), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
executor := &generationExecutor{}
|
||||||
|
promptInspectedBeforeCollection := false
|
||||||
|
collector := &generationCollector{
|
||||||
|
bundle: &bundle,
|
||||||
|
beforeRun: func() {
|
||||||
|
promptInspectedBeforeCollection = executor.promptInspections > 0
|
||||||
|
},
|
||||||
|
}
|
||||||
|
result, err := RunBatchDetailed(context.Background(), BatchRequest{
|
||||||
|
Config: generationDistributorConfig(), Batch: BatchMorning,
|
||||||
|
Now: generationTime("2026-05-29T08:30:00-05:00"), WorkingDir: t.TempDir(), OutputDir: outputDir,
|
||||||
|
Collector: collector, Executor: executor, Notifier: &generationNotifier{},
|
||||||
|
})
|
||||||
|
if err == nil || result != nil || !collector.called || !promptInspectedBeforeCollection || executor.called {
|
||||||
|
t.Fatalf("RunBatchDetailed() result/error/collection/inspection/execution = %#v/%v/%t/%t/%t", result, err, collector.called, promptInspectedBeforeCollection, executor.called)
|
||||||
|
}
|
||||||
|
if data, readErr := os.ReadFile(todayPath); readErr != nil || string(data) != previousReport {
|
||||||
|
t.Fatalf("earlier output = %q, error = %v", data, readErr)
|
||||||
|
}
|
||||||
|
if info, statErr := os.Stat(filepath.Join(outputDir, "tomorrow.md")); statErr != nil || !info.IsDir() {
|
||||||
|
t.Fatalf("blocked output info/error = %#v/%v", info, statErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunBatchDetailedRetainsReportCountsWhenNotificationFails(t *testing.T) {
|
||||||
|
bundle := generationBundle(t)
|
||||||
|
bundle.Hourly.Periods = bundle.Hourly.Periods[:1]
|
||||||
|
outputDir := t.TempDir()
|
||||||
|
notifier := &generationNotifier{batchErr: errors.New("distributor unavailable")}
|
||||||
|
result, err := RunBatchDetailed(context.Background(), BatchRequest{
|
||||||
|
Config: generationDistributorConfig(), Batch: BatchMorning,
|
||||||
|
Now: generationTime("2026-05-29T08:30:00-05:00"), WorkingDir: t.TempDir(), OutputDir: outputDir,
|
||||||
|
Collector: &generationCollector{bundle: &bundle}, Executor: &generationExecutor{}, Notifier: notifier,
|
||||||
|
})
|
||||||
|
if err != nil || result == nil || result.Total != len(result.Reports) || result.Succeeded != len(result.Reports) || result.Failed != 0 || result.Notification == nil || result.Notification.Status != "failed" {
|
||||||
|
t.Fatalf("RunBatchDetailed() result/error = %#v/%v", result, err)
|
||||||
|
}
|
||||||
|
for _, item := range result.Reports {
|
||||||
|
if item.Status != "succeeded" || item.OutputPath == "" {
|
||||||
|
t.Fatalf("report result = %#v", item)
|
||||||
|
}
|
||||||
|
if _, statErr := os.Stat(item.OutputPath); statErr != nil {
|
||||||
|
t.Fatalf("published output %q: %v", item.OutputPath, statErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunBatchReturnsNotificationFailureWithoutReportFailureWording(t *testing.T) {
|
||||||
|
bundle := generationBundle(t)
|
||||||
|
bundle.Hourly.Periods = bundle.Hourly.Periods[:1]
|
||||||
|
err := RunBatch(context.Background(), BatchRequest{
|
||||||
|
Config: generationDistributorConfig(), Batch: BatchMorning,
|
||||||
|
Now: generationTime("2026-05-29T08:30:00-05:00"), WorkingDir: t.TempDir(), OutputDir: t.TempDir(),
|
||||||
|
Collector: &generationCollector{bundle: &bundle}, Executor: &generationExecutor{}, Notifier: &generationNotifier{batchErr: errors.New("distributor unavailable")},
|
||||||
|
})
|
||||||
|
var batchErr BatchError
|
||||||
|
if !errors.As(err, &batchErr) || batchErr.Result == nil || batchErr.Result.Failed != 0 || batchErr.Result.Notification == nil || batchErr.Result.Notification.Status != "failed" || !strings.Contains(err.Error(), "notification failed") || strings.Contains(err.Error(), "reports failed") {
|
||||||
|
t.Fatalf("RunBatch() error/result = %v/%#v", err, batchErr.Result)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func generationDistributorConfig() config.Config {
|
||||||
|
cfg := generationConfig()
|
||||||
|
cfg.Notify.Distributor.Enabled = true
|
||||||
|
cfg.Notify.Distributor.PipelineIDTemplate = "weather"
|
||||||
|
return cfg
|
||||||
|
}
|
||||||
293
internal/app/batch_notification.go
Normal file
293
internal/app/batch_notification.go
Normal file
@@ -0,0 +1,293 @@
|
|||||||
|
package app
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"path/filepath"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
distributoradapter "gitea.maximumdirect.net/eric/weatherreporter/internal/adapters/distributor"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/config"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/timeutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
const runIDTimestampLayout = "20060102T150405.000000000Z"
|
||||||
|
|
||||||
|
type batchNotificationIdentity struct {
|
||||||
|
PipelineID string
|
||||||
|
BundleID string
|
||||||
|
IdempotencyKey string
|
||||||
|
}
|
||||||
|
|
||||||
|
type batchNotificationRequest struct {
|
||||||
|
Batch BatchKind
|
||||||
|
RunID string
|
||||||
|
PipelineID string
|
||||||
|
BundleID string
|
||||||
|
IdempotencyKey string
|
||||||
|
Files []batchNotificationFile
|
||||||
|
IncludedReports []BatchNotificationReport
|
||||||
|
CreatedAt time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
type batchNotificationFile struct {
|
||||||
|
ReportID report.ID
|
||||||
|
RunID string
|
||||||
|
SourcePath string
|
||||||
|
BundlePath string
|
||||||
|
}
|
||||||
|
|
||||||
|
type batchNotifier interface {
|
||||||
|
NotifyBatch(context.Context, batchNotificationRequest) (*NotificationResult, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
func batchRunID(startedAt time.Time, batch BatchKind) string {
|
||||||
|
return startedAt.UTC().Format(runIDTimestampLayout) + "_" + string(batch)
|
||||||
|
}
|
||||||
|
|
||||||
|
func notifyBatch(ctx context.Context, cfg config.Config, batch BatchKind, runID string, startedAt time.Time, result *BatchResult, planned []plannedBatchReport, notifier Notifier) *BatchNotificationResult {
|
||||||
|
if !cfg.Notify.Distributor.Enabled {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if !cfg.Notify.Distributor.Batch.Enabled {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if result == nil {
|
||||||
|
return failedBatchNotificationResult(batchNotificationRequest{}, fmt.Errorf("batch result is required"))
|
||||||
|
}
|
||||||
|
if result.Failed > 0 {
|
||||||
|
return &BatchNotificationResult{
|
||||||
|
Status: "skipped",
|
||||||
|
Reason: "one or more reports failed",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
req, err := buildBatchNotificationRequest(cfg, batch, runID, startedAt, result.Reports, planned)
|
||||||
|
if err != nil {
|
||||||
|
return failedBatchNotificationResult(batchNotificationRequest{}, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
batchNotifier, err := resolveBatchNotifier(cfg, notifier)
|
||||||
|
if err != nil {
|
||||||
|
return failedBatchNotificationResult(req, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
notification, notifyErr := batchNotifier.NotifyBatch(ctx, req)
|
||||||
|
wrappedErr := notifyErr
|
||||||
|
if notifyErr != nil {
|
||||||
|
wrappedErr = fmt.Errorf("notify batch %q run %q bundle %q: %w", batch, runID, req.BundleID, notifyErr)
|
||||||
|
}
|
||||||
|
batchResult := batchNotificationResult(req, notification)
|
||||||
|
if wrappedErr != nil {
|
||||||
|
batchResult.Status = "failed"
|
||||||
|
batchResult.Error = wrappedErr.Error()
|
||||||
|
return batchResult
|
||||||
|
}
|
||||||
|
return batchResult
|
||||||
|
}
|
||||||
|
|
||||||
|
func resolveBatchNotifier(cfg config.Config, notifier Notifier) (batchNotifier, error) {
|
||||||
|
if notifier != nil {
|
||||||
|
if batchNotifier, ok := notifier.(batchNotifier); ok {
|
||||||
|
return batchNotifier, nil
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("batch distributor notifier is required")
|
||||||
|
}
|
||||||
|
return distributorNotifier{
|
||||||
|
client: distributoradapter.New(cfg.Notify.Distributor),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func buildBatchNotificationRequest(cfg config.Config, batch BatchKind, runID string, startedAt time.Time, reports []BatchReportResult, planned []plannedBatchReport) (batchNotificationRequest, error) {
|
||||||
|
if len(reports) == 0 {
|
||||||
|
return batchNotificationRequest{}, fmt.Errorf("batch notification requires at least one report")
|
||||||
|
}
|
||||||
|
|
||||||
|
identity, err := renderBatchNotificationIdentity(cfg, batch, runID, startedAt)
|
||||||
|
if err != nil {
|
||||||
|
return batchNotificationRequest{}, err
|
||||||
|
}
|
||||||
|
if identity.PipelineID == "" {
|
||||||
|
return batchNotificationRequest{}, fmt.Errorf("batch notification pipeline id is required")
|
||||||
|
}
|
||||||
|
if identity.BundleID == "" {
|
||||||
|
return batchNotificationRequest{}, fmt.Errorf("batch notification bundle id is required")
|
||||||
|
}
|
||||||
|
if identity.IdempotencyKey == "" {
|
||||||
|
return batchNotificationRequest{}, fmt.Errorf("batch notification idempotency key is required for bundle %q", identity.BundleID)
|
||||||
|
}
|
||||||
|
|
||||||
|
plannedByRunID, err := plannedReportsByRunID(planned)
|
||||||
|
if err != nil {
|
||||||
|
return batchNotificationRequest{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
req := batchNotificationRequest{
|
||||||
|
Batch: batch,
|
||||||
|
RunID: runID,
|
||||||
|
PipelineID: identity.PipelineID,
|
||||||
|
BundleID: identity.BundleID,
|
||||||
|
IdempotencyKey: identity.IdempotencyKey,
|
||||||
|
CreatedAt: startedAt,
|
||||||
|
}
|
||||||
|
seenBundlePaths := map[string]batchNotificationFile{}
|
||||||
|
for _, item := range reports {
|
||||||
|
plannedReport, ok := plannedByRunID[item.RunID]
|
||||||
|
if !ok {
|
||||||
|
return batchNotificationRequest{}, fmt.Errorf("batch notification report %q run %q has no matching planned report", item.ReportID, item.RunID)
|
||||||
|
}
|
||||||
|
if item.ReportID != plannedReport.Resolved.Definition.ID {
|
||||||
|
return batchNotificationRequest{}, fmt.Errorf("batch notification report %q run %q does not match planned report %q", item.ReportID, item.RunID, plannedReport.Resolved.Definition.ID)
|
||||||
|
}
|
||||||
|
if item.OutputPath == "" {
|
||||||
|
return batchNotificationRequest{}, fmt.Errorf("batch notification report %q run %q is missing output path", item.ReportID, item.RunID)
|
||||||
|
}
|
||||||
|
|
||||||
|
values, err := distributorTemplateValuesForReport(cfg, plannedReport.Resolved, item.RunID, filepath.Base(item.OutputPath))
|
||||||
|
if err != nil {
|
||||||
|
return batchNotificationRequest{}, fmt.Errorf("batch notification report %q run %q source path %q: %w", item.ReportID, item.RunID, item.OutputPath, err)
|
||||||
|
}
|
||||||
|
bundlePaths, err := renderDistributorReportBundlePaths(cfg, plannedReport.Resolved, item.RunID, item.OutputPath, values)
|
||||||
|
if err != nil {
|
||||||
|
return batchNotificationRequest{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
included := BatchNotificationReport{
|
||||||
|
ReportID: item.ReportID,
|
||||||
|
RunID: item.RunID,
|
||||||
|
SourcePath: item.OutputPath,
|
||||||
|
BundlePaths: append([]string(nil), bundlePaths...),
|
||||||
|
}
|
||||||
|
for _, bundlePath := range bundlePaths {
|
||||||
|
file := batchNotificationFile{
|
||||||
|
ReportID: item.ReportID,
|
||||||
|
RunID: item.RunID,
|
||||||
|
SourcePath: item.OutputPath,
|
||||||
|
BundlePath: bundlePath,
|
||||||
|
}
|
||||||
|
if previous, ok := seenBundlePaths[bundlePath]; ok {
|
||||||
|
return batchNotificationRequest{}, fmt.Errorf("batch notification duplicate bundle path %q for report %q run %q source path %q; already used by report %q run %q source path %q", bundlePath, item.ReportID, item.RunID, item.OutputPath, previous.ReportID, previous.RunID, previous.SourcePath)
|
||||||
|
}
|
||||||
|
seenBundlePaths[bundlePath] = file
|
||||||
|
req.Files = append(req.Files, file)
|
||||||
|
}
|
||||||
|
req.IncludedReports = append(req.IncludedReports, included)
|
||||||
|
}
|
||||||
|
if len(req.Files) == 0 {
|
||||||
|
return batchNotificationRequest{}, fmt.Errorf("batch notification requires at least one file mapping")
|
||||||
|
}
|
||||||
|
return req, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func plannedReportsByRunID(planned []plannedBatchReport) (map[string]plannedBatchReport, error) {
|
||||||
|
byRunID := make(map[string]plannedBatchReport, len(planned))
|
||||||
|
for _, item := range planned {
|
||||||
|
runID := item.Resolved.Metadata().RunID
|
||||||
|
if runID == "" {
|
||||||
|
return nil, fmt.Errorf("planned report %q has empty run id", item.Resolved.Definition.ID)
|
||||||
|
}
|
||||||
|
if previous, ok := byRunID[runID]; ok {
|
||||||
|
return nil, fmt.Errorf("planned reports %q and %q share run id %q", previous.Resolved.Definition.ID, item.Resolved.Definition.ID, runID)
|
||||||
|
}
|
||||||
|
byRunID[runID] = item
|
||||||
|
}
|
||||||
|
return byRunID, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func batchDistributorUploadRequest(req batchNotificationRequest) distributoradapter.UploadRequest {
|
||||||
|
files := make([]distributoradapter.UploadFile, 0, len(req.Files))
|
||||||
|
for _, file := range req.Files {
|
||||||
|
files = append(files, distributoradapter.UploadFile{
|
||||||
|
SourcePath: file.SourcePath,
|
||||||
|
BundlePath: file.BundlePath,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
return distributoradapter.UploadRequest{
|
||||||
|
PipelineID: req.PipelineID,
|
||||||
|
BundleID: req.BundleID,
|
||||||
|
IdempotencyKey: req.IdempotencyKey,
|
||||||
|
Files: files,
|
||||||
|
CreatedAt: req.CreatedAt,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func batchNotificationResult(req batchNotificationRequest, result *NotificationResult) *BatchNotificationResult {
|
||||||
|
notification := &BatchNotificationResult{
|
||||||
|
Status: "unknown",
|
||||||
|
PipelineID: req.PipelineID,
|
||||||
|
BundleID: req.BundleID,
|
||||||
|
IdempotencyKey: req.IdempotencyKey,
|
||||||
|
IncludedReports: append([]BatchNotificationReport(nil), req.IncludedReports...),
|
||||||
|
}
|
||||||
|
if result != nil {
|
||||||
|
notification.Status = result.Status
|
||||||
|
notification.RunID = result.RunID
|
||||||
|
if result.PipelineID != "" {
|
||||||
|
notification.PipelineID = result.PipelineID
|
||||||
|
}
|
||||||
|
if result.BundleID != "" {
|
||||||
|
notification.BundleID = result.BundleID
|
||||||
|
}
|
||||||
|
if result.IdempotencyKey != "" {
|
||||||
|
notification.IdempotencyKey = result.IdempotencyKey
|
||||||
|
}
|
||||||
|
if result.Error != "" {
|
||||||
|
notification.Error = result.Error
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if notification.Status == "" {
|
||||||
|
notification.Status = "unknown"
|
||||||
|
}
|
||||||
|
return notification
|
||||||
|
}
|
||||||
|
|
||||||
|
func failedBatchNotificationResult(req batchNotificationRequest, err error) *BatchNotificationResult {
|
||||||
|
notification := batchNotificationResult(req, nil)
|
||||||
|
notification.Status = "failed"
|
||||||
|
if err != nil {
|
||||||
|
notification.Error = err.Error()
|
||||||
|
}
|
||||||
|
return notification
|
||||||
|
}
|
||||||
|
|
||||||
|
func renderBatchNotificationIdentity(cfg config.Config, batch BatchKind, runID string, startedAt time.Time) (batchNotificationIdentity, error) {
|
||||||
|
values, err := batchNotificationTemplateValues(cfg, batch, runID, startedAt)
|
||||||
|
if err != nil {
|
||||||
|
return batchNotificationIdentity{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
bundleID, err := config.RenderDistributorBatchBundleID(cfg.Notify.Distributor.Batch.BundleIDTemplate, values)
|
||||||
|
if err != nil {
|
||||||
|
return batchNotificationIdentity{}, err
|
||||||
|
}
|
||||||
|
values.BundleID = bundleID
|
||||||
|
|
||||||
|
pipelineID, err := config.RenderDistributorBatchPipelineID(cfg.Notify.Distributor.Batch.PipelineIDTemplate, values)
|
||||||
|
if err != nil {
|
||||||
|
return batchNotificationIdentity{}, err
|
||||||
|
}
|
||||||
|
idempotencyKey, err := config.RenderDistributorBatchIdempotencyKey(cfg.Notify.Distributor.Batch.IdempotencyKeyTemplate, values)
|
||||||
|
if err != nil {
|
||||||
|
return batchNotificationIdentity{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return batchNotificationIdentity{
|
||||||
|
PipelineID: pipelineID,
|
||||||
|
BundleID: bundleID,
|
||||||
|
IdempotencyKey: idempotencyKey,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func batchNotificationTemplateValues(cfg config.Config, batch BatchKind, runID string, startedAt time.Time) (config.DistributorBatchTemplateValues, error) {
|
||||||
|
location, err := timeutil.LoadLocation(cfg.WeatherAPI.Timezone)
|
||||||
|
if err != nil {
|
||||||
|
return config.DistributorBatchTemplateValues{}, fmt.Errorf("load batch notification timezone: %w", err)
|
||||||
|
}
|
||||||
|
return config.DistributorBatchTemplateValues{
|
||||||
|
LocationID: cfg.Location.ID,
|
||||||
|
Batch: string(batch),
|
||||||
|
BatchRunID: runID,
|
||||||
|
BatchStartedDate: startedAt.In(location).Format(timeutil.DateLayout),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
135
internal/app/batch_plan.go
Normal file
135
internal/app/batch_plan.go
Normal file
@@ -0,0 +1,135 @@
|
|||||||
|
package app
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/collect"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/timeutil"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/weatherdata"
|
||||||
|
)
|
||||||
|
|
||||||
|
type plannedBatchReport struct {
|
||||||
|
Resolved report.Resolved
|
||||||
|
OutputPath string
|
||||||
|
}
|
||||||
|
|
||||||
|
func planBatchRun(req BatchRequest, now time.Time, collection collect.Result) ([]plannedBatchReport, error) {
|
||||||
|
location, err := timeutil.LoadLocation(req.Config.WeatherAPI.Timezone)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
batch, err := report.BatchForCommandName(string(req.Batch))
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
registry, err := reportRegistry(req.Config)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
resolveReq := report.ResolveRequest{
|
||||||
|
Now: now,
|
||||||
|
Location: location,
|
||||||
|
}
|
||||||
|
var planned []plannedBatchReport
|
||||||
|
switch batch {
|
||||||
|
case report.Morning:
|
||||||
|
planned, err = appendPlannedReport(planned, registry, report.Today, resolveReq)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
planned, err = appendPlannedReport(planned, registry, report.Tomorrow, resolveReq)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
case report.Evening:
|
||||||
|
planned, err = appendPlannedReport(planned, registry, report.Tomorrow, resolveReq)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("unknown batch %q", batch)
|
||||||
|
}
|
||||||
|
|
||||||
|
var hourly *weatherdata.ForecastRun
|
||||||
|
if collection.Bundle != nil {
|
||||||
|
hourly = collection.Bundle.Hourly
|
||||||
|
}
|
||||||
|
for _, date := range eligibleDailyDates(hourly, now, location) {
|
||||||
|
dailyReq := resolveReq
|
||||||
|
dailyReq.Date = date
|
||||||
|
planned, err = appendPlannedReport(planned, registry, report.Daily, dailyReq)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return planned, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func appendPlannedReport(planned []plannedBatchReport, registry report.Registry, id report.ID, req report.ResolveRequest) ([]plannedBatchReport, error) {
|
||||||
|
resolved, err := registry.Resolve(id, req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return append(planned, plannedBatchReport{Resolved: resolved}), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func eligibleDailyDates(hourly *weatherdata.ForecastRun, now time.Time, location *time.Location) []time.Time {
|
||||||
|
if hourly == nil || location == nil || hourly.Product != "hourly" || len(hourly.Periods) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
hourlyStarts := make(map[time.Time]struct{}, len(hourly.Periods))
|
||||||
|
var maxLocalDate time.Time
|
||||||
|
for _, period := range hourly.Periods {
|
||||||
|
if !isHourlyPeriod(period) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
start := period.StartTime
|
||||||
|
hourlyStarts[instantKey(start)] = struct{}{}
|
||||||
|
localDate := localDateStart(start, location)
|
||||||
|
if maxLocalDate.IsZero() || localDate.After(maxLocalDate) {
|
||||||
|
maxLocalDate = localDate
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(hourlyStarts) == 0 || maxLocalDate.IsZero() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
startDate := localDateStart(now.In(location).AddDate(0, 0, 2), location)
|
||||||
|
var dates []time.Time
|
||||||
|
for candidate := startDate; !candidate.After(maxLocalDate); candidate = candidate.AddDate(0, 0, 1) {
|
||||||
|
if hasFullHourlyCoverage(candidate, location, hourlyStarts) {
|
||||||
|
dates = append(dates, candidate)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return dates
|
||||||
|
}
|
||||||
|
|
||||||
|
func isHourlyPeriod(period weatherdata.ForecastPeriod) bool {
|
||||||
|
if period.StartTime.IsZero() || period.EndTime.IsZero() {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return period.EndTime.Equal(period.StartTime.Add(time.Hour))
|
||||||
|
}
|
||||||
|
|
||||||
|
func hasFullHourlyCoverage(date time.Time, location *time.Location, hourlyStarts map[time.Time]struct{}) bool {
|
||||||
|
day := timeutil.CivilDay(date, location)
|
||||||
|
for required := day.Start; required.Before(day.End); required = required.Add(time.Hour) {
|
||||||
|
if _, ok := hourlyStarts[instantKey(required)]; !ok {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
func instantKey(value time.Time) time.Time {
|
||||||
|
return value.UTC()
|
||||||
|
}
|
||||||
|
|
||||||
|
func localDateStart(value time.Time, location *time.Location) time.Time {
|
||||||
|
local := value.In(location)
|
||||||
|
return time.Date(local.Year(), local.Month(), local.Day(), 0, 0, 0, 0, location)
|
||||||
|
}
|
||||||
347
internal/app/batch_plan_test.go
Normal file
347
internal/app/batch_plan_test.go
Normal file
@@ -0,0 +1,347 @@
|
|||||||
|
package app
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/collect"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/config"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/timeutil"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/weatherdata"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestPlanBatchRunMorningOrder(t *testing.T) {
|
||||||
|
location := mustLoadTestLocation(t, "America/Chicago")
|
||||||
|
hourly := hourlyRun(fullDayPeriods(t, "2026-05-31", location)...)
|
||||||
|
|
||||||
|
planned, err := planBatchRun(BatchRequest{Config: planningConfig(), Batch: BatchMorning}, mustParse("2026-05-29T08:00:00-05:00"), collectionWithHourly(hourly))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("planBatchRun() error = %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
assertPlannedReportIDs(t, planned, report.Today, report.Tomorrow, report.Daily)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPlanBatchRunEveningOrder(t *testing.T) {
|
||||||
|
location := mustLoadTestLocation(t, "America/Chicago")
|
||||||
|
hourly := hourlyRun(fullDayPeriods(t, "2026-05-31", location)...)
|
||||||
|
|
||||||
|
planned, err := planBatchRun(BatchRequest{Config: planningConfig(), Batch: BatchEvening}, mustParse("2026-05-29T18:00:00-05:00"), collectionWithHourly(hourly))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("planBatchRun() error = %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
assertPlannedReportIDs(t, planned, report.Tomorrow, report.Daily)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPlanBatchRunDynamicDailyDatesStartAfterTomorrow(t *testing.T) {
|
||||||
|
location := mustLoadTestLocation(t, "America/Chicago")
|
||||||
|
periods := fullDayPeriods(t, "2026-05-30", location)
|
||||||
|
periods = append(periods, fullDayPeriods(t, "2026-05-31", location)...)
|
||||||
|
periods = append(periods, fullDayPeriods(t, "2026-06-01", location)...)
|
||||||
|
|
||||||
|
planned, err := planBatchRun(BatchRequest{Config: planningConfig(), Batch: BatchMorning}, mustParse("2026-05-29T08:00:00-05:00"), collectionWithHourly(hourlyRun(periods...)))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("planBatchRun() error = %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
daily := plannedDailyReports(planned)
|
||||||
|
if len(daily) != 2 {
|
||||||
|
t.Fatalf("daily reports = %#v, want two future Daily reports", daily)
|
||||||
|
}
|
||||||
|
assertPlanningPeriod(t, daily[0].Resolved.ValidPeriod, "2026-05-31T00:00:00-05:00", "2026-06-01T00:00:00-05:00")
|
||||||
|
assertPlanningPeriod(t, daily[1].Resolved.ValidPeriod, "2026-06-01T00:00:00-05:00", "2026-06-02T00:00:00-05:00")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPlanBatchRunUsesResolvedOutputNames(t *testing.T) {
|
||||||
|
location := mustLoadTestLocation(t, "America/Chicago")
|
||||||
|
hourly := hourlyRun(fullDayPeriods(t, "2026-05-31", location)...)
|
||||||
|
|
||||||
|
planned, err := planBatchRun(BatchRequest{Config: planningConfig(), Batch: BatchEvening}, mustParse("2026-05-29T18:00:00-05:00"), collectionWithHourly(hourly))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("planBatchRun() error = %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
daily := plannedDailyReports(planned)
|
||||||
|
if len(daily) != 1 {
|
||||||
|
t.Fatalf("daily reports = %#v, want one Daily report", daily)
|
||||||
|
}
|
||||||
|
outputName, err := daily[0].Resolved.OutputName()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("OutputName() error = %v", err)
|
||||||
|
}
|
||||||
|
if outputName != "daily-2026-05-31.md" {
|
||||||
|
t.Fatalf("Daily output name = %q, want date-qualified name", outputName)
|
||||||
|
}
|
||||||
|
outputName, err = planned[0].Resolved.OutputName()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("OutputName() error = %v", err)
|
||||||
|
}
|
||||||
|
if outputName != "tomorrow.md" {
|
||||||
|
t.Fatalf("Tomorrow output name = %q, want tomorrow.md", outputName)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPlanBatchRunRejectsUnknownBatch(t *testing.T) {
|
||||||
|
_, err := planBatchRun(BatchRequest{Config: planningConfig(), Batch: BatchKind("hourly")}, mustParse("2026-05-29T08:00:00-05:00"), collect.Result{Bundle: &weatherdata.Bundle{}})
|
||||||
|
if err == nil || !strings.Contains(err.Error(), `unknown batch command "hourly"`) {
|
||||||
|
t.Fatalf("planBatchRun() error = %v, want unknown batch command", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEligibleDailyDatesRequiresFullOrdinaryLocalDay(t *testing.T) {
|
||||||
|
location := mustLoadTestLocation(t, "America/Chicago")
|
||||||
|
hourly := hourlyRun(fullDayPeriods(t, "2026-05-31", location)...)
|
||||||
|
|
||||||
|
got := eligibleDailyDates(hourly, mustParse("2026-05-29T08:00:00-05:00"), location)
|
||||||
|
assertLocalDates(t, got, location, "2026-05-31")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEligibleDailyDatesMatchesFixedOffsetStartInstants(t *testing.T) {
|
||||||
|
location := mustLoadTestLocation(t, "America/Chicago")
|
||||||
|
hourly := hourlyRun(fixedOffsetPeriods(t, fullDayPeriods(t, "2026-05-31", location))...)
|
||||||
|
|
||||||
|
got := eligibleDailyDates(hourly, mustParse("2026-05-29T08:00:00-05:00"), location)
|
||||||
|
assertLocalDates(t, got, location, "2026-05-31")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEligibleDailyDatesSkipsDayWithMissingRequiredHour(t *testing.T) {
|
||||||
|
location := mustLoadTestLocation(t, "America/Chicago")
|
||||||
|
periods := fullDayPeriods(t, "2026-05-31", location)
|
||||||
|
periods = append(periods[:12], periods[13:]...)
|
||||||
|
hourly := hourlyRun(periods...)
|
||||||
|
|
||||||
|
got := eligibleDailyDates(hourly, mustParse("2026-05-29T08:00:00-05:00"), location)
|
||||||
|
assertLocalDates(t, got, location)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEligibleDailyDatesSkipsPartialFinalDay(t *testing.T) {
|
||||||
|
location := mustLoadTestLocation(t, "America/Chicago")
|
||||||
|
periods := fullDayPeriods(t, "2026-05-31", location)
|
||||||
|
periods = append(periods, partialDayPeriods(t, "2026-06-01", location, 12)...)
|
||||||
|
hourly := hourlyRun(periods...)
|
||||||
|
|
||||||
|
got := eligibleDailyDates(hourly, mustParse("2026-05-29T08:00:00-05:00"), location)
|
||||||
|
assertLocalDates(t, got, location, "2026-05-31")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEligibleDailyDatesStartsAfterTomorrow(t *testing.T) {
|
||||||
|
location := mustLoadTestLocation(t, "America/Chicago")
|
||||||
|
periods := fullDayPeriods(t, "2026-05-29", location)
|
||||||
|
periods = append(periods, fullDayPeriods(t, "2026-05-30", location)...)
|
||||||
|
periods = append(periods, fullDayPeriods(t, "2026-05-31", location)...)
|
||||||
|
hourly := hourlyRun(periods...)
|
||||||
|
|
||||||
|
got := eligibleDailyDates(hourly, mustParse("2026-05-29T08:00:00-05:00"), location)
|
||||||
|
assertLocalDates(t, got, location, "2026-05-31")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEligibleDailyDatesReturnsMultipleFutureDatesInOrder(t *testing.T) {
|
||||||
|
location := mustLoadTestLocation(t, "America/Chicago")
|
||||||
|
periods := fullDayPeriods(t, "2026-05-31", location)
|
||||||
|
periods = append(periods, fullDayPeriods(t, "2026-06-01", location)...)
|
||||||
|
hourly := hourlyRun(periods...)
|
||||||
|
|
||||||
|
got := eligibleDailyDates(hourly, mustParse("2026-05-29T08:00:00-05:00"), location)
|
||||||
|
assertLocalDates(t, got, location, "2026-05-31", "2026-06-01")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEligibleDailyDatesIgnoresNonHourlyAndInvalidPeriods(t *testing.T) {
|
||||||
|
location := mustLoadTestLocation(t, "America/Chicago")
|
||||||
|
day := timeutil.CivilDay(mustParseLocalDate(t, "2026-05-31", location), location)
|
||||||
|
periods := []weatherdata.ForecastPeriod{
|
||||||
|
{StartTime: day.Start, EndTime: day.Start.Add(2 * time.Hour)},
|
||||||
|
{StartTime: day.Start.Add(time.Hour), EndTime: day.Start.Add(time.Hour)},
|
||||||
|
{StartTime: time.Time{}, EndTime: day.Start.Add(3 * time.Hour)},
|
||||||
|
}
|
||||||
|
periods = append(periods, fullDayPeriods(t, "2026-06-01", location)...)
|
||||||
|
hourly := hourlyRun(periods...)
|
||||||
|
|
||||||
|
got := eligibleDailyDates(hourly, mustParse("2026-05-29T08:00:00-05:00"), location)
|
||||||
|
assertLocalDates(t, got, location, "2026-06-01")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEligibleDailyDatesUsesDSTCivilDayInstants(t *testing.T) {
|
||||||
|
location := mustLoadTestLocation(t, "America/New_York")
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
now string
|
||||||
|
date string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "spring forward",
|
||||||
|
now: "2026-03-06T08:00:00-05:00",
|
||||||
|
date: "2026-03-08",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "fall back",
|
||||||
|
now: "2026-10-30T08:00:00-04:00",
|
||||||
|
date: "2026-11-01",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
hourly := hourlyRun(fullDayPeriods(t, tt.date, location)...)
|
||||||
|
|
||||||
|
got := eligibleDailyDates(hourly, mustParse(tt.now), location)
|
||||||
|
assertLocalDates(t, got, location, tt.date)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEligibleDailyDatesReturnsNoneWithoutHourlyForecast(t *testing.T) {
|
||||||
|
location := mustLoadTestLocation(t, "America/Chicago")
|
||||||
|
fullDay := fullDayPeriods(t, "2026-05-31", location)
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
hourly *weatherdata.ForecastRun
|
||||||
|
}{
|
||||||
|
{name: "nil run"},
|
||||||
|
{name: "empty periods", hourly: hourlyRun()},
|
||||||
|
{name: "non-hourly product", hourly: forecastRun("narrative", fullDay...)},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
got := eligibleDailyDates(tt.hourly, mustParse("2026-05-29T08:00:00-05:00"), location)
|
||||||
|
assertLocalDates(t, got, location)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func hourlyRun(periods ...weatherdata.ForecastPeriod) *weatherdata.ForecastRun {
|
||||||
|
return forecastRun("hourly", periods...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func forecastRun(product string, periods ...weatherdata.ForecastPeriod) *weatherdata.ForecastRun {
|
||||||
|
return &weatherdata.ForecastRun{
|
||||||
|
Product: product,
|
||||||
|
Periods: periods,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func collectionWithHourly(hourly *weatherdata.ForecastRun) collect.Result {
|
||||||
|
return collect.Result{Bundle: &weatherdata.Bundle{Hourly: hourly}}
|
||||||
|
}
|
||||||
|
|
||||||
|
func planningConfig() config.Config {
|
||||||
|
cfg := config.Defaults()
|
||||||
|
cfg.WeatherAPI.Timezone = "America/Chicago"
|
||||||
|
return cfg
|
||||||
|
}
|
||||||
|
|
||||||
|
func assertPlannedReportIDs(t *testing.T, got []plannedBatchReport, want ...report.ID) {
|
||||||
|
t.Helper()
|
||||||
|
gotIDs := make([]string, 0, len(got))
|
||||||
|
for _, item := range got {
|
||||||
|
gotIDs = append(gotIDs, string(item.Resolved.Definition.ID))
|
||||||
|
}
|
||||||
|
wantIDs := make([]string, 0, len(want))
|
||||||
|
for _, id := range want {
|
||||||
|
wantIDs = append(wantIDs, string(id))
|
||||||
|
}
|
||||||
|
if strings.Join(gotIDs, ",") != strings.Join(wantIDs, ",") {
|
||||||
|
t.Fatalf("planned report IDs = [%s], want [%s]", strings.Join(gotIDs, ","), strings.Join(wantIDs, ","))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func plannedDailyReports(planned []plannedBatchReport) []plannedBatchReport {
|
||||||
|
var daily []plannedBatchReport
|
||||||
|
for _, item := range planned {
|
||||||
|
if item.Resolved.Definition.ID == report.Daily {
|
||||||
|
daily = append(daily, item)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return daily
|
||||||
|
}
|
||||||
|
|
||||||
|
func fullDayPeriods(t *testing.T, date string, location *time.Location) []weatherdata.ForecastPeriod {
|
||||||
|
t.Helper()
|
||||||
|
day := timeutil.CivilDay(mustParseLocalDate(t, date, location), location)
|
||||||
|
var periods []weatherdata.ForecastPeriod
|
||||||
|
for start := day.Start; start.Before(day.End); start = start.Add(time.Hour) {
|
||||||
|
periods = append(periods, weatherdata.ForecastPeriod{
|
||||||
|
StartTime: start,
|
||||||
|
EndTime: start.Add(time.Hour),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
return periods
|
||||||
|
}
|
||||||
|
|
||||||
|
func partialDayPeriods(t *testing.T, date string, location *time.Location, count int) []weatherdata.ForecastPeriod {
|
||||||
|
t.Helper()
|
||||||
|
periods := fullDayPeriods(t, date, location)
|
||||||
|
if count > len(periods) {
|
||||||
|
count = len(periods)
|
||||||
|
}
|
||||||
|
return periods[:count]
|
||||||
|
}
|
||||||
|
|
||||||
|
func fixedOffsetPeriods(t *testing.T, periods []weatherdata.ForecastPeriod) []weatherdata.ForecastPeriod {
|
||||||
|
t.Helper()
|
||||||
|
out := make([]weatherdata.ForecastPeriod, 0, len(periods))
|
||||||
|
for _, period := range periods {
|
||||||
|
start, err := time.Parse(time.RFC3339, period.StartTime.Format(time.RFC3339))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("parse fixed-offset start: %v", err)
|
||||||
|
}
|
||||||
|
end, err := time.Parse(time.RFC3339, period.EndTime.Format(time.RFC3339))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("parse fixed-offset end: %v", err)
|
||||||
|
}
|
||||||
|
out = append(out, weatherdata.ForecastPeriod{StartTime: start, EndTime: end})
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func assertLocalDates(t *testing.T, got []time.Time, location *time.Location, want ...string) {
|
||||||
|
t.Helper()
|
||||||
|
gotDates := make([]string, 0, len(got))
|
||||||
|
for _, date := range got {
|
||||||
|
gotDates = append(gotDates, date.In(location).Format(timeutil.DateLayout))
|
||||||
|
}
|
||||||
|
if strings.Join(gotDates, ",") != strings.Join(want, ",") {
|
||||||
|
t.Fatalf("eligibleDailyDates() = [%s], want [%s]", strings.Join(gotDates, ","), strings.Join(want, ","))
|
||||||
|
}
|
||||||
|
for _, date := range got {
|
||||||
|
day := timeutil.CivilDay(date, location)
|
||||||
|
if !date.Equal(day.Start) {
|
||||||
|
t.Fatalf("eligible date %s is not local civil day start %s", date, day.Start)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func assertPlanningPeriod(t *testing.T, period timeutil.Period, wantStart string, wantEnd string) {
|
||||||
|
t.Helper()
|
||||||
|
if !period.IsValid() {
|
||||||
|
t.Fatalf("period = %#v, want valid", period)
|
||||||
|
}
|
||||||
|
if got := period.Start.Format(time.RFC3339); got != wantStart {
|
||||||
|
t.Fatalf("Start = %s, want %s", got, wantStart)
|
||||||
|
}
|
||||||
|
if got := period.End.Format(time.RFC3339); got != wantEnd {
|
||||||
|
t.Fatalf("End = %s, want %s", got, wantEnd)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func mustLoadTestLocation(t *testing.T, name string) *time.Location {
|
||||||
|
t.Helper()
|
||||||
|
location, err := time.LoadLocation(name)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("LoadLocation(%q) error = %v", name, err)
|
||||||
|
}
|
||||||
|
return location
|
||||||
|
}
|
||||||
|
|
||||||
|
func mustParseLocalDate(t *testing.T, value string, location *time.Location) time.Time {
|
||||||
|
t.Helper()
|
||||||
|
parsed, err := timeutil.ParseLocalDate(value, location)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("ParseLocalDate(%q) error = %v", value, err)
|
||||||
|
}
|
||||||
|
return parsed
|
||||||
|
}
|
||||||
288
internal/app/generation_test.go
Normal file
288
internal/app/generation_test.go
Normal file
@@ -0,0 +1,288 @@
|
|||||||
|
package app
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/collect"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/config"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/promptexec"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/weatherdata"
|
||||||
|
)
|
||||||
|
|
||||||
|
type generationCollector struct {
|
||||||
|
bundle *weatherdata.Bundle
|
||||||
|
err error
|
||||||
|
called bool
|
||||||
|
beforeRun func()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *generationCollector) Run(context.Context, collect.Request) (*collect.Result, error) {
|
||||||
|
if c.beforeRun != nil {
|
||||||
|
c.beforeRun()
|
||||||
|
}
|
||||||
|
c.called = true
|
||||||
|
return &collect.Result{Bundle: c.bundle}, c.err
|
||||||
|
}
|
||||||
|
|
||||||
|
type generationExecutor struct {
|
||||||
|
called bool
|
||||||
|
promptInspections int
|
||||||
|
inspectErr error
|
||||||
|
executeErr error
|
||||||
|
cancelBeforeReturn context.CancelFunc
|
||||||
|
validation promptexec.ValidationStatus
|
||||||
|
rawOutput []byte
|
||||||
|
failedPrompt string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *generationExecutor) InspectPrompt(_ context.Context, id, version string) (promptexec.PromptInspection, error) {
|
||||||
|
e.promptInspections++
|
||||||
|
if e.inspectErr != nil {
|
||||||
|
return promptexec.PromptInspection{}, e.inspectErr
|
||||||
|
}
|
||||||
|
definition := generationDefinitionForPrompt(id)
|
||||||
|
return promptexec.PromptInspection{PromptID: id, PromptVersion: version, PromptHash: "prompt-hash", DefaultProfileID: "fixture", Inputs: []promptexec.InputDefinition{{Name: "data_package", Required: true, ContentType: "application/yaml"}}, Output: promptexec.OutputContract{Format: "json", ValidationMode: "json_schema", SchemaPath: definition.GeneratedTextSchemaID + ".generated_text.schema.json"}}, nil
|
||||||
|
}
|
||||||
|
func (*generationExecutor) InspectProfile(_ context.Context, id string) (promptexec.ProfileInspection, error) {
|
||||||
|
return promptexec.ProfileInspection{ProfileID: id, BackendID: "fixture", ModelName: "fixture-model"}, nil
|
||||||
|
}
|
||||||
|
func (e *generationExecutor) Execute(_ context.Context, req promptexec.ExecuteRequest, callback promptexec.PreparationCallback) (*promptexec.Execution, error) {
|
||||||
|
stamp := time.Date(2026, 5, 29, 15, 0, 0, 0, time.UTC)
|
||||||
|
if err := callback(promptexec.Preparation{PromptID: req.PromptID, PromptVersion: req.PromptVersion, PromptHash: "prompt-hash", RenderedPromptHash: "rendered-hash", ProfileID: req.ProfileID, BackendID: "fixture", ModelName: "fixture-model", StartedAt: stamp, EndedAt: stamp}, nil); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
e.called = true
|
||||||
|
if e.executeErr != nil {
|
||||||
|
return nil, e.executeErr
|
||||||
|
}
|
||||||
|
status := e.validation
|
||||||
|
if status == "" {
|
||||||
|
status = promptexec.ValidationPassed
|
||||||
|
}
|
||||||
|
if e.failedPrompt == req.PromptID {
|
||||||
|
status = promptexec.ValidationFailed
|
||||||
|
}
|
||||||
|
rawOutput := e.rawOutput
|
||||||
|
if rawOutput == nil {
|
||||||
|
rawOutput = []byte(`{"summary":"Showers are possible during the selected day.","forecast_discussion":["A front will keep rain chances in the forecast."],"precipitation_timing":"Rain is most likely during the afternoon."}`)
|
||||||
|
}
|
||||||
|
if e.cancelBeforeReturn != nil {
|
||||||
|
e.cancelBeforeReturn()
|
||||||
|
}
|
||||||
|
return &promptexec.Execution{RunID: "provider-run", PromptID: req.PromptID, PromptVersion: req.PromptVersion, PromptHash: "prompt-hash", RenderedPromptHash: "rendered-hash", ProfileID: req.ProfileID, BackendID: "fixture", ModelName: "fixture-model", StartedAt: stamp, EndedAt: stamp, RawOutput: rawOutput, Validation: promptexec.NewValidation(status, "json_schema", generationDefinitionForPrompt(req.PromptID).GeneratedTextSchemaID+".generated_text.schema.json", nil)}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func generationDefinitionForPrompt(promptID string) report.Definition {
|
||||||
|
for _, definition := range report.DefaultRegistry().All() {
|
||||||
|
if definition.PromptID == promptID {
|
||||||
|
return definition
|
||||||
|
}
|
||||||
|
}
|
||||||
|
panic("unknown fixture prompt " + promptID)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGenerateDetailedPublishesOnlySelectedOutput(t *testing.T) {
|
||||||
|
cfg := config.Defaults()
|
||||||
|
cfg.WeatherAPI.Timezone, cfg.Location.ID = "America/Chicago", "home"
|
||||||
|
bundle := generationBundle(t)
|
||||||
|
executor := &generationExecutor{}
|
||||||
|
workingDir := t.TempDir()
|
||||||
|
result, err := GenerateDetailed(context.Background(), GenerateRequest{Config: cfg, Report: ReportDaily, Date: generationTime("2026-05-29T12:00:00-05:00"), Now: generationTime("2026-05-29T08:30:00-05:00"), WorkingDir: workingDir, Collector: &generationCollector{bundle: &bundle}, Executor: executor})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GenerateDetailed() error = %v", err)
|
||||||
|
}
|
||||||
|
if !executor.called || result.OutputPath != filepath.Join(workingDir, "daily-2026-05-29.md") || result.ValidationStatus != promptexec.ValidationPassed || result.ProfileID == "" || result.BackendID == "" || result.ModelName == "" {
|
||||||
|
t.Fatalf("result = %#v", result)
|
||||||
|
}
|
||||||
|
if result.LLMDebugPath != "" {
|
||||||
|
t.Fatalf("unexpected debug output = %q", result.LLMDebugPath)
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(filepath.Join(workingDir, "workspace")); !os.IsNotExist(err) {
|
||||||
|
t.Fatalf("unexpected default state directory: %v", err)
|
||||||
|
}
|
||||||
|
data, err := os.ReadFile(result.OutputPath)
|
||||||
|
if err != nil || len(data) == 0 {
|
||||||
|
t.Fatalf("output = %q, error = %v", data, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGenerateDetailedReturnsResolvedResultWhenCollectionFails(t *testing.T) {
|
||||||
|
cfg := config.Defaults()
|
||||||
|
cfg.WeatherAPI.Timezone, cfg.Location.ID = "America/Chicago", "home"
|
||||||
|
collectionErr := errors.New("weather source unavailable")
|
||||||
|
result, err := GenerateDetailed(context.Background(), GenerateRequest{
|
||||||
|
Config: cfg, Report: ReportDaily, Date: generationTime("2026-05-29T12:00:00-05:00"), Now: generationTime("2026-05-29T08:30:00-05:00"),
|
||||||
|
WorkingDir: t.TempDir(), Collector: &generationCollector{err: collectionErr}, Executor: &generationExecutor{},
|
||||||
|
})
|
||||||
|
if !errors.Is(err, collectionErr) {
|
||||||
|
t.Fatalf("GenerateDetailed() error = %v, want %v", err, collectionErr)
|
||||||
|
}
|
||||||
|
if result == nil || result.ReportID != report.Daily || result.RunID == "" || result.ProfileID != "fixture" || result.BackendID != "fixture" || result.ModelName != "fixture-model" || result.OutputPath != "" {
|
||||||
|
t.Fatalf("result = %#v", result)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGenerateDetailedInspectsPromptBeforeCollectingWeather(t *testing.T) {
|
||||||
|
cfg := generationConfig()
|
||||||
|
inspectionErr := errors.New("profile is invalid")
|
||||||
|
collector := &generationCollector{bundle: generationBundlePointer(t)}
|
||||||
|
result, err := GenerateDetailed(context.Background(), GenerateRequest{Config: cfg, Report: ReportDaily, Date: generationTime("2026-05-29T12:00:00-05:00"), Now: generationTime("2026-05-29T08:30:00-05:00"), WorkingDir: t.TempDir(), Collector: collector, Executor: &generationExecutor{inspectErr: inspectionErr}})
|
||||||
|
if !errors.Is(err, inspectionErr) || collector.called || result == nil {
|
||||||
|
t.Fatalf("GenerateDetailed() result/error/collector-called = %#v/%v/%t", result, err, collector.called)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGenerateDetailedPreservesDestinationBeforePublish(t *testing.T) {
|
||||||
|
for _, scenario := range []struct {
|
||||||
|
name string
|
||||||
|
executor generationExecutor
|
||||||
|
}{
|
||||||
|
{name: "generation", executor: generationExecutor{executeErr: errors.New("provider unavailable")}},
|
||||||
|
{name: "render", executor: generationExecutor{rawOutput: []byte(`{"summary":""}`)}},
|
||||||
|
} {
|
||||||
|
t.Run(scenario.name, func(t *testing.T) {
|
||||||
|
outputPath := filepath.Join(t.TempDir(), "daily.md")
|
||||||
|
if err := os.WriteFile(outputPath, []byte("previous report"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
bundle := generationBundle(t)
|
||||||
|
result, err := GenerateDetailed(context.Background(), GenerateRequest{Config: generationConfig(), Report: ReportDaily, Date: generationTime("2026-05-29T12:00:00-05:00"), Now: generationTime("2026-05-29T08:30:00-05:00"), WorkingDir: t.TempDir(), OutputPath: outputPath, Collector: &generationCollector{bundle: &bundle}, Executor: &scenario.executor})
|
||||||
|
data, readErr := os.ReadFile(outputPath)
|
||||||
|
if err == nil || result == nil || readErr != nil || string(data) != "previous report" {
|
||||||
|
t.Fatalf("GenerateDetailed() result/error/output = %#v/%v/%q (%v)", result, err, data, readErr)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGenerateDetailedPreservesDestinationWhenContextCancelsBeforePublication(t *testing.T) {
|
||||||
|
outputPath := filepath.Join(t.TempDir(), "daily.md")
|
||||||
|
const previousReport = "previous report"
|
||||||
|
if err := os.WriteFile(outputPath, []byte(previousReport), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
bundle := generationBundle(t)
|
||||||
|
result, err := GenerateDetailed(ctx, GenerateRequest{
|
||||||
|
Config: generationConfig(), Report: ReportDaily,
|
||||||
|
Date: generationTime("2026-05-29T12:00:00-05:00"), Now: generationTime("2026-05-29T08:30:00-05:00"),
|
||||||
|
WorkingDir: t.TempDir(), OutputPath: outputPath, Collector: &generationCollector{bundle: &bundle}, Executor: &generationExecutor{cancelBeforeReturn: cancel},
|
||||||
|
})
|
||||||
|
data, readErr := os.ReadFile(outputPath)
|
||||||
|
if !errors.Is(err, context.Canceled) || promptexec.CategoryOf(err) != promptexec.Canceled || result == nil || result.OutputPath != "" || readErr != nil || string(data) != previousReport {
|
||||||
|
t.Fatalf("GenerateDetailed() result/error/output = %#v/%v/%q (%v)", result, err, data, readErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGenerateDetailedPreservesDestinationWhenContextDeadlineExpiresBeforePublication(t *testing.T) {
|
||||||
|
outputPath := filepath.Join(t.TempDir(), "daily.md")
|
||||||
|
const previousReport = "previous report"
|
||||||
|
if err := os.WriteFile(outputPath, []byte(previousReport), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithDeadline(context.Background(), time.Unix(0, 0))
|
||||||
|
defer cancel()
|
||||||
|
bundle := generationBundle(t)
|
||||||
|
result, err := GenerateDetailed(ctx, GenerateRequest{
|
||||||
|
Config: generationConfig(), Report: ReportDaily,
|
||||||
|
Date: generationTime("2026-05-29T12:00:00-05:00"), Now: generationTime("2026-05-29T08:30:00-05:00"),
|
||||||
|
WorkingDir: t.TempDir(), OutputPath: outputPath, Collector: &generationCollector{bundle: &bundle}, Executor: &generationExecutor{},
|
||||||
|
})
|
||||||
|
data, readErr := os.ReadFile(outputPath)
|
||||||
|
if !errors.Is(err, context.DeadlineExceeded) || promptexec.CategoryOf(err) != promptexec.DeadlineExceeded || result == nil || result.OutputPath != "" || readErr != nil || string(data) != previousReport {
|
||||||
|
t.Fatalf("GenerateDetailed() result/error/output = %#v/%v/%q (%v)", result, err, data, readErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGenerateDetailedRetainsPublishedOutputWhenNotificationFails(t *testing.T) {
|
||||||
|
cfg := generationConfig()
|
||||||
|
cfg.Notify.Distributor.Enabled = true
|
||||||
|
cfg.Notify.Distributor.PipelineIDTemplate = "weather"
|
||||||
|
bundle := generationBundle(t)
|
||||||
|
outputPath := filepath.Join(t.TempDir(), "daily.md")
|
||||||
|
notifier := &generationNotifier{err: errors.New("distributor unavailable")}
|
||||||
|
result, err := GenerateDetailed(context.Background(), GenerateRequest{Config: cfg, Report: ReportDaily, Date: generationTime("2026-05-29T12:00:00-05:00"), Now: generationTime("2026-05-29T08:30:00-05:00"), WorkingDir: t.TempDir(), OutputPath: outputPath, Collector: &generationCollector{bundle: &bundle}, Executor: &generationExecutor{}, Notifier: notifier})
|
||||||
|
if err == nil || result == nil || result.OutputPath != outputPath || notifier.request.ReportPath != outputPath || len(notifier.request.BundlePaths) == 0 {
|
||||||
|
t.Fatalf("GenerateDetailed() result/error/request = %#v/%v/%#v", result, err, notifier.request)
|
||||||
|
}
|
||||||
|
if data, readErr := os.ReadFile(outputPath); readErr != nil || len(data) == 0 {
|
||||||
|
t.Fatalf("published output = %q, error = %v", data, readErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGenerateDetailedDoesNotReplaceDirectoryOutput(t *testing.T) {
|
||||||
|
bundle := generationBundle(t)
|
||||||
|
outputPath := filepath.Join(t.TempDir(), "daily.md")
|
||||||
|
if err := os.Mkdir(outputPath, 0o700); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
result, err := GenerateDetailed(context.Background(), GenerateRequest{Config: generationConfig(), Report: ReportDaily, Date: generationTime("2026-05-29T12:00:00-05:00"), Now: generationTime("2026-05-29T08:30:00-05:00"), WorkingDir: t.TempDir(), OutputPath: outputPath, Collector: &generationCollector{bundle: &bundle}, Executor: &generationExecutor{}})
|
||||||
|
info, statErr := os.Stat(outputPath)
|
||||||
|
if err == nil || result == nil || statErr != nil || !info.IsDir() {
|
||||||
|
t.Fatalf("GenerateDetailed() result/error/output-info = %#v/%v/%#v (%v)", result, err, info, statErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func generationConfig() config.Config {
|
||||||
|
cfg := config.Defaults()
|
||||||
|
cfg.WeatherAPI.Timezone, cfg.Location.ID = "America/Chicago", "home"
|
||||||
|
return cfg
|
||||||
|
}
|
||||||
|
|
||||||
|
func generationBundlePointer(t *testing.T) *weatherdata.Bundle {
|
||||||
|
bundle := generationBundle(t)
|
||||||
|
return &bundle
|
||||||
|
}
|
||||||
|
|
||||||
|
type generationNotifier struct {
|
||||||
|
err error
|
||||||
|
batchErr error
|
||||||
|
request NotificationRequest
|
||||||
|
batchRequest batchNotificationRequest
|
||||||
|
batchCalls int
|
||||||
|
}
|
||||||
|
|
||||||
|
func (n *generationNotifier) Notify(_ context.Context, request NotificationRequest) (*NotificationResult, error) {
|
||||||
|
n.request = request
|
||||||
|
return nil, n.err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (n *generationNotifier) NotifyBatch(_ context.Context, request batchNotificationRequest) (*NotificationResult, error) {
|
||||||
|
n.batchCalls++
|
||||||
|
n.batchRequest = request
|
||||||
|
for _, file := range request.Files {
|
||||||
|
if _, err := os.Stat(file.SourcePath); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return &NotificationResult{Status: "succeeded", PipelineID: request.PipelineID, BundleID: request.BundleID}, n.batchErr
|
||||||
|
}
|
||||||
|
|
||||||
|
func generationBundle(t *testing.T) weatherdata.Bundle {
|
||||||
|
t.Helper()
|
||||||
|
data, err := os.ReadFile(filepath.Join("..", "forecast", "testdata", "daily_bundle.json"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("read bundle fixture: %v", err)
|
||||||
|
}
|
||||||
|
var bundle weatherdata.Bundle
|
||||||
|
if err := json.Unmarshal(data, &bundle); err != nil {
|
||||||
|
t.Fatalf("decode bundle fixture: %v", err)
|
||||||
|
}
|
||||||
|
return bundle
|
||||||
|
}
|
||||||
|
func generationTime(value string) time.Time {
|
||||||
|
parsed, _ := time.Parse(time.RFC3339, value)
|
||||||
|
return parsed
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ promptexec.Executor = (*generationExecutor)(nil)
|
||||||
|
var _ Collector = (*generationCollector)(nil)
|
||||||
|
var _ Notifier = (*generationNotifier)(nil)
|
||||||
|
var _ = report.Daily
|
||||||
@@ -1,126 +0,0 @@
|
|||||||
package app
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/briefing"
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/config"
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/module"
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/promptinput"
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/state"
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/timeutil"
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/weatherdata"
|
|
||||||
)
|
|
||||||
|
|
||||||
type InspectReportsRequest struct {
|
|
||||||
Config config.Config
|
|
||||||
Limit int
|
|
||||||
}
|
|
||||||
|
|
||||||
type InspectRunRequest struct {
|
|
||||||
Config config.Config
|
|
||||||
RunID string
|
|
||||||
}
|
|
||||||
|
|
||||||
type SourceInspection struct {
|
|
||||||
RunID string `json:"runId"`
|
|
||||||
ReportID report.ID `json:"reportId"`
|
|
||||||
SourceLocation string `json:"sourceLocation,omitempty"`
|
|
||||||
Sources []briefing.SourceMetadata `json:"sources,omitempty"`
|
|
||||||
Warnings []weatherdata.SourceWarning `json:"warnings,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func InspectReports(ctx context.Context, req InspectReportsRequest) ([]state.ReportRecord, error) {
|
|
||||||
store, err := defaultStore(req.Config)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return store.ListReports(ctx, req.Limit)
|
|
||||||
}
|
|
||||||
|
|
||||||
func InspectMetadata(ctx context.Context, req InspectRunRequest) (state.Metadata, error) {
|
|
||||||
inspection, err := inspectRun(ctx, req)
|
|
||||||
return inspection.metadata, err
|
|
||||||
}
|
|
||||||
|
|
||||||
func InspectModules(ctx context.Context, req InspectRunRequest) (module.Snapshot, error) {
|
|
||||||
inspection, err := inspectRun(ctx, req)
|
|
||||||
if err != nil {
|
|
||||||
return module.Snapshot{}, err
|
|
||||||
}
|
|
||||||
return inspection.store.LoadModuleSnapshot(ctx, inspection.metadata.ModuleSnapshotPath)
|
|
||||||
}
|
|
||||||
|
|
||||||
func InspectDataPackage(ctx context.Context, req InspectRunRequest) (promptinput.Package, error) {
|
|
||||||
inspection, err := inspectRun(ctx, req)
|
|
||||||
if err != nil {
|
|
||||||
return promptinput.Package{}, err
|
|
||||||
}
|
|
||||||
return inspection.store.LoadDataPackage(ctx, inspection.metadata.DataPackagePath)
|
|
||||||
}
|
|
||||||
|
|
||||||
func InspectPriorSnapshot(ctx context.Context, req InspectRunRequest) (*state.PriorSnapshot, error) {
|
|
||||||
inspection, err := inspectRun(ctx, req)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
resolved, err := resolvedFromMetadata(inspection.metadata)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return inspection.store.FindPriorSnapshot(ctx, resolved)
|
|
||||||
}
|
|
||||||
|
|
||||||
func InspectSources(ctx context.Context, req InspectRunRequest) (SourceInspection, error) {
|
|
||||||
inspection, err := inspectRun(ctx, req)
|
|
||||||
if err != nil {
|
|
||||||
return SourceInspection{}, err
|
|
||||||
}
|
|
||||||
metadata := inspection.metadata
|
|
||||||
return SourceInspection{
|
|
||||||
RunID: metadata.RunID,
|
|
||||||
ReportID: metadata.ReportID,
|
|
||||||
SourceLocation: metadata.SourceLocation,
|
|
||||||
Sources: metadata.Sources,
|
|
||||||
Warnings: metadata.SourceWarnings,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
type runInspection struct {
|
|
||||||
store *state.FilesystemStore
|
|
||||||
metadata state.Metadata
|
|
||||||
}
|
|
||||||
|
|
||||||
func inspectRun(ctx context.Context, req InspectRunRequest) (runInspection, error) {
|
|
||||||
store, err := defaultStore(req.Config)
|
|
||||||
if err != nil {
|
|
||||||
return runInspection{}, err
|
|
||||||
}
|
|
||||||
metadata, _, err := store.LoadMetadataByRunID(ctx, req.RunID)
|
|
||||||
if err != nil {
|
|
||||||
return runInspection{}, err
|
|
||||||
}
|
|
||||||
return runInspection{store: store, metadata: metadata}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func resolvedFromMetadata(metadata state.Metadata) (report.Resolved, error) {
|
|
||||||
definition, err := report.DefaultRegistry().Lookup(metadata.ReportID)
|
|
||||||
if err != nil {
|
|
||||||
return report.Resolved{}, err
|
|
||||||
}
|
|
||||||
location, err := timeutil.LoadLocation(metadata.Timezone)
|
|
||||||
if err != nil {
|
|
||||||
return report.Resolved{}, err
|
|
||||||
}
|
|
||||||
if !metadata.ValidPeriod.IsValid() {
|
|
||||||
return report.Resolved{}, fmt.Errorf("metadata valid period for run id %q is invalid", metadata.RunID)
|
|
||||||
}
|
|
||||||
return report.Resolved{
|
|
||||||
Definition: definition,
|
|
||||||
GeneratedAt: metadata.GeneratedAt,
|
|
||||||
Timezone: location.String(),
|
|
||||||
ValidPeriod: metadata.ValidPeriod,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
214
internal/app/prompt_generate.go
Normal file
214
internal/app/prompt_generate.go
Normal file
@@ -0,0 +1,214 @@
|
|||||||
|
package app
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/briefing"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/collect"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/fileutil"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/generatedtext"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/module"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/promptdebug"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/promptexec"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/promptinput"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/weatherdata"
|
||||||
|
)
|
||||||
|
|
||||||
|
type promptReportRequest struct {
|
||||||
|
GenerateRequest
|
||||||
|
Resolved report.Resolved
|
||||||
|
Collection collect.Result
|
||||||
|
Inspection PromptInspectionResult
|
||||||
|
DebugWriter *promptdebug.PromptDebugWriter
|
||||||
|
Result *ReportResult
|
||||||
|
noNotify bool
|
||||||
|
}
|
||||||
|
|
||||||
|
type promptReportWorkflow struct {
|
||||||
|
ctx context.Context
|
||||||
|
req promptReportRequest
|
||||||
|
result *ReportResult
|
||||||
|
briefingMetadata briefing.Metadata
|
||||||
|
reportFacts ReportFacts
|
||||||
|
moduleSnapshot module.Snapshot
|
||||||
|
dataPackage []byte
|
||||||
|
handler generatedtext.Handler
|
||||||
|
debugRef promptdebug.PromptDebugRef
|
||||||
|
callbackFailed bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func generatePromptReport(ctx context.Context, req promptReportRequest) (*ReportResult, error) {
|
||||||
|
workflow, err := newPromptReportWorkflow(ctx, req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := workflow.buildInputs(); err != nil {
|
||||||
|
return workflow.result, err
|
||||||
|
}
|
||||||
|
execution, err := workflow.executePrompt()
|
||||||
|
if err != nil {
|
||||||
|
if workflow.callbackFailed {
|
||||||
|
return workflow.result, err
|
||||||
|
}
|
||||||
|
return workflow.result, workflow.reportError("execute prompt", classifiedPromptError("prompt execution failed", err))
|
||||||
|
}
|
||||||
|
if execution == nil {
|
||||||
|
return workflow.result, workflow.reportError("execute prompt", promptexec.NewError(promptexec.Generation, "prompt executor returned no execution", nil))
|
||||||
|
}
|
||||||
|
workflow.result.ValidationStatus = execution.Validation.Status
|
||||||
|
if err := workflow.writeExecutionDebug(*execution); err != nil {
|
||||||
|
return workflow.result, err
|
||||||
|
}
|
||||||
|
if execution.Validation.Status != promptexec.ValidationPassed && execution.Validation.Status != promptexec.ValidationFailed {
|
||||||
|
return workflow.result, workflow.reportError("validate prompt execution", promptexec.NewError(promptexec.OperationalValidation, "prompt execution did not complete validation", nil))
|
||||||
|
}
|
||||||
|
if execution.Validation.Status == promptexec.ValidationFailed {
|
||||||
|
return workflow.result, workflow.reportError("validate prompt execution", promptexec.NewError(promptexec.ValidationRejected, "prompt output did not satisfy its schema", nil))
|
||||||
|
}
|
||||||
|
return workflow.renderAndPublish(execution.RawOutput)
|
||||||
|
}
|
||||||
|
|
||||||
|
func newPromptReportWorkflow(ctx context.Context, req promptReportRequest) (*promptReportWorkflow, error) {
|
||||||
|
if req.Collection.Bundle == nil {
|
||||||
|
return nil, fmt.Errorf("collected weather bundle is required")
|
||||||
|
}
|
||||||
|
result := req.Result
|
||||||
|
if result == nil {
|
||||||
|
result = initialReportResult(req.GenerateRequest, req.Resolved, req.Inspection)
|
||||||
|
}
|
||||||
|
return &promptReportWorkflow{
|
||||||
|
ctx: ctx, req: req,
|
||||||
|
result: result,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func initialReportResult(req GenerateRequest, resolved report.Resolved, inspection PromptInspectionResult) *ReportResult {
|
||||||
|
metadata := resolved.Metadata()
|
||||||
|
return &ReportResult{
|
||||||
|
ReportID: resolved.Definition.ID, ReportName: resolved.Definition.Name,
|
||||||
|
PromptID: resolved.Definition.PromptID, PromptVersion: resolved.Definition.PromptVersion,
|
||||||
|
RunID: metadata.RunID, GeneratedAt: metadata.GeneratedAt, Timezone: req.Config.WeatherAPI.Timezone,
|
||||||
|
ValidPeriod: metadata.ValidPeriod,
|
||||||
|
ProfileID: inspection.ProfileID, BackendID: inspection.BackendID, ModelName: inspection.ModelName,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *promptReportWorkflow) buildInputs() error {
|
||||||
|
var err error
|
||||||
|
w.reportFacts, err = BuildReportFacts(ModuleSnapshotRequest{Config: w.req.Config, Resolved: w.req.Resolved}, w.req.Collection.Bundle)
|
||||||
|
if err != nil {
|
||||||
|
return w.reportError("build report facts", err)
|
||||||
|
}
|
||||||
|
w.moduleSnapshot, err = BuildModuleSnapshotFromFacts(ModuleSnapshotRequest{Config: w.req.Config, Resolved: w.req.Resolved}, w.reportFacts)
|
||||||
|
if err != nil {
|
||||||
|
return w.reportError("build module snapshot", err)
|
||||||
|
}
|
||||||
|
w.briefingMetadata = briefing.BuildMetadata(briefingBuildContext(w.req.Config, w.req.Resolved, w.reportFacts.Collected))
|
||||||
|
w.result.SourceWarnings = append([]weatherdata.SourceWarning(nil), w.briefingMetadata.SourceWarnings...)
|
||||||
|
dataPackage, err := promptinput.Build(promptinput.BuildRequest{Metadata: promptMetadata(w.briefingMetadata), Modules: w.moduleSnapshot})
|
||||||
|
if err != nil {
|
||||||
|
return w.reportError("build data package", err)
|
||||||
|
}
|
||||||
|
w.dataPackage, err = promptinput.MarshalYAML(dataPackage)
|
||||||
|
if err != nil {
|
||||||
|
return w.reportError("marshal data package", err)
|
||||||
|
}
|
||||||
|
w.handler, err = generatedtext.LookupDefinition(w.req.Resolved.Definition)
|
||||||
|
if err != nil {
|
||||||
|
return w.reportError("lookup generated text catalog", err)
|
||||||
|
}
|
||||||
|
w.debugRef = promptdebug.PromptDebugRef{ReportID: w.result.ReportID, ValidDate: w.req.Resolved.ValidPeriod.Start.Format("2006-01-02"), RunID: w.result.RunID}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *promptReportWorkflow) executePrompt() (*promptexec.Execution, error) {
|
||||||
|
captureDebug := w.req.DebugWriter != nil && w.req.DebugWriter.Enabled()
|
||||||
|
return w.req.Executor.Execute(w.ctx, promptexec.ExecuteRequest{PromptID: w.req.Inspection.PromptID, PromptVersion: w.req.Inspection.PromptVersion, ProfileID: w.req.Inspection.ProfileID, DataPackage: w.dataPackage, CaptureDebug: captureDebug}, w.writePreparationDebug)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *promptReportWorkflow) writePreparationDebug(preparation promptexec.Preparation, debug *promptexec.PreparationDebug) error {
|
||||||
|
w.result.ProfileID, w.result.BackendID, w.result.ModelName = preparation.ProfileID, preparation.BackendID, preparation.ModelName
|
||||||
|
if w.req.DebugWriter == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
path, err := w.req.DebugWriter.WritePreparation(w.debugRef, preparation, debug)
|
||||||
|
if err != nil {
|
||||||
|
w.callbackFailed = true
|
||||||
|
return promptDebugWriteError(err)
|
||||||
|
}
|
||||||
|
w.result.LLMDebugPath = path
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *promptReportWorkflow) writeExecutionDebug(execution promptexec.Execution) error {
|
||||||
|
if w.req.DebugWriter == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
path, err := w.req.DebugWriter.WriteExecution(w.debugRef, execution)
|
||||||
|
if err != nil {
|
||||||
|
return w.reportError("write prompt debug", promptDebugWriteError(err))
|
||||||
|
}
|
||||||
|
if path != "" {
|
||||||
|
w.result.LLMDebugPath = path
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *promptReportWorkflow) renderAndPublish(raw []byte) (*ReportResult, error) {
|
||||||
|
generatedText, _, err := w.handler.Validate(raw)
|
||||||
|
if err != nil {
|
||||||
|
return w.result, w.reportError("validate generated text", err)
|
||||||
|
}
|
||||||
|
renderContext, err := w.handler.BuildRenderContext(w.briefingMetadata, w.moduleSnapshot, w.reportFacts.Collected, w.reportFacts.Derived, generatedText)
|
||||||
|
if err != nil {
|
||||||
|
return w.result, w.reportError("build render context", err)
|
||||||
|
}
|
||||||
|
rendered, err := w.handler.Render(renderContext)
|
||||||
|
if err != nil {
|
||||||
|
return w.result, w.reportError("render template", err)
|
||||||
|
}
|
||||||
|
if err := publicationContextError(w.ctx); err != nil {
|
||||||
|
return w.result, w.reportError("publish report", err)
|
||||||
|
}
|
||||||
|
if err := fileutil.WriteFileAtomic(w.req.OutputPath, rendered); err != nil {
|
||||||
|
return w.result, err
|
||||||
|
}
|
||||||
|
w.result.OutputPath = w.req.OutputPath
|
||||||
|
if w.req.noNotify {
|
||||||
|
return w.result, nil
|
||||||
|
}
|
||||||
|
notification, err := notifyReport(w.ctx, w.req.Config, w.req.Resolved, w.result.OutputPath, w.result.RunID, w.result.GeneratedAt, w.req.Notifier)
|
||||||
|
w.result.Notification = notification
|
||||||
|
if err != nil {
|
||||||
|
return w.result, err
|
||||||
|
}
|
||||||
|
return w.result, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *promptReportWorkflow) reportError(operation string, err error) error {
|
||||||
|
return generatedReportError(w.req.Resolved, w.result.RunID, operation, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func classifiedPromptError(operation string, err error) error {
|
||||||
|
if promptexec.CategoryOf(err) != "" {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return promptexec.NewError(promptexec.Generation, operation, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func publicationContextError(ctx context.Context) error {
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
if errors.Is(err, context.DeadlineExceeded) {
|
||||||
|
return promptexec.NewError(promptexec.DeadlineExceeded, "context expired before output publication", err)
|
||||||
|
}
|
||||||
|
return promptexec.NewError(promptexec.Canceled, "context canceled before output publication", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func promptDebugWriteError(err error) error {
|
||||||
|
return promptexec.NewError(promptexec.InvalidConfiguration, "write requested prompt debug artifact", err)
|
||||||
|
}
|
||||||
142
internal/app/prompt_inspection.go
Normal file
142
internal/app/prompt_inspection.go
Normal file
@@ -0,0 +1,142 @@
|
|||||||
|
package app
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/config"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/promptexec"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
|
||||||
|
)
|
||||||
|
|
||||||
|
// PromptInspectionRequest contains the non-executing inputs required to
|
||||||
|
// validate one report's configured prompt and profile.
|
||||||
|
type PromptInspectionRequest struct {
|
||||||
|
Resolved report.Resolved
|
||||||
|
Executor promptexec.Executor
|
||||||
|
Promptkit config.PromptkitConfig
|
||||||
|
LookupEnv func(string) (string, bool)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PromptInspectionResult contains only safe identity and provenance from a
|
||||||
|
// prompt/profile inspection.
|
||||||
|
type PromptInspectionResult struct {
|
||||||
|
PromptID string
|
||||||
|
PromptVersion string
|
||||||
|
PromptHash string
|
||||||
|
ProfileID string
|
||||||
|
BackendID string
|
||||||
|
ModelName string
|
||||||
|
}
|
||||||
|
|
||||||
|
// PromptExecutionsInspectionRequest validates all prompt/profile combinations
|
||||||
|
// needed by a batch before collection begins.
|
||||||
|
type PromptExecutionsInspectionRequest struct {
|
||||||
|
Resolved []report.Resolved
|
||||||
|
Executor promptexec.Executor
|
||||||
|
Promptkit config.PromptkitConfig
|
||||||
|
LookupEnv func(string) (string, bool)
|
||||||
|
}
|
||||||
|
|
||||||
|
// InspectPromptExecution validates the exact prompt and profile needed for a
|
||||||
|
// report before collection, execution, or durable writes begin.
|
||||||
|
func InspectPromptExecution(ctx context.Context, req PromptInspectionRequest) (PromptInspectionResult, error) {
|
||||||
|
results, err := InspectPromptExecutions(ctx, PromptExecutionsInspectionRequest{
|
||||||
|
Resolved: []report.Resolved{req.Resolved},
|
||||||
|
Executor: req.Executor,
|
||||||
|
Promptkit: req.Promptkit,
|
||||||
|
LookupEnv: req.LookupEnv,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return PromptInspectionResult{}, err
|
||||||
|
}
|
||||||
|
return results[req.Resolved.Definition.ID], nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// InspectPromptExecutions validates exact prompt contracts and their unique
|
||||||
|
// effective profiles. It performs no collection, execution, or durable write.
|
||||||
|
func InspectPromptExecutions(ctx context.Context, req PromptExecutionsInspectionRequest) (map[report.ID]PromptInspectionResult, error) {
|
||||||
|
if req.Executor == nil {
|
||||||
|
return nil, promptexec.NewError(promptexec.InvalidConfiguration, "prompt executor is required", nil)
|
||||||
|
}
|
||||||
|
results := make(map[report.ID]PromptInspectionResult, len(req.Resolved))
|
||||||
|
profiles := map[string]promptexec.ProfileInspection{}
|
||||||
|
for _, resolved := range req.Resolved {
|
||||||
|
definition := resolved.Definition
|
||||||
|
if strings.TrimSpace(definition.PromptID) == "" || strings.TrimSpace(definition.PromptVersion) == "" {
|
||||||
|
return nil, promptexec.NewError(promptexec.InvalidConfiguration, "report prompt identity is incomplete", nil)
|
||||||
|
}
|
||||||
|
inspection, err := req.Executor.InspectPrompt(ctx, definition.PromptID, definition.PromptVersion)
|
||||||
|
if err != nil {
|
||||||
|
return nil, promptInspectionError("prompt inspection failed", err)
|
||||||
|
}
|
||||||
|
if inspection.PromptID != definition.PromptID || inspection.PromptVersion != definition.PromptVersion {
|
||||||
|
return nil, promptexec.NewError(promptexec.InvalidConfiguration, "prompt inspection did not return the requested prompt version", nil)
|
||||||
|
}
|
||||||
|
if !validPromptInput(inspection.Inputs) {
|
||||||
|
return nil, promptexec.NewError(promptexec.InvalidConfiguration, "prompt must declare exactly one required application/yaml data_package input", nil)
|
||||||
|
}
|
||||||
|
if !validPromptOutput(definition, inspection.Output) {
|
||||||
|
return nil, promptexec.NewError(promptexec.InvalidConfiguration, "prompt must declare the report JSON Schema output contract", nil)
|
||||||
|
}
|
||||||
|
profileID := req.Promptkit.Profile
|
||||||
|
if profileID == "" {
|
||||||
|
profileID = inspection.DefaultProfileID
|
||||||
|
}
|
||||||
|
if strings.TrimSpace(profileID) == "" {
|
||||||
|
return nil, promptexec.NewError(promptexec.InvalidConfiguration, "prompt has no execution profile", nil)
|
||||||
|
}
|
||||||
|
profile, ok := profiles[profileID]
|
||||||
|
if !ok {
|
||||||
|
profile, err = inspectPromptProfile(ctx, req.Executor, profileID, req.LookupEnv)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
profiles[profileID] = profile
|
||||||
|
}
|
||||||
|
results[definition.ID] = PromptInspectionResult{
|
||||||
|
PromptID: inspection.PromptID, PromptVersion: inspection.PromptVersion, PromptHash: inspection.PromptHash,
|
||||||
|
ProfileID: profile.ProfileID, BackendID: profile.BackendID, ModelName: profile.ModelName,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return results, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func inspectPromptProfile(ctx context.Context, executor promptexec.Executor, profileID string, lookupEnv func(string) (string, bool)) (promptexec.ProfileInspection, error) {
|
||||||
|
profile, err := executor.InspectProfile(ctx, profileID)
|
||||||
|
if err != nil {
|
||||||
|
return promptexec.ProfileInspection{}, promptInspectionError("profile inspection failed", err)
|
||||||
|
}
|
||||||
|
if profile.ProfileID != profileID {
|
||||||
|
return promptexec.ProfileInspection{}, promptexec.NewError(promptexec.InvalidConfiguration, "profile inspection did not return the selected profile", nil)
|
||||||
|
}
|
||||||
|
if profile.CredentialRequired {
|
||||||
|
return promptexec.ProfileInspection{}, promptexec.NewError(promptexec.MissingCredential, "selected profile requires an unsupported direct API key", nil)
|
||||||
|
}
|
||||||
|
if strings.TrimSpace(profile.APIKeyEnv) != "" {
|
||||||
|
if lookupEnv == nil {
|
||||||
|
lookupEnv = os.LookupEnv
|
||||||
|
}
|
||||||
|
value, present := lookupEnv(profile.APIKeyEnv)
|
||||||
|
if !present || strings.TrimSpace(value) == "" {
|
||||||
|
return promptexec.ProfileInspection{}, promptexec.NewError(promptexec.MissingCredential, "selected profile credential is unavailable", nil)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return profile, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func validPromptInput(inputs []promptexec.InputDefinition) bool {
|
||||||
|
return len(inputs) == 1 && inputs[0].Name == "data_package" && inputs[0].Required && inputs[0].ContentType == "application/yaml"
|
||||||
|
}
|
||||||
|
|
||||||
|
func validPromptOutput(definition report.Definition, output promptexec.OutputContract) bool {
|
||||||
|
return output.Format == "json" && output.ValidationMode == "json_schema" && output.SchemaPath == definition.GeneratedTextSchemaID+".generated_text.schema.json"
|
||||||
|
}
|
||||||
|
|
||||||
|
func promptInspectionError(operation string, err error) error {
|
||||||
|
if promptexec.CategoryOf(err) != "" {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return promptexec.NewError(promptexec.InvalidConfiguration, operation, err)
|
||||||
|
}
|
||||||
201
internal/app/prompt_inspection_test.go
Normal file
201
internal/app/prompt_inspection_test.go
Normal file
@@ -0,0 +1,201 @@
|
|||||||
|
package app
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/config"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/promptexec"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestInspectPromptExecutionSelectsDefaultAndOverrideProfiles(t *testing.T) {
|
||||||
|
resolved := inspectionResolved(t)
|
||||||
|
executor := &inspectionExecutor{
|
||||||
|
prompt: validPromptInspection(resolved.Definition),
|
||||||
|
profiles: map[string]promptexec.ProfileInspection{
|
||||||
|
"default-profile": {ProfileID: "default-profile", BackendID: "local", ModelName: "default-model"},
|
||||||
|
"override-profile": {ProfileID: "override-profile", BackendID: "cloud", ModelName: "override-model"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
defaultResult, err := InspectPromptExecution(context.Background(), PromptInspectionRequest{Resolved: resolved, Executor: executor})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("InspectPromptExecution(default) error = %v", err)
|
||||||
|
}
|
||||||
|
if defaultResult.ProfileID != "default-profile" || defaultResult.ModelName != "default-model" {
|
||||||
|
t.Fatalf("default result = %#v", defaultResult)
|
||||||
|
}
|
||||||
|
overrideResult, err := InspectPromptExecution(context.Background(), PromptInspectionRequest{
|
||||||
|
Resolved: resolved, Executor: executor, Promptkit: config.PromptkitConfig{Profile: "override-profile"},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("InspectPromptExecution(override) error = %v", err)
|
||||||
|
}
|
||||||
|
if overrideResult.ProfileID != "override-profile" || overrideResult.ModelName != "override-model" {
|
||||||
|
t.Fatalf("override result = %#v", overrideResult)
|
||||||
|
}
|
||||||
|
if len(executor.promptRequests) != 2 || executor.promptRequests[0].version != resolved.Definition.PromptVersion || executor.profileRequests[0] != "default-profile" || executor.profileRequests[1] != "override-profile" {
|
||||||
|
t.Fatalf("inspection requests = prompts %#v profiles %#v", executor.promptRequests, executor.profileRequests)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInspectPromptExecutionRejectsInvalidContractsAndCredentials(t *testing.T) {
|
||||||
|
resolved := inspectionResolved(t)
|
||||||
|
basePrompt := validPromptInspection(resolved.Definition)
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
prompt promptexec.PromptInspection
|
||||||
|
profile promptexec.ProfileInspection
|
||||||
|
lookupEnv func(string) (string, bool)
|
||||||
|
wantCategory promptexec.ErrorCategory
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "extra input",
|
||||||
|
prompt: func() promptexec.PromptInspection {
|
||||||
|
value := basePrompt
|
||||||
|
value.Inputs = append(value.Inputs, promptexec.InputDefinition{Name: "unexpected"})
|
||||||
|
return value
|
||||||
|
}(),
|
||||||
|
wantCategory: promptexec.InvalidConfiguration,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "wrong schema",
|
||||||
|
prompt: func() promptexec.PromptInspection {
|
||||||
|
value := basePrompt
|
||||||
|
value.Output.SchemaPath = "unexpected.schema.json"
|
||||||
|
return value
|
||||||
|
}(),
|
||||||
|
wantCategory: promptexec.InvalidConfiguration,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "direct key",
|
||||||
|
prompt: basePrompt,
|
||||||
|
profile: promptexec.ProfileInspection{ProfileID: "default-profile", CredentialRequired: true},
|
||||||
|
wantCategory: promptexec.MissingCredential,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "missing environment credential",
|
||||||
|
prompt: basePrompt,
|
||||||
|
profile: promptexec.ProfileInspection{ProfileID: "default-profile", APIKeyEnv: "PROMPT_API_KEY"},
|
||||||
|
lookupEnv: func(string) (string, bool) { return "", false },
|
||||||
|
wantCategory: promptexec.MissingCredential,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, test := range tests {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
executor := &inspectionExecutor{prompt: test.prompt, profiles: map[string]promptexec.ProfileInspection{"default-profile": test.profile}}
|
||||||
|
_, err := InspectPromptExecution(context.Background(), PromptInspectionRequest{Resolved: resolved, Executor: executor, LookupEnv: test.lookupEnv})
|
||||||
|
if err == nil || promptexec.CategoryOf(err) != test.wantCategory {
|
||||||
|
t.Fatalf("error/category = %v/%q, want %q", err, promptexec.CategoryOf(err), test.wantCategory)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInspectPromptExecutionReturnsSafeInspectionError(t *testing.T) {
|
||||||
|
resolved := inspectionResolved(t)
|
||||||
|
executor := &inspectionExecutor{promptErr: errors.New("provider response contains resolved-secret-value")}
|
||||||
|
_, err := InspectPromptExecution(context.Background(), PromptInspectionRequest{Resolved: resolved, Executor: executor})
|
||||||
|
if err == nil || promptexec.CategoryOf(err) != promptexec.InvalidConfiguration {
|
||||||
|
t.Fatalf("error/category = %v/%q", err, promptexec.CategoryOf(err))
|
||||||
|
}
|
||||||
|
if strings.Contains(err.Error(), "resolved-secret-value") {
|
||||||
|
t.Fatalf("inspection error leaks provider value: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInspectPromptExecutionsReusesEffectiveProfile(t *testing.T) {
|
||||||
|
first := inspectionResolved(t)
|
||||||
|
second := first
|
||||||
|
second.Definition.ID = report.Today
|
||||||
|
second.Definition.PromptID = "weather.today"
|
||||||
|
executor := &inspectionExecutor{
|
||||||
|
prompt: validPromptInspection(first.Definition),
|
||||||
|
profiles: map[string]promptexec.ProfileInspection{
|
||||||
|
"default-profile": {ProfileID: "default-profile", BackendID: "local", ModelName: "model"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
executor.prompts = map[string]promptexec.PromptInspection{
|
||||||
|
first.Definition.PromptID: validPromptInspection(first.Definition),
|
||||||
|
second.Definition.PromptID: validPromptInspection(second.Definition),
|
||||||
|
}
|
||||||
|
results, err := InspectPromptExecutions(context.Background(), PromptExecutionsInspectionRequest{Resolved: []report.Resolved{first, second}, Executor: executor})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("InspectPromptExecutions() error = %v", err)
|
||||||
|
}
|
||||||
|
if len(results) != 2 || len(executor.profileRequests) != 1 {
|
||||||
|
t.Fatalf("results/profile requests = %#v/%#v, want two results and one profile inspection", results, executor.profileRequests)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type inspectionPromptRequest struct {
|
||||||
|
id string
|
||||||
|
version string
|
||||||
|
}
|
||||||
|
|
||||||
|
type inspectionExecutor struct {
|
||||||
|
prompt promptexec.PromptInspection
|
||||||
|
prompts map[string]promptexec.PromptInspection
|
||||||
|
profiles map[string]promptexec.ProfileInspection
|
||||||
|
promptErr error
|
||||||
|
promptRequests []inspectionPromptRequest
|
||||||
|
profileRequests []string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *inspectionExecutor) InspectPrompt(_ context.Context, id string, version string) (promptexec.PromptInspection, error) {
|
||||||
|
e.promptRequests = append(e.promptRequests, inspectionPromptRequest{id: id, version: version})
|
||||||
|
if e.promptErr != nil {
|
||||||
|
return promptexec.PromptInspection{}, e.promptErr
|
||||||
|
}
|
||||||
|
if prompt, ok := e.prompts[id]; ok {
|
||||||
|
return prompt, nil
|
||||||
|
}
|
||||||
|
return e.prompt, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *inspectionExecutor) InspectProfile(_ context.Context, id string) (promptexec.ProfileInspection, error) {
|
||||||
|
e.profileRequests = append(e.profileRequests, id)
|
||||||
|
value, ok := e.profiles[id]
|
||||||
|
if !ok {
|
||||||
|
return promptexec.ProfileInspection{}, errors.New("profile missing")
|
||||||
|
}
|
||||||
|
return value, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *inspectionExecutor) Execute(context.Context, promptexec.ExecuteRequest, promptexec.PreparationCallback) (*promptexec.Execution, error) {
|
||||||
|
return nil, errors.New("unexpected execution")
|
||||||
|
}
|
||||||
|
|
||||||
|
func inspectionResolved(t *testing.T) report.Resolved {
|
||||||
|
t.Helper()
|
||||||
|
resolved, err := report.DefaultRegistry().Resolve(report.Daily, report.ResolveRequest{
|
||||||
|
Now: time.Date(2026, 5, 29, 12, 0, 0, 0, time.UTC),
|
||||||
|
Date: time.Date(2026, 5, 29, 0, 0, 0, 0, time.UTC),
|
||||||
|
Location: time.UTC,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Resolve() error = %v", err)
|
||||||
|
}
|
||||||
|
return resolved
|
||||||
|
}
|
||||||
|
|
||||||
|
func validPromptInspection(definition report.Definition) promptexec.PromptInspection {
|
||||||
|
return promptexec.PromptInspection{
|
||||||
|
PromptID: definition.PromptID, PromptVersion: definition.PromptVersion, PromptHash: "prompt-hash", DefaultProfileID: "default-profile",
|
||||||
|
Inputs: []promptexec.InputDefinition{{Name: "data_package", Required: true, ContentType: "application/yaml"}},
|
||||||
|
Output: promptexec.OutputContract{Format: "json", ValidationMode: "json_schema", SchemaPath: definition.GeneratedTextSchemaID + ".generated_text.schema.json"},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func logicalPromptInspection(definition report.Definition) promptexec.PromptInspection {
|
||||||
|
inspection := validPromptInspection(definition)
|
||||||
|
if definition.ID == report.Hourly {
|
||||||
|
inspection.DefaultProfileID = "weather-light"
|
||||||
|
} else {
|
||||||
|
inspection.DefaultProfileID = "weather-balanced"
|
||||||
|
}
|
||||||
|
return inspection
|
||||||
|
}
|
||||||
73
internal/app/prompt_profile_integration_test.go
Normal file
73
internal/app/prompt_profile_integration_test.go
Normal file
@@ -0,0 +1,73 @@
|
|||||||
|
package app_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
promptkitadapter "gitea.maximumdirect.net/eric/weatherreporter/internal/adapters/promptkit"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/app"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/config"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestPromptInspectionResolvesEmbeddedAndOverriddenProfilesOffline(t *testing.T) {
|
||||||
|
lookupEnv := func(string) (string, bool) { return "test-key", true }
|
||||||
|
inspect := func(t *testing.T, adapter *promptkitadapter.Adapter, id report.ID, profile string, wantID string, wantBackend string, wantModel string) {
|
||||||
|
t.Helper()
|
||||||
|
result, err := app.InspectPromptExecution(context.Background(), app.PromptInspectionRequest{
|
||||||
|
Resolved: resolvedPromptProfile(t, id),
|
||||||
|
Executor: adapter,
|
||||||
|
Promptkit: config.PromptkitConfig{Profile: profile},
|
||||||
|
LookupEnv: lookupEnv,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("InspectPromptExecution() error = %v", err)
|
||||||
|
}
|
||||||
|
if result.ProfileID != wantID || result.BackendID != wantBackend || result.ModelName != wantModel {
|
||||||
|
t.Fatalf("inspection = %#v, want profile/backend/model %q/%q/%q", result, wantID, wantBackend, wantModel)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
embedded, err := promptkitadapter.New(promptkitadapter.Config{})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("New(embedded) error = %v", err)
|
||||||
|
}
|
||||||
|
inspect(t, embedded, report.Hourly, "", "weather-light", "openrouter", "deepseek/deepseek-v4-flash")
|
||||||
|
inspect(t, embedded, report.Daily, "", "weather-balanced", "openrouter", "~google/gemini-flash-latest")
|
||||||
|
inspect(t, embedded, report.Daily, "weather-deep", "weather-deep", "openrouter", "~anthropic/claude-sonnet-latest")
|
||||||
|
|
||||||
|
override, err := promptkitadapter.New(promptkitadapter.Config{ProfileFile: writeProfileFile(t, `id: weather-light
|
||||||
|
endpoint: https://local.example/v1
|
||||||
|
model: local-weather
|
||||||
|
`)})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("New(override) error = %v", err)
|
||||||
|
}
|
||||||
|
inspect(t, override, report.Hourly, "", "weather-light", "", "local-weather")
|
||||||
|
}
|
||||||
|
|
||||||
|
func resolvedPromptProfile(t *testing.T, id report.ID) report.Resolved {
|
||||||
|
t.Helper()
|
||||||
|
now := time.Date(2026, 5, 29, 12, 0, 0, 0, time.UTC)
|
||||||
|
request := report.ResolveRequest{Now: now, Location: time.UTC}
|
||||||
|
if id == report.Daily {
|
||||||
|
request.Date = now
|
||||||
|
}
|
||||||
|
resolved, err := report.DefaultRegistry().Resolve(id, request)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Resolve(%q) error = %v", id, err)
|
||||||
|
}
|
||||||
|
return resolved
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeProfileFile(t *testing.T, profile string) string {
|
||||||
|
t.Helper()
|
||||||
|
path := filepath.Join(t.TempDir(), "profile.yml")
|
||||||
|
if err := os.WriteFile(path, []byte(profile), 0o600); err != nil {
|
||||||
|
t.Fatalf("write profile: %v", err)
|
||||||
|
}
|
||||||
|
return path
|
||||||
|
}
|
||||||
21
internal/app/test_helpers_test.go
Normal file
21
internal/app/test_helpers_test.go
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
package app
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func mustParse(value string) time.Time {
|
||||||
|
parsed, err := time.Parse(time.RFC3339, value)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
return parsed
|
||||||
|
}
|
||||||
|
|
||||||
|
func requireNoError(t *testing.T, err error) {
|
||||||
|
t.Helper()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -19,17 +19,21 @@ type AlertSummary struct {
|
|||||||
Event string `json:"event,omitempty"`
|
Event string `json:"event,omitempty"`
|
||||||
Headline string `json:"headline,omitempty"`
|
Headline string `json:"headline,omitempty"`
|
||||||
Severity string `json:"severity,omitempty"`
|
Severity string `json:"severity,omitempty"`
|
||||||
|
PeriodBegins string `json:"period_begins,omitempty"`
|
||||||
|
PeriodEnds string `json:"period_ends,omitempty"`
|
||||||
|
Instruction string `json:"instruction,omitempty"`
|
||||||
|
Description string `json:"description,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func buildAlertDigestModule(ctx ModuleContext, _ any) (*module.Output, error) {
|
func buildAlertDigestModule(ctx ModuleContext, _ any) (*module.Output, error) {
|
||||||
value := alertDigest(ctx.Collected, ctx.Derived.AlertOverlaps)
|
value := alertDigest(ctx.Collected, ctx.Derived.AlertOverlaps, ctx.Timezone)
|
||||||
if value == nil {
|
if value == nil {
|
||||||
value = &AlertDigestModule{}
|
value = &AlertDigestModule{}
|
||||||
}
|
}
|
||||||
return &module.Output{ID: module.AlertDigest, StanzaName: "alert_digest", Value: *value}, nil
|
return &module.Output{ID: module.AlertDigest, StanzaName: "alert_digest", Value: *value}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func alertDigest(collected facts.CollectedFacts, overlaps []forecast.AlertOverlap) *AlertDigestModule {
|
func alertDigest(collected facts.CollectedFacts, overlaps []forecast.AlertOverlap, timezone string) *AlertDigestModule {
|
||||||
missing := sourceMissing(collected.SourceProvenance, "alerts")
|
missing := sourceMissing(collected.SourceProvenance, "alerts")
|
||||||
if collected.Alerts == nil && !missing {
|
if collected.Alerts == nil && !missing {
|
||||||
return nil
|
return nil
|
||||||
@@ -45,6 +49,10 @@ func alertDigest(collected facts.CollectedFacts, overlaps []forecast.AlertOverla
|
|||||||
Event: overlap.Event,
|
Event: overlap.Event,
|
||||||
Headline: overlap.Headline,
|
Headline: overlap.Headline,
|
||||||
Severity: overlap.Severity,
|
Severity: overlap.Severity,
|
||||||
|
PeriodBegins: friendlyMonthDayTimeLabel(overlap.Period.Start, timezone),
|
||||||
|
PeriodEnds: friendlyMonthDayTimeLabel(overlap.Period.End, timezone),
|
||||||
|
Instruction: overlap.Instruction,
|
||||||
|
Description: overlap.Description,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
return value
|
return value
|
||||||
|
|||||||
@@ -0,0 +1,72 @@
|
|||||||
|
{
|
||||||
|
"categorical:TSTM": {
|
||||||
|
"plain_language": "General or non-severe thunderstorms.",
|
||||||
|
"official_description": "No severe thunderstorms expected.",
|
||||||
|
"relative_level": "0 of 5"
|
||||||
|
},
|
||||||
|
"categorical:MRGL": {
|
||||||
|
"plain_language": "Isolated severe storms possible.",
|
||||||
|
"official_description": "Isolated severe storms may occur within the risk area, but they are expected to be limited in duration, coverage, and intensity.",
|
||||||
|
"relative_level": "1 of 5"
|
||||||
|
},
|
||||||
|
"categorical:SLGT": {
|
||||||
|
"plain_language": "Scattered severe storms possible.",
|
||||||
|
"official_description": "Isolated intense storms are possible within the risk area, but severe weather is generally expected to be short-lived and/or not widespread.",
|
||||||
|
"relative_level": "2 of 5"
|
||||||
|
},
|
||||||
|
"categorical:ENH": {
|
||||||
|
"plain_language": "Numerous severe storms possible.",
|
||||||
|
"official_description": "Numerous severe storms are possible within the risk area, some of which may be intense.",
|
||||||
|
"relative_level": "3 of 5"
|
||||||
|
},
|
||||||
|
"categorical:MDT": {
|
||||||
|
"plain_language": "Widespread severe storms likely.",
|
||||||
|
"official_description": "Widespread severe storms are likely within the risk area. Storms may be long-lived, widespread, and intense. This risk is usually reserved for days with several supercells producing intense tornadoes and/or very large hail, or an intense squall line with widespread damaging winds.",
|
||||||
|
"relative_level": "4 of 5"
|
||||||
|
},
|
||||||
|
"categorical:HIGH": {
|
||||||
|
"plain_language": "Major severe outbreak expected.",
|
||||||
|
"official_description": "A major severe weather outbreak is expected, with long-lived, very widespread, and particularly intense severe storms. This risk is reserved for when high confidence exists in widespread coverage of severe weather with embedded instances of extreme severity (i.e., violent tornadoes or very damaging convective wind events).",
|
||||||
|
"relative_level": "5 of 5"
|
||||||
|
},
|
||||||
|
"tornado:CIG1": {
|
||||||
|
"plain_language": "Conditional potential for significant tornadoes.",
|
||||||
|
"official_description": "Intensity Level 1: Reasonable Max EF2. Note that this product describes the reasonable maximum intensity of a hazard if that hazard occurs. It does not by itself indicate the probability that the hazard will occur.",
|
||||||
|
"relative_level": "1 of 3"
|
||||||
|
},
|
||||||
|
"tornado:CIG2": {
|
||||||
|
"plain_language": "Conditional potential for strong tornadoes.",
|
||||||
|
"official_description": "Intensity Level 2: Reasonable Max EF3. Note that this product describes the reasonable maximum intensity of a hazard if that hazard occurs. It does not by itself indicate the probability that the hazard will occur.",
|
||||||
|
"relative_level": "2 of 3"
|
||||||
|
},
|
||||||
|
"tornado:CIG3": {
|
||||||
|
"plain_language": "Conditional potential for violent tornadoes.",
|
||||||
|
"official_description": "Intensity Level 3: Reasonable Max EF4 or higher. Note that this product describes the reasonable maximum intensity of a hazard if that hazard occurs. It does not by itself indicate the probability that the hazard will occur.",
|
||||||
|
"relative_level": "3 of 3"
|
||||||
|
},
|
||||||
|
"wind:CIG1": {
|
||||||
|
"plain_language": "Conditional potential for significant severe wind.",
|
||||||
|
"official_description": "Intensity Level 1: Reasonable Max wind gusts around 65 kt / 75 mph or higher. Note that this product describes the reasonable maximum intensity of a hazard if that hazard occurs. It does not by itself indicate the probability that the hazard will occur.",
|
||||||
|
"relative_level": "1 of 3"
|
||||||
|
},
|
||||||
|
"wind:CIG2": {
|
||||||
|
"plain_language": "Conditional potential for intense severe wind.",
|
||||||
|
"official_description": "Intensity Level 2: Reasonable Max wind gusts around 75 kt / 85 mph or higher. Note that this product describes the reasonable maximum intensity of a hazard if that hazard occurs. It does not by itself indicate the probability that the hazard will occur.",
|
||||||
|
"relative_level": "2 of 3"
|
||||||
|
},
|
||||||
|
"wind:CIG3": {
|
||||||
|
"plain_language": "Conditional potential for extreme severe wind.",
|
||||||
|
"official_description": "Intensity Level 3: Reasonable Max wind gusts around 100 kt / 115 mph or higher. Note that this product describes the reasonable maximum intensity of a hazard if that hazard occurs. It does not by itself indicate the probability that the hazard will occur.",
|
||||||
|
"relative_level": "3 of 3"
|
||||||
|
},
|
||||||
|
"hail:CIG1": {
|
||||||
|
"plain_language": "Conditional potential for significant hail.",
|
||||||
|
"official_description": "Intensity Level 1: Reasonable Max hail size around 2.00 to 3.75 inches. Note that this product describes the reasonable maximum intensity of a hazard if that hazard occurs. It does not by itself indicate the probability that the hazard will occur.",
|
||||||
|
"relative_level": "1 of 2"
|
||||||
|
},
|
||||||
|
"hail:CIG2": {
|
||||||
|
"plain_language": "Conditional potential for giant hail.",
|
||||||
|
"official_description": "Intensity Level 2: Reasonable Max hail size greater than 3.75 inches. Note that this product describes the reasonable maximum intensity of a hazard if that hazard occurs. It does not by itself indicate the probability that the hazard will occur.",
|
||||||
|
"relative_level": "2 of 2"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -155,10 +155,10 @@ func TestHourlyForecastPrecipMentionThreshold(t *testing.T) {
|
|||||||
func TestHourlyForecastModuleRejectsUnsupportedReports(t *testing.T) {
|
func TestHourlyForecastModuleRejectsUnsupportedReports(t *testing.T) {
|
||||||
registry := MustDefaultModuleRegistry()
|
registry := MustDefaultModuleRegistry()
|
||||||
ctx := testModuleContext()
|
ctx := testModuleContext()
|
||||||
ctx.Resolved.Definition = report.DefaultRegistry().MustLookup(report.Weekend)
|
ctx.Resolved.Definition = report.Definition{ID: report.ID("unsupported")}
|
||||||
|
|
||||||
_, err := registry.BuildModule(ctx, module.ConfigItem{ID: module.HourlyForecast})
|
_, err := registry.BuildModule(ctx, module.ConfigItem{ID: module.HourlyForecast})
|
||||||
if err == nil || !strings.Contains(err.Error(), `module "hourly_forecast" is not compatible with report "weekend"`) {
|
if err == nil || !strings.Contains(err.Error(), `module "hourly_forecast" is not compatible with report "unsupported"`) {
|
||||||
t.Fatalf("BuildModule() error = %v, want incompatible report", err)
|
t.Fatalf("BuildModule() error = %v, want incompatible report", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -227,10 +227,10 @@ func TestNarrativeForecastModuleUsesValidPeriodNarrativePeriods(t *testing.T) {
|
|||||||
func TestNarrativeForecastModuleRejectsUnsupportedReports(t *testing.T) {
|
func TestNarrativeForecastModuleRejectsUnsupportedReports(t *testing.T) {
|
||||||
registry := MustDefaultModuleRegistry()
|
registry := MustDefaultModuleRegistry()
|
||||||
ctx := testModuleContext()
|
ctx := testModuleContext()
|
||||||
ctx.Resolved.Definition = report.DefaultRegistry().MustLookup(report.Weekend)
|
ctx.Resolved.Definition = report.Definition{ID: report.ID("unsupported")}
|
||||||
|
|
||||||
_, err := registry.BuildModule(ctx, module.ConfigItem{ID: module.NarrativeForecast})
|
_, err := registry.BuildModule(ctx, module.ConfigItem{ID: module.NarrativeForecast})
|
||||||
if err == nil || !strings.Contains(err.Error(), `module "narrative_forecast" is not compatible with report "weekend"`) {
|
if err == nil || !strings.Contains(err.Error(), `module "narrative_forecast" is not compatible with report "unsupported"`) {
|
||||||
t.Fatalf("BuildModule() error = %v, want incompatible report", err)
|
t.Fatalf("BuildModule() error = %v, want incompatible report", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -253,9 +253,6 @@ func TestMetadataModuleUsesPromptSafeSourceWarningSummary(t *testing.T) {
|
|||||||
if len(value.SourceWarnings) != 1 || value.SourceWarnings[0].CompletenessImpact != "source omitted" {
|
if len(value.SourceWarnings) != 1 || value.SourceWarnings[0].CompletenessImpact != "source omitted" {
|
||||||
t.Fatalf("SourceWarnings = %#v, want warning summary", value.SourceWarnings)
|
t.Fatalf("SourceWarnings = %#v, want warning summary", value.SourceWarnings)
|
||||||
}
|
}
|
||||||
if value.Alerts == nil || !value.Alerts.Checked || value.Alerts.ActiveCount != 1 || value.Alerts.RelevantCount != 1 {
|
|
||||||
t.Fatalf("Alerts = %#v, want checked alert status", value.Alerts)
|
|
||||||
}
|
|
||||||
data, err := json.Marshal(output.Value)
|
data, err := json.Marshal(output.Value)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("Marshal metadata: %v", err)
|
t.Fatalf("Marshal metadata: %v", err)
|
||||||
@@ -264,6 +261,9 @@ func TestMetadataModuleUsesPromptSafeSourceWarningSummary(t *testing.T) {
|
|||||||
if !strings.Contains(jsonText, "source_warnings") || strings.Contains(jsonText, "endpoint") || strings.Contains(jsonText, "dataSha256") {
|
if !strings.Contains(jsonText, "source_warnings") || strings.Contains(jsonText, "endpoint") || strings.Contains(jsonText, "dataSha256") {
|
||||||
t.Fatalf("metadata json = %s, want source warning summary without transport provenance", jsonText)
|
t.Fatalf("metadata json = %s, want source warning summary without transport provenance", jsonText)
|
||||||
}
|
}
|
||||||
|
if strings.Contains(jsonText, `"alerts"`) {
|
||||||
|
t.Fatalf("metadata json = %s, want alert details only in alert_digest", jsonText)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestCurrentConditionsModuleUsesSnakeCaseUnitFields(t *testing.T) {
|
func TestCurrentConditionsModuleUsesSnakeCaseUnitFields(t *testing.T) {
|
||||||
@@ -367,6 +367,39 @@ func TestAlertDigestDistinguishesCheckedEmptyAndMissing(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestAlertDigestIncludesPeriodAndGuidance(t *testing.T) {
|
||||||
|
registry := MustDefaultModuleRegistry()
|
||||||
|
ctx := testModuleContext()
|
||||||
|
ctx.Collected.Alerts = &weatherdata.AlertRun{Alerts: []json.RawMessage{json.RawMessage(`{"event":"Wind Advisory"}`)}}
|
||||||
|
ctx.Derived.AlertOverlaps = []forecast.AlertOverlap{{
|
||||||
|
Event: "Wind Advisory",
|
||||||
|
Headline: "Wind Advisory until 8 PM",
|
||||||
|
Severity: "Moderate",
|
||||||
|
Period: timeutil.Period{Start: mustParseModuleTime("2026-06-17T18:00:00Z"), End: mustParseModuleTime("2026-06-18T01:00:00Z")},
|
||||||
|
Instruction: "Secure outdoor objects.",
|
||||||
|
Description: "Gusty winds may blow around unsecured objects.",
|
||||||
|
}}
|
||||||
|
|
||||||
|
output, err := registry.BuildModule(ctx, module.ConfigItem{ID: module.AlertDigest})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("BuildModule(alert digest) error = %v", err)
|
||||||
|
}
|
||||||
|
value := moduleValue[AlertDigestModule](t, output)
|
||||||
|
if len(value.Relevant) != 1 {
|
||||||
|
t.Fatalf("Relevant length = %d, want 1", len(value.Relevant))
|
||||||
|
}
|
||||||
|
alert := value.Relevant[0]
|
||||||
|
if alert.Event != "Wind Advisory" || alert.Headline != "Wind Advisory until 8 PM" || alert.Severity != "Moderate" {
|
||||||
|
t.Fatalf("alert identity = %#v, want preserved event/headline/severity", alert)
|
||||||
|
}
|
||||||
|
if alert.PeriodBegins != "June 17 at 1:00 PM" || alert.PeriodEnds != "June 17 at 8:00 PM" {
|
||||||
|
t.Fatalf("alert period = %q/%q, want friendly local labels", alert.PeriodBegins, alert.PeriodEnds)
|
||||||
|
}
|
||||||
|
if alert.Instruction != "Secure outdoor objects." || alert.Description != "Gusty winds may blow around unsecured objects." {
|
||||||
|
t.Fatalf("alert guidance = %#v, want instruction and description preserved", alert)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestBaseModulesOmitMissingOptionalOutputs(t *testing.T) {
|
func TestBaseModulesOmitMissingOptionalOutputs(t *testing.T) {
|
||||||
registry := MustDefaultModuleRegistry()
|
registry := MustDefaultModuleRegistry()
|
||||||
ctx := testModuleContext()
|
ctx := testModuleContext()
|
||||||
@@ -473,6 +506,34 @@ func TestAreaForecastDiscussionModuleUsesHourlyDefaultSections(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestAreaForecastDiscussionModuleUsesDailyDefaultSections(t *testing.T) {
|
||||||
|
registry := MustDefaultModuleRegistry()
|
||||||
|
ctx := testModuleContext()
|
||||||
|
ctx.Resolved.Definition = report.DefaultRegistry().MustLookup(report.Daily)
|
||||||
|
var item module.ConfigItem
|
||||||
|
for _, candidate := range ctx.Resolved.Definition.Modules {
|
||||||
|
if candidate.ID == module.AreaForecastDiscussion {
|
||||||
|
item = candidate
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if item.ID == "" {
|
||||||
|
t.Fatal("daily default modules missing area_forecast_discussion")
|
||||||
|
}
|
||||||
|
|
||||||
|
output, err := registry.BuildModule(ctx, item)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("BuildModule() error = %v", err)
|
||||||
|
}
|
||||||
|
afd := moduleValue[AreaForecastDiscussionModule](t, output)
|
||||||
|
if afd.LongTerm != "Periodic rain chances continue." {
|
||||||
|
t.Fatalf("LongTerm = %q, want selected long term section", afd.LongTerm)
|
||||||
|
}
|
||||||
|
if afd.Product != "" || len(afd.KeyMessages) != 0 || afd.ShortTerm != "" {
|
||||||
|
t.Fatalf("AFD = %#v, want only long term section", afd)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func testModuleContext() ModuleContext {
|
func testModuleContext() ModuleContext {
|
||||||
generatedAt := mustParseModuleTime("2026-05-29T08:00:00-05:00")
|
generatedAt := mustParseModuleTime("2026-05-29T08:00:00-05:00")
|
||||||
definition := report.DefaultRegistry().MustLookup(report.Daily)
|
definition := report.DefaultRegistry().MustLookup(report.Daily)
|
||||||
|
|||||||
@@ -105,9 +105,15 @@ func TestPrecipTimingModuleHandlesRainyAndDryForecasts(t *testing.T) {
|
|||||||
if rainy.PrecipitationWindows[0].PeriodBegins != "2026-05-29 at 8:00 AM" || rainy.PrecipitationWindows[0].PeriodBeginsHourLabel != "8:00 AM" || rainy.PrecipitationWindows[0].PeriodEnds != "2026-05-29 at 9:00 AM" || rainy.PrecipitationWindows[0].PeriodEndsHourLabel != "9:00 AM" || rainy.PrecipitationWindows[0].MaxPopPercent == nil || *rainy.PrecipitationWindows[0].MaxPopPercent != 60 || rainy.PrecipitationWindows[0].MaxPopHourLabel != "8:00 AM" {
|
if rainy.PrecipitationWindows[0].PeriodBegins != "2026-05-29 at 8:00 AM" || rainy.PrecipitationWindows[0].PeriodBeginsHourLabel != "8:00 AM" || rainy.PrecipitationWindows[0].PeriodEnds != "2026-05-29 at 9:00 AM" || rainy.PrecipitationWindows[0].PeriodEndsHourLabel != "9:00 AM" || rainy.PrecipitationWindows[0].MaxPopPercent == nil || *rainy.PrecipitationWindows[0].MaxPopPercent != 60 || rainy.PrecipitationWindows[0].MaxPopHourLabel != "8:00 AM" {
|
||||||
t.Fatalf("first precipitation window = %#v, want 8-9 AM at 60%%", rainy.PrecipitationWindows[0])
|
t.Fatalf("first precipitation window = %#v, want 8-9 AM at 60%%", rainy.PrecipitationWindows[0])
|
||||||
}
|
}
|
||||||
|
if rainy.PrecipitationWindows[0].PrecipitationType != "showers" || rainy.PrecipitationWindows[0].ExpectationPhrase != "Showers likely." {
|
||||||
|
t.Fatalf("first precipitation window phrase = %#v, want showers likely", rainy.PrecipitationWindows[0])
|
||||||
|
}
|
||||||
if rainy.PrecipitationWindows[1].PeriodBegins != "2026-05-29 at 12:00 PM" || rainy.PrecipitationWindows[1].PeriodBeginsHourLabel != "12:00 PM" || rainy.PrecipitationWindows[1].PeriodEnds != "2026-05-29 at 2:00 PM" || rainy.PrecipitationWindows[1].PeriodEndsHourLabel != "2:00 PM" || rainy.PrecipitationWindows[1].MaxPopPercent == nil || *rainy.PrecipitationWindows[1].MaxPopPercent != 80 || rainy.PrecipitationWindows[1].MaxPopHourLabel != "12:00 PM" {
|
if rainy.PrecipitationWindows[1].PeriodBegins != "2026-05-29 at 12:00 PM" || rainy.PrecipitationWindows[1].PeriodBeginsHourLabel != "12:00 PM" || rainy.PrecipitationWindows[1].PeriodEnds != "2026-05-29 at 2:00 PM" || rainy.PrecipitationWindows[1].PeriodEndsHourLabel != "2:00 PM" || rainy.PrecipitationWindows[1].MaxPopPercent == nil || *rainy.PrecipitationWindows[1].MaxPopPercent != 80 || rainy.PrecipitationWindows[1].MaxPopHourLabel != "12:00 PM" {
|
||||||
t.Fatalf("second precipitation window = %#v, want noon-2 PM at 80%%", rainy.PrecipitationWindows[1])
|
t.Fatalf("second precipitation window = %#v, want noon-2 PM at 80%%", rainy.PrecipitationWindows[1])
|
||||||
}
|
}
|
||||||
|
if rainy.PrecipitationWindows[1].PrecipitationType != "showers and thunderstorms" || rainy.PrecipitationWindows[1].ExpectationPhrase != "Expect showers and thunderstorms." {
|
||||||
|
t.Fatalf("second precipitation window phrase = %#v, want expect showers and thunderstorms", rainy.PrecipitationWindows[1])
|
||||||
|
}
|
||||||
data, err := json.Marshal(output.Value)
|
data, err := json.Marshal(output.Value)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("marshal precip timing: %v", err)
|
t.Fatalf("marshal precip timing: %v", err)
|
||||||
@@ -115,6 +121,9 @@ func TestPrecipTimingModuleHandlesRainyAndDryForecasts(t *testing.T) {
|
|||||||
if !strings.Contains(string(data), "precipitation_windows") || !strings.Contains(string(data), "probability_threshold") || !strings.Contains(string(data), "period_begins_hour_label") || !strings.Contains(string(data), "max_pop_hour_label") {
|
if !strings.Contains(string(data), "precipitation_windows") || !strings.Contains(string(data), "probability_threshold") || !strings.Contains(string(data), "period_begins_hour_label") || !strings.Contains(string(data), "max_pop_hour_label") {
|
||||||
t.Fatalf("precip timing json = %s, want threshold and windows", string(data))
|
t.Fatalf("precip timing json = %s, want threshold and windows", string(data))
|
||||||
}
|
}
|
||||||
|
if !strings.Contains(string(data), "precipitation_type") || !strings.Contains(string(data), "expectation_phrase") {
|
||||||
|
t.Fatalf("precip timing json = %s, want precipitation type and expectation phrase", string(data))
|
||||||
|
}
|
||||||
if strings.Contains(string(data), `"start"`) || strings.Contains(string(data), `"end"`) {
|
if strings.Contains(string(data), `"start"`) || strings.Contains(string(data), `"end"`) {
|
||||||
t.Fatalf("precip timing json = %s, want period_begins/period_ends instead of start/end", string(data))
|
t.Fatalf("precip timing json = %s, want period_begins/period_ends instead of start/end", string(data))
|
||||||
}
|
}
|
||||||
@@ -136,6 +145,100 @@ func TestPrecipTimingModuleHandlesRainyAndDryForecasts(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestPrecipTimingModuleBuildsExpectationPhrases(t *testing.T) {
|
||||||
|
now := mustParseModuleTime("2026-05-29T08:00:00-05:00")
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
maxPop float64
|
||||||
|
descriptions []string
|
||||||
|
wantType string
|
||||||
|
wantPhrase string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "chance lower bound",
|
||||||
|
maxPop: 40,
|
||||||
|
descriptions: []string{"Scattered showers"},
|
||||||
|
wantType: "showers",
|
||||||
|
wantPhrase: "Chance of showers.",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "chance upper bound",
|
||||||
|
maxPop: 49,
|
||||||
|
descriptions: []string{"Rain possible"},
|
||||||
|
wantType: "rain",
|
||||||
|
wantPhrase: "Chance of rain.",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "likely lower bound",
|
||||||
|
maxPop: 50,
|
||||||
|
descriptions: []string{"Drizzle"},
|
||||||
|
wantType: "drizzle",
|
||||||
|
wantPhrase: "Drizzle likely.",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "likely upper bound",
|
||||||
|
maxPop: 69,
|
||||||
|
descriptions: []string{"Freezing rain"},
|
||||||
|
wantType: "freezing rain",
|
||||||
|
wantPhrase: "Freezing rain likely.",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "expect lower bound",
|
||||||
|
maxPop: 70,
|
||||||
|
descriptions: []string{"Snow"},
|
||||||
|
wantType: "snow",
|
||||||
|
wantPhrase: "Expect snow.",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "showers and thunderstorms preferred",
|
||||||
|
maxPop: 100,
|
||||||
|
descriptions: []string{"Showers likely", "Thunderstorms possible"},
|
||||||
|
wantType: "showers and thunderstorms",
|
||||||
|
wantPhrase: "Expect showers and thunderstorms.",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "thunderstorms only",
|
||||||
|
maxPop: 80,
|
||||||
|
descriptions: []string{"Thunderstorms"},
|
||||||
|
wantType: "thunderstorms",
|
||||||
|
wantPhrase: "Expect thunderstorms.",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "unknown fallback",
|
||||||
|
maxPop: 95,
|
||||||
|
descriptions: []string{"Unsettled conditions"},
|
||||||
|
wantType: "precipitation",
|
||||||
|
wantPhrase: "Expect precipitation.",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
value := precipTimingValue(forecast.PrecipTiming{
|
||||||
|
ProbabilityThreshold: forecast.DefaultPrecipWindowProbabilityThreshold,
|
||||||
|
PrecipitationWindows: []forecast.PrecipitationWindow{
|
||||||
|
{
|
||||||
|
Start: now,
|
||||||
|
MaxPrecipitationProbability: forecast.TimedValue{
|
||||||
|
Value: tt.maxPop,
|
||||||
|
Time: now,
|
||||||
|
},
|
||||||
|
ProbabilityThreshold: forecast.DefaultPrecipWindowProbabilityThreshold,
|
||||||
|
TextDescriptions: tt.descriptions,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}, "America/Chicago")
|
||||||
|
if len(value.PrecipitationWindows) != 1 {
|
||||||
|
t.Fatalf("PrecipitationWindows = %#v, want one window", value.PrecipitationWindows)
|
||||||
|
}
|
||||||
|
window := value.PrecipitationWindows[0]
|
||||||
|
if window.PrecipitationType != tt.wantType || window.ExpectationPhrase != tt.wantPhrase {
|
||||||
|
t.Fatalf("window = %#v, want type %q and phrase %q", window, tt.wantType, tt.wantPhrase)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestPrecipTimingModuleUsesDerivedTimingWithoutDaypartSummaries(t *testing.T) {
|
func TestPrecipTimingModuleUsesDerivedTimingWithoutDaypartSummaries(t *testing.T) {
|
||||||
registry := MustDefaultModuleRegistry()
|
registry := MustDefaultModuleRegistry()
|
||||||
ctx := derivedModuleContext(report.Hourly)
|
ctx := derivedModuleContext(report.Hourly)
|
||||||
@@ -500,7 +603,7 @@ func TestDailyPlanningModulePackagesPlanningFields(t *testing.T) {
|
|||||||
|
|
||||||
func TestDailyPlanningModuleRejectsUnsupportedReports(t *testing.T) {
|
func TestDailyPlanningModuleRejectsUnsupportedReports(t *testing.T) {
|
||||||
registry := MustDefaultModuleRegistry()
|
registry := MustDefaultModuleRegistry()
|
||||||
for _, id := range []report.ID{report.Today, report.Tomorrow, report.Hourly, report.ThreeDay, report.Weekend, report.Storm} {
|
for _, id := range []report.ID{report.Today, report.Tomorrow, report.Hourly} {
|
||||||
t.Run(string(id), func(t *testing.T) {
|
t.Run(string(id), func(t *testing.T) {
|
||||||
ctx := derivedModuleContext(id)
|
ctx := derivedModuleContext(id)
|
||||||
_, err := registry.BuildModule(ctx, module.ConfigItem{ID: module.DailyPlanning})
|
_, err := registry.BuildModule(ctx, module.ConfigItem{ID: module.DailyPlanning})
|
||||||
|
|||||||
@@ -20,7 +20,6 @@ type MetadataModule struct {
|
|||||||
ValidPeriod timeutil.Period `json:"valid_period"`
|
ValidPeriod timeutil.Period `json:"valid_period"`
|
||||||
Location *LocationContext `json:"location,omitempty"`
|
Location *LocationContext `json:"location,omitempty"`
|
||||||
SourceWarnings []SourceWarningSummary `json:"source_warnings,omitempty"`
|
SourceWarnings []SourceWarningSummary `json:"source_warnings,omitempty"`
|
||||||
Alerts *AlertDigestModule `json:"alerts,omitempty"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type SourceWarningSummary struct {
|
type SourceWarningSummary struct {
|
||||||
@@ -44,7 +43,6 @@ func buildMetadataModule(ctx ModuleContext, _ any) (*module.Output, error) {
|
|||||||
ValidPeriod: metadata.ValidPeriod,
|
ValidPeriod: metadata.ValidPeriod,
|
||||||
Location: copyLocation(ctx.Location),
|
Location: copyLocation(ctx.Location),
|
||||||
SourceWarnings: sourceWarningSummaries(ctx.Collected.SourceWarnings),
|
SourceWarnings: sourceWarningSummaries(ctx.Collected.SourceWarnings),
|
||||||
Alerts: alertDigest(ctx.Collected, ctx.Derived.AlertOverlaps),
|
|
||||||
}
|
}
|
||||||
return &module.Output{ID: module.Metadata, StanzaName: "metadata", Value: value}, nil
|
return &module.Output{ID: module.Metadata, StanzaName: "metadata", Value: value}, nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -122,6 +122,17 @@ func friendlyDateTimeLabel(value time.Time, timezone string) string {
|
|||||||
return value.In(location).Format("2006-01-02 at 3:04 PM")
|
return value.In(location).Format("2006-01-02 at 3:04 PM")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func friendlyMonthDayTimeLabel(value time.Time, timezone string) string {
|
||||||
|
if value.IsZero() {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
location, err := timeutil.LoadLocation(timezone)
|
||||||
|
if err != nil {
|
||||||
|
location = time.UTC
|
||||||
|
}
|
||||||
|
return value.In(location).Format("January 2 at 3:04 PM")
|
||||||
|
}
|
||||||
|
|
||||||
func friendlyDateLabel(date string, timezone string) string {
|
func friendlyDateLabel(date string, timezone string) string {
|
||||||
location, err := timeutil.LoadLocation(timezone)
|
location, err := timeutil.LoadLocation(timezone)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -265,8 +265,8 @@ func (d ModuleDefinition) ValidateOptions(options any) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func defaultModuleDefinitions() []ModuleDefinition {
|
func defaultModuleDefinitions() []ModuleDefinition {
|
||||||
allReports := []report.ID{report.Daily, report.Today, report.Tomorrow, report.Hourly, report.ThreeDay, report.Weekend, report.Storm}
|
allReports := []report.ID{report.Daily, report.Today, report.Tomorrow, report.Hourly}
|
||||||
daypartReports := []report.ID{report.Daily, report.Today, report.Tomorrow, report.ThreeDay, report.Weekend}
|
daypartReports := []report.ID{report.Daily, report.Today, report.Tomorrow}
|
||||||
return []ModuleDefinition{
|
return []ModuleDefinition{
|
||||||
{
|
{
|
||||||
ID: module.Metadata,
|
ID: module.Metadata,
|
||||||
|
|||||||
@@ -263,8 +263,19 @@ func TestModuleRegistryPromptValueIsNotPersistedInSnapshotJSON(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHourlyDefaultModuleOptions(t *testing.T) {
|
func TestDefaultAreaForecastDiscussionModuleOptions(t *testing.T) {
|
||||||
definition := report.DefaultRegistry().MustLookup(report.Hourly)
|
tests := []struct {
|
||||||
|
id report.ID
|
||||||
|
wantSections string
|
||||||
|
}{
|
||||||
|
{id: report.Daily, wantSections: "long_term"},
|
||||||
|
{id: report.Hourly, wantSections: "key_messages,short_term"},
|
||||||
|
}
|
||||||
|
|
||||||
|
registry := report.DefaultRegistry()
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(string(tt.id), func(t *testing.T) {
|
||||||
|
definition := registry.MustLookup(tt.id)
|
||||||
var found bool
|
var found bool
|
||||||
for _, item := range definition.Modules {
|
for _, item := range definition.Modules {
|
||||||
if item.ID != module.AreaForecastDiscussion {
|
if item.ID != module.AreaForecastDiscussion {
|
||||||
@@ -275,12 +286,33 @@ func TestHourlyDefaultModuleOptions(t *testing.T) {
|
|||||||
if !ok {
|
if !ok {
|
||||||
t.Fatalf("AFD options type = %T, want AreaForecastDiscussionOptions", item.Options)
|
t.Fatalf("AFD options type = %T, want AreaForecastDiscussionOptions", item.Options)
|
||||||
}
|
}
|
||||||
if strings.Join(options.Sections, ",") != "key_messages,short_term" {
|
if strings.Join(options.Sections, ",") != tt.wantSections {
|
||||||
t.Fatalf("AFD sections = %#v, want key messages and short term", options.Sections)
|
t.Fatalf("AFD sections = %#v, want %s", options.Sections, tt.wantSections)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if !found {
|
if !found {
|
||||||
t.Fatal("hourly default modules missing area_forecast_discussion")
|
t.Fatal("default modules missing area_forecast_discussion")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, id := range []report.ID{report.Today, report.Tomorrow} {
|
||||||
|
t.Run(string(id), func(t *testing.T) {
|
||||||
|
definition := registry.MustLookup(id)
|
||||||
|
var found bool
|
||||||
|
for _, item := range definition.Modules {
|
||||||
|
if item.ID != module.AreaForecastDiscussion {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
found = true
|
||||||
|
if item.Options != nil {
|
||||||
|
t.Fatalf("AFD options = %#v, want default all sections", item.Options)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !found {
|
||||||
|
t.Fatal("default modules missing area_forecast_discussion")
|
||||||
|
}
|
||||||
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -341,7 +373,7 @@ func TestModuleRegistryValidatesDailyPlanningSupport(t *testing.T) {
|
|||||||
if err := registry.ValidateComposition(report.Daily, []module.ConfigItem{{ID: module.DailyPlanning}}); err != nil {
|
if err := registry.ValidateComposition(report.Daily, []module.ConfigItem{{ID: module.DailyPlanning}}); err != nil {
|
||||||
t.Fatalf("ValidateComposition(daily) error = %v", err)
|
t.Fatalf("ValidateComposition(daily) error = %v", err)
|
||||||
}
|
}
|
||||||
for _, id := range []report.ID{report.Today, report.Tomorrow, report.Hourly, report.ThreeDay, report.Weekend, report.Storm} {
|
for _, id := range []report.ID{report.Today, report.Tomorrow, report.Hourly} {
|
||||||
t.Run(string(id), func(t *testing.T) {
|
t.Run(string(id), func(t *testing.T) {
|
||||||
err := registry.ValidateComposition(id, []module.ConfigItem{{ID: module.DailyPlanning}})
|
err := registry.ValidateComposition(id, []module.ConfigItem{{ID: module.DailyPlanning}})
|
||||||
if err == nil || !strings.Contains(err.Error(), `module "daily_planning" is not compatible with report`) {
|
if err == nil || !strings.Contains(err.Error(), `module "daily_planning" is not compatible with report`) {
|
||||||
|
|||||||
@@ -1,10 +1,19 @@
|
|||||||
package briefing
|
package briefing
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/forecast"
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/forecast"
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/module"
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/module"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
precipTimingChanceLowerBound = 40
|
||||||
|
precipTimingLikelyLowerBound = 50
|
||||||
|
precipTimingExpectLowerBound = 70
|
||||||
|
)
|
||||||
|
|
||||||
type PrecipTimingModule struct {
|
type PrecipTimingModule struct {
|
||||||
MaxPopPercent *int `json:"max_pop_percent,omitempty"`
|
MaxPopPercent *int `json:"max_pop_percent,omitempty"`
|
||||||
MaxPopTime string `json:"max_pop_time,omitempty"`
|
MaxPopTime string `json:"max_pop_time,omitempty"`
|
||||||
@@ -21,6 +30,8 @@ type PrecipitationWindowModule struct {
|
|||||||
MaxPopPercent *int `json:"max_pop_percent,omitempty"`
|
MaxPopPercent *int `json:"max_pop_percent,omitempty"`
|
||||||
MaxPopTime string `json:"max_pop_time,omitempty"`
|
MaxPopTime string `json:"max_pop_time,omitempty"`
|
||||||
MaxPopHourLabel string `json:"max_pop_hour_label,omitempty"`
|
MaxPopHourLabel string `json:"max_pop_hour_label,omitempty"`
|
||||||
|
PrecipitationType string `json:"precipitation_type,omitempty"`
|
||||||
|
ExpectationPhrase string `json:"expectation_phrase,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func buildPrecipTimingModule(ctx ModuleContext, _ any) (*module.Output, error) {
|
func buildPrecipTimingModule(ctx ModuleContext, _ any) (*module.Output, error) {
|
||||||
@@ -49,7 +60,50 @@ func precipTimingValue(timing forecast.PrecipTiming, timezone string) PrecipTimi
|
|||||||
item.MaxPopPercent = roundedInt(&window.MaxPrecipitationProbability.Value)
|
item.MaxPopPercent = roundedInt(&window.MaxPrecipitationProbability.Value)
|
||||||
item.MaxPopTime = clockLabel(window.MaxPrecipitationProbability.Time, timezone)
|
item.MaxPopTime = clockLabel(window.MaxPrecipitationProbability.Time, timezone)
|
||||||
item.MaxPopHourLabel = hourMinuteLabel(window.MaxPrecipitationProbability.Time, timezone)
|
item.MaxPopHourLabel = hourMinuteLabel(window.MaxPrecipitationProbability.Time, timezone)
|
||||||
|
item.PrecipitationType = precipitationWindowType(window.TextDescriptions)
|
||||||
|
if item.MaxPopPercent != nil {
|
||||||
|
item.ExpectationPhrase = precipitationWindowExpectationPhrase(*item.MaxPopPercent, item.PrecipitationType)
|
||||||
|
}
|
||||||
value.PrecipitationWindows = append(value.PrecipitationWindows, item)
|
value.PrecipitationWindows = append(value.PrecipitationWindows, item)
|
||||||
}
|
}
|
||||||
return value
|
return value
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func precipitationWindowType(descriptions []string) string {
|
||||||
|
combined := strings.ToLower(strings.Join(descriptions, " "))
|
||||||
|
switch {
|
||||||
|
case (strings.Contains(combined, "thunderstorm") || strings.Contains(combined, "t-storm")) &&
|
||||||
|
(strings.Contains(combined, "shower") || strings.Contains(combined, "rain")):
|
||||||
|
return "showers and thunderstorms"
|
||||||
|
case strings.Contains(combined, "freezing rain"):
|
||||||
|
return "freezing rain"
|
||||||
|
case strings.Contains(combined, "thunderstorm") || strings.Contains(combined, "t-storm"):
|
||||||
|
return "thunderstorms"
|
||||||
|
case strings.Contains(combined, "shower"):
|
||||||
|
return "showers"
|
||||||
|
case strings.Contains(combined, "snow"):
|
||||||
|
return "snow"
|
||||||
|
case strings.Contains(combined, "drizzle"):
|
||||||
|
return "drizzle"
|
||||||
|
case strings.Contains(combined, "rain"):
|
||||||
|
return "rain"
|
||||||
|
default:
|
||||||
|
return "precipitation"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func precipitationWindowExpectationPhrase(maxPopPercent int, precipitationType string) string {
|
||||||
|
if precipitationType == "" {
|
||||||
|
precipitationType = "precipitation"
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case maxPopPercent >= precipTimingExpectLowerBound:
|
||||||
|
return fmt.Sprintf("Expect %s.", precipitationType)
|
||||||
|
case maxPopPercent >= precipTimingLikelyLowerBound:
|
||||||
|
return fmt.Sprintf("%s likely.", sentenceCase(precipitationType))
|
||||||
|
case maxPopPercent >= precipTimingChanceLowerBound:
|
||||||
|
return fmt.Sprintf("Chance of %s.", precipitationType)
|
||||||
|
default:
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -8,8 +8,8 @@ import (
|
|||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/weatherdata"
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/weatherdata"
|
||||||
)
|
)
|
||||||
|
|
||||||
const defaultSPCConvectiveDiscussionMinimumSeverityRank = 3
|
const defaultSPCConvectiveDiscussionMinimumSeverityRank = defaultSPCRiskDigestMinimumSeverityRank
|
||||||
const spcCategoricalOutlookType = "categorical"
|
const spcCategoricalOutlookType = defaultSPCRiskDigestOutlookType
|
||||||
|
|
||||||
type SPCConvectiveDiscussionModule struct {
|
type SPCConvectiveDiscussionModule struct {
|
||||||
IncludedBecause string `json:"included_because"`
|
IncludedBecause string `json:"included_because"`
|
||||||
|
|||||||
37
internal/briefing/spc_convective_outlook_definitions.go
Normal file
37
internal/briefing/spc_convective_outlook_definitions.go
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
package briefing
|
||||||
|
|
||||||
|
import (
|
||||||
|
"embed"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
//go:embed assets/spc_convective_outlook_definitions.json
|
||||||
|
var spcConvectiveOutlookDefinitionAssets embed.FS
|
||||||
|
|
||||||
|
var spcOutlookBackgroundDefinitions = mustLoadSPCOutlookBackgroundDefinitions()
|
||||||
|
|
||||||
|
func mustLoadSPCOutlookBackgroundDefinitions() map[string]SPCOutlookBackgroundDefinition {
|
||||||
|
data, err := spcConvectiveOutlookDefinitionAssets.ReadFile("assets/spc_convective_outlook_definitions.json")
|
||||||
|
if err != nil {
|
||||||
|
panic(fmt.Sprintf("read embedded SPC outlook definitions: %v", err))
|
||||||
|
}
|
||||||
|
var definitions map[string]SPCOutlookBackgroundDefinition
|
||||||
|
if err := json.Unmarshal(data, &definitions); err != nil {
|
||||||
|
panic(fmt.Sprintf("decode embedded SPC outlook definitions: %v", err))
|
||||||
|
}
|
||||||
|
return definitions
|
||||||
|
}
|
||||||
|
|
||||||
|
func spcOutlookBackgroundDefinition(outlookType string, label string) *SPCOutlookBackgroundDefinition {
|
||||||
|
definition, ok := spcOutlookBackgroundDefinitions[spcOutlookDefinitionKey(outlookType, label)]
|
||||||
|
if !ok {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return &definition
|
||||||
|
}
|
||||||
|
|
||||||
|
func spcOutlookDefinitionKey(outlookType string, label string) string {
|
||||||
|
return strings.ToLower(strings.TrimSpace(outlookType)) + ":" + strings.ToUpper(strings.TrimSpace(label))
|
||||||
|
}
|
||||||
@@ -1,13 +1,18 @@
|
|||||||
package briefing
|
package briefing
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
"unicode"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/module"
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/module"
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/timeutil"
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/timeutil"
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/weatherdata"
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/weatherdata"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const defaultSPCRiskDigestOutlookType = "categorical"
|
||||||
|
const defaultSPCRiskDigestMinimumSeverityRank = 3
|
||||||
|
|
||||||
type SPCConvectiveOutlooksModule struct {
|
type SPCConvectiveOutlooksModule struct {
|
||||||
Checked bool `json:"checked"`
|
Checked bool `json:"checked"`
|
||||||
AsOf string `json:"as_of,omitempty"`
|
AsOf string `json:"as_of,omitempty"`
|
||||||
@@ -16,6 +21,7 @@ type SPCConvectiveOutlooksModule struct {
|
|||||||
LocationName string `json:"location_name,omitempty"`
|
LocationName string `json:"location_name,omitempty"`
|
||||||
OutlookCount int `json:"outlook_count"`
|
OutlookCount int `json:"outlook_count"`
|
||||||
Outlooks []SPCConvectiveOutlookRecord `json:"outlooks,omitempty"`
|
Outlooks []SPCConvectiveOutlookRecord `json:"outlooks,omitempty"`
|
||||||
|
RiskDigest []SPCConvectiveOutlookDigest `json:"risk_digest,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type SPCConvectiveOutlookRecord struct {
|
type SPCConvectiveOutlookRecord struct {
|
||||||
@@ -23,6 +29,7 @@ type SPCConvectiveOutlookRecord struct {
|
|||||||
OutlookType string `json:"outlook_type,omitempty"`
|
OutlookType string `json:"outlook_type,omitempty"`
|
||||||
Label string `json:"label,omitempty"`
|
Label string `json:"label,omitempty"`
|
||||||
LabelText string `json:"label_text,omitempty"`
|
LabelText string `json:"label_text,omitempty"`
|
||||||
|
BackgroundDefinition *SPCOutlookBackgroundDefinition `json:"background_definition,omitempty"`
|
||||||
PeriodBegins string `json:"period_begins,omitempty"`
|
PeriodBegins string `json:"period_begins,omitempty"`
|
||||||
PeriodEnds string `json:"period_ends,omitempty"`
|
PeriodEnds string `json:"period_ends,omitempty"`
|
||||||
IssuedAt string `json:"issued_at,omitempty"`
|
IssuedAt string `json:"issued_at,omitempty"`
|
||||||
@@ -30,6 +37,19 @@ type SPCConvectiveOutlookRecord struct {
|
|||||||
ImageURL string `json:"image_url,omitempty"`
|
ImageURL string `json:"image_url,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type SPCOutlookBackgroundDefinition struct {
|
||||||
|
PlainLanguage string `json:"plain_language,omitempty"`
|
||||||
|
OfficialDescription string `json:"official_description,omitempty"`
|
||||||
|
RelativeLevel string `json:"relative_level,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type SPCConvectiveOutlookDigest struct {
|
||||||
|
LabelText string `json:"label_text,omitempty"`
|
||||||
|
RiskLabel string `json:"risk_label,omitempty"`
|
||||||
|
PeriodBegins string `json:"period_begins,omitempty"`
|
||||||
|
PeriodEnds string `json:"period_ends,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
func buildSPCConvectiveOutlooksModule(ctx ModuleContext, _ any) (*module.Output, error) {
|
func buildSPCConvectiveOutlooksModule(ctx ModuleContext, _ any) (*module.Output, error) {
|
||||||
value := SPCConvectiveOutlooksModule{}
|
value := SPCConvectiveOutlooksModule{}
|
||||||
run := ctx.Collected.SPCConvectiveOutlooks
|
run := ctx.Collected.SPCConvectiveOutlooks
|
||||||
@@ -49,10 +69,23 @@ func buildSPCConvectiveOutlooksModule(ctx ModuleContext, _ any) (*module.Output,
|
|||||||
}
|
}
|
||||||
|
|
||||||
value.Outlooks = spcConvectiveOutlookRecords(ctx.Derived.SPCConvectiveOutlooks, ctx.Resolved.ValidPeriod, ctx.Timezone)
|
value.Outlooks = spcConvectiveOutlookRecords(ctx.Derived.SPCConvectiveOutlooks, ctx.Resolved.ValidPeriod, ctx.Timezone)
|
||||||
|
value.RiskDigest = spcConvectiveOutlookRiskDigest(ctx.Derived.SPCConvectiveOutlooks, ctx.Resolved.ValidPeriod, ctx.Timezone, defaultSPCRiskDigestPolicy())
|
||||||
value.OutlookCount = len(value.Outlooks)
|
value.OutlookCount = len(value.Outlooks)
|
||||||
return &module.Output{ID: module.SPCConvectiveOutlooks, StanzaName: string(module.SPCConvectiveOutlooks), Value: value}, nil
|
return &module.Output{ID: module.SPCConvectiveOutlooks, StanzaName: string(module.SPCConvectiveOutlooks), Value: value}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type spcRiskDigestPolicy struct {
|
||||||
|
OutlookType string
|
||||||
|
MinimumSeverityRank int
|
||||||
|
}
|
||||||
|
|
||||||
|
func defaultSPCRiskDigestPolicy() spcRiskDigestPolicy {
|
||||||
|
return spcRiskDigestPolicy{
|
||||||
|
OutlookType: defaultSPCRiskDigestOutlookType,
|
||||||
|
MinimumSeverityRank: defaultSPCRiskDigestMinimumSeverityRank,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func spcConvectiveOutlookRecords(outlooks []weatherdata.ConvectiveOutlook, reportPeriod timeutil.Period, timezone string) []SPCConvectiveOutlookRecord {
|
func spcConvectiveOutlookRecords(outlooks []weatherdata.ConvectiveOutlook, reportPeriod timeutil.Period, timezone string) []SPCConvectiveOutlookRecord {
|
||||||
records := make([]SPCConvectiveOutlookRecord, 0, len(outlooks))
|
records := make([]SPCConvectiveOutlookRecord, 0, len(outlooks))
|
||||||
for _, outlook := range outlooks {
|
for _, outlook := range outlooks {
|
||||||
@@ -65,6 +98,7 @@ func spcConvectiveOutlookRecords(outlooks []weatherdata.ConvectiveOutlook, repor
|
|||||||
OutlookType: outlook.OutlookType,
|
OutlookType: outlook.OutlookType,
|
||||||
Label: outlook.Label,
|
Label: outlook.Label,
|
||||||
LabelText: outlook.LabelText,
|
LabelText: outlook.LabelText,
|
||||||
|
BackgroundDefinition: spcOutlookBackgroundDefinition(outlook.OutlookType, outlook.Label),
|
||||||
PeriodBegins: friendlyPeriodBeginsLabel(outlookPeriod, timezone),
|
PeriodBegins: friendlyPeriodBeginsLabel(outlookPeriod, timezone),
|
||||||
PeriodEnds: friendlyPeriodEndsLabel(outlookPeriod, timezone),
|
PeriodEnds: friendlyPeriodEndsLabel(outlookPeriod, timezone),
|
||||||
IssuedAt: friendlyOptionalTime(outlook.IssuedAt, timezone),
|
IssuedAt: friendlyOptionalTime(outlook.IssuedAt, timezone),
|
||||||
@@ -75,6 +109,42 @@ func spcConvectiveOutlookRecords(outlooks []weatherdata.ConvectiveOutlook, repor
|
|||||||
return records
|
return records
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func spcConvectiveOutlookRiskDigest(outlooks []weatherdata.ConvectiveOutlook, reportPeriod timeutil.Period, timezone string, policy spcRiskDigestPolicy) []SPCConvectiveOutlookDigest {
|
||||||
|
records := make([]SPCConvectiveOutlookDigest, 0, len(outlooks))
|
||||||
|
for _, outlook := range outlooks {
|
||||||
|
if outlook.OutlookType != policy.OutlookType {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if outlook.SeverityRank == nil || *outlook.SeverityRank < policy.MinimumSeverityRank {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !outlook.ContainsLocation {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
outlookPeriod := timeutil.Period{Start: outlook.ValidFrom, End: outlook.ValidTo}
|
||||||
|
if !outlookPeriod.IsValid() || !outlookPeriod.Overlaps(reportPeriod) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
records = append(records, SPCConvectiveOutlookDigest{
|
||||||
|
LabelText: outlook.LabelText,
|
||||||
|
RiskLabel: spcRiskDigestLabel(outlook.LabelText),
|
||||||
|
PeriodBegins: friendlyMonthDayTimeLabel(outlookPeriod.Start, timezone),
|
||||||
|
PeriodEnds: friendlyMonthDayTimeLabel(outlookPeriod.End, timezone),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
return records
|
||||||
|
}
|
||||||
|
|
||||||
|
func spcRiskDigestLabel(labelText string) string {
|
||||||
|
label := strings.TrimSpace(labelText)
|
||||||
|
if label == "" {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
runes := []rune(strings.ToLower(label))
|
||||||
|
runes[0] = unicode.ToUpper(runes[0])
|
||||||
|
return string(runes)
|
||||||
|
}
|
||||||
|
|
||||||
func friendlyOptionalTime(value *time.Time, timezone string) string {
|
func friendlyOptionalTime(value *time.Time, timezone string) string {
|
||||||
if value == nil {
|
if value == nil {
|
||||||
return ""
|
return ""
|
||||||
|
|||||||
@@ -65,18 +65,31 @@ func TestSPCConvectiveOutlooksModuleBuildsPromptSafeRiskProduct(t *testing.T) {
|
|||||||
if got.Day != 1 || got.OutlookType != "categorical" || got.Label != "SLGT" || got.LabelText != "Slight Risk" {
|
if got.Day != 1 || got.OutlookType != "categorical" || got.Label != "SLGT" || got.LabelText != "Slight Risk" {
|
||||||
t.Fatalf("outlook = %#v, want categorical slight risk fields", got)
|
t.Fatalf("outlook = %#v, want categorical slight risk fields", got)
|
||||||
}
|
}
|
||||||
|
if got.BackgroundDefinition == nil ||
|
||||||
|
got.BackgroundDefinition.PlainLanguage != "Scattered severe storms possible." ||
|
||||||
|
got.BackgroundDefinition.OfficialDescription != "Isolated intense storms are possible within the risk area, but severe weather is generally expected to be short-lived and/or not widespread." ||
|
||||||
|
got.BackgroundDefinition.RelativeLevel != "2 of 5" {
|
||||||
|
t.Fatalf("background definition = %#v, want Slight Risk helper", got.BackgroundDefinition)
|
||||||
|
}
|
||||||
if got.PeriodBegins != "2026-05-29 at 11:00 AM" || got.PeriodEnds != "2026-05-30 at 7:00 AM" || got.IssuedAt != "2026-05-29 at 8:45 AM" {
|
if got.PeriodBegins != "2026-05-29 at 11:00 AM" || got.PeriodEnds != "2026-05-30 at 7:00 AM" || got.IssuedAt != "2026-05-29 at 8:45 AM" {
|
||||||
t.Fatalf("outlook times = %#v, want friendly local labels", got)
|
t.Fatalf("outlook times = %#v, want friendly local labels", got)
|
||||||
}
|
}
|
||||||
if !got.ContainsLocation || got.ImageURL == "" {
|
if !got.ContainsLocation || got.ImageURL == "" {
|
||||||
t.Fatalf("outlook = %#v, want location flag and image URL", got)
|
t.Fatalf("outlook = %#v, want location flag and image URL", got)
|
||||||
}
|
}
|
||||||
|
if len(value.RiskDigest) != 1 {
|
||||||
|
t.Fatalf("RiskDigest length = %d, want 1", len(value.RiskDigest))
|
||||||
|
}
|
||||||
|
digest := value.RiskDigest[0]
|
||||||
|
if digest.LabelText != "Slight Risk" || digest.RiskLabel != "Slight risk" || digest.PeriodBegins != "May 29 at 11:00 AM" || digest.PeriodEnds != "May 30 at 7:00 AM" {
|
||||||
|
t.Fatalf("risk digest = %#v, want prompt-facing slight risk record", digest)
|
||||||
|
}
|
||||||
data, err := json.Marshal(output.Value)
|
data, err := json.Marshal(output.Value)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("Marshal() error = %v", err)
|
t.Fatalf("Marshal() error = %v", err)
|
||||||
}
|
}
|
||||||
text := string(data)
|
text := string(data)
|
||||||
for _, field := range []string{"checked", "as_of", "issued_at", "location_id", "location_name", "outlook_count", "outlooks", "period_begins", "period_ends", "contains_location", "image_url"} {
|
for _, field := range []string{"checked", "as_of", "issued_at", "location_id", "location_name", "outlook_count", "outlooks", "risk_digest", "background_definition", "plain_language", "official_description", "relative_level", "period_begins", "period_ends", "contains_location", "image_url"} {
|
||||||
if !strings.Contains(text, field) {
|
if !strings.Contains(text, field) {
|
||||||
t.Fatalf("json = %s, want field %s", text, field)
|
t.Fatalf("json = %s, want field %s", text, field)
|
||||||
}
|
}
|
||||||
@@ -88,6 +101,163 @@ func TestSPCConvectiveOutlooksModuleBuildsPromptSafeRiskProduct(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestSPCOutlookBackgroundDefinitionLookup(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
outlookType string
|
||||||
|
label string
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{name: "exact slight risk", outlookType: "categorical", label: "SLGT", want: true},
|
||||||
|
{name: "normalized slight risk", outlookType: " Categorical ", label: "slgt", want: true},
|
||||||
|
{name: "expanded marginal risk", outlookType: "categorical", label: "MRGL", want: true},
|
||||||
|
{name: "expanded conditional tornado risk", outlookType: "tornado", label: "CIG3", want: true},
|
||||||
|
{name: "unknown risk", outlookType: "categorical", label: "FOO"},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
definition := spcOutlookBackgroundDefinition(tt.outlookType, tt.label)
|
||||||
|
if tt.want && definition == nil {
|
||||||
|
t.Fatalf("spcOutlookBackgroundDefinition(%q, %q) = nil, want definition", tt.outlookType, tt.label)
|
||||||
|
}
|
||||||
|
if !tt.want && definition != nil {
|
||||||
|
t.Fatalf("spcOutlookBackgroundDefinition(%q, %q) = %#v, want nil", tt.outlookType, tt.label, definition)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSPCConvectiveOutlooksModuleOmitsUnknownBackgroundDefinition(t *testing.T) {
|
||||||
|
registry := MustDefaultModuleRegistry()
|
||||||
|
ctx := testModuleContext()
|
||||||
|
outlook := spcRiskDigestTestOutlook("categorical", "Unknown Risk", 2, true,
|
||||||
|
"2026-05-29T11:00:00-05:00", "2026-05-30T07:00:00-05:00")
|
||||||
|
outlook.Label = "FOO"
|
||||||
|
ctx.Collected.SPCConvectiveOutlooks = &weatherdata.ConvectiveOutlookRun{
|
||||||
|
Outlooks: []weatherdata.ConvectiveOutlook{outlook},
|
||||||
|
}
|
||||||
|
ctx.Derived.SPCConvectiveOutlooks = []weatherdata.ConvectiveOutlook{outlook}
|
||||||
|
|
||||||
|
output, err := registry.BuildModule(ctx, module.ConfigItem{ID: module.SPCConvectiveOutlooks})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("BuildModule() error = %v", err)
|
||||||
|
}
|
||||||
|
value := moduleValue[SPCConvectiveOutlooksModule](t, output)
|
||||||
|
if len(value.Outlooks) != 1 {
|
||||||
|
t.Fatalf("Outlooks length = %d, want 1", len(value.Outlooks))
|
||||||
|
}
|
||||||
|
if value.Outlooks[0].BackgroundDefinition != nil {
|
||||||
|
t.Fatalf("BackgroundDefinition = %#v, want nil for undefined risk", value.Outlooks[0].BackgroundDefinition)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSPCOutlookBackgroundDefinitionsAssetHasUsableEntries(t *testing.T) {
|
||||||
|
wantKeys := []string{
|
||||||
|
"categorical:TSTM",
|
||||||
|
"categorical:MRGL",
|
||||||
|
"categorical:SLGT",
|
||||||
|
"categorical:ENH",
|
||||||
|
"categorical:MDT",
|
||||||
|
"categorical:HIGH",
|
||||||
|
"tornado:CIG1",
|
||||||
|
"tornado:CIG2",
|
||||||
|
"tornado:CIG3",
|
||||||
|
"wind:CIG1",
|
||||||
|
"wind:CIG2",
|
||||||
|
"wind:CIG3",
|
||||||
|
"hail:CIG1",
|
||||||
|
"hail:CIG2",
|
||||||
|
}
|
||||||
|
if len(spcOutlookBackgroundDefinitions) != len(wantKeys) {
|
||||||
|
t.Fatalf("embedded SPC outlook background definitions length = %d, want %d", len(spcOutlookBackgroundDefinitions), len(wantKeys))
|
||||||
|
}
|
||||||
|
for _, key := range wantKeys {
|
||||||
|
if _, ok := spcOutlookBackgroundDefinitions[key]; !ok {
|
||||||
|
t.Fatalf("embedded SPC outlook background definitions missing %q", key)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for key, definition := range spcOutlookBackgroundDefinitions {
|
||||||
|
if strings.TrimSpace(key) == "" {
|
||||||
|
t.Fatal("embedded SPC outlook background definitions contain empty key")
|
||||||
|
}
|
||||||
|
if definition.PlainLanguage == "" || definition.OfficialDescription == "" || definition.RelativeLevel == "" {
|
||||||
|
t.Fatalf("embedded SPC outlook background definition %q is incomplete: %#v", key, definition)
|
||||||
|
}
|
||||||
|
if strings.Contains(definition.OfficialDescription, ".Note") || strings.Contains(definition.OfficialDescription, "higher.Note") {
|
||||||
|
t.Fatalf("embedded SPC outlook background definition %q has missing sentence spacing: %q", key, definition.OfficialDescription)
|
||||||
|
}
|
||||||
|
if strings.Contains(definition.OfficialDescription, "by themselves") {
|
||||||
|
t.Fatalf("embedded SPC outlook background definition %q has singular grammar issue: %q", key, definition.OfficialDescription)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSPCRiskDigestDefaultPolicyConstants(t *testing.T) {
|
||||||
|
if defaultSPCRiskDigestOutlookType != "categorical" {
|
||||||
|
t.Fatalf("defaultSPCRiskDigestOutlookType = %q, want categorical", defaultSPCRiskDigestOutlookType)
|
||||||
|
}
|
||||||
|
if defaultSPCRiskDigestMinimumSeverityRank != 3 {
|
||||||
|
t.Fatalf("defaultSPCRiskDigestMinimumSeverityRank = %d, want 3", defaultSPCRiskDigestMinimumSeverityRank)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSPCConvectiveOutlooksRiskDigestFilters(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
outlook weatherdata.ConvectiveOutlook
|
||||||
|
wantRisk bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "categorical slight risk included",
|
||||||
|
outlook: spcRiskDigestTestOutlook("categorical", "Slight Risk", 3, true,
|
||||||
|
"2026-05-29T11:00:00-05:00", "2026-05-30T07:00:00-05:00"),
|
||||||
|
wantRisk: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "marginal risk excluded",
|
||||||
|
outlook: spcRiskDigestTestOutlook("categorical", "Marginal Risk", 2, true,
|
||||||
|
"2026-05-29T11:00:00-05:00", "2026-05-30T07:00:00-05:00"),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "non categorical high rank excluded",
|
||||||
|
outlook: spcRiskDigestTestOutlook("wind", "30% Wind Risk", 30, true,
|
||||||
|
"2026-05-29T11:00:00-05:00", "2026-05-30T07:00:00-05:00"),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "non overlapping excluded",
|
||||||
|
outlook: spcRiskDigestTestOutlook("categorical", "Enhanced Risk", 4, true,
|
||||||
|
"2026-05-30T07:00:00-05:00", "2026-05-31T07:00:00-05:00"),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "location miss excluded",
|
||||||
|
outlook: spcRiskDigestTestOutlook("categorical", "Moderate Risk", 5, false,
|
||||||
|
"2026-05-29T11:00:00-05:00", "2026-05-30T07:00:00-05:00"),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
registry := MustDefaultModuleRegistry()
|
||||||
|
ctx := testModuleContext()
|
||||||
|
ctx.Collected.SPCConvectiveOutlooks = &weatherdata.ConvectiveOutlookRun{
|
||||||
|
Outlooks: []weatherdata.ConvectiveOutlook{tt.outlook},
|
||||||
|
}
|
||||||
|
ctx.Derived.SPCConvectiveOutlooks = []weatherdata.ConvectiveOutlook{tt.outlook}
|
||||||
|
|
||||||
|
output, err := registry.BuildModule(ctx, module.ConfigItem{ID: module.SPCConvectiveOutlooks})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("BuildModule() error = %v", err)
|
||||||
|
}
|
||||||
|
value := moduleValue[SPCConvectiveOutlooksModule](t, output)
|
||||||
|
gotRisk := len(value.RiskDigest) > 0
|
||||||
|
if gotRisk != tt.wantRisk {
|
||||||
|
t.Fatalf("RiskDigest = %#v, want included=%v", value.RiskDigest, tt.wantRisk)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestSPCConvectiveOutlooksModuleSkipsNonOverlappingOutlooks(t *testing.T) {
|
func TestSPCConvectiveOutlooksModuleSkipsNonOverlappingOutlooks(t *testing.T) {
|
||||||
registry := MustDefaultModuleRegistry()
|
registry := MustDefaultModuleRegistry()
|
||||||
ctx := testModuleContext()
|
ctx := testModuleContext()
|
||||||
@@ -117,6 +287,9 @@ func TestSPCConvectiveOutlooksModuleSkipsNonOverlappingOutlooks(t *testing.T) {
|
|||||||
if value.OutlookCount != 0 || len(value.Outlooks) != 0 {
|
if value.OutlookCount != 0 || len(value.Outlooks) != 0 {
|
||||||
t.Fatalf("value = %#v, want non-overlapping outlook omitted", value)
|
t.Fatalf("value = %#v, want non-overlapping outlook omitted", value)
|
||||||
}
|
}
|
||||||
|
if len(value.RiskDigest) != 0 {
|
||||||
|
t.Fatalf("RiskDigest = %#v, want non-overlapping outlook omitted", value.RiskDigest)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSPCConvectiveOutlooksModuleBuildsCheckedEmptyStanza(t *testing.T) {
|
func TestSPCConvectiveOutlooksModuleBuildsCheckedEmptyStanza(t *testing.T) {
|
||||||
@@ -167,3 +340,16 @@ func TestSPCConvectiveOutlooksModuleBuildsUncheckedStanzaForMissingSource(t *tes
|
|||||||
t.Fatalf("missing source value = %#v, want unchecked empty stanza", value)
|
t.Fatalf("missing source value = %#v, want unchecked empty stanza", value)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func spcRiskDigestTestOutlook(outlookType string, labelText string, rank int, containsLocation bool, validFrom string, validTo string) weatherdata.ConvectiveOutlook {
|
||||||
|
return weatherdata.ConvectiveOutlook{
|
||||||
|
ID: labelText,
|
||||||
|
Day: 1,
|
||||||
|
OutlookType: outlookType,
|
||||||
|
LabelText: labelText,
|
||||||
|
SeverityRank: &rank,
|
||||||
|
ValidFrom: mustParseModuleTime(validFrom),
|
||||||
|
ValidTo: mustParseModuleTime(validTo),
|
||||||
|
ContainsLocation: containsLocation,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
6
internal/buildinfo/buildinfo.go
Normal file
6
internal/buildinfo/buildinfo.go
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
// Package buildinfo exposes release metadata injected by the build pipeline.
|
||||||
|
package buildinfo
|
||||||
|
|
||||||
|
// Version identifies this Weatherreporter build. Release builds replace the
|
||||||
|
// development value with their semantic version tag through the Go linker.
|
||||||
|
var Version = "development"
|
||||||
@@ -1,313 +0,0 @@
|
|||||||
// Package changes compares structured module snapshots.
|
|
||||||
package changes
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"math"
|
|
||||||
"sort"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/module"
|
|
||||||
)
|
|
||||||
|
|
||||||
type Thresholds struct {
|
|
||||||
TemperatureDegrees float64
|
|
||||||
PrecipProbabilityPoints int
|
|
||||||
WindGustMilesPerHour int
|
|
||||||
PrecipTimingShiftMinutes int
|
|
||||||
}
|
|
||||||
|
|
||||||
type Change struct {
|
|
||||||
Type string `json:"type"`
|
|
||||||
Message string `json:"message"`
|
|
||||||
Previous string `json:"previous,omitempty"`
|
|
||||||
Current string `json:"current,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func CompareDaily(previous module.Snapshot, current module.Snapshot, thresholds Thresholds) ([]Change, error) {
|
|
||||||
previousSummary, err := requiredStanza[dailySummaryStanza](previous, "derived_daily_summary")
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("previous daily summary: %w", err)
|
|
||||||
}
|
|
||||||
currentSummary, err := requiredStanza[dailySummaryStanza](current, "derived_daily_summary")
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("current daily summary: %w", err)
|
|
||||||
}
|
|
||||||
previousDayparts, err := requiredStanza[map[string]daypartSummaryStanza](previous, "derived_daypart_summaries")
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("previous daypart summaries: %w", err)
|
|
||||||
}
|
|
||||||
currentDayparts, err := requiredStanza[map[string]daypartSummaryStanza](current, "derived_daypart_summaries")
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("current daypart summaries: %w", err)
|
|
||||||
}
|
|
||||||
previousAlerts, _, err := module.StanzaValue[alertDigestStanza](previous, "alert_digest")
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
currentAlerts, _, err := module.StanzaValue[alertDigestStanza](current, "alert_digest")
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
previousTiming, previousHasTiming, err := module.StanzaValue[precipTimingStanza](previous, "precip_timing")
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
currentTiming, currentHasTiming, err := module.StanzaValue[precipTimingStanza](current, "precip_timing")
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
var changes []Change
|
|
||||||
changes = append(changes, compareTemperatureValues("Low", previousSummary.LowTempF, currentSummary.LowTempF, thresholds.TemperatureDegrees)...)
|
|
||||||
changes = append(changes, compareTemperatureValues("High", previousSummary.HighTempF, currentSummary.HighTempF, thresholds.TemperatureDegrees)...)
|
|
||||||
changes = append(changes, comparePrecipitationValues(previousSummary.DailyPrecipitationProbability, currentSummary.DailyPrecipitationProbability, thresholds.PrecipProbabilityPoints, "")...)
|
|
||||||
if previousHasTiming && currentHasTiming {
|
|
||||||
changes = append(changes, comparePrecipTiming(previousTiming.MaxPopTime, currentTiming.MaxPopTime, thresholds.PrecipTimingShiftMinutes, "")...)
|
|
||||||
}
|
|
||||||
changes = append(changes, compareWindValues(previousSummary.MaxWindGustMph, currentSummary.MaxWindGustMph, thresholds.WindGustMilesPerHour, "")...)
|
|
||||||
changes = append(changes, compareAlerts(previousAlerts.Relevant, currentAlerts.Relevant)...)
|
|
||||||
changes = append(changes, compareIndicators(aggregateIndicators(previousDayparts), aggregateIndicators(currentDayparts), "")...)
|
|
||||||
sortChanges(changes)
|
|
||||||
return changes, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
type dailySummaryStanza struct {
|
|
||||||
Date string `json:"date,omitempty"`
|
|
||||||
HighTempF *int `json:"high_temp_f,omitempty"`
|
|
||||||
LowTempF *int `json:"low_temp_f,omitempty"`
|
|
||||||
DailyPrecipitationProbability *int `json:"daily_precipitation_probability,omitempty"`
|
|
||||||
MaxWindGustMph *int `json:"max_wind_gust_mph,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type daypartSummaryStanza struct {
|
|
||||||
Date string `json:"date,omitempty"`
|
|
||||||
PeriodBegins string `json:"period_begins,omitempty"`
|
|
||||||
PeriodEnds string `json:"period_ends,omitempty"`
|
|
||||||
TempRangeF string `json:"temp_range_f,omitempty"`
|
|
||||||
MaxPopPercent *int `json:"max_pop_percent,omitempty"`
|
|
||||||
MaxPopTime string `json:"max_pop_time,omitempty"`
|
|
||||||
MaxWindGustMph *int `json:"max_wind_gust_mph,omitempty"`
|
|
||||||
Snow bool `json:"snow,omitempty"`
|
|
||||||
Ice bool `json:"ice,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type precipTimingStanza struct {
|
|
||||||
MaxPopPercent *int `json:"max_pop_percent,omitempty"`
|
|
||||||
MaxPopTime string `json:"max_pop_time,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type alertDigestStanza struct {
|
|
||||||
Relevant []alertSummaryStanza `json:"relevant,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type alertSummaryStanza struct {
|
|
||||||
Event string `json:"event,omitempty"`
|
|
||||||
Headline string `json:"headline,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type indicators struct {
|
|
||||||
Snow bool
|
|
||||||
Ice bool
|
|
||||||
}
|
|
||||||
|
|
||||||
func requiredStanza[T any](snapshot module.Snapshot, name string) (T, error) {
|
|
||||||
value, ok, err := module.StanzaValue[T](snapshot, name)
|
|
||||||
if err != nil {
|
|
||||||
return value, err
|
|
||||||
}
|
|
||||||
if !ok {
|
|
||||||
return value, fmt.Errorf("stanza %q is required", name)
|
|
||||||
}
|
|
||||||
return value, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func compareTemperatureValues(label string, previous *int, current *int, threshold float64) []Change {
|
|
||||||
if previous == nil || current == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if !differenceAtLeast(float64(*previous), float64(*current), threshold) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return []Change{{
|
|
||||||
Type: "temperature_shift",
|
|
||||||
Message: fmt.Sprintf("%s temperature changed from %d to %d.", label, *previous, *current),
|
|
||||||
Previous: fmt.Sprintf("%d", *previous),
|
|
||||||
Current: fmt.Sprintf("%d", *current),
|
|
||||||
}}
|
|
||||||
}
|
|
||||||
|
|
||||||
func comparePrecipitationValues(previous *int, current *int, threshold int, prefix string) []Change {
|
|
||||||
if previous == nil || current == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
previousCategory := precipitationCategory(float64(*previous))
|
|
||||||
currentCategory := precipitationCategory(float64(*current))
|
|
||||||
if previousCategory == currentCategory && !differenceAtLeast(float64(*previous), float64(*current), float64(threshold)) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
changeType := prefix + "precip_probability_change"
|
|
||||||
return []Change{{
|
|
||||||
Type: changeType,
|
|
||||||
Message: fmt.Sprintf("Peak precipitation chance changed from %d%% (%s) to %d%% (%s).", *previous, previousCategory, *current, currentCategory),
|
|
||||||
Previous: fmt.Sprintf("%d%% %s", *previous, previousCategory),
|
|
||||||
Current: fmt.Sprintf("%d%% %s", *current, currentCategory),
|
|
||||||
}}
|
|
||||||
}
|
|
||||||
|
|
||||||
func comparePrecipTiming(previous string, current string, thresholdMinutes int, prefix string) []Change {
|
|
||||||
if thresholdMinutes <= 0 || previous == "" || current == "" || previous == current {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
previousTime, previousOK := parseClock(previous)
|
|
||||||
currentTime, currentOK := parseClock(current)
|
|
||||||
if !previousOK || !currentOK {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if int(math.Abs(currentTime.Sub(previousTime).Minutes())) < thresholdMinutes {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return []Change{{
|
|
||||||
Type: prefix + "precip_timing_shift",
|
|
||||||
Message: fmt.Sprintf("Peak precipitation timing shifted from %s to %s.", previous, current),
|
|
||||||
Previous: previous,
|
|
||||||
Current: current,
|
|
||||||
}}
|
|
||||||
}
|
|
||||||
|
|
||||||
func compareWindValues(previous *int, current *int, threshold int, prefix string) []Change {
|
|
||||||
if previous == nil || current == nil || !differenceAtLeast(float64(*previous), float64(*current), float64(threshold)) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return []Change{{
|
|
||||||
Type: prefix + "wind_gust_change",
|
|
||||||
Message: fmt.Sprintf("Peak wind gust changed from %d mph to %d mph.", *previous, *current),
|
|
||||||
Previous: fmt.Sprintf("%d mph", *previous),
|
|
||||||
Current: fmt.Sprintf("%d mph", *current),
|
|
||||||
}}
|
|
||||||
}
|
|
||||||
|
|
||||||
func compareAlerts(previous []alertSummaryStanza, current []alertSummaryStanza) []Change {
|
|
||||||
previousSet := alertSet(previous)
|
|
||||||
currentSet := alertSet(current)
|
|
||||||
var changes []Change
|
|
||||||
for event := range currentSet {
|
|
||||||
if _, ok := previousSet[event]; !ok {
|
|
||||||
changes = append(changes, Change{Type: "alert_added", Message: fmt.Sprintf("Alert added: %s.", event), Current: event})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
for event := range previousSet {
|
|
||||||
if _, ok := currentSet[event]; !ok {
|
|
||||||
changes = append(changes, Change{Type: "alert_removed", Message: fmt.Sprintf("Alert removed: %s.", event), Previous: event})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
sortChanges(changes)
|
|
||||||
return changes
|
|
||||||
}
|
|
||||||
|
|
||||||
func compareIndicators(previous indicators, current indicators, prefix string) []Change {
|
|
||||||
var changes []Change
|
|
||||||
for _, item := range []struct {
|
|
||||||
name string
|
|
||||||
previous bool
|
|
||||||
current bool
|
|
||||||
}{
|
|
||||||
{name: "snow", previous: previous.Snow, current: current.Snow},
|
|
||||||
{name: "ice", previous: previous.Ice, current: current.Ice},
|
|
||||||
} {
|
|
||||||
if item.previous == item.current {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
changeType := prefix + item.name + "_risk_change"
|
|
||||||
if item.current {
|
|
||||||
changes = append(changes, Change{Type: changeType, Message: fmt.Sprintf("%s risk is now present.", item.name), Current: "present"})
|
|
||||||
} else {
|
|
||||||
changes = append(changes, Change{Type: changeType, Message: fmt.Sprintf("%s risk is no longer present.", item.name), Previous: "present"})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return changes
|
|
||||||
}
|
|
||||||
|
|
||||||
func aggregateIndicators(dayparts map[string]daypartSummaryStanza) indicators {
|
|
||||||
out := indicators{}
|
|
||||||
for _, daypart := range dayparts {
|
|
||||||
out.Snow = out.Snow || daypart.Snow
|
|
||||||
out.Ice = out.Ice || daypart.Ice
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
func alertSet(alerts []alertSummaryStanza) map[string]struct{} {
|
|
||||||
out := map[string]struct{}{}
|
|
||||||
for _, alert := range alerts {
|
|
||||||
event := alert.Event
|
|
||||||
if event == "" {
|
|
||||||
event = alert.Headline
|
|
||||||
}
|
|
||||||
if event != "" {
|
|
||||||
out[event] = struct{}{}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
func precipitationCategory(value float64) string {
|
|
||||||
switch {
|
|
||||||
case value >= 70:
|
|
||||||
return "high"
|
|
||||||
case value >= 50:
|
|
||||||
return "likely"
|
|
||||||
case value >= 20:
|
|
||||||
return "possible"
|
|
||||||
default:
|
|
||||||
return "low"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func differenceAtLeast(previous float64, current float64, threshold float64) bool {
|
|
||||||
if threshold <= 0 {
|
|
||||||
return previous != current
|
|
||||||
}
|
|
||||||
return math.Abs(current-previous) >= threshold
|
|
||||||
}
|
|
||||||
|
|
||||||
func sortChanges(items []Change) {
|
|
||||||
sort.SliceStable(items, func(i, j int) bool {
|
|
||||||
if items[i].Type == items[j].Type {
|
|
||||||
return items[i].Message < items[j].Message
|
|
||||||
}
|
|
||||||
return items[i].Type < items[j].Type
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseClock(value string) (time.Time, bool) {
|
|
||||||
value = strings.TrimSpace(value)
|
|
||||||
for _, layout := range []string{"3 PM", "3:04 PM", "15:04"} {
|
|
||||||
if parsed, err := time.Parse(layout, value); err == nil {
|
|
||||||
return parsed, true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return time.Time{}, false
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseTempRange(value string) (*int, *int) {
|
|
||||||
value = strings.TrimSpace(value)
|
|
||||||
if value == "" {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
parts := strings.Split(value, "-")
|
|
||||||
if len(parts) == 1 {
|
|
||||||
if parsed, err := strconv.Atoi(strings.TrimSpace(parts[0])); err == nil {
|
|
||||||
return &parsed, &parsed
|
|
||||||
}
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
minValue, minErr := strconv.Atoi(strings.TrimSpace(parts[0]))
|
|
||||||
maxValue, maxErr := strconv.Atoi(strings.TrimSpace(parts[len(parts)-1]))
|
|
||||||
if minErr != nil || maxErr != nil {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
return &minValue, &maxValue
|
|
||||||
}
|
|
||||||
@@ -1,138 +0,0 @@
|
|||||||
package changes
|
|
||||||
|
|
||||||
import (
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/module"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestCompareDailyNoMeaningfulChanges(t *testing.T) {
|
|
||||||
previous := dailySnapshot(t, 60, 70, 30, "8 AM", nil, false)
|
|
||||||
current := dailySnapshot(t, 61, 71, 35, "8:30 AM", nil, false)
|
|
||||||
|
|
||||||
changes, err := CompareDaily(previous, current, testThresholds())
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("CompareDaily() error = %v", err)
|
|
||||||
}
|
|
||||||
if len(changes) != 0 {
|
|
||||||
t.Fatalf("changes = %#v, want none", changes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCompareDailyTemperatureThreshold(t *testing.T) {
|
|
||||||
previous := dailySnapshot(t, 50, 70, 10, "8 AM", nil, false)
|
|
||||||
current := dailySnapshot(t, 58, 79, 10, "8 AM", nil, false)
|
|
||||||
|
|
||||||
changes, err := CompareDaily(previous, current, testThresholds())
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("CompareDaily() error = %v", err)
|
|
||||||
}
|
|
||||||
if countType(changes, "temperature_shift") != 2 {
|
|
||||||
t.Fatalf("changes = %#v, want low and high temperature changes", changes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCompareDailyPrecipTimingShift(t *testing.T) {
|
|
||||||
previous := dailySnapshot(t, 60, 70, 60, "8 AM", nil, false)
|
|
||||||
current := dailySnapshot(t, 60, 70, 60, "11 AM", nil, false)
|
|
||||||
|
|
||||||
changes, err := CompareDaily(previous, current, testThresholds())
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("CompareDaily() error = %v", err)
|
|
||||||
}
|
|
||||||
if countType(changes, "precip_timing_shift") != 1 {
|
|
||||||
t.Fatalf("changes = %#v, want timing shift", changes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCompareDailyAlertAddedAndRemoved(t *testing.T) {
|
|
||||||
previous := dailySnapshot(t, 60, 70, 10, "8 AM", []string{"Wind Advisory"}, false)
|
|
||||||
current := dailySnapshot(t, 60, 70, 10, "8 AM", []string{"Flood Watch"}, false)
|
|
||||||
|
|
||||||
changes, err := CompareDaily(previous, current, testThresholds())
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("CompareDaily() error = %v", err)
|
|
||||||
}
|
|
||||||
if countType(changes, "alert_added") != 1 || countType(changes, "alert_removed") != 1 {
|
|
||||||
t.Fatalf("changes = %#v, want one alert added and one removed", changes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCompareDailyIndicatorChange(t *testing.T) {
|
|
||||||
previous := dailySnapshot(t, 60, 70, 10, "8 AM", nil, false)
|
|
||||||
current := dailySnapshot(t, 60, 70, 10, "8 AM", nil, true)
|
|
||||||
|
|
||||||
changes, err := CompareDaily(previous, current, testThresholds())
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("CompareDaily() error = %v", err)
|
|
||||||
}
|
|
||||||
if countType(changes, "snow_risk_change") != 1 {
|
|
||||||
t.Fatalf("changes = %#v, want snow risk change", changes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCompareDailyRequiresComparisonStanzas(t *testing.T) {
|
|
||||||
_, err := CompareDaily(snapshot(t), dailySnapshot(t, 60, 70, 10, "8 AM", nil, false), testThresholds())
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("CompareDaily() error = nil, want missing stanza error")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "derived_daily_summary") {
|
|
||||||
t.Fatalf("error = %q, want derived_daily_summary context", err.Error())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func dailySnapshot(t *testing.T, low int, high int, precip int, precipTime string, alerts []string, snow bool) module.Snapshot {
|
|
||||||
t.Helper()
|
|
||||||
relevant := make([]alertSummaryStanza, 0, len(alerts))
|
|
||||||
for _, alert := range alerts {
|
|
||||||
relevant = append(relevant, alertSummaryStanza{Event: alert})
|
|
||||||
}
|
|
||||||
return snapshot(t,
|
|
||||||
module.Output{ID: module.DerivedDailySummary, StanzaName: "derived_daily_summary", Value: dailySummaryStanza{
|
|
||||||
Date: "2026-05-29",
|
|
||||||
HighTempF: &high,
|
|
||||||
LowTempF: &low,
|
|
||||||
DailyPrecipitationProbability: &precip,
|
|
||||||
}},
|
|
||||||
module.Output{ID: module.DerivedDaypartSummaries, StanzaName: "derived_daypart_summaries", Value: map[string]daypartSummaryStanza{
|
|
||||||
"morning": {
|
|
||||||
Date: "2026-05-29",
|
|
||||||
PeriodBegins: "2026-05-29 at 6:00 AM",
|
|
||||||
PeriodEnds: "2026-05-29 at 10:00 AM",
|
|
||||||
TempRangeF: "60-70",
|
|
||||||
Snow: snow,
|
|
||||||
},
|
|
||||||
}},
|
|
||||||
module.Output{ID: module.PrecipTiming, StanzaName: "precip_timing", Value: precipTimingStanza{MaxPopPercent: &precip, MaxPopTime: precipTime}},
|
|
||||||
module.Output{ID: module.AlertDigest, StanzaName: "alert_digest", Value: alertDigestStanza{Relevant: relevant}},
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
func snapshot(t *testing.T, outputs ...module.Output) module.Snapshot {
|
|
||||||
t.Helper()
|
|
||||||
snapshot, err := module.NewSnapshot(outputs)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("NewSnapshot() error = %v", err)
|
|
||||||
}
|
|
||||||
return snapshot
|
|
||||||
}
|
|
||||||
|
|
||||||
func testThresholds() Thresholds {
|
|
||||||
return Thresholds{
|
|
||||||
TemperatureDegrees: 5,
|
|
||||||
PrecipProbabilityPoints: 20,
|
|
||||||
WindGustMilesPerHour: 10,
|
|
||||||
PrecipTimingShiftMinutes: 120,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func countType(changes []Change, changeType string) int {
|
|
||||||
var count int
|
|
||||||
for _, change := range changes {
|
|
||||||
if change.Type == changeType {
|
|
||||||
count++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return count
|
|
||||||
}
|
|
||||||
@@ -1,144 +0,0 @@
|
|||||||
package changes
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"sort"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/module"
|
|
||||||
)
|
|
||||||
|
|
||||||
func CompareThreeDay(previous module.Snapshot, current module.Snapshot, thresholds Thresholds) ([]Change, error) {
|
|
||||||
previousDayparts, err := requiredStanza[map[string]daypartSummaryStanza](previous, "derived_daypart_summaries")
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("previous daypart summaries: %w", err)
|
|
||||||
}
|
|
||||||
currentDayparts, err := requiredStanza[map[string]daypartSummaryStanza](current, "derived_daypart_summaries")
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("current daypart summaries: %w", err)
|
|
||||||
}
|
|
||||||
previousDays := outlookDaysFromDayparts(previousDayparts)
|
|
||||||
currentDays := outlookDaysFromDayparts(currentDayparts)
|
|
||||||
return compareOutlookDays(previousDays, currentDays, thresholds, "")
|
|
||||||
}
|
|
||||||
|
|
||||||
type outlookDay struct {
|
|
||||||
Date string
|
|
||||||
LowTempF *int
|
|
||||||
HighTempF *int
|
|
||||||
MaxPopPercent *int
|
|
||||||
MaxPopTime string
|
|
||||||
MaxWindGustMph *int
|
|
||||||
Indicators indicators
|
|
||||||
}
|
|
||||||
|
|
||||||
func compareOutlookDays(previousDays map[string]outlookDay, currentDays map[string]outlookDay, thresholds Thresholds, prefix string) ([]Change, error) {
|
|
||||||
var changes []Change
|
|
||||||
for date, currentDay := range currentDays {
|
|
||||||
previousDay, ok := previousDays[date]
|
|
||||||
if !ok {
|
|
||||||
changes = append(changes, Change{Type: prefix + "outlook_day_added", Message: fmt.Sprintf("Outlook day added: %s.", date), Current: date})
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
changes = append(changes, compareOutlookDay(date, previousDay, currentDay, thresholds, prefix)...)
|
|
||||||
}
|
|
||||||
for date := range previousDays {
|
|
||||||
if _, ok := currentDays[date]; !ok {
|
|
||||||
changes = append(changes, Change{Type: prefix + "outlook_day_removed", Message: fmt.Sprintf("Outlook day removed: %s.", date), Previous: date})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
sortChanges(changes)
|
|
||||||
return changes, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func compareOutlookDay(date string, previous outlookDay, current outlookDay, thresholds Thresholds, prefix string) []Change {
|
|
||||||
var changes []Change
|
|
||||||
for _, change := range compareTemperatureValues("Low", previous.LowTempF, current.LowTempF, thresholds.TemperatureDegrees) {
|
|
||||||
change.Message = date + ": " + change.Message
|
|
||||||
change.Type = prefix + "outlook_" + change.Type
|
|
||||||
changes = append(changes, change)
|
|
||||||
}
|
|
||||||
for _, change := range compareTemperatureValues("High", previous.HighTempF, current.HighTempF, thresholds.TemperatureDegrees) {
|
|
||||||
change.Message = date + ": " + change.Message
|
|
||||||
change.Type = prefix + "outlook_" + change.Type
|
|
||||||
changes = append(changes, change)
|
|
||||||
}
|
|
||||||
for _, change := range comparePrecipitationValues(previous.MaxPopPercent, current.MaxPopPercent, thresholds.PrecipProbabilityPoints, prefix+"outlook_") {
|
|
||||||
change.Message = date + ": " + change.Message
|
|
||||||
changes = append(changes, change)
|
|
||||||
}
|
|
||||||
for _, change := range comparePrecipTiming(previous.MaxPopTime, current.MaxPopTime, thresholds.PrecipTimingShiftMinutes, prefix+"outlook_") {
|
|
||||||
change.Message = date + ": " + change.Message
|
|
||||||
changes = append(changes, change)
|
|
||||||
}
|
|
||||||
for _, change := range compareWindValues(previous.MaxWindGustMph, current.MaxWindGustMph, thresholds.WindGustMilesPerHour, prefix+"outlook_") {
|
|
||||||
change.Message = date + ": " + change.Message
|
|
||||||
changes = append(changes, change)
|
|
||||||
}
|
|
||||||
for _, change := range compareIndicators(previous.Indicators, current.Indicators, prefix+"outlook_") {
|
|
||||||
change.Message = date + ": " + change.Message
|
|
||||||
changes = append(changes, change)
|
|
||||||
}
|
|
||||||
return changes
|
|
||||||
}
|
|
||||||
|
|
||||||
func outlookDaysFromDayparts(dayparts map[string]daypartSummaryStanza) map[string]outlookDay {
|
|
||||||
out := map[string]outlookDay{}
|
|
||||||
var keys []string
|
|
||||||
for key := range dayparts {
|
|
||||||
keys = append(keys, key)
|
|
||||||
}
|
|
||||||
sort.Strings(keys)
|
|
||||||
for _, key := range keys {
|
|
||||||
daypart := dayparts[key]
|
|
||||||
date := daypartDate(daypart)
|
|
||||||
if date == "" {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
day := out[date]
|
|
||||||
day.Date = date
|
|
||||||
low, high := parseTempRange(daypart.TempRangeF)
|
|
||||||
day.LowTempF = minInt(day.LowTempF, low)
|
|
||||||
day.HighTempF = maxInt(day.HighTempF, high)
|
|
||||||
day.MaxPopPercent = maxInt(day.MaxPopPercent, daypart.MaxPopPercent)
|
|
||||||
if daypart.MaxPopPercent != nil && day.MaxPopPercent != nil && *daypart.MaxPopPercent == *day.MaxPopPercent {
|
|
||||||
day.MaxPopTime = daypart.MaxPopTime
|
|
||||||
}
|
|
||||||
day.MaxWindGustMph = maxInt(day.MaxWindGustMph, daypart.MaxWindGustMph)
|
|
||||||
day.Indicators.Snow = day.Indicators.Snow || daypart.Snow
|
|
||||||
day.Indicators.Ice = day.Indicators.Ice || daypart.Ice
|
|
||||||
out[date] = day
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
func daypartDate(daypart daypartSummaryStanza) string {
|
|
||||||
return daypart.Date
|
|
||||||
}
|
|
||||||
|
|
||||||
func minInt(a *int, b *int) *int {
|
|
||||||
if a == nil {
|
|
||||||
return copyInt(b)
|
|
||||||
}
|
|
||||||
if b != nil && *b < *a {
|
|
||||||
return copyInt(b)
|
|
||||||
}
|
|
||||||
return a
|
|
||||||
}
|
|
||||||
|
|
||||||
func maxInt(a *int, b *int) *int {
|
|
||||||
if a == nil {
|
|
||||||
return copyInt(b)
|
|
||||||
}
|
|
||||||
if b != nil && *b > *a {
|
|
||||||
return copyInt(b)
|
|
||||||
}
|
|
||||||
return a
|
|
||||||
}
|
|
||||||
|
|
||||||
func copyInt(value *int) *int {
|
|
||||||
if value == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
copied := *value
|
|
||||||
return &copied
|
|
||||||
}
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
package changes
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/module"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestCompareThreeDayDetectsDayChanges(t *testing.T) {
|
|
||||||
previous := outlookSnapshot(t, "2026-05-29", "70", 20, "9 AM", false)
|
|
||||||
current := outlookSnapshot(t, "2026-05-29", "78", 70, "12 PM", true)
|
|
||||||
|
|
||||||
changes, err := CompareThreeDay(previous, current, Thresholds{
|
|
||||||
TemperatureDegrees: 5,
|
|
||||||
PrecipProbabilityPoints: 20,
|
|
||||||
PrecipTimingShiftMinutes: 120,
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("CompareThreeDay() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(changes) == 0 {
|
|
||||||
t.Fatal("changes length = 0, want detected 3-day changes")
|
|
||||||
}
|
|
||||||
if countType(changes, "outlook_precip_probability_change") == 0 || countType(changes, "outlook_snow_risk_change") == 0 {
|
|
||||||
t.Fatalf("changes = %#v, want precipitation and snow changes", changes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func outlookSnapshot(t *testing.T, date string, tempRange string, precip int, precipTime string, snow bool) module.Snapshot {
|
|
||||||
t.Helper()
|
|
||||||
return snapshot(t, module.Output{ID: module.DerivedDaypartSummaries, StanzaName: "derived_daypart_summaries", Value: map[string]daypartSummaryStanza{
|
|
||||||
date + "_morning": {
|
|
||||||
Date: date,
|
|
||||||
PeriodBegins: date + " at 6:00 AM",
|
|
||||||
PeriodEnds: date + " at 10:00 AM",
|
|
||||||
TempRangeF: tempRange,
|
|
||||||
MaxPopPercent: &precip,
|
|
||||||
MaxPopTime: precipTime,
|
|
||||||
Snow: snow,
|
|
||||||
},
|
|
||||||
}})
|
|
||||||
}
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
package changes
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/module"
|
|
||||||
)
|
|
||||||
|
|
||||||
func CompareWeekend(previous module.Snapshot, current module.Snapshot, thresholds Thresholds) ([]Change, error) {
|
|
||||||
previousDayparts, err := requiredStanza[map[string]daypartSummaryStanza](previous, "derived_daypart_summaries")
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("previous weekend daypart summaries: %w", err)
|
|
||||||
}
|
|
||||||
currentDayparts, err := requiredStanza[map[string]daypartSummaryStanza](current, "derived_daypart_summaries")
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("current weekend daypart summaries: %w", err)
|
|
||||||
}
|
|
||||||
return compareOutlookDays(outlookDaysFromDayparts(previousDayparts), outlookDaysFromDayparts(currentDayparts), thresholds, "weekend_")
|
|
||||||
}
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
package changes
|
|
||||||
|
|
||||||
import "testing"
|
|
||||||
|
|
||||||
func TestCompareWeekendDetectsOutlookChanges(t *testing.T) {
|
|
||||||
previous := outlookSnapshot(t, "2026-05-30", "70", 10, "9 AM", false)
|
|
||||||
current := outlookSnapshot(t, "2026-05-30", "78", 10, "9 AM", true)
|
|
||||||
|
|
||||||
changes, err := CompareWeekend(previous, current, Thresholds{TemperatureDegrees: 5})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("CompareWeekend() error = %v", err)
|
|
||||||
}
|
|
||||||
if len(changes) == 0 {
|
|
||||||
t.Fatal("changes length = 0, want weekend changes")
|
|
||||||
}
|
|
||||||
if countType(changes, "weekend_outlook_snow_risk_change") == 0 {
|
|
||||||
t.Fatalf("changes = %#v, want snow risk change", changes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
59
internal/cli/executor_factory.go
Normal file
59
internal/cli/executor_factory.go
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"time"
|
||||||
|
|
||||||
|
promptkitadapter "gitea.maximumdirect.net/eric/weatherreporter/internal/adapters/promptkit"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/config"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/promptexec"
|
||||||
|
)
|
||||||
|
|
||||||
|
// PromptExecutorConfig is the project-owned construction input for one prompt
|
||||||
|
// executor. It keeps adapter implementation types out of Runner's API.
|
||||||
|
type PromptExecutorConfig struct {
|
||||||
|
Profile string
|
||||||
|
ProfileFile string
|
||||||
|
ProfileDirectory string
|
||||||
|
Timeout time.Duration
|
||||||
|
LocalEndpoint string
|
||||||
|
LocalConcurrencyLimit int
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExecutorFactory constructs one executor for an action.
|
||||||
|
type ExecutorFactory func(PromptExecutorConfig) (promptexec.Executor, error)
|
||||||
|
|
||||||
|
func (r Runner) promptExecutor(cfg config.PromptkitConfig) (promptexec.Executor, error) {
|
||||||
|
factory := r.ExecutorFactory
|
||||||
|
if factory == nil {
|
||||||
|
factory = newPromptkitExecutor
|
||||||
|
}
|
||||||
|
return factory(promptExecutorConfig(cfg))
|
||||||
|
}
|
||||||
|
|
||||||
|
func promptExecutorConfig(cfg config.PromptkitConfig) PromptExecutorConfig {
|
||||||
|
result := PromptExecutorConfig{
|
||||||
|
Profile: cfg.Profile,
|
||||||
|
ProfileFile: cfg.ProfileFile,
|
||||||
|
ProfileDirectory: cfg.ProfileDir,
|
||||||
|
Timeout: cfg.Timeout,
|
||||||
|
}
|
||||||
|
if cfg.Local.Endpoint != "" {
|
||||||
|
result.LocalEndpoint = cfg.Local.Endpoint
|
||||||
|
result.LocalConcurrencyLimit = cfg.Local.ConcurrencyLimit
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
func newPromptkitExecutor(cfg PromptExecutorConfig) (promptexec.Executor, error) {
|
||||||
|
return promptkitadapter.New(promptkitAdapterConfig(cfg))
|
||||||
|
}
|
||||||
|
|
||||||
|
func promptkitAdapterConfig(cfg PromptExecutorConfig) promptkitadapter.Config {
|
||||||
|
return promptkitadapter.Config{
|
||||||
|
ProfileDirectory: cfg.ProfileDirectory,
|
||||||
|
ProfileFile: cfg.ProfileFile,
|
||||||
|
LocalEndpoint: cfg.LocalEndpoint,
|
||||||
|
LocalConcurrencyLimit: cfg.LocalConcurrencyLimit,
|
||||||
|
Timeout: cfg.Timeout,
|
||||||
|
}
|
||||||
|
}
|
||||||
78
internal/cli/executor_factory_test.go
Normal file
78
internal/cli/executor_factory_test.go
Normal file
@@ -0,0 +1,78 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
promptkitadapter "gitea.maximumdirect.net/eric/weatherreporter/internal/adapters/promptkit"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/config"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/promptexec"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestRunnerPromptExecutorMapsConfigurationOnce(t *testing.T) {
|
||||||
|
var calls int
|
||||||
|
var received PromptExecutorConfig
|
||||||
|
runner := Runner{ExecutorFactory: func(value PromptExecutorConfig) (promptexec.Executor, error) {
|
||||||
|
calls++
|
||||||
|
received = value
|
||||||
|
return factoryExecutor{}, nil
|
||||||
|
}}
|
||||||
|
executor, err := runner.promptExecutor(config.PromptkitConfig{
|
||||||
|
Profile: "selected-profile",
|
||||||
|
ProfileFile: "/etc/weatherreporter/profile.yml",
|
||||||
|
Timeout: 45 * time.Second,
|
||||||
|
Local: config.PromptkitLocalConfig{
|
||||||
|
Endpoint: "http://127.0.0.1:8080",
|
||||||
|
ConcurrencyLimit: 3,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil || executor == nil || calls != 1 {
|
||||||
|
t.Fatalf("executor/error/calls = %#v/%v/%d", executor, err, calls)
|
||||||
|
}
|
||||||
|
want := PromptExecutorConfig{
|
||||||
|
Profile: "selected-profile", ProfileFile: "/etc/weatherreporter/profile.yml", Timeout: 45 * time.Second,
|
||||||
|
LocalEndpoint: "http://127.0.0.1:8080", LocalConcurrencyLimit: 3,
|
||||||
|
}
|
||||||
|
if received != want {
|
||||||
|
t.Fatalf("factory config = %#v, want %#v", received, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPromptExecutorConfigLeavesBlankLocalBackendUnregistered(t *testing.T) {
|
||||||
|
value := promptExecutorConfig(config.PromptkitConfig{
|
||||||
|
Timeout: 2 * time.Minute,
|
||||||
|
Local: config.PromptkitLocalConfig{ConcurrencyLimit: 1},
|
||||||
|
})
|
||||||
|
if value.LocalEndpoint != "" || value.LocalConcurrencyLimit != 0 {
|
||||||
|
t.Fatalf("executor config = %#v, want no local backend", value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPromptkitAdapterConfigMapsExecutorSettings(t *testing.T) {
|
||||||
|
adapterConfig := promptkitAdapterConfig(PromptExecutorConfig{
|
||||||
|
ProfileDirectory: "/etc/weatherreporter/profiles",
|
||||||
|
Timeout: 30 * time.Second, LocalEndpoint: "http://127.0.0.1:8080", LocalConcurrencyLimit: 2,
|
||||||
|
})
|
||||||
|
want := promptkitadapter.Config{
|
||||||
|
ProfileDirectory: "/etc/weatherreporter/profiles",
|
||||||
|
Timeout: 30 * time.Second, LocalEndpoint: "http://127.0.0.1:8080", LocalConcurrencyLimit: 2,
|
||||||
|
}
|
||||||
|
if adapterConfig != want {
|
||||||
|
t.Fatalf("adapter config = %#v, want %#v", adapterConfig, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type factoryExecutor struct{}
|
||||||
|
|
||||||
|
func (factoryExecutor) InspectPrompt(context.Context, string, string) (promptexec.PromptInspection, error) {
|
||||||
|
return promptexec.PromptInspection{}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (factoryExecutor) InspectProfile(context.Context, string) (promptexec.ProfileInspection, error) {
|
||||||
|
return promptexec.ProfileInspection{}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (factoryExecutor) Execute(context.Context, promptexec.ExecuteRequest, promptexec.PreparationCallback) (*promptexec.Execution, error) {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
62
internal/cli/output.go
Normal file
62
internal/cli/output.go
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/app"
|
||||||
|
)
|
||||||
|
|
||||||
|
type outputOptions struct {
|
||||||
|
Quiet bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeActionResult(stdout, stderr io.Writer, value any, opts outputOptions, writeStatus func(io.Writer)) error {
|
||||||
|
if opts.Quiet {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if writeStatus != nil && stderr != nil {
|
||||||
|
writeStatus(stderr)
|
||||||
|
}
|
||||||
|
return writeJSON(stdout, value)
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeJSON(stdout io.Writer, value any) error {
|
||||||
|
encoder := json.NewEncoder(stdout)
|
||||||
|
encoder.SetIndent("", " ")
|
||||||
|
return encoder.Encode(value)
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeBatchStatus(stderr io.Writer, result *app.BatchResult) {
|
||||||
|
if stderr == nil || result == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
for _, item := range result.Reports {
|
||||||
|
if item.Status == "failed" {
|
||||||
|
_, _ = fmt.Fprintf(stderr, "report=%s status=failed error=%q\n", item.ReportID, item.Error)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
_, _ = fmt.Fprintf(stderr, "report=%s status=succeeded output=%q\n", item.ReportID, item.OutputPath)
|
||||||
|
}
|
||||||
|
if result.Notification != nil {
|
||||||
|
_, _ = fmt.Fprintf(stderr, "batchNotification status=%q", result.Notification.Status)
|
||||||
|
if result.Notification.Reason != "" {
|
||||||
|
_, _ = fmt.Fprintf(stderr, " reason=%q", result.Notification.Reason)
|
||||||
|
}
|
||||||
|
if result.Notification.RunID != "" {
|
||||||
|
_, _ = fmt.Fprintf(stderr, " runId=%q", result.Notification.RunID)
|
||||||
|
}
|
||||||
|
if result.Notification.PipelineID != "" {
|
||||||
|
_, _ = fmt.Fprintf(stderr, " pipelineId=%q", result.Notification.PipelineID)
|
||||||
|
}
|
||||||
|
if result.Notification.BundleID != "" {
|
||||||
|
_, _ = fmt.Fprintf(stderr, " bundleId=%q", result.Notification.BundleID)
|
||||||
|
}
|
||||||
|
if result.Notification.Error != "" {
|
||||||
|
_, _ = fmt.Fprintf(stderr, " error=%q", result.Notification.Error)
|
||||||
|
}
|
||||||
|
_, _ = fmt.Fprintln(stderr)
|
||||||
|
}
|
||||||
|
_, _ = fmt.Fprintf(stderr, "batch=%s total=%d succeeded=%d failed=%d\n", result.Batch, result.Total, result.Succeeded, result.Failed)
|
||||||
|
}
|
||||||
59
internal/cli/output_test.go
Normal file
59
internal/cli/output_test.go
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"io"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestWriteActionResultWritesStatusBeforeJSON(t *testing.T) {
|
||||||
|
var output bytes.Buffer
|
||||||
|
|
||||||
|
err := writeActionResult(&output, &output, map[string]string{"status": "succeeded"}, outputOptions{}, func(w io.Writer) {
|
||||||
|
_, _ = w.Write([]byte("status line\n"))
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("writeActionResult() error = %v", err)
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(output.String(), "status line\n") {
|
||||||
|
t.Fatalf("output = %q, want status before JSON", output.String())
|
||||||
|
}
|
||||||
|
if !strings.Contains(output.String(), `"status": "succeeded"`) {
|
||||||
|
t.Fatalf("output missing JSON result:\n%s", output.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWriteActionResultQuietSuppressesOutput(t *testing.T) {
|
||||||
|
var stdout bytes.Buffer
|
||||||
|
var stderr bytes.Buffer
|
||||||
|
|
||||||
|
err := writeActionResult(&stdout, &stderr, map[string]string{"status": "succeeded"}, outputOptions{Quiet: true}, func(w io.Writer) {
|
||||||
|
_, _ = w.Write([]byte("status line\n"))
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("writeActionResult() error = %v", err)
|
||||||
|
}
|
||||||
|
if stdout.Len() != 0 || stderr.Len() != 0 {
|
||||||
|
t.Fatalf("stdout/stderr = %q/%q, want no output", stdout.String(), stderr.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWriteActionResultToleratesNilStderr(t *testing.T) {
|
||||||
|
var stdout bytes.Buffer
|
||||||
|
statusCalled := false
|
||||||
|
|
||||||
|
err := writeActionResult(&stdout, nil, map[string]string{"status": "succeeded"}, outputOptions{}, func(w io.Writer) {
|
||||||
|
statusCalled = true
|
||||||
|
_, _ = w.Write([]byte("status line\n"))
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("writeActionResult() error = %v", err)
|
||||||
|
}
|
||||||
|
if statusCalled {
|
||||||
|
t.Fatal("status writer was called with nil stderr")
|
||||||
|
}
|
||||||
|
if !strings.Contains(stdout.String(), `"status": "succeeded"`) {
|
||||||
|
t.Fatalf("stdout missing JSON result:\n%s", stdout.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
158
internal/cli/result.go
Normal file
158
internal/cli/result.go
Normal file
@@ -0,0 +1,158 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/app"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/timeutil"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/weatherdata"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
commandGenerate = "generate"
|
||||||
|
commandRun = "run"
|
||||||
|
|
||||||
|
summaryStatusSucceeded = "succeeded"
|
||||||
|
summaryStatusFailed = "failed"
|
||||||
|
)
|
||||||
|
|
||||||
|
type generateSummary struct {
|
||||||
|
Command string `json:"command"`
|
||||||
|
ReportID report.ID `json:"reportId"`
|
||||||
|
ReportName string `json:"reportName"`
|
||||||
|
PromptID string `json:"promptId"`
|
||||||
|
RunID string `json:"runId"`
|
||||||
|
Status string `json:"status"`
|
||||||
|
GeneratedAt time.Time `json:"generatedAt"`
|
||||||
|
ValidPeriod timeutil.Period `json:"validPeriod"`
|
||||||
|
OutputPath string `json:"outputPath,omitempty"`
|
||||||
|
LLMDebugPath string `json:"llmDebugPath,omitempty"`
|
||||||
|
PromptVersion string `json:"promptVersion"`
|
||||||
|
Timezone string `json:"timezone"`
|
||||||
|
ProfileID string `json:"profileId,omitempty"`
|
||||||
|
BackendID string `json:"backendId,omitempty"`
|
||||||
|
ModelName string `json:"modelName,omitempty"`
|
||||||
|
SourceWarnings []weatherdata.SourceWarning `json:"sourceWarnings,omitempty"`
|
||||||
|
ValidationStatus string `json:"validationStatus,omitempty"`
|
||||||
|
Notification *generateNotificationSummary `json:"notification,omitempty"`
|
||||||
|
Error string `json:"error,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type generateNotificationSummary struct {
|
||||||
|
Status string `json:"status,omitempty"`
|
||||||
|
UploadStatus string `json:"uploadStatus,omitempty"`
|
||||||
|
StatusError string `json:"statusError,omitempty"`
|
||||||
|
RunID string `json:"runId,omitempty"`
|
||||||
|
PipelineID string `json:"pipelineId,omitempty"`
|
||||||
|
BundleID string `json:"bundleId,omitempty"`
|
||||||
|
IdempotencyKey string `json:"idempotencyKey,omitempty"`
|
||||||
|
AcceptedAt *time.Time `json:"acceptedAt,omitempty"`
|
||||||
|
StartedAt *time.Time `json:"startedAt,omitempty"`
|
||||||
|
FinishedAt *time.Time `json:"finishedAt,omitempty"`
|
||||||
|
Error string `json:"error,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type batchSummary struct {
|
||||||
|
Command string `json:"command"`
|
||||||
|
Batch app.BatchKind `json:"batch"`
|
||||||
|
Status string `json:"status"`
|
||||||
|
StartedAt time.Time `json:"startedAt"`
|
||||||
|
FinishedAt time.Time `json:"finishedAt"`
|
||||||
|
Total int `json:"total"`
|
||||||
|
Succeeded int `json:"succeeded"`
|
||||||
|
Failed int `json:"failed"`
|
||||||
|
Notification *app.BatchNotificationResult `json:"notification,omitempty"`
|
||||||
|
Reports []app.BatchReportResult `json:"reports"`
|
||||||
|
Error string `json:"error,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func newGenerateSummary(result *app.ReportResult, err error) generateSummary {
|
||||||
|
summary := generateSummary{Command: commandGenerate}
|
||||||
|
if result == nil {
|
||||||
|
return summary
|
||||||
|
}
|
||||||
|
|
||||||
|
summary.ReportID = result.ReportID
|
||||||
|
summary.ReportName = result.ReportName
|
||||||
|
summary.PromptID = result.PromptID
|
||||||
|
summary.PromptVersion = result.PromptVersion
|
||||||
|
summary.RunID = result.RunID
|
||||||
|
summary.Status = summaryStatusSucceeded
|
||||||
|
summary.GeneratedAt = result.GeneratedAt
|
||||||
|
summary.ValidPeriod = result.ValidPeriod
|
||||||
|
summary.Timezone = result.Timezone
|
||||||
|
summary.ProfileID, summary.BackendID, summary.ModelName = result.ProfileID, result.BackendID, result.ModelName
|
||||||
|
summary.SourceWarnings = append([]weatherdata.SourceWarning(nil), result.SourceWarnings...)
|
||||||
|
summary.ValidationStatus = string(result.ValidationStatus)
|
||||||
|
summary.OutputPath = result.OutputPath
|
||||||
|
summary.LLMDebugPath = result.LLMDebugPath
|
||||||
|
summary.Notification = newGenerateNotificationSummary(result.Notification)
|
||||||
|
if err != nil {
|
||||||
|
summary.Status = summaryStatusFailed
|
||||||
|
summary.Error = err.Error()
|
||||||
|
}
|
||||||
|
return summary
|
||||||
|
}
|
||||||
|
|
||||||
|
func newGenerateNotificationSummary(result *app.NotificationResult) *generateNotificationSummary {
|
||||||
|
if result == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
summary := &generateNotificationSummary{
|
||||||
|
Status: result.Status,
|
||||||
|
UploadStatus: result.UploadStatus,
|
||||||
|
StatusError: result.StatusError,
|
||||||
|
RunID: result.RunID,
|
||||||
|
PipelineID: result.PipelineID,
|
||||||
|
BundleID: result.BundleID,
|
||||||
|
IdempotencyKey: result.IdempotencyKey,
|
||||||
|
StartedAt: result.StartedAt,
|
||||||
|
FinishedAt: result.FinishedAt,
|
||||||
|
Error: result.Error,
|
||||||
|
}
|
||||||
|
if !result.AcceptedAt.IsZero() {
|
||||||
|
acceptedAt := result.AcceptedAt
|
||||||
|
summary.AcceptedAt = &acceptedAt
|
||||||
|
}
|
||||||
|
return summary
|
||||||
|
}
|
||||||
|
|
||||||
|
func newBatchSummary(result *app.BatchResult) batchSummary {
|
||||||
|
summary := batchSummary{Command: commandRun}
|
||||||
|
if result == nil {
|
||||||
|
return summary
|
||||||
|
}
|
||||||
|
|
||||||
|
summary.Batch = result.Batch
|
||||||
|
summary.Status = batchSummaryStatus(result)
|
||||||
|
summary.StartedAt = result.StartedAt
|
||||||
|
summary.FinishedAt = result.FinishedAt
|
||||||
|
summary.Total = result.Total
|
||||||
|
summary.Succeeded = result.Succeeded
|
||||||
|
summary.Failed = result.Failed
|
||||||
|
summary.Notification = result.Notification
|
||||||
|
summary.Reports = append([]app.BatchReportResult(nil), result.Reports...)
|
||||||
|
if summary.Status == summaryStatusFailed {
|
||||||
|
summary.Error = app.BatchError{Result: result}.Error()
|
||||||
|
}
|
||||||
|
return summary
|
||||||
|
}
|
||||||
|
|
||||||
|
func batchSummaryStatus(result *app.BatchResult) string {
|
||||||
|
if result == nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
if result.Failed > 0 || (result.Notification != nil && result.Notification.Status == summaryStatusFailed) {
|
||||||
|
return summaryStatusFailed
|
||||||
|
}
|
||||||
|
return summaryStatusSucceeded
|
||||||
|
}
|
||||||
|
|
||||||
|
func reportName(id report.ID) string {
|
||||||
|
definition, err := report.DefaultRegistry().Lookup(id)
|
||||||
|
if err != nil {
|
||||||
|
return string(id)
|
||||||
|
}
|
||||||
|
return definition.Name
|
||||||
|
}
|
||||||
31
internal/cli/result_test.go
Normal file
31
internal/cli/result_test.go
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/app"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/promptexec"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/timeutil"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/weatherdata"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestGenerateSummaryUsesActiveResultFields(t *testing.T) {
|
||||||
|
generatedAt := time.Date(2026, 5, 29, 13, 30, 0, 0, time.UTC)
|
||||||
|
summary := newGenerateSummary(&app.ReportResult{ReportID: report.Daily, ReportName: "Daily Report", PromptID: "weather.daily_generated_text", PromptVersion: "2.0.0", RunID: "run-123", GeneratedAt: generatedAt, Timezone: "America/Chicago", ValidPeriod: timeutil.Period{Start: generatedAt, End: generatedAt.Add(24 * time.Hour)}, ProfileID: "weather-balanced", BackendID: "openrouter", ModelName: "model", SourceWarnings: []weatherdata.SourceWarning{{Source: "alerts", Message: "source unavailable"}}, ValidationStatus: promptexec.ValidationPassed, OutputPath: "/reports/daily.md"}, nil)
|
||||||
|
if summary.OutputPath == "" || summary.ProfileID == "" || summary.ValidationStatus != string(promptexec.ValidationPassed) || len(summary.SourceWarnings) != 1 {
|
||||||
|
t.Fatalf("summary = %#v", summary)
|
||||||
|
}
|
||||||
|
data, err := json.Marshal(summary)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Marshal() error = %v", err)
|
||||||
|
}
|
||||||
|
for _, forbidden := range []string{"reportPath", "metadataPath", "dataPackagePath", "preparationPath", "executionPath", "generatedTextRawPath", "generatedTextPath", "renderContextPath"} {
|
||||||
|
if strings.Contains(string(data), forbidden) {
|
||||||
|
t.Fatalf("summary includes %q: %s", forbidden, data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,12 +2,14 @@ package cli
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
|
||||||
"flag"
|
"flag"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/app"
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/app"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/buildinfo"
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/config"
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/config"
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
|
||||||
"gitea.maximumdirect.net/eric/weatherreporter/internal/timeutil"
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/timeutil"
|
||||||
@@ -17,33 +19,32 @@ const helpText = `weatherreporter prepares weather reports from normalized forec
|
|||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
weatherreporter --help
|
weatherreporter --help
|
||||||
weatherreporter generate daily --date YYYY-MM-DD [--config PATH] [--units VALUE] [--tz NAME] [--out PATH]
|
weatherreporter --version
|
||||||
weatherreporter generate today [--config PATH] [--units VALUE] [--tz NAME] [--out PATH] [--date YYYY-MM-DD]
|
weatherreporter generate daily --date YYYY-MM-DD [--config PATH] [--units VALUE] [--tz NAME] [--out PATH] [--llm-debug-dir PATH] [--quiet]
|
||||||
weatherreporter generate tomorrow [--config PATH] [--units VALUE] [--tz NAME] [--out PATH]
|
weatherreporter generate today [--config PATH] [--units VALUE] [--tz NAME] [--out PATH] [--date YYYY-MM-DD] [--llm-debug-dir PATH] [--quiet]
|
||||||
weatherreporter generate hourly [--config PATH] [--units VALUE] [--tz NAME] [--out PATH]
|
weatherreporter generate tomorrow [--config PATH] [--units VALUE] [--tz NAME] [--out PATH] [--llm-debug-dir PATH] [--quiet]
|
||||||
weatherreporter generate three-day [--config PATH] [--units VALUE] [--tz NAME] [--out PATH]
|
weatherreporter generate hourly [--config PATH] [--units VALUE] [--tz NAME] [--out PATH] [--llm-debug-dir PATH] [--quiet]
|
||||||
weatherreporter generate weekend [--config PATH] [--units VALUE] [--tz NAME] [--out PATH]
|
weatherreporter run morning [--config PATH] [--units VALUE] [--tz NAME] [--out-dir PATH] [--llm-debug-dir PATH] [--quiet]
|
||||||
weatherreporter generate storm [--config PATH] [--units VALUE] [--tz NAME] [--out PATH] --start TIME --end TIME
|
weatherreporter run evening [--config PATH] [--units VALUE] [--tz NAME] [--out-dir PATH] [--llm-debug-dir PATH] [--quiet]
|
||||||
weatherreporter run morning [--config PATH] [--units VALUE] [--tz NAME] [--out-dir PATH]
|
|
||||||
weatherreporter run evening [--config PATH] [--units VALUE] [--tz NAME] [--out-dir PATH]
|
|
||||||
weatherreporter inspect reports [--config PATH] [--limit N]
|
|
||||||
weatherreporter inspect metadata [--config PATH] RUN_ID
|
|
||||||
weatherreporter inspect modules [--config PATH] RUN_ID
|
|
||||||
weatherreporter inspect data-package [--config PATH] RUN_ID
|
|
||||||
weatherreporter inspect prior [--config PATH] RUN_ID
|
|
||||||
weatherreporter inspect sources [--config PATH] RUN_ID
|
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-h, --help Show this help message.
|
-h, --help Show this help message.
|
||||||
|
--version Show the Weatherreporter version.
|
||||||
--config PATH Load configuration from PATH instead of /usr/local/etc/weatherreporter/config.yml.
|
--config PATH Load configuration from PATH instead of /usr/local/etc/weatherreporter/config.yml.
|
||||||
--units VALUE Override weather API units.
|
--units VALUE Override weather API units.
|
||||||
--tz NAME Override weather API timezone.
|
--tz NAME Override weather API timezone.
|
||||||
--out PATH Write an extra Markdown report copy where supported by the generate command.
|
--out PATH Write the generated Markdown report to PATH.
|
||||||
--out-dir PATH Write extra Markdown report copies for run commands.
|
--llm-debug-dir PATH Write sensitive prompt debug artifacts under PATH.
|
||||||
|
--out-dir PATH Write generated Markdown reports beneath PATH for run commands.
|
||||||
|
--quiet Suppress successful generate and run output.
|
||||||
`
|
`
|
||||||
|
|
||||||
type Runner struct {
|
type Runner struct {
|
||||||
Clock timeutil.Clock
|
Clock timeutil.Clock
|
||||||
|
ExecutorFactory ExecutorFactory
|
||||||
|
Version string
|
||||||
|
WorkingDir string
|
||||||
|
runBatchDetailed func(context.Context, app.BatchRequest) (*app.BatchResult, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
func Run(ctx context.Context, args []string, stdout io.Writer, stderr io.Writer) error {
|
func Run(ctx context.Context, args []string, stdout io.Writer, stderr io.Writer) error {
|
||||||
@@ -51,7 +52,6 @@ func Run(ctx context.Context, args []string, stdout io.Writer, stderr io.Writer)
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (r Runner) Run(ctx context.Context, args []string, stdout io.Writer, stderr io.Writer) error {
|
func (r Runner) Run(ctx context.Context, args []string, stdout io.Writer, stderr io.Writer) error {
|
||||||
_ = stderr
|
|
||||||
if r.Clock == nil {
|
if r.Clock == nil {
|
||||||
r.Clock = timeutil.SystemClock{}
|
r.Clock = timeutil.SystemClock{}
|
||||||
}
|
}
|
||||||
@@ -59,32 +59,54 @@ func (r Runner) Run(ctx context.Context, args []string, stdout io.Writer, stderr
|
|||||||
_, err := fmt.Fprint(stdout, helpText)
|
_, err := fmt.Fprint(stdout, helpText)
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
if args[0] == "--version" {
|
||||||
|
if len(args) != 1 {
|
||||||
|
return fmt.Errorf("--version does not accept arguments")
|
||||||
|
}
|
||||||
|
version := r.Version
|
||||||
|
if version == "" {
|
||||||
|
version = buildinfo.Version
|
||||||
|
}
|
||||||
|
_, err := fmt.Fprintf(stdout, "weatherreporter %s\n", version)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
switch args[0] {
|
switch args[0] {
|
||||||
case "generate":
|
case "generate":
|
||||||
req, err := r.resolveGenerate(args[1:])
|
req, opts, err := r.resolveGenerateAction(args[1:])
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return app.Generate(ctx, req)
|
result, err := app.GenerateDetailed(ctx, req)
|
||||||
case "run":
|
|
||||||
req, err := r.resolveRun(args[1:])
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
result, err := app.RunBatchDetailed(ctx, req)
|
|
||||||
if result != nil {
|
if result != nil {
|
||||||
writeRunLogs(stderr, result)
|
summary := newGenerateSummary(result, err)
|
||||||
if encodeErr := writeJSON(stdout, result); encodeErr != nil {
|
if encodeErr := writeActionResult(stdout, stderr, summary, outputOptions{Quiet: opts.Quiet}, nil); encodeErr != nil {
|
||||||
return encodeErr
|
return encodeErr
|
||||||
}
|
}
|
||||||
if result.Failed > 0 {
|
}
|
||||||
|
return err
|
||||||
|
case "run":
|
||||||
|
req, opts, err := r.resolveRunAction(args[1:])
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
runBatchDetailed := r.runBatchDetailed
|
||||||
|
if runBatchDetailed == nil {
|
||||||
|
runBatchDetailed = app.RunBatchDetailed
|
||||||
|
}
|
||||||
|
result, err := runBatchDetailed(ctx, req)
|
||||||
|
if result != nil {
|
||||||
|
summary := newBatchSummary(result)
|
||||||
|
if encodeErr := writeActionResult(stdout, stderr, summary, outputOptions{Quiet: opts.Quiet}, func(w io.Writer) {
|
||||||
|
writeBatchStatus(w, result)
|
||||||
|
}); encodeErr != nil {
|
||||||
|
return encodeErr
|
||||||
|
}
|
||||||
|
if summary.Status == summaryStatusFailed {
|
||||||
return app.BatchError{Result: result}
|
return app.BatchError{Result: result}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return err
|
return err
|
||||||
case "inspect":
|
|
||||||
return r.runInspect(ctx, args[1:], stdout)
|
|
||||||
default:
|
default:
|
||||||
return fmt.Errorf("unknown command %q", args[0])
|
return fmt.Errorf("unknown command %q", args[0])
|
||||||
}
|
}
|
||||||
@@ -96,105 +118,35 @@ type commonOptions struct {
|
|||||||
Timezone string
|
Timezone string
|
||||||
Output string
|
Output string
|
||||||
OutputDir string
|
OutputDir string
|
||||||
|
LLMDebugDir string
|
||||||
|
Quiet bool
|
||||||
}
|
}
|
||||||
|
|
||||||
type generateOptions struct {
|
type generateOptions struct {
|
||||||
commonOptions
|
commonOptions
|
||||||
Date string
|
Date string
|
||||||
Start string
|
|
||||||
End string
|
|
||||||
}
|
|
||||||
|
|
||||||
type inspectOptions struct {
|
|
||||||
ConfigPath string
|
|
||||||
Limit int
|
|
||||||
RunID string
|
|
||||||
}
|
|
||||||
|
|
||||||
type inspectRunCommand struct {
|
|
||||||
Name string
|
|
||||||
Inspect func(context.Context, app.InspectRunRequest) (any, error)
|
|
||||||
}
|
|
||||||
|
|
||||||
var inspectRunCommands = []inspectRunCommand{
|
|
||||||
{Name: "metadata", Inspect: func(ctx context.Context, req app.InspectRunRequest) (any, error) {
|
|
||||||
return app.InspectMetadata(ctx, req)
|
|
||||||
}},
|
|
||||||
{Name: "modules", Inspect: func(ctx context.Context, req app.InspectRunRequest) (any, error) {
|
|
||||||
return app.InspectModules(ctx, req)
|
|
||||||
}},
|
|
||||||
{Name: "data-package", Inspect: func(ctx context.Context, req app.InspectRunRequest) (any, error) {
|
|
||||||
return app.InspectDataPackage(ctx, req)
|
|
||||||
}},
|
|
||||||
{Name: "prior", Inspect: func(ctx context.Context, req app.InspectRunRequest) (any, error) {
|
|
||||||
return app.InspectPriorSnapshot(ctx, req)
|
|
||||||
}},
|
|
||||||
{Name: "sources", Inspect: func(ctx context.Context, req app.InspectRunRequest) (any, error) {
|
|
||||||
return app.InspectSources(ctx, req)
|
|
||||||
}},
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r Runner) runInspect(ctx context.Context, args []string, stdout io.Writer) error {
|
|
||||||
if len(args) == 0 {
|
|
||||||
return fmt.Errorf("inspect requires a command")
|
|
||||||
}
|
|
||||||
command := args[0]
|
|
||||||
switch command {
|
|
||||||
case "reports":
|
|
||||||
opts, err := parseInspectReportsFlags(args[1:])
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
cfg, err := config.Load(config.LoadOptions{Path: opts.ConfigPath})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
records, err := app.InspectReports(ctx, app.InspectReportsRequest{Config: cfg, Limit: opts.Limit})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return writeJSON(stdout, records)
|
|
||||||
default:
|
|
||||||
for _, candidate := range inspectRunCommands {
|
|
||||||
if candidate.Name == command {
|
|
||||||
return runInspectRunCommand(ctx, stdout, candidate, args[1:])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return fmt.Errorf("unknown inspect command %q", command)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func runInspectRunCommand(ctx context.Context, stdout io.Writer, command inspectRunCommand, args []string) error {
|
|
||||||
opts, err := parseInspectRunFlags(command.Name, args)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
cfg, err := config.Load(config.LoadOptions{Path: opts.ConfigPath})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
value, err := command.Inspect(ctx, app.InspectRunRequest{Config: cfg, RunID: opts.RunID})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return writeJSON(stdout, value)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (r Runner) resolveGenerate(args []string) (app.GenerateRequest, error) {
|
func (r Runner) resolveGenerate(args []string) (app.GenerateRequest, error) {
|
||||||
|
req, _, err := r.resolveGenerateAction(args)
|
||||||
|
return req, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r Runner) resolveGenerateAction(args []string) (app.GenerateRequest, commonOptions, error) {
|
||||||
if r.Clock == nil {
|
if r.Clock == nil {
|
||||||
r.Clock = timeutil.SystemClock{}
|
r.Clock = timeutil.SystemClock{}
|
||||||
}
|
}
|
||||||
if len(args) == 0 {
|
if len(args) == 0 {
|
||||||
return app.GenerateRequest{}, fmt.Errorf("generate requires a report name")
|
return app.GenerateRequest{}, commonOptions{}, fmt.Errorf("generate requires a report name")
|
||||||
}
|
}
|
||||||
if _, err := report.IDForCommandName(args[0]); err != nil {
|
if _, err := report.IDForCommandName(args[0]); err != nil {
|
||||||
return app.GenerateRequest{}, fmt.Errorf("unknown generate report %q", args[0])
|
return app.GenerateRequest{}, commonOptions{}, fmt.Errorf("unknown generate report %q", args[0])
|
||||||
}
|
}
|
||||||
reportKind := app.ReportKind(args[0])
|
reportKind := app.ReportKind(args[0])
|
||||||
|
|
||||||
opts, err := parseGenerateFlags(reportKind, args[1:])
|
opts, err := parseGenerateFlags(reportKind, args[1:])
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return app.GenerateRequest{}, err
|
return app.GenerateRequest{}, commonOptions{}, err
|
||||||
}
|
}
|
||||||
cfg, err := config.Load(config.LoadOptions{
|
cfg, err := config.Load(config.LoadOptions{
|
||||||
Path: opts.ConfigPath,
|
Path: opts.ConfigPath,
|
||||||
@@ -202,28 +154,44 @@ func (r Runner) resolveGenerate(args []string) (app.GenerateRequest, error) {
|
|||||||
Timezone: opts.Timezone,
|
Timezone: opts.Timezone,
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return app.GenerateRequest{}, err
|
return app.GenerateRequest{}, commonOptions{}, err
|
||||||
|
}
|
||||||
|
executor, err := r.promptExecutor(cfg.Promptkit)
|
||||||
|
if err != nil {
|
||||||
|
return app.GenerateRequest{}, commonOptions{}, err
|
||||||
}
|
}
|
||||||
location, err := timeutil.LoadLocation(cfg.WeatherAPI.Timezone)
|
location, err := timeutil.LoadLocation(cfg.WeatherAPI.Timezone)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return app.GenerateRequest{}, err
|
return app.GenerateRequest{}, commonOptions{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
workingDir, err := r.workingDir()
|
||||||
|
if err != nil {
|
||||||
|
return app.GenerateRequest{}, commonOptions{}, err
|
||||||
|
}
|
||||||
|
outputPath, err := resolveOutputOverride(workingDir, opts.Output)
|
||||||
|
if err != nil {
|
||||||
|
return app.GenerateRequest{}, commonOptions{}, err
|
||||||
}
|
}
|
||||||
|
|
||||||
req := app.GenerateRequest{
|
req := app.GenerateRequest{
|
||||||
Config: cfg,
|
Config: cfg,
|
||||||
Report: reportKind,
|
Report: reportKind,
|
||||||
OutputPath: opts.Output,
|
WorkingDir: workingDir,
|
||||||
|
OutputPath: outputPath,
|
||||||
|
LLMDebugDir: opts.LLMDebugDir,
|
||||||
Now: r.Clock.Now(),
|
Now: r.Clock.Now(),
|
||||||
|
Executor: executor,
|
||||||
}
|
}
|
||||||
|
|
||||||
switch reportKind {
|
switch reportKind {
|
||||||
case app.ReportDaily:
|
case app.ReportDaily:
|
||||||
if opts.Date == "" {
|
if opts.Date == "" {
|
||||||
return app.GenerateRequest{}, fmt.Errorf("generate daily requires --date YYYY-MM-DD")
|
return app.GenerateRequest{}, commonOptions{}, fmt.Errorf("generate daily requires --date YYYY-MM-DD")
|
||||||
}
|
}
|
||||||
req.Date, err = timeutil.ParseLocalDate(opts.Date, location)
|
req.Date, err = timeutil.ParseLocalDate(opts.Date, location)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return app.GenerateRequest{}, err
|
return app.GenerateRequest{}, commonOptions{}, err
|
||||||
}
|
}
|
||||||
case app.ReportToday:
|
case app.ReportToday:
|
||||||
if opts.Date == "" {
|
if opts.Date == "" {
|
||||||
@@ -231,41 +199,33 @@ func (r Runner) resolveGenerate(args []string) (app.GenerateRequest, error) {
|
|||||||
} else {
|
} else {
|
||||||
req.Date, err = timeutil.ParseLocalDate(opts.Date, location)
|
req.Date, err = timeutil.ParseLocalDate(opts.Date, location)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return app.GenerateRequest{}, err
|
return app.GenerateRequest{}, commonOptions{}, err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
case app.ReportStorm:
|
|
||||||
if opts.Start == "" {
|
|
||||||
return app.GenerateRequest{}, fmt.Errorf("generate storm requires --start")
|
|
||||||
}
|
|
||||||
if opts.End == "" {
|
|
||||||
return app.GenerateRequest{}, fmt.Errorf("generate storm requires --end")
|
|
||||||
}
|
|
||||||
period, err := report.ParseStormPeriod(opts.Start, opts.End, location)
|
|
||||||
if err != nil {
|
|
||||||
return app.GenerateRequest{}, err
|
|
||||||
}
|
|
||||||
req.StormStart = period.Start
|
|
||||||
req.StormEnd = period.End
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return req, nil
|
return req, opts.commonOptions, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (r Runner) resolveRun(args []string) (app.BatchRequest, error) {
|
func (r Runner) resolveRun(args []string) (app.BatchRequest, error) {
|
||||||
|
req, _, err := r.resolveRunAction(args)
|
||||||
|
return req, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r Runner) resolveRunAction(args []string) (app.BatchRequest, commonOptions, error) {
|
||||||
if r.Clock == nil {
|
if r.Clock == nil {
|
||||||
r.Clock = timeutil.SystemClock{}
|
r.Clock = timeutil.SystemClock{}
|
||||||
}
|
}
|
||||||
if len(args) == 0 {
|
if len(args) == 0 {
|
||||||
return app.BatchRequest{}, fmt.Errorf("run requires a batch name")
|
return app.BatchRequest{}, commonOptions{}, fmt.Errorf("run requires a batch name")
|
||||||
}
|
}
|
||||||
if _, err := report.BatchForCommandName(args[0]); err != nil {
|
if _, err := report.BatchForCommandName(args[0]); err != nil {
|
||||||
return app.BatchRequest{}, fmt.Errorf("unknown run batch %q", args[0])
|
return app.BatchRequest{}, commonOptions{}, fmt.Errorf("unknown run batch %q", args[0])
|
||||||
}
|
}
|
||||||
batch := app.BatchKind(args[0])
|
batch := app.BatchKind(args[0])
|
||||||
opts, err := parseRunFlags(args[1:])
|
opts, err := parseRunFlags(args[1:])
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return app.BatchRequest{}, err
|
return app.BatchRequest{}, commonOptions{}, err
|
||||||
}
|
}
|
||||||
cfg, err := config.Load(config.LoadOptions{
|
cfg, err := config.Load(config.LoadOptions{
|
||||||
Path: opts.ConfigPath,
|
Path: opts.ConfigPath,
|
||||||
@@ -273,9 +233,21 @@ func (r Runner) resolveRun(args []string) (app.BatchRequest, error) {
|
|||||||
Timezone: opts.Timezone,
|
Timezone: opts.Timezone,
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return app.BatchRequest{}, err
|
return app.BatchRequest{}, commonOptions{}, err
|
||||||
}
|
}
|
||||||
return app.BatchRequest{Config: cfg, Batch: batch, Now: r.Clock.Now(), OutputDir: opts.OutputDir}, nil
|
executor, err := r.promptExecutor(cfg.Promptkit)
|
||||||
|
if err != nil {
|
||||||
|
return app.BatchRequest{}, commonOptions{}, err
|
||||||
|
}
|
||||||
|
workingDir, err := r.workingDir()
|
||||||
|
if err != nil {
|
||||||
|
return app.BatchRequest{}, commonOptions{}, err
|
||||||
|
}
|
||||||
|
outputDir, err := resolveOutputOverride(workingDir, opts.OutputDir)
|
||||||
|
if err != nil {
|
||||||
|
return app.BatchRequest{}, commonOptions{}, err
|
||||||
|
}
|
||||||
|
return app.BatchRequest{Config: cfg, Batch: batch, Now: r.Clock.Now(), WorkingDir: workingDir, OutputDir: outputDir, LLMDebugDir: opts.LLMDebugDir, Executor: executor}, opts, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func resolveRun(args []string) (app.BatchRequest, error) {
|
func resolveRun(args []string) (app.BatchRequest, error) {
|
||||||
@@ -287,13 +259,10 @@ func parseGenerateFlags(report app.ReportKind, args []string) (generateOptions,
|
|||||||
fs.SetOutput(io.Discard)
|
fs.SetOutput(io.Discard)
|
||||||
opts := generateOptions{}
|
opts := generateOptions{}
|
||||||
addCommonFlags(fs, &opts.commonOptions, true)
|
addCommonFlags(fs, &opts.commonOptions, true)
|
||||||
|
fs.BoolVar(&opts.Quiet, "quiet", false, "suppress successful action output")
|
||||||
if report == app.ReportDaily || report == app.ReportToday {
|
if report == app.ReportDaily || report == app.ReportToday {
|
||||||
fs.StringVar(&opts.Date, "date", "", "report date in YYYY-MM-DD")
|
fs.StringVar(&opts.Date, "date", "", "report date in YYYY-MM-DD")
|
||||||
}
|
}
|
||||||
if report == app.ReportStorm {
|
|
||||||
fs.StringVar(&opts.Start, "start", "", "storm start time")
|
|
||||||
fs.StringVar(&opts.End, "end", "", "storm end time")
|
|
||||||
}
|
|
||||||
if err := fs.Parse(args); err != nil {
|
if err := fs.Parse(args); err != nil {
|
||||||
return generateOptions{}, err
|
return generateOptions{}, err
|
||||||
}
|
}
|
||||||
@@ -308,7 +277,8 @@ func parseRunFlags(args []string) (commonOptions, error) {
|
|||||||
fs.SetOutput(io.Discard)
|
fs.SetOutput(io.Discard)
|
||||||
opts := commonOptions{}
|
opts := commonOptions{}
|
||||||
addCommonFlags(fs, &opts, false)
|
addCommonFlags(fs, &opts, false)
|
||||||
fs.StringVar(&opts.OutputDir, "out-dir", "", "extra Markdown report copy directory")
|
fs.StringVar(&opts.OutputDir, "out-dir", "", "generated Markdown report directory")
|
||||||
|
fs.BoolVar(&opts.Quiet, "quiet", false, "suppress successful action output")
|
||||||
if err := fs.Parse(args); err != nil {
|
if err := fs.Parse(args); err != nil {
|
||||||
return commonOptions{}, err
|
return commonOptions{}, err
|
||||||
}
|
}
|
||||||
@@ -318,74 +288,37 @@ func parseRunFlags(args []string) (commonOptions, error) {
|
|||||||
return opts, nil
|
return opts, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func parseInspectReportsFlags(args []string) (inspectOptions, error) {
|
|
||||||
fs := flag.NewFlagSet("inspect reports", flag.ContinueOnError)
|
|
||||||
fs.SetOutput(io.Discard)
|
|
||||||
opts := inspectOptions{Limit: 20}
|
|
||||||
fs.StringVar(&opts.ConfigPath, "config", "", "configuration file path")
|
|
||||||
fs.IntVar(&opts.Limit, "limit", 20, "maximum reports to list")
|
|
||||||
if err := fs.Parse(args); err != nil {
|
|
||||||
return inspectOptions{}, err
|
|
||||||
}
|
|
||||||
if fs.NArg() > 0 {
|
|
||||||
return inspectOptions{}, fmt.Errorf("unexpected argument %q", fs.Arg(0))
|
|
||||||
}
|
|
||||||
if opts.Limit < 0 {
|
|
||||||
return inspectOptions{}, fmt.Errorf("limit must be zero or greater")
|
|
||||||
}
|
|
||||||
return opts, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseInspectRunFlags(command string, args []string) (inspectOptions, error) {
|
|
||||||
fs := flag.NewFlagSet("inspect "+command, flag.ContinueOnError)
|
|
||||||
fs.SetOutput(io.Discard)
|
|
||||||
opts := inspectOptions{}
|
|
||||||
fs.StringVar(&opts.ConfigPath, "config", "", "configuration file path")
|
|
||||||
if err := fs.Parse(args); err != nil {
|
|
||||||
return inspectOptions{}, err
|
|
||||||
}
|
|
||||||
if fs.NArg() != 1 {
|
|
||||||
return inspectOptions{}, fmt.Errorf("inspect %s requires a run id", command)
|
|
||||||
}
|
|
||||||
opts.RunID = fs.Arg(0)
|
|
||||||
return opts, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeJSON(stdout io.Writer, value any) error {
|
|
||||||
encoder := json.NewEncoder(stdout)
|
|
||||||
encoder.SetIndent("", " ")
|
|
||||||
return encoder.Encode(value)
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeRunLogs(stderr io.Writer, result *app.BatchResult) {
|
|
||||||
if stderr == nil || result == nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
for _, item := range result.Reports {
|
|
||||||
notificationFields := ""
|
|
||||||
if item.NotificationStatus != "" {
|
|
||||||
notificationFields += fmt.Sprintf(" notificationStatus=%q", item.NotificationStatus)
|
|
||||||
}
|
|
||||||
if item.NotificationRunID != "" {
|
|
||||||
notificationFields += fmt.Sprintf(" notificationRunId=%q", item.NotificationRunID)
|
|
||||||
}
|
|
||||||
if item.NotificationError != "" {
|
|
||||||
notificationFields += fmt.Sprintf(" notificationError=%q", item.NotificationError)
|
|
||||||
}
|
|
||||||
if item.Status == "failed" {
|
|
||||||
_, _ = fmt.Fprintf(stderr, "report=%s status=failed error=%q%s\n", item.ReportID, item.Error, notificationFields)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
_, _ = fmt.Fprintf(stderr, "report=%s status=succeeded output=%q%s\n", item.ReportID, item.OutputPath, notificationFields)
|
|
||||||
}
|
|
||||||
_, _ = fmt.Fprintf(stderr, "batch=%s total=%d succeeded=%d failed=%d\n", result.Batch, result.Total, result.Succeeded, result.Failed)
|
|
||||||
}
|
|
||||||
|
|
||||||
func addCommonFlags(fs *flag.FlagSet, opts *commonOptions, includeOutput bool) {
|
func addCommonFlags(fs *flag.FlagSet, opts *commonOptions, includeOutput bool) {
|
||||||
fs.StringVar(&opts.ConfigPath, "config", "", "configuration file path")
|
fs.StringVar(&opts.ConfigPath, "config", "", "configuration file path")
|
||||||
fs.StringVar(&opts.Units, "units", "", "weather API units")
|
fs.StringVar(&opts.Units, "units", "", "weather API units")
|
||||||
fs.StringVar(&opts.Timezone, "tz", "", "weather API timezone")
|
fs.StringVar(&opts.Timezone, "tz", "", "weather API timezone")
|
||||||
|
fs.StringVar(&opts.LLMDebugDir, "llm-debug-dir", "", "write sensitive prompt debug artifacts under PATH")
|
||||||
if includeOutput {
|
if includeOutput {
|
||||||
fs.StringVar(&opts.Output, "out", "", "extra Markdown report copy path")
|
fs.StringVar(&opts.Output, "out", "", "generated Markdown report path")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (r Runner) workingDir() (string, error) {
|
||||||
|
workingDir := r.WorkingDir
|
||||||
|
if workingDir == "" {
|
||||||
|
var err error
|
||||||
|
workingDir, err = os.Getwd()
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("get working directory: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !filepath.IsAbs(workingDir) {
|
||||||
|
return "", fmt.Errorf("working directory %q must be absolute", workingDir)
|
||||||
|
}
|
||||||
|
return filepath.Clean(workingDir), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func resolveOutputOverride(workingDir, value string) (string, error) {
|
||||||
|
if value == "" {
|
||||||
|
return "", nil
|
||||||
|
}
|
||||||
|
if !filepath.IsAbs(value) {
|
||||||
|
value = filepath.Join(workingDir, value)
|
||||||
|
}
|
||||||
|
return filepath.Clean(value), nil
|
||||||
|
}
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
143
internal/cli/run_test.go
Normal file
143
internal/cli/run_test.go
Normal file
@@ -0,0 +1,143 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/app"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/promptexec"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/timeutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestParseRunFlagsAcceptsPromptDebugDirectory(t *testing.T) {
|
||||||
|
opts, err := parseRunFlags([]string{"--llm-debug-dir", "/tmp/prompt-debug"})
|
||||||
|
if err != nil || opts.LLMDebugDir != "/tmp/prompt-debug" {
|
||||||
|
t.Fatalf("parseRunFlags() = %#v, %v", opts, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestResolveRunActionConstructsOneExecutor(t *testing.T) {
|
||||||
|
for _, command := range []string{"morning", "evening"} {
|
||||||
|
t.Run(command, func(t *testing.T) {
|
||||||
|
configPath := filepath.Join(t.TempDir(), "config.yml")
|
||||||
|
if err := os.WriteFile(configPath, []byte("weather_api:\n base_url: https://weather.api.example.com/\n"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
calls := 0
|
||||||
|
executor := &factoryExecutor{}
|
||||||
|
runner := Runner{
|
||||||
|
Clock: timeutil.FixedClock{Time: time.Date(2026, 5, 29, 8, 0, 0, 0, time.UTC)},
|
||||||
|
ExecutorFactory: func(PromptExecutorConfig) (promptexec.Executor, error) {
|
||||||
|
calls++
|
||||||
|
return executor, nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
req, _, err := runner.resolveRunAction([]string{command, "--config", configPath, "--llm-debug-dir", "/tmp/debug"})
|
||||||
|
if err != nil || calls != 1 || req.Executor != executor || req.LLMDebugDir != "/tmp/debug" {
|
||||||
|
t.Fatalf("resolveRunAction() request/error/calls = %#v/%v/%d", req, err, calls)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestResolveGenerateActionUsesInjectedWorkingDirectoryForOutputOverrides(t *testing.T) {
|
||||||
|
workingDir := t.TempDir()
|
||||||
|
configPath := filepath.Join(t.TempDir(), "config.yml")
|
||||||
|
if err := os.WriteFile(configPath, []byte("weather_api:\n base_url: https://weather.api.example.com/\n"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
absoluteOutput := filepath.Join(t.TempDir(), "daily.md")
|
||||||
|
for _, scenario := range []struct {
|
||||||
|
name string
|
||||||
|
out string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{name: "default", want: ""},
|
||||||
|
{name: "relative", out: "reports/daily.md", want: filepath.Join(workingDir, "reports", "daily.md")},
|
||||||
|
{name: "absolute", out: absoluteOutput, want: absoluteOutput},
|
||||||
|
} {
|
||||||
|
t.Run(scenario.name, func(t *testing.T) {
|
||||||
|
runner := Runner{
|
||||||
|
Clock: timeutil.FixedClock{Time: time.Date(2026, 5, 29, 8, 0, 0, 0, time.UTC)},
|
||||||
|
WorkingDir: workingDir,
|
||||||
|
ExecutorFactory: func(PromptExecutorConfig) (promptexec.Executor, error) {
|
||||||
|
return &factoryExecutor{}, nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
args := []string{"daily", "--date", "2026-05-29", "--config", configPath}
|
||||||
|
if scenario.out != "" {
|
||||||
|
args = append(args, "--out", scenario.out)
|
||||||
|
}
|
||||||
|
req, _, err := runner.resolveGenerateAction(args)
|
||||||
|
if err != nil || req.WorkingDir != workingDir || req.OutputPath != scenario.want {
|
||||||
|
t.Fatalf("resolveGenerateAction() request/error = %#v/%v", req, err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunActionReturnsFailureForBatchNotificationFailure(t *testing.T) {
|
||||||
|
configPath := filepath.Join(t.TempDir(), "config.yml")
|
||||||
|
if err := os.WriteFile(configPath, []byte("weather_api:\n base_url: https://weather.api.example.com/\n"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
result := &app.BatchResult{
|
||||||
|
Batch: app.BatchMorning, Total: 2, Succeeded: 2,
|
||||||
|
Reports: []app.BatchReportResult{
|
||||||
|
{ReportID: "today", Status: "succeeded", OutputPath: "/reports/today.md"},
|
||||||
|
{ReportID: "tomorrow", Status: "succeeded", OutputPath: "/reports/tomorrow.md"},
|
||||||
|
},
|
||||||
|
Notification: &app.BatchNotificationResult{Status: "failed", Error: "distributor unavailable"},
|
||||||
|
}
|
||||||
|
var stdout, stderr bytes.Buffer
|
||||||
|
runner := Runner{
|
||||||
|
Clock: timeutil.FixedClock{Time: time.Date(2026, 5, 29, 8, 0, 0, 0, time.UTC)},
|
||||||
|
ExecutorFactory: func(PromptExecutorConfig) (promptexec.Executor, error) {
|
||||||
|
return &factoryExecutor{}, nil
|
||||||
|
},
|
||||||
|
runBatchDetailed: func(context.Context, app.BatchRequest) (*app.BatchResult, error) {
|
||||||
|
return result, nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
err := runner.Run(context.Background(), []string{"run", "morning", "--config", configPath}, &stdout, &stderr)
|
||||||
|
var batchErr app.BatchError
|
||||||
|
if !errors.As(err, &batchErr) || !strings.Contains(err.Error(), "notification failed") {
|
||||||
|
t.Fatalf("Run() error = %v", err)
|
||||||
|
}
|
||||||
|
var summary batchSummary
|
||||||
|
if err := json.Unmarshal(stdout.Bytes(), &summary); err != nil {
|
||||||
|
t.Fatalf("decode summary: %v", err)
|
||||||
|
}
|
||||||
|
if summary.Status != summaryStatusFailed || summary.Total != 2 || summary.Succeeded != 2 || summary.Failed != 0 || summary.Notification == nil || summary.Notification.Status != "failed" {
|
||||||
|
t.Fatalf("summary = %#v", summary)
|
||||||
|
}
|
||||||
|
if !strings.Contains(stderr.String(), `batchNotification status="failed"`) {
|
||||||
|
t.Fatalf("stdout/stderr = %q/%q", stdout.String(), stderr.String())
|
||||||
|
}
|
||||||
|
for _, field := range []string{"notificationStatus", "notificationRunId", "notificationPipelineId", "notificationError"} {
|
||||||
|
if strings.Contains(stdout.String(), field) || strings.Contains(stderr.String(), field) {
|
||||||
|
t.Fatalf("stdout/stderr includes removed field %q: %q/%q", field, stdout.String(), stderr.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInspectCommandIsUnknownAndAbsentFromHelp(t *testing.T) {
|
||||||
|
var stdout, stderr bytes.Buffer
|
||||||
|
err := (Runner{}).Run(context.Background(), []string{"inspect", "reports"}, &stdout, &stderr)
|
||||||
|
if err == nil || err.Error() != `unknown command "inspect"` {
|
||||||
|
t.Fatalf("Run(inspect) error = %v", err)
|
||||||
|
}
|
||||||
|
if err := (Runner{}).Run(context.Background(), []string{"--help"}, &stdout, &stderr); err != nil {
|
||||||
|
t.Fatalf("Run(--help) error = %v", err)
|
||||||
|
}
|
||||||
|
if strings.Contains(stdout.String(), "inspect") {
|
||||||
|
t.Fatalf("help contains removed inspect command:\n%s", stdout.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
31
internal/collect/collect.go
Normal file
31
internal/collect/collect.go
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
// Package collect owns upstream weather source collection for application use.
|
||||||
|
package collect
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/adapters/weatherapi"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/config"
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/weatherdata"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Request struct {
|
||||||
|
Config config.Config
|
||||||
|
}
|
||||||
|
|
||||||
|
type Result struct {
|
||||||
|
Bundle *weatherdata.Bundle
|
||||||
|
}
|
||||||
|
|
||||||
|
func Run(ctx context.Context, req Request) (*Result, error) {
|
||||||
|
client, err := weatherapi.New(req.Config)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("prepare weather collection: %w", err)
|
||||||
|
}
|
||||||
|
bundle, err := client.FetchBundle(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("collect weather bundle: %w", err)
|
||||||
|
}
|
||||||
|
return &Result{Bundle: bundle}, nil
|
||||||
|
}
|
||||||
99
internal/collect/collect_test.go
Normal file
99
internal/collect/collect_test.go
Normal file
@@ -0,0 +1,99 @@
|
|||||||
|
package collect
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/weatherreporter/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestRunFetchesBundle(t *testing.T) {
|
||||||
|
server := collectionTestServer(t, nil)
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
cfg := config.Defaults()
|
||||||
|
cfg.WeatherAPI.BaseURL = server.URL + "/"
|
||||||
|
|
||||||
|
result, err := Run(context.Background(), Request{Config: cfg})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Run() error = %v", err)
|
||||||
|
}
|
||||||
|
if result == nil || result.Bundle == nil {
|
||||||
|
t.Fatal("Run() result bundle = nil, want fetched bundle")
|
||||||
|
}
|
||||||
|
if result.Bundle.Hourly == nil {
|
||||||
|
t.Fatal("Hourly = nil, want fetched hourly forecast")
|
||||||
|
}
|
||||||
|
if result.Bundle.WeatherStory == nil || result.Bundle.WeatherStory.Title != "Several Chances for Rain Through Monday" {
|
||||||
|
t.Fatalf("WeatherStory = %#v, want fetched weather story", result.Bundle.WeatherStory)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunWrapsAdapterConstructionError(t *testing.T) {
|
||||||
|
cfg := config.Defaults()
|
||||||
|
cfg.WeatherAPI.BaseURL = ""
|
||||||
|
cfg.Secrets.Directory = "super-secret-directory"
|
||||||
|
|
||||||
|
_, err := Run(context.Background(), Request{Config: cfg})
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("Run() error = nil, want adapter construction error")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "prepare weather collection") {
|
||||||
|
t.Fatalf("error = %q, want collection setup context", err.Error())
|
||||||
|
}
|
||||||
|
if strings.Contains(err.Error(), cfg.Secrets.Directory) {
|
||||||
|
t.Fatalf("error = %q, want no secret path leakage", err.Error())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunWrapsFetchError(t *testing.T) {
|
||||||
|
server := collectionTestServer(t, map[string]int{"/observations": http.StatusBadGateway})
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
cfg := config.Defaults()
|
||||||
|
cfg.WeatherAPI.BaseURL = server.URL + "/"
|
||||||
|
|
||||||
|
_, err := Run(context.Background(), Request{Config: cfg})
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("Run() error = nil, want fetch error")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "collect weather bundle") {
|
||||||
|
t.Fatalf("error = %q, want collection fetch context", err.Error())
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "/observations") {
|
||||||
|
t.Fatalf("error = %q, want source endpoint context", err.Error())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func collectionTestServer(t *testing.T, statusByPath map[string]int) *httptest.Server {
|
||||||
|
t.Helper()
|
||||||
|
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if status := statusByPath[r.URL.Path]; status != 0 {
|
||||||
|
http.Error(w, "upstream failure", status)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
switch r.URL.Path {
|
||||||
|
case "/observations":
|
||||||
|
_, _ = w.Write([]byte(`{"data":{"timestamp":"2026-05-29T14:00:00Z","conditionCode":3}}`))
|
||||||
|
case "/conditions/current":
|
||||||
|
_, _ = w.Write([]byte(`{"data":{"conditionText":"Clear"}}`))
|
||||||
|
case "/forecast/hourly":
|
||||||
|
_, _ = w.Write([]byte(`{"data":{"issuedAt":"2026-05-29T10:30:00-05:00","product":"hourly","periods":[{"startTime":"2026-05-29T13:00:00-05:00","endTime":"2026-05-29T14:00:00-05:00"}]}}`))
|
||||||
|
case "/forecast/narrative":
|
||||||
|
_, _ = w.Write([]byte(`{"data":{"issuedAt":"2026-05-29T10:30:00-05:00","product":"narrative","periods":[]}}`))
|
||||||
|
case "/alerts/active":
|
||||||
|
_, _ = w.Write([]byte(`{"data":{"alerts":[]}}`))
|
||||||
|
case "/discussion":
|
||||||
|
_, _ = w.Write([]byte(`{"data":{"product":"discussion","issuedAt":"2026-05-29T09:25:00-05:00","keyMessages":[],"shortTerm":{"qualifier":"(Short Term)","text":"Short-term AFD narrative for saved bundle."},"longTerm":{"qualifier":"(Long Term)","text":"Long-term AFD narrative for saved bundle."}}}`))
|
||||||
|
case "/weatherstories/latest":
|
||||||
|
_, _ = w.Write([]byte(`{"data":{"officeId":"LSX","startTime":"2026-05-30T08:46:00Z","endTime":"2026-05-31T11:00:00Z","updatedAt":"2026-05-30T09:00:34Z","title":"Several Chances for Rain Through Monday","description":"Scattered showers and thunderstorms remain possible.","altText":"Forecast weather story graphic.","priority":false,"order":1,"downloadUrl":"https://api.weather.gov/offices/LSX/weatherstories/download/test"}}`))
|
||||||
|
case "/outlooks/convective":
|
||||||
|
_, _ = w.Write([]byte(`{"data":{"asOf":"2026-05-29T16:00:00Z","outlooks":[],"discussions":[]}}`))
|
||||||
|
default:
|
||||||
|
http.NotFound(w, r)
|
||||||
|
}
|
||||||
|
}))
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user