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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
use std::borrow::Cow;
use std::error;
use std::fmt;
use bstr::BString;
use scolapasta_string_escape::format_debug_escape_into;
use crate::core::{TryConvertMut, Value as _};
use crate::error::{Error, RubyException};
use crate::gc::MrbGarbageCollection;
use crate::sys;
use crate::value::Value;
use crate::Artichoke;
#[derive(Default, Debug)]
pub struct Builder(CaughtException);
impl Builder {
#[must_use]
pub fn new() -> Self {
Self::default()
}
#[must_use]
pub fn with_value(mut self, value: Value) -> Self {
self.0.value = value;
self
}
#[must_use]
pub fn with_name(mut self, name: String) -> Self {
self.0.name = name;
self
}
#[must_use]
pub fn with_message(mut self, message: Vec<u8>) -> Self {
self.0.message = message.into();
self
}
#[must_use]
pub fn finish(self) -> CaughtException {
self.0
}
}
#[derive(Default, Debug, Clone)]
pub struct CaughtException {
value: Value,
name: String,
message: BString,
}
impl CaughtException {
#[must_use]
pub fn builder() -> Builder {
Builder::new()
}
#[must_use]
pub fn with_value_class_and_message(value: Value, name: String, message: Vec<u8>) -> Self {
let message = message.into();
Self { value, name, message }
}
}
impl fmt::Display for CaughtException {
fn fmt(&self, mut f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(&self.name())?;
f.write_str(" (")?;
format_debug_escape_into(&mut f, &self.message())?;
f.write_str(")")?;
Ok(())
}
}
impl error::Error for CaughtException {}
impl RubyException for CaughtException {
fn message(&self) -> Cow<'_, [u8]> {
self.message.as_slice().into()
}
fn name(&self) -> Cow<'_, str> {
self.name.as_str().into()
}
fn vm_backtrace(&self, interp: &mut Artichoke) -> Option<Vec<Vec<u8>>> {
let backtrace = self.value.funcall(interp, "backtrace", &[], None).ok()?;
let backtrace = interp.try_convert_mut(backtrace).ok()?;
Some(backtrace)
}
fn as_mrb_value(&self, interp: &mut Artichoke) -> Option<sys::mrb_value> {
let _ = interp;
Some(self.value.inner())
}
}
impl From<CaughtException> for Box<dyn RubyException> {
fn from(exc: CaughtException) -> Self {
Box::new(exc)
}
}
impl From<CaughtException> for Error {
fn from(exc: CaughtException) -> Self {
Self::from(Box::<dyn RubyException>::from(exc))
}
}
pub fn last_error(interp: &mut Artichoke, exception: Value) -> Result<Error, Error> {
let mut arena = interp.create_arena_savepoint()?;
let class = exception.funcall(&mut arena, "class", &[], None)?;
let classname = class.funcall(&mut arena, "name", &[], None)?;
let classname = classname.try_convert_into_mut::<&str>(&mut arena)?;
let message = exception.funcall(&mut arena, "message", &[], None)?;
let message = message.try_convert_into_mut::<&[u8]>(&mut arena)?;
let exc = CaughtException::builder()
.with_value(exception)
.with_name(classname.into())
.with_message(message.to_vec())
.finish();
Ok(Error::from(exc))
}
#[cfg(test)]
mod tests {
use bstr::ByteSlice;
use crate::test::prelude::*;
#[test]
fn return_exception() {
let mut interp = interpreter();
let err = interp.eval(b"raise ArgumentError.new('waffles')").unwrap_err();
assert_eq!("ArgumentError", err.name().as_ref());
assert_eq!(b"waffles".as_bstr(), err.message().as_ref().as_bstr());
let expected_backtrace = b"(eval):1".to_vec();
let backtrace = bstr::join("\n", err.vm_backtrace(&mut interp).unwrap());
assert_eq!(backtrace.as_bstr(), expected_backtrace.as_bstr());
}
#[test]
fn return_exception_with_no_backtrace() {
let mut interp = interpreter();
let err = interp.eval(b"def bad; (; end").unwrap_err();
assert_eq!("SyntaxError", err.name().as_ref());
assert_eq!(b"syntax error".as_bstr(), err.message().as_ref().as_bstr());
assert_eq!(None, err.vm_backtrace(&mut interp));
}
#[test]
fn raise_does_not_panic_or_segfault() {
let mut interp = interpreter();
interp.eval(br#"raise 'foo'"#).unwrap_err();
interp.eval(br#"raise 'foo'"#).unwrap_err();
interp.eval(br#"eval("raise 'foo'")"#).unwrap_err();
interp.eval(br#"eval("raise 'foo'")"#).unwrap_err();
interp.eval(br#"require 'foo'"#).unwrap_err();
interp.eval(br#"require 'foo'"#).unwrap_err();
interp.eval(br#"eval("require 'foo'")"#).unwrap_err();
interp.eval(br#"eval("require 'foo'")"#).unwrap_err();
interp.eval(br#"Regexp.compile(2)"#).unwrap_err();
interp.eval(br#"Regexp.compile(2)"#).unwrap_err();
#[cfg(feature = "core-regexp")]
{
interp.eval(br#"eval("Regexp.compile(2)")"#).unwrap_err();
interp.eval(br#"eval("Regexp.compile(2)")"#).unwrap_err();
}
#[cfg(feature = "stdlib-forwardable")]
{
const REQUIRE_TEST: &[u8] = b"\
def fail
begin
require 'foo'
rescue LoadError
require 'forwardable'
end
end
fail
";
interp.eval(REQUIRE_TEST).unwrap();
}
let kernel = interp.eval(br#"Kernel"#).unwrap();
kernel.funcall(&mut interp, "raise", &[], None).unwrap_err();
kernel.funcall(&mut interp, "raise", &[], None).unwrap_err();
}
}