Skip to content

fix(gem): name the skipped BUNDLE_PATH verbatim in the config-ignored warning #225

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.

Sign up for GitHub

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

Closed
Mikola Lysenko (mikolalysenko) wants to merge 1 commit into from
+28 −1
Closed

fix(gem): name the skipped BUNDLE_PATH verbatim in the config-ignored warning #225

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion crates/socket-patch-core/src/crawlers/ruby_crawler.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,8 +673,14 @@ pub struct BundleStoreDiscovery {
pub fn config_path_ignored_warning(value: &str) -> (&'static str, String) {
(
"gem_bundle_config_path_ignored",
// Display inside manual quotes, NOT `{value:?}`: Debug escaping
// doubles backslashes, so on Windows the detail printed
// `C:\\Users\\…` for a config that says `C:\Users\…` — breaking
// both the substring assertions and any human copy-pasting the
// path. The value is already a single scraped line, so Display
// cannot smuggle in newlines the quotes would mask.
format!(
"bundler app config BUNDLE_PATH {value:?} resolves outside the project \
"bundler app config BUNDLE_PATH \"{value}\" resolves outside the project \
root; ignoring it as an install root (a committed .bundle/config is \
untrusted input — set BUNDLE_PATH in the environment to use an \
out-of-tree bundle path)"
Expand Down Expand Up @@ -1532,6 +1538,27 @@ mod tests {
/// the CLI's warning channels), keyed by the verbatim config value —
/// and stays `None` for a contained value or a `path.system` drop
/// (bundler itself ignores the path there; nothing was refused).
/// The detail must carry the config value VERBATIM. `{value:?}` (Debug)
/// escaped backslashes, so on Windows the warning printed `C:\\Users\\…`
/// for a config that says `C:\Users\…` — invisible on Unix (temp paths
/// carry no backslashes), red on the windows-latest CI leg, and wrong
/// for any human copy-pasting the path out of the warning. A
/// backslash-bearing value pins it on every platform.
#[test]
fn config_path_ignored_warning_names_the_value_verbatim() {
let value = r"C:\Users\dev\bundle store";
let (code, detail) = config_path_ignored_warning(value);
assert_eq!(code, "gem_bundle_config_path_ignored");
assert!(
detail.contains(value),
"detail must contain the unescaped value: {detail}"
);
assert!(
!detail.contains(r"C:\\Users"),
"Debug escaping must not double backslashes: {detail}"
);
}

#[tokio::test]
async fn discovery_records_skipped_config_path() {
let dir = tempfile::tempdir().unwrap();
Expand Down
Loading