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