From 1a2d8cfc986f35637d14000d916fd1f13447073c Mon Sep 17 00:00:00 2001 From: Divy Srivastava Date: Tue, 14 Nov 2023 04:15:49 -0800 Subject: [PATCH] refactor: snapshot module for deno_runtime (#21162) Closes #21134 --- runtime/lib.rs | 1 + runtime/snapshot.rs | 261 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 262 insertions(+) create mode 100644 runtime/snapshot.rs diff --git a/runtime/lib.rs b/runtime/lib.rs index c494463755..6a0a6569c6 100644 --- a/runtime/lib.rs +++ b/runtime/lib.rs @@ -30,6 +30,7 @@ pub mod inspector_server; pub mod js; pub mod ops; pub mod permissions; +pub mod snapshot; pub mod tokio_util; pub mod web_worker; pub mod worker; diff --git a/runtime/snapshot.rs b/runtime/snapshot.rs new file mode 100644 index 0000000000..61b0e075f4 --- /dev/null +++ b/runtime/snapshot.rs @@ -0,0 +1,261 @@ +// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license. + +use crate::ops; +use crate::shared::maybe_transpile_source; +use crate::shared::runtime; +use deno_cache::SqliteBackedCache; +use deno_core::error::AnyError; +use deno_core::snapshot_util::*; +use deno_core::Extension; +use deno_http::DefaultHttpPropertyExtractor; +use std::path::Path; +use std::path::PathBuf; +use std::sync::Arc; + +#[derive(Clone)] +struct Permissions; + +impl deno_fetch::FetchPermissions for Permissions { + fn check_net_url( + &mut self, + _url: &deno_core::url::Url, + _api_name: &str, + ) -> Result<(), deno_core::error::AnyError> { + unreachable!("snapshotting!") + } + + fn check_read( + &mut self, + _p: &Path, + _api_name: &str, + ) -> Result<(), deno_core::error::AnyError> { + unreachable!("snapshotting!") + } +} + +impl deno_websocket::WebSocketPermissions for Permissions { + fn check_net_url( + &mut self, + _url: &deno_core::url::Url, + _api_name: &str, + ) -> Result<(), deno_core::error::AnyError> { + unreachable!("snapshotting!") + } +} + +impl deno_web::TimersPermission for Permissions { + fn allow_hrtime(&mut self) -> bool { + unreachable!("snapshotting!") + } +} + +impl deno_ffi::FfiPermissions for Permissions { + fn check_partial( + &mut self, + _path: Option<&Path>, + ) -> Result<(), deno_core::error::AnyError> { + unreachable!("snapshotting!") + } +} + +impl deno_napi::NapiPermissions for Permissions { + fn check( + &mut self, + _path: Option<&Path>, + ) -> Result<(), deno_core::error::AnyError> { + unreachable!("snapshotting!") + } +} + +impl deno_node::NodePermissions for Permissions { + fn check_net_url( + &mut self, + _url: &deno_core::url::Url, + _api_name: &str, + ) -> Result<(), deno_core::error::AnyError> { + unreachable!("snapshotting!") + } + fn check_read(&self, _p: &Path) -> Result<(), deno_core::error::AnyError> { + unreachable!("snapshotting!") + } + fn check_sys( + &self, + _kind: &str, + _api_name: &str, + ) -> Result<(), deno_core::error::AnyError> { + unreachable!("snapshotting!") + } +} + +impl deno_net::NetPermissions for Permissions { + fn check_net>( + &mut self, + _host: &(T, Option), + _api_name: &str, + ) -> Result<(), deno_core::error::AnyError> { + unreachable!("snapshotting!") + } + + fn check_read( + &mut self, + _p: &Path, + _api_name: &str, + ) -> Result<(), deno_core::error::AnyError> { + unreachable!("snapshotting!") + } + + fn check_write( + &mut self, + _p: &Path, + _api_name: &str, + ) -> Result<(), deno_core::error::AnyError> { + unreachable!("snapshotting!") + } +} + +impl deno_fs::FsPermissions for Permissions { + fn check_read( + &mut self, + _path: &Path, + _api_name: &str, + ) -> Result<(), AnyError> { + unreachable!("snapshotting!") + } + + fn check_read_all(&mut self, _api_name: &str) -> Result<(), AnyError> { + unreachable!("snapshotting!") + } + + fn check_read_blind( + &mut self, + _path: &Path, + _display: &str, + _api_name: &str, + ) -> Result<(), AnyError> { + unreachable!("snapshotting!") + } + + fn check_write( + &mut self, + _path: &Path, + _api_name: &str, + ) -> Result<(), AnyError> { + unreachable!("snapshotting!") + } + + fn check_write_partial( + &mut self, + _path: &Path, + _api_name: &str, + ) -> Result<(), AnyError> { + unreachable!("snapshotting!") + } + + fn check_write_all(&mut self, _api_name: &str) -> Result<(), AnyError> { + unreachable!("snapshotting!") + } + + fn check_write_blind( + &mut self, + _path: &Path, + _display: &str, + _api_name: &str, + ) -> Result<(), AnyError> { + unreachable!("snapshotting!") + } +} + +impl deno_kv::sqlite::SqliteDbHandlerPermissions for Permissions { + fn check_read( + &mut self, + _path: &Path, + _api_name: &str, + ) -> Result<(), AnyError> { + unreachable!("snapshotting!") + } + + fn check_write( + &mut self, + _path: &Path, + _api_name: &str, + ) -> Result<(), AnyError> { + unreachable!("snapshotting!") + } +} + +pub fn create_runtime_snapshot(snapshot_path: PathBuf) { + // NOTE(bartlomieju): ordering is important here, keep it in sync with + // `runtime/worker.rs`, `runtime/web_worker.rs` and `cli/build.rs`! + let fs = std::sync::Arc::new(deno_fs::RealFs); + let mut extensions: Vec = vec![ + deno_webidl::deno_webidl::init_ops_and_esm(), + deno_console::deno_console::init_ops_and_esm(), + deno_url::deno_url::init_ops_and_esm(), + deno_web::deno_web::init_ops_and_esm::( + Default::default(), + Default::default(), + ), + deno_fetch::deno_fetch::init_ops_and_esm::(Default::default()), + deno_cache::deno_cache::init_ops_and_esm::(None), + deno_websocket::deno_websocket::init_ops_and_esm::( + "".to_owned(), + None, + None, + ), + deno_webstorage::deno_webstorage::init_ops_and_esm(None), + deno_crypto::deno_crypto::init_ops_and_esm(None), + deno_broadcast_channel::deno_broadcast_channel::init_ops_and_esm( + deno_broadcast_channel::InMemoryBroadcastChannel::default(), + ), + deno_ffi::deno_ffi::init_ops_and_esm::(), + deno_net::deno_net::init_ops_and_esm::(None, None), + deno_tls::deno_tls::init_ops_and_esm(), + deno_kv::deno_kv::init_ops_and_esm(deno_kv::sqlite::SqliteDbHandler::< + Permissions, + >::new(None, None)), + deno_cron::deno_cron::init_ops_and_esm( + deno_cron::local::LocalCronHandler::new(), + ), + deno_napi::deno_napi::init_ops_and_esm::(), + deno_http::deno_http::init_ops_and_esm::(), + deno_io::deno_io::init_ops_and_esm(Default::default()), + deno_fs::deno_fs::init_ops_and_esm::(fs.clone()), + deno_node::deno_node::init_ops_and_esm::(None, fs), + runtime::init_ops_and_esm(), + ops::runtime::deno_runtime::init_ops("deno:runtime".parse().unwrap()), + ops::worker_host::deno_worker_host::init_ops( + Arc::new(|_| unreachable!("not used in snapshot.")), + None, + ), + ops::fs_events::deno_fs_events::init_ops(), + ops::os::deno_os::init_ops(Default::default()), + ops::permissions::deno_permissions::init_ops(), + ops::process::deno_process::init_ops(), + ops::signal::deno_signal::init_ops(), + ops::tty::deno_tty::init_ops(), + ops::http::deno_http_runtime::init_ops(), + ops::bootstrap::deno_bootstrap::init_ops(), + ]; + + for extension in &mut extensions { + for source in extension.esm_files.to_mut() { + maybe_transpile_source(source).unwrap(); + } + for source in extension.js_files.to_mut() { + maybe_transpile_source(source).unwrap(); + } + } + + let output = create_snapshot(CreateSnapshotOptions { + cargo_manifest_dir: env!("CARGO_MANIFEST_DIR"), + snapshot_path, + startup_snapshot: None, + extensions, + compression_cb: None, + with_runtime_cb: None, + skip_op_registration: false, + }); + for path in output.files_loaded_during_snapshot { + println!("cargo:rerun-if-changed={}", path.display()); + } +}