lsp-cli 0.1.0

Command-line tool for talking to Language Server Protocol (LSP) servers from the terminal.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
use super::{
    BACKGROUND_ENV, ClientPhase, ClientSession, Daemon, DaemonArgs, DaemonTarget, POLL_INTERVAL,
    ReaderEvent, UPSTREAM_SHUTDOWN_TIMEOUT, UpstreamServer,
};
use crate::commands::common::prepare_workspace;
use crate::config::ConfigStore;
use crate::lsp::transport::read_message;
use crate::lsp::{jsonrpc, path_to_file_uri, workspace_name};
use crate::runtime_state::{daemon_socket_path, default_daemon_root};
use crate::server_stderr::CapturedStderr;
use crate::system_log::{
    log_lsp_server_exit, log_lsp_server_started, log_lsp_server_starting, log_unexpected_error,
};
use lsp_types::notification::{Exit, Notification};
use lsp_types::request::{Request, Shutdown};
use serde_json::Value;
use std::collections::{BTreeMap, BTreeSet};
use std::fs::{self, File};
use std::io::{BufRead, BufReader, Write};
use std::os::unix::net::{UnixListener, UnixStream};
use std::path::Path;
use std::process::{Command, Stdio};
use std::sync::mpsc::{self, Receiver};
use std::thread;
use std::time::Instant;

pub(super) fn resolve_target(
    args: &DaemonArgs,
    config: &ConfigStore,
) -> Result<DaemonTarget, String> {
    let workspace = prepare_workspace(
        &args.path,
        args.lsp.as_deref(),
        args.lang.as_deref(),
        args.download,
        config,
    )?;
    let server = workspace.server;
    let workspace_root = fs::canonicalize(&server.workspace_root).map_err(|error| {
        format!(
            "failed to resolve {}: {error}",
            server.workspace_root.display()
        )
    })?;
    let workspace_root_string = workspace_root.display().to_string();
    let root_uri = path_to_file_uri(&workspace_root)?;
    let workspace_name = workspace_name(&workspace_root);
    let socket_root = default_daemon_root()?;
    fs::create_dir_all(&socket_root)
        .map_err(|error| format!("failed to create {}: {error}", socket_root.display()))?;

    #[cfg(unix)]
    {
        use std::os::unix::fs::PermissionsExt;

        let permissions = fs::Permissions::from_mode(0o700);
        fs::set_permissions(&socket_root, permissions).map_err(|error| {
            format!(
                "failed to secure daemon socket root {}: {error}",
                socket_root.display()
            )
        })?;
    }

    let socket_path = daemon_socket_path(
        &socket_root,
        &workspace_root,
        &server.server,
        &server.command,
    );

    Ok(DaemonTarget {
        path: args.path.clone(),
        workspace_root_string,
        root_uri,
        workspace_name,
        server_name: server.server,
        socket_path,
    })
}

pub(super) fn launch_background(
    args: &DaemonArgs,
    target: &DaemonTarget,
) -> Result<String, String> {
    launch_background_for_connection(
        &args.path,
        &target.server_name,
        &target.socket_path,
        args.debug,
        args.idle_timeout,
    )?;
    Ok(target.socket_path.display().to_string())
}

pub(super) fn launch_background_for_connection(
    path: &Path,
    server_name: &str,
    socket_path: &Path,
    debug: bool,
    idle_timeout: std::time::Duration,
) -> Result<(), String> {
    let executable = std::env::current_exe()
        .map_err(|error| format!("failed to resolve lsp-cli executable: {error}"))?;
    let devnull =
        File::open("/dev/null").map_err(|error| format!("failed to open /dev/null: {error}"))?;
    let mut command = Command::new(executable);
    command
        .arg("daemon")
        .arg(path)
        .env(BACKGROUND_ENV, "1")
        .stdin(Stdio::from(devnull))
        .stdout(Stdio::piped())
        .stderr(Stdio::null());

    command.arg("--lsp").arg(server_name);
    if debug {
        command.arg("--debug");
    }
    command
        .arg("--idle-timeout")
        .arg(idle_timeout.as_secs_f64().to_string());

    let mut child = command
        .spawn()
        .map_err(|error| format!("failed to start daemon process: {error}"))?;
    let stdout = child
        .stdout
        .take()
        .ok_or_else(|| "failed to capture daemon startup status".to_string())?;
    let mut reader = BufReader::new(stdout);
    let mut status = String::new();
    let mut payload = String::new();
    reader
        .read_line(&mut status)
        .map_err(|error| format!("failed to read daemon startup status: {error}"))?;
    reader
        .read_line(&mut payload)
        .map_err(|error| format!("failed to read daemon startup payload: {error}"))?;

    match status.trim_end() {
        "READY" => {
            let payload = payload.trim_end().to_string();
            if payload.is_empty() {
                return Err("daemon started without reporting a socket path".to_string());
            }
            if payload != socket_path.display().to_string() {
                return Err(format!(
                    "daemon reported unexpected socket path {payload:?}, expected {}",
                    socket_path.display()
                ));
            }
            Ok(())
        }
        "ERROR" => Err(payload.trim_end().to_string()),
        other => Err(format!("unexpected daemon startup status {other:?}")),
    }
}

pub(super) fn run_background(args: &DaemonArgs, target: DaemonTarget) -> Result<String, String> {
    let mut daemon = match unsafe { setsid_wrapper() }
        .and_then(|()| Daemon::new(target, args.debug, args.idle_timeout))
    {
        Ok(daemon) => daemon,
        Err(error) => {
            let _ = print_startup_status("ERROR", &error);
            return Err(error);
        }
    };
    print_startup_status("READY", &daemon.target.socket_path.display().to_string())?;
    daemon.serve()?;
    Ok(String::new())
}

fn print_startup_status(status: &str, payload: &str) -> Result<(), String> {
    let mut stdout = std::io::stdout().lock();
    writeln!(stdout, "{status}")
        .map_err(|error| format!("failed to report daemon status: {error}"))?;
    writeln!(stdout, "{payload}")
        .and_then(|()| stdout.flush())
        .map_err(|error| format!("failed to flush daemon status: {error}"))
}

pub(super) fn bind_listener(socket_path: &Path) -> Result<UnixListener, String> {
    if socket_path.exists() {
        match UnixStream::connect(socket_path) {
            Ok(_) => {
                return Err(format!(
                    "a daemon is already listening on {}",
                    socket_path.display()
                ));
            }
            Err(_) => {
                fs::remove_file(socket_path).map_err(|error| {
                    format!(
                        "failed to remove stale socket {}: {error}",
                        socket_path.display()
                    )
                })?;
            }
        }
    }

    UnixListener::bind(socket_path).map_err(|error| {
        format!(
            "failed to bind daemon socket {}: {error}",
            socket_path.display()
        )
    })
}

pub(super) fn spawn_reader<R>(reader: R) -> Receiver<ReaderEvent>
where
    R: std::io::Read + Send + 'static,
{
    let (sender, receiver) = mpsc::channel();
    thread::spawn(move || {
        let mut reader = BufReader::new(reader);
        loop {
            match read_message(&mut reader) {
                Ok(Some(message)) => {
                    if sender.send(ReaderEvent::Message(message)).is_err() {
                        return;
                    }
                }
                Ok(None) => {
                    let _ = sender.send(ReaderEvent::EndOfStream);
                    return;
                }
                Err(error) => {
                    let _ = sender.send(ReaderEvent::Error(error));
                    return;
                }
            }
        }
    });
    receiver
}

impl ClientSession {
    pub(super) fn new(stream: UnixStream) -> Result<Self, String> {
        let reader = stream
            .try_clone()
            .map_err(|error| format!("failed to clone client socket: {error}"))?;

        Ok(Self {
            writer: stream,
            messages: spawn_reader(reader),
            phase: ClientPhase::WaitingForInitialize,
            wants_background_work: false,
            forwarded_client_requests: BTreeSet::new(),
            pending_server_requests: BTreeMap::new(),
            open_documents: BTreeSet::new(),
        })
    }
}

impl UpstreamServer {
    pub(super) fn spawn(target: &DaemonTarget, debug: bool) -> Result<Self, String> {
        let executable = std::env::current_exe()
            .map_err(|error| format!("failed to resolve lsp-cli executable: {error}"))?;
        let mut command = Command::new(executable);
        command
            .arg("run")
            .arg(&target.path)
            .stdin(Stdio::piped())
            .stdout(Stdio::piped())
            .stderr(Stdio::piped());

        if debug {
            command.arg("--debug");
        }

        command.arg("--lsp").arg(&target.server_name);

        log_lsp_server_starting();
        let mut child = command.spawn().map_err(|error| {
            let error = format!(
                "failed to start lsp-cli run for {}: {error}",
                target.server_name
            );
            log_unexpected_error(&error);
            error
        })?;
        log_lsp_server_started(child.id());
        let stdin = child.stdin.take().ok_or_else(|| {
            let error = "failed to open LSP server stdin".to_string();
            log_unexpected_error(&error);
            error
        })?;
        let stdout = child.stdout.take().ok_or_else(|| {
            let error = "failed to open LSP server stdout".to_string();
            log_unexpected_error(&error);
            error
        })?;
        let stderr = CapturedStderr::spawn(
            child.stderr.take().ok_or_else(|| {
                let error = "failed to open LSP server stderr".to_string();
                log_unexpected_error(&error);
                error
            })?,
            debug,
        );

        Ok(Self {
            child,
            stdin,
            stderr,
            messages: spawn_reader(stdout),
            initialize_fingerprint: None,
            initialize_result: None,
            restart_required: false,
            background_work: super::BackgroundWorkTracker::default(),
        })
    }

    pub(super) fn shutdown(&mut self, debug: bool) -> Result<(), String> {
        let _ = self.stderr.summary();
        if self.initialize_fingerprint.is_some() {
            let shutdown_id = Value::String("lsp-cli/daemon-shutdown".to_string());
            let shutdown = jsonrpc(Some(shutdown_id.clone()), Shutdown::METHOD, &())?;
            crate::lsp::transport::log_debug_message(debug, "daemon upstream <- ", &shutdown);
            let _ = crate::lsp::transport::write_message(&mut self.stdin, &shutdown);

            let started = Instant::now();
            while started.elapsed() < UPSTREAM_SHUTDOWN_TIMEOUT {
                let Some(remaining) = UPSTREAM_SHUTDOWN_TIMEOUT.checked_sub(started.elapsed())
                else {
                    break;
                };

                match self.messages.recv_timeout(remaining) {
                    Ok(ReaderEvent::Message(message)) => {
                        if super::response_id(&message).as_ref().is_some_and(|value| {
                            *value == Value::String("lsp-cli/daemon-shutdown".to_string())
                        }) {
                            break;
                        }
                    }
                    Ok(ReaderEvent::EndOfStream | ReaderEvent::Error(_)) | Err(_) => break,
                }
            }

            let exit = jsonrpc::<u64, _>(None, Exit::METHOD, &())?;
            crate::lsp::transport::log_debug_message(debug, "daemon upstream <- ", &exit);
            let _ = crate::lsp::transport::write_message(&mut self.stdin, &exit);
        }

        match self.child.try_wait() {
            Ok(Some(status)) => {
                log_lsp_server_exit(status);
                return Ok(());
            }
            Ok(None) => {}
            Err(error) => {
                let error = format!("failed to inspect LSP server process: {error}");
                log_unexpected_error(&error);
                return Err(error);
            }
        }

        let started = Instant::now();
        while started.elapsed() < UPSTREAM_SHUTDOWN_TIMEOUT {
            match self.child.try_wait() {
                Ok(Some(status)) => {
                    log_lsp_server_exit(status);
                    return Ok(());
                }
                Ok(None) => thread::sleep(POLL_INTERVAL),
                Err(error) => {
                    let error = format!("failed to wait for LSP server exit: {error}");
                    log_unexpected_error(&error);
                    return Err(error);
                }
            }
        }

        self.child.kill().map_err(|error| {
            let error = format!("failed to stop LSP server process: {error}");
            log_unexpected_error(&error);
            error
        })?;
        let status = self.child.wait().map_err(|error| {
            let error = format!("failed to reap LSP server process: {error}");
            log_unexpected_error(&error);
            error
        })?;
        log_lsp_server_exit(status);
        Ok(())
    }
}

unsafe fn setsid_wrapper() -> Result<(), String> {
    unsafe extern "C" {
        fn setsid() -> i32;
    }

    if unsafe { setsid() } == -1 {
        return Err(format!(
            "failed to detach daemon from terminal: {}",
            std::io::Error::last_os_error()
        ));
    }

    Ok(())
}