luau 0.732.0

Safe lifetime-bound Rust embedding API for the Luau runtime
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

use luau::{Error, Function, Lua, ThreadStatus};

#[test]
fn thread_resume() -> Result<(), Error> {
    let lua = Lua::new()?;
    let thread = lua
        .load(
            r#"
            local sum = ...
            for _ = 1, 4 do
                sum += coroutine.yield(sum)
            end
            return sum
            "#,
        )
        .into_thread()?;

    assert_eq!(thread.status(), ThreadStatus::Resumable);
    assert_eq!(thread.resume::<i64>(0)?, 0);
    assert_eq!(thread.status(), ThreadStatus::Resumable);
    assert_eq!(thread.resume::<i64>(1)?, 1);
    assert_eq!(thread.resume::<i64>(2)?, 3);
    assert_eq!(thread.resume::<i64>(3)?, 6);
    assert_eq!(thread.resume::<i64>(4)?, 10);
    assert_eq!(thread.status(), ThreadStatus::Finished);
    assert!(matches!(
        thread.resume::<()>(()),
        Err(Error::CoroutineUnresumable)
    ));

    Ok(())
}

#[test]
fn sandboxed_chunk_thread_binds_an_isolated_environment() -> Result<(), Error> {
    let lua = Lua::new()?;
    lua.globals()?.set("shared_global", 1)?;
    lua.sandbox(true)?;
    lua.globals()?.set("shared_global", 2)?;

    let chunk = lua
        .load("file_global = 42; return file_global, shared_global")
        .into_sandboxed()?;

    {
        let function = chunk.function();
        lua.gc_collect()?;
        assert_eq!(function.call::<(i32, i32)>(())?, (42, 1));
    }

    let thread = chunk.into_thread();
    assert_eq!(thread.resume::<(i32, i32)>(())?, (42, 1));
    assert_eq!(lua.globals()?.get::<Option<i32>>("file_global")?, None);

    Ok(())
}

#[test]
fn thread_sandbox_inherits_current_globals_without_stale_imports() -> Result<(), Error> {
    let lua = Lua::new()?;
    lua.globals()?.set("x", 1)?;
    lua.sandbox(true)?;

    let load_parent_setter = lua.create_function(luau::callback!(|lua| {
        lua.load("return function(value) x = value end")
            .eval::<Function<'_>>()
    }))?;
    let set_parent: Function<'_> = load_parent_setter.call(())?;
    lua.current_thread().sandbox()?;

    let get_x = lua.load("return x").into_function()?;
    assert_eq!(get_x.call::<i32>(())?, 1);

    set_parent.call::<()>(2)?;
    assert_eq!(get_x.call::<i32>(())?, 2);
    Ok(())
}

#[test]
fn thread_resume_error_is_raised_at_the_suspended_yield() -> Result<(), Error> {
    let lua = Lua::new()?;
    let thread: luau::Thread<'_> = lua
        .load(
            r#"
                return coroutine.create(function()
                    local ok, error = pcall(coroutine.yield, 123)
                    assert(not ok)
                    assert(error == "injected error")
                    return "recovered"
                end)
            "#,
        )
        .eval()?;

    assert_eq!(thread.resume::<i32>(())?, 123);
    assert_eq!(
        thread.resume_error::<String>("injected error")?,
        "recovered"
    );

    Ok(())
}

#[test]
fn thread_resume_inherits_the_active_callback_depth() {
    std::thread::Builder::new()
        .stack_size(16 * 1024 * 1024)
        .spawn(|| {
            let lua = Lua::new().expect("Lua should initialize");
            let resume = lua
                .create_function(|lua, mut arguments| {
                    let depth: i32 = arguments.next()?;
                    if depth > 0 {
                        let thread = lua.load("return rust_resume(...)").into_thread()?;
                        thread.resume::<()>(depth - 1)?;
                    }
                    arguments.finish(())
                })
                .expect("the callback should be created");
            lua.globals()
                .and_then(|globals| globals.set("rust_resume", resume))
                .expect("the callback should be registered");

            let thread = lua
                .load("return rust_resume(...)")
                .into_thread()
                .expect("the coroutine should be created");
            let error = thread
                .resume::<()>(256)
                .expect_err("nested native resumes must observe Luau's call-depth limit");
            assert!(error.to_string().contains("C stack overflow"), "{error}");
        })
        .expect("the test thread should start")
        .join()
        .expect("the test thread should finish");
}

#[test]
fn thread_runtime_errors_include_the_failed_coroutine_traceback() -> Result<(), Error> {
    let lua = Lua::new()?;
    let thread = lua
        .load(
            r#"
                local function fail()
                    error("expected failure")
                end
                fail()
            "#,
        )
        .set_name("thread_traceback")
        .into_thread()?;

    let error = thread
        .resume::<()>(())
        .expect_err("the coroutine should fail");
    let message = error.to_string();
    assert!(message.contains("expected failure"));
    assert!(message.contains("stack traceback:"));
    assert!(message.contains("thread_traceback"));

    Ok(())
}