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

Support per-endpoint request size limits #380

Merged
merged 3 commits into from
Sep 17, 2024
Merged

Conversation

sfackler
Copy link
Member

Before this PR

All endpoints with serializable request bodies limited them to 50MiB without the ability to configure that.

After this PR

==COMMIT_MSG==
Added support for per-endpoint request size limits via the server-limit-request-size: N tag.
==COMMIT_MSG==

There's a bit of jank in the codegen since up until now it's been totally infallible. To work around this, we inject compile_error! macro calls when the configured limit fails to parse properly. In the Java implementation, this parsing is deferred to runtime.

The limit is passed as a const generic parameter in the StdRequestDeserializer. I'm not sure if this is the "right" approach, but it lets us preserve back compat. Custom endpoints can set the parameter directly, which is workable but a bit weird. In the future it might make sense for the limit to be a more first-class concept in some way.

Closes #374

@sfackler sfackler requested a review from a team September 16, 2024 15:07
@changelog-app
Copy link

changelog-app bot commented Sep 16, 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

Added support for per-endpoint request size limits via the server-limit-request-size: N tag.

Check the box to generate changelog(s)

  • Generate changelog entry

@@ -0,0 +1,50 @@
pub fn parse(s: &str) -> Result<usize, String> {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this based on an equivalent java class where we are trying to maintain the same logic? Or is there some crate we could use that handles this so we're not worried about edge cases?

The logic here seems fine to be but I'm a bit paranoid that there's some edge case we've missed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, the Java version is here: https://github.com/palantir/human-readable-types/blob/develop/human-readable-types/src/main/java/com/palantir/humanreadabletypes/HumanReadableByteCount.java. It should be the same except the Rust version doesn't currently handle byte, mebibyte, etc since I never see those used in practice.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't found an existing crate that handles this parsing unfortunately.

@sfackler sfackler merged commit 4103e9e into master Sep 17, 2024
5 checks passed
@sfackler sfackler deleted the per-endpoint-limits branch September 17, 2024 17:20
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.

Support per-endpoint request size limits
3 participants