Fix config env vars that are prefix of another with underscore. #7748
Conversation
This file contains 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
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
@bors: r+ Nice catch! |
|
📌 Commit 829ddf0 has been approved by |
bors
added
S-waiting-on-bors
bors
added a commit
that referenced
this pull request
Jan 6, 2020
Fix config env vars that are prefix of another with underscore. This fixes the CARGO_BUILD_TARGET_DIR and CARGO_PROFILE_DEV_DEBUG_ASSERTIONS environment variables. Hopefully the big comment explains everything, but to review: `deserialize_option` does not know the type of the value it is about to deserialize. The type could be a struct, in which case it needs to check if `CARGO_FOO_BAR_*` environment variables are set. However, when deserializing something like `build.target`, this prefix check will incorrectly match `CARGO_BUILD_TARGET_DIR` which happens to be a prefix of `CARGO_BUILD_TARGET_*`. It attempts to call `visit_some` which fails if `CARGO_BUILD_TARGET` is not set. The solution here is to detect scenarios where one field is a prefix of another, and skip the environment prefix check (by setting `Deserializer::env_prefix_ok` appropriately). This means we cannot have `Option<SomeStruct>` be a prefix of another field with an underscore. I think that's fine, and we should try to probably avoid these kinds a prefixes anyways. Closes #7253.
|
☀️ Test successful - checks-azure |
bors
added a commit
to rust-lang/rust
that referenced
this pull request
Jan 7, 2020
Update cargo 9 commits in 86134e7666a088682f20b76278c3ee096a315218..6e1ca924a67dd1ac89c33f294ef26b5c43b89168 2019-12-23 16:08:07 +0000 to 2020-01-06 19:11:37 +0000 - Fix dynamic linking for Windows UWP MSVC targets (rust-lang/cargo#7758) - Fix CARGO_TARGET_triple_LINKER environment variable. (rust-lang/cargo#7763) - Remove metadata dep_kinds duplicates. (rust-lang/cargo#7756) - Check for a source defined multiple times. (rust-lang/cargo#7751) - Fix typo. (rust-lang/cargo#7735) - Fix config env vars that are prefix of another with underscore. (rust-lang/cargo#7748) - Add test for `cargo pkgid` (rust-lang/cargo#7741) - Add a note to the error message for using --feature / --no-default-features in a virtual workspace (rust-lang/cargo#7742) - Fix debug message. (rust-lang/cargo#7749)
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.
This fixes the CARGO_BUILD_TARGET_DIR and CARGO_PROFILE_DEV_DEBUG_ASSERTIONS environment variables. Hopefully the big comment explains everything, but to review:
deserialize_optiondoes not know the type of the value it is about to deserialize. The type could be a struct, in which case it needs to check ifCARGO_FOO_BAR_*environment variables are set. However, when deserializing something likebuild.target, this prefix check will incorrectly matchCARGO_BUILD_TARGET_DIRwhich happens to be a prefix ofCARGO_BUILD_TARGET_*. It attempts to callvisit_somewhich fails ifCARGO_BUILD_TARGETis not set.The solution here is to detect scenarios where one field is a prefix of another, and skip the environment prefix check (by setting
Deserializer::env_prefix_okappropriately). This means we cannot haveOption<SomeStruct>be a prefix of another field with an underscore. I think that's fine, and we should try to probably avoid these kinds a prefixes anyways.Closes #7253.