difftreelog
feat experimental object field order preservation
in: master
15 files changed
Cargo.lockdiffbeforeafterboth--- a/Cargo.lock
+++ b/Cargo.lock
@@ -492,6 +492,7 @@
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d0ffa0837f2dfa6fb90868c2b5468cad482e175f7dad97e7421951e663f2b527"
dependencies = [
+ "indexmap",
"itoa",
"ryu",
"serde",
bindings/jsonnet/Cargo.tomldiffbeforeafterboth--- a/bindings/jsonnet/Cargo.toml
+++ b/bindings/jsonnet/Cargo.toml
@@ -17,3 +17,4 @@
[features]
interop = []
+exp-preserve-order = ["jrsonnet-evaluator/exp-preserve-order"]
bindings/jsonnet/src/lib.rsdiffbeforeafterboth--- a/bindings/jsonnet/src/lib.rs
+++ b/bindings/jsonnet/src/lib.rs
@@ -58,7 +58,11 @@
pub extern "C" fn jsonnet_string_output(vm: &EvaluationState, v: c_int) {
match v {
1 => vm.set_manifest_format(ManifestFormat::String),
- 0 => vm.set_manifest_format(ManifestFormat::Json(4)),
+ 0 => vm.set_manifest_format(ManifestFormat::Json {
+ padding: 4,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order: false,
+ }),
_ => panic!("incorrect output format"),
}
}
bindings/jsonnet/src/val_modify.rsdiffbeforeafterboth--- a/bindings/jsonnet/src/val_modify.rs
+++ b/bindings/jsonnet/src/val_modify.rs
@@ -5,8 +5,7 @@
use std::{ffi::CStr, os::raw::c_char};
use gcmodule::Cc;
-use jrsonnet_evaluator::{val::ArrValue, EvaluationState, LazyBinding, LazyVal, ObjMember, Val};
-use jrsonnet_parser::Visibility;
+use jrsonnet_evaluator::{val::ArrValue, EvaluationState, LazyVal, Val};
/// # Safety
///
@@ -41,19 +40,9 @@
val: &Val,
) {
match obj {
- Val::Obj(old) => {
- let new_obj = old.clone().extend_with_field(
- CStr::from_ptr(name).to_str().unwrap().into(),
- ObjMember {
- add: false,
- visibility: Visibility::Normal,
- invoke: LazyBinding::Bound(LazyVal::new_resolved(val.clone())),
- location: None,
- },
- );
-
- *obj = Val::Obj(new_obj);
- }
+ Val::Obj(old) => old
+ .extend_field(CStr::from_ptr(name).to_str().unwrap().into())
+ .value(val.clone()),
_ => panic!("should receive object"),
}
}
cmds/jrsonnet/Cargo.tomldiffbeforeafterboth--- a/cmds/jrsonnet/Cargo.toml
+++ b/cmds/jrsonnet/Cargo.toml
@@ -9,6 +9,12 @@
[features]
# Use mimalloc as allocator
mimalloc = ["mimallocator"]
+# Experimental feature, which allows to preserve order of object fields
+exp-preserve-order = [
+ "jrsonnet-evaluator/exp-preserve-order",
+ "jrsonnet-evaluator/exp-serde-preserve-order",
+ "jrsonnet-cli/exp-preserve-order",
+]
[dependencies]
jrsonnet-evaluator = { path = "../../crates/jrsonnet-evaluator", version = "0.4.2" }
crates/jrsonnet-cli/Cargo.tomldiffbeforeafterboth--- a/crates/jrsonnet-cli/Cargo.toml
+++ b/crates/jrsonnet-cli/Cargo.toml
@@ -6,6 +6,9 @@
license = "MIT"
edition = "2021"
+[features]
+exp-preserve-order = ["jrsonnet-evaluator/exp-preserve-order"]
+
[dependencies]
jrsonnet-evaluator = { path = "../../crates/jrsonnet-evaluator", version = "0.4.2", features = [
"explaining-traces",
crates/jrsonnet-cli/src/manifest.rsdiffbeforeafterboth--- a/crates/jrsonnet-cli/src/manifest.rs
+++ b/crates/jrsonnet-cli/src/manifest.rs
@@ -43,20 +43,30 @@
/// `0` for hard tabs, `-1` for single line output [default: 3 for json, 2 for yaml]
#[clap(long)]
line_padding: Option<usize>,
+ /// Preserve order in object manifestification
+ #[cfg(feature = "exp-preserve-order")]
+ #[clap(long)]
+ exp_preserve_order: bool,
}
impl ConfigureState for ManifestOpts {
fn configure(&self, state: &EvaluationState) -> Result<()> {
if self.string {
state.set_manifest_format(ManifestFormat::String);
} else {
+ #[cfg(feature = "exp-preserve-order")]
+ let preserve_order = self.exp_preserve_order;
match self.format {
ManifestFormatName::String => state.set_manifest_format(ManifestFormat::String),
- ManifestFormatName::Json => {
- state.set_manifest_format(ManifestFormat::Json(self.line_padding.unwrap_or(3)))
- }
- ManifestFormatName::Yaml => {
- state.set_manifest_format(ManifestFormat::Yaml(self.line_padding.unwrap_or(2)))
- }
+ ManifestFormatName::Json => state.set_manifest_format(ManifestFormat::Json {
+ padding: self.line_padding.unwrap_or(3),
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
+ }),
+ ManifestFormatName::Yaml => state.set_manifest_format(ManifestFormat::Yaml {
+ padding: self.line_padding.unwrap_or(2),
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
+ }),
}
}
if self.yaml_stream {
crates/jrsonnet-evaluator/Cargo.tomldiffbeforeafterboth--- a/crates/jrsonnet-evaluator/Cargo.toml
+++ b/crates/jrsonnet-evaluator/Cargo.toml
@@ -15,6 +15,10 @@
# Allows library authors to throw custom errors
anyhow-error = ["anyhow"]
+# Allows to preserve field order in objects
+exp-preserve-order = []
+exp-serde-preserve-order = ["serde_json/preserve_order"]
+
[dependencies]
jrsonnet-interner = { path = "../jrsonnet-interner", version = "0.4.2" }
jrsonnet-parser = { path = "../jrsonnet-parser", version = "0.4.2" }
crates/jrsonnet-evaluator/src/builtin/manifest.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/builtin/manifest.rs
+++ b/crates/jrsonnet-evaluator/src/builtin/manifest.rs
@@ -21,6 +21,8 @@
pub mtype: ManifestType,
pub newline: &'s str,
pub key_val_sep: &'s str,
+ #[cfg(feature = "exp-preserve-order")]
+ pub preserve_order: bool,
}
pub fn manifest_json_ex(val: &Val, options: &ManifestJsonOptions<'_>) -> Result<String> {
@@ -85,7 +87,10 @@
Val::Obj(obj) => {
obj.run_assertions()?;
buf.push('{');
- let fields = obj.fields();
+ let fields = obj.fields(
+ #[cfg(feature = "exp-preserve-order")]
+ options.preserve_order,
+ );
if !fields.is_empty() {
if mtype != ManifestType::ToString && mtype != ManifestType::Minify {
buf.push_str(options.newline);
@@ -182,6 +187,10 @@
/// safe_key: 1
/// ```
pub quote_keys: bool,
+ /// If true - then order of fields is preserved as written,
+ /// instead of sorting alphabetically
+ #[cfg(feature = "exp-preserve-order")]
+ pub preserve_order: bool,
}
/// From https://github.com/chyh1990/yaml-rust/blob/da52a68615f2ecdd6b7e4567019f280c433c1521/src/emitter.rs#L289
@@ -287,7 +296,14 @@
if o.is_empty() {
buf.push_str("{}");
} else {
- for (i, key) in o.fields().iter().enumerate() {
+ for (i, key) in o
+ .fields(
+ #[cfg(feature = "exp-preserve-order")]
+ options.preserve_order,
+ )
+ .iter()
+ .enumerate()
+ {
if i != 0 {
buf.push('\n');
buf.push_str(cur_padding);
crates/jrsonnet-evaluator/src/builtin/mod.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/builtin/mod.rs
+++ b/crates/jrsonnet-evaluator/src/builtin/mod.rs
@@ -162,11 +162,7 @@
Ok(match x {
A(x) => x.chars().count(),
B(x) => x.len(),
- C(x) => x
- .fields_visibility()
- .into_iter()
- .filter(|(_k, v)| *v)
- .count(),
+ C(x) => x.len(),
D(f) => f.args_len(),
})
}
@@ -191,8 +187,20 @@
}
#[jrsonnet_macros::builtin]
-fn builtin_object_fields_ex(obj: ObjValue, inc_hidden: bool) -> Result<VecVal> {
- let out = obj.fields_ex(inc_hidden);
+fn builtin_object_fields_ex(
+ obj: ObjValue,
+ inc_hidden: bool,
+ #[cfg(feature = "exp-preserve-order")] preserve_order: Option<bool>,
+) -> Result<VecVal> {
+ #[cfg(not(feature = "exp-preserve-order"))]
+ let preserve_order = false;
+ #[cfg(feature = "exp-preserve-order")]
+ let preserve_order = preserve_order.unwrap_or(false);
+ let out = obj.fields_ex(
+ inc_hidden,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
+ );
Ok(VecVal(Cc::new(
out.into_iter().map(Val::Str).collect::<Vec<_>>(),
)))
@@ -586,6 +594,7 @@
indent: IStr,
newline: Option<IStr>,
key_val_sep: Option<IStr>,
+ #[cfg(feature = "exp-preserve-order")] preserve_order: Option<bool>,
) -> Result<String> {
let newline = newline.as_deref().unwrap_or("\n");
let key_val_sep = key_val_sep.as_deref().unwrap_or(": ");
@@ -596,6 +605,8 @@
mtype: ManifestType::Std,
newline,
key_val_sep,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order: preserve_order.unwrap_or(false),
},
)
}
@@ -605,6 +616,7 @@
value: Any,
indent_array_in_object: Option<bool>,
quote_keys: Option<bool>,
+ #[cfg(feature = "exp-preserve-order")] preserve_order: Option<bool>,
) -> Result<String> {
manifest_yaml_ex(
&value.0,
@@ -616,6 +628,8 @@
""
},
quote_keys: quote_keys.unwrap_or(true),
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order: preserve_order.unwrap_or(false),
},
)
}
crates/jrsonnet-evaluator/src/integrations/serde.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/integrations/serde.rs
+++ b/crates/jrsonnet-evaluator/src/integrations/serde.rs
@@ -28,7 +28,10 @@
}
Val::Obj(o) => {
let mut out = Map::new();
- for key in o.fields() {
+ for key in o.fields(
+ #[cfg(feature = "exp-preserve-order")]
+ cfg!(feature = "exp-serde-preserve-order"),
+ ) {
out.insert(
(&key as &str).into(),
o.get(key)?
crates/jrsonnet-evaluator/src/lib.rsdiffbeforeafterboth1#![warn(clippy::all, clippy::nursery)]2#![allow(3 macro_expanded_macro_exports_accessed_by_absolute_paths,4 clippy::ptr_arg5)]67// For jrsonnet-macros8extern crate self as jrsonnet_evaluator;910mod builtin;11mod ctx;12mod dynamic;13pub mod error;14mod evaluate;15pub mod function;16pub mod gc;17mod import;18mod integrations;19mod map;20pub mod native;21mod obj;22pub mod trace;23pub mod typed;24pub mod val;2526use std::{27 cell::{Ref, RefCell, RefMut},28 collections::HashMap,29 fmt::Debug,30 path::{Path, PathBuf},31 rc::Rc,32};3334pub use ctx::*;35pub use dynamic::*;36use error::{Error::*, LocError, Result, StackTraceElement};37pub use evaluate::*;38use function::{Builtin, CallLocation, TlaArg};39use gc::{GcHashMap, TraceBox};40use gcmodule::{Cc, Trace, Weak};41pub use import::*;42pub use jrsonnet_interner::IStr;43pub use jrsonnet_parser as parser;44use jrsonnet_parser::*;45pub use obj::*;46use trace::{location_to_offset, offset_to_location, CodeLocation, CompactFormat, TraceFormat};47pub use val::{LazyVal, ManifestFormat, Val};4849pub trait Bindable: Trace + 'static {50 fn bind(&self, this: Option<ObjValue>, super_obj: Option<ObjValue>) -> Result<LazyVal>;51}5253#[derive(Clone, Trace)]54pub enum LazyBinding {55 Bindable(Cc<TraceBox<dyn Bindable>>),56 Bound(LazyVal),57}5859impl Debug for LazyBinding {60 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {61 write!(f, "LazyBinding")62 }63}64impl LazyBinding {65 pub fn evaluate(&self, this: Option<ObjValue>, super_obj: Option<ObjValue>) -> Result<LazyVal> {66 match self {67 Self::Bindable(v) => v.bind(this, super_obj),68 Self::Bound(v) => Ok(v.clone()),69 }70 }71}7273pub struct EvaluationSettings {74 /// Limits recursion by limiting the number of stack frames75 pub max_stack: usize,76 /// Limits amount of stack trace items preserved77 pub max_trace: usize,78 /// Used for s`td.extVar`79 pub ext_vars: HashMap<IStr, Val>,80 /// Used for ext.native81 pub ext_natives: HashMap<IStr, Cc<TraceBox<dyn Builtin>>>,82 /// TLA vars83 pub tla_vars: HashMap<IStr, TlaArg>,84 /// Global variables are inserted in default context85 pub globals: HashMap<IStr, Val>,86 /// Used to resolve file locations/contents87 pub import_resolver: Box<dyn ImportResolver>,88 /// Used in manifestification functions89 pub manifest_format: ManifestFormat,90 /// Used for bindings91 pub trace_format: Box<dyn TraceFormat>,92}93impl Default for EvaluationSettings {94 fn default() -> Self {95 Self {96 max_stack: 200,97 max_trace: 20,98 globals: Default::default(),99 ext_vars: Default::default(),100 ext_natives: Default::default(),101 tla_vars: Default::default(),102 import_resolver: Box::new(DummyImportResolver),103 manifest_format: ManifestFormat::Json(4),104 trace_format: Box::new(CompactFormat {105 padding: 4,106 resolver: trace::PathResolver::Absolute,107 }),108 }109 }110}111112#[derive(Default)]113struct EvaluationData {114 /// Used for stack overflow detection, stacktrace is populated on unwind115 stack_depth: usize,116 /// Updated every time stack entry is popt117 stack_generation: usize,118119 breakpoints: Breakpoints,120 /// Contains file source codes and evaluation results for imports and pretty-printed stacktraces121 files: GcHashMap<Rc<Path>, FileData>,122 str_files: GcHashMap<Rc<Path>, IStr>,123 bin_files: GcHashMap<Rc<Path>, Rc<[u8]>>,124}125126pub struct FileData {127 source_code: IStr,128 parsed: LocExpr,129 evaluated: Option<Val>,130}131132#[allow(clippy::type_complexity)]133pub struct Breakpoint {134 loc: ExprLocation,135 collected: RefCell<HashMap<usize, (usize, Vec<Result<Val>>)>>,136}137#[derive(Default)]138struct Breakpoints(Vec<Rc<Breakpoint>>);139impl Breakpoints {140 fn insert(141 &self,142 stack_depth: usize,143 stack_generation: usize,144 loc: &ExprLocation,145 result: Result<Val>,146 ) -> Result<Val> {147 if self.0.is_empty() {148 return result;149 }150 for item in self.0.iter() {151 if item.loc.belongs_to(loc) {152 let mut collected = item.collected.borrow_mut();153 let (depth, vals) = collected.entry(stack_generation).or_default();154 if stack_depth > *depth {155 vals.clear();156 }157 vals.push(result.clone());158 }159 }160 result161 }162}163164#[derive(Default)]165pub struct EvaluationStateInternals {166 /// Internal state167 data: RefCell<EvaluationData>,168 /// Settings, safe to change at runtime169 settings: RefCell<EvaluationSettings>,170}171172thread_local! {173 /// Contains the state for a currently executed file.174 /// Global state is fine here.175 pub(crate) static EVAL_STATE: RefCell<Option<EvaluationState>> = RefCell::new(None)176}177178pub(crate) fn with_state<T>(f: impl FnOnce(&EvaluationState) -> T) -> T {179 EVAL_STATE.with(|s| {180 f(s.borrow().as_ref().expect(181 "missing evaluation state, some functions should be called inside of run_in_state call",182 ))183 })184}185pub fn push_frame<T>(186 e: CallLocation,187 frame_desc: impl FnOnce() -> String,188 f: impl FnOnce() -> Result<T>,189) -> Result<T> {190 with_state(|s| s.push(e, frame_desc, f))191}192193#[allow(dead_code)]194pub fn push_val_frame(195 e: &ExprLocation,196 frame_desc: impl FnOnce() -> String,197 f: impl FnOnce() -> Result<Val>,198) -> Result<Val> {199 with_state(|s| s.push_val(e, frame_desc, f))200}201#[allow(dead_code)]202pub fn push_description_frame<T>(203 frame_desc: impl FnOnce() -> String,204 f: impl FnOnce() -> Result<T>,205) -> Result<T> {206 with_state(|s| s.push_description(frame_desc, f))207}208209/// Maintains stack trace and import resolution210#[derive(Default, Clone)]211pub struct EvaluationState(Rc<EvaluationStateInternals>);212213impl EvaluationState {214 /// Parses and adds file as loaded215 pub fn add_file(&self, path: Rc<Path>, source_code: IStr) -> Result<LocExpr> {216 let parsed = parse(217 &source_code,218 &ParserSettings {219 file_name: path.clone(),220 },221 )222 .map_err(|error| ImportSyntaxError {223 error: Box::new(error),224 path: path.to_owned(),225 source_code: source_code.clone(),226 })?;227 self.add_parsed_file(path, source_code, parsed.clone())?;228229 Ok(parsed)230 }231232 pub fn reset_evaluation_state(&self, name: &Path) {233 self.data_mut()234 .files235 .get_mut(name)236 .unwrap()237 .evaluated238 .take();239 }240241 /// Adds file by source code and parsed expr242 pub fn add_parsed_file(243 &self,244 name: Rc<Path>,245 source_code: IStr,246 parsed: LocExpr,247 ) -> Result<()> {248 self.data_mut().files.insert(249 name,250 FileData {251 source_code,252 parsed,253 evaluated: None,254 },255 );256257 Ok(())258 }259 pub fn get_source(&self, name: &Path) -> Option<IStr> {260 let ro_map = &self.data().files;261 ro_map.get(name).map(|value| value.source_code.clone())262 }263 pub fn map_source_locations(&self, file: &Path, locs: &[usize]) -> Vec<CodeLocation> {264 offset_to_location(&self.get_source(file).unwrap_or_else(|| "".into()), locs)265 }266 pub fn map_from_source_location(267 &self,268 file: &Path,269 line: usize,270 column: usize,271 ) -> Option<usize> {272 location_to_offset(&self.get_source(file).unwrap(), line, column)273 }274 pub fn import_file(&self, from: &Path, path: &Path) -> Result<Val> {275 let file_path = self.resolve_file(from, path)?;276 {277 let data = self.data();278 let files = &data.files;279 if files.contains_key(&file_path as &Path) {280 drop(data);281 return self.evaluate_loaded_file_raw(&file_path);282 }283 }284 let contents = self.load_file_str(&file_path)?;285 self.add_file(file_path.clone(), contents)?;286 self.evaluate_loaded_file_raw(&file_path)287 }288 pub(crate) fn import_file_str(&self, from: &Path, path: &Path) -> Result<IStr> {289 let path = self.resolve_file(from, path)?;290 if !self.data().str_files.contains_key(&path) {291 let file_str = self.load_file_str(&path)?;292 self.data_mut().str_files.insert(path.clone(), file_str);293 }294 Ok(self.data().str_files.get(&path).cloned().unwrap())295 }296 pub(crate) fn import_file_bin(&self, from: &Path, path: &Path) -> Result<Rc<[u8]>> {297 let path = self.resolve_file(from, path)?;298 if !self.data().bin_files.contains_key(&path) {299 let file_bin = self.load_file_bin(&path)?;300 self.data_mut().bin_files.insert(path.clone(), file_bin);301 }302 Ok(self.data().bin_files.get(&path).cloned().unwrap())303 }304305 fn evaluate_loaded_file_raw(&self, name: &Path) -> Result<Val> {306 let expr: LocExpr = {307 let ro_map = &self.data().files;308 let value = ro_map309 .get(name)310 .unwrap_or_else(|| panic!("file not added: {:?}", name));311 if let Some(ref evaluated) = value.evaluated {312 return Ok(evaluated.clone());313 }314 value.parsed.clone()315 };316 let value = evaluate(self.create_default_context(), &expr)?;317 {318 self.data_mut()319 .files320 .get_mut(name)321 .unwrap()322 .evaluated323 .replace(value.clone());324 }325 Ok(value)326 }327328 /// Adds standard library global variable (std) to this evaluator329 pub fn with_stdlib(&self) -> &Self {330 use jrsonnet_stdlib::STDLIB_STR;331 let std_path: Rc<Path> = PathBuf::from("std.jsonnet").into();332 self.run_in_state(|| {333 self.add_parsed_file(334 std_path.clone(),335 STDLIB_STR.to_owned().into(),336 builtin::get_parsed_stdlib(),337 )338 .unwrap();339 let val = self.evaluate_loaded_file_raw(&std_path).unwrap();340 self.settings_mut().globals.insert("std".into(), val);341 });342 self343 }344345 /// Creates context with all passed global variables346 pub fn create_default_context(&self) -> Context {347 let globals = &self.settings().globals;348 let mut new_bindings = GcHashMap::with_capacity(globals.len());349 for (name, value) in globals.iter() {350 new_bindings.insert(name.clone(), LazyVal::new_resolved(value.clone()));351 }352 Context::new().extend_bound(new_bindings)353 }354355 /// Executes code creating a new stack frame356 pub fn push<T>(357 &self,358 e: CallLocation,359 frame_desc: impl FnOnce() -> String,360 f: impl FnOnce() -> Result<T>,361 ) -> Result<T> {362 {363 let mut data = self.data_mut();364 let stack_depth = &mut data.stack_depth;365 if *stack_depth > self.max_stack() {366 // Error creation uses data, so i drop guard here367 drop(data);368 throw!(StackOverflow);369 } else {370 *stack_depth += 1;371 }372 }373 let result = f();374 {375 let mut data = self.data_mut();376 data.stack_depth -= 1;377 data.stack_generation += 1;378 }379 if let Err(mut err) = result {380 err.trace_mut().0.push(StackTraceElement {381 location: e.0.cloned(),382 desc: frame_desc(),383 });384 return Err(err);385 }386 result387 }388389 /// Executes code creating a new stack frame390 pub fn push_val(391 &self,392 e: &ExprLocation,393 frame_desc: impl FnOnce() -> String,394 f: impl FnOnce() -> Result<Val>,395 ) -> Result<Val> {396 {397 let mut data = self.data_mut();398 let stack_depth = &mut data.stack_depth;399 if *stack_depth > self.max_stack() {400 // Error creation uses data, so i drop guard here401 drop(data);402 throw!(StackOverflow);403 } else {404 *stack_depth += 1;405 }406 }407 let mut result = f();408 {409 let mut data = self.data_mut();410 data.stack_depth -= 1;411 data.stack_generation += 1;412 result = data413 .breakpoints414 .insert(data.stack_depth, data.stack_generation, e, result);415 }416 if let Err(mut err) = result {417 err.trace_mut().0.push(StackTraceElement {418 location: Some(e.clone()),419 desc: frame_desc(),420 });421 return Err(err);422 }423 result424 }425 /// Executes code creating a new stack frame426 pub fn push_description<T>(427 &self,428 frame_desc: impl FnOnce() -> String,429 f: impl FnOnce() -> Result<T>,430 ) -> Result<T> {431 {432 let mut data = self.data_mut();433 let stack_depth = &mut data.stack_depth;434 if *stack_depth > self.max_stack() {435 // Error creation uses data, so i drop guard here436 drop(data);437 throw!(StackOverflow);438 } else {439 *stack_depth += 1;440 }441 }442 let result = f();443 {444 let mut data = self.data_mut();445 data.stack_depth -= 1;446 data.stack_generation += 1;447 }448 if let Err(mut err) = result {449 err.trace_mut().0.push(StackTraceElement {450 location: None,451 desc: frame_desc(),452 });453 return Err(err);454 }455 result456 }457458 /// Runs passed function in state (required if function needs to modify stack trace)459 pub fn run_in_state<T>(&self, f: impl FnOnce() -> T) -> T {460 EVAL_STATE.with(|v| {461 let has_state = v.borrow().is_some();462 if !has_state {463 v.borrow_mut().replace(self.clone());464 }465 let result = f();466 if !has_state {467 v.borrow_mut().take();468 }469 result470 })471 }472 pub fn run_in_state_with_breakpoint(473 &self,474 bp: Rc<Breakpoint>,475 f: impl FnOnce() -> Result<()>,476 ) -> Result<()> {477 {478 let mut data = self.data_mut();479 data.breakpoints.0.push(bp);480 }481482 let result = self.run_in_state(f);483484 {485 let mut data = self.data_mut();486 data.breakpoints.0.pop();487 }488489 result490 }491492 pub fn stringify_err(&self, e: &LocError) -> String {493 let mut out = String::new();494 self.settings()495 .trace_format496 .write_trace(&mut out, self, e)497 .unwrap();498 out499 }500501 pub fn manifest(&self, val: Val) -> Result<IStr> {502 self.run_in_state(|| {503 push_description_frame(504 || "manifestification".to_string(),505 || val.manifest(&self.manifest_format()),506 )507 })508 }509 pub fn manifest_multi(&self, val: Val) -> Result<Vec<(IStr, IStr)>> {510 self.run_in_state(|| val.manifest_multi(&self.manifest_format()))511 }512 pub fn manifest_stream(&self, val: Val) -> Result<Vec<IStr>> {513 self.run_in_state(|| val.manifest_stream(&self.manifest_format()))514 }515516 /// If passed value is function then call with set TLA517 pub fn with_tla(&self, val: Val) -> Result<Val> {518 self.run_in_state(|| {519 Ok(match val {520 Val::Func(func) => push_description_frame(521 || "during TLA call".to_owned(),522 || {523 func.evaluate(524 self.create_default_context(),525 CallLocation::native(),526 &self.settings().tla_vars,527 true,528 )529 },530 )?,531 v => v,532 })533 })534 }535}536537/// Internals538impl EvaluationState {539 fn data(&self) -> Ref<EvaluationData> {540 self.0.data.borrow()541 }542 fn data_mut(&self) -> RefMut<EvaluationData> {543 self.0.data.borrow_mut()544 }545 pub fn settings(&self) -> Ref<EvaluationSettings> {546 self.0.settings.borrow()547 }548 pub fn settings_mut(&self) -> RefMut<EvaluationSettings> {549 self.0.settings.borrow_mut()550 }551}552553/// Raw methods evaluate passed values but don't perform TLA execution554impl EvaluationState {555 pub fn evaluate_file_raw(&self, name: &Path) -> Result<Val> {556 self.run_in_state(|| self.import_file(&std::env::current_dir().expect("cwd"), name))557 }558 pub fn evaluate_file_raw_nocwd(&self, name: &Path) -> Result<Val> {559 self.run_in_state(|| self.import_file(&PathBuf::from("."), name))560 }561 /// Parses and evaluates the given snippet562 pub fn evaluate_snippet_raw(&self, source: Rc<Path>, code: IStr) -> Result<Val> {563 let parsed = parse(564 &code,565 &ParserSettings {566 file_name: source.clone(),567 },568 )569 .map_err(|e| ImportSyntaxError {570 path: source.clone(),571 source_code: code.clone(),572 error: Box::new(e),573 })?;574 self.add_parsed_file(source, code, parsed.clone())?;575 self.evaluate_expr_raw(parsed)576 }577 /// Evaluates the parsed expression578 pub fn evaluate_expr_raw(&self, code: LocExpr) -> Result<Val> {579 self.run_in_state(|| evaluate(self.create_default_context(), &code))580 }581}582583/// Settings utilities584impl EvaluationState {585 pub fn add_ext_var(&self, name: IStr, value: Val) {586 self.settings_mut().ext_vars.insert(name, value);587 }588 pub fn add_ext_str(&self, name: IStr, value: IStr) {589 self.add_ext_var(name, Val::Str(value));590 }591 pub fn add_ext_code(&self, name: IStr, code: IStr) -> Result<()> {592 let value =593 self.evaluate_snippet_raw(PathBuf::from(format!("ext_code {}", name)).into(), code)?;594 self.add_ext_var(name, value);595 Ok(())596 }597598 pub fn add_tla(&self, name: IStr, value: Val) {599 self.settings_mut()600 .tla_vars601 .insert(name, TlaArg::Val(value));602 }603 pub fn add_tla_str(&self, name: IStr, value: IStr) {604 self.settings_mut()605 .tla_vars606 .insert(name, TlaArg::String(value));607 }608 pub fn add_tla_code(&self, name: IStr, code: IStr) -> Result<()> {609 let parsed = self.add_file(PathBuf::from(format!("tla_code {}", name)).into(), code)?;610 self.settings_mut()611 .tla_vars612 .insert(name, TlaArg::Code(parsed));613 Ok(())614 }615616 pub fn resolve_file(&self, from: &Path, path: &Path) -> Result<Rc<Path>> {617 self.settings().import_resolver.resolve_file(from, path)618 }619 pub fn load_file_str(&self, path: &Path) -> Result<IStr> {620 self.settings().import_resolver.load_file_str(path)621 }622 pub fn load_file_bin(&self, path: &Path) -> Result<Rc<[u8]>> {623 self.settings().import_resolver.load_file_bin(path)624 }625626 pub fn import_resolver(&self) -> Ref<dyn ImportResolver> {627 Ref::map(self.settings(), |s| &*s.import_resolver)628 }629 pub fn set_import_resolver(&self, resolver: Box<dyn ImportResolver>) {630 self.settings_mut().import_resolver = resolver;631 }632633 pub fn add_native(&self, name: IStr, cb: Cc<TraceBox<dyn Builtin>>) {634 self.settings_mut().ext_natives.insert(name, cb);635 }636637 pub fn manifest_format(&self) -> ManifestFormat {638 self.settings().manifest_format.clone()639 }640 pub fn set_manifest_format(&self, format: ManifestFormat) {641 self.settings_mut().manifest_format = format;642 }643644 pub fn trace_format(&self) -> Ref<dyn TraceFormat> {645 Ref::map(self.settings(), |s| &*s.trace_format)646 }647 pub fn set_trace_format(&self, format: Box<dyn TraceFormat>) {648 self.settings_mut().trace_format = format;649 }650651 pub fn max_trace(&self) -> usize {652 self.settings().max_trace653 }654 pub fn set_max_trace(&self, trace: usize) {655 self.settings_mut().max_trace = trace;656 }657658 pub fn max_stack(&self) -> usize {659 self.settings().max_stack660 }661 pub fn set_max_stack(&self, trace: usize) {662 self.settings_mut().max_stack = trace;663 }664}665666pub fn cc_ptr_eq<T>(a: &Cc<T>, b: &Cc<T>) -> bool {667 let a = a as &T;668 let b = b as &T;669 std::ptr::eq(a, b)670}671672fn weak_raw<T>(a: Weak<T>) -> *const () {673 unsafe { std::mem::transmute(a) }674}675fn weak_ptr_eq<T>(a: Weak<T>, b: Weak<T>) -> bool {676 std::ptr::eq(weak_raw(a), weak_raw(b))677}678679#[test]680fn weak_unsafe() {681 let a = Cc::new(1);682 let b = Cc::new(2);683684 let aw1 = a.clone().downgrade();685 let aw2 = a.clone().downgrade();686 let aw3 = a.clone().downgrade();687688 let bw = b.clone().downgrade();689690 assert!(weak_ptr_eq(aw1, aw2));691 assert!(!weak_ptr_eq(aw3, bw));692}693694#[cfg(test)]695pub mod tests {696 use std::{697 path::{Path, PathBuf},698 rc::Rc,699 };700701 use gcmodule::{Cc, Trace};702 use jrsonnet_parser::*;703704 use super::Val;705 use crate::{706 error::Error::*,707 function::{BuiltinParam, CallLocation},708 gc::TraceBox,709 native::NativeCallbackHandler,710 val::primitive_equals,711 EvaluationState,712 };713714 #[test]715 #[should_panic]716 fn eval_state_stacktrace() {717 let state = EvaluationState::default();718 state.run_in_state(|| {719 state720 .push(721 CallLocation::new(&ExprLocation(PathBuf::from("test1.jsonnet").into(), 10, 20)),722 || "outer".to_owned(),723 || {724 state.push(725 CallLocation::new(&ExprLocation(726 PathBuf::from("test2.jsonnet").into(),727 30,728 40,729 )),730 || "inner".to_owned(),731 || Err(RuntimeError("".into()).into()),732 )?;733 Ok(Val::Null)734 },735 )736 .unwrap();737 });738 }739740 #[test]741 fn eval_state_standard() {742 let state = EvaluationState::default();743 state.with_stdlib();744 assert!(primitive_equals(745 &state746 .evaluate_snippet_raw(747 PathBuf::from("raw.jsonnet").into(),748 r#"std.assertEqual(std.base64("test"), "dGVzdA==")"#.into()749 )750 .unwrap(),751 &Val::Bool(true),752 )753 .unwrap());754 }755756 macro_rules! eval {757 ($str: expr) => {{758 let evaluator = EvaluationState::default();759 evaluator.with_stdlib();760 evaluator.run_in_state(|| {761 evaluator762 .evaluate_snippet_raw(PathBuf::from("raw.jsonnet").into(), $str.into())763 .unwrap()764 })765 }};766 }767 macro_rules! eval_json {768 ($str: expr) => {{769 let evaluator = EvaluationState::default();770 evaluator.with_stdlib();771 evaluator.run_in_state(|| {772 evaluator773 .evaluate_snippet_raw(PathBuf::from("raw.jsonnet").into(), $str.into())774 .unwrap()775 .to_json(0)776 .unwrap()777 .replace("\n", "")778 })779 }};780 }781782 /// Asserts given code returns `true`783 macro_rules! assert_eval {784 ($str: expr) => {785 assert!(primitive_equals(&eval!($str), &Val::Bool(true)).unwrap())786 };787 }788789 /// Asserts given code returns `false`790 macro_rules! assert_eval_neg {791 ($str: expr) => {792 assert!(primitive_equals(&eval!($str), &Val::Bool(false)).unwrap())793 };794 }795 macro_rules! assert_json {796 ($str: expr, $out: expr) => {797 assert_eq!(eval_json!($str), $out.replace("\t", ""))798 };799 }800801 /// Sanity checking, before trusting to another tests802 #[test]803 fn equality_operator() {804 assert_eval!("2 == 2");805 assert_eval_neg!("2 != 2");806 assert_eval!("2 != 3");807 assert_eval_neg!("2 == 3");808 assert_eval!("'Hello' == 'Hello'");809 assert_eval_neg!("'Hello' != 'Hello'");810 assert_eval!("'Hello' != 'World'");811 assert_eval_neg!("'Hello' == 'World'");812 }813814 #[test]815 fn math_evaluation() {816 assert_eval!("2 + 2 * 2 == 6");817 assert_eval!("3 + (2 + 2 * 2) == 9");818 }819820 #[test]821 fn string_concat() {822 assert_eval!("'Hello' + 'World' == 'HelloWorld'");823 assert_eval!("'Hello' * 3 == 'HelloHelloHello'");824 assert_eval!("'Hello' + 'World' * 3 == 'HelloWorldWorldWorld'");825 }826827 #[test]828 fn faster_join() {829 assert_eval!("std.join([0,0], [[1,2],[3,4],[5,6]]) == [1,2,0,0,3,4,0,0,5,6]");830 assert_eval!("std.join(',', ['1','2','3','4']) == '1,2,3,4'");831 }832833 #[test]834 fn function_contexts() {835 assert_eval!(836 r#"837 local k = {838 t(name = self.h): [self.h, name],839 h: 3,840 };841 local f = {842 t: k.t(),843 h: 4,844 };845 f.t[0] == f.t[1]846 "#847 );848 }849850 #[test]851 fn local() {852 assert_eval!("local a = 2; local b = 3; a + b == 5");853 assert_eval!("local a = 1, b = a + 1; a + b == 3");854 assert_eval!("local a = 1; local a = 2; a == 2");855 }856857 #[test]858 fn object_lazyness() {859 assert_json!("local a = {a:error 'test'}; {}", r#"{}"#);860 }861862 #[test]863 fn object_inheritance() {864 assert_json!("{a: self.b} + {b:3}", r#"{"a": 3,"b": 3}"#);865 }866867 #[test]868 fn object_assertion_success() {869 eval!("{assert \"a\" in self} + {a:2}");870 }871872 #[test]873 fn object_assertion_error() {874 eval!("{assert \"a\" in self}");875 }876877 #[test]878 fn lazy_args() {879 eval!("local test(a) = 2; test(error '3')");880 }881882 #[test]883 #[should_panic]884 fn tailstrict_args() {885 eval!("local test(a) = 2; test(error '3') tailstrict");886 }887888 #[test]889 #[should_panic]890 fn no_binding_error() {891 eval!("a");892 }893894 #[test]895 fn test_object() {896 assert_json!("{a:2}", r#"{"a": 2}"#);897 assert_json!("{a:2+2}", r#"{"a": 4}"#);898 assert_json!("{a:2}+{b:2}", r#"{"a": 2,"b": 2}"#);899 assert_json!("{b:3}+{b:2}", r#"{"b": 2}"#);900 assert_json!("{b:3}+{b+:2}", r#"{"b": 5}"#);901 assert_json!("local test='a'; {[test]:2}", r#"{"a": 2}"#);902 assert_json!(903 r#"904 {905 name: "Alice",906 welcome: "Hello " + self.name + "!",907 }908 "#,909 r#"{"name": "Alice","welcome": "Hello Alice!"}"#910 );911 assert_json!(912 r#"913 {914 name: "Alice",915 welcome: "Hello " + self.name + "!",916 } + {917 name: "Bob"918 }919 "#,920 r#"{"name": "Bob","welcome": "Hello Bob!"}"#921 );922 }923924 #[test]925 fn functions() {926 assert_json!(r#"local a = function(b, c = 2) b + c; a(2)"#, "4");927 assert_json!(928 r#"local a = function(b, c = "Dear") b + c + d, d = "World"; a("Hello")"#,929 r#""HelloDearWorld""#930 );931 }932933 #[test]934 fn local_methods() {935 assert_json!(r#"local a(b, c = 2) = b + c; a(2)"#, "4");936 assert_json!(937 r#"local a(b, c = "Dear") = b + c + d, d = "World"; a("Hello")"#,938 r#""HelloDearWorld""#939 );940 }941942 #[test]943 fn object_locals() {944 assert_json!(r#"{local a = 3, b: a}"#, r#"{"b": 3}"#);945 assert_json!(r#"{local a = 3, local c = a, b: c}"#, r#"{"b": 3}"#);946 assert_json!(947 r#"{local a = function (b) {[b]:4}, test: a("test")}"#,948 r#"{"test": {"test": 4}}"#949 );950 }951952 #[test]953 fn object_comp() {954 assert_json!(955 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}"#,956 "{\"h1_2\": \"0a\",\"h1_3\": \"0a\",\"h1_4\": \"0a\",\"h2_3\": \"a1\",\"h2_4\": \"a1\",\"h3_2\": \"0a\",\"h3_4\": \"a1\"}"957 )958 }959960 #[test]961 fn direct_self() {962 println!(963 "{:#?}",964 eval!(965 r#"966 {967 local me = self,968 a: 3,969 b(): me.a,970 }971 "#972 )973 );974 }975976 #[test]977 fn indirect_self() {978 // `self` assigned to `me` was lost when being979 // referenced from field980 eval!(981 r#"{982 local me = self,983 a: 3,984 b: me.a,985 }.b"#986 );987 }988989 // We can't trust other tests (And official jsonnet testsuite), if assert is not working correctly990 #[test]991 fn std_assert_ok() {992 eval!("std.assertEqual(4.5 << 2, 16)");993 }994995 #[test]996 #[should_panic]997 fn std_assert_failure() {998 eval!("std.assertEqual(4.5 << 2, 15)");999 }10001001 #[test]1002 fn string_is_string() {1003 assert!(primitive_equals(1004 &eval!("local arr = 'hello'; (!std.isArray(arr)) && (!std.isString(arr))"),1005 &Val::Bool(false),1006 )1007 .unwrap());1008 }10091010 #[test]1011 fn base64_works() {1012 assert_json!(r#"std.base64("test")"#, r#""dGVzdA==""#);1013 }10141015 #[test]1016 fn utf8_chars() {1017 assert_json!(1018 r#"local c="😎";{c:std.codepoint(c),l:std.length(c)}"#,1019 r#"{"c": 128526,"l": 1}"#1020 )1021 }10221023 #[test]1024 fn json() {1025 assert_json!(1026 r#"std.manifestJsonEx({a:3, b:4, c:6},"")"#,1027 r#""{\n\"a\": 3,\n\"b\": 4,\n\"c\": 6\n}""#1028 );1029 }10301031 #[test]1032 fn json_minified() {1033 assert_json!(1034 r#"std.manifestJsonMinified({a:3, b:4, c:6})"#,1035 r#""{\"a\":3,\"b\":4,\"c\":6}""#1036 );1037 }10381039 #[test]1040 fn parse_json() {1041 assert_json!(1042 r#"std.parseJson('{"a": -1,"b": 1,"c": 3.141,"d": []}')"#,1043 r#"{"a": -1,"b": 1,"c": 3.141,"d": []}"#1044 );1045 }10461047 #[test]1048 fn test() {1049 assert_json!(1050 r#"[[a, b] for a in [1,2,3] for b in [4,5,6]]"#,1051 "[[1,4],[1,5],[1,6],[2,4],[2,5],[2,6],[3,4],[3,5],[3,6]]"1052 );1053 }10541055 #[test]1056 fn sjsonnet() {1057 eval!(1058 r#"1059 local x0 = {k: 1};1060 local x1 = {k: x0.k + x0.k};1061 local x2 = {k: x1.k + x1.k};1062 local x3 = {k: x2.k + x2.k};1063 local x4 = {k: x3.k + x3.k};1064 local x5 = {k: x4.k + x4.k};1065 local x6 = {k: x5.k + x5.k};1066 local x7 = {k: x6.k + x6.k};1067 local x8 = {k: x7.k + x7.k};1068 local x9 = {k: x8.k + x8.k};1069 local x10 = {k: x9.k + x9.k};1070 local x11 = {k: x10.k + x10.k};1071 local x12 = {k: x11.k + x11.k};1072 local x13 = {k: x12.k + x12.k};1073 local x14 = {k: x13.k + x13.k};1074 local x15 = {k: x14.k + x14.k};1075 local x16 = {k: x15.k + x15.k};1076 local x17 = {k: x16.k + x16.k};1077 local x18 = {k: x17.k + x17.k};1078 local x19 = {k: x18.k + x18.k};1079 local x20 = {k: x19.k + x19.k};1080 local x21 = {k: x20.k + x20.k};1081 x21.k1082 "#1083 );1084 }10851086 // This test is commented out by default, because of huge compilation slowdown1087 // #[bench]1088 // fn bench_codegen(b: &mut Bencher) {1089 // b.iter(|| {1090 // #[allow(clippy::all)]1091 // let stdlib = {1092 // use jrsonnet_parser::*;1093 // include!(concat!(env!("OUT_DIR"), "/stdlib.rs"))1094 // };1095 // stdlib1096 // })1097 // }10981099 /*1100 #[bench]1101 fn bench_serialize(b: &mut Bencher) {1102 b.iter(|| {1103 bincode::deserialize::<jrsonnet_parser::LocExpr>(include_bytes!(concat!(1104 env!("OUT_DIR"),1105 "/stdlib.bincode"1106 )))1107 .expect("deserialize stdlib")1108 })1109 }11101111 #[bench]1112 fn bench_parse(b: &mut Bencher) {1113 b.iter(|| {1114 jrsonnet_parser::parse(1115 jrsonnet_stdlib::STDLIB_STR,1116 &jrsonnet_parser::ParserSettings {1117 loc_data: true,1118 file_name: Rc::new(PathBuf::from("std.jsonnet")),1119 },1120 )1121 })1122 }1123 */11241125 #[test]1126 fn equality() {1127 println!(1128 "{:?}",1129 jrsonnet_parser::parse(1130 "{ x: 1, y: 2 } == { x: 1, y: 2 }",1131 &ParserSettings {1132 file_name: PathBuf::from("equality").into(),1133 }1134 )1135 );1136 assert_eval!("{ x: 1, y: 2 } == { x: 1, y: 2 }")1137 }11381139 #[test]1140 fn native_ext() -> crate::error::Result<()> {1141 use super::native::NativeCallback;1142 let evaluator = EvaluationState::default();11431144 evaluator.with_stdlib();11451146 #[derive(Trace)]1147 struct NativeAdd;1148 impl NativeCallbackHandler for NativeAdd {1149 fn call(&self, from: Option<Rc<Path>>, args: &[Val]) -> crate::error::Result<Val> {1150 assert_eq!(1151 &from.unwrap() as &Path,1152 &PathBuf::from("native_caller.jsonnet")1153 );1154 match (&args[0], &args[1]) {1155 (Val::Num(a), Val::Num(b)) => Ok(Val::Num(a + b)),1156 (_, _) => unreachable!(),1157 }1158 }1159 }1160 evaluator.settings_mut().ext_natives.insert(1161 "native_add".into(),1162 #[allow(deprecated)]1163 Cc::new(TraceBox(Box::new(NativeCallback::new(1164 vec![1165 BuiltinParam {1166 name: "a".into(),1167 has_default: false,1168 },1169 BuiltinParam {1170 name: "b".into(),1171 has_default: false,1172 },1173 ],1174 TraceBox(Box::new(NativeAdd)),1175 )))),1176 );1177 evaluator.evaluate_snippet_raw(1178 PathBuf::from("native_caller.jsonnet").into(),1179 "std.assertEqual(std.native(\"native_add\")(1, 2), 3)".into(),1180 )?;1181 Ok(())1182 }11831184 #[test]1185 fn constant_intrinsic() -> crate::error::Result<()> {1186 assert_eval!(1187 "local std2 = std; local std = std2 { primitiveEquals(a, b):: false }; 1 == 1"1188 );1189 Ok(())1190 }11911192 #[test]1193 fn standalone_super() -> crate::error::Result<()> {1194 assert_eval!(1195 r#"1196 local obj = {1197 a: 1,1198 b: 2,1199 c: 3,1200 };1201 local test = obj + {1202 fields: std.objectFields(super),1203 d: 5,1204 };1205 test.fields == ['a', 'b', 'c']1206 "#1207 );1208 Ok(())1209 }12101211 #[test]1212 fn comp_self() -> crate::error::Result<()> {1213 assert_eval!(1214 r#"1215 std.objectFields({1216 a:{1217 [name]: name for name in std.objectFields(self)1218 },1219 b: 2,1220 c: 3,1221 }.a) == ['a', 'b', 'c']1222 "#1223 );12241225 Ok(())1226 }12271228 struct TestImportResolver(Vec<u8>);1229 impl crate::import::ImportResolver for TestImportResolver {1230 fn resolve_file(&self, _: &Path, _: &Path) -> crate::error::Result<Rc<Path>> {1231 Ok(PathBuf::from("/test").into())1232 }12331234 fn load_file_contents(&self, _: &Path) -> crate::error::Result<Vec<u8>> {1235 Ok(self.0.clone())1236 }12371238 unsafe fn as_any(&self) -> &dyn std::any::Any {1239 panic!()1240 }12411242 fn load_file_bin(&self, _resolved: &Path) -> crate::error::Result<Rc<[u8]>> {1243 panic!()1244 }1245 }12461247 #[test]1248 fn issue_23() {1249 let state = EvaluationState::default();1250 state.set_import_resolver(Box::new(TestImportResolver(r#"import "/test""#.into())));1251 let _ = state.evaluate_file_raw(&PathBuf::from("/test"));1252 }12531254 #[test]1255 fn issue_40() {1256 let state = EvaluationState::default();1257 state.with_stdlib();12581259 let error = state1260 .evaluate_snippet_raw(1261 PathBuf::from("issue40.jsonnet").into(),1262 r#"1263 local conf = {1264 n: ""1265 };12661267 local result = conf + {1268 assert std.isNumber(self.n): "is number"1269 };12701271 std.manifestJsonEx(result, "")1272 "#1273 .into(),1274 )1275 .unwrap_err();1276 assert_eq!(error.error().to_string(), "assert failed: is number");1277 }12781279 #[test]1280 fn test_ascii_upper_lower() {1281 assert_eval!(r#"std.assertEqual(std.asciiUpper("aBc😀"), "ABC😀")"#);1282 assert_eval!(r#"std.assertEqual(std.asciiLower("aBc😀"), "abc😀")"#);1283 }12841285 #[test]1286 fn test_member() {1287 assert_eval!(r#"!std.member("", "")"#);1288 assert_eval!(r#"std.member("abc", "a")"#);1289 assert_eval!(r#"!std.member("abc", "d")"#);1290 assert_eval!(r#"!std.member([], "")"#);1291 assert_eval!(r#"std.member(["a", "b", "c"], "a")"#);1292 assert_eval!(r#"!std.member(["a", "b", "c"], "d")"#);1293 }12941295 #[test]1296 fn test_count() {1297 assert_eval!(r#"std.assertEqual(std.count([], ""), 0)"#);1298 assert_eval!(r#"std.assertEqual(std.count(["a", "b", "a"], "d"), 0)"#);1299 assert_eval!(r#"std.assertEqual(std.count(["a", "b", "a"], "a"), 2)"#);1300 }13011302 mod derive_typed {1303 use std::path::PathBuf;13041305 use crate::{typed::Typed, EvaluationState};13061307 #[derive(PartialEq, Debug, Typed)]1308 struct MyTyped {1309 a: u32,1310 #[typed(rename = "b")]1311 c: String,1312 }13131314 #[test]1315 fn test() {1316 let es = EvaluationState::default();1317 let val = eval!("{a: 14, b: 'Hello, world!'}");1318 let typed = es.run_in_state(|| MyTyped::try_from(val).unwrap());13191320 assert_eq!(1321 typed,1322 MyTyped {1323 a: 14,1324 c: "Hello, world!".to_string()1325 }1326 );1327 es.settings_mut().globals.insert(1328 "mytyped".into(),1329 es.run_in_state(|| typed.try_into()).unwrap(),1330 );13311332 let v = es1333 .evaluate_snippet_raw(1334 PathBuf::from("raw.jsonnet").into(),1335 "1336 mytyped == {a: 14, b: 'Hello, world!'}1337 "1338 .into(),1339 )1340 .unwrap()1341 .as_bool()1342 .unwrap();1343 assert!(v)1344 }1345 }1346}crates/jrsonnet-evaluator/src/obj.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/obj.rs
+++ b/crates/jrsonnet-evaluator/src/obj.rs
@@ -18,10 +18,82 @@
push_frame, throw, weak_ptr_eq, weak_raw, Bindable, LazyBinding, LazyVal, Result, Val,
};
+#[cfg(not(feature = "exp-preserve-order"))]
+pub(crate) mod ordering {
+ use gcmodule::Trace;
+
+ #[derive(Clone, Copy, Default, Debug, Trace)]
+ pub struct FieldIndex;
+ impl FieldIndex {
+ pub fn next(self) -> Self {
+ Self
+ }
+ }
+
+ #[derive(Clone, Copy, Default, Debug, Trace)]
+ pub struct SuperDepth;
+ impl SuperDepth {
+ pub fn deeper(self) -> Self {
+ Self
+ }
+ }
+
+ #[derive(Clone, Copy)]
+ pub struct FieldSortKey;
+ impl FieldSortKey {
+ pub fn new(_: SuperDepth, _: FieldIndex) -> Self {
+ Self
+ }
+ }
+}
+
+#[cfg(feature = "exp-preserve-order")]
+mod ordering {
+ use std::cmp::Reverse;
+
+ use gcmodule::Trace;
+
+ #[derive(Clone, Copy, Default, Debug, Trace, PartialEq, Eq, PartialOrd, Ord)]
+ pub struct FieldIndex(u32);
+ impl FieldIndex {
+ pub fn next(self) -> Self {
+ Self(self.0 + 1)
+ }
+ }
+
+ #[derive(Clone, Copy, Default, PartialEq, Eq, PartialOrd, Ord, Debug)]
+ pub struct SuperDepth(u32);
+ impl SuperDepth {
+ pub fn deeper(self) -> Self {
+ Self(self.0 + 1)
+ }
+ }
+
+ #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug)]
+ pub struct FieldSortKey(Reverse<SuperDepth>, FieldIndex);
+ impl FieldSortKey {
+ pub fn new(depth: SuperDepth, index: FieldIndex) -> Self {
+ Self(Reverse(depth), index)
+ }
+ pub fn collide(self, other: Self) -> Self {
+ if self.0 .0 > other.0 .0 {
+ self
+ } else if self.0 .0 < other.0 .0 {
+ other
+ } else {
+ unreachable!("object can't have two fields with same name")
+ }
+ }
+ }
+}
+
+pub(crate) use ordering::*;
+
#[derive(Debug, Trace)]
pub struct ObjMember {
pub add: bool,
pub visibility: Visibility,
+ original_index: FieldIndex,
pub invoke: LazyBinding,
pub location: Option<ExprLocation>,
}
@@ -120,6 +192,14 @@
),
}
}
+ pub(crate) fn extend_with_raw_member(self, key: IStr, value: ObjMember) -> Self {
+ let mut new = GcHashMap::with_capacity(1);
+ new.insert(key, value);
+ Self::new(Some(self), Cc::new(new), Cc::new(Vec::new()))
+ }
+ pub fn extend_field(&mut self, name: IStr) -> ObjMemberBuilder<ExtendBuilder> {
+ ObjMemberBuilder::new(ExtendBuilder(self), name, FieldIndex::default())
+ }
pub fn with_this(&self, this_obj: Self) -> Self {
Self(Cc::new(ObjValueInternals {
super_obj: self.0.super_obj.clone(),
@@ -131,6 +211,13 @@
}))
}
+ pub fn len(&self) -> usize {
+ self.fields_visibility()
+ .into_iter()
+ .filter(|(_, (visible, _))| *visible)
+ .count()
+ }
+
pub fn is_empty(&self) -> bool {
if !self.0.this_entries.is_empty() {
return false;
@@ -143,51 +230,93 @@
}
/// Run callback for every field found in object
- pub(crate) fn enum_fields(&self, handler: &mut impl FnMut(&IStr, &ObjMember) -> bool) -> bool {
+ pub(crate) fn enum_fields(
+ &self,
+ depth: SuperDepth,
+ handler: &mut impl FnMut(SuperDepth, &IStr, &ObjMember) -> bool,
+ ) -> bool {
if let Some(s) = &self.0.super_obj {
- if s.enum_fields(handler) {
+ if s.enum_fields(depth.deeper(), handler) {
return true;
}
}
for (name, member) in self.0.this_entries.iter() {
- if handler(name, member) {
+ if handler(depth, name, member) {
return true;
}
}
false
}
- pub fn fields_visibility(&self) -> FxHashMap<IStr, bool> {
+ pub fn fields_visibility(&self) -> FxHashMap<IStr, (bool, FieldSortKey)> {
let mut out = FxHashMap::default();
- self.enum_fields(&mut |name, member| {
+ self.enum_fields(SuperDepth::default(), &mut |depth, name, member| {
+ let new_sort_key = FieldSortKey::new(depth, member.original_index);
match member.visibility {
Visibility::Normal => {
let entry = out.entry(name.to_owned());
- entry.or_insert(true);
+ let v = entry.or_insert((true, new_sort_key));
+ v.1 = new_sort_key;
}
Visibility::Hidden => {
- out.insert(name.to_owned(), false);
+ out.insert(name.to_owned(), (false, new_sort_key));
}
Visibility::Unhide => {
- out.insert(name.to_owned(), true);
+ out.insert(name.to_owned(), (true, new_sort_key));
}
};
false
});
out
}
- pub fn fields_ex(&self, include_hidden: bool) -> Vec<IStr> {
+ pub fn fields_ex(
+ &self,
+ include_hidden: bool,
+ #[cfg(feature = "exp-preserve-order")] preserve_order: bool,
+ ) -> Vec<IStr> {
+ #[cfg(feature = "exp-preserve-order")]
+ if preserve_order {
+ let (mut fields, mut keys): (Vec<_>, Vec<_>) = self
+ .fields_visibility()
+ .into_iter()
+ .filter(|(_, (visible, _))| include_hidden || *visible)
+ .enumerate()
+ .map(|(idx, (k, (_, sk)))| (k, (sk, idx)))
+ .unzip();
+ keys.sort_unstable_by_key(|v| v.0);
+ // Reorder in-place by resulting indexes
+ for i in 0..fields.len() {
+ let x = fields[i].clone();
+ let mut j = i;
+ loop {
+ let k = keys[j].1;
+ keys[j].1 = j;
+ if k == i {
+ break;
+ }
+ fields[j] = fields[k].clone();
+ j = k
+ }
+ fields[j] = x;
+ }
+ return fields;
+ }
+
let mut fields: Vec<_> = self
.fields_visibility()
.into_iter()
- .filter(|(_k, v)| include_hidden || *v)
+ .filter(|(_, (visible, _))| include_hidden || *visible)
.map(|(k, _)| k)
.collect();
fields.sort_unstable();
fields
}
- pub fn fields(&self) -> Vec<IStr> {
- self.fields_ex(false)
+ pub fn fields(&self, #[cfg(feature = "exp-preserve-order")] preserve_order: bool) -> Vec<IStr> {
+ self.fields_ex(
+ false,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
+ )
}
pub fn field_visibility(&self, name: IStr) -> Option<Visibility> {
@@ -236,11 +365,7 @@
self.get_raw(key, self.0.this_obj.as_ref())
}
- pub fn extend_with_field(self, key: IStr, value: ObjMember) -> Self {
- let mut new = GcHashMap::with_capacity(1);
- new.insert(key, value);
- Self::new(Some(self), Cc::new(new), Cc::new(Vec::new()))
- }
+ // pub fn extend_with(self, key: )
fn get_raw(&self, key: IStr, real_this: Option<&Self>) -> Result<Option<Val>> {
let real_this = real_this.unwrap_or(self);
@@ -339,6 +464,7 @@
super_obj: Option<ObjValue>,
map: GcHashMap<IStr, ObjMember>,
assertions: Vec<TraceBox<dyn ObjectAssertion>>,
+ next_field_index: FieldIndex,
}
impl ObjValueBuilder {
pub fn new() -> Self {
@@ -349,6 +475,7 @@
super_obj: None,
map: GcHashMap::with_capacity(capacity),
assertions: Vec::new(),
+ next_field_index: FieldIndex::default(),
}
}
pub fn reserve_asserts(&mut self, capacity: usize) -> &mut Self {
@@ -364,14 +491,10 @@
self.assertions.push(assertion);
self
}
- pub fn member(&mut self, name: IStr) -> ObjMemberBuilder {
- ObjMemberBuilder {
- value: self,
- name,
- add: false,
- visibility: Visibility::Normal,
- location: None,
- }
+ pub fn member(&mut self, name: IStr) -> ObjMemberBuilder<ValueBuilder> {
+ let field_index = self.next_field_index;
+ self.next_field_index = self.next_field_index.next();
+ ObjMemberBuilder::new(ValueBuilder(self), name, field_index)
}
pub fn build(self) -> ObjValue {
@@ -385,16 +508,28 @@
}
#[must_use = "value not added unless binding() was called"]
-pub struct ObjMemberBuilder<'v> {
- value: &'v mut ObjValueBuilder,
+pub struct ObjMemberBuilder<Kind> {
+ kind: Kind,
name: IStr,
add: bool,
visibility: Visibility,
+ original_index: FieldIndex,
location: Option<ExprLocation>,
}
#[allow(clippy::missing_const_for_fn)]
-impl<'v> ObjMemberBuilder<'v> {
+impl<Kind> ObjMemberBuilder<Kind> {
+ pub(crate) fn new(kind: Kind, name: IStr, original_index: FieldIndex) -> Self {
+ Self {
+ kind,
+ name,
+ original_index,
+ add: false,
+ visibility: Visibility::Normal,
+ location: None,
+ }
+ }
+
pub const fn with_add(mut self, add: bool) -> Self {
self.add = add;
self
@@ -413,6 +548,23 @@
self.location = Some(location);
self
}
+ fn build_member(self, binding: LazyBinding) -> (Kind, IStr, ObjMember) {
+ (
+ self.kind,
+ self.name,
+ ObjMember {
+ add: self.add,
+ visibility: self.visibility,
+ original_index: self.original_index,
+ invoke: binding,
+ location: self.location,
+ },
+ )
+ }
+}
+
+pub struct ValueBuilder<'v>(&'v mut ObjValueBuilder);
+impl<'v> ObjMemberBuilder<ValueBuilder<'v>> {
pub fn value(self, value: Val) -> Result<()> {
self.binding(LazyBinding::Bound(LazyVal::new_resolved(value)))
}
@@ -420,22 +572,31 @@
self.binding(LazyBinding::Bindable(Cc::new(bindable)))
}
pub fn binding(self, binding: LazyBinding) -> Result<()> {
- let old = self.value.map.insert(
- self.name.clone(),
- ObjMember {
- add: self.add,
- visibility: self.visibility,
- invoke: binding,
- location: self.location.clone(),
- },
- );
+ let (receiver, name, member) = self.build_member(binding);
+ let location = member.location.clone();
+ let old = receiver.0.map.insert(name.clone(), member);
if old.is_some() {
push_frame(
- CallLocation(self.location.as_ref()),
- || format!("field <{}> initializtion", self.name.clone()),
- || throw!(DuplicateFieldName(self.name.clone())),
+ CallLocation(location.as_ref()),
+ || format!("field <{}> initializtion", name.clone()),
+ || throw!(DuplicateFieldName(name.clone())),
)?
}
Ok(())
}
}
+
+pub struct ExtendBuilder<'v>(&'v mut ObjValue);
+impl<'v> ObjMemberBuilder<ExtendBuilder<'v>> {
+ pub fn value(self, value: Val) {
+ self.binding(LazyBinding::Bound(LazyVal::new_resolved(value)))
+ }
+ pub fn bindable(self, bindable: TraceBox<dyn Bindable>) {
+ self.binding(LazyBinding::Bindable(Cc::new(bindable)))
+ }
+ pub fn binding(self, binding: LazyBinding) -> () {
+ let (receiver, name, member) = self.build_member(binding);
+ let new = receiver.0.clone();
+ *receiver.0 = new.extend_with_raw_member(name, member)
+ }
+}
crates/jrsonnet-evaluator/src/val.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/val.rs
+++ b/crates/jrsonnet-evaluator/src/val.rs
@@ -167,11 +167,31 @@
#[derive(Clone)]
pub enum ManifestFormat {
YamlStream(Box<ManifestFormat>),
- Yaml(usize),
- Json(usize),
+ Yaml {
+ padding: usize,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order: bool,
+ },
+ Json {
+ padding: usize,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order: bool,
+ },
ToString,
String,
}
+impl ManifestFormat {
+ #[cfg(feature = "exp-preserve-order")]
+ fn preserve_order(&self) -> bool {
+ match self {
+ ManifestFormat::YamlStream(s) => s.preserve_order(),
+ ManifestFormat::Yaml { preserve_order, .. } => *preserve_order,
+ ManifestFormat::Json { preserve_order, .. } => *preserve_order,
+ ManifestFormat::ToString => false,
+ ManifestFormat::String => false,
+ }
+ }
+}
#[derive(Debug, Clone, Trace)]
pub struct Slice {
@@ -559,6 +579,8 @@
mtype: ManifestType::ToString,
newline: "\n",
key_val_sep: ": ",
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order: false,
},
)?
.into(),
@@ -571,7 +593,10 @@
Self::Obj(obj) => obj,
_ => throw!(MultiManifestOutputIsNotAObject),
};
- let keys = obj.fields();
+ let keys = obj.fields(
+ #[cfg(feature = "exp-preserve-order")]
+ ty.preserve_order(),
+ );
let mut out = Vec::with_capacity(keys.len());
for key in keys {
let value = obj
@@ -622,8 +647,24 @@
out.into()
}
- ManifestFormat::Yaml(padding) => self.to_yaml(*padding)?,
- ManifestFormat::Json(padding) => self.to_json(*padding)?,
+ ManifestFormat::Yaml {
+ padding,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
+ } => self.to_yaml(
+ *padding,
+ #[cfg(feature = "exp-preserve-order")]
+ *preserve_order,
+ )?,
+ ManifestFormat::Json {
+ padding,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
+ } => self.to_json(
+ *padding,
+ #[cfg(feature = "exp-preserve-order")]
+ *preserve_order,
+ )?,
ManifestFormat::ToString => self.to_string()?,
ManifestFormat::String => match self {
Self::Str(s) => s.clone(),
@@ -633,7 +674,11 @@
}
/// For manifestification
- pub fn to_json(&self, padding: usize) -> Result<IStr> {
+ pub fn to_json(
+ &self,
+ padding: usize,
+ #[cfg(feature = "exp-preserve-order")] preserve_order: bool,
+ ) -> Result<IStr> {
manifest_json_ex(
self,
&ManifestJsonOptions {
@@ -645,13 +690,19 @@
},
newline: "\n",
key_val_sep: ": ",
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
},
)
.map(|s| s.into())
}
/// Calls `std.manifestJson`
- pub fn to_std_json(&self, padding: usize) -> Result<Rc<str>> {
+ pub fn to_std_json(
+ &self,
+ padding: usize,
+ #[cfg(feature = "exp-preserve-order")] preserve_order: bool,
+ ) -> Result<Rc<str>> {
manifest_json_ex(
self,
&ManifestJsonOptions {
@@ -659,12 +710,18 @@
mtype: ManifestType::Std,
newline: "\n",
key_val_sep: ": ",
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
},
)
.map(|s| s.into())
}
- pub fn to_yaml(&self, padding: usize) -> Result<IStr> {
+ pub fn to_yaml(
+ &self,
+ padding: usize,
+ #[cfg(feature = "exp-preserve-order")] preserve_order: bool,
+ ) -> Result<IStr> {
let padding = &" ".repeat(padding);
manifest_yaml_ex(
self,
@@ -672,6 +729,8 @@
padding,
arr_element_padding: padding,
quote_keys: false,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
},
)
.map(|s| s.into())
@@ -733,8 +792,15 @@
if ObjValue::ptr_eq(a, b) {
return Ok(true);
}
- let fields = a.fields();
- if fields != b.fields() {
+ let fields = a.fields(
+ #[cfg(feature = "exp-preserve-order")]
+ false,
+ );
+ if fields
+ != b.fields(
+ #[cfg(feature = "exp-preserve-order")]
+ false,
+ ) {
return Ok(false);
}
for field in fields {
crates/jrsonnet-macros/src/lib.rsdiffbeforeafterboth--- a/crates/jrsonnet-macros/src/lib.rs
+++ b/crates/jrsonnet-macros/src/lib.rs
@@ -122,6 +122,7 @@
ty: Box<Type>,
is_option: bool,
name: String,
+ cfg_attrs: Vec<Attribute>,
// ident: Ident,
},
Lazy {
@@ -134,20 +135,15 @@
impl ArgInfo {
fn parse(arg: &FnArg) -> Result<Self> {
- let typed = match arg {
+ let arg = match arg {
FnArg::Receiver(_) => unreachable!(),
FnArg::Typed(a) => a,
};
- let ident = match &typed.pat as &Pat {
+ let ident = match &arg.pat as &Pat {
Pat::Ident(i) => i.ident.clone(),
- _ => {
- return Err(Error::new(
- typed.pat.span(),
- "arg should be plain identifier",
- ))
- }
+ _ => return Err(Error::new(arg.pat.span(), "arg should be plain identifier")),
};
- let ty = &typed.ty;
+ let ty = &arg.ty;
if type_is_path(ty, "CallLocation").is_some() {
return Ok(Self::Location);
} else if type_is_path(ty, "Self").is_some() {
@@ -172,11 +168,18 @@
(false, ty.clone())
};
+ let cfg_attrs = arg
+ .attrs
+ .iter()
+ .filter(|a| a.path.is_ident("cfg"))
+ .cloned()
+ .collect();
+
Ok(Self::Normal {
ty,
is_option,
name: ident.to_string(),
- // ident,
+ cfg_attrs,
})
}
}
@@ -215,13 +218,22 @@
let params_desc = args.iter().flat_map(|a| match a {
ArgInfo::Normal {
- is_option, name, ..
- }
- | ArgInfo::Lazy { is_option, name } => Some(quote! {
+ is_option,
+ name,
+ cfg_attrs,
+ ..
+ } => Some(quote! {
+ #(#cfg_attrs)*
+ BuiltinParam {
+ name: std::borrow::Cow::Borrowed(#name),
+ has_default: #is_option,
+ },
+ }),
+ ArgInfo::Lazy { is_option, name } => Some(quote! {
BuiltinParam {
name: std::borrow::Cow::Borrowed(#name),
has_default: #is_option,
- }
+ },
}),
ArgInfo::Location => None,
ArgInfo::This => None,
@@ -232,23 +244,27 @@
ty,
is_option,
name,
- // ident,
+ cfg_attrs,
} => {
let eval = quote! {::jrsonnet_evaluator::push_description_frame(
|| format!("argument <{}> evaluation", #name),
|| <#ty>::try_from(value.evaluate()?),
)?};
- if *is_option {
+ let value = if *is_option {
quote! {if let Some(value) = parsed.get(#name) {
Some(#eval)
} else {
None
- }}
+ },}
} else {
quote! {{
let value = parsed.get(#name).expect("args shape is checked");
#eval
- }}
+ },}
+ };
+ quote! {
+ #(#cfg_attrs)*
+ #value
}
}
ArgInfo::Lazy { is_option, name } => {
@@ -260,12 +276,12 @@
}}
} else {
quote! {
- parsed.get(#name).expect("args shape is correct").clone()
+ parsed.get(#name).expect("args shape is correct").clone(),
}
}
}
- ArgInfo::Location => quote! {location},
- ArgInfo::This => quote! {self},
+ ArgInfo::Location => quote! {location,},
+ ArgInfo::This => quote! {self,},
});
let fields = attr.fields.iter().map(|field| {
@@ -309,7 +325,7 @@
parser::ExprLocation,
};
const PARAMS: &'static [BuiltinParam] = &[
- #(#params_desc),*
+ #(#params_desc)*
];
#static_ext
@@ -326,7 +342,7 @@
fn call(&self, context: Context, location: CallLocation, args: &dyn ArgsLike) -> Result<Val> {
let parsed = parse_builtin_call(context, &PARAMS, args, false)?;
- let result: #result = #name(#(#pass),*);
+ let result: #result = #name(#(#pass)*);
let result = result?;
result.try_into()
}