8201f3d72f
When working on the git stash picker PR (#35927) I notice that my test
was detected as a binary file on the git diff view and on GitHub. This
was due to the fact that I was using the literal char \0 (instead of a
proper representation like `\x00` or `\u{0000}`) character in my test
strings. This causes problems with git diff and GitHub's diff viewer,
and a reviewer might even assume that the file is corrupted, not
viewable or even malicious.
Looking at the rest of the codebase, only at `crates/git/src/commit.rs`
this character was used, so I replaced it with `\x00` which is a more
common representation of the null character in Rust strings.
It can also be seen that the PR that introduced this code, can't be
viewed properly on Github:
https://github.com/zed-industries/zed/pull/27636/files#diff-31114f0b22306b467482573446f71c638277510b442a10e60dd9a8667ccd93c3
Closes #ISSUE
Release Notes:
- Use `\x00` representation instead of literal null character in strings
to improve compatibility with git diff and GitHub's diff viewer.
Since the file is not viewable from the "Files changed" tab on Github,
this is the changed code:
dcd743aca4/crates/git/src/commit.rs (L66-L74)
112 lines
3.5 KiB
Rust
112 lines
3.5 KiB
Rust
use crate::{Oid, status::StatusCode};
|
|
use anyhow::{Context as _, Result};
|
|
use collections::HashMap;
|
|
use std::path::Path;
|
|
|
|
pub async fn get_messages(working_directory: &Path, shas: &[Oid]) -> Result<HashMap<Oid, String>> {
|
|
if shas.is_empty() {
|
|
return Ok(HashMap::default());
|
|
}
|
|
|
|
const MARKER: &str = "<MARKER>";
|
|
|
|
let output = util::command::new_smol_command("git")
|
|
.current_dir(working_directory)
|
|
.arg("show")
|
|
.arg("-s")
|
|
.arg(format!("--format=%B{}", MARKER))
|
|
.args(shas.iter().map(ToString::to_string))
|
|
.output()
|
|
.await
|
|
.context("starting git blame process")?;
|
|
|
|
anyhow::ensure!(
|
|
output.status.success(),
|
|
"'git show' failed with error {:?}",
|
|
output.status
|
|
);
|
|
|
|
Ok(shas
|
|
.iter()
|
|
.cloned()
|
|
.zip(
|
|
String::from_utf8_lossy(&output.stdout)
|
|
.trim()
|
|
.split_terminator(MARKER)
|
|
.map(|str| str.trim().replace("<", "<").replace(">", ">")),
|
|
)
|
|
.collect::<HashMap<Oid, String>>())
|
|
}
|
|
|
|
/// Parse the output of `git diff --name-status -z`
|
|
pub fn parse_git_diff_name_status(content: &str) -> impl Iterator<Item = (&Path, StatusCode)> {
|
|
let mut parts = content.split('\0');
|
|
std::iter::from_fn(move || {
|
|
loop {
|
|
let status_str = parts.next()?;
|
|
let path = parts.next()?;
|
|
let status = match status_str {
|
|
"M" => StatusCode::Modified,
|
|
"A" => StatusCode::Added,
|
|
"D" => StatusCode::Deleted,
|
|
_ => continue,
|
|
};
|
|
return Some((Path::new(path), status));
|
|
}
|
|
})
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_parse_git_diff_name_status() {
|
|
let input = concat!(
|
|
"M\x00Cargo.lock\x00",
|
|
"M\x00crates/project/Cargo.toml\x00",
|
|
"M\x00crates/project/src/buffer_store.rs\x00",
|
|
"D\x00crates/project/src/git.rs\x00",
|
|
"A\x00crates/project/src/git_store.rs\x00",
|
|
"A\x00crates/project/src/git_store/git_traversal.rs\x00",
|
|
"M\x00crates/project/src/project.rs\x00",
|
|
"M\x00crates/project/src/worktree_store.rs\x00",
|
|
"M\x00crates/project_panel/src/project_panel.rs\x00",
|
|
);
|
|
|
|
let output = parse_git_diff_name_status(input).collect::<Vec<_>>();
|
|
assert_eq!(
|
|
output,
|
|
&[
|
|
(Path::new("Cargo.lock"), StatusCode::Modified),
|
|
(Path::new("crates/project/Cargo.toml"), StatusCode::Modified),
|
|
(
|
|
Path::new("crates/project/src/buffer_store.rs"),
|
|
StatusCode::Modified
|
|
),
|
|
(Path::new("crates/project/src/git.rs"), StatusCode::Deleted),
|
|
(
|
|
Path::new("crates/project/src/git_store.rs"),
|
|
StatusCode::Added
|
|
),
|
|
(
|
|
Path::new("crates/project/src/git_store/git_traversal.rs"),
|
|
StatusCode::Added,
|
|
),
|
|
(
|
|
Path::new("crates/project/src/project.rs"),
|
|
StatusCode::Modified
|
|
),
|
|
(
|
|
Path::new("crates/project/src/worktree_store.rs"),
|
|
StatusCode::Modified
|
|
),
|
|
(
|
|
Path::new("crates/project_panel/src/project_panel.rs"),
|
|
StatusCode::Modified
|
|
),
|
|
]
|
|
);
|
|
}
|
|
}
|