use std::collections::HashMap;
use std::path::{Path, PathBuf};
use crate::lsp::registry::ServerKind;
use crate::lsp::roots::ServerKey;
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct StoredDiagnostic {
pub file: PathBuf,
pub line: u32,
pub column: u32,
pub end_line: u32,
pub end_column: u32,
pub severity: DiagnosticSeverity,
pub message: String,
pub code: Option<String>,
pub source: Option<String>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DiagnosticSeverity {
Error,
Warning,
Information,
Hint,
}
impl DiagnosticSeverity {
pub fn as_str(self) -> &'static str {
match self {
Self::Error => "error",
Self::Warning => "warning",
Self::Information => "information",
Self::Hint => "hint",
}
}
}
#[derive(Debug, Clone)]
pub struct DiagnosticEntry {
pub diagnostics: Vec<StoredDiagnostic>,
pub epoch: u64,
pub result_id: Option<String>,
}
pub struct DiagnosticsStore {
entries: HashMap<(ServerKey, PathBuf), DiagnosticEntry>,
order: Vec<(ServerKey, PathBuf)>,
capacity: usize,
next_epoch: u64,
}
impl DiagnosticsStore {
pub fn new() -> Self {
Self::with_capacity(5000)
}
pub fn with_capacity(capacity: usize) -> Self {
Self {
entries: HashMap::new(),
order: Vec::new(),
capacity,
next_epoch: 0,
}
}
pub fn set_capacity(&mut self, capacity: usize) {
self.capacity = capacity;
if capacity > 0 {
while self.entries.len() > capacity {
self.evict_lru();
}
}
}
pub fn len(&self) -> usize {
self.entries.len()
}
pub fn is_empty(&self) -> bool {
self.entries.is_empty()
}
pub fn publish(
&mut self,
server: ServerKey,
file: PathBuf,
diagnostics: Vec<StoredDiagnostic>,
) {
self.publish_with_result_id(server, file, diagnostics, None);
}
pub fn publish_with_result_id(
&mut self,
server: ServerKey,
file: PathBuf,
diagnostics: Vec<StoredDiagnostic>,
result_id: Option<String>,
) {
let key = (server, file);
self.next_epoch = self.next_epoch.saturating_add(1);
let entry = DiagnosticEntry {
diagnostics,
epoch: self.next_epoch,
result_id,
};
if self.entries.contains_key(&key) {
self.entries.insert(key.clone(), entry);
self.touch_existing(&key);
} else {
if self.capacity > 0 && self.entries.len() >= self.capacity {
self.evict_lru();
}
self.entries.insert(key.clone(), entry);
self.order.push(key);
}
}
pub fn publish_with_kind(
&mut self,
kind: ServerKind,
file: PathBuf,
diagnostics: Vec<StoredDiagnostic>,
) {
let key = ServerKey {
kind,
root: PathBuf::new(),
};
self.publish(key, file, diagnostics);
}
pub fn for_file(&self, file: &Path) -> Vec<&StoredDiagnostic> {
self.entries
.iter()
.filter(|((_, stored_file), _)| stored_file == file)
.flat_map(|(_, entry)| entry.diagnostics.iter())
.collect()
}
pub fn entries_for_file(&self, file: &Path) -> Vec<(&ServerKey, &DiagnosticEntry)> {
self.entries
.iter()
.filter(|((_, stored_file), _)| stored_file == file)
.map(|((key, _), entry)| (key, entry))
.collect()
}
pub fn has_any_report_for_file(&self, file: &Path) -> bool {
self.entries.keys().any(|(_, f)| f == file)
}
pub fn for_directory(&self, dir: &Path) -> Vec<&StoredDiagnostic> {
self.entries
.iter()
.filter(|((_, stored_file), _)| stored_file.starts_with(dir))
.flat_map(|(_, entry)| entry.diagnostics.iter())
.collect()
}
pub fn all(&self) -> Vec<&StoredDiagnostic> {
self.entries
.values()
.flat_map(|entry| entry.diagnostics.iter())
.collect()
}
pub fn clear_server(&mut self, server: ServerKind) {
self.entries
.retain(|(stored_key, _), _| stored_key.kind != server);
self.order
.retain(|(stored_key, _)| stored_key.kind != server);
}
pub fn clear_server_instance(&mut self, key: &ServerKey) {
self.entries.retain(|(k, _), _| k != key);
self.order.retain(|(k, _)| k != key);
}
fn evict_lru(&mut self) -> Option<(ServerKey, PathBuf)> {
if self.order.is_empty() {
return None;
}
let evicted = self.order.remove(0);
self.entries.remove(&evicted);
Some(evicted)
}
fn touch_existing(&mut self, key: &(ServerKey, PathBuf)) {
if let Some(idx) = self.order.iter().position(|k| k == key) {
let removed = self.order.remove(idx);
self.order.push(removed);
}
}
}
impl Default for DiagnosticsStore {
fn default() -> Self {
Self::new()
}
}
pub fn from_lsp_diagnostics(
file: PathBuf,
lsp_diagnostics: Vec<lsp_types::Diagnostic>,
) -> Vec<StoredDiagnostic> {
lsp_diagnostics
.into_iter()
.map(|diagnostic| StoredDiagnostic {
file: file.clone(),
line: diagnostic.range.start.line + 1,
column: diagnostic.range.start.character + 1,
end_line: diagnostic.range.end.line + 1,
end_column: diagnostic.range.end.character + 1,
severity: match diagnostic.severity {
Some(lsp_types::DiagnosticSeverity::ERROR) => DiagnosticSeverity::Error,
Some(lsp_types::DiagnosticSeverity::WARNING) => DiagnosticSeverity::Warning,
Some(lsp_types::DiagnosticSeverity::INFORMATION) => DiagnosticSeverity::Information,
Some(lsp_types::DiagnosticSeverity::HINT) => DiagnosticSeverity::Hint,
_ => DiagnosticSeverity::Warning,
},
message: diagnostic.message,
code: diagnostic.code.map(|code| match code {
lsp_types::NumberOrString::Number(value) => value.to_string(),
lsp_types::NumberOrString::String(value) => value,
}),
source: diagnostic.source,
})
.collect()
}
#[cfg(test)]
mod tests {
use std::path::{Path, PathBuf};
use lsp_types::{
Diagnostic, DiagnosticSeverity as LspDiagnosticSeverity, NumberOrString, Position, Range,
};
use super::{from_lsp_diagnostics, DiagnosticSeverity, DiagnosticsStore, StoredDiagnostic};
use crate::lsp::registry::ServerKind;
use crate::lsp::roots::ServerKey;
fn server_key(kind: ServerKind) -> ServerKey {
ServerKey {
kind,
root: PathBuf::from("/tmp/repo"),
}
}
fn diag(file: &str, line: u32, msg: &str, sev: DiagnosticSeverity) -> StoredDiagnostic {
StoredDiagnostic {
file: PathBuf::from(file),
line,
column: 1,
end_line: line,
end_column: 2,
severity: sev,
message: msg.into(),
code: None,
source: None,
}
}
#[test]
fn converts_lsp_positions_to_one_based() {
let file = PathBuf::from("/tmp/demo.rs");
let diagnostics = from_lsp_diagnostics(
file.clone(),
vec![Diagnostic {
range: Range::new(Position::new(0, 0), Position::new(1, 4)),
severity: Some(LspDiagnosticSeverity::ERROR),
code: Some(NumberOrString::String("E1".into())),
code_description: None,
source: Some("fake".into()),
message: "boom".into(),
related_information: None,
tags: None,
data: None,
}],
);
assert_eq!(diagnostics.len(), 1);
assert_eq!(diagnostics[0].file, file);
assert_eq!(diagnostics[0].line, 1);
assert_eq!(diagnostics[0].column, 1);
assert_eq!(diagnostics[0].end_line, 2);
assert_eq!(diagnostics[0].end_column, 5);
assert_eq!(diagnostics[0].severity, DiagnosticSeverity::Error);
assert_eq!(diagnostics[0].code.as_deref(), Some("E1"));
}
#[test]
fn publish_replaces_existing_file_diagnostics() {
let file = PathBuf::from("/tmp/demo.rs");
let mut store = DiagnosticsStore::new();
let key = server_key(ServerKind::Rust);
store.publish(
key.clone(),
file.clone(),
vec![diag(
"/tmp/demo.rs",
1,
"first",
DiagnosticSeverity::Warning,
)],
);
store.publish(
key.clone(),
file.clone(),
vec![diag("/tmp/demo.rs", 2, "second", DiagnosticSeverity::Error)],
);
let stored = store.for_file(&file);
assert_eq!(stored.len(), 1);
assert_eq!(stored[0].message, "second");
}
#[test]
fn empty_publish_is_preserved_as_checked_clean() {
let file = PathBuf::from("/tmp/clean.rs");
let mut store = DiagnosticsStore::new();
let key = server_key(ServerKind::Rust);
store.publish(
key.clone(),
file.clone(),
vec![diag(
"/tmp/clean.rs",
5,
"fix me",
DiagnosticSeverity::Warning,
)],
);
assert!(store.has_any_report_for_file(&file));
assert_eq!(store.for_file(&file).len(), 1);
store.publish(key.clone(), file.clone(), Vec::new());
assert!(
store.has_any_report_for_file(&file),
"checked-clean must be distinguishable from never-checked"
);
assert_eq!(store.for_file(&file).len(), 0);
let entries = store.entries_for_file(&file);
assert_eq!(entries.len(), 1);
assert!(entries[0].1.epoch > 0);
}
#[test]
fn never_checked_returns_no_report() {
let store = DiagnosticsStore::new();
let file = PathBuf::from("/tmp/never.rs");
assert!(!store.has_any_report_for_file(&file));
assert!(store.for_file(&file).is_empty());
}
#[test]
fn per_server_state_is_tracked_independently() {
let file = PathBuf::from("/tmp/multi.py");
let mut store = DiagnosticsStore::new();
let pyright_key = server_key(ServerKind::Python);
let ty_key = server_key(ServerKind::Ty);
store.publish(
pyright_key,
file.clone(),
vec![diag(
"/tmp/multi.py",
1,
"pyright says X",
DiagnosticSeverity::Error,
)],
);
store.publish(
ty_key,
file.clone(),
vec![diag(
"/tmp/multi.py",
2,
"ty says Y",
DiagnosticSeverity::Warning,
)],
);
let messages: Vec<&str> = store
.for_file(&file)
.into_iter()
.map(|d| d.message.as_str())
.collect();
assert_eq!(messages.len(), 2, "both servers' reports preserved");
assert!(messages.iter().any(|m| m == &"pyright says X"));
assert!(messages.iter().any(|m| m == &"ty says Y"));
}
#[test]
fn lru_evicts_oldest_when_capacity_exceeded() {
let mut store = DiagnosticsStore::with_capacity(2);
let key = server_key(ServerKind::Rust);
store.publish(
key.clone(),
PathBuf::from("/a.rs"),
vec![diag("/a.rs", 1, "a", DiagnosticSeverity::Warning)],
);
store.publish(
key.clone(),
PathBuf::from("/b.rs"),
vec![diag("/b.rs", 1, "b", DiagnosticSeverity::Warning)],
);
assert_eq!(store.len(), 2);
store.publish(
key.clone(),
PathBuf::from("/c.rs"),
vec![diag("/c.rs", 1, "c", DiagnosticSeverity::Warning)],
);
assert_eq!(store.len(), 2);
assert!(!store.has_any_report_for_file(Path::new("/a.rs")));
assert!(store.has_any_report_for_file(Path::new("/b.rs")));
assert!(store.has_any_report_for_file(Path::new("/c.rs")));
}
#[test]
fn touching_existing_entry_moves_it_to_end_of_lru() {
let mut store = DiagnosticsStore::with_capacity(2);
let key = server_key(ServerKind::Rust);
store.publish(
key.clone(),
PathBuf::from("/a.rs"),
vec![diag("/a.rs", 1, "a", DiagnosticSeverity::Warning)],
);
store.publish(
key.clone(),
PathBuf::from("/b.rs"),
vec![diag("/b.rs", 1, "b", DiagnosticSeverity::Warning)],
);
store.publish(
key.clone(),
PathBuf::from("/a.rs"),
vec![diag("/a.rs", 1, "a2", DiagnosticSeverity::Error)],
);
store.publish(
key.clone(),
PathBuf::from("/c.rs"),
vec![diag("/c.rs", 1, "c", DiagnosticSeverity::Warning)],
);
assert!(store.has_any_report_for_file(Path::new("/a.rs")));
assert!(!store.has_any_report_for_file(Path::new("/b.rs")));
assert!(store.has_any_report_for_file(Path::new("/c.rs")));
}
#[test]
fn capacity_zero_disables_eviction() {
let mut store = DiagnosticsStore::with_capacity(0);
let key = server_key(ServerKind::Rust);
for i in 0..50 {
store.publish(
key.clone(),
PathBuf::from(format!("/f{i}.rs")),
vec![diag(
&format!("/f{i}.rs"),
1,
"x",
DiagnosticSeverity::Warning,
)],
);
}
assert_eq!(store.len(), 50);
}
#[test]
fn set_capacity_evicts_on_shrink() {
let mut store = DiagnosticsStore::with_capacity(0);
let key = server_key(ServerKind::Rust);
for i in 0..10 {
store.publish(
key.clone(),
PathBuf::from(format!("/f{i}.rs")),
vec![diag(
&format!("/f{i}.rs"),
1,
"x",
DiagnosticSeverity::Warning,
)],
);
}
assert_eq!(store.len(), 10);
store.set_capacity(3);
assert_eq!(store.len(), 3);
assert!(store.has_any_report_for_file(Path::new("/f9.rs")));
assert!(!store.has_any_report_for_file(Path::new("/f0.rs")));
}
#[test]
fn epoch_increments_monotonically() {
let mut store = DiagnosticsStore::new();
let key = server_key(ServerKind::Rust);
let file = PathBuf::from("/e.rs");
store.publish(key.clone(), file.clone(), Vec::new());
let e1 = store.entries_for_file(&file)[0].1.epoch;
store.publish(key.clone(), file.clone(), Vec::new());
let e2 = store.entries_for_file(&file)[0].1.epoch;
assert!(e2 > e1, "epoch must increase on republish");
}
#[test]
fn result_id_is_round_tripped() {
let mut store = DiagnosticsStore::new();
let key = server_key(ServerKind::Rust);
let file = PathBuf::from("/r.rs");
store.publish_with_result_id(
key.clone(),
file.clone(),
Vec::new(),
Some("rev-42".to_string()),
);
let entries = store.entries_for_file(&file);
assert_eq!(entries[0].1.result_id.as_deref(), Some("rev-42"));
}
#[test]
fn clear_server_drops_all_entries_for_kind() {
let mut store = DiagnosticsStore::new();
let py_key = server_key(ServerKind::Python);
let rust_key = server_key(ServerKind::Rust);
store.publish(
py_key.clone(),
PathBuf::from("/a.py"),
vec![diag("/a.py", 1, "x", DiagnosticSeverity::Error)],
);
store.publish(
rust_key.clone(),
PathBuf::from("/b.rs"),
vec![diag("/b.rs", 1, "y", DiagnosticSeverity::Error)],
);
store.clear_server(ServerKind::Python);
assert!(!store.has_any_report_for_file(Path::new("/a.py")));
assert!(store.has_any_report_for_file(Path::new("/b.rs")));
}
}