git.delta.rocks / jrsonnet / refs/commits / ceab885d07f7

1#![feature(box_syntax, box_patterns)]2#![feature(type_alias_impl_trait)]3#![feature(debug_non_exhaustive)]4#![feature(test)]5#![feature(stmt_expr_attributes)]6#![allow(macro_expanded_macro_exports_accessed_by_absolute_paths)]78extern crate test;910mod ctx;11mod dynamic;12mod error;13mod evaluate;14mod function;15mod import;16mod map;17mod obj;18mod val;19pub mod trace;2021pub use ctx::*;22pub use dynamic::*;23pub use error::*;24pub use evaluate::*;25pub use function::parse_function_call;26pub use import::*;27use jrsonnet_parser::*;28pub use obj::*;29use std::{cell::{Ref, RefCell, RefMut}, collections::HashMap, fmt::Debug, path::PathBuf, rc::Rc};30pub use val::*;31use trace::{offset_to_location, CodeLocation};3233type BindableFn = dyn Fn(Option<ObjValue>, Option<ObjValue>) -> Result<LazyVal>;34#[derive(Clone)]35pub enum LazyBinding {36	Bindable(Rc<BindableFn>),37	Bound(LazyVal),38}3940impl Debug for LazyBinding {41	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {42		write!(f, "LazyBinding")43	}44}45impl LazyBinding {46	pub fn evaluate(&self, this: Option<ObjValue>, super_obj: Option<ObjValue>) -> Result<LazyVal> {47		match self {48			LazyBinding::Bindable(v) => v(this, super_obj),49			LazyBinding::Bound(v) => Ok(v.clone()),50		}51	}52}5354struct EvaluationSettings {55	max_stack_frames: usize,56	max_stack_trace_size: usize,57	ext_vars: HashMap<Rc<str>, Val>,58	globals: HashMap<Rc<str>, Val>,59	import_resolver: Box<dyn ImportResolver>,60}61impl Default for EvaluationSettings {62	fn default() -> Self {63		EvaluationSettings {64			max_stack_frames: 200,65			max_stack_trace_size: 20,66			globals: Default::default(),67			ext_vars: Default::default(),68			import_resolver: Box::new(DummyImportResolver),69		}70	}71}7273#[derive(Default)]74struct EvaluationData {75	/// Used for stack overflow detection, stacktrace is now populated on unwind76	stack_depth: usize,77	/// Contains file source codes and evaluated results for imports and pretty78	/// printing stacktraces79	files: HashMap<Rc<PathBuf>, FileData>,80	str_files: HashMap<Rc<PathBuf>, Rc<str>>,81}8283pub struct FileData(Rc<str>, LocExpr, Option<Val>);84#[derive(Default)]85pub struct EvaluationStateInternals {86	data: RefCell<EvaluationData>,87	settings: RefCell<EvaluationSettings>,88}8990thread_local! {91	/// Contains state for currently executing file92	/// Global state is fine there93	pub(crate) static EVAL_STATE: RefCell<Option<EvaluationState>> = RefCell::new(None)94}95pub(crate) fn with_state<T>(f: impl FnOnce(&EvaluationState) -> T) -> T {96	EVAL_STATE.with(|s| f(s.borrow().as_ref().unwrap()))97}98pub fn create_error(err: Error) -> LocError {99	with_state(|s| s.error(err))100}101pub fn create_error_result<T>(err: Error) -> Result<T> {102	Err(with_state(|s| s.error(err)))103}104pub(crate) fn push<T>(105	e: &Option<ExprLocation>,106	frame_desc: impl FnOnce() -> String,107	f: impl FnOnce() -> Result<T>,108) -> Result<T> {109	if let Some(v) = e {110		with_state(|s| s.push(&v, frame_desc, f))111	} else {112		f()113	}114}115116/// Maintains stack trace and import resolution117#[derive(Default, Clone)]118pub struct EvaluationState(Rc<EvaluationStateInternals>);119impl EvaluationState {120	fn data(&self) -> Ref<EvaluationData> {121		self.0.data.borrow()122	}123	fn data_mut(&self) -> RefMut<EvaluationData> {124		self.0.data.borrow_mut()125	}126	fn settings(&self) -> Ref<EvaluationSettings> {127		self.0.settings.borrow()128	}129	fn settings_mut(&self) -> RefMut<EvaluationSettings> {130		self.0.settings.borrow_mut()131	}132133	pub fn set_import_resolver(&self, resolver: Box<dyn ImportResolver>) {134		self.settings_mut().import_resolver = resolver;135	}136	pub fn import_resolver(&self) -> Ref<dyn ImportResolver> {137		Ref::map(self.settings(), |s|&*s.import_resolver)138	}139140	pub fn evaluate_file_to_json(141		&self,142		path: &PathBuf,143	) -> std::result::Result<Rc<str>, LocError> {144		self.import_file(&PathBuf::new(), &path).and_then(|v|v.into_json(4))145	}146	pub fn evaluate_snippet_to_json(147		&self,148		path: &PathBuf,149		snippet: &str,150	) -> std::result::Result<Rc<str>, LocError> {151		self.parse_evaluate_raw_with_source(Rc::new(path.clone()), snippet).and_then(|v|v.into_json(4))152	}153154	pub fn add_file(155		&self,156		name: Rc<PathBuf>,157		code: Rc<str>,158	) -> std::result::Result<(), ParseError> {159		self.data_mut().files.insert(160			name.clone(),161			FileData(162				code.clone(),163				parse(164					&code,165					&ParserSettings {166						file_name: name,167						loc_data: true,168					},169				)?,170				None,171			),172		);173174		Ok(())175	}176	pub fn add_parsed_file(177		&self,178		name: Rc<PathBuf>,179		code: Rc<str>,180		parsed: LocExpr,181	) -> std::result::Result<(), ()> {182		self.data_mut()183			.files184			.insert(name, FileData(code, parsed, None));185186		Ok(())187	}188	pub fn get_source(&self, name: &PathBuf) -> Option<Rc<str>> {189		let ro_map = &self.data().files;190		ro_map.get(name).map(|value| value.0.clone())191	}192	pub fn map_source_locations(&self, file: &PathBuf, locs: &[usize]) -> Vec<CodeLocation> {193		offset_to_location(&self.get_source(file).unwrap(), locs)194	}195196	pub fn evaluate_file(&self, name: &PathBuf) -> Result<Val> {197		self.run_in_state(|| {198			let expr: LocExpr = {199				let ro_map = &self.data().files;200				let value = ro_map201					.get(name)202					.unwrap_or_else(|| panic!("file not added: {:?}", name));203				if value.2.is_some() {204					return Ok(value.2.clone().unwrap());205				}206				value.1.clone()207			};208			let value = evaluate(self.create_default_context()?, &expr)?;209			{210				self.0211					.data.borrow_mut()212					.files213					.get_mut(name)214					.unwrap()215					.2216					.replace(value.clone());217			}218			Ok(value)219		})220	}221	pub(crate) fn import_file(&self, from: &PathBuf, path: &PathBuf) -> Result<Val> {222		let file_path = self.settings().import_resolver.resolve_file(from, path)?;223		{224			let files = &self.data().files;225			if files.contains_key(&file_path) {226				return self.evaluate_file(&file_path);227			}228		}229		let contents = self.settings().import_resolver.load_file_contents(&file_path)?;230		self.add_file(file_path.clone(), contents).map_err(|e| {231			create_error(Error::ImportSyntaxError(e))232		})?;233		self.evaluate_file(&file_path)234	}235	pub(crate) fn import_file_str(&self, from: &PathBuf, path: &PathBuf) -> Result<Rc<str>> {236		let path = self.settings().import_resolver.resolve_file(from, path)?;237		if !self.data().str_files.contains_key(&path) {238			let file_str = self.settings().import_resolver.load_file_contents(&path)?;239			self.data_mut()240				.str_files241				.insert(path.clone(), file_str);242		}243		Ok(self.data().str_files.get(&path).cloned().unwrap())244	}245246	pub fn parse_evaluate_raw_with_source(&self, source: Rc<PathBuf>, code: &str) -> Result<Val> {247		let parsed = parse(248			&code,249			&ParserSettings {250				file_name: source,251				loc_data: true,252			},253		)254		.unwrap();255		self.evaluate_raw(parsed)256	}257	pub fn parse_evaluate_raw(&self, code: &str) -> Result<Val> {258		self.parse_evaluate_raw_with_source(Rc::new(PathBuf::from("raw.jsonnet")), code)259	}260261	pub fn evaluate_raw(&self, code: LocExpr) -> Result<Val> {262		self.run_in_state(|| evaluate(self.create_default_context()?, &code))263	}264265	pub fn add_global(&self, name: Rc<str>, value: Val) {266		self.settings_mut().globals.insert(name, value);267	}268	pub fn add_ext_var(&self, name: Rc<str>, value: Val) {269		self.settings_mut().ext_vars.insert(name, value);270	}271	pub fn set_max_trace(&self, max_trace: usize) {272		self.settings_mut().max_stack_trace_size = max_trace;273	}274	pub fn set_max_stack(&self, max_stack: usize) {275		self.settings_mut().max_stack_frames = max_stack;276	}277278	pub fn with_stdlib(&self) -> &Self {279		let std_path = Rc::new(PathBuf::from("std.jsonnet"));280		self.run_in_state(|| {281			use jrsonnet_stdlib::STDLIB_STR;282			let mut parsed = false;283			#[cfg(feature = "codegenerated-stdlib")]284			if !parsed {285				parsed = true;286				#[allow(clippy::all)]287				let stdlib = {288					use jrsonnet_parser::*;289					include!(concat!(env!("OUT_DIR"), "/stdlib.rs"))290				};291				self.add_parsed_file(std_path.clone(), STDLIB_STR.to_owned().into(), stdlib)292					.unwrap();293			}294295			#[cfg(feature = "serialized-stdlib")]296			if !parsed {297				parsed = true;298				self.add_parsed_file(299					std_path.clone(),300					STDLIB_STR.to_owned().into(),301					bincode::deserialize(include_bytes!(concat!(302						env!("OUT_DIR"),303						"/stdlib.bincode"304					)))305					.expect("deserialize stdlib"),306				)307				.unwrap();308			}309310			if !parsed {311				self.add_file(std_path, STDLIB_STR.to_owned().into())312					.unwrap();313			}314			let val = self.evaluate_file(&PathBuf::from("std.jsonnet")).unwrap();315			self.add_global("std".into(), val);316		});317		self318	}319320	pub fn create_default_context(&self) -> Result<Context> {321		let globals = &self.settings().globals;322		let mut new_bindings: HashMap<Rc<str>, LazyBinding> = HashMap::new();323		for (name, value) in globals.iter() {324			new_bindings.insert(325				name.clone(),326				LazyBinding::Bound(resolved_lazy_val!(value.clone())),327			);328		}329		Context::new().extend_unbound(new_bindings, None, None, None)330	}331332	/// Executes code, creating new stack frame333	pub fn push<T>(334		&self,335		e: &ExprLocation,336		frame_desc: impl FnOnce() -> String,337		f: impl FnOnce() -> Result<T>,338	) -> Result<T> {339		{340			let mut data = self.data_mut();341			let stack_depth = &mut data.stack_depth;342			if *stack_depth > self.settings().max_stack_frames {343				// Error creation uses data, so i drop guard here344				drop(data);345				return Err(self.error(Error::StackOverflow));346			} else {347				*stack_depth+=1;348			}349		}350		let result = f();351		self.data_mut().stack_depth -= 1;352		if let Err(mut err) = result {353			(err.1).0.push(StackTraceElement(e.clone(), frame_desc()));354			return Err(err);355		}356		result357	}358359	/// Creates error with stack trace360	pub fn error(&self, err: Error) -> LocError {361		LocError(err, StackTrace(vec![]))362	}363364	/// Runs passed function in state (required, if function needs to modify stack trace)365	pub fn run_in_state<T>(&self, f: impl FnOnce() -> T) -> T {366		EVAL_STATE.with(|v| {367			let has_state = v.borrow().is_some();368			if !has_state {369				v.borrow_mut().replace(self.clone());370			}371			let result = f();372			if !has_state {373				v.borrow_mut().take();374			}375			result376		})377	}378}379380#[cfg(test)]381pub mod tests {382	use super::Val;383	use crate::EvaluationState;384	use jrsonnet_parser::*;385	use std::{path::PathBuf, rc::Rc};386387	#[test]388	fn eval_state_stacktrace() {389		let state = EvaluationState::default();390		state.run_in_state(||{391			state392			.push(393				&ExprLocation(Rc::new(PathBuf::from("test1.jsonnet")), 10, 20),394				|| "outer".to_owned(),395				|| {396					state.push(397						&ExprLocation(Rc::new(PathBuf::from("test2.jsonnet")), 30, 40),398						|| "inner".to_owned(),399						|| {400							Err(create_error(crate::error::Error::RuntimeError("".into())))401						},402					)?;403					Ok(())404				},405			)406			.unwrap();407		});408	}409410	#[test]411	fn eval_state_standard() {412		let state = EvaluationState::default();413		state.with_stdlib();414		assert_eq!(415			state416				.parse_evaluate_raw(r#"std.assertEqual(std.base64("test"), "dGVzdA==")"#)417				.unwrap(),418			Val::Bool(true)419		);420	}421422	macro_rules! eval {423		($str: expr) => {424			EvaluationState::default()425				.with_stdlib()426				.parse_evaluate_raw($str)427				.unwrap()428		};429	}430	macro_rules! eval_json {431		($str: expr) => {{432			let evaluator = EvaluationState::default();433			evaluator.with_stdlib();434			evaluator.run_in_state(||{435				evaluator436					.parse_evaluate_raw($str)437					.unwrap()438					.into_json(0)439					.unwrap()440					.replace("\n", "")441			})442		}}443	}444445	/// Asserts given code returns `true`446	macro_rules! assert_eval {447		($str: expr) => {448			assert_eq!(eval!($str), Val::Bool(true))449		};450	}451452	/// Asserts given code returns `false`453	macro_rules! assert_eval_neg {454		($str: expr) => {455			assert_eq!(eval!($str), Val::Bool(false))456		};457	}458	macro_rules! assert_json {459		($str: expr, $out: expr) => {460			assert_eq!(eval_json!($str), $out.replace("\t", ""))461		};462	}463464	/// Sanity checking, before trusting to another tests465	#[test]466	fn equality_operator() {467		assert_eval!("2 == 2");468		assert_eval_neg!("2 != 2");469		assert_eval!("2 != 3");470		assert_eval_neg!("2 == 3");471		assert_eval!("'Hello' == 'Hello'");472		assert_eval_neg!("'Hello' != 'Hello'");473		assert_eval!("'Hello' != 'World'");474		assert_eval_neg!("'Hello' == 'World'");475	}476477	#[test]478	fn math_evaluation() {479		assert_eval!("2 + 2 * 2 == 6");480		assert_eval!("3 + (2 + 2 * 2) == 9");481	}482483	#[test]484	fn string_concat() {485		assert_eval!("'Hello' + 'World' == 'HelloWorld'");486		assert_eval!("'Hello' * 3 == 'HelloHelloHello'");487		assert_eval!("'Hello' + 'World' * 3 == 'HelloWorldWorldWorld'");488	}489490	#[test]491	fn faster_join() {492		assert_eval!("std.join([0,0], [[1,2],[3,4],[5,6]]) == [1,2,0,0,3,4,0,0,5,6]");493		assert_eval!("std.join(',', ['1','2','3','4']) == '1,2,3,4'");494	}495496	#[test]497	fn function_contexts() {498		assert_eval!(499			r#"500				local k = {501					t(name = self.h): [self.h, name],502					h: 3,503				};504				local f = {505					t: k.t(),506					h: 4,507				};508				f.t[0] == f.t[1]509			"#510		);511	}512513	#[test]514	fn local() {515		assert_eval!("local a = 2; local b = 3; a + b == 5");516		assert_eval!("local a = 1, b = a + 1; a + b == 3");517		assert_eval!("local a = 1; local a = 2; a == 2");518	}519520	#[test]521	fn object_lazyness() {522		assert_json!("local a = {a:error 'test'}; {}", r#"{}"#);523	}524525	#[test]526	fn object_inheritance() {527		assert_json!("{a: self.b} + {b:3}", r#"{"a": 3,"b": 3}"#);528	}529530	#[test]531	fn object_assertion_success() {532		eval!("{assert \"a\" in self} + {a:2}");533	}534535	#[test]536	fn object_assertion_error() {537		eval!("{assert \"a\" in self}");538	}539540	#[test]541	fn lazy_args() {542		eval!("local test(a) = 2; test(error '3')");543	}544545	#[test]546	#[should_panic]547	fn tailstrict_args() {548		eval!("local test(a) = 2; test(error '3') tailstrict");549	}550551	#[test]552	#[should_panic]553	fn no_binding_error() {554		eval!("a");555	}556557	#[test]558	fn test_object() {559		assert_json!("{a:2}", r#"{"a": 2}"#);560		assert_json!("{a:2+2}", r#"{"a": 4}"#);561		assert_json!("{a:2}+{b:2}", r#"{"a": 2,"b": 2}"#);562		assert_json!("{b:3}+{b:2}", r#"{"b": 2}"#);563		assert_json!("{b:3}+{b+:2}", r#"{"b": 5}"#);564		assert_json!("local test='a'; {[test]:2}", r#"{"a": 2}"#);565		assert_json!(566			r#"567				{568					name: "Alice",569					welcome: "Hello " + self.name + "!",570				}571			"#,572			r#"{"name": "Alice","welcome": "Hello Alice!"}"#573		);574		assert_json!(575			r#"576				{577					name: "Alice",578					welcome: "Hello " + self.name + "!",579				} + {580					name: "Bob"581				}582			"#,583			r#"{"name": "Bob","welcome": "Hello Bob!"}"#584		);585	}586587	#[test]588	fn functions() {589		assert_json!(r#"local a = function(b, c = 2) b + c; a(2)"#, "4");590		assert_json!(591			r#"local a = function(b, c = "Dear") b + c + d, d = "World"; a("Hello")"#,592			r#""HelloDearWorld""#593		);594	}595596	#[test]597	fn local_methods() {598		assert_json!(r#"local a(b, c = 2) = b + c; a(2)"#, "4");599		assert_json!(600			r#"local a(b, c = "Dear") = b + c + d, d = "World"; a("Hello")"#,601			r#""HelloDearWorld""#602		);603	}604605	#[test]606	fn object_locals() {607		assert_json!(r#"{local a = 3, b: a}"#, r#"{"b": 3}"#);608		assert_json!(r#"{local a = 3, local c = a, b: c}"#, r#"{"b": 3}"#);609		assert_json!(610			r#"{local a = function (b) {[b]:4}, test: a("test")}"#,611			r#"{"test": {"test": 4}}"#612		);613	}614615	#[test]616	fn object_comp() {617		assert_json!(618			r#"{local t = "a", ["h"+i+"_"+z]: if "h"+(i-1)+"_"+z in self then t+1 else 0+t for i in [1,2,3] for z in [2,3,4] if z != i}"#,619			"{\"h1_2\": \"0a\",\"h1_3\": \"0a\",\"h1_4\": \"0a\",\"h2_3\": \"a1\",\"h2_4\": \"a1\",\"h3_2\": \"0a\",\"h3_4\": \"a1\"}"620		)621	}622623	#[test]624	fn direct_self() {625		println!(626			"{:#?}",627			eval!(628				r#"629					{630						local me = self,631						a: 3,632						b(): me.a,633					}634				"#635			)636		);637	}638639	#[test]640	fn indirect_self() {641		// `self` assigned to `me` was lost when being642		// referenced from field643		eval!(644			r#"{645				local me = self,646				a: 3,647				b: me.a,648			}.b"#649		);650	}651652	// We can't trust other tests (And official jsonnet testsuite), if assert is not working correctly653	#[test]654	fn std_assert_ok() {655		eval!("std.assertEqual(4.5 << 2, 16)");656	}657658	#[test]659	#[should_panic]660	fn std_assert_failure() {661		eval!("std.assertEqual(4.5 << 2, 15)");662	}663664	#[test]665	fn string_is_string() {666		assert_eq!(667			eval!("local arr = 'hello'; (!std.isArray(arr)) && (!std.isString(arr))"),668			Val::Bool(false)669		);670	}671672	#[test]673	fn base64_works() {674		assert_json!(r#"std.base64("test")"#, r#""dGVzdA==""#);675	}676677	#[test]678	fn utf8_chars() {679		assert_json!(680			r#"local c="😎";{c:std.codepoint(c),l:std.length(c)}"#,681			r#"{"c": 128526,"l": 1}"#682		)683	}684685	#[test]686	fn json() {687		assert_json!(688			r#"std.manifestJsonEx({a:3, b:4, c:6},"")"#,689			r#""{\n\"a\": 3,\n\"b\": 4,\n\"c\": 6\n}""#690		);691	}692693	#[test]694	fn test() {695		assert_json!(696			r#"[[a, b] for a in [1,2,3] for b in [4,5,6]]"#,697			"[[1,4],[1,5],[1,6],[2,4],[2,5],[2,6],[3,4],[3,5],[3,6]]"698		);699	}700701	#[test]702	fn sjsonnet() {703		eval!(704			r#"705			local x0 = {k: 1};706			local x1 = {k: x0.k + x0.k};707			local x2 = {k: x1.k + x1.k};708			local x3 = {k: x2.k + x2.k};709			local x4 = {k: x3.k + x3.k};710			local x5 = {k: x4.k + x4.k};711			local x6 = {k: x5.k + x5.k};712			local x7 = {k: x6.k + x6.k};713			local x8 = {k: x7.k + x7.k};714			local x9 = {k: x8.k + x8.k};715			local x10 = {k: x9.k + x9.k};716			local x11 = {k: x10.k + x10.k};717			local x12 = {k: x11.k + x11.k};718			local x13 = {k: x12.k + x12.k};719			local x14 = {k: x13.k + x13.k};720			local x15 = {k: x14.k + x14.k};721			local x16 = {k: x15.k + x15.k};722			local x17 = {k: x16.k + x16.k};723			local x18 = {k: x17.k + x17.k};724			local x19 = {k: x18.k + x18.k};725			local x20 = {k: x19.k + x19.k};726			local x21 = {k: x20.k + x20.k};727			x21.k728		"#729		);730	}731732	use test::Bencher;733734	// This test is commented out by default, because of huge compilation slowdown735	// #[bench]736	// fn bench_codegen(b: &mut Bencher) {737	// 	b.iter(|| {738	// 		#[allow(clippy::all)]739	// 		let stdlib = {740	// 			use jrsonnet_parser::*;741	// 			include!(concat!(env!("OUT_DIR"), "/stdlib.rs"))742	// 		};743	// 		stdlib744	// 	})745	// }746747	#[bench]748	fn bench_serialize(b: &mut Bencher) {749		b.iter(|| {750			bincode::deserialize::<jrsonnet_parser::LocExpr>(include_bytes!(concat!(751				env!("OUT_DIR"),752				"/stdlib.bincode"753			)))754			.expect("deserialize stdlib")755		})756	}757758	#[bench]759	fn bench_parse(b: &mut Bencher) {760		b.iter(|| {761			jrsonnet_parser::parse(762				jrsonnet_stdlib::STDLIB_STR,763				&jrsonnet_parser::ParserSettings {764					loc_data: true,765					file_name: Rc::new(PathBuf::from("std.jsonnet")),766				},767			)768		})769	}770}