diff --git a/Cargo.lock b/Cargo.lock index c76a936..c6137b3 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2725,7 +2725,6 @@ dependencies = [ name = "lutra-terminal" version = "0.0.0" dependencies = [ - "lutra-proc", "portable-pty", "proptest", "tempfile", diff --git a/crates/engine/src/cmd/lsp_assist.rs b/crates/engine/src/cmd/lsp_assist.rs index d45ae26..a4fb69b 100644 --- a/crates/engine/src/cmd/lsp_assist.rs +++ b/crates/engine/src/cmd/lsp_assist.rs @@ -19,14 +19,6 @@ //! runs these commands through the `engine_execute_waiting` IPC, on a //! worker thread, so the window never waits either. //! -//! **Superseded completions:** CodeMirror asks again as the user types and -//! drops the older answer. Each new `lsp.completion` therefore cancels the -//! previous one still pending on the same server (`$/cancelRequest`, via -//! [`Server::cancel`]), so Phpactor stops computing a list nobody reads. -//! The cancelled command resolves with the empty result, not an error. -//! Hover and signature help are not cancelled: they are asked once per -//! pause, not per keystroke. -//! //! Without a session (no project, toolchain not ready, server failed) the //! commands fail with `failed`; a server that does not offer the feature, //! and a buffer that is not PHP, give the empty result. Server answers are @@ -34,12 +26,11 @@ //! empty result. use std::path::Path; -use std::sync::{Mutex, PoisonError}; use std::time::Duration; use lutra_lsp::types::position_to_json; use lutra_lsp::uri::path_to_uri; -use lutra_lsp::{LspError, Range, RequestId, Server}; +use lutra_lsp::{LspError, Range, Server}; use lutra_text::{ColumnUnit, Position}; use serde::Deserialize; use serde_json::{Map, Value, json}; @@ -74,13 +65,6 @@ pub const REQUEST_TIMEOUT: Duration = Duration::from_secs(10); /// for the queue in front of it ([`Pending::wait`] adds one more second). const WAIT_TIMEOUT: Duration = Duration::from_secs(11); -/// The latest `textDocument/completion` request: the address of the -/// [`Server`] it went to and its id. One slot for the process is enough: -/// there is one PHP session per engine, and a slot taken over by another -/// engine's server only means one older request runs to its end. The -/// address keeps a request from being cancelled on another server. -static LATEST_COMPLETION: Mutex> = Mutex::new(None); - /// Registers the commands of this module. /// /// # Errors @@ -162,7 +146,6 @@ impl Command for Completion { None => json!({"triggerKind": 1}), }), convert: completion_result, - supersede: true, }, ) } @@ -200,7 +183,6 @@ impl Command for Hover { empty: json!({ "contents": "" }), context: None, convert: hover_result, - supersede: false, }, ) } @@ -238,7 +220,6 @@ impl Command for SignatureHelp { empty: json!({ "signatures": [], "activeSignature": 0, "activeParameter": 0 }), context: None, convert: signature_result, - supersede: false, }, ) } @@ -262,9 +243,6 @@ struct Ask { context: Option, /// Converts the server's answer into the command's result. convert: fn(&Value) -> Value, - /// Whether this request cancels the previous one of its kind still - /// pending (completion; see the module docs). - supersede: bool, } /// Validates the request, queues it on the session (see the module docs) @@ -284,7 +262,6 @@ fn ask(state: &mut State, ask: Ask) -> Result { empty, context, convert, - supersede, } = ask; let open = state .buffers @@ -323,28 +300,17 @@ fn ask(state: &mut State, ask: Ask) -> Result { let _ = sender.send(Ok(empty)); return; } - let empty = empty.clone(); - if supersede { - cancel_latest(server); - } let reply = sender.clone(); let sent = server.request_with( method, request, REQUEST_TIMEOUT, Box::new(move |result: Result| { - let _ = reply.send(match result { - Err(LspError::Cancelled) => Ok(empty), - other => other.map(|value| convert(&value)), - }); + let _ = reply.send(result.map(|value| convert(&value))); }), ); - match sent { - Ok(request) if supersede => remember_latest(server, request), - Ok(_) => {} - Err(e) => { - let _ = sender.send(Err(e)); - } + if let Err(e) = sent { + let _ = sender.send(Err(e)); } }); if !queued { @@ -359,33 +325,6 @@ fn ask(state: &mut State, ask: Ask) -> Result { ))) } -/// The address that identifies `server` in [`LATEST_COMPLETION`]. -fn server_key(server: &Server) -> usize { - std::ptr::from_ref(server).addr() -} - -/// Cancels the latest completion request if it went to `server` and is -/// still pending; its command then resolves with the empty result. A -/// poisoned slot is used as it is: it only holds plain data. -fn cancel_latest(server: &Server) { - let latest = LATEST_COMPLETION - .lock() - .unwrap_or_else(PoisonError::into_inner) - .take(); - if let Some((key, id)) = latest - && key == server_key(server) - { - server.cancel(id); - } -} - -/// Records `id` as the latest completion request, sent to `server`. -fn remember_latest(server: &Server, id: RequestId) { - *LATEST_COMPLETION - .lock() - .unwrap_or_else(PoisonError::into_inner) = Some((server_key(server), id)); -} - /// The command's value from the converted answer. /// /// # Errors diff --git a/crates/engine/tests/lsp_assist.rs b/crates/engine/tests/lsp_assist.rs index 70e8cb1..a057f23 100644 --- a/crates/engine/tests/lsp_assist.rs +++ b/crates/engine/tests/lsp_assist.rs @@ -147,39 +147,6 @@ fn completion_sees_the_edit_before_it_and_is_capped() { assert_eq!(items[0]["label"], "item000"); } -#[test] -fn a_new_completion_cancels_the_one_it_supersedes() { - let (_dir, mut engine) = project(&[("a.php", " ExitCode { let role = std::env::args().nth(1).unwrap_or_default(); match role.as_str() { "tree-plain" | "tree-proc" => tree(role == "tree-proc"), - "tree-on-input" => { - let mut line = String::new(); - if std::io::stdin().lock().read_line(&mut line).is_err() { - return ExitCode::from(3); - } - tree(false) - } _ => ExitCode::from(2), } } diff --git a/crates/proc/src/lib.rs b/crates/proc/src/lib.rs index 27475eb..2249e49 100644 --- a/crates/proc/src/lib.rs +++ b/crates/proc/src/lib.rs @@ -25,17 +25,10 @@ //! by an explicit [`Child::kill`] or drop, which then signal the direct //! child only. //! -//! A child started by [`spawn`] runs before it is put into its job (Windows) -//! or before its watchdog exists (Unix), so a grandchild it starts in that -//! window (microseconds) can escape. Short-lived tools (git, `php -l`, the -//! PHP probe) accept that: they start their own children (git hooks) much -//! later, when they are in the job already. [`spawn_suspended`] closes the -//! window on Windows for long-lived children (Phpactor) at the cost of a -//! system-wide thread snapshot (about 60 ms per start). -//! -//! [`adopt`] (Windows) puts a process started by someone else, the -//! integrated terminal's ConPTY shell, into a kill-on-close job and returns -//! a [`Guard`] that holds it. +//! A child starts running before it is put into its job (Windows) or before +//! its watchdog exists (Unix), so a grandchild it starts in that window +//! (microseconds) can escape; language servers and git start their own +//! children much later. use std::io; use std::ops::{Deref, DerefMut}; @@ -97,46 +90,10 @@ pub struct Child { /// starting the watchdog). When the group cannot be set up, the child that /// was already started is killed and reaped before the error is returned, /// so it never runs unguarded. -pub fn spawn(command: Command) -> io::Result { - spawn_with(command, Group::prepare, Group::attach) -} - -/// Like [`spawn`], but on Windows the child is created suspended and resumed -/// only once it is in its job, so not even its first instruction runs -/// outside it. Meant for long-lived children: finding the child's primary -/// thread to resume it takes a snapshot of every thread on the machine -/// (about 60 ms). On other platforms it is [`spawn`]. -/// -/// On Windows the creation flags of `command` are replaced by -/// `CREATE_SUSPENDED | CREATE_NO_WINDOW`. -/// -/// # Errors -/// The errors of [`spawn`], and on Windows the error of resuming the child; -/// the child is killed and reaped before an error is returned. -pub fn spawn_suspended(command: Command) -> io::Result { - #[cfg(windows)] - { - spawn_with(command, Group::prepare_suspended, Group::attach_suspended) - } - #[cfg(not(windows))] - { - spawn(command) - } -} - -/// Starts `command` after `prepare` and puts it into the group `attach` -/// creates; kills and reaps the child when `attach` fails. -/// -/// # Errors -/// The error of [`Command::spawn`] or of `attach`. -fn spawn_with( - mut command: Command, - prepare: fn(&mut Command), - attach: fn(&std::process::Child) -> io::Result, -) -> io::Result { - prepare(&mut command); +pub fn spawn(mut command: Command) -> io::Result { + Group::prepare(&mut command); let mut inner = command.spawn()?; - match attach(&inner) { + match Group::attach(&inner) { Ok(group) => Ok(Child { inner, group }), Err(error) => { let _ = inner.kill(); @@ -146,53 +103,6 @@ fn spawn_with( } } -/// A kill-on-close job for a process Lutra did not start through [`spawn`] -/// (Windows only, see [`adopt`]). Dropping it kills the process and -/// everything it started. -#[cfg(windows)] -pub struct Guard { - /// The job object. - group: Group, -} - -/// Puts the process behind `process` into a new kill-on-close job, so it -/// and everything it starts from now on die with Lutra or with the returned -/// [`Guard`]. Processes it started before are not adopted. -/// -/// `process` needs `PROCESS_SET_QUOTA | PROCESS_TERMINATE` access (a handle -/// from `CreateProcess` has all access) and stays owned by the caller. -/// -/// # Errors -/// The OS error of creating the job or assigning the process to it. -#[cfg(windows)] -pub fn adopt(process: std::os::windows::io::RawHandle) -> io::Result { - Group::adopt(process).map(|group| Guard { group }) -} - -#[cfg(windows)] -impl Guard { - /// Terminates every process in the job. - pub fn kill(&mut self) { - self.group.kill(); - } -} - -#[cfg(windows)] -impl std::fmt::Debug for Guard { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - f.debug_struct("Guard").finish_non_exhaustive() - } -} - -#[cfg(windows)] -impl Drop for Guard { - /// Kills the job's processes; closing the job handle right after would - /// do the same. - fn drop(&mut self) { - self.group.kill(); - } -} - impl Child { /// Kills the child and every process in its group, without waiting for /// the child; call [`std::process::Child::wait`] to reap it. diff --git a/crates/proc/src/windows.rs b/crates/proc/src/windows.rs index 4a9a2b8..0f152e8 100644 --- a/crates/proc/src/windows.rs +++ b/crates/proc/src/windows.rs @@ -1,46 +1,23 @@ //! Windows: one job object per child with `JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE` //! (). //! -//! A child started with [`Group::prepare`] runs before it joins its job (a -//! window of microseconds). [`Group::prepare_suspended`] closes that window: -//! the child is created suspended (`CREATE_SUSPENDED`), put into its job and -//! only then resumed. The standard library keeps the primary thread's handle -//! to itself, so the thread is found through a Tool Help snapshot of the -//! system's threads (`CreateToolhelp32Snapshot`, `Thread32First` / -//! `Thread32Next`) and resumed with `OpenThread` + `ResumeThread`. The -//! snapshot covers every thread on the machine and costs about 60 ms -//! (measured 2026-10-27: 43 → 107 ms per `cmd /c exit`), which is why only -//! long-lived children pay for it. -//! -//! [`Group::adopt`] puts a process someone else started (the terminal's -//! ConPTY shell) into a new job by its handle. -//! -//! This is the one module in Lutra that allows `unsafe`: the job object, -//! Tool Help and thread APIs are only reachable through FFI. Every call gets -//! valid arguments by construction: handles come from `CreateJobObjectW`, -//! `CreateToolhelp32Snapshot` or `OpenThread` (owned by an [`OwnedHandle`] -//! right away) or from a live [`std::process::Child`], and the limit and -//! thread entry structures are plain C structs that are valid when zeroed. +//! This is the one module in Lutra that allows `unsafe`: the job object API +//! is only reachable through FFI. Every call gets valid arguments by +//! construction: handles come from `CreateJobObjectW` (owned by an +//! [`OwnedHandle`] right away) or from a live [`std::process::Child`], and +//! the limit structure is a plain C struct that is valid when zeroed. #![allow(unsafe_code)] use std::io; -use std::os::windows::io::{AsRawHandle, FromRawHandle, OwnedHandle, RawHandle}; -use std::os::windows::process::CommandExt; +use std::os::windows::io::{AsRawHandle, FromRawHandle, OwnedHandle}; use std::process::Command; -use windows_sys::Win32::Foundation::INVALID_HANDLE_VALUE; -use windows_sys::Win32::System::Diagnostics::ToolHelp::{ - CreateToolhelp32Snapshot, TH32CS_SNAPTHREAD, THREADENTRY32, Thread32First, Thread32Next, -}; use windows_sys::Win32::System::JobObjects::{ AssignProcessToJobObject, CreateJobObjectW, JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE, JOBOBJECT_EXTENDED_LIMIT_INFORMATION, JobObjectExtendedLimitInformation, SetInformationJobObject, TerminateJobObject, }; -use windows_sys::Win32::System::Threading::{ - CREATE_NO_WINDOW, CREATE_SUSPENDED, OpenThread, ResumeThread, THREAD_SUSPEND_RESUME, -}; /// The exit code a process killed with its job reports. const KILLED_EXIT_CODE: u32 = 1; @@ -63,40 +40,6 @@ impl Group { /// The OS error of `CreateJobObjectW`, `SetInformationJobObject` or /// `AssignProcessToJobObject`. pub(crate) fn attach(child: &std::process::Child) -> io::Result { - Self::adopt(child.as_raw_handle()) - } - - /// Makes the process start suspended and without a console window - /// (`CREATE_SUSPENDED | CREATE_NO_WINDOW`). These replace any creation - /// flags set on `command` before: the standard library cannot read them - /// back, and every tool Lutra runs is a console program whose window - /// must stay hidden. - pub(crate) fn prepare_suspended(command: &mut Command) { - command.creation_flags(CREATE_SUSPENDED | CREATE_NO_WINDOW); - } - - /// Creates a kill-on-close job, puts the suspended `child` into it and - /// resumes it. - /// - /// # Errors - /// The errors of [`Group::attach`] and of resuming the child (see - /// [`resume`]). The job is closed on error, which kills the child once - /// it is in the job. - pub(crate) fn attach_suspended(child: &std::process::Child) -> io::Result { - let group = Self::attach(child)?; - resume(child.id())?; - Ok(group) - } - - /// Creates a kill-on-close job and puts the process behind `process` - /// into it. The handle needs `PROCESS_SET_QUOTA | PROCESS_TERMINATE` - /// access (a handle from `CreateProcess` has all access) and stays owned - /// by the caller. - /// - /// # Errors - /// The OS error of `CreateJobObjectW`, `SetInformationJobObject` or - /// `AssignProcessToJobObject`. - pub(crate) fn adopt(process: RawHandle) -> io::Result { let raw = unsafe { CreateJobObjectW(std::ptr::null(), std::ptr::null()) }; if raw.is_null() { return Err(io::Error::last_os_error()); @@ -117,7 +60,8 @@ impl Group { if set == 0 { return Err(io::Error::last_os_error()); } - let assigned = unsafe { AssignProcessToJobObject(job.as_raw_handle(), process) }; + let assigned = + unsafe { AssignProcessToJobObject(job.as_raw_handle(), child.as_raw_handle()) }; if assigned == 0 { return Err(io::Error::last_os_error()); } @@ -131,52 +75,3 @@ impl Group { let _ = unsafe { TerminateJobObject(self.job.as_raw_handle(), KILLED_EXIT_CODE) }; } } - -/// Resumes every thread of the suspended process `pid`. A process created -/// with `CREATE_SUSPENDED` has exactly one thread, its primary thread, with -/// a suspend count of one. -/// -/// # Errors -/// The OS error of `CreateToolhelp32Snapshot`, `OpenThread` or -/// `ResumeThread`, or `NotFound` when the snapshot holds no thread of `pid`. -fn resume(pid: u32) -> io::Result<()> { - let raw = unsafe { CreateToolhelp32Snapshot(TH32CS_SNAPTHREAD, 0) }; - if raw == INVALID_HANDLE_VALUE || raw.is_null() { - return Err(io::Error::last_os_error()); - } - let snapshot = unsafe { OwnedHandle::from_raw_handle(raw) }; - let mut entry: THREADENTRY32 = unsafe { std::mem::zeroed() }; - entry.dwSize = u32::try_from(std::mem::size_of::()).map_err(io::Error::other)?; - let mut resumed = 0usize; - let mut more = unsafe { Thread32First(snapshot.as_raw_handle(), &raw mut entry) } != 0; - while more { - if entry.th32OwnerProcessID == pid { - resume_thread(entry.th32ThreadID)?; - resumed += 1; - } - more = unsafe { Thread32Next(snapshot.as_raw_handle(), &raw mut entry) } != 0; - } - if resumed == 0 { - return Err(io::Error::new( - io::ErrorKind::NotFound, - format!("no thread of process {pid} to resume"), - )); - } - Ok(()) -} - -/// Opens thread `tid` and decrements its suspend count once. -/// -/// # Errors -/// The OS error of `OpenThread` or `ResumeThread`. -fn resume_thread(tid: u32) -> io::Result<()> { - let raw = unsafe { OpenThread(THREAD_SUSPEND_RESUME, 0, tid) }; - if raw.is_null() { - return Err(io::Error::last_os_error()); - } - let thread = unsafe { OwnedHandle::from_raw_handle(raw) }; - if unsafe { ResumeThread(thread.as_raw_handle()) } == u32::MAX { - return Err(io::Error::last_os_error()); - } - Ok(()) -} diff --git a/crates/proc/tests/process_tree.rs b/crates/proc/tests/process_tree.rs index c9e5663..7cc3b2f 100644 --- a/crates/proc/tests/process_tree.rs +++ b/crates/proc/tests/process_tree.rs @@ -8,7 +8,7 @@ #![allow(clippy::unwrap_used)] -use std::io::{BufRead, BufReader, Read, Write}; +use std::io::{BufRead, BufReader, Read}; use std::process::{ChildStdout, Command, Stdio}; use std::sync::mpsc; use std::thread; @@ -101,37 +101,3 @@ fn a_missing_program_is_an_error() { let error = lutra_proc::spawn(Command::new("lutra-proc-no-such-program")).unwrap_err(); assert_eq!(error.kind(), std::io::ErrorKind::NotFound); } - -#[test] -fn a_suspended_start_runs_and_takes_the_whole_tree() { - let mut child = lutra_proc::spawn_suspended(helper("unknown-role")).unwrap(); - assert_eq!(child.wait().unwrap().code(), Some(2)); - let mut parent = lutra_proc::spawn_suspended(helper("tree-plain")).unwrap(); - let reader = ready(parent.stdout.take().unwrap()); - drop(parent); - assert_gone(reader); -} - -#[test] -fn hard_kill_works_when_a_suspended_start_parent_guards_its_child() { - let mut parent = lutra_proc::spawn_suspended(helper("tree-proc")).unwrap(); - let reader = ready(parent.stdout.take().unwrap()); - std::process::Child::kill(&mut parent).unwrap(); - parent.wait().unwrap(); - assert_gone(reader); -} - -#[cfg(windows)] -#[test] -fn dropping_an_adopt_guard_takes_the_tree_started_after_it() { - use std::os::windows::io::AsRawHandle; - let mut command = helper("tree-on-input"); - command.stdin(Stdio::piped()); - let mut parent = command.spawn().unwrap(); - let guard = lutra_proc::adopt(parent.as_raw_handle()).unwrap(); - parent.stdin.take().unwrap().write_all(b"go\n").unwrap(); - let reader = ready(parent.stdout.take().unwrap()); - drop(guard); - assert_gone(reader); - parent.wait().unwrap(); -} diff --git a/crates/syntax/tests/properties.proptest-regressions b/crates/syntax/tests/properties.proptest-regressions index a530005..aa3e02b 100644 --- a/crates/syntax/tests/properties.proptest-regressions +++ b/crates/syntax/tests/properties.proptest-regressions @@ -6,4 +6,3 @@ # everyone who runs the test benefits from these saved cases. cc c8b0a3ee622e3fac3ec69a94aebc22f23c9b3870156159ba6d9c2c5387d5eced # shrinks to fixture = Index(0), steps = [[(5318099958520493566, 19, 12), (10643632058251538265, 19, 18)], [(11062977690082286900, 37, 1)], [(3728561719478013405, 20, 10)]] cc 3129b8640200f6a3b49b6579ba02346c578c68a5fb37bf929f93fb1aa0f4ef9b # shrinks to fixture = Index(14757395258967641293), steps = [[(14373769676898819633, 13, 21)], [(0, 0, 0)]] -cc 4efe36814ff9aa1f8c9bdc1fad55604ae0481a45732032f1c02d772977c1be4b # shrinks to fixture = Index(0), seeds = [(8685451444708560058, 1, 15)] diff --git a/crates/syntax/tests/properties.rs b/crates/syntax/tests/properties.rs index e631bc6..d323e61 100644 --- a/crates/syntax/tests/properties.rs +++ b/crates/syntax/tests/properties.rs @@ -3,17 +3,9 @@ //! //! tree-sitter recovers from syntax errors heuristically, and the recovery //! may differ between an incremental and a fresh parse of the same broken -//! text. Equality is therefore asserted whenever the edited text parses -//! without errors, and an undo round trip must always end at the fresh -//! result of the (error-free) original. -//! -//! Equality means the same outline, the same folding ranges and the same -//! sequence of leaf node kinds, not the same S-expression: an incremental -//! reparse may reuse a node where a fresh parse picks another wrapper for -//! the same tokens (tree-sitter-php 0.25.1 keeps `(union_type -//! (primitive_type))` for `array &$cache` after an undo, a fresh parse gives -//! `(primitive_type)`). Every structural feature Lutra builds on the tree -//! reads outline, folding or leaves, so wrapper nodes may differ. +//! text. Tree equality is therefore asserted whenever the edited text +//! parses without errors, and an undo round trip must always end at the +//! fresh tree of the (error-free) original. #![allow( clippy::unwrap_used, @@ -95,18 +87,6 @@ fn edit_for(text: &str, (start, len, fragment): (usize, usize, usize)) -> Edit { Edit::replace(start..end.max(start), FRAGMENTS[fragment]) } -/// The kinds of the named leaf nodes of `tree`, in document order, read -/// from its S-expression: a leaf is a node that closes right after its kind. -fn leaf_kinds(tree: &lutra_syntax::Tree) -> Vec { - let sexp = tree.to_sexp().replace('(', " ( ").replace(')', " ) "); - let tokens: Vec<&str> = sexp.split_whitespace().collect(); - tokens - .windows(3) - .filter(|window| window[0] == "(" && window[2] == ")") - .map(|window| window[1].to_owned()) - .collect() -} - proptest! { #![proptest_config(ProptestConfig::with_cases(256))] @@ -154,7 +134,7 @@ proptest! { let _ = outline(&tree); let _ = folding(&tree); if !fresh.has_errors() { - prop_assert_eq!(leaf_kinds(&tree), leaf_kinds(&fresh)); + prop_assert_eq!(tree.to_sexp(), fresh.to_sexp()); prop_assert_eq!(outline(&tree), outline(&fresh)); prop_assert_eq!(folding(&tree), folding(&fresh)); } @@ -186,7 +166,7 @@ proptest! { } prop_assert_eq!(tree.text().text(), original); if !expected.has_errors() { - prop_assert_eq!(leaf_kinds(&tree), leaf_kinds(&expected)); + prop_assert_eq!(tree.to_sexp(), expected.to_sexp()); prop_assert_eq!(outline(&tree), outline(&expected)); prop_assert_eq!(folding(&tree), folding(&expected)); } diff --git a/crates/terminal/Cargo.toml b/crates/terminal/Cargo.toml index 5cc1bd2..21f6b12 100644 --- a/crates/terminal/Cargo.toml +++ b/crates/terminal/Cargo.toml @@ -15,9 +15,6 @@ layer = 3 portable-pty = "0.9.0" thiserror = "2.0.21" -[target.'cfg(windows)'.dependencies] -lutra-proc.workspace = true - [lints] workspace = true diff --git a/crates/terminal/src/session.rs b/crates/terminal/src/session.rs index c85ba52..250ec04 100644 --- a/crates/terminal/src/session.rs +++ b/crates/terminal/src/session.rs @@ -132,10 +132,6 @@ pub struct Session { killer: Box, /// Process id of the shell, if the platform reports one. pid: Option, - /// The kill-on-close job the shell was adopted into (Windows), so the - /// shell and what it started die with the session or with Lutra. - #[cfg(windows)] - guard: lutra_proc::Guard, } impl std::fmt::Debug for Session { @@ -193,15 +189,6 @@ impl Session { } let mut child = pair.slave.spawn_command(cmd).map_err(spawn_error)?; drop(pair.slave); - #[cfg(windows)] - let guard = match adopt(child.as_ref()) { - Ok(guard) => guard, - Err(e) => { - let _ = child.kill(); - let _ = child.wait(); - return Err(e); - } - }; let mut killer = child.clone_killer(); let pid = child.process_id(); let started = (|| { @@ -248,8 +235,6 @@ impl Session { master, killer, pid, - #[cfg(windows)] - guard, }) } @@ -359,9 +344,7 @@ impl Session { } /// Kills the shell unless it already exited, stops the reader and drops - /// buffered output. The pty closes once the waiter sees the exit. On - /// Windows it also kills every process left in the shell's job, such as - /// a background server the shell started, even after the shell exited. + /// buffered output. The pty closes once the waiter sees the exit. /// Killing is best effort: an error means the process is already gone, /// so it is ignored. pub fn kill(&mut self) { @@ -377,27 +360,9 @@ impl Session { if !exited { let _ = self.killer.kill(); } - #[cfg(windows)] - self.guard.kill(); } } -/// Adopts the ConPTY shell `child` into a kill-on-close job -/// ([`lutra_proc::adopt`]). The shell runs for a few microseconds before -/// that; a process it starts in that window is not in the job, and the -/// pseudo console still ends it when Lutra closes its pipes. -/// -/// # Errors -/// [`TerminalError::Spawn`] when portable-pty gives no process handle or -/// the job cannot be set up. -#[cfg(windows)] -fn adopt(child: &dyn portable_pty::Child) -> Result { - let handle = child - .as_raw_handle() - .ok_or_else(|| TerminalError::Spawn("the shell has no process handle".into()))?; - lutra_proc::adopt(handle).map_err(spawn_error) -} - impl Drop for Session { fn drop(&mut self) { self.kill(); diff --git a/docs/architecture.md b/docs/architecture.md index 84f9df8..10ef649 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -264,7 +264,7 @@ Watched directories: the VFS watcher is non-recursive, so `project.children` wat `crates/syntax` (L1, depends on `lutra-text` only) parses PHP with tree-sitter (`tree-sitter` 0.26, `tree-sitter-php` 0.25, both MIT; the grammar variant that accepts inline HTML around ` Tree` (never fails), `parser.reparse(&Tree, &[lutra_text::Edit]) -> Result`, `outline(&Tree) -> Vec`, `folding(&Tree) -> Vec`. `Tree` carries the text it was parsed from (a `lutra_text::Buffer`, cheap to clone) plus `truncated()` and `has_errors()`; that is why `outline` takes no separate text argument (the contract sketch had `outline(tree, text)`): a tree and a mismatching text can't be combined. -- **Reparse:** the edit batch has `Buffer::apply` semantics (ranges against the old text, any order). It is mapped to one tree-sitter `InputEdit` covering the smallest start to the largest end, with points (row, byte column, rows by `\n` as tree-sitter counts them) computed from the old and new text. Proptests check that a reparse gives the same leaf node kinds, outline and folding as a fresh parse whenever the edited text is error-free, and that an undo round trip ends at the original's. They compare leaves, not the whole S-expression (F3): an incremental reparse may keep a wrapper node a fresh parse does not build (tree-sitter-php 0.25.1, the newest release, keeps `(union_type (primitive_type))` for `array &$cache` after an undo where a fresh parse gives `(primitive_type)`), and nothing Lutra builds on the tree reads those wrappers. On broken code tree-sitter's error recovery may legitimately differ between an incremental and a fresh parse; the engine can reparse from scratch when it wants a canonical tree (for example on save). +- **Reparse:** the edit batch has `Buffer::apply` semantics (ranges against the old text, any order). It is mapped to one tree-sitter `InputEdit` covering the smallest start to the largest end, with points (row, byte column, rows by `\n` as tree-sitter counts them) computed from the old and new text. Proptests check that a reparse gives the same tree, outline and folding as a fresh parse whenever the edited text is error-free, and that an undo round trip ends at the original tree. On broken code tree-sitter's error recovery may legitimately differ between an incremental and a fresh parse; the engine can reparse from scratch when it wants a canonical tree (for example on save). - **Outline:** `OutlineItem {kind, name, detail, range, selection_range, children}`; `OutlineKind::as_str()` gives the contract names (`namespace`, `class`, …, `enumCase`). Braced and unbraced namespaces (an unbraced one owns everything up to the next namespace statement), promoted constructor parameters as properties after the constructor, enum cases with backing values, multi-element `const`/property declarations as one item each, attributes inside the declaration range. Anonymous classes are classes named `class@anonymous` (`OutlineItem::is_anonymous`, for the index to skip). Function, method and closure bodies are not searched; statements at file level are (`if (!function_exists(…)) { function … }`). Error nodes are transparent and nameless declarations are dropped. The search descends at most 96 levels. - **Folding:** multi-line brace blocks (class-like bodies, function and control bodies, `switch`/`match`), arrays, comments, heredoc/nowdoc, `use A\{…}` groups and runs of two or more `use` statements; ranges include the delimiters. The walk is iterative and skips the inside of single-line nodes. - **Positions:** 0-based line and UTF-16 column through `Buffer::offset_to_position` (about 1 µs per conversion on a 1 MB rope; the parse dominates). @@ -343,11 +343,9 @@ Watched directories: the VFS watcher is non-recursive, so `project.children` wat - **Windows:** one job object per child with `JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE` (`windows-sys`). Lutra holds the only handle, so dropping the `Child` or the end of Lutra's process (the kernel closes its handles) kills the child and everything it started. Jobs nest (Windows 8+), so this works when Lutra itself runs in a job (terminal, `cargo`, CI). `crates/proc/src/windows.rs` is the only module that allows `unsafe` (FFI). - **Unix:** the child leads a new process group; a `/bin/sh` watchdog in its own group blocks on a pipe only Lutra holds and sends `SIGKILL` to the child's group when the pipe closes (drop, kill, quit, or a `SIGKILL` of Lutra). Left behind after a `SIGKILL` of Lutra: processes that left the group themselves (`setsid`/`setpgid`, daemons), and the child if Lutra dies between starting it and starting its watchdog. Compiled and tested by CI only (no Unix machine here). - `Child` dereferences to `std::process::Child`. `Child::kill` replaces the standard `kill` and takes the whole group; `kill_and_wait` also reaps; `Drop` kills the group and reaps. -- A child of `spawn` runs for a moment before it joins its job (Windows) or before its watchdog exists (Unix); a grandchild started in those microseconds can escape. Short-lived tools (git, `php -l`, the `php -v` probe) keep this path: git starts hooks long after it is in its job. -- `lutra_proc::spawn_suspended` (F3) closes the window on Windows for long-lived children (Phpactor): `CREATE_SUSPENDED | CREATE_NO_WINDOW` (replacing the command's creation flags), assign to the job, then resume the primary thread. std keeps the thread handle to itself, so the thread is found with a Tool Help snapshot (`CreateToolhelp32Snapshot` + `Thread32First/Next`, `OpenThread` + `ResumeThread`). The snapshot covers every thread on the machine. Measured 2026-10-27, debug, 30× `cmd /c exit`, other builds running: std 35–38 ms, std + `CREATE_NO_WINDOW` 54–55 ms, `spawn` 55–65 ms (unchanged from H1), `spawn_suspended` 130–187 ms. That is why git does not use it. On Unix it is `spawn`. -- `lutra_proc::adopt(RawHandle) -> io::Result` (Windows, F3) puts a process someone else started into a new kill-on-close job; dropping the `Guard` or `Guard::kill` ends the process and everything it started since. -- Tests: `crates/proc/tests/process_tree.rs` starts `lutra-proc-helper`, which starts a sleeping grandchild holding the test's pipe. A hard kill of the helper (`TerminateProcess` / `SIGKILL`, with and without the helper itself in a group), `Child::kill` and drop each end the tree; the pipe reaches end of file. Without `KILL_ON_JOB_CLOSE` the hard-kill tests fail. The same runs for `spawn_suspended`, and `adopt` is tested with a helper that starts its grandchild only after a line on stdin, i.e. after the adoption (9 tests). -- The integrated terminal (portable-pty): on Windows the ConPTY shell is adopted into a job right after it starts (`portable_pty::Child::as_raw_handle`, F3). `Session::kill` and drop kill the job, so processes the shell started (a dev server, `start /b`) end with the terminal tab or with Lutra, even after the shell itself exited. A process the shell starts in the microseconds before the adoption is not in the job; the ConPTY host still ends its console clients when its pipes break. On Unix portable-pty makes the shell a session leader, and closing the PTY master on Lutra's exit hangs it up. +- A child runs for a moment before it joins its job (Windows) or before its watchdog exists (Unix); a grandchild started in those microseconds can escape. +- Tests: `crates/proc/tests/process_tree.rs` starts `lutra-proc-helper`, which starts a sleeping grandchild holding the test's pipe. A hard kill of the helper (`TerminateProcess` / `SIGKILL`, with and without the helper itself in a group), `Child::kill` and drop each end the tree; the pipe reaches end of file. Without `KILL_ON_JOB_CLOSE` the hard-kill tests fail. +- The integrated terminal (portable-pty) does not use it yet. On Unix portable-pty makes the shell a session leader, and closing the PTY master on Lutra's exit hangs it up. On Windows the ConPTY host ends its clients when its pipes break; joining the shell to a job needs an adopt-by-handle API (`portable_pty::Child::as_raw_handle`), a follow-up. ### Terminal (M3.6) @@ -424,7 +422,7 @@ Watched directories: the VFS watcher is non-recursive, so `project.children` wat - After an edit: 1.8 s and 2.7–2.9 s, including Phpactor's 1 s debounce. - Without the adjustments: no diagnostics within 180 s. - **Known gaps:** - - ~~A Phpactor process outlives Lutra when Lutra is killed.~~ Fixed by H1: Phpactor starts through `lutra_proc::spawn` (since F3 `spawn_suspended`; see Child processes). + - ~~A Phpactor process outlives Lutra when Lutra is killed.~~ Fixed by H1: Phpactor starts through `lutra_proc::spawn` (see Child processes). - ~~`window/showMessage` and `logMessage` are dropped, and server-initiated progress is not shown.~~ Fixed by H3. - **Tests:** - `crates/engine/tests/lsp.rs` has 10 tests against `lutra-lsp-fake`: sync incl. UTF-16 and CRLF edits, diagnostics list/clear, reload resync, requests after edits, project close, restart, quit, missing server, crash and give-up, no server without a project, and a proptest of random edits. The ignored `real_phpactor_reports_diagnostics` runs with `LUTRA_PHPACTOR=`. @@ -468,7 +466,6 @@ Watched directories: the VFS watcher is non-recursive, so `project.children` wat - Under the lock the command validates, runs the LSP pump once (so a buffer opened a moment ago is opened on the server first) and queues a closure with `lsp::submit`. That runs after every queued `didChange`. - The closure sends the request with `request_with` (timeout 10 s). The reply callback converts the answer on the client thread, so a big list is never converted under the lock. - It sends the result into the `Pending`'s channel. The host waits without the lock (wait 11 s + 1 s grace) and resolves. - - **Superseded completions (F3):** each `lsp.completion` cancels the previous completion request still pending on the same server (`Server::cancel`, which sends `$/cancelRequest`) before it sends its own; CodeMirror has dropped that answer anyway. The cancelled command resolves with the empty result, not an error. The latest request is one process-wide slot keyed by the server's address. Hover and signature help are not cancelled. Test: `a_new_completion_cancels_the_one_it_supersedes` (the fake server holds a completion while the text contains `SLOW`). - The UI calls these commands with `runWaiting` (`engine_execute_waiting`, off the main thread). - **Editor:** - **Before a request,** the UI awaits the buffer sync's `idle()` and drops the request if the document changed meanwhile. Positions are lines and UTF-16 columns, which CodeMirror counts the same way within a line, so CRLF files need no conversion. @@ -654,7 +651,6 @@ Watched directories: the VFS watcher is non-recursive, so `project.children` wat | Date | Change | Summary | |---|---|---| -| 2026-10-27 | minor | F3: `lutra_proc::spawn_suspended` (Phpactor) and `adopt` (ConPTY shell in a job), cancel superseded completions, syntax proptests compare leaf kinds | | 2026-10-27 | minor | C6 F1: remote branch checkout without a configured remote (`--no-track`), `git.lastMessage` and the Amend prefill, one shared git status store | | 2026-10-27 | minor | F2: `ui.screenshot` through WebView2 `CapturePreview` without focus; region fallback elsewhere; `--control` windows open unfocused | | 2026-10-26 | minor | M4.5: branches (status-bar item, popup, `vcs.branches`, `vcs.newBranch`, `vcs.checkout`) | diff --git a/docs/development.md b/docs/development.md index b8686dc..4665c7e 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,6 +1,6 @@ # Development -> **Status:** draft · **Last updated:** 2026-10-27 +> **Status:** draft · **Last updated:** 2026-10-14 ## Prerequisites @@ -18,31 +18,7 @@ cargo xtask ci # the full quality gate, run before every commit cargo xtask fixtures # create Symfony and Laravel reference projects in target/fixtures/ ``` -## Data directories - -A `--control PORT` instance keeps its settings, recovery journal and webview data in `/lutra-control//`, never in your own data directory, so a dev or agent instance cannot change your settings or restore your journal. `--data-dir DIR` or `LUTRA_DATA_DIR=DIR` pick another directory, for any instance: - -```sh -cargo run -p lutra-desktop -- --control 7979 --data-dir target/lutra-data . -``` - -Delete the folder to start fresh. Its window opens without taking the foreground, and `ui.screenshot` never focuses it; only `app.focus` does. To check that on Windows, build with `--features bundled-ui` and run `LUTRA_DESKTOP_EXE=/debug/lutra-desktop.exe LUTRA_CONTROL_PORT= cargo test -p lutra-desktop --test screenshot_focus -- --ignored`. - -## Build directories and parallel work - -- Keep `CARGO_TARGET_DIR` inside the repository folder: the default `target/`, or `/target` per git worktree (`/target/` is gitignored). Antivirus exclusions usually cover the checkout. On Windows, unsigned binaries built outside an excluded folder have taken about 26 s to start each child process (Phpactor, git, the test helpers) against 28 ms inside, which makes tests time out. -- Several builds in parallel (agents, worktrees): give each its own `CARGO_TARGET_DIR` and limit the jobs, e.g. `CARGO_BUILD_JOBS=4`. Delete a worktree's target directory once its work is merged; a full build takes about 10 GB. - -## Deleting `ui/node_modules` - -pnpm hardlinks packages from its shared store. Deleting `ui/node_modules` with Git Bash `rm -rf` on Windows breaks those links for other checkouts and makes their running Vitest fail with `EBUSY`. Delete it with either of: - -```sh -cmd //c "rmdir /s /q ui\node_modules" -node -e "require('fs').rmSync('ui/node_modules',{recursive:true,force:true})" -``` - -Then run `pnpm --dir ui install` again. +A `--control PORT` instance keeps its settings, recovery journal and webview data in `/lutra-control//`, never in your own data directory; `--data-dir DIR` or `LUTRA_DATA_DIR=DIR` pick another directory. Delete the folder to start fresh. Its window opens without taking the foreground, and `ui.screenshot` never focuses it; only `app.focus` does. To check that on Windows, build with `--features bundled-ui` and run `LUTRA_DESKTOP_EXE=/debug/lutra-desktop.exe LUTRA_CONTROL_PORT= cargo test -p lutra-desktop --test screenshot_focus -- --ignored`. ## Robustness: Lutra never crashes @@ -56,7 +32,6 @@ No inline comments. Doc comment blocks above modules, functions, types and field | Date | Change | Summary | |---|---|---| -| 2026-10-27 | minor | F3: data directories, build directories inside the repository, parallel builds, deleting `ui/node_modules` | | 2026-10-27 | minor | Unfocused `--control` windows and the screenshot focus check (F2) | | 2026-10-25 | minor | Isolated data directory for `--control` instances (H6) | | 2026-10-14 | minor | Node.js 22.12+ required by the frontend toolchain | diff --git a/docs/gaps.md b/docs/gaps.md index c19a314..5dea8ae 100644 --- a/docs/gaps.md +++ b/docs/gaps.md @@ -36,8 +36,6 @@ G11 progress: M1.7 added the crash-recovery journal: unsaved buffers are written G11 progress (H6): development and live-check instances no longer share the user's data. `--data-dir PATH` / `LUTRA_DATA_DIR` move settings, the recovery journal, the rendezvous file and the WebView2 user data (local storage) into one directory; `--control PORT` without either uses `/lutra-control//`. The Phpactor cache stays shared from the user's data directory. An isolated instance never forwards to or registers as the user's main instance. A unit test drives an isolated `--control` engine through the control channel (`settings.set`, journal write) and checks the user directory is byte-for-byte unchanged. -G11 progress (F3): Phpactor starts suspended and joins its kill-on-close job before its first instruction (`lutra_proc::spawn_suspended`); git and `php -l` keep the cheaper `spawn` (the suspended start costs about 60 ms more per process). The terminal's ConPTY shell is adopted into a job, so a dev server started in the terminal ends with the tab or with Lutra. A superseded completion request is cancelled with `$/cancelRequest`. The syntax undo round-trip proptest no longer fails on a wrapper node tree-sitter keeps after an incremental reparse (it compares leaf kinds, outline and folding). Not verified with a hard kill of the running app (Daniel at the PC). - G14 progress: M1.11 moved every UI string in `ui/src` into the English catalog `ui/src/i18n/en.json` behind `t(key, params?)`, enforced by `vue/no-bare-strings-in-template` and a catalog test. Messages the engine sends (`EngineError.message`, the slogan from `app.about`) are still English text; they need message keys with params before a second language can cover them. G5 progress: M2.3 landed the find-in-files backend: `crates/search` (parallel walk with the project's ignore rules, literal or regex, case, whole word, globs, binary and size skips, match cap, cancel) and the engine commands `search.find` / `search.cancel` with streamed `searchResults` and `searchDone` events; dirty buffers are searched in their buffer text. First result on a generated 20k-file tree 10–43 ms (release, measured). M2.4 added the Find tool window in a new bottom panel (options, globs, grouped and highlighted results, counts, cancel, truncated hint, keyboard navigation, `editor.reveal`, `find.open` `Mod+Alt+F` with prefill). M2.5 added the first symbol index (`crates/index`: every project file, PHP declarations from tree-sitter outlines, vendor as library, parallel build off the engine lock, incremental on disk and buffer changes, cancelled on project close) and the commands `index.status`, `goto.file`, `goto.class`, `goto.symbol` with `indexProgress`/`indexReady` events; a generated 20k-file project (88 MB of PHP) indexes in 3.9–4.2 s (release, measured, target 5 s), queries take 2–12 ms. M2.6 added the go-to popup (Files / Classes / Symbols tabs, `Mod+P`, `Mod+Alt+C`, `Mod+T`, live fuzzy results with marked characters, library rows labelled, indexing hint, `editor.reveal`). Open in G5: replace in files, scopes and history, go-to extras (recent files on an empty query, a non-project toggle, `:line`, file-type filter), an index that survives restarts, changes in directories the non-recursive watcher does not watch, usages. @@ -54,7 +52,6 @@ G6 progress: M3.2 landed the LSP client library in `crates/lsp`: JSON-RPC framin | Date | Change | Summary | |---|---|---| -| 2026-10-27 | minor | G11 note: suspended Phpactor start, terminal shell in a job, completion cancel, syntax proptest (F3) | | 2026-10-27 | patch | G8: amend prefill, remote checkout fix, shared status store (C6 F1) | | 2026-10-27 | minor | Screenshot item shrunk: webview capture without focus on Windows (F2) | | 2026-10-26 | minor | G8 shrunk: branch widget and popup (M4.5) |