awkawbandClaude Opus 5
9e7d81307d
The suite runs against mock servers written from the upstream source, so
it cannot catch a place where a real server disagrees with that reading.
`examples/smoke_test.rs` can: it lists every resource, checks the
pagination walk against a single oversized request, probes the per_page
cap, and exercises statics, search and health_check. The upload wire
format (POST plus `_method=PUT`) was read from the framework source
rather than observed, so its write tier is the real verification of it.
It prints PASS/FAIL per check and never the contents of a record.
Writes are guarded. `IN_SMOKE_WRITE_HOST` must equal the host in
`IN_BASE_URL`, so a write can only reach a server that was named
explicitly. `IN_BASE_URL` has no default, unlike the other example,
because defaulting to the hosted app is the wrong failure for a tool
that can write. The write tier leaves a gap in the client number
sequence and a soft-deleted row even after cleanup, so it is documented
as disposable-instance only.
Running it against a dead port exposed a diagnosability gap:
`Error::Http` printed "error sending request for url (...)" and nothing
else. reqwest's Display stops at the outermost layer, and the reason
("Connection refused", a DNS failure, a TLS error) lives in `source()`.
The error now renders its whole cause chain.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
115 lines
6.3 KiB
Markdown
115 lines
6.3 KiB
Markdown
# Changelog
|
|
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
## [Unreleased]
|
|
|
|
### Added
|
|
|
|
- Document uploads: `upload_client`, `upload_invoice`, `upload_expense`, and
|
|
thirteen more, one for each resource with an `/{id}/upload` route. They
|
|
take a `Vec<FileUpload>` and an optional `is_public`, and return the
|
|
refreshed record. Uploads are never retried, since a replay could attach
|
|
the file twice. This is the only way the API creates a document, so there
|
|
is no `create_document`. Enables reqwest's `multipart` feature, which adds
|
|
`mime`, `mime_guess`, and `unicase` and leaves the MSRV at 1.88.
|
|
- `FileUpload` and `Error::InvalidUpload`. An upload with no files, a nameless
|
|
file, or an unparseable MIME type is refused locally, because the server
|
|
answers an empty upload with a success that changed nothing.
|
|
- A declared minimum supported Rust version of **1.88**, verified by running
|
|
the test suite against it. The floor comes from the dependency graph
|
|
(`reqwest` → `url` → `idna` → `icu_*`), not from this crate's own code.
|
|
CI builds on both the MSRV and the pinned dev toolchain, plus a weekly
|
|
advisory job on latest stable that reports breakage from a new Rust
|
|
release. The advisory job fails visibly rather than silently; it is kept
|
|
non-blocking through branch protection rather than `continue-on-error`.
|
|
- Wrappers for every one of the API's 34 `Route::resource` groups, plus
|
|
`users` — 284 methods (including document uploads). See `COVERAGE.md` for the per-endpoint inventory.
|
|
- `COVERAGE.md`, a detailed record of what is wrapped, what is not, and why,
|
|
checked against `routes/api.php` on the `v5-stable` branch.
|
|
- Retry with full-jitter exponential backoff, configurable through
|
|
`RetryPolicy` and `InvoiceNinjaClient::with_retry_policy`. Defaults to 3
|
|
retries. `Retry-After` is honoured when the server sends it.
|
|
- `InvoiceNinjaClient::with_timeout` and a `DEFAULT_TIMEOUT` of 60 seconds
|
|
applied to every request.
|
|
- Typed responses for previously untyped endpoints: `Statics`, `StaticItem`,
|
|
`Currency`, `DateFormat`, `SearchResults`, `SearchHit`, `HealthCheck`, and
|
|
`PhpVersion`.
|
|
- `statics_as`, `search_as`, and `health_check_as` as generic escape hatches
|
|
for callers who need to pin a shape the typed models leave in `extra`.
|
|
- `tests/client_requests.rs`: 50 tests covering the request plumbing against
|
|
a loopback `wiremock` server. No network or credentials required.
|
|
- `RetryPolicy::max_elapsed`, a ceiling on the time one call may spend across
|
|
all attempts, defaulting to 120 seconds. The request timeout is per
|
|
attempt, so without this the default policy could spend four minutes on a
|
|
call that times out repeatedly.
|
|
|
|
### Changed
|
|
|
|
- `statics`, `search`, and `health_check` return concrete types instead of
|
|
being generic over `T: DeserializeOwned`.
|
|
- `send_email` now unwraps the `data` envelope, so `T` is the entity
|
|
(`Invoice`, `Quote`, …) rather than a wrapper the caller had to model. It
|
|
stays generic because the endpoint serves all four entity types.
|
|
- `chart` remains generic, deliberately: the eleven chart endpoints share no
|
|
common response shape, so there is nothing to narrow to.
|
|
- The base URL is parsed and validated when the client is constructed. A
|
|
missing scheme used to produce a 404 on every call instead of one error.
|
|
- `list_all_*` terminates on `meta.pagination.total_pages` when the server
|
|
sends it, falling back to the short-page heuristic only when it does not.
|
|
- `Error` is now `#[non_exhaustive]`, so later variants are not a breaking
|
|
change. Matches on it need a catch-all arm.
|
|
- `Error::Json` is now a struct variant carrying an `excerpt` of the body
|
|
that failed to decode. The serde message alone ("expected value at line 1
|
|
column 1") does not reveal that the response was, say, an HTML error page
|
|
from a proxy or a login redirect from a wrong base URL.
|
|
- API errors with an empty or message-less body now report the status reason
|
|
("Not Found") instead of rendering blank.
|
|
- `Error::Http` now renders its whole cause chain. `reqwest`'s own message
|
|
stops at "error sending request for url (...)", leaving out the part that
|
|
says why — "Connection refused", a DNS failure, a TLS handshake error — so
|
|
anyone printing the error had no way to tell which it was.
|
|
|
|
### Fixed
|
|
|
|
- `list_all_*` silently truncated results. The server caps page size at
|
|
`min(abs(per_page), 5000)`, so a page shorter than requested did not mean
|
|
the last page — the walk stopped early and returned a partial list as
|
|
though it were complete. `per_page` is now clamped to the server maximum so
|
|
the fallback heuristic holds.
|
|
- `list_all_*` with `per_page(0)` never terminated: the check `got < 0` has
|
|
no solution. It now falls back to the default page size, and a `MAX_PAGES`
|
|
backstop raises `Error::PaginationLimit` rather than quietly truncating.
|
|
- Requests could hang indefinitely. `reqwest` applies no timeout of its own
|
|
and none was configured.
|
|
- Ids were interpolated into request paths unescaped, so a `/`, `?`, or `#`
|
|
in an id changed which endpoint was addressed.
|
|
|
|
### Security
|
|
|
|
- Ids used as URL path segments are escaped, and ids that are empty or
|
|
consist only of dots are rejected. Escaping alone is insufficient: the
|
|
WHATWG rules the `url` crate implements decode `%2E` back to `.` before
|
|
resolving dot segments, so an escaped `..` still collapsed the path. An
|
|
empty id would have addressed the collection route, making
|
|
`delete_client("")` mean `DELETE /clients`.
|
|
- `POST` is never replayed on a 5xx or timeout, since the server may have
|
|
applied it before the response was lost and a replay would duplicate an
|
|
invoice, payment, or email. A 429 is the exception — the server states it
|
|
refused the request, so no work was done.
|
|
- The API token and password are held as headers marked sensitive, so
|
|
neither appears in `Debug` output. `reqwest`'s own `Client` debug prints
|
|
its default headers, so this is the only thing keeping the token out of
|
|
logs; there is now a regression test pinning it.
|
|
|
|
## [0.1.0] - 2026-10-23
|
|
|
|
### Added
|
|
|
|
- Initial release: async client for the Invoice Ninja v5 API covering
|
|
clients, invoices, quotes, credits, payments, products, expenses,
|
|
projects, tasks, and vendors.
|