use crate::{ json_log::LogRecord, protocol::{ message_len_from_buffer, read_message_with_len, write_message, MessageId, MESSAGE_LEN_SIZE, }, proxy::ProxyLaunchError, }; use anyhow::{anyhow, Context as _, Result}; use async_trait::async_trait; use collections::HashMap; use futures::{ channel::{ mpsc::{self, Sender, UnboundedReceiver, UnboundedSender}, oneshot, }, future::BoxFuture, select, select_biased, AsyncReadExt as _, Future, FutureExt as _, StreamExt as _, }; use gpui::{ AppContext, AsyncAppContext, Context, EventEmitter, Model, ModelContext, SemanticVersion, Task, WeakModel, }; use parking_lot::Mutex; use rpc::{ proto::{self, build_typed_envelope, Envelope, EnvelopedMessage, PeerId, RequestMessage}, AnyProtoClient, EntityMessageSubscriber, ProtoClient, ProtoMessageHandlerSet, RpcError, }; use smol::{ fs, process::{self, Child, Stdio}, }; use std::{ any::TypeId, collections::VecDeque, ffi::OsStr, fmt, ops::ControlFlow, path::{Path, PathBuf}, sync::{ atomic::{AtomicU32, Ordering::SeqCst}, Arc, Weak, }, time::{Duration, Instant, SystemTime, UNIX_EPOCH}, }; use tempfile::TempDir; use util::ResultExt; #[derive( Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, serde::Serialize, serde::Deserialize, )] pub struct SshProjectId(pub u64); #[derive(Clone)] pub struct SshSocket { connection_options: SshConnectionOptions, socket_path: PathBuf, } #[derive(Debug, Default, Clone, PartialEq, Eq)] pub struct SshConnectionOptions { pub host: String, pub username: Option, pub port: Option, pub password: Option, pub args: Option>, } impl SshConnectionOptions { pub fn parse_command_line(input: &str) -> Result { let input = input.trim_start_matches("ssh "); let mut hostname: Option = None; let mut username: Option = None; let mut port: Option = None; let mut args = Vec::new(); // disallowed: -E, -e, -F, -f, -G, -g, -M, -N, -n, -O, -q, -S, -s, -T, -t, -V, -v, -W const ALLOWED_OPTS: &[&str] = &[ "-4", "-6", "-A", "-a", "-C", "-K", "-k", "-X", "-x", "-Y", "-y", ]; const ALLOWED_ARGS: &[&str] = &[ "-B", "-b", "-c", "-D", "-I", "-i", "-J", "-L", "-l", "-m", "-o", "-P", "-p", "-R", "-w", ]; let mut tokens = shlex::split(input) .ok_or_else(|| anyhow!("invalid input"))? .into_iter(); 'outer: while let Some(arg) = tokens.next() { if ALLOWED_OPTS.contains(&(&arg as &str)) { args.push(arg.to_string()); continue; } if arg == "-p" { port = tokens.next().and_then(|arg| arg.parse().ok()); continue; } else if let Some(p) = arg.strip_prefix("-p") { port = p.parse().ok(); continue; } if arg == "-l" { username = tokens.next(); continue; } else if let Some(l) = arg.strip_prefix("-l") { username = Some(l.to_string()); continue; } for a in ALLOWED_ARGS { if arg == *a { args.push(arg); if let Some(next) = tokens.next() { args.push(next); } continue 'outer; } else if arg.starts_with(a) { args.push(arg); continue 'outer; } } if arg.starts_with("-") || hostname.is_some() { anyhow::bail!("unsupported argument: {:?}", arg); } let mut input = &arg as &str; if let Some((u, rest)) = input.split_once('@') { input = rest; username = Some(u.to_string()); } if let Some((rest, p)) = input.split_once(':') { input = rest; port = p.parse().ok() } hostname = Some(input.to_string()) } let Some(hostname) = hostname else { anyhow::bail!("missing hostname"); }; Ok(Self { host: hostname.to_string(), username: username.clone(), port, password: None, args: Some(args), }) } pub fn ssh_url(&self) -> String { let mut result = String::from("ssh://"); if let Some(username) = &self.username { result.push_str(username); result.push('@'); } result.push_str(&self.host); if let Some(port) = self.port { result.push(':'); result.push_str(&port.to_string()); } result } pub fn additional_args(&self) -> Option<&Vec> { self.args.as_ref() } fn scp_url(&self) -> String { if let Some(username) = &self.username { format!("{}@{}", username, self.host) } else { self.host.clone() } } pub fn connection_string(&self) -> String { let host = if let Some(username) = &self.username { format!("{}@{}", username, self.host) } else { self.host.clone() }; if let Some(port) = &self.port { format!("{}:{}", host, port) } else { host } } // Uniquely identifies dev server projects on a remote host. Needs to be // stable for the same dev server project. pub fn remote_server_identifier(&self) -> String { let mut identifier = format!("dev-server-{:?}", self.host); if let Some(username) = self.username.as_ref() { identifier.push('-'); identifier.push_str(&username); } identifier } } #[derive(Copy, Clone, Debug)] pub struct SshPlatform { pub os: &'static str, pub arch: &'static str, } impl SshPlatform { pub fn triple(&self) -> Option { Some(format!( "{}-{}", self.arch, match self.os { "linux" => "unknown-linux-gnu", "macos" => "apple-darwin", _ => return None, } )) } } pub enum ServerBinary { LocalBinary(PathBuf), ReleaseUrl { url: String, body: String }, } pub trait SshClientDelegate: Send + Sync { fn ask_password( &self, prompt: String, cx: &mut AsyncAppContext, ) -> oneshot::Receiver>; fn remote_server_binary_path( &self, platform: SshPlatform, cx: &mut AsyncAppContext, ) -> Result; fn get_server_binary( &self, platform: SshPlatform, cx: &mut AsyncAppContext, ) -> oneshot::Receiver>; fn set_status(&self, status: Option<&str>, cx: &mut AsyncAppContext); } impl SshSocket { fn ssh_command>(&self, program: S) -> process::Command { let mut command = process::Command::new("ssh"); self.ssh_options(&mut command) .arg(self.connection_options.ssh_url()) .arg(program); command } fn ssh_options<'a>(&self, command: &'a mut process::Command) -> &'a mut process::Command { command .stdin(Stdio::piped()) .stdout(Stdio::piped()) .stderr(Stdio::piped()) .args(["-o", "ControlMaster=no", "-o"]) .arg(format!("ControlPath={}", self.socket_path.display())) } fn ssh_args(&self) -> Vec { vec![ "-o".to_string(), "ControlMaster=no".to_string(), "-o".to_string(), format!("ControlPath={}", self.socket_path.display()), self.connection_options.ssh_url(), ] } } async fn run_cmd(command: &mut process::Command) -> Result { let output = command.output().await?; if output.status.success() { Ok(String::from_utf8_lossy(&output.stdout).to_string()) } else { Err(anyhow!( "failed to run command: {}", String::from_utf8_lossy(&output.stderr) )) } } const MAX_MISSED_HEARTBEATS: usize = 5; const HEARTBEAT_INTERVAL: Duration = Duration::from_secs(5); const HEARTBEAT_TIMEOUT: Duration = Duration::from_secs(5); const MAX_RECONNECT_ATTEMPTS: usize = 3; enum State { Connecting, Connected { ssh_connection: Box, delegate: Arc, multiplex_task: Task>, heartbeat_task: Task>, }, HeartbeatMissed { missed_heartbeats: usize, ssh_connection: Box, delegate: Arc, multiplex_task: Task>, heartbeat_task: Task>, }, Reconnecting, ReconnectFailed { ssh_connection: Box, delegate: Arc, error: anyhow::Error, attempts: usize, }, ReconnectExhausted, ServerNotRunning, } impl fmt::Display for State { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { Self::Connecting => write!(f, "connecting"), Self::Connected { .. } => write!(f, "connected"), Self::Reconnecting => write!(f, "reconnecting"), Self::ReconnectFailed { .. } => write!(f, "reconnect failed"), Self::ReconnectExhausted => write!(f, "reconnect exhausted"), Self::HeartbeatMissed { .. } => write!(f, "heartbeat missed"), Self::ServerNotRunning { .. } => write!(f, "server not running"), } } } impl State { fn ssh_connection(&self) -> Option<&dyn SshRemoteProcess> { match self { Self::Connected { ssh_connection, .. } => Some(ssh_connection.as_ref()), Self::HeartbeatMissed { ssh_connection, .. } => Some(ssh_connection.as_ref()), Self::ReconnectFailed { ssh_connection, .. } => Some(ssh_connection.as_ref()), _ => None, } } fn can_reconnect(&self) -> bool { match self { Self::Connected { .. } | Self::HeartbeatMissed { .. } | Self::ReconnectFailed { .. } => true, State::Connecting | State::Reconnecting | State::ReconnectExhausted | State::ServerNotRunning => false, } } fn is_reconnect_failed(&self) -> bool { matches!(self, Self::ReconnectFailed { .. }) } fn is_reconnect_exhausted(&self) -> bool { matches!(self, Self::ReconnectExhausted { .. }) } fn is_server_not_running(&self) -> bool { matches!(self, Self::ServerNotRunning) } fn is_reconnecting(&self) -> bool { matches!(self, Self::Reconnecting { .. }) } fn heartbeat_recovered(self) -> Self { match self { Self::HeartbeatMissed { ssh_connection, delegate, multiplex_task, heartbeat_task, .. } => Self::Connected { ssh_connection, delegate, multiplex_task, heartbeat_task, }, _ => self, } } fn heartbeat_missed(self) -> Self { match self { Self::Connected { ssh_connection, delegate, multiplex_task, heartbeat_task, } => Self::HeartbeatMissed { missed_heartbeats: 1, ssh_connection, delegate, multiplex_task, heartbeat_task, }, Self::HeartbeatMissed { missed_heartbeats, ssh_connection, delegate, multiplex_task, heartbeat_task, } => Self::HeartbeatMissed { missed_heartbeats: missed_heartbeats + 1, ssh_connection, delegate, multiplex_task, heartbeat_task, }, _ => self, } } } /// The state of the ssh connection. #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub enum ConnectionState { Connecting, Connected, HeartbeatMissed, Reconnecting, Disconnected, } impl From<&State> for ConnectionState { fn from(value: &State) -> Self { match value { State::Connecting => Self::Connecting, State::Connected { .. } => Self::Connected, State::Reconnecting | State::ReconnectFailed { .. } => Self::Reconnecting, State::HeartbeatMissed { .. } => Self::HeartbeatMissed, State::ReconnectExhausted => Self::Disconnected, State::ServerNotRunning => Self::Disconnected, } } } pub struct SshRemoteClient { client: Arc, unique_identifier: String, connection_options: SshConnectionOptions, state: Arc>>, } #[derive(Debug)] pub enum SshRemoteEvent { Disconnected, } impl EventEmitter for SshRemoteClient {} impl SshRemoteClient { pub fn new( unique_identifier: String, connection_options: SshConnectionOptions, cancellation: oneshot::Receiver<()>, delegate: Arc, cx: &AppContext, ) -> Task>>> { cx.spawn(|mut cx| async move { let success = Box::pin(async move { let (outgoing_tx, outgoing_rx) = mpsc::unbounded::(); let (incoming_tx, incoming_rx) = mpsc::unbounded::(); let (connection_activity_tx, connection_activity_rx) = mpsc::channel::<()>(1); let client = cx.update(|cx| ChannelClient::new(incoming_rx, outgoing_tx, cx, "client"))?; let this = cx.new_model(|_| Self { client: client.clone(), unique_identifier: unique_identifier.clone(), connection_options: connection_options.clone(), state: Arc::new(Mutex::new(Some(State::Connecting))), })?; let (ssh_connection, io_task) = Self::establish_connection( unique_identifier, false, connection_options, incoming_tx, outgoing_rx, connection_activity_tx, delegate.clone(), &mut cx, ) .await?; let multiplex_task = Self::monitor(this.downgrade(), io_task, &cx); if let Err(error) = client.ping(HEARTBEAT_TIMEOUT).await { log::error!("failed to establish connection: {}", error); return Err(error); } let heartbeat_task = Self::heartbeat(this.downgrade(), connection_activity_rx, &mut cx); this.update(&mut cx, |this, _| { *this.state.lock() = Some(State::Connected { ssh_connection, delegate, multiplex_task, heartbeat_task, }); })?; Ok(Some(this)) }); select! { _ = cancellation.fuse() => { Ok(None) } result = success.fuse() => result } }) } pub fn shutdown_processes( &self, shutdown_request: Option, ) -> Option> { let state = self.state.lock().take()?; log::info!("shutting down ssh processes"); let State::Connected { multiplex_task, heartbeat_task, ssh_connection, delegate, } = state else { return None; }; let client = self.client.clone(); Some(async move { if let Some(shutdown_request) = shutdown_request { client.send(shutdown_request).log_err(); // We wait 50ms instead of waiting for a response, because // waiting for a response would require us to wait on the main thread // which we want to avoid in an `on_app_quit` callback. smol::Timer::after(Duration::from_millis(50)).await; } // Drop `multiplex_task` because it owns our ssh_proxy_process, which is a // child of master_process. drop(multiplex_task); // Now drop the rest of state, which kills master process. drop(heartbeat_task); drop(ssh_connection); drop(delegate); }) } fn reconnect(&mut self, cx: &mut ModelContext) -> Result<()> { let mut lock = self.state.lock(); let can_reconnect = lock .as_ref() .map(|state| state.can_reconnect()) .unwrap_or(false); if !can_reconnect { let error = if let Some(state) = lock.as_ref() { format!("invalid state, cannot reconnect while in state {state}") } else { "no state set".to_string() }; log::info!("aborting reconnect, because not in state that allows reconnecting"); return Err(anyhow!(error)); } let state = lock.take().unwrap(); let (attempts, mut ssh_connection, delegate) = match state { State::Connected { ssh_connection, delegate, multiplex_task, heartbeat_task, } | State::HeartbeatMissed { ssh_connection, delegate, multiplex_task, heartbeat_task, .. } => { drop(multiplex_task); drop(heartbeat_task); (0, ssh_connection, delegate) } State::ReconnectFailed { attempts, ssh_connection, delegate, .. } => (attempts, ssh_connection, delegate), State::Connecting | State::Reconnecting | State::ReconnectExhausted | State::ServerNotRunning => unreachable!(), }; let attempts = attempts + 1; if attempts > MAX_RECONNECT_ATTEMPTS { log::error!( "Failed to reconnect to after {} attempts, giving up", MAX_RECONNECT_ATTEMPTS ); drop(lock); self.set_state(State::ReconnectExhausted, cx); return Ok(()); } drop(lock); self.set_state(State::Reconnecting, cx); log::info!("Trying to reconnect to ssh server... Attempt {}", attempts); let identifier = self.unique_identifier.clone(); let client = self.client.clone(); let reconnect_task = cx.spawn(|this, mut cx| async move { macro_rules! failed { ($error:expr, $attempts:expr, $ssh_connection:expr, $delegate:expr) => { return State::ReconnectFailed { error: anyhow!($error), attempts: $attempts, ssh_connection: $ssh_connection, delegate: $delegate, }; }; } if let Err(error) = ssh_connection .kill() .await .context("Failed to kill ssh process") { failed!(error, attempts, ssh_connection, delegate); }; let connection_options = ssh_connection.connection_options(); let (outgoing_tx, outgoing_rx) = mpsc::unbounded::(); let (incoming_tx, incoming_rx) = mpsc::unbounded::(); let (connection_activity_tx, connection_activity_rx) = mpsc::channel::<()>(1); let (ssh_connection, io_task) = match Self::establish_connection( identifier, true, connection_options, incoming_tx, outgoing_rx, connection_activity_tx, delegate.clone(), &mut cx, ) .await { Ok((ssh_connection, ssh_process)) => (ssh_connection, ssh_process), Err(error) => { failed!(error, attempts, ssh_connection, delegate); } }; let multiplex_task = Self::monitor(this.clone(), io_task, &cx); client.reconnect(incoming_rx, outgoing_tx, &cx); if let Err(error) = client.resync(HEARTBEAT_TIMEOUT).await { failed!(error, attempts, ssh_connection, delegate); }; State::Connected { ssh_connection, delegate, multiplex_task, heartbeat_task: Self::heartbeat(this.clone(), connection_activity_rx, &mut cx), } }); cx.spawn(|this, mut cx| async move { let new_state = reconnect_task.await; this.update(&mut cx, |this, cx| { this.try_set_state(cx, |old_state| { if old_state.is_reconnecting() { match &new_state { State::Connecting | State::Reconnecting { .. } | State::HeartbeatMissed { .. } | State::ServerNotRunning => {} State::Connected { .. } => { log::info!("Successfully reconnected"); } State::ReconnectFailed { error, attempts, .. } => { log::error!( "Reconnect attempt {} failed: {:?}. Starting new attempt...", attempts, error ); } State::ReconnectExhausted => { log::error!("Reconnect attempt failed and all attempts exhausted"); } } Some(new_state) } else { None } }); if this.state_is(State::is_reconnect_failed) { this.reconnect(cx) } else if this.state_is(State::is_reconnect_exhausted) { Ok(()) } else { log::debug!("State has transition from Reconnecting into new state while attempting reconnect."); Ok(()) } }) }) .detach_and_log_err(cx); Ok(()) } fn heartbeat( this: WeakModel, mut connection_activity_rx: mpsc::Receiver<()>, cx: &mut AsyncAppContext, ) -> Task> { let Ok(client) = this.update(cx, |this, _| this.client.clone()) else { return Task::ready(Err(anyhow!("SshRemoteClient lost"))); }; cx.spawn(|mut cx| { let this = this.clone(); async move { let mut missed_heartbeats = 0; let keepalive_timer = cx.background_executor().timer(HEARTBEAT_INTERVAL).fuse(); futures::pin_mut!(keepalive_timer); loop { select_biased! { result = connection_activity_rx.next().fuse() => { if result.is_none() { log::warn!("ssh heartbeat: connection activity channel has been dropped. stopping."); return Ok(()); } if missed_heartbeats != 0 { missed_heartbeats = 0; this.update(&mut cx, |this, mut cx| { this.handle_heartbeat_result(missed_heartbeats, &mut cx) })?; } } _ = keepalive_timer => { log::debug!("Sending heartbeat to server..."); let result = select_biased! { _ = connection_activity_rx.next().fuse() => { Ok(()) } ping_result = client.ping(HEARTBEAT_TIMEOUT).fuse() => { ping_result } }; if result.is_err() { missed_heartbeats += 1; log::warn!( "No heartbeat from server after {:?}. Missed heartbeat {} out of {}.", HEARTBEAT_TIMEOUT, missed_heartbeats, MAX_MISSED_HEARTBEATS ); } else if missed_heartbeats != 0 { missed_heartbeats = 0; } else { continue; } let result = this.update(&mut cx, |this, mut cx| { this.handle_heartbeat_result(missed_heartbeats, &mut cx) })?; if result.is_break() { return Ok(()); } } } keepalive_timer.set(cx.background_executor().timer(HEARTBEAT_INTERVAL).fuse()); } } }) } fn handle_heartbeat_result( &mut self, missed_heartbeats: usize, cx: &mut ModelContext, ) -> ControlFlow<()> { let state = self.state.lock().take().unwrap(); let next_state = if missed_heartbeats > 0 { state.heartbeat_missed() } else { state.heartbeat_recovered() }; self.set_state(next_state, cx); if missed_heartbeats >= MAX_MISSED_HEARTBEATS { log::error!( "Missed last {} heartbeats. Reconnecting...", missed_heartbeats ); self.reconnect(cx) .context("failed to start reconnect process after missing heartbeats") .log_err(); ControlFlow::Break(()) } else { ControlFlow::Continue(()) } } fn multiplex( mut ssh_proxy_process: Child, incoming_tx: UnboundedSender, mut outgoing_rx: UnboundedReceiver, mut connection_activity_tx: Sender<()>, cx: &AsyncAppContext, ) -> Task> { let mut child_stderr = ssh_proxy_process.stderr.take().unwrap(); let mut child_stdout = ssh_proxy_process.stdout.take().unwrap(); let mut child_stdin = ssh_proxy_process.stdin.take().unwrap(); let mut stdin_buffer = Vec::new(); let mut stdout_buffer = Vec::new(); let mut stderr_buffer = Vec::new(); let mut stderr_offset = 0; let stdin_task = cx.background_executor().spawn(async move { while let Some(outgoing) = outgoing_rx.next().await { write_message(&mut child_stdin, &mut stdin_buffer, outgoing).await?; } anyhow::Ok(()) }); let stdout_task = cx.background_executor().spawn({ let mut connection_activity_tx = connection_activity_tx.clone(); async move { loop { stdout_buffer.resize(MESSAGE_LEN_SIZE, 0); let len = child_stdout.read(&mut stdout_buffer).await?; if len == 0 { return anyhow::Ok(()); } if len < MESSAGE_LEN_SIZE { child_stdout.read_exact(&mut stdout_buffer[len..]).await?; } let message_len = message_len_from_buffer(&stdout_buffer); let envelope = read_message_with_len(&mut child_stdout, &mut stdout_buffer, message_len) .await?; connection_activity_tx.try_send(()).ok(); incoming_tx.unbounded_send(envelope).ok(); } } }); let stderr_task: Task> = cx.background_executor().spawn(async move { loop { stderr_buffer.resize(stderr_offset + 1024, 0); let len = child_stderr .read(&mut stderr_buffer[stderr_offset..]) .await?; if len == 0 { return anyhow::Ok(()); } stderr_offset += len; let mut start_ix = 0; while let Some(ix) = stderr_buffer[start_ix..stderr_offset] .iter() .position(|b| b == &b'\n') { let line_ix = start_ix + ix; let content = &stderr_buffer[start_ix..line_ix]; start_ix = line_ix + 1; if let Ok(record) = serde_json::from_slice::(content) { record.log(log::logger()) } else { eprintln!("(remote) {}", String::from_utf8_lossy(content)); } } stderr_buffer.drain(0..start_ix); stderr_offset -= start_ix; connection_activity_tx.try_send(()).ok(); } }); cx.spawn(|_| async move { let result = futures::select! { result = stdin_task.fuse() => { result.context("stdin") } result = stdout_task.fuse() => { result.context("stdout") } result = stderr_task.fuse() => { result.context("stderr") } }; let status = ssh_proxy_process.status().await?.code().unwrap_or(1); match result { Ok(_) => Ok(status), Err(error) => Err(error), } }) } fn monitor( this: WeakModel, io_task: Task>, cx: &AsyncAppContext, ) -> Task> { cx.spawn(|mut cx| async move { let result = io_task.await; match result { Ok(exit_code) => { if let Some(error) = ProxyLaunchError::from_exit_code(exit_code) { match error { ProxyLaunchError::ServerNotRunning => { log::error!("failed to reconnect because server is not running"); this.update(&mut cx, |this, cx| { this.set_state(State::ServerNotRunning, cx); })?; } } } else if exit_code > 0 { log::error!("proxy process terminated unexpectedly"); this.update(&mut cx, |this, cx| { this.reconnect(cx).ok(); })?; } } Err(error) => { log::warn!("ssh io task died with error: {:?}. reconnecting...", error); this.update(&mut cx, |this, cx| { this.reconnect(cx).ok(); })?; } } Ok(()) }) } fn state_is(&self, check: impl FnOnce(&State) -> bool) -> bool { self.state.lock().as_ref().map_or(false, check) } fn try_set_state( &self, cx: &mut ModelContext, map: impl FnOnce(&State) -> Option, ) { let mut lock = self.state.lock(); let new_state = lock.as_ref().and_then(map); if let Some(new_state) = new_state { lock.replace(new_state); cx.notify(); } } fn set_state(&self, state: State, cx: &mut ModelContext) { log::info!("setting state to '{}'", &state); let is_reconnect_exhausted = state.is_reconnect_exhausted(); let is_server_not_running = state.is_server_not_running(); self.state.lock().replace(state); if is_reconnect_exhausted || is_server_not_running { cx.emit(SshRemoteEvent::Disconnected); } cx.notify(); } #[allow(clippy::too_many_arguments)] async fn establish_connection( unique_identifier: String, reconnect: bool, connection_options: SshConnectionOptions, incoming_tx: UnboundedSender, outgoing_rx: UnboundedReceiver, connection_activity_tx: Sender<()>, delegate: Arc, cx: &mut AsyncAppContext, ) -> Result<(Box, Task>)> { #[cfg(any(test, feature = "test-support"))] if let Some(fake) = fake::SshRemoteConnection::new(&connection_options) { let io_task = fake::SshRemoteConnection::multiplex( fake.connection_options(), incoming_tx, outgoing_rx, connection_activity_tx, cx, ) .await; return Ok((fake, io_task)); } let ssh_connection = SshRemoteConnection::new(connection_options, delegate.clone(), cx).await?; let platform = ssh_connection.query_platform().await?; let remote_binary_path = delegate.remote_server_binary_path(platform, cx)?; if !reconnect { ssh_connection .ensure_server_binary(&delegate, &remote_binary_path, platform, cx) .await?; } let socket = ssh_connection.socket.clone(); run_cmd(socket.ssh_command(&remote_binary_path).arg("version")).await?; delegate.set_status(Some("Starting proxy"), cx); let mut start_proxy_command = format!( "RUST_LOG={} RUST_BACKTRACE={} {:?} proxy --identifier {}", std::env::var("RUST_LOG").unwrap_or_default(), std::env::var("RUST_BACKTRACE").unwrap_or_default(), remote_binary_path, unique_identifier, ); if reconnect { start_proxy_command.push_str(" --reconnect"); } let ssh_proxy_process = socket .ssh_command(start_proxy_command) // IMPORTANT: we kill this process when we drop the task that uses it. .kill_on_drop(true) .spawn() .context("failed to spawn remote server")?; let io_task = Self::multiplex( ssh_proxy_process, incoming_tx, outgoing_rx, connection_activity_tx, &cx, ); Ok((Box::new(ssh_connection), io_task)) } pub fn subscribe_to_entity(&self, remote_id: u64, entity: &Model) { self.client.subscribe_to_entity(remote_id, entity); } pub fn ssh_args(&self) -> Option> { self.state .lock() .as_ref() .and_then(|state| state.ssh_connection()) .map(|ssh_connection| ssh_connection.ssh_args()) } pub fn proto_client(&self) -> AnyProtoClient { self.client.clone().into() } pub fn connection_string(&self) -> String { self.connection_options.connection_string() } pub fn connection_options(&self) -> SshConnectionOptions { self.connection_options.clone() } pub fn connection_state(&self) -> ConnectionState { self.state .lock() .as_ref() .map(ConnectionState::from) .unwrap_or(ConnectionState::Disconnected) } pub fn is_disconnected(&self) -> bool { self.connection_state() == ConnectionState::Disconnected } #[cfg(any(test, feature = "test-support"))] pub fn simulate_disconnect(&self, client_cx: &mut AppContext) -> Task<()> { let port = self.connection_options().port.unwrap(); client_cx.spawn(|cx| async move { let (channel, server_cx) = cx .update_global(|c: &mut fake::ServerConnections, _| c.get(port)) .unwrap(); let (outgoing_tx, _) = mpsc::unbounded::(); let (_, incoming_rx) = mpsc::unbounded::(); channel.reconnect(incoming_rx, outgoing_tx, &server_cx); }) } #[cfg(any(test, feature = "test-support"))] pub fn fake_server( client_cx: &mut gpui::TestAppContext, server_cx: &mut gpui::TestAppContext, ) -> (u16, Arc) { use gpui::BorrowAppContext; let (outgoing_tx, _) = mpsc::unbounded::(); let (_, incoming_rx) = mpsc::unbounded::(); let server_client = server_cx.update(|cx| ChannelClient::new(incoming_rx, outgoing_tx, cx, "fake-server")); let port = client_cx.update(|cx| { cx.update_default_global(|c: &mut fake::ServerConnections, _| { c.push(server_client.clone(), server_cx.to_async()) }) }); (port, server_client) } #[cfg(any(test, feature = "test-support"))] pub async fn fake_client(port: u16, client_cx: &mut gpui::TestAppContext) -> Model { let (_tx, rx) = oneshot::channel(); client_cx .update(|cx| { Self::new( "fake".to_string(), SshConnectionOptions { host: "".to_string(), port: Some(port), ..Default::default() }, rx, Arc::new(fake::Delegate), cx, ) }) .await .unwrap() .unwrap() } } impl From for AnyProtoClient { fn from(client: SshRemoteClient) -> Self { AnyProtoClient::new(client.client.clone()) } } #[async_trait] trait SshRemoteProcess: Send + Sync { async fn kill(&mut self) -> Result<()>; fn ssh_args(&self) -> Vec; fn connection_options(&self) -> SshConnectionOptions; } struct SshRemoteConnection { socket: SshSocket, master_process: process::Child, _temp_dir: TempDir, } impl Drop for SshRemoteConnection { fn drop(&mut self) { if let Err(error) = self.master_process.kill() { log::error!("failed to kill SSH master process: {}", error); } } } #[async_trait] impl SshRemoteProcess for SshRemoteConnection { async fn kill(&mut self) -> Result<()> { self.master_process.kill()?; self.master_process.status().await?; Ok(()) } fn ssh_args(&self) -> Vec { self.socket.ssh_args() } fn connection_options(&self) -> SshConnectionOptions { self.socket.connection_options.clone() } } impl SshRemoteConnection { #[cfg(not(unix))] async fn new( _connection_options: SshConnectionOptions, _delegate: Arc, _cx: &mut AsyncAppContext, ) -> Result { Err(anyhow!("ssh is not supported on this platform")) } #[cfg(unix)] async fn new( connection_options: SshConnectionOptions, delegate: Arc, cx: &mut AsyncAppContext, ) -> Result { use futures::AsyncWriteExt as _; use futures::{io::BufReader, AsyncBufReadExt as _}; use smol::{fs::unix::PermissionsExt as _, net::unix::UnixListener}; use util::ResultExt as _; delegate.set_status(Some("Connecting"), cx); let url = connection_options.ssh_url(); let temp_dir = tempfile::Builder::new() .prefix("zed-ssh-session") .tempdir()?; // Create a domain socket listener to handle requests from the askpass program. let askpass_socket = temp_dir.path().join("askpass.sock"); let (askpass_opened_tx, askpass_opened_rx) = oneshot::channel::<()>(); let listener = UnixListener::bind(&askpass_socket).context("failed to create askpass socket")?; let askpass_task = cx.spawn({ let delegate = delegate.clone(); |mut cx| async move { let mut askpass_opened_tx = Some(askpass_opened_tx); while let Ok((mut stream, _)) = listener.accept().await { if let Some(askpass_opened_tx) = askpass_opened_tx.take() { askpass_opened_tx.send(()).ok(); } let mut buffer = Vec::new(); let mut reader = BufReader::new(&mut stream); if reader.read_until(b'\0', &mut buffer).await.is_err() { buffer.clear(); } let password_prompt = String::from_utf8_lossy(&buffer); if let Some(password) = delegate .ask_password(password_prompt.to_string(), &mut cx) .await .context("failed to get ssh password") .and_then(|p| p) .log_err() { stream.write_all(password.as_bytes()).await.log_err(); } } } }); // Create an askpass script that communicates back to this process. let askpass_script = format!( "{shebang}\n{print_args} | nc -U {askpass_socket} 2> /dev/null \n", askpass_socket = askpass_socket.display(), print_args = "printf '%s\\0' \"$@\"", shebang = "#!/bin/sh", ); let askpass_script_path = temp_dir.path().join("askpass.sh"); fs::write(&askpass_script_path, askpass_script).await?; fs::set_permissions(&askpass_script_path, std::fs::Permissions::from_mode(0o755)).await?; // Start the master SSH process, which does not do anything except for establish // the connection and keep it open, allowing other ssh commands to reuse it // via a control socket. let socket_path = temp_dir.path().join("ssh.sock"); let mut master_process = process::Command::new("ssh") .stdin(Stdio::null()) .stdout(Stdio::piped()) .stderr(Stdio::piped()) .env("SSH_ASKPASS_REQUIRE", "force") .env("SSH_ASKPASS", &askpass_script_path) .args(connection_options.additional_args().unwrap_or(&Vec::new())) .args([ "-N", "-o", "ControlPersist=no", "-o", "ControlMaster=yes", "-o", ]) .arg(format!("ControlPath={}", socket_path.display())) .arg(&url) .spawn()?; // Wait for this ssh process to close its stdout, indicating that authentication // has completed. let stdout = master_process.stdout.as_mut().unwrap(); let mut output = Vec::new(); let connection_timeout = Duration::from_secs(10); let result = select_biased! { _ = askpass_opened_rx.fuse() => { // If the askpass script has opened, that means the user is typing // their password, in which case we don't want to timeout anymore, // since we know a connection has been established. stdout.read_to_end(&mut output).await?; Ok(()) } result = stdout.read_to_end(&mut output).fuse() => { result?; Ok(()) } _ = futures::FutureExt::fuse(smol::Timer::after(connection_timeout)) => { Err(anyhow!("Exceeded {:?} timeout trying to connect to host", connection_timeout)) } }; if let Err(e) = result { return Err(e.context("Failed to connect to host")); } drop(askpass_task); if master_process.try_status()?.is_some() { output.clear(); let mut stderr = master_process.stderr.take().unwrap(); stderr.read_to_end(&mut output).await?; let error_message = format!( "failed to connect: {}", String::from_utf8_lossy(&output).trim() ); Err(anyhow!(error_message))?; } Ok(Self { socket: SshSocket { connection_options, socket_path, }, master_process, _temp_dir: temp_dir, }) } async fn ensure_server_binary( &self, delegate: &Arc, dst_path: &Path, platform: SshPlatform, cx: &mut AsyncAppContext, ) -> Result<()> { let lock_file = dst_path.with_extension("lock"); let timestamp = SystemTime::now() .duration_since(UNIX_EPOCH) .unwrap() .as_secs(); let lock_content = timestamp.to_string(); let lock_stale_age = Duration::from_secs(10 * 60); let max_wait_time = Duration::from_secs(10 * 60); let check_interval = Duration::from_secs(5); let start_time = Instant::now(); loop { let lock_acquired = self.create_lock_file(&lock_file, &lock_content).await?; if lock_acquired { let result = self .update_server_binary_if_needed(delegate, dst_path, platform, cx) .await; self.remove_lock_file(&lock_file).await.ok(); return result; } else { if let Ok(is_stale) = self.is_lock_stale(&lock_file, &lock_stale_age).await { if is_stale { self.remove_lock_file(&lock_file).await?; continue; } else { if start_time.elapsed() > max_wait_time { return Err(anyhow!("Timeout waiting for lock to be released")); } log::info!( "Found lockfile: {:?}. Will check again in {:?}", lock_file, check_interval ); delegate.set_status( Some("Waiting for another Zed instance to finish uploading binary"), cx, ); smol::Timer::after(check_interval).await; continue; } } else { // Unable to check lock, assume it's valid and wait if start_time.elapsed() > max_wait_time { return Err(anyhow!("Timeout waiting for lock to be released")); } smol::Timer::after(check_interval).await; continue; } } } } async fn create_lock_file(&self, lock_file: &Path, content: &str) -> Result { let parent_dir = lock_file .parent() .ok_or_else(|| anyhow!("Lock file path has no parent directory"))?; // Be mindful of the escaping here: we need to make sure that we have quotes // inside the string, so that `sh -c` gets a quoted string passed to it. let script = format!( "\"mkdir -p '{0}' && [ ! -f '{1}' ] && echo '{2}' > '{1}' && echo 'created' || echo 'exists'\"", parent_dir.display(), lock_file.display(), content ); let output = run_cmd(self.socket.ssh_command("sh").arg("-c").arg(&script)) .await .with_context(|| format!("failed to create a lock file at {:?}", lock_file))?; Ok(output.trim() == "created") } async fn is_lock_stale(&self, lock_file: &Path, max_age: &Duration) -> Result { let threshold = max_age.as_secs(); // Be mindful of the escaping here: we need to make sure that we have quotes // inside the string, so that `sh -c` gets a quoted string passed to it. let script = format!( "\"[ -f '{0}' ] && [ $(( $(date +%s) - $(date -r '{0}' +%s) )) -gt {1} ] && echo 'stale' || echo 'recent'\"", lock_file.display(), threshold ); let output = run_cmd(self.socket.ssh_command("sh").arg("-c").arg(script)) .await .with_context(|| { format!("failed to check whether lock file {:?} is stale", lock_file) })?; Ok(output.trim() == "stale") } async fn remove_lock_file(&self, lock_file: &Path) -> Result<()> { run_cmd(self.socket.ssh_command("rm").arg("-f").arg(lock_file)) .await .context("failed to remove lock file")?; Ok(()) } async fn update_server_binary_if_needed( &self, delegate: &Arc, dst_path: &Path, platform: SshPlatform, cx: &mut AsyncAppContext, ) -> Result<()> { if std::env::var("ZED_USE_CACHED_REMOTE_SERVER").is_ok() { if let Ok(installed_version) = run_cmd(self.socket.ssh_command(dst_path).arg("version")).await { log::info!("using cached server binary version {}", installed_version); return Ok(()); } } let (binary, version) = delegate.get_server_binary(platform, cx).await??; let mut server_binary_exists = false; if !server_binary_exists && cfg!(not(debug_assertions)) { if let Ok(installed_version) = run_cmd(self.socket.ssh_command(dst_path).arg("version")).await { if installed_version.trim() == version.to_string() { server_binary_exists = true; } log::info!("checked remote server binary for version. latest version: {}. remote server version: {}", version.to_string(), installed_version.trim()); } } if server_binary_exists { log::info!("remote development server already present",); return Ok(()); } match binary { ServerBinary::LocalBinary(src_path) => { self.upload_local_server_binary(&src_path, dst_path, delegate, cx) .await } ServerBinary::ReleaseUrl { url, body } => { self.download_binary_on_server(&url, &body, dst_path, delegate, cx) .await } } } async fn download_binary_on_server( &self, url: &str, body: &str, dst_path: &Path, delegate: &Arc, cx: &mut AsyncAppContext, ) -> Result<()> { let mut dst_path_gz = dst_path.to_path_buf(); dst_path_gz.set_extension("gz"); if let Some(parent) = dst_path.parent() { run_cmd(self.socket.ssh_command("mkdir").arg("-p").arg(parent)).await?; } delegate.set_status(Some("Downloading remote development server on host"), cx); let script = format!( r#" if command -v wget >/dev/null 2>&1; then wget --max-redirect=5 --method=GET --header="Content-Type: application/json" --body-data='{}' '{}' -O '{}' && echo "wget" elif command -v curl >/dev/null 2>&1; then curl -L -X GET -H "Content-Type: application/json" -d '{}' '{}' -o '{}' && echo "curl" else echo "Neither curl nor wget is available" >&2 exit 1 fi "#, body.replace("'", r#"\'"#), url, dst_path_gz.display(), body.replace("'", r#"\'"#), url, dst_path_gz.display(), ); let output = run_cmd(self.socket.ssh_command("bash").arg("-c").arg(script)) .await .context("Failed to download server binary")?; if !output.contains("curl") && !output.contains("wget") { return Err(anyhow!("Failed to download server binary: {}", output)); } self.extract_server_binary(dst_path, &dst_path_gz, delegate, cx) .await } async fn upload_local_server_binary( &self, src_path: &Path, dst_path: &Path, delegate: &Arc, cx: &mut AsyncAppContext, ) -> Result<()> { let mut dst_path_gz = dst_path.to_path_buf(); dst_path_gz.set_extension("gz"); if let Some(parent) = dst_path.parent() { run_cmd(self.socket.ssh_command("mkdir").arg("-p").arg(parent)).await?; } let src_stat = fs::metadata(&src_path).await?; let size = src_stat.len(); let t0 = Instant::now(); delegate.set_status(Some("Uploading remote development server"), cx); log::info!("uploading remote development server ({}kb)", size / 1024); self.upload_file(&src_path, &dst_path_gz) .await .context("failed to upload server binary")?; log::info!("uploaded remote development server in {:?}", t0.elapsed()); self.extract_server_binary(dst_path, &dst_path_gz, delegate, cx) .await } async fn extract_server_binary( &self, dst_path: &Path, dst_path_gz: &Path, delegate: &Arc, cx: &mut AsyncAppContext, ) -> Result<()> { delegate.set_status(Some("Extracting remote development server"), cx); run_cmd( self.socket .ssh_command("gunzip") .arg("--force") .arg(&dst_path_gz), ) .await?; let server_mode = 0o755; delegate.set_status(Some("Marking remote development server executable"), cx); run_cmd( self.socket .ssh_command("chmod") .arg(format!("{:o}", server_mode)) .arg(dst_path), ) .await?; Ok(()) } async fn query_platform(&self) -> Result { let os = run_cmd(self.socket.ssh_command("uname").arg("-s")).await?; let arch = run_cmd(self.socket.ssh_command("uname").arg("-m")).await?; let os = match os.trim() { "Darwin" => "macos", "Linux" => "linux", _ => Err(anyhow!("unknown uname os {os:?}"))?, }; let arch = if arch.starts_with("arm") || arch.starts_with("aarch64") { "aarch64" } else if arch.starts_with("x86") || arch.starts_with("i686") { "x86_64" } else { Err(anyhow!("unknown uname architecture {arch:?}"))? }; Ok(SshPlatform { os, arch }) } async fn upload_file(&self, src_path: &Path, dest_path: &Path) -> Result<()> { let mut command = process::Command::new("scp"); let output = self .socket .ssh_options(&mut command) .args( self.socket .connection_options .port .map(|port| vec!["-P".to_string(), port.to_string()]) .unwrap_or_default(), ) .arg(src_path) .arg(format!( "{}:{}", self.socket.connection_options.scp_url(), dest_path.display() )) .output() .await?; if output.status.success() { Ok(()) } else { Err(anyhow!( "failed to upload file {} -> {}: {}", src_path.display(), dest_path.display(), String::from_utf8_lossy(&output.stderr) )) } } } type ResponseChannels = Mutex)>>>; pub struct ChannelClient { next_message_id: AtomicU32, outgoing_tx: Mutex>, buffer: Mutex>, response_channels: ResponseChannels, message_handlers: Mutex, max_received: AtomicU32, name: &'static str, task: Mutex>>, } impl ChannelClient { pub fn new( incoming_rx: mpsc::UnboundedReceiver, outgoing_tx: mpsc::UnboundedSender, cx: &AppContext, name: &'static str, ) -> Arc { Arc::new_cyclic(|this| Self { outgoing_tx: Mutex::new(outgoing_tx), next_message_id: AtomicU32::new(0), max_received: AtomicU32::new(0), response_channels: ResponseChannels::default(), message_handlers: Default::default(), buffer: Mutex::new(VecDeque::new()), name, task: Mutex::new(Self::start_handling_messages( this.clone(), incoming_rx, &cx.to_async(), )), }) } fn start_handling_messages( this: Weak, mut incoming_rx: mpsc::UnboundedReceiver, cx: &AsyncAppContext, ) -> Task> { cx.spawn(|cx| { async move { let peer_id = PeerId { owner_id: 0, id: 0 }; while let Some(incoming) = incoming_rx.next().await { let Some(this) = this.upgrade() else { return anyhow::Ok(()); }; if let Some(ack_id) = incoming.ack_id { let mut buffer = this.buffer.lock(); while buffer.front().is_some_and(|msg| msg.id <= ack_id) { buffer.pop_front(); } } if let Some(proto::envelope::Payload::FlushBufferedMessages(_)) = &incoming.payload { log::debug!("{}:ssh message received. name:FlushBufferedMessages", this.name); { let buffer = this.buffer.lock(); for envelope in buffer.iter() { this.outgoing_tx.lock().unbounded_send(envelope.clone()).ok(); } } let mut envelope = proto::Ack{}.into_envelope(0, Some(incoming.id), None); envelope.id = this.next_message_id.fetch_add(1, SeqCst); this.outgoing_tx.lock().unbounded_send(envelope).ok(); continue; } this.max_received.store(incoming.id, SeqCst); if let Some(request_id) = incoming.responding_to { let request_id = MessageId(request_id); let sender = this.response_channels.lock().remove(&request_id); if let Some(sender) = sender { let (tx, rx) = oneshot::channel(); if incoming.payload.is_some() { sender.send((incoming, tx)).ok(); } rx.await.ok(); } } else if let Some(envelope) = build_typed_envelope(peer_id, Instant::now(), incoming) { let type_name = envelope.payload_type_name(); if let Some(future) = ProtoMessageHandlerSet::handle_message( &this.message_handlers, envelope, this.clone().into(), cx.clone(), ) { log::debug!("{}:ssh message received. name:{type_name}", this.name); cx.foreground_executor().spawn(async move { match future.await { Ok(_) => { log::debug!("{}:ssh message handled. name:{type_name}", this.name); } Err(error) => { log::error!( "{}:error handling message. type:{type_name}, error:{error}", this.name, ); } } }).detach() } else { log::error!("{}:unhandled ssh message name:{type_name}", this.name); } } } anyhow::Ok(()) } }) } pub fn reconnect( self: &Arc, incoming_rx: UnboundedReceiver, outgoing_tx: UnboundedSender, cx: &AsyncAppContext, ) { *self.outgoing_tx.lock() = outgoing_tx; *self.task.lock() = Self::start_handling_messages(Arc::downgrade(self), incoming_rx, cx); } pub fn subscribe_to_entity(&self, remote_id: u64, entity: &Model) { let id = (TypeId::of::(), remote_id); let mut message_handlers = self.message_handlers.lock(); if message_handlers .entities_by_type_and_remote_id .contains_key(&id) { panic!("already subscribed to entity"); } message_handlers.entities_by_type_and_remote_id.insert( id, EntityMessageSubscriber::Entity { handle: entity.downgrade().into(), }, ); } pub fn request( &self, payload: T, ) -> impl 'static + Future> { self.request_internal(payload, true) } fn request_internal( &self, payload: T, use_buffer: bool, ) -> impl 'static + Future> { log::debug!("ssh request start. name:{}", T::NAME); let response = self.request_dynamic(payload.into_envelope(0, None, None), T::NAME, use_buffer); async move { let response = response.await?; log::debug!("ssh request finish. name:{}", T::NAME); T::Response::from_envelope(response) .ok_or_else(|| anyhow!("received a response of the wrong type")) } } pub async fn resync(&self, timeout: Duration) -> Result<()> { smol::future::or( async { self.request_internal(proto::FlushBufferedMessages {}, false) .await?; for envelope in self.buffer.lock().iter() { self.outgoing_tx .lock() .unbounded_send(envelope.clone()) .ok(); } Ok(()) }, async { smol::Timer::after(timeout).await; Err(anyhow!("Timeout detected")) }, ) .await } pub async fn ping(&self, timeout: Duration) -> Result<()> { smol::future::or( async { self.request(proto::Ping {}).await?; Ok(()) }, async { smol::Timer::after(timeout).await; Err(anyhow!("Timeout detected")) }, ) .await } pub fn send(&self, payload: T) -> Result<()> { log::debug!("ssh send name:{}", T::NAME); self.send_dynamic(payload.into_envelope(0, None, None)) } fn request_dynamic( &self, mut envelope: proto::Envelope, type_name: &'static str, use_buffer: bool, ) -> impl 'static + Future> { envelope.id = self.next_message_id.fetch_add(1, SeqCst); let (tx, rx) = oneshot::channel(); let mut response_channels_lock = self.response_channels.lock(); response_channels_lock.insert(MessageId(envelope.id), tx); drop(response_channels_lock); let result = if use_buffer { self.send_buffered(envelope) } else { self.send_unbuffered(envelope) }; async move { if let Err(error) = &result { log::error!("failed to send message: {}", error); return Err(anyhow!("failed to send message: {}", error)); } let response = rx.await.context("connection lost")?.0; if let Some(proto::envelope::Payload::Error(error)) = &response.payload { return Err(RpcError::from_proto(error, type_name)); } Ok(response) } } pub fn send_dynamic(&self, mut envelope: proto::Envelope) -> Result<()> { envelope.id = self.next_message_id.fetch_add(1, SeqCst); self.send_buffered(envelope) } fn send_buffered(&self, mut envelope: proto::Envelope) -> Result<()> { envelope.ack_id = Some(self.max_received.load(SeqCst)); self.buffer.lock().push_back(envelope.clone()); // ignore errors on send (happen while we're reconnecting) // assume that the global "disconnected" overlay is sufficient. self.outgoing_tx.lock().unbounded_send(envelope).ok(); Ok(()) } fn send_unbuffered(&self, mut envelope: proto::Envelope) -> Result<()> { envelope.ack_id = Some(self.max_received.load(SeqCst)); self.outgoing_tx.lock().unbounded_send(envelope).ok(); Ok(()) } } impl ProtoClient for ChannelClient { fn request( &self, envelope: proto::Envelope, request_type: &'static str, ) -> BoxFuture<'static, Result> { self.request_dynamic(envelope, request_type, true).boxed() } fn send(&self, envelope: proto::Envelope, _message_type: &'static str) -> Result<()> { self.send_dynamic(envelope) } fn send_response(&self, envelope: Envelope, _message_type: &'static str) -> anyhow::Result<()> { self.send_dynamic(envelope) } fn message_handler_set(&self) -> &Mutex { &self.message_handlers } fn is_via_collab(&self) -> bool { false } } #[cfg(any(test, feature = "test-support"))] mod fake { use std::{path::PathBuf, sync::Arc}; use anyhow::Result; use async_trait::async_trait; use futures::{ channel::{ mpsc::{self, Sender}, oneshot, }, select_biased, FutureExt, SinkExt, StreamExt, }; use gpui::{AsyncAppContext, BorrowAppContext, Global, SemanticVersion, Task}; use rpc::proto::Envelope; use super::{ ChannelClient, ServerBinary, SshClientDelegate, SshConnectionOptions, SshPlatform, SshRemoteProcess, }; pub(super) struct SshRemoteConnection { connection_options: SshConnectionOptions, } impl SshRemoteConnection { pub(super) fn new( connection_options: &SshConnectionOptions, ) -> Option> { if connection_options.host == "" { return Some(Box::new(Self { connection_options: connection_options.clone(), })); } return None; } pub(super) async fn multiplex( connection_options: SshConnectionOptions, mut client_incoming_tx: mpsc::UnboundedSender, mut client_outgoing_rx: mpsc::UnboundedReceiver, mut connection_activity_tx: Sender<()>, cx: &mut AsyncAppContext, ) -> Task> { let (mut server_incoming_tx, server_incoming_rx) = mpsc::unbounded::(); let (server_outgoing_tx, mut server_outgoing_rx) = mpsc::unbounded::(); let (channel, server_cx) = cx .update(|cx| { cx.update_global(|conns: &mut ServerConnections, _| { conns.get(connection_options.port.unwrap()) }) }) .unwrap(); channel.reconnect(server_incoming_rx, server_outgoing_tx, &server_cx); // send to proxy_tx to get to the server. // receive from cx.background_executor().spawn(async move { loop { select_biased! { server_to_client = server_outgoing_rx.next().fuse() => { let Some(server_to_client) = server_to_client else { return Ok(1) }; connection_activity_tx.try_send(()).ok(); client_incoming_tx.send(server_to_client).await.ok(); } client_to_server = client_outgoing_rx.next().fuse() => { let Some(client_to_server) = client_to_server else { return Ok(1) }; server_incoming_tx.send(client_to_server).await.ok(); } } } }) } } #[async_trait] impl SshRemoteProcess for SshRemoteConnection { async fn kill(&mut self) -> Result<()> { Ok(()) } fn ssh_args(&self) -> Vec { Vec::new() } fn connection_options(&self) -> SshConnectionOptions { self.connection_options.clone() } } #[derive(Default)] pub(super) struct ServerConnections(Vec<(Arc, AsyncAppContext)>); impl Global for ServerConnections {} impl ServerConnections { pub(super) fn push(&mut self, server: Arc, cx: AsyncAppContext) -> u16 { self.0.push((server.clone(), cx)); self.0.len() as u16 - 1 } pub(super) fn get(&mut self, port: u16) -> (Arc, AsyncAppContext) { self.0 .get(port as usize) .expect("no fake server for port") .clone() } } pub(super) struct Delegate; impl SshClientDelegate for Delegate { fn ask_password( &self, _: String, _: &mut AsyncAppContext, ) -> oneshot::Receiver> { unreachable!() } fn remote_server_binary_path( &self, _: SshPlatform, _: &mut AsyncAppContext, ) -> Result { unreachable!() } fn get_server_binary( &self, _: SshPlatform, _: &mut AsyncAppContext, ) -> oneshot::Receiver> { unreachable!() } fn set_status(&self, _: Option<&str>, _: &mut AsyncAppContext) { unreachable!() } } }