Merge branch 'main' into feature/jit-toggle

.github/workflows/ci.yaml

@@ -24,7 +24,7 @@ jobs:
           components: rustfmt
 
       - name: Install Tooling
-        uses: CompeyDev/setup-rokit@v0.1.0
+        uses: CompeyDev/setup-rokit@v0.1.2
 
       - name: Check Formatting
         run: just fmt-check
@@ -38,7 +38,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install Tooling
-        uses: CompeyDev/setup-rokit@v0.1.0
+        uses: CompeyDev/setup-rokit@v0.1.2
 
       - name: Analyze
         run: just analyze

.lune/websocket_client.luau

@@ -28,8 +28,8 @@ end)
 
 for _ = 1, 5 do
 	local start = os.clock()
-	socket.send(tostring(1))
-	local response = socket.next()
+	socket:send(tostring(1))
+	local response = socket:next()
 	local elapsed = os.clock() - start
 	print(`Got response '{response}' in {elapsed * 1_000} milliseconds`)
 	task.wait(1 - elapsed)
@@ -38,7 +38,7 @@ end
 -- Everything went well, and we are done with the socket, so we can close it
 
 print("Closing web socket...")
-socket.close()
+socket:close()
 
 task.cancel(forceExit)
 print("Done! 🌙")

.lune/websocket_server.luau

@@ -15,9 +15,9 @@ local handle = net.serve(PORT, {
 	handleWebSocket = function(socket)
 		print("Got new web socket connection!")
 		repeat
-			local message = socket.next()
+			local message = socket:next()
 			if message ~= nil then
-				socket.send("Echo - " .. message)
+				socket:send("Echo - " .. message)
 			end
 		until message == nil
 		print("Web socket disconnected.")

CHANGELOG.md

@@ -8,6 +8,46 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## `0.9.0`
+
+### Breaking changes
+
+- Added two new process spawning functions - `process.create` and `process.exec`, removing the previous `process.spawn` API completely. ([#211])
+
+  To migrate from `process.spawn`, use the new `process.exec` API which retains the same behavior as the old function.
+
+  The new `process.create` function is a non-blocking process creation API and can be used to interactively
+  read and write stdio of the process.
+
+  ```lua
+  local child = process.create("program", {
+    "cli-argument",
+    "other-cli-argument"
+  })
+
+  -- Writing to stdin
+  child.stdin:write("Hello from Lune!")
+
+  -- Reading from stdout
+  local data = child.stdout:read()
+  print(buffer.tostring(data))
+  ```
+
+- WebSocket methods in `net.socket` and `net.serve` now use standard Lua method calling convention and colon syntax.
+  This means `socket.send(...)` is now `socket:send(...)`, `socket.close(...)` is now `socket:close(...)`, and so on.
+
+- `Runtime::run` now returns a more useful value instead of an `ExitCode` ([#178])
+
+### Changed
+
+- Documentation comments for several standard library properties have been improved ([#248], [#250])
+- Error messages no longer contain redundant or duplicate stack trace information
+
+[#178]: https://github.com/lune-org/lune/pull/178
+[#211]: https://github.com/lune-org/lune/pull/211
+[#248]: https://github.com/lune-org/lune/pull/248
+[#250]: https://github.com/lune-org/lune/pull/250
+
 ## `0.8.9` - October 7th, 2024
 
 ### Changed

crates/lune-utils/src/fmt/error/components.rs

@@ -26,6 +26,11 @@ static STYLED_STACK_END: Lazy<String> = Lazy::new(|| {
     )
 });
 
+// NOTE: We indent using 4 spaces instead of tabs since
+// these errors are most likely to be displayed in a terminal
+// or some kind of live output - and tabs don't work well there
+const STACK_TRACE_INDENT: &str = "    ";
+
 /**
     Error components parsed from a [`LuaError`].
 
@@ -86,7 +91,7 @@ impl fmt::Display for ErrorComponents {
             let trace = self.trace.as_ref().unwrap();
             writeln!(f, "{}", *STYLED_STACK_BEGIN)?;
             for line in trace.lines() {
-                writeln!(f, "\t{line}")?;
+                writeln!(f, "{STACK_TRACE_INDENT}{line}")?;
             }
             writeln!(f, "{}", *STYLED_STACK_END)?;
         }
@@ -124,7 +129,7 @@ impl From<LuaError> for ErrorComponents {
         }
 
         // We will then try to extract any stack trace
-        let trace = if let LuaError::CallbackError {
+        let mut trace = if let LuaError::CallbackError {
             ref traceback,
             ref cause,
         } = *error
@@ -147,6 +152,45 @@ impl From<LuaError> for ErrorComponents {
             None
         };
 
+        // Sometimes, we can get duplicate stack trace lines that only
+        // mention "[C]", without a function name or path, and these can
+        // be safely ignored / removed if the following line has more info
+        if let Some(trace) = &mut trace {
+            let lines = trace.lines_mut();
+            loop {
+                let first_is_c_and_empty = lines
+                    .first()
+                    .is_some_and(|line| line.source().is_c() && line.is_empty());
+                let second_is_c_and_nonempty = lines
+                    .get(1)
+                    .is_some_and(|line| line.source().is_c() && !line.is_empty());
+                if first_is_c_and_empty && second_is_c_and_nonempty {
+                    lines.remove(0);
+                } else {
+                    break;
+                }
+            }
+        }
+
+        // Finally, we do some light postprocessing to remove duplicate
+        // information, such as the location prefix in the error message
+        if let Some(message) = messages.last_mut() {
+            if let Some(line) = trace
+                .iter()
+                .flat_map(StackTrace::lines)
+                .find(|line| line.source().is_lua())
+            {
+                let location_prefix = format!(
+                    "[string \"{}\"]:{}:",
+                    line.path().unwrap(),
+                    line.line_number().unwrap()
+                );
+                if message.starts_with(&location_prefix) {
+                    *message = message[location_prefix.len()..].trim().to_string();
+                }
+            }
+        }
+
         ErrorComponents { messages, trace }
     }
 }

crates/lune-utils/src/fmt/error/stack_trace.rs

@@ -39,6 +39,24 @@ pub enum StackTraceSource {
     Lua,
 }
 
+impl StackTraceSource {
+    /**
+        Returns `true` if the error originated from a C / Rust function, `false` otherwise.
+    */
+    #[must_use]
+    pub const fn is_c(self) -> bool {
+        matches!(self, Self::C)
+    }
+
+    /**
+        Returns `true` if the error originated from a Lua (user) function, `false` otherwise.
+    */
+    #[must_use]
+    pub const fn is_lua(self) -> bool {
+        matches!(self, Self::Lua)
+    }
+}
+
 /**
     Stack trace line parsed from a [`LuaError`].
 */
@@ -82,6 +100,20 @@ impl StackTraceLine {
     pub fn function_name(&self) -> Option<&str> {
         self.function_name.as_deref()
     }
+
+    /**
+        Returns `true` if the stack trace line contains no "useful" information, `false` otherwise.
+
+        Useful information is determined as one of:
+
+        - A path
+        - A line number
+        - A function name
+    */
+    #[must_use]
+    pub const fn is_empty(&self) -> bool {
+        self.path.is_none() && self.line_number.is_none() && self.function_name.is_none()
+    }
 }
 
 impl FromStr for StackTraceLine {
@@ -145,6 +177,14 @@ impl StackTrace {
     pub fn lines(&self) -> &[StackTraceLine] {
         &self.lines
     }
+
+    /**
+        Returns the individual stack trace lines, mutably.
+    */
+    #[must_use]
+    pub fn lines_mut(&mut self) -> &mut Vec<StackTraceLine> {
+        &mut self.lines
+    }
 }
 
 impl FromStr for StackTrace {

crates/lune-utils/src/fmt/error/tests.rs

@@ -2,7 +2,7 @@ use mlua::prelude::*;
 
 use crate::fmt::ErrorComponents;
 
-fn new_lua_result() -> LuaResult<()> {
+fn new_lua_runtime_error() -> LuaResult<()> {
     let lua = Lua::new();
 
     lua.globals()
@@ -17,13 +17,34 @@ fn new_lua_result() -> LuaResult<()> {
     lua.load("f()").set_name("chunk_name").eval()
 }
 
+fn new_lua_script_error() -> LuaResult<()> {
+    let lua = Lua::new();
+
+    lua.load(
+        "local function inner()\
+        \n    error(\"oh no, a script error\")\
+        \nend\
+        \n\
+        \nlocal function outer()\
+        \n    inner()\
+        \nend\
+        \n\
+        \nouter()\
+        ",
+    )
+    .set_name("chunk_name")
+    .eval()
+}
+
 // Tests for error context stack
 mod context {
     use super::*;
 
     #[test]
     fn preserves_original() {
-        let lua_error = new_lua_result().context("additional context").unwrap_err();
+        let lua_error = new_lua_runtime_error()
+            .context("additional context")
+            .unwrap_err();
         let components = ErrorComponents::from(lua_error);
 
         assert_eq!(components.messages()[0], "additional context");
@@ -34,7 +55,7 @@ mod context {
     fn preserves_levels() {
         // NOTE: The behavior in mlua is to preserve a single level of context
         // and not all levels (context gets replaced on each call to `context`)
-        let lua_error = new_lua_result()
+        let lua_error = new_lua_runtime_error()
             .context("level 1")
             .context("level 2")
             .context("level 3")
@@ -54,7 +75,7 @@ mod error_components {
 
     #[test]
     fn message() {
-        let lua_error = new_lua_result().unwrap_err();
+        let lua_error = new_lua_runtime_error().unwrap_err();
         let components = ErrorComponents::from(lua_error);
 
         assert_eq!(components.messages()[0], "oh no, a runtime error");
@@ -62,7 +83,7 @@ mod error_components {
 
     #[test]
     fn stack_begin_end() {
-        let lua_error = new_lua_result().unwrap_err();
+        let lua_error = new_lua_runtime_error().unwrap_err();
         let formatted = format!("{}", ErrorComponents::from(lua_error));
 
         assert!(formatted.contains("Stack Begin"));
@@ -71,7 +92,7 @@ mod error_components {
 
     #[test]
     fn stack_lines() {
-        let lua_error = new_lua_result().unwrap_err();
+        let lua_error = new_lua_runtime_error().unwrap_err();
         let components = ErrorComponents::from(lua_error);
 
         let mut lines = components.trace().unwrap().lines().iter();
@@ -83,3 +104,47 @@ mod error_components {
         assert_eq!(line_2, "Script 'chunk_name', Line 1");
     }
 }
+
+// Tests for general formatting
+mod general {
+    use super::*;
+
+    #[test]
+    fn message_does_not_contain_location() {
+        let lua_error = new_lua_script_error().unwrap_err();
+
+        let components = ErrorComponents::from(lua_error);
+        let trace = components.trace().unwrap();
+
+        let first_message = components.messages().first().unwrap();
+        let first_lua_stack_line = trace
+            .lines()
+            .iter()
+            .find(|line| line.source().is_lua())
+            .unwrap();
+
+        let location_prefix = format!(
+            "[string \"{}\"]:{}:",
+            first_lua_stack_line.path().unwrap(),
+            first_lua_stack_line.line_number().unwrap()
+        );
+
+        assert!(!first_message.starts_with(&location_prefix));
+    }
+
+    #[test]
+    fn no_redundant_c_mentions() {
+        let lua_error = new_lua_script_error().unwrap_err();
+
+        let components = ErrorComponents::from(lua_error);
+        let trace = components.trace().unwrap();
+
+        let c_stack_lines = trace
+            .lines()
+            .iter()
+            .filter(|line| line.source().is_c())
+            .collect::<Vec<_>>();
+
+        assert_eq!(c_stack_lines.len(), 1); // Just the "error" call
+    }
+}

rokit.toml

@@ -1,4 +1,4 @@
 [tools]
-luau-lsp = "JohnnyMorganz/luau-lsp@1.32.1"
+luau-lsp = "JohnnyMorganz/luau-lsp@1.33.1"
 stylua = "JohnnyMorganz/StyLua@0.20.0"
-just = "casey/just@1.34.0"
+just = "casey/just@1.36.0"