Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[stacked] Box streaming request bodies #268

Merged
merged 3 commits into from
Jan 3, 2024
Merged

[stacked] Box streaming request bodies #268

merged 3 commits into from
Jan 3, 2024

Conversation

sfackler
Copy link
Member

@sfackler sfackler commented Oct 8, 2023

Before this PR

Streaming request bodies were passed by reference at the Client level, while they were passed by value in the generated Conjure code. This complicated codegen and caused inconsistencies in behavior between conjure-codegen and conjure-macros.

After this PR

==COMMIT_MSG==
Streaming request bodies are now passed by value to the client.
==COMMIT_MSG==

We could go further and implement a bigger change to handle palantir/conjure-rust-runtime#146. However, this would complicate the interface even more and be only possible in the async client. Given that we don't have any use cases for full-duplex communications via Conjure clients it doesn't seem worth it.

Closes #259

Base automatically changed from custom-client-improvements to master January 2, 2024 20:41
@changelog-app
Copy link

changelog-app bot commented Jan 2, 2024

Generate changelog in changelog/@unreleased

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.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Streaming request bodies are now passed by value to the client.

Check the box to generate changelog(s)

  • Generate changelog entry

@sfackler sfackler merged commit c801c30 into master Jan 3, 2024
5 checks passed
@sfackler sfackler deleted the boxed-body branch January 3, 2024 02:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change {Async,}RequestBody::Streaming to store a boxed writer
3 participants