Handling dependency name sanitization #127
Merged
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
beeb
reviewed
Aug 5, 2024
src/utils.rs
Outdated
Comment on lines
151
to
156
| pub fn sanitize_dependency_name(dependency_name: &str) -> String { | ||
| if FILE_NAME_REGEX.is_match(dependency_name) { | ||
| return String::new(); | ||
| } | ||
| dependency_name.replace("/", "-") | ||
| } |
There was a problem hiding this comment.
A bit simplistic, and we could avoid to error if we instead replace the offending characters by allowed ones.
Maybe we can use https://crates.io/crates/sanitize-filename instead of rolling our own. They handle windows special chars and max file length too.
beeb
reviewed
Aug 5, 2024
src/utils.rs
Outdated
| @@ -145,18 +145,50 @@ pub fn get_url_type(dependency_url: &str) -> UrlType { | |||
| UrlType::Http | |||
| } | |||
|
|
|||
| pub fn sanitize_dependency_name(dependency_name: &str) -> String { | |||
| let options = sanitize_filename::Options { truncate: true, windows: true, replacement: "-" }; | |||
There was a problem hiding this comment.
Suggested change
| let options = sanitize_filename::Options { truncate: true, windows: true, replacement: "-" }; | |
| let options = sanitize_filename::Options { truncate: true, windows: cfg!(windows), replacement: "-" }; |
beeb
requested changes
Aug 6, 2024
src/config.rs
Outdated
| let new_dep_remapped = format_remap_name(soldeer_config, add_dep); | ||
| let new_dep_orig = | ||
| format!("dependencies/{}-{}/", add_dep.name(), add_dep.version()); | ||
| let new_dep_remapped: String = format_remap_name(soldeer_config, add_dep); |
There was a problem hiding this comment.
Suggested change
| let new_dep_remapped: String = format_remap_name(soldeer_config, add_dep); | |
| let new_dep_remapped = format_remap_name(soldeer_config, add_dep); |
src/janitor.rs
Outdated
| let sanitized_name = | ||
| sanitize_dependency_name(&format!("{}-{}", dependency.name(), dependency.version())); | ||
|
|
||
| let new_path: std::path::PathBuf = DEPENDENCY_DIR.clone().join(format!("{sanitized_name}.zip")); |
There was a problem hiding this comment.
Suggested change
| let new_path: std::path::PathBuf = DEPENDENCY_DIR.clone().join(format!("{sanitized_name}.zip")); | |
| let new_path = DEPENDENCY_DIR.clone().join(format!("{sanitized_name}.zip")); |
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.
No description provided.