algocline-engine 0.41.0

//! Phase A re-spike for algocline issue 1779637712-85681.
//!
//! Goal: measure mlua-check (v0.2 library API) false / true positive ratio
//! on shipped Lua under the **library-direct** path. The earlier MCP-mediated
//! probe was bounded by `'Custom globals are not available'`; here we drive
//! `mlua_check::vm::register(&Lua)` directly, which auto-bridges live VM
//! globals into the SymbolTable.
//!
//! Setup mirrors the production bridge minimally:
//!   1. seed `alc` table with stub fields (state / json_* / log / llm / eval /
//!      time / _dirs) so prelude.lua loads,
//!   2. dofile prelude.lua so `alc.map` / `alc.reduce` / etc. become real
//!      table entries,
//!   3. call `mlua_check::vm::register(&lua)` to harvest the SymbolTable,
//!   4. lint each shipped Lua file and tally counts.
//!
//! Run with:
//!   `cargo test -p algocline-engine --test lua_lint_spike -- --nocapture`
//!
//! Now gating: any diagnostic on shipped Lua fails CI (`just ci` → `just test`
//! → `cargo test --workspace`). To intentionally suppress an over-eager
//! mlua-check rule on a file, add `---@diagnostic disable: <rule>` at the top
//! of that file rather than relaxing the assertion below.

use std::fs;
use std::path::{Path, PathBuf};

use mlua::Lua;
use mlua_check::vm::register;

fn engine_crate() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
}

fn workspace_root() -> PathBuf {
    engine_crate()
        .parent()
        .and_then(|p| p.parent())
        .map(Path::to_path_buf)
        .expect("workspace root resolvable from engine crate")
}

/// Prepare a Lua VM with the production `alc` global so the SymbolTable
/// reflects what shipped Lua actually sees at runtime.
fn make_vm() -> Lua {
    let lua = Lua::new();

    let setup = r#"
        alc = {}
        -- Service-layer stubs (normally injected by the Rust bridge)
        alc.state = {
            get = function(_, default) return default end,
            set = function() end,
        }
        alc.json_encode = function() end
        alc.json_decode = function() end
        alc.log = function() end
        alc.llm = function() end
        alc.llm_batch = function() end
        alc.eval = function() end
        alc.time = function() return 0 end
        alc.budget_remaining = function() return 0 end
        alc.card = {
            create = function() end,
            get = function() end,
            list = function() end,
            find = function() end,
            append = function() end,
        }
        alc._dirs = { scenarios = "/dev/null" }
    "#;
    lua.load(setup)
        .set_name("@alc_stub_setup")
        .exec()
        .expect("alc stub setup must succeed");

    let prelude = engine_crate().join("src").join("prelude.lua");
    let code =
        fs::read_to_string(&prelude).unwrap_or_else(|e| panic!("read {}: {e}", prelude.display()));
    lua.load(&code)
        .set_name(format!("@{}", prelude.display()))
        .exec()
        .expect("prelude.lua must load on stubbed alc");

    lua
}

fn shipped_files() -> Vec<PathBuf> {
    let root = workspace_root();
    let shapes = root
        .join("crates")
        .join("algocline-app")
        .join("src")
        .join("service")
        .join("gendoc")
        .join("alc_shapes");
    let docs = root
        .join("crates")
        .join("algocline-app")
        .join("src")
        .join("service")
        .join("lua")
        .join("gendoc");
    let prelude = engine_crate().join("src").join("prelude.lua");

    let mut out: Vec<PathBuf> = Vec::new();
    for sub in [&shapes, &docs] {
        if !sub.exists() {
            continue;
        }
        collect_lua(sub, &mut out);
    }
    out.push(prelude);
    out.sort();
    out
}

fn collect_lua(dir: &Path, out: &mut Vec<PathBuf>) {
    let Ok(entries) = fs::read_dir(dir) else {
        return;
    };
    for entry in entries.flatten() {
        let path = entry.path();
        if path.is_dir() {
            collect_lua(&path, out);
        } else if path.extension().and_then(|e| e.to_str()) == Some("lua") {
            out.push(path);
        }
    }
}

/// Map a shipped file's on-disk path to the chunk_name (virtual module
/// path) that production-side `require()` actually uses, so emmylua's
/// workspace-based require resolution can find sibling modules across
/// lint() calls. Without this mapping, every `require("tools.docs.X")`
/// yields `Cannot resolve module` even though runtime `package.preload`
/// (`gendoc.rs:EMBEDDED_TOOL_PRELOADS`) injects them.
fn chunk_name_for(file: &Path) -> String {
    let s = file.to_string_lossy();
    // alc_shapes/<name>.lua — `require("alc_shapes")` / `require("alc_shapes.X")`
    if let Some(idx) = s.find("/gendoc/alc_shapes/") {
        let rel = &s[idx + "/gendoc/".len()..]; // "alc_shapes/<name>.lua"
        return format!("@{rel}");
    }
    // lua/gendoc/docs/<name>.lua — `require("tools.docs.X")`
    if let Some(idx) = s.find("/lua/gendoc/docs/") {
        let rel = &s[idx + "/lua/gendoc/".len()..]; // "docs/<name>.lua"
        return format!("@tools/{rel}");
    }
    // lua/gendoc/gen_docs.lua — top-level driver, no sibling require target
    if s.ends_with("/lua/gendoc/gen_docs.lua") {
        return "@gen_docs.lua".to_string();
    }
    // prelude.lua — standalone
    if s.ends_with("/prelude.lua") {
        return "@prelude.lua".to_string();
    }
    format!("@{}", file.display())
}

#[test]
fn shipped_lua_is_lint_clean() {
    let lua = make_vm();
    let engine = register(&lua).expect("register(&lua) must succeed");

    let files = shipped_files();
    assert!(!files.is_empty(), "shipped_files() yielded zero entries");

    println!("\n=== mlua-check library-direct spike ===");
    println!("VM: alc stubs + prelude.lua loaded");
    println!("Files: {}\n", files.len());

    // Pass 1: inject every shipped file into the analysis workspace under
    // its production module path. After this loop, emmylua knows every
    // require target. Diagnostics from this pass are discarded because
    // dependencies may not have been registered yet when each file was
    // first linted.
    let sources: Vec<(PathBuf, String, String)> = files
        .iter()
        .filter_map(|file| {
            let code = fs::read_to_string(file).ok()?;
            let chunk = chunk_name_for(file);
            Some((file.clone(), chunk, code))
        })
        .collect();

    for (_, chunk, code) in &sources {
        let _ = engine.lint(code, chunk);
    }

    // Pass 2: re-lint and collect the now-stable diagnostics.
    let mut total_warnings = 0usize;
    let mut total_errors = 0usize;

    for (file, chunk, code) in &sources {
        let result = engine.lint(code, chunk);
        total_warnings += result.warning_count;
        total_errors += result.error_count;

        let rel = file
            .strip_prefix(workspace_root())
            .unwrap_or(file)
            .display();
        println!(
            "{:>3} warn / {:>2} err  {}",
            result.warning_count, result.error_count, rel
        );

        for diag in result.diagnostics.iter().take(6) {
            println!(
                "    [{:?}] L{}:{}  {}  ({})",
                diag.severity, diag.line, diag.column, diag.message, diag.rule,
            );
        }
        if result.diagnostics.len() > 6 {
            println!(
                "    ... {} more diagnostics suppressed",
                result.diagnostics.len() - 6
            );
        }
    }

    println!(
        "\nTotal: {total_warnings} warnings / {total_errors} errors across {} files",
        files.len()
    );

    assert_eq!(
        total_errors, 0,
        "shipped Lua produced {total_errors} mlua-check errors; \
         fix the source or add `---@diagnostic disable: <rule>` at the top of the offending file"
    );
    assert_eq!(
        total_warnings, 0,
        "shipped Lua produced {total_warnings} mlua-check warnings; \
         fix the source or add `---@diagnostic disable: <rule>` at the top of the offending file"
    );
}