mlua_batteries/

json.rs

//! JSON encode/decode module.
//!
//! ```lua
//! local json = std.json
//! local t = json.decode('{"a":1}')
//! local s = json.encode(t)
//! local s2 = json.encode_pretty(t)
//! ```
//!
//! # Empty tables
//!
//! An empty Lua table `{}` is encoded as a JSON **object** `{}`,
//! not an array `[]`. This matches the `classify` heuristic: a table
//! with `raw_len() == 0` is treated as a map.

use mlua::prelude::*;
use serde_json::Value as JsonValue;

use crate::policy::PathOp;
use crate::util::{check_path, classify, with_config, TableKind};

pub fn module(lua: &Lua) -> LuaResult<LuaTable> {
    let t = lua.create_table()?;

    t.set(
        "decode",
        lua.create_function(|lua, s: String| {
            let max_depth = with_config(lua, |c| c.max_json_depth)?;
            let value: JsonValue = serde_json::from_str(&s)
                .map_err(|e| LuaError::external(format!("json.decode: {e}")))?;
            json_to_lua(lua, &value, max_depth)
        })?,
    )?;

    t.set(
        "encode",
        lua.create_function(|lua, value: LuaValue| {
            let max_depth = with_config(lua, |c| c.max_json_depth)?;
            let json = lua_to_json(&value, max_depth)?;
            serde_json::to_string(&json)
                .map_err(|e| LuaError::external(format!("json.encode: {e}")))
        })?,
    )?;

    t.set(
        "encode_pretty",
        lua.create_function(|lua, value: LuaValue| {
            let max_depth = with_config(lua, |c| c.max_json_depth)?;
            let json = lua_to_json(&value, max_depth)?;
            serde_json::to_string_pretty(&json)
                .map_err(|e| LuaError::external(format!("json.encode_pretty: {e}")))
        })?,
    )?;

    t.set(
        "read_file",
        lua.create_function(|lua, path: String| {
            let access = check_path(lua, &path, PathOp::Read)?;
            let max_depth = with_config(lua, |c| c.max_json_depth)?;
            let content = access.read_to_string().map_err(LuaError::external)?;
            let value: JsonValue = serde_json::from_str(&content)
                .map_err(|e| LuaError::external(format!("json.read_file: {e}")))?;
            json_to_lua(lua, &value, max_depth)
        })?,
    )?;

    t.set(
        "write_file",
        lua.create_function(|lua, (path, value): (String, LuaValue)| {
            let access = check_path(lua, &path, PathOp::Write)?;
            let max_depth = with_config(lua, |c| c.max_json_depth)?;
            let json = lua_to_json(&value, max_depth)?;
            let content = serde_json::to_string_pretty(&json)
                .map_err(|e| LuaError::external(format!("json.write_file: {e}")))?;
            access
                .write(content.as_bytes())
                .map_err(LuaError::external)?;
            Ok(true)
        })?,
    )?;

    Ok(t)
}

// ─── Conversion: JSON → Lua ────────────────────────────

pub(crate) fn json_to_lua(lua: &Lua, value: &JsonValue, max_depth: usize) -> LuaResult<LuaValue> {
    json_to_lua_inner(lua, value, 0, max_depth)
}

fn json_to_lua_inner(
    lua: &Lua,
    value: &JsonValue,
    depth: usize,
    max_depth: usize,
) -> LuaResult<LuaValue> {
    if depth > max_depth {
        return Err(LuaError::external(format!(
            "JSON nesting too deep (limit: {max_depth})"
        )));
    }
    match value {
        JsonValue::Null => Ok(LuaValue::Nil),
        JsonValue::Bool(b) => Ok(LuaValue::Boolean(*b)),
        JsonValue::Number(n) => {
            if let Some(i) = n.as_i64() {
                Ok(LuaValue::Integer(i))
            } else if let Some(f) = n.as_f64() {
                Ok(LuaValue::Number(f))
            } else {
                Err(LuaError::external(format!(
                    "JSON number {n} is not representable as i64 or f64"
                )))
            }
        }
        JsonValue::String(s) => lua.create_string(s).map(LuaValue::String),
        JsonValue::Array(arr) => {
            let table = lua.create_table()?;
            for (i, v) in arr.iter().enumerate() {
                table.set(i + 1, json_to_lua_inner(lua, v, depth + 1, max_depth)?)?;
            }
            Ok(LuaValue::Table(table))
        }
        JsonValue::Object(map) => {
            let table = lua.create_table()?;
            for (k, v) in map {
                table.set(k.as_str(), json_to_lua_inner(lua, v, depth + 1, max_depth)?)?;
            }
            Ok(LuaValue::Table(table))
        }
    }
}

// ─── Conversion: Lua → JSON ────────────────────────────

pub(crate) fn lua_to_json(value: &LuaValue, max_depth: usize) -> LuaResult<JsonValue> {
    lua_to_json_inner(value, 0, max_depth)
}

fn lua_to_json_inner(value: &LuaValue, depth: usize, max_depth: usize) -> LuaResult<JsonValue> {
    if depth > max_depth {
        return Err(LuaError::external(format!(
            "Lua table nesting too deep for JSON (limit: {max_depth})"
        )));
    }
    match value {
        LuaValue::Nil => Ok(JsonValue::Null),
        LuaValue::Boolean(b) => Ok(JsonValue::Bool(*b)),
        LuaValue::Integer(i) => Ok(JsonValue::Number((*i).into())),
        LuaValue::Number(n) => serde_json::Number::from_f64(*n)
            .map(JsonValue::Number)
            .ok_or_else(|| LuaError::external(format!("cannot convert {n} to JSON number"))),
        LuaValue::String(s) => Ok(JsonValue::String(s.to_str()?.to_string())),
        LuaValue::Table(t) => lua_table_to_json(t, depth, max_depth),
        _ => Err(LuaError::external("unsupported type for JSON conversion")),
    }
}

fn lua_table_to_json(table: &LuaTable, depth: usize, max_depth: usize) -> LuaResult<JsonValue> {
    match classify(table)? {
        TableKind::Array(len) => {
            let mut arr = Vec::with_capacity(len);
            for i in 1..=len {
                let v: LuaValue = table.raw_get(i)?;
                arr.push(lua_to_json_inner(&v, depth + 1, max_depth)?);
            }
            Ok(JsonValue::Array(arr))
        }
        TableKind::Map(pairs) => {
            let mut map = serde_json::Map::new();
            for (k, v) in pairs {
                let key = match k {
                    LuaValue::String(s) => s.to_str()?.to_string(),
                    LuaValue::Integer(i) => i.to_string(),
                    LuaValue::Number(n) => n.to_string(),
                    other => {
                        return Err(LuaError::external(format!(
                            "unsupported table key type for JSON: {}",
                            other.type_name()
                        )));
                    }
                };
                map.insert(key, lua_to_json_inner(&v, depth + 1, max_depth)?);
            }
            Ok(JsonValue::Object(map))
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::util::test_eval as eval;

    #[test]
    fn decode_object() {
        let s: String = eval(
            r#"
            local t = std.json.decode('{"a":1,"b":"hello"}')
            return tostring(t.a) .. "," .. t.b
        "#,
        );
        assert_eq!(s, "1,hello");
    }

    #[test]
    fn decode_array() {
        let n: i64 = eval(
            r#"
            local arr = std.json.decode('[10,20,30]')
            return #arr
        "#,
        );
        assert_eq!(n, 3);
    }

    #[test]
    fn decode_invalid_returns_error() {
        let lua = Lua::new();
        crate::register_all(&lua, "std").unwrap();
        let result: mlua::Result<LuaValue> = lua.load(r#"return std.json.decode("{bad")"#).eval();
        assert!(result.is_err());
    }

    #[test]
    fn encode_roundtrip() {
        let s: String = eval(
            r#"
            local original = '{"name":"test","values":[1,2,3]}'
            local t = std.json.decode(original)
            local encoded = std.json.encode(t)
            local t2 = std.json.decode(encoded)
            return t2.name .. "," .. tostring(#t2.values)
        "#,
        );
        assert_eq!(s, "test,3");
    }

    #[test]
    fn encode_empty_table_as_object() {
        let s: String = eval(
            r#"
            return std.json.encode({})
        "#,
        );
        assert_eq!(s, "{}");
    }

    #[test]
    fn encode_nested_structure() {
        let s: String = eval(
            r#"
            return std.json.encode({items = {1, 2}, meta = {ok = true}})
        "#,
        );
        let v: serde_json::Value = serde_json::from_str(&s).unwrap();
        assert!(v["items"].is_array());
        assert_eq!(v["meta"]["ok"], true);
    }

    #[test]
    fn encode_pretty_has_newlines() {
        let s: String = eval(
            r#"
            return std.json.encode_pretty({a = 1})
        "#,
        );
        assert!(s.contains('\n'));
    }

    #[test]
    fn decode_null_becomes_nil() {
        let b: bool = eval(
            r#"
            local t = std.json.decode('{"x":null}')
            return t.x == nil
        "#,
        );
        assert!(b);
    }

    #[test]
    fn decode_boolean() {
        let s: String = eval(
            r#"
            local t = std.json.decode('{"flag":true}')
            return type(t.flag)
        "#,
        );
        assert_eq!(s, "boolean");
    }

    #[test]
    fn max_depth_enforced_on_decode() {
        let lua = Lua::new();
        let config = crate::config::Config::builder()
            .max_json_depth(2)
            .build()
            .unwrap();
        crate::register_all_with(&lua, "std", config).unwrap();

        // depth 3: {"a":{"b":{"c":1}}}
        let result: mlua::Result<LuaValue> = lua
            .load(r#"return std.json.decode('{"a":{"b":{"c":1}}}')"#)
            .eval();
        assert!(result.is_err());
    }

    #[test]
    fn max_depth_enforced_on_encode() {
        let lua = Lua::new();
        let config = crate::config::Config::builder()
            .max_json_depth(2)
            .build()
            .unwrap();
        crate::register_all_with(&lua, "std", config).unwrap();

        // depth 3 nested table
        let result: mlua::Result<LuaValue> = lua
            .load(r#"return std.json.encode({a = {b = {c = 1}}})"#)
            .eval();
        assert!(result.is_err());
    }

    #[test]
    fn encode_rejects_boolean_key() {
        let lua = Lua::new();
        crate::register_all(&lua, "std").unwrap();

        let result: mlua::Result<LuaValue> = lua
            .load(
                r#"
                local t = {}
                t[true] = "val"
                return std.json.encode(t)
            "#,
            )
            .eval();
        assert!(result.is_err());
        let err_msg = result.unwrap_err().to_string();
        assert!(err_msg.contains("unsupported table key type"));
    }

    #[test]
    fn read_file_and_write_file_roundtrip() {
        let dir = std::env::temp_dir().join("mlua_bat_test_json_file");
        std::fs::create_dir_all(&dir).unwrap();
        let path = dir.join("data.json");
        let path_str = path.to_string_lossy();

        let lua = Lua::new();
        crate::register_all(&lua, "std").unwrap();

        let s: String = lua
            .load(&format!(
                r#"
                std.json.write_file("{path_str}", {{name = "test", ok = true}})
                local t = std.json.read_file("{path_str}")
                return t.name
            "#
            ))
            .eval()
            .unwrap();
        assert_eq!(s, "test");
        let _ = std::fs::remove_dir_all(&dir);
    }
}