1use crate::HeadlessProject;
2use crate::headless_project::HeadlessAppState;
3use anyhow::{Context as _, Result, anyhow};
4use client::{ProjectId, ProxySettings};
5use collections::HashMap;
6use project::trusted_worktrees;
7use util::ResultExt;
8
9use extension::ExtensionHostProxy;
10use fs::{Fs, RealFs};
11use futures::channel::{mpsc, oneshot};
12use futures::{AsyncRead, AsyncWrite, AsyncWriteExt, FutureExt, SinkExt, select, select_biased};
13use git::GitHostingProviderRegistry;
14use gpui::{App, AppContext as _, Context, Entity, UpdateGlobal as _};
15use gpui_tokio::Tokio;
16use http_client::{Url, read_proxy_from_env};
17use language::LanguageRegistry;
18use node_runtime::{NodeBinaryOptions, NodeRuntime};
19use paths::logs_dir;
20use project::project_settings::ProjectSettings;
21use util::command::new_smol_command;
22
23use proto::CrashReport;
24use release_channel::{AppCommitSha, AppVersion, RELEASE_CHANNEL, ReleaseChannel};
25use remote::RemoteClient;
26use remote::{
27 json_log::LogRecord,
28 protocol::{read_message, write_message},
29 proxy::ProxyLaunchError,
30};
31use reqwest_client::ReqwestClient;
32use rpc::proto::{self, Envelope, REMOTE_SERVER_PROJECT_ID};
33use rpc::{AnyProtoClient, TypedEnvelope};
34use settings::{Settings, SettingsStore, watch_config_file};
35
36use smol::channel::{Receiver, Sender};
37use smol::io::AsyncReadExt;
38use smol::{net::unix::UnixListener, stream::StreamExt as _};
39use std::{
40 env,
41 ffi::OsStr,
42 fs::File,
43 io::Write,
44 mem,
45 ops::ControlFlow,
46 path::{Path, PathBuf},
47 process::ExitStatus,
48 str::FromStr,
49 sync::{Arc, LazyLock},
50};
51use thiserror::Error;
52
53pub static VERSION: LazyLock<String> = LazyLock::new(|| match *RELEASE_CHANNEL {
54 ReleaseChannel::Stable | ReleaseChannel::Preview => env!("ZED_PKG_VERSION").to_owned(),
55 ReleaseChannel::Nightly | ReleaseChannel::Dev => {
56 let commit_sha = option_env!("ZED_COMMIT_SHA").unwrap_or("missing-zed-commit-sha");
57 let build_identifier = option_env!("ZED_BUILD_ID");
58 if let Some(build_id) = build_identifier {
59 format!("{build_id}+{commit_sha}")
60 } else {
61 commit_sha.to_owned()
62 }
63 }
64});
65
66fn init_logging_proxy() {
67 env_logger::builder()
68 .format(|buf, record| {
69 let mut log_record = LogRecord::new(record);
70 log_record.message =
71 std::borrow::Cow::Owned(format!("(remote proxy) {}", log_record.message));
72 serde_json::to_writer(&mut *buf, &log_record)?;
73 buf.write_all(b"\n")?;
74 Ok(())
75 })
76 .init();
77}
78
79fn init_logging_server(log_file_path: &Path) -> Result<Receiver<Vec<u8>>> {
80 struct MultiWrite {
81 file: File,
82 channel: Sender<Vec<u8>>,
83 buffer: Vec<u8>,
84 }
85
86 impl Write for MultiWrite {
87 fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
88 let written = self.file.write(buf)?;
89 self.buffer.extend_from_slice(&buf[..written]);
90 Ok(written)
91 }
92
93 fn flush(&mut self) -> std::io::Result<()> {
94 self.channel
95 .send_blocking(self.buffer.clone())
96 .map_err(std::io::Error::other)?;
97 self.buffer.clear();
98 self.file.flush()
99 }
100 }
101
102 let log_file = std::fs::OpenOptions::new()
103 .create(true)
104 .append(true)
105 .open(log_file_path)
106 .context("Failed to open log file in append mode")?;
107
108 let (tx, rx) = smol::channel::unbounded();
109
110 let target = Box::new(MultiWrite {
111 file: log_file,
112 channel: tx,
113 buffer: Vec::new(),
114 });
115
116 let old_hook = std::panic::take_hook();
117 std::panic::set_hook(Box::new(move |info| {
118 let backtrace = std::backtrace::Backtrace::force_capture();
119 let message = info.payload_as_str().unwrap_or("Box<Any>").to_owned();
120 let location = info
121 .location()
122 .map_or_else(|| "<unknown>".to_owned(), |location| location.to_string());
123 let current_thread = std::thread::current();
124 let thread_name = current_thread.name().unwrap_or("<unnamed>");
125
126 let msg = format!("thread '{thread_name}' panicked at {location}:\n{message}\n{backtrace}");
127 // NOTE: This log never reaches the client, as the communication is handled on a main thread task
128 // which will never run once we panic.
129 log::error!("{msg}");
130 old_hook(info);
131 }));
132 env_logger::Builder::new()
133 .filter_level(log::LevelFilter::Info)
134 .parse_default_env()
135 .target(env_logger::Target::Pipe(target))
136 .format(|buf, record| {
137 let mut log_record = LogRecord::new(record);
138 log_record.message =
139 std::borrow::Cow::Owned(format!("(remote server) {}", log_record.message));
140 serde_json::to_writer(&mut *buf, &log_record)?;
141 buf.write_all(b"\n")?;
142 Ok(())
143 })
144 .init();
145
146 Ok(rx)
147}
148
149fn handle_crash_files_requests(project: &Entity<HeadlessProject>, client: &AnyProtoClient) {
150 client.add_request_handler(
151 project.downgrade(),
152 |_, _: TypedEnvelope<proto::GetCrashFiles>, _cx| async move {
153 let mut legacy_panics = Vec::new();
154 let mut crashes = Vec::new();
155 let mut children = smol::fs::read_dir(paths::logs_dir()).await?;
156 while let Some(child) = children.next().await {
157 let child = child?;
158 let child_path = child.path();
159
160 let extension = child_path.extension();
161 if extension == Some(OsStr::new("panic")) {
162 let filename = if let Some(filename) = child_path.file_name() {
163 filename.to_string_lossy()
164 } else {
165 continue;
166 };
167
168 if !filename.starts_with("zed") {
169 continue;
170 }
171
172 let file_contents = smol::fs::read_to_string(&child_path)
173 .await
174 .context("error reading panic file")?;
175
176 legacy_panics.push(file_contents);
177 smol::fs::remove_file(&child_path)
178 .await
179 .context("error removing panic")
180 .log_err();
181 } else if extension == Some(OsStr::new("dmp")) {
182 let mut json_path = child_path.clone();
183 json_path.set_extension("json");
184 if let Ok(json_content) = smol::fs::read_to_string(&json_path).await {
185 crashes.push(CrashReport {
186 metadata: json_content,
187 minidump_contents: smol::fs::read(&child_path).await?,
188 });
189 smol::fs::remove_file(&child_path).await.log_err();
190 smol::fs::remove_file(&json_path).await.log_err();
191 } else {
192 log::error!("Couldn't find json metadata for crash: {child_path:?}");
193 }
194 }
195 }
196
197 anyhow::Ok(proto::GetCrashFilesResponse { crashes })
198 },
199 );
200}
201
202struct ServerListeners {
203 stdin: UnixListener,
204 stdout: UnixListener,
205 stderr: UnixListener,
206}
207
208impl ServerListeners {
209 pub fn new(stdin_path: PathBuf, stdout_path: PathBuf, stderr_path: PathBuf) -> Result<Self> {
210 Ok(Self {
211 stdin: UnixListener::bind(stdin_path).context("failed to bind stdin socket")?,
212 stdout: UnixListener::bind(stdout_path).context("failed to bind stdout socket")?,
213 stderr: UnixListener::bind(stderr_path).context("failed to bind stderr socket")?,
214 })
215 }
216}
217
218fn start_server(
219 listeners: ServerListeners,
220 log_rx: Receiver<Vec<u8>>,
221 cx: &mut App,
222 is_wsl_interop: bool,
223) -> AnyProtoClient {
224 // This is the server idle timeout. If no connection comes in this timeout, the server will shut down.
225 const IDLE_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(6);
226
227 let (incoming_tx, incoming_rx) = mpsc::unbounded::<Envelope>();
228 let (outgoing_tx, mut outgoing_rx) = mpsc::unbounded::<Envelope>();
229 let (app_quit_tx, mut app_quit_rx) = mpsc::unbounded::<()>();
230
231 cx.on_app_quit(move |_| {
232 let mut app_quit_tx = app_quit_tx.clone();
233 async move {
234 log::info!("app quitting. sending signal to server main loop");
235 app_quit_tx.send(()).await.ok();
236 }
237 })
238 .detach();
239
240 cx.spawn(async move |cx| {
241 let mut stdin_incoming = listeners.stdin.incoming();
242 let mut stdout_incoming = listeners.stdout.incoming();
243 let mut stderr_incoming = listeners.stderr.incoming();
244
245 loop {
246 let streams = futures::future::join3(stdin_incoming.next(), stdout_incoming.next(), stderr_incoming.next());
247
248 log::info!("accepting new connections");
249 let result = select! {
250 streams = streams.fuse() => {
251 let (Some(Ok(stdin_stream)), Some(Ok(stdout_stream)), Some(Ok(stderr_stream))) = streams else {
252 log::error!("failed to accept new connections");
253 break;
254 };
255 log::info!("accepted new connections");
256 anyhow::Ok((stdin_stream, stdout_stream, stderr_stream))
257 }
258 _ = futures::FutureExt::fuse(cx.background_executor().timer(IDLE_TIMEOUT)) => {
259 log::warn!("timed out waiting for new connections after {:?}. exiting.", IDLE_TIMEOUT);
260 cx.update(|cx| {
261 // TODO: This is a hack, because in a headless project, shutdown isn't executed
262 // when calling quit, but it should be.
263 cx.shutdown();
264 cx.quit();
265 });
266 break;
267 }
268 _ = app_quit_rx.next().fuse() => {
269 log::info!("app quit requested");
270 break;
271 }
272 };
273
274 let Ok((mut stdin_stream, mut stdout_stream, mut stderr_stream)) = result else {
275 break;
276 };
277
278 let mut input_buffer = Vec::new();
279 let mut output_buffer = Vec::new();
280
281 let (mut stdin_msg_tx, mut stdin_msg_rx) = mpsc::unbounded::<Envelope>();
282 cx.background_spawn(async move {
283 while let Ok(msg) = read_message(&mut stdin_stream, &mut input_buffer).await {
284 if (stdin_msg_tx.send(msg).await).is_err() {
285 break;
286 }
287 }
288 }).detach();
289
290 loop {
291
292 select_biased! {
293 _ = app_quit_rx.next().fuse() => {
294 return anyhow::Ok(());
295 }
296
297 stdin_message = stdin_msg_rx.next().fuse() => {
298 let Some(message) = stdin_message else {
299 log::warn!("error reading message on stdin. exiting.");
300 break;
301 };
302 if let Err(error) = incoming_tx.unbounded_send(message) {
303 log::error!("failed to send message to application: {error:?}. exiting.");
304 return Err(anyhow!(error));
305 }
306 }
307
308 outgoing_message = outgoing_rx.next().fuse() => {
309 let Some(message) = outgoing_message else {
310 log::error!("stdout handler, no message");
311 break;
312 };
313
314 if let Err(error) =
315 write_message(&mut stdout_stream, &mut output_buffer, message).await
316 {
317 log::error!("failed to write stdout message: {:?}", error);
318 break;
319 }
320 if let Err(error) = stdout_stream.flush().await {
321 log::error!("failed to flush stdout message: {:?}", error);
322 break;
323 }
324 }
325
326 log_message = log_rx.recv().fuse() => {
327 if let Ok(log_message) = log_message {
328 if let Err(error) = stderr_stream.write_all(&log_message).await {
329 log::error!("failed to write log message to stderr: {:?}", error);
330 break;
331 }
332 if let Err(error) = stderr_stream.flush().await {
333 log::error!("failed to flush stderr stream: {:?}", error);
334 break;
335 }
336 }
337 }
338 }
339 }
340 }
341 anyhow::Ok(())
342 })
343 .detach();
344
345 RemoteClient::proto_client_from_channels(incoming_rx, outgoing_tx, cx, "server", is_wsl_interop)
346}
347
348fn init_paths() -> anyhow::Result<()> {
349 for path in [
350 paths::config_dir(),
351 paths::extensions_dir(),
352 paths::languages_dir(),
353 paths::logs_dir(),
354 paths::temp_dir(),
355 paths::hang_traces_dir(),
356 paths::remote_extensions_dir(),
357 paths::remote_extensions_uploads_dir(),
358 ]
359 .iter()
360 {
361 std::fs::create_dir_all(path).with_context(|| format!("creating directory {path:?}"))?;
362 }
363 Ok(())
364}
365
366pub fn execute_run(
367 log_file: PathBuf,
368 pid_file: PathBuf,
369 stdin_socket: PathBuf,
370 stdout_socket: PathBuf,
371 stderr_socket: PathBuf,
372) -> Result<()> {
373 init_paths()?;
374
375 match daemonize()? {
376 ControlFlow::Break(_) => return Ok(()),
377 ControlFlow::Continue(_) => {}
378 }
379
380 let app = gpui::Application::headless();
381 let id = std::process::id().to_string();
382 app.background_executor()
383 .spawn(crashes::init(crashes::InitCrashHandler {
384 session_id: id,
385 zed_version: VERSION.to_owned(),
386 binary: "zed-remote-server".to_string(),
387 release_channel: release_channel::RELEASE_CHANNEL_NAME.clone(),
388 commit_sha: option_env!("ZED_COMMIT_SHA").unwrap_or("no_sha").to_owned(),
389 }))
390 .detach();
391 let log_rx = init_logging_server(&log_file)?;
392 log::info!(
393 "starting up. pid_file: {:?}, log_file: {:?}, stdin_socket: {:?}, stdout_socket: {:?}, stderr_socket: {:?}",
394 pid_file,
395 log_file,
396 stdin_socket,
397 stdout_socket,
398 stderr_socket
399 );
400
401 write_pid_file(&pid_file)
402 .with_context(|| format!("failed to write pid file: {:?}", &pid_file))?;
403
404 let listeners = ServerListeners::new(stdin_socket, stdout_socket, stderr_socket)?;
405
406 rayon::ThreadPoolBuilder::new()
407 .num_threads(std::thread::available_parallelism().map_or(1, |n| n.get().div_ceil(2)))
408 .stack_size(10 * 1024 * 1024)
409 .thread_name(|ix| format!("RayonWorker{}", ix))
410 .build_global()
411 .unwrap();
412
413 let (shell_env_loaded_tx, shell_env_loaded_rx) = oneshot::channel();
414 app.background_executor()
415 .spawn(async {
416 util::load_login_shell_environment().await.log_err();
417 shell_env_loaded_tx.send(()).ok();
418 })
419 .detach();
420
421 let git_hosting_provider_registry = Arc::new(GitHostingProviderRegistry::new());
422 let run = move |cx: &mut _| {
423 settings::init(cx);
424 let app_commit_sha = option_env!("ZED_COMMIT_SHA").map(|s| AppCommitSha::new(s.to_owned()));
425 let app_version = AppVersion::load(
426 env!("ZED_PKG_VERSION"),
427 option_env!("ZED_BUILD_ID"),
428 app_commit_sha,
429 );
430 release_channel::init(app_version, cx);
431 gpui_tokio::init(cx);
432
433 HeadlessProject::init(cx);
434
435 let is_wsl_interop = if cfg!(target_os = "linux") {
436 // See: https://learn.microsoft.com/en-us/windows/wsl/filesystems#disable-interoperability
437 matches!(std::fs::read_to_string("/proc/sys/fs/binfmt_misc/WSLInterop"), Ok(s) if s.contains("enabled"))
438 } else {
439 false
440 };
441
442 log::info!("gpui app started, initializing server");
443 let session = start_server(listeners, log_rx, cx, is_wsl_interop);
444 trusted_worktrees::init(
445 HashMap::default(),
446 Some((session.clone(), ProjectId(REMOTE_SERVER_PROJECT_ID))),
447 None,
448 cx,
449 );
450
451 GitHostingProviderRegistry::set_global(git_hosting_provider_registry, cx);
452 git_hosting_providers::init(cx);
453 dap_adapters::init(cx);
454
455 extension::init(cx);
456 let extension_host_proxy = ExtensionHostProxy::global(cx);
457
458 json_schema_store::init(cx);
459
460 let project = cx.new(|cx| {
461 let fs = Arc::new(RealFs::new(None, cx.background_executor().clone()));
462 let node_settings_rx = initialize_settings(session.clone(), fs.clone(), cx);
463
464 let proxy_url = read_proxy_settings(cx);
465
466 let http_client = {
467 let _guard = Tokio::handle(cx).enter();
468 Arc::new(
469 ReqwestClient::proxy_and_user_agent(
470 proxy_url,
471 &format!(
472 "Zed-Server/{} ({}; {})",
473 env!("CARGO_PKG_VERSION"),
474 std::env::consts::OS,
475 std::env::consts::ARCH
476 ),
477 )
478 .expect("Could not start HTTP client"),
479 )
480 };
481
482 let node_runtime = NodeRuntime::new(
483 http_client.clone(),
484 Some(shell_env_loaded_rx),
485 node_settings_rx,
486 );
487
488 let mut languages = LanguageRegistry::new(cx.background_executor().clone());
489 languages.set_language_server_download_dir(paths::languages_dir().clone());
490 let languages = Arc::new(languages);
491
492 HeadlessProject::new(
493 HeadlessAppState {
494 session: session.clone(),
495 fs,
496 http_client,
497 node_runtime,
498 languages,
499 extension_host_proxy,
500 },
501 true,
502 cx,
503 )
504 });
505
506 handle_crash_files_requests(&project, &session);
507
508 cx.background_spawn(async move { cleanup_old_binaries() })
509 .detach();
510
511 mem::forget(project);
512 };
513 // We do not reuse any of the state after unwinding, so we don't run risk of observing broken invariants.
514 let app = std::panic::AssertUnwindSafe(app);
515 let run = std::panic::AssertUnwindSafe(run);
516 let res = std::panic::catch_unwind(move || { app }.0.run({ run }.0));
517 if let Err(_) = res {
518 log::error!("app panicked. quitting.");
519 Err(anyhow::anyhow!("panicked"))
520 } else {
521 log::info!("gpui app is shut down. quitting.");
522 Ok(())
523 }
524}
525
526#[derive(Debug, Error)]
527pub(crate) enum ServerPathError {
528 #[error("Failed to create server_dir `{path}`")]
529 CreateServerDir {
530 #[source]
531 source: std::io::Error,
532 path: PathBuf,
533 },
534 #[error("Failed to create logs_dir `{path}`")]
535 CreateLogsDir {
536 #[source]
537 source: std::io::Error,
538 path: PathBuf,
539 },
540}
541
542#[derive(Clone, Debug)]
543struct ServerPaths {
544 log_file: PathBuf,
545 pid_file: PathBuf,
546 stdin_socket: PathBuf,
547 stdout_socket: PathBuf,
548 stderr_socket: PathBuf,
549}
550
551impl ServerPaths {
552 fn new(identifier: &str) -> Result<Self, ServerPathError> {
553 let server_dir = paths::remote_server_state_dir().join(identifier);
554 std::fs::create_dir_all(&server_dir).map_err(|source| {
555 ServerPathError::CreateServerDir {
556 source,
557 path: server_dir.clone(),
558 }
559 })?;
560 let log_dir = logs_dir();
561 std::fs::create_dir_all(log_dir).map_err(|source| ServerPathError::CreateLogsDir {
562 source,
563 path: log_dir.clone(),
564 })?;
565
566 let pid_file = server_dir.join("server.pid");
567 let stdin_socket = server_dir.join("stdin.sock");
568 let stdout_socket = server_dir.join("stdout.sock");
569 let stderr_socket = server_dir.join("stderr.sock");
570 let log_file = logs_dir().join(format!("server-{}.log", identifier));
571
572 Ok(Self {
573 pid_file,
574 stdin_socket,
575 stdout_socket,
576 stderr_socket,
577 log_file,
578 })
579 }
580}
581
582#[derive(Debug, Error)]
583pub(crate) enum ExecuteProxyError {
584 #[error("Failed to init server paths")]
585 ServerPath(#[from] ServerPathError),
586
587 #[error(transparent)]
588 ServerNotRunning(#[from] ProxyLaunchError),
589
590 #[error("Failed to check PidFile '{path}'")]
591 CheckPidFile {
592 #[source]
593 source: CheckPidError,
594 path: PathBuf,
595 },
596
597 #[error("Failed to kill existing server with pid '{pid}'")]
598 KillRunningServer {
599 #[source]
600 source: std::io::Error,
601 pid: u32,
602 },
603
604 #[error("failed to spawn server")]
605 SpawnServer(#[source] SpawnServerError),
606
607 #[error("stdin_task failed")]
608 StdinTask(#[source] anyhow::Error),
609 #[error("stdout_task failed")]
610 StdoutTask(#[source] anyhow::Error),
611 #[error("stderr_task failed")]
612 StderrTask(#[source] anyhow::Error),
613}
614
615pub(crate) fn execute_proxy(
616 identifier: String,
617 is_reconnecting: bool,
618) -> Result<(), ExecuteProxyError> {
619 init_logging_proxy();
620
621 let server_paths = ServerPaths::new(&identifier)?;
622
623 let id = std::process::id().to_string();
624 smol::spawn(crashes::init(crashes::InitCrashHandler {
625 session_id: id,
626 zed_version: VERSION.to_owned(),
627 binary: "zed-remote-server".to_string(),
628 release_channel: release_channel::RELEASE_CHANNEL_NAME.clone(),
629 commit_sha: option_env!("ZED_COMMIT_SHA").unwrap_or("no_sha").to_owned(),
630 }))
631 .detach();
632
633 log::info!("starting proxy process. PID: {}", std::process::id());
634 smol::block_on(async {
635 let server_pid = check_pid_file(&server_paths.pid_file)
636 .await
637 .map_err(|source| ExecuteProxyError::CheckPidFile {
638 source,
639 path: server_paths.pid_file.clone(),
640 })?;
641 let server_running = server_pid.is_some();
642 if is_reconnecting {
643 if !server_running {
644 log::error!("attempted to reconnect, but no server running");
645 return Err(ExecuteProxyError::ServerNotRunning(
646 ProxyLaunchError::ServerNotRunning,
647 ));
648 }
649 } else {
650 if let Some(pid) = server_pid {
651 log::info!(
652 "proxy found server already running with PID {}. Killing process and cleaning up files...",
653 pid
654 );
655 kill_running_server(pid, &server_paths).await?;
656 }
657
658 spawn_server(&server_paths)
659 .await
660 .map_err(ExecuteProxyError::SpawnServer)?;
661 };
662 Ok(())
663 })?;
664
665 let stdin_task = smol::spawn(async move {
666 let stdin = smol::Unblock::new(std::io::stdin());
667 let stream = smol::net::unix::UnixStream::connect(&server_paths.stdin_socket).await?;
668 handle_io(stdin, stream, "stdin").await
669 });
670
671 let stdout_task: smol::Task<Result<()>> = smol::spawn(async move {
672 let stdout = smol::Unblock::new(std::io::stdout());
673 let stream = smol::net::unix::UnixStream::connect(&server_paths.stdout_socket).await?;
674 handle_io(stream, stdout, "stdout").await
675 });
676
677 let stderr_task: smol::Task<Result<()>> = smol::spawn(async move {
678 let mut stderr = smol::Unblock::new(std::io::stderr());
679 let mut stream = smol::net::unix::UnixStream::connect(&server_paths.stderr_socket).await?;
680 let mut stderr_buffer = vec![0; 2048];
681 loop {
682 match stream
683 .read(&mut stderr_buffer)
684 .await
685 .context("reading stderr")?
686 {
687 0 => {
688 let error =
689 std::io::Error::new(std::io::ErrorKind::UnexpectedEof, "stderr closed");
690 Err(anyhow!(error))?;
691 }
692 n => {
693 stderr.write_all(&stderr_buffer[..n]).await?;
694 stderr.flush().await?;
695 }
696 }
697 }
698 });
699
700 if let Err(forwarding_result) = smol::block_on(async move {
701 futures::select! {
702 result = stdin_task.fuse() => result.map_err(ExecuteProxyError::StdinTask),
703 result = stdout_task.fuse() => result.map_err(ExecuteProxyError::StdoutTask),
704 result = stderr_task.fuse() => result.map_err(ExecuteProxyError::StderrTask),
705 }
706 }) {
707 log::error!(
708 "encountered error while forwarding messages: {:?}, terminating...",
709 forwarding_result
710 );
711 return Err(forwarding_result);
712 }
713
714 Ok(())
715}
716
717async fn kill_running_server(pid: u32, paths: &ServerPaths) -> Result<(), ExecuteProxyError> {
718 log::info!("killing existing server with PID {}", pid);
719 new_smol_command("kill")
720 .arg(pid.to_string())
721 .output()
722 .await
723 .map_err(|source| ExecuteProxyError::KillRunningServer { source, pid })?;
724
725 for file in [
726 &paths.pid_file,
727 &paths.stdin_socket,
728 &paths.stdout_socket,
729 &paths.stderr_socket,
730 ] {
731 log::debug!("cleaning up file {:?} before starting new server", file);
732 std::fs::remove_file(file).ok();
733 }
734 Ok(())
735}
736
737#[derive(Debug, Error)]
738pub(crate) enum SpawnServerError {
739 #[error("failed to remove stdin socket")]
740 RemoveStdinSocket(#[source] std::io::Error),
741
742 #[error("failed to remove stdout socket")]
743 RemoveStdoutSocket(#[source] std::io::Error),
744
745 #[error("failed to remove stderr socket")]
746 RemoveStderrSocket(#[source] std::io::Error),
747
748 #[error("failed to get current_exe")]
749 CurrentExe(#[source] std::io::Error),
750
751 #[error("failed to launch server process")]
752 ProcessStatus(#[source] std::io::Error),
753
754 #[error("failed to launch and detach server process: {status}\n{paths}")]
755 LaunchStatus { status: ExitStatus, paths: String },
756
757 #[error("failed to wait for server to be ready to accept connections")]
758 Timeout,
759}
760
761async fn spawn_server(paths: &ServerPaths) -> Result<(), SpawnServerError> {
762 log::info!("spawning server process",);
763 if paths.stdin_socket.exists() {
764 std::fs::remove_file(&paths.stdin_socket).map_err(SpawnServerError::RemoveStdinSocket)?;
765 }
766 if paths.stdout_socket.exists() {
767 std::fs::remove_file(&paths.stdout_socket).map_err(SpawnServerError::RemoveStdoutSocket)?;
768 }
769 if paths.stderr_socket.exists() {
770 std::fs::remove_file(&paths.stderr_socket).map_err(SpawnServerError::RemoveStderrSocket)?;
771 }
772
773 let binary_name = std::env::current_exe().map_err(SpawnServerError::CurrentExe)?;
774 let mut server_process = new_smol_command(binary_name);
775 server_process
776 .arg("run")
777 .arg("--log-file")
778 .arg(&paths.log_file)
779 .arg("--pid-file")
780 .arg(&paths.pid_file)
781 .arg("--stdin-socket")
782 .arg(&paths.stdin_socket)
783 .arg("--stdout-socket")
784 .arg(&paths.stdout_socket)
785 .arg("--stderr-socket")
786 .arg(&paths.stderr_socket);
787
788 let status = server_process
789 .status()
790 .await
791 .map_err(SpawnServerError::ProcessStatus)?;
792
793 if !status.success() {
794 return Err(SpawnServerError::LaunchStatus {
795 status,
796 paths: format!(
797 "log file: {:?}, pid file: {:?}",
798 paths.log_file, paths.pid_file,
799 ),
800 });
801 }
802
803 let mut total_time_waited = std::time::Duration::from_secs(0);
804 let wait_duration = std::time::Duration::from_millis(20);
805 while !paths.stdout_socket.exists()
806 || !paths.stdin_socket.exists()
807 || !paths.stderr_socket.exists()
808 {
809 log::debug!("waiting for server to be ready to accept connections...");
810 std::thread::sleep(wait_duration);
811 total_time_waited += wait_duration;
812 if total_time_waited > std::time::Duration::from_secs(10) {
813 return Err(SpawnServerError::Timeout);
814 }
815 }
816
817 log::info!(
818 "server ready to accept connections. total time waited: {:?}",
819 total_time_waited
820 );
821
822 Ok(())
823}
824
825#[derive(Debug, Error)]
826#[error("Failed to remove PID file for missing process (pid `{pid}`")]
827pub(crate) struct CheckPidError {
828 #[source]
829 source: std::io::Error,
830 pid: u32,
831}
832
833async fn check_pid_file(path: &Path) -> Result<Option<u32>, CheckPidError> {
834 let Some(pid) = std::fs::read_to_string(&path)
835 .ok()
836 .and_then(|contents| contents.parse::<u32>().ok())
837 else {
838 return Ok(None);
839 };
840
841 log::debug!("Checking if process with PID {} exists...", pid);
842 match new_smol_command("kill")
843 .arg("-0")
844 .arg(pid.to_string())
845 .output()
846 .await
847 {
848 Ok(output) if output.status.success() => {
849 log::debug!(
850 "Process with PID {} exists. NOT spawning new server, but attaching to existing one.",
851 pid
852 );
853 Ok(Some(pid))
854 }
855 _ => {
856 log::debug!(
857 "Found PID file, but process with that PID does not exist. Removing PID file."
858 );
859 std::fs::remove_file(&path).map_err(|source| CheckPidError { source, pid })?;
860 Ok(None)
861 }
862 }
863}
864
865fn write_pid_file(path: &Path) -> Result<()> {
866 if path.exists() {
867 std::fs::remove_file(path)?;
868 }
869 let pid = std::process::id().to_string();
870 log::debug!("writing PID {} to file {:?}", pid, path);
871 std::fs::write(path, pid).context("Failed to write PID file")
872}
873
874async fn handle_io<R, W>(mut reader: R, mut writer: W, socket_name: &str) -> Result<()>
875where
876 R: AsyncRead + Unpin,
877 W: AsyncWrite + Unpin,
878{
879 use remote::protocol::{read_message_raw, write_size_prefixed_buffer};
880
881 let mut buffer = Vec::new();
882 loop {
883 read_message_raw(&mut reader, &mut buffer)
884 .await
885 .with_context(|| format!("failed to read message from {}", socket_name))?;
886 write_size_prefixed_buffer(&mut writer, &mut buffer)
887 .await
888 .with_context(|| format!("failed to write message to {}", socket_name))?;
889 writer.flush().await?;
890 buffer.clear();
891 }
892}
893
894fn initialize_settings(
895 session: AnyProtoClient,
896 fs: Arc<dyn Fs>,
897 cx: &mut App,
898) -> watch::Receiver<Option<NodeBinaryOptions>> {
899 let user_settings_file_rx =
900 watch_config_file(cx.background_executor(), fs, paths::settings_file().clone());
901
902 handle_settings_file_changes(user_settings_file_rx, cx, {
903 move |err, _cx| {
904 if let Some(e) = err {
905 log::info!("Server settings failed to change: {}", e);
906
907 session
908 .send(proto::Toast {
909 project_id: REMOTE_SERVER_PROJECT_ID,
910 notification_id: "server-settings-failed".to_string(),
911 message: format!(
912 "Error in settings on remote host {:?}: {}",
913 paths::settings_file(),
914 e
915 ),
916 })
917 .log_err();
918 } else {
919 session
920 .send(proto::HideToast {
921 project_id: REMOTE_SERVER_PROJECT_ID,
922 notification_id: "server-settings-failed".to_string(),
923 })
924 .log_err();
925 }
926 }
927 });
928
929 let (mut tx, rx) = watch::channel(None);
930 let mut node_settings = None;
931 cx.observe_global::<SettingsStore>(move |cx| {
932 let new_node_settings = &ProjectSettings::get_global(cx).node;
933 if Some(new_node_settings) != node_settings.as_ref() {
934 log::info!("Got new node settings: {new_node_settings:?}");
935 let options = NodeBinaryOptions {
936 allow_path_lookup: !new_node_settings.ignore_system_version,
937 // TODO: Implement this setting
938 allow_binary_download: true,
939 use_paths: new_node_settings.path.as_ref().map(|node_path| {
940 let node_path = PathBuf::from(shellexpand::tilde(node_path).as_ref());
941 let npm_path = new_node_settings
942 .npm_path
943 .as_ref()
944 .map(|path| PathBuf::from(shellexpand::tilde(&path).as_ref()));
945 (
946 node_path.clone(),
947 npm_path.unwrap_or_else(|| {
948 let base_path = PathBuf::new();
949 node_path.parent().unwrap_or(&base_path).join("npm")
950 }),
951 )
952 }),
953 };
954 node_settings = Some(new_node_settings.clone());
955 tx.send(Some(options)).ok();
956 }
957 })
958 .detach();
959
960 rx
961}
962
963pub fn handle_settings_file_changes(
964 mut server_settings_file: mpsc::UnboundedReceiver<String>,
965 cx: &mut App,
966 settings_changed: impl Fn(Option<anyhow::Error>, &mut App) + 'static,
967) {
968 let server_settings_content = cx
969 .foreground_executor()
970 .block_on(server_settings_file.next())
971 .unwrap();
972 SettingsStore::update_global(cx, |store, cx| {
973 store
974 .set_server_settings(&server_settings_content, cx)
975 .log_err();
976 });
977 cx.spawn(async move |cx| {
978 while let Some(server_settings_content) = server_settings_file.next().await {
979 cx.update_global(|store: &mut SettingsStore, cx| {
980 let result = store.set_server_settings(&server_settings_content, cx);
981 if let Err(err) = &result {
982 log::error!("Failed to load server settings: {err}");
983 }
984 settings_changed(result.err(), cx);
985 cx.refresh_windows();
986 });
987 }
988 })
989 .detach();
990}
991
992fn read_proxy_settings(cx: &mut Context<HeadlessProject>) -> Option<Url> {
993 let proxy_str = ProxySettings::get_global(cx).proxy.to_owned();
994
995 proxy_str
996 .as_deref()
997 .map(str::trim)
998 .filter(|input| !input.is_empty())
999 .and_then(|input| {
1000 input
1001 .parse::<Url>()
1002 .inspect_err(|e| log::error!("Error parsing proxy settings: {}", e))
1003 .ok()
1004 })
1005 .or_else(read_proxy_from_env)
1006}
1007
1008fn daemonize() -> Result<ControlFlow<()>> {
1009 match fork::fork().map_err(|e| anyhow!("failed to call fork with error code {e}"))? {
1010 fork::Fork::Parent(_) => {
1011 return Ok(ControlFlow::Break(()));
1012 }
1013 fork::Fork::Child => {}
1014 }
1015
1016 // Once we've detached from the parent, we want to close stdout/stderr/stdin
1017 // so that the outer SSH process is not attached to us in any way anymore.
1018 unsafe { redirect_standard_streams() }?;
1019
1020 Ok(ControlFlow::Continue(()))
1021}
1022
1023unsafe fn redirect_standard_streams() -> Result<()> {
1024 let devnull_fd = unsafe { libc::open(b"/dev/null\0" as *const [u8; 10] as _, libc::O_RDWR) };
1025 anyhow::ensure!(devnull_fd != -1, "failed to open /dev/null");
1026
1027 let process_stdio = |name, fd| {
1028 let reopened_fd = unsafe { libc::dup2(devnull_fd, fd) };
1029 anyhow::ensure!(
1030 reopened_fd != -1,
1031 format!("failed to redirect {} to /dev/null", name)
1032 );
1033 Ok(())
1034 };
1035
1036 process_stdio("stdin", libc::STDIN_FILENO)?;
1037 process_stdio("stdout", libc::STDOUT_FILENO)?;
1038 process_stdio("stderr", libc::STDERR_FILENO)?;
1039
1040 anyhow::ensure!(
1041 unsafe { libc::close(devnull_fd) != -1 },
1042 "failed to close /dev/null fd after redirecting"
1043 );
1044
1045 Ok(())
1046}
1047
1048fn cleanup_old_binaries() -> Result<()> {
1049 let server_dir = paths::remote_server_dir_relative();
1050 let release_channel = release_channel::RELEASE_CHANNEL.dev_name();
1051 let prefix = format!("zed-remote-server-{}-", release_channel);
1052
1053 for entry in std::fs::read_dir(server_dir.as_std_path())? {
1054 let path = entry?.path();
1055
1056 if let Some(file_name) = path.file_name()
1057 && let Some(version) = file_name.to_string_lossy().strip_prefix(&prefix)
1058 && !is_new_version(version)
1059 && !is_file_in_use(file_name)
1060 {
1061 log::info!("removing old remote server binary: {:?}", path);
1062 std::fs::remove_file(&path)?;
1063 }
1064 }
1065
1066 Ok(())
1067}
1068
1069fn is_new_version(version: &str) -> bool {
1070 semver::Version::from_str(version)
1071 .ok()
1072 .zip(semver::Version::from_str(env!("ZED_PKG_VERSION")).ok())
1073 .is_some_and(|(version, current_version)| version >= current_version)
1074}
1075
1076fn is_file_in_use(file_name: &OsStr) -> bool {
1077 let info = sysinfo::System::new_with_specifics(sysinfo::RefreshKind::nothing().with_processes(
1078 sysinfo::ProcessRefreshKind::nothing().with_exe(sysinfo::UpdateKind::Always),
1079 ));
1080
1081 for process in info.processes().values() {
1082 if process
1083 .exe()
1084 .is_some_and(|exe| exe.file_name().is_some_and(|name| name == file_name))
1085 {
1086 return true;
1087 }
1088 }
1089
1090 false
1091}