// Copyright 2018-2021 the Deno authors. All rights reserved. MIT license. use crate::colors; use crate::inspector::DenoInspector; use crate::inspector::InspectorServer; use crate::js; use crate::metrics::RuntimeMetrics; use crate::ops; use crate::permissions::Permissions; use crate::tokio_util::create_basic_runtime; use deno_core::error::AnyError; use deno_core::error::Context as ErrorContext; use deno_core::futures::channel::mpsc; use deno_core::futures::future::poll_fn; use deno_core::futures::future::FutureExt; use deno_core::futures::stream::StreamExt; use deno_core::futures::task::AtomicWaker; use deno_core::serde_json; use deno_core::serde_json::json; use deno_core::url::Url; use deno_core::v8; use deno_core::GetErrorClassFn; use deno_core::JsErrorCreateFn; use deno_core::JsRuntime; use deno_core::ModuleLoader; use deno_core::ModuleSpecifier; use deno_core::RuntimeOptions; use deno_file::BlobUrlStore; use log::debug; use std::env; use std::rc::Rc; use std::sync::atomic::AtomicBool; use std::sync::atomic::Ordering; use std::sync::Arc; use std::task::Context; use std::task::Poll; use tokio::sync::Mutex as AsyncMutex; /// Events that are sent to host from child /// worker. pub enum WorkerEvent { Message(Box<[u8]>), Error(AnyError), TerminalError(AnyError), } pub struct WorkerChannelsInternal { pub sender: mpsc::Sender, pub receiver: mpsc::Receiver>, } /// Wrapper for `WorkerHandle` that adds functionality /// for terminating workers. /// /// This struct is used by host as well as worker itself. /// /// Host uses it to communicate with worker and terminate it, /// while worker uses it only to finish execution on `self.close()`. #[derive(Clone)] pub struct WebWorkerHandle { pub sender: mpsc::Sender>, pub receiver: Arc>>, terminate_tx: mpsc::Sender<()>, terminated: Arc, isolate_handle: v8::IsolateHandle, } impl WebWorkerHandle { /// Post message to worker as a host. pub fn post_message(&self, buf: Box<[u8]>) -> Result<(), AnyError> { let mut sender = self.sender.clone(); // If the channel is closed, // the worker must have terminated but the termination message has not yet been recieved. // // Therefore just treat it as if the worker has terminated and return. if sender.is_closed() { self.terminated.store(true, Ordering::SeqCst); return Ok(()); } sender.try_send(buf)?; Ok(()) } /// Get the event with lock. /// Return error if more than one listener tries to get event pub async fn get_event(&self) -> Result, AnyError> { let mut receiver = self.receiver.try_lock()?; Ok(receiver.next().await) } pub fn terminate(&self) { // This function can be called multiple times by whomever holds // the handle. However only a single "termination" should occur so // we need a guard here. let already_terminated = self.terminated.swap(true, Ordering::SeqCst); if !already_terminated { self.isolate_handle.terminate_execution(); let mut sender = self.terminate_tx.clone(); // This call should be infallible hence the `expect`. // This might change in the future. sender.try_send(()).expect("Failed to terminate"); } } } fn create_channels( isolate_handle: v8::IsolateHandle, terminate_tx: mpsc::Sender<()>, ) -> (WorkerChannelsInternal, WebWorkerHandle) { let (in_tx, in_rx) = mpsc::channel::>(1); let (out_tx, out_rx) = mpsc::channel::(1); let internal_channels = WorkerChannelsInternal { sender: out_tx, receiver: in_rx, }; let external_channels = WebWorkerHandle { sender: in_tx, receiver: Arc::new(AsyncMutex::new(out_rx)), terminated: Arc::new(AtomicBool::new(false)), terminate_tx, isolate_handle, }; (internal_channels, external_channels) } /// This struct is an implementation of `Worker` Web API /// /// Each `WebWorker` is either a child of `MainWorker` or other /// `WebWorker`. pub struct WebWorker { id: u32, inspector: Option>, // Following fields are pub because they are accessed // when creating a new WebWorker instance. pub(crate) internal_channels: WorkerChannelsInternal, pub js_runtime: JsRuntime, pub name: String, waker: AtomicWaker, event_loop_idle: bool, terminate_rx: mpsc::Receiver<()>, handle: WebWorkerHandle, pub use_deno_namespace: bool, pub main_module: ModuleSpecifier, } pub struct WebWorkerOptions { /// Sets `Deno.args` in JS runtime. pub args: Vec, pub debug_flag: bool, pub unstable: bool, pub ca_data: Option>, pub user_agent: String, pub seed: Option, pub module_loader: Rc, pub create_web_worker_cb: Arc, pub js_error_create_fn: Option>, pub use_deno_namespace: bool, pub attach_inspector: bool, pub maybe_inspector_server: Option>, pub apply_source_maps: bool, /// Sets `Deno.version.deno` in JS runtime. pub runtime_version: String, /// Sets `Deno.version.typescript` in JS runtime. pub ts_version: String, /// Sets `Deno.noColor` in JS runtime. pub no_color: bool, pub get_error_class_fn: Option, pub blob_url_store: BlobUrlStore, } impl WebWorker { pub fn from_options( name: String, permissions: Permissions, main_module: ModuleSpecifier, worker_id: u32, options: &WebWorkerOptions, ) -> Self { let mut js_runtime = JsRuntime::new(RuntimeOptions { module_loader: Some(options.module_loader.clone()), startup_snapshot: Some(js::deno_isolate_init()), js_error_create_fn: options.js_error_create_fn.clone(), get_error_class_fn: options.get_error_class_fn, ..Default::default() }); let inspector = if options.attach_inspector { Some(DenoInspector::new( &mut js_runtime, options.maybe_inspector_server.clone(), )) } else { None }; let (terminate_tx, terminate_rx) = mpsc::channel::<()>(1); let isolate_handle = js_runtime.v8_isolate().thread_safe_handle(); let (internal_channels, handle) = create_channels(isolate_handle, terminate_tx); let mut worker = Self { id: worker_id, inspector, internal_channels, js_runtime, name, waker: AtomicWaker::new(), event_loop_idle: false, terminate_rx, handle, use_deno_namespace: options.use_deno_namespace, main_module: main_module.clone(), }; { let handle = worker.thread_safe_handle(); let sender = worker.internal_channels.sender.clone(); let js_runtime = &mut worker.js_runtime; // All ops registered in this function depend on these { let op_state = js_runtime.op_state(); let mut op_state = op_state.borrow_mut(); op_state.put(RuntimeMetrics::default()); op_state.put::(permissions); op_state.put(ops::UnstableChecker { unstable: options.unstable, }); } ops::web_worker::init(js_runtime, sender.clone(), handle); ops::runtime::init(js_runtime, main_module.clone()); ops::fetch::init( js_runtime, options.user_agent.clone(), options.ca_data.clone(), ); ops::timers::init(js_runtime); ops::worker_host::init( js_runtime, Some(sender), options.create_web_worker_cb.clone(), ); ops::reg_sync(js_runtime, "op_close", deno_core::op_close); ops::reg_sync(js_runtime, "op_resources", deno_core::op_resources); ops::url::init(js_runtime); ops::file::init( js_runtime, options.blob_url_store.clone(), Some(main_module), ); ops::io::init(js_runtime); ops::webgpu::init(js_runtime); ops::websocket::init( js_runtime, options.user_agent.clone(), options.ca_data.clone(), ); ops::crypto::init(js_runtime, options.seed); if options.use_deno_namespace { ops::fs_events::init(js_runtime); ops::fs::init(js_runtime); ops::net::init(js_runtime); ops::os::init(js_runtime); ops::http::init(js_runtime); ops::permissions::init(js_runtime); ops::plugin::init(js_runtime); ops::process::init(js_runtime); ops::signal::init(js_runtime); ops::tls::init(js_runtime); ops::tty::init(js_runtime); let op_state = js_runtime.op_state(); let mut op_state = op_state.borrow_mut(); let t = &mut op_state.resource_table; let (stdin, stdout, stderr) = ops::io::get_stdio(); if let Some(stream) = stdin { t.add(stream); } if let Some(stream) = stdout { t.add(stream); } if let Some(stream) = stderr { t.add(stream); } } worker } } pub fn bootstrap(&mut self, options: &WebWorkerOptions) { let runtime_options = json!({ "args": options.args, "applySourceMaps": options.apply_source_maps, "debugFlag": options.debug_flag, "denoVersion": options.runtime_version, "noColor": options.no_color, "pid": std::process::id(), "ppid": ops::runtime::ppid(), "target": env!("TARGET"), "tsVersion": options.ts_version, "unstableFlag": options.unstable, "v8Version": deno_core::v8_version(), "location": self.main_module, }); let runtime_options_str = serde_json::to_string_pretty(&runtime_options).unwrap(); // Instead of using name for log we use `worker-${id}` because // WebWorkers can have empty string as name. let script = format!( "bootstrap.workerRuntime({}, \"{}\", {}, \"worker-{}\")", runtime_options_str, self.name, options.use_deno_namespace, self.id ); self .execute(&script) .expect("Failed to execute worker bootstrap script"); } /// Same as execute2() but the filename defaults to "$CWD/__anonymous__". pub fn execute(&mut self, js_source: &str) -> Result<(), AnyError> { let path = env::current_dir() .context("Failed to get current working directory")? .join("__anonymous__"); let url = Url::from_file_path(path).unwrap(); self.js_runtime.execute(url.as_str(), js_source) } /// Loads, instantiates and executes specified JavaScript module. pub async fn execute_module( &mut self, module_specifier: &ModuleSpecifier, ) -> Result<(), AnyError> { let id = self.js_runtime.load_module(module_specifier, None).await?; let mut receiver = self.js_runtime.mod_evaluate(id); tokio::select! { maybe_result = receiver.next() => { debug!("received worker module evaluate {:#?}", maybe_result); // If `None` is returned it means that runtime was destroyed before // evaluation was complete. This can happen in Web Worker when `self.close()` // is called at top level. let result = maybe_result.unwrap_or(Ok(())); return result; } event_loop_result = self.run_event_loop() => { if self.has_been_terminated() { return Ok(()); } event_loop_result?; let maybe_result = receiver.next().await; let result = maybe_result.unwrap_or(Ok(())); return result; } } } /// Returns a way to communicate with the Worker from other threads. pub fn thread_safe_handle(&self) -> WebWorkerHandle { self.handle.clone() } pub fn has_been_terminated(&self) -> bool { self.handle.terminated.load(Ordering::SeqCst) } pub fn poll_event_loop( &mut self, cx: &mut Context, ) -> Poll> { if self.has_been_terminated() { return Poll::Ready(Ok(())); } if !self.event_loop_idle { let poll_result = { // We always poll the inspector if it exists. let _ = self.inspector.as_mut().map(|i| i.poll_unpin(cx)); self.waker.register(cx.waker()); self.js_runtime.poll_event_loop(cx) }; if let Poll::Ready(r) = poll_result { if self.has_been_terminated() { return Poll::Ready(Ok(())); } if let Err(e) = r { print_worker_error(e.to_string(), &self.name); let mut sender = self.internal_channels.sender.clone(); sender .try_send(WorkerEvent::Error(e)) .expect("Failed to post message to host"); } self.event_loop_idle = true; } } if let Poll::Ready(r) = self.terminate_rx.poll_next_unpin(cx) { // terminate_rx should never be closed assert!(r.is_some()); return Poll::Ready(Ok(())); } let maybe_msg_poll_result = self.internal_channels.receiver.poll_next_unpin(cx); if let Poll::Ready(maybe_msg) = maybe_msg_poll_result { let msg = maybe_msg.expect("Received `None` instead of message in worker"); let msg = String::from_utf8(msg.to_vec()).unwrap(); let script = format!("workerMessageRecvCallback({})", msg); // TODO(bartlomieju): set proper script name like "deno:runtime/web_worker.js" // so it's dimmed in stack trace instead of using "__anonymous__" if let Err(e) = self.execute(&script) { // If execution was terminated during message callback then // just ignore it if self.has_been_terminated() { return Poll::Ready(Ok(())); } // Otherwise forward error to host let mut sender = self.internal_channels.sender.clone(); sender .try_send(WorkerEvent::Error(e)) .expect("Failed to post message to host"); } // Let event loop be polled again self.event_loop_idle = false; self.waker.wake(); } Poll::Pending } pub async fn run_event_loop(&mut self) -> Result<(), AnyError> { poll_fn(|cx| self.poll_event_loop(cx)).await } } impl Drop for WebWorker { fn drop(&mut self) { // The Isolate object must outlive the Inspector object, but this is // currently not enforced by the type system. self.inspector.take(); } } fn print_worker_error(error_str: String, name: &str) { eprintln!( "{}: Uncaught (in worker \"{}\") {}", colors::red_bold("error"), name, error_str.trim_start_matches("Uncaught "), ); } /// This function should be called from a thread dedicated to this worker. // TODO(bartlomieju): check if order of actions is aligned to Worker spec pub fn run_web_worker( mut worker: WebWorker, specifier: ModuleSpecifier, maybe_source_code: Option, ) -> Result<(), AnyError> { let name = worker.name.to_string(); let rt = create_basic_runtime(); // TODO(bartlomieju): run following block using "select!" // with terminate // Execute provided source code immediately let result = if let Some(source_code) = maybe_source_code { worker.execute(&source_code) } else { // TODO(bartlomieju): add "type": "classic", ie. ability to load // script instead of module let load_future = worker.execute_module(&specifier).boxed_local(); rt.block_on(load_future) }; let mut sender = worker.internal_channels.sender.clone(); // If sender is closed it means that worker has already been closed from // within using "globalThis.close()" if sender.is_closed() { return Ok(()); } if let Err(e) = result { print_worker_error(e.to_string(), &name); sender .try_send(WorkerEvent::TerminalError(e)) .expect("Failed to post message to host"); // Failure to execute script is a terminal error, bye, bye. return Ok(()); } let result = rt.block_on(worker.run_event_loop()); debug!("Worker thread shuts down {}", &name); result } #[cfg(test)] mod tests { use super::*; use crate::tokio_util; use deno_core::serde_json::json; fn create_test_web_worker() -> WebWorker { let main_module = deno_core::resolve_url_or_path("./hello.js").unwrap(); let module_loader = Rc::new(deno_core::NoopModuleLoader); let create_web_worker_cb = Arc::new(|_| unreachable!()); let options = WebWorkerOptions { args: vec![], apply_source_maps: false, debug_flag: false, unstable: false, ca_data: None, user_agent: "x".to_string(), seed: None, module_loader, create_web_worker_cb, js_error_create_fn: None, use_deno_namespace: false, attach_inspector: false, maybe_inspector_server: None, runtime_version: "x".to_string(), ts_version: "x".to_string(), no_color: true, get_error_class_fn: None, blob_url_store: BlobUrlStore::default(), }; let mut worker = WebWorker::from_options( "TEST".to_string(), Permissions::allow_all(), main_module, 1, &options, ); worker.bootstrap(&options); worker } #[tokio::test] async fn test_worker_messages() { let (handle_sender, handle_receiver) = std::sync::mpsc::sync_channel::(1); let join_handle = std::thread::spawn(move || { let mut worker = create_test_web_worker(); let source = r#" onmessage = function(e) { console.log("msg from main script", e.data); if (e.data == "exit") { return close(); } else { console.assert(e.data === "hi"); } postMessage([1, 2, 3]); console.log("after postMessage"); } "#; worker.execute(source).unwrap(); let handle = worker.thread_safe_handle(); handle_sender.send(handle).unwrap(); let r = tokio_util::run_basic(worker.run_event_loop()); assert!(r.is_ok()) }); let mut handle = handle_receiver.recv().unwrap(); let msg = json!("hi").to_string().into_boxed_str().into_boxed_bytes(); let r = handle.post_message(msg.clone()); assert!(r.is_ok()); let maybe_msg = handle.get_event().await.unwrap(); assert!(maybe_msg.is_some()); let r = handle.post_message(msg.clone()); assert!(r.is_ok()); let maybe_msg = handle.get_event().await.unwrap(); assert!(maybe_msg.is_some()); match maybe_msg { Some(WorkerEvent::Message(buf)) => { assert_eq!(*buf, *b"[1,2,3]"); } _ => unreachable!(), } let msg = json!("exit") .to_string() .into_boxed_str() .into_boxed_bytes(); let r = handle.post_message(msg); assert!(r.is_ok()); let event = handle.get_event().await.unwrap(); assert!(event.is_none()); handle.sender.close_channel(); join_handle.join().expect("Failed to join worker thread"); } #[tokio::test] async fn removed_from_resource_table_on_close() { let (handle_sender, handle_receiver) = std::sync::mpsc::sync_channel::(1); let join_handle = std::thread::spawn(move || { let mut worker = create_test_web_worker(); worker.execute("onmessage = () => { close(); }").unwrap(); let handle = worker.thread_safe_handle(); handle_sender.send(handle).unwrap(); let r = tokio_util::run_basic(worker.run_event_loop()); assert!(r.is_ok()) }); let mut handle = handle_receiver.recv().unwrap(); let msg = json!("hi").to_string().into_boxed_str().into_boxed_bytes(); let r = handle.post_message(msg.clone()); assert!(r.is_ok()); let event = handle.get_event().await.unwrap(); assert!(event.is_none()); handle.sender.close_channel(); join_handle.join().expect("Failed to join worker thread"); } }