/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at https://mozilla.org/MPL/2.0/. */ use std::cell::Cell; use std::sync::Arc; use std::sync::atomic::{AtomicBool, Ordering}; use constellation_traits::{StructuredSerializedData, WorkerScriptLoadOrigin}; use crossbeam_channel::{Sender, unbounded}; use devtools_traits::{DevtoolsPageInfo, ScriptToDevtoolsControlMsg, WorkerId}; use dom_struct::dom_struct; use ipc_channel::ipc; use js::jsapi::{Heap, JSObject}; use js::jsval::UndefinedValue; use js::rust::{CustomAutoRooter, CustomAutoRooterGuard, HandleObject, HandleValue}; use net_traits::request::Referrer; use uuid::Uuid; use crate::dom::abstractworker::{SimpleWorkerErrorHandler, WorkerScriptMsg}; use crate::dom::bindings::cell::DomRefCell; use crate::dom::bindings::codegen::Bindings::MessagePortBinding::StructuredSerializeOptions; use crate::dom::bindings::codegen::Bindings::WorkerBinding::{WorkerMethods, WorkerOptions}; use crate::dom::bindings::error::{Error, ErrorResult, Fallible}; use crate::dom::bindings::inheritance::Castable; use crate::dom::bindings::refcounted::Trusted; use crate::dom::bindings::reflector::{DomGlobal, reflect_dom_object_with_proto}; use crate::dom::bindings::root::DomRoot; use crate::dom::bindings::str::USVString; use crate::dom::bindings::structuredclone; use crate::dom::bindings::trace::{CustomTraceable, RootedTraceableBox}; use crate::dom::dedicatedworkerglobalscope::{ DedicatedWorkerGlobalScope, DedicatedWorkerScriptMsg, }; use crate::dom::eventtarget::EventTarget; use crate::dom::globalscope::GlobalScope; use crate::dom::messageevent::MessageEvent; use crate::dom::window::Window; use crate::dom::workerglobalscope::prepare_workerscope_init; use crate::realms::enter_realm; use crate::script_runtime::{CanGc, JSContext, ThreadSafeJSContext}; use crate::task::TaskOnce; pub(crate) type TrustedWorkerAddress = Trusted; // https://html.spec.whatwg.org/multipage/#worker #[dom_struct] pub(crate) struct Worker { eventtarget: EventTarget, /// Sender to the Receiver associated with the DedicatedWorkerGlobalScope /// this Worker created. sender: Sender, #[ignore_malloc_size_of = "Arc"] closing: Arc, terminated: Cell, #[ignore_malloc_size_of = "Arc"] #[no_trace] context_for_interrupt: DomRefCell>, } impl Worker { fn new_inherited(sender: Sender, closing: Arc) -> Worker { Worker { eventtarget: EventTarget::new_inherited(), sender, closing, terminated: Cell::new(false), context_for_interrupt: Default::default(), } } fn new( global: &GlobalScope, proto: Option, sender: Sender, closing: Arc, can_gc: CanGc, ) -> DomRoot { reflect_dom_object_with_proto( Box::new(Worker::new_inherited(sender, closing)), global, proto, can_gc, ) } pub(crate) fn is_terminated(&self) -> bool { self.terminated.get() } pub(crate) fn set_context_for_interrupt(&self, cx: ThreadSafeJSContext) { assert!( self.context_for_interrupt.borrow().is_none(), "Context for interrupt must be set only once" ); *self.context_for_interrupt.borrow_mut() = Some(cx); } pub(crate) fn handle_message( address: TrustedWorkerAddress, data: StructuredSerializedData, can_gc: CanGc, ) { let worker = address.root(); if worker.is_terminated() { return; } let global = worker.global(); let target = worker.upcast(); let _ac = enter_realm(target); rooted!(in(*GlobalScope::get_cx()) let mut message = UndefinedValue()); if let Ok(ports) = structuredclone::read(&global, data, message.handle_mut()) { MessageEvent::dispatch_jsval( target, &global, message.handle(), None, None, ports, can_gc, ); } else { // Step 4 of the "port post message steps" of the implicit messageport, fire messageerror. MessageEvent::dispatch_error(target, &global, can_gc); } } pub(crate) fn dispatch_simple_error(address: TrustedWorkerAddress, can_gc: CanGc) { let worker = address.root(); worker.upcast().fire_event(atom!("error"), can_gc); } /// fn post_message_impl( &self, cx: JSContext, message: HandleValue, transfer: CustomAutoRooterGuard>, ) -> ErrorResult { let data = structuredclone::write(cx, message, Some(transfer))?; let address = Trusted::new(self); // NOTE: step 9 of https://html.spec.whatwg.org/multipage/#dom-messageport-postmessage // indicates that a nonexistent communication channel should result in a silent error. let _ = self.sender.send(DedicatedWorkerScriptMsg::CommonWorker( address, WorkerScriptMsg::DOMMessage { origin: self.global().origin().immutable().clone(), data: Box::new(data), }, )); Ok(()) } } impl WorkerMethods for Worker { // https://html.spec.whatwg.org/multipage/#dom-worker #[allow(unsafe_code)] fn Constructor( global: &GlobalScope, proto: Option, can_gc: CanGc, script_url: USVString, worker_options: &WorkerOptions, ) -> Fallible> { // Step 2-4. let worker_url = match global.api_base_url().join(&script_url) { Ok(url) => url, Err(_) => return Err(Error::Syntax), }; let (sender, receiver) = unbounded(); let closing = Arc::new(AtomicBool::new(false)); let worker = Worker::new(global, proto, sender.clone(), closing.clone(), can_gc); let worker_ref = Trusted::new(&*worker); let worker_load_origin = WorkerScriptLoadOrigin { referrer_url: match global.get_referrer() { Referrer::Client(url) => Some(url), Referrer::ReferrerUrl(url) => Some(url), _ => None, }, referrer_policy: global.get_referrer_policy(), pipeline_id: global.pipeline_id(), }; let webview_id = global.webview_id().expect("global must have a webview id"); let browsing_context = global .downcast::() .map(|w| w.window_proxy().browsing_context_id()) .or_else(|| { global .downcast::() .and_then(|w| w.browsing_context()) }); let (devtools_sender, devtools_receiver) = ipc::channel().unwrap(); let worker_id = WorkerId(Uuid::new_v4()); if let Some(chan) = global.devtools_chan() { let pipeline_id = global.pipeline_id(); let title = format!("Worker for {}", worker_url); if let Some(browsing_context) = browsing_context { let page_info = DevtoolsPageInfo { title, url: worker_url.clone(), is_top_level_global: false, }; let _ = chan.send(ScriptToDevtoolsControlMsg::NewGlobal( (browsing_context, pipeline_id, Some(worker_id), webview_id), devtools_sender.clone(), page_info, )); } } let init = prepare_workerscope_init(global, Some(devtools_sender), Some(worker_id)); let (control_sender, control_receiver) = unbounded(); let (context_sender, context_receiver) = unbounded(); let event_loop_sender = global .event_loop_sender() .expect("Tried to create a worker in a worker while not handling a message?"); let join_handle = DedicatedWorkerGlobalScope::run_worker_scope( init, worker_url, devtools_receiver, worker_ref, event_loop_sender, sender, receiver, worker_load_origin, String::from(&*worker_options.name), worker_options.type_, closing.clone(), global.image_cache(), browsing_context, #[cfg(feature = "webgpu")] global.wgpu_id_hub(), control_receiver, context_sender, global.insecure_requests_policy(), global.policy_container(), ); let context = context_receiver .recv() .expect("Couldn't receive a context for worker."); worker.set_context_for_interrupt(context.clone()); global.track_worker(closing, join_handle, control_sender, context); Ok(worker) } /// fn PostMessage( &self, cx: JSContext, message: HandleValue, transfer: CustomAutoRooterGuard>, ) -> ErrorResult { self.post_message_impl(cx, message, transfer) } /// fn PostMessage_( &self, cx: JSContext, message: HandleValue, options: RootedTraceableBox, ) -> ErrorResult { let mut rooted = CustomAutoRooter::new( options .transfer .iter() .map(|js: &RootedTraceableBox>| js.get()) .collect(), ); let guard = CustomAutoRooterGuard::new(*cx, &mut rooted); self.post_message_impl(cx, message, guard) } // https://html.spec.whatwg.org/multipage/#terminate-a-worker fn Terminate(&self) { // Step 1 if self.closing.swap(true, Ordering::SeqCst) { return; } // Step 2 self.terminated.set(true); // Step 3 if let Some(cx) = self.context_for_interrupt.borrow().as_ref() { cx.request_interrupt_callback() } } // https://html.spec.whatwg.org/multipage/#handler-worker-onmessage event_handler!(message, GetOnmessage, SetOnmessage); // https://html.spec.whatwg.org/multipage/#handler-worker-onmessageerror event_handler!(messageerror, GetOnmessageerror, SetOnmessageerror); // https://html.spec.whatwg.org/multipage/#handler-workerglobalscope-onerror event_handler!(error, GetOnerror, SetOnerror); } impl TaskOnce for SimpleWorkerErrorHandler { #[cfg_attr(crown, allow(crown::unrooted_must_root))] fn run_once(self) { Worker::dispatch_simple_error(self.addr, CanGc::note()); } }