cli/lib/worker.rs - main - githubmirror/deno

cli/lib/worker.rs
1 112 строк38 KB
Nathan Whitaker
fix(cache): store Web Cache under origin data (#36145)
20 июл 2026, 22:59
20 июл 2026, 22:5901c89b8
// Copyright 2018-2026 the Deno authors. MIT license.

use std::path::Path;
use std::path::PathBuf;
use std::rc::Rc;
use std::sync::Arc;

use boxed_error::Boxed;
use deno_bundle_runtime::BundleProvider;
use deno_core::ModuleSpecifier;
use deno_core::error::JsError;
use deno_node::NodeRequireLoaderRc;
use deno_node::ops::ipc::ChildIpcSerialization;
use deno_path_util::url_from_file_path;
use deno_path_util::url_to_file_path;
use deno_resolver::npm::DenoInNpmPackageChecker;
use deno_resolver::npm::NpmResolver;
use deno_runtime::BootstrapOptions;
use deno_runtime::CpuProfilerConfig;
use deno_runtime::FeatureChecker;
use deno_runtime::UNSTABLE_FEATURES;
use deno_runtime::WorkerExecutionMode;
use deno_runtime::WorkerLogLevel;
use deno_runtime::colors;
use deno_runtime::deno_core;
use deno_runtime::deno_core::CompiledWasmModuleStore;
use deno_runtime::deno_core::Extension;
use deno_runtime::deno_core::JsRuntime;
use deno_runtime::deno_core::LocalInspectorSession;
use deno_runtime::deno_core::ModuleLoader;
use deno_runtime::deno_core::SharedArrayBufferStore;
use deno_runtime::deno_core::error::CoreError;
use deno_runtime::deno_core::v8;
use deno_runtime::deno_fs;
use deno_runtime::deno_inspector_server::MainInspectorSessionChannel;
use deno_runtime::deno_napi::DenoRtNativeAddonLoaderRc;
use deno_runtime::deno_node::NodeExtInitServices;
use deno_runtime::deno_node::NodeRequireLoader;
use deno_runtime::deno_node::NodeResolver;
use deno_runtime::deno_permissions::PermissionsContainer;
use deno_runtime::deno_process::NpmProcessStateProviderRc;
use deno_runtime::deno_telemetry::OtelConfig;
use deno_runtime::deno_tls::RootCertStoreProvider;
use deno_runtime::deno_web::Blob;
use deno_runtime::deno_web::BlobStoreTrait;
use deno_runtime::deno_web::InMemoryBroadcastChannel;
use deno_runtime::fmt_errors::format_js_error;
use deno_runtime::ops::worker_host::CreateWebWorkerCb;
use deno_runtime::web_worker::WebWorker;
use deno_runtime::web_worker::WebWorkerOptions;
use deno_runtime::web_worker::WebWorkerServiceOptions;
use deno_runtime::worker::MainWorker;
use deno_runtime::worker::WorkerOptions;
use deno_runtime::worker::WorkerServiceOptions;
use node_resolver::UrlOrPath;
use node_resolver::errors::ResolvePkgJsonBinExportError;
use url::Url;

use crate::args::has_trace_permissions_enabled;
use crate::sys::DenoLibSys;
use crate::util::checksum;

pub struct CreateModuleLoaderResult {
  pub module_loader: Rc<dyn ModuleLoader>,
  pub node_require_loader: Rc<dyn NodeRequireLoader>,
  pub hook_registry:
    Option<deno_runtime::deno_node::ops::module_hooks::LoaderHookRegistry>,
}

pub trait ModuleLoaderFactory: Send + Sync {
  fn create_for_main(
    &self,
    root_permissions: PermissionsContainer,
  ) -> CreateModuleLoaderResult;

  fn create_for_worker(
    &self,
    parent_permissions: PermissionsContainer,
    permissions: PermissionsContainer,
    maybe_main_module_blob: Option<(ModuleSpecifier, Arc<Blob>)>,
  ) -> CreateModuleLoaderResult;
}

enum StorageKeyResolverStrategy {
  Specified(Option<String>),
  UseMainModule,
}

pub struct StorageKeyResolver(StorageKeyResolverStrategy);

impl StorageKeyResolver {
  pub fn from_flag(location: &Url) -> Self {
    // if a location is set, then the ascii serialization of the location is
    // used, unless the origin is opaque, and then no storage origin is set, as
    // we can't expect the origin to be reproducible
    let storage_origin = location.origin();
    Self(StorageKeyResolverStrategy::Specified(
      if storage_origin.is_tuple() {
        Some(storage_origin.ascii_serialization())
      } else {
        None
      },
    ))
  }

  pub fn from_config_file_url(url: &Url) -> Self {
    Self(StorageKeyResolverStrategy::Specified(Some(url.to_string())))
  }

  /// Storage key for a compiled binary. Keyed by the stable app name so each
  /// app gets a single persistent store, independent of the main module URL
  /// (which is not stable across differently named binaries). The `app:`
  /// prefix namespaces this key from URL-derived keys so a compiled app and a
  /// `deno run` of the same origin can't collide in the shared, temp-backed
  /// `caches` directory (which is keyed by the hash of this string rather than
  /// by the per-app data directory).
  pub fn from_compile_app_name(app_name: &str) -> Self {
    Self(StorageKeyResolverStrategy::Specified(Some(format!(
      "app:{app_name}"
    ))))
  }

  pub fn new_use_main_module() -> Self {
    Self(StorageKeyResolverStrategy::UseMainModule)
  }

  /// Creates a storage key resolver that will always resolve to being empty.
  pub fn empty() -> Self {
    Self(StorageKeyResolverStrategy::Specified(None))
  }

  /// Resolves the storage key to use based on the current flags, config, or main module.
  pub fn resolve_storage_key(&self, main_module: &Url) -> Option<String> {
    // use the stored value or fall back to using the path of the main module.
    match &self.0 {
      StorageKeyResolverStrategy::Specified(value) => value.clone(),
      StorageKeyResolverStrategy::UseMainModule => {
        Some(main_module.to_string())
      }
    }
  }
}

/// Returns the persistent Cache API storage root beneath Deno's origin data
/// directory. Each storage key uses a hashed child directory of this root.
pub fn get_cache_storage_dir(origin_data_folder_path: &Path) -> PathBuf {
  origin_data_folder_path.join("web_cache")
}

fn get_cache_storage_dir_for_key(
  origin_data_folder_path: &Path,
  key: &str,
) -> PathBuf {
  get_cache_storage_dir(origin_data_folder_path)
    .join(checksum::r#gen(&[key.as_bytes()]))
}

/// By default V8 uses 1.4Gb heap limit which is meant for browser tabs.
/// Instead probe for the total memory on the system and use it instead
/// as a default. In case the platform is Linux and `DENO_USE_CGROUPS` is set,
/// parse cgroup config to get the cgroup-constrained memory limit.
pub fn create_isolate_create_params<TSys: DenoLibSys>(
  #[allow(
    unused_variables,
    reason = "used only in Linux to get cgroup-constrained memory limit"
  )]
  sys: &TSys,
) -> Option<v8::CreateParams> {
  #[cfg(any(target_os = "android", target_os = "linux"))]
  {
    linux::get_memory_limit(sys).map(|memory_limit| {
      v8::CreateParams::default()
        .heap_limits_from_system_memory(memory_limit, 0)
    })
  }
  #[cfg(not(any(target_os = "android", target_os = "linux")))]
  {
    let maybe_mem_info = deno_runtime::deno_os::sys_info::mem_info();
    maybe_mem_info.map(|mem_info| {
      v8::CreateParams::default()
        .heap_limits_from_system_memory(mem_info.total, 0)
    })
  }
}

#[cfg(any(target_os = "android", target_os = "linux"))]
mod linux {
  use deno_runtime::deno_node::ops::process::cgroup::CgroupVersion;
  use deno_runtime::deno_node::ops::process::cgroup::parse_self_cgroup;

  /// Get memory limit with cgroup (either v1 or v2) taken into account.
  pub(super) fn get_memory_limit<TSys: crate::sys::DenoLibSys>(
    sys: &TSys,
  ) -> Option<u64> {
    let system_total_memory = deno_runtime::deno_os::sys_info::mem_info()
      .map(|mem_info| mem_info.total);

    // For performance, parse cgroup config only when DENO_USE_CGROUPS is set
    if sys.env_var_os("DENO_USE_CGROUPS").is_none() {
      return system_total_memory;
    }

    let Ok(self_cgroup) = sys.fs_read_to_string("/proc/self/cgroup") else {
      return system_total_memory;
    };

    let limit = match parse_self_cgroup(&self_cgroup) {
      CgroupVersion::V1 { cgroup_relpath } => {
        let limit_path = std::path::Path::new("/sys/fs/cgroup/memory")
          .join(cgroup_relpath)
          .join("memory.limit_in_bytes");
        sys
          .fs_read_to_string(limit_path)
          .ok()
          .and_then(|s| s.trim().parse::<u64>().ok())
      }
      CgroupVersion::V2 { cgroup_relpath } => {
        let limit_path = std::path::Path::new("/sys/fs/cgroup")
          .join(cgroup_relpath)
          .join("memory.max");
        sys
          .fs_read_to_string(limit_path)
          .ok()
          .and_then(|s| s.trim().parse::<u64>().ok())
      }
      CgroupVersion::None => system_total_memory,
    };

    limit.or(system_total_memory)
  }
}

#[derive(Debug, Boxed, deno_error::JsError)]
pub struct ResolveNpmBinaryEntrypointError(
  pub Box<ResolveNpmBinaryEntrypointErrorKind>,
);

#[derive(Debug, thiserror::Error, deno_error::JsError)]
pub enum ResolveNpmBinaryEntrypointErrorKind {
  #[class(inherit)]
  #[error(transparent)]
  PathToUrl(#[from] deno_path_util::PathToUrlError),
  #[class(inherit)]
  #[error(transparent)]
  ResolvePkgJsonBinExport(ResolvePkgJsonBinExportError),
  #[class(generic)]
  #[error("{original:#}\n\nFallback failed: {fallback:#}")]
  Fallback {
    fallback: ResolveNpmBinaryEntrypointFallbackError,
    original: ResolvePkgJsonBinExportError,
  },
}

#[derive(Debug, thiserror::Error, deno_error::JsError)]
pub enum ResolveNpmBinaryEntrypointFallbackError {
  #[class(inherit)]
  #[error(transparent)]
  PackageSubpathResolve(
    node_resolver::errors::PackageSubpathFromDenoModuleResolveError,
  ),
  #[class(generic)]
  #[error("Cannot find module '{0}'")]
  ModuleNotFound(UrlOrPath),
}

pub struct LibMainWorkerOptions {
  pub argv: Vec<String>,
  pub log_level: WorkerLogLevel,
  pub enable_raw_imports: bool,
  pub enable_testing_features: bool,
  pub has_node_modules_dir: bool,
  pub inspect_brk: bool,
  pub inspect_wait: bool,
  pub trace_ops: Option<Vec<String>>,
  pub is_inspecting: bool,
  /// If this is a `deno compile`-ed executable.
  pub is_standalone: bool,
  // If the runtime should try to use `export default { fetch }`
  pub auto_serve: bool,
  pub location: Option<Url>,
  pub argv0: Option<String>,
  pub node_debug: Option<String>,
  pub node_cluster_unique_id: Option<String>,
  pub node_cluster_sched_policy: Option<String>,
  pub otel_config: OtelConfig,
  pub origin_data_folder_path: Option<PathBuf>,
  pub seed: Option<u64>,
  pub unsafely_ignore_certificate_errors: Option<Vec<String>>,
  pub skip_op_registration: bool,
  pub node_ipc_init: Option<(i64, ChildIpcSerialization)>,
  pub no_legacy_abort: bool,
  pub startup_snapshot: Option<&'static [u8]>,
  /// Residual `lazy_loaded_js` sources from the snapshot build script.
  pub residual_lazy_js_sources: &'static [(&'static str, &'static str)],
  /// Residual `lazy_loaded_esm` sources from the snapshot build script.
  pub residual_lazy_esm_sources: &'static [(&'static str, &'static str)],
  pub serve_port: Option<u16>,
  pub serve_host: Option<String>,
  pub close_on_idle: bool,
  pub maybe_initial_cwd: Option<Url>,
  /// When true, the `OffscreenCanvas` global is removed at bootstrap.
  pub disable_offscreen_canvas: bool,
}

#[derive(Default, Clone)]
pub struct LibWorkerFactoryRoots {
  pub compiled_wasm_module_store: CompiledWasmModuleStore,
  pub shared_array_buffer_store: SharedArrayBufferStore,
}

struct LibWorkerFactorySharedState<TSys: DenoLibSys> {
  blob_store: Arc<dyn BlobStoreTrait>,
  broadcast_channel: InMemoryBroadcastChannel,
  code_cache: Option<Arc<dyn deno_runtime::code_cache::CodeCache>>,
  compiled_wasm_module_store: CompiledWasmModuleStore,
  deno_rt_native_addon_loader: Option<DenoRtNativeAddonLoaderRc>,
  feature_checker: Arc<FeatureChecker>,
  fs: Arc<dyn deno_fs::FileSystem>,
  maybe_coverage_dir: Option<PathBuf>,
  maybe_cpu_prof_config: Option<CpuProfilerConfig>,
  main_inspector_session_tx: MainInspectorSessionChannel,
  module_loader_factory: Box<dyn ModuleLoaderFactory>,
  node_resolver:
    Arc<NodeResolver<DenoInNpmPackageChecker, NpmResolver<TSys>, TSys>>,
  npm_process_state_provider: NpmProcessStateProviderRc,
  pkg_json_resolver: Arc<node_resolver::PackageJsonResolver<TSys>>,
  root_cert_store_provider: Arc<dyn RootCertStoreProvider>,
  shared_array_buffer_store: SharedArrayBufferStore,
  storage_key_resolver: StorageKeyResolver,
  sys: TSys,
  options: LibMainWorkerOptions,
  bundle_provider: Option<Arc<dyn BundleProvider>>,
}

impl<TSys: DenoLibSys> LibWorkerFactorySharedState<TSys> {
  fn resolve_unstable_features(
    &self,
    feature_checker: &FeatureChecker,
  ) -> Vec<i32> {
    let mut unstable_features = Vec::with_capacity(UNSTABLE_FEATURES.len());
    for feature in UNSTABLE_FEATURES {
      if feature_checker.check(feature.name) {
        unstable_features.push(feature.id);
      }
    }
    unstable_features
  }

  fn create_node_init_services(
    &self,
    node_require_loader: NodeRequireLoaderRc,
  ) -> NodeExtInitServices<DenoInNpmPackageChecker, NpmResolver<TSys>, TSys> {
    NodeExtInitServices {
      node_require_loader,
      node_resolver: self.node_resolver.clone(),
      pkg_json_resolver: self.pkg_json_resolver.clone(),
      sys: self.sys.clone(),
    }
  }

  fn create_web_worker_callback(
    self: &Arc<Self>,
    stdio: deno_runtime::deno_io::Stdio,
  ) -> Arc<CreateWebWorkerCb> {
    let shared = self.clone();
    Arc::new(move |args| {
      let CreateModuleLoaderResult {
        module_loader,
        node_require_loader,
        hook_registry,
      } = shared.module_loader_factory.create_for_worker(
        args.parent_permissions.clone(),
        args.permissions.clone(),
        args
          .maybe_main_module_blob
          .clone()
          .map(|blob| (args.main_module.clone(), blob)),
      );
      let create_web_worker_cb =
        shared.create_web_worker_callback(stdio.clone());

      let maybe_storage_key = shared
        .storage_key_resolver
        .resolve_storage_key(&args.main_module);
      let cache_storage_dir = maybe_storage_key.as_ref().map(|key| {
        // TODO(@satyarohith): storage quota management
        get_cache_storage_dir_for_key(
          shared.options.origin_data_folder_path.as_ref().unwrap(), // must be set if storage key resolver returns a value
          key,
        )
      });

      // TODO(bartlomieju): this is cruft, update FeatureChecker to spit out
      // list of enabled features.
      let feature_checker = shared.feature_checker.clone();
      let unstable_features =
        shared.resolve_unstable_features(feature_checker.as_ref());

      let services = WebWorkerServiceOptions {
        deno_rt_native_addon_loader: shared.deno_rt_native_addon_loader.clone(),
        root_cert_store_provider: Some(shared.root_cert_store_provider.clone()),
        module_loader,
        fs: shared.fs.clone(),
        node_services: Some(
          shared.create_node_init_services(node_require_loader),
        ),
        blob_store: shared.blob_store.clone(),
        broadcast_channel: shared.broadcast_channel.clone(),
        shared_array_buffer_store: Some(
          shared.shared_array_buffer_store.clone(),
        ),
        compiled_wasm_module_store: Some(
          shared.compiled_wasm_module_store.clone(),
        ),
        main_inspector_session_tx: shared.main_inspector_session_tx.clone(),
        feature_checker,
        npm_process_state_provider: Some(
          shared.npm_process_state_provider.clone(),
        ),
        permissions: args.permissions,
        bundle_provider: shared.bundle_provider.clone(),
      };
      let maybe_initial_cwd = shared.options.maybe_initial_cwd.clone();
      // Apply resource limits to v8::CreateParams if specified.
      // Uses individual V8 ResourceConstraints setters to match Node.js
      // behavior (node_worker.cc UpdateResourceConstraints).
      let (create_params, resolved_limits) = if let Some(ref limits) =
        args.resource_limits
      {
        let mut params =
          create_isolate_create_params(&shared.sys).unwrap_or_default();

        if let Some(max_old) =
          limits.max_old_generation_size_mb.filter(|&v| v > 0)
        {
          params =
            params.set_max_old_generation_size_in_bytes(max_old * 1024 * 1024);
        }
        if let Some(max_young) =
          limits.max_young_generation_size_mb.filter(|&v| v > 0)
        {
          params = params
            .set_max_young_generation_size_in_bytes(max_young * 1024 * 1024);
        }
        if let Some(code_range) = limits.code_range_size_mb.filter(|&v| v > 0) {
          params =
            params.set_code_range_size_in_bytes(code_range * 1024 * 1024);
        }

        let mb = 1024 * 1024;
        // Read back resolved values (including V8 defaults for
        // unspecified fields), matching Node.js behavior.
        // Note: integer division truncates sub-MB fractions, which is fine
        // since V8 and Node.js both work in whole-MB granularity here.
        let resolved = deno_node::ops::worker_threads::ResolvedResourceLimits {
          max_young_generation_size_mb: params
            .max_young_generation_size_in_bytes()
            / mb,
          max_old_generation_size_mb: params.max_old_generation_size_in_bytes()
            / mb,
          code_range_size_mb: params.code_range_size_in_bytes() / mb,
          stack_size_mb: limits
            .stack_size_mb
            .unwrap_or(deno_node::ops::worker_threads::DEFAULT_STACK_SIZE_MB),
        };

        (Some(params), Some(resolved))
      } else {
        (create_isolate_create_params(&shared.sys), None)
      };

      let options = WebWorkerOptions {
        name: args.name,
        main_module: args.main_module.clone(),
        worker_id: args.worker_id,
        bootstrap: BootstrapOptions {
          deno_version: crate::version::DENO_VERSION_INFO.deno.to_string(),
          args: shared.options.argv.clone(),
          cpu_count: std::thread::available_parallelism()
            .map(|p| p.get())
            .unwrap_or(1),
          log_level: shared.options.log_level,
          enable_testing_features: shared.options.enable_testing_features,
          locale: deno_core::v8::icu::get_language_tag(),
          location: Some(args.main_module),
          color_level: colors::get_color_level(),
          unstable_features,
          user_agent: crate::version::DENO_VERSION_INFO.user_agent.to_string(),
          inspect: shared.options.is_inspecting,
          is_standalone: shared.options.is_standalone,
          auto_serve: shared.options.auto_serve,
          has_node_modules_dir: shared.options.has_node_modules_dir,
          argv0: shared.options.argv0.clone(),
          node_debug: shared.options.node_debug.clone(),
          node_cluster_unique_id: shared.options.node_cluster_unique_id.clone(),
          node_cluster_sched_policy: shared
            .options
            .node_cluster_sched_policy
            .clone(),
          node_ipc_init: None,
          mode: WorkerExecutionMode::Worker,
          serve_port: shared.options.serve_port,
          serve_host: shared.options.serve_host.clone(),
          otel_config: shared.options.otel_config.clone(),
          no_legacy_abort: shared.options.no_legacy_abort,
          close_on_idle: args.close_on_idle,
          disable_offscreen_canvas: shared.options.disable_offscreen_canvas,
        },
        extensions: vec![],
        startup_snapshot: shared.options.startup_snapshot,
        residual_lazy_js_sources: shared.options.residual_lazy_js_sources,
        residual_lazy_esm_sources: shared.options.residual_lazy_esm_sources,
        create_params,
        unsafely_ignore_certificate_errors: shared
          .options
          .unsafely_ignore_certificate_errors
          .clone(),
        seed: shared.options.seed,
        create_web_worker_cb,
        format_js_error_fn: Some(Arc::new(move |a| {
          format_js_error(a, maybe_initial_cwd.as_ref())
        })),
        worker_type: args.worker_type,
        stdio: stdio.clone(),
        cache_storage_dir,
        trace_ops: shared.options.trace_ops.clone(),
        close_on_idle: args.close_on_idle,
        maybe_worker_metadata: args.maybe_worker_metadata,
        maybe_main_module_blob: args.maybe_main_module_blob,
        maybe_coverage_dir: shared.maybe_coverage_dir.clone(),
        maybe_cpu_prof_config: shared.maybe_cpu_prof_config.clone(),
        enable_raw_imports: shared.options.enable_raw_imports,
        enable_stack_trace_arg_in_ops: has_trace_permissions_enabled(
          &shared.sys,
        ),
        wait_for_debugger_on_start: args.wait_for_debugger_on_start,
        wait_for_page_wait_for_debugger: args.wait_for_page_wait_for_debugger,
      };

      let has_resource_limits = args.resource_limits.is_some();
      let (mut worker, handle, bootstrap_options) =
        WebWorker::from_options(services, options);

      // Store resolved resource limits in the worker's op state BEFORE
      // bootstrapping, so the worker_threads polyfill can read them
      // via op during init.
      if let Some(resolved) = resolved_limits {
        worker.js_runtime.op_state().borrow_mut().put(resolved);
      }

      worker.bootstrap(&bootstrap_options);

      // Wire the module hook registry into OpState after bootstrap so
      // `module.registerHooks()` in worker scripts shares state with the
      // worker's module loader (same pattern as the main worker).
      if let Some(registry) = hook_registry {
        worker.js_runtime.op_state().borrow_mut().put(registry);
      }

      // When resource limits are set, install a near-heap-limit callback
      // that terminates the worker's isolate gracefully instead of
      // crashing the entire process with a V8 fatal OOM.
      if has_resource_limits {
        let ts_handle = worker.js_runtime.v8_isolate().thread_safe_handle();
        let oom_flag = worker.oom_triggered.clone();
        worker.js_runtime.add_near_heap_limit_callback(
          move |current_limit, _initial_limit| {
            oom_flag.store(true, std::sync::atomic::Ordering::SeqCst);
            ts_handle.terminate_execution();
            current_limit * 2
          },
        );
      }

      (worker, handle)
    })
  }
}

pub struct LibMainWorkerFactory<TSys: DenoLibSys> {
  shared: Arc<LibWorkerFactorySharedState<TSys>>,
}

impl<TSys: DenoLibSys> LibMainWorkerFactory<TSys> {
  #[allow(clippy::too_many_arguments, reason = "construction")]
  pub fn new(
    blob_store: Arc<dyn BlobStoreTrait>,
    code_cache: Option<Arc<dyn deno_runtime::code_cache::CodeCache>>,
    deno_rt_native_addon_loader: Option<DenoRtNativeAddonLoaderRc>,
    feature_checker: Arc<FeatureChecker>,
    fs: Arc<dyn deno_fs::FileSystem>,
    maybe_coverage_dir: Option<PathBuf>,
    maybe_cpu_prof_config: Option<CpuProfilerConfig>,
    module_loader_factory: Box<dyn ModuleLoaderFactory>,
    node_resolver: Arc<
      NodeResolver<DenoInNpmPackageChecker, NpmResolver<TSys>, TSys>,
    >,
    npm_process_state_provider: NpmProcessStateProviderRc,
    pkg_json_resolver: Arc<node_resolver::PackageJsonResolver<TSys>>,
    root_cert_store_provider: Arc<dyn RootCertStoreProvider>,
    storage_key_resolver: StorageKeyResolver,
    sys: TSys,
    options: LibMainWorkerOptions,
    roots: LibWorkerFactoryRoots,
    bundle_provider: Option<Arc<dyn BundleProvider>>,
  ) -> Self {
    Self {
      shared: Arc::new(LibWorkerFactorySharedState {
        blob_store,
        broadcast_channel: Default::default(),
        code_cache,
        compiled_wasm_module_store: roots.compiled_wasm_module_store,
        deno_rt_native_addon_loader,
        feature_checker,
        fs,
        maybe_coverage_dir,
        maybe_cpu_prof_config,
        main_inspector_session_tx: MainInspectorSessionChannel::new(),
        module_loader_factory,
        node_resolver,
        npm_process_state_provider,
        pkg_json_resolver,
        root_cert_store_provider,
        shared_array_buffer_store: roots.shared_array_buffer_store,
        storage_key_resolver,
        sys,
        options,
        bundle_provider,
      }),
    }
  }

  pub fn create_main_worker(
    &self,
    mode: WorkerExecutionMode,
    permissions: PermissionsContainer,
    main_module: Url,
    preload_modules: Vec<Url>,
    require_modules: Vec<Url>,
  ) -> Result<LibMainWorker, CoreError> {
    self.create_custom_worker(
      mode,
      main_module,
      preload_modules,
      require_modules,
      permissions,
      vec![],
      Default::default(),
      None,
    )
  }

  #[allow(clippy::too_many_arguments, reason = "TODO: cleanup")]
  pub fn create_custom_worker(
    &self,
    mode: WorkerExecutionMode,
    main_module: Url,
    preload_modules: Vec<Url>,
    require_modules: Vec<Url>,
    permissions: PermissionsContainer,
    custom_extensions: Vec<Extension>,
    stdio: deno_runtime::deno_io::Stdio,
    unconfigured_runtime: Option<deno_runtime::UnconfiguredRuntime>,
  ) -> Result<LibMainWorker, CoreError> {
    let shared = &self.shared;
    let CreateModuleLoaderResult {
      module_loader,
      node_require_loader,
      hook_registry,
    } = shared
      .module_loader_factory
      .create_for_main(permissions.clone());

    // TODO(bartlomieju): this is cruft, update FeatureChecker to spit out
    // list of enabled features.
    let feature_checker = shared.feature_checker.clone();
    let unstable_features =
      shared.resolve_unstable_features(feature_checker.as_ref());
    let maybe_storage_key = shared
      .storage_key_resolver
      .resolve_storage_key(&main_module);
    let origin_storage_dir: Option<PathBuf> =
      maybe_storage_key.as_ref().map(|key| {
        shared
          .options
          .origin_data_folder_path
          .as_ref()
          .unwrap() // must be set if storage key resolver returns a value
          .join(checksum::r#gen(&[key.as_bytes()]))
      });
    let cache_storage_dir = maybe_storage_key.as_ref().map(|key| {
      // TODO(@satyarohith): storage quota management
      get_cache_storage_dir_for_key(
        shared.options.origin_data_folder_path.as_ref().unwrap(), // must be set if storage key resolver returns a value
        key,
      )
    });

    let services = WorkerServiceOptions {
      deno_rt_native_addon_loader: shared.deno_rt_native_addon_loader.clone(),
      root_cert_store_provider: Some(shared.root_cert_store_provider.clone()),
      module_loader,
      fs: shared.fs.clone(),
      node_services: Some(
        shared.create_node_init_services(node_require_loader),
      ),
      npm_process_state_provider: Some(
        shared.npm_process_state_provider.clone(),
      ),
      blob_store: shared.blob_store.clone(),
      broadcast_channel: shared.broadcast_channel.clone(),
      fetch_dns_resolver: Default::default(),
      shared_array_buffer_store: Some(shared.shared_array_buffer_store.clone()),
      compiled_wasm_module_store: Some(
        shared.compiled_wasm_module_store.clone(),
      ),
      feature_checker,
      permissions,
      v8_code_cache: shared.code_cache.clone(),
      bundle_provider: shared.bundle_provider.clone(),
    };

    let maybe_initial_cwd = shared.options.maybe_initial_cwd.clone();

    let options = WorkerOptions {
      bootstrap: BootstrapOptions {
        deno_version: crate::version::DENO_VERSION_INFO.deno.to_string(),
        args: shared.options.argv.clone(),
        cpu_count: std::thread::available_parallelism()
          .map(|p| p.get())
          .unwrap_or(1),
        log_level: shared.options.log_level,
        enable_testing_features: shared.options.enable_testing_features,
        locale: deno_core::v8::icu::get_language_tag(),
        location: shared.options.location.clone(),
        color_level: colors::get_color_level(),
        unstable_features,
        user_agent: crate::version::DENO_VERSION_INFO.user_agent.to_string(),
        inspect: shared.options.is_inspecting,
        is_standalone: shared.options.is_standalone,
        auto_serve: shared.options.auto_serve,
        has_node_modules_dir: shared.options.has_node_modules_dir,
        argv0: shared.options.argv0.clone(),
        node_debug: shared.options.node_debug.clone(),
        node_cluster_unique_id: shared.options.node_cluster_unique_id.clone(),
        node_cluster_sched_policy: shared
          .options
          .node_cluster_sched_policy
          .clone(),
        node_ipc_init: shared.options.node_ipc_init,
        mode,
        no_legacy_abort: shared.options.no_legacy_abort,
        serve_port: shared.options.serve_port,
        serve_host: shared.options.serve_host.clone(),
        otel_config: shared.options.otel_config.clone(),
        close_on_idle: shared.options.close_on_idle,
        disable_offscreen_canvas: shared.options.disable_offscreen_canvas,
      },
      extensions: custom_extensions,
      startup_snapshot: shared.options.startup_snapshot,
      residual_lazy_js_sources: shared.options.residual_lazy_js_sources,
      residual_lazy_esm_sources: shared.options.residual_lazy_esm_sources,
      create_params: create_isolate_create_params(&shared.sys),
      unsafely_ignore_certificate_errors: shared
        .options
        .unsafely_ignore_certificate_errors
        .clone(),
      seed: shared.options.seed,
      format_js_error_fn: Some(Arc::new(move |e| {
        format_js_error(e, maybe_initial_cwd.as_ref())
      })),
      create_web_worker_cb: shared.create_web_worker_callback(stdio.clone()),
      should_break_on_first_statement: shared.options.inspect_brk,
      should_wait_for_inspector_session: shared.options.inspect_wait,
      trace_ops: shared.options.trace_ops.clone(),
      cache_storage_dir,
      origin_storage_dir,
      stdio,
      skip_op_registration: shared.options.skip_op_registration,
      enable_raw_imports: shared.options.enable_raw_imports,
      enable_stack_trace_arg_in_ops: has_trace_permissions_enabled(&shared.sys),
      unconfigured_runtime,
    };

    let mut worker =
      MainWorker::bootstrap_from_options(&main_module, services, options);
    worker.setup_memory_trim_handler();

    // Wire module hook registry into OpState so JS ops share it with the loader
    if let Some(registry) = hook_registry {
      worker.js_runtime.op_state().borrow_mut().put(registry);
    }

    // Store the main inspector session sender for worker debugging
    let inspector = worker.js_runtime.inspector();
    let session_tx = inspector.get_session_sender();
    shared.main_inspector_session_tx.set(session_tx);

    Ok(LibMainWorker {
      main_module,
      preload_modules,
      require_modules,
      worker,
    })
  }

  pub fn resolve_npm_binary_entrypoint(
    &self,
    package_folder: &Path,
    sub_path: Option<&str>,
  ) -> Result<Url, ResolveNpmBinaryEntrypointError> {
    match self
      .shared
      .node_resolver
      .resolve_binary_export(package_folder, sub_path)
    {
      Ok(bin_value) => Ok(url_from_file_path(bin_value.path())?),
      Err(original_err) => {
        // if the binary entrypoint was not found, fallback to regular node resolution
        let result =
          self.resolve_binary_entrypoint_fallback(package_folder, sub_path);
        match result {
          Ok(Some(path)) => Ok(url_from_file_path(&path)?),
          Ok(None) => Err(
            ResolveNpmBinaryEntrypointErrorKind::ResolvePkgJsonBinExport(
              original_err,
            )
            .into_box(),
          ),
          Err(fallback_err) => Err(
            ResolveNpmBinaryEntrypointErrorKind::Fallback {
              original: original_err,
              fallback: fallback_err,
            }
            .into_box(),
          ),
        }
      }
    }
  }

  /// resolve the binary entrypoint using regular node resolution
  fn resolve_binary_entrypoint_fallback(
    &self,
    package_folder: &Path,
    sub_path: Option<&str>,
  ) -> Result<Option<PathBuf>, ResolveNpmBinaryEntrypointFallbackError> {
    // only fallback if the user specified a sub path
    if sub_path.is_none() {
      // it's confusing to users if the package doesn't have any binary
      // entrypoint and we just execute the main script which will likely
      // have blank output, so do not resolve the entrypoint in this case
      return Ok(None);
    }

    let specifier = self
      .shared
      .node_resolver
      .resolve_package_subpath_from_deno_module(
        package_folder,
        sub_path,
        /* referrer */ None,
        node_resolver::ResolutionMode::Import,
        node_resolver::NodeResolutionKind::Execution,
      )
      .map_err(
        ResolveNpmBinaryEntrypointFallbackError::PackageSubpathResolve,
      )?;
    let path = match specifier {
      UrlOrPath::Url(ref url) => match url_to_file_path(url) {
        Ok(path) => path,
        Err(_) => {
          return Err(ResolveNpmBinaryEntrypointFallbackError::ModuleNotFound(
            specifier,
          ));
        }
      },
      UrlOrPath::Path(path) => path,
    };
    if self.shared.sys.fs_exists_no_err(&path) {
      Ok(Some(path))
    } else {
      Err(ResolveNpmBinaryEntrypointFallbackError::ModuleNotFound(
        UrlOrPath::Path(path),
      ))
    }
  }
}

pub struct LibMainWorker {
  main_module: Url,
  preload_modules: Vec<Url>,
  require_modules: Vec<Url>,
  worker: MainWorker,
}

impl LibMainWorker {
  pub fn into_main_worker(self) -> MainWorker {
    self.worker
  }

  pub fn main_module(&self) -> &Url {
    &self.main_module
  }

  pub fn js_runtime(&mut self) -> &mut JsRuntime {
    &mut self.worker.js_runtime
  }

  #[inline]
  pub fn create_inspector_session(
    &mut self,
    cb: deno_core::InspectorSessionSend,
  ) -> LocalInspectorSession {
    self.worker.create_inspector_session(cb)
  }

  #[inline]
  pub fn dispatch_load_event(&mut self) -> Result<(), Box<JsError>> {
    self.worker.dispatch_load_event()
  }

  #[inline]
  pub fn dispatch_beforeunload_event(&mut self) -> Result<bool, Box<JsError>> {
    self.worker.dispatch_beforeunload_event()
  }

  #[inline]
  pub fn dispatch_process_beforeexit_event(
    &mut self,
  ) -> Result<bool, Box<JsError>> {
    self.worker.dispatch_process_beforeexit_event()
  }

  #[inline]
  pub fn dispatch_unload_event(&mut self) -> Result<(), Box<JsError>> {
    self.worker.dispatch_unload_event()
  }

  #[inline]
  pub fn dispatch_process_exit_event(&mut self) -> Result<(), Box<JsError>> {
    self.worker.dispatch_process_exit_event()
  }

  #[inline]
  pub fn run_napi_ref_finalizers(&mut self) {
    self.worker.run_napi_ref_finalizers()
  }

  pub async fn execute_main_module(&mut self) -> Result<(), CoreError> {
    let id = self.worker.preload_main_module(&self.main_module).await?;
    self.worker.evaluate_module(id).await?;

    // After loading and evaluating all modules, trim the glibc malloc arena.
    // Module loading/TypeScript compilation creates heavy allocation churn
    // that glibc's allocator doesn't release back to the OS, causing RSS on
    // Linux to be much higher than on other platforms (see #25722).
    #[cfg(all(target_os = "linux", target_env = "gnu"))]
    {
      // SAFETY: calling libc malloc_trim which is safe to call at any time.
      unsafe {
        libc::malloc_trim(0);
      }
    }

    Ok(())
  }

  pub async fn execute_side_module(&mut self) -> Result<(), CoreError> {
    let id = self.worker.preload_side_module(&self.main_module).await?;
    self.worker.evaluate_module(id).await?;

    #[cfg(all(target_os = "linux", target_env = "gnu"))]
    {
      // SAFETY: calling libc malloc_trim which is safe to call at any time.
      unsafe {
        libc::malloc_trim(0);
      }
    }

    Ok(())
  }

  pub async fn execute_preload_modules(&mut self) -> Result<(), CoreError> {
    for preload_module_url in self.preload_modules.iter() {
      let id = self.worker.preload_side_module(preload_module_url).await?;
      self.worker.evaluate_module(id).await?;
      self.worker.run_event_loop(false).await?;
    }
    // Even though we load as ESM here, these files will be forced to be loaded as CJS
    // because of checks in get_known_mode_with_is_script
    for require_module_url in self.require_modules.iter() {
      let id = self.worker.preload_side_module(require_module_url).await?;
      self.worker.evaluate_module(id).await?;
      self.worker.run_event_loop(false).await?;
    }
    Ok(())
  }

  /// The "load phase": run any preload/require modules, then load and
  /// first-evaluate the main module and fire the `load` event. This is
  /// everything that happens before the steady-state event loop begins.
  ///
  /// It is factored out of [`Self::run`] so callers that need to treat
  /// load-phase failures differently from steady-state failures (the desktop
  /// runtime tags them as a `DesktopStartupError`) can wrap just this call
  /// without hand-copying the rest of `run`.
  pub async fn execute_load_phase(&mut self) -> Result<(), CoreError> {
    // Run preload modules first if they were defined
    self.execute_preload_modules().await?;

    self.execute_main_module().await?;
    self.worker.dispatch_load_event()?;

    Ok(())
  }

  /// The "loop phase" that follows [`Self::execute_load_phase`]: drive the
  /// event loop until the program is done, fire the unload / exit handlers,
  /// and return the process exit code.
  pub async fn run_event_loop_to_completion(
    &mut self,
  ) -> Result<i32, CoreError> {
    loop {
      self
        .worker
        .run_event_loop(/* wait for inspector */ false)
        .await?;

      let web_continue = self.worker.dispatch_beforeunload_event()?;
      if !web_continue {
        let node_continue = self.worker.dispatch_process_beforeexit_event()?;
        if !node_continue {
          break;
        }
      }
    }

    self.worker.dispatch_unload_event()?;
    self.worker.dispatch_process_exit_event()?;
    self.worker.run_napi_ref_finalizers();

    Ok(self.worker.exit_code())
  }

  pub async fn run(&mut self) -> Result<i32, CoreError> {
    log::debug!("main_module {}", self.main_module);

    self.execute_load_phase().await?;
    self.run_event_loop_to_completion().await
  }

  #[inline]
  pub async fn run_event_loop(
    &mut self,
    wait_for_inspector: bool,
  ) -> Result<(), CoreError> {
    self.worker.run_event_loop(wait_for_inspector).await
  }

  #[inline]
  pub fn exit_code(&self) -> i32 {
    self.worker.exit_code()
  }
}

#[cfg(test)]
mod test {
  use super::*;

  #[test]
  fn storage_key_resolver_test() {
    let resolver =
      StorageKeyResolver(StorageKeyResolverStrategy::UseMainModule);
    let specifier = Url::parse("file:///a.ts").unwrap();
    assert_eq!(
      resolver.resolve_storage_key(&specifier),
      Some(specifier.to_string())
    );
    let resolver =
      StorageKeyResolver(StorageKeyResolverStrategy::Specified(None));
    assert_eq!(resolver.resolve_storage_key(&specifier), None);
    let resolver = StorageKeyResolver(StorageKeyResolverStrategy::Specified(
      Some("value".to_string()),
    ));
    assert_eq!(
      resolver.resolve_storage_key(&specifier),
      Some("value".to_string())
    );

    // test empty
    let resolver = StorageKeyResolver::empty();
    assert_eq!(resolver.resolve_storage_key(&specifier), None);
  }

  #[test]
  fn cache_storage_dir_is_under_origin_data() {
    let origin_data_dir = PathBuf::from("deno_dir").join("location_data");
    let key = "file:///project/main.ts";

    assert_eq!(
      get_cache_storage_dir(&origin_data_dir),
      origin_data_dir.join("web_cache")
    );
    assert_eq!(
      get_cache_storage_dir_for_key(&origin_data_dir, key),
      origin_data_dir
        .join("web_cache")
        .join(checksum::r#gen(&[key.as_bytes()]))
    );
  }
}