fix(cli-rs): name the Luau heap cap when a plugin runs out of memory

This commit is contained in:
Simon Klee
2026-11-18 14:22:14 +01:00
Unverified
parent 1ee3e6279a
commit c352371bb0
2 changed files with 13 additions and 6 deletions
@@ -419,7 +419,8 @@ fn an_armed_interrupt_stays_with_its_call_and_its_vm() {
// Expected (luau-spike 1.3): a VM's heap is capped; an allocation past it fails the call and the plugin, and the
// process's memory is not touched. A task holds what it allocated on its stack or in the plugin's own state: either
// way the failure names the memory (await-luau).
// way the failure names the memory (await-luau), with the cap (luau-oom: mlua's "memory error: not enough memory"
// told `/plugins` neither).
#[test]
fn a_plugin_that_allocates_past_its_cap_fails() {
let host = host();
@@ -440,7 +441,7 @@ fn a_plugin_that_allocates_past_its_cap_fails() {
keymap(&host).dispatch("hog", None);
host.app.advance(Duration::from_millis(1));
let error = failure(&registry, "test.luau").expect("the hog failed");
assert!(error.contains("memory"), "{keep}: {error}");
assert_eq!(error, "test.luau: out of memory: an allocation went past its 4 MiB Luau heap cap", "{keep}");
}
}
+10 -4
View File
@@ -272,9 +272,9 @@ impl Vm {
};
if let Some(stopped) = self.budget.stopped.take() {
// A failed task's error with its frames comes this way too ([`super::bind`]'s `fail`).
return Err(report(&self.id, &stopped));
return Err(report(&self.id, &stopped, self.cap));
}
let result = result.map_err(|error| report(&self.id, &error.to_string()))?;
let result = result.map_err(|error| report(&self.id, &error.to_string(), self.cap))?;
if self.lua.used_memory() + ROOM >= self.cap {
// Garbage does not count: only what a full collection leaves, and only when the heap is that near the cap.
let _ = self.lua.gc_collect();
@@ -357,10 +357,16 @@ impl Drop for Outer<'_> {
/// What an author reads for Luau error `error` of plugin `id`: `<id>: <file>.luau:<line>: <message>`, then the
/// traceback's frames in the plugin's own files. mlua's `runtime error:` prefix goes, and so do the frames of C
/// functions, of mlua's `require` and of the host's `@opencode/plugin`, which say nothing about the plugin.
fn report(id: &str, error: &str) -> String {
/// functions, of mlua's `require` and of the host's `@opencode/plugin`, which say nothing about the plugin. An
/// allocation over the heap's `cap` says so, with the cap.
fn report(id: &str, error: &str, cap: usize) -> String {
let (message, traceback) = error.split_once("\nstack traceback:\n").unwrap_or((error, ""));
let message = message.trim_end().strip_prefix("runtime error: ").unwrap_or(message.trim_end());
// Luau's text for an allocation the cap refused, "not enough memory" (mlua's "memory error: " before it on a call,
// not on a task), names no cap.
let capped = format!("out of memory: an allocation went past its {} MiB Luau heap cap", cap >> 20);
let refused = message.strip_prefix("memory error: ").unwrap_or(message) == "not enough memory";
let message = if refused { &capped } else { message };
let frames: Vec<String> = traceback
.lines()
.map(|line| line.trim_start_matches(['\t', ' ', '>']))