1use collections::{HashMap, VecDeque};
2use copilot::Copilot;
3use editor::{actions::MoveToEnd, scroll::Autoscroll, Editor, EditorEvent};
4use futures::{channel::mpsc, StreamExt};
5use gpui::{
6 actions, div, AppContext, Context, Corner, EventEmitter, FocusHandle, FocusableView,
7 IntoElement, Model, ModelContext, ParentElement, Render, Styled, Subscription, View,
8 ViewContext, VisualContext, WeakModel, WindowContext,
9};
10use language::{language_settings::SoftWrap, LanguageServerId};
11use lsp::{
12 notification::SetTrace, IoKind, LanguageServer, LanguageServerName, MessageType,
13 SetTraceParams, TraceValue,
14};
15use project::{search::SearchQuery, Project, WorktreeId};
16use std::{borrow::Cow, sync::Arc};
17use ui::{prelude::*, Button, Checkbox, ContextMenu, Label, PopoverMenu, ToggleState};
18use workspace::{
19 item::{Item, ItemHandle},
20 searchable::{SearchEvent, SearchableItem, SearchableItemHandle},
21 SplitDirection, ToolbarItemEvent, ToolbarItemLocation, ToolbarItemView, Workspace, WorkspaceId,
22};
23
24const SEND_LINE: &str = "// Send:";
25const RECEIVE_LINE: &str = "// Receive:";
26const MAX_STORED_LOG_ENTRIES: usize = 2000;
27
28pub struct LogStore {
29 projects: HashMap<WeakModel<Project>, ProjectState>,
30 language_servers: HashMap<LanguageServerId, LanguageServerState>,
31 copilot_log_subscription: Option<lsp::Subscription>,
32 _copilot_subscription: Option<gpui::Subscription>,
33 io_tx: mpsc::UnboundedSender<(LanguageServerId, IoKind, String)>,
34}
35
36struct ProjectState {
37 _subscriptions: [gpui::Subscription; 2],
38}
39
40trait Message: AsRef<str> {
41 type Level: Copy + std::fmt::Debug;
42 fn should_include(&self, _: Self::Level) -> bool {
43 true
44 }
45}
46
47struct LogMessage {
48 message: String,
49 typ: MessageType,
50}
51
52impl AsRef<str> for LogMessage {
53 fn as_ref(&self) -> &str {
54 &self.message
55 }
56}
57
58impl Message for LogMessage {
59 type Level = MessageType;
60
61 fn should_include(&self, level: Self::Level) -> bool {
62 match (self.typ, level) {
63 (MessageType::ERROR, _) => true,
64 (_, MessageType::ERROR) => false,
65 (MessageType::WARNING, _) => true,
66 (_, MessageType::WARNING) => false,
67 (MessageType::INFO, _) => true,
68 (_, MessageType::INFO) => false,
69 _ => true,
70 }
71 }
72}
73
74struct TraceMessage {
75 message: String,
76}
77
78impl AsRef<str> for TraceMessage {
79 fn as_ref(&self) -> &str {
80 &self.message
81 }
82}
83
84impl Message for TraceMessage {
85 type Level = ();
86}
87
88struct RpcMessage {
89 message: String,
90}
91
92impl AsRef<str> for RpcMessage {
93 fn as_ref(&self) -> &str {
94 &self.message
95 }
96}
97
98impl Message for RpcMessage {
99 type Level = ();
100}
101
102struct LanguageServerState {
103 name: Option<LanguageServerName>,
104 worktree_id: Option<WorktreeId>,
105 kind: LanguageServerKind,
106 log_messages: VecDeque<LogMessage>,
107 trace_messages: VecDeque<TraceMessage>,
108 rpc_state: Option<LanguageServerRpcState>,
109 trace_level: TraceValue,
110 log_level: MessageType,
111 io_logs_subscription: Option<lsp::Subscription>,
112}
113
114#[derive(PartialEq, Clone)]
115pub enum LanguageServerKind {
116 Local { project: WeakModel<Project> },
117 Remote { project: WeakModel<Project> },
118 Global,
119}
120
121impl LanguageServerKind {
122 fn is_remote(&self) -> bool {
123 matches!(self, LanguageServerKind::Remote { .. })
124 }
125}
126
127impl std::fmt::Debug for LanguageServerKind {
128 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
129 match self {
130 LanguageServerKind::Local { .. } => write!(f, "LanguageServerKind::Local"),
131 LanguageServerKind::Remote { .. } => write!(f, "LanguageServerKind::Remote"),
132 LanguageServerKind::Global => write!(f, "LanguageServerKind::Global"),
133 }
134 }
135}
136
137impl LanguageServerKind {
138 fn project(&self) -> Option<&WeakModel<Project>> {
139 match self {
140 Self::Local { project } => Some(project),
141 Self::Remote { project } => Some(project),
142 Self::Global { .. } => None,
143 }
144 }
145}
146
147struct LanguageServerRpcState {
148 rpc_messages: VecDeque<RpcMessage>,
149 last_message_kind: Option<MessageKind>,
150}
151
152pub struct LspLogView {
153 pub(crate) editor: View<Editor>,
154 editor_subscriptions: Vec<Subscription>,
155 log_store: Model<LogStore>,
156 current_server_id: Option<LanguageServerId>,
157 active_entry_kind: LogKind,
158 project: Model<Project>,
159 focus_handle: FocusHandle,
160 _log_store_subscriptions: Vec<Subscription>,
161}
162
163pub struct LspLogToolbarItemView {
164 log_view: Option<View<LspLogView>>,
165 _log_view_subscription: Option<Subscription>,
166}
167
168#[derive(Copy, Clone, PartialEq, Eq)]
169enum MessageKind {
170 Send,
171 Receive,
172}
173
174#[derive(Clone, Copy, Debug, Default, PartialEq)]
175pub enum LogKind {
176 Rpc,
177 Trace,
178 #[default]
179 Logs,
180 ServerInfo,
181}
182
183impl LogKind {
184 fn label(&self) -> &'static str {
185 match self {
186 LogKind::Rpc => RPC_MESSAGES,
187 LogKind::Trace => SERVER_TRACE,
188 LogKind::Logs => SERVER_LOGS,
189 LogKind::ServerInfo => SERVER_INFO,
190 }
191 }
192}
193
194#[derive(Clone, Debug, PartialEq)]
195pub(crate) struct LogMenuItem {
196 pub server_id: LanguageServerId,
197 pub server_name: LanguageServerName,
198 pub worktree_root_name: String,
199 pub rpc_trace_enabled: bool,
200 pub selected_entry: LogKind,
201 pub trace_level: lsp::TraceValue,
202 pub server_kind: LanguageServerKind,
203}
204
205actions!(debug, [OpenLanguageServerLogs]);
206
207pub fn init(cx: &mut AppContext) {
208 let log_store = cx.new_model(LogStore::new);
209
210 cx.observe_new_views(move |workspace: &mut Workspace, cx| {
211 let project = workspace.project();
212 if project.read(cx).is_local() || project.read(cx).is_via_ssh() {
213 log_store.update(cx, |store, cx| {
214 store.add_project(project, cx);
215 });
216 }
217
218 let log_store = log_store.clone();
219 workspace.register_action(move |workspace, _: &OpenLanguageServerLogs, cx| {
220 let project = workspace.project().read(cx);
221 if project.is_local() || project.is_via_ssh() {
222 workspace.split_item(
223 SplitDirection::Right,
224 Box::new(cx.new_view(|cx| {
225 LspLogView::new(workspace.project().clone(), log_store.clone(), cx)
226 })),
227 cx,
228 );
229 }
230 });
231 })
232 .detach();
233}
234
235impl LogStore {
236 pub fn new(cx: &mut ModelContext<Self>) -> Self {
237 let (io_tx, mut io_rx) = mpsc::unbounded();
238
239 let copilot_subscription = Copilot::global(cx).map(|copilot| {
240 let copilot = &copilot;
241 cx.subscribe(copilot, |this, copilot, inline_completion_event, cx| {
242 if let copilot::Event::CopilotLanguageServerStarted = inline_completion_event {
243 if let Some(server) = copilot.read(cx).language_server() {
244 let server_id = server.server_id();
245 let weak_this = cx.weak_model();
246 this.copilot_log_subscription =
247 Some(server.on_notification::<copilot::request::LogMessage, _>(
248 move |params, mut cx| {
249 weak_this
250 .update(&mut cx, |this, cx| {
251 this.add_language_server_log(
252 server_id,
253 MessageType::LOG,
254 ¶ms.message,
255 cx,
256 );
257 })
258 .ok();
259 },
260 ));
261 let name = LanguageServerName::new_static("copilot");
262 this.add_language_server(
263 LanguageServerKind::Global,
264 server.server_id(),
265 Some(name),
266 None,
267 Some(server.clone()),
268 cx,
269 );
270 }
271 }
272 })
273 });
274
275 let this = Self {
276 copilot_log_subscription: None,
277 _copilot_subscription: copilot_subscription,
278 projects: HashMap::default(),
279 language_servers: HashMap::default(),
280 io_tx,
281 };
282
283 cx.spawn(|this, mut cx| async move {
284 while let Some((server_id, io_kind, message)) = io_rx.next().await {
285 if let Some(this) = this.upgrade() {
286 this.update(&mut cx, |this, cx| {
287 this.on_io(server_id, io_kind, &message, cx);
288 })?;
289 }
290 }
291 anyhow::Ok(())
292 })
293 .detach_and_log_err(cx);
294 this
295 }
296
297 pub fn add_project(&mut self, project: &Model<Project>, cx: &mut ModelContext<Self>) {
298 let weak_project = project.downgrade();
299 self.projects.insert(
300 project.downgrade(),
301 ProjectState {
302 _subscriptions: [
303 cx.observe_release(project, move |this, _, _| {
304 this.projects.remove(&weak_project);
305 this.language_servers
306 .retain(|_, state| state.kind.project() != Some(&weak_project));
307 }),
308 cx.subscribe(project, |this, project, event, cx| {
309 let server_kind = if project.read(cx).is_via_ssh() {
310 LanguageServerKind::Remote {
311 project: project.downgrade(),
312 }
313 } else {
314 LanguageServerKind::Local {
315 project: project.downgrade(),
316 }
317 };
318
319 match event {
320 project::Event::LanguageServerAdded(id, name, worktree_id) => {
321 this.add_language_server(
322 server_kind,
323 *id,
324 Some(name.clone()),
325 *worktree_id,
326 project
327 .read(cx)
328 .lsp_store()
329 .read(cx)
330 .language_server_for_id(*id),
331 cx,
332 );
333 }
334 project::Event::LanguageServerRemoved(id) => {
335 this.remove_language_server(*id, cx);
336 }
337 project::Event::LanguageServerLog(id, typ, message) => {
338 this.add_language_server(server_kind, *id, None, None, None, cx);
339 match typ {
340 project::LanguageServerLogType::Log(typ) => {
341 this.add_language_server_log(*id, *typ, message, cx);
342 }
343 project::LanguageServerLogType::Trace(_) => {
344 this.add_language_server_trace(*id, message, cx);
345 }
346 }
347 }
348 _ => {}
349 }
350 }),
351 ],
352 },
353 );
354 }
355
356 fn get_language_server_state(
357 &mut self,
358 id: LanguageServerId,
359 ) -> Option<&mut LanguageServerState> {
360 self.language_servers.get_mut(&id)
361 }
362
363 fn add_language_server(
364 &mut self,
365 kind: LanguageServerKind,
366 server_id: LanguageServerId,
367 name: Option<LanguageServerName>,
368 worktree_id: Option<WorktreeId>,
369 server: Option<Arc<LanguageServer>>,
370 cx: &mut ModelContext<Self>,
371 ) -> Option<&mut LanguageServerState> {
372 let server_state = self.language_servers.entry(server_id).or_insert_with(|| {
373 cx.notify();
374 LanguageServerState {
375 name: None,
376 worktree_id: None,
377 kind,
378 rpc_state: None,
379 log_messages: VecDeque::with_capacity(MAX_STORED_LOG_ENTRIES),
380 trace_messages: VecDeque::with_capacity(MAX_STORED_LOG_ENTRIES),
381 trace_level: TraceValue::Off,
382 log_level: MessageType::LOG,
383 io_logs_subscription: None,
384 }
385 });
386
387 if let Some(name) = name {
388 server_state.name = Some(name);
389 }
390 if let Some(worktree_id) = worktree_id {
391 server_state.worktree_id = Some(worktree_id);
392 }
393
394 if let Some(server) = server
395 .clone()
396 .filter(|_| server_state.io_logs_subscription.is_none())
397 {
398 let io_tx = self.io_tx.clone();
399 let server_id = server.server_id();
400 server_state.io_logs_subscription = Some(server.on_io(move |io_kind, message| {
401 io_tx
402 .unbounded_send((server_id, io_kind, message.to_string()))
403 .ok();
404 }));
405 }
406
407 Some(server_state)
408 }
409
410 fn add_language_server_log(
411 &mut self,
412 id: LanguageServerId,
413 typ: MessageType,
414 message: &str,
415 cx: &mut ModelContext<Self>,
416 ) -> Option<()> {
417 let language_server_state = self.get_language_server_state(id)?;
418
419 let log_lines = &mut language_server_state.log_messages;
420 Self::add_language_server_message(
421 log_lines,
422 id,
423 LogMessage {
424 message: message.trim_end().to_string(),
425 typ,
426 },
427 language_server_state.log_level,
428 LogKind::Logs,
429 cx,
430 );
431 Some(())
432 }
433
434 fn add_language_server_trace(
435 &mut self,
436 id: LanguageServerId,
437 message: &str,
438 cx: &mut ModelContext<Self>,
439 ) -> Option<()> {
440 let language_server_state = self.get_language_server_state(id)?;
441
442 let log_lines = &mut language_server_state.trace_messages;
443 Self::add_language_server_message(
444 log_lines,
445 id,
446 TraceMessage {
447 message: message.trim_end().to_string(),
448 },
449 (),
450 LogKind::Trace,
451 cx,
452 );
453 Some(())
454 }
455
456 fn add_language_server_message<T: Message>(
457 log_lines: &mut VecDeque<T>,
458 id: LanguageServerId,
459 message: T,
460 current_severity: <T as Message>::Level,
461 kind: LogKind,
462 cx: &mut ModelContext<Self>,
463 ) {
464 while log_lines.len() >= MAX_STORED_LOG_ENTRIES {
465 log_lines.pop_front();
466 }
467 let entry: &str = message.as_ref();
468 let entry = entry.to_string();
469 let visible = message.should_include(current_severity);
470 log_lines.push_back(message);
471
472 if visible {
473 cx.emit(Event::NewServerLogEntry { id, entry, kind });
474 cx.notify();
475 }
476 }
477
478 fn remove_language_server(&mut self, id: LanguageServerId, cx: &mut ModelContext<Self>) {
479 self.language_servers.remove(&id);
480 cx.notify();
481 }
482
483 fn server_logs(&self, server_id: LanguageServerId) -> Option<&VecDeque<LogMessage>> {
484 Some(&self.language_servers.get(&server_id)?.log_messages)
485 }
486
487 fn server_trace(&self, server_id: LanguageServerId) -> Option<&VecDeque<TraceMessage>> {
488 Some(&self.language_servers.get(&server_id)?.trace_messages)
489 }
490
491 fn server_ids_for_project<'a>(
492 &'a self,
493 lookup_project: &'a WeakModel<Project>,
494 ) -> impl Iterator<Item = LanguageServerId> + 'a {
495 self.language_servers
496 .iter()
497 .filter_map(move |(id, state)| match &state.kind {
498 LanguageServerKind::Local { project } | LanguageServerKind::Remote { project } => {
499 if project == lookup_project {
500 Some(*id)
501 } else {
502 None
503 }
504 }
505 LanguageServerKind::Global => Some(*id),
506 })
507 }
508
509 fn enable_rpc_trace_for_language_server(
510 &mut self,
511 server_id: LanguageServerId,
512 ) -> Option<&mut LanguageServerRpcState> {
513 let rpc_state = self
514 .language_servers
515 .get_mut(&server_id)?
516 .rpc_state
517 .get_or_insert_with(|| LanguageServerRpcState {
518 rpc_messages: VecDeque::with_capacity(MAX_STORED_LOG_ENTRIES),
519 last_message_kind: None,
520 });
521 Some(rpc_state)
522 }
523
524 pub fn disable_rpc_trace_for_language_server(
525 &mut self,
526 server_id: LanguageServerId,
527 ) -> Option<()> {
528 self.language_servers.get_mut(&server_id)?.rpc_state.take();
529 Some(())
530 }
531
532 fn on_io(
533 &mut self,
534 language_server_id: LanguageServerId,
535 io_kind: IoKind,
536 message: &str,
537 cx: &mut ModelContext<Self>,
538 ) -> Option<()> {
539 let is_received = match io_kind {
540 IoKind::StdOut => true,
541 IoKind::StdIn => false,
542 IoKind::StdErr => {
543 let message = format!("stderr: {}", message.trim());
544 self.add_language_server_log(language_server_id, MessageType::LOG, &message, cx);
545 return Some(());
546 }
547 };
548
549 let state = self
550 .get_language_server_state(language_server_id)?
551 .rpc_state
552 .as_mut()?;
553 let kind = if is_received {
554 MessageKind::Receive
555 } else {
556 MessageKind::Send
557 };
558
559 let rpc_log_lines = &mut state.rpc_messages;
560 if state.last_message_kind != Some(kind) {
561 let line_before_message = match kind {
562 MessageKind::Send => SEND_LINE,
563 MessageKind::Receive => RECEIVE_LINE,
564 };
565 rpc_log_lines.push_back(RpcMessage {
566 message: line_before_message.to_string(),
567 });
568 cx.emit(Event::NewServerLogEntry {
569 id: language_server_id,
570 entry: line_before_message.to_string(),
571 kind: LogKind::Rpc,
572 });
573 }
574
575 while rpc_log_lines.len() >= MAX_STORED_LOG_ENTRIES {
576 rpc_log_lines.pop_front();
577 }
578 let message = message.trim();
579 rpc_log_lines.push_back(RpcMessage {
580 message: message.to_string(),
581 });
582 cx.emit(Event::NewServerLogEntry {
583 id: language_server_id,
584 entry: message.to_string(),
585 kind: LogKind::Rpc,
586 });
587 cx.notify();
588 Some(())
589 }
590}
591
592impl LspLogView {
593 pub fn new(
594 project: Model<Project>,
595 log_store: Model<LogStore>,
596 cx: &mut ViewContext<Self>,
597 ) -> Self {
598 let server_id = log_store
599 .read(cx)
600 .language_servers
601 .iter()
602 .find(|(_, server)| server.kind.project() == Some(&project.downgrade()))
603 .map(|(id, _)| *id);
604
605 let weak_project = project.downgrade();
606 let model_changes_subscription = cx.observe(&log_store, move |this, store, cx| {
607 let first_server_id_for_project =
608 store.read(cx).server_ids_for_project(&weak_project).next();
609 if let Some(current_lsp) = this.current_server_id {
610 if !store.read(cx).language_servers.contains_key(¤t_lsp) {
611 if let Some(server_id) = first_server_id_for_project {
612 match this.active_entry_kind {
613 LogKind::Rpc => this.show_rpc_trace_for_server(server_id, cx),
614 LogKind::Trace => this.show_trace_for_server(server_id, cx),
615 LogKind::Logs => this.show_logs_for_server(server_id, cx),
616 LogKind::ServerInfo => this.show_server_info(server_id, cx),
617 }
618 } else {
619 this.current_server_id = None;
620 this.editor.update(cx, |editor, cx| {
621 editor.set_read_only(false);
622 editor.clear(cx);
623 editor.set_read_only(true);
624 });
625 cx.notify();
626 }
627 }
628 } else if let Some(server_id) = first_server_id_for_project {
629 match this.active_entry_kind {
630 LogKind::Rpc => this.show_rpc_trace_for_server(server_id, cx),
631 LogKind::Trace => this.show_trace_for_server(server_id, cx),
632 LogKind::Logs => this.show_logs_for_server(server_id, cx),
633 LogKind::ServerInfo => this.show_server_info(server_id, cx),
634 }
635 }
636
637 cx.notify();
638 });
639 let events_subscriptions = cx.subscribe(&log_store, |log_view, _, e, cx| match e {
640 Event::NewServerLogEntry { id, entry, kind } => {
641 if log_view.current_server_id == Some(*id) && *kind == log_view.active_entry_kind {
642 log_view.editor.update(cx, |editor, cx| {
643 editor.set_read_only(false);
644 let last_point = editor.buffer().read(cx).len(cx);
645 let newest_cursor_is_at_end =
646 editor.selections.newest::<usize>(cx).start >= last_point;
647 editor.edit(
648 vec![
649 (last_point..last_point, entry.trim()),
650 (last_point..last_point, "\n"),
651 ],
652 cx,
653 );
654 let entry_length = entry.len();
655 if entry_length > 1024 {
656 editor.fold_ranges(
657 vec![last_point + 1024..last_point + entry_length],
658 false,
659 cx,
660 );
661 }
662
663 if newest_cursor_is_at_end {
664 editor.request_autoscroll(Autoscroll::bottom(), cx);
665 }
666 editor.set_read_only(true);
667 });
668 }
669 }
670 });
671 let (editor, editor_subscriptions) = Self::editor_for_logs(String::new(), cx);
672
673 let focus_handle = cx.focus_handle();
674 let focus_subscription = cx.on_focus(&focus_handle, |log_view, cx| {
675 cx.focus_view(&log_view.editor);
676 });
677
678 let mut this = Self {
679 focus_handle,
680 editor,
681 editor_subscriptions,
682 project,
683 log_store,
684 current_server_id: None,
685 active_entry_kind: LogKind::Logs,
686 _log_store_subscriptions: vec![
687 model_changes_subscription,
688 events_subscriptions,
689 focus_subscription,
690 ],
691 };
692 if let Some(server_id) = server_id {
693 this.show_logs_for_server(server_id, cx);
694 }
695 this
696 }
697
698 fn editor_for_logs(
699 log_contents: String,
700 cx: &mut ViewContext<Self>,
701 ) -> (View<Editor>, Vec<Subscription>) {
702 let editor = cx.new_view(|cx| {
703 let mut editor = Editor::multi_line(cx);
704 editor.set_text(log_contents, cx);
705 editor.move_to_end(&MoveToEnd, cx);
706 editor.set_read_only(true);
707 editor.set_show_inline_completions(Some(false), cx);
708 editor.set_soft_wrap_mode(SoftWrap::EditorWidth, cx);
709 editor
710 });
711 let editor_subscription = cx.subscribe(
712 &editor,
713 |_, _, event: &EditorEvent, cx: &mut ViewContext<LspLogView>| cx.emit(event.clone()),
714 );
715 let search_subscription = cx.subscribe(
716 &editor,
717 |_, _, event: &SearchEvent, cx: &mut ViewContext<LspLogView>| cx.emit(event.clone()),
718 );
719 (editor, vec![editor_subscription, search_subscription])
720 }
721
722 fn editor_for_server_info(
723 server: &LanguageServer,
724 cx: &mut ViewContext<Self>,
725 ) -> (View<Editor>, Vec<Subscription>) {
726 let editor = cx.new_view(|cx| {
727 let mut editor = Editor::multi_line(cx);
728 let server_info = format!(
729 "* Server: {NAME} (id {ID})
730
731* Binary: {BINARY:#?}
732
733* Running in project: {PATH:?}
734
735* Capabilities: {CAPABILITIES}",
736 NAME = server.name(),
737 ID = server.server_id(),
738 BINARY = server.binary(),
739 PATH = server.root_path(),
740 CAPABILITIES = serde_json::to_string_pretty(&server.capabilities())
741 .unwrap_or_else(|e| format!("Failed to serialize capabilities: {e}")),
742 );
743 editor.set_text(server_info, cx);
744 editor.set_read_only(true);
745 editor.set_show_inline_completions(Some(false), cx);
746 editor.set_soft_wrap_mode(SoftWrap::EditorWidth, cx);
747 editor
748 });
749 let editor_subscription = cx.subscribe(
750 &editor,
751 |_, _, event: &EditorEvent, cx: &mut ViewContext<LspLogView>| cx.emit(event.clone()),
752 );
753 let search_subscription = cx.subscribe(
754 &editor,
755 |_, _, event: &SearchEvent, cx: &mut ViewContext<LspLogView>| cx.emit(event.clone()),
756 );
757 (editor, vec![editor_subscription, search_subscription])
758 }
759
760 pub(crate) fn menu_items<'a>(&'a self, cx: &'a AppContext) -> Option<Vec<LogMenuItem>> {
761 let log_store = self.log_store.read(cx);
762
763 let unknown_server = LanguageServerName::new_static("unknown server");
764
765 let mut rows = log_store
766 .language_servers
767 .iter()
768 .map(|(server_id, state)| match &state.kind {
769 LanguageServerKind::Local { .. } | LanguageServerKind::Remote { .. } => {
770 let worktree_root_name = state
771 .worktree_id
772 .and_then(|id| self.project.read(cx).worktree_for_id(id, cx))
773 .map(|worktree| worktree.read(cx).root_name().to_string())
774 .unwrap_or_else(|| "Unknown worktree".to_string());
775
776 LogMenuItem {
777 server_id: *server_id,
778 server_name: state.name.clone().unwrap_or(unknown_server.clone()),
779 server_kind: state.kind.clone(),
780 worktree_root_name,
781 rpc_trace_enabled: state.rpc_state.is_some(),
782 selected_entry: self.active_entry_kind,
783 trace_level: lsp::TraceValue::Off,
784 }
785 }
786
787 LanguageServerKind::Global => LogMenuItem {
788 server_id: *server_id,
789 server_name: state.name.clone().unwrap_or(unknown_server.clone()),
790 server_kind: state.kind.clone(),
791 worktree_root_name: "supplementary".to_string(),
792 rpc_trace_enabled: state.rpc_state.is_some(),
793 selected_entry: self.active_entry_kind,
794 trace_level: lsp::TraceValue::Off,
795 },
796 })
797 .chain(
798 self.project
799 .read(cx)
800 .supplementary_language_servers(cx)
801 .filter_map(|(server_id, name)| {
802 let state = log_store.language_servers.get(&server_id)?;
803 Some(LogMenuItem {
804 server_id,
805 server_name: name.clone(),
806 server_kind: state.kind.clone(),
807 worktree_root_name: "supplementary".to_string(),
808 rpc_trace_enabled: state.rpc_state.is_some(),
809 selected_entry: self.active_entry_kind,
810 trace_level: lsp::TraceValue::Off,
811 })
812 }),
813 )
814 .collect::<Vec<_>>();
815 rows.sort_by_key(|row| row.server_id);
816 rows.dedup_by_key(|row| row.server_id);
817 Some(rows)
818 }
819
820 fn show_logs_for_server(&mut self, server_id: LanguageServerId, cx: &mut ViewContext<Self>) {
821 let typ = self
822 .log_store
823 .read_with(cx, |v, _| {
824 v.language_servers.get(&server_id).map(|v| v.log_level)
825 })
826 .unwrap_or(MessageType::LOG);
827 let log_contents = self
828 .log_store
829 .read(cx)
830 .server_logs(server_id)
831 .map(|v| log_contents(v, typ));
832 if let Some(log_contents) = log_contents {
833 self.current_server_id = Some(server_id);
834 self.active_entry_kind = LogKind::Logs;
835 let (editor, editor_subscriptions) = Self::editor_for_logs(log_contents, cx);
836 self.editor = editor;
837 self.editor_subscriptions = editor_subscriptions;
838 cx.notify();
839 }
840 cx.focus(&self.focus_handle);
841 }
842
843 fn update_log_level(
844 &self,
845 server_id: LanguageServerId,
846 level: MessageType,
847 cx: &mut ViewContext<Self>,
848 ) {
849 let log_contents = self.log_store.update(cx, |this, _| {
850 if let Some(state) = this.get_language_server_state(server_id) {
851 state.log_level = level;
852 }
853
854 this.server_logs(server_id).map(|v| log_contents(v, level))
855 });
856
857 if let Some(log_contents) = log_contents {
858 self.editor.update(cx, move |editor, cx| {
859 editor.set_text(log_contents, cx);
860 editor.move_to_end(&MoveToEnd, cx);
861 });
862 cx.notify();
863 }
864
865 cx.focus(&self.focus_handle);
866 }
867
868 fn show_trace_for_server(&mut self, server_id: LanguageServerId, cx: &mut ViewContext<Self>) {
869 let log_contents = self
870 .log_store
871 .read(cx)
872 .server_trace(server_id)
873 .map(|v| log_contents(v, ()));
874 if let Some(log_contents) = log_contents {
875 self.current_server_id = Some(server_id);
876 self.active_entry_kind = LogKind::Trace;
877 let (editor, editor_subscriptions) = Self::editor_for_logs(log_contents, cx);
878 self.editor = editor;
879 self.editor_subscriptions = editor_subscriptions;
880 cx.notify();
881 }
882 cx.focus(&self.focus_handle);
883 }
884
885 fn show_rpc_trace_for_server(
886 &mut self,
887 server_id: LanguageServerId,
888 cx: &mut ViewContext<Self>,
889 ) {
890 let rpc_log = self.log_store.update(cx, |log_store, _| {
891 log_store
892 .enable_rpc_trace_for_language_server(server_id)
893 .map(|state| log_contents(&state.rpc_messages, ()))
894 });
895 if let Some(rpc_log) = rpc_log {
896 self.current_server_id = Some(server_id);
897 self.active_entry_kind = LogKind::Rpc;
898 let (editor, editor_subscriptions) = Self::editor_for_logs(rpc_log, cx);
899 let language = self.project.read(cx).languages().language_for_name("JSON");
900 editor
901 .read(cx)
902 .buffer()
903 .read(cx)
904 .as_singleton()
905 .expect("log buffer should be a singleton")
906 .update(cx, |_, cx| {
907 cx.spawn({
908 let buffer = cx.handle();
909 |_, mut cx| async move {
910 let language = language.await.ok();
911 buffer.update(&mut cx, |buffer, cx| {
912 buffer.set_language(language, cx);
913 })
914 }
915 })
916 .detach_and_log_err(cx);
917 });
918
919 self.editor = editor;
920 self.editor_subscriptions = editor_subscriptions;
921 cx.notify();
922 }
923
924 cx.focus(&self.focus_handle);
925 }
926
927 fn toggle_rpc_trace_for_server(
928 &mut self,
929 server_id: LanguageServerId,
930 enabled: bool,
931 cx: &mut ViewContext<Self>,
932 ) {
933 self.log_store.update(cx, |log_store, _| {
934 if enabled {
935 log_store.enable_rpc_trace_for_language_server(server_id);
936 } else {
937 log_store.disable_rpc_trace_for_language_server(server_id);
938 }
939 });
940 if !enabled && Some(server_id) == self.current_server_id {
941 self.show_logs_for_server(server_id, cx);
942 cx.notify();
943 }
944 }
945
946 fn update_trace_level(
947 &self,
948 server_id: LanguageServerId,
949 level: TraceValue,
950 cx: &mut ViewContext<Self>,
951 ) {
952 if let Some(server) = self
953 .project
954 .read(cx)
955 .lsp_store()
956 .read(cx)
957 .language_server_for_id(server_id)
958 {
959 self.log_store.update(cx, |this, _| {
960 if let Some(state) = this.get_language_server_state(server_id) {
961 state.trace_level = level;
962 }
963 });
964
965 server
966 .notify::<SetTrace>(&SetTraceParams { value: level })
967 .ok();
968 }
969 }
970
971 fn show_server_info(&mut self, server_id: LanguageServerId, cx: &mut ViewContext<Self>) {
972 let lsp_store = self.project.read(cx).lsp_store();
973 let Some(server) = lsp_store.read(cx).language_server_for_id(server_id) else {
974 return;
975 };
976 self.current_server_id = Some(server_id);
977 self.active_entry_kind = LogKind::ServerInfo;
978 let (editor, editor_subscriptions) = Self::editor_for_server_info(&server, cx);
979 self.editor = editor;
980 self.editor_subscriptions = editor_subscriptions;
981 cx.notify();
982 cx.focus(&self.focus_handle);
983 }
984}
985
986fn log_filter<T: Message>(line: &T, cmp: <T as Message>::Level) -> Option<&str> {
987 if line.should_include(cmp) {
988 Some(line.as_ref())
989 } else {
990 None
991 }
992}
993
994fn log_contents<T: Message>(lines: &VecDeque<T>, cmp: <T as Message>::Level) -> String {
995 let (a, b) = lines.as_slices();
996 let a = a.iter().filter_map(move |v| log_filter(v, cmp));
997 let b = b.iter().filter_map(move |v| log_filter(v, cmp));
998 a.chain(b).fold(String::new(), |mut acc, el| {
999 acc.push_str(el);
1000 acc.push('\n');
1001 acc
1002 })
1003}
1004
1005impl Render for LspLogView {
1006 fn render(&mut self, cx: &mut ViewContext<Self>) -> impl IntoElement {
1007 self.editor
1008 .update(cx, |editor, cx| editor.render(cx).into_any_element())
1009 }
1010}
1011
1012impl FocusableView for LspLogView {
1013 fn focus_handle(&self, _: &AppContext) -> FocusHandle {
1014 self.focus_handle.clone()
1015 }
1016}
1017
1018impl Item for LspLogView {
1019 type Event = EditorEvent;
1020
1021 fn to_item_events(event: &Self::Event, f: impl FnMut(workspace::item::ItemEvent)) {
1022 Editor::to_item_events(event, f)
1023 }
1024
1025 fn tab_content_text(&self, _cx: &WindowContext) -> Option<SharedString> {
1026 Some("LSP Logs".into())
1027 }
1028
1029 fn telemetry_event_text(&self) -> Option<&'static str> {
1030 None
1031 }
1032
1033 fn as_searchable(&self, handle: &View<Self>) -> Option<Box<dyn SearchableItemHandle>> {
1034 Some(Box::new(handle.clone()))
1035 }
1036
1037 fn clone_on_split(
1038 &self,
1039 _workspace_id: Option<WorkspaceId>,
1040 cx: &mut ViewContext<Self>,
1041 ) -> Option<View<Self>>
1042 where
1043 Self: Sized,
1044 {
1045 Some(cx.new_view(|cx| {
1046 let mut new_view = Self::new(self.project.clone(), self.log_store.clone(), cx);
1047 if let Some(server_id) = self.current_server_id {
1048 match self.active_entry_kind {
1049 LogKind::Rpc => new_view.show_rpc_trace_for_server(server_id, cx),
1050 LogKind::Trace => new_view.show_trace_for_server(server_id, cx),
1051 LogKind::Logs => new_view.show_logs_for_server(server_id, cx),
1052 LogKind::ServerInfo => new_view.show_server_info(server_id, cx),
1053 }
1054 }
1055 new_view
1056 }))
1057 }
1058}
1059
1060impl SearchableItem for LspLogView {
1061 type Match = <Editor as SearchableItem>::Match;
1062
1063 fn clear_matches(&mut self, cx: &mut ViewContext<Self>) {
1064 self.editor.update(cx, |e, cx| e.clear_matches(cx))
1065 }
1066
1067 fn update_matches(&mut self, matches: &[Self::Match], cx: &mut ViewContext<Self>) {
1068 self.editor
1069 .update(cx, |e, cx| e.update_matches(matches, cx))
1070 }
1071
1072 fn query_suggestion(&mut self, cx: &mut ViewContext<Self>) -> String {
1073 self.editor.update(cx, |e, cx| e.query_suggestion(cx))
1074 }
1075
1076 fn activate_match(
1077 &mut self,
1078 index: usize,
1079 matches: &[Self::Match],
1080 cx: &mut ViewContext<Self>,
1081 ) {
1082 self.editor
1083 .update(cx, |e, cx| e.activate_match(index, matches, cx))
1084 }
1085
1086 fn select_matches(&mut self, matches: &[Self::Match], cx: &mut ViewContext<Self>) {
1087 self.editor
1088 .update(cx, |e, cx| e.select_matches(matches, cx))
1089 }
1090
1091 fn find_matches(
1092 &mut self,
1093 query: Arc<project::search::SearchQuery>,
1094 cx: &mut ViewContext<Self>,
1095 ) -> gpui::Task<Vec<Self::Match>> {
1096 self.editor.update(cx, |e, cx| e.find_matches(query, cx))
1097 }
1098
1099 fn replace(&mut self, _: &Self::Match, _: &SearchQuery, _: &mut ViewContext<Self>) {
1100 // Since LSP Log is read-only, it doesn't make sense to support replace operation.
1101 }
1102 fn supported_options() -> workspace::searchable::SearchOptions {
1103 workspace::searchable::SearchOptions {
1104 case: true,
1105 word: true,
1106 regex: true,
1107 // LSP log is read-only.
1108 replacement: false,
1109 selection: false,
1110 }
1111 }
1112 fn active_match_index(
1113 &mut self,
1114 matches: &[Self::Match],
1115 cx: &mut ViewContext<Self>,
1116 ) -> Option<usize> {
1117 self.editor
1118 .update(cx, |e, cx| e.active_match_index(matches, cx))
1119 }
1120}
1121
1122impl EventEmitter<ToolbarItemEvent> for LspLogToolbarItemView {}
1123
1124impl ToolbarItemView for LspLogToolbarItemView {
1125 fn set_active_pane_item(
1126 &mut self,
1127 active_pane_item: Option<&dyn ItemHandle>,
1128 cx: &mut ViewContext<Self>,
1129 ) -> workspace::ToolbarItemLocation {
1130 if let Some(item) = active_pane_item {
1131 if let Some(log_view) = item.downcast::<LspLogView>() {
1132 self.log_view = Some(log_view.clone());
1133 self._log_view_subscription = Some(cx.observe(&log_view, |_, _, cx| {
1134 cx.notify();
1135 }));
1136 return ToolbarItemLocation::PrimaryLeft;
1137 }
1138 }
1139 self.log_view = None;
1140 self._log_view_subscription = None;
1141 ToolbarItemLocation::Hidden
1142 }
1143}
1144
1145impl Render for LspLogToolbarItemView {
1146 fn render(&mut self, cx: &mut ViewContext<Self>) -> impl IntoElement {
1147 let Some(log_view) = self.log_view.clone() else {
1148 return div();
1149 };
1150 let (menu_rows, current_server_id) = log_view.update(cx, |log_view, cx| {
1151 let menu_rows = log_view.menu_items(cx).unwrap_or_default();
1152 let current_server_id = log_view.current_server_id;
1153 (menu_rows, current_server_id)
1154 });
1155
1156 let current_server = current_server_id.and_then(|current_server_id| {
1157 if let Ok(ix) = menu_rows.binary_search_by_key(¤t_server_id, |e| e.server_id) {
1158 Some(menu_rows[ix].clone())
1159 } else {
1160 None
1161 }
1162 });
1163 let available_language_servers: Vec<_> = menu_rows
1164 .iter()
1165 .map(|row| {
1166 (
1167 row.server_id,
1168 row.server_name.clone(),
1169 row.worktree_root_name.clone(),
1170 row.selected_entry,
1171 )
1172 })
1173 .collect();
1174 let log_toolbar_view = cx.view().clone();
1175 let lsp_menu = PopoverMenu::new("LspLogView")
1176 .anchor(Corner::TopLeft)
1177 .trigger(Button::new(
1178 "language_server_menu_header",
1179 current_server
1180 .as_ref()
1181 .map(|row| {
1182 Cow::Owned(format!(
1183 "{} ({})",
1184 row.server_name.0, row.worktree_root_name,
1185 ))
1186 })
1187 .unwrap_or_else(|| "No server selected".into()),
1188 ))
1189 .menu({
1190 let log_view = log_view.clone();
1191 move |cx| {
1192 let log_view = log_view.clone();
1193 ContextMenu::build(cx, |mut menu, cx| {
1194 for (server_id, name, worktree_root, active_entry_kind) in
1195 available_language_servers.iter()
1196 {
1197 let label = format!("{} ({})", name, worktree_root);
1198 let server_id = *server_id;
1199 let active_entry_kind = *active_entry_kind;
1200 menu = menu.entry(
1201 label,
1202 None,
1203 cx.handler_for(&log_view, move |view, cx| {
1204 view.current_server_id = Some(server_id);
1205 view.active_entry_kind = active_entry_kind;
1206 match view.active_entry_kind {
1207 LogKind::Rpc => {
1208 view.toggle_rpc_trace_for_server(server_id, true, cx);
1209 view.show_rpc_trace_for_server(server_id, cx);
1210 }
1211 LogKind::Trace => view.show_trace_for_server(server_id, cx),
1212 LogKind::Logs => view.show_logs_for_server(server_id, cx),
1213 LogKind::ServerInfo => view.show_server_info(server_id, cx),
1214 }
1215 cx.notify();
1216 }),
1217 );
1218 }
1219 menu
1220 })
1221 .into()
1222 }
1223 });
1224 let view_selector = current_server.map(|server| {
1225 let server_id = server.server_id;
1226 let is_remote = server.server_kind.is_remote();
1227 let rpc_trace_enabled = server.rpc_trace_enabled;
1228 let log_view = log_view.clone();
1229 PopoverMenu::new("LspViewSelector")
1230 .anchor(Corner::TopLeft)
1231 .trigger(Button::new(
1232 "language_server_menu_header",
1233 server.selected_entry.label(),
1234 ))
1235 .menu(move |cx| {
1236 let log_toolbar_view = log_toolbar_view.clone();
1237 let log_view = log_view.clone();
1238 Some(ContextMenu::build(cx, move |this, cx| {
1239 this.entry(
1240 SERVER_LOGS,
1241 None,
1242 cx.handler_for(&log_view, move |view, cx| {
1243 view.show_logs_for_server(server_id, cx);
1244 }),
1245 )
1246 .when(!is_remote, |this| {
1247 this.entry(
1248 SERVER_TRACE,
1249 None,
1250 cx.handler_for(&log_view, move |view, cx| {
1251 view.show_trace_for_server(server_id, cx);
1252 }),
1253 )
1254 .custom_entry(
1255 {
1256 let log_toolbar_view = log_toolbar_view.clone();
1257 move |cx| {
1258 h_flex()
1259 .w_full()
1260 .justify_between()
1261 .child(Label::new(RPC_MESSAGES))
1262 .child(
1263 div().child(
1264 Checkbox::new(
1265 "LspLogEnableRpcTrace",
1266 if rpc_trace_enabled {
1267 ToggleState::Selected
1268 } else {
1269 ToggleState::Unselected
1270 },
1271 )
1272 .on_click(cx.listener_for(
1273 &log_toolbar_view,
1274 move |view, selection, cx| {
1275 let enabled = matches!(
1276 selection,
1277 ToggleState::Selected
1278 );
1279 view.toggle_rpc_logging_for_server(
1280 server_id, enabled, cx,
1281 );
1282 cx.stop_propagation();
1283 },
1284 )),
1285 ),
1286 )
1287 .into_any_element()
1288 }
1289 },
1290 cx.handler_for(&log_view, move |view, cx| {
1291 view.show_rpc_trace_for_server(server_id, cx);
1292 }),
1293 )
1294 })
1295 .entry(
1296 SERVER_INFO,
1297 None,
1298 cx.handler_for(&log_view, move |view, cx| {
1299 view.show_server_info(server_id, cx);
1300 }),
1301 )
1302 }))
1303 })
1304 });
1305 h_flex()
1306 .size_full()
1307 .justify_between()
1308 .child(
1309 h_flex()
1310 .child(lsp_menu)
1311 .children(view_selector)
1312 .child(log_view.update(cx, |this, _| match this.active_entry_kind {
1313 LogKind::Trace => {
1314 let log_view = log_view.clone();
1315 div().child(
1316 PopoverMenu::new("lsp-trace-level-menu")
1317 .anchor(Corner::TopLeft)
1318 .trigger(Button::new(
1319 "language_server_trace_level_selector",
1320 "Trace level",
1321 ))
1322 .menu({
1323 let log_view = log_view.clone();
1324
1325 move |cx| {
1326 let id = log_view.read(cx).current_server_id?;
1327
1328 let trace_level = log_view.update(cx, |this, cx| {
1329 this.log_store.update(cx, |this, _| {
1330 Some(
1331 this.get_language_server_state(id)?
1332 .trace_level,
1333 )
1334 })
1335 })?;
1336
1337 ContextMenu::build(cx, |mut menu, _| {
1338 let log_view = log_view.clone();
1339
1340 for (option, label) in [
1341 (TraceValue::Off, "Off"),
1342 (TraceValue::Messages, "Messages"),
1343 (TraceValue::Verbose, "Verbose"),
1344 ] {
1345 menu = menu.entry(label, None, {
1346 let log_view = log_view.clone();
1347 move |cx| {
1348 log_view.update(cx, |this, cx| {
1349 if let Some(id) =
1350 this.current_server_id
1351 {
1352 this.update_trace_level(
1353 id, option, cx,
1354 );
1355 }
1356 });
1357 }
1358 });
1359 if option == trace_level {
1360 menu.select_last();
1361 }
1362 }
1363
1364 menu
1365 })
1366 .into()
1367 }
1368 }),
1369 )
1370 }
1371 LogKind::Logs => {
1372 let log_view = log_view.clone();
1373 div().child(
1374 PopoverMenu::new("lsp-log-level-menu")
1375 .anchor(Corner::TopLeft)
1376 .trigger(Button::new(
1377 "language_server_log_level_selector",
1378 "Log level",
1379 ))
1380 .menu({
1381 let log_view = log_view.clone();
1382
1383 move |cx| {
1384 let id = log_view.read(cx).current_server_id?;
1385
1386 let log_level = log_view.update(cx, |this, cx| {
1387 this.log_store.update(cx, |this, _| {
1388 Some(
1389 this.get_language_server_state(id)?
1390 .log_level,
1391 )
1392 })
1393 })?;
1394
1395 ContextMenu::build(cx, |mut menu, _| {
1396 let log_view = log_view.clone();
1397
1398 for (option, label) in [
1399 (MessageType::LOG, "Log"),
1400 (MessageType::INFO, "Info"),
1401 (MessageType::WARNING, "Warning"),
1402 (MessageType::ERROR, "Error"),
1403 ] {
1404 menu = menu.entry(label, None, {
1405 let log_view = log_view.clone();
1406 move |cx| {
1407 log_view.update(cx, |this, cx| {
1408 if let Some(id) =
1409 this.current_server_id
1410 {
1411 this.update_log_level(
1412 id, option, cx,
1413 );
1414 }
1415 });
1416 }
1417 });
1418 if option == log_level {
1419 menu.select_last();
1420 }
1421 }
1422
1423 menu
1424 })
1425 .into()
1426 }
1427 }),
1428 )
1429 }
1430 _ => div(),
1431 })),
1432 )
1433 .child(
1434 div()
1435 .child(
1436 Button::new("clear_log_button", "Clear").on_click(cx.listener(
1437 |this, _, cx| {
1438 if let Some(log_view) = this.log_view.as_ref() {
1439 log_view.update(cx, |log_view, cx| {
1440 log_view.editor.update(cx, |editor, cx| {
1441 editor.set_read_only(false);
1442 editor.clear(cx);
1443 editor.set_read_only(true);
1444 });
1445 })
1446 }
1447 },
1448 )),
1449 )
1450 .ml_2(),
1451 )
1452 }
1453}
1454
1455const RPC_MESSAGES: &str = "RPC Messages";
1456const SERVER_LOGS: &str = "Server Logs";
1457const SERVER_TRACE: &str = "Server Trace";
1458const SERVER_INFO: &str = "Server Info";
1459
1460impl Default for LspLogToolbarItemView {
1461 fn default() -> Self {
1462 Self::new()
1463 }
1464}
1465
1466impl LspLogToolbarItemView {
1467 pub fn new() -> Self {
1468 Self {
1469 log_view: None,
1470 _log_view_subscription: None,
1471 }
1472 }
1473
1474 fn toggle_rpc_logging_for_server(
1475 &mut self,
1476 id: LanguageServerId,
1477 enabled: bool,
1478 cx: &mut ViewContext<Self>,
1479 ) {
1480 if let Some(log_view) = &self.log_view {
1481 log_view.update(cx, |log_view, cx| {
1482 log_view.toggle_rpc_trace_for_server(id, enabled, cx);
1483 if !enabled && Some(id) == log_view.current_server_id {
1484 log_view.show_logs_for_server(id, cx);
1485 cx.notify();
1486 } else if enabled {
1487 log_view.show_rpc_trace_for_server(id, cx);
1488 cx.notify();
1489 }
1490 cx.focus(&log_view.focus_handle);
1491 });
1492 }
1493 cx.notify();
1494 }
1495}
1496
1497pub enum Event {
1498 NewServerLogEntry {
1499 id: LanguageServerId,
1500 entry: String,
1501 kind: LogKind,
1502 },
1503}
1504
1505impl EventEmitter<Event> for LogStore {}
1506impl EventEmitter<Event> for LspLogView {}
1507impl EventEmitter<EditorEvent> for LspLogView {}
1508impl EventEmitter<SearchEvent> for LspLogView {}