1mod ignore;
2mod lsp_command;
3pub mod search;
4pub mod worktree;
5
6#[cfg(test)]
7mod project_tests;
8
9use anyhow::{anyhow, Context, Result};
10use client::{proto, Client, PeerId, TypedEnvelope, UserStore};
11use clock::ReplicaId;
12use collections::{hash_map, BTreeMap, HashMap, HashSet};
13use futures::{future::Shared, AsyncWriteExt, Future, FutureExt, StreamExt, TryFutureExt};
14
15use gpui::{
16 AnyModelHandle, AppContext, AsyncAppContext, Entity, ModelContext, ModelHandle,
17 MutableAppContext, Task, UpgradeModelHandle, WeakModelHandle,
18};
19use language::{
20 point_to_lsp,
21 proto::{
22 deserialize_anchor, deserialize_line_ending, deserialize_version, serialize_anchor,
23 serialize_version,
24 },
25 range_from_lsp, range_to_lsp, Anchor, Bias, Buffer, CachedLspAdapter, CharKind, CodeAction,
26 CodeLabel, Completion, Diagnostic, DiagnosticEntry, DiagnosticSet, Event as BufferEvent,
27 File as _, Language, LanguageRegistry, LanguageServerName, LocalFile, OffsetRangeExt,
28 Operation, Patch, PointUtf16, TextBufferSnapshot, ToOffset, ToPointUtf16, Transaction,
29};
30use lsp::{
31 DiagnosticSeverity, DiagnosticTag, DocumentHighlightKind, LanguageServer, LanguageString,
32 MarkedString,
33};
34use lsp_command::*;
35use parking_lot::Mutex;
36use postage::watch;
37use rand::prelude::*;
38use search::SearchQuery;
39use serde::Serialize;
40use settings::{FormatOnSave, Formatter, Settings};
41use sha2::{Digest, Sha256};
42use similar::{ChangeTag, TextDiff};
43use std::{
44 cell::RefCell,
45 cmp::{self, Ordering},
46 convert::TryInto,
47 ffi::OsString,
48 hash::Hash,
49 mem,
50 num::NonZeroU32,
51 ops::Range,
52 os::unix::{ffi::OsStrExt, prelude::OsStringExt},
53 path::{Component, Path, PathBuf},
54 rc::Rc,
55 str,
56 sync::{
57 atomic::{AtomicUsize, Ordering::SeqCst},
58 Arc,
59 },
60 time::Instant,
61};
62use thiserror::Error;
63use util::{defer, post_inc, ResultExt, TryFutureExt as _};
64
65pub use db::Db;
66pub use fs::*;
67pub use worktree::*;
68
69pub trait Item: Entity {
70 fn entry_id(&self, cx: &AppContext) -> Option<ProjectEntryId>;
71}
72
73pub struct ProjectStore {
74 projects: Vec<WeakModelHandle<Project>>,
75}
76
77// Language server state is stored across 3 collections:
78// language_servers =>
79// a mapping from unique server id to LanguageServerState which can either be a task for a
80// server in the process of starting, or a running server with adapter and language server arcs
81// language_server_ids => a mapping from worktreeId and server name to the unique server id
82// language_server_statuses => a mapping from unique server id to the current server status
83//
84// Multiple worktrees can map to the same language server for example when you jump to the definition
85// of a file in the standard library. So language_server_ids is used to look up which server is active
86// for a given worktree and language server name
87//
88// When starting a language server, first the id map is checked to make sure a server isn't already available
89// for that worktree. If there is one, it finishes early. Otherwise, a new id is allocated and and
90// the Starting variant of LanguageServerState is stored in the language_servers map.
91pub struct Project {
92 worktrees: Vec<WorktreeHandle>,
93 active_entry: Option<ProjectEntryId>,
94 languages: Arc<LanguageRegistry>,
95 language_servers: HashMap<usize, LanguageServerState>,
96 language_server_ids: HashMap<(WorktreeId, LanguageServerName), usize>,
97 language_server_statuses: BTreeMap<usize, LanguageServerStatus>,
98 language_server_settings: Arc<Mutex<serde_json::Value>>,
99 last_workspace_edits_by_language_server: HashMap<usize, ProjectTransaction>,
100 next_language_server_id: usize,
101 client: Arc<client::Client>,
102 next_entry_id: Arc<AtomicUsize>,
103 next_diagnostic_group_id: usize,
104 user_store: ModelHandle<UserStore>,
105 project_store: ModelHandle<ProjectStore>,
106 fs: Arc<dyn Fs>,
107 client_state: Option<ProjectClientState>,
108 collaborators: HashMap<PeerId, Collaborator>,
109 client_subscriptions: Vec<client::Subscription>,
110 _subscriptions: Vec<gpui::Subscription>,
111 opened_buffer: (watch::Sender<()>, watch::Receiver<()>),
112 shared_buffers: HashMap<PeerId, HashSet<u64>>,
113 #[allow(clippy::type_complexity)]
114 loading_buffers: HashMap<
115 ProjectPath,
116 postage::watch::Receiver<Option<Result<ModelHandle<Buffer>, Arc<anyhow::Error>>>>,
117 >,
118 #[allow(clippy::type_complexity)]
119 loading_local_worktrees:
120 HashMap<Arc<Path>, Shared<Task<Result<ModelHandle<Worktree>, Arc<anyhow::Error>>>>>,
121 opened_buffers: HashMap<u64, OpenBuffer>,
122 incomplete_buffers: HashMap<u64, ModelHandle<Buffer>>,
123 buffer_snapshots: HashMap<u64, Vec<(i32, TextBufferSnapshot)>>,
124 buffers_being_formatted: HashSet<usize>,
125 nonce: u128,
126 _maintain_buffer_languages: Task<()>,
127}
128
129#[derive(Error, Debug)]
130pub enum JoinProjectError {
131 #[error("host declined join request")]
132 HostDeclined,
133 #[error("host closed the project")]
134 HostClosedProject,
135 #[error("host went offline")]
136 HostWentOffline,
137 #[error("{0}")]
138 Other(#[from] anyhow::Error),
139}
140
141enum OpenBuffer {
142 Strong(ModelHandle<Buffer>),
143 Weak(WeakModelHandle<Buffer>),
144 Operations(Vec<Operation>),
145}
146
147enum WorktreeHandle {
148 Strong(ModelHandle<Worktree>),
149 Weak(WeakModelHandle<Worktree>),
150}
151
152enum ProjectClientState {
153 Local {
154 remote_id: u64,
155 _detect_unshare: Task<Option<()>>,
156 },
157 Remote {
158 sharing_has_stopped: bool,
159 remote_id: u64,
160 replica_id: ReplicaId,
161 _detect_unshare: Task<Option<()>>,
162 },
163}
164
165#[derive(Clone, Debug)]
166pub struct Collaborator {
167 pub peer_id: PeerId,
168 pub replica_id: ReplicaId,
169}
170
171#[derive(Clone, Debug, PartialEq, Eq)]
172pub enum Event {
173 ActiveEntryChanged(Option<ProjectEntryId>),
174 WorktreeAdded,
175 WorktreeRemoved(WorktreeId),
176 DiskBasedDiagnosticsStarted {
177 language_server_id: usize,
178 },
179 DiskBasedDiagnosticsFinished {
180 language_server_id: usize,
181 },
182 DiagnosticsUpdated {
183 path: ProjectPath,
184 language_server_id: usize,
185 },
186 RemoteIdChanged(Option<u64>),
187 DisconnectedFromHost,
188 CollaboratorLeft(PeerId),
189}
190
191pub enum LanguageServerState {
192 Starting(Task<Option<Arc<LanguageServer>>>),
193 Running {
194 language: Arc<Language>,
195 adapter: Arc<CachedLspAdapter>,
196 server: Arc<LanguageServer>,
197 },
198}
199
200#[derive(Serialize)]
201pub struct LanguageServerStatus {
202 pub name: String,
203 pub pending_work: BTreeMap<String, LanguageServerProgress>,
204 pub has_pending_diagnostic_updates: bool,
205 progress_tokens: HashSet<String>,
206}
207
208#[derive(Clone, Debug, Serialize)]
209pub struct LanguageServerProgress {
210 pub message: Option<String>,
211 pub percentage: Option<usize>,
212 #[serde(skip_serializing)]
213 pub last_update_at: Instant,
214}
215
216#[derive(Clone, Debug, Eq, PartialEq, Hash, PartialOrd, Ord)]
217pub struct ProjectPath {
218 pub worktree_id: WorktreeId,
219 pub path: Arc<Path>,
220}
221
222#[derive(Copy, Clone, Debug, Default, PartialEq, Serialize)]
223pub struct DiagnosticSummary {
224 pub language_server_id: usize,
225 pub error_count: usize,
226 pub warning_count: usize,
227}
228
229#[derive(Debug, Clone)]
230pub struct Location {
231 pub buffer: ModelHandle<Buffer>,
232 pub range: Range<language::Anchor>,
233}
234
235#[derive(Debug, Clone)]
236pub struct LocationLink {
237 pub origin: Option<Location>,
238 pub target: Location,
239}
240
241#[derive(Debug)]
242pub struct DocumentHighlight {
243 pub range: Range<language::Anchor>,
244 pub kind: DocumentHighlightKind,
245}
246
247#[derive(Clone, Debug)]
248pub struct Symbol {
249 pub language_server_name: LanguageServerName,
250 pub source_worktree_id: WorktreeId,
251 pub path: ProjectPath,
252 pub label: CodeLabel,
253 pub name: String,
254 pub kind: lsp::SymbolKind,
255 pub range: Range<PointUtf16>,
256 pub signature: [u8; 32],
257}
258
259#[derive(Clone, Debug, PartialEq)]
260pub struct HoverBlock {
261 pub text: String,
262 pub language: Option<String>,
263}
264
265impl HoverBlock {
266 fn try_new(marked_string: MarkedString) -> Option<Self> {
267 let result = match marked_string {
268 MarkedString::LanguageString(LanguageString { language, value }) => HoverBlock {
269 text: value,
270 language: Some(language),
271 },
272 MarkedString::String(text) => HoverBlock {
273 text,
274 language: None,
275 },
276 };
277 if result.text.is_empty() {
278 None
279 } else {
280 Some(result)
281 }
282 }
283}
284
285#[derive(Debug)]
286pub struct Hover {
287 pub contents: Vec<HoverBlock>,
288 pub range: Option<Range<language::Anchor>>,
289}
290
291#[derive(Default)]
292pub struct ProjectTransaction(pub HashMap<ModelHandle<Buffer>, language::Transaction>);
293
294impl DiagnosticSummary {
295 fn new<'a, T: 'a>(
296 language_server_id: usize,
297 diagnostics: impl IntoIterator<Item = &'a DiagnosticEntry<T>>,
298 ) -> Self {
299 let mut this = Self {
300 language_server_id,
301 error_count: 0,
302 warning_count: 0,
303 };
304
305 for entry in diagnostics {
306 if entry.diagnostic.is_primary {
307 match entry.diagnostic.severity {
308 DiagnosticSeverity::ERROR => this.error_count += 1,
309 DiagnosticSeverity::WARNING => this.warning_count += 1,
310 _ => {}
311 }
312 }
313 }
314
315 this
316 }
317
318 pub fn is_empty(&self) -> bool {
319 self.error_count == 0 && self.warning_count == 0
320 }
321
322 pub fn to_proto(&self, path: &Path) -> proto::DiagnosticSummary {
323 proto::DiagnosticSummary {
324 path: path.to_string_lossy().to_string(),
325 language_server_id: self.language_server_id as u64,
326 error_count: self.error_count as u32,
327 warning_count: self.warning_count as u32,
328 }
329 }
330}
331
332#[derive(Clone, Copy, Debug, Default, Hash, PartialEq, Eq, PartialOrd, Ord)]
333pub struct ProjectEntryId(usize);
334
335impl ProjectEntryId {
336 pub const MAX: Self = Self(usize::MAX);
337
338 pub fn new(counter: &AtomicUsize) -> Self {
339 Self(counter.fetch_add(1, SeqCst))
340 }
341
342 pub fn from_proto(id: u64) -> Self {
343 Self(id as usize)
344 }
345
346 pub fn to_proto(&self) -> u64 {
347 self.0 as u64
348 }
349
350 pub fn to_usize(&self) -> usize {
351 self.0
352 }
353}
354
355#[derive(Debug, Clone, Copy, PartialEq, Eq)]
356pub enum FormatTrigger {
357 Save,
358 Manual,
359}
360
361impl FormatTrigger {
362 fn from_proto(value: i32) -> FormatTrigger {
363 match value {
364 0 => FormatTrigger::Save,
365 1 => FormatTrigger::Manual,
366 _ => FormatTrigger::Save,
367 }
368 }
369}
370
371impl Project {
372 pub fn init(client: &Arc<Client>) {
373 client.add_model_message_handler(Self::handle_add_collaborator);
374 client.add_model_message_handler(Self::handle_buffer_reloaded);
375 client.add_model_message_handler(Self::handle_buffer_saved);
376 client.add_model_message_handler(Self::handle_start_language_server);
377 client.add_model_message_handler(Self::handle_update_language_server);
378 client.add_model_message_handler(Self::handle_remove_collaborator);
379 client.add_model_message_handler(Self::handle_update_project);
380 client.add_model_message_handler(Self::handle_unshare_project);
381 client.add_model_message_handler(Self::handle_create_buffer_for_peer);
382 client.add_model_message_handler(Self::handle_update_buffer_file);
383 client.add_model_message_handler(Self::handle_update_buffer);
384 client.add_model_message_handler(Self::handle_update_diagnostic_summary);
385 client.add_model_message_handler(Self::handle_update_worktree);
386 client.add_model_request_handler(Self::handle_create_project_entry);
387 client.add_model_request_handler(Self::handle_rename_project_entry);
388 client.add_model_request_handler(Self::handle_copy_project_entry);
389 client.add_model_request_handler(Self::handle_delete_project_entry);
390 client.add_model_request_handler(Self::handle_apply_additional_edits_for_completion);
391 client.add_model_request_handler(Self::handle_apply_code_action);
392 client.add_model_request_handler(Self::handle_reload_buffers);
393 client.add_model_request_handler(Self::handle_format_buffers);
394 client.add_model_request_handler(Self::handle_get_code_actions);
395 client.add_model_request_handler(Self::handle_get_completions);
396 client.add_model_request_handler(Self::handle_lsp_command::<GetHover>);
397 client.add_model_request_handler(Self::handle_lsp_command::<GetDefinition>);
398 client.add_model_request_handler(Self::handle_lsp_command::<GetTypeDefinition>);
399 client.add_model_request_handler(Self::handle_lsp_command::<GetDocumentHighlights>);
400 client.add_model_request_handler(Self::handle_lsp_command::<GetReferences>);
401 client.add_model_request_handler(Self::handle_lsp_command::<PrepareRename>);
402 client.add_model_request_handler(Self::handle_lsp_command::<PerformRename>);
403 client.add_model_request_handler(Self::handle_search_project);
404 client.add_model_request_handler(Self::handle_get_project_symbols);
405 client.add_model_request_handler(Self::handle_open_buffer_for_symbol);
406 client.add_model_request_handler(Self::handle_open_buffer_by_id);
407 client.add_model_request_handler(Self::handle_open_buffer_by_path);
408 client.add_model_request_handler(Self::handle_save_buffer);
409 client.add_model_message_handler(Self::handle_update_diff_base);
410 }
411
412 pub fn local(
413 client: Arc<Client>,
414 user_store: ModelHandle<UserStore>,
415 project_store: ModelHandle<ProjectStore>,
416 languages: Arc<LanguageRegistry>,
417 fs: Arc<dyn Fs>,
418 cx: &mut MutableAppContext,
419 ) -> ModelHandle<Self> {
420 cx.add_model(|cx: &mut ModelContext<Self>| {
421 let handle = cx.weak_handle();
422 project_store.update(cx, |store, cx| store.add_project(handle, cx));
423
424 Self {
425 worktrees: Default::default(),
426 collaborators: Default::default(),
427 opened_buffers: Default::default(),
428 shared_buffers: Default::default(),
429 incomplete_buffers: Default::default(),
430 loading_buffers: Default::default(),
431 loading_local_worktrees: Default::default(),
432 buffer_snapshots: Default::default(),
433 client_state: None,
434 opened_buffer: watch::channel(),
435 client_subscriptions: Vec::new(),
436 _subscriptions: vec![cx.observe_global::<Settings, _>(Self::on_settings_changed)],
437 _maintain_buffer_languages: Self::maintain_buffer_languages(&languages, cx),
438 active_entry: None,
439 languages,
440 client,
441 user_store,
442 project_store,
443 fs,
444 next_entry_id: Default::default(),
445 next_diagnostic_group_id: Default::default(),
446 language_servers: Default::default(),
447 language_server_ids: Default::default(),
448 language_server_statuses: Default::default(),
449 last_workspace_edits_by_language_server: Default::default(),
450 language_server_settings: Default::default(),
451 buffers_being_formatted: Default::default(),
452 next_language_server_id: 0,
453 nonce: StdRng::from_entropy().gen(),
454 }
455 })
456 }
457
458 pub async fn remote(
459 remote_id: u64,
460 client: Arc<Client>,
461 user_store: ModelHandle<UserStore>,
462 project_store: ModelHandle<ProjectStore>,
463 languages: Arc<LanguageRegistry>,
464 fs: Arc<dyn Fs>,
465 mut cx: AsyncAppContext,
466 ) -> Result<ModelHandle<Self>, JoinProjectError> {
467 client.authenticate_and_connect(true, &cx).await?;
468
469 let response = client
470 .request(proto::JoinProject {
471 project_id: remote_id,
472 })
473 .await?;
474
475 let replica_id = response.replica_id as ReplicaId;
476
477 let mut worktrees = Vec::new();
478 for worktree in response.worktrees {
479 let worktree = cx
480 .update(|cx| Worktree::remote(remote_id, replica_id, worktree, client.clone(), cx));
481 worktrees.push(worktree);
482 }
483
484 let this = cx.add_model(|cx: &mut ModelContext<Self>| {
485 let handle = cx.weak_handle();
486 project_store.update(cx, |store, cx| store.add_project(handle, cx));
487
488 let mut this = Self {
489 worktrees: Vec::new(),
490 loading_buffers: Default::default(),
491 opened_buffer: watch::channel(),
492 shared_buffers: Default::default(),
493 incomplete_buffers: Default::default(),
494 loading_local_worktrees: Default::default(),
495 active_entry: None,
496 collaborators: Default::default(),
497 _maintain_buffer_languages: Self::maintain_buffer_languages(&languages, cx),
498 languages,
499 user_store: user_store.clone(),
500 project_store,
501 fs,
502 next_entry_id: Default::default(),
503 next_diagnostic_group_id: Default::default(),
504 client_subscriptions: vec![client.add_model_for_remote_entity(remote_id, cx)],
505 _subscriptions: Default::default(),
506 client: client.clone(),
507 client_state: Some(ProjectClientState::Remote {
508 sharing_has_stopped: false,
509 remote_id,
510 replica_id,
511 _detect_unshare: cx.spawn_weak(move |this, mut cx| {
512 async move {
513 let mut status = client.status();
514 let is_connected =
515 status.next().await.map_or(false, |s| s.is_connected());
516 // Even if we're initially connected, any future change of the status means we momentarily disconnected.
517 if !is_connected || status.next().await.is_some() {
518 if let Some(this) = this.upgrade(&cx) {
519 this.update(&mut cx, |this, cx| this.disconnected_from_host(cx))
520 }
521 }
522 Ok(())
523 }
524 .log_err()
525 }),
526 }),
527 language_servers: Default::default(),
528 language_server_ids: Default::default(),
529 language_server_settings: Default::default(),
530 language_server_statuses: response
531 .language_servers
532 .into_iter()
533 .map(|server| {
534 (
535 server.id as usize,
536 LanguageServerStatus {
537 name: server.name,
538 pending_work: Default::default(),
539 has_pending_diagnostic_updates: false,
540 progress_tokens: Default::default(),
541 },
542 )
543 })
544 .collect(),
545 last_workspace_edits_by_language_server: Default::default(),
546 next_language_server_id: 0,
547 opened_buffers: Default::default(),
548 buffers_being_formatted: Default::default(),
549 buffer_snapshots: Default::default(),
550 nonce: StdRng::from_entropy().gen(),
551 };
552 for worktree in worktrees {
553 this.add_worktree(&worktree, cx);
554 }
555 this
556 });
557
558 let user_ids = response
559 .collaborators
560 .iter()
561 .map(|peer| peer.user_id)
562 .collect();
563 user_store
564 .update(&mut cx, |user_store, cx| user_store.get_users(user_ids, cx))
565 .await?;
566 let mut collaborators = HashMap::default();
567 for message in response.collaborators {
568 let collaborator = Collaborator::from_proto(message);
569 collaborators.insert(collaborator.peer_id, collaborator);
570 }
571
572 this.update(&mut cx, |this, _| {
573 this.collaborators = collaborators;
574 });
575
576 Ok(this)
577 }
578
579 #[cfg(any(test, feature = "test-support"))]
580 pub async fn test(
581 fs: Arc<dyn Fs>,
582 root_paths: impl IntoIterator<Item = &Path>,
583 cx: &mut gpui::TestAppContext,
584 ) -> ModelHandle<Project> {
585 if !cx.read(|cx| cx.has_global::<Settings>()) {
586 cx.update(|cx| {
587 cx.set_global(Settings::test(cx));
588 cx.set_global(HomeDir(Path::new("/tmp/").to_path_buf()))
589 });
590 }
591
592 let languages = Arc::new(LanguageRegistry::test());
593 let http_client = client::test::FakeHttpClient::with_404_response();
594 let client = cx.update(|cx| client::Client::new(http_client.clone(), cx));
595 let user_store = cx.add_model(|cx| UserStore::new(client.clone(), http_client, cx));
596 let project_store = cx.add_model(|_| ProjectStore::new());
597 let project =
598 cx.update(|cx| Project::local(client, user_store, project_store, languages, fs, cx));
599 for path in root_paths {
600 let (tree, _) = project
601 .update(cx, |project, cx| {
602 project.find_or_create_local_worktree(path, true, cx)
603 })
604 .await
605 .unwrap();
606 tree.read_with(cx, |tree, _| tree.as_local().unwrap().scan_complete())
607 .await;
608 }
609 project
610 }
611
612 fn on_settings_changed(&mut self, cx: &mut ModelContext<Self>) {
613 let settings = cx.global::<Settings>();
614
615 let mut language_servers_to_start = Vec::new();
616 for buffer in self.opened_buffers.values() {
617 if let Some(buffer) = buffer.upgrade(cx) {
618 let buffer = buffer.read(cx);
619 if let Some((file, language)) = File::from_dyn(buffer.file()).zip(buffer.language())
620 {
621 if settings.enable_language_server(Some(&language.name())) {
622 let worktree = file.worktree.read(cx);
623 language_servers_to_start.push((
624 worktree.id(),
625 worktree.as_local().unwrap().abs_path().clone(),
626 language.clone(),
627 ));
628 }
629 }
630 }
631 }
632
633 let mut language_servers_to_stop = Vec::new();
634 for language in self.languages.to_vec() {
635 if let Some(lsp_adapter) = language.lsp_adapter() {
636 if !settings.enable_language_server(Some(&language.name())) {
637 let lsp_name = &lsp_adapter.name;
638 for (worktree_id, started_lsp_name) in self.language_server_ids.keys() {
639 if lsp_name == started_lsp_name {
640 language_servers_to_stop.push((*worktree_id, started_lsp_name.clone()));
641 }
642 }
643 }
644 }
645 }
646
647 // Stop all newly-disabled language servers.
648 for (worktree_id, adapter_name) in language_servers_to_stop {
649 self.stop_language_server(worktree_id, adapter_name, cx)
650 .detach();
651 }
652
653 // Start all the newly-enabled language servers.
654 for (worktree_id, worktree_path, language) in language_servers_to_start {
655 self.start_language_server(worktree_id, worktree_path, language, cx);
656 }
657
658 cx.notify();
659 }
660
661 pub fn buffer_for_id(&self, remote_id: u64, cx: &AppContext) -> Option<ModelHandle<Buffer>> {
662 self.opened_buffers
663 .get(&remote_id)
664 .and_then(|buffer| buffer.upgrade(cx))
665 }
666
667 pub fn languages(&self) -> &Arc<LanguageRegistry> {
668 &self.languages
669 }
670
671 pub fn client(&self) -> Arc<Client> {
672 self.client.clone()
673 }
674
675 pub fn user_store(&self) -> ModelHandle<UserStore> {
676 self.user_store.clone()
677 }
678
679 pub fn project_store(&self) -> ModelHandle<ProjectStore> {
680 self.project_store.clone()
681 }
682
683 #[cfg(any(test, feature = "test-support"))]
684 pub fn check_invariants(&self, cx: &AppContext) {
685 if self.is_local() {
686 let mut worktree_root_paths = HashMap::default();
687 for worktree in self.worktrees(cx) {
688 let worktree = worktree.read(cx);
689 let abs_path = worktree.as_local().unwrap().abs_path().clone();
690 let prev_worktree_id = worktree_root_paths.insert(abs_path.clone(), worktree.id());
691 assert_eq!(
692 prev_worktree_id,
693 None,
694 "abs path {:?} for worktree {:?} is not unique ({:?} was already registered with the same path)",
695 abs_path,
696 worktree.id(),
697 prev_worktree_id
698 )
699 }
700 } else {
701 let replica_id = self.replica_id();
702 for buffer in self.opened_buffers.values() {
703 if let Some(buffer) = buffer.upgrade(cx) {
704 let buffer = buffer.read(cx);
705 assert_eq!(
706 buffer.deferred_ops_len(),
707 0,
708 "replica {}, buffer {} has deferred operations",
709 replica_id,
710 buffer.remote_id()
711 );
712 }
713 }
714 }
715 }
716
717 #[cfg(any(test, feature = "test-support"))]
718 pub fn has_open_buffer(&self, path: impl Into<ProjectPath>, cx: &AppContext) -> bool {
719 let path = path.into();
720 if let Some(worktree) = self.worktree_for_id(path.worktree_id, cx) {
721 self.opened_buffers.iter().any(|(_, buffer)| {
722 if let Some(buffer) = buffer.upgrade(cx) {
723 if let Some(file) = File::from_dyn(buffer.read(cx).file()) {
724 if file.worktree == worktree && file.path() == &path.path {
725 return true;
726 }
727 }
728 }
729 false
730 })
731 } else {
732 false
733 }
734 }
735
736 pub fn fs(&self) -> &Arc<dyn Fs> {
737 &self.fs
738 }
739
740 pub fn remote_id(&self) -> Option<u64> {
741 match self.client_state.as_ref()? {
742 ProjectClientState::Local { remote_id, .. }
743 | ProjectClientState::Remote { remote_id, .. } => Some(*remote_id),
744 }
745 }
746
747 pub fn replica_id(&self) -> ReplicaId {
748 match &self.client_state {
749 Some(ProjectClientState::Remote { replica_id, .. }) => *replica_id,
750 _ => 0,
751 }
752 }
753
754 fn metadata_changed(&mut self, cx: &mut ModelContext<Self>) {
755 if let Some(ProjectClientState::Local { remote_id, .. }) = &self.client_state {
756 let project_id = *remote_id;
757 // Broadcast worktrees only if the project is online.
758 let worktrees = self
759 .worktrees
760 .iter()
761 .filter_map(|worktree| {
762 worktree
763 .upgrade(cx)
764 .map(|worktree| worktree.read(cx).as_local().unwrap().metadata_proto())
765 })
766 .collect();
767 self.client
768 .send(proto::UpdateProject {
769 project_id,
770 worktrees,
771 })
772 .log_err();
773
774 let worktrees = self.visible_worktrees(cx).collect::<Vec<_>>();
775 let scans_complete = futures::future::join_all(
776 worktrees
777 .iter()
778 .filter_map(|worktree| Some(worktree.read(cx).as_local()?.scan_complete())),
779 );
780
781 let worktrees = worktrees.into_iter().map(|handle| handle.downgrade());
782
783 cx.spawn_weak(move |_, cx| async move {
784 scans_complete.await;
785 cx.read(|cx| {
786 for worktree in worktrees {
787 if let Some(worktree) = worktree
788 .upgrade(cx)
789 .and_then(|worktree| worktree.read(cx).as_local())
790 {
791 worktree.send_extension_counts(project_id);
792 }
793 }
794 })
795 })
796 .detach();
797 }
798
799 self.project_store.update(cx, |_, cx| cx.notify());
800 cx.notify();
801 }
802
803 pub fn collaborators(&self) -> &HashMap<PeerId, Collaborator> {
804 &self.collaborators
805 }
806
807 pub fn worktrees<'a>(
808 &'a self,
809 cx: &'a AppContext,
810 ) -> impl 'a + DoubleEndedIterator<Item = ModelHandle<Worktree>> {
811 self.worktrees
812 .iter()
813 .filter_map(move |worktree| worktree.upgrade(cx))
814 }
815
816 pub fn visible_worktrees<'a>(
817 &'a self,
818 cx: &'a AppContext,
819 ) -> impl 'a + DoubleEndedIterator<Item = ModelHandle<Worktree>> {
820 self.worktrees.iter().filter_map(|worktree| {
821 worktree.upgrade(cx).and_then(|worktree| {
822 if worktree.read(cx).is_visible() {
823 Some(worktree)
824 } else {
825 None
826 }
827 })
828 })
829 }
830
831 pub fn worktree_root_names<'a>(&'a self, cx: &'a AppContext) -> impl Iterator<Item = &'a str> {
832 self.visible_worktrees(cx)
833 .map(|tree| tree.read(cx).root_name())
834 }
835
836 pub fn worktree_for_id(
837 &self,
838 id: WorktreeId,
839 cx: &AppContext,
840 ) -> Option<ModelHandle<Worktree>> {
841 self.worktrees(cx)
842 .find(|worktree| worktree.read(cx).id() == id)
843 }
844
845 pub fn worktree_for_entry(
846 &self,
847 entry_id: ProjectEntryId,
848 cx: &AppContext,
849 ) -> Option<ModelHandle<Worktree>> {
850 self.worktrees(cx)
851 .find(|worktree| worktree.read(cx).contains_entry(entry_id))
852 }
853
854 pub fn worktree_id_for_entry(
855 &self,
856 entry_id: ProjectEntryId,
857 cx: &AppContext,
858 ) -> Option<WorktreeId> {
859 self.worktree_for_entry(entry_id, cx)
860 .map(|worktree| worktree.read(cx).id())
861 }
862
863 pub fn contains_paths(&self, paths: &[PathBuf], cx: &AppContext) -> bool {
864 paths.iter().all(|path| self.contains_path(path, cx))
865 }
866
867 pub fn contains_path(&self, path: &Path, cx: &AppContext) -> bool {
868 for worktree in self.worktrees(cx) {
869 let worktree = worktree.read(cx).as_local();
870 if worktree.map_or(false, |w| w.contains_abs_path(path)) {
871 return true;
872 }
873 }
874 false
875 }
876
877 pub fn create_entry(
878 &mut self,
879 project_path: impl Into<ProjectPath>,
880 is_directory: bool,
881 cx: &mut ModelContext<Self>,
882 ) -> Option<Task<Result<Entry>>> {
883 let project_path = project_path.into();
884 let worktree = self.worktree_for_id(project_path.worktree_id, cx)?;
885 if self.is_local() {
886 Some(worktree.update(cx, |worktree, cx| {
887 worktree
888 .as_local_mut()
889 .unwrap()
890 .create_entry(project_path.path, is_directory, cx)
891 }))
892 } else {
893 let client = self.client.clone();
894 let project_id = self.remote_id().unwrap();
895 Some(cx.spawn_weak(|_, mut cx| async move {
896 let response = client
897 .request(proto::CreateProjectEntry {
898 worktree_id: project_path.worktree_id.to_proto(),
899 project_id,
900 path: project_path.path.as_os_str().as_bytes().to_vec(),
901 is_directory,
902 })
903 .await?;
904 let entry = response
905 .entry
906 .ok_or_else(|| anyhow!("missing entry in response"))?;
907 worktree
908 .update(&mut cx, |worktree, cx| {
909 worktree.as_remote_mut().unwrap().insert_entry(
910 entry,
911 response.worktree_scan_id as usize,
912 cx,
913 )
914 })
915 .await
916 }))
917 }
918 }
919
920 pub fn copy_entry(
921 &mut self,
922 entry_id: ProjectEntryId,
923 new_path: impl Into<Arc<Path>>,
924 cx: &mut ModelContext<Self>,
925 ) -> Option<Task<Result<Entry>>> {
926 let worktree = self.worktree_for_entry(entry_id, cx)?;
927 let new_path = new_path.into();
928 if self.is_local() {
929 worktree.update(cx, |worktree, cx| {
930 worktree
931 .as_local_mut()
932 .unwrap()
933 .copy_entry(entry_id, new_path, cx)
934 })
935 } else {
936 let client = self.client.clone();
937 let project_id = self.remote_id().unwrap();
938
939 Some(cx.spawn_weak(|_, mut cx| async move {
940 let response = client
941 .request(proto::CopyProjectEntry {
942 project_id,
943 entry_id: entry_id.to_proto(),
944 new_path: new_path.as_os_str().as_bytes().to_vec(),
945 })
946 .await?;
947 let entry = response
948 .entry
949 .ok_or_else(|| anyhow!("missing entry in response"))?;
950 worktree
951 .update(&mut cx, |worktree, cx| {
952 worktree.as_remote_mut().unwrap().insert_entry(
953 entry,
954 response.worktree_scan_id as usize,
955 cx,
956 )
957 })
958 .await
959 }))
960 }
961 }
962
963 pub fn rename_entry(
964 &mut self,
965 entry_id: ProjectEntryId,
966 new_path: impl Into<Arc<Path>>,
967 cx: &mut ModelContext<Self>,
968 ) -> Option<Task<Result<Entry>>> {
969 let worktree = self.worktree_for_entry(entry_id, cx)?;
970 let new_path = new_path.into();
971 if self.is_local() {
972 worktree.update(cx, |worktree, cx| {
973 worktree
974 .as_local_mut()
975 .unwrap()
976 .rename_entry(entry_id, new_path, cx)
977 })
978 } else {
979 let client = self.client.clone();
980 let project_id = self.remote_id().unwrap();
981
982 Some(cx.spawn_weak(|_, mut cx| async move {
983 let response = client
984 .request(proto::RenameProjectEntry {
985 project_id,
986 entry_id: entry_id.to_proto(),
987 new_path: new_path.as_os_str().as_bytes().to_vec(),
988 })
989 .await?;
990 let entry = response
991 .entry
992 .ok_or_else(|| anyhow!("missing entry in response"))?;
993 worktree
994 .update(&mut cx, |worktree, cx| {
995 worktree.as_remote_mut().unwrap().insert_entry(
996 entry,
997 response.worktree_scan_id as usize,
998 cx,
999 )
1000 })
1001 .await
1002 }))
1003 }
1004 }
1005
1006 pub fn delete_entry(
1007 &mut self,
1008 entry_id: ProjectEntryId,
1009 cx: &mut ModelContext<Self>,
1010 ) -> Option<Task<Result<()>>> {
1011 let worktree = self.worktree_for_entry(entry_id, cx)?;
1012 if self.is_local() {
1013 worktree.update(cx, |worktree, cx| {
1014 worktree.as_local_mut().unwrap().delete_entry(entry_id, cx)
1015 })
1016 } else {
1017 let client = self.client.clone();
1018 let project_id = self.remote_id().unwrap();
1019 Some(cx.spawn_weak(|_, mut cx| async move {
1020 let response = client
1021 .request(proto::DeleteProjectEntry {
1022 project_id,
1023 entry_id: entry_id.to_proto(),
1024 })
1025 .await?;
1026 worktree
1027 .update(&mut cx, move |worktree, cx| {
1028 worktree.as_remote_mut().unwrap().delete_entry(
1029 entry_id,
1030 response.worktree_scan_id as usize,
1031 cx,
1032 )
1033 })
1034 .await
1035 }))
1036 }
1037 }
1038
1039 pub fn shared(&mut self, project_id: u64, cx: &mut ModelContext<Self>) -> Task<Result<()>> {
1040 if self.client_state.is_some() {
1041 return Task::ready(Err(anyhow!("project was already shared")));
1042 }
1043
1044 let mut worktree_share_tasks = Vec::new();
1045
1046 for open_buffer in self.opened_buffers.values_mut() {
1047 match open_buffer {
1048 OpenBuffer::Strong(_) => {}
1049 OpenBuffer::Weak(buffer) => {
1050 if let Some(buffer) = buffer.upgrade(cx) {
1051 *open_buffer = OpenBuffer::Strong(buffer);
1052 }
1053 }
1054 OpenBuffer::Operations(_) => unreachable!(),
1055 }
1056 }
1057
1058 for worktree_handle in self.worktrees.iter_mut() {
1059 match worktree_handle {
1060 WorktreeHandle::Strong(_) => {}
1061 WorktreeHandle::Weak(worktree) => {
1062 if let Some(worktree) = worktree.upgrade(cx) {
1063 *worktree_handle = WorktreeHandle::Strong(worktree);
1064 }
1065 }
1066 }
1067 }
1068
1069 for (server_id, status) in &self.language_server_statuses {
1070 self.client
1071 .send(proto::StartLanguageServer {
1072 project_id,
1073 server: Some(proto::LanguageServer {
1074 id: *server_id as u64,
1075 name: status.name.clone(),
1076 }),
1077 })
1078 .log_err();
1079 }
1080
1081 for worktree in self.worktrees(cx).collect::<Vec<_>>() {
1082 worktree.update(cx, |worktree, cx| {
1083 let worktree = worktree.as_local_mut().unwrap();
1084 worktree_share_tasks.push(worktree.share(project_id, cx));
1085 });
1086 }
1087
1088 self.client_subscriptions
1089 .push(self.client.add_model_for_remote_entity(project_id, cx));
1090 self.metadata_changed(cx);
1091 cx.emit(Event::RemoteIdChanged(Some(project_id)));
1092 cx.notify();
1093
1094 let mut status = self.client.status();
1095 self.client_state = Some(ProjectClientState::Local {
1096 remote_id: project_id,
1097 _detect_unshare: cx.spawn_weak(move |this, mut cx| {
1098 async move {
1099 let is_connected = status.next().await.map_or(false, |s| s.is_connected());
1100 // Even if we're initially connected, any future change of the status means we momentarily disconnected.
1101 if !is_connected || status.next().await.is_some() {
1102 if let Some(this) = this.upgrade(&cx) {
1103 let _ = this.update(&mut cx, |this, cx| this.unshare(cx));
1104 }
1105 }
1106 Ok(())
1107 }
1108 .log_err()
1109 }),
1110 });
1111
1112 cx.foreground().spawn(async move {
1113 futures::future::try_join_all(worktree_share_tasks).await?;
1114 Ok(())
1115 })
1116 }
1117
1118 pub fn unshare(&mut self, cx: &mut ModelContext<Self>) -> Result<()> {
1119 if self.is_remote() {
1120 return Err(anyhow!("attempted to unshare a remote project"));
1121 }
1122
1123 if let Some(ProjectClientState::Local { remote_id, .. }) = self.client_state.take() {
1124 self.collaborators.clear();
1125 self.shared_buffers.clear();
1126 self.client_subscriptions.clear();
1127
1128 for worktree_handle in self.worktrees.iter_mut() {
1129 if let WorktreeHandle::Strong(worktree) = worktree_handle {
1130 let is_visible = worktree.update(cx, |worktree, _| {
1131 worktree.as_local_mut().unwrap().unshare();
1132 worktree.is_visible()
1133 });
1134 if !is_visible {
1135 *worktree_handle = WorktreeHandle::Weak(worktree.downgrade());
1136 }
1137 }
1138 }
1139
1140 for open_buffer in self.opened_buffers.values_mut() {
1141 if let OpenBuffer::Strong(buffer) = open_buffer {
1142 *open_buffer = OpenBuffer::Weak(buffer.downgrade());
1143 }
1144 }
1145
1146 self.metadata_changed(cx);
1147 cx.notify();
1148 self.client.send(proto::UnshareProject {
1149 project_id: remote_id,
1150 })?;
1151
1152 Ok(())
1153 } else {
1154 Err(anyhow!("attempted to unshare an unshared project"))
1155 }
1156 }
1157
1158 fn disconnected_from_host(&mut self, cx: &mut ModelContext<Self>) {
1159 if let Some(ProjectClientState::Remote {
1160 sharing_has_stopped,
1161 ..
1162 }) = &mut self.client_state
1163 {
1164 *sharing_has_stopped = true;
1165 self.collaborators.clear();
1166 for worktree in &self.worktrees {
1167 if let Some(worktree) = worktree.upgrade(cx) {
1168 worktree.update(cx, |worktree, _| {
1169 if let Some(worktree) = worktree.as_remote_mut() {
1170 worktree.disconnected_from_host();
1171 }
1172 });
1173 }
1174 }
1175 cx.emit(Event::DisconnectedFromHost);
1176 cx.notify();
1177
1178 // Wake up all futures currently waiting on a buffer to get opened,
1179 // to give them a chance to fail now that we've disconnected.
1180 *self.opened_buffer.0.borrow_mut() = ();
1181 }
1182 }
1183
1184 pub fn is_read_only(&self) -> bool {
1185 match &self.client_state {
1186 Some(ProjectClientState::Remote {
1187 sharing_has_stopped,
1188 ..
1189 }) => *sharing_has_stopped,
1190 _ => false,
1191 }
1192 }
1193
1194 pub fn is_local(&self) -> bool {
1195 match &self.client_state {
1196 Some(ProjectClientState::Remote { .. }) => false,
1197 _ => true,
1198 }
1199 }
1200
1201 pub fn is_remote(&self) -> bool {
1202 !self.is_local()
1203 }
1204
1205 pub fn create_buffer(
1206 &mut self,
1207 text: &str,
1208 language: Option<Arc<Language>>,
1209 cx: &mut ModelContext<Self>,
1210 ) -> Result<ModelHandle<Buffer>> {
1211 if self.is_remote() {
1212 return Err(anyhow!("creating buffers as a guest is not supported yet"));
1213 }
1214
1215 let buffer = cx.add_model(|cx| {
1216 Buffer::new(self.replica_id(), text, cx)
1217 .with_language(language.unwrap_or_else(|| language::PLAIN_TEXT.clone()), cx)
1218 });
1219 self.register_buffer(&buffer, cx)?;
1220 Ok(buffer)
1221 }
1222
1223 pub fn open_path(
1224 &mut self,
1225 path: impl Into<ProjectPath>,
1226 cx: &mut ModelContext<Self>,
1227 ) -> Task<Result<(ProjectEntryId, AnyModelHandle)>> {
1228 let task = self.open_buffer(path, cx);
1229 cx.spawn_weak(|_, cx| async move {
1230 let buffer = task.await?;
1231 let project_entry_id = buffer
1232 .read_with(&cx, |buffer, cx| {
1233 File::from_dyn(buffer.file()).and_then(|file| file.project_entry_id(cx))
1234 })
1235 .ok_or_else(|| anyhow!("no project entry"))?;
1236 Ok((project_entry_id, buffer.into()))
1237 })
1238 }
1239
1240 pub fn open_local_buffer(
1241 &mut self,
1242 abs_path: impl AsRef<Path>,
1243 cx: &mut ModelContext<Self>,
1244 ) -> Task<Result<ModelHandle<Buffer>>> {
1245 if let Some((worktree, relative_path)) = self.find_local_worktree(abs_path.as_ref(), cx) {
1246 self.open_buffer((worktree.read(cx).id(), relative_path), cx)
1247 } else {
1248 Task::ready(Err(anyhow!("no such path")))
1249 }
1250 }
1251
1252 pub fn open_buffer(
1253 &mut self,
1254 path: impl Into<ProjectPath>,
1255 cx: &mut ModelContext<Self>,
1256 ) -> Task<Result<ModelHandle<Buffer>>> {
1257 let project_path = path.into();
1258 let worktree = if let Some(worktree) = self.worktree_for_id(project_path.worktree_id, cx) {
1259 worktree
1260 } else {
1261 return Task::ready(Err(anyhow!("no such worktree")));
1262 };
1263
1264 // If there is already a buffer for the given path, then return it.
1265 let existing_buffer = self.get_open_buffer(&project_path, cx);
1266 if let Some(existing_buffer) = existing_buffer {
1267 return Task::ready(Ok(existing_buffer));
1268 }
1269
1270 let mut loading_watch = match self.loading_buffers.entry(project_path.clone()) {
1271 // If the given path is already being loaded, then wait for that existing
1272 // task to complete and return the same buffer.
1273 hash_map::Entry::Occupied(e) => e.get().clone(),
1274
1275 // Otherwise, record the fact that this path is now being loaded.
1276 hash_map::Entry::Vacant(entry) => {
1277 let (mut tx, rx) = postage::watch::channel();
1278 entry.insert(rx.clone());
1279
1280 let load_buffer = if worktree.read(cx).is_local() {
1281 self.open_local_buffer_internal(&project_path.path, &worktree, cx)
1282 } else {
1283 self.open_remote_buffer_internal(&project_path.path, &worktree, cx)
1284 };
1285
1286 cx.spawn(move |this, mut cx| async move {
1287 let load_result = load_buffer.await;
1288 *tx.borrow_mut() = Some(this.update(&mut cx, |this, _| {
1289 // Record the fact that the buffer is no longer loading.
1290 this.loading_buffers.remove(&project_path);
1291 let buffer = load_result.map_err(Arc::new)?;
1292 Ok(buffer)
1293 }));
1294 })
1295 .detach();
1296 rx
1297 }
1298 };
1299
1300 cx.foreground().spawn(async move {
1301 loop {
1302 if let Some(result) = loading_watch.borrow().as_ref() {
1303 match result {
1304 Ok(buffer) => return Ok(buffer.clone()),
1305 Err(error) => return Err(anyhow!("{}", error)),
1306 }
1307 }
1308 loading_watch.next().await;
1309 }
1310 })
1311 }
1312
1313 fn open_local_buffer_internal(
1314 &mut self,
1315 path: &Arc<Path>,
1316 worktree: &ModelHandle<Worktree>,
1317 cx: &mut ModelContext<Self>,
1318 ) -> Task<Result<ModelHandle<Buffer>>> {
1319 let load_buffer = worktree.update(cx, |worktree, cx| {
1320 let worktree = worktree.as_local_mut().unwrap();
1321 worktree.load_buffer(path, cx)
1322 });
1323 cx.spawn(|this, mut cx| async move {
1324 let buffer = load_buffer.await?;
1325 this.update(&mut cx, |this, cx| this.register_buffer(&buffer, cx))?;
1326 Ok(buffer)
1327 })
1328 }
1329
1330 fn open_remote_buffer_internal(
1331 &mut self,
1332 path: &Arc<Path>,
1333 worktree: &ModelHandle<Worktree>,
1334 cx: &mut ModelContext<Self>,
1335 ) -> Task<Result<ModelHandle<Buffer>>> {
1336 let rpc = self.client.clone();
1337 let project_id = self.remote_id().unwrap();
1338 let remote_worktree_id = worktree.read(cx).id();
1339 let path = path.clone();
1340 let path_string = path.to_string_lossy().to_string();
1341 cx.spawn(|this, mut cx| async move {
1342 let response = rpc
1343 .request(proto::OpenBufferByPath {
1344 project_id,
1345 worktree_id: remote_worktree_id.to_proto(),
1346 path: path_string,
1347 })
1348 .await?;
1349 this.update(&mut cx, |this, cx| {
1350 this.wait_for_buffer(response.buffer_id, cx)
1351 })
1352 .await
1353 })
1354 }
1355
1356 /// LanguageServerName is owned, because it is inserted into a map
1357 fn open_local_buffer_via_lsp(
1358 &mut self,
1359 abs_path: lsp::Url,
1360 language_server_id: usize,
1361 language_server_name: LanguageServerName,
1362 cx: &mut ModelContext<Self>,
1363 ) -> Task<Result<ModelHandle<Buffer>>> {
1364 cx.spawn(|this, mut cx| async move {
1365 let abs_path = abs_path
1366 .to_file_path()
1367 .map_err(|_| anyhow!("can't convert URI to path"))?;
1368 let (worktree, relative_path) = if let Some(result) =
1369 this.read_with(&cx, |this, cx| this.find_local_worktree(&abs_path, cx))
1370 {
1371 result
1372 } else {
1373 let worktree = this
1374 .update(&mut cx, |this, cx| {
1375 this.create_local_worktree(&abs_path, false, cx)
1376 })
1377 .await?;
1378 this.update(&mut cx, |this, cx| {
1379 this.language_server_ids.insert(
1380 (worktree.read(cx).id(), language_server_name),
1381 language_server_id,
1382 );
1383 });
1384 (worktree, PathBuf::new())
1385 };
1386
1387 let project_path = ProjectPath {
1388 worktree_id: worktree.read_with(&cx, |worktree, _| worktree.id()),
1389 path: relative_path.into(),
1390 };
1391 this.update(&mut cx, |this, cx| this.open_buffer(project_path, cx))
1392 .await
1393 })
1394 }
1395
1396 pub fn open_buffer_by_id(
1397 &mut self,
1398 id: u64,
1399 cx: &mut ModelContext<Self>,
1400 ) -> Task<Result<ModelHandle<Buffer>>> {
1401 if let Some(buffer) = self.buffer_for_id(id, cx) {
1402 Task::ready(Ok(buffer))
1403 } else if self.is_local() {
1404 Task::ready(Err(anyhow!("buffer {} does not exist", id)))
1405 } else if let Some(project_id) = self.remote_id() {
1406 let request = self
1407 .client
1408 .request(proto::OpenBufferById { project_id, id });
1409 cx.spawn(|this, mut cx| async move {
1410 let buffer_id = request.await?.buffer_id;
1411 this.update(&mut cx, |this, cx| this.wait_for_buffer(buffer_id, cx))
1412 .await
1413 })
1414 } else {
1415 Task::ready(Err(anyhow!("cannot open buffer while disconnected")))
1416 }
1417 }
1418
1419 pub fn save_buffer_as(
1420 &mut self,
1421 buffer: ModelHandle<Buffer>,
1422 abs_path: PathBuf,
1423 cx: &mut ModelContext<Project>,
1424 ) -> Task<Result<()>> {
1425 let worktree_task = self.find_or_create_local_worktree(&abs_path, true, cx);
1426 let old_path =
1427 File::from_dyn(buffer.read(cx).file()).and_then(|f| Some(f.as_local()?.abs_path(cx)));
1428 cx.spawn(|this, mut cx| async move {
1429 if let Some(old_path) = old_path {
1430 this.update(&mut cx, |this, cx| {
1431 this.unregister_buffer_from_language_server(&buffer, old_path, cx);
1432 });
1433 }
1434 let (worktree, path) = worktree_task.await?;
1435 worktree
1436 .update(&mut cx, |worktree, cx| {
1437 worktree
1438 .as_local_mut()
1439 .unwrap()
1440 .save_buffer_as(buffer.clone(), path, cx)
1441 })
1442 .await?;
1443 this.update(&mut cx, |this, cx| {
1444 this.assign_language_to_buffer(&buffer, cx);
1445 this.register_buffer_with_language_server(&buffer, cx);
1446 });
1447 Ok(())
1448 })
1449 }
1450
1451 pub fn get_open_buffer(
1452 &mut self,
1453 path: &ProjectPath,
1454 cx: &mut ModelContext<Self>,
1455 ) -> Option<ModelHandle<Buffer>> {
1456 let worktree = self.worktree_for_id(path.worktree_id, cx)?;
1457 self.opened_buffers.values().find_map(|buffer| {
1458 let buffer = buffer.upgrade(cx)?;
1459 let file = File::from_dyn(buffer.read(cx).file())?;
1460 if file.worktree == worktree && file.path() == &path.path {
1461 Some(buffer)
1462 } else {
1463 None
1464 }
1465 })
1466 }
1467
1468 fn register_buffer(
1469 &mut self,
1470 buffer: &ModelHandle<Buffer>,
1471 cx: &mut ModelContext<Self>,
1472 ) -> Result<()> {
1473 let remote_id = buffer.read(cx).remote_id();
1474 let open_buffer = if self.is_remote() || self.is_shared() {
1475 OpenBuffer::Strong(buffer.clone())
1476 } else {
1477 OpenBuffer::Weak(buffer.downgrade())
1478 };
1479
1480 match self.opened_buffers.insert(remote_id, open_buffer) {
1481 None => {}
1482 Some(OpenBuffer::Operations(operations)) => {
1483 buffer.update(cx, |buffer, cx| buffer.apply_ops(operations, cx))?
1484 }
1485 Some(OpenBuffer::Weak(existing_handle)) => {
1486 if existing_handle.upgrade(cx).is_some() {
1487 Err(anyhow!(
1488 "already registered buffer with remote id {}",
1489 remote_id
1490 ))?
1491 }
1492 }
1493 Some(OpenBuffer::Strong(_)) => Err(anyhow!(
1494 "already registered buffer with remote id {}",
1495 remote_id
1496 ))?,
1497 }
1498 cx.subscribe(buffer, |this, buffer, event, cx| {
1499 this.on_buffer_event(buffer, event, cx);
1500 })
1501 .detach();
1502
1503 self.assign_language_to_buffer(buffer, cx);
1504 self.register_buffer_with_language_server(buffer, cx);
1505 cx.observe_release(buffer, |this, buffer, cx| {
1506 if let Some(file) = File::from_dyn(buffer.file()) {
1507 if file.is_local() {
1508 let uri = lsp::Url::from_file_path(file.abs_path(cx)).unwrap();
1509 if let Some((_, server)) = this.language_server_for_buffer(buffer, cx) {
1510 server
1511 .notify::<lsp::notification::DidCloseTextDocument>(
1512 lsp::DidCloseTextDocumentParams {
1513 text_document: lsp::TextDocumentIdentifier::new(uri),
1514 },
1515 )
1516 .log_err();
1517 }
1518 }
1519 }
1520 })
1521 .detach();
1522
1523 *self.opened_buffer.0.borrow_mut() = ();
1524 Ok(())
1525 }
1526
1527 fn register_buffer_with_language_server(
1528 &mut self,
1529 buffer_handle: &ModelHandle<Buffer>,
1530 cx: &mut ModelContext<Self>,
1531 ) {
1532 let buffer = buffer_handle.read(cx);
1533 let buffer_id = buffer.remote_id();
1534 if let Some(file) = File::from_dyn(buffer.file()) {
1535 if file.is_local() {
1536 let uri = lsp::Url::from_file_path(file.abs_path(cx)).unwrap();
1537 let initial_snapshot = buffer.text_snapshot();
1538
1539 let mut language_server = None;
1540 let mut language_id = None;
1541 if let Some(language) = buffer.language() {
1542 let worktree_id = file.worktree_id(cx);
1543 if let Some(adapter) = language.lsp_adapter() {
1544 language_id = adapter.language_ids.get(language.name().as_ref()).cloned();
1545 language_server = self
1546 .language_server_ids
1547 .get(&(worktree_id, adapter.name.clone()))
1548 .and_then(|id| self.language_servers.get(id))
1549 .and_then(|server_state| {
1550 if let LanguageServerState::Running { server, .. } = server_state {
1551 Some(server.clone())
1552 } else {
1553 None
1554 }
1555 });
1556 }
1557 }
1558
1559 if let Some(local_worktree) = file.worktree.read(cx).as_local() {
1560 if let Some(diagnostics) = local_worktree.diagnostics_for_path(file.path()) {
1561 self.update_buffer_diagnostics(buffer_handle, diagnostics, None, cx)
1562 .log_err();
1563 }
1564 }
1565
1566 if let Some(server) = language_server {
1567 server
1568 .notify::<lsp::notification::DidOpenTextDocument>(
1569 lsp::DidOpenTextDocumentParams {
1570 text_document: lsp::TextDocumentItem::new(
1571 uri,
1572 language_id.unwrap_or_default(),
1573 0,
1574 initial_snapshot.text(),
1575 ),
1576 },
1577 )
1578 .log_err();
1579 buffer_handle.update(cx, |buffer, cx| {
1580 buffer.set_completion_triggers(
1581 server
1582 .capabilities()
1583 .completion_provider
1584 .as_ref()
1585 .and_then(|provider| provider.trigger_characters.clone())
1586 .unwrap_or_default(),
1587 cx,
1588 )
1589 });
1590 self.buffer_snapshots
1591 .insert(buffer_id, vec![(0, initial_snapshot)]);
1592 }
1593 }
1594 }
1595 }
1596
1597 fn unregister_buffer_from_language_server(
1598 &mut self,
1599 buffer: &ModelHandle<Buffer>,
1600 old_path: PathBuf,
1601 cx: &mut ModelContext<Self>,
1602 ) {
1603 buffer.update(cx, |buffer, cx| {
1604 buffer.update_diagnostics(Default::default(), cx);
1605 self.buffer_snapshots.remove(&buffer.remote_id());
1606 if let Some((_, language_server)) = self.language_server_for_buffer(buffer, cx) {
1607 language_server
1608 .notify::<lsp::notification::DidCloseTextDocument>(
1609 lsp::DidCloseTextDocumentParams {
1610 text_document: lsp::TextDocumentIdentifier::new(
1611 lsp::Url::from_file_path(old_path).unwrap(),
1612 ),
1613 },
1614 )
1615 .log_err();
1616 }
1617 });
1618 }
1619
1620 fn on_buffer_event(
1621 &mut self,
1622 buffer: ModelHandle<Buffer>,
1623 event: &BufferEvent,
1624 cx: &mut ModelContext<Self>,
1625 ) -> Option<()> {
1626 match event {
1627 BufferEvent::Operation(operation) => {
1628 if let Some(project_id) = self.remote_id() {
1629 let request = self.client.request(proto::UpdateBuffer {
1630 project_id,
1631 buffer_id: buffer.read(cx).remote_id(),
1632 operations: vec![language::proto::serialize_operation(operation)],
1633 });
1634 cx.background().spawn(request).detach_and_log_err(cx);
1635 } else if let Some(project_id) = self.remote_id() {
1636 let _ = self
1637 .client
1638 .send(proto::RegisterProjectActivity { project_id });
1639 }
1640 }
1641 BufferEvent::Edited { .. } => {
1642 let language_server = self
1643 .language_server_for_buffer(buffer.read(cx), cx)
1644 .map(|(_, server)| server.clone())?;
1645 let buffer = buffer.read(cx);
1646 let file = File::from_dyn(buffer.file())?;
1647 let abs_path = file.as_local()?.abs_path(cx);
1648 let uri = lsp::Url::from_file_path(abs_path).unwrap();
1649 let buffer_snapshots = self.buffer_snapshots.get_mut(&buffer.remote_id())?;
1650 let (version, prev_snapshot) = buffer_snapshots.last()?;
1651 let next_snapshot = buffer.text_snapshot();
1652 let next_version = version + 1;
1653
1654 let content_changes = buffer
1655 .edits_since::<(PointUtf16, usize)>(prev_snapshot.version())
1656 .map(|edit| {
1657 let edit_start = edit.new.start.0;
1658 let edit_end = edit_start + (edit.old.end.0 - edit.old.start.0);
1659 let new_text = next_snapshot
1660 .text_for_range(edit.new.start.1..edit.new.end.1)
1661 .collect();
1662 lsp::TextDocumentContentChangeEvent {
1663 range: Some(lsp::Range::new(
1664 point_to_lsp(edit_start),
1665 point_to_lsp(edit_end),
1666 )),
1667 range_length: None,
1668 text: new_text,
1669 }
1670 })
1671 .collect();
1672
1673 buffer_snapshots.push((next_version, next_snapshot));
1674
1675 language_server
1676 .notify::<lsp::notification::DidChangeTextDocument>(
1677 lsp::DidChangeTextDocumentParams {
1678 text_document: lsp::VersionedTextDocumentIdentifier::new(
1679 uri,
1680 next_version,
1681 ),
1682 content_changes,
1683 },
1684 )
1685 .log_err();
1686 }
1687 BufferEvent::Saved => {
1688 let file = File::from_dyn(buffer.read(cx).file())?;
1689 let worktree_id = file.worktree_id(cx);
1690 let abs_path = file.as_local()?.abs_path(cx);
1691 let text_document = lsp::TextDocumentIdentifier {
1692 uri: lsp::Url::from_file_path(abs_path).unwrap(),
1693 };
1694
1695 for (_, _, server) in self.language_servers_for_worktree(worktree_id) {
1696 server
1697 .notify::<lsp::notification::DidSaveTextDocument>(
1698 lsp::DidSaveTextDocumentParams {
1699 text_document: text_document.clone(),
1700 text: None,
1701 },
1702 )
1703 .log_err();
1704 }
1705
1706 // After saving a buffer, simulate disk-based diagnostics being finished for languages
1707 // that don't support a disk-based progress token.
1708 let (lsp_adapter, language_server) =
1709 self.language_server_for_buffer(buffer.read(cx), cx)?;
1710 if lsp_adapter.disk_based_diagnostics_progress_token.is_none() {
1711 let server_id = language_server.server_id();
1712 self.disk_based_diagnostics_finished(server_id, cx);
1713 self.broadcast_language_server_update(
1714 server_id,
1715 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdated(
1716 proto::LspDiskBasedDiagnosticsUpdated {},
1717 ),
1718 );
1719 }
1720 }
1721 _ => {}
1722 }
1723
1724 None
1725 }
1726
1727 fn language_servers_for_worktree(
1728 &self,
1729 worktree_id: WorktreeId,
1730 ) -> impl Iterator<Item = (&Arc<CachedLspAdapter>, &Arc<Language>, &Arc<LanguageServer>)> {
1731 self.language_server_ids
1732 .iter()
1733 .filter_map(move |((language_server_worktree_id, _), id)| {
1734 if *language_server_worktree_id == worktree_id {
1735 if let Some(LanguageServerState::Running {
1736 adapter,
1737 language,
1738 server,
1739 }) = self.language_servers.get(id)
1740 {
1741 return Some((adapter, language, server));
1742 }
1743 }
1744 None
1745 })
1746 }
1747
1748 fn maintain_buffer_languages(
1749 languages: &LanguageRegistry,
1750 cx: &mut ModelContext<Project>,
1751 ) -> Task<()> {
1752 let mut subscription = languages.subscribe();
1753 cx.spawn_weak(|project, mut cx| async move {
1754 while let Some(()) = subscription.next().await {
1755 if let Some(project) = project.upgrade(&cx) {
1756 project.update(&mut cx, |project, cx| {
1757 let mut buffers_without_language = Vec::new();
1758 for buffer in project.opened_buffers.values() {
1759 if let Some(buffer) = buffer.upgrade(cx) {
1760 if buffer.read(cx).language().is_none() {
1761 buffers_without_language.push(buffer);
1762 }
1763 }
1764 }
1765
1766 for buffer in buffers_without_language {
1767 project.assign_language_to_buffer(&buffer, cx);
1768 project.register_buffer_with_language_server(&buffer, cx);
1769 }
1770 });
1771 }
1772 }
1773 })
1774 }
1775
1776 fn assign_language_to_buffer(
1777 &mut self,
1778 buffer: &ModelHandle<Buffer>,
1779 cx: &mut ModelContext<Self>,
1780 ) -> Option<()> {
1781 // If the buffer has a language, set it and start the language server if we haven't already.
1782 let full_path = buffer.read(cx).file()?.full_path(cx);
1783 let new_language = self.languages.select_language(&full_path)?;
1784 buffer.update(cx, |buffer, cx| {
1785 if buffer.language().map_or(true, |old_language| {
1786 !Arc::ptr_eq(old_language, &new_language)
1787 }) {
1788 buffer.set_language_registry(self.languages.clone());
1789 buffer.set_language(Some(new_language.clone()), cx);
1790 }
1791 });
1792
1793 let file = File::from_dyn(buffer.read(cx).file())?;
1794 let worktree = file.worktree.read(cx).as_local()?;
1795 let worktree_id = worktree.id();
1796 let worktree_abs_path = worktree.abs_path().clone();
1797 self.start_language_server(worktree_id, worktree_abs_path, new_language, cx);
1798
1799 None
1800 }
1801
1802 fn merge_json_value_into(source: serde_json::Value, target: &mut serde_json::Value) {
1803 use serde_json::Value;
1804
1805 match (source, target) {
1806 (Value::Object(source), Value::Object(target)) => {
1807 for (key, value) in source {
1808 if let Some(target) = target.get_mut(&key) {
1809 Self::merge_json_value_into(value, target);
1810 } else {
1811 target.insert(key.clone(), value);
1812 }
1813 }
1814 }
1815
1816 (source, target) => *target = source,
1817 }
1818 }
1819
1820 fn start_language_server(
1821 &mut self,
1822 worktree_id: WorktreeId,
1823 worktree_path: Arc<Path>,
1824 language: Arc<Language>,
1825 cx: &mut ModelContext<Self>,
1826 ) {
1827 if !cx
1828 .global::<Settings>()
1829 .enable_language_server(Some(&language.name()))
1830 {
1831 return;
1832 }
1833
1834 let adapter = if let Some(adapter) = language.lsp_adapter() {
1835 adapter
1836 } else {
1837 return;
1838 };
1839 let key = (worktree_id, adapter.name.clone());
1840
1841 let mut initialization_options = adapter.initialization_options.clone();
1842
1843 let lsp = &cx.global::<Settings>().lsp.get(&adapter.name.0);
1844 let override_options = lsp.map(|s| s.initialization_options.clone()).flatten();
1845 match (&mut initialization_options, override_options) {
1846 (Some(initialization_options), Some(override_options)) => {
1847 Self::merge_json_value_into(override_options, initialization_options);
1848 }
1849
1850 (None, override_options) => initialization_options = override_options,
1851
1852 _ => {}
1853 }
1854
1855 self.language_server_ids
1856 .entry(key.clone())
1857 .or_insert_with(|| {
1858 let server_id = post_inc(&mut self.next_language_server_id);
1859 let language_server = self.languages.start_language_server(
1860 server_id,
1861 language.clone(),
1862 worktree_path,
1863 self.client.http_client(),
1864 cx,
1865 );
1866 self.language_servers.insert(
1867 server_id,
1868 LanguageServerState::Starting(cx.spawn_weak(|this, mut cx| async move {
1869 let language_server = language_server?.await.log_err()?;
1870 let language_server = language_server
1871 .initialize(initialization_options)
1872 .await
1873 .log_err()?;
1874 let this = this.upgrade(&cx)?;
1875
1876 language_server
1877 .on_notification::<lsp::notification::PublishDiagnostics, _>({
1878 let this = this.downgrade();
1879 let adapter = adapter.clone();
1880 move |mut params, cx| {
1881 let this = this;
1882 let adapter = adapter.clone();
1883 cx.spawn(|mut cx| async move {
1884 adapter.process_diagnostics(&mut params).await;
1885 if let Some(this) = this.upgrade(&cx) {
1886 this.update(&mut cx, |this, cx| {
1887 this.update_diagnostics(
1888 server_id,
1889 params,
1890 &adapter.disk_based_diagnostic_sources,
1891 cx,
1892 )
1893 .log_err();
1894 });
1895 }
1896 })
1897 .detach();
1898 }
1899 })
1900 .detach();
1901
1902 language_server
1903 .on_request::<lsp::request::WorkspaceConfiguration, _, _>({
1904 let settings = this.read_with(&cx, |this, _| {
1905 this.language_server_settings.clone()
1906 });
1907 move |params, _| {
1908 let settings = settings.lock().clone();
1909 async move {
1910 Ok(params
1911 .items
1912 .into_iter()
1913 .map(|item| {
1914 if let Some(section) = &item.section {
1915 settings
1916 .get(section)
1917 .cloned()
1918 .unwrap_or(serde_json::Value::Null)
1919 } else {
1920 settings.clone()
1921 }
1922 })
1923 .collect())
1924 }
1925 }
1926 })
1927 .detach();
1928
1929 // Even though we don't have handling for these requests, respond to them to
1930 // avoid stalling any language server like `gopls` which waits for a response
1931 // to these requests when initializing.
1932 language_server
1933 .on_request::<lsp::request::WorkDoneProgressCreate, _, _>({
1934 let this = this.downgrade();
1935 move |params, mut cx| async move {
1936 if let Some(this) = this.upgrade(&cx) {
1937 this.update(&mut cx, |this, _| {
1938 if let Some(status) =
1939 this.language_server_statuses.get_mut(&server_id)
1940 {
1941 if let lsp::NumberOrString::String(token) =
1942 params.token
1943 {
1944 status.progress_tokens.insert(token);
1945 }
1946 }
1947 });
1948 }
1949 Ok(())
1950 }
1951 })
1952 .detach();
1953 language_server
1954 .on_request::<lsp::request::RegisterCapability, _, _>(|_, _| async {
1955 Ok(())
1956 })
1957 .detach();
1958
1959 language_server
1960 .on_request::<lsp::request::ApplyWorkspaceEdit, _, _>({
1961 let this = this.downgrade();
1962 let adapter = adapter.clone();
1963 let language_server = language_server.clone();
1964 move |params, cx| {
1965 Self::on_lsp_workspace_edit(
1966 this,
1967 params,
1968 server_id,
1969 adapter.clone(),
1970 language_server.clone(),
1971 cx,
1972 )
1973 }
1974 })
1975 .detach();
1976
1977 let disk_based_diagnostics_progress_token =
1978 adapter.disk_based_diagnostics_progress_token.clone();
1979
1980 language_server
1981 .on_notification::<lsp::notification::Progress, _>({
1982 let this = this.downgrade();
1983 move |params, mut cx| {
1984 if let Some(this) = this.upgrade(&cx) {
1985 this.update(&mut cx, |this, cx| {
1986 this.on_lsp_progress(
1987 params,
1988 server_id,
1989 disk_based_diagnostics_progress_token.clone(),
1990 cx,
1991 );
1992 });
1993 }
1994 }
1995 })
1996 .detach();
1997
1998 this.update(&mut cx, |this, cx| {
1999 // If the language server for this key doesn't match the server id, don't store the
2000 // server. Which will cause it to be dropped, killing the process
2001 if this
2002 .language_server_ids
2003 .get(&key)
2004 .map(|id| id != &server_id)
2005 .unwrap_or(false)
2006 {
2007 return None;
2008 }
2009
2010 // Update language_servers collection with Running variant of LanguageServerState
2011 // indicating that the server is up and running and ready
2012 this.language_servers.insert(
2013 server_id,
2014 LanguageServerState::Running {
2015 adapter: adapter.clone(),
2016 language,
2017 server: language_server.clone(),
2018 },
2019 );
2020 this.language_server_statuses.insert(
2021 server_id,
2022 LanguageServerStatus {
2023 name: language_server.name().to_string(),
2024 pending_work: Default::default(),
2025 has_pending_diagnostic_updates: false,
2026 progress_tokens: Default::default(),
2027 },
2028 );
2029 language_server
2030 .notify::<lsp::notification::DidChangeConfiguration>(
2031 lsp::DidChangeConfigurationParams {
2032 settings: this.language_server_settings.lock().clone(),
2033 },
2034 )
2035 .ok();
2036
2037 if let Some(project_id) = this.remote_id() {
2038 this.client
2039 .send(proto::StartLanguageServer {
2040 project_id,
2041 server: Some(proto::LanguageServer {
2042 id: server_id as u64,
2043 name: language_server.name().to_string(),
2044 }),
2045 })
2046 .log_err();
2047 }
2048
2049 // Tell the language server about every open buffer in the worktree that matches the language.
2050 for buffer in this.opened_buffers.values() {
2051 if let Some(buffer_handle) = buffer.upgrade(cx) {
2052 let buffer = buffer_handle.read(cx);
2053 let file = if let Some(file) = File::from_dyn(buffer.file()) {
2054 file
2055 } else {
2056 continue;
2057 };
2058 let language = if let Some(language) = buffer.language() {
2059 language
2060 } else {
2061 continue;
2062 };
2063 if file.worktree.read(cx).id() != key.0
2064 || language.lsp_adapter().map(|a| a.name.clone())
2065 != Some(key.1.clone())
2066 {
2067 continue;
2068 }
2069
2070 let file = file.as_local()?;
2071 let versions = this
2072 .buffer_snapshots
2073 .entry(buffer.remote_id())
2074 .or_insert_with(|| vec![(0, buffer.text_snapshot())]);
2075 let (version, initial_snapshot) = versions.last().unwrap();
2076 let uri = lsp::Url::from_file_path(file.abs_path(cx)).unwrap();
2077 language_server
2078 .notify::<lsp::notification::DidOpenTextDocument>(
2079 lsp::DidOpenTextDocumentParams {
2080 text_document: lsp::TextDocumentItem::new(
2081 uri,
2082 adapter
2083 .language_ids
2084 .get(language.name().as_ref())
2085 .cloned()
2086 .unwrap_or_default(),
2087 *version,
2088 initial_snapshot.text(),
2089 ),
2090 },
2091 )
2092 .log_err()?;
2093 buffer_handle.update(cx, |buffer, cx| {
2094 buffer.set_completion_triggers(
2095 language_server
2096 .capabilities()
2097 .completion_provider
2098 .as_ref()
2099 .and_then(|provider| {
2100 provider.trigger_characters.clone()
2101 })
2102 .unwrap_or_default(),
2103 cx,
2104 )
2105 });
2106 }
2107 }
2108
2109 cx.notify();
2110 Some(language_server)
2111 })
2112 })),
2113 );
2114
2115 server_id
2116 });
2117 }
2118
2119 // Returns a list of all of the worktrees which no longer have a language server and the root path
2120 // for the stopped server
2121 fn stop_language_server(
2122 &mut self,
2123 worktree_id: WorktreeId,
2124 adapter_name: LanguageServerName,
2125 cx: &mut ModelContext<Self>,
2126 ) -> Task<(Option<PathBuf>, Vec<WorktreeId>)> {
2127 let key = (worktree_id, adapter_name);
2128 if let Some(server_id) = self.language_server_ids.remove(&key) {
2129 // Remove other entries for this language server as well
2130 let mut orphaned_worktrees = vec![worktree_id];
2131 let other_keys = self.language_server_ids.keys().cloned().collect::<Vec<_>>();
2132 for other_key in other_keys {
2133 if self.language_server_ids.get(&other_key) == Some(&server_id) {
2134 self.language_server_ids.remove(&other_key);
2135 orphaned_worktrees.push(other_key.0);
2136 }
2137 }
2138
2139 self.language_server_statuses.remove(&server_id);
2140 cx.notify();
2141
2142 let server_state = self.language_servers.remove(&server_id);
2143 cx.spawn_weak(|this, mut cx| async move {
2144 let mut root_path = None;
2145
2146 let server = match server_state {
2147 Some(LanguageServerState::Starting(started_language_server)) => {
2148 started_language_server.await
2149 }
2150 Some(LanguageServerState::Running { server, .. }) => Some(server),
2151 None => None,
2152 };
2153
2154 if let Some(server) = server {
2155 root_path = Some(server.root_path().clone());
2156 if let Some(shutdown) = server.shutdown() {
2157 shutdown.await;
2158 }
2159 }
2160
2161 if let Some(this) = this.upgrade(&cx) {
2162 this.update(&mut cx, |this, cx| {
2163 this.language_server_statuses.remove(&server_id);
2164 cx.notify();
2165 });
2166 }
2167
2168 (root_path, orphaned_worktrees)
2169 })
2170 } else {
2171 Task::ready((None, Vec::new()))
2172 }
2173 }
2174
2175 pub fn restart_language_servers_for_buffers(
2176 &mut self,
2177 buffers: impl IntoIterator<Item = ModelHandle<Buffer>>,
2178 cx: &mut ModelContext<Self>,
2179 ) -> Option<()> {
2180 let language_server_lookup_info: HashSet<(WorktreeId, Arc<Path>, PathBuf)> = buffers
2181 .into_iter()
2182 .filter_map(|buffer| {
2183 let file = File::from_dyn(buffer.read(cx).file())?;
2184 let worktree = file.worktree.read(cx).as_local()?;
2185 let worktree_id = worktree.id();
2186 let worktree_abs_path = worktree.abs_path().clone();
2187 let full_path = file.full_path(cx);
2188 Some((worktree_id, worktree_abs_path, full_path))
2189 })
2190 .collect();
2191 for (worktree_id, worktree_abs_path, full_path) in language_server_lookup_info {
2192 let language = self.languages.select_language(&full_path)?;
2193 self.restart_language_server(worktree_id, worktree_abs_path, language, cx);
2194 }
2195
2196 None
2197 }
2198
2199 fn restart_language_server(
2200 &mut self,
2201 worktree_id: WorktreeId,
2202 fallback_path: Arc<Path>,
2203 language: Arc<Language>,
2204 cx: &mut ModelContext<Self>,
2205 ) {
2206 let adapter = if let Some(adapter) = language.lsp_adapter() {
2207 adapter
2208 } else {
2209 return;
2210 };
2211
2212 let server_name = adapter.name.clone();
2213 let stop = self.stop_language_server(worktree_id, server_name.clone(), cx);
2214 cx.spawn_weak(|this, mut cx| async move {
2215 let (original_root_path, orphaned_worktrees) = stop.await;
2216 if let Some(this) = this.upgrade(&cx) {
2217 this.update(&mut cx, |this, cx| {
2218 // Attempt to restart using original server path. Fallback to passed in
2219 // path if we could not retrieve the root path
2220 let root_path = original_root_path
2221 .map(|path_buf| Arc::from(path_buf.as_path()))
2222 .unwrap_or(fallback_path);
2223
2224 this.start_language_server(worktree_id, root_path, language, cx);
2225
2226 // Lookup new server id and set it for each of the orphaned worktrees
2227 if let Some(new_server_id) = this
2228 .language_server_ids
2229 .get(&(worktree_id, server_name.clone()))
2230 .cloned()
2231 {
2232 for orphaned_worktree in orphaned_worktrees {
2233 this.language_server_ids
2234 .insert((orphaned_worktree, server_name.clone()), new_server_id);
2235 }
2236 }
2237 });
2238 }
2239 })
2240 .detach();
2241 }
2242
2243 fn on_lsp_progress(
2244 &mut self,
2245 progress: lsp::ProgressParams,
2246 server_id: usize,
2247 disk_based_diagnostics_progress_token: Option<String>,
2248 cx: &mut ModelContext<Self>,
2249 ) {
2250 let token = match progress.token {
2251 lsp::NumberOrString::String(token) => token,
2252 lsp::NumberOrString::Number(token) => {
2253 log::info!("skipping numeric progress token {}", token);
2254 return;
2255 }
2256 };
2257 let lsp::ProgressParamsValue::WorkDone(progress) = progress.value;
2258 let language_server_status =
2259 if let Some(status) = self.language_server_statuses.get_mut(&server_id) {
2260 status
2261 } else {
2262 return;
2263 };
2264
2265 if !language_server_status.progress_tokens.contains(&token) {
2266 return;
2267 }
2268
2269 let is_disk_based_diagnostics_progress = disk_based_diagnostics_progress_token
2270 .as_ref()
2271 .map_or(false, |disk_based_token| {
2272 token.starts_with(disk_based_token)
2273 });
2274
2275 match progress {
2276 lsp::WorkDoneProgress::Begin(report) => {
2277 if is_disk_based_diagnostics_progress {
2278 language_server_status.has_pending_diagnostic_updates = true;
2279 self.disk_based_diagnostics_started(server_id, cx);
2280 self.broadcast_language_server_update(
2281 server_id,
2282 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdating(
2283 proto::LspDiskBasedDiagnosticsUpdating {},
2284 ),
2285 );
2286 } else {
2287 self.on_lsp_work_start(
2288 server_id,
2289 token.clone(),
2290 LanguageServerProgress {
2291 message: report.message.clone(),
2292 percentage: report.percentage.map(|p| p as usize),
2293 last_update_at: Instant::now(),
2294 },
2295 cx,
2296 );
2297 self.broadcast_language_server_update(
2298 server_id,
2299 proto::update_language_server::Variant::WorkStart(proto::LspWorkStart {
2300 token,
2301 message: report.message,
2302 percentage: report.percentage.map(|p| p as u32),
2303 }),
2304 );
2305 }
2306 }
2307 lsp::WorkDoneProgress::Report(report) => {
2308 if !is_disk_based_diagnostics_progress {
2309 self.on_lsp_work_progress(
2310 server_id,
2311 token.clone(),
2312 LanguageServerProgress {
2313 message: report.message.clone(),
2314 percentage: report.percentage.map(|p| p as usize),
2315 last_update_at: Instant::now(),
2316 },
2317 cx,
2318 );
2319 self.broadcast_language_server_update(
2320 server_id,
2321 proto::update_language_server::Variant::WorkProgress(
2322 proto::LspWorkProgress {
2323 token,
2324 message: report.message,
2325 percentage: report.percentage.map(|p| p as u32),
2326 },
2327 ),
2328 );
2329 }
2330 }
2331 lsp::WorkDoneProgress::End(_) => {
2332 language_server_status.progress_tokens.remove(&token);
2333
2334 if is_disk_based_diagnostics_progress {
2335 language_server_status.has_pending_diagnostic_updates = false;
2336 self.disk_based_diagnostics_finished(server_id, cx);
2337 self.broadcast_language_server_update(
2338 server_id,
2339 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdated(
2340 proto::LspDiskBasedDiagnosticsUpdated {},
2341 ),
2342 );
2343 } else {
2344 self.on_lsp_work_end(server_id, token.clone(), cx);
2345 self.broadcast_language_server_update(
2346 server_id,
2347 proto::update_language_server::Variant::WorkEnd(proto::LspWorkEnd {
2348 token,
2349 }),
2350 );
2351 }
2352 }
2353 }
2354 }
2355
2356 fn on_lsp_work_start(
2357 &mut self,
2358 language_server_id: usize,
2359 token: String,
2360 progress: LanguageServerProgress,
2361 cx: &mut ModelContext<Self>,
2362 ) {
2363 if let Some(status) = self.language_server_statuses.get_mut(&language_server_id) {
2364 status.pending_work.insert(token, progress);
2365 cx.notify();
2366 }
2367 }
2368
2369 fn on_lsp_work_progress(
2370 &mut self,
2371 language_server_id: usize,
2372 token: String,
2373 progress: LanguageServerProgress,
2374 cx: &mut ModelContext<Self>,
2375 ) {
2376 if let Some(status) = self.language_server_statuses.get_mut(&language_server_id) {
2377 let entry = status
2378 .pending_work
2379 .entry(token)
2380 .or_insert(LanguageServerProgress {
2381 message: Default::default(),
2382 percentage: Default::default(),
2383 last_update_at: progress.last_update_at,
2384 });
2385 if progress.message.is_some() {
2386 entry.message = progress.message;
2387 }
2388 if progress.percentage.is_some() {
2389 entry.percentage = progress.percentage;
2390 }
2391 entry.last_update_at = progress.last_update_at;
2392 cx.notify();
2393 }
2394 }
2395
2396 fn on_lsp_work_end(
2397 &mut self,
2398 language_server_id: usize,
2399 token: String,
2400 cx: &mut ModelContext<Self>,
2401 ) {
2402 if let Some(status) = self.language_server_statuses.get_mut(&language_server_id) {
2403 status.pending_work.remove(&token);
2404 cx.notify();
2405 }
2406 }
2407
2408 async fn on_lsp_workspace_edit(
2409 this: WeakModelHandle<Self>,
2410 params: lsp::ApplyWorkspaceEditParams,
2411 server_id: usize,
2412 adapter: Arc<CachedLspAdapter>,
2413 language_server: Arc<LanguageServer>,
2414 mut cx: AsyncAppContext,
2415 ) -> Result<lsp::ApplyWorkspaceEditResponse> {
2416 let this = this
2417 .upgrade(&cx)
2418 .ok_or_else(|| anyhow!("project project closed"))?;
2419 let transaction = Self::deserialize_workspace_edit(
2420 this.clone(),
2421 params.edit,
2422 true,
2423 adapter.clone(),
2424 language_server.clone(),
2425 &mut cx,
2426 )
2427 .await
2428 .log_err();
2429 this.update(&mut cx, |this, _| {
2430 if let Some(transaction) = transaction {
2431 this.last_workspace_edits_by_language_server
2432 .insert(server_id, transaction);
2433 }
2434 });
2435 Ok(lsp::ApplyWorkspaceEditResponse {
2436 applied: true,
2437 failed_change: None,
2438 failure_reason: None,
2439 })
2440 }
2441
2442 fn broadcast_language_server_update(
2443 &self,
2444 language_server_id: usize,
2445 event: proto::update_language_server::Variant,
2446 ) {
2447 if let Some(project_id) = self.remote_id() {
2448 self.client
2449 .send(proto::UpdateLanguageServer {
2450 project_id,
2451 language_server_id: language_server_id as u64,
2452 variant: Some(event),
2453 })
2454 .log_err();
2455 }
2456 }
2457
2458 pub fn set_language_server_settings(&mut self, settings: serde_json::Value) {
2459 for server_state in self.language_servers.values() {
2460 if let LanguageServerState::Running { server, .. } = server_state {
2461 server
2462 .notify::<lsp::notification::DidChangeConfiguration>(
2463 lsp::DidChangeConfigurationParams {
2464 settings: settings.clone(),
2465 },
2466 )
2467 .ok();
2468 }
2469 }
2470 *self.language_server_settings.lock() = settings;
2471 }
2472
2473 pub fn language_server_statuses(
2474 &self,
2475 ) -> impl DoubleEndedIterator<Item = &LanguageServerStatus> {
2476 self.language_server_statuses.values()
2477 }
2478
2479 pub fn update_diagnostics(
2480 &mut self,
2481 language_server_id: usize,
2482 params: lsp::PublishDiagnosticsParams,
2483 disk_based_sources: &[String],
2484 cx: &mut ModelContext<Self>,
2485 ) -> Result<()> {
2486 let abs_path = params
2487 .uri
2488 .to_file_path()
2489 .map_err(|_| anyhow!("URI is not a file"))?;
2490 let mut diagnostics = Vec::default();
2491 let mut primary_diagnostic_group_ids = HashMap::default();
2492 let mut sources_by_group_id = HashMap::default();
2493 let mut supporting_diagnostics = HashMap::default();
2494 for diagnostic in ¶ms.diagnostics {
2495 let source = diagnostic.source.as_ref();
2496 let code = diagnostic.code.as_ref().map(|code| match code {
2497 lsp::NumberOrString::Number(code) => code.to_string(),
2498 lsp::NumberOrString::String(code) => code.clone(),
2499 });
2500 let range = range_from_lsp(diagnostic.range);
2501 let is_supporting = diagnostic
2502 .related_information
2503 .as_ref()
2504 .map_or(false, |infos| {
2505 infos.iter().any(|info| {
2506 primary_diagnostic_group_ids.contains_key(&(
2507 source,
2508 code.clone(),
2509 range_from_lsp(info.location.range),
2510 ))
2511 })
2512 });
2513
2514 let is_unnecessary = diagnostic.tags.as_ref().map_or(false, |tags| {
2515 tags.iter().any(|tag| *tag == DiagnosticTag::UNNECESSARY)
2516 });
2517
2518 if is_supporting {
2519 supporting_diagnostics.insert(
2520 (source, code.clone(), range),
2521 (diagnostic.severity, is_unnecessary),
2522 );
2523 } else {
2524 let group_id = post_inc(&mut self.next_diagnostic_group_id);
2525 let is_disk_based =
2526 source.map_or(false, |source| disk_based_sources.contains(source));
2527
2528 sources_by_group_id.insert(group_id, source);
2529 primary_diagnostic_group_ids
2530 .insert((source, code.clone(), range.clone()), group_id);
2531
2532 diagnostics.push(DiagnosticEntry {
2533 range,
2534 diagnostic: Diagnostic {
2535 code: code.clone(),
2536 severity: diagnostic.severity.unwrap_or(DiagnosticSeverity::ERROR),
2537 message: diagnostic.message.clone(),
2538 group_id,
2539 is_primary: true,
2540 is_valid: true,
2541 is_disk_based,
2542 is_unnecessary,
2543 },
2544 });
2545 if let Some(infos) = &diagnostic.related_information {
2546 for info in infos {
2547 if info.location.uri == params.uri && !info.message.is_empty() {
2548 let range = range_from_lsp(info.location.range);
2549 diagnostics.push(DiagnosticEntry {
2550 range,
2551 diagnostic: Diagnostic {
2552 code: code.clone(),
2553 severity: DiagnosticSeverity::INFORMATION,
2554 message: info.message.clone(),
2555 group_id,
2556 is_primary: false,
2557 is_valid: true,
2558 is_disk_based,
2559 is_unnecessary: false,
2560 },
2561 });
2562 }
2563 }
2564 }
2565 }
2566 }
2567
2568 for entry in &mut diagnostics {
2569 let diagnostic = &mut entry.diagnostic;
2570 if !diagnostic.is_primary {
2571 let source = *sources_by_group_id.get(&diagnostic.group_id).unwrap();
2572 if let Some(&(severity, is_unnecessary)) = supporting_diagnostics.get(&(
2573 source,
2574 diagnostic.code.clone(),
2575 entry.range.clone(),
2576 )) {
2577 if let Some(severity) = severity {
2578 diagnostic.severity = severity;
2579 }
2580 diagnostic.is_unnecessary = is_unnecessary;
2581 }
2582 }
2583 }
2584
2585 self.update_diagnostic_entries(
2586 language_server_id,
2587 abs_path,
2588 params.version,
2589 diagnostics,
2590 cx,
2591 )?;
2592 Ok(())
2593 }
2594
2595 pub fn update_diagnostic_entries(
2596 &mut self,
2597 language_server_id: usize,
2598 abs_path: PathBuf,
2599 version: Option<i32>,
2600 diagnostics: Vec<DiagnosticEntry<PointUtf16>>,
2601 cx: &mut ModelContext<Project>,
2602 ) -> Result<(), anyhow::Error> {
2603 let (worktree, relative_path) = self
2604 .find_local_worktree(&abs_path, cx)
2605 .ok_or_else(|| anyhow!("no worktree found for diagnostics"))?;
2606
2607 let project_path = ProjectPath {
2608 worktree_id: worktree.read(cx).id(),
2609 path: relative_path.into(),
2610 };
2611 if let Some(buffer) = self.get_open_buffer(&project_path, cx) {
2612 self.update_buffer_diagnostics(&buffer, diagnostics.clone(), version, cx)?;
2613 }
2614
2615 let updated = worktree.update(cx, |worktree, cx| {
2616 worktree
2617 .as_local_mut()
2618 .ok_or_else(|| anyhow!("not a local worktree"))?
2619 .update_diagnostics(
2620 language_server_id,
2621 project_path.path.clone(),
2622 diagnostics,
2623 cx,
2624 )
2625 })?;
2626 if updated {
2627 cx.emit(Event::DiagnosticsUpdated {
2628 language_server_id,
2629 path: project_path,
2630 });
2631 }
2632 Ok(())
2633 }
2634
2635 fn update_buffer_diagnostics(
2636 &mut self,
2637 buffer: &ModelHandle<Buffer>,
2638 mut diagnostics: Vec<DiagnosticEntry<PointUtf16>>,
2639 version: Option<i32>,
2640 cx: &mut ModelContext<Self>,
2641 ) -> Result<()> {
2642 fn compare_diagnostics(a: &Diagnostic, b: &Diagnostic) -> Ordering {
2643 Ordering::Equal
2644 .then_with(|| b.is_primary.cmp(&a.is_primary))
2645 .then_with(|| a.is_disk_based.cmp(&b.is_disk_based))
2646 .then_with(|| a.severity.cmp(&b.severity))
2647 .then_with(|| a.message.cmp(&b.message))
2648 }
2649
2650 let snapshot = self.buffer_snapshot_for_lsp_version(buffer, version, cx)?;
2651
2652 diagnostics.sort_unstable_by(|a, b| {
2653 Ordering::Equal
2654 .then_with(|| a.range.start.cmp(&b.range.start))
2655 .then_with(|| b.range.end.cmp(&a.range.end))
2656 .then_with(|| compare_diagnostics(&a.diagnostic, &b.diagnostic))
2657 });
2658
2659 let mut sanitized_diagnostics = Vec::new();
2660 let edits_since_save = Patch::new(
2661 snapshot
2662 .edits_since::<PointUtf16>(buffer.read(cx).saved_version())
2663 .collect(),
2664 );
2665 for entry in diagnostics {
2666 let start;
2667 let end;
2668 if entry.diagnostic.is_disk_based {
2669 // Some diagnostics are based on files on disk instead of buffers'
2670 // current contents. Adjust these diagnostics' ranges to reflect
2671 // any unsaved edits.
2672 start = edits_since_save.old_to_new(entry.range.start);
2673 end = edits_since_save.old_to_new(entry.range.end);
2674 } else {
2675 start = entry.range.start;
2676 end = entry.range.end;
2677 }
2678
2679 let mut range = snapshot.clip_point_utf16(start, Bias::Left)
2680 ..snapshot.clip_point_utf16(end, Bias::Right);
2681
2682 // Expand empty ranges by one character
2683 if range.start == range.end {
2684 range.end.column += 1;
2685 range.end = snapshot.clip_point_utf16(range.end, Bias::Right);
2686 if range.start == range.end && range.end.column > 0 {
2687 range.start.column -= 1;
2688 range.start = snapshot.clip_point_utf16(range.start, Bias::Left);
2689 }
2690 }
2691
2692 sanitized_diagnostics.push(DiagnosticEntry {
2693 range,
2694 diagnostic: entry.diagnostic,
2695 });
2696 }
2697 drop(edits_since_save);
2698
2699 let set = DiagnosticSet::new(sanitized_diagnostics, &snapshot);
2700 buffer.update(cx, |buffer, cx| buffer.update_diagnostics(set, cx));
2701 Ok(())
2702 }
2703
2704 pub fn reload_buffers(
2705 &self,
2706 buffers: HashSet<ModelHandle<Buffer>>,
2707 push_to_history: bool,
2708 cx: &mut ModelContext<Self>,
2709 ) -> Task<Result<ProjectTransaction>> {
2710 let mut local_buffers = Vec::new();
2711 let mut remote_buffers = None;
2712 for buffer_handle in buffers {
2713 let buffer = buffer_handle.read(cx);
2714 if buffer.is_dirty() {
2715 if let Some(file) = File::from_dyn(buffer.file()) {
2716 if file.is_local() {
2717 local_buffers.push(buffer_handle);
2718 } else {
2719 remote_buffers.get_or_insert(Vec::new()).push(buffer_handle);
2720 }
2721 }
2722 }
2723 }
2724
2725 let remote_buffers = self.remote_id().zip(remote_buffers);
2726 let client = self.client.clone();
2727
2728 cx.spawn(|this, mut cx| async move {
2729 let mut project_transaction = ProjectTransaction::default();
2730
2731 if let Some((project_id, remote_buffers)) = remote_buffers {
2732 let response = client
2733 .request(proto::ReloadBuffers {
2734 project_id,
2735 buffer_ids: remote_buffers
2736 .iter()
2737 .map(|buffer| buffer.read_with(&cx, |buffer, _| buffer.remote_id()))
2738 .collect(),
2739 })
2740 .await?
2741 .transaction
2742 .ok_or_else(|| anyhow!("missing transaction"))?;
2743 project_transaction = this
2744 .update(&mut cx, |this, cx| {
2745 this.deserialize_project_transaction(response, push_to_history, cx)
2746 })
2747 .await?;
2748 }
2749
2750 for buffer in local_buffers {
2751 let transaction = buffer
2752 .update(&mut cx, |buffer, cx| buffer.reload(cx))
2753 .await?;
2754 buffer.update(&mut cx, |buffer, cx| {
2755 if let Some(transaction) = transaction {
2756 if !push_to_history {
2757 buffer.forget_transaction(transaction.id);
2758 }
2759 project_transaction.0.insert(cx.handle(), transaction);
2760 }
2761 });
2762 }
2763
2764 Ok(project_transaction)
2765 })
2766 }
2767
2768 pub fn format(
2769 &self,
2770 buffers: HashSet<ModelHandle<Buffer>>,
2771 push_to_history: bool,
2772 trigger: FormatTrigger,
2773 cx: &mut ModelContext<Project>,
2774 ) -> Task<Result<ProjectTransaction>> {
2775 let mut local_buffers = Vec::new();
2776 let mut remote_buffers = None;
2777 for buffer_handle in buffers {
2778 let buffer = buffer_handle.read(cx);
2779 if let Some(file) = File::from_dyn(buffer.file()) {
2780 if let Some(buffer_abs_path) = file.as_local().map(|f| f.abs_path(cx)) {
2781 if let Some((_, server)) = self.language_server_for_buffer(buffer, cx) {
2782 local_buffers.push((buffer_handle, buffer_abs_path, server.clone()));
2783 }
2784 } else {
2785 remote_buffers.get_or_insert(Vec::new()).push(buffer_handle);
2786 }
2787 } else {
2788 return Task::ready(Ok(Default::default()));
2789 }
2790 }
2791
2792 let remote_buffers = self.remote_id().zip(remote_buffers);
2793 let client = self.client.clone();
2794
2795 cx.spawn(|this, mut cx| async move {
2796 let mut project_transaction = ProjectTransaction::default();
2797
2798 if let Some((project_id, remote_buffers)) = remote_buffers {
2799 let response = client
2800 .request(proto::FormatBuffers {
2801 project_id,
2802 trigger: trigger as i32,
2803 buffer_ids: remote_buffers
2804 .iter()
2805 .map(|buffer| buffer.read_with(&cx, |buffer, _| buffer.remote_id()))
2806 .collect(),
2807 })
2808 .await?
2809 .transaction
2810 .ok_or_else(|| anyhow!("missing transaction"))?;
2811 project_transaction = this
2812 .update(&mut cx, |this, cx| {
2813 this.deserialize_project_transaction(response, push_to_history, cx)
2814 })
2815 .await?;
2816 }
2817
2818 // Do not allow multiple concurrent formatting requests for the
2819 // same buffer.
2820 this.update(&mut cx, |this, _| {
2821 local_buffers
2822 .retain(|(buffer, _, _)| this.buffers_being_formatted.insert(buffer.id()));
2823 });
2824 let _cleanup = defer({
2825 let this = this.clone();
2826 let mut cx = cx.clone();
2827 let local_buffers = &local_buffers;
2828 move || {
2829 this.update(&mut cx, |this, _| {
2830 for (buffer, _, _) in local_buffers {
2831 this.buffers_being_formatted.remove(&buffer.id());
2832 }
2833 });
2834 }
2835 });
2836
2837 for (buffer, buffer_abs_path, language_server) in &local_buffers {
2838 let (format_on_save, formatter, tab_size) = buffer.read_with(&cx, |buffer, cx| {
2839 let settings = cx.global::<Settings>();
2840 let language_name = buffer.language().map(|language| language.name());
2841 (
2842 settings.format_on_save(language_name.as_deref()),
2843 settings.formatter(language_name.as_deref()),
2844 settings.tab_size(language_name.as_deref()),
2845 )
2846 });
2847
2848 let transaction = match (formatter, format_on_save) {
2849 (_, FormatOnSave::Off) if trigger == FormatTrigger::Save => continue,
2850
2851 (Formatter::LanguageServer, FormatOnSave::On | FormatOnSave::Off)
2852 | (_, FormatOnSave::LanguageServer) => Self::format_via_lsp(
2853 &this,
2854 &buffer,
2855 &buffer_abs_path,
2856 &language_server,
2857 tab_size,
2858 &mut cx,
2859 )
2860 .await
2861 .context("failed to format via language server")?,
2862
2863 (
2864 Formatter::External { command, arguments },
2865 FormatOnSave::On | FormatOnSave::Off,
2866 )
2867 | (_, FormatOnSave::External { command, arguments }) => {
2868 Self::format_via_external_command(
2869 &buffer,
2870 &buffer_abs_path,
2871 &command,
2872 &arguments,
2873 &mut cx,
2874 )
2875 .await
2876 .context(format!(
2877 "failed to format via external command {:?}",
2878 command
2879 ))?
2880 }
2881 };
2882
2883 if let Some(transaction) = transaction {
2884 if !push_to_history {
2885 buffer.update(&mut cx, |buffer, _| {
2886 buffer.forget_transaction(transaction.id)
2887 });
2888 }
2889 project_transaction.0.insert(buffer.clone(), transaction);
2890 }
2891 }
2892
2893 Ok(project_transaction)
2894 })
2895 }
2896
2897 async fn format_via_lsp(
2898 this: &ModelHandle<Self>,
2899 buffer: &ModelHandle<Buffer>,
2900 abs_path: &Path,
2901 language_server: &Arc<LanguageServer>,
2902 tab_size: NonZeroU32,
2903 cx: &mut AsyncAppContext,
2904 ) -> Result<Option<Transaction>> {
2905 let text_document =
2906 lsp::TextDocumentIdentifier::new(lsp::Url::from_file_path(abs_path).unwrap());
2907 let capabilities = &language_server.capabilities();
2908 let lsp_edits = if capabilities
2909 .document_formatting_provider
2910 .as_ref()
2911 .map_or(false, |provider| *provider != lsp::OneOf::Left(false))
2912 {
2913 language_server
2914 .request::<lsp::request::Formatting>(lsp::DocumentFormattingParams {
2915 text_document,
2916 options: lsp::FormattingOptions {
2917 tab_size: tab_size.into(),
2918 insert_spaces: true,
2919 insert_final_newline: Some(true),
2920 ..Default::default()
2921 },
2922 work_done_progress_params: Default::default(),
2923 })
2924 .await?
2925 } else if capabilities
2926 .document_range_formatting_provider
2927 .as_ref()
2928 .map_or(false, |provider| *provider != lsp::OneOf::Left(false))
2929 {
2930 let buffer_start = lsp::Position::new(0, 0);
2931 let buffer_end =
2932 buffer.read_with(cx, |buffer, _| point_to_lsp(buffer.max_point_utf16()));
2933 language_server
2934 .request::<lsp::request::RangeFormatting>(lsp::DocumentRangeFormattingParams {
2935 text_document,
2936 range: lsp::Range::new(buffer_start, buffer_end),
2937 options: lsp::FormattingOptions {
2938 tab_size: tab_size.into(),
2939 insert_spaces: true,
2940 insert_final_newline: Some(true),
2941 ..Default::default()
2942 },
2943 work_done_progress_params: Default::default(),
2944 })
2945 .await?
2946 } else {
2947 None
2948 };
2949
2950 if let Some(lsp_edits) = lsp_edits {
2951 let edits = this
2952 .update(cx, |this, cx| {
2953 this.edits_from_lsp(buffer, lsp_edits, None, cx)
2954 })
2955 .await?;
2956 buffer.update(cx, |buffer, cx| {
2957 buffer.finalize_last_transaction();
2958 buffer.start_transaction();
2959 for (range, text) in edits {
2960 buffer.edit([(range, text)], None, cx);
2961 }
2962 if buffer.end_transaction(cx).is_some() {
2963 let transaction = buffer.finalize_last_transaction().unwrap().clone();
2964 Ok(Some(transaction))
2965 } else {
2966 Ok(None)
2967 }
2968 })
2969 } else {
2970 Ok(None)
2971 }
2972 }
2973
2974 async fn format_via_external_command(
2975 buffer: &ModelHandle<Buffer>,
2976 buffer_abs_path: &Path,
2977 command: &str,
2978 arguments: &[String],
2979 cx: &mut AsyncAppContext,
2980 ) -> Result<Option<Transaction>> {
2981 let working_dir_path = buffer.read_with(cx, |buffer, cx| {
2982 let file = File::from_dyn(buffer.file())?;
2983 let worktree = file.worktree.read(cx).as_local()?;
2984 let mut worktree_path = worktree.abs_path().to_path_buf();
2985 if worktree.root_entry()?.is_file() {
2986 worktree_path.pop();
2987 }
2988 Some(worktree_path)
2989 });
2990
2991 if let Some(working_dir_path) = working_dir_path {
2992 let mut child =
2993 smol::process::Command::new(command)
2994 .args(arguments.iter().map(|arg| {
2995 arg.replace("{buffer_path}", &buffer_abs_path.to_string_lossy())
2996 }))
2997 .current_dir(&working_dir_path)
2998 .stdin(smol::process::Stdio::piped())
2999 .stdout(smol::process::Stdio::piped())
3000 .stderr(smol::process::Stdio::piped())
3001 .spawn()?;
3002 let stdin = child
3003 .stdin
3004 .as_mut()
3005 .ok_or_else(|| anyhow!("failed to acquire stdin"))?;
3006 let text = buffer.read_with(cx, |buffer, _| buffer.as_rope().clone());
3007 for chunk in text.chunks() {
3008 stdin.write_all(chunk.as_bytes()).await?;
3009 }
3010 stdin.flush().await?;
3011
3012 let output = child.output().await?;
3013 if !output.status.success() {
3014 return Err(anyhow!(
3015 "command failed with exit code {:?}:\nstdout: {}\nstderr: {}",
3016 output.status.code(),
3017 String::from_utf8_lossy(&output.stdout),
3018 String::from_utf8_lossy(&output.stderr),
3019 ));
3020 }
3021
3022 let stdout = String::from_utf8(output.stdout)?;
3023 let diff = buffer
3024 .read_with(cx, |buffer, cx| buffer.diff(stdout, cx))
3025 .await;
3026 Ok(buffer.update(cx, |buffer, cx| buffer.apply_diff(diff, cx).cloned()))
3027 } else {
3028 Ok(None)
3029 }
3030 }
3031
3032 pub fn definition<T: ToPointUtf16>(
3033 &self,
3034 buffer: &ModelHandle<Buffer>,
3035 position: T,
3036 cx: &mut ModelContext<Self>,
3037 ) -> Task<Result<Vec<LocationLink>>> {
3038 let position = position.to_point_utf16(buffer.read(cx));
3039 self.request_lsp(buffer.clone(), GetDefinition { position }, cx)
3040 }
3041
3042 pub fn type_definition<T: ToPointUtf16>(
3043 &self,
3044 buffer: &ModelHandle<Buffer>,
3045 position: T,
3046 cx: &mut ModelContext<Self>,
3047 ) -> Task<Result<Vec<LocationLink>>> {
3048 let position = position.to_point_utf16(buffer.read(cx));
3049 self.request_lsp(buffer.clone(), GetTypeDefinition { position }, cx)
3050 }
3051
3052 pub fn references<T: ToPointUtf16>(
3053 &self,
3054 buffer: &ModelHandle<Buffer>,
3055 position: T,
3056 cx: &mut ModelContext<Self>,
3057 ) -> Task<Result<Vec<Location>>> {
3058 let position = position.to_point_utf16(buffer.read(cx));
3059 self.request_lsp(buffer.clone(), GetReferences { position }, cx)
3060 }
3061
3062 pub fn document_highlights<T: ToPointUtf16>(
3063 &self,
3064 buffer: &ModelHandle<Buffer>,
3065 position: T,
3066 cx: &mut ModelContext<Self>,
3067 ) -> Task<Result<Vec<DocumentHighlight>>> {
3068 let position = position.to_point_utf16(buffer.read(cx));
3069 self.request_lsp(buffer.clone(), GetDocumentHighlights { position }, cx)
3070 }
3071
3072 pub fn symbols(&self, query: &str, cx: &mut ModelContext<Self>) -> Task<Result<Vec<Symbol>>> {
3073 if self.is_local() {
3074 let mut requests = Vec::new();
3075 for ((worktree_id, _), server_id) in self.language_server_ids.iter() {
3076 let worktree_id = *worktree_id;
3077 if let Some(worktree) = self
3078 .worktree_for_id(worktree_id, cx)
3079 .and_then(|worktree| worktree.read(cx).as_local())
3080 {
3081 if let Some(LanguageServerState::Running {
3082 adapter,
3083 language,
3084 server,
3085 }) = self.language_servers.get(server_id)
3086 {
3087 let adapter = adapter.clone();
3088 let language = language.clone();
3089 let worktree_abs_path = worktree.abs_path().clone();
3090 requests.push(
3091 server
3092 .request::<lsp::request::WorkspaceSymbol>(
3093 lsp::WorkspaceSymbolParams {
3094 query: query.to_string(),
3095 ..Default::default()
3096 },
3097 )
3098 .log_err()
3099 .map(move |response| {
3100 (
3101 adapter,
3102 language,
3103 worktree_id,
3104 worktree_abs_path,
3105 response.unwrap_or_default(),
3106 )
3107 }),
3108 );
3109 }
3110 }
3111 }
3112
3113 cx.spawn_weak(|this, cx| async move {
3114 let responses = futures::future::join_all(requests).await;
3115 let this = if let Some(this) = this.upgrade(&cx) {
3116 this
3117 } else {
3118 return Ok(Default::default());
3119 };
3120 let symbols = this.read_with(&cx, |this, cx| {
3121 let mut symbols = Vec::new();
3122 for (
3123 adapter,
3124 adapter_language,
3125 source_worktree_id,
3126 worktree_abs_path,
3127 response,
3128 ) in responses
3129 {
3130 symbols.extend(response.into_iter().flatten().filter_map(|lsp_symbol| {
3131 let abs_path = lsp_symbol.location.uri.to_file_path().ok()?;
3132 let mut worktree_id = source_worktree_id;
3133 let path;
3134 if let Some((worktree, rel_path)) =
3135 this.find_local_worktree(&abs_path, cx)
3136 {
3137 worktree_id = worktree.read(cx).id();
3138 path = rel_path;
3139 } else {
3140 path = relativize_path(&worktree_abs_path, &abs_path);
3141 }
3142
3143 let project_path = ProjectPath {
3144 worktree_id,
3145 path: path.into(),
3146 };
3147 let signature = this.symbol_signature(&project_path);
3148 let language = this
3149 .languages
3150 .select_language(&project_path.path)
3151 .unwrap_or(adapter_language.clone());
3152 let language_server_name = adapter.name.clone();
3153 Some(async move {
3154 let label = language
3155 .label_for_symbol(&lsp_symbol.name, lsp_symbol.kind)
3156 .await;
3157
3158 Symbol {
3159 language_server_name,
3160 source_worktree_id,
3161 path: project_path,
3162 label: label.unwrap_or_else(|| {
3163 CodeLabel::plain(lsp_symbol.name.clone(), None)
3164 }),
3165 kind: lsp_symbol.kind,
3166 name: lsp_symbol.name,
3167 range: range_from_lsp(lsp_symbol.location.range),
3168 signature,
3169 }
3170 })
3171 }));
3172 }
3173 symbols
3174 });
3175 Ok(futures::future::join_all(symbols).await)
3176 })
3177 } else if let Some(project_id) = self.remote_id() {
3178 let request = self.client.request(proto::GetProjectSymbols {
3179 project_id,
3180 query: query.to_string(),
3181 });
3182 cx.spawn_weak(|this, cx| async move {
3183 let response = request.await?;
3184 let mut symbols = Vec::new();
3185 if let Some(this) = this.upgrade(&cx) {
3186 let new_symbols = this.read_with(&cx, |this, _| {
3187 response
3188 .symbols
3189 .into_iter()
3190 .map(|symbol| this.deserialize_symbol(symbol))
3191 .collect::<Vec<_>>()
3192 });
3193 symbols = futures::future::join_all(new_symbols)
3194 .await
3195 .into_iter()
3196 .filter_map(|symbol| symbol.log_err())
3197 .collect::<Vec<_>>();
3198 }
3199 Ok(symbols)
3200 })
3201 } else {
3202 Task::ready(Ok(Default::default()))
3203 }
3204 }
3205
3206 pub fn open_buffer_for_symbol(
3207 &mut self,
3208 symbol: &Symbol,
3209 cx: &mut ModelContext<Self>,
3210 ) -> Task<Result<ModelHandle<Buffer>>> {
3211 if self.is_local() {
3212 let language_server_id = if let Some(id) = self.language_server_ids.get(&(
3213 symbol.source_worktree_id,
3214 symbol.language_server_name.clone(),
3215 )) {
3216 *id
3217 } else {
3218 return Task::ready(Err(anyhow!(
3219 "language server for worktree and language not found"
3220 )));
3221 };
3222
3223 let worktree_abs_path = if let Some(worktree_abs_path) = self
3224 .worktree_for_id(symbol.path.worktree_id, cx)
3225 .and_then(|worktree| worktree.read(cx).as_local())
3226 .map(|local_worktree| local_worktree.abs_path())
3227 {
3228 worktree_abs_path
3229 } else {
3230 return Task::ready(Err(anyhow!("worktree not found for symbol")));
3231 };
3232 let symbol_abs_path = worktree_abs_path.join(&symbol.path.path);
3233 let symbol_uri = if let Ok(uri) = lsp::Url::from_file_path(symbol_abs_path) {
3234 uri
3235 } else {
3236 return Task::ready(Err(anyhow!("invalid symbol path")));
3237 };
3238
3239 self.open_local_buffer_via_lsp(
3240 symbol_uri,
3241 language_server_id,
3242 symbol.language_server_name.clone(),
3243 cx,
3244 )
3245 } else if let Some(project_id) = self.remote_id() {
3246 let request = self.client.request(proto::OpenBufferForSymbol {
3247 project_id,
3248 symbol: Some(serialize_symbol(symbol)),
3249 });
3250 cx.spawn(|this, mut cx| async move {
3251 let response = request.await?;
3252 this.update(&mut cx, |this, cx| {
3253 this.wait_for_buffer(response.buffer_id, cx)
3254 })
3255 .await
3256 })
3257 } else {
3258 Task::ready(Err(anyhow!("project does not have a remote id")))
3259 }
3260 }
3261
3262 pub fn hover<T: ToPointUtf16>(
3263 &self,
3264 buffer: &ModelHandle<Buffer>,
3265 position: T,
3266 cx: &mut ModelContext<Self>,
3267 ) -> Task<Result<Option<Hover>>> {
3268 let position = position.to_point_utf16(buffer.read(cx));
3269 self.request_lsp(buffer.clone(), GetHover { position }, cx)
3270 }
3271
3272 pub fn completions<T: ToPointUtf16>(
3273 &self,
3274 source_buffer_handle: &ModelHandle<Buffer>,
3275 position: T,
3276 cx: &mut ModelContext<Self>,
3277 ) -> Task<Result<Vec<Completion>>> {
3278 let source_buffer_handle = source_buffer_handle.clone();
3279 let source_buffer = source_buffer_handle.read(cx);
3280 let buffer_id = source_buffer.remote_id();
3281 let language = source_buffer.language().cloned();
3282 let worktree;
3283 let buffer_abs_path;
3284 if let Some(file) = File::from_dyn(source_buffer.file()) {
3285 worktree = file.worktree.clone();
3286 buffer_abs_path = file.as_local().map(|f| f.abs_path(cx));
3287 } else {
3288 return Task::ready(Ok(Default::default()));
3289 };
3290
3291 let position = position.to_point_utf16(source_buffer);
3292 let anchor = source_buffer.anchor_after(position);
3293
3294 if worktree.read(cx).as_local().is_some() {
3295 let buffer_abs_path = buffer_abs_path.unwrap();
3296 let lang_server =
3297 if let Some((_, server)) = self.language_server_for_buffer(source_buffer, cx) {
3298 server.clone()
3299 } else {
3300 return Task::ready(Ok(Default::default()));
3301 };
3302
3303 cx.spawn(|_, cx| async move {
3304 let completions = lang_server
3305 .request::<lsp::request::Completion>(lsp::CompletionParams {
3306 text_document_position: lsp::TextDocumentPositionParams::new(
3307 lsp::TextDocumentIdentifier::new(
3308 lsp::Url::from_file_path(buffer_abs_path).unwrap(),
3309 ),
3310 point_to_lsp(position),
3311 ),
3312 context: Default::default(),
3313 work_done_progress_params: Default::default(),
3314 partial_result_params: Default::default(),
3315 })
3316 .await
3317 .context("lsp completion request failed")?;
3318
3319 let completions = if let Some(completions) = completions {
3320 match completions {
3321 lsp::CompletionResponse::Array(completions) => completions,
3322 lsp::CompletionResponse::List(list) => list.items,
3323 }
3324 } else {
3325 Default::default()
3326 };
3327
3328 let completions = source_buffer_handle.read_with(&cx, |this, _| {
3329 let snapshot = this.snapshot();
3330 let clipped_position = this.clip_point_utf16(position, Bias::Left);
3331 let mut range_for_token = None;
3332 completions.into_iter().filter_map(move |lsp_completion| {
3333 // For now, we can only handle additional edits if they are returned
3334 // when resolving the completion, not if they are present initially.
3335 if lsp_completion
3336 .additional_text_edits
3337 .as_ref()
3338 .map_or(false, |edits| !edits.is_empty())
3339 {
3340 return None;
3341 }
3342
3343 let (old_range, mut new_text) = match lsp_completion.text_edit.as_ref() {
3344 // If the language server provides a range to overwrite, then
3345 // check that the range is valid.
3346 Some(lsp::CompletionTextEdit::Edit(edit)) => {
3347 let range = range_from_lsp(edit.range);
3348 let start = snapshot.clip_point_utf16(range.start, Bias::Left);
3349 let end = snapshot.clip_point_utf16(range.end, Bias::Left);
3350 if start != range.start || end != range.end {
3351 log::info!("completion out of expected range");
3352 return None;
3353 }
3354 (
3355 snapshot.anchor_before(start)..snapshot.anchor_after(end),
3356 edit.new_text.clone(),
3357 )
3358 }
3359 // If the language server does not provide a range, then infer
3360 // the range based on the syntax tree.
3361 None => {
3362 if position != clipped_position {
3363 log::info!("completion out of expected range");
3364 return None;
3365 }
3366 let Range { start, end } = range_for_token
3367 .get_or_insert_with(|| {
3368 let offset = position.to_offset(&snapshot);
3369 let (range, kind) = snapshot.surrounding_word(offset);
3370 if kind == Some(CharKind::Word) {
3371 range
3372 } else {
3373 offset..offset
3374 }
3375 })
3376 .clone();
3377 let text = lsp_completion
3378 .insert_text
3379 .as_ref()
3380 .unwrap_or(&lsp_completion.label)
3381 .clone();
3382 (
3383 snapshot.anchor_before(start)..snapshot.anchor_after(end),
3384 text,
3385 )
3386 }
3387 Some(lsp::CompletionTextEdit::InsertAndReplace(_)) => {
3388 log::info!("unsupported insert/replace completion");
3389 return None;
3390 }
3391 };
3392
3393 LineEnding::normalize(&mut new_text);
3394 let language = language.clone();
3395 Some(async move {
3396 let label = if let Some(language) = language {
3397 language.label_for_completion(&lsp_completion).await
3398 } else {
3399 None
3400 };
3401 Completion {
3402 old_range,
3403 new_text,
3404 label: label.unwrap_or_else(|| {
3405 CodeLabel::plain(
3406 lsp_completion.label.clone(),
3407 lsp_completion.filter_text.as_deref(),
3408 )
3409 }),
3410 lsp_completion,
3411 }
3412 })
3413 })
3414 });
3415
3416 Ok(futures::future::join_all(completions).await)
3417 })
3418 } else if let Some(project_id) = self.remote_id() {
3419 let rpc = self.client.clone();
3420 let message = proto::GetCompletions {
3421 project_id,
3422 buffer_id,
3423 position: Some(language::proto::serialize_anchor(&anchor)),
3424 version: serialize_version(&source_buffer.version()),
3425 };
3426 cx.spawn_weak(|_, mut cx| async move {
3427 let response = rpc.request(message).await?;
3428
3429 source_buffer_handle
3430 .update(&mut cx, |buffer, _| {
3431 buffer.wait_for_version(deserialize_version(response.version))
3432 })
3433 .await;
3434
3435 let completions = response.completions.into_iter().map(|completion| {
3436 language::proto::deserialize_completion(completion, language.clone())
3437 });
3438 futures::future::try_join_all(completions).await
3439 })
3440 } else {
3441 Task::ready(Ok(Default::default()))
3442 }
3443 }
3444
3445 pub fn apply_additional_edits_for_completion(
3446 &self,
3447 buffer_handle: ModelHandle<Buffer>,
3448 completion: Completion,
3449 push_to_history: bool,
3450 cx: &mut ModelContext<Self>,
3451 ) -> Task<Result<Option<Transaction>>> {
3452 let buffer = buffer_handle.read(cx);
3453 let buffer_id = buffer.remote_id();
3454
3455 if self.is_local() {
3456 let lang_server = match self.language_server_for_buffer(buffer, cx) {
3457 Some((_, server)) => server.clone(),
3458 _ => return Task::ready(Ok(Default::default())),
3459 };
3460
3461 cx.spawn(|this, mut cx| async move {
3462 let resolved_completion = lang_server
3463 .request::<lsp::request::ResolveCompletionItem>(completion.lsp_completion)
3464 .await?;
3465
3466 if let Some(edits) = resolved_completion.additional_text_edits {
3467 let edits = this
3468 .update(&mut cx, |this, cx| {
3469 this.edits_from_lsp(&buffer_handle, edits, None, cx)
3470 })
3471 .await?;
3472
3473 buffer_handle.update(&mut cx, |buffer, cx| {
3474 buffer.finalize_last_transaction();
3475 buffer.start_transaction();
3476
3477 for (range, text) in edits {
3478 let primary = &completion.old_range;
3479 let start_within = primary.start.cmp(&range.start, buffer).is_le()
3480 && primary.end.cmp(&range.start, buffer).is_ge();
3481 let end_within = range.start.cmp(&primary.end, buffer).is_le()
3482 && range.end.cmp(&primary.end, buffer).is_ge();
3483
3484 //Skip addtional edits which overlap with the primary completion edit
3485 //https://github.com/zed-industries/zed/pull/1871
3486 if !start_within && !end_within {
3487 buffer.edit([(range, text)], None, cx);
3488 }
3489 }
3490
3491 let transaction = if buffer.end_transaction(cx).is_some() {
3492 let transaction = buffer.finalize_last_transaction().unwrap().clone();
3493 if !push_to_history {
3494 buffer.forget_transaction(transaction.id);
3495 }
3496 Some(transaction)
3497 } else {
3498 None
3499 };
3500 Ok(transaction)
3501 })
3502 } else {
3503 Ok(None)
3504 }
3505 })
3506 } else if let Some(project_id) = self.remote_id() {
3507 let client = self.client.clone();
3508 cx.spawn(|_, mut cx| async move {
3509 let response = client
3510 .request(proto::ApplyCompletionAdditionalEdits {
3511 project_id,
3512 buffer_id,
3513 completion: Some(language::proto::serialize_completion(&completion)),
3514 })
3515 .await?;
3516
3517 if let Some(transaction) = response.transaction {
3518 let transaction = language::proto::deserialize_transaction(transaction)?;
3519 buffer_handle
3520 .update(&mut cx, |buffer, _| {
3521 buffer.wait_for_edits(transaction.edit_ids.iter().copied())
3522 })
3523 .await;
3524 if push_to_history {
3525 buffer_handle.update(&mut cx, |buffer, _| {
3526 buffer.push_transaction(transaction.clone(), Instant::now());
3527 });
3528 }
3529 Ok(Some(transaction))
3530 } else {
3531 Ok(None)
3532 }
3533 })
3534 } else {
3535 Task::ready(Err(anyhow!("project does not have a remote id")))
3536 }
3537 }
3538
3539 pub fn code_actions<T: Clone + ToOffset>(
3540 &self,
3541 buffer_handle: &ModelHandle<Buffer>,
3542 range: Range<T>,
3543 cx: &mut ModelContext<Self>,
3544 ) -> Task<Result<Vec<CodeAction>>> {
3545 let buffer_handle = buffer_handle.clone();
3546 let buffer = buffer_handle.read(cx);
3547 let snapshot = buffer.snapshot();
3548 let relevant_diagnostics = snapshot
3549 .diagnostics_in_range::<usize, usize>(range.to_offset(&snapshot), false)
3550 .map(|entry| entry.to_lsp_diagnostic_stub())
3551 .collect();
3552 let buffer_id = buffer.remote_id();
3553 let worktree;
3554 let buffer_abs_path;
3555 if let Some(file) = File::from_dyn(buffer.file()) {
3556 worktree = file.worktree.clone();
3557 buffer_abs_path = file.as_local().map(|f| f.abs_path(cx));
3558 } else {
3559 return Task::ready(Ok(Default::default()));
3560 };
3561 let range = buffer.anchor_before(range.start)..buffer.anchor_before(range.end);
3562
3563 if worktree.read(cx).as_local().is_some() {
3564 let buffer_abs_path = buffer_abs_path.unwrap();
3565 let lang_server = if let Some((_, server)) = self.language_server_for_buffer(buffer, cx)
3566 {
3567 server.clone()
3568 } else {
3569 return Task::ready(Ok(Default::default()));
3570 };
3571
3572 let lsp_range = range_to_lsp(range.to_point_utf16(buffer));
3573 cx.foreground().spawn(async move {
3574 if lang_server.capabilities().code_action_provider.is_none() {
3575 return Ok(Default::default());
3576 }
3577
3578 Ok(lang_server
3579 .request::<lsp::request::CodeActionRequest>(lsp::CodeActionParams {
3580 text_document: lsp::TextDocumentIdentifier::new(
3581 lsp::Url::from_file_path(buffer_abs_path).unwrap(),
3582 ),
3583 range: lsp_range,
3584 work_done_progress_params: Default::default(),
3585 partial_result_params: Default::default(),
3586 context: lsp::CodeActionContext {
3587 diagnostics: relevant_diagnostics,
3588 only: None,
3589 },
3590 })
3591 .await?
3592 .unwrap_or_default()
3593 .into_iter()
3594 .filter_map(|entry| {
3595 if let lsp::CodeActionOrCommand::CodeAction(lsp_action) = entry {
3596 Some(CodeAction {
3597 range: range.clone(),
3598 lsp_action,
3599 })
3600 } else {
3601 None
3602 }
3603 })
3604 .collect())
3605 })
3606 } else if let Some(project_id) = self.remote_id() {
3607 let rpc = self.client.clone();
3608 let version = buffer.version();
3609 cx.spawn_weak(|_, mut cx| async move {
3610 let response = rpc
3611 .request(proto::GetCodeActions {
3612 project_id,
3613 buffer_id,
3614 start: Some(language::proto::serialize_anchor(&range.start)),
3615 end: Some(language::proto::serialize_anchor(&range.end)),
3616 version: serialize_version(&version),
3617 })
3618 .await?;
3619
3620 buffer_handle
3621 .update(&mut cx, |buffer, _| {
3622 buffer.wait_for_version(deserialize_version(response.version))
3623 })
3624 .await;
3625
3626 response
3627 .actions
3628 .into_iter()
3629 .map(language::proto::deserialize_code_action)
3630 .collect()
3631 })
3632 } else {
3633 Task::ready(Ok(Default::default()))
3634 }
3635 }
3636
3637 pub fn apply_code_action(
3638 &self,
3639 buffer_handle: ModelHandle<Buffer>,
3640 mut action: CodeAction,
3641 push_to_history: bool,
3642 cx: &mut ModelContext<Self>,
3643 ) -> Task<Result<ProjectTransaction>> {
3644 if self.is_local() {
3645 let buffer = buffer_handle.read(cx);
3646 let (lsp_adapter, lang_server) =
3647 if let Some((adapter, server)) = self.language_server_for_buffer(buffer, cx) {
3648 (adapter.clone(), server.clone())
3649 } else {
3650 return Task::ready(Ok(Default::default()));
3651 };
3652 let range = action.range.to_point_utf16(buffer);
3653
3654 cx.spawn(|this, mut cx| async move {
3655 if let Some(lsp_range) = action
3656 .lsp_action
3657 .data
3658 .as_mut()
3659 .and_then(|d| d.get_mut("codeActionParams"))
3660 .and_then(|d| d.get_mut("range"))
3661 {
3662 *lsp_range = serde_json::to_value(&range_to_lsp(range)).unwrap();
3663 action.lsp_action = lang_server
3664 .request::<lsp::request::CodeActionResolveRequest>(action.lsp_action)
3665 .await?;
3666 } else {
3667 let actions = this
3668 .update(&mut cx, |this, cx| {
3669 this.code_actions(&buffer_handle, action.range, cx)
3670 })
3671 .await?;
3672 action.lsp_action = actions
3673 .into_iter()
3674 .find(|a| a.lsp_action.title == action.lsp_action.title)
3675 .ok_or_else(|| anyhow!("code action is outdated"))?
3676 .lsp_action;
3677 }
3678
3679 if let Some(edit) = action.lsp_action.edit {
3680 if edit.changes.is_some() || edit.document_changes.is_some() {
3681 return Self::deserialize_workspace_edit(
3682 this,
3683 edit,
3684 push_to_history,
3685 lsp_adapter.clone(),
3686 lang_server.clone(),
3687 &mut cx,
3688 )
3689 .await;
3690 }
3691 }
3692
3693 if let Some(command) = action.lsp_action.command {
3694 this.update(&mut cx, |this, _| {
3695 this.last_workspace_edits_by_language_server
3696 .remove(&lang_server.server_id());
3697 });
3698 lang_server
3699 .request::<lsp::request::ExecuteCommand>(lsp::ExecuteCommandParams {
3700 command: command.command,
3701 arguments: command.arguments.unwrap_or_default(),
3702 ..Default::default()
3703 })
3704 .await?;
3705 return Ok(this.update(&mut cx, |this, _| {
3706 this.last_workspace_edits_by_language_server
3707 .remove(&lang_server.server_id())
3708 .unwrap_or_default()
3709 }));
3710 }
3711
3712 Ok(ProjectTransaction::default())
3713 })
3714 } else if let Some(project_id) = self.remote_id() {
3715 let client = self.client.clone();
3716 let request = proto::ApplyCodeAction {
3717 project_id,
3718 buffer_id: buffer_handle.read(cx).remote_id(),
3719 action: Some(language::proto::serialize_code_action(&action)),
3720 };
3721 cx.spawn(|this, mut cx| async move {
3722 let response = client
3723 .request(request)
3724 .await?
3725 .transaction
3726 .ok_or_else(|| anyhow!("missing transaction"))?;
3727 this.update(&mut cx, |this, cx| {
3728 this.deserialize_project_transaction(response, push_to_history, cx)
3729 })
3730 .await
3731 })
3732 } else {
3733 Task::ready(Err(anyhow!("project does not have a remote id")))
3734 }
3735 }
3736
3737 async fn deserialize_workspace_edit(
3738 this: ModelHandle<Self>,
3739 edit: lsp::WorkspaceEdit,
3740 push_to_history: bool,
3741 lsp_adapter: Arc<CachedLspAdapter>,
3742 language_server: Arc<LanguageServer>,
3743 cx: &mut AsyncAppContext,
3744 ) -> Result<ProjectTransaction> {
3745 let fs = this.read_with(cx, |this, _| this.fs.clone());
3746 let mut operations = Vec::new();
3747 if let Some(document_changes) = edit.document_changes {
3748 match document_changes {
3749 lsp::DocumentChanges::Edits(edits) => {
3750 operations.extend(edits.into_iter().map(lsp::DocumentChangeOperation::Edit))
3751 }
3752 lsp::DocumentChanges::Operations(ops) => operations = ops,
3753 }
3754 } else if let Some(changes) = edit.changes {
3755 operations.extend(changes.into_iter().map(|(uri, edits)| {
3756 lsp::DocumentChangeOperation::Edit(lsp::TextDocumentEdit {
3757 text_document: lsp::OptionalVersionedTextDocumentIdentifier {
3758 uri,
3759 version: None,
3760 },
3761 edits: edits.into_iter().map(lsp::OneOf::Left).collect(),
3762 })
3763 }));
3764 }
3765
3766 let mut project_transaction = ProjectTransaction::default();
3767 for operation in operations {
3768 match operation {
3769 lsp::DocumentChangeOperation::Op(lsp::ResourceOp::Create(op)) => {
3770 let abs_path = op
3771 .uri
3772 .to_file_path()
3773 .map_err(|_| anyhow!("can't convert URI to path"))?;
3774
3775 if let Some(parent_path) = abs_path.parent() {
3776 fs.create_dir(parent_path).await?;
3777 }
3778 if abs_path.ends_with("/") {
3779 fs.create_dir(&abs_path).await?;
3780 } else {
3781 fs.create_file(&abs_path, op.options.map(Into::into).unwrap_or_default())
3782 .await?;
3783 }
3784 }
3785 lsp::DocumentChangeOperation::Op(lsp::ResourceOp::Rename(op)) => {
3786 let source_abs_path = op
3787 .old_uri
3788 .to_file_path()
3789 .map_err(|_| anyhow!("can't convert URI to path"))?;
3790 let target_abs_path = op
3791 .new_uri
3792 .to_file_path()
3793 .map_err(|_| anyhow!("can't convert URI to path"))?;
3794 fs.rename(
3795 &source_abs_path,
3796 &target_abs_path,
3797 op.options.map(Into::into).unwrap_or_default(),
3798 )
3799 .await?;
3800 }
3801 lsp::DocumentChangeOperation::Op(lsp::ResourceOp::Delete(op)) => {
3802 let abs_path = op
3803 .uri
3804 .to_file_path()
3805 .map_err(|_| anyhow!("can't convert URI to path"))?;
3806 let options = op.options.map(Into::into).unwrap_or_default();
3807 if abs_path.ends_with("/") {
3808 fs.remove_dir(&abs_path, options).await?;
3809 } else {
3810 fs.remove_file(&abs_path, options).await?;
3811 }
3812 }
3813 lsp::DocumentChangeOperation::Edit(op) => {
3814 let buffer_to_edit = this
3815 .update(cx, |this, cx| {
3816 this.open_local_buffer_via_lsp(
3817 op.text_document.uri,
3818 language_server.server_id(),
3819 lsp_adapter.name.clone(),
3820 cx,
3821 )
3822 })
3823 .await?;
3824
3825 let edits = this
3826 .update(cx, |this, cx| {
3827 let edits = op.edits.into_iter().map(|edit| match edit {
3828 lsp::OneOf::Left(edit) => edit,
3829 lsp::OneOf::Right(edit) => edit.text_edit,
3830 });
3831 this.edits_from_lsp(
3832 &buffer_to_edit,
3833 edits,
3834 op.text_document.version,
3835 cx,
3836 )
3837 })
3838 .await?;
3839
3840 let transaction = buffer_to_edit.update(cx, |buffer, cx| {
3841 buffer.finalize_last_transaction();
3842 buffer.start_transaction();
3843 for (range, text) in edits {
3844 buffer.edit([(range, text)], None, cx);
3845 }
3846 let transaction = if buffer.end_transaction(cx).is_some() {
3847 let transaction = buffer.finalize_last_transaction().unwrap().clone();
3848 if !push_to_history {
3849 buffer.forget_transaction(transaction.id);
3850 }
3851 Some(transaction)
3852 } else {
3853 None
3854 };
3855
3856 transaction
3857 });
3858 if let Some(transaction) = transaction {
3859 project_transaction.0.insert(buffer_to_edit, transaction);
3860 }
3861 }
3862 }
3863 }
3864
3865 Ok(project_transaction)
3866 }
3867
3868 pub fn prepare_rename<T: ToPointUtf16>(
3869 &self,
3870 buffer: ModelHandle<Buffer>,
3871 position: T,
3872 cx: &mut ModelContext<Self>,
3873 ) -> Task<Result<Option<Range<Anchor>>>> {
3874 let position = position.to_point_utf16(buffer.read(cx));
3875 self.request_lsp(buffer, PrepareRename { position }, cx)
3876 }
3877
3878 pub fn perform_rename<T: ToPointUtf16>(
3879 &self,
3880 buffer: ModelHandle<Buffer>,
3881 position: T,
3882 new_name: String,
3883 push_to_history: bool,
3884 cx: &mut ModelContext<Self>,
3885 ) -> Task<Result<ProjectTransaction>> {
3886 let position = position.to_point_utf16(buffer.read(cx));
3887 self.request_lsp(
3888 buffer,
3889 PerformRename {
3890 position,
3891 new_name,
3892 push_to_history,
3893 },
3894 cx,
3895 )
3896 }
3897
3898 #[allow(clippy::type_complexity)]
3899 pub fn search(
3900 &self,
3901 query: SearchQuery,
3902 cx: &mut ModelContext<Self>,
3903 ) -> Task<Result<HashMap<ModelHandle<Buffer>, Vec<Range<Anchor>>>>> {
3904 if self.is_local() {
3905 let snapshots = self
3906 .visible_worktrees(cx)
3907 .filter_map(|tree| {
3908 let tree = tree.read(cx).as_local()?;
3909 Some(tree.snapshot())
3910 })
3911 .collect::<Vec<_>>();
3912
3913 let background = cx.background().clone();
3914 let path_count: usize = snapshots.iter().map(|s| s.visible_file_count()).sum();
3915 if path_count == 0 {
3916 return Task::ready(Ok(Default::default()));
3917 }
3918 let workers = background.num_cpus().min(path_count);
3919 let (matching_paths_tx, mut matching_paths_rx) = smol::channel::bounded(1024);
3920 cx.background()
3921 .spawn({
3922 let fs = self.fs.clone();
3923 let background = cx.background().clone();
3924 let query = query.clone();
3925 async move {
3926 let fs = &fs;
3927 let query = &query;
3928 let matching_paths_tx = &matching_paths_tx;
3929 let paths_per_worker = (path_count + workers - 1) / workers;
3930 let snapshots = &snapshots;
3931 background
3932 .scoped(|scope| {
3933 for worker_ix in 0..workers {
3934 let worker_start_ix = worker_ix * paths_per_worker;
3935 let worker_end_ix = worker_start_ix + paths_per_worker;
3936 scope.spawn(async move {
3937 let mut snapshot_start_ix = 0;
3938 let mut abs_path = PathBuf::new();
3939 for snapshot in snapshots {
3940 let snapshot_end_ix =
3941 snapshot_start_ix + snapshot.visible_file_count();
3942 if worker_end_ix <= snapshot_start_ix {
3943 break;
3944 } else if worker_start_ix > snapshot_end_ix {
3945 snapshot_start_ix = snapshot_end_ix;
3946 continue;
3947 } else {
3948 let start_in_snapshot = worker_start_ix
3949 .saturating_sub(snapshot_start_ix);
3950 let end_in_snapshot =
3951 cmp::min(worker_end_ix, snapshot_end_ix)
3952 - snapshot_start_ix;
3953
3954 for entry in snapshot
3955 .files(false, start_in_snapshot)
3956 .take(end_in_snapshot - start_in_snapshot)
3957 {
3958 if matching_paths_tx.is_closed() {
3959 break;
3960 }
3961
3962 abs_path.clear();
3963 abs_path.push(&snapshot.abs_path());
3964 abs_path.push(&entry.path);
3965 let matches = if let Some(file) =
3966 fs.open_sync(&abs_path).await.log_err()
3967 {
3968 query.detect(file).unwrap_or(false)
3969 } else {
3970 false
3971 };
3972
3973 if matches {
3974 let project_path =
3975 (snapshot.id(), entry.path.clone());
3976 if matching_paths_tx
3977 .send(project_path)
3978 .await
3979 .is_err()
3980 {
3981 break;
3982 }
3983 }
3984 }
3985
3986 snapshot_start_ix = snapshot_end_ix;
3987 }
3988 }
3989 });
3990 }
3991 })
3992 .await;
3993 }
3994 })
3995 .detach();
3996
3997 let (buffers_tx, buffers_rx) = smol::channel::bounded(1024);
3998 let open_buffers = self
3999 .opened_buffers
4000 .values()
4001 .filter_map(|b| b.upgrade(cx))
4002 .collect::<HashSet<_>>();
4003 cx.spawn(|this, cx| async move {
4004 for buffer in &open_buffers {
4005 let snapshot = buffer.read_with(&cx, |buffer, _| buffer.snapshot());
4006 buffers_tx.send((buffer.clone(), snapshot)).await?;
4007 }
4008
4009 let open_buffers = Rc::new(RefCell::new(open_buffers));
4010 while let Some(project_path) = matching_paths_rx.next().await {
4011 if buffers_tx.is_closed() {
4012 break;
4013 }
4014
4015 let this = this.clone();
4016 let open_buffers = open_buffers.clone();
4017 let buffers_tx = buffers_tx.clone();
4018 cx.spawn(|mut cx| async move {
4019 if let Some(buffer) = this
4020 .update(&mut cx, |this, cx| this.open_buffer(project_path, cx))
4021 .await
4022 .log_err()
4023 {
4024 if open_buffers.borrow_mut().insert(buffer.clone()) {
4025 let snapshot = buffer.read_with(&cx, |buffer, _| buffer.snapshot());
4026 buffers_tx.send((buffer, snapshot)).await?;
4027 }
4028 }
4029
4030 Ok::<_, anyhow::Error>(())
4031 })
4032 .detach();
4033 }
4034
4035 Ok::<_, anyhow::Error>(())
4036 })
4037 .detach_and_log_err(cx);
4038
4039 let background = cx.background().clone();
4040 cx.background().spawn(async move {
4041 let query = &query;
4042 let mut matched_buffers = Vec::new();
4043 for _ in 0..workers {
4044 matched_buffers.push(HashMap::default());
4045 }
4046 background
4047 .scoped(|scope| {
4048 for worker_matched_buffers in matched_buffers.iter_mut() {
4049 let mut buffers_rx = buffers_rx.clone();
4050 scope.spawn(async move {
4051 while let Some((buffer, snapshot)) = buffers_rx.next().await {
4052 let buffer_matches = query
4053 .search(snapshot.as_rope())
4054 .await
4055 .iter()
4056 .map(|range| {
4057 snapshot.anchor_before(range.start)
4058 ..snapshot.anchor_after(range.end)
4059 })
4060 .collect::<Vec<_>>();
4061 if !buffer_matches.is_empty() {
4062 worker_matched_buffers
4063 .insert(buffer.clone(), buffer_matches);
4064 }
4065 }
4066 });
4067 }
4068 })
4069 .await;
4070 Ok(matched_buffers.into_iter().flatten().collect())
4071 })
4072 } else if let Some(project_id) = self.remote_id() {
4073 let request = self.client.request(query.to_proto(project_id));
4074 cx.spawn(|this, mut cx| async move {
4075 let response = request.await?;
4076 let mut result = HashMap::default();
4077 for location in response.locations {
4078 let target_buffer = this
4079 .update(&mut cx, |this, cx| {
4080 this.wait_for_buffer(location.buffer_id, cx)
4081 })
4082 .await?;
4083 let start = location
4084 .start
4085 .and_then(deserialize_anchor)
4086 .ok_or_else(|| anyhow!("missing target start"))?;
4087 let end = location
4088 .end
4089 .and_then(deserialize_anchor)
4090 .ok_or_else(|| anyhow!("missing target end"))?;
4091 result
4092 .entry(target_buffer)
4093 .or_insert(Vec::new())
4094 .push(start..end)
4095 }
4096 Ok(result)
4097 })
4098 } else {
4099 Task::ready(Ok(Default::default()))
4100 }
4101 }
4102
4103 fn request_lsp<R: LspCommand>(
4104 &self,
4105 buffer_handle: ModelHandle<Buffer>,
4106 request: R,
4107 cx: &mut ModelContext<Self>,
4108 ) -> Task<Result<R::Response>>
4109 where
4110 <R::LspRequest as lsp::request::Request>::Result: Send,
4111 {
4112 let buffer = buffer_handle.read(cx);
4113 if self.is_local() {
4114 let file = File::from_dyn(buffer.file()).and_then(File::as_local);
4115 if let Some((file, language_server)) = file.zip(
4116 self.language_server_for_buffer(buffer, cx)
4117 .map(|(_, server)| server.clone()),
4118 ) {
4119 let lsp_params = request.to_lsp(&file.abs_path(cx), cx);
4120 return cx.spawn(|this, cx| async move {
4121 if !request.check_capabilities(language_server.capabilities()) {
4122 return Ok(Default::default());
4123 }
4124
4125 let response = language_server
4126 .request::<R::LspRequest>(lsp_params)
4127 .await
4128 .context("lsp request failed")?;
4129 request
4130 .response_from_lsp(response, this, buffer_handle, cx)
4131 .await
4132 });
4133 }
4134 } else if let Some(project_id) = self.remote_id() {
4135 let rpc = self.client.clone();
4136 let message = request.to_proto(project_id, buffer);
4137 return cx.spawn(|this, cx| async move {
4138 let response = rpc.request(message).await?;
4139 request
4140 .response_from_proto(response, this, buffer_handle, cx)
4141 .await
4142 });
4143 }
4144 Task::ready(Ok(Default::default()))
4145 }
4146
4147 pub fn find_or_create_local_worktree(
4148 &mut self,
4149 abs_path: impl AsRef<Path>,
4150 visible: bool,
4151 cx: &mut ModelContext<Self>,
4152 ) -> Task<Result<(ModelHandle<Worktree>, PathBuf)>> {
4153 let abs_path = abs_path.as_ref();
4154 if let Some((tree, relative_path)) = self.find_local_worktree(abs_path, cx) {
4155 Task::ready(Ok((tree, relative_path)))
4156 } else {
4157 let worktree = self.create_local_worktree(abs_path, visible, cx);
4158 cx.foreground()
4159 .spawn(async move { Ok((worktree.await?, PathBuf::new())) })
4160 }
4161 }
4162
4163 pub fn find_local_worktree(
4164 &self,
4165 abs_path: &Path,
4166 cx: &AppContext,
4167 ) -> Option<(ModelHandle<Worktree>, PathBuf)> {
4168 for tree in &self.worktrees {
4169 if let Some(tree) = tree.upgrade(cx) {
4170 if let Some(relative_path) = tree
4171 .read(cx)
4172 .as_local()
4173 .and_then(|t| abs_path.strip_prefix(t.abs_path()).ok())
4174 {
4175 return Some((tree.clone(), relative_path.into()));
4176 }
4177 }
4178 }
4179 None
4180 }
4181
4182 pub fn is_shared(&self) -> bool {
4183 match &self.client_state {
4184 Some(ProjectClientState::Local { .. }) => true,
4185 _ => false,
4186 }
4187 }
4188
4189 fn create_local_worktree(
4190 &mut self,
4191 abs_path: impl AsRef<Path>,
4192 visible: bool,
4193 cx: &mut ModelContext<Self>,
4194 ) -> Task<Result<ModelHandle<Worktree>>> {
4195 let fs = self.fs.clone();
4196 let client = self.client.clone();
4197 let next_entry_id = self.next_entry_id.clone();
4198 let path: Arc<Path> = abs_path.as_ref().into();
4199 let task = self
4200 .loading_local_worktrees
4201 .entry(path.clone())
4202 .or_insert_with(|| {
4203 cx.spawn(|project, mut cx| {
4204 async move {
4205 let worktree = Worktree::local(
4206 client.clone(),
4207 path.clone(),
4208 visible,
4209 fs,
4210 next_entry_id,
4211 &mut cx,
4212 )
4213 .await;
4214 project.update(&mut cx, |project, _| {
4215 project.loading_local_worktrees.remove(&path);
4216 });
4217 let worktree = worktree?;
4218
4219 let project_id = project.update(&mut cx, |project, cx| {
4220 project.add_worktree(&worktree, cx);
4221 project.remote_id()
4222 });
4223
4224 if let Some(project_id) = project_id {
4225 worktree
4226 .update(&mut cx, |worktree, cx| {
4227 worktree.as_local_mut().unwrap().share(project_id, cx)
4228 })
4229 .await
4230 .log_err();
4231 }
4232
4233 Ok(worktree)
4234 }
4235 .map_err(Arc::new)
4236 })
4237 .shared()
4238 })
4239 .clone();
4240 cx.foreground().spawn(async move {
4241 match task.await {
4242 Ok(worktree) => Ok(worktree),
4243 Err(err) => Err(anyhow!("{}", err)),
4244 }
4245 })
4246 }
4247
4248 pub fn remove_worktree(&mut self, id_to_remove: WorktreeId, cx: &mut ModelContext<Self>) {
4249 self.worktrees.retain(|worktree| {
4250 if let Some(worktree) = worktree.upgrade(cx) {
4251 let id = worktree.read(cx).id();
4252 if id == id_to_remove {
4253 cx.emit(Event::WorktreeRemoved(id));
4254 false
4255 } else {
4256 true
4257 }
4258 } else {
4259 false
4260 }
4261 });
4262 self.metadata_changed(cx);
4263 cx.notify();
4264 }
4265
4266 fn add_worktree(&mut self, worktree: &ModelHandle<Worktree>, cx: &mut ModelContext<Self>) {
4267 cx.observe(worktree, |_, _, cx| cx.notify()).detach();
4268 if worktree.read(cx).is_local() {
4269 cx.subscribe(worktree, |this, worktree, event, cx| match event {
4270 worktree::Event::UpdatedEntries => this.update_local_worktree_buffers(worktree, cx),
4271 worktree::Event::UpdatedGitRepositories(updated_repos) => {
4272 this.update_local_worktree_buffers_git_repos(worktree, updated_repos, cx)
4273 }
4274 })
4275 .detach();
4276 }
4277
4278 let push_strong_handle = {
4279 let worktree = worktree.read(cx);
4280 self.is_shared() || worktree.is_visible() || worktree.is_remote()
4281 };
4282 if push_strong_handle {
4283 self.worktrees
4284 .push(WorktreeHandle::Strong(worktree.clone()));
4285 } else {
4286 self.worktrees
4287 .push(WorktreeHandle::Weak(worktree.downgrade()));
4288 }
4289
4290 self.metadata_changed(cx);
4291 cx.observe_release(worktree, |this, worktree, cx| {
4292 this.remove_worktree(worktree.id(), cx);
4293 cx.notify();
4294 })
4295 .detach();
4296
4297 cx.emit(Event::WorktreeAdded);
4298 cx.notify();
4299 }
4300
4301 fn update_local_worktree_buffers(
4302 &mut self,
4303 worktree_handle: ModelHandle<Worktree>,
4304 cx: &mut ModelContext<Self>,
4305 ) {
4306 let snapshot = worktree_handle.read(cx).snapshot();
4307 let mut buffers_to_delete = Vec::new();
4308 let mut renamed_buffers = Vec::new();
4309 for (buffer_id, buffer) in &self.opened_buffers {
4310 if let Some(buffer) = buffer.upgrade(cx) {
4311 buffer.update(cx, |buffer, cx| {
4312 if let Some(old_file) = File::from_dyn(buffer.file()) {
4313 if old_file.worktree != worktree_handle {
4314 return;
4315 }
4316
4317 let new_file = if let Some(entry) = snapshot.entry_for_id(old_file.entry_id)
4318 {
4319 File {
4320 is_local: true,
4321 entry_id: entry.id,
4322 mtime: entry.mtime,
4323 path: entry.path.clone(),
4324 worktree: worktree_handle.clone(),
4325 is_deleted: false,
4326 }
4327 } else if let Some(entry) =
4328 snapshot.entry_for_path(old_file.path().as_ref())
4329 {
4330 File {
4331 is_local: true,
4332 entry_id: entry.id,
4333 mtime: entry.mtime,
4334 path: entry.path.clone(),
4335 worktree: worktree_handle.clone(),
4336 is_deleted: false,
4337 }
4338 } else {
4339 File {
4340 is_local: true,
4341 entry_id: old_file.entry_id,
4342 path: old_file.path().clone(),
4343 mtime: old_file.mtime(),
4344 worktree: worktree_handle.clone(),
4345 is_deleted: true,
4346 }
4347 };
4348
4349 let old_path = old_file.abs_path(cx);
4350 if new_file.abs_path(cx) != old_path {
4351 renamed_buffers.push((cx.handle(), old_path));
4352 }
4353
4354 if let Some(project_id) = self.remote_id() {
4355 self.client
4356 .send(proto::UpdateBufferFile {
4357 project_id,
4358 buffer_id: *buffer_id as u64,
4359 file: Some(new_file.to_proto()),
4360 })
4361 .log_err();
4362 }
4363 buffer.file_updated(Arc::new(new_file), cx).detach();
4364 }
4365 });
4366 } else {
4367 buffers_to_delete.push(*buffer_id);
4368 }
4369 }
4370
4371 for buffer_id in buffers_to_delete {
4372 self.opened_buffers.remove(&buffer_id);
4373 }
4374
4375 for (buffer, old_path) in renamed_buffers {
4376 self.unregister_buffer_from_language_server(&buffer, old_path, cx);
4377 self.assign_language_to_buffer(&buffer, cx);
4378 self.register_buffer_with_language_server(&buffer, cx);
4379 }
4380 }
4381
4382 fn update_local_worktree_buffers_git_repos(
4383 &mut self,
4384 worktree: ModelHandle<Worktree>,
4385 repos: &[GitRepositoryEntry],
4386 cx: &mut ModelContext<Self>,
4387 ) {
4388 for (_, buffer) in &self.opened_buffers {
4389 if let Some(buffer) = buffer.upgrade(cx) {
4390 let file = match File::from_dyn(buffer.read(cx).file()) {
4391 Some(file) => file,
4392 None => continue,
4393 };
4394 if file.worktree != worktree {
4395 continue;
4396 }
4397
4398 let path = file.path().clone();
4399
4400 let repo = match repos.iter().find(|repo| repo.manages(&path)) {
4401 Some(repo) => repo.clone(),
4402 None => return,
4403 };
4404
4405 let relative_repo = match path.strip_prefix(repo.content_path) {
4406 Ok(relative_repo) => relative_repo.to_owned(),
4407 Err(_) => return,
4408 };
4409
4410 let remote_id = self.remote_id();
4411 let client = self.client.clone();
4412
4413 cx.spawn(|_, mut cx| async move {
4414 let diff_base = cx
4415 .background()
4416 .spawn(async move { repo.repo.lock().load_index_text(&relative_repo) })
4417 .await;
4418
4419 let buffer_id = buffer.update(&mut cx, |buffer, cx| {
4420 buffer.set_diff_base(diff_base.clone(), cx);
4421 buffer.remote_id()
4422 });
4423
4424 if let Some(project_id) = remote_id {
4425 client
4426 .send(proto::UpdateDiffBase {
4427 project_id,
4428 buffer_id: buffer_id as u64,
4429 diff_base,
4430 })
4431 .log_err();
4432 }
4433 })
4434 .detach();
4435 }
4436 }
4437 }
4438
4439 pub fn set_active_path(&mut self, entry: Option<ProjectPath>, cx: &mut ModelContext<Self>) {
4440 let new_active_entry = entry.and_then(|project_path| {
4441 let worktree = self.worktree_for_id(project_path.worktree_id, cx)?;
4442 let entry = worktree.read(cx).entry_for_path(project_path.path)?;
4443 Some(entry.id)
4444 });
4445 if new_active_entry != self.active_entry {
4446 self.active_entry = new_active_entry;
4447 cx.emit(Event::ActiveEntryChanged(new_active_entry));
4448 }
4449 }
4450
4451 pub fn language_servers_running_disk_based_diagnostics(
4452 &self,
4453 ) -> impl Iterator<Item = usize> + '_ {
4454 self.language_server_statuses
4455 .iter()
4456 .filter_map(|(id, status)| {
4457 if status.has_pending_diagnostic_updates {
4458 Some(*id)
4459 } else {
4460 None
4461 }
4462 })
4463 }
4464
4465 pub fn diagnostic_summary(&self, cx: &AppContext) -> DiagnosticSummary {
4466 let mut summary = DiagnosticSummary::default();
4467 for (_, path_summary) in self.diagnostic_summaries(cx) {
4468 summary.error_count += path_summary.error_count;
4469 summary.warning_count += path_summary.warning_count;
4470 }
4471 summary
4472 }
4473
4474 pub fn diagnostic_summaries<'a>(
4475 &'a self,
4476 cx: &'a AppContext,
4477 ) -> impl Iterator<Item = (ProjectPath, DiagnosticSummary)> + 'a {
4478 self.visible_worktrees(cx).flat_map(move |worktree| {
4479 let worktree = worktree.read(cx);
4480 let worktree_id = worktree.id();
4481 worktree
4482 .diagnostic_summaries()
4483 .map(move |(path, summary)| (ProjectPath { worktree_id, path }, summary))
4484 })
4485 }
4486
4487 pub fn disk_based_diagnostics_started(
4488 &mut self,
4489 language_server_id: usize,
4490 cx: &mut ModelContext<Self>,
4491 ) {
4492 cx.emit(Event::DiskBasedDiagnosticsStarted { language_server_id });
4493 }
4494
4495 pub fn disk_based_diagnostics_finished(
4496 &mut self,
4497 language_server_id: usize,
4498 cx: &mut ModelContext<Self>,
4499 ) {
4500 cx.emit(Event::DiskBasedDiagnosticsFinished { language_server_id });
4501 }
4502
4503 pub fn active_entry(&self) -> Option<ProjectEntryId> {
4504 self.active_entry
4505 }
4506
4507 pub fn entry_for_path(&self, path: &ProjectPath, cx: &AppContext) -> Option<Entry> {
4508 self.worktree_for_id(path.worktree_id, cx)?
4509 .read(cx)
4510 .entry_for_path(&path.path)
4511 .cloned()
4512 }
4513
4514 pub fn path_for_entry(&self, entry_id: ProjectEntryId, cx: &AppContext) -> Option<ProjectPath> {
4515 let worktree = self.worktree_for_entry(entry_id, cx)?;
4516 let worktree = worktree.read(cx);
4517 let worktree_id = worktree.id();
4518 let path = worktree.entry_for_id(entry_id)?.path.clone();
4519 Some(ProjectPath { worktree_id, path })
4520 }
4521
4522 // RPC message handlers
4523
4524 async fn handle_unshare_project(
4525 this: ModelHandle<Self>,
4526 _: TypedEnvelope<proto::UnshareProject>,
4527 _: Arc<Client>,
4528 mut cx: AsyncAppContext,
4529 ) -> Result<()> {
4530 this.update(&mut cx, |this, cx| {
4531 if this.is_local() {
4532 this.unshare(cx)?;
4533 } else {
4534 this.disconnected_from_host(cx);
4535 }
4536 Ok(())
4537 })
4538 }
4539
4540 async fn handle_add_collaborator(
4541 this: ModelHandle<Self>,
4542 mut envelope: TypedEnvelope<proto::AddProjectCollaborator>,
4543 _: Arc<Client>,
4544 mut cx: AsyncAppContext,
4545 ) -> Result<()> {
4546 let collaborator = envelope
4547 .payload
4548 .collaborator
4549 .take()
4550 .ok_or_else(|| anyhow!("empty collaborator"))?;
4551
4552 let collaborator = Collaborator::from_proto(collaborator);
4553 this.update(&mut cx, |this, cx| {
4554 this.collaborators
4555 .insert(collaborator.peer_id, collaborator);
4556 cx.notify();
4557 });
4558
4559 Ok(())
4560 }
4561
4562 async fn handle_remove_collaborator(
4563 this: ModelHandle<Self>,
4564 envelope: TypedEnvelope<proto::RemoveProjectCollaborator>,
4565 _: Arc<Client>,
4566 mut cx: AsyncAppContext,
4567 ) -> Result<()> {
4568 this.update(&mut cx, |this, cx| {
4569 let peer_id = PeerId(envelope.payload.peer_id);
4570 let replica_id = this
4571 .collaborators
4572 .remove(&peer_id)
4573 .ok_or_else(|| anyhow!("unknown peer {:?}", peer_id))?
4574 .replica_id;
4575 for buffer in this.opened_buffers.values() {
4576 if let Some(buffer) = buffer.upgrade(cx) {
4577 buffer.update(cx, |buffer, cx| buffer.remove_peer(replica_id, cx));
4578 }
4579 }
4580 this.shared_buffers.remove(&peer_id);
4581
4582 cx.emit(Event::CollaboratorLeft(peer_id));
4583 cx.notify();
4584 Ok(())
4585 })
4586 }
4587
4588 async fn handle_update_project(
4589 this: ModelHandle<Self>,
4590 envelope: TypedEnvelope<proto::UpdateProject>,
4591 client: Arc<Client>,
4592 mut cx: AsyncAppContext,
4593 ) -> Result<()> {
4594 this.update(&mut cx, |this, cx| {
4595 let replica_id = this.replica_id();
4596 let remote_id = this.remote_id().ok_or_else(|| anyhow!("invalid project"))?;
4597
4598 let mut old_worktrees_by_id = this
4599 .worktrees
4600 .drain(..)
4601 .filter_map(|worktree| {
4602 let worktree = worktree.upgrade(cx)?;
4603 Some((worktree.read(cx).id(), worktree))
4604 })
4605 .collect::<HashMap<_, _>>();
4606
4607 for worktree in envelope.payload.worktrees {
4608 if let Some(old_worktree) =
4609 old_worktrees_by_id.remove(&WorktreeId::from_proto(worktree.id))
4610 {
4611 this.worktrees.push(WorktreeHandle::Strong(old_worktree));
4612 } else {
4613 let worktree =
4614 Worktree::remote(remote_id, replica_id, worktree, client.clone(), cx);
4615 this.add_worktree(&worktree, cx);
4616 }
4617 }
4618
4619 this.metadata_changed(cx);
4620 for (id, _) in old_worktrees_by_id {
4621 cx.emit(Event::WorktreeRemoved(id));
4622 }
4623
4624 Ok(())
4625 })
4626 }
4627
4628 async fn handle_update_worktree(
4629 this: ModelHandle<Self>,
4630 envelope: TypedEnvelope<proto::UpdateWorktree>,
4631 _: Arc<Client>,
4632 mut cx: AsyncAppContext,
4633 ) -> Result<()> {
4634 this.update(&mut cx, |this, cx| {
4635 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
4636 if let Some(worktree) = this.worktree_for_id(worktree_id, cx) {
4637 worktree.update(cx, |worktree, _| {
4638 let worktree = worktree.as_remote_mut().unwrap();
4639 worktree.update_from_remote(envelope.payload);
4640 });
4641 }
4642 Ok(())
4643 })
4644 }
4645
4646 async fn handle_create_project_entry(
4647 this: ModelHandle<Self>,
4648 envelope: TypedEnvelope<proto::CreateProjectEntry>,
4649 _: Arc<Client>,
4650 mut cx: AsyncAppContext,
4651 ) -> Result<proto::ProjectEntryResponse> {
4652 let worktree = this.update(&mut cx, |this, cx| {
4653 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
4654 this.worktree_for_id(worktree_id, cx)
4655 .ok_or_else(|| anyhow!("worktree not found"))
4656 })?;
4657 let worktree_scan_id = worktree.read_with(&cx, |worktree, _| worktree.scan_id());
4658 let entry = worktree
4659 .update(&mut cx, |worktree, cx| {
4660 let worktree = worktree.as_local_mut().unwrap();
4661 let path = PathBuf::from(OsString::from_vec(envelope.payload.path));
4662 worktree.create_entry(path, envelope.payload.is_directory, cx)
4663 })
4664 .await?;
4665 Ok(proto::ProjectEntryResponse {
4666 entry: Some((&entry).into()),
4667 worktree_scan_id: worktree_scan_id as u64,
4668 })
4669 }
4670
4671 async fn handle_rename_project_entry(
4672 this: ModelHandle<Self>,
4673 envelope: TypedEnvelope<proto::RenameProjectEntry>,
4674 _: Arc<Client>,
4675 mut cx: AsyncAppContext,
4676 ) -> Result<proto::ProjectEntryResponse> {
4677 let entry_id = ProjectEntryId::from_proto(envelope.payload.entry_id);
4678 let worktree = this.read_with(&cx, |this, cx| {
4679 this.worktree_for_entry(entry_id, cx)
4680 .ok_or_else(|| anyhow!("worktree not found"))
4681 })?;
4682 let worktree_scan_id = worktree.read_with(&cx, |worktree, _| worktree.scan_id());
4683 let entry = worktree
4684 .update(&mut cx, |worktree, cx| {
4685 let new_path = PathBuf::from(OsString::from_vec(envelope.payload.new_path));
4686 worktree
4687 .as_local_mut()
4688 .unwrap()
4689 .rename_entry(entry_id, new_path, cx)
4690 .ok_or_else(|| anyhow!("invalid entry"))
4691 })?
4692 .await?;
4693 Ok(proto::ProjectEntryResponse {
4694 entry: Some((&entry).into()),
4695 worktree_scan_id: worktree_scan_id as u64,
4696 })
4697 }
4698
4699 async fn handle_copy_project_entry(
4700 this: ModelHandle<Self>,
4701 envelope: TypedEnvelope<proto::CopyProjectEntry>,
4702 _: Arc<Client>,
4703 mut cx: AsyncAppContext,
4704 ) -> Result<proto::ProjectEntryResponse> {
4705 let entry_id = ProjectEntryId::from_proto(envelope.payload.entry_id);
4706 let worktree = this.read_with(&cx, |this, cx| {
4707 this.worktree_for_entry(entry_id, cx)
4708 .ok_or_else(|| anyhow!("worktree not found"))
4709 })?;
4710 let worktree_scan_id = worktree.read_with(&cx, |worktree, _| worktree.scan_id());
4711 let entry = worktree
4712 .update(&mut cx, |worktree, cx| {
4713 let new_path = PathBuf::from(OsString::from_vec(envelope.payload.new_path));
4714 worktree
4715 .as_local_mut()
4716 .unwrap()
4717 .copy_entry(entry_id, new_path, cx)
4718 .ok_or_else(|| anyhow!("invalid entry"))
4719 })?
4720 .await?;
4721 Ok(proto::ProjectEntryResponse {
4722 entry: Some((&entry).into()),
4723 worktree_scan_id: worktree_scan_id as u64,
4724 })
4725 }
4726
4727 async fn handle_delete_project_entry(
4728 this: ModelHandle<Self>,
4729 envelope: TypedEnvelope<proto::DeleteProjectEntry>,
4730 _: Arc<Client>,
4731 mut cx: AsyncAppContext,
4732 ) -> Result<proto::ProjectEntryResponse> {
4733 let entry_id = ProjectEntryId::from_proto(envelope.payload.entry_id);
4734 let worktree = this.read_with(&cx, |this, cx| {
4735 this.worktree_for_entry(entry_id, cx)
4736 .ok_or_else(|| anyhow!("worktree not found"))
4737 })?;
4738 let worktree_scan_id = worktree.read_with(&cx, |worktree, _| worktree.scan_id());
4739 worktree
4740 .update(&mut cx, |worktree, cx| {
4741 worktree
4742 .as_local_mut()
4743 .unwrap()
4744 .delete_entry(entry_id, cx)
4745 .ok_or_else(|| anyhow!("invalid entry"))
4746 })?
4747 .await?;
4748 Ok(proto::ProjectEntryResponse {
4749 entry: None,
4750 worktree_scan_id: worktree_scan_id as u64,
4751 })
4752 }
4753
4754 async fn handle_update_diagnostic_summary(
4755 this: ModelHandle<Self>,
4756 envelope: TypedEnvelope<proto::UpdateDiagnosticSummary>,
4757 _: Arc<Client>,
4758 mut cx: AsyncAppContext,
4759 ) -> Result<()> {
4760 this.update(&mut cx, |this, cx| {
4761 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
4762 if let Some(worktree) = this.worktree_for_id(worktree_id, cx) {
4763 if let Some(summary) = envelope.payload.summary {
4764 let project_path = ProjectPath {
4765 worktree_id,
4766 path: Path::new(&summary.path).into(),
4767 };
4768 worktree.update(cx, |worktree, _| {
4769 worktree
4770 .as_remote_mut()
4771 .unwrap()
4772 .update_diagnostic_summary(project_path.path.clone(), &summary);
4773 });
4774 cx.emit(Event::DiagnosticsUpdated {
4775 language_server_id: summary.language_server_id as usize,
4776 path: project_path,
4777 });
4778 }
4779 }
4780 Ok(())
4781 })
4782 }
4783
4784 async fn handle_start_language_server(
4785 this: ModelHandle<Self>,
4786 envelope: TypedEnvelope<proto::StartLanguageServer>,
4787 _: Arc<Client>,
4788 mut cx: AsyncAppContext,
4789 ) -> Result<()> {
4790 let server = envelope
4791 .payload
4792 .server
4793 .ok_or_else(|| anyhow!("invalid server"))?;
4794 this.update(&mut cx, |this, cx| {
4795 this.language_server_statuses.insert(
4796 server.id as usize,
4797 LanguageServerStatus {
4798 name: server.name,
4799 pending_work: Default::default(),
4800 has_pending_diagnostic_updates: false,
4801 progress_tokens: Default::default(),
4802 },
4803 );
4804 cx.notify();
4805 });
4806 Ok(())
4807 }
4808
4809 async fn handle_update_language_server(
4810 this: ModelHandle<Self>,
4811 envelope: TypedEnvelope<proto::UpdateLanguageServer>,
4812 _: Arc<Client>,
4813 mut cx: AsyncAppContext,
4814 ) -> Result<()> {
4815 let language_server_id = envelope.payload.language_server_id as usize;
4816 match envelope
4817 .payload
4818 .variant
4819 .ok_or_else(|| anyhow!("invalid variant"))?
4820 {
4821 proto::update_language_server::Variant::WorkStart(payload) => {
4822 this.update(&mut cx, |this, cx| {
4823 this.on_lsp_work_start(
4824 language_server_id,
4825 payload.token,
4826 LanguageServerProgress {
4827 message: payload.message,
4828 percentage: payload.percentage.map(|p| p as usize),
4829 last_update_at: Instant::now(),
4830 },
4831 cx,
4832 );
4833 })
4834 }
4835 proto::update_language_server::Variant::WorkProgress(payload) => {
4836 this.update(&mut cx, |this, cx| {
4837 this.on_lsp_work_progress(
4838 language_server_id,
4839 payload.token,
4840 LanguageServerProgress {
4841 message: payload.message,
4842 percentage: payload.percentage.map(|p| p as usize),
4843 last_update_at: Instant::now(),
4844 },
4845 cx,
4846 );
4847 })
4848 }
4849 proto::update_language_server::Variant::WorkEnd(payload) => {
4850 this.update(&mut cx, |this, cx| {
4851 this.on_lsp_work_end(language_server_id, payload.token, cx);
4852 })
4853 }
4854 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdating(_) => {
4855 this.update(&mut cx, |this, cx| {
4856 this.disk_based_diagnostics_started(language_server_id, cx);
4857 })
4858 }
4859 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdated(_) => {
4860 this.update(&mut cx, |this, cx| {
4861 this.disk_based_diagnostics_finished(language_server_id, cx)
4862 });
4863 }
4864 }
4865
4866 Ok(())
4867 }
4868
4869 async fn handle_update_buffer(
4870 this: ModelHandle<Self>,
4871 envelope: TypedEnvelope<proto::UpdateBuffer>,
4872 _: Arc<Client>,
4873 mut cx: AsyncAppContext,
4874 ) -> Result<()> {
4875 this.update(&mut cx, |this, cx| {
4876 let payload = envelope.payload.clone();
4877 let buffer_id = payload.buffer_id;
4878 let ops = payload
4879 .operations
4880 .into_iter()
4881 .map(language::proto::deserialize_operation)
4882 .collect::<Result<Vec<_>, _>>()?;
4883 let is_remote = this.is_remote();
4884 match this.opened_buffers.entry(buffer_id) {
4885 hash_map::Entry::Occupied(mut e) => match e.get_mut() {
4886 OpenBuffer::Strong(buffer) => {
4887 buffer.update(cx, |buffer, cx| buffer.apply_ops(ops, cx))?;
4888 }
4889 OpenBuffer::Operations(operations) => operations.extend_from_slice(&ops),
4890 OpenBuffer::Weak(_) => {}
4891 },
4892 hash_map::Entry::Vacant(e) => {
4893 assert!(
4894 is_remote,
4895 "received buffer update from {:?}",
4896 envelope.original_sender_id
4897 );
4898 e.insert(OpenBuffer::Operations(ops));
4899 }
4900 }
4901 Ok(())
4902 })
4903 }
4904
4905 async fn handle_create_buffer_for_peer(
4906 this: ModelHandle<Self>,
4907 envelope: TypedEnvelope<proto::CreateBufferForPeer>,
4908 _: Arc<Client>,
4909 mut cx: AsyncAppContext,
4910 ) -> Result<()> {
4911 this.update(&mut cx, |this, cx| {
4912 match envelope
4913 .payload
4914 .variant
4915 .ok_or_else(|| anyhow!("missing variant"))?
4916 {
4917 proto::create_buffer_for_peer::Variant::State(mut state) => {
4918 let mut buffer_file = None;
4919 if let Some(file) = state.file.take() {
4920 let worktree_id = WorktreeId::from_proto(file.worktree_id);
4921 let worktree = this.worktree_for_id(worktree_id, cx).ok_or_else(|| {
4922 anyhow!("no worktree found for id {}", file.worktree_id)
4923 })?;
4924 buffer_file = Some(Arc::new(File::from_proto(file, worktree.clone(), cx)?)
4925 as Arc<dyn language::File>);
4926 }
4927
4928 let buffer_id = state.id;
4929 let buffer = cx.add_model(|_| {
4930 Buffer::from_proto(this.replica_id(), state, buffer_file).unwrap()
4931 });
4932 this.incomplete_buffers.insert(buffer_id, buffer);
4933 }
4934 proto::create_buffer_for_peer::Variant::Chunk(chunk) => {
4935 let buffer = this
4936 .incomplete_buffers
4937 .get(&chunk.buffer_id)
4938 .ok_or_else(|| {
4939 anyhow!(
4940 "received chunk for buffer {} without initial state",
4941 chunk.buffer_id
4942 )
4943 })?
4944 .clone();
4945 let operations = chunk
4946 .operations
4947 .into_iter()
4948 .map(language::proto::deserialize_operation)
4949 .collect::<Result<Vec<_>>>()?;
4950 buffer.update(cx, |buffer, cx| buffer.apply_ops(operations, cx))?;
4951
4952 if chunk.is_last {
4953 this.incomplete_buffers.remove(&chunk.buffer_id);
4954 this.register_buffer(&buffer, cx)?;
4955 }
4956 }
4957 }
4958
4959 Ok(())
4960 })
4961 }
4962
4963 async fn handle_update_diff_base(
4964 this: ModelHandle<Self>,
4965 envelope: TypedEnvelope<proto::UpdateDiffBase>,
4966 _: Arc<Client>,
4967 mut cx: AsyncAppContext,
4968 ) -> Result<()> {
4969 this.update(&mut cx, |this, cx| {
4970 let buffer_id = envelope.payload.buffer_id;
4971 let diff_base = envelope.payload.diff_base;
4972 let buffer = this
4973 .opened_buffers
4974 .get_mut(&buffer_id)
4975 .and_then(|b| b.upgrade(cx))
4976 .ok_or_else(|| anyhow!("No such buffer {}", buffer_id))?;
4977
4978 buffer.update(cx, |buffer, cx| buffer.set_diff_base(diff_base, cx));
4979
4980 Ok(())
4981 })
4982 }
4983
4984 async fn handle_update_buffer_file(
4985 this: ModelHandle<Self>,
4986 envelope: TypedEnvelope<proto::UpdateBufferFile>,
4987 _: Arc<Client>,
4988 mut cx: AsyncAppContext,
4989 ) -> Result<()> {
4990 this.update(&mut cx, |this, cx| {
4991 let payload = envelope.payload.clone();
4992 let buffer_id = payload.buffer_id;
4993 let file = payload.file.ok_or_else(|| anyhow!("invalid file"))?;
4994 let worktree = this
4995 .worktree_for_id(WorktreeId::from_proto(file.worktree_id), cx)
4996 .ok_or_else(|| anyhow!("no such worktree"))?;
4997 let file = File::from_proto(file, worktree, cx)?;
4998 let buffer = this
4999 .opened_buffers
5000 .get_mut(&buffer_id)
5001 .and_then(|b| b.upgrade(cx))
5002 .ok_or_else(|| anyhow!("no such buffer"))?;
5003 buffer.update(cx, |buffer, cx| {
5004 buffer.file_updated(Arc::new(file), cx).detach();
5005 });
5006 this.assign_language_to_buffer(&buffer, cx);
5007 Ok(())
5008 })
5009 }
5010
5011 async fn handle_save_buffer(
5012 this: ModelHandle<Self>,
5013 envelope: TypedEnvelope<proto::SaveBuffer>,
5014 _: Arc<Client>,
5015 mut cx: AsyncAppContext,
5016 ) -> Result<proto::BufferSaved> {
5017 let buffer_id = envelope.payload.buffer_id;
5018 let requested_version = deserialize_version(envelope.payload.version);
5019
5020 let (project_id, buffer) = this.update(&mut cx, |this, cx| {
5021 let project_id = this.remote_id().ok_or_else(|| anyhow!("not connected"))?;
5022 let buffer = this
5023 .opened_buffers
5024 .get(&buffer_id)
5025 .and_then(|buffer| buffer.upgrade(cx))
5026 .ok_or_else(|| anyhow!("unknown buffer id {}", buffer_id))?;
5027 Ok::<_, anyhow::Error>((project_id, buffer))
5028 })?;
5029 buffer
5030 .update(&mut cx, |buffer, _| {
5031 buffer.wait_for_version(requested_version)
5032 })
5033 .await;
5034
5035 let (saved_version, fingerprint, mtime) =
5036 buffer.update(&mut cx, |buffer, cx| buffer.save(cx)).await?;
5037 Ok(proto::BufferSaved {
5038 project_id,
5039 buffer_id,
5040 version: serialize_version(&saved_version),
5041 mtime: Some(mtime.into()),
5042 fingerprint,
5043 })
5044 }
5045
5046 async fn handle_reload_buffers(
5047 this: ModelHandle<Self>,
5048 envelope: TypedEnvelope<proto::ReloadBuffers>,
5049 _: Arc<Client>,
5050 mut cx: AsyncAppContext,
5051 ) -> Result<proto::ReloadBuffersResponse> {
5052 let sender_id = envelope.original_sender_id()?;
5053 let reload = this.update(&mut cx, |this, cx| {
5054 let mut buffers = HashSet::default();
5055 for buffer_id in &envelope.payload.buffer_ids {
5056 buffers.insert(
5057 this.opened_buffers
5058 .get(buffer_id)
5059 .and_then(|buffer| buffer.upgrade(cx))
5060 .ok_or_else(|| anyhow!("unknown buffer id {}", buffer_id))?,
5061 );
5062 }
5063 Ok::<_, anyhow::Error>(this.reload_buffers(buffers, false, cx))
5064 })?;
5065
5066 let project_transaction = reload.await?;
5067 let project_transaction = this.update(&mut cx, |this, cx| {
5068 this.serialize_project_transaction_for_peer(project_transaction, sender_id, cx)
5069 });
5070 Ok(proto::ReloadBuffersResponse {
5071 transaction: Some(project_transaction),
5072 })
5073 }
5074
5075 async fn handle_format_buffers(
5076 this: ModelHandle<Self>,
5077 envelope: TypedEnvelope<proto::FormatBuffers>,
5078 _: Arc<Client>,
5079 mut cx: AsyncAppContext,
5080 ) -> Result<proto::FormatBuffersResponse> {
5081 let sender_id = envelope.original_sender_id()?;
5082 let format = this.update(&mut cx, |this, cx| {
5083 let mut buffers = HashSet::default();
5084 for buffer_id in &envelope.payload.buffer_ids {
5085 buffers.insert(
5086 this.opened_buffers
5087 .get(buffer_id)
5088 .and_then(|buffer| buffer.upgrade(cx))
5089 .ok_or_else(|| anyhow!("unknown buffer id {}", buffer_id))?,
5090 );
5091 }
5092 let trigger = FormatTrigger::from_proto(envelope.payload.trigger);
5093 Ok::<_, anyhow::Error>(this.format(buffers, false, trigger, cx))
5094 })?;
5095
5096 let project_transaction = format.await?;
5097 let project_transaction = this.update(&mut cx, |this, cx| {
5098 this.serialize_project_transaction_for_peer(project_transaction, sender_id, cx)
5099 });
5100 Ok(proto::FormatBuffersResponse {
5101 transaction: Some(project_transaction),
5102 })
5103 }
5104
5105 async fn handle_get_completions(
5106 this: ModelHandle<Self>,
5107 envelope: TypedEnvelope<proto::GetCompletions>,
5108 _: Arc<Client>,
5109 mut cx: AsyncAppContext,
5110 ) -> Result<proto::GetCompletionsResponse> {
5111 let position = envelope
5112 .payload
5113 .position
5114 .and_then(language::proto::deserialize_anchor)
5115 .ok_or_else(|| anyhow!("invalid position"))?;
5116 let version = deserialize_version(envelope.payload.version);
5117 let buffer = this.read_with(&cx, |this, cx| {
5118 this.opened_buffers
5119 .get(&envelope.payload.buffer_id)
5120 .and_then(|buffer| buffer.upgrade(cx))
5121 .ok_or_else(|| anyhow!("unknown buffer id {}", envelope.payload.buffer_id))
5122 })?;
5123 buffer
5124 .update(&mut cx, |buffer, _| buffer.wait_for_version(version))
5125 .await;
5126 let version = buffer.read_with(&cx, |buffer, _| buffer.version());
5127 let completions = this
5128 .update(&mut cx, |this, cx| this.completions(&buffer, position, cx))
5129 .await?;
5130
5131 Ok(proto::GetCompletionsResponse {
5132 completions: completions
5133 .iter()
5134 .map(language::proto::serialize_completion)
5135 .collect(),
5136 version: serialize_version(&version),
5137 })
5138 }
5139
5140 async fn handle_apply_additional_edits_for_completion(
5141 this: ModelHandle<Self>,
5142 envelope: TypedEnvelope<proto::ApplyCompletionAdditionalEdits>,
5143 _: Arc<Client>,
5144 mut cx: AsyncAppContext,
5145 ) -> Result<proto::ApplyCompletionAdditionalEditsResponse> {
5146 let (buffer, completion) = this.update(&mut cx, |this, cx| {
5147 let buffer = this
5148 .opened_buffers
5149 .get(&envelope.payload.buffer_id)
5150 .and_then(|buffer| buffer.upgrade(cx))
5151 .ok_or_else(|| anyhow!("unknown buffer id {}", envelope.payload.buffer_id))?;
5152 let language = buffer.read(cx).language();
5153 let completion = language::proto::deserialize_completion(
5154 envelope
5155 .payload
5156 .completion
5157 .ok_or_else(|| anyhow!("invalid completion"))?,
5158 language.cloned(),
5159 );
5160 Ok::<_, anyhow::Error>((buffer, completion))
5161 })?;
5162
5163 let completion = completion.await?;
5164
5165 let apply_additional_edits = this.update(&mut cx, |this, cx| {
5166 this.apply_additional_edits_for_completion(buffer, completion, false, cx)
5167 });
5168
5169 Ok(proto::ApplyCompletionAdditionalEditsResponse {
5170 transaction: apply_additional_edits
5171 .await?
5172 .as_ref()
5173 .map(language::proto::serialize_transaction),
5174 })
5175 }
5176
5177 async fn handle_get_code_actions(
5178 this: ModelHandle<Self>,
5179 envelope: TypedEnvelope<proto::GetCodeActions>,
5180 _: Arc<Client>,
5181 mut cx: AsyncAppContext,
5182 ) -> Result<proto::GetCodeActionsResponse> {
5183 let start = envelope
5184 .payload
5185 .start
5186 .and_then(language::proto::deserialize_anchor)
5187 .ok_or_else(|| anyhow!("invalid start"))?;
5188 let end = envelope
5189 .payload
5190 .end
5191 .and_then(language::proto::deserialize_anchor)
5192 .ok_or_else(|| anyhow!("invalid end"))?;
5193 let buffer = this.update(&mut cx, |this, cx| {
5194 this.opened_buffers
5195 .get(&envelope.payload.buffer_id)
5196 .and_then(|buffer| buffer.upgrade(cx))
5197 .ok_or_else(|| anyhow!("unknown buffer id {}", envelope.payload.buffer_id))
5198 })?;
5199 buffer
5200 .update(&mut cx, |buffer, _| {
5201 buffer.wait_for_version(deserialize_version(envelope.payload.version))
5202 })
5203 .await;
5204
5205 let version = buffer.read_with(&cx, |buffer, _| buffer.version());
5206 let code_actions = this.update(&mut cx, |this, cx| {
5207 Ok::<_, anyhow::Error>(this.code_actions(&buffer, start..end, cx))
5208 })?;
5209
5210 Ok(proto::GetCodeActionsResponse {
5211 actions: code_actions
5212 .await?
5213 .iter()
5214 .map(language::proto::serialize_code_action)
5215 .collect(),
5216 version: serialize_version(&version),
5217 })
5218 }
5219
5220 async fn handle_apply_code_action(
5221 this: ModelHandle<Self>,
5222 envelope: TypedEnvelope<proto::ApplyCodeAction>,
5223 _: Arc<Client>,
5224 mut cx: AsyncAppContext,
5225 ) -> Result<proto::ApplyCodeActionResponse> {
5226 let sender_id = envelope.original_sender_id()?;
5227 let action = language::proto::deserialize_code_action(
5228 envelope
5229 .payload
5230 .action
5231 .ok_or_else(|| anyhow!("invalid action"))?,
5232 )?;
5233 let apply_code_action = this.update(&mut cx, |this, cx| {
5234 let buffer = this
5235 .opened_buffers
5236 .get(&envelope.payload.buffer_id)
5237 .and_then(|buffer| buffer.upgrade(cx))
5238 .ok_or_else(|| anyhow!("unknown buffer id {}", envelope.payload.buffer_id))?;
5239 Ok::<_, anyhow::Error>(this.apply_code_action(buffer, action, false, cx))
5240 })?;
5241
5242 let project_transaction = apply_code_action.await?;
5243 let project_transaction = this.update(&mut cx, |this, cx| {
5244 this.serialize_project_transaction_for_peer(project_transaction, sender_id, cx)
5245 });
5246 Ok(proto::ApplyCodeActionResponse {
5247 transaction: Some(project_transaction),
5248 })
5249 }
5250
5251 async fn handle_lsp_command<T: LspCommand>(
5252 this: ModelHandle<Self>,
5253 envelope: TypedEnvelope<T::ProtoRequest>,
5254 _: Arc<Client>,
5255 mut cx: AsyncAppContext,
5256 ) -> Result<<T::ProtoRequest as proto::RequestMessage>::Response>
5257 where
5258 <T::LspRequest as lsp::request::Request>::Result: Send,
5259 {
5260 let sender_id = envelope.original_sender_id()?;
5261 let buffer_id = T::buffer_id_from_proto(&envelope.payload);
5262 let buffer_handle = this.read_with(&cx, |this, _| {
5263 this.opened_buffers
5264 .get(&buffer_id)
5265 .and_then(|buffer| buffer.upgrade(&cx))
5266 .ok_or_else(|| anyhow!("unknown buffer id {}", buffer_id))
5267 })?;
5268 let request = T::from_proto(
5269 envelope.payload,
5270 this.clone(),
5271 buffer_handle.clone(),
5272 cx.clone(),
5273 )
5274 .await?;
5275 let buffer_version = buffer_handle.read_with(&cx, |buffer, _| buffer.version());
5276 let response = this
5277 .update(&mut cx, |this, cx| {
5278 this.request_lsp(buffer_handle, request, cx)
5279 })
5280 .await?;
5281 this.update(&mut cx, |this, cx| {
5282 Ok(T::response_to_proto(
5283 response,
5284 this,
5285 sender_id,
5286 &buffer_version,
5287 cx,
5288 ))
5289 })
5290 }
5291
5292 async fn handle_get_project_symbols(
5293 this: ModelHandle<Self>,
5294 envelope: TypedEnvelope<proto::GetProjectSymbols>,
5295 _: Arc<Client>,
5296 mut cx: AsyncAppContext,
5297 ) -> Result<proto::GetProjectSymbolsResponse> {
5298 let symbols = this
5299 .update(&mut cx, |this, cx| {
5300 this.symbols(&envelope.payload.query, cx)
5301 })
5302 .await?;
5303
5304 Ok(proto::GetProjectSymbolsResponse {
5305 symbols: symbols.iter().map(serialize_symbol).collect(),
5306 })
5307 }
5308
5309 async fn handle_search_project(
5310 this: ModelHandle<Self>,
5311 envelope: TypedEnvelope<proto::SearchProject>,
5312 _: Arc<Client>,
5313 mut cx: AsyncAppContext,
5314 ) -> Result<proto::SearchProjectResponse> {
5315 let peer_id = envelope.original_sender_id()?;
5316 let query = SearchQuery::from_proto(envelope.payload)?;
5317 let result = this
5318 .update(&mut cx, |this, cx| this.search(query, cx))
5319 .await?;
5320
5321 this.update(&mut cx, |this, cx| {
5322 let mut locations = Vec::new();
5323 for (buffer, ranges) in result {
5324 for range in ranges {
5325 let start = serialize_anchor(&range.start);
5326 let end = serialize_anchor(&range.end);
5327 let buffer_id = this.create_buffer_for_peer(&buffer, peer_id, cx);
5328 locations.push(proto::Location {
5329 buffer_id,
5330 start: Some(start),
5331 end: Some(end),
5332 });
5333 }
5334 }
5335 Ok(proto::SearchProjectResponse { locations })
5336 })
5337 }
5338
5339 async fn handle_open_buffer_for_symbol(
5340 this: ModelHandle<Self>,
5341 envelope: TypedEnvelope<proto::OpenBufferForSymbol>,
5342 _: Arc<Client>,
5343 mut cx: AsyncAppContext,
5344 ) -> Result<proto::OpenBufferForSymbolResponse> {
5345 let peer_id = envelope.original_sender_id()?;
5346 let symbol = envelope
5347 .payload
5348 .symbol
5349 .ok_or_else(|| anyhow!("invalid symbol"))?;
5350 let symbol = this
5351 .read_with(&cx, |this, _| this.deserialize_symbol(symbol))
5352 .await?;
5353 let symbol = this.read_with(&cx, |this, _| {
5354 let signature = this.symbol_signature(&symbol.path);
5355 if signature == symbol.signature {
5356 Ok(symbol)
5357 } else {
5358 Err(anyhow!("invalid symbol signature"))
5359 }
5360 })?;
5361 let buffer = this
5362 .update(&mut cx, |this, cx| this.open_buffer_for_symbol(&symbol, cx))
5363 .await?;
5364
5365 Ok(proto::OpenBufferForSymbolResponse {
5366 buffer_id: this.update(&mut cx, |this, cx| {
5367 this.create_buffer_for_peer(&buffer, peer_id, cx)
5368 }),
5369 })
5370 }
5371
5372 fn symbol_signature(&self, project_path: &ProjectPath) -> [u8; 32] {
5373 let mut hasher = Sha256::new();
5374 hasher.update(project_path.worktree_id.to_proto().to_be_bytes());
5375 hasher.update(project_path.path.to_string_lossy().as_bytes());
5376 hasher.update(self.nonce.to_be_bytes());
5377 hasher.finalize().as_slice().try_into().unwrap()
5378 }
5379
5380 async fn handle_open_buffer_by_id(
5381 this: ModelHandle<Self>,
5382 envelope: TypedEnvelope<proto::OpenBufferById>,
5383 _: Arc<Client>,
5384 mut cx: AsyncAppContext,
5385 ) -> Result<proto::OpenBufferResponse> {
5386 let peer_id = envelope.original_sender_id()?;
5387 let buffer = this
5388 .update(&mut cx, |this, cx| {
5389 this.open_buffer_by_id(envelope.payload.id, cx)
5390 })
5391 .await?;
5392 this.update(&mut cx, |this, cx| {
5393 Ok(proto::OpenBufferResponse {
5394 buffer_id: this.create_buffer_for_peer(&buffer, peer_id, cx),
5395 })
5396 })
5397 }
5398
5399 async fn handle_open_buffer_by_path(
5400 this: ModelHandle<Self>,
5401 envelope: TypedEnvelope<proto::OpenBufferByPath>,
5402 _: Arc<Client>,
5403 mut cx: AsyncAppContext,
5404 ) -> Result<proto::OpenBufferResponse> {
5405 let peer_id = envelope.original_sender_id()?;
5406 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
5407 let open_buffer = this.update(&mut cx, |this, cx| {
5408 this.open_buffer(
5409 ProjectPath {
5410 worktree_id,
5411 path: PathBuf::from(envelope.payload.path).into(),
5412 },
5413 cx,
5414 )
5415 });
5416
5417 let buffer = open_buffer.await?;
5418 this.update(&mut cx, |this, cx| {
5419 Ok(proto::OpenBufferResponse {
5420 buffer_id: this.create_buffer_for_peer(&buffer, peer_id, cx),
5421 })
5422 })
5423 }
5424
5425 fn serialize_project_transaction_for_peer(
5426 &mut self,
5427 project_transaction: ProjectTransaction,
5428 peer_id: PeerId,
5429 cx: &AppContext,
5430 ) -> proto::ProjectTransaction {
5431 let mut serialized_transaction = proto::ProjectTransaction {
5432 buffer_ids: Default::default(),
5433 transactions: Default::default(),
5434 };
5435 for (buffer, transaction) in project_transaction.0 {
5436 serialized_transaction
5437 .buffer_ids
5438 .push(self.create_buffer_for_peer(&buffer, peer_id, cx));
5439 serialized_transaction
5440 .transactions
5441 .push(language::proto::serialize_transaction(&transaction));
5442 }
5443 serialized_transaction
5444 }
5445
5446 fn deserialize_project_transaction(
5447 &mut self,
5448 message: proto::ProjectTransaction,
5449 push_to_history: bool,
5450 cx: &mut ModelContext<Self>,
5451 ) -> Task<Result<ProjectTransaction>> {
5452 cx.spawn(|this, mut cx| async move {
5453 let mut project_transaction = ProjectTransaction::default();
5454 for (buffer_id, transaction) in message.buffer_ids.into_iter().zip(message.transactions)
5455 {
5456 let buffer = this
5457 .update(&mut cx, |this, cx| this.wait_for_buffer(buffer_id, cx))
5458 .await?;
5459 let transaction = language::proto::deserialize_transaction(transaction)?;
5460 project_transaction.0.insert(buffer, transaction);
5461 }
5462
5463 for (buffer, transaction) in &project_transaction.0 {
5464 buffer
5465 .update(&mut cx, |buffer, _| {
5466 buffer.wait_for_edits(transaction.edit_ids.iter().copied())
5467 })
5468 .await;
5469
5470 if push_to_history {
5471 buffer.update(&mut cx, |buffer, _| {
5472 buffer.push_transaction(transaction.clone(), Instant::now());
5473 });
5474 }
5475 }
5476
5477 Ok(project_transaction)
5478 })
5479 }
5480
5481 fn create_buffer_for_peer(
5482 &mut self,
5483 buffer: &ModelHandle<Buffer>,
5484 peer_id: PeerId,
5485 cx: &AppContext,
5486 ) -> u64 {
5487 let buffer_id = buffer.read(cx).remote_id();
5488 if let Some(project_id) = self.remote_id() {
5489 let shared_buffers = self.shared_buffers.entry(peer_id).or_default();
5490 if shared_buffers.insert(buffer_id) {
5491 let buffer = buffer.read(cx);
5492 let state = buffer.to_proto();
5493 let operations = buffer.serialize_ops(cx);
5494 let client = self.client.clone();
5495 cx.background()
5496 .spawn(
5497 async move {
5498 let mut operations = operations.await;
5499
5500 client.send(proto::CreateBufferForPeer {
5501 project_id,
5502 peer_id: peer_id.0,
5503 variant: Some(proto::create_buffer_for_peer::Variant::State(state)),
5504 })?;
5505
5506 loop {
5507 #[cfg(any(test, feature = "test-support"))]
5508 const CHUNK_SIZE: usize = 5;
5509
5510 #[cfg(not(any(test, feature = "test-support")))]
5511 const CHUNK_SIZE: usize = 100;
5512
5513 let chunk = operations
5514 .drain(..cmp::min(CHUNK_SIZE, operations.len()))
5515 .collect();
5516 let is_last = operations.is_empty();
5517 client.send(proto::CreateBufferForPeer {
5518 project_id,
5519 peer_id: peer_id.0,
5520 variant: Some(proto::create_buffer_for_peer::Variant::Chunk(
5521 proto::BufferChunk {
5522 buffer_id,
5523 operations: chunk,
5524 is_last,
5525 },
5526 )),
5527 })?;
5528
5529 if is_last {
5530 break;
5531 }
5532 }
5533
5534 Ok(())
5535 }
5536 .log_err(),
5537 )
5538 .detach();
5539 }
5540 }
5541
5542 buffer_id
5543 }
5544
5545 fn wait_for_buffer(
5546 &self,
5547 id: u64,
5548 cx: &mut ModelContext<Self>,
5549 ) -> Task<Result<ModelHandle<Buffer>>> {
5550 let mut opened_buffer_rx = self.opened_buffer.1.clone();
5551 cx.spawn(|this, mut cx| async move {
5552 let buffer = loop {
5553 let buffer = this.read_with(&cx, |this, cx| {
5554 this.opened_buffers
5555 .get(&id)
5556 .and_then(|buffer| buffer.upgrade(cx))
5557 });
5558 if let Some(buffer) = buffer {
5559 break buffer;
5560 } else if this.read_with(&cx, |this, _| this.is_read_only()) {
5561 return Err(anyhow!("disconnected before buffer {} could be opened", id));
5562 }
5563
5564 opened_buffer_rx
5565 .next()
5566 .await
5567 .ok_or_else(|| anyhow!("project dropped while waiting for buffer"))?;
5568 };
5569 buffer.update(&mut cx, |buffer, cx| buffer.git_diff_recalc(cx));
5570 Ok(buffer)
5571 })
5572 }
5573
5574 fn deserialize_symbol(
5575 &self,
5576 serialized_symbol: proto::Symbol,
5577 ) -> impl Future<Output = Result<Symbol>> {
5578 let languages = self.languages.clone();
5579 async move {
5580 let source_worktree_id = WorktreeId::from_proto(serialized_symbol.source_worktree_id);
5581 let worktree_id = WorktreeId::from_proto(serialized_symbol.worktree_id);
5582 let start = serialized_symbol
5583 .start
5584 .ok_or_else(|| anyhow!("invalid start"))?;
5585 let end = serialized_symbol
5586 .end
5587 .ok_or_else(|| anyhow!("invalid end"))?;
5588 let kind = unsafe { mem::transmute(serialized_symbol.kind) };
5589 let path = ProjectPath {
5590 worktree_id,
5591 path: PathBuf::from(serialized_symbol.path).into(),
5592 };
5593 let language = languages.select_language(&path.path);
5594 Ok(Symbol {
5595 language_server_name: LanguageServerName(
5596 serialized_symbol.language_server_name.into(),
5597 ),
5598 source_worktree_id,
5599 path,
5600 label: {
5601 match language {
5602 Some(language) => {
5603 language
5604 .label_for_symbol(&serialized_symbol.name, kind)
5605 .await
5606 }
5607 None => None,
5608 }
5609 .unwrap_or_else(|| CodeLabel::plain(serialized_symbol.name.clone(), None))
5610 },
5611
5612 name: serialized_symbol.name,
5613 range: PointUtf16::new(start.row, start.column)
5614 ..PointUtf16::new(end.row, end.column),
5615 kind,
5616 signature: serialized_symbol
5617 .signature
5618 .try_into()
5619 .map_err(|_| anyhow!("invalid signature"))?,
5620 })
5621 }
5622 }
5623
5624 async fn handle_buffer_saved(
5625 this: ModelHandle<Self>,
5626 envelope: TypedEnvelope<proto::BufferSaved>,
5627 _: Arc<Client>,
5628 mut cx: AsyncAppContext,
5629 ) -> Result<()> {
5630 let version = deserialize_version(envelope.payload.version);
5631 let mtime = envelope
5632 .payload
5633 .mtime
5634 .ok_or_else(|| anyhow!("missing mtime"))?
5635 .into();
5636
5637 this.update(&mut cx, |this, cx| {
5638 let buffer = this
5639 .opened_buffers
5640 .get(&envelope.payload.buffer_id)
5641 .and_then(|buffer| buffer.upgrade(cx));
5642 if let Some(buffer) = buffer {
5643 buffer.update(cx, |buffer, cx| {
5644 buffer.did_save(version, envelope.payload.fingerprint, mtime, None, cx);
5645 });
5646 }
5647 Ok(())
5648 })
5649 }
5650
5651 async fn handle_buffer_reloaded(
5652 this: ModelHandle<Self>,
5653 envelope: TypedEnvelope<proto::BufferReloaded>,
5654 _: Arc<Client>,
5655 mut cx: AsyncAppContext,
5656 ) -> Result<()> {
5657 let payload = envelope.payload;
5658 let version = deserialize_version(payload.version);
5659 let line_ending = deserialize_line_ending(
5660 proto::LineEnding::from_i32(payload.line_ending)
5661 .ok_or_else(|| anyhow!("missing line ending"))?,
5662 );
5663 let mtime = payload
5664 .mtime
5665 .ok_or_else(|| anyhow!("missing mtime"))?
5666 .into();
5667 this.update(&mut cx, |this, cx| {
5668 let buffer = this
5669 .opened_buffers
5670 .get(&payload.buffer_id)
5671 .and_then(|buffer| buffer.upgrade(cx));
5672 if let Some(buffer) = buffer {
5673 buffer.update(cx, |buffer, cx| {
5674 buffer.did_reload(version, payload.fingerprint, line_ending, mtime, cx);
5675 });
5676 }
5677 Ok(())
5678 })
5679 }
5680
5681 #[allow(clippy::type_complexity)]
5682 fn edits_from_lsp(
5683 &mut self,
5684 buffer: &ModelHandle<Buffer>,
5685 lsp_edits: impl 'static + Send + IntoIterator<Item = lsp::TextEdit>,
5686 version: Option<i32>,
5687 cx: &mut ModelContext<Self>,
5688 ) -> Task<Result<Vec<(Range<Anchor>, String)>>> {
5689 let snapshot = self.buffer_snapshot_for_lsp_version(buffer, version, cx);
5690 cx.background().spawn(async move {
5691 let snapshot = snapshot?;
5692 let mut lsp_edits = lsp_edits
5693 .into_iter()
5694 .map(|edit| (range_from_lsp(edit.range), edit.new_text))
5695 .collect::<Vec<_>>();
5696 lsp_edits.sort_by_key(|(range, _)| range.start);
5697
5698 let mut lsp_edits = lsp_edits.into_iter().peekable();
5699 let mut edits = Vec::new();
5700 while let Some((mut range, mut new_text)) = lsp_edits.next() {
5701 // Clip invalid ranges provided by the language server.
5702 range.start = snapshot.clip_point_utf16(range.start, Bias::Left);
5703 range.end = snapshot.clip_point_utf16(range.end, Bias::Left);
5704
5705 // Combine any LSP edits that are adjacent.
5706 //
5707 // Also, combine LSP edits that are separated from each other by only
5708 // a newline. This is important because for some code actions,
5709 // Rust-analyzer rewrites the entire buffer via a series of edits that
5710 // are separated by unchanged newline characters.
5711 //
5712 // In order for the diffing logic below to work properly, any edits that
5713 // cancel each other out must be combined into one.
5714 while let Some((next_range, next_text)) = lsp_edits.peek() {
5715 if next_range.start > range.end {
5716 if next_range.start.row > range.end.row + 1
5717 || next_range.start.column > 0
5718 || snapshot.clip_point_utf16(
5719 PointUtf16::new(range.end.row, u32::MAX),
5720 Bias::Left,
5721 ) > range.end
5722 {
5723 break;
5724 }
5725 new_text.push('\n');
5726 }
5727 range.end = next_range.end;
5728 new_text.push_str(next_text);
5729 lsp_edits.next();
5730 }
5731
5732 // For multiline edits, perform a diff of the old and new text so that
5733 // we can identify the changes more precisely, preserving the locations
5734 // of any anchors positioned in the unchanged regions.
5735 if range.end.row > range.start.row {
5736 let mut offset = range.start.to_offset(&snapshot);
5737 let old_text = snapshot.text_for_range(range).collect::<String>();
5738
5739 let diff = TextDiff::from_lines(old_text.as_str(), &new_text);
5740 let mut moved_since_edit = true;
5741 for change in diff.iter_all_changes() {
5742 let tag = change.tag();
5743 let value = change.value();
5744 match tag {
5745 ChangeTag::Equal => {
5746 offset += value.len();
5747 moved_since_edit = true;
5748 }
5749 ChangeTag::Delete => {
5750 let start = snapshot.anchor_after(offset);
5751 let end = snapshot.anchor_before(offset + value.len());
5752 if moved_since_edit {
5753 edits.push((start..end, String::new()));
5754 } else {
5755 edits.last_mut().unwrap().0.end = end;
5756 }
5757 offset += value.len();
5758 moved_since_edit = false;
5759 }
5760 ChangeTag::Insert => {
5761 if moved_since_edit {
5762 let anchor = snapshot.anchor_after(offset);
5763 edits.push((anchor..anchor, value.to_string()));
5764 } else {
5765 edits.last_mut().unwrap().1.push_str(value);
5766 }
5767 moved_since_edit = false;
5768 }
5769 }
5770 }
5771 } else if range.end == range.start {
5772 let anchor = snapshot.anchor_after(range.start);
5773 edits.push((anchor..anchor, new_text));
5774 } else {
5775 let edit_start = snapshot.anchor_after(range.start);
5776 let edit_end = snapshot.anchor_before(range.end);
5777 edits.push((edit_start..edit_end, new_text));
5778 }
5779 }
5780
5781 Ok(edits)
5782 })
5783 }
5784
5785 fn buffer_snapshot_for_lsp_version(
5786 &mut self,
5787 buffer: &ModelHandle<Buffer>,
5788 version: Option<i32>,
5789 cx: &AppContext,
5790 ) -> Result<TextBufferSnapshot> {
5791 const OLD_VERSIONS_TO_RETAIN: i32 = 10;
5792
5793 if let Some(version) = version {
5794 let buffer_id = buffer.read(cx).remote_id();
5795 let snapshots = self
5796 .buffer_snapshots
5797 .get_mut(&buffer_id)
5798 .ok_or_else(|| anyhow!("no snapshot found for buffer {}", buffer_id))?;
5799 let mut found_snapshot = None;
5800 snapshots.retain(|(snapshot_version, snapshot)| {
5801 if snapshot_version + OLD_VERSIONS_TO_RETAIN < version {
5802 false
5803 } else {
5804 if *snapshot_version == version {
5805 found_snapshot = Some(snapshot.clone());
5806 }
5807 true
5808 }
5809 });
5810
5811 found_snapshot.ok_or_else(|| {
5812 anyhow!(
5813 "snapshot not found for buffer {} at version {}",
5814 buffer_id,
5815 version
5816 )
5817 })
5818 } else {
5819 Ok((buffer.read(cx)).text_snapshot())
5820 }
5821 }
5822
5823 fn language_server_for_buffer(
5824 &self,
5825 buffer: &Buffer,
5826 cx: &AppContext,
5827 ) -> Option<(&Arc<CachedLspAdapter>, &Arc<LanguageServer>)> {
5828 if let Some((file, language)) = File::from_dyn(buffer.file()).zip(buffer.language()) {
5829 let name = language.lsp_adapter()?.name.clone();
5830 let worktree_id = file.worktree_id(cx);
5831 let key = (worktree_id, name);
5832
5833 if let Some(server_id) = self.language_server_ids.get(&key) {
5834 if let Some(LanguageServerState::Running {
5835 adapter, server, ..
5836 }) = self.language_servers.get(server_id)
5837 {
5838 return Some((adapter, server));
5839 }
5840 }
5841 }
5842
5843 None
5844 }
5845}
5846
5847impl ProjectStore {
5848 pub fn new() -> Self {
5849 Self {
5850 projects: Default::default(),
5851 }
5852 }
5853
5854 pub fn projects<'a>(
5855 &'a self,
5856 cx: &'a AppContext,
5857 ) -> impl 'a + Iterator<Item = ModelHandle<Project>> {
5858 self.projects
5859 .iter()
5860 .filter_map(|project| project.upgrade(cx))
5861 }
5862
5863 fn add_project(&mut self, project: WeakModelHandle<Project>, cx: &mut ModelContext<Self>) {
5864 if let Err(ix) = self
5865 .projects
5866 .binary_search_by_key(&project.id(), WeakModelHandle::id)
5867 {
5868 self.projects.insert(ix, project);
5869 }
5870 cx.notify();
5871 }
5872
5873 fn prune_projects(&mut self, cx: &mut ModelContext<Self>) {
5874 let mut did_change = false;
5875 self.projects.retain(|project| {
5876 if project.is_upgradable(cx) {
5877 true
5878 } else {
5879 did_change = true;
5880 false
5881 }
5882 });
5883 if did_change {
5884 cx.notify();
5885 }
5886 }
5887}
5888
5889impl WorktreeHandle {
5890 pub fn upgrade(&self, cx: &AppContext) -> Option<ModelHandle<Worktree>> {
5891 match self {
5892 WorktreeHandle::Strong(handle) => Some(handle.clone()),
5893 WorktreeHandle::Weak(handle) => handle.upgrade(cx),
5894 }
5895 }
5896}
5897
5898impl OpenBuffer {
5899 pub fn upgrade(&self, cx: &impl UpgradeModelHandle) -> Option<ModelHandle<Buffer>> {
5900 match self {
5901 OpenBuffer::Strong(handle) => Some(handle.clone()),
5902 OpenBuffer::Weak(handle) => handle.upgrade(cx),
5903 OpenBuffer::Operations(_) => None,
5904 }
5905 }
5906}
5907
5908pub struct PathMatchCandidateSet {
5909 pub snapshot: Snapshot,
5910 pub include_ignored: bool,
5911 pub include_root_name: bool,
5912}
5913
5914impl<'a> fuzzy::PathMatchCandidateSet<'a> for PathMatchCandidateSet {
5915 type Candidates = PathMatchCandidateSetIter<'a>;
5916
5917 fn id(&self) -> usize {
5918 self.snapshot.id().to_usize()
5919 }
5920
5921 fn len(&self) -> usize {
5922 if self.include_ignored {
5923 self.snapshot.file_count()
5924 } else {
5925 self.snapshot.visible_file_count()
5926 }
5927 }
5928
5929 fn prefix(&self) -> Arc<str> {
5930 if self.snapshot.root_entry().map_or(false, |e| e.is_file()) {
5931 self.snapshot.root_name().into()
5932 } else if self.include_root_name {
5933 format!("{}/", self.snapshot.root_name()).into()
5934 } else {
5935 "".into()
5936 }
5937 }
5938
5939 fn candidates(&'a self, start: usize) -> Self::Candidates {
5940 PathMatchCandidateSetIter {
5941 traversal: self.snapshot.files(self.include_ignored, start),
5942 }
5943 }
5944}
5945
5946pub struct PathMatchCandidateSetIter<'a> {
5947 traversal: Traversal<'a>,
5948}
5949
5950impl<'a> Iterator for PathMatchCandidateSetIter<'a> {
5951 type Item = fuzzy::PathMatchCandidate<'a>;
5952
5953 fn next(&mut self) -> Option<Self::Item> {
5954 self.traversal.next().map(|entry| {
5955 if let EntryKind::File(char_bag) = entry.kind {
5956 fuzzy::PathMatchCandidate {
5957 path: &entry.path,
5958 char_bag,
5959 }
5960 } else {
5961 unreachable!()
5962 }
5963 })
5964 }
5965}
5966
5967impl Entity for ProjectStore {
5968 type Event = ();
5969}
5970
5971impl Entity for Project {
5972 type Event = Event;
5973
5974 fn release(&mut self, cx: &mut gpui::MutableAppContext) {
5975 self.project_store.update(cx, ProjectStore::prune_projects);
5976
5977 match &self.client_state {
5978 Some(ProjectClientState::Local { remote_id, .. }) => {
5979 self.client
5980 .send(proto::UnshareProject {
5981 project_id: *remote_id,
5982 })
5983 .log_err();
5984 }
5985 Some(ProjectClientState::Remote { remote_id, .. }) => {
5986 self.client
5987 .send(proto::LeaveProject {
5988 project_id: *remote_id,
5989 })
5990 .log_err();
5991 }
5992 _ => {}
5993 }
5994 }
5995
5996 fn app_will_quit(
5997 &mut self,
5998 _: &mut MutableAppContext,
5999 ) -> Option<std::pin::Pin<Box<dyn 'static + Future<Output = ()>>>> {
6000 let shutdown_futures = self
6001 .language_servers
6002 .drain()
6003 .map(|(_, server_state)| async {
6004 match server_state {
6005 LanguageServerState::Running { server, .. } => server.shutdown()?.await,
6006 LanguageServerState::Starting(starting_server) => {
6007 starting_server.await?.shutdown()?.await
6008 }
6009 }
6010 })
6011 .collect::<Vec<_>>();
6012
6013 Some(
6014 async move {
6015 futures::future::join_all(shutdown_futures).await;
6016 }
6017 .boxed(),
6018 )
6019 }
6020}
6021
6022impl Collaborator {
6023 fn from_proto(message: proto::Collaborator) -> Self {
6024 Self {
6025 peer_id: PeerId(message.peer_id),
6026 replica_id: message.replica_id as ReplicaId,
6027 }
6028 }
6029}
6030
6031impl<P: AsRef<Path>> From<(WorktreeId, P)> for ProjectPath {
6032 fn from((worktree_id, path): (WorktreeId, P)) -> Self {
6033 Self {
6034 worktree_id,
6035 path: path.as_ref().into(),
6036 }
6037 }
6038}
6039
6040fn serialize_symbol(symbol: &Symbol) -> proto::Symbol {
6041 proto::Symbol {
6042 language_server_name: symbol.language_server_name.0.to_string(),
6043 source_worktree_id: symbol.source_worktree_id.to_proto(),
6044 worktree_id: symbol.path.worktree_id.to_proto(),
6045 path: symbol.path.path.to_string_lossy().to_string(),
6046 name: symbol.name.clone(),
6047 kind: unsafe { mem::transmute(symbol.kind) },
6048 start: Some(proto::Point {
6049 row: symbol.range.start.row,
6050 column: symbol.range.start.column,
6051 }),
6052 end: Some(proto::Point {
6053 row: symbol.range.end.row,
6054 column: symbol.range.end.column,
6055 }),
6056 signature: symbol.signature.to_vec(),
6057 }
6058}
6059
6060fn relativize_path(base: &Path, path: &Path) -> PathBuf {
6061 let mut path_components = path.components();
6062 let mut base_components = base.components();
6063 let mut components: Vec<Component> = Vec::new();
6064 loop {
6065 match (path_components.next(), base_components.next()) {
6066 (None, None) => break,
6067 (Some(a), None) => {
6068 components.push(a);
6069 components.extend(path_components.by_ref());
6070 break;
6071 }
6072 (None, _) => components.push(Component::ParentDir),
6073 (Some(a), Some(b)) if components.is_empty() && a == b => (),
6074 (Some(a), Some(b)) if b == Component::CurDir => components.push(a),
6075 (Some(a), Some(_)) => {
6076 components.push(Component::ParentDir);
6077 for _ in base_components {
6078 components.push(Component::ParentDir);
6079 }
6080 components.push(a);
6081 components.extend(path_components.by_ref());
6082 break;
6083 }
6084 }
6085 }
6086 components.iter().map(|c| c.as_os_str()).collect()
6087}
6088
6089impl Item for Buffer {
6090 fn entry_id(&self, cx: &AppContext) -> Option<ProjectEntryId> {
6091 File::from_dyn(self.file()).and_then(|file| file.project_entry_id(cx))
6092 }
6093}