Implement cargo compatibility status code enforcement feature flag #7776
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Turbo87
added
C-internal 🔧
Turbo87
force-pushed
the
cargo-compat
branch
from
a2c0394 to
ad926bf
Compare
LawnGnome
approved these changes
Dec 20, 2023
The middleware has its own unit tests to verify its functionality. Here, we can test what would happen if we toggled the status code enforcement off eventually.
Turbo87
force-pushed
the
cargo-compat
branch
from
ad926bf to
9adb205
Compare
|
shouldn't have pushed in last minute fixes... 😅 |
Turbo87
commented
Dec 21, 2023
Comment on lines
+8
to
+34
| #[derive(Clone, Copy, Debug)] | ||
| pub enum StatusCodeConfig { | ||
| /// Use the original response status code that the backend returned. | ||
| Disabled, | ||
| /// Use `200 OK` for all responses to cargo-relevant endpoints. | ||
| AdjustAll, | ||
| /// Use `200 OK` for all `2xx` responses to cargo-relevant endpoints, and | ||
| /// the original status code for all other responses. | ||
| AdjustSuccess, | ||
| } | ||
|
|
||
| #[derive(Debug, thiserror::Error)] | ||
| #[error("Failed to parse StatusCodeConfig")] | ||
| pub struct StatusCodeConfigError; | ||
|
|
||
| impl FromStr for StatusCodeConfig { | ||
| type Err = StatusCodeConfigError; | ||
|
|
||
| fn from_str(s: &str) -> Result<Self, Self::Err> { | ||
| match s { | ||
| "disabled" => Ok(Self::Disabled), | ||
| "adjust-all" => Ok(Self::AdjustAll), | ||
| "adjust-success" => Ok(Self::AdjustSuccess), | ||
| _ => Err(StatusCodeConfigError), | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
I've changed the implementation from a simple bool to an enum. This allows us to use the original status codes in tests, 200 everywhere in production, and e.g. 200 for 2xx on staging or eventually on production too.
Turbo87
commented
Dec 21, 2023
Comment on lines
+229
to
+230
| cargo_compat_status_code_config: var_parsed("CARGO_COMPAT_STATUS_CODES")? | ||
| .unwrap_or(StatusCodeConfig::AdjustAll), |
There was a problem hiding this comment.
if no value is set it will default to AdjustAll (i.e. convert everything to 200 OK)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #7715 we implemented a middleware that ensured
200 OKresponse status codes for all API endpoints that are relevant for cargo (see https://doc.rust-lang.org/cargo/reference/registry-web-api.html).The PR also mentioned:
This PR implements such a feature flag, based on the value of a
CARGO_COMPAT_STATUS_CODESenvironment variable. If that env var is set to"n"it will disable this part of the middleware and return the real status codes instead.Also, our integration test suite is using this behavior by default now. The middleware has dedicated unit tests which already verify that the middleware works as expected. In the integration tests we can test what would happen if we toggled the status code enforcement off eventually.
Related: