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

difftreelog

source

crates/jrsonnet-evaluator/src/async_import.rs9.2 KiBsourcehistory
1use std::{cell::RefCell, path::Path};23use async_trait::async_trait;4use jrsonnet_gcmodule::Trace;5use jrsonnet_interner::IStr;6use jrsonnet_parser::{7	ArgsDesc, AssertStmt, BindSpec, CompSpec, Destruct, Expr, FieldMember, FieldName, ForSpecData,8	IfSpecData, LocExpr, Member, ObjBody, Param, ParamsDesc, ParserSettings, SliceDesc, Source,9	SourcePath,10};1112use crate::{gc::GcHashMap, throw, FileData, ImportResolver, State};1314pub struct Import {15	path: IStr,16	expression: bool,17}1819pub struct FoundImports(Vec<Import>);2021// Visits all nodes, trying to find import statements22#[allow(clippy::too_many_lines)]23pub fn find_imports(expr: &LocExpr, out: &mut FoundImports) {24	fn in_destruct(dest: &Destruct, #[allow(unused_variables)] out: &mut FoundImports) {25		match dest {26			#[cfg(feature = "exp-destruct")]27			Destruct::Array {28				start,29				rest: _,30				end,31			} => {32				for dest in start {33					in_destruct(dest, out);34				}35				for dest in end {36					in_destruct(dest, out);37				}38			}39			#[cfg(feature = "exp-destruct")]40			Destruct::Object { fields, rest: _ } => {41				for (_, dest, default) in fields {42					if let Some(dest) = dest {43						in_destruct(dest, out);44					}45					if let Some(expr) = default {46						find_imports(expr, out);47					}48				}49			}50			#[cfg(feature = "exp-destruct")]51			Destruct::Skip => {}52			Destruct::Full(_) => {}53		}54	}55	fn in_compspec(specs: &[CompSpec], out: &mut FoundImports) {56		for spec in specs {57			match spec {58				CompSpec::IfSpec(IfSpecData(expr)) => find_imports(expr, out),59				CompSpec::ForSpec(ForSpecData(destruct, expr)) => {60					in_destruct(destruct, out);61					find_imports(expr, out);62				}63			}64		}65	}66	fn in_params(params: &ParamsDesc, out: &mut FoundImports) {67		for Param(dest, default) in &*params.0 {68			in_destruct(dest, out);69			if let Some(expr) = default {70				find_imports(expr, out);71			}72		}73	}74	fn in_bind(specs: &[BindSpec], out: &mut FoundImports) {75		for spec in specs {76			match spec {77				BindSpec::Field {78					into: dest,79					value: expr,80				} => {81					in_destruct(dest, out);82					find_imports(expr, out);83				}84				BindSpec::Function {85					name: _,86					params,87					value: expr,88				} => {89					in_params(params, out);90					find_imports(expr, out);91				}92			}93		}94	}95	fn in_args(ArgsDesc { unnamed, named }: &ArgsDesc, out: &mut FoundImports) {96		for expr in unnamed {97			find_imports(expr, out);98		}99		for (_, expr) in named {100			find_imports(expr, out);101		}102	}103	fn in_obj(obj: &ObjBody, out: &mut FoundImports) {104		match obj {105			ObjBody::MemberList(v) => {106				for member in v {107					match member {108						Member::Field(FieldMember {109							name,110							params,111							value,112							..113						}) => {114							match name {115								FieldName::Fixed(_) => {}116								FieldName::Dyn(expr) => find_imports(expr, out),117							}118							if let Some(params) = params {119								in_params(params, out);120							}121							find_imports(value, out);122						}123						Member::BindStmt(_) => todo!(),124						Member::AssertStmt(AssertStmt(expr, expr2)) => {125							find_imports(expr, out);126							if let Some(expr) = expr2 {127								find_imports(expr, out);128							}129						}130					}131				}132			}133			ObjBody::ObjComp(_) => todo!(),134		}135	}136	match &*expr.0 {137		Expr::Import(v) | Expr::ImportStr(v) | Expr::ImportBin(v) => {138			if let Expr::Str(s) = &*v.0 {139				out.0.push(Import {140					path: s.clone(),141					expression: matches!(&*expr.0, Expr::Import(_)),142				});143			}144			// Non-string import will fail in runtime145		}146147		Expr::Literal(_) | Expr::Str(_) | Expr::Num(_) | Expr::Var(_) => {}148149		Expr::Arr(arr) => {150			for expr in arr {151				find_imports(expr, out);152			}153		}154		Expr::ArrComp(expr, specs) => {155			find_imports(expr, out);156			in_compspec(specs, out);157		}158		Expr::Obj(obj) => in_obj(obj, out),159		Expr::ObjExtend(expr, obj) => {160			find_imports(expr, out);161			in_obj(obj, out);162		}163		Expr::BinaryOp(a, _, b) => {164			find_imports(a, out);165			find_imports(b, out);166		}167		Expr::AssertExpr(AssertStmt(expr, expr2), then) => {168			find_imports(expr, out);169			if let Some(expr) = expr2 {170				find_imports(expr, out);171			}172			find_imports(then, out);173		}174		Expr::LocalExpr(specs, expr) => {175			in_bind(specs, out);176			find_imports(expr, out);177		}178		Expr::Apply(expr, args, _) => {179			find_imports(expr, out);180			in_args(args, out);181		}182		Expr::Index(expr, index) => {183			find_imports(expr, out);184			find_imports(index, out);185		}186		Expr::Function(params, expr) => {187			in_params(params, out);188			find_imports(expr, out);189		}190		Expr::IfElse {191			cond: IfSpecData(expr),192			cond_then,193			cond_else,194		} => {195			find_imports(expr, out);196			find_imports(cond_then, out);197			if let Some(expr) = cond_else {198				find_imports(expr, out);199			}200		}201		Expr::Slice(expr, SliceDesc { start, end, step }) => {202			find_imports(expr, out);203			if let Some(expr) = start {204				find_imports(expr, out);205			}206			if let Some(expr) = end {207				find_imports(expr, out);208			}209			if let Some(expr) = step {210				find_imports(expr, out);211			}212		}213		Expr::Parened(expr) | Expr::UnaryOp(_, expr) | Expr::ErrorStmt(expr) => {214			find_imports(expr, out);215		}216	}217}218219#[async_trait(?Send)]220pub trait AsyncImportResolver {221	type Error;222	/// Resolves file path, e.g. `(/home/user/manifests, b.libjsonnet)` can correspond223	/// both to `/home/user/manifests/b.libjsonnet` and to `/home/user/${vendor}/b.libjsonnet`224	/// where `${vendor}` is a library path.225	///226	/// `from` should only be returned from [`ImportResolver::resolve`], or from other defined file, any other value227	/// may result in panic228	async fn resolve_from(&self, from: &SourcePath, path: &str) -> Result<SourcePath, Self::Error>;229	async fn resolve_from_default(&self, path: &str) -> Result<SourcePath, Self::Error> {230		self.resolve_from(&SourcePath::default(), path).await231	}232	/// Resolves absolute path, doesn't supports jpath and other fancy things233	async fn resolve(&self, path: &Path) -> Result<SourcePath, Self::Error>;234235	/// Load resolved file236	/// This should only be called with value returned from [`ImportResolver::resolve_file`]/[`ImportResolver::resolve`],237	/// this cannot be resolved using associated type, as evaluator uses object instead of generic for [`ImportResolver`]238	async fn load_file_contents(&self, resolved: &SourcePath) -> Result<Vec<u8>, Self::Error>;239}240241#[derive(Trace)]242struct ResolvedImportResolver {243	resolved: RefCell<GcHashMap<(SourcePath, IStr), (SourcePath, bool)>>,244}245impl ImportResolver for ResolvedImportResolver {246	fn load_file_contents(&self, _resolved: &SourcePath) -> crate::Result<Vec<u8>> {247		unreachable!("all files should be loaded at this point");248	}249250	fn resolve_from(&self, from: &SourcePath, path: &str) -> crate::Result<SourcePath> {251		Ok(self252			.resolved253			.borrow()254			.get(&(from.clone(), path.into()))255			.expect("all imports should be resolved at this point")256			.0257			.clone())258	}259260	fn resolve_from_default(&self, path: &str) -> crate::Result<SourcePath> {261		self.resolve_from(&SourcePath::default(), path)262	}263264	fn resolve(&self, path: &Path) -> crate::Result<SourcePath> {265		throw!(crate::error::ErrorKind::AbsoluteImportNotSupported(266			path.to_owned()267		))268	}269270	fn as_any(&self) -> &dyn std::any::Any {271		self272	}273}274275enum Job {276	LoadFile { path: SourcePath, parse: bool },277	ParseFile(SourcePath),278	ResolveImport { from: SourcePath, import: Import },279}280281#[allow(clippy::future_not_send)]282pub async fn async_import<H>(s: State, handler: H, path: impl AsRef<Path>) -> Result<(), H::Error>283where284	H: AsyncImportResolver,285{286	let mut resolved = s287		.import_resolver()288		.as_any()289		.downcast_ref::<ResolvedImportResolver>()290		.map_or_else(GcHashMap::new, |resolver| {291			std::mem::take(&mut *resolver.resolved.borrow_mut())292		});293	let mut queue = vec![Job::LoadFile {294		path: handler.resolve(path.as_ref()).await?,295		parse: true,296	}];297	while let Some(job) = queue.pop() {298		match job {299			Job::LoadFile { path, parse } => {300				if !s.0.file_cache.borrow().contains_key(&path) {301					let data = handler.load_file_contents(&path).await?;302					s.0.file_cache303						.borrow_mut()304						.insert(path.clone(), FileData::new_bytes(data.as_slice().into()));305				}306				if parse {307					queue.push(Job::ParseFile(path));308				}309			}310			Job::ParseFile(path) => {311				if let Some(file) = s.0.file_cache.borrow_mut().get_mut(&path) {312					if file.parsed.is_none() {313						let Some(code) = file.get_string() else {314							continue;315						};316						let source = Source::new(path.clone(), code.clone());317						// If failed - then skip import318						file.parsed =319							jrsonnet_parser::parse(&code, &ParserSettings { source }).ok();320						if let Some(parsed) = &file.parsed {321							let mut imports = FoundImports(vec![]);322							find_imports(parsed, &mut imports);323							for import in imports.0 {324								queue.push(Job::ResolveImport {325									from: path.clone(),326									import,327								});328							}329						}330					}331				}332			}333			Job::ResolveImport { from, import } => {334				if let Some((resolved, expression)) =335					resolved.get_mut(&(from.clone(), import.path.clone()))336				{337					if import.expression && !*expression {338						*expression = true;339						queue.push(Job::ParseFile(resolved.clone()));340					}341					continue;342				}343				let resolved = handler.resolve_from(&from, &import.path).await?;344				queue.push(Job::LoadFile {345					path: resolved,346					parse: import.expression,347				});348			}349		}350	}351	s.set_import_resolver(ResolvedImportResolver {352		resolved: RefCell::new(resolved),353	});354	Ok(())355}