From 513fce723c7e37aa353844303f36022517f2db43 Mon Sep 17 00:00:00 2001 From: DanConwayDev Date: Fri, 25 Jul 2025 21:02:26 +0100 Subject: refactor: move `utils` and `list` helpers to lib to enable forthcoming `ngit sync` cmd --- src/bin/git_remote_nostr/fetch.rs | 10 +- src/bin/git_remote_nostr/list.rs | 163 +------------- src/bin/git_remote_nostr/main.rs | 3 +- src/bin/git_remote_nostr/push.rs | 17 +- src/bin/git_remote_nostr/utils.rs | 448 -------------------------------------- 5 files changed, 18 insertions(+), 623 deletions(-) delete mode 100644 src/bin/git_remote_nostr/utils.rs (limited to 'src/bin/git_remote_nostr') diff --git a/src/bin/git_remote_nostr/fetch.rs b/src/bin/git_remote_nostr/fetch.rs index f3d4362..221d964 100644 --- a/src/bin/git_remote_nostr/fetch.rs +++ b/src/bin/git_remote_nostr/fetch.rs @@ -19,15 +19,15 @@ use ngit::{ git_events::{KIND_PULL_REQUEST, KIND_PULL_REQUEST_UPDATE, tag_value}, login::get_curent_user, repo_ref::{RepoRef, is_grasp_server}, + utils::{ + Direction, find_proposal_and_patches_by_branch_name, get_oids_from_fetch_batch, + get_open_or_draft_proposals, get_read_protocols_to_try, join_with_and, + set_protocol_preference, + }, }; use nostr::nips::nip19; use nostr_sdk::{Event, ToBech32}; -use crate::utils::{ - Direction, find_proposal_and_patches_by_branch_name, get_oids_from_fetch_batch, - get_open_or_draft_proposals, get_read_protocols_to_try, join_with_and, set_protocol_preference, -}; - pub async fn run_fetch( git_repo: &Repo, repo_ref: &RepoRef, diff --git a/src/bin/git_remote_nostr/list.rs b/src/bin/git_remote_nostr/list.rs index 7bdf170..df98c12 100644 --- a/src/bin/git_remote_nostr/list.rs +++ b/src/bin/git_remote_nostr/list.rs @@ -1,30 +1,22 @@ -use core::str; use std::collections::HashMap; -use anyhow::{Context, Result, anyhow}; -use auth_git2::GitAuthenticator; +use anyhow::{Context, Result}; use client::get_state_from_cache; use git::RepoActions; use ngit::{ client, - git::{ - self, - nostr_url::{CloneUrl, NostrUrlDecoded, ServerProtocol}, - }, + git::{self}, git_events::{KIND_PULL_REQUEST, KIND_PULL_REQUEST_UPDATE, event_to_cover_letter, tag_value}, + list::{get_ahead_behind, list_from_remotes}, login::get_curent_user, - repo_ref::{self, is_grasp_server}, + repo_ref::{self}, + utils::{get_open_or_draft_proposals, get_short_git_server_name}, }; -use nostr_sdk::hashes::sha1::Hash as Sha1Hash; use repo_ref::RepoRef; use crate::{ fetch::{fetch_from_git_server, make_commits_for_proposal}, git::Repo, - utils::{ - Direction, get_open_or_draft_proposals, get_read_protocols_to_try, - get_short_git_server_name, join_with_and, set_protocol_preference, - }, }; pub async fn run_list( @@ -210,148 +202,3 @@ async fn get_open_and_draft_proposals_state( } Ok(state) } - -pub fn list_from_remotes( - term: &console::Term, - git_repo: &Repo, - git_servers: &Vec, - decoded_nostr_url: &NostrUrlDecoded, - grasp_servers: &[String], -) -> HashMap, bool)> { - let mut remote_states = HashMap::new(); - let mut errors = HashMap::new(); - for url in git_servers { - let is_grasp_server = is_grasp_server(url, grasp_servers); - match list_from_remote(term, git_repo, url, decoded_nostr_url, is_grasp_server) { - Err(error) => { - errors.insert(url, error); - } - Ok(state) => { - remote_states.insert(url.to_string(), (state, is_grasp_server)); - } - } - } - remote_states -} - -pub fn list_from_remote( - term: &console::Term, - git_repo: &Repo, - git_server_url: &str, - decoded_nostr_url: &NostrUrlDecoded, - is_grasp_server: bool, -) -> Result> { - let server_url = git_server_url.parse::()?; - let protocols_to_attempt = - get_read_protocols_to_try(git_repo, &server_url, decoded_nostr_url, is_grasp_server); - - let mut failed_protocols = vec![]; - let mut remote_state: Option> = None; - - for protocol in &protocols_to_attempt { - term.write_line( - format!( - "fetching {} ref list over {protocol}...", - server_url.short_name(), - ) - .as_str(), - )?; - - let formatted_url = server_url.format_as(protocol, &decoded_nostr_url.user)?; - let res = list_from_remote_url( - git_repo, - &formatted_url, - [ServerProtocol::UnauthHttps, ServerProtocol::UnauthHttp].contains(protocol), - term, - ); - - match res { - Ok(state) => { - remote_state = Some(state); - term.clear_last_lines(1)?; - if !failed_protocols.is_empty() { - term.write_line( - format!( - "list: succeeded over {protocol} from {}", - server_url.short_name(), - ) - .as_str(), - )?; - let _ = - set_protocol_preference(git_repo, protocol, &server_url, &Direction::Fetch); - } - break; - } - Err(error) => { - term.clear_last_lines(1)?; - term.write_line( - format!("list: {formatted_url} failed over {protocol}: {error}").as_str(), - )?; - failed_protocols.push(protocol); - } - } - } - if let Some(remote_state) = remote_state { - if failed_protocols.is_empty() { - term.clear_last_lines(1)?; - } - Ok(remote_state) - } else { - let error = anyhow!( - "{} failed over {}{}", - server_url.short_name(), - join_with_and(&failed_protocols), - if decoded_nostr_url.protocol.is_some() { - " and nostr url contains protocol override so no other protocols were attempted" - } else { - "" - }, - ); - term.write_line(format!("list: {error}").as_str())?; - Err(error) - } -} - -fn list_from_remote_url( - git_repo: &Repo, - git_server_remote_url: &str, - dont_authenticate: bool, - term: &console::Term, -) -> Result> { - let git_config = git_repo.git_repo.config()?; - - let mut git_server_remote = git_repo.git_repo.remote_anonymous(git_server_remote_url)?; - // authentication may be required - let auth = GitAuthenticator::default(); - let mut remote_callbacks = git2::RemoteCallbacks::new(); - if !dont_authenticate { - remote_callbacks.credentials(auth.credentials(&git_config)); - } - term.write_line("list: connecting...")?; - git_server_remote.connect_auth(git2::Direction::Fetch, Some(remote_callbacks), None)?; - term.clear_last_lines(1)?; - let mut state = HashMap::new(); - for head in git_server_remote.list()? { - if let Some(symbolic_reference) = head.symref_target() { - state.insert( - head.name().to_string(), - format!("ref: {symbolic_reference}"), - ); - // ignore dereferenced tags - } else if !head.name().to_string().ends_with("^{}") { - state.insert(head.name().to_string(), head.oid().to_string()); - } - } - git_server_remote.disconnect()?; - Ok(state) -} - -fn get_ahead_behind( - git_repo: &Repo, - base_ref_or_oid: &str, - latest_ref_or_oid: &str, -) -> Result<(Vec, Vec)> { - let base = git_repo.get_commit_or_tip_of_reference(base_ref_or_oid)?; - let latest = git_repo.get_commit_or_tip_of_reference(latest_ref_or_oid)?; - git_repo.get_commits_ahead_behind(&base, &latest) -} diff --git a/src/bin/git_remote_nostr/main.rs b/src/bin/git_remote_nostr/main.rs index cf47a30..aac626b 100644 --- a/src/bin/git_remote_nostr/main.rs +++ b/src/bin/git_remote_nostr/main.rs @@ -18,16 +18,15 @@ use ngit::{ client::{self, Params}, git::{self, utils::set_git_timeout}, login::existing::load_existing_login, + utils::read_line, }; use nostr::nips::nip19::Nip19Coordinate; -use utils::read_line; use crate::{client::Client, git::Repo}; mod fetch; mod list; mod push; -mod utils; #[tokio::main] async fn main() -> Result<()> { diff --git a/src/bin/git_remote_nostr/push.rs b/src/bin/git_remote_nostr/push.rs index 909a0ab..74e98f9 100644 --- a/src/bin/git_remote_nostr/push.rs +++ b/src/bin/git_remote_nostr/push.rs @@ -25,9 +25,15 @@ use ngit::{ oid_to_shorthand_string, }, git_events::{self, KIND_PULL_REQUEST, event_to_cover_letter, get_event_root}, + list::list_from_remotes, login::{self, user::UserRef}, repo_ref::{self, get_repo_config_from_yaml, is_grasp_server, normalize_grasp_server_url}, repo_state, + utils::{ + Direction, find_proposal_and_patches_by_branch_name, get_all_proposals, + get_remote_name_by_url, get_short_git_server_name, get_write_protocols_to_try, + join_with_and, read_line, set_protocol_preference, + }, }; use nostr::{event::UnsignedEvent, nips::nip10::Marker}; use nostr_sdk::{ @@ -37,16 +43,7 @@ use nostr_sdk::{ use repo_ref::RepoRef; use repo_state::RepoState; -use crate::{ - client::Client, - git::Repo, - list::list_from_remotes, - utils::{ - Direction, find_proposal_and_patches_by_branch_name, get_all_proposals, - get_remote_name_by_url, get_short_git_server_name, get_write_protocols_to_try, - join_with_and, read_line, set_protocol_preference, - }, -}; +use crate::{client::Client, git::Repo}; #[allow(clippy::too_many_lines)] #[allow(clippy::type_complexity)] diff --git a/src/bin/git_remote_nostr/utils.rs b/src/bin/git_remote_nostr/utils.rs deleted file mode 100644 index 2cb85bf..0000000 --- a/src/bin/git_remote_nostr/utils.rs +++ /dev/null @@ -1,448 +0,0 @@ -use core::str; -use std::{ - collections::HashMap, - fmt, - io::{self, Stdin}, - str::FromStr, -}; - -use anyhow::{Context, Result, bail}; -use git2::Repository; -use ngit::{ - client::{ - get_all_proposal_patch_pr_pr_update_events_from_cache, get_events_from_local_cache, - get_proposals_and_revisions_from_cache, - }, - git::{ - Repo, RepoActions, - nostr_url::{CloneUrl, NostrUrlDecoded, ServerProtocol}, - }, - git_events::{ - event_is_revision_root, get_pr_tip_event_or_most_recent_patch_with_ancestors, get_status, - is_event_proposal_root_for_branch, status_kinds, - }, - repo_ref::RepoRef, -}; -use nostr_sdk::{Event, EventId, Kind, PublicKey, Url}; - -pub fn get_short_git_server_name(git_repo: &Repo, url: &str) -> std::string::String { - if let Ok(name) = get_remote_name_by_url(&git_repo.git_repo, url) { - return name; - } - if let Ok(url) = Url::parse(url) { - if let Some(domain) = url.domain() { - return domain.to_string(); - } - } - url.to_string() -} - -pub fn get_remote_name_by_url(git_repo: &Repository, url: &str) -> Result { - let remotes = git_repo.remotes()?; - Ok(remotes - .iter() - .find(|r| { - if let Some(name) = r { - if let Some(remote_url) = git_repo.find_remote(name).unwrap().url() { - url == remote_url - } else { - false - } - } else { - false - } - }) - .context("could not find remote with matching url")? - .context("remote with matching url must be named")? - .to_string()) -} - -pub fn get_oids_from_fetch_batch( - stdin: &Stdin, - initial_oid: &str, - initial_refstr: &str, -) -> Result> { - let mut line = String::new(); - let mut batch = HashMap::new(); - batch.insert(initial_refstr.to_string(), initial_oid.to_string()); - loop { - let tokens = read_line(stdin, &mut line)?; - match tokens.as_slice() { - ["fetch", oid, refstr] => { - batch.insert((*refstr).to_string(), (*oid).to_string()); - } - [] => break, - _ => bail!( - "after a `fetch` command we are only expecting another fetch or an empty line" - ), - } - } - Ok(batch) -} - -/// Read one line from stdin, and split it into tokens. -pub fn read_line<'a>(stdin: &io::Stdin, line: &'a mut String) -> io::Result> { - line.clear(); - - let read = stdin.read_line(line)?; - if read == 0 { - return Ok(vec![]); - } - let line = line.trim(); - let tokens = line.split(' ').filter(|t| !t.is_empty()).collect(); - - Ok(tokens) -} - -pub async fn get_open_or_draft_proposals( - git_repo: &Repo, - repo_ref: &RepoRef, -) -> Result)>> { - let git_repo_path = git_repo.get_path()?; - let proposals: Vec = - get_proposals_and_revisions_from_cache(git_repo_path, repo_ref.coordinates()) - .await? - .iter() - .filter(|e| - // If we wanted to treat to list Pull Requests that revise a Patch we would do this: - // e.kind.eq(&KIND_PULL_REQUEST) || - !event_is_revision_root(e)) - .cloned() - .collect(); - - let statuses: Vec = { - let mut statuses = get_events_from_local_cache( - git_repo_path, - vec![ - nostr::Filter::default() - .kinds(status_kinds().clone()) - .events(proposals.iter().map(|e| e.id)), - ], - ) - .await?; - statuses.sort_by_key(|e| e.created_at); - statuses.reverse(); - statuses - }; - let mut open_or_draft_proposals = HashMap::new(); - - for proposal in &proposals { - let status = get_status(proposal, repo_ref, &statuses, &proposals); - if [Kind::GitStatusOpen, Kind::GitStatusDraft].contains(&status) { - if let Ok(commits_events) = get_all_proposal_patch_pr_pr_update_events_from_cache( - git_repo_path, - repo_ref, - &proposal.id, - ) - .await - { - if let Ok(most_recent_proposal_patch_chain) = - get_pr_tip_event_or_most_recent_patch_with_ancestors(commits_events.clone()) - { - open_or_draft_proposals.insert( - proposal.id, - (proposal.clone(), most_recent_proposal_patch_chain), - ); - } - } - } - } - Ok(open_or_draft_proposals) -} - -pub async fn get_all_proposals( - git_repo: &Repo, - repo_ref: &RepoRef, -) -> Result)>> { - let git_repo_path = git_repo.get_path()?; - let proposals: Vec = - get_proposals_and_revisions_from_cache(git_repo_path, repo_ref.coordinates()) - .await? - .iter() - .filter(|e| - // If we wanted to treat to list Pull Requests that revise a Patch we would do this: - // e.kind.eq(&KIND_PULL_REQUEST) || - !event_is_revision_root(e)) - .cloned() - .collect(); - - let mut all_proposals = HashMap::new(); - - for proposal in proposals { - if let Ok(commits_events) = get_all_proposal_patch_pr_pr_update_events_from_cache( - git_repo_path, - repo_ref, - &proposal.id, - ) - .await - { - if let Ok(most_recent_proposal_patch_chain) = - get_pr_tip_event_or_most_recent_patch_with_ancestors(commits_events.clone()) - { - all_proposals.insert(proposal.id, (proposal, most_recent_proposal_patch_chain)); - } - } - } - Ok(all_proposals) -} - -pub fn find_proposal_and_patches_by_branch_name<'a>( - refstr: &'a str, - proposals: &'a HashMap)>, - current_user: Option<&PublicKey>, -) -> Option<(&'a EventId, &'a (Event, Vec))> { - proposals.iter().find(|(_, (proposal, _))| { - is_event_proposal_root_for_branch(proposal, refstr, current_user).unwrap_or(false) - }) -} - -pub fn join_with_and(items: &[T]) -> String { - match items.len() { - 0 => String::new(), - 1 => items[0].to_string(), - _ => { - let last_item = items.last().unwrap().to_string(); - let rest = &items[..items.len() - 1]; - format!( - "{} and {}", - rest.iter() - .map(std::string::ToString::to_string) - .collect::>() - .join(", "), - last_item - ) - } - } -} - -/// get an ordered vector of server protocols to attempt -pub fn get_read_protocols_to_try( - git_repo: &Repo, - server_url: &CloneUrl, - decoded_nostr_url: &NostrUrlDecoded, - is_grasp_server: bool, -) -> Vec { - if is_grasp_server { - if server_url.protocol() == ServerProtocol::Http { - vec![(ServerProtocol::UnauthHttp)] - } else { - vec![(ServerProtocol::UnauthHttps)] - } - } else if server_url.protocol() == ServerProtocol::Filesystem { - vec![(ServerProtocol::Filesystem)] - } else if let Some(protocol) = &decoded_nostr_url.protocol { - vec![protocol.clone()] - } else { - let mut list = if server_url.protocol() == ServerProtocol::Http { - vec![ - ServerProtocol::UnauthHttp, - ServerProtocol::Ssh, - // note: list and fetch stop here if ssh was authenticated - ServerProtocol::Http, - ] - } else if server_url.protocol() == ServerProtocol::Ftp { - vec![ServerProtocol::Ftp, ServerProtocol::Ssh] - } else if server_url.protocol() == ServerProtocol::Git { - vec![ - ServerProtocol::Git, - ServerProtocol::UnauthHttps, - ServerProtocol::Ssh, - // note: list and fetch stop here if ssh was authenticated - ServerProtocol::Https, - ] - } else { - vec![ - ServerProtocol::UnauthHttps, - ServerProtocol::Ssh, - // note: list and fetch stop here if ssh was authenticated - ServerProtocol::Https, - ] - }; - if let Some(protocol) = get_protocol_preference(git_repo, server_url, &Direction::Fetch) { - if let Some(pos) = list.iter().position(|p| *p == protocol) { - list.remove(pos); - list.insert(0, protocol); - } - } - list - } -} - -/// get an ordered vector of server protocols to attempt -pub fn get_write_protocols_to_try( - git_repo: &Repo, - server_url: &CloneUrl, - decoded_nostr_url: &NostrUrlDecoded, - is_grasp_server: bool, -) -> Vec { - if is_grasp_server { - if server_url.protocol() == ServerProtocol::Http { - vec![(ServerProtocol::UnauthHttp)] - } else { - vec![(ServerProtocol::UnauthHttps)] - } - } else if server_url.protocol() == ServerProtocol::Filesystem { - vec![(ServerProtocol::Filesystem)] - } else if let Some(protocol) = &decoded_nostr_url.protocol { - vec![protocol.clone()] - } else { - let mut list = if server_url.protocol() == ServerProtocol::Http { - vec![ - ServerProtocol::Ssh, - // note: list and fetch stop here if ssh was authenticated - ServerProtocol::Http, - ] - } else if server_url.protocol() == ServerProtocol::Ftp { - vec![ServerProtocol::Ssh, ServerProtocol::Ftp] - } else if server_url.protocol() == ServerProtocol::Git { - vec![ - ServerProtocol::Ssh, - ServerProtocol::Git, - // note: list and fetch stop here if ssh was authenticated - ServerProtocol::Https, - ] - } else { - vec![ - ServerProtocol::Ssh, - // note: list and fetch stop here if ssh was authenticated - ServerProtocol::Https, - ] - }; - if let Some(protocol) = get_protocol_preference(git_repo, server_url, &Direction::Push) { - if let Some(pos) = list.iter().position(|p| *p == protocol) { - list.remove(pos); - list.insert(0, protocol); - } - } - - list - } -} - -#[derive(Debug, PartialEq)] -pub enum Direction { - Push, - Fetch, -} -impl fmt::Display for Direction { - fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { - match self { - Direction::Push => write!(f, "push"), - Direction::Fetch => write!(f, "fetch"), - } - } -} - -pub fn get_protocol_preference( - git_repo: &Repo, - server_url: &CloneUrl, - direction: &Direction, -) -> Option { - let server_short_name = server_url.short_name(); - if let Ok(Some(list)) = - git_repo.get_git_config_item(format!("nostr.protocol-{direction}").as_str(), Some(false)) - { - for item in list.split(';') { - let pair = item.split(',').collect::>(); - if let Some(url) = pair.get(1) { - if *url == server_short_name { - if let Some(protocol) = pair.first() { - if let Ok(protocol) = ServerProtocol::from_str(protocol) { - return Some(protocol); - } - } - } - } - } - } - None -} - -pub fn set_protocol_preference( - git_repo: &Repo, - protocol: &ServerProtocol, - server_url: &CloneUrl, - direction: &Direction, -) -> Result<()> { - let server_short_name = server_url.short_name(); - let mut new = String::new(); - if let Some(list) = - git_repo.get_git_config_item(format!("nostr.protocol-{direction}").as_str(), Some(false))? - { - for item in list.split(';') { - let pair = item.split(',').collect::>(); - if let Some(url) = pair.get(1) { - if *url != server_short_name && !item.is_empty() { - new.push_str(format!("{item};").as_str()); - } - } - } - } - new.push_str(format!("{protocol},{server_short_name};").as_str()); - - git_repo.save_git_config_item( - format!("nostr.protocol-{direction}").as_str(), - new.as_str(), - false, - ) -} - -pub fn error_might_be_authentication_related(error: &anyhow::Error) -> bool { - let error_str = error.to_string(); - for s in [ - "no ssh keys found", - "invalid or unknown remote ssh hostkey", - "authentication", - "Permission", - "permission", - "not found", - ] { - if error_str.contains(s) { - return true; - } - } - false -} - -#[cfg(test)] -mod tests { - use super::*; - mod join_with_and { - use super::*; - #[test] - fn test_empty() { - let items: Vec<&str> = vec![]; - assert_eq!(join_with_and(&items), ""); - } - - #[test] - fn test_single_item() { - let items = vec!["apple"]; - assert_eq!(join_with_and(&items), "apple"); - } - - #[test] - fn test_two_items() { - let items = vec!["apple", "banana"]; - assert_eq!(join_with_and(&items), "apple and banana"); - } - - #[test] - fn test_three_items() { - let items = vec!["apple", "banana", "cherry"]; - assert_eq!(join_with_and(&items), "apple, banana and cherry"); - } - - #[test] - fn test_four_items() { - let items = vec!["apple", "banana", "cherry", "date"]; - assert_eq!(join_with_and(&items), "apple, banana, cherry and date"); - } - - #[test] - fn test_multiple_items() { - let items = vec!["one", "two", "three", "four", "five"]; - assert_eq!(join_with_and(&items), "one, two, three, four and five"); - } - } -} -- cgit v1.2.3