Skip to content

Commit

Permalink
Initial work on job queues for service workers
Browse files Browse the repository at this point in the history
  • Loading branch information
creativcoder committed Nov 21, 2016
1 parent 6cc1976 commit 114c491
Show file tree
Hide file tree
Showing 11 changed files with 462 additions and 68 deletions.
1 change: 0 additions & 1 deletion components/script/dom/bindings/trace.rs
Expand Up @@ -195,7 +195,6 @@ impl JSTraceable for Heap<*mut JSObject> {
}
}


impl JSTraceable for Heap<JSVal> {
fn trace(&self, trc: *mut JSTracer) {
trace_jsval(trc, "heap value", self);
Expand Down
26 changes: 19 additions & 7 deletions components/script/dom/client.rs
Expand Up @@ -4,20 +4,20 @@

use dom::bindings::codegen::Bindings::ClientBinding::{ClientMethods, Wrap};
use dom::bindings::codegen::Bindings::ClientBinding::FrameType;
use dom::bindings::js::JS;
use dom::bindings::js::Root;
use dom::bindings::js::{JS, Root, MutNullableHeap};
use dom::bindings::reflector::{Reflector, reflect_dom_object};
use dom::bindings::str::{DOMString, USVString};
use dom::serviceworker::ServiceWorker;
use dom::window::Window;
use servo_url::ServoUrl;
use std::default::Default;
use uuid::Uuid;

#[dom_struct]
pub struct Client {
reflector_: Reflector,
active_worker: Option<JS<ServiceWorker>>,
url: USVString,
active_worker: MutNullableHeap<JS<ServiceWorker>>,
url: ServoUrl,
frame_type: FrameType,
#[ignore_heap_size_of = "Defined in uuid"]
id: Uuid
Expand All @@ -27,8 +27,8 @@ impl Client {
fn new_inherited(url: ServoUrl) -> Client {
Client {
reflector_: Reflector::new(),
active_worker: None,
url: USVString(url.as_str().to_owned()),
active_worker: Default::default(),
url: url,
frame_type: FrameType::None,
id: Uuid::new_v4()
}
Expand All @@ -39,12 +39,24 @@ impl Client {
window,
Wrap)
}

pub fn creation_url(&self) -> ServoUrl {
self.url.clone()
}

pub fn get_controller(&self) -> Option<Root<ServiceWorker>> {
self.active_worker.get()
}

pub fn set_controller(&self, worker: &ServiceWorker) {
self.active_worker.set(Some(worker));
}
}

impl ClientMethods for Client {
// https://w3c.github.io/ServiceWorker/#client-url-attribute
fn Url(&self) -> USVString {
self.url.clone()
USVString(self.url.as_str().to_owned())
}

// https://w3c.github.io/ServiceWorker/#client-frametype
Expand Down
13 changes: 11 additions & 2 deletions components/script/dom/promise.rs
Expand Up @@ -23,8 +23,8 @@ use js::conversions::ToJSValConvertible;
use js::jsapi::{CallOriginalPromiseResolve, CallOriginalPromiseReject, CallOriginalPromiseThen};
use js::jsapi::{JSAutoCompartment, CallArgs, JS_GetFunctionObject, JS_NewFunction};
use js::jsapi::{JSContext, HandleValue, HandleObject, IsPromiseObject, GetFunctionNativeReserved};
use js::jsapi::{JS_ClearPendingException, JSObject, AddRawValueRoot, RemoveRawValueRoot};
use js::jsapi::{MutableHandleObject, NewPromiseObject, ResolvePromise, RejectPromise};
use js::jsapi::{JS_ClearPendingException, JSObject, AddRawValueRoot, RemoveRawValueRoot, PromiseState};
use js::jsapi::{MutableHandleObject, NewPromiseObject, ResolvePromise, RejectPromise, GetPromiseState};
use js::jsapi::{SetFunctionNativeReserved, NewFunctionWithReserved, AddPromiseReactions};
use js::jsval::{JSVal, UndefinedValue, ObjectValue, Int32Value};
use std::ptr;
Expand Down Expand Up @@ -199,6 +199,15 @@ impl Promise {
}
}

#[allow(unsafe_code)]
pub fn is_settled(&self) -> bool {
let state = unsafe { GetPromiseState(self.promise_obj()) };
match state {
PromiseState::Rejected | PromiseState::Fulfilled => true,
_ => false
}
}

#[allow(unsafe_code)]
fn promise_obj(&self) -> HandleObject {
let obj = self.reflector().get_jsobject();
Expand Down
6 changes: 3 additions & 3 deletions components/script/dom/serviceworker.rs
Expand Up @@ -46,9 +46,9 @@ impl ServiceWorker {
}

pub fn install_serviceworker(global: &GlobalScope,
script_url: ServoUrl,
scope_url: ServoUrl,
skip_waiting: bool) -> Root<ServiceWorker> {
script_url: ServoUrl,
scope_url: ServoUrl,
skip_waiting: bool) -> Root<ServiceWorker> {
reflect_dom_object(box ServiceWorker::new_inherited(script_url.as_str(),
skip_waiting,
scope_url), global, Wrap)
Expand Down
55 changes: 23 additions & 32 deletions components/script/dom/serviceworkercontainer.rs
Expand Up @@ -5,16 +5,16 @@
use dom::bindings::codegen::Bindings::ServiceWorkerContainerBinding::{ServiceWorkerContainerMethods, Wrap};
use dom::bindings::codegen::Bindings::ServiceWorkerContainerBinding::RegistrationOptions;
use dom::bindings::error::Error;
use dom::bindings::inheritance::Castable;
use dom::bindings::js::{JS, MutNullableHeap, Root};
use dom::bindings::reflector::{Reflectable, reflect_dom_object};
use dom::bindings::str::USVString;
use dom::client::Client;
use dom::eventtarget::EventTarget;
use dom::globalscope::GlobalScope;
use dom::promise::Promise;
use dom::serviceworker::ServiceWorker;
use dom::serviceworkerregistration::ServiceWorkerRegistration;
use script_thread::ScriptThread;
use serviceworkerjob::{Job, JobType};
use std::ascii::AsciiExt;
use std::default::Default;
use std::rc::Rc;
Expand All @@ -23,70 +23,66 @@ use std::rc::Rc;
pub struct ServiceWorkerContainer {
eventtarget: EventTarget,
controller: MutNullableHeap<JS<ServiceWorker>>,
client: JS<Client>
}

impl ServiceWorkerContainer {
fn new_inherited() -> ServiceWorkerContainer {
fn new_inherited(client: &Client) -> ServiceWorkerContainer {
ServiceWorkerContainer {
eventtarget: EventTarget::new_inherited(),
controller: Default::default(),
client: JS::from_ref(client),
}
}

#[allow(unrooted_must_root)]
pub fn new(global: &GlobalScope) -> Root<ServiceWorkerContainer> {
reflect_dom_object(box ServiceWorkerContainer::new_inherited(), global, Wrap)
}
}

pub trait Controllable {
fn set_controller(&self, active_worker: &ServiceWorker);
}

impl Controllable for ServiceWorkerContainer {
fn set_controller(&self, active_worker: &ServiceWorker) {
self.controller.set(Some(active_worker));
self.upcast::<EventTarget>().fire_event(atom!("controllerchange"));
let client = Client::new(&global.as_window());
let container = ServiceWorkerContainer::new_inherited(&*client);
reflect_dom_object(box container, global, Wrap)
}
}

impl ServiceWorkerContainerMethods for ServiceWorkerContainer {
// https://w3c.github.io/ServiceWorker/#service-worker-container-controller-attribute
fn GetController(&self) -> Option<Root<ServiceWorker>> {
return self.controller.get()
self.client.get_controller()
}

#[allow(unrooted_must_root)]
// https://w3c.github.io/ServiceWorker/#service-worker-container-register-method
// https://w3c.github.io/ServiceWorker/#service-worker-container-register-method and - A
// https://w3c.github.io/ServiceWorker/#start-register-algorithm - B
fn Register(&self,
script_url: USVString,
options: &RegistrationOptions) -> Rc<Promise> {
// A: Step 1
let promise = Promise::new(&*self.global());
let ctx = self.global().get_cx();
let ctx = (&*self.global()).get_cx();
let USVString(ref script_url) = script_url;
let api_base_url = self.global().api_base_url();
// Step 3-4
// A: Step 3-5
let script_url = match api_base_url.join(script_url) {
Ok(url) => url,
Err(_) => {
promise.reject_error(ctx, Error::Type("Invalid script URL".to_owned()));
return promise;
}
};
// Step 5
// B: Step 2
match script_url.scheme() {
"https" | "http" => {},
_ => {
promise.reject_error(ctx, Error::Type("Only secure origins are allowed".to_owned()));
return promise;
}
}
// Step 6
// B: Step 3
if script_url.path().to_ascii_lowercase().contains("%2f") ||
script_url.path().to_ascii_lowercase().contains("%5c") {
promise.reject_error(ctx, Error::Type("Script URL contains forbidden characters".to_owned()));
return promise;
}
// Step 8-9
// B: Step 4-5
let scope = match options.scope {
Some(ref scope) => {
let &USVString(ref inner_scope) = scope;
Expand All @@ -100,29 +96,24 @@ impl ServiceWorkerContainerMethods for ServiceWorkerContainer {
},
None => script_url.join("./").unwrap()
};
// Step 11
// B: Step 6
match scope.scheme() {
"https" | "http" => {},
_ => {
promise.reject_error(ctx, Error::Type("Only secure origins are allowed".to_owned()));
return promise;
}
}
// Step 12
// B: Step 7
if scope.path().to_ascii_lowercase().contains("%2f") ||
scope.path().to_ascii_lowercase().contains("%5c") {
promise.reject_error(ctx, Error::Type("Scope URL contains forbidden characters".to_owned()));
return promise;
}

let global = self.global();
let worker_registration = ServiceWorkerRegistration::new(&global,
script_url,
scope.clone(),
self);
ScriptThread::set_registration(scope, &*worker_registration, self.global().pipeline_id());

promise.resolve_native(ctx, &*worker_registration);
// B: Step 8
let job = Job::create_job(JobType::Register, scope, script_url, promise.clone(), &*self.client);
ScriptThread::schedule_job(job, &*self.global());
promise
}
}
38 changes: 29 additions & 9 deletions components/script/dom/serviceworkerregistration.rs
Expand Up @@ -10,18 +10,20 @@ use dom::bindings::str::USVString;
use dom::eventtarget::EventTarget;
use dom::globalscope::GlobalScope;
use dom::serviceworker::ServiceWorker;
use dom::serviceworkercontainer::Controllable;
use dom::workerglobalscope::prepare_workerscope_init;
use script_traits::{WorkerScriptLoadOrigin, ScopeThings};
use servo_url::ServoUrl;
use std::cell::Cell;


#[dom_struct]
pub struct ServiceWorkerRegistration {
eventtarget: EventTarget,
active: Option<JS<ServiceWorker>>,
installing: Option<JS<ServiceWorker>>,
waiting: Option<JS<ServiceWorker>>,
scope: String
scope: ServoUrl,
uninstalling: Cell<bool>
}

impl ServiceWorkerRegistration {
Expand All @@ -31,24 +33,31 @@ impl ServiceWorkerRegistration {
active: Some(JS::from_ref(active_sw)),
installing: None,
waiting: None,
scope: scope.as_str().to_owned(),
scope: scope,
uninstalling: Cell::new(false)
}
}
#[allow(unrooted_must_root)]
pub fn new(global: &GlobalScope,
script_url: ServoUrl,
scope: ServoUrl,
container: &Controllable) -> Root<ServiceWorkerRegistration> {
script_url: &ServoUrl,
scope: ServoUrl) -> Root<ServiceWorkerRegistration> {
let active_worker = ServiceWorker::install_serviceworker(global, script_url.clone(), scope.clone(), true);
active_worker.set_transition_state(ServiceWorkerState::Installed);
container.set_controller(&*active_worker.clone());
reflect_dom_object(box ServiceWorkerRegistration::new_inherited(&*active_worker, scope), global, Wrap)
}

pub fn get_installed(&self) -> &ServiceWorker {
self.active.as_ref().unwrap()
}

pub fn get_uninstalling(&self) -> bool {
self.uninstalling.get()
}

pub fn set_uninstalling(&self, flag: bool) {
self.uninstalling.set(flag)
}

pub fn create_scope_things(global: &GlobalScope, script_url: ServoUrl) -> ScopeThings {
let worker_load_origin = WorkerScriptLoadOrigin {
referrer_url: None,
Expand All @@ -58,7 +67,7 @@ impl ServiceWorkerRegistration {

let worker_id = global.get_next_worker_id();
let devtools_chan = global.devtools_chan().cloned();
let init = prepare_workerscope_init(global, None);
let init = prepare_workerscope_init(&global, None);
ScopeThings {
script_url: script_url,
init: init,
Expand All @@ -67,6 +76,17 @@ impl ServiceWorkerRegistration {
worker_id: worker_id
}
}

// https://w3c.github.io/ServiceWorker/#get-newest-worker-algorithm
pub fn get_newest_worker(&self) -> Option<Root<ServiceWorker>> {
if self.installing.as_ref().is_some() {
self.installing.as_ref().map(|sw| Root::from_ref(&**sw))
} else if self.waiting.as_ref().is_some() {
self.waiting.as_ref().map(|sw| Root::from_ref(&**sw))
} else {
self.active.as_ref().map(|sw| Root::from_ref(&**sw))
}
}
}

pub fn longest_prefix_match(stored_scope: &ServoUrl, potential_match: &ServoUrl) -> bool {
Expand Down Expand Up @@ -100,6 +120,6 @@ impl ServiceWorkerRegistrationMethods for ServiceWorkerRegistration {

// https://w3c.github.io/ServiceWorker/#service-worker-registration-scope-attribute
fn Scope(&self) -> USVString {
USVString(self.scope.clone())
USVString(self.scope.as_str().to_owned())
}
}
14 changes: 14 additions & 0 deletions components/script/dom/urlhelper.rs
Expand Up @@ -92,4 +92,18 @@ impl UrlHelper {
let _ = quirks::set_username(url, &value.0);
}
}
// https://w3c.github.io/webappsec-secure-contexts/#is-origin-trustworthy
pub fn is_origin_trustworthy(url: &ServoUrl) -> bool {
// Step 3
if url.scheme() == "http" || url.scheme() == "wss" {
true
// Step 4
} else if url.host().is_some() {
let host = url.host_str().unwrap();
host == "127.0.0.0/8" || host == "::1/128"
// Step 5
} else {
url.scheme() == "file"
}
}
}
1 change: 1 addition & 0 deletions components/script/lib.rs
Expand Up @@ -113,6 +113,7 @@ pub mod script_runtime;
#[allow(unsafe_code)]
pub mod script_thread;
mod serviceworker_manager;
mod serviceworkerjob;
mod task_source;
pub mod textinput;
mod timers;
Expand Down

0 comments on commit 114c491

Please sign in to comment.