mashin_runtime 0.1.2

The mashin runtime engine
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
/* -------------------------------------------------------- *\
 *                                                          *
 *      ███╗░░░███╗░█████╗░░██████╗██╗░░██╗██╗███╗░░██╗     *
 *      ████╗░████║██╔══██╗██╔════╝██║░░██║██║████╗░██║     *
 *      ██╔████╔██║███████║╚█████╗░███████║██║██╔██╗██║     *
 *      ██║╚██╔╝██║██╔══██║░╚═══██╗██╔══██║██║██║╚████║     *
 *      ██║░╚═╝░██║██║░░██║██████╔╝██║░░██║██║██║░╚███║     *
 *      ╚═╝░░░░░╚═╝╚═╝░░╚═╝╚═════╝░╚═╝░░╚═╝╚═╝╚═╝░░╚══╝     *
 *                                         by Nutshimit     *
 * -------------------------------------------------------- *
 *                                                          *
 *   This file is dual-licensed as Apache-2.0 or GPL-3.0.   *
 *   see LICENSE for license details.                       *
 *                                                          *
\* ---------------------------------------------------------*/

use anyhow::{anyhow, bail, Result};
use cache::{get_source_from_bytes, HttpCache, SourceFile};
use deno_ast::{MediaType, ParseParams, SourceTextInfo};
use deno_core::{
	error::uri_error,
	futures::{self, FutureExt},
	include_js_files, resolve_import, resolve_path,
	serde_json::json,
	Extension, JsRuntime, ModuleLoader, ModuleSource, ModuleSourceFuture, ModuleSpecifier,
	ModuleType, OpDecl, ResolutionKind, RuntimeOptions,
};
use deno_fetch::FetchPermissions;
use deno_web::{BlobStore, TimersPermission};
use deno_websocket::WebSocketPermissions;
use http_client::{fetch_once, FetchOnceArgs, FetchOnceResult, HttpClient};
pub use mashin_core::{
	colors,
	sdk::{ResourceAction, Urn},
	ExecutedResource,
};
use mashin_core::{mashin_dir::MashinDir, BackendState, ExecutedResources, MashinEngine};
use std::{
	cell::RefCell,
	env::current_dir,
	fs,
	future::Future,
	ops::{Deref, DerefMut},
	path::Path,
	pin::Pin,
	rc::Rc,
	sync::Arc,
};

mod builtin;
mod cache;
mod http_client;

#[macro_export]
macro_rules! log {
	($level:tt, $patter:expr $(, $values:expr)* $(,)?) => {
		log::$level!(
			target: "mashin::runtime",
            $patter $(, $values)*
		)
	};
}

#[macro_export]
macro_rules! js_log {
	($level:tt, $patter:expr $(, $values:expr)* $(,)?) => {
		log::$level!(
			target: "mashin::js",
            $patter $(, $values)*
		)
	};
}

struct AllowAllPermissions;

impl FetchPermissions for AllowAllPermissions {
	fn check_net_url(&mut self, _url: &deno_core::url::Url, _api_name: &str) -> Result<()> {
		Ok(())
	}

	fn check_read(&mut self, _path: &Path, _api_name: &str) -> Result<()> {
		Ok(())
	}
}

impl TimersPermission for AllowAllPermissions {
	fn allow_hrtime(&mut self) -> bool {
		true
	}

	fn check_unstable(&self, _state: &deno_core::OpState, _api_name: &'static str) {
		// allow unstable apis
	}
}

impl WebSocketPermissions for AllowAllPermissions {
	fn check_net_url(
		&mut self,
		_url: &deno_core::url::Url,
		_api_name: &str,
	) -> std::result::Result<(), deno_core::error::AnyError> {
		Ok(())
	}
}

pub struct Runtime {
	runtime: JsRuntime,
	main_module: String,
	command: RuntimeCommand,
	raw_args: Vec<String>,
	mashin_dir: MashinDir,
}

pub struct RuntimeResult {
	pub executed_resources: Rc<RefCell<ExecutedResources>>,
}

pub enum RuntimeCommand {
	Run,
	Destroy,
}

impl Deref for Runtime {
	type Target = JsRuntime;

	fn deref(&self) -> &Self::Target {
		&self.runtime
	}
}

impl DerefMut for Runtime {
	fn deref_mut(&mut self) -> &mut Self::Target {
		&mut self.runtime
	}
}

impl Runtime {
	pub fn new(
		main_module: &str,
		command: RuntimeCommand,
		raw_args: Vec<String>,
		executed_resources: Option<Rc<RefCell<ExecutedResources>>>,
	) -> Result<Self> {
		let mashin_dir = MashinDir::new(None)?;
		let is_first_run = executed_resources.is_none();
		let backend_state = BackendState::new(&mashin_dir)?;
		let http_cache = HttpCache::new(&mashin_dir.deps_folder_path());
		let http_client = HttpClient::new(http_cache, None)?;
		let isolated_mashin_dir = mashin_dir.clone();
		let isolated_http_client = http_client.clone();

		let extension = Extension::builder("mashin_core")
			.esm(include_js_files!(
				mashin_core dir "js",
				"01_errors.js",
				"06_util.js",
				"30_os.js",
				"40_ffi.js",
				"98_global_scope.js",
				"99_main.js",
			))
			.ops(stdlib())
			.state(move |state| {
				// fixme: init in cli?
				let backend = Rc::new(RefCell::new(backend_state));
				state.put(
					MashinEngine::new(backend, b"mysuperpassword", executed_resources)
						.expect("valid engine"),
				);
				state.put(isolated_mashin_dir);
				state.put(isolated_http_client);
				state.put(AllowAllPermissions {});
			})
			.build();

		let runtime = JsRuntime::new(RuntimeOptions {
			extensions: vec![
				deno_console::deno_console::init_ops_and_esm(),
				deno_webidl::deno_webidl::init_ops_and_esm(),
				deno_url::deno_url::init_ops_and_esm(),
				deno_web::deno_web::init_ops_and_esm::<AllowAllPermissions>(
					BlobStore::default(),
					None,
				),
				deno_fetch::deno_fetch::init_ops_and_esm::<AllowAllPermissions>(
					deno_fetch::Options {
						user_agent: format!("mashin_core/{}", env!("CARGO_PKG_VERSION")),
						..Default::default()
					},
				),
				extension,
			],
			module_loader: Some(Rc::new(TypescriptModuleLoader {
				http_client: Arc::new(http_client),
			})),

			..Default::default()
		});

		let mut runtime =
			Self { command, main_module: main_module.to_string(), runtime, raw_args, mashin_dir };

		// bootstrap the engine
		runtime.bootstrap(is_first_run)?;
		Ok(runtime)
	}

	pub async fn run(&mut self) -> Result<RuntimeResult> {
		match self.command {
			RuntimeCommand::Run => {
				self.run_main_module().await?;
			},
			RuntimeCommand::Destroy => todo!(),
		};

		let rc_op_state = self.runtime.op_state();
		let op_state = rc_op_state.borrow();
		let engine = op_state.borrow::<MashinEngine>();
		let executed_resources_rc = engine.executed_resources.clone();

		let all_resources_in_state = engine.state_handler.borrow().resources()?;
		let mut executed_resources = executed_resources_rc.borrow_mut();

		for urn in &all_resources_in_state {
			if !executed_resources.contains_key(urn) {
				executed_resources.insert(
					urn,
					ExecutedResource {
						diff: None,
						provider: urn.as_provider()?,
						required_change: Some(ResourceAction::Delete),
					},
				);
			}
		}

		Ok(RuntimeResult { executed_resources: executed_resources_rc.clone() })
	}

	// trigger `bootstrapMainRuntime` in `js/99_main.js`
	fn bootstrap(&mut self, is_first_run: bool) -> Result<()> {
		self.runtime.execute_script(
			"file://__bootstrap.js",
			format!(
				r#"globalThis.bootstrap.mainRuntime({})"#,
				json!({
					"isFirstRun": is_first_run,
					// allow parsing env with Deno.args
					"args": self.raw_args,
					// allow target with Deno.env
					"target": env!("TARGET")
				})
			),
		)?;
		Ok(())
	}

	// run the main module, evaluating each resource
	async fn run_main_module(&mut self) -> Result<()> {
		let main_module = resolve_path(&self.main_module, current_dir()?.as_path())?;
		let mod_id = self.runtime.load_main_module(&main_module, None).await?;
		let result_main = self.runtime.mod_evaluate(mod_id);
		self.runtime.run_event_loop(false).await?;
		result_main.await?
	}
}

fn stdlib() -> Vec<OpDecl> {
	let mut ops = vec![];
	ops.extend(builtin::mashin_core_client::op_decls());
	ops
}

#[derive(Debug, Clone)]
struct TypescriptModuleLoader {
	http_client: Arc<HttpClient>,
}

impl TypescriptModuleLoader {
	fn load_from_remote_url(
		&self,
		path: &ModuleSpecifier,
		redirect_limit: i64,
	) -> Pin<Box<dyn Future<Output = Result<SourceFile>> + Send>> {
		match self.http_client.cache().fetch_cached(path, redirect_limit) {
			Ok(Some(file)) => return futures::future::ok(file).boxed(),
			Ok(None) => {},
			Err(err) => return futures::future::err(err).boxed(),
		}
		let http_client = self.http_client.clone();
		let http_cache = http_client.cache().clone();
		let file_fetcher = self.clone();
		let path = path.clone();
		async move {
			match fetch_once(
				&http_client.clone(),
				FetchOnceArgs { url: path.clone(), maybe_accept: None, maybe_etag: None },
			)
			.await?
			{
				FetchOnceResult::NotModified => {
					let file = http_cache.fetch_cached(&path, 10)?.unwrap();
					Ok(file)
				},
				FetchOnceResult::Redirect(redirect_url, headers) => {
					http_cache.set(&path, headers, &[])?;
					file_fetcher.load_from_remote_url(&redirect_url, redirect_limit - 1).await
				},
				FetchOnceResult::Code(bytes, headers) => {
					http_cache.set(&path, headers.clone(), &bytes)?;
					let file = http_cache.build_remote_file(&path, bytes, &headers)?;
					Ok(file)
				},
			}
		}
		.boxed()
	}

	async fn load_from_filesystem(path: &ModuleSpecifier) -> Result<SourceFile> {
		let local = path
			.to_file_path()
			.map_err(|_| uri_error(format!("Invalid file path.\n  Specifier: {path}")))?;
		let bytes = fs::read(&local)?;
		let charset = detect_charset(&bytes).to_string();
		let source = get_source_from_bytes(bytes, Some(charset))?;
		let media_type = MediaType::from_specifier(path);

		Ok(SourceFile {
			local,
			maybe_types: None,
			media_type,
			source: source.into(),
			specifier: path.clone(),
			maybe_headers: None,
		})
	}
}

impl ModuleLoader for TypescriptModuleLoader {
	fn resolve(
		&self,
		specifier: &str,
		referrer: &str,
		_is_main: ResolutionKind,
	) -> Result<ModuleSpecifier> {
		Ok(resolve_import(specifier, referrer)?)
	}

	fn load(
		&self,
		module_specifier: &ModuleSpecifier,
		_maybe_referrer: Option<ModuleSpecifier>,
		_is_dyn_import: bool,
	) -> Pin<Box<ModuleSourceFuture>> {
		let module_specifier = module_specifier.clone();
		let file_fetcher = self.clone();

		async move {
			let source_file = match module_specifier.scheme() {
				"file" => TypescriptModuleLoader::load_from_filesystem(&module_specifier).await?,
				"https" => file_fetcher.load_from_remote_url(&module_specifier, 10).await?,
				_ => return Err(anyhow!("Unsupported module specifier: {}", module_specifier)),
			};

			let (module_type, should_transpile) = match source_file.media_type {
				MediaType::JavaScript | MediaType::Mjs | MediaType::Cjs =>
					(ModuleType::JavaScript, false),
				MediaType::Jsx => (ModuleType::JavaScript, true),
				MediaType::TypeScript |
				MediaType::Mts |
				MediaType::Cts |
				MediaType::Dts |
				MediaType::Dmts |
				MediaType::Dcts |
				MediaType::Tsx => (ModuleType::JavaScript, true),
				MediaType::Json => (ModuleType::Json, false),
				_ => bail!("Unknown extension {:?}", module_specifier),
			};

			let code = if should_transpile {
				let parsed = deno_ast::parse_module(ParseParams {
					specifier: module_specifier.to_string(),
					text_info: SourceTextInfo::from_string(source_file.source.to_string()),
					media_type: source_file.media_type,
					capture_tokens: false,
					scope_analysis: false,
					maybe_syntax: None,
				})?;
				parsed.transpile(&Default::default())?.text
			} else {
				source_file.source.to_string()
			};
			let module = ModuleSource {
				code: code.into(),
				module_type,
				module_url_specified: module_specifier.to_string(),
				module_url_found: module_specifier.to_string(),
			};
			Ok(module)
		}
		.boxed_local()
	}
}

pub fn detect_charset(bytes: &'_ [u8]) -> &'static str {
	const UTF16_LE_BOM: &[u8] = b"\xFF\xFE";
	const UTF16_BE_BOM: &[u8] = b"\xFE\xFF";

	if bytes.starts_with(UTF16_LE_BOM) {
		"utf-16le"
	} else if bytes.starts_with(UTF16_BE_BOM) {
		"utf-16be"
	} else {
		// Assume everything else is utf-8
		"utf-8"
	}
}