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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
use std::sync::mpsc;
use std::sync::mpsc::{RecvTimeoutError, TryRecvError};
use std::sync::Arc;
use std::sync::Mutex;
use std::time::Duration;
use failure::Fallible;
use log::*;
use serde;
pub use process::LaunchOptionsBuilder;
use process::{LaunchOptions, Process};
pub use tab::Tab;
use transport::Transport;
use which::which;
use crate::browser::context::Context;
use crate::protocol::browser::methods::GetVersion;
pub use crate::protocol::browser::methods::VersionInformationReturnObject;
use crate::protocol::target::methods::{CreateTarget, SetDiscoverTargets};
use crate::protocol::{self, Event};
use crate::util;
pub mod context;
#[cfg(feature = "fetch")]
mod fetcher;
mod process;
pub mod tab;
mod transport;
pub struct Browser {
process: Option<Process>,
transport: Arc<Transport>,
tabs: Arc<Mutex<Vec<Arc<Tab>>>>,
loop_shutdown_tx: mpsc::Sender<()>,
}
impl Browser {
pub fn new(launch_options: LaunchOptions) -> Fallible<Self> {
let idle_browser_timeout = launch_options.idle_browser_timeout;
let process = Process::new(launch_options)?;
let process_id = process.get_id();
let transport = Arc::new(Transport::new(
process.debug_ws_url.clone(),
Some(process_id),
idle_browser_timeout,
)?);
Self::create_browser(Some(process), transport, idle_browser_timeout)
}
pub fn default() -> Fallible<Self> {
let launch_options = LaunchOptionsBuilder::default()
.path(Some(default_executable().unwrap()))
.build()
.unwrap();
Ok(Self::new(launch_options).unwrap())
}
pub fn connect(debug_ws_url: String) -> Fallible<Self> {
let transport = Arc::new(Transport::new(debug_ws_url, None, Duration::from_secs(30))?);
trace!("created transport");
Self::create_browser(None, transport, Duration::from_secs(30))
}
fn create_browser(
process: Option<Process>,
transport: Arc<Transport>,
idle_browser_timeout: Duration,
) -> Fallible<Self> {
let tabs = Arc::new(Mutex::new(vec![]));
let (shutdown_tx, shutdown_rx) = mpsc::channel();
let browser = Self {
process,
tabs,
transport,
loop_shutdown_tx: shutdown_tx,
};
let incoming_events_rx = browser.transport.listen_to_browser_events();
browser.handle_browser_level_events(
incoming_events_rx,
browser.get_process_id(),
shutdown_rx,
idle_browser_timeout,
);
trace!("created browser event listener");
trace!("Calling set discover");
browser.call_method(SetDiscoverTargets { discover: true })?;
browser.wait_for_initial_tab()?;
Ok(browser)
}
pub fn get_process_id(&self) -> Option<u32> {
if let Some(process) = &self.process {
Some(process.get_id())
} else {
None
}
}
pub fn get_tabs(&self) -> &Arc<Mutex<Vec<Arc<Tab>>>> {
&self.tabs
}
pub fn wait_for_initial_tab(&self) -> Fallible<Arc<Tab>> {
util::Wait::with_timeout(Duration::from_secs(10))
.until(|| self.tabs.lock().unwrap().first().map(|tab| Arc::clone(tab)))
.map_err(Into::into)
}
pub fn new_tab(&self) -> Fallible<Arc<Tab>> {
let default_blank_tab = CreateTarget {
url: "about:blank",
width: None,
height: None,
browser_context_id: None,
enable_begin_frame_control: None,
};
self.new_tab_with_options(default_blank_tab)
}
pub fn new_tab_with_options(&self, create_target_params: CreateTarget) -> Fallible<Arc<Tab>> {
let target_id = self.call_method(create_target_params)?.target_id;
util::Wait::with_timeout(Duration::from_secs(20))
.until(|| {
let tabs = self.tabs.lock().unwrap();
tabs.iter().find_map(|tab| {
if *tab.get_target_id() == target_id {
Some(tab.clone())
} else {
None
}
})
})
.map_err(Into::into)
}
pub fn new_context(&self) -> Fallible<context::Context> {
debug!("Creating new browser context");
let context_id = self
.call_method(protocol::target::methods::CreateBrowserContext {})?
.browser_context_id;
debug!("Created new browser context: {:?}", context_id);
Ok(Context::new(self, context_id))
}
pub fn get_version(&self) -> Fallible<VersionInformationReturnObject> {
self.call_method(GetVersion {})
}
fn handle_browser_level_events(
&self,
events_rx: mpsc::Receiver<Event>,
process_id: Option<u32>,
shutdown_rx: mpsc::Receiver<()>,
idle_browser_timeout: Duration,
) {
let tabs = Arc::clone(&self.tabs);
let transport = Arc::clone(&self.transport);
std::thread::spawn(move || {
trace!("Starting browser's event handling loop");
loop {
match shutdown_rx.try_recv() {
Ok(_) | Err(TryRecvError::Disconnected) => {
info!("Browser event loop received shutdown message");
break;
}
Err(TryRecvError::Empty) => {}
}
match events_rx.recv_timeout(idle_browser_timeout) {
Err(recv_timeout_error) => {
match recv_timeout_error {
RecvTimeoutError::Timeout => {
error!(
"Got a timeout while listening for browser events (Chrome #{:?})",
process_id
);
}
RecvTimeoutError::Disconnected => {
debug!(
"Browser event sender disconnected while loop was waiting (Chrome #{:?})",
process_id
);
}
}
break;
}
Ok(event) => {
match event {
Event::TargetCreated(ev) => {
let target_info = ev.params.target_info;
trace!("Creating target: {:?}", target_info);
if target_info.target_type.is_page() {
match Tab::new(target_info, Arc::clone(&transport)) {
Ok(new_tab) => {
tabs.lock().unwrap().push(Arc::new(new_tab));
}
Err(_tab_creation_err) => {
info!("Failed to create a handle to new tab");
break;
}
}
}
}
Event::TargetInfoChanged(ev) => {
let target_info = ev.params.target_info;
trace!("Target info changed: {:?}", target_info);
if target_info.target_type.is_page() {
let locked_tabs = tabs.lock().unwrap();
let updated_tab = locked_tabs
.iter()
.find(|tab| *tab.get_target_id() == target_info.target_id)
.expect("got TargetInfoChanged event about a tab not in our list");
updated_tab.update_target_info(target_info);
}
}
Event::TargetDestroyed(ev) => {
trace!("Target destroyed: {:?}", ev.params.target_id);
}
_ => {
let mut raw_event = format!("{:?}", event);
raw_event.truncate(50);
trace!("Unhandled event: {}", raw_event);
}
}
}
}
}
info!("Finished browser's event handling loop");
});
}
fn call_method<C>(&self, method: C) -> Fallible<C::ReturnObject>
where
C: protocol::Method + serde::Serialize,
{
self.transport.call_method_on_browser(method)
}
#[allow(dead_code)]
#[cfg(test)]
pub(crate) fn process(&self) -> Option<&Process> {
#[allow(clippy::used_underscore_binding)]
self.process.as_ref()
}
}
impl Drop for Browser {
fn drop(&mut self) {
info!("Dropping browser");
let _ = self.loop_shutdown_tx.send(());
self.transport.shutdown();
}
}
pub fn default_executable() -> Result<std::path::PathBuf, String> {
if let Ok(path) = std::env::var("CHROME") {
if std::path::Path::new(&path).exists() {
return Ok(path.into());
}
}
for app in &[
"google-chrome-stable",
"chromium",
"chromium-browser",
"chrome",
"chrome-browser",
] {
if let Ok(path) = which(app) {
return Ok(path);
}
}
#[cfg(target_os = "macos")]
{
let default_paths = &["/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"][..];
for path in default_paths {
if std::path::Path::new(path).exists() {
return Ok(path.into());
}
}
}
#[cfg(windows)]
{
use crate::browser::process::get_chrome_path_from_registry;
if let Some(path) = get_chrome_path_from_registry() {
if path.exists() {
return Ok(path);
}
}
}
Err("Could not auto detect a chrome executable".to_string())
}