1use anyhow::{Context, Result};
2use collections::HashMap;
3use futures::{
4 Future, FutureExt as _,
5 channel::oneshot,
6 future::{BoxFuture, LocalBoxFuture},
7};
8use gpui::{AnyEntity, AnyWeakEntity, AsyncApp, BackgroundExecutor, Entity, FutureExt as _};
9use parking_lot::Mutex;
10use proto::{
11 AnyTypedEnvelope, EntityMessage, Envelope, EnvelopedMessage, LspRequestId, LspRequestMessage,
12 RequestMessage, TypedEnvelope, error::ErrorExt as _,
13};
14use std::{
15 any::{Any, TypeId},
16 sync::{
17 Arc, OnceLock,
18 atomic::{self, AtomicU64},
19 },
20 time::Duration,
21};
22
23#[derive(Clone)]
24pub struct AnyProtoClient(Arc<State>);
25
26type RequestIds = Arc<
27 Mutex<
28 HashMap<
29 LspRequestId,
30 oneshot::Sender<
31 Result<
32 Option<TypedEnvelope<Vec<proto::ProtoLspResponse<Box<dyn AnyTypedEnvelope>>>>>,
33 >,
34 >,
35 >,
36 >,
37>;
38
39static NEXT_LSP_REQUEST_ID: OnceLock<Arc<AtomicU64>> = OnceLock::new();
40static REQUEST_IDS: OnceLock<RequestIds> = OnceLock::new();
41
42struct State {
43 client: Arc<dyn ProtoClient>,
44 next_lsp_request_id: Arc<AtomicU64>,
45 request_ids: RequestIds,
46}
47
48pub trait ProtoClient: Send + Sync {
49 fn request(
50 &self,
51 envelope: Envelope,
52 request_type: &'static str,
53 ) -> BoxFuture<'static, Result<Envelope>>;
54
55 fn send(&self, envelope: Envelope, message_type: &'static str) -> Result<()>;
56
57 fn send_response(&self, envelope: Envelope, message_type: &'static str) -> Result<()>;
58
59 fn message_handler_set(&self) -> &parking_lot::Mutex<ProtoMessageHandlerSet>;
60
61 fn is_via_collab(&self) -> bool;
62}
63
64#[derive(Default)]
65pub struct ProtoMessageHandlerSet {
66 pub entity_types_by_message_type: HashMap<TypeId, TypeId>,
67 pub entities_by_type_and_remote_id: HashMap<(TypeId, u64), EntityMessageSubscriber>,
68 pub entity_id_extractors: HashMap<TypeId, fn(&dyn AnyTypedEnvelope) -> u64>,
69 pub entities_by_message_type: HashMap<TypeId, AnyWeakEntity>,
70 pub message_handlers: HashMap<TypeId, ProtoMessageHandler>,
71}
72
73pub type ProtoMessageHandler = Arc<
74 dyn Send
75 + Sync
76 + Fn(
77 AnyEntity,
78 Box<dyn AnyTypedEnvelope>,
79 AnyProtoClient,
80 AsyncApp,
81 ) -> LocalBoxFuture<'static, Result<()>>,
82>;
83
84impl ProtoMessageHandlerSet {
85 pub fn clear(&mut self) {
86 self.message_handlers.clear();
87 self.entities_by_message_type.clear();
88 self.entities_by_type_and_remote_id.clear();
89 self.entity_id_extractors.clear();
90 }
91
92 fn add_message_handler(
93 &mut self,
94 message_type_id: TypeId,
95 entity: gpui::AnyWeakEntity,
96 handler: ProtoMessageHandler,
97 ) {
98 self.entities_by_message_type
99 .insert(message_type_id, entity);
100 let prev_handler = self.message_handlers.insert(message_type_id, handler);
101 if prev_handler.is_some() {
102 panic!("registered handler for the same message twice");
103 }
104 }
105
106 fn add_entity_message_handler(
107 &mut self,
108 message_type_id: TypeId,
109 entity_type_id: TypeId,
110 entity_id_extractor: fn(&dyn AnyTypedEnvelope) -> u64,
111 handler: ProtoMessageHandler,
112 ) {
113 self.entity_id_extractors
114 .entry(message_type_id)
115 .or_insert(entity_id_extractor);
116 self.entity_types_by_message_type
117 .insert(message_type_id, entity_type_id);
118 let prev_handler = self.message_handlers.insert(message_type_id, handler);
119 if prev_handler.is_some() {
120 panic!("registered handler for the same message twice");
121 }
122 }
123
124 pub fn handle_message(
125 this: &parking_lot::Mutex<Self>,
126 message: Box<dyn AnyTypedEnvelope>,
127 client: AnyProtoClient,
128 cx: AsyncApp,
129 ) -> Option<LocalBoxFuture<'static, Result<()>>> {
130 let payload_type_id = message.payload_type_id();
131 let mut this = this.lock();
132 let handler = this.message_handlers.get(&payload_type_id)?.clone();
133 let entity = if let Some(entity) = this.entities_by_message_type.get(&payload_type_id) {
134 entity.upgrade()?
135 } else {
136 let extract_entity_id = *this.entity_id_extractors.get(&payload_type_id)?;
137 let entity_type_id = *this.entity_types_by_message_type.get(&payload_type_id)?;
138 let entity_id = (extract_entity_id)(message.as_ref());
139 match this
140 .entities_by_type_and_remote_id
141 .get_mut(&(entity_type_id, entity_id))?
142 {
143 EntityMessageSubscriber::Pending(pending) => {
144 pending.push(message);
145 return None;
146 }
147 EntityMessageSubscriber::Entity { handle } => handle.upgrade()?,
148 }
149 };
150 drop(this);
151 Some(handler(entity, message, client, cx))
152 }
153}
154
155pub enum EntityMessageSubscriber {
156 Entity { handle: AnyWeakEntity },
157 Pending(Vec<Box<dyn AnyTypedEnvelope>>),
158}
159
160impl std::fmt::Debug for EntityMessageSubscriber {
161 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
162 match self {
163 EntityMessageSubscriber::Entity { handle } => f
164 .debug_struct("EntityMessageSubscriber::Entity")
165 .field("handle", handle)
166 .finish(),
167 EntityMessageSubscriber::Pending(vec) => f
168 .debug_struct("EntityMessageSubscriber::Pending")
169 .field(
170 "envelopes",
171 &vec.iter()
172 .map(|envelope| envelope.payload_type_name())
173 .collect::<Vec<_>>(),
174 )
175 .finish(),
176 }
177 }
178}
179
180impl<T> From<Arc<T>> for AnyProtoClient
181where
182 T: ProtoClient + 'static,
183{
184 fn from(client: Arc<T>) -> Self {
185 Self::new(client)
186 }
187}
188
189impl AnyProtoClient {
190 pub fn new<T: ProtoClient + 'static>(client: Arc<T>) -> Self {
191 Self(Arc::new(State {
192 client,
193 next_lsp_request_id: NEXT_LSP_REQUEST_ID
194 .get_or_init(|| Arc::new(AtomicU64::new(0)))
195 .clone(),
196 request_ids: REQUEST_IDS.get_or_init(RequestIds::default).clone(),
197 }))
198 }
199
200 pub fn is_via_collab(&self) -> bool {
201 self.0.client.is_via_collab()
202 }
203
204 pub fn request<T: RequestMessage>(
205 &self,
206 request: T,
207 ) -> impl Future<Output = Result<T::Response>> + use<T> {
208 let envelope = request.into_envelope(0, None, None);
209 let response = self.0.client.request(envelope, T::NAME);
210 async move {
211 T::Response::from_envelope(response.await?)
212 .context("received response of the wrong type")
213 }
214 }
215
216 pub fn send<T: EnvelopedMessage>(&self, request: T) -> Result<()> {
217 let envelope = request.into_envelope(0, None, None);
218 self.0.client.send(envelope, T::NAME)
219 }
220
221 pub fn send_response<T: EnvelopedMessage>(&self, request_id: u32, request: T) -> Result<()> {
222 let envelope = request.into_envelope(0, Some(request_id), None);
223 self.0.client.send(envelope, T::NAME)
224 }
225
226 pub fn request_lsp<T>(
227 &self,
228 project_id: u64,
229 timeout: Duration,
230 executor: BackgroundExecutor,
231 request: T,
232 ) -> impl Future<
233 Output = Result<Option<TypedEnvelope<Vec<proto::ProtoLspResponse<T::Response>>>>>,
234 > + use<T>
235 where
236 T: LspRequestMessage,
237 {
238 let new_id = LspRequestId(
239 self.0
240 .next_lsp_request_id
241 .fetch_add(1, atomic::Ordering::Acquire),
242 );
243 let (tx, rx) = oneshot::channel();
244 {
245 self.0.request_ids.lock().insert(new_id, tx);
246 }
247
248 let query = proto::LspQuery {
249 project_id,
250 lsp_request_id: new_id.0,
251 request: Some(request.to_proto_query()),
252 };
253 let request = self.request(query);
254 let request_ids = self.0.request_ids.clone();
255 async move {
256 match request.await {
257 Ok(_request_enqueued) => {}
258 Err(e) => {
259 request_ids.lock().remove(&new_id);
260 return Err(e).context("sending LSP proto request");
261 }
262 }
263
264 let response = rx.with_timeout(timeout, &executor).await;
265 {
266 request_ids.lock().remove(&new_id);
267 }
268 match response {
269 Ok(Ok(response)) => {
270 let response = response
271 .context("waiting for LSP proto response")?
272 .map(|response| {
273 anyhow::Ok(TypedEnvelope {
274 payload: response
275 .payload
276 .into_iter()
277 .map(|lsp_response| lsp_response.into_response::<T>())
278 .collect::<Result<Vec<_>>>()?,
279 sender_id: response.sender_id,
280 original_sender_id: response.original_sender_id,
281 message_id: response.message_id,
282 received_at: response.received_at,
283 })
284 })
285 .transpose()
286 .context("converting LSP proto response")?;
287 Ok(response)
288 }
289 Err(_cancelled_due_timeout) => Ok(None),
290 Ok(Err(_channel_dropped)) => Ok(None),
291 }
292 }
293 }
294
295 pub fn send_lsp_response<T: LspRequestMessage>(
296 &self,
297 project_id: u64,
298 lsp_request_id: LspRequestId,
299 server_responses: HashMap<u64, T::Response>,
300 ) -> Result<()> {
301 self.send(proto::LspQueryResponse {
302 project_id,
303 lsp_request_id: lsp_request_id.0,
304 responses: server_responses
305 .into_iter()
306 .map(|(server_id, response)| proto::LspResponse {
307 server_id,
308 response: Some(T::response_to_proto_query(response)),
309 })
310 .collect(),
311 })
312 }
313
314 pub fn handle_lsp_response(&self, mut envelope: TypedEnvelope<proto::LspQueryResponse>) {
315 let request_id = LspRequestId(envelope.payload.lsp_request_id);
316 let mut response_senders = self.0.request_ids.lock();
317 if let Some(tx) = response_senders.remove(&request_id) {
318 let responses = envelope.payload.responses.drain(..).collect::<Vec<_>>();
319 tx.send(Ok(Some(proto::TypedEnvelope {
320 sender_id: envelope.sender_id,
321 original_sender_id: envelope.original_sender_id,
322 message_id: envelope.message_id,
323 received_at: envelope.received_at,
324 payload: responses
325 .into_iter()
326 .filter_map(|response| {
327 use proto::lsp_response::Response;
328
329 let server_id = response.server_id;
330 let response = match response.response? {
331 Response::GetReferencesResponse(response) => {
332 to_any_envelope(&envelope, response)
333 }
334 Response::GetDocumentColorResponse(response) => {
335 to_any_envelope(&envelope, response)
336 }
337 Response::GetHoverResponse(response) => {
338 to_any_envelope(&envelope, response)
339 }
340 Response::GetCodeActionsResponse(response) => {
341 to_any_envelope(&envelope, response)
342 }
343 Response::GetSignatureHelpResponse(response) => {
344 to_any_envelope(&envelope, response)
345 }
346 Response::GetCodeLensResponse(response) => {
347 to_any_envelope(&envelope, response)
348 }
349 Response::GetDocumentDiagnosticsResponse(response) => {
350 to_any_envelope(&envelope, response)
351 }
352 Response::GetDefinitionResponse(response) => {
353 to_any_envelope(&envelope, response)
354 }
355 Response::GetDeclarationResponse(response) => {
356 to_any_envelope(&envelope, response)
357 }
358 Response::GetTypeDefinitionResponse(response) => {
359 to_any_envelope(&envelope, response)
360 }
361 Response::GetImplementationResponse(response) => {
362 to_any_envelope(&envelope, response)
363 }
364 };
365 Some(proto::ProtoLspResponse {
366 server_id,
367 response,
368 })
369 })
370 .collect(),
371 })))
372 .ok();
373 }
374 }
375
376 pub fn add_request_handler<M, E, H, F>(&self, entity: gpui::WeakEntity<E>, handler: H)
377 where
378 M: RequestMessage,
379 E: 'static,
380 H: 'static + Sync + Fn(Entity<E>, TypedEnvelope<M>, AsyncApp) -> F + Send + Sync,
381 F: 'static + Future<Output = Result<M::Response>>,
382 {
383 self.0
384 .client
385 .message_handler_set()
386 .lock()
387 .add_message_handler(
388 TypeId::of::<M>(),
389 entity.into(),
390 Arc::new(move |entity, envelope, client, cx| {
391 let entity = entity.downcast::<E>().unwrap();
392 let envelope = envelope.into_any().downcast::<TypedEnvelope<M>>().unwrap();
393 let request_id = envelope.message_id();
394 handler(entity, *envelope, cx)
395 .then(move |result| async move {
396 match result {
397 Ok(response) => {
398 client.send_response(request_id, response)?;
399 Ok(())
400 }
401 Err(error) => {
402 client.send_response(request_id, error.to_proto())?;
403 Err(error)
404 }
405 }
406 })
407 .boxed_local()
408 }),
409 )
410 }
411
412 pub fn add_entity_request_handler<M, E, H, F>(&self, handler: H)
413 where
414 M: EnvelopedMessage + RequestMessage + EntityMessage,
415 E: 'static,
416 H: 'static + Sync + Send + Fn(gpui::Entity<E>, TypedEnvelope<M>, AsyncApp) -> F,
417 F: 'static + Future<Output = Result<M::Response>>,
418 {
419 let message_type_id = TypeId::of::<M>();
420 let entity_type_id = TypeId::of::<E>();
421 let entity_id_extractor = |envelope: &dyn AnyTypedEnvelope| {
422 (envelope as &dyn Any)
423 .downcast_ref::<TypedEnvelope<M>>()
424 .unwrap()
425 .payload
426 .remote_entity_id()
427 };
428 self.0
429 .client
430 .message_handler_set()
431 .lock()
432 .add_entity_message_handler(
433 message_type_id,
434 entity_type_id,
435 entity_id_extractor,
436 Arc::new(move |entity, envelope, client, cx| {
437 let entity = entity.downcast::<E>().unwrap();
438 let envelope = envelope.into_any().downcast::<TypedEnvelope<M>>().unwrap();
439 let request_id = envelope.message_id();
440 handler(entity, *envelope, cx)
441 .then(move |result| async move {
442 match result {
443 Ok(response) => {
444 client.send_response(request_id, response)?;
445 Ok(())
446 }
447 Err(error) => {
448 client.send_response(request_id, error.to_proto())?;
449 Err(error)
450 }
451 }
452 })
453 .boxed_local()
454 }),
455 );
456 }
457
458 pub fn add_entity_message_handler<M, E, H, F>(&self, handler: H)
459 where
460 M: EnvelopedMessage + EntityMessage,
461 E: 'static,
462 H: 'static + Sync + Send + Fn(gpui::Entity<E>, TypedEnvelope<M>, AsyncApp) -> F,
463 F: 'static + Future<Output = Result<()>>,
464 {
465 let message_type_id = TypeId::of::<M>();
466 let entity_type_id = TypeId::of::<E>();
467 let entity_id_extractor = |envelope: &dyn AnyTypedEnvelope| {
468 (envelope as &dyn Any)
469 .downcast_ref::<TypedEnvelope<M>>()
470 .unwrap()
471 .payload
472 .remote_entity_id()
473 };
474 self.0
475 .client
476 .message_handler_set()
477 .lock()
478 .add_entity_message_handler(
479 message_type_id,
480 entity_type_id,
481 entity_id_extractor,
482 Arc::new(move |entity, envelope, _, cx| {
483 let entity = entity.downcast::<E>().unwrap();
484 let envelope = envelope.into_any().downcast::<TypedEnvelope<M>>().unwrap();
485 handler(entity, *envelope, cx).boxed_local()
486 }),
487 );
488 }
489
490 pub fn subscribe_to_entity<E: 'static>(&self, remote_id: u64, entity: &Entity<E>) {
491 let id = (TypeId::of::<E>(), remote_id);
492
493 let mut message_handlers = self.0.client.message_handler_set().lock();
494 if message_handlers
495 .entities_by_type_and_remote_id
496 .contains_key(&id)
497 {
498 panic!("already subscribed to entity");
499 }
500
501 message_handlers.entities_by_type_and_remote_id.insert(
502 id,
503 EntityMessageSubscriber::Entity {
504 handle: entity.downgrade().into(),
505 },
506 );
507 }
508}
509
510fn to_any_envelope<T: EnvelopedMessage>(
511 envelope: &TypedEnvelope<proto::LspQueryResponse>,
512 response: T,
513) -> Box<dyn AnyTypedEnvelope> {
514 Box::new(proto::TypedEnvelope {
515 sender_id: envelope.sender_id,
516 original_sender_id: envelope.original_sender_id,
517 message_id: envelope.message_id,
518 received_at: envelope.received_at,
519 payload: response,
520 }) as Box<_>
521}