lsp-bridge 0.1.0

A comprehensive Rust library that provides a bridge between Language Server Protocol (LSP) servers and clients
Documentation
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
//! Main LSP Bridge interface coordinating client-server communication.

use crate::client::LspClient;
use crate::config::LspServerConfig;
use crate::error::{LspError, Result};
use crate::protocol::{DocumentState, ServerCapabilities};
use crate::server::{LspServer, LspServerManager, ServerId, ServerState};
use async_trait::async_trait;
use lsp_types::{self, notification::Notification, request::Request, *};
use std::collections::HashMap;
use std::sync::Arc;
use tokio::sync::RwLock;
use tracing::{info, warn};

/// Main LSP Bridge interface that coordinates all LSP operations.
///
/// This is the primary entry point for using the LSP Bridge library.
/// It manages multiple LSP servers, handles document synchronization,
/// and provides a unified interface for LSP operations.
pub struct LspBridge {
    client: Arc<LspClient>,
    server_configs: Arc<RwLock<HashMap<ServerId, LspServerConfig>>>,
}

impl LspBridge {
    /// Create a new LSP Bridge instance.
    pub fn new() -> Self {
        Self {
            client: Arc::new(LspClient::new()),
            server_configs: Arc::new(RwLock::new(HashMap::new())),
        }
    }

    /// Register a new LSP server with the bridge.
    ///
    /// # Arguments
    ///
    /// * `server_id` - Unique identifier for the server
    /// * `config` - Configuration for the server
    ///
    /// # Returns
    ///
    /// The server ID that can be used for subsequent operations.
    pub async fn register_server<I: Into<String>>(
        &mut self,
        server_id: I,
        config: LspServerConfig,
    ) -> Result<ServerId> {
        let server_id: String = server_id.into();

        // Validate configuration
        config.validate()?;

        // Store configuration
        // Explicitly call String::clone for rust-analyzer
        let server_id_for_config: String = String::clone(&server_id);
        self.server_configs
            .write()
            .await
            .insert(server_id_for_config, config.clone());

        // Create server instance - explicit clone for rust-analyzer
        let server_id_for_server: String = String::clone(&server_id);
        let server = LspServer::new(server_id_for_server, config);

        // Register with client - explicit clone for rust-analyzer
        let server_id_for_client: String = String::clone(&server_id);
        self.client
            .register_server(server_id_for_client, server)
            .await?;

        info!("Registered LSP server: {0}", server_id);
        Ok(server_id)
    }

    /// Unregister an LSP server from the bridge.
    pub async fn unregister_server(&mut self, server_id: &str) -> Result<()> {
        // Remove configuration
        self.server_configs.write().await.remove(server_id);

        // Unregister from client
        self.client.unregister_server(server_id).await?;

        info!("Unregistered LSP server: {0}", server_id);
        Ok(())
    }

    /// Start an LSP server.
    pub async fn start_server(&mut self, server_id: &str) -> Result<()> {
        if let Some(server) = self.client.get_server(server_id) {
            server.write().await.start().await?;
            info!("Started LSP server: {0}", server_id);
            Ok(())
        } else {
            Err(LspError::server_not_found(server_id).into())
        }
    }

    /// Stop an LSP server.
    pub async fn stop_server(&mut self, server_id: &str) -> Result<()> {
        if let Some(server) = self.client.get_server(server_id) {
            server.write().await.stop().await?;
            info!("Stopped LSP server: {0}", server_id);
            Ok(())
        } else {
            Err(LspError::server_not_found(server_id).into())
        }
    }

    /// Restart an LSP server.
    pub async fn restart_server(&mut self, server_id: &str) -> Result<()> {
        if let Some(server) = self.client.get_server(server_id) {
            server.write().await.restart().await?;
            info!("Restarted LSP server: {0}", server_id);
            Ok(())
        } else {
            Err(LspError::server_not_found(server_id).into())
        }
    }

    /// Get the state of an LSP server.
    pub async fn server_state(&self, server_id: &str) -> Result<ServerState> {
        if let Some(server) = self.client.get_server(server_id) {
            Ok(server.read().await.state().await)
        } else {
            Err(LspError::server_not_found(server_id).into())
        }
    }

    /// Get the capabilities of an LSP server.
    pub async fn server_capabilities(&self, server_id: &str) -> Result<ServerCapabilities> {
        if let Some(server) = self.client.get_server(server_id) {
            if let Some(capabilities) = server.read().await.capabilities().await {
                Ok(capabilities)
            } else {
                Err(LspError::custom("Server capabilities not available").into())
            }
        } else {
            Err(LspError::server_not_found(server_id).into())
        }
    }

    /// Set the active server for operations that don't specify a server.
    pub async fn set_active_server(&self, server_id: Option<ServerId>) -> Result<()> {
        self.client.set_active_server(server_id).await
    }

    /// Get the active server ID.
    pub async fn active_server(&self) -> Option<ServerId> {
        self.client.active_server().await
    }

    /// Wait for a server to become ready.
    pub async fn wait_server_ready(&self, server_id: &str) -> Result<()> {
        self.client.wait_server_ready(server_id, 30).await
    }

    /// Open a document in an LSP server.
    pub async fn open_document(&self, server_id: &str, uri: &str, content: &str) -> Result<()> {
        // Determine language ID from URI
        let language_id = self.detect_language_id(uri);

        self.client
            .open_document(server_id, uri, content, &language_id)
            .await
    }

    /// Close a document in an LSP server.
    pub async fn close_document(&self, server_id: &str, uri: &str) -> Result<()> {
        self.client.close_document(server_id, uri).await
    }

    /// Update document content.
    pub async fn update_document(&self, server_id: &str, uri: &str, content: &str) -> Result<()> {
        self.client.update_document(server_id, uri, content).await
    }

    /// Request completions for a document position.
    pub async fn get_completions(
        &self,
        server_id: &str,
        uri: &str,
        position: Position,
    ) -> Result<Vec<CompletionItem>> {
        self.client.get_completions(server_id, uri, position).await
    }

    /// Get hover information for a document position.
    pub async fn get_hover(
        &self,
        server_id: &str,
        uri: &str,
        position: Position,
    ) -> Result<Option<Hover>> {
        self.client.get_hover(server_id, uri, position).await
    }

    /// Go to definition for a document position.
    pub async fn go_to_definition(
        &self,
        server_id: &str,
        uri: &str,
        position: Position,
    ) -> Result<Option<Location>> {
        let response = self
            .client
            .go_to_definition(server_id, uri, position)
            .await?;

        match response {
            Some(GotoDefinitionResponse::Scalar(location)) => Ok(Some(location)),
            Some(GotoDefinitionResponse::Array(locations)) => Ok(locations.into_iter().next()),
            Some(GotoDefinitionResponse::Link(links)) => {
                Ok(links.into_iter().next().map(|link| Location {
                    uri: link.target_uri,
                    range: link.target_selection_range,
                }))
            }
            None => Ok(None),
        }
    }

    /// Find references for a document position.
    pub async fn find_references(
        &self,
        server_id: &str,
        uri: &str,
        position: Position,
    ) -> Result<Vec<Location>> {
        self.client
            .find_references(server_id, uri, position, false)
            .await
    }

    /// Format a document.
    pub async fn format_document(&self, server_id: &str, uri: &str) -> Result<Vec<TextEdit>> {
        let options = FormattingOptions {
            tab_size: 4,
            insert_spaces: true,
            properties: HashMap::new(),
            trim_trailing_whitespace: Some(true),
            insert_final_newline: Some(true),
            trim_final_newlines: Some(true),
        };

        self.client.format_document(server_id, uri, options).await
    }

    /// Get diagnostics for a document.
    pub fn get_diagnostics(&self, server_id: &str, uri: &str) -> Result<Vec<Diagnostic>> {
        // Verify server exists
        if self.client.get_server(server_id).is_none() {
            return Err(LspError::server_not_found(server_id).into());
        }

        Ok(self.client.get_diagnostics(uri))
    }

    /// Send a custom request to a server.
    pub async fn request<R: Request>(&self, server_id: &str, params: R::Params) -> Result<R::Result>
    where
        R::Params: serde::Serialize,
        R::Result: serde::de::DeserializeOwned,
    {
        if let Some(server) = self.client.get_server(server_id) {
            let response = server
                .read()
                .await
                .request(R::METHOD.to_string(), Some(serde_json::to_value(params)?))
                .await?;

            let result: R::Result = serde_json::from_value(response)?;
            Ok(result)
        } else {
            Err(LspError::server_not_found(server_id).into())
        }
    }

    /// Send a custom notification to a server.
    pub async fn notify<N: Notification>(&self, server_id: &str, params: N::Params) -> Result<()>
    where
        N::Params: serde::Serialize,
    {
        if let Some(server) = self.client.get_server(server_id) {
            server
                .read()
                .await
                .notify(N::METHOD.to_string(), Some(serde_json::to_value(params)?))
                .await?;
            Ok(())
        } else {
            Err(LspError::server_not_found(server_id).into())
        }
    }

    /// Get document state.
    pub fn get_document_state(&self, uri: &str) -> Option<DocumentState> {
        self.client.get_document_state(uri)
    }

    /// List all open documents.
    pub fn list_documents(&self) -> Vec<String> {
        self.client.list_documents()
    }

    /// Get the number of registered servers (for testing/debugging).
    pub fn server_count(&self) -> usize {
        self.client.server_count()
    }

    /// Check if a server is registered (for testing/debugging).
    pub fn has_server(&self, server_id: &str) -> bool {
        self.client.get_server(server_id).is_some()
    }

    /// List all registered server IDs (for testing/debugging).
    pub fn list_servers(&self) -> Vec<String> {
        self.client.list_servers()
    }

    /// Shutdown all servers and cleanup.
    pub async fn shutdown(&mut self) -> Result<()> {
        info!("Shutting down LSP Bridge");

        let servers = self.list_servers();
        for server_id in servers {
            if let Err(e) = self.stop_server(&server_id).await {
                warn!("Error stopping server {0}: {1}", server_id, e);
            }
        }

        self.server_configs.write().await.clear();

        info!("LSP Bridge shutdown complete");
        Ok(())
    }

    /// Detect language ID from file URI.
    fn detect_language_id(&self, uri: &str) -> String {
        // Extract file extension and map to language ID
        if let Some(extension) = uri.split('.').next_back() {
            match extension {
                "rs" => "rust",
                "py" => "python",
                "js" => "javascript",
                "ts" => "typescript",
                "json" => "json",
                "yaml" | "yml" => "yaml",
                "toml" => "toml",
                "md" => "markdown",
                "html" => "html",
                "css" => "css",
                "cpp" | "cc" | "cxx" => "cpp",
                "c" => "c",
                "h" | "hpp" => "c",
                "java" => "java",
                "go" => "go",
                "php" => "php",
                "rb" => "ruby",
                "swift" => "swift",
                "kt" => "kotlin",
                "cs" => "csharp",
                _ => "plaintext",
            }
            .to_string()
        } else {
            "plaintext".to_string()
        }
    }

    /// Get signature help at a position.
    pub async fn get_signature_help(
        &self,
        server_id: &str,
        uri: &str,
        position: Position,
    ) -> Result<Option<SignatureHelp>> {
        self.client.get_signature_help(server_id, uri, position).await
    }

    /// Get document symbols.
    pub async fn get_document_symbols(
        &self,
        server_id: &str,
        uri: &str,
    ) -> Result<Vec<DocumentSymbol>> {
        self.client.get_document_symbols(server_id, uri).await
    }

    /// Get workspace symbols.
    pub async fn get_workspace_symbols(
        &self,
        server_id: &str,
        query: &str,
    ) -> Result<Vec<SymbolInformation>> {
        self.client.get_workspace_symbols(server_id, query).await
    }

    /// Get code actions for a range.
    pub async fn get_code_actions(
        &self,
        server_id: &str,
        uri: &str,
        range: Range,
        context: CodeActionContext,
    ) -> Result<Vec<CodeActionOrCommand>> {
        self.client.get_code_actions(server_id, uri, range, context).await
    }

    /// Rename a symbol.
    pub async fn rename_symbol(
        &self,
        server_id: &str,
        uri: &str,
        position: Position,
        new_name: &str,
    ) -> Result<Option<WorkspaceEdit>> {
        self.client.rename_symbol(server_id, uri, position, new_name).await
    }

    /// Apply text edits to content and return the result.
    pub fn apply_text_edits(&self, content: &str, edits: &[TextEdit]) -> Result<String> {
        crate::utils::document::apply_edits(content, edits)
    }
}

#[async_trait]
impl LspServerManager for LspBridge {
    async fn start_server(&mut self, server_id: &str) -> Result<()> {
        self.start_server(server_id).await
    }

    async fn stop_server(&mut self, server_id: &str) -> Result<()> {
        self.stop_server(server_id).await
    }

    async fn restart_server(&mut self, server_id: &str) -> Result<()> {
        self.restart_server(server_id).await
    }

    async fn server_state(&self, server_id: &str) -> Result<ServerState> {
        self.server_state(server_id).await
    }

    async fn server_capabilities(&self, server_id: &str) -> Result<ServerCapabilities> {
        self.server_capabilities(server_id).await
    }

    async fn server_request(
        &self,
        server_id: &str,
        method: String,
        params: Option<serde_json::Value>,
    ) -> Result<serde_json::Value> {
        if let Some(server) = self.client.get_server(server_id) {
            server.read().await.request(method, params).await
        } else {
            Err(LspError::server_not_found(server_id).into())
        }
    }

    async fn server_notify(
        &self,
        server_id: &str,
        method: String,
        params: Option<serde_json::Value>,
    ) -> Result<()> {
        if let Some(server) = self.client.get_server(server_id) {
            server.read().await.notify(method, params).await
        } else {
            Err(LspError::server_not_found(server_id).into())
        }
    }
}

impl Default for LspBridge {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::time::Duration;

    #[tokio::test]
    async fn test_bridge_creation() {
        let bridge = LspBridge::new();
        assert_eq!(bridge.server_count(), 0);
    }

    #[tokio::test]
    async fn test_server_registration() {
        let mut bridge = LspBridge::new();
        let config = LspServerConfig::new()
            .command("test-server")
            .startup_timeout(Duration::from_secs(5));

        let server_id = bridge.register_server("test", config).await.unwrap();
        assert_eq!(server_id, "test");
        assert_eq!(bridge.server_count(), 1);
    }

    #[test]
    fn test_language_detection() {
        let bridge = LspBridge::new();

        assert_eq!(bridge.detect_language_id("file:///test.rs"), "rust");
        assert_eq!(bridge.detect_language_id("file:///test.py"), "python");
        assert_eq!(bridge.detect_language_id("file:///test.js"), "javascript");
        assert_eq!(
            bridge.detect_language_id("file:///test.unknown"),
            "plaintext"
        );
    }

    #[test]
    fn test_text_edits() {
        let bridge = LspBridge::new();
        let content = "line 1\nline 2\nline 3";

        let edits = vec![TextEdit {
            range: Range {
                start: Position {
                    line: 1,
                    character: 0,
                },
                end: Position {
                    line: 1,
                    character: 6,
                },
            },
            new_text: "modified".to_string(),
        }];

        let result = bridge.apply_text_edits(content, &edits).unwrap();
        assert_eq!(result, "line 1\nmodified\nline 3");
    }
}