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