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 .thread_name(|ix| format!("RayonWorker{}", ix))
376 .build_global()
377 .unwrap();
378
379 let (shell_env_loaded_tx, shell_env_loaded_rx) = oneshot::channel();
380 app.background_executor()
381 .spawn(async {
382 util::load_login_shell_environment().await.log_err();
383 shell_env_loaded_tx.send(()).ok();
384 })
385 .detach();
386
387 let git_hosting_provider_registry = Arc::new(GitHostingProviderRegistry::new());
388 app.run(move |cx| {
389 settings::init(cx);
390 let app_version = AppVersion::load(env!("ZED_PKG_VERSION"));
391 release_channel::init(app_version, cx);
392 gpui_tokio::init(cx);
393
394 HeadlessProject::init(cx);
395
396 log::info!("gpui app started, initializing server");
397 let session = start_server(listeners, log_rx, cx);
398
399 client::init_settings(cx);
400
401 GitHostingProviderRegistry::set_global(git_hosting_provider_registry, cx);
402 git_hosting_providers::init(cx);
403 dap_adapters::init(cx);
404
405 extension::init(cx);
406 let extension_host_proxy = ExtensionHostProxy::global(cx);
407
408 json_schema_store::init(cx);
409
410 let project = cx.new(|cx| {
411 let fs = Arc::new(RealFs::new(None, cx.background_executor().clone()));
412 let node_settings_rx = initialize_settings(session.clone(), fs.clone(), cx);
413
414 let proxy_url = read_proxy_settings(cx);
415
416 let http_client = {
417 let _guard = Tokio::handle(cx).enter();
418 Arc::new(
419 ReqwestClient::proxy_and_user_agent(
420 proxy_url,
421 &format!(
422 "Zed-Server/{} ({}; {})",
423 env!("CARGO_PKG_VERSION"),
424 std::env::consts::OS,
425 std::env::consts::ARCH
426 ),
427 )
428 .expect("Could not start HTTP client"),
429 )
430 };
431
432 let node_runtime = NodeRuntime::new(
433 http_client.clone(),
434 Some(shell_env_loaded_rx),
435 node_settings_rx,
436 );
437
438 let mut languages = LanguageRegistry::new(cx.background_executor().clone());
439 languages.set_language_server_download_dir(paths::languages_dir().clone());
440 let languages = Arc::new(languages);
441
442 HeadlessProject::new(
443 HeadlessAppState {
444 session: session.clone(),
445 fs,
446 http_client,
447 node_runtime,
448 languages,
449 extension_host_proxy,
450 },
451 cx,
452 )
453 });
454
455 handle_crash_files_requests(&project, &session);
456
457 cx.background_spawn(async move { cleanup_old_binaries() })
458 .detach();
459
460 mem::forget(project);
461 });
462 log::info!("gpui app is shut down. quitting.");
463 Ok(())
464}
465
466#[derive(Debug, Error)]
467pub(crate) enum ServerPathError {
468 #[error("Failed to create server_dir `{path}`")]
469 CreateServerDir {
470 #[source]
471 source: std::io::Error,
472 path: PathBuf,
473 },
474 #[error("Failed to create logs_dir `{path}`")]
475 CreateLogsDir {
476 #[source]
477 source: std::io::Error,
478 path: PathBuf,
479 },
480}
481
482#[derive(Clone, Debug)]
483struct ServerPaths {
484 log_file: PathBuf,
485 pid_file: PathBuf,
486 stdin_socket: PathBuf,
487 stdout_socket: PathBuf,
488 stderr_socket: PathBuf,
489}
490
491impl ServerPaths {
492 fn new(identifier: &str) -> Result<Self, ServerPathError> {
493 let server_dir = paths::remote_server_state_dir().join(identifier);
494 std::fs::create_dir_all(&server_dir).map_err(|source| {
495 ServerPathError::CreateServerDir {
496 source,
497 path: server_dir.clone(),
498 }
499 })?;
500 let log_dir = logs_dir();
501 std::fs::create_dir_all(log_dir).map_err(|source| ServerPathError::CreateLogsDir {
502 source: source,
503 path: log_dir.clone(),
504 })?;
505
506 let pid_file = server_dir.join("server.pid");
507 let stdin_socket = server_dir.join("stdin.sock");
508 let stdout_socket = server_dir.join("stdout.sock");
509 let stderr_socket = server_dir.join("stderr.sock");
510 let log_file = logs_dir().join(format!("server-{}.log", identifier));
511
512 Ok(Self {
513 pid_file,
514 stdin_socket,
515 stdout_socket,
516 stderr_socket,
517 log_file,
518 })
519 }
520}
521
522#[derive(Debug, Error)]
523pub(crate) enum ExecuteProxyError {
524 #[error("Failed to init server paths")]
525 ServerPath(#[from] ServerPathError),
526
527 #[error(transparent)]
528 ServerNotRunning(#[from] ProxyLaunchError),
529
530 #[error("Failed to check PidFile '{path}'")]
531 CheckPidFile {
532 #[source]
533 source: CheckPidError,
534 path: PathBuf,
535 },
536
537 #[error("Failed to kill existing server with pid '{pid}'")]
538 KillRunningServer {
539 #[source]
540 source: std::io::Error,
541 pid: u32,
542 },
543
544 #[error("failed to spawn server")]
545 SpawnServer(#[source] SpawnServerError),
546
547 #[error("stdin_task failed")]
548 StdinTask(#[source] anyhow::Error),
549 #[error("stdout_task failed")]
550 StdoutTask(#[source] anyhow::Error),
551 #[error("stderr_task failed")]
552 StderrTask(#[source] anyhow::Error),
553}
554
555pub(crate) fn execute_proxy(
556 identifier: String,
557 is_reconnecting: bool,
558) -> Result<(), ExecuteProxyError> {
559 init_logging_proxy();
560
561 let server_paths = ServerPaths::new(&identifier)?;
562
563 let id = std::process::id().to_string();
564 smol::spawn(crashes::init(crashes::InitCrashHandler {
565 session_id: id,
566 zed_version: VERSION.to_owned(),
567 binary: "zed-remote-server".to_string(),
568 release_channel: release_channel::RELEASE_CHANNEL_NAME.clone(),
569 commit_sha: option_env!("ZED_COMMIT_SHA").unwrap_or("no_sha").to_owned(),
570 }))
571 .detach();
572
573 log::info!("starting proxy process. PID: {}", std::process::id());
574 smol::block_on(async {
575 let server_pid = check_pid_file(&server_paths.pid_file)
576 .await
577 .map_err(|source| ExecuteProxyError::CheckPidFile {
578 source,
579 path: server_paths.pid_file.clone(),
580 })?;
581 let server_running = server_pid.is_some();
582 if is_reconnecting {
583 if !server_running {
584 log::error!("attempted to reconnect, but no server running");
585 return Err(ExecuteProxyError::ServerNotRunning(
586 ProxyLaunchError::ServerNotRunning,
587 ));
588 }
589 } else {
590 if let Some(pid) = server_pid {
591 log::info!(
592 "proxy found server already running with PID {}. Killing process and cleaning up files...",
593 pid
594 );
595 kill_running_server(pid, &server_paths).await?;
596 }
597
598 spawn_server(&server_paths)
599 .await
600 .map_err(ExecuteProxyError::SpawnServer)?;
601 };
602 Ok(())
603 })?;
604
605 let stdin_task = smol::spawn(async move {
606 let stdin = Async::new(std::io::stdin())?;
607 let stream = smol::net::unix::UnixStream::connect(&server_paths.stdin_socket).await?;
608 handle_io(stdin, stream, "stdin").await
609 });
610
611 let stdout_task: smol::Task<Result<()>> = smol::spawn(async move {
612 let stdout = Async::new(std::io::stdout())?;
613 let stream = smol::net::unix::UnixStream::connect(&server_paths.stdout_socket).await?;
614 handle_io(stream, stdout, "stdout").await
615 });
616
617 let stderr_task: smol::Task<Result<()>> = smol::spawn(async move {
618 let mut stderr = Async::new(std::io::stderr())?;
619 let mut stream = smol::net::unix::UnixStream::connect(&server_paths.stderr_socket).await?;
620 let mut stderr_buffer = vec![0; 2048];
621 loop {
622 match stream
623 .read(&mut stderr_buffer)
624 .await
625 .context("reading stderr")?
626 {
627 0 => {
628 let error =
629 std::io::Error::new(std::io::ErrorKind::UnexpectedEof, "stderr closed");
630 Err(anyhow!(error))?;
631 }
632 n => {
633 stderr.write_all(&stderr_buffer[..n]).await?;
634 stderr.flush().await?;
635 }
636 }
637 }
638 });
639
640 if let Err(forwarding_result) = smol::block_on(async move {
641 futures::select! {
642 result = stdin_task.fuse() => result.map_err(ExecuteProxyError::StdinTask),
643 result = stdout_task.fuse() => result.map_err(ExecuteProxyError::StdoutTask),
644 result = stderr_task.fuse() => result.map_err(ExecuteProxyError::StderrTask),
645 }
646 }) {
647 log::error!(
648 "encountered error while forwarding messages: {:?}, terminating...",
649 forwarding_result
650 );
651 return Err(forwarding_result);
652 }
653
654 Ok(())
655}
656
657async fn kill_running_server(pid: u32, paths: &ServerPaths) -> Result<(), ExecuteProxyError> {
658 log::info!("killing existing server with PID {}", pid);
659 smol::process::Command::new("kill")
660 .arg(pid.to_string())
661 .output()
662 .await
663 .map_err(|source| ExecuteProxyError::KillRunningServer { source, pid })?;
664
665 for file in [
666 &paths.pid_file,
667 &paths.stdin_socket,
668 &paths.stdout_socket,
669 &paths.stderr_socket,
670 ] {
671 log::debug!("cleaning up file {:?} before starting new server", file);
672 std::fs::remove_file(file).ok();
673 }
674 Ok(())
675}
676
677#[derive(Debug, Error)]
678pub(crate) enum SpawnServerError {
679 #[error("failed to remove stdin socket")]
680 RemoveStdinSocket(#[source] std::io::Error),
681
682 #[error("failed to remove stdout socket")]
683 RemoveStdoutSocket(#[source] std::io::Error),
684
685 #[error("failed to remove stderr socket")]
686 RemoveStderrSocket(#[source] std::io::Error),
687
688 #[error("failed to get current_exe")]
689 CurrentExe(#[source] std::io::Error),
690
691 #[error("failed to launch server process")]
692 ProcessStatus(#[source] std::io::Error),
693
694 #[error("failed to launch and detach server process: {status}\n{paths}")]
695 LaunchStatus { status: ExitStatus, paths: String },
696}
697
698async fn spawn_server(paths: &ServerPaths) -> Result<(), SpawnServerError> {
699 if paths.stdin_socket.exists() {
700 std::fs::remove_file(&paths.stdin_socket).map_err(SpawnServerError::RemoveStdinSocket)?;
701 }
702 if paths.stdout_socket.exists() {
703 std::fs::remove_file(&paths.stdout_socket).map_err(SpawnServerError::RemoveStdoutSocket)?;
704 }
705 if paths.stderr_socket.exists() {
706 std::fs::remove_file(&paths.stderr_socket).map_err(SpawnServerError::RemoveStderrSocket)?;
707 }
708
709 let binary_name = std::env::current_exe().map_err(SpawnServerError::CurrentExe)?;
710 let mut server_process = smol::process::Command::new(binary_name);
711 server_process
712 .arg("run")
713 .arg("--log-file")
714 .arg(&paths.log_file)
715 .arg("--pid-file")
716 .arg(&paths.pid_file)
717 .arg("--stdin-socket")
718 .arg(&paths.stdin_socket)
719 .arg("--stdout-socket")
720 .arg(&paths.stdout_socket)
721 .arg("--stderr-socket")
722 .arg(&paths.stderr_socket);
723
724 let status = server_process
725 .status()
726 .await
727 .map_err(SpawnServerError::ProcessStatus)?;
728
729 if !status.success() {
730 return Err(SpawnServerError::LaunchStatus {
731 status,
732 paths: format!(
733 "log file: {:?}, pid file: {:?}",
734 paths.log_file, paths.pid_file,
735 ),
736 });
737 }
738
739 let mut total_time_waited = std::time::Duration::from_secs(0);
740 let wait_duration = std::time::Duration::from_millis(20);
741 while !paths.stdout_socket.exists()
742 || !paths.stdin_socket.exists()
743 || !paths.stderr_socket.exists()
744 {
745 log::debug!("waiting for server to be ready to accept connections...");
746 std::thread::sleep(wait_duration);
747 total_time_waited += wait_duration;
748 }
749
750 log::info!(
751 "server ready to accept connections. total time waited: {:?}",
752 total_time_waited
753 );
754
755 Ok(())
756}
757
758#[derive(Debug, Error)]
759#[error("Failed to remove PID file for missing process (pid `{pid}`")]
760pub(crate) struct CheckPidError {
761 #[source]
762 source: std::io::Error,
763 pid: u32,
764}
765
766async fn check_pid_file(path: &Path) -> Result<Option<u32>, CheckPidError> {
767 let Some(pid) = std::fs::read_to_string(&path)
768 .ok()
769 .and_then(|contents| contents.parse::<u32>().ok())
770 else {
771 return Ok(None);
772 };
773
774 log::debug!("Checking if process with PID {} exists...", pid);
775 match smol::process::Command::new("kill")
776 .arg("-0")
777 .arg(pid.to_string())
778 .output()
779 .await
780 {
781 Ok(output) if output.status.success() => {
782 log::debug!(
783 "Process with PID {} exists. NOT spawning new server, but attaching to existing one.",
784 pid
785 );
786 Ok(Some(pid))
787 }
788 _ => {
789 log::debug!(
790 "Found PID file, but process with that PID does not exist. Removing PID file."
791 );
792 std::fs::remove_file(&path).map_err(|source| CheckPidError { source, pid })?;
793 Ok(None)
794 }
795 }
796}
797
798fn write_pid_file(path: &Path) -> Result<()> {
799 if path.exists() {
800 std::fs::remove_file(path)?;
801 }
802 let pid = std::process::id().to_string();
803 log::debug!("writing PID {} to file {:?}", pid, path);
804 std::fs::write(path, pid).context("Failed to write PID file")
805}
806
807async fn handle_io<R, W>(mut reader: R, mut writer: W, socket_name: &str) -> Result<()>
808where
809 R: AsyncRead + Unpin,
810 W: AsyncWrite + Unpin,
811{
812 use remote::protocol::{read_message_raw, write_size_prefixed_buffer};
813
814 let mut buffer = Vec::new();
815 loop {
816 read_message_raw(&mut reader, &mut buffer)
817 .await
818 .with_context(|| format!("failed to read message from {}", socket_name))?;
819 write_size_prefixed_buffer(&mut writer, &mut buffer)
820 .await
821 .with_context(|| format!("failed to write message to {}", socket_name))?;
822 writer.flush().await?;
823 buffer.clear();
824 }
825}
826
827fn initialize_settings(
828 session: AnyProtoClient,
829 fs: Arc<dyn Fs>,
830 cx: &mut App,
831) -> watch::Receiver<Option<NodeBinaryOptions>> {
832 let user_settings_file_rx =
833 watch_config_file(cx.background_executor(), fs, paths::settings_file().clone());
834
835 handle_settings_file_changes(user_settings_file_rx, cx, {
836 move |err, _cx| {
837 if let Some(e) = err {
838 log::info!("Server settings failed to change: {}", e);
839
840 session
841 .send(proto::Toast {
842 project_id: REMOTE_SERVER_PROJECT_ID,
843 notification_id: "server-settings-failed".to_string(),
844 message: format!(
845 "Error in settings on remote host {:?}: {}",
846 paths::settings_file(),
847 e
848 ),
849 })
850 .log_err();
851 } else {
852 session
853 .send(proto::HideToast {
854 project_id: REMOTE_SERVER_PROJECT_ID,
855 notification_id: "server-settings-failed".to_string(),
856 })
857 .log_err();
858 }
859 }
860 });
861
862 let (mut tx, rx) = watch::channel(None);
863 let mut node_settings = None;
864 cx.observe_global::<SettingsStore>(move |cx| {
865 let new_node_settings = &ProjectSettings::get_global(cx).node;
866 if Some(new_node_settings) != node_settings.as_ref() {
867 log::info!("Got new node settings: {new_node_settings:?}");
868 let options = NodeBinaryOptions {
869 allow_path_lookup: !new_node_settings.ignore_system_version,
870 // TODO: Implement this setting
871 allow_binary_download: true,
872 use_paths: new_node_settings.path.as_ref().map(|node_path| {
873 let node_path = PathBuf::from(shellexpand::tilde(node_path).as_ref());
874 let npm_path = new_node_settings
875 .npm_path
876 .as_ref()
877 .map(|path| PathBuf::from(shellexpand::tilde(&path).as_ref()));
878 (
879 node_path.clone(),
880 npm_path.unwrap_or_else(|| {
881 let base_path = PathBuf::new();
882 node_path.parent().unwrap_or(&base_path).join("npm")
883 }),
884 )
885 }),
886 };
887 node_settings = Some(new_node_settings.clone());
888 tx.send(Some(options)).ok();
889 }
890 })
891 .detach();
892
893 rx
894}
895
896pub fn handle_settings_file_changes(
897 mut server_settings_file: mpsc::UnboundedReceiver<String>,
898 cx: &mut App,
899 settings_changed: impl Fn(Option<anyhow::Error>, &mut App) + 'static,
900) {
901 let server_settings_content = cx
902 .background_executor()
903 .block(server_settings_file.next())
904 .unwrap();
905 SettingsStore::update_global(cx, |store, cx| {
906 store
907 .set_server_settings(&server_settings_content, cx)
908 .log_err();
909 });
910 cx.spawn(async move |cx| {
911 while let Some(server_settings_content) = server_settings_file.next().await {
912 let result = cx.update_global(|store: &mut SettingsStore, cx| {
913 let result = store.set_server_settings(&server_settings_content, cx);
914 if let Err(err) = &result {
915 log::error!("Failed to load server settings: {err}");
916 }
917 settings_changed(result.err(), cx);
918 cx.refresh_windows();
919 });
920 if result.is_err() {
921 break; // App dropped
922 }
923 }
924 })
925 .detach();
926}
927
928fn read_proxy_settings(cx: &mut Context<HeadlessProject>) -> Option<Url> {
929 let proxy_str = ProxySettings::get_global(cx).proxy.to_owned();
930
931 proxy_str
932 .as_ref()
933 .and_then(|input: &String| {
934 input
935 .parse::<Url>()
936 .inspect_err(|e| log::error!("Error parsing proxy settings: {}", e))
937 .ok()
938 })
939 .or_else(read_proxy_from_env)
940}
941
942fn daemonize() -> Result<ControlFlow<()>> {
943 match fork::fork().map_err(|e| anyhow!("failed to call fork with error code {e}"))? {
944 fork::Fork::Parent(_) => {
945 return Ok(ControlFlow::Break(()));
946 }
947 fork::Fork::Child => {}
948 }
949
950 // Once we've detached from the parent, we want to close stdout/stderr/stdin
951 // so that the outer SSH process is not attached to us in any way anymore.
952 unsafe { redirect_standard_streams() }?;
953
954 Ok(ControlFlow::Continue(()))
955}
956
957unsafe fn redirect_standard_streams() -> Result<()> {
958 let devnull_fd = unsafe { libc::open(b"/dev/null\0" as *const [u8; 10] as _, libc::O_RDWR) };
959 anyhow::ensure!(devnull_fd != -1, "failed to open /dev/null");
960
961 let process_stdio = |name, fd| {
962 let reopened_fd = unsafe { libc::dup2(devnull_fd, fd) };
963 anyhow::ensure!(
964 reopened_fd != -1,
965 format!("failed to redirect {} to /dev/null", name)
966 );
967 Ok(())
968 };
969
970 process_stdio("stdin", libc::STDIN_FILENO)?;
971 process_stdio("stdout", libc::STDOUT_FILENO)?;
972 process_stdio("stderr", libc::STDERR_FILENO)?;
973
974 anyhow::ensure!(
975 unsafe { libc::close(devnull_fd) != -1 },
976 "failed to close /dev/null fd after redirecting"
977 );
978
979 Ok(())
980}
981
982fn cleanup_old_binaries() -> Result<()> {
983 let server_dir = paths::remote_server_dir_relative();
984 let release_channel = release_channel::RELEASE_CHANNEL.dev_name();
985 let prefix = format!("zed-remote-server-{}-", release_channel);
986
987 for entry in std::fs::read_dir(server_dir.as_std_path())? {
988 let path = entry?.path();
989
990 if let Some(file_name) = path.file_name()
991 && let Some(version) = file_name.to_string_lossy().strip_prefix(&prefix)
992 && !is_new_version(version)
993 && !is_file_in_use(file_name)
994 {
995 log::info!("removing old remote server binary: {:?}", path);
996 std::fs::remove_file(&path)?;
997 }
998 }
999
1000 Ok(())
1001}
1002
1003fn is_new_version(version: &str) -> bool {
1004 SemanticVersion::from_str(version)
1005 .ok()
1006 .zip(SemanticVersion::from_str(env!("ZED_PKG_VERSION")).ok())
1007 .is_some_and(|(version, current_version)| version >= current_version)
1008}
1009
1010fn is_file_in_use(file_name: &OsStr) -> bool {
1011 let info = sysinfo::System::new_with_specifics(sysinfo::RefreshKind::nothing().with_processes(
1012 sysinfo::ProcessRefreshKind::nothing().with_exe(sysinfo::UpdateKind::Always),
1013 ));
1014
1015 for process in info.processes().values() {
1016 if process
1017 .exe()
1018 .is_some_and(|exe| exe.file_name().is_some_and(|name| name == file_name))
1019 {
1020 return true;
1021 }
1022 }
1023
1024 false
1025}