aboutsummaryrefslogtreecommitdiffstats
path: root/components/script/serviceworker_manager.rs
blob: f76ba776be98e79644292cc463476a780b61a843 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
/* 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/. */

//! The service worker manager persists the descriptor of any registered service workers.
//! It also stores an active workers map, which holds descriptors of running service workers.
//! If an active service worker timeouts, then it removes the descriptor entry from its
//! active_workers map

use crate::dom::abstractworker::WorkerScriptMsg;
use crate::dom::bindings::structuredclone::StructuredCloneData;
use crate::dom::serviceworkerglobalscope::{ServiceWorkerGlobalScope, ServiceWorkerScriptMsg};
use crate::dom::serviceworkerregistration::longest_prefix_match;
use crossbeam_channel::{unbounded, Receiver, RecvError, Sender};
use devtools_traits::{DevtoolsPageInfo, ScriptToDevtoolsControlMsg};
use ipc_channel::ipc::{self, IpcSender};
use ipc_channel::router::ROUTER;
use net_traits::{CoreResourceMsg, CustomResponseMediator};
use script_traits::{DOMMessage, SWManagerMsg, SWManagerSenders, ScopeThings, ServiceWorkerMsg};
use servo_config::prefs::PREFS;
use servo_url::ServoUrl;
use std::collections::HashMap;
use std::thread;

enum Message {
    FromResource(CustomResponseMediator),
    FromConstellation(ServiceWorkerMsg),
}

pub struct ServiceWorkerManager {
    // map of registered service worker descriptors
    registered_workers: HashMap<ServoUrl, ScopeThings>,
    // map of active service worker descriptors
    active_workers: HashMap<ServoUrl, Sender<ServiceWorkerScriptMsg>>,
    // own sender to send messages here
    own_sender: IpcSender<ServiceWorkerMsg>,
    // receiver to receive messages from constellation
    own_port: Receiver<ServiceWorkerMsg>,
    // to receive resource messages
    resource_receiver: Receiver<CustomResponseMediator>,
}

impl ServiceWorkerManager {
    fn new(
        own_sender: IpcSender<ServiceWorkerMsg>,
        from_constellation_receiver: Receiver<ServiceWorkerMsg>,
        resource_port: Receiver<CustomResponseMediator>,
    ) -> ServiceWorkerManager {
        ServiceWorkerManager {
            registered_workers: HashMap::new(),
            active_workers: HashMap::new(),
            own_sender: own_sender,
            own_port: from_constellation_receiver,
            resource_receiver: resource_port,
        }
    }

    pub fn spawn_manager(sw_senders: SWManagerSenders) {
        let (own_sender, from_constellation_receiver) = ipc::channel().unwrap();
        let (resource_chan, resource_port) = ipc::channel().unwrap();
        let from_constellation =
            ROUTER.route_ipc_receiver_to_new_crossbeam_receiver(from_constellation_receiver);
        let resource_port = ROUTER.route_ipc_receiver_to_new_crossbeam_receiver(resource_port);
        let _ = sw_senders
            .resource_sender
            .send(CoreResourceMsg::NetworkMediator(resource_chan));
        let _ = sw_senders
            .swmanager_sender
            .send(SWManagerMsg::OwnSender(own_sender.clone()));
        thread::Builder::new()
            .name("ServiceWorkerManager".to_owned())
            .spawn(move || {
                ServiceWorkerManager::new(own_sender, from_constellation, resource_port)
                    .handle_message();
            })
            .expect("Thread spawning failed");
    }

    pub fn get_matching_scope(&self, load_url: &ServoUrl) -> Option<ServoUrl> {
        for scope in self.registered_workers.keys() {
            if longest_prefix_match(&scope, load_url) {
                return Some(scope.clone());
            }
        }
        None
    }

    pub fn wakeup_serviceworker(
        &mut self,
        scope_url: ServoUrl,
    ) -> Option<Sender<ServiceWorkerScriptMsg>> {
        let scope_things = self.registered_workers.get(&scope_url);
        if let Some(scope_things) = scope_things {
            let (sender, receiver) = unbounded();
            let (devtools_sender, devtools_receiver) = ipc::channel().unwrap();
            if let Some(ref chan) = scope_things.devtools_chan {
                let title = format!("ServiceWorker for {}", scope_things.script_url);
                let page_info = DevtoolsPageInfo {
                    title: title,
                    url: scope_things.script_url.clone(),
                };
                let _ = chan.send(ScriptToDevtoolsControlMsg::NewGlobal(
                    (scope_things.init.pipeline_id, Some(scope_things.worker_id)),
                    devtools_sender,
                    page_info,
                ));
            };
            ServiceWorkerGlobalScope::run_serviceworker_scope(
                scope_things.clone(),
                sender.clone(),
                receiver,
                devtools_receiver,
                self.own_sender.clone(),
                scope_url.clone(),
            );
            // We store the activated worker
            self.active_workers.insert(scope_url, sender.clone());
            return Some(sender);
        } else {
            warn!("Unable to activate service worker");
            None
        }
    }

    fn handle_message(&mut self) {
        while let Ok(message) = self.receive_message() {
            let should_continue = match message {
                Message::FromConstellation(msg) => self.handle_message_from_constellation(msg),
                Message::FromResource(msg) => self.handle_message_from_resource(msg),
            };
            if !should_continue {
                break;
            }
        }
    }

    fn forward_message(&self, msg: DOMMessage, sender: &Sender<ServiceWorkerScriptMsg>) {
        let DOMMessage(data) = msg;
        let data = StructuredCloneData::Vector(data);
        let _ = sender.send(ServiceWorkerScriptMsg::CommonWorker(
            WorkerScriptMsg::DOMMessage(data),
        ));
    }

    fn handle_message_from_constellation(&mut self, msg: ServiceWorkerMsg) -> bool {
        match msg {
            ServiceWorkerMsg::RegisterServiceWorker(scope_things, scope) => {
                if self.registered_workers.contains_key(&scope) {
                    warn!("ScopeThings for {:?} already stored in SW-Manager", scope);
                } else {
                    self.registered_workers.insert(scope, scope_things);
                }
                true
            },
            ServiceWorkerMsg::Timeout(scope) => {
                if self.active_workers.contains_key(&scope) {
                    let _ = self.active_workers.remove(&scope);
                } else {
                    warn!("ServiceWorker for {:?} is not active", scope);
                }
                true
            },
            ServiceWorkerMsg::ForwardDOMMessage(msg, scope_url) => {
                if self.active_workers.contains_key(&scope_url) {
                    if let Some(ref sender) = self.active_workers.get(&scope_url) {
                        self.forward_message(msg, &sender);
                    }
                } else {
                    if let Some(ref sender) = self.wakeup_serviceworker(scope_url) {
                        self.forward_message(msg, &sender);
                    }
                }
                true
            },
            ServiceWorkerMsg::Exit => false,
        }
    }

    fn handle_message_from_resource(&mut self, mediator: CustomResponseMediator) -> bool {
        if serviceworker_enabled() {
            if let Some(scope) = self.get_matching_scope(&mediator.load_url) {
                if self.active_workers.contains_key(&scope) {
                    if let Some(sender) = self.active_workers.get(&scope) {
                        let _ = sender.send(ServiceWorkerScriptMsg::Response(mediator));
                    }
                } else {
                    if let Some(sender) = self.wakeup_serviceworker(scope) {
                        let _ = sender.send(ServiceWorkerScriptMsg::Response(mediator));
                    }
                }
            } else {
                let _ = mediator.response_chan.send(None);
            }
        } else {
            let _ = mediator.response_chan.send(None);
        }
        true
    }

    fn receive_message(&mut self) -> Result<Message, RecvError> {
        select! {
            recv(self.own_port) -> msg => msg.map(Message::FromConstellation),
            recv(self.resource_receiver) -> msg => msg.map(Message::FromResource),
        }
    }
}

pub fn serviceworker_enabled() -> bool {
    PREFS
        .get("dom.serviceworker.enabled")
        .as_boolean()
        .unwrap_or(false)
}