fresh-editor 0.3.9

//! Reproducer for the dev-container LSP "Go to Definition" path-translation
//! bug.
//!
//! Background. Container authorities mount the host workspace into the
//! container at `remoteWorkspaceFolder` — typically not the same string
//! as the host workspace path. The editor's [`FilesystemSpec::Local`]
//! doc-comment claims paths "translate 1:1 between host and container",
//! and that's true for the *bytes* of the prefix once you cross the
//! mount, but it isn't true for the *path string itself*: a host
//! workspace at `/tmp/xxx/proj` shows up inside the container at
//! `/workspaces/proj`. The LSP server runs in the container, so URIs in
//! its outgoing `textDocument/*` traffic and incoming `Location`
//! responses use the container-side path. The editor lives on the host,
//! so its buffer file paths are host-side. There's currently no
//! translation between the two — that's the bug, and this test pins it.
//!
//! What this test does. It drives a real attach via the in-tree fake
//! devcontainer CLI, configures the Python LSP to point at
//! [`scripts/fake-lsp/bin/fake-pylsp`] (a bash stub that records every
//! URI it receives and answers `definition` with a configurable
//! `Location`), opens a host file, and triggers Go-to-Definition. The
//! fake LSP is set up to claim the definition lives at
//! `file:///workspaces/proj/util.py` — a *container* path that doesn't
//! exist on the host. The test then asserts both translation
//! directions:
//!
//!   * **host → container** (`didOpen` URI must use the container
//!     path the editor told docker to mount at, not the host path);
//!   * **container → host** (after the `Location` comes back, the
//!     active buffer's host path must resolve to `util.py` *on the
//!     host*, and the cursor must land at the line/character the LSP
//!     returned).
//!
//! The test is expected to fail today because the editor sends host
//! URIs in `didOpen` and opens the literal container URI from the
//! definition response. The fix lives in the URI-construction sites
//! around `app/types.rs:file_path_to_lsp_uri` and the inverse
//! `app/mod.rs:uri_to_path` — those need to know about the active
//! authority's host↔container path mapping.

#![cfg(all(unix, feature = "plugins"))]

use crate::common::harness::{copy_plugin, copy_plugin_lib, EditorTestHarness, HarnessOptions};
use crate::common::tracing::init_tracing_from_env;
use crossterm::event::{KeyCode, KeyModifiers};
use std::fs;
use std::path::{Path, PathBuf};
use std::time::{Duration, Instant};

/// Pre-flight checks that must hold before the test attempts to talk
/// to the fake LSP. These are cheap, deterministic invariants that
/// fail loudly with an actionable message instead of letting a
/// missing `python3` (the fake-pylsp shebang) or a stripped-execute
/// bit on the script silently degrade into a 180s nextest timeout.
///
/// Pattern stolen from the rest of the suite: any infra problem that
/// is going to make the test pointless should panic *before* the
/// long wait_untils start, so CI logs show the cause on the line the
/// test fails.
fn assert_test_infra() {
    // 1. python3 must resolve via PATH — that's how the fake-pylsp
    //    shebang (`#!/usr/bin/env python3`) finds an interpreter.
    //    On macOS CI both `/usr/bin/python3` (XCode tools) and
    //    `/usr/local/bin/python3` (Homebrew) usually work; we just
    //    need *some* python3 that `env` can find.
    match std::process::Command::new("python3")
        .arg("--version")
        .output()
    {
        Ok(out) if out.status.success() => {
            eprintln!(
                "[infra] python3: {}",
                String::from_utf8_lossy(&out.stdout).trim()
            );
        }
        Ok(out) => panic!(
            "infra: `python3 --version` exited {}; stderr={:?}. \
             The fake-pylsp shebang requires python3 on PATH.",
            out.status,
            String::from_utf8_lossy(&out.stderr).trim()
        ),
        Err(e) => panic!(
            "infra: `python3 --version` failed to spawn: {e}. \
             The fake-pylsp shebang requires python3 on PATH."
        ),
    }

    // 2. fake-pylsp must be a real executable file with a Python
    //    shebang. Git tracks the +x bit (mode 100755), but a careless
    //    rebase / scripted edit can lose it; catching that here
    //    surfaces "this is why your LSP never started" instead of
    //    "the editor hung waiting for an `initialize` reply".
    let pylsp = fake_lsp_bin_dir().join("fake-pylsp");
    let meta = match std::fs::metadata(&pylsp) {
        Ok(m) => m,
        Err(e) => panic!("infra: fake-pylsp missing at {pylsp:?}: {e}"),
    };
    assert!(
        meta.is_file(),
        "infra: fake-pylsp at {pylsp:?} is not a regular file"
    );
    #[cfg(unix)]
    {
        use std::os::unix::fs::PermissionsExt;
        let mode = meta.permissions().mode();
        assert!(
            mode & 0o111 != 0,
            "infra: fake-pylsp at {pylsp:?} is not executable (mode={:o}). \
             `chmod +x` it or check that git preserved the executable bit.",
            mode
        );
    }
    let first_line = std::fs::read_to_string(&pylsp)
        .ok()
        .and_then(|s| s.lines().next().map(str::to_string))
        .unwrap_or_default();
    assert!(
        first_line.starts_with("#!") && first_line.contains("python"),
        "infra: fake-pylsp shebang should reference python; got {first_line:?}"
    );
    eprintln!("[infra] fake-pylsp ready: {pylsp:?} ({first_line})");
}

/// Dump the test's external state (fake-LSP URI log, fake-docker
/// exec history, container-fs stash) so a hung test in CI shows what
/// stage it actually got to. Called periodically from
/// [`wait_until_with_dumps`] and after every `wait_until` panic.
fn dump_external_state(state: &Path, label: &str) {
    eprintln!("=== fake state dump [{label}] ===");
    eprintln!("--- fake_lsp_uris ---");
    match fs::read_to_string(state.join("fake_lsp_uris")) {
        Ok(s) if s.is_empty() => eprintln!("(empty)"),
        Ok(s) => eprint!("{s}"),
        Err(e) => eprintln!("(missing: {e})"),
    }
    eprintln!("--- exec_history ---");
    match fs::read_to_string(state.join("exec_history")) {
        Ok(s) if s.is_empty() => eprintln!("(empty)"),
        Ok(s) => eprint!("{s}"),
        Err(e) => eprintln!("(missing: {e})"),
    }
    // LSP stderr (if any) goes to a per-PID file under the editor's
    // log dir. Surface its tail so a Python crash inside fake-pylsp
    // surfaces in the CI log instead of disappearing into the void.
    let lsp_log_path = fresh::services::log_dirs::lsp_log_path("python");
    eprintln!("--- lsp stderr ({}) ---", lsp_log_path.display());
    match fs::read_to_string(&lsp_log_path) {
        Ok(s) if s.is_empty() => eprintln!("(empty)"),
        Ok(s) => {
            // Cap to last ~4 KB so a chatty server doesn't flood CI.
            let tail = if s.len() > 4096 {
                &s[s.len() - 4096..]
            } else {
                &s[..]
            };
            eprint!("{tail}");
        }
        Err(e) => eprintln!("(missing: {e})"),
    }
    eprintln!("=== end dump ===");
}

/// Wrap [`EditorTestHarness::wait_until`] with periodic state dumps.
/// Same semantic-wait contract — runs forever (CONTRIBUTING §3) and
/// relies on nextest's outer 180s kill — but every 10 s of waiting
/// it eprintln's the fake state so a CI log of a TIMEOUT shows the
/// stage we got stuck at instead of just an empty progress line.
fn wait_until_with_dumps<F>(harness: &mut EditorTestHarness, label: &str, state: &Path, mut cond: F)
where
    F: FnMut(&EditorTestHarness) -> bool,
{
    let start = Instant::now();
    let mut last_dump = start;
    eprintln!("[wait] start: {label}");
    loop {
        harness.tick_and_render().unwrap();
        if cond(harness) {
            eprintln!(
                "[wait] satisfied: {label} (after {:.1}s)",
                start.elapsed().as_secs_f64()
            );
            return;
        }
        if last_dump.elapsed() >= Duration::from_secs(10) {
            eprintln!(
                "[wait] still waiting on {label} after {:.1}s",
                start.elapsed().as_secs_f64()
            );
            dump_external_state(state, label);
            last_dump = Instant::now();
        }
        std::thread::sleep(Duration::from_millis(50));
        harness.advance_time(Duration::from_millis(50));
    }
}

/// Path to the in-tree `fake-pylsp` bin dir. Tests prepend this to
/// PATH so `command -v fake-pylsp` resolves both on the host (for the
/// pre-attach phase) and inside the fake "container" (the captured
/// `userEnvProbe` PATH echoes this dir back through `docker exec
/// -e PATH=…`).
fn fake_lsp_bin_dir() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("../../scripts/fake-lsp/bin")
        .canonicalize()
        .expect("scripts/fake-lsp/bin must exist relative to CARGO_MANIFEST_DIR")
}

/// Set up a workspace that triggers the dev-container popup and is
/// otherwise minimal. The python LSP config + fake-lsp wiring happens
/// at the harness layer; this just plants the source files and a
/// `.devcontainer/devcontainer.json`.
fn set_up_workspace() -> (tempfile::TempDir, PathBuf) {
    fresh::i18n::set_locale("en");

    let temp = tempfile::tempdir().unwrap();
    let workspace = temp.path().canonicalize().unwrap();

    let dc = workspace.join(".devcontainer");
    fs::create_dir_all(&dc).unwrap();
    fs::write(
        dc.join("devcontainer.json"),
        r#"{
            "name": "fake-lsp-go-to-def",
            "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
            "remoteUser": "vscode",
            "userEnvProbe": "loginInteractiveShell"
        }"#,
    )
    .unwrap();

    // Distinct contents on each side so an accidental "open the same
    // file twice" doesn't smuggle a false positive past the cursor
    // assertion. `util.py` is intentionally long enough to host a
    // real line 5.
    fs::write(
        workspace.join("main.py"),
        "from util import helper\n\n\ndef main():\n    helper()\n",
    )
    .unwrap();
    fs::write(
        workspace.join("util.py"),
        "# util.py — host copy\n\
         # line 1\n\
         # line 2\n\
         # line 3\n\
         # line 4\n\
         def helper():\n\
         \treturn 'host-side definition target'\n",
    )
    .unwrap();

    let plugins_dir = workspace.join("plugins");
    fs::create_dir_all(&plugins_dir).unwrap();
    copy_plugin_lib(&plugins_dir);
    copy_plugin(&plugins_dir, "devcontainer");

    (temp, workspace)
}

/// Wait until the devcontainer plugin's "Reopen in Container?" popup
/// is rendered. Mirrors `devcontainer_attach_e2e::wait_for_attach_popup`
/// but inlined here so the test file stays self-contained.
fn wait_for_attach_popup(harness: &mut EditorTestHarness) {
    // Semantic waits, no in-test timeouts (CONTRIBUTING §3). nextest
    // applies its own outer timeout if anything genuinely hangs.
    harness
        .wait_until(|h| {
            let reg = h.editor().command_registry().read().unwrap();
            reg.get_all().iter().any(|c| c.name == "%cmd.run_lifecycle")
        })
        .unwrap();
    harness.editor().fire_plugins_loaded_hook();
    harness
        .wait_until(|h| {
            let screen = h.screen_to_string();
            screen.contains("Dev Container Detected") && screen.contains("Reopen in Container")
        })
        .unwrap();
}

/// Promote the plugin-staged authority to active. Same idiom as the
/// existing devcontainer attach e2e — the harness has no main loop, so
/// the test does the `take_pending_authority → set_boot_authority`
/// swap inline. Waits indefinitely (CONTRIBUTING §3); nextest's outer
/// timeout catches genuine hangs.
fn wait_for_container_authority(harness: &mut EditorTestHarness) -> String {
    loop {
        harness.tick_and_render().unwrap();
        if let Some(auth) = harness.editor_mut().take_pending_authority() {
            harness.editor_mut().set_boot_authority(auth);
            return harness.editor().authority().display_label.clone();
        }
        if harness
            .editor()
            .authority()
            .display_label
            .starts_with("Container:")
        {
            return harness.editor().authority().display_label.clone();
        }
        std::thread::sleep(std::time::Duration::from_millis(50));
        harness.advance_time(std::time::Duration::from_millis(50));
    }
}

fn read_uri_log(state: &Path) -> String {
    fs::read_to_string(state.join("fake_lsp_uris")).unwrap_or_default()
}

/// Reproducer.
///
/// Today this test fails because:
///   * `didOpen` carries `file:///<host>/main.py` rather than
///     `file:///workspaces/proj/main.py`; and
///   * the `Location` URI `file:///workspaces/proj/util.py` is opened
///     verbatim as a host path, so either the open fails or the active
///     buffer ends up at the wrong host file (and the cursor land
///     position drifts).
///
/// Both directions need to be fixed for Go-to-Definition to work in a
/// devcontainer. Don't gut one side without exercising the other.
#[test]
fn goto_definition_translates_uris_between_host_and_container() {
    let (_workspace_temp, workspace) = set_up_workspace();
    let main_py = workspace.join("main.py");
    let host_util_py = workspace.join("util.py");

    // Configure python's LSP to use the `fake-pylsp` shim. We
    // deliberately use the bare command name (no path) so the lookup
    // goes through PATH inside the fake "container" — the same path
    // the production code uses via `docker exec sh -c 'command -v
    // pylsp'`.
    let mut config = fresh::config::Config::default();
    config.lsp.insert(
        "python".to_string(),
        fresh::types::LspLanguageConfig::Multi(vec![fresh::services::lsp::LspServerConfig {
            command: "fake-pylsp".to_string(),
            args: vec![],
            enabled: true,
            auto_start: true,
            process_limits: fresh::services::process_limits::ProcessLimits::default(),
            initialization_options: None,
            env: Default::default(),
            language_id_overrides: Default::default(),
            root_markers: vec![".devcontainer".to_string(), ".git".to_string()],
            name: None,
            only_features: None,
            except_features: None,
        }]),
    );

    let mut harness = EditorTestHarness::create(
        160,
        40,
        HarnessOptions::new()
            .with_working_dir(workspace.clone())
            .with_config(config)
            .with_fake_devcontainer()
            .without_empty_plugins_dir(),
    )
    .unwrap();

    // Pin the in-container workspace path so it diverges from the
    // host path. Set AFTER `with_fake_devcontainer()` acquires its
    // process-global mutex — setting before would race with parallel
    // tests' cleanup of the same env var.
    std::env::set_var("FAKE_DC_REMOTE_WORKSPACE", "/workspaces/proj");

    // Pre-state: the fake-lsp uri log must not exist yet (or be
    // empty). The fake-pylsp creates it on first message, so we
    // assert the symptom only after triggering Go-to-Definition.
    let state = harness
        .fake_devcontainer_state()
        .expect("with_fake_devcontainer was set")
        .to_path_buf();

    // Prepend the fake-lsp bin dir to the *host* PATH — the
    // pre-attach probe (`captureContainerLoginEnv` etc.) and the post-
    // attach `docker exec` both need to find `fake-pylsp`. With
    // `FAKE_DC_REMOTE_WORKSPACE=/workspaces/proj` and the host's PATH
    // injected through the fake docker shim, this is the simplest way
    // to make the binary reachable from "inside" the container.
    let fake_lsp_bin = fake_lsp_bin_dir();
    let host_path = std::env::var("PATH").unwrap_or_default();
    let already_on_path = host_path
        .split(':')
        .any(|p| Path::new(p) == fake_lsp_bin.as_path());
    if !already_on_path {
        std::env::set_var("PATH", format!("{}:{}", fake_lsp_bin.display(), host_path));
    }

    // Have `userEnvProbe` echo a PATH that includes the fake-lsp dir
    // so the in-container `command -v fake-pylsp` probe (and the
    // subsequent `docker exec -e PATH=… fake-pylsp` spawn) can
    // resolve the binary. The fake docker reuses the parent process's
    // env when no `-e` is passed, but the captured probe overrides
    // PATH on every spawn — so it *must* contain our dir.
    // The captured probe PATH gets sent to every subsequent
    // `docker exec` via `-e PATH=…`, which means it has to be a PATH
    // a real shell can survive on. Include `/bin` and `/sbin`
    // explicitly: the fake-docker shim's `exec sh -c "…"` needs to
    // resolve `sh` itself through this PATH, and on macOS `sh` lives
    // *only* at `/bin/sh` (Linux usrmerge distros also have
    // `/usr/bin/sh`, which is why the missing `/bin` only hurt
    // macOS CI). The fake-docker shim's *default* probe-response
    // includes `/sbin:/bin` for the same reason; we just have to
    // remember to do the same when overriding it. Without `/bin`,
    // `exec sh …` exits 127, `command_exists` returns false, and the
    // LSP never starts — which is what the previous CI run hung on.
    fs::write(
        state.join("probe_response"),
        format!(
            "PATH=/home/vscode/.local/bin:/usr/local/bin:/usr/bin:/usr/sbin:/bin:/sbin:{}\n\
             HOME=/home/vscode\n\
             LANG=C.UTF-8\n",
            fake_lsp_bin.display()
        ),
    )
    .expect("write probe_response");

    // Pin the definition target the fake LSP returns. The URI uses
    // the *container* workspace path so the editor (on the host) has
    // to translate it back. Line 5 col 0 lands on `def helper():` in
    // util.py — far enough from line 0 that an off-by-N translation
    // bug shows up clearly.
    fs::write(
        state.join("fake_lsp_definition_uri"),
        "file:///workspaces/proj/util.py\n",
    )
    .expect("write fake_lsp_definition_uri");
    fs::write(state.join("fake_lsp_definition_line"), "5\n")
        .expect("write fake_lsp_definition_line");
    fs::write(state.join("fake_lsp_definition_character"), "0\n")
        .expect("write fake_lsp_definition_character");

    harness.tick_and_render().unwrap();

    // Drive the attach popup → "Reopen in Container" → wait for
    // authority. After this point, every spawn we drive (including
    // the LSP) routes through the container authority's
    // `DockerLongRunningSpawner`.
    wait_for_attach_popup(&mut harness);
    harness
        .send_key(KeyCode::Enter, KeyModifiers::NONE)
        .unwrap();
    let label = wait_for_container_authority(&mut harness);
    assert!(
        label.starts_with("Container:"),
        "expected container authority, got {label:?}"
    );

    // Open main.py — the LSP autostarts because `auto_start: true`
    // and the file extension matches the python language config.
    harness.open_file(&main_py).unwrap();

    // Wait for the LSP to handshake. The fake-pylsp logs every URI
    // it sees; an `initialize` line is the earliest signal that the
    // server is alive and the editor is talking to it.
    wait_until_with_dumps(&mut harness, "fake-pylsp initialize", &state, |_| {
        read_uri_log(&state)
            .lines()
            .any(|l| l.starts_with("initialize "))
    });

    // Wait for the editor to send `didOpen` for main.py before we
    // ask for a definition — without this the request races the
    // open notification.
    wait_until_with_dumps(&mut harness, "fake-pylsp didOpen main.py", &state, |_| {
        read_uri_log(&state)
            .lines()
            .any(|l| l.starts_with("didOpen ") && l.contains("main.py"))
    });

    // Move the cursor onto the `helper()` call inside `def main():`.
    // main.py contents:
    //   line 0: `from util import helper`
    //   line 1: ``
    //   line 2: ``
    //   line 3: `def main():`
    //   line 4: `    helper()`
    for _ in 0..4 {
        harness.send_key(KeyCode::Down, KeyModifiers::NONE).unwrap();
    }
    for _ in 0..6 {
        harness
            .send_key(KeyCode::Right, KeyModifiers::NONE)
            .unwrap();
    }
    harness.process_async_and_render().unwrap();

    // Trigger Go-to-Definition. F12 is the conventional binding;
    // mirrors `lsp_goto_definition_readonly.rs`.
    harness
        .send_key(KeyCode::F(12), KeyModifiers::NONE)
        .unwrap();
    // Wait until the goto-def round-trip has fully settled — i.e.
    // the active buffer has switched to util.py. That's a stronger
    // semantic checkpoint than "fake-pylsp logged the definition
    // request" because the latter passes as soon as the LSP
    // *receives* the request, whereas the assertions below depend
    // on the editor having *processed the response*. CI is slower
    // than local; pinning a fixed pump-loop here is what gave us
    // the previous timeout.
    wait_until_with_dumps(&mut harness, "active buffer == host util.py", &state, |h| {
        h.editor()
            .active_state()
            .buffer
            .file_path()
            .is_some_and(|p| p == host_util_py.as_path())
    });

    // ── Direction 1: host → container ────────────────────────────
    // The first `didOpen` URI the LSP saw must be the *container*
    // path (the workspace mounted at `/workspaces/proj`). The host
    // path leaks in today.
    let log = read_uri_log(&state);
    let did_open_lines: Vec<&str> = log.lines().filter(|l| l.starts_with("didOpen ")).collect();
    assert!(
        !did_open_lines.is_empty(),
        "expected at least one didOpen URI in the fake-lsp log; full log:\n{log}"
    );
    let first_did_open = did_open_lines[0];
    assert!(
        first_did_open.contains("file:///workspaces/proj/main.py"),
        "didOpen URI must use the in-container workspace path \
         `/workspaces/proj/main.py`, but got: {first_did_open:?}.\n\
         Full uri log:\n{log}\n\
         (This is the host→container URI translation gap: the editor \
          tells the LSP about a file at the host path, which the \
          in-container server can't see.)"
    );
    assert!(
        !first_did_open.contains(workspace.to_str().unwrap()),
        "didOpen URI must NOT carry the host workspace path; got: \
         {first_did_open:?}. Full uri log:\n{log}"
    );

    // ── Direction 2: container → host ────────────────────────────
    // The fake LSP returned `file:///workspaces/proj/util.py` line 5
    // col 0. After the editor processes the response, the active
    // buffer should be the host's `util.py`, and the cursor should
    // sit at line 5 col 0 — not line 0 (which is what an
    // open-empty-buffer fallback would give).
    let active_path: Option<PathBuf> = harness
        .editor()
        .active_state()
        .buffer
        .file_path()
        .map(|p| p.to_path_buf());
    assert_eq!(
        active_path.as_deref(),
        Some(host_util_py.as_path()),
        "after Go-to-Definition the active buffer's host path must be \
         the host's util.py, not the literal container path returned \
         by the LSP. Got: {active_path:?}. \
         (Container→host URI translation gap.)"
    );

    let cursor_pos = harness.cursor_position();
    let (line, character) = harness
        .editor()
        .active_state()
        .buffer
        .position_to_lsp_position(cursor_pos);
    assert_eq!(
        (line, character),
        (5, 0),
        "after Go-to-Definition the cursor must be at line 5, col 0 \
         (matching the fake LSP's response). A line:0 col:0 result \
         usually means the editor opened a fresh empty buffer for \
         the container URI instead of resolving it to the host file."
    );

    // Cleanup any per-test env that we set above so neighbouring
    // tests in the same process don't inherit it. The fake-devcontainer
    // mutex serializes us, so no race window.
    std::env::remove_var("FAKE_DC_REMOTE_WORKSPACE");
}

/// Common setup for the container-fetched-buffer tests below: planted
/// workspace, fake-pylsp on PATH, container authority attached, and
/// `main.py` opened so an LSP handshake has happened. Returns the
/// per-test state dir so callers can write `fake_lsp_definition_*`
/// pinning the response, and stash files under `container_fs/`.
fn arrange_attached_session_with_open_main_py() -> (
    tempfile::TempDir,
    std::path::PathBuf,
    EditorTestHarness,
    std::path::PathBuf,
) {
    // Wire up tracing so RUST_LOG=info / debug from CI surfaces
    // editor-side LSP events (`Spawning async LSP server`, didOpen
    // race grace, etc.) alongside our explicit eprintln breadcrumbs.
    init_tracing_from_env();
    // Pre-flight invariants: any infra problem fails *here*, before
    // we burn 180s waiting for a python3 that isn't on PATH or a
    // script with a stripped exec bit.
    assert_test_infra();

    let (workspace_temp, workspace) = set_up_workspace();
    let main_py = workspace.join("main.py");

    let mut config = fresh::config::Config::default();
    config.lsp.insert(
        "python".to_string(),
        fresh::types::LspLanguageConfig::Multi(vec![fresh::services::lsp::LspServerConfig {
            command: "fake-pylsp".to_string(),
            args: vec![],
            enabled: true,
            auto_start: true,
            process_limits: fresh::services::process_limits::ProcessLimits::default(),
            initialization_options: None,
            env: Default::default(),
            language_id_overrides: Default::default(),
            root_markers: vec![".devcontainer".to_string(), ".git".to_string()],
            name: None,
            only_features: None,
            except_features: None,
        }]),
    );

    let mut harness = EditorTestHarness::create(
        160,
        40,
        HarnessOptions::new()
            .with_working_dir(workspace.clone())
            .with_config(config)
            .with_fake_devcontainer()
            .without_empty_plugins_dir(),
    )
    .unwrap();

    // Set FAKE_DC_REMOTE_WORKSPACE *after* the fake-devcontainer
    // mutex is held (it's acquired inside `with_fake_devcontainer`).
    // Setting before would race with parallel tests' cleanup of the
    // same env var — they could clobber the value between our
    // `set_var` and the lock acquisition.
    std::env::set_var("FAKE_DC_REMOTE_WORKSPACE", "/workspaces/proj");

    let state = harness
        .fake_devcontainer_state()
        .expect("with_fake_devcontainer was set")
        .to_path_buf();

    let fake_lsp_bin = fake_lsp_bin_dir();
    let host_path = std::env::var("PATH").unwrap_or_default();
    if !host_path
        .split(':')
        .any(|p| Path::new(p) == fake_lsp_bin.as_path())
    {
        std::env::set_var("PATH", format!("{}:{}", fake_lsp_bin.display(), host_path));
    }
    // The captured probe PATH gets sent to every subsequent
    // `docker exec` via `-e PATH=…`, which means it has to be a PATH
    // a real shell can survive on. Include `/bin` and `/sbin`
    // explicitly: the fake-docker shim's `exec sh -c "…"` needs to
    // resolve `sh` itself through this PATH, and on macOS `sh` lives
    // *only* at `/bin/sh` (Linux usrmerge distros also have
    // `/usr/bin/sh`, which is why the missing `/bin` only hurt
    // macOS CI). The fake-docker shim's *default* probe-response
    // includes `/sbin:/bin` for the same reason; we just have to
    // remember to do the same when overriding it. Without `/bin`,
    // `exec sh …` exits 127, `command_exists` returns false, and the
    // LSP never starts — which is what the previous CI run hung on.
    fs::write(
        state.join("probe_response"),
        format!(
            "PATH=/home/vscode/.local/bin:/usr/local/bin:/usr/bin:/usr/sbin:/bin:/sbin:{}\n\
             HOME=/home/vscode\n\
             LANG=C.UTF-8\n",
            fake_lsp_bin.display()
        ),
    )
    .expect("write probe_response");

    harness.tick_and_render().unwrap();

    wait_for_attach_popup(&mut harness);
    harness
        .send_key(KeyCode::Enter, KeyModifiers::NONE)
        .unwrap();
    let label = wait_for_container_authority(&mut harness);
    assert!(
        label.starts_with("Container:"),
        "expected container authority, got {label:?}"
    );

    // Fail-fast: the editor will shortly call `command_exists`
    // through the *active* authority's spawner; if it returns
    // false, the LSP never starts and `wait_until_with_dumps` will
    // hang for 180s. Run the exact same probe right here so a
    // misconfigured PATH / missing exec bit / fake-docker shim bug
    // surfaces with a clear message instead of a nextest timeout.
    //
    // The CI logs from the previous failed run pinpointed this as
    // the actual stuck point on macOS — the editor's
    // `command_exists` returned false but we couldn't tell whether
    // the failure was on the host (file/permissions) or in the
    // fake-docker → sh → `command -v` chain. Running the probe
    // directly here narrows it to "this exact authority + this
    // exact command" so the panic message names the gap.
    {
        let spawner = harness.editor().authority().long_running_spawner.clone();
        let rt = tokio::runtime::Runtime::new().expect("tokio runtime for command_exists probe");
        let exists = rt.block_on(async move { spawner.command_exists("fake-pylsp").await });
        drop(rt);
        if !exists {
            // Surface absolutely everything we know about the
            // probe so CI logs name the cause: which docker shim
            // ran, what PATH it received, what the host can see.
            eprintln!("[infra] command_exists('fake-pylsp') returned false");
            eprintln!("[infra] host fake_lsp_bin: {}", fake_lsp_bin.display());
            eprintln!(
                "[infra] host PATH: {}",
                std::env::var("PATH").unwrap_or_default()
            );
            // Try the SAME probe on the host — if this works, the
            // problem is the docker shim / -e PATH= round-trip;
            // if it doesn't, the problem is the file/permissions.
            let host_probe = std::process::Command::new("sh")
                .args(["-c", "command -v fake-pylsp"])
                .output();
            match host_probe {
                Ok(out) => eprintln!(
                    "[infra] host `sh -c 'command -v fake-pylsp'`: status={}, stdout={:?}, stderr={:?}",
                    out.status,
                    String::from_utf8_lossy(&out.stdout).trim(),
                    String::from_utf8_lossy(&out.stderr).trim(),
                ),
                Err(e) => eprintln!("[infra] host `sh -c 'command -v fake-pylsp'`: spawn failed: {e}"),
            }
            // Run the probe a *second* way — directly invoke the
            // fake-docker shim from this test process, bypassing
            // the spawner. Surfaces whether the shim itself is
            // bypassing the export, or `sh` inside it can't see
            // PATH, or what.
            let shim_probe = std::process::Command::new("docker")
                .args([
                    "exec",
                    "-e",
                    &format!(
                        "PATH=/home/vscode/.local/bin:/usr/local/bin:/usr/bin:/usr/sbin:/bin:/sbin:{}",
                        fake_lsp_bin.display()
                    ),
                    "fake-id",
                    "sh",
                    "-c",
                    "echo PATH=$PATH; command -v fake-pylsp; echo exit=$?",
                ])
                .output();
            match shim_probe {
                Ok(out) => eprintln!(
                    "[infra] direct fake-docker probe: status={}, stdout={:?}, stderr={:?}",
                    out.status,
                    String::from_utf8_lossy(&out.stdout),
                    String::from_utf8_lossy(&out.stderr),
                ),
                Err(e) => eprintln!("[infra] direct fake-docker probe: spawn failed: {e}"),
            }
            dump_external_state(&state, "command_exists pre-flight");
            panic!(
                "infra: command_exists('fake-pylsp') returned false through the \
                 active authority's spawner. The editor's LSP spawn will fail \
                 the same way and the test would otherwise hang. See diagnostics above."
            );
        }
        eprintln!("[infra] command_exists('fake-pylsp') OK through authority spawner");
    }

    harness.open_file(&main_py).unwrap();
    wait_until_with_dumps(&mut harness, "fake-pylsp initialize", &state, |_| {
        read_uri_log(&state)
            .lines()
            .any(|l| l.starts_with("initialize "))
    });
    wait_until_with_dumps(&mut harness, "fake-pylsp didOpen main.py", &state, |_| {
        read_uri_log(&state)
            .lines()
            .any(|l| l.starts_with("didOpen ") && l.contains("main.py"))
    });

    (workspace_temp, workspace, harness, state)
}

/// Pin a definition target the fake LSP will return for the next
/// `textDocument/definition` request.
fn pin_fake_lsp_definition(state: &Path, uri: &str, line: u32, character: u32) {
    fs::write(state.join("fake_lsp_definition_uri"), format!("{uri}\n"))
        .expect("write fake_lsp_definition_uri");
    fs::write(state.join("fake_lsp_definition_line"), format!("{line}\n"))
        .expect("write fake_lsp_definition_line");
    fs::write(
        state.join("fake_lsp_definition_character"),
        format!("{character}\n"),
    )
    .expect("write fake_lsp_definition_character");
}

/// Stash a file under `<state>/container_fs/<abs_container_path>` so
/// the fake docker shim's `cat` special-case can serve it. Mirrors
/// what `docker exec <id> cat <path>` would return for a real
/// container.
fn stash_container_file(state: &Path, container_path: &str, content: &str) {
    let stash = state.join("container_fs").join(
        container_path
            .strip_prefix('/')
            .expect("container_path must be absolute"),
    );
    fs::create_dir_all(stash.parent().expect("non-root container path")).unwrap();
    fs::write(&stash, content).unwrap_or_else(|e| panic!("stash {stash:?}: {e}"));
}

/// Run cursor down N times, right M times, then trigger Goto-Def.
fn trigger_goto_definition(harness: &mut EditorTestHarness, down: usize, right: usize) {
    for _ in 0..down {
        harness.send_key(KeyCode::Down, KeyModifiers::NONE).unwrap();
    }
    for _ in 0..right {
        harness
            .send_key(KeyCode::Right, KeyModifiers::NONE)
            .unwrap();
    }
    harness.process_async_and_render().unwrap();
    harness
        .send_key(KeyCode::F(12), KeyModifiers::NONE)
        .unwrap();
}

/// Reproducer: Goto-Definition into a *container-only* file (the
/// canonical case is jumping into `flask/app.py` from
/// `~/.local/lib/python3.12/site-packages/`, which only exists inside
/// the container's Python venv). The translation table doesn't help
/// here because the path isn't under the workspace mount.
///
/// Expected behaviour: the editor fetches the file's contents through
/// the active authority (`docker exec <id> cat <path>`) and opens the
/// result as a *read-only* buffer whose path is the in-container path.
/// Cursor lands at the LSP-reported line/column.
///
/// Currently fails because the editor calls `open_file` with the raw
/// container path, which the host filesystem can't see — the buffer
/// either errors out or ends up empty at the wrong location.
#[test]
fn goto_definition_into_container_only_file_opens_read_only_buffer() {
    let (_workspace_temp, _workspace, mut harness, state) =
        arrange_attached_session_with_open_main_py();

    // The container-only file the LSP will point at. Mirrors the
    // user-reported scenario verbatim (Flask installed into the
    // vscode user's local site-packages).
    let container_path = "/home/vscode/.local/lib/python3.12/site-packages/flask/app.py";
    let container_content = "# flask/app.py — fetched from container\n\
                             # line 1\n\
                             # line 2\n\
                             def some_app_helper():\n\
                             \treturn 'this content lives only in the container'\n";
    stash_container_file(&state, container_path, container_content);

    // Pin the LSP response. Line 3 is `def some_app_helper():` in
    // the stashed content — far from line 0 so we can tell an empty
    // fallback buffer apart from a real fetch.
    pin_fake_lsp_definition(&state, &format!("file://{container_path}"), 3, 0);

    // Trigger Goto-Def from main.py line 4 (the `helper()` call).
    trigger_goto_definition(&mut harness, 4, 6);
    // Semantic wait: the goto-def response, the container fetch
    // round-trip (`docker exec cat`), and the buffer creation /
    // focus / cursor placement all settle by the time the active
    // buffer's file_path matches the container path. Using
    // `wait_until` instead of a fixed pump-loop means CI's
    // potentially slower docker spawn doesn't push us off a cliff.
    wait_until_with_dumps(
        &mut harness,
        "active buffer == fetched container path",
        &state,
        |h| {
            h.editor()
                .active_state()
                .buffer
                .file_path()
                .is_some_and(|p| p == Path::new(container_path))
        },
    );

    // ── Container-fetched buffer assertions ──────────────────────
    // The active buffer's path is the container path verbatim — no
    // host translation possible because the file isn't under the
    // workspace mount. The buffer's contents are what we stashed,
    // proving the fetch went through the docker exec route. The
    // buffer is read-only because container-only files have no
    // host-side writeback path. The cursor lands where the LSP
    // pointed.
    let active_path: Option<PathBuf> = harness
        .editor()
        .active_state()
        .buffer
        .file_path()
        .map(|p| p.to_path_buf());
    assert_eq!(
        active_path.as_deref(),
        Some(Path::new(container_path)),
        "active buffer path must be the container path; got {active_path:?}"
    );

    let content = harness
        .editor()
        .active_state()
        .buffer
        .to_string()
        .expect("buffer content readable");
    assert_eq!(
        content, container_content,
        "active buffer content must match what `docker exec cat` returned"
    );

    assert!(
        harness.editor().is_active_buffer_read_only(),
        "container-fetched buffers must be read-only (no host-side writeback)"
    );

    let cursor_pos = harness.cursor_position();
    let (line, character) = harness
        .editor()
        .active_state()
        .buffer
        .position_to_lsp_position(cursor_pos);
    assert_eq!(
        (line, character),
        (3, 0),
        "cursor must land at the LSP-reported line/character. (0,0) \
         usually means the editor created an empty buffer instead of \
         fetching the container file."
    );

    std::env::remove_var("FAKE_DC_REMOTE_WORKSPACE");
}

/// Reproducer for the failure mode: Goto-Def returns a URI that
/// resolves to neither a host-visible file nor a container-readable
/// one (e.g. a stale path the LSP cached, or a typo in a server's
/// own location math). The editor must surface a user-visible error
/// instead of silently opening a phantom buffer.
///
/// Currently fails because the editor calls `open_file` on the
/// untranslatable path and either errors silently or opens an empty
/// buffer.
#[test]
fn goto_definition_to_unreachable_uri_surfaces_error_message() {
    let (_workspace_temp, _workspace, mut harness, state) =
        arrange_attached_session_with_open_main_py();

    // Path doesn't exist on host; we deliberately *don't* stash it
    // under `container_fs/`, so the fake docker `cat` falls through
    // to real `cat` and exits 1.
    let unreachable = "/this/path/exists/nowhere/ghost.py";
    pin_fake_lsp_definition(&state, &format!("file://{unreachable}"), 7, 0);

    trigger_goto_definition(&mut harness, 4, 6);
    // Semantic wait on the rendered failure — the status bar shows
    // "could not open …" once the editor has fully resolved the
    // goto-def response (LSP returns Location → host check fails →
    // container `cat` fails → `Editor::open_lsp_uri_target` returns
    // `Err` → status line set). Waiting on the screen instead of a
    // pump-loop means CI's slower docker spawn doesn't matter.
    wait_until_with_dumps(&mut harness, "status line: 'could not open'", &state, |h| {
        h.screen_to_string().contains("could not open")
    });

    // The active buffer must NOT be a phantom at the unreachable
    // path. The most likely "bad" outcome is the editor opening an
    // empty buffer at `/this/path/exists/nowhere/ghost.py` (visible
    // as the active buffer's path matching the unreachable string),
    // which we explicitly forbid.
    let active_path: Option<PathBuf> = harness
        .editor()
        .active_state()
        .buffer
        .file_path()
        .map(|p| p.to_path_buf());
    assert_ne!(
        active_path.as_deref(),
        Some(Path::new(unreachable)),
        "Goto-Def into an unreachable URI must NOT open a phantom \
         buffer at that path. Got: {active_path:?}"
    );

    std::env::remove_var("FAKE_DC_REMOTE_WORKSPACE");
}