summaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorNayeem Rahman <nayeemrmn99@gmail.com>2023-06-13 16:45:06 +0100
committerGitHub <noreply@github.com>2023-06-13 09:45:06 -0600
commitceb03cfb037cf7024a5048b17b508ddda59cfa05 (patch)
tree0c2df444e00f17131f9e2af708f80cdc4b032ce8 /runtime
parent5348778666d2d8d7ce138bbdf75ac5aa9f7ed428 (diff)
refactor(core): cleanup feature flags for js source inclusion (#19463)
Remove `ExtensionFileSourceCode::LoadedFromFsDuringSnapshot` and feature `include_js_for_snapshotting` since they leak paths that are only applicable in this repo to embedders. Replace with feature `exclude_js_sources`. Additionally the feature `force_include_js_sources` allows negating it, if both features are set. We need both of these because features are additive and there must be a way of force including sources for snapshot creation while still having the `exclude_js_sources` feature. `force_include_js_sources` is only set for build deps, so sources are still excluded from the final binary. You can also specify `force_include_js_sources` on any extension to override the above features for that extension. Towards #19398. But there was still the snapshot-from-snapshot situation where code could be executed twice, I addressed that by making `mod_evaluate()` and scripts like `core/01_core.js` behave idempotently. This allowed unifying `ext::init_ops()` and `ext::init_ops_and_esm()` into `ext::init()`.
Diffstat (limited to 'runtime')
-rw-r--r--runtime/Cargo.toml11
-rw-r--r--runtime/build.rs59
-rw-r--r--runtime/examples/extension_with_esm/main.rs2
-rw-r--r--runtime/examples/extension_with_ops/main.rs2
-rw-r--r--runtime/js.rs7
-rw-r--r--runtime/web_worker.rs60
-rw-r--r--runtime/worker.rs58
7 files changed, 89 insertions, 110 deletions
diff --git a/runtime/Cargo.toml b/runtime/Cargo.toml
index 77571b210..e66698a01 100644
--- a/runtime/Cargo.toml
+++ b/runtime/Cargo.toml
@@ -14,15 +14,8 @@ description = "Provides the deno runtime library"
docsrs = []
# A feature that disables creation of startup snapshot during in the build script.
dont_create_runtime_snapshot = []
-# A feature that changes how startup snapshot is generated, that allows
-# extending it in embedder crates.
-snapshot_from_snapshot = []
-# A feature that disables embedding of the JavaScript source files in the binary.
-# With this feature enabled, the sources must be consumed during build time,
-# by creating a startup snapshot.
-include_js_files_for_snapshotting = [
- "deno_core/include_js_files_for_snapshotting",
-]
+# Enable to exclude `js/99_main.js` from the generated snapshot.
+exclude_js_main_from_snapshot = []
[lib]
name = "deno_runtime"
diff --git a/runtime/build.rs b/runtime/build.rs
index f656682a1..d7b4018fb 100644
--- a/runtime/build.rs
+++ b/runtime/build.rs
@@ -35,7 +35,7 @@ mod startup_snapshot {
file_source.specifier
),
};
- let code = file_source.load()?;
+ let code = file_source.load();
if !should_transpile {
return Ok(code);
@@ -264,22 +264,20 @@ mod startup_snapshot {
],
);
- #[cfg(not(feature = "snapshot_from_snapshot"))]
+ #[cfg(not(feature = "exclude_js_main_from_snapshot"))]
deno_core::extension!(
runtime_main,
deps = [runtime],
customizer = |ext: &mut deno_core::ExtensionBuilder| {
ext.esm(vec![ExtensionFileSource {
specifier: "ext:runtime_main/js/99_main.js",
- code: deno_core::ExtensionFileSourceCode::IncludedInBinary(
- include_str!("js/99_main.js"),
- ),
+ code: include_str!("js/99_main.js"),
}]);
ext.esm_entry_point("ext:runtime_main/js/99_main.js");
}
);
- #[cfg(feature = "snapshot_from_snapshot")]
+ #[cfg(feature = "exclude_js_main_from_snapshot")]
deno_core::extension!(
runtime_main,
deps = [runtime],
@@ -294,50 +292,48 @@ mod startup_snapshot {
// `runtime/worker.rs`, `runtime/web_worker.rs` and `cli/build.rs`!
let fs = std::sync::Arc::new(deno_fs::RealFs);
let extensions: Vec<Extension> = 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::<Permissions>(
+ deno_webidl::deno_webidl::init(),
+ deno_console::deno_console::init(),
+ deno_url::deno_url::init(),
+ deno_web::deno_web::init::<Permissions>(
deno_web::BlobStore::default(),
Default::default(),
),
- deno_fetch::deno_fetch::init_ops_and_esm::<Permissions>(
- Default::default(),
- ),
- deno_cache::deno_cache::init_ops_and_esm::<SqliteBackedCache>(None),
- deno_websocket::deno_websocket::init_ops_and_esm::<Permissions>(
+ deno_fetch::deno_fetch::init::<Permissions>(Default::default()),
+ deno_cache::deno_cache::init::<SqliteBackedCache>(None),
+ deno_websocket::deno_websocket::init::<Permissions>(
"".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_webstorage::deno_webstorage::init(None),
+ deno_crypto::deno_crypto::init(None),
+ deno_broadcast_channel::deno_broadcast_channel::init(
deno_broadcast_channel::InMemoryBroadcastChannel::default(),
false, // No --unstable.
),
- deno_ffi::deno_ffi::init_ops_and_esm::<Permissions>(false),
- deno_net::deno_net::init_ops_and_esm::<Permissions>(
+ deno_ffi::deno_ffi::init::<Permissions>(false),
+ deno_net::deno_net::init::<Permissions>(
None, false, // No --unstable.
None,
),
- deno_tls::deno_tls::init_ops_and_esm(),
- deno_kv::deno_kv::init_ops_and_esm(
+ deno_tls::deno_tls::init(),
+ deno_kv::deno_kv::init(
deno_kv::sqlite::SqliteDbHandler::<Permissions>::new(None),
false, // No --unstable
),
- deno_napi::deno_napi::init_ops_and_esm::<Permissions>(),
- deno_http::deno_http::init_ops_and_esm::<DefaultHttpPropertyExtractor>(),
- deno_io::deno_io::init_ops_and_esm(Default::default()),
- deno_fs::deno_fs::init_ops_and_esm::<Permissions>(false, fs.clone()),
- runtime::init_ops_and_esm(),
+ deno_napi::deno_napi::init::<Permissions>(),
+ deno_http::deno_http::init::<DefaultHttpPropertyExtractor>(),
+ deno_io::deno_io::init(Default::default()),
+ deno_fs::deno_fs::init::<Permissions>(false, fs.clone()),
+ runtime::init(),
// FIXME(bartlomieju): these extensions are specified last, because they
// depend on `runtime`, even though it should be other way around
- deno_node::deno_node::init_ops_and_esm::<Permissions>(None, fs),
- runtime_main::init_ops_and_esm(),
+ deno_node::deno_node::init::<Permissions>(None, fs),
+ runtime_main::init(),
];
- let output = create_snapshot(CreateSnapshotOptions {
+ create_snapshot(CreateSnapshotOptions {
cargo_manifest_dir: env!("CARGO_MANIFEST_DIR"),
snapshot_path,
startup_snapshot: None,
@@ -345,9 +341,6 @@ mod startup_snapshot {
compression_cb: None,
snapshot_module_load_cb: Some(Box::new(transpile_ts_for_snapshotting)),
});
- for path in output.files_loaded_during_snapshot {
- println!("cargo:rerun-if-changed={}", path.display());
- }
}
}
diff --git a/runtime/examples/extension_with_esm/main.rs b/runtime/examples/extension_with_esm/main.rs
index 6b21460a3..e2b7fccd1 100644
--- a/runtime/examples/extension_with_esm/main.rs
+++ b/runtime/examples/extension_with_esm/main.rs
@@ -26,7 +26,7 @@ async fn main() -> Result<(), AnyError> {
PermissionsContainer::allow_all(),
WorkerOptions {
module_loader: Rc::new(FsModuleLoader),
- extensions: vec![hello_runtime::init_ops_and_esm()],
+ extensions: vec![hello_runtime::init()],
..Default::default()
},
);
diff --git a/runtime/examples/extension_with_ops/main.rs b/runtime/examples/extension_with_ops/main.rs
index 1feb4ba27..53b6ca4fc 100644
--- a/runtime/examples/extension_with_ops/main.rs
+++ b/runtime/examples/extension_with_ops/main.rs
@@ -28,7 +28,7 @@ async fn main() -> Result<(), AnyError> {
PermissionsContainer::allow_all(),
WorkerOptions {
module_loader: Rc::new(FsModuleLoader),
- extensions: vec![hello_runtime::init_ops()],
+ extensions: vec![hello_runtime::init()],
..Default::default()
},
);
diff --git a/runtime/js.rs b/runtime/js.rs
index def2724ce..6aaa32f5f 100644
--- a/runtime/js.rs
+++ b/runtime/js.rs
@@ -13,10 +13,3 @@ pub fn deno_isolate_init() -> Snapshot {
debug!("Deno isolate init with snapshots.");
Snapshot::Static(RUNTIME_SNAPSHOT)
}
-
-#[cfg(not(feature = "include_js_files_for_snapshotting"))]
-pub static SOURCE_CODE_FOR_99_MAIN_JS: &str = include_str!("js/99_main.js");
-
-#[cfg(feature = "include_js_files_for_snapshotting")]
-pub static PATH_FOR_99_MAIN_JS: &str =
- concat!(env!("CARGO_MANIFEST_DIR"), "/js/99_main.js");
diff --git a/runtime/web_worker.rs b/runtime/web_worker.rs
index 36f9718b5..796e23c3c 100644
--- a/runtime/web_worker.rs
+++ b/runtime/web_worker.rs
@@ -399,14 +399,14 @@ impl WebWorker {
// `runtime/build.rs`, `runtime/worker.rs` and `cli/build.rs`!
let mut extensions: Vec<Extension> = vec![
// Web APIs
- deno_webidl::deno_webidl::init_ops(),
- deno_console::deno_console::init_ops(),
- deno_url::deno_url::init_ops(),
- deno_web::deno_web::init_ops::<PermissionsContainer>(
+ deno_webidl::deno_webidl::init(),
+ deno_console::deno_console::init(),
+ deno_url::deno_url::init(),
+ deno_web::deno_web::init::<PermissionsContainer>(
options.blob_store.clone(),
Some(main_module.clone()),
),
- deno_fetch::deno_fetch::init_ops::<PermissionsContainer>(
+ deno_fetch::deno_fetch::init::<PermissionsContainer>(
deno_fetch::Options {
user_agent: options.bootstrap.user_agent.clone(),
root_cert_store_provider: options.root_cert_store_provider.clone(),
@@ -417,57 +417,57 @@ impl WebWorker {
..Default::default()
},
),
- deno_cache::deno_cache::init_ops::<SqliteBackedCache>(create_cache),
- deno_websocket::deno_websocket::init_ops::<PermissionsContainer>(
+ deno_cache::deno_cache::init::<SqliteBackedCache>(create_cache),
+ deno_websocket::deno_websocket::init::<PermissionsContainer>(
options.bootstrap.user_agent.clone(),
options.root_cert_store_provider.clone(),
options.unsafely_ignore_certificate_errors.clone(),
),
- deno_webstorage::deno_webstorage::init_ops(None).disable(),
- deno_crypto::deno_crypto::init_ops(options.seed),
- deno_broadcast_channel::deno_broadcast_channel::init_ops(
+ deno_webstorage::deno_webstorage::init(None).disable(),
+ deno_crypto::deno_crypto::init(options.seed),
+ deno_broadcast_channel::deno_broadcast_channel::init(
options.broadcast_channel.clone(),
unstable,
),
- deno_ffi::deno_ffi::init_ops::<PermissionsContainer>(unstable),
- deno_net::deno_net::init_ops::<PermissionsContainer>(
+ deno_ffi::deno_ffi::init::<PermissionsContainer>(unstable),
+ deno_net::deno_net::init::<PermissionsContainer>(
options.root_cert_store_provider.clone(),
unstable,
options.unsafely_ignore_certificate_errors.clone(),
),
- deno_tls::deno_tls::init_ops(),
- deno_kv::deno_kv::init_ops(
+ deno_tls::deno_tls::init(),
+ deno_kv::deno_kv::init(
SqliteDbHandler::<PermissionsContainer>::new(None),
unstable,
),
- deno_napi::deno_napi::init_ops::<PermissionsContainer>(),
- deno_http::deno_http::init_ops::<DefaultHttpPropertyExtractor>(),
- deno_io::deno_io::init_ops(Some(options.stdio)),
- deno_fs::deno_fs::init_ops::<PermissionsContainer>(
+ deno_napi::deno_napi::init::<PermissionsContainer>(),
+ deno_http::deno_http::init::<DefaultHttpPropertyExtractor>(),
+ deno_io::deno_io::init(Some(options.stdio)),
+ deno_fs::deno_fs::init::<PermissionsContainer>(
unstable,
options.fs.clone(),
),
- deno_node::deno_node::init_ops::<PermissionsContainer>(
+ deno_node::deno_node::init::<PermissionsContainer>(
options.npm_resolver,
options.fs,
),
// Runtime ops that are always initialized for WebWorkers
- ops::web_worker::deno_web_worker::init_ops(),
- ops::runtime::deno_runtime::init_ops(main_module.clone()),
- ops::worker_host::deno_worker_host::init_ops(
+ ops::web_worker::deno_web_worker::init(),
+ ops::runtime::deno_runtime::init(main_module.clone()),
+ ops::worker_host::deno_worker_host::init(
options.create_web_worker_cb.clone(),
options.preload_module_cb.clone(),
options.pre_execute_module_cb.clone(),
options.format_js_error_fn.clone(),
),
- ops::fs_events::deno_fs_events::init_ops(),
- ops::os::deno_os_worker::init_ops(),
- 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(),
- deno_permissions_web_worker::init_ops(
+ ops::fs_events::deno_fs_events::init(),
+ ops::os::deno_os_worker::init(),
+ ops::permissions::deno_permissions::init(),
+ ops::process::deno_process::init(),
+ ops::signal::deno_signal::init(),
+ ops::tty::deno_tty::init(),
+ ops::http::deno_http_runtime::init(),
+ deno_permissions_web_worker::init(
permissions,
unstable,
enable_testing_features,
diff --git a/runtime/worker.rs b/runtime/worker.rs
index 10375818d..4b78c1a94 100644
--- a/runtime/worker.rs
+++ b/runtime/worker.rs
@@ -235,14 +235,14 @@ impl MainWorker {
// `runtime/build.rs`, `runtime/web_worker.rs` and `cli/build.rs`!
let mut extensions = vec![
// Web APIs
- deno_webidl::deno_webidl::init_ops(),
- deno_console::deno_console::init_ops(),
- deno_url::deno_url::init_ops(),
- deno_web::deno_web::init_ops::<PermissionsContainer>(
+ deno_webidl::deno_webidl::init(),
+ deno_console::deno_console::init(),
+ deno_url::deno_url::init(),
+ deno_web::deno_web::init::<PermissionsContainer>(
options.blob_store.clone(),
options.bootstrap.location.clone(),
),
- deno_fetch::deno_fetch::init_ops::<PermissionsContainer>(
+ deno_fetch::deno_fetch::init::<PermissionsContainer>(
deno_fetch::Options {
user_agent: options.bootstrap.user_agent.clone(),
root_cert_store_provider: options.root_cert_store_provider.clone(),
@@ -253,60 +253,60 @@ impl MainWorker {
..Default::default()
},
),
- deno_cache::deno_cache::init_ops::<SqliteBackedCache>(create_cache),
- deno_websocket::deno_websocket::init_ops::<PermissionsContainer>(
+ deno_cache::deno_cache::init::<SqliteBackedCache>(create_cache),
+ deno_websocket::deno_websocket::init::<PermissionsContainer>(
options.bootstrap.user_agent.clone(),
options.root_cert_store_provider.clone(),
options.unsafely_ignore_certificate_errors.clone(),
),
- deno_webstorage::deno_webstorage::init_ops(
+ deno_webstorage::deno_webstorage::init(
options.origin_storage_dir.clone(),
),
- deno_crypto::deno_crypto::init_ops(options.seed),
- deno_broadcast_channel::deno_broadcast_channel::init_ops(
+ deno_crypto::deno_crypto::init(options.seed),
+ deno_broadcast_channel::deno_broadcast_channel::init(
options.broadcast_channel.clone(),
unstable,
),
- deno_ffi::deno_ffi::init_ops::<PermissionsContainer>(unstable),
- deno_net::deno_net::init_ops::<PermissionsContainer>(
+ deno_ffi::deno_ffi::init::<PermissionsContainer>(unstable),
+ deno_net::deno_net::init::<PermissionsContainer>(
options.root_cert_store_provider.clone(),
unstable,
options.unsafely_ignore_certificate_errors.clone(),
),
- deno_tls::deno_tls::init_ops(),
- deno_kv::deno_kv::init_ops(
+ deno_tls::deno_tls::init(),
+ deno_kv::deno_kv::init(
SqliteDbHandler::<PermissionsContainer>::new(
options.origin_storage_dir.clone(),
),
unstable,
),
- deno_napi::deno_napi::init_ops::<PermissionsContainer>(),
- deno_http::deno_http::init_ops::<DefaultHttpPropertyExtractor>(),
- deno_io::deno_io::init_ops(Some(options.stdio)),
- deno_fs::deno_fs::init_ops::<PermissionsContainer>(
+ deno_napi::deno_napi::init::<PermissionsContainer>(),
+ deno_http::deno_http::init::<DefaultHttpPropertyExtractor>(),
+ deno_io::deno_io::init(Some(options.stdio)),
+ deno_fs::deno_fs::init::<PermissionsContainer>(
unstable,
options.fs.clone(),
),
- deno_node::deno_node::init_ops::<PermissionsContainer>(
+ deno_node::deno_node::init::<PermissionsContainer>(
options.npm_resolver,
options.fs,
),
// Ops from this crate
- ops::runtime::deno_runtime::init_ops(main_module.clone()),
- ops::worker_host::deno_worker_host::init_ops(
+ ops::runtime::deno_runtime::init(main_module.clone()),
+ ops::worker_host::deno_worker_host::init(
options.create_web_worker_cb.clone(),
options.web_worker_preload_module_cb.clone(),
options.web_worker_pre_execute_module_cb.clone(),
options.format_js_error_fn.clone(),
),
- ops::fs_events::deno_fs_events::init_ops(),
- ops::os::deno_os::init_ops(exit_code.clone()),
- 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(),
- deno_permissions_worker::init_ops(
+ ops::fs_events::deno_fs_events::init(),
+ ops::os::deno_os::init(exit_code.clone()),
+ ops::permissions::deno_permissions::init(),
+ ops::process::deno_process::init(),
+ ops::signal::deno_signal::init(),
+ ops::tty::deno_tty::init(),
+ ops::http::deno_http_runtime::init(),
+ deno_permissions_worker::init(
permissions,
unstable,
enable_testing_features,