Our handling of streaming request bodies is currently incorrect. We accept a func() io.ReadCloser, but assume this function can be called multiple times. In practice, some bodies are streamed from sources that can't be reconstructed or retrieved again without additional handling.
In this PR we introduce the RequestBody interface, implemented by 3 exported constructor functions:
RequestBodyInMemory for payloads of known types that can be easily reset
RequestBodyStreamOnce for payloads that can not be reset
RequestBodyStreamWithReplay for arbitrary functions that return readers but can be called multiple times to generate new bodies.
After this merges, I plan to update conjure-go's generated client interfaces. Those that currently have a bodyArg func() io.ReadCloser will instead have bodyArg httpclient.RequestBody and the caller can decide what to provide.
What do the change types mean?
- `feature`: A new feature of the service.
- `improvement`: An incremental improvement in the functionality or operation of the service.
- `fix`: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
- `break`: Has the potential to break consumers of this service's API, inclusive of both Palantir services
and external consumers of the service's API (e.g. customer-written software or integrations).
- `deprecation`: Advertises the intention to remove service functionality without any change to the
operation of the service itself.
- `manualTask`: Requires the possibility of manual intervention (running a script, eyeballing configuration,
performing database surgery, ...) at the time of upgrade for it to succeed.
- `migration`: A fully automatic upgrade migration task with no engineer input required.
_Note: only one type should be chosen._
How are new versions calculated?
- ❗The `break` and `manual task` changelog types will result in a major release!
- 🐛 The `fix` changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
- ✨ All others will result in a minor version release.
Add interface RequestBody to encapsulate bodies that can be replayed and those that can't
**Check the box to generate changelog(s)**
- [x] Generate changelog entry
Our handling of streaming request bodies is currently incorrect. We accept a
func() io.ReadCloser
, but assume this function can be called multiple times. In practice, some bodies are streamed from sources that can't be reconstructed or retrieved again without additional handling.In this PR we introduce the RequestBody interface, implemented by 3 exported constructor functions:
After this merges, I plan to update conjure-go's generated client interfaces. Those that currently have a
bodyArg func() io.ReadCloser
will instead havebodyArg httpclient.RequestBody
and the caller can decide what to provide.This change is