#![cfg(unix)] use std::{ fs, path::PathBuf, sync::atomic::{AtomicU64, Ordering}, thread, time::{Duration, Instant}, }; use serde_json::{Value, json}; use vamp::{ editor::{Cursor, Input, Mode}, plugin::{DiagnosticSeverity, SemanticTokenKind, SemanticTokenModifier, TextPosition}, session::EditorSession, }; static NEXT_FIXTURE: AtomicU64 = AtomicU64::new(0); // A real subprocess speaking framed LSP to the native client. // Files are explicit test-controlled gates; no wall-clock ordering assumptions. const SERVER: &str = r#" require 'json' require 'uri' STDIN.binmode STDOUT.binmode STDOUT.sync = true mode, log, release, source, target, alternate = ARGV def uri(path) 'file://' + URI::DEFAULT_PARSER.escape(File.expand_path(path), /[^A-Za-z0-9\-._~\/]/) end def emit(frame) body = JSON.generate({'jsonrpc' => '2.0'}.merge(frame)).encode('UTF-8').b header = "Content-Length: #{body.bytesize}\r\nContent-Type: application/vscode-jsonrpc; charset=utf8\r\n\r\n".b # Both fragmented headers/bodies and multiple immediately adjacent frames. STDOUT.write(header.byteslice(0, 7)) STDOUT.write(header.byteslice(7..)) STDOUT.write(body.byteslice(0, 3)) STDOUT.write(body.byteslice(3..)) end def result(id, value) emit({'id' => id, 'result' => value}) end def range(row, start, finish) {'start' => {'line' => row, 'character' => start}, 'end' => {'line' => row, 'character' => finish}} end def location(path, row = 0, column = 3) {'uri' => uri(path), 'range' => range(row, column, column + (row == 0 ? 1 : 0))} end def diagnostics(document, message, old: false, unversioned: false) diagnostic = {'range' => old ? range(999, 0, 0) : range(0, 2, 4), 'severity' => 1, 'message' => message} items = [diagnostic] items << {'range' => range(1, 0, 0), 'severity' => 4, 'message' => 'newline boundary'} unless old params = {'uri' => document['uri'], 'diagnostics' => items} params['version'] = document['version'] - (old ? 1 : 0) unless unversioned emit({'method' => 'textDocument/publishDiagnostics', 'params' => params}) end initialize_id = nil initialized_sent = false held = [] semantic_held = [] definition_count = 0 source_uri = uri(source) documents = {} control_id = nil loop do if initialize_id && !initialized_sent && (!['gated', 'hover-gated', 'controlled-gated'].include?(mode) || File.exist?(release)) sync = case mode when 'numeric' then 1 when 'none' then {'openClose' => false, 'change' => 0, 'save' => false} when 'incremental' then {'openClose' => true, 'change' => 2, 'save' => {'includeText' => true}} else {'openClose' => true, 'change' => 1, 'save' => {'includeText' => true}} end capabilities = {'positionEncoding' => 'utf-16', 'textDocumentSync' => sync, 'definitionProvider' => ['unsupported', 'controlled-unsupported'].include?(mode) ? false : {'workDoneProgress' => false}, 'hoverProvider' => ['hover-unsupported', 'controlled-unsupported'].include?(mode) ? false : {'workDoneProgress' => false}} if mode.include?('semantic') capabilities['semanticTokensProvider'] = { 'legend' => {'tokenTypes' => ['custom', 'variable', 'function', 'comment', 'type'], 'tokenModifiers' => ['custom', 'readonly', 'declaration', 'async', 'defaultLibrary']}, 'range' => true, 'full' => mode.include?('range') ? false : {'delta' => true}} end result(initialize_id, {'capabilities' => capabilities}) initialized_sent = true end if !held.empty? && File.exist?(release) && ['stale', 'hover-stale'].include?(mode) held.each do |request| result(request['id'], request['method'] == 'textDocument/hover' ? {'contents' => 'stale hover'} : location(target)) end held.clear emit({'method' => 'window/showMessage', 'params' => {'type' => 3, 'message' => 'stale response complete'}}) end control = release + '.control' if File.exist?(control) command = JSON.parse(File.read(control)) if command['id'] != control_id control_id = command.fetch('id') case command.fetch('action') when 'publish', 'clear' document = documents.fetch(command.fetch('uri', source_uri)) params = {'uri' => document['uri'], 'version' => command.fetch('version', document['version']), 'diagnostics' => command['action'] == 'clear' ? [] : [{'range' => range(0, 2, 4), 'severity' => 2, 'message' => command.fetch('message')}]} emit({'method' => 'textDocument/publishDiagnostics', 'params' => params}) when 'semantic-result' request = semantic_held.delete_at(command.fetch('index', 0)) raise 'no held semantic request' unless request emit({'id' => request.fetch('id')}.merge(command.fetch('response'))) when 'refresh' emit({'id' => "refresh-#{control_id}", 'method' => 'workspace/semanticTokens/refresh'}) when 'die' exit! 7 when 'malformed' STDOUT.write("Content-Length: nope\r\n\r\n") else raise 'unknown fixture action' end # The response proves the worker consumed every preceding publication. emit({'id' => "control-#{control_id}", 'method' => 'workspace/configuration', 'params' => {'items' => []}}) end end next unless IO.select([STDIN], nil, nil, 0.01) headers = {} loop do line = STDIN.gets("\r\n") exit if line.nil? break if line == "\r\n" name, value = line.chomp("\r\n").split(':', 2) headers[name.downcase] = value.strip end length = Integer(headers.fetch('content-length')) body = STDIN.read(length) raise 'client body length mismatch' unless body && body.bytesize == length frame = JSON.parse(body) File.open(log, 'a') { |file| file.puts(JSON.generate(frame)); file.flush } case frame['method'] when 'initialize' initialize_id = frame.fetch('id') emit({'id' => 'pre-init-message', 'method' => 'window/showMessageRequest', 'params' => {'type' => 3, 'message' => 'server initialization', 'actions' => []}}) when 'initialized' emit({'id' => 'settings', 'method' => 'workspace/configuration', 'params' => {'items' => [{'section' => 'rust-analyzer'}, {'section' => 'missing'}]}}) emit({'id' => 0, 'method' => '$/unsupported', 'params' => {}}) when 'textDocument/didOpen' document = frame.fetch('params').fetch('textDocument') documents[document['uri']] = document if document['uri'] == source_uri && !mode.start_with?('controlled') if mode == 'malformed' STDOUT.write("Content-Length: nope\r\n\r\n") elsif mode == 'dead' exit! 7 else diagnostics(document, "initial\e diagnostic", unversioned: mode == 'unversioned') end end when 'textDocument/didChange' document = frame.fetch('params').fetch('textDocument') documents[document['uri']] = document if document['uri'] == source_uri && !['malformed', 'dead'].include?(mode) && !mode.start_with?('controlled') diagnostics(document, 'obsolete must drop', old: true) diagnostics(document, "revision #{document['version']}") end when 'textDocument/definition' definition_count += 1 case mode when 'stale' held << frame when 'superseded' held << frame if held.length == 2 result(held[0]['id'], location(alternate)) result(held[1]['id'], location(target)) held.clear end when 'remote' result(frame['id'], {'uri' => 'https://example.invalid/source.rs', 'range' => range(0, 0, 1)}) when 'bounds' result(frame['id'], location(target, 999, 0)) when 'missing' result(frame['id'], location(target + '.missing')) else case definition_count when 1 result(frame['id'], location(target)) when 2 link = {'targetUri' => uri(target), 'targetRange' => range(1, 0, 0), 'targetSelectionRange' => range(1, 0, 0)} result(frame['id'], [link, location(alternate, 0, 0)]) else result(frame['id'], nil) end end when 'textDocument/hover' if mode == 'hover-stale' held << frame elsif mode == 'hover-superseded' held << frame if held.length == 2 result(held[0]['id'], {'contents' => 'old hover'}) result(held[1]['id'], {'contents' => 'new hover'}) held.clear end else contents = case mode when 'hover-markdown' then {'kind' => 'markdown', 'value' => "**Header**\n```rust\nfn main() {}\n```"} when 'hover-marked' then ['explanation', {'language' => 'rust', 'value' => "fn main() {\n}"}, 'tail'] when 'hover-string' then "one\nsecond" when 'hover-empty' then nil when 'hover-malformed' then {'kind' => 'html', 'value' => 'bad'} else {'kind' => 'plaintext', 'value' => "hover first\r\n😀e\u{301}\tsecond\e\u{85}\nlast"} end hover = contents.nil? ? nil : {'contents' => contents, 'range' => range(mode == 'hover-invalid-range' ? 999 : 0, 2, 4)} result(frame['id'], hover) end when 'textDocument/semanticTokens/full', 'textDocument/semanticTokens/range' if mode.start_with?('controlled') semantic_held << frame else result(frame['id'], {'data' => [ 0, 0, 1, 4, 0, 0, 1, 2, 1, 2, 0, 2, 1, 2, 12, 0, 1, 1, 3, 16, 0, 1, 1, 0, 1, 1, 0, 4, 4, 0 ]}) end when 'shutdown' result(frame['id'], nil) when 'exit' exit 0 end end "#; struct Fixture { root: PathBuf, source: PathBuf, target: PathBuf, alternate: PathBuf, log: PathBuf, release: PathBuf, } impl Fixture { fn new() -> Self { let root = std::env::temp_dir().join(format!( "vamp-lsp-{}-{}", std::process::id(), NEXT_FIXTURE.fetch_add(1, Ordering::Relaxed), )); fs::create_dir(&root).unwrap(); let root = fs::canonicalize(root).unwrap(); let fixture = Self { source: root.join("source space λ.rs"), target: root.join("target space 😀.rs"), alternate: root.join("alternate.rs"), log: root.join("protocol.jsonl"), release: root.join("release"), root, }; fs::write(&fixture.source, "A😀e\u{301}Z\n").unwrap(); fs::write(&fixture.target, "disk\n").unwrap(); fs::write(&fixture.alternate, "other\n").unwrap(); fixture } fn open(&self, mode: &str) -> EditorSession { let server = self.root.join("server.rb"); fs::write(&server, SERVER).unwrap(); let command = if mode == "spawn" { json!([self.root.join("unavailable-language-server")]) } else { json!([ "ruby", server, mode, self.log, self.release, self.source, self.target, self.alternate ]) }; let options = json!({ "extensions": if mode == "irrelevant" { vec!["myl"] } else { vec!["rs"] }, "command": command, "initialization_options": {"fixture": true}, "settings": {"rust-analyzer": {"cargo": {"allFeatures": true}}}, }); let config = format!( "Vamp.configure do |config|\n config.clipboard_mode = 'separate'\n config.lsp['fixture-language'] = JSON.parse({})\n config.bind 'leader d', config.core.lsp.definition\n config.bind 'leader D', config.core.lsp.diagnostics\n config.bind 'K', config.core.lsp.hover\nend\n", serde_json::to_string(&options.to_string()).unwrap(), ); let config_path = self.root.join("config.rb"); fs::write(&config_path, config).unwrap(); EditorSession::open( Some(self.source.clone()), vec!["text".into(), "diagnostics".into()], Some(&config_path), ) .unwrap() } fn worker_log(&self, worker: usize) -> PathBuf { if worker == 0 { self.log.clone() } else { self.root.join(format!("protocol-{worker}.jsonl")) } } fn worker_release(&self, worker: usize) -> PathBuf { if worker == 0 { self.release.clone() } else { self.root.join(format!("release-{worker}")) } } fn worker_frames(&self, worker: usize) -> Vec { fs::read_to_string(self.worker_log(worker)) .unwrap_or_default() .lines() .filter_map(|line| serde_json::from_str(line).ok()) .collect() } fn worker_count(&self, worker: usize, method: &str) -> usize { self.worker_frames(worker) .iter() .filter(|frame| frame["method"] == method) .count() } fn open_stack(&self, modes: [&str; 2], overlap: bool) -> EditorSession { self.open_stack_at(modes, overlap, &self.source) } fn open_stack_at( &self, modes: [&str; 2], overlap: bool, path: &std::path::Path, ) -> EditorSession { let server = self.root.join("server.rb"); fs::write(&server, SERVER).unwrap(); let command = |worker: usize, mode: &str| { if mode == "spawn" { json!([self.root.join("unavailable-language-server")]) } else { json!([ "ruby", server, mode, self.worker_log(worker), self.worker_release(worker), self.source, self.target, self.alternate ]) } }; let servers: Vec<_> = modes .into_iter() .enumerate() .map(|(worker, mode)| json!({"command": command(worker, mode)})) .collect(); let mut languages = json!({"python": {"extensions": ["rs"], "servers": servers}}); if overlap { languages["zzz-other"] = json!({"extensions": ["rs"], "command": command(2, "controlled")}); } let config = format!( "Vamp.configure do |config|\n config.clipboard_mode = 'separate'\n JSON.parse({}).each {{ |language, options| config.lsp[language] = options }}\n config.bind 'K', config.core.lsp.hover\nend\n", serde_json::to_string(&languages.to_string()).unwrap(), ); let config_path = self.root.join("config.rb"); fs::write(&config_path, config).unwrap(); EditorSession::open( Some(path.to_path_buf()), vec!["text".into(), "diagnostics".into()], Some(&config_path), ) .unwrap() } fn control(&self, worker: usize, id: u64, mut command: Value) { command["id"] = json!(id); let path = self.worker_release(worker).with_extension("control"); let temporary = path.with_extension("pending"); fs::write(&temporary, command.to_string()).unwrap(); fs::rename(temporary, path).unwrap(); } fn acknowledged(&self, worker: usize, id: u64) -> bool { self.worker_frames(worker) .iter() .any(|frame| frame["id"] == format!("control-{id}") && frame.get("result").is_some()) } fn frames(&self) -> Vec { fs::read_to_string(&self.log) .unwrap_or_default() .lines() // A concurrent final line can be incomplete; the next poll reads it again. .filter_map(|line| serde_json::from_str(line).ok()) .collect() } fn method_count(&self, method: &str) -> usize { self.frames() .iter() .filter(|frame| frame["method"] == method) .count() } fn release(&self) { fs::write(&self.release, "release").unwrap(); } } impl Drop for Fixture { fn drop(&mut self) { let _ = fs::remove_dir_all(&self.root); } } // Process-isolated deadline only: all semantic ordering uses protocol/file gates. fn until( session: &mut EditorSession, fixture: &Fixture, predicate: impl Fn(&EditorSession) -> bool, ) { let deadline = Instant::now() + Duration::from_secs(5); loop { session.poll(); if predicate(session) { return; } assert!( Instant::now() < deadline, "LSP fixture did not reach state: {}\n{}", session.editor().message(), serde_json::to_string_pretty(&fixture.frames()).unwrap(), ); thread::sleep(Duration::from_millis(2)); } } fn edit_target(session: &mut EditorSession, fixture: &Fixture) -> usize { session.execute(&format!("edit {}", fixture.target.display())); let id = session.editor().buffer_id(); session.handle(Input::Char('i')); session.handle(Input::Paste("😀e\u{301}".into())); session.handle(Input::Escape); assert_eq!(session.editor().lines(), &["😀e\u{301}disk", ""]); assert!(session.editor().dirty()); session.execute("buffer 1"); id } #[test] fn lsp_framing_lifecycle_diagnostics_and_unicode_dirty_definition() { let fixture = Fixture::new(); let mut session = fixture.open("basic"); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 && fixture .frames() .iter() .any(|frame| frame["id"] == "settings") && fixture.frames().iter().any(|frame| frame["id"] == 0) }); let diagnostic = session.editor().diagnostics().next().unwrap(); assert_eq!(diagnostic.start.row, 0); assert_eq!(diagnostic.start.column, 1); // inside emoji => whole emoji assert_eq!(diagnostic.end.column, 3); // inside e + combining accent => whole cluster assert_eq!(diagnostic.severity, DiagnosticSeverity::Error); assert_eq!(diagnostic.message, "initial diagnostic"); assert_eq!(session.editor().diagnostics().nth(1).unwrap().start.row, 1); assert!(session.editor().diagnostic_at_cursor().is_none()); session.handle(Input::Right); assert!(session.editor().diagnostic_at_cursor().is_some()); let frames = fixture.frames(); let initialize = &frames[0]; assert_eq!(initialize["method"], "initialize"); assert_eq!( initialize["params"]["capabilities"]["general"]["positionEncodings"], json!(["utf-16"]) ); assert_eq!( initialize["params"]["initializationOptions"], json!({"fixture": true}) ); assert_eq!( initialize["params"]["capabilities"]["textDocument"]["publishDiagnostics"]["versionSupport"], true ); assert_eq!( initialize["params"]["workspaceFolders"][0]["uri"], initialize["params"]["rootUri"] ); let open_index = frames .iter() .position(|frame| frame["method"] == "textDocument/didOpen") .unwrap(); let initialized_index = frames .iter() .position(|frame| frame["method"] == "initialized") .unwrap(); assert!(initialized_index < open_index); assert_eq!( frames[open_index]["params"]["textDocument"]["languageId"], "fixture-language" ); assert_eq!( frames[open_index]["params"]["textDocument"]["text"], "A😀e\u{301}Z\n" ); assert!( frames[open_index]["params"]["textDocument"]["uri"] .as_str() .unwrap() .contains("%20") ); assert!( frames[open_index]["params"]["textDocument"]["uri"] .as_str() .unwrap() .contains("%CE%BB") ); assert_eq!( frames .iter() .find(|frame| frame["id"] == "pre-init-message") .unwrap()["result"], Value::Null ); assert_eq!( frames .iter() .find(|frame| frame["id"] == "settings") .unwrap()["result"], json!([{"cargo": {"allFeatures": true}}, null]) ); assert_eq!( frames.iter().find(|frame| frame["id"] == 0).unwrap()["error"]["code"], -32601 ); let target_id = edit_target(&mut session, &fixture); session.handle(Input::Home); for _ in 0..3 { session.handle(Input::Right); } session.handle(Input::Char(' ')); session.handle(Input::Char('d')); until(&mut session, &fixture, |session| { session.editor().buffer_id() == target_id }); assert_eq!(session.editor().buffer_count(), 2); assert_eq!(session.editor().cursor(), Cursor { row: 0, column: 1 }); assert_eq!(session.editor().mode(), Mode::Normal); assert_eq!(session.editor().lines(), &["😀e\u{301}disk", ""]); assert_eq!(fs::read_to_string(&fixture.target).unwrap(), "disk\n"); let definition = fixture .frames() .into_iter() .find(|frame| frame["method"] == "textDocument/definition") .unwrap(); assert_eq!( definition["params"]["position"], json!({"line": 0, "character": 5}) ); session.handle(Input::Ctrl('o')); assert_eq!(session.editor().buffer_id(), 1); assert_eq!(session.editor().cursor(), Cursor { row: 0, column: 3 }); assert_eq!(session.editor().lines(), &["A😀e\u{301}Z", ""]); session.handle(Input::Ctrl('i')); assert_eq!(session.editor().buffer_id(), target_id); assert_eq!(session.editor().cursor(), Cursor { row: 0, column: 1 }); assert_eq!(session.editor().lines(), &["😀e\u{301}disk", ""]); assert!(session.editor().dirty()); session.poll(); assert_eq!(fixture.method_count("textDocument/definition"), 1); session.execute("buffer 1"); session.execute("lsp.definition"); until(&mut session, &fixture, |session| { session.editor().buffer_id() == target_id }); assert_eq!(session.editor().cursor(), Cursor { row: 1, column: 0 }); assert!( session .editor() .message() .contains("first of 2 definitions") ); session.execute("buffer 1"); session.execute("lsp.definition"); until(&mut session, &fixture, |session| { session.editor().message().contains("no definition found") }); assert_eq!(session.editor().buffer_id(), 1); session.handle(Input::Ctrl('o')); assert_eq!(session.editor().buffer_id(), target_id); assert_eq!(session.editor().cursor(), Cursor { row: 1, column: 0 }); session.handle(Input::Ctrl('i')); assert_eq!(session.editor().buffer_id(), 1); session.poll(); assert_eq!(fixture.method_count("textDocument/definition"), 3); session.handle(Input::Char('A')); session.handle(Input::Char('!')); assert_eq!(session.editor().diagnostics().count(), 0); session.handle(Input::Escape); until(&mut session, &fixture, |session| { session .editor() .diagnostics() .any(|diagnostic| diagnostic.message.starts_with("revision ")) }); assert!( !session .editor() .diagnostics() .any(|diagnostic| diagnostic.message.contains("obsolete")) ); session.execute("w"); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/didSave") == 1 }); let save = fixture .frames() .into_iter() .find(|frame| frame["method"] == "textDocument/didSave") .unwrap(); assert_eq!(save["params"]["text"], "A😀e\u{301}Z!\n"); session.execute("bdelete 1"); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/didClose") == 1 }); assert_eq!(session.editor().buffer_id(), target_id); assert!(session.editor().dirty()); } #[test] fn lsp_initialization_and_incremental_sync_do_not_block_native_typing() { let fixture = Fixture::new(); let mut session = fixture.open("gated"); until(&mut session, &fixture, |_| { fixture.method_count("initialize") == 1 }); session.handle(Input::Char('A')); session.handle(Input::Char('!')); session.handle(Input::Escape); assert_eq!(session.editor().lines(), &["A😀e\u{301}Z!", ""]); assert_eq!(fixture.method_count("textDocument/didOpen"), 0); session.execute("lsp.diagnostics"); until(&mut session, &fixture, |session| { session.editor().message().contains("server initializing") }); fixture.release(); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); let opens: Vec<_> = fixture .frames() .into_iter() .filter(|frame| frame["method"] == "textDocument/didOpen") .collect(); assert_eq!(opens.len(), 1); assert_eq!( opens[0]["params"]["textDocument"]["text"], "A😀e\u{301}Z!\n" ); assert_eq!(opens[0]["params"]["textDocument"]["version"], 2); drop(session); let fixture = Fixture::new(); let mut session = fixture.open("incremental"); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); session.handle(Input::Char('A')); session.handle(Input::Char('!')); session.handle(Input::Escape); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/didChange") == 1 }); let change = fixture .frames() .into_iter() .find(|frame| frame["method"] == "textDocument/didChange") .unwrap(); assert_eq!( change["params"]["contentChanges"][0]["range"], json!({"start": {"line": 0, "character": 0}, "end": {"line": 1, "character": 0}}) ); assert_eq!( change["params"]["contentChanges"][0]["text"], "A😀e\u{301}Z!\n" ); assert_eq!(change["params"]["textDocument"]["version"], 2); } #[test] fn lsp_old_source_and_superseded_definitions_never_steal_focus() { let fixture = Fixture::new(); let mut session = fixture.open("stale"); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); session.execute("lsp.definition"); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/definition") == 1 }); session.handle(Input::Char('A')); session.handle(Input::Char('!')); assert_eq!(session.editor().mode(), Mode::Insert); assert_eq!(session.editor().lines(), &["A😀e\u{301}Z!", ""]); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/didChange") == 1 }); fixture.release(); until(&mut session, &fixture, |session| { session .editor() .message() .contains("stale response complete") }); assert_eq!(session.editor().buffer_id(), 1); assert_eq!(session.editor().mode(), Mode::Insert); session.handle(Input::Escape); session.handle(Input::Char('u')); assert_eq!(session.editor().lines(), &["A😀e\u{301}Z", ""]); let cursor = session.editor().cursor(); for input in [Input::Ctrl('o'), Input::Ctrl('i')] { session.handle(input); assert_eq!(session.editor().buffer_id(), 1); assert_eq!(session.editor().cursor(), cursor); } session.poll(); assert_eq!(fixture.method_count("textDocument/definition"), 1); drop(session); let fixture = Fixture::new(); let mut session = fixture.open("stale"); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); session.execute("lsp.definition"); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/definition") == 1 }); session.execute(&format!("edit {}", fixture.alternate.display())); let active_id = session.editor().buffer_id(); fixture.release(); until(&mut session, &fixture, |session| { session .editor() .message() .contains("stale response complete") }); assert_eq!(session.editor().buffer_id(), active_id); assert_eq!(session.editor().path(), Some(fixture.alternate.as_path())); assert_eq!(session.editor().buffer_count(), 2); session.handle(Input::Ctrl('o')); assert_eq!(session.editor().buffer_id(), 1); assert_eq!(session.editor().cursor(), Cursor { row: 0, column: 0 }); session.handle(Input::Ctrl('i')); assert_eq!(session.editor().buffer_id(), active_id); session.handle(Input::Ctrl('i')); assert_eq!(session.editor().buffer_id(), active_id); session.poll(); assert_eq!(fixture.method_count("textDocument/definition"), 1); drop(session); let fixture = Fixture::new(); let mut session = fixture.open("stale"); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); let source_cursor = session.editor().cursor(); session.execute("lsp.definition"); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/definition") == 1 }); session.execute(&format!("edit {}", fixture.alternate.display())); let alternate_id = session.editor().buffer_id(); session.handle(Input::Ctrl('o')); assert_eq!(session.editor().buffer_id(), 1); assert_eq!(session.editor().cursor(), source_cursor); fixture.release(); until(&mut session, &fixture, |session| { session .editor() .message() .contains("stale response complete") }); assert_eq!(session.editor().buffer_id(), 1); assert_eq!(session.editor().cursor(), source_cursor); assert_eq!(session.editor().buffer_count(), 2); session.handle(Input::Ctrl('i')); assert_eq!(session.editor().buffer_id(), alternate_id); assert_eq!(session.editor().path(), Some(fixture.alternate.as_path())); session.handle(Input::Ctrl('i')); assert_eq!(session.editor().buffer_id(), alternate_id); session.poll(); assert_eq!(fixture.method_count("textDocument/definition"), 1); drop(session); let fixture = Fixture::new(); let mut session = fixture.open("superseded"); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); session.execute("lsp.definition"); session.execute("lsp.definition"); until(&mut session, &fixture, |session| { session.editor().path() == Some(fixture.target.as_path()) }); assert_eq!(fixture.method_count("textDocument/definition"), 2); assert_eq!(session.editor().buffer_count(), 2); assert!( !session .editor() .buffers() .any(|buffer| buffer.path == Some(fixture.alternate.as_path())) ); let target_id = session.editor().buffer_id(); let destination = session.editor().cursor(); session.handle(Input::Ctrl('o')); assert_eq!(session.editor().buffer_id(), 1); assert_eq!(session.editor().cursor(), Cursor { row: 0, column: 0 }); session.handle(Input::Ctrl('o')); assert_eq!(session.editor().buffer_id(), 1); session.handle(Input::Ctrl('i')); assert_eq!(session.editor().buffer_id(), target_id); assert_eq!(session.editor().cursor(), destination); session.handle(Input::Ctrl('i')); assert_eq!(session.editor().buffer_id(), target_id); assert_eq!(session.editor().buffer_count(), 2); session.poll(); assert_eq!(fixture.method_count("textDocument/definition"), 2); } #[test] fn lsp_server_failures_and_unsupported_results_leave_native_editor_available() { for mode in [ "spawn", "malformed", "dead", "unsupported", "remote", "bounds", "missing", ] { let fixture = Fixture::new(); let mut session = fixture.open(mode); if matches!(mode, "spawn" | "malformed" | "dead") { until(&mut session, &fixture, |session| { session.editor().message().contains(if mode == "spawn" { "failed to start" } else { "server stopped" }) }); assert_eq!(session.editor().diagnostics().count(), 0); } else { until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); session.execute("lsp.definition"); until(&mut session, &fixture, |session| { session .editor() .message() .contains(if mode == "unsupported" { "does not support" } else { "definition failed" }) }); if mode == "unsupported" { assert_eq!(fixture.method_count("textDocument/definition"), 0); } } assert_eq!(session.editor().buffer_id(), 1, "{mode}"); let cursor = session.editor().cursor(); let definitions = fixture.method_count("textDocument/definition"); for input in [Input::Ctrl('o'), Input::Ctrl('i')] { session.handle(input); assert_eq!(session.editor().buffer_id(), 1, "{mode}"); assert_eq!(session.editor().cursor(), cursor, "{mode}"); } session.poll(); assert_eq!(fixture.method_count("textDocument/definition"), definitions); session.handle(Input::Char('A')); session.handle(Input::Char('!')); session.handle(Input::Escape); assert_eq!(session.editor().lines(), &["A😀e\u{301}Z!", ""], "{mode}"); session.handle(Input::Char('u')); assert_eq!(session.editor().lines(), &["A😀e\u{301}Z", ""], "{mode}"); } } #[test] fn lsp_optional_configuration_numeric_sync_and_unversioned_diagnostics() { let fixture = Fixture::new(); let session = EditorSession::open( Some(fixture.source.clone()), vec!["text".into(), "diagnostics".into()], None, ) .unwrap(); assert_eq!(session.editor().diagnostics().count(), 0); assert!(!fixture.log.exists()); drop(session); for mode in ["numeric", "unversioned"] { let fixture = Fixture::new(); let mut session = fixture.open(mode); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); session.handle(Input::Char('A')); session.handle(Input::Char('!')); session.handle(Input::Escape); until(&mut session, &fixture, |session| { session .editor() .diagnostics() .any(|diagnostic| diagnostic.message == "revision 2") }); let change = fixture .frames() .into_iter() .find(|frame| frame["method"] == "textDocument/didChange") .unwrap(); assert!(change["params"]["contentChanges"][0].get("range").is_none()); assert_eq!(change["params"]["textDocument"]["version"], 2); } let fixture = Fixture::new(); let mut session = fixture.open("none"); until(&mut session, &fixture, |_| { fixture .frames() .iter() .any(|frame| frame["id"] == "settings") }); session.handle(Input::Char('A')); session.handle(Input::Char('!')); session.handle(Input::Escape); session.execute("w"); session.handle(Input::Char(' ')); session.handle(Input::Char('D')); until(&mut session, &fixture, |session| { session .editor() .message() .contains("diagnostics update automatically") }); assert_eq!(fixture.method_count("textDocument/didOpen"), 0); assert_eq!(fixture.method_count("textDocument/didChange"), 0); assert_eq!(fixture.method_count("textDocument/didSave"), 0); } #[test] fn lsp_definition_reuses_dirty_targets_without_an_enabled_target_language() { let mut fixture = Fixture::new(); let target = fixture.target.with_extension("txt"); fs::rename(&fixture.target, &target).unwrap(); fixture.target = target; let mut session = fixture.open("basic"); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); let target_id = edit_target(&mut session, &fixture); session.execute("lsp.definition"); until(&mut session, &fixture, |session| { session.editor().buffer_id() == target_id }); assert_eq!(session.editor().cursor(), Cursor { row: 0, column: 1 }); assert_eq!(session.editor().lines(), &["😀e\u{301}disk", ""]); assert!(session.editor().dirty()); assert_eq!(fs::read_to_string(&fixture.target).unwrap(), "disk\n"); assert_eq!(fixture.method_count("textDocument/didOpen"), 1); session.handle(Input::Ctrl('o')); assert_eq!(session.editor().buffer_id(), 1); session.handle(Input::Ctrl('i')); assert_eq!(session.editor().buffer_id(), target_id); assert_eq!(session.editor().cursor(), Cursor { row: 0, column: 1 }); assert_eq!(session.editor().lines(), &["😀e\u{301}disk", ""]); assert!(session.editor().dirty()); session.poll(); assert_eq!(fixture.method_count("textDocument/definition"), 1); assert_eq!(fixture.method_count("textDocument/didOpen"), 1); session.handle(Input::Char('u')); assert_eq!(session.editor().lines(), &["disk", ""]); assert_eq!(fs::read_to_string(&fixture.target).unwrap(), "disk\n"); } #[test] fn lsp_definition_does_not_move_a_caret_that_has_moved_since_the_request() { let fixture = Fixture::new(); let mut session = fixture.open("stale"); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); session.execute("lsp.definition"); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/definition") == 1 }); session.handle(Input::Right); fixture.release(); until(&mut session, &fixture, |session| { session .editor() .message() .contains("stale response complete") }); assert_eq!(session.editor().buffer_id(), 1); assert_eq!(session.editor().buffer_count(), 1); assert_eq!(session.editor().cursor(), Cursor { row: 0, column: 1 }); for input in [Input::Ctrl('o'), Input::Ctrl('i')] { session.handle(input); assert_eq!(session.editor().buffer_id(), 1); assert_eq!(session.editor().cursor(), Cursor { row: 0, column: 1 }); } session.poll(); assert_eq!(fixture.method_count("textDocument/definition"), 1); } #[test] fn lsp_only_starts_an_explicitly_configured_server_when_a_matching_buffer_opens() { let fixture = Fixture::new(); let mut session = fixture.open("irrelevant"); session.execute("lsp.diagnostics"); until(&mut session, &fixture, |session| { session.editor().message().contains("no running server") }); assert!(!fixture.log.exists()); let custom = fixture.root.join("custom.myl"); fs::write(&custom, "custom language\n").unwrap(); session.execute(&format!("edit {}", custom.display())); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/didOpen") == 1 }); let frames = fixture.frames(); let open = frames .iter() .find(|frame| frame["method"] == "textDocument/didOpen") .unwrap(); assert_eq!( open["params"]["textDocument"]["languageId"], "fixture-language" ); assert_eq!(open["params"]["textDocument"]["text"], "custom language\n"); } #[test] fn lsp_session_shutdown_finishes_the_server_protocol_before_returning() { let fixture = Fixture::new(); let mut session = fixture.open("basic"); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); drop(session); assert_eq!(fixture.method_count("shutdown"), 1); } #[test] fn lsp_hover_typed_action_preserves_multiline_content_and_primary_utf16_position() { for (mode, expected) in [ ("hover-plain", "hover first\n😀e\u{301} second \nlast"), ("hover-markdown", "**Header**\n```rust\nfn main() {}\n```"), ("hover-marked", "explanation\n\nfn main() {\n}\n\ntail"), ("hover-string", "one\nsecond"), ] { let fixture = Fixture::new(); let mut session = fixture.open(mode); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); for _ in 0..3 { session.handle(Input::Right); } let before = session.editor().cursor(); session.handle(Input::Char('K')); until(&mut session, &fixture, |session| { session.editor().hover().is_some() }); assert_eq!(session.editor().hover().unwrap().text(), expected); assert_eq!(session.editor().cursor(), before); assert_eq!(session.editor().mode(), Mode::Normal); assert!(!session.editor().dirty()); let frames = fixture.frames(); let hover = frames .iter() .find(|frame| frame["method"] == "textDocument/hover") .unwrap(); assert_eq!( hover["params"]["position"], json!({"line": 0, "character": 5}) ); let initialize = frames .iter() .find(|frame| frame["method"] == "initialize") .unwrap(); assert_eq!( initialize["params"]["capabilities"]["textDocument"]["hover"]["contentFormat"], json!(["plaintext", "markdown"]) ); session.handle(Input::Down); assert_eq!(session.editor().cursor(), before); assert_eq!(session.editor().hover().unwrap().top, 1); session.handle(Input::Escape); assert!(session.editor().hover().is_none()); } } #[test] fn lsp_hover_queues_before_initialize_and_ignores_cancelled_and_superseded_requests() { let fixture = Fixture::new(); let mut session = fixture.open("hover-gated"); session.execute("lsp.diagnostics"); until(&mut session, &fixture, |session| { session.editor().message().contains("server initializing") }); assert_eq!(fixture.method_count("textDocument/hover"), 0); session.execute("lsp.hover"); fixture.release(); until(&mut session, &fixture, |session| { session.editor().hover().is_some() }); drop(session); for input in [Input::Escape, Input::Right, Input::Char('i')] { let fixture = Fixture::new(); let mut session = fixture.open("hover-stale"); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); session.execute("lsp.hover"); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/hover") == 1 }); session.handle(input); fixture.release(); until(&mut session, &fixture, |session| { session .editor() .message() .contains("stale response complete") }); assert!(session.editor().hover().is_none()); } let fixture = Fixture::new(); let mut session = fixture.open("hover-superseded"); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); session.execute("lsp.hover"); session.execute("lsp.hover"); until(&mut session, &fixture, |session| { session.editor().hover().is_some() }); assert_eq!(session.editor().hover().unwrap().text(), "new hover"); } #[test] fn lsp_hover_absent_unsupported_and_invalid_results_preserve_native_editing() { for mode in [ "hover-empty", "hover-unsupported", "hover-malformed", "hover-invalid-range", ] { let fixture = Fixture::new(); let mut session = fixture.open(mode); until(&mut session, &fixture, |session| { session.editor().diagnostics().count() == 2 }); session.execute("lsp.hover"); until(&mut session, &fixture, |session| { session .editor() .message() .contains(if mode == "hover-empty" { "no hover information" } else if mode == "hover-unsupported" { "does not support hover" } else { "hover failed" }) }); assert!(session.editor().hover().is_none()); assert_eq!( fixture.method_count("textDocument/hover"), usize::from(mode != "hover-unsupported") ); session.handle(Input::Char('A')); session.handle(Input::Char('!')); session.handle(Input::Escape); assert_eq!(session.editor().lines(), &["A😀e\u{301}Z!", ""]); session.handle(Input::Char('u')); assert_eq!(session.editor().lines(), &["A😀e\u{301}Z", ""]); assert_eq!(fixture.method_count("textDocument/definition"), 0); } } fn diagnostic_messages(session: &EditorSession) -> Vec<&str> { session .editor() .diagnostics() .map(|diagnostic| diagnostic.message.as_str()) .collect() } fn wait_protocol(fixture: &Fixture, predicate: impl Fn() -> bool) { let deadline = Instant::now() + Duration::from_secs(5); while !predicate() { assert!( Instant::now() < deadline, "fixture protocol gate did not complete: {:?}", fixture.frames() ); thread::sleep(Duration::from_millis(2)); } // Deliberately no session.poll(): outputs may be queued across a rename/close. } fn publish( session: &mut EditorSession, fixture: &Fixture, worker: usize, id: u64, command: Value, expected: &[&str], ) { fixture.control(worker, id, command); until(session, fixture, |session| { fixture.acknowledged(worker, id) && diagnostic_messages(session) == expected }); } #[test] fn lsp_python_stack_merges_in_assignment_order_and_routes_positions_only_to_ty() { let fixture = Fixture::new(); let mut session = fixture.open_stack(["controlled-gated", "controlled"], true); until(&mut session, &fixture, |_| { fixture.worker_count(0, "initialize") == 1 && fixture.worker_count(1, "textDocument/didOpen") == 1 }); assert_eq!(fixture.worker_count(0, "textDocument/didOpen"), 0); session.handle(Input::Char('A')); session.handle(Input::Char('!')); session.handle(Input::Escape); assert_eq!(session.editor().lines(), &["A😀e\u{301}Z!", ""]); session.execute("lsp.hover"); fixture.release(); until(&mut session, &fixture, |session| { session.editor().hover().is_some() }); assert_eq!(fixture.worker_count(0, "textDocument/hover"), 1); assert_eq!(fixture.worker_count(1, "textDocument/hover"), 0); for worker in 0..2 { let frames = fixture.worker_frames(worker); let initialize = frames .iter() .find(|frame| frame["method"] == "initialize") .unwrap(); assert!( initialize["params"]["capabilities"]["textDocument"] .get("diagnostic") .is_none() ); let open = frames .iter() .find(|frame| frame["method"] == "textDocument/didOpen") .unwrap(); assert_eq!(open["params"]["textDocument"]["languageId"], "python"); } publish( &mut session, &fixture, 1, 1, json!({"action": "publish", "message": "ruff"}), &["ruff"], ); publish( &mut session, &fixture, 0, 1, json!({"action": "publish", "message": "ty"}), &["ty", "ruff"], ); publish( &mut session, &fixture, 0, 2, json!({"action": "publish", "message": "ty replaced"}), &["ty replaced", "ruff"], ); publish( &mut session, &fixture, 1, 2, json!({"action": "clear"}), &["ty replaced"], ); publish( &mut session, &fixture, 1, 3, json!({"action": "publish", "message": "duplicate"}), &["ty replaced", "duplicate"], ); publish( &mut session, &fixture, 0, 3, json!({"action": "publish", "message": "duplicate"}), &["duplicate", "duplicate"], ); publish( &mut session, &fixture, 0, 4, json!({"action": "clear"}), &["duplicate"], ); publish( &mut session, &fixture, 1, 4, json!({"action": "clear"}), &[], ); publish( &mut session, &fixture, 0, 5, json!({"action": "publish", "message": "ty first"}), &["ty first"], ); publish( &mut session, &fixture, 1, 5, json!({"action": "publish", "message": "ruff second"}), &["ty first", "ruff second"], ); let target_id = edit_target(&mut session, &fixture); session.execute("lsp.definition"); until(&mut session, &fixture, |session| { session.editor().buffer_id() == target_id }); assert_eq!(session.editor().lines(), &["😀e\u{301}disk", ""]); assert_eq!(session.editor().cursor(), Cursor { row: 0, column: 1 }); assert_eq!(fixture.worker_count(0, "textDocument/definition"), 1); assert_eq!(fixture.worker_count(1, "textDocument/definition"), 0); session.execute("buffer 1"); assert_eq!(diagnostic_messages(&session), ["ty first", "ruff second"]); session.handle(Input::Char('A')); session.handle(Input::Char('?')); session.handle(Input::Escape); assert!(diagnostic_messages(&session).is_empty()); until(&mut session, &fixture, |_| { (0..2).all(|worker| { fixture.worker_frames(worker).iter().any(|frame| { frame["method"] == "textDocument/didChange" && frame["params"]["contentChanges"][0]["text"] == "A😀e\u{301}Z!?\n" }) }) }); publish( &mut session, &fixture, 1, 6, json!({"action": "publish", "version": 1, "message": "obsolete"}), &[], ); publish( &mut session, &fixture, 1, 7, json!({"action": "publish", "message": "new lint"}), &["new lint"], ); publish( &mut session, &fixture, 0, 6, json!({"action": "clear"}), &["new lint"], ); session.execute("w"); until(&mut session, &fixture, |_| { (0..2).all(|worker| fixture.worker_count(worker, "textDocument/didSave") == 1) }); session.execute("bdelete 1"); until(&mut session, &fixture, |_| { (0..2).all(|worker| fixture.worker_count(worker, "textDocument/didClose") == 1) }); assert_eq!(session.editor().buffer_id(), target_id); assert!( !fixture.worker_log(2).exists(), "overlapping losing language must never start" ); drop(session); for worker in 0..2 { assert_eq!(fixture.worker_count(worker, "shutdown"), 1); assert_eq!(fixture.worker_count(worker, "exit"), 1); } } #[test] fn lsp_python_stack_failures_retire_only_the_offender_in_active_and_parked_buffers() { for failing in 0..2 { for failure in ["spawn", "malformed", "die"] { let fixture = Fixture::new(); fs::write(&fixture.target, "A😀e\u{301}Z\n").unwrap(); let mut modes = ["controlled"; 2]; if failure == "spawn" { modes[failing] = "spawn"; } let mut session = fixture.open_stack(modes, true); let survivor = 1 - failing; until(&mut session, &fixture, |session| { fixture.worker_count(survivor, "textDocument/didOpen") == 1 && if failure == "spawn" { session.editor().message().contains("failed to start") } else { fixture.worker_count(failing, "textDocument/didOpen") == 1 } }); publish( &mut session, &fixture, survivor, 1, json!({"action": "publish", "message": "healthy source"}), &["healthy source"], ); if failure != "spawn" { let expected = if failing == 0 { ["failed source", "healthy source"] } else { ["healthy source", "failed source"] }; publish( &mut session, &fixture, failing, 1, json!({"action": "publish", "message": "failed source"}), &expected, ); } session.execute(&format!("edit {}", fixture.target.display())); until(&mut session, &fixture, |_| { fixture.worker_count(survivor, "textDocument/didOpen") == 2 && (failure == "spawn" || fixture.worker_count(failing, "textDocument/didOpen") == 2) }); let target_uri = fixture .worker_frames(survivor) .into_iter() .filter(|frame| frame["method"] == "textDocument/didOpen") .nth(1) .unwrap()["params"]["textDocument"]["uri"] .clone(); publish( &mut session, &fixture, survivor, 2, json!({"action": "publish", "uri": target_uri, "message": "healthy target"}), &["healthy target"], ); if failure != "spawn" { let expected = if failing == 0 { ["failed target", "healthy target"] } else { ["healthy target", "failed target"] }; publish( &mut session, &fixture, failing, 2, json!({"action": "publish", "uri": target_uri, "message": "failed target"}), &expected, ); fixture.control(failing, 3, json!({"action": failure})); until(&mut session, &fixture, |session| { session.editor().message().contains("server stopped") && diagnostic_messages(session) == ["healthy target"] }); } assert_eq!(diagnostic_messages(&session), ["healthy target"]); session.execute("buffer 1"); assert_eq!(diagnostic_messages(&session), ["healthy source"]); session.handle(Input::Char('A')); session.handle(Input::Char('!')); session.handle(Input::Escape); assert_eq!(session.editor().lines(), &["A😀e\u{301}Z!", ""]); assert!(diagnostic_messages(&session).is_empty()); until(&mut session, &fixture, |_| { fixture.worker_count(survivor, "textDocument/didChange") == 1 }); publish( &mut session, &fixture, survivor, 3, json!({"action": "publish", "version": 1, "message": "stale healthy"}), &[], ); publish( &mut session, &fixture, survivor, 4, json!({"action": "publish", "message": "healthy edit"}), &["healthy edit"], ); if failing == 0 { session.execute("lsp.definition"); until(&mut session, &fixture, |session| { session.editor().message().contains("no running server") }); assert_eq!(fixture.worker_count(1, "textDocument/definition"), 0); } else { session.execute("lsp.hover"); until(&mut session, &fixture, |session| { session.editor().hover().is_some() }); } assert!(!fixture.worker_log(2).exists()); } } } #[test] fn lsp_python_stack_discards_queued_same_revision_diagnostics_after_rename_and_close() { let fixture = Fixture::new(); let mut session = fixture.open_stack(["controlled", "controlled"], false); until(&mut session, &fixture, |_| { (0..2).all(|worker| fixture.worker_count(worker, "textDocument/didOpen") == 1) }); publish( &mut session, &fixture, 0, 1, json!({"action": "publish", "message": "before rename"}), &["before rename"], ); let revision = session.editor().context().revision; for worker in 0..2 { fixture.control( worker, 2, json!({"action": "publish", "message": "queued old path"}), ); } wait_protocol(&fixture, || { (0..2).all(|worker| fixture.acknowledged(worker, 2)) }); let renamed = fixture.root.join("renamed.rs"); session.execute(&format!("w {}", renamed.display())); assert_eq!(session.editor().context().revision, revision); until(&mut session, &fixture, |_| { (0..2).all(|worker| { fixture.worker_count(worker, "textDocument/didClose") == 1 && fixture.worker_count(worker, "textDocument/didOpen") == 2 }) }); assert!(diagnostic_messages(&session).is_empty()); let old_uri = fixture .worker_frames(0) .into_iter() .find(|frame| frame["method"] == "textDocument/didOpen") .unwrap()["params"]["textDocument"]["uri"] .clone(); let new_uri = fixture .worker_frames(0) .into_iter() .filter(|frame| frame["method"] == "textDocument/didOpen") .nth(1) .unwrap()["params"]["textDocument"]["uri"] .clone(); publish( &mut session, &fixture, 0, 3, json!({"action": "publish", "uri": old_uri, "message": "closed old path"}), &[], ); publish( &mut session, &fixture, 1, 3, json!({"action": "publish", "uri": new_uri, "message": "new path"}), &["new path"], ); fixture.control( 1, 4, json!({"action": "publish", "uri": new_uri, "message": "queued closed buffer"}), ); wait_protocol(&fixture, || fixture.acknowledged(1, 4)); session.execute("bdelete 1"); until(&mut session, &fixture, |_| { (0..2).all(|worker| fixture.worker_count(worker, "textDocument/didClose") == 2) }); assert!(!session.editor().has_buffer(1)); assert!(diagnostic_messages(&session).is_empty()); } #[test] fn lsp_python_stack_aggregate_message_limit_preserves_the_healthy_contribution() { let fixture = Fixture::new(); let mut session = fixture.open_stack(["controlled", "controlled"], false); until(&mut session, &fixture, |_| { (0..2).all(|worker| fixture.worker_count(worker, "textDocument/didOpen") == 1) }); let large = "x".repeat(2 * 1024 * 1024 + 1); fixture.control(0, 1, json!({"action": "publish", "message": large})); until(&mut session, &fixture, |session| { fixture.acknowledged(0, 1) && session.editor().diagnostics().count() == 1 }); assert_eq!( session.editor().diagnostics().next().unwrap().message.len(), large.len() ); fixture.control(1, 1, json!({"action": "publish", "message": large})); until(&mut session, &fixture, |session| { session .editor() .message() .contains("combined diagnostic messages exceed 4 MiB") }); assert_eq!(session.editor().diagnostics().count(), 1); assert_eq!( session.editor().diagnostics().next().unwrap().message.len(), large.len() ); publish( &mut session, &fixture, 0, 2, json!({"action": "publish", "message": "healthy replacement"}), &["healthy replacement"], ); session.handle(Input::Char('A')); session.handle(Input::Char('!')); session.handle(Input::Escape); assert_eq!(session.editor().lines(), &["A😀e\u{301}Z!", ""]); } #[test] fn lsp_python_stack_seeds_dirty_unserved_documents_before_lazy_startup() { let mut fixture = Fixture::new(); fixture.target = fixture.root.join("target.txt"); fs::write(&fixture.target, "disk\n").unwrap(); let mut session = fixture.open_stack_at(["controlled", "controlled"], false, &fixture.target); session.execute("lsp.diagnostics"); until(&mut session, &fixture, |session| { session.editor().message().contains("no running server") }); assert!(!fixture.worker_log(0).exists()); assert!(!fixture.worker_log(1).exists()); session.handle(Input::Char('i')); session.handle(Input::Paste("😀e\u{301}".into())); session.handle(Input::Escape); session.execute(&format!("edit {}", fixture.source.display())); until(&mut session, &fixture, |_| { (0..2).all(|worker| fixture.worker_count(worker, "textDocument/didOpen") == 1) }); session.execute("lsp.definition"); until(&mut session, &fixture, |session| { session.editor().buffer_id() == 1 }); assert_eq!(session.editor().lines(), &["😀e\u{301}disk", ""]); assert_eq!(session.editor().cursor(), Cursor { row: 0, column: 1 }); assert!(session.editor().dirty()); assert_eq!(fs::read_to_string(&fixture.target).unwrap(), "disk\n"); assert_eq!(fixture.worker_count(0, "textDocument/definition"), 1); assert_eq!(fixture.worker_count(1, "textDocument/definition"), 0); for worker in 0..2 { assert_eq!( fixture.worker_count(worker, "textDocument/didOpen"), 1, "the unserved target is cached, not opened on the wire" ); } } #[test] fn lsp_python_stack_does_not_fall_back_to_ruff_when_ty_lacks_position_capabilities() { let fixture = Fixture::new(); let mut session = fixture.open_stack(["controlled-unsupported", "controlled"], false); until(&mut session, &fixture, |_| { (0..2).all(|worker| fixture.worker_count(worker, "textDocument/didOpen") == 1) }); publish( &mut session, &fixture, 1, 1, json!({"action": "publish", "message": "lint remains available"}), &["lint remains available"], ); for command in ["lsp.definition", "lsp.hover"] { let previous_message = session.editor().message().to_owned(); session.execute(command); until(&mut session, &fixture, |session| { session.editor().message() != previous_message }); assert_eq!(session.editor().buffer_id(), 1); assert_eq!(diagnostic_messages(&session), ["lint remains available"]); } for worker in 0..2 { assert_eq!(fixture.worker_count(worker, "textDocument/definition"), 0); assert_eq!(fixture.worker_count(worker, "textDocument/hover"), 0); } } fn semantic_reply(session: &mut EditorSession, fixture: &Fixture, id: u64, response: Value) { fixture.control( 0, id, json!({"action": "semantic-result", "response": response}), ); wait_protocol(fixture, || fixture.acknowledged(0, id)); session.poll(); } #[test] fn lsp_semantics_are_automatic_full_or_whole_document_range_with_canonical_legends() { for mode in ["semantic-auto", "semantic-range"] { let fixture = Fixture::new(); fs::write(&fixture.source, "A😀e\u{301}Z\nnext\n").unwrap(); let mut session = fixture.open(mode); until(&mut session, &fixture, |session| { session.editor().semantic_tokens().len() == 5 && session.editor().diagnostics().count() == 2 }); let tokens = session.editor().semantic_tokens(); assert_eq!(tokens[0].kind, SemanticTokenKind::Type); assert_eq!(tokens[1].kind, SemanticTokenKind::Variable); assert_eq!(tokens[1].start, TextPosition { row: 0, column: 1 }); assert_eq!(tokens[1].end, TextPosition { row: 0, column: 2 }); assert_eq!(tokens[1].modifiers, SemanticTokenModifier::Readonly as u16); assert_eq!(tokens[2].kind, SemanticTokenKind::Function); assert_eq!( tokens[2].modifiers, SemanticTokenModifier::Declaration as u16 | SemanticTokenModifier::Async as u16 ); assert_eq!(tokens[3].kind, SemanticTokenKind::Comment); assert_eq!( tokens[3].modifiers, SemanticTokenModifier::DefaultLibrary as u16 ); assert_eq!(tokens[2].start, tokens[3].start); assert_eq!(tokens[2].end, tokens[3].end); assert_eq!(tokens[4].start, TextPosition { row: 1, column: 0 }); assert_eq!(tokens[4].end, TextPosition { row: 1, column: 4 }); let frames = fixture.frames(); let request = frames .iter() .find(|frame| { frame["method"] == if mode == "semantic-range" { "textDocument/semanticTokens/range" } else { "textDocument/semanticTokens/full" } }) .unwrap(); if mode == "semantic-range" { assert_eq!( request["params"]["range"], json!({"start": {"line": 0, "character": 0}, "end": {"line": 2, "character": 0}}) ); assert_eq!(fixture.method_count("textDocument/semanticTokens/full"), 0); } else { assert!(request["params"].get("range").is_none()); assert_eq!(fixture.method_count("textDocument/semanticTokens/range"), 0); } assert_eq!( fixture.method_count("textDocument/semanticTokens/full/delta"), 0 ); let initialize = frames .iter() .find(|frame| frame["method"] == "initialize") .unwrap(); assert_eq!( initialize["params"]["capabilities"]["textDocument"]["semanticTokens"]["requests"]["full"], true ); assert_eq!( initialize["params"]["capabilities"]["workspace"]["semanticTokens"]["refreshSupport"], true ); } } #[test] fn lsp_semantics_never_request_unsupported_primary_or_supporting_sibling() { for modes in [ ["controlled", "controlled-semantic"], ["controlled-semantic", "controlled-semantic"], ] { let fixture = Fixture::new(); let mut session = fixture.open_stack(modes, false); until(&mut session, &fixture, |_| { (0..2).all(|worker| fixture.worker_count(worker, "textDocument/didOpen") == 1) && (modes[0] == "controlled" || fixture.worker_count(0, "textDocument/semanticTokens/full") == 1) }); for worker in 0..2 { fixture.control(worker, 1, json!({"action": "refresh"})); } until(&mut session, &fixture, |_| { (0..2).all(|worker| fixture.acknowledged(worker, 1)) }); assert_eq!( fixture.worker_count(1, "textDocument/semanticTokens/full"), 0 ); assert_eq!( fixture.worker_count(1, "textDocument/semanticTokens/range"), 0 ); if modes[0] == "controlled" { assert_eq!( fixture.worker_count(0, "textDocument/semanticTokens/full"), 0 ); assert_eq!( fixture.worker_count(0, "textDocument/semanticTokens/range"), 0 ); } else { semantic_reply( &mut session, &fixture, 2, json!({"result": {"data": [0, 0, 1, 1, 0]}}), ); until(&mut session, &fixture, |_| { fixture.worker_count(0, "textDocument/semanticTokens/full") == 2 }); assert!(session.editor().semantic_tokens().is_empty()); semantic_reply( &mut session, &fixture, 3, json!({"result": {"data": [0, 0, 1, 1, 0]}}), ); assert_eq!(session.editor().semantic_tokens().len(), 1); } } } #[test] fn lsp_semantics_coalesce_changed_text_and_refresh_without_decoding_stale_payloads() { let fixture = Fixture::new(); let mut session = fixture.open("controlled-semantic"); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/semanticTokens/full") == 1 }); session.handle(Input::Char('A')); session.handle(Input::Char('!')); session.handle(Input::Char('?')); session.handle(Input::Escape); until(&mut session, &fixture, |_| { fixture.frames().iter().any(|frame| { frame["method"] == "textDocument/didChange" && frame["params"]["contentChanges"][0]["text"] == "A😀e\u{301}Z!?\n" }) }); assert_eq!(fixture.method_count("textDocument/semanticTokens/full"), 1); semantic_reply( &mut session, &fixture, 1, json!({"result": {"data": ["stale malformed data"]}}), ); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/semanticTokens/full") == 2 }); assert!( !session .editor() .message() .contains("semantic tokens failed") ); assert!(session.editor().semantic_tokens().is_empty()); fixture.control(0, 2, json!({"action": "refresh"})); until(&mut session, &fixture, |_| fixture.acknowledged(0, 2)); assert_eq!(fixture.method_count("textDocument/semanticTokens/full"), 2); semantic_reply( &mut session, &fixture, 3, json!({"result": {"data": [0, 0, 1, 4, 0]}}), ); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/semanticTokens/full") == 3 }); assert!(session.editor().semantic_tokens().is_empty()); semantic_reply( &mut session, &fixture, 4, json!({"result": {"data": [0, 6, 2, 1, 0]}}), ); let tokens = session.editor().semantic_tokens(); assert_eq!(tokens.len(), 1); assert_eq!(tokens[0].start, TextPosition { row: 0, column: 4 }); assert_eq!(tokens[0].end, TextPosition { row: 0, column: 6 }); let frames = fixture.frames(); let change = frames .iter() .rposition(|frame| frame["method"] == "textDocument/didChange") .unwrap(); let request = frames .iter() .rposition(|frame| frame["method"] == "textDocument/semanticTokens/full") .unwrap(); assert!(change < request); assert!(frames.iter().any(|frame| frame["id"] == "refresh-2" && frame["result"].is_null() && frame.get("result").is_some())); } #[test] fn lsp_semantics_discard_queued_same_revision_rename_and_close_outputs() { let fixture = Fixture::new(); let mut session = fixture.open("controlled-semantic"); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/semanticTokens/full") == 1 }); fixture.control( 0, 1, json!({"action": "semantic-result", "response": {"result": {"data": [0, 0, 1, 1, 0]}}}), ); wait_protocol(&fixture, || fixture.acknowledged(0, 1)); let revision = session.editor().context().revision; let renamed = fixture.root.join("renamed.rs"); session.execute(&format!("w {}", renamed.display())); assert_eq!(session.editor().context().revision, revision); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/semanticTokens/full") == 2 && fixture.method_count("textDocument/didClose") == 1 }); assert!(session.editor().semantic_tokens().is_empty()); semantic_reply( &mut session, &fixture, 2, json!({"result": {"data": [0, 0, 1, 4, 0]}}), ); assert_eq!( session.editor().semantic_tokens()[0].kind, SemanticTokenKind::Type ); fixture.control(0, 3, json!({"action": "refresh"})); until(&mut session, &fixture, |_| { fixture.acknowledged(0, 3) && fixture.method_count("textDocument/semanticTokens/full") == 3 }); let renamed_again = fixture.root.join("renamed-again.rs"); session.execute(&format!("w {}", renamed_again.display())); assert_eq!(session.editor().context().revision, revision); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/didClose") == 2 }); assert_eq!(fixture.method_count("textDocument/semanticTokens/full"), 3); semantic_reply( &mut session, &fixture, 4, json!({"result": {"data": ["old path malformed"]}}), ); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/semanticTokens/full") == 4 }); assert!(session.editor().semantic_tokens().is_empty()); assert!( !session .editor() .message() .contains("semantic tokens failed") ); semantic_reply( &mut session, &fixture, 5, json!({"result": {"data": [0, 0, 1, 4, 0]}}), ); fixture.control(0, 6, json!({"action": "refresh"})); until(&mut session, &fixture, |_| { fixture.acknowledged(0, 6) && fixture.method_count("textDocument/semanticTokens/full") == 5 }); fixture.control( 0, 7, json!({"action": "semantic-result", "response": {"result": {"data": [0, 0, 1, 1, 0]}}}), ); wait_protocol(&fixture, || fixture.acknowledged(0, 7)); session.execute("bdelete 1"); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/didClose") == 3 }); assert!(!session.editor().has_buffer(1)); assert!(session.editor().semantic_tokens().is_empty()); session.execute(&format!("edit {}", renamed_again.display())); let reopened = session.editor().buffer_id(); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/semanticTokens/full") == 6 }); session.execute(&format!("bdelete {reopened}")); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/didClose") == 4 }); semantic_reply( &mut session, &fixture, 8, json!({"result": {"data": ["closed malformed"]}}), ); assert!(session.editor().semantic_tokens().is_empty()); assert!( !session .editor() .message() .contains("semantic tokens failed") ); } #[test] fn lsp_semantic_empty_null_and_feature_errors_keep_diagnostics_hover_and_definition() { let fixture = Fixture::new(); let mut session = fixture.open("controlled-semantic"); until(&mut session, &fixture, |_| { fixture.method_count("textDocument/semanticTokens/full") == 1 }); semantic_reply( &mut session, &fixture, 1, json!({"result": {"data": [0, 0, 1, 1, 0]}}), ); assert_eq!(session.editor().semantic_tokens().len(), 1); publish( &mut session, &fixture, 0, 2, json!({"action": "publish", "message": "lint intact"}), &["lint intact"], ); for (index, response) in [ json!({"result": null}), json!({"result": {"data": []}}), json!({"result": {"data": [0, 0, 1, 1]}}), json!({"result": {"data": [0, 2, 1, 0, 0]}}), json!({"result": {"data": [0, 0, 1, 1, 32]}}), json!({"error": {"code": -32603, "message": "feature error"}}), json!({"error": {"code": "bad", "message": "malformed error"}}), json!({"result": null, "error": {"code": -1, "message": "both"}}), json!({}), ] .into_iter() .enumerate() { let id = 3 + index as u64 * 4; fixture.control(0, id, json!({"action": "refresh"})); until(&mut session, &fixture, |_| fixture.acknowledged(0, id)); assert_eq!( session.editor().semantic_tokens().len(), 1, "same-text refresh retains the existing overlay until its result" ); semantic_reply(&mut session, &fixture, id + 1, response); assert!(session.editor().semantic_tokens().is_empty()); assert_eq!(diagnostic_messages(&session), ["lint intact"]); if index >= 2 { assert!( session .editor() .message() .contains("semantic tokens failed") ); } fixture.control(0, id + 2, json!({"action": "refresh"})); until(&mut session, &fixture, |_| fixture.acknowledged(0, id + 2)); semantic_reply( &mut session, &fixture, id + 3, json!({"result": {"data": [0, 0, 1, 1, 0]}}), ); assert_eq!(session.editor().semantic_tokens().len(), 1); } session.execute("lsp.hover"); until(&mut session, &fixture, |session| { session.editor().hover().is_some() }); assert_eq!(diagnostic_messages(&session), ["lint intact"]); session.execute("lsp.definition"); until(&mut session, &fixture, |session| { session.editor().buffer_id() != 1 }); assert_eq!(session.editor().lines(), &["disk", ""]); session.execute("buffer 1"); assert_eq!(diagnostic_messages(&session), ["lint intact"]); assert_eq!(session.editor().semantic_tokens().len(), 1); } #[test] fn lsp_semantic_primary_retirement_clears_active_and_parked_without_sibling_takeover() { for failing in 0..2 { let fixture = Fixture::new(); fs::write(&fixture.target, "A😀e\u{301}Z\n").unwrap(); let mut session = fixture.open_stack(["controlled-semantic"; 2], false); until(&mut session, &fixture, |_| { fixture.worker_count(0, "textDocument/semanticTokens/full") == 1 && fixture.worker_count(1, "textDocument/didOpen") == 1 }); semantic_reply( &mut session, &fixture, 1, json!({"result": {"data": [0, 0, 1, 1, 0]}}), ); for worker in 0..2 { fixture.control( worker, 2, json!({"action": "publish", "message": if worker == failing { "retiring" } else { "healthy" }}), ); } until(&mut session, &fixture, |_| { (0..2).all(|worker| fixture.acknowledged(worker, 2)) }); session.execute(&format!("edit {}", fixture.target.display())); until(&mut session, &fixture, |_| { fixture.worker_count(0, "textDocument/semanticTokens/full") == 2 && fixture.worker_count(1, "textDocument/didOpen") == 2 }); semantic_reply( &mut session, &fixture, 3, json!({"result": {"data": [0, 0, 1, 1, 0]}}), ); let target_uri = fixture .worker_frames(0) .into_iter() .filter(|frame| frame["method"] == "textDocument/didOpen") .nth(1) .unwrap()["params"]["textDocument"]["uri"] .clone(); for worker in 0..2 { fixture.control( worker, 4, json!({"action": "publish", "uri": target_uri, "message": if worker == failing { "retiring" } else { "healthy" }}), ); } until(&mut session, &fixture, |_| { (0..2).all(|worker| fixture.acknowledged(worker, 4)) }); fixture.control(failing, 5, json!({"action": "die"})); until(&mut session, &fixture, |session| { session.editor().message().contains("server stopped") && diagnostic_messages(session) == ["healthy"] }); assert_eq!( session.editor().semantic_tokens().len(), usize::from(failing != 0) ); session.execute("buffer 1"); assert_eq!(diagnostic_messages(&session), ["healthy"]); assert_eq!( session.editor().semantic_tokens().len(), usize::from(failing != 0) ); assert_eq!( fixture.worker_count(1, "textDocument/semanticTokens/full"), 0 ); } }