Skip to main content

script/dom/workers/
dedicatedworkerglobalscope.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::sync::Arc;
6use std::sync::atomic::AtomicBool;
7use std::thread::{self, JoinHandle};
8
9use crossbeam_channel::{Receiver, Sender, unbounded};
10use devtools_traits::DevtoolScriptControlMsg;
11use dom_struct::dom_struct;
12use fonts::FontContext;
13use js::context::JSContext;
14use js::jsapi::{Heap, JSObject};
15use js::jsval::UndefinedValue;
16use js::rust::{CustomAutoRooter, CustomAutoRooterGuard, HandleValue};
17use net_traits::blob_url_store::UrlWithBlobClaim;
18use net_traits::image_cache::ImageCache;
19use net_traits::policy_container::{PolicyContainer, RequestPolicyContainer};
20use net_traits::request::{
21    CredentialsMode, Destination, InsecureRequestsPolicy, Origin, ParserMetadata,
22    PreloadedResources, Referrer, RequestBuilder, RequestClient, RequestMode,
23};
24use script_bindings::cell::DomRefCell;
25use servo_base::generic_channel::{GenericReceiver, RoutedReceiver};
26use servo_base::id::{BrowsingContextId, PipelineId, ScriptEventLoopId, WebViewId};
27use servo_constellation_traits::{WorkerGlobalScopeInit, WorkerScriptLoadOrigin};
28use servo_url::{ImmutableOrigin, ServoUrl};
29use style::thread_state::{self, ThreadState};
30
31use crate::conversions::Convert;
32use crate::dom::abstractworker::{MessageData, SimpleWorkerErrorHandler, WorkerScriptMsg};
33use crate::dom::abstractworkerglobalscope::{WorkerEventLoopMethods, run_worker_event_loop};
34use crate::dom::bindings::codegen::Bindings::DedicatedWorkerGlobalScopeBinding;
35use crate::dom::bindings::codegen::Bindings::DedicatedWorkerGlobalScopeBinding::DedicatedWorkerGlobalScopeMethods;
36use crate::dom::bindings::codegen::Bindings::MessagePortBinding::StructuredSerializeOptions;
37use crate::dom::bindings::codegen::Bindings::WorkerBinding::{WorkerOptions, WorkerType};
38use crate::dom::bindings::error::{ErrorInfo, ErrorResult};
39use crate::dom::bindings::inheritance::Castable;
40use crate::dom::bindings::refcounted::Trusted;
41use crate::dom::bindings::reflector::DomGlobal;
42use crate::dom::bindings::root::DomRoot;
43use crate::dom::bindings::str::DOMString;
44use crate::dom::bindings::structuredclone;
45use crate::dom::bindings::trace::{CustomTraceable, RootedTraceableBox};
46use crate::dom::csp::Violation;
47use crate::dom::errorevent::ErrorEvent;
48use crate::dom::event::{Event, EventBubbles, EventCancelable};
49use crate::dom::eventtarget::EventTarget;
50use crate::dom::globalscope::GlobalScope;
51use crate::dom::html::htmlscriptelement::Script;
52use crate::dom::messageevent::MessageEvent;
53use crate::dom::types::DebuggerGlobalScope;
54#[cfg(feature = "webgpu")]
55use crate::dom::webgpu::identityhub::IdentityHub;
56use crate::dom::worker::{TrustedWorkerAddress, Worker};
57use crate::dom::workerglobalscope::{ScriptFetchContext, WorkerGlobalScope};
58use crate::messaging::{CommonScriptMsg, ScriptEventLoopReceiver, ScriptEventLoopSender};
59use crate::realms::enter_auto_realm;
60use crate::script_module::{ModuleFetchClient, fetch_a_module_worker_script_graph};
61use crate::script_runtime::ScriptThreadEventCategory::WorkerEvent;
62use crate::script_runtime::{CanGc, Runtime, ThreadSafeJSContext};
63use crate::task_queue::{QueuedTask, QueuedTaskConversion, TaskQueue};
64use crate::task_source::TaskSourceName;
65
66/// Set the `worker` field of a related DedicatedWorkerGlobalScope object to a particular
67/// value for the duration of this object's lifetime. This ensures that the related Worker
68/// object only lives as long as necessary (ie. while events are being executed), while
69/// providing a reference that can be cloned freely.
70pub(crate) struct AutoWorkerReset<'a> {
71    workerscope: &'a DedicatedWorkerGlobalScope,
72    old_worker: Option<TrustedWorkerAddress>,
73}
74
75impl<'a> AutoWorkerReset<'a> {
76    pub(crate) fn new(
77        workerscope: &'a DedicatedWorkerGlobalScope,
78        worker: TrustedWorkerAddress,
79    ) -> AutoWorkerReset<'a> {
80        let old_worker = workerscope.replace_worker(Some(worker));
81        AutoWorkerReset {
82            workerscope,
83            old_worker,
84        }
85    }
86}
87
88impl Drop for AutoWorkerReset<'_> {
89    fn drop(&mut self) {
90        self.workerscope
91            .replace_worker(std::mem::take(&mut self.old_worker));
92    }
93}
94
95/// Messages sent from the owning global.
96pub(crate) enum DedicatedWorkerControlMsg {
97    /// Shutdown the worker.
98    Exit,
99}
100
101pub(crate) enum DedicatedWorkerScriptMsg {
102    /// Standard message from a worker.
103    CommonWorker(TrustedWorkerAddress, WorkerScriptMsg),
104    /// Wake-up call from the task queue.
105    WakeUp,
106}
107
108pub(crate) enum MixedMessage {
109    Worker(DedicatedWorkerScriptMsg),
110    Devtools(DevtoolScriptControlMsg),
111    Control(DedicatedWorkerControlMsg),
112    Timer,
113}
114
115impl QueuedTaskConversion for DedicatedWorkerScriptMsg {
116    fn task_source_name(&self) -> Option<&TaskSourceName> {
117        let common_worker_msg = match self {
118            DedicatedWorkerScriptMsg::CommonWorker(_, common_worker_msg) => common_worker_msg,
119            _ => return None,
120        };
121        let script_msg = match common_worker_msg {
122            WorkerScriptMsg::Common(script_msg) => script_msg,
123            _ => return None,
124        };
125        match script_msg {
126            CommonScriptMsg::Task(_category, _boxed, _pipeline_id, source_name) => {
127                Some(source_name)
128            },
129            _ => None,
130        }
131    }
132
133    fn pipeline_id(&self) -> Option<PipelineId> {
134        // Workers always return None, since the pipeline_id is only used to check for document activity,
135        // and this check does not apply to worker event-loops.
136        None
137    }
138
139    fn into_queued_task(self) -> Option<QueuedTask> {
140        let (worker, common_worker_msg) = match self {
141            DedicatedWorkerScriptMsg::CommonWorker(worker, common_worker_msg) => {
142                (worker, common_worker_msg)
143            },
144            _ => return None,
145        };
146        let script_msg = match common_worker_msg {
147            WorkerScriptMsg::Common(script_msg) => script_msg,
148            _ => return None,
149        };
150        let (event_category, task, pipeline_id, task_source) = match script_msg {
151            CommonScriptMsg::Task(category, boxed, pipeline_id, task_source) => {
152                (category, boxed, pipeline_id, task_source)
153            },
154            _ => return None,
155        };
156        Some(QueuedTask {
157            worker: Some(worker),
158            event_category,
159            task,
160            pipeline_id,
161            task_source,
162        })
163    }
164
165    fn from_queued_task(queued_task: QueuedTask) -> Self {
166        let script_msg = CommonScriptMsg::Task(
167            queued_task.event_category,
168            queued_task.task,
169            queued_task.pipeline_id,
170            queued_task.task_source,
171        );
172        DedicatedWorkerScriptMsg::CommonWorker(
173            queued_task.worker.unwrap(),
174            WorkerScriptMsg::Common(script_msg),
175        )
176    }
177
178    fn inactive_msg() -> Self {
179        // Inactive is only relevant in the context of a browsing-context event-loop.
180        panic!("Workers should never receive messages marked as inactive");
181    }
182
183    fn wake_up_msg() -> Self {
184        DedicatedWorkerScriptMsg::WakeUp
185    }
186
187    fn is_wake_up(&self) -> bool {
188        matches!(self, DedicatedWorkerScriptMsg::WakeUp)
189    }
190}
191
192unsafe_no_jsmanaged_fields!(TaskQueue<DedicatedWorkerScriptMsg>);
193
194// https://html.spec.whatwg.org/multipage/#dedicatedworkerglobalscope
195#[dom_struct]
196pub(crate) struct DedicatedWorkerGlobalScope {
197    workerglobalscope: WorkerGlobalScope,
198    /// The [`WebViewId`] of the `WebView` that this worker is associated with.
199    #[no_trace]
200    webview_id: WebViewId,
201    #[ignore_malloc_size_of = "Defined in std"]
202    task_queue: TaskQueue<DedicatedWorkerScriptMsg>,
203    own_sender: Sender<DedicatedWorkerScriptMsg>,
204    worker: DomRefCell<Option<TrustedWorkerAddress>>,
205    /// Sender to the parent thread.
206    parent_event_loop_sender: ScriptEventLoopSender,
207    #[ignore_malloc_size_of = "ImageCache"]
208    #[no_trace]
209    image_cache: Arc<dyn ImageCache>,
210    #[no_trace]
211    browsing_context: Option<BrowsingContextId>,
212    /// A receiver of control messages,
213    /// currently only used to signal shutdown.
214    #[no_trace]
215    control_receiver: Receiver<DedicatedWorkerControlMsg>,
216    #[no_trace]
217    queued_worker_tasks: DomRefCell<Vec<MessageData>>,
218}
219
220impl WorkerEventLoopMethods for DedicatedWorkerGlobalScope {
221    type WorkerMsg = DedicatedWorkerScriptMsg;
222    type ControlMsg = DedicatedWorkerControlMsg;
223    type Event = MixedMessage;
224
225    fn task_queue(&self) -> &TaskQueue<DedicatedWorkerScriptMsg> {
226        &self.task_queue
227    }
228
229    fn handle_event(&self, event: MixedMessage, cx: &mut JSContext) -> bool {
230        self.handle_mixed_message(event, cx)
231    }
232
233    fn handle_worker_post_event(
234        &self,
235        worker: &TrustedWorkerAddress,
236    ) -> Option<AutoWorkerReset<'_>> {
237        let ar = AutoWorkerReset::new(self, worker.clone());
238        Some(ar)
239    }
240
241    fn from_control_msg(msg: DedicatedWorkerControlMsg) -> MixedMessage {
242        MixedMessage::Control(msg)
243    }
244
245    fn from_worker_msg(msg: DedicatedWorkerScriptMsg) -> MixedMessage {
246        MixedMessage::Worker(msg)
247    }
248
249    fn from_devtools_msg(msg: DevtoolScriptControlMsg) -> MixedMessage {
250        MixedMessage::Devtools(msg)
251    }
252
253    fn from_timer_msg() -> MixedMessage {
254        MixedMessage::Timer
255    }
256
257    fn control_receiver(&self) -> &Receiver<DedicatedWorkerControlMsg> {
258        &self.control_receiver
259    }
260}
261
262impl DedicatedWorkerGlobalScope {
263    #[allow(clippy::too_many_arguments)]
264    fn new_inherited(
265        init: WorkerGlobalScopeInit,
266        webview_id: WebViewId,
267        worker_name: DOMString,
268        worker_type: WorkerType,
269        worker_url: ServoUrl,
270        from_devtools_receiver: RoutedReceiver<DevtoolScriptControlMsg>,
271        runtime: Runtime,
272        parent_event_loop_sender: ScriptEventLoopSender,
273        own_sender: Sender<DedicatedWorkerScriptMsg>,
274        receiver: Receiver<DedicatedWorkerScriptMsg>,
275        closing: Arc<AtomicBool>,
276        image_cache: Arc<dyn ImageCache>,
277        browsing_context: Option<BrowsingContextId>,
278        #[cfg(feature = "webgpu")] gpu_id_hub: Arc<IdentityHub>,
279        control_receiver: Receiver<DedicatedWorkerControlMsg>,
280        insecure_requests_policy: InsecureRequestsPolicy,
281        font_context: Option<Arc<FontContext>>,
282    ) -> DedicatedWorkerGlobalScope {
283        DedicatedWorkerGlobalScope {
284            workerglobalscope: WorkerGlobalScope::new_inherited(
285                init,
286                worker_name,
287                worker_type,
288                worker_url,
289                runtime,
290                from_devtools_receiver,
291                closing,
292                #[cfg(feature = "webgpu")]
293                gpu_id_hub,
294                insecure_requests_policy,
295                font_context,
296            ),
297            webview_id,
298            task_queue: TaskQueue::new(receiver, own_sender.clone()),
299            own_sender,
300            parent_event_loop_sender,
301            worker: DomRefCell::new(None),
302            image_cache,
303            browsing_context,
304            control_receiver,
305            queued_worker_tasks: Default::default(),
306        }
307    }
308
309    #[expect(clippy::too_many_arguments)]
310    pub(crate) fn new(
311        init: WorkerGlobalScopeInit,
312        webview_id: WebViewId,
313        worker_name: DOMString,
314        worker_type: WorkerType,
315        worker_url: ServoUrl,
316        from_devtools_receiver: RoutedReceiver<DevtoolScriptControlMsg>,
317        runtime: Runtime,
318        parent_event_loop_sender: ScriptEventLoopSender,
319        own_sender: Sender<DedicatedWorkerScriptMsg>,
320        receiver: Receiver<DedicatedWorkerScriptMsg>,
321        closing: Arc<AtomicBool>,
322        image_cache: Arc<dyn ImageCache>,
323        browsing_context: Option<BrowsingContextId>,
324        #[cfg(feature = "webgpu")] gpu_id_hub: Arc<IdentityHub>,
325        control_receiver: Receiver<DedicatedWorkerControlMsg>,
326        insecure_requests_policy: InsecureRequestsPolicy,
327        font_context: Option<Arc<FontContext>>,
328        debugger_global: &DebuggerGlobalScope,
329        cx: &mut js::context::JSContext,
330    ) -> DomRoot<DedicatedWorkerGlobalScope> {
331        let scope = Box::new(DedicatedWorkerGlobalScope::new_inherited(
332            init,
333            webview_id,
334            worker_name,
335            worker_type,
336            worker_url,
337            from_devtools_receiver,
338            runtime,
339            parent_event_loop_sender,
340            own_sender,
341            receiver,
342            closing,
343            image_cache,
344            browsing_context,
345            #[cfg(feature = "webgpu")]
346            gpu_id_hub,
347            control_receiver,
348            insecure_requests_policy,
349            font_context,
350        ));
351        let scope = DedicatedWorkerGlobalScopeBinding::Wrap::<crate::DomTypeHolder>(cx, scope);
352        scope
353            .upcast::<WorkerGlobalScope>()
354            .init_debugger_global(debugger_global, cx);
355
356        scope
357    }
358
359    /// <https://html.spec.whatwg.org/multipage/#run-a-worker>
360    #[expect(unsafe_code)]
361    #[allow(clippy::too_many_arguments)]
362    pub(crate) fn run_worker_scope(
363        mut init: WorkerGlobalScopeInit,
364        webview_id: WebViewId,
365        worker_url: UrlWithBlobClaim,
366        from_devtools_receiver: GenericReceiver<DevtoolScriptControlMsg>,
367        worker: TrustedWorkerAddress,
368        parent_event_loop_sender: ScriptEventLoopSender,
369        own_sender: Sender<DedicatedWorkerScriptMsg>,
370        receiver: Receiver<DedicatedWorkerScriptMsg>,
371        worker_load_origin: WorkerScriptLoadOrigin,
372        worker_options: &WorkerOptions,
373        closing: Arc<AtomicBool>,
374        image_cache: Arc<dyn ImageCache>,
375        browsing_context: Option<BrowsingContextId>,
376        #[cfg(feature = "webgpu")] gpu_id_hub: Arc<IdentityHub>,
377        control_receiver: Receiver<DedicatedWorkerControlMsg>,
378        context_sender: Sender<ThreadSafeJSContext>,
379        insecure_requests_policy: InsecureRequestsPolicy,
380        policy_container: PolicyContainer,
381        font_context: Option<Arc<FontContext>>,
382    ) -> JoinHandle<()> {
383        let event_loop_id = ScriptEventLoopId::installed()
384            .expect("Should always be in a ScriptThread or in a dedicated worker");
385        let current_global = GlobalScope::current().expect("No current global object");
386        let origin = current_global.origin().immutable().clone();
387        let referrer = current_global.get_referrer();
388        let parent = current_global.runtime_handle();
389        let current_global_ancestor_trustworthy = current_global.has_trustworthy_ancestor_origin();
390        let is_secure_context = current_global.is_secure_context();
391        let is_nested_browsing_context = current_global.is_nested_browsing_context();
392
393        let worker_type = worker_options.type_;
394        let worker_name = worker_options.name.to_string();
395        let credentials = worker_options.credentials.convert();
396
397        thread::Builder::new()
398            .name(format!("WW:{}", worker_url.debug_compact()))
399            .spawn(move || {
400                thread_state::initialize(ThreadState::SCRIPT | ThreadState::IN_WORKER);
401                ScriptEventLoopId::install(event_loop_id);
402
403                let WorkerScriptLoadOrigin {
404                    referrer_url,
405                    pipeline_id,
406                    ..
407                } = worker_load_origin;
408
409                let referrer = referrer_url.map(Referrer::ReferrerUrl).unwrap_or(referrer);
410
411                let request_client = RequestClient {
412                    preloaded_resources: PreloadedResources::default(),
413                    policy_container: RequestPolicyContainer::PolicyContainer(
414                        policy_container.clone(),
415                    ),
416                    origin: Origin::Origin(origin.clone()),
417                    is_nested_browsing_context,
418                    insecure_requests_policy,
419                };
420
421                let event_loop_sender = ScriptEventLoopSender::DedicatedWorker {
422                    sender: own_sender.clone(),
423                    main_thread_worker: worker.clone(),
424                };
425
426                let runtime = unsafe {
427                    Runtime::new_with_parent(Some(parent), Some(event_loop_sender.clone()))
428                };
429                // SAFETY: We are in a new thread, so this first cx.
430                // It is OK to have it separated of runtime here,
431                // because it will never outlive it (runtime destruction happens at the end of this function)
432                let mut cx = unsafe { runtime.cx() };
433                let cx = &mut cx;
434                let debugger_global = DebuggerGlobalScope::new(
435                    pipeline_id,
436                    init.to_devtools_sender.clone(),
437                    init.from_devtools_sender
438                        .clone()
439                        .expect("Guaranteed by Worker::Constructor"),
440                    init.mem_profiler_chan.clone(),
441                    init.time_profiler_chan.clone(),
442                    init.script_to_constellation_chan.clone(),
443                    init.script_to_embedder_chan.clone(),
444                    init.resource_threads.clone(),
445                    init.storage_threads.clone(),
446                    #[cfg(feature = "webgpu")]
447                    gpu_id_hub.clone(),
448                    cx,
449                );
450                debugger_global.execute(cx);
451
452                let context_for_interrupt = runtime.thread_safe_js_context();
453                let _ = context_sender.send(context_for_interrupt);
454
455                let devtools_mpsc_port = from_devtools_receiver.route_preserving_errors();
456
457                // Step 8 "Set up a worker environment settings object [...]"
458                //
459                // <https://html.spec.whatwg.org/multipage/#script-settings-for-workers>
460                //
461                // > The origin: Return a unique opaque origin if `worker global
462                // > scope`'s url's scheme is "data", and `inherited origin`
463                // > otherwise.
464                if worker_url.scheme() == "data" {
465                    // Workers created from a data: url are secure if they were created from secure contexts
466                    if is_secure_context {
467                        init.origin = ImmutableOrigin::new_opaque_data_url_worker();
468                    } else {
469                        init.origin = ImmutableOrigin::new_opaque();
470                    }
471                }
472
473                let worker_id = init.worker_id;
474                let devtools_enabled = init.to_devtools_sender.is_some();
475                let global = DedicatedWorkerGlobalScope::new(
476                    init,
477                    webview_id,
478                    worker_name.into(),
479                    worker_type,
480                    worker_url.url(),
481                    devtools_mpsc_port,
482                    runtime,
483                    parent_event_loop_sender,
484                    own_sender,
485                    receiver,
486                    closing,
487                    image_cache,
488                    browsing_context,
489                    #[cfg(feature = "webgpu")]
490                    gpu_id_hub,
491                    control_receiver,
492                    insecure_requests_policy,
493                    font_context,
494                    &debugger_global,
495                    cx,
496                );
497                if devtools_enabled {
498                    debugger_global.fire_add_debuggee(
499                        cx,
500                        global.upcast(),
501                        pipeline_id,
502                        Some(worker_id),
503                    );
504                }
505                let scope = global.upcast::<WorkerGlobalScope>();
506                let global_scope = global.upcast::<GlobalScope>();
507
508                let fetch_client = ModuleFetchClient {
509                    insecure_requests_policy,
510                    has_trustworthy_ancestor_origin: current_global_ancestor_trustworthy,
511                    policy_container,
512                    client: request_client,
513                    pipeline_id,
514                    origin,
515                };
516
517                // Step 12. Obtain script by switching on options["type"]:
518                {
519                    let _ar = AutoWorkerReset::new(&global, worker.clone());
520                    match worker_type {
521                        WorkerType::Classic => {
522                            fetch_a_classic_worker_script(
523                                scope,
524                                worker_url,
525                                fetch_client,
526                                Destination::Worker,
527                                Some(webview_id),
528                                referrer,
529                            );
530                        },
531                        WorkerType::Module => {
532                            let worker_scope = DomRoot::from_ref(scope);
533                            fetch_a_module_worker_script_graph(
534                                cx,
535                                global_scope,
536                                worker_url.url(),
537                                fetch_client,
538                                Destination::Worker,
539                                referrer,
540                                credentials,
541                                move |cx, module_tree| {
542                                    worker_scope.on_complete(cx, module_tree.map(Script::Module));
543                                },
544                            );
545                        },
546                    }
547
548                    let reporter_name = format!("dedicated-worker-reporter-{}", worker_id);
549                    scope
550                        .upcast::<GlobalScope>()
551                        .mem_profiler_chan()
552                        .run_with_memory_reporting(
553                            || {
554                                // Step 27, Run the responsible event loop specified
555                                // by inside settings until it is destroyed.
556                                // The worker processing model remains on this step
557                                // until the event loop is destroyed,
558                                // which happens after the closing flag is set to true.
559                                while !scope.is_closing() {
560                                    run_worker_event_loop(&*global, Some(&worker), cx);
561                                }
562                            },
563                            reporter_name,
564                            event_loop_sender,
565                            CommonScriptMsg::CollectReports,
566                        );
567                }
568
569                scope.clear_js_runtime();
570            })
571            .expect("Thread spawning failed")
572    }
573
574    pub(crate) fn webview_id(&self) -> WebViewId {
575        self.webview_id
576    }
577
578    /// The non-None value of the `worker` field can contain a rooted [`TrustedWorkerAddress`]
579    /// version of the main thread's worker object. This is set while handling messages and then
580    /// unset otherwise, ensuring that the main thread object can be garbage collected. See
581    /// [`AutoWorkerReset`].
582    fn replace_worker(
583        &self,
584        new_worker: Option<TrustedWorkerAddress>,
585    ) -> Option<TrustedWorkerAddress> {
586        let old_worker = std::mem::replace(&mut *self.worker.borrow_mut(), new_worker);
587
588        // The `TaskManager` maintains a handle to this `DedicatedWorkerGlobalScope`'s
589        // event_loop_sender, which might in turn have a `TrustedWorkerAddress` rooting of the main
590        // thread's worker, which prevents garbage collection. Resetting it here ensures that
591        // garbage collection of the main thread object can happen again (assuming the new `worker`
592        // is `None`).
593        self.upcast::<GlobalScope>()
594            .task_manager()
595            .set_sender(self.event_loop_sender());
596
597        old_worker
598    }
599
600    pub(crate) fn image_cache(&self) -> Arc<dyn ImageCache> {
601        self.image_cache.clone()
602    }
603
604    pub(crate) fn event_loop_sender(&self) -> Option<ScriptEventLoopSender> {
605        Some(ScriptEventLoopSender::DedicatedWorker {
606            sender: self.own_sender.clone(),
607            main_thread_worker: self.worker.borrow().clone()?,
608        })
609    }
610
611    pub(crate) fn new_script_pair(&self) -> (ScriptEventLoopSender, ScriptEventLoopReceiver) {
612        let (sender, receiver) = unbounded();
613        let main_thread_worker = self.worker.borrow().as_ref().unwrap().clone();
614        (
615            ScriptEventLoopSender::DedicatedWorker {
616                sender,
617                main_thread_worker,
618            },
619            ScriptEventLoopReceiver::DedicatedWorker(receiver),
620        )
621    }
622
623    pub(crate) fn fire_queued_messages(&self, cx: &mut JSContext) {
624        let queue: Vec<_> = self.queued_worker_tasks.borrow_mut().drain(..).collect();
625        for msg in queue {
626            if self.upcast::<WorkerGlobalScope>().is_closing() {
627                return;
628            }
629            self.dispatch_message_event(cx, msg);
630        }
631    }
632
633    fn dispatch_message_event(&self, cx: &mut JSContext, msg: MessageData) {
634        let scope = self.upcast::<WorkerGlobalScope>();
635        let target = self.upcast();
636        let mut realm = enter_auto_realm(cx, self);
637        let cx = &mut realm;
638        rooted!(&in(cx) let mut message = UndefinedValue());
639        if let Ok(ports) =
640            structuredclone::read(cx, scope.upcast(), *msg.data, message.handle_mut())
641        {
642            MessageEvent::dispatch_jsval(
643                cx,
644                target,
645                scope.upcast(),
646                message.handle(),
647                Some(&msg.origin.ascii_serialization()),
648                None,
649                ports,
650            );
651        } else {
652            MessageEvent::dispatch_error(cx, target, scope.upcast());
653        }
654    }
655
656    fn handle_script_event(&self, msg: WorkerScriptMsg, cx: &mut JSContext) {
657        match msg {
658            WorkerScriptMsg::DOMMessage(message_data) => {
659                if self.upcast::<WorkerGlobalScope>().is_execution_ready() {
660                    self.dispatch_message_event(cx, message_data);
661                } else {
662                    self.queued_worker_tasks.borrow_mut().push(message_data);
663                }
664            },
665            WorkerScriptMsg::Common(msg) => {
666                self.upcast::<WorkerGlobalScope>().process_event(msg, cx);
667            },
668        }
669    }
670
671    fn handle_mixed_message(&self, msg: MixedMessage, cx: &mut JSContext) -> bool {
672        if self.upcast::<WorkerGlobalScope>().is_closing() {
673            return false;
674        }
675        // FIXME(#26324): `self.worker` is None in devtools messages.
676        match msg {
677            MixedMessage::Devtools(msg) => self
678                .upcast::<WorkerGlobalScope>()
679                .handle_devtools_message(msg, cx),
680            MixedMessage::Worker(DedicatedWorkerScriptMsg::CommonWorker(linked_worker, msg)) => {
681                let _ar = AutoWorkerReset::new(self, linked_worker);
682                self.handle_script_event(msg, cx);
683            },
684            MixedMessage::Worker(DedicatedWorkerScriptMsg::WakeUp) => {},
685            MixedMessage::Control(DedicatedWorkerControlMsg::Exit) => {
686                return false;
687            },
688            MixedMessage::Timer => {},
689        }
690        true
691    }
692
693    /// Step 7.2 of <https://html.spec.whatwg.org/multipage/#report-an-exception>
694    pub(crate) fn forward_error_to_worker_object(&self, error_info: ErrorInfo) {
695        // Step 7.2.1. Let workerObject be the Worker object associated with global.
696        let worker = self.worker.borrow().as_ref().unwrap().clone();
697        let pipeline_id = self.upcast::<GlobalScope>().pipeline_id();
698        let task = Box::new(task!(forward_error_to_worker_object: move |cx| {
699            let worker = worker.root();
700            let global = worker.global();
701
702            // Step 7.2.2. Set notHandled to the result of firing an event named error at workerObject, using ErrorEvent,
703            // with the cancelable attribute initialized to true, and additional attributes initialized according to errorInfo.
704            let event = ErrorEvent::new(
705                &global,
706                atom!("error"),
707                EventBubbles::DoesNotBubble,
708                EventCancelable::Cancelable,
709                error_info.message.as_str().into(),
710                error_info.filename.as_str().into(),
711                error_info.lineno,
712                error_info.column,
713                HandleValue::null(),
714                CanGc::from_cx(cx),
715            );
716
717            // Step 7.2.3. If notHandled is true, then report exception for workerObject's relevant global object with omitError set to true.
718            if event.upcast::<Event>().fire(cx, worker.upcast::<EventTarget>()) {
719                global.report_an_error(cx, error_info, HandleValue::null());
720            }
721        }));
722        self.parent_event_loop_sender
723            .send(CommonScriptMsg::Task(
724                WorkerEvent,
725                task,
726                Some(pipeline_id),
727                TaskSourceName::DOMManipulation,
728            ))
729            .unwrap();
730    }
731
732    /// <https://html.spec.whatwg.org/multipage/#dom-dedicatedworkerglobalscope-postmessage>
733    fn post_message_impl(
734        &self,
735        cx: &mut JSContext,
736        message: HandleValue,
737        transfer: CustomAutoRooterGuard<Vec<*mut JSObject>>,
738    ) -> ErrorResult {
739        let data = structuredclone::write(cx, message, Some(transfer))?;
740        let worker = self.worker.borrow().as_ref().unwrap().clone();
741        let global_scope = self.upcast::<GlobalScope>();
742        let pipeline_id = global_scope.pipeline_id();
743        let task = Box::new(task!(post_worker_message: move |cx| {
744            Worker::handle_message(worker, data, cx);
745        }));
746        self.parent_event_loop_sender
747            .send(CommonScriptMsg::Task(
748                WorkerEvent,
749                task,
750                Some(pipeline_id),
751                TaskSourceName::DOMManipulation,
752            ))
753            .expect("Sending to parent failed");
754        Ok(())
755    }
756
757    pub(crate) fn browsing_context(&self) -> Option<BrowsingContextId> {
758        self.browsing_context
759    }
760
761    pub(crate) fn report_csp_violations(&self, violations: Vec<Violation>) {
762        let pipeline_id = self.upcast::<GlobalScope>().pipeline_id();
763        self.parent_event_loop_sender
764            .send(CommonScriptMsg::ReportCspViolations(
765                pipeline_id,
766                violations,
767            ))
768            .expect("Sending to parent failed");
769    }
770
771    pub(crate) fn forward_simple_error_at_worker(&self) {
772        let pipeline_id = self.upcast::<GlobalScope>().pipeline_id();
773        let worker = self.worker.borrow().clone().expect("worker must be set");
774        self.parent_event_loop_sender
775            .send(CommonScriptMsg::Task(
776                WorkerEvent,
777                Box::new(SimpleWorkerErrorHandler::new(worker)),
778                Some(pipeline_id),
779                TaskSourceName::DOMManipulation,
780            ))
781            .expect("Sending to parent failed");
782    }
783}
784
785/// <https://html.spec.whatwg.org/multipage/#fetch-a-classic-worker-script>
786pub(crate) fn fetch_a_classic_worker_script(
787    workerscope: &WorkerGlobalScope,
788    url_with_blob_lock: UrlWithBlobClaim,
789    fetch_client: ModuleFetchClient,
790    destination: Destination,
791    webview_id: Option<WebViewId>,
792    referrer: Referrer,
793) {
794    // Step 1. Let request be a new request whose URL is url,
795    let request = RequestBuilder::new(webview_id, url_with_blob_lock.clone(), referrer)
796        // client is fetchClient,
797        .insecure_requests_policy(fetch_client.insecure_requests_policy)
798        .has_trustworthy_ancestor_origin(fetch_client.has_trustworthy_ancestor_origin)
799        .policy_container(fetch_client.policy_container.clone())
800        .client(fetch_client.client)
801        .pipeline_id(Some(fetch_client.pipeline_id))
802        .origin(fetch_client.origin)
803        // destination is destination,
804        .destination(destination)
805        // TODO initiator type is "other",
806        // mode is "same-origin",
807        .mode(RequestMode::SameOrigin)
808        // credentials mode is "same-origin",
809        .credentials_mode(CredentialsMode::CredentialsSameOrigin)
810        // parser metadata is "not parser-inserted",
811        .parser_metadata(ParserMetadata::NotParserInserted)
812        // and whose use-URL-credentials flag is set.
813        .use_url_credentials(true);
814
815    let context = ScriptFetchContext::new(
816        Trusted::new(workerscope),
817        url_with_blob_lock.url(),
818        fetch_client.policy_container,
819    );
820    let global = workerscope.upcast::<GlobalScope>();
821    let task_source = global.task_manager().networking_task_source().to_sendable();
822    global.fetch(request, context, task_source);
823}
824
825impl DedicatedWorkerGlobalScopeMethods<crate::DomTypeHolder> for DedicatedWorkerGlobalScope {
826    /// <https://html.spec.whatwg.org/multipage/#dom-dedicatedworkerglobalscope-name>
827    fn Name(&self) -> DOMString {
828        self.workerglobalscope.worker_name()
829    }
830
831    /// <https://html.spec.whatwg.org/multipage/#dom-dedicatedworkerglobalscope-postmessage>
832    fn PostMessage(
833        &self,
834        cx: &mut JSContext,
835        message: HandleValue,
836        transfer: CustomAutoRooterGuard<Vec<*mut JSObject>>,
837    ) -> ErrorResult {
838        self.post_message_impl(cx, message, transfer)
839    }
840
841    /// <https://html.spec.whatwg.org/multipage/#dom-dedicatedworkerglobalscope-postmessage>
842    fn PostMessage_(
843        &self,
844        cx: &mut JSContext,
845        message: HandleValue,
846        options: RootedTraceableBox<StructuredSerializeOptions>,
847    ) -> ErrorResult {
848        let mut rooted = CustomAutoRooter::new(
849            options
850                .transfer
851                .iter()
852                .map(|js: &RootedTraceableBox<Heap<*mut JSObject>>| js.get())
853                .collect(),
854        );
855        #[expect(unsafe_code)]
856        let guard = unsafe { CustomAutoRooterGuard::new(cx.raw_cx(), &mut rooted) };
857        self.post_message_impl(cx, message, guard)
858    }
859
860    /// <https://html.spec.whatwg.org/multipage/#dom-dedicatedworkerglobalscope-close>
861    fn Close(&self) {
862        // Step 2
863        self.upcast::<WorkerGlobalScope>().close();
864    }
865
866    // https://html.spec.whatwg.org/multipage/#handler-dedicatedworkerglobalscope-onmessage
867    event_handler!(message, GetOnmessage, SetOnmessage);
868
869    // https://html.spec.whatwg.org/multipage/#handler-dedicatedworkerglobalscope-onmessageerror
870    event_handler!(messageerror, GetOnmessageerror, SetOnmessageerror);
871}