LukeMathWalker / LukeMathWalker/pavex
feat: Include the server request id in the error shown by Pavex CLI, if relevant
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2.1k
- Forks
- 80
- PR merge metrics
- No merged PRs in 30d
Description
https://api.pavex.dev will always populate the `X-Server-Request-Id` header whenever it returns a response. It looks like `sri-xxxx`, since it's built on `ServerRequestId`.
Pavex's CLI should include that request id whenever it exposes an error to the user that traces back to a failed request to the API. This allows the user to communicate that id back to us when triaging the issue, thus speeding up resolution.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Pavex CLI paths that expose errors from failed requests to the API, then inspect how response headers are handled. Confirm the behavior for responses carrying X-Server-Request-Id; done means relevant user-facing errors include that request id.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100