1use std::{
2 borrow::Cow,
3 ops::{Deref, DerefMut, Range},
4 sync::Arc,
5};
6
7use anyhow::Result;
8use serde_json::json;
9
10use crate::{Editor, ToPoint};
11use collections::HashSet;
12use futures::Future;
13use gpui::{AssetSource, View, ViewContext, VisualTestContext};
14use indoc::indoc;
15use language::{
16 point_to_lsp, FakeLspAdapter, Language, LanguageConfig, LanguageMatcher, LanguageQueries,
17};
18use lsp::{notification, request};
19use multi_buffer::ToPointUtf16;
20use project::Project;
21use smol::stream::StreamExt;
22use workspace::{AppState, Workspace, WorkspaceHandle};
23
24use super::editor_test_context::{AssertionContextManager, EditorTestContext};
25
26pub struct EditorLspTestContext {
27 pub cx: EditorTestContext,
28 pub lsp: lsp::FakeLanguageServer,
29 pub workspace: View<Workspace>,
30 pub buffer_lsp_url: lsp::Url,
31}
32
33impl EditorLspTestContext {
34 pub async fn new(
35 language: Language,
36 capabilities: lsp::ServerCapabilities,
37 cx: &mut gpui::TestAppContext,
38 ) -> EditorLspTestContext {
39 let app_state = cx.update(AppState::test);
40
41 cx.update(|cx| {
42 cx.text_system()
43 .add_fonts(vec![assets::Assets
44 .load("fonts/zed-mono/zed-mono-extended.ttf")
45 .unwrap()
46 .unwrap()])
47 .unwrap();
48 language::init(cx);
49 crate::init(cx);
50 workspace::init(app_state.clone(), cx);
51 Project::init_settings(cx);
52 });
53
54 let file_name = format!(
55 "file.{}",
56 language
57 .path_suffixes()
58 .first()
59 .expect("language must have a path suffix for EditorLspTestContext")
60 );
61
62 let project = Project::test(app_state.fs.clone(), [], cx).await;
63
64 let language_registry = project.read_with(cx, |project, _| project.languages().clone());
65 let mut fake_servers = language_registry.register_fake_lsp_adapter(
66 language.name().as_ref(),
67 FakeLspAdapter {
68 capabilities,
69 ..Default::default()
70 },
71 );
72 language_registry.add(Arc::new(language));
73
74 app_state
75 .fs
76 .as_fake()
77 .insert_tree("/root", json!({ "dir": { file_name.clone(): "" }}))
78 .await;
79
80 let window = cx.add_window(|cx| Workspace::test_new(project.clone(), cx));
81
82 let workspace = window.root_view(cx).unwrap();
83
84 let mut cx = VisualTestContext::from_window(*window.deref(), cx);
85 project
86 .update(&mut cx, |project, cx| {
87 project.find_or_create_local_worktree("/root", true, cx)
88 })
89 .await
90 .unwrap();
91 cx.read(|cx| workspace.read(cx).worktree_scans_complete(cx))
92 .await;
93 let file = cx.read(|cx| workspace.file_project_paths(cx)[0].clone());
94 let item = workspace
95 .update(&mut cx, |workspace, cx| {
96 workspace.open_path(file, None, true, cx)
97 })
98 .await
99 .expect("Could not open test file");
100 let editor = cx.update(|cx| {
101 item.act_as::<Editor>(cx)
102 .expect("Opened test file wasn't an editor")
103 });
104 editor.update(&mut cx, |editor, cx| editor.focus(cx));
105
106 let lsp = fake_servers.next().await.unwrap();
107 Self {
108 cx: EditorTestContext {
109 cx,
110 window: window.into(),
111 editor,
112 assertion_cx: AssertionContextManager::new(),
113 },
114 lsp,
115 workspace,
116 buffer_lsp_url: lsp::Url::from_file_path(format!("/root/dir/{file_name}")).unwrap(),
117 }
118 }
119
120 pub async fn new_rust(
121 capabilities: lsp::ServerCapabilities,
122 cx: &mut gpui::TestAppContext,
123 ) -> EditorLspTestContext {
124 let language = Language::new(
125 LanguageConfig {
126 name: "Rust".into(),
127 matcher: LanguageMatcher {
128 path_suffixes: vec!["rs".to_string()],
129 ..Default::default()
130 },
131 ..Default::default()
132 },
133 Some(tree_sitter_rust::language()),
134 )
135 .with_queries(LanguageQueries {
136 indents: Some(Cow::from(indoc! {r#"
137 [
138 ((where_clause) _ @end)
139 (field_expression)
140 (call_expression)
141 (assignment_expression)
142 (let_declaration)
143 (let_chain)
144 (await_expression)
145 ] @indent
146
147 (_ "[" "]" @end) @indent
148 (_ "<" ">" @end) @indent
149 (_ "{" "}" @end) @indent
150 (_ "(" ")" @end) @indent"#})),
151 brackets: Some(Cow::from(indoc! {r#"
152 ("(" @open ")" @close)
153 ("[" @open "]" @close)
154 ("{" @open "}" @close)
155 ("<" @open ">" @close)
156 ("\"" @open "\"" @close)
157 (closure_parameters "|" @open "|" @close)"#})),
158 ..Default::default()
159 })
160 .expect("Could not parse queries");
161
162 Self::new(language, capabilities, cx).await
163 }
164
165 pub async fn new_typescript(
166 capabilities: lsp::ServerCapabilities,
167 cx: &mut gpui::TestAppContext,
168 ) -> EditorLspTestContext {
169 let mut word_characters: HashSet<char> = Default::default();
170 word_characters.insert('$');
171 word_characters.insert('#');
172 let language = Language::new(
173 LanguageConfig {
174 name: "Typescript".into(),
175 matcher: LanguageMatcher {
176 path_suffixes: vec!["ts".to_string()],
177 ..Default::default()
178 },
179 brackets: language::BracketPairConfig {
180 pairs: vec![language::BracketPair {
181 start: "{".to_string(),
182 end: "}".to_string(),
183 close: true,
184 newline: true,
185 }],
186 disabled_scopes_by_bracket_ix: Default::default(),
187 },
188 word_characters,
189 ..Default::default()
190 },
191 Some(tree_sitter_typescript::language_typescript()),
192 )
193 .with_queries(LanguageQueries {
194 brackets: Some(Cow::from(indoc! {r#"
195 ("(" @open ")" @close)
196 ("[" @open "]" @close)
197 ("{" @open "}" @close)
198 ("<" @open ">" @close)
199 ("\"" @open "\"" @close)"#})),
200 indents: Some(Cow::from(indoc! {r#"
201 [
202 (call_expression)
203 (assignment_expression)
204 (member_expression)
205 (lexical_declaration)
206 (variable_declaration)
207 (assignment_expression)
208 (if_statement)
209 (for_statement)
210 ] @indent
211
212 (_ "[" "]" @end) @indent
213 (_ "<" ">" @end) @indent
214 (_ "{" "}" @end) @indent
215 (_ "(" ")" @end) @indent
216 "#})),
217 ..Default::default()
218 })
219 .expect("Could not parse queries");
220
221 Self::new(language, capabilities, cx).await
222 }
223
224 pub async fn new_html(cx: &mut gpui::TestAppContext) -> Self {
225 let language = Language::new(
226 LanguageConfig {
227 name: "HTML".into(),
228 matcher: LanguageMatcher {
229 path_suffixes: vec!["html".into()],
230 ..Default::default()
231 },
232 block_comment: Some(("<!-- ".into(), " -->".into())),
233 ..Default::default()
234 },
235 Some(tree_sitter_html::language()),
236 );
237 Self::new(language, Default::default(), cx).await
238 }
239
240 // Constructs lsp range using a marked string with '[', ']' range delimiters
241 pub fn lsp_range(&mut self, marked_text: &str) -> lsp::Range {
242 let ranges = self.ranges(marked_text);
243 self.to_lsp_range(ranges[0].clone())
244 }
245
246 pub fn to_lsp_range(&mut self, range: Range<usize>) -> lsp::Range {
247 let snapshot = self.update_editor(|editor, cx| editor.snapshot(cx));
248 let start_point = range.start.to_point(&snapshot.buffer_snapshot);
249 let end_point = range.end.to_point(&snapshot.buffer_snapshot);
250
251 self.editor(|editor, cx| {
252 let buffer = editor.buffer().read(cx);
253 let start = point_to_lsp(
254 buffer
255 .point_to_buffer_offset(start_point, cx)
256 .unwrap()
257 .1
258 .to_point_utf16(&buffer.read(cx)),
259 );
260 let end = point_to_lsp(
261 buffer
262 .point_to_buffer_offset(end_point, cx)
263 .unwrap()
264 .1
265 .to_point_utf16(&buffer.read(cx)),
266 );
267
268 lsp::Range { start, end }
269 })
270 }
271
272 pub fn to_lsp(&mut self, offset: usize) -> lsp::Position {
273 let snapshot = self.update_editor(|editor, cx| editor.snapshot(cx));
274 let point = offset.to_point(&snapshot.buffer_snapshot);
275
276 self.editor(|editor, cx| {
277 let buffer = editor.buffer().read(cx);
278 point_to_lsp(
279 buffer
280 .point_to_buffer_offset(point, cx)
281 .unwrap()
282 .1
283 .to_point_utf16(&buffer.read(cx)),
284 )
285 })
286 }
287
288 pub fn update_workspace<F, T>(&mut self, update: F) -> T
289 where
290 F: FnOnce(&mut Workspace, &mut ViewContext<Workspace>) -> T,
291 {
292 self.workspace.update(&mut self.cx.cx, update)
293 }
294
295 pub fn handle_request<T, F, Fut>(
296 &self,
297 mut handler: F,
298 ) -> futures::channel::mpsc::UnboundedReceiver<()>
299 where
300 T: 'static + request::Request,
301 T::Params: 'static + Send,
302 F: 'static + Send + FnMut(lsp::Url, T::Params, gpui::AsyncAppContext) -> Fut,
303 Fut: 'static + Send + Future<Output = Result<T::Result>>,
304 {
305 let url = self.buffer_lsp_url.clone();
306 self.lsp.handle_request::<T, _, _>(move |params, cx| {
307 let url = url.clone();
308 handler(url, params, cx)
309 })
310 }
311
312 pub fn notify<T: notification::Notification>(&self, params: T::Params) {
313 self.lsp.notify::<T>(params);
314 }
315}
316
317impl Deref for EditorLspTestContext {
318 type Target = EditorTestContext;
319
320 fn deref(&self) -> &Self::Target {
321 &self.cx
322 }
323}
324
325impl DerefMut for EditorLspTestContext {
326 fn deref_mut(&mut self) -> &mut Self::Target {
327 &mut self.cx
328 }
329}