Skip to content

Commit

Permalink
webdriver_server: associate timeouts with session
Browse files Browse the repository at this point in the history
The WebDriver timeout configuration durations should be associated with
the session so that they do not bleed across sessions.  Since they are
currently stored on the WebDriverHandler, a call to the SetTimeouts
command will cause them to affect the subsequent session.
  • Loading branch information
andreastt committed Jan 26, 2017
1 parent 88cd8a3 commit e87c275
Showing 1 changed file with 62 additions and 32 deletions.
94 changes: 62 additions & 32 deletions components/webdriver_server/lib.rs
Expand Up @@ -96,18 +96,39 @@ pub fn start_server(port: u16, constellation_chan: Sender<ConstellationMsg>) {
}).expect("Thread spawning failed");
}

/// Represents the current WebDriver session and holds relevant session state.
struct WebDriverSession {
id: Uuid,
frame_id: Option<FrameId>
frame_id: Option<FrameId>,

/// Time to wait for injected scripts to run before interrupting them.
script_timeout: u32,

/// Time to wait for a page to finish loading upon navigation.
load_timeout: u32,

/// Time to wait for the element location strategy when retrieving elements, and when
/// waiting for an element to become interactable.
implicit_wait_timeout: u32,
}

impl WebDriverSession {
pub fn new() -> WebDriverSession {
WebDriverSession {
id: Uuid::new_v4(),
frame_id: None,

script_timeout: 30_000,
load_timeout: 300_000,
implicit_wait_timeout: 0,
}
}
}

struct Handler {
session: Option<WebDriverSession>,
constellation_chan: Sender<ConstellationMsg>,
script_timeout: u32,
load_timeout: u32,
resize_timeout: u32,
implicit_wait_timeout: u32
}

#[derive(Clone, Copy, PartialEq)]
Expand Down Expand Up @@ -230,24 +251,12 @@ impl ToJson for SetPrefsParameters {
}
}

impl WebDriverSession {
pub fn new() -> WebDriverSession {
WebDriverSession {
id: Uuid::new_v4(),
frame_id: None
}
}
}

impl Handler {
pub fn new(constellation_chan: Sender<ConstellationMsg>) -> Handler {
Handler {
session: None,
constellation_chan: constellation_chan,
script_timeout: 30_000,
load_timeout: 300_000,
resize_timeout: 500,
implicit_wait_timeout: 0
}
}

Expand Down Expand Up @@ -355,19 +364,25 @@ impl Handler {

fn wait_for_load(&self,
sender: IpcSender<LoadStatus>,
receiver: IpcReceiver<LoadStatus>) -> WebDriverResult<WebDriverResponse> {
let timeout = self.load_timeout;
receiver: IpcReceiver<LoadStatus>)
-> WebDriverResult<WebDriverResponse> {
let session = try!(self.session
.as_ref()
.ok_or(WebDriverError::new(ErrorStatus::SessionNotCreated, "")));

let timeout = session.load_timeout;
let timeout_chan = sender;
thread::spawn(move || {
thread::sleep(Duration::from_millis(timeout as u64));
let _ = timeout_chan.send(LoadStatus::LoadTimeout);
});

//Wait to get a load event
// wait to get a load event
match receiver.recv().unwrap() {
LoadStatus::LoadComplete => Ok(WebDriverResponse::Void),
LoadStatus::LoadTimeout => Err(WebDriverError::new(ErrorStatus::Timeout,
"Load timed out"))
LoadStatus::LoadTimeout => {
Err(WebDriverError::new(ErrorStatus::Timeout, "Load timed out"))
}
}
}

Expand Down Expand Up @@ -683,15 +698,24 @@ impl Handler {
}
}

fn handle_set_timeouts(&mut self, parameters: &TimeoutsParameters) -> WebDriverResult<WebDriverResponse> {
//TODO: this conversion is crazy, spec should limit these to u32 and check upstream
fn handle_set_timeouts(&mut self,
parameters: &TimeoutsParameters)
-> WebDriverResult<WebDriverResponse> {
let mut session = try!(self.session
.as_mut()
.ok_or(WebDriverError::new(ErrorStatus::SessionNotCreated, "")));

// TODO(ato): Conversation is wrong. The script timeout can be null, and the numeric
// values should be limited to u32 in the standard.
let value = parameters.ms as u32;
match &parameters.type_[..] {
"implicit" => self.implicit_wait_timeout = value,
"page load" => self.load_timeout = value,
"script" => self.script_timeout = value,
x => return Err(WebDriverError::new(ErrorStatus::InvalidSelector,
format!("Unknown timeout type {}", x)))
"script" => session.script_timeout = value,
"page load" => session.load_timeout = value,
"implicit" => session.implicit_wait_timeout = value,
x => {
return Err(WebDriverError::new(ErrorStatus::InvalidSelector,
format!("Unknown timeout type {}", x)))
}
}
Ok(WebDriverResponse::Void)
}
Expand All @@ -712,13 +736,19 @@ impl Handler {
}

fn handle_execute_async_script(&self,
parameters: &JavascriptCommandParameters) -> WebDriverResult<WebDriverResponse> {
parameters: &JavascriptCommandParameters)
-> WebDriverResult<WebDriverResponse> {
let session = try!(self.session
.as_ref()
.ok_or(WebDriverError::new(ErrorStatus::SessionNotCreated, "")));

let func_body = &parameters.script;
let args_string = "window.webdriverCallback";

let script = format!(
"setTimeout(webdriverTimeout, {}); (function(callback) {{ {} }})({})",
self.script_timeout, func_body, args_string);
let script = format!("setTimeout(webdriverTimeout, {}); (function(callback) {{ {} }})({})",
session.script_timeout,
func_body,
args_string);

let (sender, receiver) = ipc::channel().unwrap();
let command = WebDriverScriptCommand::ExecuteAsyncScript(script, sender);
Expand Down

0 comments on commit e87c275

Please sign in to comment.