git.delta.rocks / jrsonnet / refs/commits / 9f8d4fc520b3

difftreelog

feat friendlier errors

Yaroslav Bolyukin2022-05-26parent: #96da6f3.patch.diff
in: master

8 files changed

modifiedCargo.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"
modifiedCargo.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
modifiedbindings/jsonnet/src/import.rsdiffbeforeafterboth
--- a/bindings/jsonnet/src/import.rs
+++ b/bindings/jsonnet/src/import.rs
@@ -32,9 +32,9 @@
 	out: RefCell<HashMap<PathBuf, Vec<u8>>>,
 }
 impl ImportResolver for CallbackImportResolver {
-	fn resolve_file(&self, from: &Path, path: &Path) -> Result<PathBuf> {
+	fn resolve_file(&self, from: &Path, path: &str) -> Result<PathBuf> {
 		let base = CString::new(from.to_str().unwrap()).unwrap().into_raw();
-		let rel = CString::new(path.to_str().unwrap()).unwrap().into_raw();
+		let rel = CString::new(path).unwrap().into_raw();
 		let found_here: *mut c_char = null_mut();
 		let mut success: i32 = 0;
 		let result_ptr = unsafe {
@@ -108,17 +108,17 @@
 	}
 }
 impl ImportResolver for NativeImportResolver {
-	fn resolve_file(&self, from: &Path, path: &Path) -> Result<PathBuf> {
+	fn resolve_file(&self, from: &Path, path: &str) -> Result<PathBuf> {
 		let mut new_path = from.to_owned();
 		new_path.push(path);
 		if new_path.exists() {
-			Ok(new_path.into())
+			Ok(new_path)
 		} else {
 			for library_path in self.library_paths.borrow().iter() {
 				let mut cloned = library_path.clone();
 				cloned.push(path);
 				if cloned.exists() {
-					return Ok(cloned.into());
+					return Ok(cloned);
 				}
 			}
 			throw!(ImportFileNotFound(from.to_owned(), path.to_owned()))
modifiedbindings/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()
 }
modifiedcrates/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" }
modifiedcrates/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)
modifiedcrates/jrsonnet-evaluator/src/error.rsdiffbeforeafterboth
before · crates/jrsonnet-evaluator/src/error.rs
1use std::{fmt::Debug, path::PathBuf};23use gcmodule::Trace;4use jrsonnet_interner::IStr;5use jrsonnet_parser::{BinaryOpType, ExprLocation, Source, UnaryOpType};6use jrsonnet_types::ValType;7use thiserror::Error;89use crate::{10	stdlib::{format::FormatError, sort::SortError},11	typed::TypeLocError,12};1314#[derive(Error, Debug, Clone, Trace)]15pub enum Error {16	#[error("intrinsic not found: {0}")]17	IntrinsicNotFound(IStr),1819	#[error("operator {0} does not operate on type {1}")]20	UnaryOperatorDoesNotOperateOnType(UnaryOpType, ValType),21	#[error("binary operation {1} {0} {2} is not implemented")]22	BinaryOperatorDoesNotOperateOnValues(BinaryOpType, ValType, ValType),2324	#[error("no top level object in this context")]25	NoTopLevelObjectFound,26	#[error("self is only usable inside objects")]27	CantUseSelfOutsideOfObject,28	#[error("no super found")]29	NoSuperFound,3031	#[error("for loop can only iterate over arrays")]32	InComprehensionCanOnlyIterateOverArray,3334	#[error("array out of bounds: {0} is not within [0,{1})")]35	ArrayBoundsError(usize, usize),36	#[error("string out of bounds: {0} is not within [0,{1})")]37	StringBoundsError(usize, usize),3839	#[error("assert failed: {0}")]40	AssertionFailed(IStr),4142	#[error("variable is not defined: {0}")]43	VariableIsNotDefined(IStr),44	#[error("duplicate local var: {0}")]45	DuplicateLocalVar(IStr),4647	#[error("type mismatch: expected {}, got {2} {0}", .1.iter().map(|e| format!("{}", e)).collect::<Vec<_>>().join(", "))]48	TypeMismatch(&'static str, Vec<ValType>, ValType),49	#[error("no such field: {0}")]50	NoSuchField(IStr),5152	#[error("only functions can be called, got {0}")]53	OnlyFunctionsCanBeCalledGot(ValType),54	#[error("parameter {0} is not defined")]55	UnknownFunctionParameter(String),56	#[error("argument {0} is already bound")]57	BindingParameterASecondTime(IStr),58	#[error("too many args, function has {0}")]59	TooManyArgsFunctionHas(usize),60	#[error("function argument is not passed: {0}")]61	FunctionParameterNotBoundInCall(IStr),6263	#[error("external variable is not defined: {0}")]64	UndefinedExternalVariable(IStr),6566	#[error("field name should be string, got {0}")]67	FieldMustBeStringGot(ValType),68	#[error("duplicate field name: {0}")]69	DuplicateFieldName(IStr),7071	#[error("attempted to index array with string {0}")]72	AttemptedIndexAnArrayWithString(IStr),73	#[error("{0} index type should be {1}, got {2}")]74	ValueIndexMustBeTypeGot(ValType, ValType, ValType),75	#[error("cant index into {0}")]76	CantIndexInto(ValType),77	#[error("{0} is not indexable")]78	ValueIsNotIndexable(ValType),7980	#[error("super can't be used standalone")]81	StandaloneSuper,8283	#[error("can't resolve {1} from {0}")]84	ImportFileNotFound(PathBuf, String),85	#[error("resolved file not found: {0}")]86	ResolvedFileNotFound(PathBuf),87	#[error("imported file is not valid utf-8: {0:?}")]88	ImportBadFileUtf8(PathBuf),89	#[error("import io error: {0}")]90	ImportIo(String),91	#[error("tried to import {1} from {0}, but imports is not supported")]92	ImportNotSupported(PathBuf, PathBuf),93	#[error("can't import from virtual file")]94	CantImportFromVirtualFile,95	#[error(96		"syntax error: expected {}, got {:?}",97		.error.expected,98		.source_code.chars().nth(error.location.offset)99		.map_or_else(|| "EOF".into(), |c| c.to_string())100	)]101	ImportSyntaxError {102		path: Source,103		source_code: IStr,104		#[skip_trace]105		error: Box<jrsonnet_parser::ParseError>,106	},107108	#[error("runtime error: {0}")]109	RuntimeError(IStr),110	#[error("stack overflow, try to reduce recursion, or set --max-stack to bigger value")]111	StackOverflow,112	#[error("infinite recursion detected")]113	InfiniteRecursionDetected,114	#[error("tried to index by fractional value")]115	FractionalIndex,116	#[error("attempted to divide by zero")]117	DivisionByZero,118119	#[error("string manifest output is not an string")]120	StringManifestOutputIsNotAString,121	#[error("stream manifest output is not an array")]122	StreamManifestOutputIsNotAArray,123	#[error("multi manifest output is not an object")]124	MultiManifestOutputIsNotAObject,125126	#[error("cant recurse stream manifest")]127	StreamManifestOutputCannotBeRecursed,128	#[error("stream manifest output cannot consist of raw strings")]129	StreamManifestCannotNestString,130131	#[error("{0}")]132	ImportCallbackError(String),133	#[error("invalid unicode codepoint: {0}")]134	InvalidUnicodeCodepointGot(u32),135136	#[error("format error: {0}")]137	Format(#[from] FormatError),138	#[error("type error: {0}")]139	TypeError(TypeLocError),140	#[error("sort error: {0}")]141	Sort(#[from] SortError),142143	/// Thrown as error, as this is legacy feature, and error here144	/// is acceptable for defeating object field cache145	#[error("should not reach outside: std.thisFile")]146	MagicThisFileUsed,147148	#[cfg(feature = "anyhow-error")]149	#[error(transparent)]150	Other(Rc<anyhow::Error>),151}152153#[cfg(feature = "anyhow-error")]154impl From<anyhow::Error> for LocError {155	fn from(e: anyhow::Error) -> Self {156		Self::new(Error::Other(Rc::new(e)))157	}158}159160impl From<Error> for LocError {161	fn from(e: Error) -> Self {162		Self::new(e)163	}164}165166#[derive(Clone, Debug, Trace)]167pub struct StackTraceElement {168	pub location: Option<ExprLocation>,169	pub desc: String,170}171#[derive(Debug, Clone, Trace)]172pub struct StackTrace(pub Vec<StackTraceElement>);173174#[derive(Clone, Trace)]175pub struct LocError(Box<(Error, StackTrace)>);176impl LocError {177	pub fn new(e: Error) -> Self {178		Self(Box::new((e, StackTrace(vec![]))))179	}180181	pub const fn error(&self) -> &Error {182		&(self.0).0183	}184	pub fn error_mut(&mut self) -> &mut Error {185		&mut (self.0).0186	}187	pub const fn trace(&self) -> &StackTrace {188		&(self.0).1189	}190	pub fn trace_mut(&mut self) -> &mut StackTrace {191		&mut (self.0).1192	}193}194impl Debug for LocError {195	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {196		writeln!(f, "{}", self.0 .0)?;197		for el in &self.0 .1 .0 {198			writeln!(f, "\t{:?}", el)?;199		}200		Ok(())201	}202}203204pub type Result<V, E = LocError> = std::result::Result<V, E>;205206#[macro_export]207macro_rules! throw {208	($e: expr) => {209		return Err($e.into())210	};211}212213#[macro_export]214macro_rules! throw_runtime {215	($($tt:tt)*) => {216		return Err($crate::error::Error::RuntimeError(format!($($tt)*).into()).into())217	};218}
modifiedcrates/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!(),
-		}
+			}
 		}
 	})
 }