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