script/dom/workers/
worker.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use std::cell::Cell;
6use std::sync::Arc;
7use std::sync::atomic::{AtomicBool, Ordering};
8
9use crossbeam_channel::{Sender, unbounded};
10use devtools_traits::{DevtoolsPageInfo, ScriptToDevtoolsControlMsg, WorkerId};
11use dom_struct::dom_struct;
12use js::context::JSContext;
13use js::jsapi::{Heap, JSObject};
14use js::jsval::UndefinedValue;
15use js::rust::{CustomAutoRooter, CustomAutoRooterGuard, HandleObject, HandleValue};
16use net_traits::request::Referrer;
17use script_bindings::cell::DomRefCell;
18use script_bindings::reflector::reflect_dom_object_with_proto;
19use servo_base::generic_channel;
20use servo_constellation_traits::{StructuredSerializedData, WorkerScriptLoadOrigin};
21use uuid::Uuid;
22
23use crate::dom::abstractworker::{MessageData, SimpleWorkerErrorHandler, WorkerScriptMsg};
24use crate::dom::bindings::codegen::Bindings::MessagePortBinding::StructuredSerializeOptions;
25use crate::dom::bindings::codegen::Bindings::WorkerBinding::{WorkerMethods, WorkerOptions};
26use crate::dom::bindings::codegen::UnionTypes::TrustedScriptURLOrUSVString;
27use crate::dom::bindings::error::{Error, ErrorResult, Fallible};
28use crate::dom::bindings::inheritance::Castable;
29use crate::dom::bindings::refcounted::Trusted;
30use crate::dom::bindings::reflector::DomGlobal;
31use crate::dom::bindings::root::DomRoot;
32use crate::dom::bindings::structuredclone;
33use crate::dom::bindings::trace::{CustomTraceable, RootedTraceableBox};
34use crate::dom::dedicatedworkerglobalscope::{
35    DedicatedWorkerGlobalScope, DedicatedWorkerScriptMsg,
36};
37use crate::dom::eventtarget::EventTarget;
38use crate::dom::globalscope::GlobalScope;
39use crate::dom::messageevent::MessageEvent;
40use crate::dom::sharedworkerglobalscope::SharedWorkerGlobalScope;
41use crate::dom::trustedtypes::trustedscripturl::TrustedScriptURL;
42use crate::dom::window::Window;
43use crate::dom::workerglobalscope::prepare_workerscope_init;
44use crate::realms::enter_auto_realm;
45use crate::script_runtime::ThreadSafeJSContext;
46use crate::tasks::task::TaskOnce;
47use crate::url::ensure_blob_referenced_by_url_is_kept_alive;
48
49pub(crate) type TrustedWorkerAddress = Trusted<Worker>;
50
51// https://html.spec.whatwg.org/multipage/#worker
52#[dom_struct]
53pub(crate) struct Worker {
54    eventtarget: EventTarget,
55    /// Sender to the Receiver associated with the DedicatedWorkerGlobalScope
56    /// this Worker created.
57    sender: Sender<DedicatedWorkerScriptMsg>,
58    #[conditional_malloc_size_of]
59    closing: Arc<AtomicBool>,
60    terminated: Cell<bool>,
61    #[ignore_malloc_size_of = "mozjs"]
62    #[no_trace]
63    context_for_interrupt: DomRefCell<Option<ThreadSafeJSContext>>,
64}
65
66impl Worker {
67    fn new_inherited(sender: Sender<DedicatedWorkerScriptMsg>, closing: Arc<AtomicBool>) -> Worker {
68        Worker {
69            eventtarget: EventTarget::new_inherited(),
70            sender,
71            closing,
72            terminated: Cell::new(false),
73            context_for_interrupt: Default::default(),
74        }
75    }
76
77    fn new(
78        cx: &mut JSContext,
79        global: &GlobalScope,
80        proto: Option<HandleObject>,
81        sender: Sender<DedicatedWorkerScriptMsg>,
82        closing: Arc<AtomicBool>,
83    ) -> DomRoot<Worker> {
84        reflect_dom_object_with_proto(
85            cx,
86            Box::new(Worker::new_inherited(sender, closing)),
87            global,
88            proto,
89        )
90    }
91
92    pub(crate) fn is_terminated(&self) -> bool {
93        self.terminated.get()
94    }
95
96    pub(crate) fn set_context_for_interrupt(&self, cx: ThreadSafeJSContext) {
97        assert!(
98            self.context_for_interrupt.borrow().is_none(),
99            "Context for interrupt must be set only once"
100        );
101        *self.context_for_interrupt.borrow_mut() = Some(cx);
102    }
103
104    pub(crate) fn handle_message(
105        address: TrustedWorkerAddress,
106        data: StructuredSerializedData,
107        cx: &mut JSContext,
108    ) {
109        let worker = address.root();
110
111        if worker.is_terminated() {
112            return;
113        }
114
115        let global = worker.global();
116        let target = worker.upcast();
117        let mut realm = enter_auto_realm(cx, target);
118        let cx = &mut realm.current_realm();
119        rooted!(&in(cx) let mut message = UndefinedValue());
120        if let Ok(ports) = structuredclone::read(cx, &global, data, message.handle_mut()) {
121            MessageEvent::dispatch_jsval(cx, target, &global, message.handle(), None, None, ports);
122        } else {
123            // Step 4 of the "port post message steps" of the implicit messageport, fire messageerror.
124            MessageEvent::dispatch_error(cx, target, &global);
125        }
126    }
127
128    pub(crate) fn dispatch_simple_error(
129        cx: &mut js::context::JSContext,
130        address: TrustedWorkerAddress,
131    ) {
132        let worker = address.root();
133        worker.upcast().fire_event(cx, atom!("error"));
134    }
135
136    /// <https://html.spec.whatwg.org/multipage/#dom-dedicatedworkerglobalscope-postmessage>
137    fn post_message_impl(
138        &self,
139        cx: &mut JSContext,
140        message: HandleValue,
141        transfer: CustomAutoRooterGuard<Vec<*mut JSObject>>,
142    ) -> ErrorResult {
143        let data = structuredclone::write(cx, message, Some(transfer))?;
144        let address = Trusted::new(self);
145
146        // NOTE: step 9 of https://html.spec.whatwg.org/multipage/#dom-messageport-postmessage
147        // indicates that a nonexistent communication channel should result in a silent error.
148        let _ = self.sender.send(DedicatedWorkerScriptMsg::CommonWorker(
149            address,
150            WorkerScriptMsg::DOMMessage(MessageData {
151                origin: self.global().origin().immutable().clone(),
152                pipeline_id: self.global().pipeline_id(),
153                data: Box::new(data),
154            }),
155        ));
156        Ok(())
157    }
158}
159
160impl WorkerMethods<crate::DomTypeHolder> for Worker {
161    /// <https://html.spec.whatwg.org/multipage/#dom-worker>
162    fn Constructor(
163        cx: &mut JSContext,
164        global: &GlobalScope,
165        proto: Option<HandleObject>,
166        script_url: TrustedScriptURLOrUSVString,
167        worker_options: &WorkerOptions,
168    ) -> Fallible<DomRoot<Worker>> {
169        // Step 1: Let compliantScriptURL be the result of invoking the
170        // Get Trusted Type compliant string algorithm with TrustedScriptURL,
171        // this's relevant global object, scriptURL, "Worker constructor", and "script".
172        let compliant_script_url = TrustedScriptURL::get_trusted_type_compliant_string(
173            cx,
174            global,
175            script_url,
176            "Worker constructor",
177        )?;
178        // Step 2. Let outsideSettings be this's relevant settings object.
179        // Step 3. Let workerURL be the result of encoding-parsing a URL given compliantScriptURL,
180        // relative to outsideSettings.
181        // TODO: Locking the URL should eventually happen inside encoding_parse_a_url, since most callers
182        // will expect their blobs to be kept alive...
183        let Ok(worker_url) = global
184            .encoding_parse_a_url(&compliant_script_url.str())
185            .map(|url| ensure_blob_referenced_by_url_is_kept_alive(global, url))
186        else {
187            // Step 4. If workerURL is failure, then throw a "SyntaxError" DOMException.
188            return Err(Error::Syntax(None));
189        };
190
191        let (sender, receiver) = unbounded();
192        let closing = Arc::new(AtomicBool::new(false));
193        let worker = Worker::new(cx, global, proto, sender.clone(), closing.clone());
194        let worker_ref = Trusted::new(&*worker);
195
196        let worker_load_origin = WorkerScriptLoadOrigin {
197            referrer_url: match global.get_referrer() {
198                Referrer::Client(url) => Some(url),
199                Referrer::ReferrerUrl(url) => Some(url),
200                _ => None,
201            },
202            referrer_policy: global.get_referrer_policy(),
203            pipeline_id: global.pipeline_id(),
204        };
205
206        let webview_id = global
207            .webview_id()
208            .expect("Global object must have a WebViewId");
209        let browsing_context = global
210            .downcast::<Window>()
211            .map(|w| w.window_proxy().browsing_context_id())
212            .or_else(|| {
213                global
214                    .downcast::<DedicatedWorkerGlobalScope>()
215                    .and_then(|w| w.browsing_context())
216                    .or_else(|| {
217                        global
218                            .downcast::<SharedWorkerGlobalScope>()
219                            .and_then(|w| w.browsing_context())
220                    })
221            });
222
223        let (devtools_sender, devtools_receiver) = generic_channel::channel().unwrap();
224        let worker_id = WorkerId(Uuid::new_v4());
225        if let Some(chan) = global.devtools_chan() {
226            let pipeline_id = global.pipeline_id();
227            let title = format!("Worker for {}", worker_url.url());
228            if let Some(browsing_context) = browsing_context {
229                let page_info = DevtoolsPageInfo {
230                    title,
231                    url: worker_url.url(),
232                    is_top_level_global: false,
233                    is_service_worker: false,
234                };
235                let _ = chan.send(ScriptToDevtoolsControlMsg::NewGlobal(
236                    (browsing_context, pipeline_id, Some(worker_id), webview_id),
237                    devtools_sender.clone(),
238                    page_info,
239                ));
240            }
241        }
242
243        #[cfg(feature = "webgl")]
244        let webgl_chan = global
245            .downcast::<Window>()
246            .and_then(|window| window.webgl_chan_value());
247        let init = prepare_workerscope_init(
248            global,
249            Some(devtools_sender),
250            Some(worker_id),
251            #[cfg(feature = "webgl")]
252            webgl_chan,
253        );
254        let animation_frame_provider_supported = global
255            .downcast::<DedicatedWorkerGlobalScope>()
256            .map(|worker| worker.animation_frame_provider_supported_flag())
257            .unwrap_or_else(|| Arc::new(AtomicBool::new(init.animation_frame_provider_supported)));
258
259        let (control_sender, control_receiver) = unbounded();
260        let (context_sender, context_receiver) = unbounded();
261
262        let event_loop_sender = global
263            .event_loop_sender()
264            .expect("Tried to create a worker in a worker while not handling a message?");
265        let join_handle = DedicatedWorkerGlobalScope::run_worker_scope(
266            init,
267            webview_id,
268            worker_url,
269            devtools_receiver,
270            worker_ref,
271            event_loop_sender,
272            sender,
273            receiver,
274            worker_load_origin,
275            worker_options,
276            closing.clone(),
277            animation_frame_provider_supported.clone(),
278            global.image_cache(),
279            browsing_context,
280            #[cfg(feature = "webgpu")]
281            global.wgpu_id_hub(),
282            control_receiver,
283            context_sender,
284            global.insecure_requests_policy(),
285            global.policy_container(),
286            global.font_context(),
287        );
288
289        let context = context_receiver
290            .recv()
291            .expect("Couldn't receive a context for worker.");
292
293        worker.set_context_for_interrupt(context.clone());
294        global.track_worker(
295            closing,
296            animation_frame_provider_supported,
297            join_handle,
298            control_sender,
299            context,
300        );
301
302        Ok(worker)
303    }
304
305    /// <https://html.spec.whatwg.org/multipage/#dom-worker-postmessage>
306    fn PostMessage(
307        &self,
308        cx: &mut JSContext,
309        message: HandleValue,
310        transfer: CustomAutoRooterGuard<Vec<*mut JSObject>>,
311    ) -> ErrorResult {
312        self.post_message_impl(cx, message, transfer)
313    }
314
315    /// <https://html.spec.whatwg.org/multipage/#dom-worker-postmessage>
316    fn PostMessage_(
317        &self,
318        cx: &mut JSContext,
319        message: HandleValue,
320        options: RootedTraceableBox<StructuredSerializeOptions>,
321    ) -> ErrorResult {
322        let mut rooted = CustomAutoRooter::new(
323            options
324                .transfer
325                .iter()
326                .map(|js: &RootedTraceableBox<Heap<*mut JSObject>>| js.get())
327                .collect(),
328        );
329        #[expect(unsafe_code)]
330        let guard = unsafe { CustomAutoRooterGuard::new(cx.raw_cx(), &mut rooted) };
331        self.post_message_impl(cx, message, guard)
332    }
333
334    /// <https://html.spec.whatwg.org/multipage/#terminate-a-worker>
335    fn Terminate(&self) {
336        // Step 1
337        if self.closing.swap(true, Ordering::SeqCst) {
338            return;
339        }
340
341        // Step 2
342        self.terminated.set(true);
343
344        // Step 3
345        if let Some(cx) = self.context_for_interrupt.borrow().as_ref() {
346            cx.request_interrupt_callback()
347        }
348    }
349
350    // https://html.spec.whatwg.org/multipage/#handler-worker-onmessage
351    event_handler!(message, GetOnmessage, SetOnmessage);
352
353    // https://html.spec.whatwg.org/multipage/#handler-worker-onmessageerror
354    event_handler!(messageerror, GetOnmessageerror, SetOnmessageerror);
355
356    // https://html.spec.whatwg.org/multipage/#handler-workerglobalscope-onerror
357    event_handler!(error, GetOnerror, SetOnerror);
358}
359
360impl TaskOnce for SimpleWorkerErrorHandler<Worker> {
361    #[cfg_attr(crown, expect(crown::unrooted_must_root))]
362    fn run_once(self, cx: &mut JSContext) {
363        Worker::dispatch_simple_error(cx, self.addr);
364    }
365}
script/dom/workers/worker.rs

script/dom/workers/
worker.rs
