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