sway_lsp/server_state.rs
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
//! The context or environment in which the language server functions.
use crate::{
config::{Config, GarbageCollectionConfig, Warnings},
core::{
document::{Documents, PidLockedFiles},
session::{self, Session},
},
error::{DirectoryError, DocumentError, LanguageServerError},
utils::{debug, keyword_docs::KeywordDocs},
};
use crossbeam_channel::{Receiver, Sender};
use dashmap::{mapref::multiple::RefMulti, DashMap};
use forc_pkg::manifest::GenericManifestFile;
use forc_pkg::PackageManifestFile;
use lsp_types::{Diagnostic, Url};
use parking_lot::{Mutex, RwLock};
use std::{
collections::{BTreeMap, VecDeque},
process::Command,
};
use std::{
mem,
path::PathBuf,
sync::{
atomic::{AtomicBool, Ordering},
Arc,
},
};
use sway_core::LspConfig;
use tokio::sync::Notify;
use tower_lsp::{jsonrpc, Client};
const DEFAULT_SESSION_CACHE_CAPACITY: usize = 4;
/// `ServerState` is the primary mutable state of the language server
pub struct ServerState {
pub(crate) client: Option<Client>,
pub config: Arc<RwLock<Config>>,
pub(crate) keyword_docs: Arc<KeywordDocs>,
/// A Least Recently Used (LRU) cache of [Session]s, each representing a project opened in the user's workspace.
/// This cache limits memory usage by maintaining a fixed number of active sessions, automatically
/// evicting the least recently used sessions when the capacity is reached.
pub sessions: LruSessionCache,
pub documents: Documents,
// Compilation thread related fields
pub(crate) retrigger_compilation: Arc<AtomicBool>,
pub is_compiling: Arc<AtomicBool>,
pub(crate) cb_tx: Sender<TaskMessage>,
pub(crate) cb_rx: Arc<Receiver<TaskMessage>>,
pub(crate) finished_compilation: Arc<Notify>,
pub(crate) pid_locked_files: PidLockedFiles,
manifest_cache: DashMap<Url, Arc<PathBuf>>,
last_compilation_state: Arc<RwLock<LastCompilationState>>,
}
impl Default for ServerState {
fn default() -> Self {
let (cb_tx, cb_rx) = crossbeam_channel::bounded(1);
let state = ServerState {
client: None,
config: Arc::new(RwLock::new(Config::default())),
keyword_docs: Arc::new(KeywordDocs::new()),
sessions: LruSessionCache::new(DEFAULT_SESSION_CACHE_CAPACITY),
documents: Documents::new(),
retrigger_compilation: Arc::new(AtomicBool::new(false)),
is_compiling: Arc::new(AtomicBool::new(false)),
cb_tx,
cb_rx: Arc::new(cb_rx),
finished_compilation: Arc::new(Notify::new()),
pid_locked_files: PidLockedFiles::new(),
manifest_cache: DashMap::new(),
last_compilation_state: Arc::new(RwLock::new(LastCompilationState::Uninitialized)),
};
// Spawn a new thread dedicated to handling compilation tasks
state.spawn_compilation_thread();
state
}
}
/// `LastCompilationState` represents the state of the last compilation process.
/// It is primarily used for debugging purposes.
#[derive(Debug, PartialEq)]
enum LastCompilationState {
Success,
Failed,
Uninitialized,
}
/// `TaskMessage` represents the set of messages or commands that can be sent to and processed by a worker thread in the compilation environment.
#[derive(Debug)]
pub enum TaskMessage {
CompilationContext(CompilationContext),
// A signal to the receiving thread to gracefully terminate its operation.
Terminate,
}
/// `CompilationContext` encapsulates all the necessary details required by the compilation thread to execute a compilation process.
/// It acts as a container for shared resources and state information relevant to a specific compilation task.
#[derive(Debug, Default)]
pub struct CompilationContext {
pub session: Option<Arc<Session>>,
pub uri: Option<Url>,
pub version: Option<i32>,
pub optimized_build: bool,
pub gc_options: GarbageCollectionConfig,
pub file_versions: BTreeMap<PathBuf, Option<u64>>,
}
impl ServerState {
pub fn new(client: Client) -> ServerState {
ServerState {
client: Some(client),
..Default::default()
}
}
/// Spawns a new thread dedicated to handling compilation tasks. This thread listens for
/// `TaskMessage` instances sent over a channel and processes them accordingly.
///
/// This approach allows for asynchronous compilation tasks to be handled in parallel to
/// the main application flow, improving efficiency and responsiveness.
pub fn spawn_compilation_thread(&self) {
let is_compiling = self.is_compiling.clone();
let retrigger_compilation = self.retrigger_compilation.clone();
let finished_compilation = self.finished_compilation.clone();
let rx = self.cb_rx.clone();
let last_compilation_state = self.last_compilation_state.clone();
std::thread::spawn(move || {
while let Ok(msg) = rx.recv() {
match msg {
TaskMessage::CompilationContext(ctx) => {
let uri = ctx.uri.as_ref().unwrap().clone();
let session = ctx.session.as_ref().unwrap().clone();
let mut engines_clone = session.engines.read().clone();
// Perform garbage collection if enabled to manage memory usage.
if ctx.gc_options.gc_enabled {
// Call this on the engines clone so we don't clear types that are still in use
// and might be needed in the case cancel compilation was triggered.
if let Err(err) =
session.garbage_collect_module(&mut engines_clone, &uri)
{
tracing::error!(
"Unable to perform garbage collection: {}",
err.to_string()
);
}
}
let lsp_mode = Some(LspConfig {
optimized_build: ctx.optimized_build,
file_versions: ctx.file_versions,
});
// Set the is_compiling flag to true so that the wait_for_parsing function knows that we are compiling
is_compiling.store(true, Ordering::SeqCst);
match session::parse_project(
&uri,
&engines_clone,
Some(retrigger_compilation.clone()),
lsp_mode,
session.clone(),
) {
Ok(()) => {
let path = uri.to_file_path().unwrap();
// Find the program id from the path
match session::program_id_from_path(&path, &engines_clone) {
Ok(program_id) => {
// Use the program id to get the metrics for the program
if let Some(metrics) = session.metrics.get(&program_id) {
// It's very important to check if the workspace AST was reused to determine if we need to overwrite the engines.
// Because the engines_clone has garbage collection applied. If the workspace AST was reused, we need to keep the old engines
// as the engines_clone might have cleared some types that are still in use.
if metrics.reused_programs == 0 {
// Commit local changes in the programs, module, and function caches to the shared state.
// This ensures that any modifications made during compilation are preserved
// before we swap the engines.
engines_clone.qe().commit();
// The compiler did not reuse the workspace AST.
// We need to overwrite the old engines with the engines clone.
mem::swap(
&mut *session.engines.write(),
&mut engines_clone,
);
}
}
*last_compilation_state.write() =
LastCompilationState::Success;
}
Err(err) => {
tracing::error!("{}", err.to_string());
*last_compilation_state.write() =
LastCompilationState::Failed;
}
}
}
Err(_err) => {
*last_compilation_state.write() = LastCompilationState::Failed;
}
}
// Reset the flags to false
is_compiling.store(false, Ordering::SeqCst);
retrigger_compilation.store(false, Ordering::SeqCst);
// Make sure there isn't any pending compilation work
if rx.is_empty() {
// finished compilation, notify waiters
finished_compilation.notify_waiters();
}
}
TaskMessage::Terminate => {
// If we receive a terminate message, we need to exit the thread
return;
}
}
}
});
}
/// Spawns a new thread dedicated to checking if the client process is still active,
/// and if not, shutting down the server.
pub fn spawn_client_heartbeat(&self, client_pid: usize) {
tokio::spawn(async move {
loop {
// Not using sysinfo here because it has compatibility issues with fuel.nix
// https://github.com/FuelLabs/fuel.nix/issues/64
let output = Command::new("ps")
.arg("-p")
.arg(client_pid.to_string())
.output()
.expect("Failed to execute ps command");
if String::from_utf8_lossy(&output.stdout).contains(&format!("{client_pid} ")) {
tracing::trace!("Client Heartbeat: still running ({client_pid})");
} else {
std::process::exit(0);
}
tokio::time::sleep(std::time::Duration::from_secs(60)).await;
}
});
}
/// Waits asynchronously for the `is_compiling` flag to become false.
///
/// This function checks the state of `is_compiling`, and if it's true,
/// it awaits on a notification. Once notified, it checks again, repeating
/// this process until `is_compiling` becomes false.
pub async fn wait_for_parsing(&self) {
loop {
// Check both the is_compiling flag and the last_compilation_state.
// Wait if is_compiling is true or if the last_compilation_state is Uninitialized.
if !self.is_compiling.load(Ordering::SeqCst)
&& *self.last_compilation_state.read() != LastCompilationState::Uninitialized
{
// compilation is finished, lets check if there are pending compilation requests.
if self.cb_rx.is_empty() {
// no pending compilation work, safe to break.
break;
}
}
// We are still compiling, lets wait to be notified.
self.finished_compilation.notified().await;
}
}
pub fn shutdown_server(&self) -> jsonrpc::Result<()> {
let _p = tracing::trace_span!("shutdown_server").entered();
tracing::info!("Shutting Down the Sway Language Server");
// Drain pending compilation requests
while self.cb_rx.try_recv().is_ok() {}
// Set the retrigger_compilation flag to true so that the compilation exits early
self.retrigger_compilation.store(true, Ordering::SeqCst);
// Send a terminate message to the compilation thread
self.cb_tx
.send(TaskMessage::Terminate)
.expect("failed to send terminate message");
let _ = self.sessions.iter().map(|item| {
let session = item.value();
session.shutdown();
});
Ok(())
}
pub(crate) async fn publish_diagnostics(
&self,
uri: Url,
workspace_uri: Url,
session: Arc<Session>,
) {
let diagnostics = self.diagnostics(&uri, session.clone());
// Note: Even if the computed diagnostics vec is empty, we still have to push the empty Vec
// in order to clear former diagnostics. Newly pushed diagnostics always replace previously pushed diagnostics.
if let Some(client) = self.client.as_ref() {
client
.publish_diagnostics(workspace_uri.clone(), diagnostics, None)
.await;
}
}
fn diagnostics(&self, uri: &Url, session: Arc<Session>) -> Vec<Diagnostic> {
let mut diagnostics_to_publish = vec![];
let config = &self.config.read();
let tokens = session.token_map().tokens_for_file(uri);
match config.debug.show_collected_tokens_as_warnings {
// If collected_tokens_as_warnings is Parsed or Typed,
// take over the normal error and warning display behavior
// and instead show the either the parsed or typed tokens as warnings.
// This is useful for debugging the lsp parser.
Warnings::Parsed => {
diagnostics_to_publish = debug::generate_warnings_for_parsed_tokens(tokens);
}
Warnings::Typed => {
diagnostics_to_publish = debug::generate_warnings_for_typed_tokens(tokens);
}
Warnings::Default => {
if let Some(diagnostics) =
session.diagnostics.read().get(&PathBuf::from(uri.path()))
{
if config.diagnostic.show_warnings {
diagnostics_to_publish.extend(diagnostics.warnings.clone());
}
if config.diagnostic.show_errors {
diagnostics_to_publish.extend(diagnostics.errors.clone());
}
}
}
}
diagnostics_to_publish
}
/// Constructs and returns a tuple of `(Url, Arc<Session>)` from a given workspace URI.
/// The returned URL represents the temp directory workspace.
pub async fn uri_and_session_from_workspace(
&self,
workspace_uri: &Url,
) -> Result<(Url, Arc<Session>), LanguageServerError> {
let session = self.url_to_session(workspace_uri).await?;
let uri = session.sync.workspace_to_temp_url(workspace_uri)?;
Ok((uri, session))
}
async fn url_to_session(&self, uri: &Url) -> Result<Arc<Session>, LanguageServerError> {
// Try to get the manifest directory from the cache
let manifest_dir = if let Some(cached_dir) = self.manifest_cache.get(uri) {
cached_dir.clone()
} else {
// Otherwise, find the manifest directory from the uri and cache it
let path = PathBuf::from(uri.path());
let manifest = PackageManifestFile::from_dir(&path).map_err(|_| {
DocumentError::ManifestFileNotFound {
dir: path.to_string_lossy().to_string(),
}
})?;
let dir = Arc::new(
manifest
.path()
.parent()
.ok_or(DirectoryError::ManifestDirNotFound)?
.to_path_buf(),
);
self.manifest_cache.insert(uri.clone(), dir.clone());
dir
};
// If the session is already in the cache, return it
if let Some(session) = self.sessions.get(&manifest_dir) {
return Ok(session);
}
// If no session can be found, then we need to call init and insert a new session into the map
let session = Arc::new(Session::new());
session.init(uri, &self.documents).await?;
self.sessions
.insert((*manifest_dir).clone(), session.clone());
Ok(session)
}
}
/// A Least Recently Used (LRU) cache for storing and managing `Session` objects.
/// This cache helps limit memory usage by maintaining a fixed number of active sessions.
pub struct LruSessionCache {
/// Stores the actual `Session` objects, keyed by their file paths.
sessions: Arc<DashMap<PathBuf, Arc<Session>>>,
/// Keeps track of the order in which sessions were accessed, with most recent at the front.
usage_order: Arc<Mutex<VecDeque<PathBuf>>>,
/// The maximum number of sessions that can be stored in the cache.
capacity: usize,
}
impl LruSessionCache {
/// Creates a new `LruSessionCache` with the specified capacity.
pub fn new(capacity: usize) -> Self {
LruSessionCache {
sessions: Arc::new(DashMap::new()),
usage_order: Arc::new(Mutex::new(VecDeque::with_capacity(capacity))),
capacity,
}
}
pub fn iter(&self) -> impl Iterator<Item = RefMulti<'_, PathBuf, Arc<Session>>> {
self.sessions.iter()
}
/// Retrieves a session from the cache and updates its position to the front of the usage order.
pub fn get(&self, path: &PathBuf) -> Option<Arc<Session>> {
if let Some(session) = self.sessions.try_get(path).try_unwrap() {
if self.sessions.len() >= self.capacity {
self.move_to_front(path);
}
Some(session.clone())
} else {
None
}
}
/// Inserts or updates a session in the cache.
/// If at capacity and inserting a new session, evicts the least recently used one.
/// For existing sessions, updates their position in the usage order if at capacity.
pub fn insert(&self, path: PathBuf, session: Arc<Session>) {
if let Some(mut entry) = self.sessions.get_mut(&path) {
// Session already exists, update it
*entry = session;
self.move_to_front(&path);
} else {
// New session
if self.sessions.len() >= self.capacity {
self.evict_least_used();
}
self.sessions.insert(path.clone(), session);
let mut order = self.usage_order.lock();
order.push_front(path);
}
}
/// Moves the specified path to the front of the usage order, marking it as most recently used.
fn move_to_front(&self, path: &PathBuf) {
tracing::trace!("Moving path to front of usage order: {:?}", path);
let mut order = self.usage_order.lock();
if let Some(index) = order.iter().position(|p| p == path) {
order.remove(index);
}
order.push_front(path.clone());
}
/// Removes the least recently used session from the cache when the capacity is reached.
fn evict_least_used(&self) {
let mut order = self.usage_order.lock();
if let Some(old_path) = order.pop_back() {
tracing::trace!(
"Cache at capacity. Evicting least used session: {:?}",
old_path
);
self.sessions.remove(&old_path);
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::path::PathBuf;
use std::sync::Arc;
#[test]
fn test_lru_session_cache_insertion_and_retrieval() {
let cache = LruSessionCache::new(2);
let path1 = PathBuf::from("/path/1");
let path2 = PathBuf::from("/path/2");
let session1 = Arc::new(Session::new());
let session2 = Arc::new(Session::new());
cache.insert(path1.clone(), session1.clone());
cache.insert(path2.clone(), session2.clone());
assert!(Arc::ptr_eq(&cache.get(&path1).unwrap(), &session1));
assert!(Arc::ptr_eq(&cache.get(&path2).unwrap(), &session2));
}
#[test]
fn test_lru_session_cache_capacity() {
let cache = LruSessionCache::new(2);
let path1 = PathBuf::from("/path/1");
let path2 = PathBuf::from("/path/2");
let path3 = PathBuf::from("/path/3");
let session1 = Arc::new(Session::new());
let session2 = Arc::new(Session::new());
let session3 = Arc::new(Session::new());
cache.insert(path1.clone(), session1);
cache.insert(path2.clone(), session2);
cache.insert(path3.clone(), session3);
assert!(cache.get(&path1).is_none());
assert!(cache.get(&path2).is_some());
assert!(cache.get(&path3).is_some());
}
#[test]
fn test_lru_session_cache_update_order() {
let cache = LruSessionCache::new(2);
let path1 = PathBuf::from("/path/1");
let path2 = PathBuf::from("/path/2");
let path3 = PathBuf::from("/path/3");
let session1 = Arc::new(Session::new());
let session2 = Arc::new(Session::new());
let session3 = Arc::new(Session::new());
cache.insert(path1.clone(), session1.clone());
cache.insert(path2.clone(), session2.clone());
// Access path1 to move it to the front
cache.get(&path1);
// Insert path3, which should evict path2
cache.insert(path3.clone(), session3);
assert!(cache.get(&path1).is_some());
assert!(cache.get(&path2).is_none());
assert!(cache.get(&path3).is_some());
}
#[test]
fn test_lru_session_cache_overwrite() {
let cache = LruSessionCache::new(2);
let path1 = PathBuf::from("/path/1");
let session1 = Arc::new(Session::new());
let session1_new = Arc::new(Session::new());
cache.insert(path1.clone(), session1);
cache.insert(path1.clone(), session1_new.clone());
assert!(Arc::ptr_eq(&cache.get(&path1).unwrap(), &session1_new));
}
}