Filter common git hosting providers from SSH config hosts (#51528)
Fixes https://github.com/zed-industries/zed/issues/50218 - For every `Host` block: collect its host patterns (handling continuations and filtering `!`/`*/\`), remember any `Hostname`. - When the block ends: if `Hostname` is a git provider → discard everything. - Else if `Hostname` exists → keep all host aliases. - Else → keep only the host aliases that are not git providers. Added more extensive test coverage as well to cover the above! Release Notes: - Fixed SSH host picker showing git provider domains (e.g. github.com, gitlab.com) from SSH config. --------- Co-authored-by: Nathan Sobo <nathan@zed.dev>
This commit is contained in:
Sarmad GulzarandNathan Sobo authored and GitHub committed
1 parent
7340835769
commit
3dd2e80ec5
1 file changed
+161
-40
@@ -1,60 +1,116 @@
|
||||
use std::collections::BTreeSet;
|
||||
|
||||
const FILTERED_GIT_PROVIDER_HOSTNAMES: &[&str] = &[
|
||||
"dev.azure.com",
|
||||
"bitbucket.org",
|
||||
"chromium.googlesource.com",
|
||||
"codeberg.org",
|
||||
"gitea.com",
|
||||
"gitee.com",
|
||||
"github.com",
|
||||
"gist.github.com",
|
||||
"gitlab.com",
|
||||
"sourcehut.org",
|
||||
"git.sr.ht",
|
||||
];
|
||||
|
||||
pub fn parse_ssh_config_hosts(config: &str) -> BTreeSet<String> {
|
||||
let mut hosts = BTreeSet::new();
|
||||
let mut needs_another_line = false;
|
||||
parse_host_blocks(config)
|
||||
.into_iter()
|
||||
.flat_map(HostBlock::non_git_provider_hosts)
|
||||
.collect()
|
||||
}
|
||||
|
||||
struct HostBlock {
|
||||
aliases: BTreeSet<String>,
|
||||
hostname: Option<String>,
|
||||
}
|
||||
|
||||
impl HostBlock {
|
||||
fn non_git_provider_hosts(self) -> impl Iterator<Item = String> {
|
||||
let hostname = self.hostname;
|
||||
let hostname_ref = hostname.as_deref().map(is_git_provider_domain);
|
||||
self.aliases
|
||||
.into_iter()
|
||||
.filter(move |alias| !hostname_ref.unwrap_or_else(|| is_git_provider_domain(alias)))
|
||||
}
|
||||
}
|
||||
|
||||
fn parse_host_blocks(config: &str) -> Vec<HostBlock> {
|
||||
let mut blocks = Vec::new();
|
||||
let mut aliases = BTreeSet::new();
|
||||
let mut hostname = None;
|
||||
let mut needs_continuation = false;
|
||||
|
||||
for line in config.lines() {
|
||||
let line = line.trim_start();
|
||||
if let Some(line) = line.strip_prefix("Host") {
|
||||
match line.chars().next() {
|
||||
Some('\\') => {
|
||||
needs_another_line = true;
|
||||
}
|
||||
Some('\n' | '\r') => {
|
||||
needs_another_line = false;
|
||||
}
|
||||
Some(c) if c.is_whitespace() => {
|
||||
parse_hosts_from(line, &mut hosts);
|
||||
}
|
||||
Some(_) | None => {
|
||||
needs_another_line = false;
|
||||
}
|
||||
};
|
||||
|
||||
if needs_another_line {
|
||||
parse_hosts_from(line, &mut hosts);
|
||||
needs_another_line = line.trim_end().ends_with('\\');
|
||||
} else {
|
||||
needs_another_line = false;
|
||||
if needs_continuation {
|
||||
needs_continuation = line.trim_end().ends_with('\\');
|
||||
parse_hosts(line, &mut aliases);
|
||||
continue;
|
||||
}
|
||||
|
||||
let Some((keyword, value)) = split_keyword_and_value(line) else {
|
||||
continue;
|
||||
};
|
||||
|
||||
if keyword.eq_ignore_ascii_case("host") {
|
||||
if !aliases.is_empty() {
|
||||
blocks.push(HostBlock { aliases, hostname });
|
||||
aliases = BTreeSet::new();
|
||||
hostname = None;
|
||||
}
|
||||
} else if needs_another_line {
|
||||
needs_another_line = line.trim_end().ends_with('\\');
|
||||
parse_hosts_from(line, &mut hosts);
|
||||
} else {
|
||||
needs_another_line = false;
|
||||
parse_hosts(value, &mut aliases);
|
||||
needs_continuation = line.trim_end().ends_with('\\');
|
||||
} else if keyword.eq_ignore_ascii_case("hostname") {
|
||||
hostname = value.split_whitespace().next().map(ToOwned::to_owned);
|
||||
}
|
||||
}
|
||||
|
||||
hosts
|
||||
if !aliases.is_empty() {
|
||||
blocks.push(HostBlock { aliases, hostname });
|
||||
}
|
||||
|
||||
blocks
|
||||
}
|
||||
|
||||
fn parse_hosts_from(line: &str, hosts: &mut BTreeSet<String>) {
|
||||
fn parse_hosts(line: &str, hosts: &mut BTreeSet<String>) {
|
||||
hosts.extend(
|
||||
line.split_whitespace()
|
||||
.map(|field| field.trim_end_matches('\\'))
|
||||
.filter(|field| !field.starts_with("!"))
|
||||
.filter(|field| !field.contains("*"))
|
||||
.filter(|field| *field != "\\")
|
||||
.filter(|field| !field.is_empty())
|
||||
.map(|field| field.to_owned()),
|
||||
);
|
||||
}
|
||||
|
||||
fn split_keyword_and_value(line: &str) -> Option<(&str, &str)> {
|
||||
let keyword_end = line.find(char::is_whitespace).unwrap_or(line.len());
|
||||
let keyword = &line[..keyword_end];
|
||||
if keyword.is_empty() {
|
||||
return None;
|
||||
}
|
||||
|
||||
let value = line[keyword_end..].trim_start();
|
||||
Some((keyword, value))
|
||||
}
|
||||
|
||||
fn is_git_provider_domain(host: &str) -> bool {
|
||||
let host = host.to_ascii_lowercase();
|
||||
FILTERED_GIT_PROVIDER_HOSTNAMES.contains(&host.as_str())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use indoc::indoc;
|
||||
|
||||
#[test]
|
||||
fn test_thank_you_bjorn3() {
|
||||
let hosts = "
|
||||
let hosts = indoc! {"
|
||||
Host *
|
||||
AddKeysToAgent yes
|
||||
UseKeychain yes
|
||||
@@ -67,19 +123,20 @@ mod tests {
|
||||
User not_me
|
||||
|
||||
Host something
|
||||
HostName whatever.tld
|
||||
HostName whatever.tld
|
||||
|
||||
Host linux bsd host3
|
||||
User bjorn
|
||||
Host linux bsd host3
|
||||
User bjorn
|
||||
|
||||
Host rpi
|
||||
user rpi
|
||||
hostname rpi.local
|
||||
Host rpi
|
||||
user rpi
|
||||
hostname rpi.local
|
||||
|
||||
Host \
|
||||
somehost \
|
||||
anotherhost
|
||||
Hostname 192.168.3.3";
|
||||
Host \\
|
||||
somehost \\
|
||||
anotherhost
|
||||
Hostname 192.168.3.3
|
||||
"};
|
||||
|
||||
let expected_hosts = BTreeSet::from_iter([
|
||||
"something".to_owned(),
|
||||
@@ -93,4 +150,68 @@ mod tests {
|
||||
|
||||
assert_eq!(expected_hosts, parse_ssh_config_hosts(hosts));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn filters_git_provider_domains_from_hostname() {
|
||||
let hosts = indoc! {"
|
||||
Host github-personal
|
||||
HostName github.com
|
||||
|
||||
Host gitlab-work
|
||||
HostName GITLAB.COM
|
||||
|
||||
Host local
|
||||
HostName example.com
|
||||
"};
|
||||
|
||||
assert_eq!(
|
||||
BTreeSet::from_iter(["local".to_owned()]),
|
||||
parse_ssh_config_hosts(hosts)
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn falls_back_to_host_when_hostname_is_absent() {
|
||||
let hosts = indoc! {"
|
||||
Host github.com bitbucket.org keep-me
|
||||
User git
|
||||
"};
|
||||
|
||||
assert_eq!(
|
||||
BTreeSet::from_iter(["keep-me".to_owned()]),
|
||||
parse_ssh_config_hosts(hosts)
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn does_not_fuzzy_match_host_aliases() {
|
||||
let hosts = indoc! {"
|
||||
Host GitHub GitLab Bitbucket GITHUB github
|
||||
User git
|
||||
"};
|
||||
|
||||
assert_eq!(
|
||||
BTreeSet::from_iter([
|
||||
"Bitbucket".to_owned(),
|
||||
"GITHUB".to_owned(),
|
||||
"GitHub".to_owned(),
|
||||
"GitLab".to_owned(),
|
||||
"github".to_owned(),
|
||||
]),
|
||||
parse_ssh_config_hosts(hosts)
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn uses_hostname_before_host_filtering() {
|
||||
let hosts = indoc! {"
|
||||
Host github.com keep-me
|
||||
HostName example.com
|
||||
"};
|
||||
|
||||
assert_eq!(
|
||||
BTreeSet::from_iter(["github.com".to_owned(), "keep-me".to_owned()]),
|
||||
parse_ssh_config_hosts(hosts)
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user