lsp: Track completion triggers for each language separately (#20471)

This PR improves how we handle completions in buffers with multiple
LSPs.

Context: while working on
https://github.com/zed-industries/zed/issues/19777 with @mgsloan we
noticed that completion triggers coming from language servers are not
tracked properly. Namely, each buffer has `completion_triggers` field
which is read from the configuration of a language server. The problem
is, there can be multiple language servers for a single buffer, in which
case we'd just stick to the one that was registered last.

This PR makes the tracking a bit more fine-grained. We now track not
only what the completion triggers are, but also their origin server id.
Whenever completion triggers are updated, we recreate the completion
triggers set.
Release Notes:

- Fixed completions not triggering when multiple language servers are
used for a single file.
This commit is contained in:
Piotr Osiewicz 2024-11-10 10:29:10 +01:00 committed by GitHub
parent 2b7ee1e872
commit f3320998a8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 91 additions and 24 deletions

View file

@ -40,7 +40,7 @@ use std::{
borrow::Cow,
cell::Cell,
cmp::{self, Ordering, Reverse},
collections::BTreeMap,
collections::{BTreeMap, BTreeSet},
ffi::OsStr,
fmt,
future::Future,
@ -126,7 +126,8 @@ pub struct Buffer {
diagnostics: SmallVec<[(LanguageServerId, DiagnosticSet); 2]>,
remote_selections: TreeMap<ReplicaId, SelectionSet>,
diagnostics_timestamp: clock::Lamport,
completion_triggers: Vec<String>,
completion_triggers: BTreeSet<String>,
completion_triggers_per_language_server: HashMap<LanguageServerId, BTreeSet<String>>,
completion_triggers_timestamp: clock::Lamport,
deferred_ops: OperationQueue<Operation>,
capability: Capability,
@ -315,6 +316,8 @@ pub enum Operation {
triggers: Vec<String>,
/// The buffer's lamport timestamp.
lamport_timestamp: clock::Lamport,
/// The language server ID.
server_id: LanguageServerId,
},
}
@ -697,12 +700,15 @@ impl Buffer {
}));
}
operations.push(proto::serialize_operation(
&Operation::UpdateCompletionTriggers {
triggers: self.completion_triggers.clone(),
lamport_timestamp: self.completion_triggers_timestamp,
},
));
for (server_id, completions) in &self.completion_triggers_per_language_server {
operations.push(proto::serialize_operation(
&Operation::UpdateCompletionTriggers {
triggers: completions.iter().cloned().collect(),
lamport_timestamp: self.completion_triggers_timestamp,
server_id: *server_id,
},
));
}
let text_operations = self.text.operations().clone();
cx.background_executor().spawn(async move {
@ -774,6 +780,7 @@ impl Buffer {
diagnostics: Default::default(),
diagnostics_timestamp: Default::default(),
completion_triggers: Default::default(),
completion_triggers_per_language_server: Default::default(),
completion_triggers_timestamp: Default::default(),
deferred_ops: OperationQueue::new(),
has_conflict: false,
@ -2229,8 +2236,21 @@ impl Buffer {
Operation::UpdateCompletionTriggers {
triggers,
lamport_timestamp,
server_id,
} => {
self.completion_triggers = triggers;
if triggers.is_empty() {
self.completion_triggers_per_language_server
.remove(&server_id);
self.completion_triggers = self
.completion_triggers_per_language_server
.values()
.flat_map(|triggers| triggers.into_iter().cloned())
.collect();
} else {
self.completion_triggers_per_language_server
.insert(server_id, triggers.iter().cloned().collect());
self.completion_triggers.extend(triggers);
}
self.text.lamport_clock.observe(lamport_timestamp);
}
}
@ -2374,13 +2394,31 @@ impl Buffer {
}
/// Override current completion triggers with the user-provided completion triggers.
pub fn set_completion_triggers(&mut self, triggers: Vec<String>, cx: &mut ModelContext<Self>) {
self.completion_triggers.clone_from(&triggers);
pub fn set_completion_triggers(
&mut self,
server_id: LanguageServerId,
triggers: BTreeSet<String>,
cx: &mut ModelContext<Self>,
) {
self.completion_triggers_timestamp = self.text.lamport_clock.tick();
if triggers.is_empty() {
self.completion_triggers_per_language_server
.remove(&server_id);
self.completion_triggers = self
.completion_triggers_per_language_server
.values()
.flat_map(|triggers| triggers.into_iter().cloned())
.collect();
} else {
self.completion_triggers_per_language_server
.insert(server_id, triggers.clone());
self.completion_triggers.extend(triggers.iter().cloned());
}
self.send_operation(
Operation::UpdateCompletionTriggers {
triggers,
triggers: triggers.iter().cloned().collect(),
lamport_timestamp: self.completion_triggers_timestamp,
server_id,
},
true,
cx,
@ -2390,7 +2428,7 @@ impl Buffer {
/// Returns a list of strings which trigger a completion menu for this language.
/// Usually this is driven by LSP server which returns a list of trigger characters for completions.
pub fn completion_triggers(&self) -> &[String] {
pub fn completion_triggers(&self) -> &BTreeSet<String> {
&self.completion_triggers
}

View file

@ -79,11 +79,13 @@ pub fn serialize_operation(operation: &crate::Operation) -> proto::Operation {
crate::Operation::UpdateCompletionTriggers {
triggers,
lamport_timestamp,
server_id,
} => proto::operation::Variant::UpdateCompletionTriggers(
proto::operation::UpdateCompletionTriggers {
replica_id: lamport_timestamp.replica_id as u32,
lamport_timestamp: lamport_timestamp.value,
triggers: triggers.clone(),
triggers: triggers.iter().cloned().collect(),
language_server_id: server_id.to_proto(),
},
),
}),
@ -326,6 +328,7 @@ pub fn deserialize_operation(message: proto::Operation) -> Result<crate::Operati
replica_id: message.replica_id as ReplicaId,
value: message.lamport_timestamp,
},
server_id: LanguageServerId::from_proto(message.language_server_id),
}
}
},