difftreelog
feat(evaluator) readable error messages
in: master
6 files changed
crates/jrsonnet-evaluator/Cargo.tomldiffbeforeafterboth--- a/crates/jrsonnet-evaluator/Cargo.toml
+++ b/crates/jrsonnet-evaluator/Cargo.toml
@@ -37,6 +37,8 @@
base64 = "0.12.3"
rustc-hash = "1.1.0"
+thiserror = "1.0.20"
+
# Serialized stdlib
[dependencies.serde]
version = "1.0.115"
crates/jrsonnet-evaluator/src/builtin/format.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/builtin/format.rs
+++ b/crates/jrsonnet-evaluator/src/builtin/format.rs
@@ -2,16 +2,23 @@
#![allow(clippy::too_many_arguments)]
use crate::{error::Error::*, throw, LocError, ObjValue, Result, Val, ValType};
+use thiserror::Error;
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, Error)]
pub enum FormatError {
+ #[error("truncated format code")]
TruncatedFormatCode,
+ #[error("unrecognized conversion type: {0}")]
UnrecognizedConversionType(char),
+ #[error("not enough values")]
NotEnoughValues,
+ #[error("cannot use * width with object")]
CannotUseStarWidthWithObject,
+ #[error("mapping keys required")]
MappingKeysRequired,
+ #[error("no such format field: {0}")]
NoSuchFormatField(Rc<str>),
}
crates/jrsonnet-evaluator/src/builtin/sort.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/builtin/sort.rs
+++ b/crates/jrsonnet-evaluator/src/builtin/sort.rs
@@ -4,9 +4,11 @@
};
use std::rc::Rc;
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, thiserror::Error)]
pub enum SortError {
+ #[error("sort key should be string or number")]
SortKeyShouldBeStringOrNumber,
+ #[error("sort elements should have equal types")]
SortElementsShouldHaveEqualType,
}
crates/jrsonnet-evaluator/src/ctx.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/ctx.rs
+++ b/crates/jrsonnet-evaluator/src/ctx.rs
@@ -63,7 +63,7 @@
.bindings
.get(&name)
.cloned()
- .ok_or_else(|| UnknownVariable(name))?)
+ .ok_or_else(|| VariableIsNotDefined(name))?)
}
pub fn into_future(self, ctx: FutureContext) -> Self {
{
crates/jrsonnet-evaluator/src/error.rsdiffbeforeafterboth1use crate::{2 builtin::{format::FormatError, sort::SortError},3 ValType,4};5use jrsonnet_parser::{BinaryOpType, ExprLocation, UnaryOpType};6use std::{path::PathBuf, rc::Rc};78#[derive(Debug, Clone)]9pub enum Error {10 IntrinsicNotFound(Rc<str>, Rc<str>),11 IntrinsicArgumentReorderingIsNotSupportedYet,1213 UnaryOperatorDoesNotOperateOnType(UnaryOpType, ValType),14 BinaryOperatorDoesNotOperateOnValues(BinaryOpType, ValType, ValType),1516 NoTopLevelObjectFound,17 CantUseSelfOutsideOfObject,18 CantUseSuperOutsideOfObject,1920 InComprehensionCanOnlyIterateOverArray,2122 ArrayBoundsError(usize, usize),2324 AssertionFailed(Rc<str>),2526 VariableIsNotDefined(String),27 TypeMismatch(&'static str, Vec<ValType>, ValType),28 NoSuchField(Rc<str>),2930 UnknownVariable(Rc<str>),3132 OnlyFunctionsCanBeCalledGot(ValType),33 UnknownFunctionParameter(String),34 BindingParameterASecondTime(Rc<str>),35 TooManyArgsFunctionHas(usize),36 FunctionParameterNotBoundInCall(Rc<str>),3738 UndefinedExternalVariable(Rc<str>),39 UndefinedExternalFunction(Rc<str>),4041 FieldMustBeStringGot(ValType),4243 AttemptedIndexAnArrayWithString(Rc<str>),44 ValueIndexMustBeTypeGot(ValType, ValType, ValType),45 CantIndexInto(ValType),4647 StandaloneSuper,4849 ImportFileNotFound(PathBuf, PathBuf),50 ResolvedFileNotFound(PathBuf),51 ImportBadFileUtf8(PathBuf),52 ImportNotSupported(PathBuf, PathBuf),53 ImportSyntaxError {54 path: Rc<PathBuf>,55 source_code: Rc<str>,56 error: Box<jrsonnet_parser::ParseError>,57 },5859 RuntimeError(Rc<str>),60 StackOverflow,61 FractionalIndex,62 DivisionByZero,6364 StringManifestOutputIsNotAString,65 StreamManifestOutputIsNotAArray,66 MultiManifestOutputIsNotAObject,6768 StreamManifestOutputCannotBeRecursed,69 StreamManifestCannotNestString,7071 ImportCallbackError(String),72 InvalidUnicodeCodepointGot(u32),7374 Format(FormatError),75 Sort(SortError),76}77impl From<Error> for LocError {78 fn from(e: Error) -> Self {79 Self::new(e)80 }81}8283#[derive(Clone, Debug)]84pub struct StackTraceElement {85 pub location: ExprLocation,86 pub desc: String,87}88#[derive(Debug, Clone)]89pub struct StackTrace(pub Vec<StackTraceElement>);9091#[derive(Debug, Clone)]92pub struct LocError(Box<(Error, StackTrace)>);93impl LocError {94 pub fn new(e: Error) -> Self {95 Self(Box::new((e, StackTrace(vec![]))))96 }9798 pub const fn error(&self) -> &Error {99 &(self.0).0100 }101 pub const fn trace(&self) -> &StackTrace {102 &(self.0).1103 }104 pub fn trace_mut(&mut self) -> &mut StackTrace {105 &mut (self.0).1106 }107}108109pub type Result<V> = std::result::Result<V, LocError>;110111#[macro_export]112macro_rules! throw {113 ($e: expr) => {114 return Err($e.into());115 };116}crates/jrsonnet-evaluator/src/trace/mod.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/trace/mod.rs
+++ b/crates/jrsonnet-evaluator/src/trace/mod.rs
@@ -86,7 +86,7 @@
evaluation_state: &EvaluationState,
error: &LocError,
) -> Result<(), std::fmt::Error> {
- writeln!(out, "{:?}", error.error())?;
+ writeln!(out, "{}", error.error())?;
let file_names = error
.trace()
.0
@@ -132,7 +132,7 @@
evaluation_state: &EvaluationState,
error: &LocError,
) -> Result<(), std::fmt::Error> {
- writeln!(out, "{:?}", error.error())?;
+ writeln!(out, "{}", error.error())?;
for (i, item) in error.trace().0.iter().enumerate() {
if i != 0 {
writeln!(out)?;
@@ -171,7 +171,7 @@
display_list::{DisplayList, FormatOptions},
snippet::{AnnotationType, Slice, Snippet, SourceAnnotation},
};
- writeln!(out, "{:?}", error.error())?;
+ writeln!(out, "{}", error.error())?;
let trace = &error.trace();
for item in trace.0.iter() {
let desc = &item.desc;