Skip to main content

aft/lsp/
client.rs

1use std::collections::HashMap;
2use std::io::{self, BufReader, BufWriter};
3use std::path::{Path, PathBuf};
4use std::process::{Child, Command, Stdio};
5use std::str::FromStr;
6use std::sync::atomic::{AtomicI64, Ordering};
7use std::sync::{Arc, Mutex};
8use std::thread;
9use std::time::{Duration, Instant};
10
11use crossbeam_channel::{bounded, RecvTimeoutError, Sender};
12use serde::de::DeserializeOwned;
13use serde_json::{json, Value};
14
15use crate::lsp::jsonrpc::{
16    Notification, Request, RequestId, Response as JsonRpcResponse, ServerMessage,
17};
18use crate::lsp::registry::ServerKind;
19use crate::lsp::{transport, LspError};
20
21const REQUEST_TIMEOUT: Duration = Duration::from_secs(30);
22const SHUTDOWN_TIMEOUT: Duration = Duration::from_secs(5);
23const EXIT_POLL_INTERVAL: Duration = Duration::from_millis(25);
24
25type PendingMap = HashMap<RequestId, Sender<JsonRpcResponse>>;
26
27/// Lifecycle state of a language server.
28#[derive(Debug, Clone, Copy, PartialEq, Eq)]
29pub enum ServerState {
30    Starting,
31    Initializing,
32    Ready,
33    ShuttingDown,
34    Exited,
35}
36
37/// Events sent from background reader threads into the main loop.
38#[derive(Debug)]
39pub enum LspEvent {
40    /// Server sent a notification (e.g. publishDiagnostics).
41    Notification {
42        server_kind: ServerKind,
43        root: PathBuf,
44        method: String,
45        params: Option<Value>,
46    },
47    /// Server sent a request (e.g. workspace/configuration).
48    ServerRequest {
49        server_kind: ServerKind,
50        root: PathBuf,
51        id: RequestId,
52        method: String,
53        params: Option<Value>,
54    },
55    /// Server process exited or the transport stream closed.
56    ServerExited {
57        server_kind: ServerKind,
58        root: PathBuf,
59    },
60}
61
62/// A client connected to one language server process.
63pub struct LspClient {
64    kind: ServerKind,
65    root: PathBuf,
66    state: ServerState,
67    child: Child,
68    writer: Arc<Mutex<BufWriter<std::process::ChildStdin>>>,
69
70    /// Pending request responses, keyed by request ID.
71    pending: Arc<Mutex<PendingMap>>,
72    /// Next request ID counter.
73    next_id: AtomicI64,
74}
75
76impl LspClient {
77    /// Spawn a new language server process and start the background reader thread.
78    pub fn spawn(
79        kind: ServerKind,
80        root: PathBuf,
81        binary: &Path,
82        args: &[&str],
83        event_tx: Sender<LspEvent>,
84    ) -> io::Result<Self> {
85        let mut child = Command::new(binary)
86            .args(args)
87            .current_dir(&root)
88            .stdin(Stdio::piped())
89            .stdout(Stdio::piped())
90            // Use null() instead of piped() to prevent deadlock when the server
91            // writes more than ~64KB to stderr (piped buffer fills, server blocks)
92            .stderr(Stdio::null())
93            .spawn()?;
94
95        let stdout = child
96            .stdout
97            .take()
98            .ok_or_else(|| io::Error::other("language server missing stdout pipe"))?;
99        let stdin = child
100            .stdin
101            .take()
102            .ok_or_else(|| io::Error::other("language server missing stdin pipe"))?;
103
104        let writer = Arc::new(Mutex::new(BufWriter::new(stdin)));
105        let pending = Arc::new(Mutex::new(PendingMap::new()));
106        let reader_pending = Arc::clone(&pending);
107        let reader_writer = Arc::clone(&writer);
108        let reader_kind = kind;
109        let reader_root = root.clone();
110
111        thread::spawn(move || {
112            let mut reader = BufReader::new(stdout);
113            loop {
114                match transport::read_message(&mut reader) {
115                    Ok(Some(ServerMessage::Response(response))) => {
116                        if let Ok(mut guard) = reader_pending.lock() {
117                            if let Some(tx) = guard.remove(&response.id) {
118                                if tx.send(response).is_err() {
119                                    log::debug!("[aft-lsp] response channel closed");
120                                }
121                            }
122                        } else {
123                            let _ = event_tx.send(LspEvent::ServerExited {
124                                server_kind: reader_kind,
125                                root: reader_root.clone(),
126                            });
127                            break;
128                        }
129                    }
130                    Ok(Some(ServerMessage::Notification { method, params })) => {
131                        let _ = event_tx.send(LspEvent::Notification {
132                            server_kind: reader_kind,
133                            root: reader_root.clone(),
134                            method,
135                            params,
136                        });
137                    }
138                    Ok(Some(ServerMessage::Request { id, method, params })) => {
139                        // Auto-respond to server requests to prevent deadlocks.
140                        // Server requests (like client/registerCapability,
141                        // window/workDoneProgress/create) block the server until
142                        // we respond. If we don't respond, the server won't send
143                        // responses to OUR pending requests → deadlock.
144                        if let Ok(mut w) = reader_writer.lock() {
145                            let response = super::jsonrpc::OutgoingResponse::success(
146                                id.clone(),
147                                serde_json::Value::Null,
148                            );
149                            let _ = transport::write_response(&mut *w, &response);
150                        }
151                        // Also forward as event for any interested handlers
152                        let _ = event_tx.send(LspEvent::ServerRequest {
153                            server_kind: reader_kind,
154                            root: reader_root.clone(),
155                            id,
156                            method,
157                            params,
158                        });
159                    }
160                    Ok(None) | Err(_) => {
161                        if let Ok(mut guard) = reader_pending.lock() {
162                            guard.clear();
163                        }
164                        let _ = event_tx.send(LspEvent::ServerExited {
165                            server_kind: reader_kind,
166                            root: reader_root.clone(),
167                        });
168                        break;
169                    }
170                }
171            }
172        });
173
174        Ok(Self {
175            kind,
176            root,
177            state: ServerState::Starting,
178            child,
179            writer,
180            pending,
181            next_id: AtomicI64::new(1),
182        })
183    }
184
185    /// Send the initialize request and wait for response. Transition to Ready.
186    pub fn initialize(
187        &mut self,
188        workspace_root: &Path,
189    ) -> Result<lsp_types::InitializeResult, LspError> {
190        self.ensure_can_send()?;
191        self.state = ServerState::Initializing;
192
193        let root_uri = lsp_types::Uri::from_str(&format!("file://{}", workspace_root.display()))
194            .map_err(|_| {
195                LspError::NotFound(format!(
196                    "failed to convert workspace root '{}' to file URI",
197                    workspace_root.display()
198                ))
199            })?;
200
201        let params = serde_json::from_value::<lsp_types::InitializeParams>(json!({
202            "processId": std::process::id(),
203            "rootUri": root_uri,
204            "capabilities": {
205                "workspace": {
206                    "workspaceFolders": true,
207                    "configuration": true
208                },
209                "textDocument": {
210                    "synchronization": {
211                        "dynamicRegistration": false,
212                        "didSave": true,
213                        "willSave": false,
214                        "willSaveWaitUntil": false
215                    },
216                    "publishDiagnostics": {
217                        "relatedInformation": true,
218                        "versionSupport": true,
219                        "codeDescriptionSupport": true,
220                        "dataSupport": true
221                    }
222                }
223            },
224            "clientInfo": {
225                "name": "aft",
226                "version": env!("CARGO_PKG_VERSION")
227            },
228            "workspaceFolders": [
229                {
230                    "uri": root_uri,
231                    "name": workspace_root
232                        .file_name()
233                        .and_then(|name| name.to_str())
234                        .unwrap_or("workspace")
235                }
236            ]
237        }))?;
238
239        let result = self.send_request::<lsp_types::request::Initialize>(params)?;
240        self.send_notification::<lsp_types::notification::Initialized>(serde_json::from_value(
241            json!({}),
242        )?)?;
243        self.state = ServerState::Ready;
244        Ok(result)
245    }
246
247    /// Send a request and wait for the response.
248    pub fn send_request<R>(&mut self, params: R::Params) -> Result<R::Result, LspError>
249    where
250        R: lsp_types::request::Request,
251        R::Params: serde::Serialize,
252        R::Result: DeserializeOwned,
253    {
254        self.ensure_can_send()?;
255
256        let id = RequestId::Int(self.next_id.fetch_add(1, Ordering::Relaxed));
257        let (tx, rx) = bounded(1);
258        {
259            let mut pending = self.lock_pending()?;
260            pending.insert(id.clone(), tx);
261        }
262
263        let request = Request::new(id.clone(), R::METHOD, Some(serde_json::to_value(params)?));
264        {
265            let mut writer = self
266                .writer
267                .lock()
268                .map_err(|_| LspError::ServerNotReady("writer lock poisoned".to_string()))?;
269            if let Err(err) = transport::write_request(&mut *writer, &request) {
270                self.remove_pending(&id);
271                return Err(err.into());
272            }
273        }
274
275        let response = match rx.recv_timeout(REQUEST_TIMEOUT) {
276            Ok(response) => response,
277            Err(RecvTimeoutError::Timeout) => {
278                self.remove_pending(&id);
279                return Err(LspError::Timeout(format!(
280                    "timed out waiting for '{}' response from {:?}",
281                    R::METHOD,
282                    self.kind
283                )));
284            }
285            Err(RecvTimeoutError::Disconnected) => {
286                self.remove_pending(&id);
287                return Err(LspError::ServerNotReady(format!(
288                    "language server {:?} disconnected while waiting for '{}'",
289                    self.kind,
290                    R::METHOD
291                )));
292            }
293        };
294
295        if let Some(error) = response.error {
296            return Err(LspError::ServerError {
297                code: error.code,
298                message: error.message,
299            });
300        }
301
302        serde_json::from_value(response.result.unwrap_or(Value::Null)).map_err(Into::into)
303    }
304
305    /// Send a notification (fire-and-forget).
306    pub fn send_notification<N>(&mut self, params: N::Params) -> Result<(), LspError>
307    where
308        N: lsp_types::notification::Notification,
309        N::Params: serde::Serialize,
310    {
311        self.ensure_can_send()?;
312        let notification = Notification::new(N::METHOD, Some(serde_json::to_value(params)?));
313        let mut writer = self
314            .writer
315            .lock()
316            .map_err(|_| LspError::ServerNotReady("writer lock poisoned".to_string()))?;
317        transport::write_notification(&mut *writer, &notification)?;
318        Ok(())
319    }
320
321    /// Graceful shutdown: send shutdown request, then exit notification.
322    pub fn shutdown(&mut self) -> Result<(), LspError> {
323        if self.state == ServerState::Exited {
324            return Ok(());
325        }
326
327        if self.child.try_wait()?.is_some() {
328            self.state = ServerState::Exited;
329            return Ok(());
330        }
331
332        if let Err(err) = self.send_request::<lsp_types::request::Shutdown>(()) {
333            self.state = ServerState::ShuttingDown;
334            if self.child.try_wait()?.is_some() {
335                self.state = ServerState::Exited;
336                return Ok(());
337            }
338            return Err(err);
339        }
340
341        self.state = ServerState::ShuttingDown;
342
343        if let Err(err) = self.send_notification::<lsp_types::notification::Exit>(()) {
344            if self.child.try_wait()?.is_some() {
345                self.state = ServerState::Exited;
346                return Ok(());
347            }
348            return Err(err);
349        }
350
351        let deadline = Instant::now() + SHUTDOWN_TIMEOUT;
352        loop {
353            if self.child.try_wait()?.is_some() {
354                self.state = ServerState::Exited;
355                return Ok(());
356            }
357            if Instant::now() >= deadline {
358                return Err(LspError::Timeout(format!(
359                    "timed out waiting for {:?} to exit",
360                    self.kind
361                )));
362            }
363            thread::sleep(EXIT_POLL_INTERVAL);
364        }
365    }
366
367    pub fn state(&self) -> ServerState {
368        self.state
369    }
370
371    pub fn kind(&self) -> ServerKind {
372        self.kind
373    }
374
375    pub fn root(&self) -> &Path {
376        &self.root
377    }
378
379    fn ensure_can_send(&self) -> Result<(), LspError> {
380        if matches!(self.state, ServerState::ShuttingDown | ServerState::Exited) {
381            return Err(LspError::ServerNotReady(format!(
382                "language server {:?} is not ready (state: {:?})",
383                self.kind, self.state
384            )));
385        }
386        Ok(())
387    }
388
389    fn lock_pending(&self) -> Result<std::sync::MutexGuard<'_, PendingMap>, LspError> {
390        self.pending
391            .lock()
392            .map_err(|_| io::Error::other("pending response map poisoned").into())
393    }
394
395    fn remove_pending(&self, id: &RequestId) {
396        if let Ok(mut pending) = self.pending.lock() {
397            pending.remove(id);
398        }
399    }
400}