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 editor.edit(
646 vec![
647 (last_point..last_point, entry.trim()),
648 (last_point..last_point, "\n"),
649 ],
650 cx,
651 );
652 let entry_length = entry.len();
653 if entry_length > 1024 {
654 editor.fold_ranges(
655 vec![last_point + 1024..last_point + entry_length],
656 false,
657 cx,
658 );
659 }
660 editor.request_autoscroll(Autoscroll::fit(), cx);
661 editor.set_read_only(true);
662 });
663 }
664 }
665 });
666 let (editor, editor_subscriptions) = Self::editor_for_logs(String::new(), cx);
667
668 let focus_handle = cx.focus_handle();
669 let focus_subscription = cx.on_focus(&focus_handle, |log_view, cx| {
670 cx.focus_view(&log_view.editor);
671 });
672
673 let mut this = Self {
674 focus_handle,
675 editor,
676 editor_subscriptions,
677 project,
678 log_store,
679 current_server_id: None,
680 active_entry_kind: LogKind::Logs,
681 _log_store_subscriptions: vec![
682 model_changes_subscription,
683 events_subscriptions,
684 focus_subscription,
685 ],
686 };
687 if let Some(server_id) = server_id {
688 this.show_logs_for_server(server_id, cx);
689 }
690 this
691 }
692
693 fn editor_for_logs(
694 log_contents: String,
695 cx: &mut ViewContext<Self>,
696 ) -> (View<Editor>, Vec<Subscription>) {
697 let editor = cx.new_view(|cx| {
698 let mut editor = Editor::multi_line(cx);
699 editor.set_text(log_contents, cx);
700 editor.move_to_end(&MoveToEnd, cx);
701 editor.set_read_only(true);
702 editor.set_show_inline_completions(Some(false), cx);
703 editor.set_soft_wrap_mode(SoftWrap::EditorWidth, cx);
704 editor
705 });
706 let editor_subscription = cx.subscribe(
707 &editor,
708 |_, _, event: &EditorEvent, cx: &mut ViewContext<LspLogView>| cx.emit(event.clone()),
709 );
710 let search_subscription = cx.subscribe(
711 &editor,
712 |_, _, event: &SearchEvent, cx: &mut ViewContext<LspLogView>| cx.emit(event.clone()),
713 );
714 (editor, vec![editor_subscription, search_subscription])
715 }
716
717 fn editor_for_server_info(
718 server: &LanguageServer,
719 cx: &mut ViewContext<Self>,
720 ) -> (View<Editor>, Vec<Subscription>) {
721 let editor = cx.new_view(|cx| {
722 let mut editor = Editor::multi_line(cx);
723 let server_info = format!(
724 "* Server: {NAME} (id {ID})
725
726* Binary: {BINARY:#?}
727
728* Running in project: {PATH:?}
729
730* Capabilities: {CAPABILITIES}",
731 NAME = server.name(),
732 ID = server.server_id(),
733 BINARY = server.binary(),
734 PATH = server.root_path(),
735 CAPABILITIES = serde_json::to_string_pretty(&server.capabilities())
736 .unwrap_or_else(|e| format!("Failed to serialize capabilities: {e}")),
737 );
738 editor.set_text(server_info, cx);
739 editor.set_read_only(true);
740 editor.set_show_inline_completions(Some(false), cx);
741 editor.set_soft_wrap_mode(SoftWrap::EditorWidth, cx);
742 editor
743 });
744 let editor_subscription = cx.subscribe(
745 &editor,
746 |_, _, event: &EditorEvent, cx: &mut ViewContext<LspLogView>| cx.emit(event.clone()),
747 );
748 let search_subscription = cx.subscribe(
749 &editor,
750 |_, _, event: &SearchEvent, cx: &mut ViewContext<LspLogView>| cx.emit(event.clone()),
751 );
752 (editor, vec![editor_subscription, search_subscription])
753 }
754
755 pub(crate) fn menu_items<'a>(&'a self, cx: &'a AppContext) -> Option<Vec<LogMenuItem>> {
756 let log_store = self.log_store.read(cx);
757
758 let unknown_server = LanguageServerName::new_static("unknown server");
759
760 let mut rows = log_store
761 .language_servers
762 .iter()
763 .map(|(server_id, state)| match &state.kind {
764 LanguageServerKind::Local { .. } | LanguageServerKind::Remote { .. } => {
765 let worktree_root_name = state
766 .worktree_id
767 .and_then(|id| self.project.read(cx).worktree_for_id(id, cx))
768 .map(|worktree| worktree.read(cx).root_name().to_string())
769 .unwrap_or_else(|| "Unknown worktree".to_string());
770
771 LogMenuItem {
772 server_id: *server_id,
773 server_name: state.name.clone().unwrap_or(unknown_server.clone()),
774 server_kind: state.kind.clone(),
775 worktree_root_name,
776 rpc_trace_enabled: state.rpc_state.is_some(),
777 selected_entry: self.active_entry_kind,
778 trace_level: lsp::TraceValue::Off,
779 }
780 }
781
782 LanguageServerKind::Global => LogMenuItem {
783 server_id: *server_id,
784 server_name: state.name.clone().unwrap_or(unknown_server.clone()),
785 server_kind: state.kind.clone(),
786 worktree_root_name: "supplementary".to_string(),
787 rpc_trace_enabled: state.rpc_state.is_some(),
788 selected_entry: self.active_entry_kind,
789 trace_level: lsp::TraceValue::Off,
790 },
791 })
792 .chain(
793 self.project
794 .read(cx)
795 .supplementary_language_servers(cx)
796 .filter_map(|(server_id, name)| {
797 let state = log_store.language_servers.get(&server_id)?;
798 Some(LogMenuItem {
799 server_id,
800 server_name: name.clone(),
801 server_kind: state.kind.clone(),
802 worktree_root_name: "supplementary".to_string(),
803 rpc_trace_enabled: state.rpc_state.is_some(),
804 selected_entry: self.active_entry_kind,
805 trace_level: lsp::TraceValue::Off,
806 })
807 }),
808 )
809 .collect::<Vec<_>>();
810 rows.sort_by_key(|row| row.server_id);
811 rows.dedup_by_key(|row| row.server_id);
812 Some(rows)
813 }
814
815 fn show_logs_for_server(&mut self, server_id: LanguageServerId, cx: &mut ViewContext<Self>) {
816 let typ = self
817 .log_store
818 .read_with(cx, |v, _| {
819 v.language_servers.get(&server_id).map(|v| v.log_level)
820 })
821 .unwrap_or(MessageType::LOG);
822 let log_contents = self
823 .log_store
824 .read(cx)
825 .server_logs(server_id)
826 .map(|v| log_contents(v, typ));
827 if let Some(log_contents) = log_contents {
828 self.current_server_id = Some(server_id);
829 self.active_entry_kind = LogKind::Logs;
830 let (editor, editor_subscriptions) = Self::editor_for_logs(log_contents, cx);
831 self.editor = editor;
832 self.editor_subscriptions = editor_subscriptions;
833 cx.notify();
834 }
835 cx.focus(&self.focus_handle);
836 }
837
838 fn update_log_level(
839 &self,
840 server_id: LanguageServerId,
841 level: MessageType,
842 cx: &mut ViewContext<Self>,
843 ) {
844 let log_contents = self.log_store.update(cx, |this, _| {
845 if let Some(state) = this.get_language_server_state(server_id) {
846 state.log_level = level;
847 }
848
849 this.server_logs(server_id).map(|v| log_contents(v, level))
850 });
851
852 if let Some(log_contents) = log_contents {
853 self.editor.update(cx, move |editor, cx| {
854 editor.set_text(log_contents, cx);
855 editor.move_to_end(&MoveToEnd, cx);
856 });
857 cx.notify();
858 }
859
860 cx.focus(&self.focus_handle);
861 }
862
863 fn show_trace_for_server(&mut self, server_id: LanguageServerId, cx: &mut ViewContext<Self>) {
864 let log_contents = self
865 .log_store
866 .read(cx)
867 .server_trace(server_id)
868 .map(|v| log_contents(v, ()));
869 if let Some(log_contents) = log_contents {
870 self.current_server_id = Some(server_id);
871 self.active_entry_kind = LogKind::Trace;
872 let (editor, editor_subscriptions) = Self::editor_for_logs(log_contents, cx);
873 self.editor = editor;
874 self.editor_subscriptions = editor_subscriptions;
875 cx.notify();
876 }
877 cx.focus(&self.focus_handle);
878 }
879
880 fn show_rpc_trace_for_server(
881 &mut self,
882 server_id: LanguageServerId,
883 cx: &mut ViewContext<Self>,
884 ) {
885 let rpc_log = self.log_store.update(cx, |log_store, _| {
886 log_store
887 .enable_rpc_trace_for_language_server(server_id)
888 .map(|state| log_contents(&state.rpc_messages, ()))
889 });
890 if let Some(rpc_log) = rpc_log {
891 self.current_server_id = Some(server_id);
892 self.active_entry_kind = LogKind::Rpc;
893 let (editor, editor_subscriptions) = Self::editor_for_logs(rpc_log, cx);
894 let language = self.project.read(cx).languages().language_for_name("JSON");
895 editor
896 .read(cx)
897 .buffer()
898 .read(cx)
899 .as_singleton()
900 .expect("log buffer should be a singleton")
901 .update(cx, |_, cx| {
902 cx.spawn({
903 let buffer = cx.handle();
904 |_, mut cx| async move {
905 let language = language.await.ok();
906 buffer.update(&mut cx, |buffer, cx| {
907 buffer.set_language(language, cx);
908 })
909 }
910 })
911 .detach_and_log_err(cx);
912 });
913
914 self.editor = editor;
915 self.editor_subscriptions = editor_subscriptions;
916 cx.notify();
917 }
918
919 cx.focus(&self.focus_handle);
920 }
921
922 fn toggle_rpc_trace_for_server(
923 &mut self,
924 server_id: LanguageServerId,
925 enabled: bool,
926 cx: &mut ViewContext<Self>,
927 ) {
928 self.log_store.update(cx, |log_store, _| {
929 if enabled {
930 log_store.enable_rpc_trace_for_language_server(server_id);
931 } else {
932 log_store.disable_rpc_trace_for_language_server(server_id);
933 }
934 });
935 if !enabled && Some(server_id) == self.current_server_id {
936 self.show_logs_for_server(server_id, cx);
937 cx.notify();
938 }
939 }
940
941 fn update_trace_level(
942 &self,
943 server_id: LanguageServerId,
944 level: TraceValue,
945 cx: &mut ViewContext<Self>,
946 ) {
947 if let Some(server) = self
948 .project
949 .read(cx)
950 .lsp_store()
951 .read(cx)
952 .language_server_for_id(server_id)
953 {
954 self.log_store.update(cx, |this, _| {
955 if let Some(state) = this.get_language_server_state(server_id) {
956 state.trace_level = level;
957 }
958 });
959
960 server
961 .notify::<SetTrace>(SetTraceParams { value: level })
962 .ok();
963 }
964 }
965
966 fn show_server_info(&mut self, server_id: LanguageServerId, cx: &mut ViewContext<Self>) {
967 let lsp_store = self.project.read(cx).lsp_store();
968 let Some(server) = lsp_store.read(cx).language_server_for_id(server_id) else {
969 return;
970 };
971 self.current_server_id = Some(server_id);
972 self.active_entry_kind = LogKind::ServerInfo;
973 let (editor, editor_subscriptions) = Self::editor_for_server_info(&server, cx);
974 self.editor = editor;
975 self.editor_subscriptions = editor_subscriptions;
976 cx.notify();
977 cx.focus(&self.focus_handle);
978 }
979}
980
981fn log_filter<T: Message>(line: &T, cmp: <T as Message>::Level) -> Option<&str> {
982 if line.should_include(cmp) {
983 Some(line.as_ref())
984 } else {
985 None
986 }
987}
988
989fn log_contents<T: Message>(lines: &VecDeque<T>, cmp: <T as Message>::Level) -> String {
990 let (a, b) = lines.as_slices();
991 let a = a.iter().filter_map(move |v| log_filter(v, cmp));
992 let b = b.iter().filter_map(move |v| log_filter(v, cmp));
993 a.chain(b).fold(String::new(), |mut acc, el| {
994 acc.push_str(el);
995 acc.push('\n');
996 acc
997 })
998}
999
1000impl Render for LspLogView {
1001 fn render(&mut self, cx: &mut ViewContext<Self>) -> impl IntoElement {
1002 self.editor
1003 .update(cx, |editor, cx| editor.render(cx).into_any_element())
1004 }
1005}
1006
1007impl FocusableView for LspLogView {
1008 fn focus_handle(&self, _: &AppContext) -> FocusHandle {
1009 self.focus_handle.clone()
1010 }
1011}
1012
1013impl Item for LspLogView {
1014 type Event = EditorEvent;
1015
1016 fn to_item_events(event: &Self::Event, f: impl FnMut(workspace::item::ItemEvent)) {
1017 Editor::to_item_events(event, f)
1018 }
1019
1020 fn tab_content_text(&self, _cx: &WindowContext) -> Option<SharedString> {
1021 Some("LSP Logs".into())
1022 }
1023
1024 fn telemetry_event_text(&self) -> Option<&'static str> {
1025 None
1026 }
1027
1028 fn as_searchable(&self, handle: &View<Self>) -> Option<Box<dyn SearchableItemHandle>> {
1029 Some(Box::new(handle.clone()))
1030 }
1031
1032 fn clone_on_split(
1033 &self,
1034 _workspace_id: Option<WorkspaceId>,
1035 cx: &mut ViewContext<Self>,
1036 ) -> Option<View<Self>>
1037 where
1038 Self: Sized,
1039 {
1040 Some(cx.new_view(|cx| {
1041 let mut new_view = Self::new(self.project.clone(), self.log_store.clone(), cx);
1042 if let Some(server_id) = self.current_server_id {
1043 match self.active_entry_kind {
1044 LogKind::Rpc => new_view.show_rpc_trace_for_server(server_id, cx),
1045 LogKind::Trace => new_view.show_trace_for_server(server_id, cx),
1046 LogKind::Logs => new_view.show_logs_for_server(server_id, cx),
1047 LogKind::ServerInfo => new_view.show_server_info(server_id, cx),
1048 }
1049 }
1050 new_view
1051 }))
1052 }
1053}
1054
1055impl SearchableItem for LspLogView {
1056 type Match = <Editor as SearchableItem>::Match;
1057
1058 fn clear_matches(&mut self, cx: &mut ViewContext<Self>) {
1059 self.editor.update(cx, |e, cx| e.clear_matches(cx))
1060 }
1061
1062 fn update_matches(&mut self, matches: &[Self::Match], cx: &mut ViewContext<Self>) {
1063 self.editor
1064 .update(cx, |e, cx| e.update_matches(matches, cx))
1065 }
1066
1067 fn query_suggestion(&mut self, cx: &mut ViewContext<Self>) -> String {
1068 self.editor.update(cx, |e, cx| e.query_suggestion(cx))
1069 }
1070
1071 fn activate_match(
1072 &mut self,
1073 index: usize,
1074 matches: &[Self::Match],
1075 cx: &mut ViewContext<Self>,
1076 ) {
1077 self.editor
1078 .update(cx, |e, cx| e.activate_match(index, matches, cx))
1079 }
1080
1081 fn select_matches(&mut self, matches: &[Self::Match], cx: &mut ViewContext<Self>) {
1082 self.editor
1083 .update(cx, |e, cx| e.select_matches(matches, cx))
1084 }
1085
1086 fn find_matches(
1087 &mut self,
1088 query: Arc<project::search::SearchQuery>,
1089 cx: &mut ViewContext<Self>,
1090 ) -> gpui::Task<Vec<Self::Match>> {
1091 self.editor.update(cx, |e, cx| e.find_matches(query, cx))
1092 }
1093
1094 fn replace(&mut self, _: &Self::Match, _: &SearchQuery, _: &mut ViewContext<Self>) {
1095 // Since LSP Log is read-only, it doesn't make sense to support replace operation.
1096 }
1097 fn supported_options() -> workspace::searchable::SearchOptions {
1098 workspace::searchable::SearchOptions {
1099 case: true,
1100 word: true,
1101 regex: true,
1102 // LSP log is read-only.
1103 replacement: false,
1104 selection: false,
1105 }
1106 }
1107 fn active_match_index(
1108 &mut self,
1109 matches: &[Self::Match],
1110 cx: &mut ViewContext<Self>,
1111 ) -> Option<usize> {
1112 self.editor
1113 .update(cx, |e, cx| e.active_match_index(matches, cx))
1114 }
1115}
1116
1117impl EventEmitter<ToolbarItemEvent> for LspLogToolbarItemView {}
1118
1119impl ToolbarItemView for LspLogToolbarItemView {
1120 fn set_active_pane_item(
1121 &mut self,
1122 active_pane_item: Option<&dyn ItemHandle>,
1123 cx: &mut ViewContext<Self>,
1124 ) -> workspace::ToolbarItemLocation {
1125 if let Some(item) = active_pane_item {
1126 if let Some(log_view) = item.downcast::<LspLogView>() {
1127 self.log_view = Some(log_view.clone());
1128 self._log_view_subscription = Some(cx.observe(&log_view, |_, _, cx| {
1129 cx.notify();
1130 }));
1131 return ToolbarItemLocation::PrimaryLeft;
1132 }
1133 }
1134 self.log_view = None;
1135 self._log_view_subscription = None;
1136 ToolbarItemLocation::Hidden
1137 }
1138}
1139
1140impl Render for LspLogToolbarItemView {
1141 fn render(&mut self, cx: &mut ViewContext<Self>) -> impl IntoElement {
1142 let Some(log_view) = self.log_view.clone() else {
1143 return div();
1144 };
1145 let (menu_rows, current_server_id) = log_view.update(cx, |log_view, cx| {
1146 let menu_rows = log_view.menu_items(cx).unwrap_or_default();
1147 let current_server_id = log_view.current_server_id;
1148 (menu_rows, current_server_id)
1149 });
1150
1151 let current_server = current_server_id.and_then(|current_server_id| {
1152 if let Ok(ix) = menu_rows.binary_search_by_key(¤t_server_id, |e| e.server_id) {
1153 Some(menu_rows[ix].clone())
1154 } else {
1155 None
1156 }
1157 });
1158 let available_language_servers: Vec<_> = menu_rows
1159 .iter()
1160 .map(|row| {
1161 (
1162 row.server_id,
1163 row.server_name.clone(),
1164 row.worktree_root_name.clone(),
1165 row.selected_entry,
1166 )
1167 })
1168 .collect();
1169 let log_toolbar_view = cx.view().clone();
1170 let lsp_menu = PopoverMenu::new("LspLogView")
1171 .anchor(Corner::TopLeft)
1172 .trigger(Button::new(
1173 "language_server_menu_header",
1174 current_server
1175 .as_ref()
1176 .map(|row| {
1177 Cow::Owned(format!(
1178 "{} ({})",
1179 row.server_name.0, row.worktree_root_name,
1180 ))
1181 })
1182 .unwrap_or_else(|| "No server selected".into()),
1183 ))
1184 .menu({
1185 let log_view = log_view.clone();
1186 move |cx| {
1187 let log_view = log_view.clone();
1188 ContextMenu::build(cx, |mut menu, cx| {
1189 for (server_id, name, worktree_root, active_entry_kind) in
1190 available_language_servers.iter()
1191 {
1192 let label = format!("{} ({})", name, worktree_root);
1193 let server_id = *server_id;
1194 let active_entry_kind = *active_entry_kind;
1195 menu = menu.entry(
1196 label,
1197 None,
1198 cx.handler_for(&log_view, move |view, cx| {
1199 view.current_server_id = Some(server_id);
1200 view.active_entry_kind = active_entry_kind;
1201 match view.active_entry_kind {
1202 LogKind::Rpc => {
1203 view.toggle_rpc_trace_for_server(server_id, true, cx);
1204 view.show_rpc_trace_for_server(server_id, cx);
1205 }
1206 LogKind::Trace => view.show_trace_for_server(server_id, cx),
1207 LogKind::Logs => view.show_logs_for_server(server_id, cx),
1208 LogKind::ServerInfo => view.show_server_info(server_id, cx),
1209 }
1210 cx.notify();
1211 }),
1212 );
1213 }
1214 menu
1215 })
1216 .into()
1217 }
1218 });
1219 let view_selector = current_server.map(|server| {
1220 let server_id = server.server_id;
1221 let is_remote = server.server_kind.is_remote();
1222 let rpc_trace_enabled = server.rpc_trace_enabled;
1223 let log_view = log_view.clone();
1224 PopoverMenu::new("LspViewSelector")
1225 .anchor(Corner::TopLeft)
1226 .trigger(Button::new(
1227 "language_server_menu_header",
1228 server.selected_entry.label(),
1229 ))
1230 .menu(move |cx| {
1231 let log_toolbar_view = log_toolbar_view.clone();
1232 let log_view = log_view.clone();
1233 Some(ContextMenu::build(cx, move |this, cx| {
1234 this.entry(
1235 SERVER_LOGS,
1236 None,
1237 cx.handler_for(&log_view, move |view, cx| {
1238 view.show_logs_for_server(server_id, cx);
1239 }),
1240 )
1241 .when(!is_remote, |this| {
1242 this.entry(
1243 SERVER_TRACE,
1244 None,
1245 cx.handler_for(&log_view, move |view, cx| {
1246 view.show_trace_for_server(server_id, cx);
1247 }),
1248 )
1249 .custom_entry(
1250 {
1251 let log_toolbar_view = log_toolbar_view.clone();
1252 move |cx| {
1253 h_flex()
1254 .w_full()
1255 .justify_between()
1256 .child(Label::new(RPC_MESSAGES))
1257 .child(
1258 div().child(
1259 Checkbox::new(
1260 "LspLogEnableRpcTrace",
1261 if rpc_trace_enabled {
1262 ToggleState::Selected
1263 } else {
1264 ToggleState::Unselected
1265 },
1266 )
1267 .on_click(cx.listener_for(
1268 &log_toolbar_view,
1269 move |view, selection, cx| {
1270 let enabled = matches!(
1271 selection,
1272 ToggleState::Selected
1273 );
1274 view.toggle_rpc_logging_for_server(
1275 server_id, enabled, cx,
1276 );
1277 cx.stop_propagation();
1278 },
1279 )),
1280 ),
1281 )
1282 .into_any_element()
1283 }
1284 },
1285 cx.handler_for(&log_view, move |view, cx| {
1286 view.show_rpc_trace_for_server(server_id, cx);
1287 }),
1288 )
1289 })
1290 .entry(
1291 SERVER_INFO,
1292 None,
1293 cx.handler_for(&log_view, move |view, cx| {
1294 view.show_server_info(server_id, cx);
1295 }),
1296 )
1297 }))
1298 })
1299 });
1300 h_flex()
1301 .size_full()
1302 .justify_between()
1303 .child(
1304 h_flex()
1305 .child(lsp_menu)
1306 .children(view_selector)
1307 .child(log_view.update(cx, |this, _| match this.active_entry_kind {
1308 LogKind::Trace => {
1309 let log_view = log_view.clone();
1310 div().child(
1311 PopoverMenu::new("lsp-trace-level-menu")
1312 .anchor(Corner::TopLeft)
1313 .trigger(Button::new(
1314 "language_server_trace_level_selector",
1315 "Trace level",
1316 ))
1317 .menu({
1318 let log_view = log_view.clone();
1319
1320 move |cx| {
1321 let id = log_view.read(cx).current_server_id?;
1322
1323 let trace_level = log_view.update(cx, |this, cx| {
1324 this.log_store.update(cx, |this, _| {
1325 Some(
1326 this.get_language_server_state(id)?
1327 .trace_level,
1328 )
1329 })
1330 })?;
1331
1332 ContextMenu::build(cx, |mut menu, _| {
1333 let log_view = log_view.clone();
1334
1335 for (option, label) in [
1336 (TraceValue::Off, "Off"),
1337 (TraceValue::Messages, "Messages"),
1338 (TraceValue::Verbose, "Verbose"),
1339 ] {
1340 menu = menu.entry(label, None, {
1341 let log_view = log_view.clone();
1342 move |cx| {
1343 log_view.update(cx, |this, cx| {
1344 if let Some(id) =
1345 this.current_server_id
1346 {
1347 this.update_trace_level(
1348 id, option, cx,
1349 );
1350 }
1351 });
1352 }
1353 });
1354 if option == trace_level {
1355 menu.select_last();
1356 }
1357 }
1358
1359 menu
1360 })
1361 .into()
1362 }
1363 }),
1364 )
1365 }
1366 LogKind::Logs => {
1367 let log_view = log_view.clone();
1368 div().child(
1369 PopoverMenu::new("lsp-log-level-menu")
1370 .anchor(Corner::TopLeft)
1371 .trigger(Button::new(
1372 "language_server_log_level_selector",
1373 "Log level",
1374 ))
1375 .menu({
1376 let log_view = log_view.clone();
1377
1378 move |cx| {
1379 let id = log_view.read(cx).current_server_id?;
1380
1381 let log_level = log_view.update(cx, |this, cx| {
1382 this.log_store.update(cx, |this, _| {
1383 Some(
1384 this.get_language_server_state(id)?
1385 .log_level,
1386 )
1387 })
1388 })?;
1389
1390 ContextMenu::build(cx, |mut menu, _| {
1391 let log_view = log_view.clone();
1392
1393 for (option, label) in [
1394 (MessageType::LOG, "Log"),
1395 (MessageType::INFO, "Info"),
1396 (MessageType::WARNING, "Warning"),
1397 (MessageType::ERROR, "Error"),
1398 ] {
1399 menu = menu.entry(label, None, {
1400 let log_view = log_view.clone();
1401 move |cx| {
1402 log_view.update(cx, |this, cx| {
1403 if let Some(id) =
1404 this.current_server_id
1405 {
1406 this.update_log_level(
1407 id, option, cx,
1408 );
1409 }
1410 });
1411 }
1412 });
1413 if option == log_level {
1414 menu.select_last();
1415 }
1416 }
1417
1418 menu
1419 })
1420 .into()
1421 }
1422 }),
1423 )
1424 }
1425 _ => div(),
1426 })),
1427 )
1428 .child(
1429 div()
1430 .child(
1431 Button::new("clear_log_button", "Clear").on_click(cx.listener(
1432 |this, _, cx| {
1433 if let Some(log_view) = this.log_view.as_ref() {
1434 log_view.update(cx, |log_view, cx| {
1435 log_view.editor.update(cx, |editor, cx| {
1436 editor.set_read_only(false);
1437 editor.clear(cx);
1438 editor.set_read_only(true);
1439 });
1440 })
1441 }
1442 },
1443 )),
1444 )
1445 .ml_2(),
1446 )
1447 }
1448}
1449
1450const RPC_MESSAGES: &str = "RPC Messages";
1451const SERVER_LOGS: &str = "Server Logs";
1452const SERVER_TRACE: &str = "Server Trace";
1453const SERVER_INFO: &str = "Server Info";
1454
1455impl Default for LspLogToolbarItemView {
1456 fn default() -> Self {
1457 Self::new()
1458 }
1459}
1460
1461impl LspLogToolbarItemView {
1462 pub fn new() -> Self {
1463 Self {
1464 log_view: None,
1465 _log_view_subscription: None,
1466 }
1467 }
1468
1469 fn toggle_rpc_logging_for_server(
1470 &mut self,
1471 id: LanguageServerId,
1472 enabled: bool,
1473 cx: &mut ViewContext<Self>,
1474 ) {
1475 if let Some(log_view) = &self.log_view {
1476 log_view.update(cx, |log_view, cx| {
1477 log_view.toggle_rpc_trace_for_server(id, enabled, cx);
1478 if !enabled && Some(id) == log_view.current_server_id {
1479 log_view.show_logs_for_server(id, cx);
1480 cx.notify();
1481 } else if enabled {
1482 log_view.show_rpc_trace_for_server(id, cx);
1483 cx.notify();
1484 }
1485 cx.focus(&log_view.focus_handle);
1486 });
1487 }
1488 cx.notify();
1489 }
1490}
1491
1492pub enum Event {
1493 NewServerLogEntry {
1494 id: LanguageServerId,
1495 entry: String,
1496 kind: LogKind,
1497 },
1498}
1499
1500impl EventEmitter<Event> for LogStore {}
1501impl EventEmitter<Event> for LspLogView {}
1502impl EventEmitter<EditorEvent> for LspLogView {}
1503impl EventEmitter<SearchEvent> for LspLogView {}