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

difftreelog

feat composable ContextInitializer

Yaroslav Bolyukin2023-07-13parent: #e98be8b.patch.diff
in: master

5 files changed

modifiedcrates/jrsonnet-evaluator/src/lib.rsdiffbeforeafterboth
--- a/crates/jrsonnet-evaluator/src/lib.rs
+++ b/crates/jrsonnet-evaluator/src/lib.rs
@@ -126,20 +126,29 @@
 /// During import, this trait will be called to create initial context for file.
 /// It may initialize global variables, stdlib for example.
 pub trait ContextInitializer: Trace {
+	/// For which size the builder should be preallocated
+	fn reserve_vars(&self) -> usize {
+		0
+	}
 	/// Initialize default file context.
-	fn initialize(&self, state: State, for_file: Source) -> Context;
+	/// Has default implementation, which calls `populate`.
+	/// Prefer to always implement `populate` instead.
+	fn initialize(&self, state: State, for_file: Source) -> Context {
+		let mut builder = ContextBuilder::with_capacity(state, self.reserve_vars());
+		self.populate(for_file, &mut builder);
+		builder.build()
+	}
+	/// For composability: extend builder. May panic if this initialization is not supported,
+	/// and the context may only be created via `initialize`.
+	fn populate(&self, for_file: Source, builder: &mut ContextBuilder);
 	/// Allows upcasting from abstract to concrete context initializer.
 	/// jrsonnet by itself doesn't use this method, it is allowed for it to panic.
 	fn as_any(&self) -> &dyn Any;
 }
 
 /// Context initializer which adds nothing.
-#[derive(Trace)]
-pub struct DummyContextInitializer;
-impl ContextInitializer for DummyContextInitializer {
-	fn initialize(&self, state: State, _for_file: Source) -> Context {
-		ContextBuilder::new(state).build()
-	}
+impl ContextInitializer for () {
+	fn populate(&self, _for_file: Source, _builder: &mut ContextBuilder) {}
 	fn as_any(&self) -> &dyn Any {
 		self
 	}
@@ -157,7 +166,7 @@
 impl Default for EvaluationSettings {
 	fn default() -> Self {
 		Self {
-			context_initializer: tb!(DummyContextInitializer),
+			context_initializer: tb!(()),
 			import_resolver: tb!(DummyImportResolver),
 		}
 	}
@@ -396,6 +405,46 @@
 	pub fn settings_mut(&self) -> RefMut<'_, EvaluationSettings> {
 		self.0.settings.borrow_mut()
 	}
+	pub fn add_global(&self, name: IStr, value: Thunk<Val>) {
+		#[derive(Trace)]
+		struct GlobalsCtx {
+			globals: RefCell<GcHashMap<IStr, Thunk<Val>>>,
+			inner: TraceBox<dyn ContextInitializer>,
+		}
+		impl ContextInitializer for GlobalsCtx {
+			fn reserve_vars(&self) -> usize {
+				self.inner.reserve_vars() + self.globals.borrow().len()
+			}
+			fn populate(&self, for_file: Source, builder: &mut ContextBuilder) {
+				self.inner.populate(for_file, builder);
+				for (name, val) in self.globals.borrow().iter() {
+					builder.bind(name.clone(), val.clone());
+				}
+			}
+
+			fn as_any(&self) -> &dyn Any {
+				self
+			}
+		}
+		let mut settings = self.settings_mut();
+		let initializer = &mut settings.context_initializer;
+		match initializer.as_any().downcast_ref::<GlobalsCtx>() {
+			Some(glob) => {
+				glob.globals.borrow_mut().insert(name, value);
+			}
+			None => {
+				let inner = std::mem::replace(&mut settings.context_initializer, tb!(()));
+				settings.context_initializer = tb!(GlobalsCtx {
+					globals: {
+						let mut out = GcHashMap::with_capacity(1);
+						out.insert(name, value);
+						RefCell::new(out)
+					},
+					inner
+				})
+			}
+		}
+	}
 }
 
 /// Raw methods evaluate passed values but don't perform TLA execution
modifiedcrates/jrsonnet-stdlib/src/lib.rsdiffbeforeafterboth
before · crates/jrsonnet-stdlib/src/lib.rs
1use std::{2	cell::{Ref, RefCell, RefMut},3	collections::HashMap,4	rc::Rc,5};67use jrsonnet_evaluator::{8	error::{ErrorKind::*, Result},9	function::{builtin::Builtin, CallLocation, FuncVal, TlaArg},10	gc::{GcHashMap, TraceBox},11	tb,12	trace::PathResolver,13	Context, ContextBuilder, IStr, ObjValue, ObjValueBuilder, State, Thunk, Val,14};15use jrsonnet_gcmodule::{Cc, Trace};16use jrsonnet_parser::Source;1718mod expr;19mod types;20pub use types::*;21mod arrays;22pub use arrays::*;23mod math;24pub use math::*;25mod operator;26pub use operator::*;27mod sort;28pub use sort::*;29mod hash;30pub use hash::*;31mod encoding;32pub use encoding::*;33mod objects;34pub use objects::*;35mod manifest;36pub use manifest::*;37mod parse;38pub use parse::*;39mod strings;40pub use strings::*;41mod misc;42pub use misc::*;43mod sets;44pub use sets::*;45mod compat;46pub use compat::*;4748pub fn stdlib_uncached(settings: Rc<RefCell<Settings>>) -> ObjValue {49	let mut builder = ObjValueBuilder::new();5051	let expr = expr::stdlib_expr();52	let eval = jrsonnet_evaluator::evaluate(ContextBuilder::dangerous_empty_state().build(), &expr)53		.expect("stdlib.jsonnet should have no errors")54		.as_obj()55		.expect("stdlib.jsonnet should evaluate to object");5657	builder.with_super(eval);5859	for (name, builtin) in [60		// Types61		("type", builtin_type::INST),62		("isString", builtin_is_string::INST),63		("isNumber", builtin_is_number::INST),64		("isBoolean", builtin_is_boolean::INST),65		("isObject", builtin_is_object::INST),66		("isArray", builtin_is_array::INST),67		("isFunction", builtin_is_function::INST),68		// Arrays69		("makeArray", builtin_make_array::INST),70		("repeat", builtin_repeat::INST),71		("slice", builtin_slice::INST),72		("map", builtin_map::INST),73		("flatMap", builtin_flatmap::INST),74		("filter", builtin_filter::INST),75		("foldl", builtin_foldl::INST),76		("foldr", builtin_foldr::INST),77		("range", builtin_range::INST),78		("join", builtin_join::INST),79		("reverse", builtin_reverse::INST),80		("any", builtin_any::INST),81		("all", builtin_all::INST),82		("member", builtin_member::INST),83		("count", builtin_count::INST),84		// Math85		("abs", builtin_abs::INST),86		("sign", builtin_sign::INST),87		("max", builtin_max::INST),88		("min", builtin_min::INST),89		("sum", builtin_sum::INST),90		("modulo", builtin_modulo::INST),91		("floor", builtin_floor::INST),92		("ceil", builtin_ceil::INST),93		("log", builtin_log::INST),94		("pow", builtin_pow::INST),95		("sqrt", builtin_sqrt::INST),96		("sin", builtin_sin::INST),97		("cos", builtin_cos::INST),98		("tan", builtin_tan::INST),99		("asin", builtin_asin::INST),100		("acos", builtin_acos::INST),101		("atan", builtin_atan::INST),102		("exp", builtin_exp::INST),103		("mantissa", builtin_mantissa::INST),104		("exponent", builtin_exponent::INST),105		// Operator106		("mod", builtin_mod::INST),107		("primitiveEquals", builtin_primitive_equals::INST),108		("equals", builtin_equals::INST),109		("xor", builtin_xor::INST),110		("format", builtin_format::INST),111		// Sort112		("sort", builtin_sort::INST),113		("uniq", builtin_uniq::INST),114		("set", builtin_set::INST),115		// Hash116		("md5", builtin_md5::INST),117		("sha256", builtin_sha256::INST),118		("sha512", builtin_sha512::INST),119		// Encoding120		("encodeUTF8", builtin_encode_utf8::INST),121		("decodeUTF8", builtin_decode_utf8::INST),122		("base64", builtin_base64::INST),123		("base64Decode", builtin_base64_decode::INST),124		("base64DecodeBytes", builtin_base64_decode_bytes::INST),125		// Objects126		("objectFieldsEx", builtin_object_fields_ex::INST),127		("objectHasEx", builtin_object_has_ex::INST),128		// Manifest129		("escapeStringJson", builtin_escape_string_json::INST),130		("manifestJsonEx", builtin_manifest_json_ex::INST),131		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),132		("manifestTomlEx", builtin_manifest_toml_ex::INST),133		// Parsing134		("parseJson", builtin_parse_json::INST),135		("parseYaml", builtin_parse_yaml::INST),136		// Strings137		("codepoint", builtin_codepoint::INST),138		("substr", builtin_substr::INST),139		("char", builtin_char::INST),140		("strReplace", builtin_str_replace::INST),141		("splitLimit", builtin_splitlimit::INST),142		("asciiUpper", builtin_ascii_upper::INST),143		("asciiLower", builtin_ascii_lower::INST),144		("findSubstr", builtin_find_substr::INST),145		("parseInt", builtin_parse_int::INST),146		#[cfg(feature = "exp-bigint")]147		("bigint", builtin_bigint::INST),148		("parseOctal", builtin_parse_octal::INST),149		("parseHex", builtin_parse_hex::INST),150		// Misc151		("length", builtin_length::INST),152		("startsWith", builtin_starts_with::INST),153		("endsWith", builtin_ends_with::INST),154		// Sets155		("setMember", builtin_set_member::INST),156		("setInter", builtin_set_inter::INST),157		// Compat158		("__compare", builtin___compare::INST),159	]160	.iter()161	.cloned()162	{163		builder164			.member(name.into())165			.hide()166			.value(Val::Func(FuncVal::StaticBuiltin(builtin)))167			.expect("no conflict");168	}169170	builder171		.member("extVar".into())172		.hide()173		.value(Val::Func(FuncVal::builtin(builtin_ext_var {174			settings: settings.clone(),175		})))176		.expect("no conflict");177	builder178		.member("native".into())179		.hide()180		.value(Val::Func(FuncVal::builtin(builtin_native {181			settings: settings.clone(),182		})))183		.expect("no conflict");184	builder185		.member("trace".into())186		.hide()187		.value(Val::Func(FuncVal::builtin(builtin_trace { settings })))188		.expect("no conflict");189190	builder191		.member("id".into())192		.hide()193		.value(Val::Func(FuncVal::Id))194		.expect("no conflict");195196	builder.build()197}198199pub trait TracePrinter {200	fn print_trace(&self, loc: CallLocation, value: IStr);201}202203pub struct StdTracePrinter {204	resolver: PathResolver,205}206impl StdTracePrinter {207	pub fn new(resolver: PathResolver) -> Self {208		Self { resolver }209	}210}211impl TracePrinter for StdTracePrinter {212	fn print_trace(&self, loc: CallLocation, value: IStr) {213		eprint!("TRACE:");214		if let Some(loc) = loc.0 {215			let locs = loc.0.map_source_locations(&[loc.1]);216			eprint!(217				" {}:{}",218				match loc.0.source_path().path() {219					Some(p) => self.resolver.resolve(p),220					None => loc.0.source_path().to_string(),221				},222				locs[0].line223			);224		}225		eprintln!(" {value}");226	}227}228229pub struct Settings {230	/// Used for `std.extVar`231	pub ext_vars: HashMap<IStr, TlaArg>,232	/// Used for `std.native`233	pub ext_natives: HashMap<IStr, Cc<TraceBox<dyn Builtin>>>,234	/// Helper to add globals without implementing custom ContextInitializer235	pub globals: GcHashMap<IStr, Thunk<Val>>,236	/// Used for `std.trace`237	pub trace_printer: Box<dyn TracePrinter>,238	/// Used for `std.thisFile`239	pub path_resolver: PathResolver,240}241242fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {243	let source_name = format!("<extvar:{name}>");244	Source::new_virtual(source_name.into(), code.into())245}246247#[derive(Trace, Clone)]248pub struct ContextInitializer {249	// When we don't need to support legacy-this-file, we can reuse same context for all files250	#[cfg(not(feature = "legacy-this-file"))]251	context: Context,252	// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it253	#[cfg(feature = "legacy-this-file")]254	stdlib_obj: ObjValue,255	settings: Rc<RefCell<Settings>>,256}257impl ContextInitializer {258	pub fn new(_s: State, resolver: PathResolver) -> Self {259		let settings = Settings {260			ext_vars: Default::default(),261			ext_natives: Default::default(),262			globals: Default::default(),263			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),264			path_resolver: resolver,265		};266		let settings = Rc::new(RefCell::new(settings));267		Self {268			#[cfg(not(feature = "legacy-this-file"))]269			context: {270				let mut context = ContextBuilder::with_capacity(_s, 1);271				context.bind(272					"std".into(),273					Thunk::evaluated(Val::Obj(stdlib_uncached(settings.clone()))),274				);275				context.build()276			},277			#[cfg(feature = "legacy-this-file")]278			stdlib_obj: stdlib_uncached(settings.clone()),279			settings,280		}281	}282	pub fn settings(&self) -> Ref<Settings> {283		self.settings.borrow()284	}285	pub fn settings_mut(&self) -> RefMut<Settings> {286		self.settings.borrow_mut()287	}288	pub fn add_ext_var(&self, name: IStr, value: Val) {289		self.settings_mut()290			.ext_vars291			.insert(name, TlaArg::Val(value));292	}293	pub fn add_ext_str(&self, name: IStr, value: IStr) {294		self.settings_mut()295			.ext_vars296			.insert(name, TlaArg::String(value));297	}298	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {299		let code = code.into();300		let source = extvar_source(name, code.clone());301		let parsed = jrsonnet_parser::parse(302			&code,303			&jrsonnet_parser::ParserSettings {304				source: source.clone(),305			},306		)307		.map_err(|e| ImportSyntaxError {308			path: source,309			error: Box::new(e),310		})?;311		// self.data_mut().volatile_files.insert(source_name, code);312		self.settings_mut()313			.ext_vars314			.insert(name.into(), TlaArg::Code(parsed));315		Ok(())316	}317	pub fn add_native(&self, name: IStr, cb: impl Builtin) {318		self.settings_mut()319			.ext_natives320			.insert(name, Cc::new(tb!(cb)));321	}322}323impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {324	#[cfg(not(feature = "legacy-this-file"))]325	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {326		let out = self.context.clone();327		let globals = &self.settings().globals;328		if globals.is_empty() {329			return out;330		}331332		let mut out = ContextBuilder::extend(out);333		for (k, v) in globals.iter() {334			out.bind(k.clone(), v.clone());335		}336		out.build()337	}338	#[cfg(feature = "legacy-this-file")]339	fn initialize(&self, s: State, source: Source) -> Context {340		use jrsonnet_evaluator::val::StrValue;341342		let mut builder = ObjValueBuilder::new();343		builder.with_super(self.stdlib_obj.clone());344		builder345			.member("thisFile".into())346			.hide()347			.value(Val::Str(StrValue::Flat(348				match source.source_path().path() {349					Some(p) => self.settings().path_resolver.resolve(p).into(),350					None => source.source_path().to_string().into(),351				},352			)))353			.expect("this object builder is empty");354		let stdlib_with_this_file = builder.build();355356		let mut context = ContextBuilder::with_capacity(s, 1);357		context.bind(358			"std".into(),359			Thunk::evaluated(Val::Obj(stdlib_with_this_file)),360		);361		for (k, v) in self.settings().globals.iter() {362			context.bind(k.clone(), v.clone());363		}364		context.build()365	}366	fn as_any(&self) -> &dyn std::any::Any {367		self368	}369}370371pub trait StateExt {372	/// This method was previously implemented in jrsonnet-evaluator itself373	fn with_stdlib(&self);374	fn add_global(&self, name: IStr, value: Thunk<Val>);375}376377impl StateExt for State {378	fn with_stdlib(&self) {379		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());380		self.settings_mut().context_initializer = tb!(initializer)381	}382	fn add_global(&self, name: IStr, value: Thunk<Val>) {383		self.settings()384			.context_initializer385			.as_any()386			.downcast_ref::<ContextInitializer>()387			.expect("not standard context initializer")388			.settings_mut()389			.globals390			.insert(name, value);391	}392}
modifiedflake.lockdiffbeforeafterboth
--- a/flake.lock
+++ b/flake.lock
@@ -5,11 +5,11 @@
         "systems": "systems"
       },
       "locked": {
-        "lastModified": 1681202837,
-        "narHash": "sha256-H+Rh19JDwRtpVPAWp64F+rlEtxUWBAQW28eAi3SRSzg=",
+        "lastModified": 1689068808,
+        "narHash": "sha256-6ixXo3wt24N/melDWjq70UuHQLxGV8jZvooRanIHXw0=",
         "owner": "numtide",
         "repo": "flake-utils",
-        "rev": "cfacdce06f30d2b68473a46042957675eebb3401",
+        "rev": "919d646de7be200f3bf08cb76ae1f09402b6f9b4",
         "type": "github"
       },
       "original": {
@@ -20,11 +20,11 @@
     },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1683574088,
-        "narHash": "sha256-RjE7UXfyYBV3vkpjL5irZOF+4ZgTQlvEWYJsFL2Hig0=",
+        "lastModified": 1689162265,
+        "narHash": "sha256-kdW79sfwX2TTX8yFBNUsEYOG+gQuAOHU+WcUtxMUnlc=",
         "owner": "nixos",
         "repo": "nixpkgs",
-        "rev": "05b1a97381588ba98d98f8725b2137fce0ab45cb",
+        "rev": "1941c7d8f1219c615a1d6dae826e0d6fab89acca",
         "type": "github"
       },
       "original": {
@@ -50,11 +50,11 @@
         ]
       },
       "locked": {
-        "lastModified": 1683512408,
-        "narHash": "sha256-QMJGp/37En+d5YocJuSU89GL14bBYkIJQ6mqhRfqkkc=",
+        "lastModified": 1689129196,
+        "narHash": "sha256-/z/Al4sFcIh5oPQWA9MclQmJR9g3RO8UDiHGaj/T9R8=",
         "owner": "oxalica",
         "repo": "rust-overlay",
-        "rev": "75b07756c3feb22cf230e75fb064c1b4c725b9bc",
+        "rev": "db8d909c9526d4406579ee7343bf2d7de3d15eac",
         "type": "github"
       },
       "original": {
modifiedflake.nixdiffbeforeafterboth
--- a/flake.nix
+++ b/flake.nix
@@ -16,7 +16,7 @@
           inherit system;
           overlays = [ rust-overlay.overlays.default ];
         };
-        rust = ((pkgs.rustChannelOf { date = "2023-05-07"; channel = "nightly"; }).default.override {
+        rust = ((pkgs.rustChannelOf { date = "2023-06-26"; channel = "nightly"; }).default.override {
           extensions = [ "rust-src" "miri" "rust-analyzer" ];
         });
       in
modifiedtests/tests/common.rsdiffbeforeafterboth
--- a/tests/tests/common.rs
+++ b/tests/tests/common.rs
@@ -5,7 +5,6 @@
 	function::{builtin, FuncVal},
 	throw, ObjValueBuilder, State, Thunk, Val,
 };
-use jrsonnet_stdlib::StateExt;
 
 #[macro_export]
 macro_rules! ensure_eq {