difftreelog
feat friendlier errors
in: master
8 files changed
Cargo.lockdiffbeforeafterboth--- a/Cargo.lock
+++ b/Cargo.lock
@@ -3,6 +3,17 @@
version = 3
[[package]]
+name = "ahash"
+version = "0.7.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fcb51a0695d8f838b1ee009b3fbf66bda078cd64590202a864a8f3e8c4315c47"
+dependencies = [
+ "getrandom",
+ "once_cell",
+ "version_check",
+]
+
+[[package]]
name = "annotate-snippets"
version = "0.9.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -69,6 +80,12 @@
checksum = "4785bdd1c96b2a846b2bd7cc02e86b6b3dbf14e7e53446c4f54c92a361040822"
[[package]]
+name = "cfg-if"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
+
+[[package]]
name = "clap"
version = "3.1.13"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -152,12 +169,32 @@
]
[[package]]
+name = "getrandom"
+version = "0.2.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9be70c98951c83b8d2f8f60d7065fa6d5146873094452a1008da8c2f1e4205ad"
+dependencies = [
+ "cfg-if 1.0.0",
+ "libc",
+ "wasi",
+]
+
+[[package]]
name = "hashbrown"
version = "0.11.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ab5ef0d4909ef3724cc8cce6ccc8572c5c817592e9285f5464f8e86f8bd3726e"
[[package]]
+name = "hashbrown"
+version = "0.12.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "db0d4cf898abf0081f964436dc980e96670a0f36863e4b83aaacdb65c9d7ccc3"
+dependencies = [
+ "ahash",
+]
+
+[[package]]
name = "heck"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -179,7 +216,7 @@
checksum = "bc633605454125dec4b66843673f01c7df2b89479b32e0ed634e43a91cff62a5"
dependencies = [
"autocfg",
- "hashbrown",
+ "hashbrown 0.11.2",
]
[[package]]
@@ -221,6 +258,7 @@
"base64",
"bincode",
"gcmodule",
+ "hashbrown 0.12.1",
"jrsonnet-interner",
"jrsonnet-macros",
"jrsonnet-parser",
@@ -232,6 +270,8 @@
"serde",
"serde_json",
"serde_yaml",
+ "static_assertions",
+ "strsim",
"thiserror",
]
@@ -240,6 +280,7 @@
version = "0.4.2"
dependencies = [
"gcmodule",
+ "hashbrown 0.12.1",
"rustc-hash",
"serde",
]
@@ -262,6 +303,7 @@
"jrsonnet-stdlib",
"peg",
"serde",
+ "static_assertions",
]
[[package]]
@@ -293,9 +335,9 @@
[[package]]
name = "libc"
-version = "0.2.108"
+version = "0.2.125"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8521a1b57e76b1ec69af7599e75e38e7b7fad6610f037db8c79b127201b5d119"
+checksum = "5916d2ae698f6de9bfb891ad7a8d65c09d232dc58cc4ac433c7da3b2fd84bc2b"
[[package]]
name = "linked-hash-map"
@@ -338,6 +380,12 @@
]
[[package]]
+name = "once_cell"
+version = "1.10.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "87f3e037eac156d1775da914196f0f37741a274155e34a0b7e427c35d2a2ecb9"
+
+[[package]]
name = "os_str_bytes"
version = "6.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -359,7 +407,7 @@
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d58c7c768d4ba344e3e8d72518ac13e259d7c7ade24167003b8488e10b6740a3"
dependencies = [
- "cfg-if",
+ "cfg-if 0.1.10",
"cloudabi",
"libc",
"redox_syscall",
@@ -516,6 +564,12 @@
checksum = "1ecab6c735a6bb4139c0caafd0cc3635748bbb3acf4550e8138122099251f309"
[[package]]
+name = "static_assertions"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f"
+
+[[package]]
name = "strsim"
version = "0.10.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -598,6 +652,12 @@
checksum = "5fecdca9a5291cc2b8dcf7dc02453fee791a280f3743cb0905f8822ae463b3fe"
[[package]]
+name = "wasi"
+version = "0.10.2+wasi-snapshot-preview1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fd6fbd9a79829dd1ad0cc20627bf1ed606756a7f77edff7b66b7064f9cb327c6"
+
+[[package]]
name = "winapi"
version = "0.3.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
Cargo.tomldiffbeforeafterboth--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,9 +1,5 @@
[workspace]
-members = [
- "crates/*",
- "bindings/jsonnet",
- "cmds/jrsonnet",
-]
+members = ["crates/*", "bindings/jsonnet", "cmds/jrsonnet"]
[profile.test]
opt-level = 1
@@ -14,3 +10,4 @@
codegen-units = 1
debug = 0
panic = "abort"
+strip = true
bindings/jsonnet/src/import.rsdiffbeforeafterboth1//! Import resolution manipulation utilities23use std::{4 any::Any,5 cell::RefCell,6 collections::HashMap,7 ffi::{c_void, CStr, CString},8 fs::File,9 io::Read,10 os::raw::{c_char, c_int},11 path::{Path, PathBuf},12 ptr::null_mut,13};1415use jrsonnet_evaluator::{16 error::{Error::*, Result},17 throw, ImportResolver, State,18};1920pub type JsonnetImportCallback = unsafe extern "C" fn(21 ctx: *mut c_void,22 base: *const c_char,23 rel: *const c_char,24 found_here: *mut *const c_char,25 success: &mut c_int,26) -> *mut c_char;2728/// Resolves imports using callback29pub struct CallbackImportResolver {30 cb: JsonnetImportCallback,31 ctx: *mut c_void,32 out: RefCell<HashMap<PathBuf, Vec<u8>>>,33}34impl ImportResolver for CallbackImportResolver {35 fn resolve_file(&self, from: &Path, path: &Path) -> Result<PathBuf> {36 let base = CString::new(from.to_str().unwrap()).unwrap().into_raw();37 let rel = CString::new(path.to_str().unwrap()).unwrap().into_raw();38 let found_here: *mut c_char = null_mut();39 let mut success: i32 = 0;40 let result_ptr = unsafe {41 (self.cb)(42 self.ctx,43 base,44 rel,45 &mut (found_here as *const _),46 &mut success,47 )48 };49 // Release memory occipied by arguments passed50 unsafe {51 let _ = CString::from_raw(base);52 let _ = CString::from_raw(rel);53 }54 let result_raw = unsafe { CStr::from_ptr(result_ptr) };55 let result_str = result_raw.to_str().unwrap();56 assert!(success == 0 || success == 1);57 if success == 0 {58 unsafe { CString::from_raw(result_ptr) };59 let result = result_str.to_owned();60 throw!(ImportCallbackError(result));61 }6263 let found_here_raw = unsafe { CStr::from_ptr(found_here) };64 let found_here_buf = PathBuf::from(found_here_raw.to_str().unwrap());65 unsafe {66 let _ = CString::from_raw(found_here);67 }6869 let mut out = self.out.borrow_mut();70 if !out.contains_key(&found_here_buf) {71 out.insert(found_here_buf.clone(), result_str.into());72 unsafe { CString::from_raw(result_ptr) };73 }7475 Ok(found_here_buf)76 }77 fn load_file_contents(&self, resolved: &Path) -> Result<Vec<u8>> {78 Ok(self.out.borrow().get(resolved).unwrap().clone())79 }8081 unsafe fn as_any(&self) -> &dyn Any {82 self83 }84}8586/// # Safety87#[no_mangle]88pub unsafe extern "C" fn jsonnet_import_callback(89 vm: &State,90 cb: JsonnetImportCallback,91 ctx: *mut c_void,92) {93 vm.set_import_resolver(Box::new(CallbackImportResolver {94 cb,95 ctx,96 out: RefCell::new(HashMap::new()),97 }))98}99100/// Standard FS import resolver101#[derive(Default)]102pub struct NativeImportResolver {103 library_paths: RefCell<Vec<PathBuf>>,104}105impl NativeImportResolver {106 fn add_jpath(&self, path: PathBuf) {107 self.library_paths.borrow_mut().push(path);108 }109}110impl ImportResolver for NativeImportResolver {111 fn resolve_file(&self, from: &Path, path: &Path) -> Result<PathBuf> {112 let mut new_path = from.to_owned();113 new_path.push(path);114 if new_path.exists() {115 Ok(new_path.into())116 } else {117 for library_path in self.library_paths.borrow().iter() {118 let mut cloned = library_path.clone();119 cloned.push(path);120 if cloned.exists() {121 return Ok(cloned.into());122 }123 }124 throw!(ImportFileNotFound(from.to_owned(), path.to_owned()))125 }126 }127 fn load_file_contents(&self, id: &Path) -> Result<Vec<u8>> {128 let mut file = File::open(id).map_err(|_e| ResolvedFileNotFound(id.to_owned()))?;129 let mut out = Vec::new();130 file.read_to_end(&mut out)131 .map_err(|e| ImportIo(e.to_string()))?;132 Ok(out)133 }134 unsafe fn as_any(&self) -> &dyn Any {135 self136 }137}138139/// # Safety140///141/// This function is safe, if received v is a pointer to normal C string142#[no_mangle]143pub unsafe extern "C" fn jsonnet_jpath_add(vm: &State, v: *const c_char) {144 let cstr = CStr::from_ptr(v);145 let path = PathBuf::from(cstr.to_str().unwrap());146 let any_resolver = &vm.settings().import_resolver;147 let resolver = any_resolver148 .as_any()149 .downcast_ref::<NativeImportResolver>()150 .expect("jpaths are not compatible with callback imports!");151 resolver.add_jpath(path);152}bindings/jsonnet/src/vars_tlas.rsdiffbeforeafterboth--- a/bindings/jsonnet/src/vars_tlas.rs
+++ b/bindings/jsonnet/src/vars_tlas.rs
@@ -20,11 +20,8 @@
pub unsafe extern "C" fn jsonnet_ext_code(vm: &State, name: *const c_char, value: *const c_char) {
let name = CStr::from_ptr(name);
let value = CStr::from_ptr(value);
- vm.add_ext_code(
- name.to_str().unwrap().into(),
- value.to_str().unwrap().into(),
- )
- .unwrap()
+ vm.add_ext_code(name.to_str().unwrap(), value.to_str().unwrap().into())
+ .unwrap()
}
/// # Safety
#[no_mangle]
@@ -41,9 +38,6 @@
pub unsafe extern "C" fn jsonnet_tla_code(vm: &State, name: *const c_char, value: *const c_char) {
let name = CStr::from_ptr(name);
let value = CStr::from_ptr(value);
- vm.add_tla_code(
- name.to_str().unwrap().into(),
- value.to_str().unwrap().into(),
- )
- .unwrap()
+ vm.add_tla_code(name.to_str().unwrap().into(), value.to_str().unwrap())
+ .unwrap()
}
crates/jrsonnet-evaluator/Cargo.tomldiffbeforeafterboth--- a/crates/jrsonnet-evaluator/Cargo.toml
+++ b/crates/jrsonnet-evaluator/Cargo.toml
@@ -7,13 +7,16 @@
edition = "2021"
[features]
-default = ["serialized-stdlib", "explaining-traces"]
+default = ["serialized-stdlib", "explaining-traces", "friendly-errors"]
# Serializes standard library AST instead of parsing them every run
serialized-stdlib = ["bincode", "jrsonnet-parser/serde"]
# Rustc-like trace visualization
explaining-traces = ["annotate-snippets"]
# Allows library authors to throw custom errors
anyhow-error = ["anyhow"]
+# Provides helpful explaintations to errors, at cost of adding
+# more dependencies and slowing down error path
+friendly-errors = ["strsim"]
# Allows to preserve field order in objects
exp-preserve-order = []
@@ -42,20 +45,13 @@
serde_json = "1.0"
serde_yaml = { git = "https://github.com/CertainLach/serde-yaml", branch = "feature/old-octals-quirk" }
-[dependencies.anyhow]
-version = "1.0"
-optional = true
-
+anyhow = { version = "1.0", optional = true }
+# Friendly errors
+strsim = { version = "0.10.0", optional = true }
# Serialized stdlib
-[dependencies.bincode]
-version = "1.3"
-optional = true
-
+bincode = { version = "1.3", optional = true }
# Explaining traces
-[dependencies.annotate-snippets]
-version = "0.9.1"
-features = ["color"]
-optional = true
+annotate-snippets = { version = "0.9.1", features = ["color"], optional = true }
[build-dependencies]
jrsonnet-stdlib = { path = "../jrsonnet-stdlib", version = "0.4.2" }
crates/jrsonnet-evaluator/src/ctx.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/ctx.rs
+++ b/crates/jrsonnet-evaluator/src/ctx.rs
@@ -49,13 +49,40 @@
}))
}
+ #[cfg(not(feature = "friendly-errors"))]
pub fn binding(&self, name: IStr) -> Result<Thunk<Val>> {
Ok(self
.0
.bindings
.get(&name)
.cloned()
- .ok_or(VariableIsNotDefined(name))?)
+ .ok_or(VariableIsNotDefined(name, vec![]))?)
+ }
+
+ #[cfg(feature = "friendly-errors")]
+ pub fn binding(&self, name: IStr) -> Result<Thunk<Val>> {
+ use std::cmp::Ordering;
+
+ use crate::throw;
+
+ if let Some(val) = self.0.bindings.get(&name).cloned() {
+ return Ok(val);
+ }
+
+ let mut heap = Vec::new();
+ self.0.bindings.clone().iter_keys(|k| {
+ let conf = strsim::jaro_winkler(&k as &str, &name as &str);
+ if conf < 0.8 {
+ return;
+ }
+ heap.push((conf, k));
+ });
+ heap.sort_by(|a, b| b.0.partial_cmp(&a.0).unwrap_or(Ordering::Equal));
+
+ throw!(VariableIsNotDefined(
+ name,
+ heap.into_iter().map(|(_, k)| k).collect()
+ ))
}
pub fn contains_binding(&self, name: IStr) -> bool {
self.0.bindings.contains_key(&name)
crates/jrsonnet-evaluator/src/error.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/error.rs
+++ b/crates/jrsonnet-evaluator/src/error.rs
@@ -11,6 +11,30 @@
typed::TypeLocError,
};
+fn format_found(list: &[IStr], what: &str) -> String {
+ if list.is_empty() {
+ return String::new();
+ }
+ let mut out = String::new();
+ out.push_str("\nThere is ");
+ out.push_str(what);
+ if list.len() > 1 {
+ out.push('s');
+ }
+ out.push_str(" with similar name");
+ if list.len() > 1 {
+ out.push('s');
+ }
+ out.push_str(" present: ");
+ for (i, v) in list.iter().enumerate() {
+ if i != 0 {
+ out.push_str(", ");
+ }
+ out.push_str(v as &str);
+ }
+ out
+}
+
#[derive(Error, Debug, Clone, Trace)]
pub enum Error {
#[error("intrinsic not found: {0}")]
@@ -39,15 +63,15 @@
#[error("assert failed: {0}")]
AssertionFailed(IStr),
- #[error("variable is not defined: {0}")]
- VariableIsNotDefined(IStr),
+ #[error("variable is not defined: {0}{}", format_found(.1, "variable"))]
+ VariableIsNotDefined(IStr, Vec<IStr>),
#[error("duplicate local var: {0}")]
DuplicateLocalVar(IStr),
#[error("type mismatch: expected {}, got {2} {0}", .1.iter().map(|e| format!("{}", e)).collect::<Vec<_>>().join(", "))]
TypeMismatch(&'static str, Vec<ValType>, ValType),
- #[error("no such field: {0}")]
- NoSuchField(IStr),
+ #[error("no such field: {0}{}", format_found(.1, "field"))]
+ NoSuchField(IStr, Vec<IStr>),
#[error("only functions can be called, got {0}")]
OnlyFunctionsCanBeCalledGot(ValType),
crates/jrsonnet-evaluator/src/evaluate/mod.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/evaluate/mod.rs
+++ b/crates/jrsonnet-evaluator/src/evaluate/mod.rs
@@ -1,4 +1,4 @@
-use std::rc::Rc;
+use std::{cmp::Ordering, rc::Rc};
use gcmodule::{Cc, Trace};
use jrsonnet_interner::IStr;
@@ -450,7 +450,29 @@
|| format!("field <{}> access", key),
|| match v.get(s.clone(), key.clone()) {
Ok(Some(v)) => Ok(v),
- Ok(None) => throw!(NoSuchField(key.clone())),
+ #[cfg(not(feature = "friendly-errors"))]
+ Ok(None) => throw!(NoSuchField(key.clone(), vec![])),
+ #[cfg(feature = "friendly-errors")]
+ Ok(None) => {
+ let mut heap = Vec::new();
+ for field in v.fields_ex(
+ true,
+ #[cfg(feature = "exp-preserve-order")]
+ false,
+ ) {
+ let conf = strsim::jaro_winkler(&field as &str, &key as &str);
+ if conf < 0.8 {
+ continue;
+ }
+ heap.push((conf, field));
+ }
+ heap.sort_by(|a, b| b.0.partial_cmp(&a.0).unwrap_or(Ordering::Equal));
+
+ throw!(NoSuchField(
+ key.clone(),
+ heap.into_iter().map(|(_, v)| v).collect()
+ ))
+ }
Err(e) if matches!(e.error(), MagicThisFileUsed) => {
Ok(Val::Str(loc.0.full_path().into()))
}
@@ -630,14 +652,14 @@
let path = s.resolve_file(&import_location, path as &str)?;
match i {
Import(_) => s.push(
- CallLocation::new(loc),
+ CallLocation::new(loc),
|| format!("import {:?}", path.clone()),
|| s.import(path.clone()),
)?,
ImportStr(_) => Val::Str(s.import_str(path)?),
ImportBin(_) => Val::Arr(ArrValue::Bytes(s.import_bin(path)?)),
_ => unreachable!(),
- }
+ }
}
})
}