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

script/dom/workers/
worker.rs
