editor_lsp_test_context.rs

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