Skip to main content

chaser_oxide/handler/
target.rs

1use std::collections::VecDeque;
2use std::pin::Pin;
3use std::sync::Arc;
4use std::time::Instant;
5
6use chromiumoxide_cdp::cdp::browser_protocol::target::DetachFromTargetParams;
7use futures::channel::oneshot::Sender;
8use futures::stream::Stream;
9use futures::task::{Context, Poll};
10
11use chromiumoxide_cdp::cdp::browser_protocol::page::{FrameId, GetFrameTreeParams};
12use chromiumoxide_cdp::cdp::browser_protocol::{
13    browser::BrowserContextId,
14    log as cdplog, performance,
15    target::{AttachToTargetParams, SessionId, SetAutoAttachParams, TargetId, TargetInfo},
16};
17use chromiumoxide_cdp::cdp::events::CdpEvent;
18use chromiumoxide_cdp::cdp::CdpEventMessage;
19use chromiumoxide_types::{Command, Method, Request, Response};
20
21use crate::auth::Credentials;
22use crate::cdp::browser_protocol::target::CloseTargetParams;
23use crate::cmd::CommandChain;
24use crate::cmd::CommandMessage;
25use crate::error::{CdpError, Result};
26use crate::handler::browser::BrowserContext;
27use crate::handler::domworld::DOMWorldKind;
28use crate::handler::emulation::EmulationManager;
29use crate::handler::frame::{
30    FrameEvent, FrameManager, NavigationError, NavigationId, NavigationOk,
31};
32use crate::handler::frame::{FrameNavigationRequest, UTILITY_WORLD_NAME};
33use crate::handler::network::{NetworkEvent, NetworkManager};
34use crate::handler::page::PageHandle;
35use crate::handler::viewport::Viewport;
36use crate::handler::{PageInner, REQUEST_TIMEOUT};
37use crate::listeners::{EventListenerRequest, EventListeners};
38use crate::{page::Page, ArcHttpRequest};
39use chromiumoxide_cdp::cdp::js_protocol::runtime::{
40    ExecutionContextId, RunIfWaitingForDebuggerParams,
41};
42use std::time::Duration;
43
44macro_rules! advance_state {
45    ($s:ident, $cx:ident, $now:ident, $cmds: ident, $next_state:expr ) => {{
46        if let Poll::Ready(poll) = $cmds.poll($now) {
47            return match poll {
48                None => {
49                    $s.init_state = $next_state;
50                    $s.poll($cx, $now)
51                }
52                Some(Ok((method, params))) => Some(TargetEvent::Request(Request {
53                    method,
54                    session_id: $s.session_id.clone().map(Into::into),
55                    params,
56                })),
57                Some(Err(_)) => Some($s.on_initialization_failed()),
58            };
59        } else {
60            return None;
61        }
62    }};
63}
64
65#[derive(Debug)]
66pub struct Target {
67    /// Info about this target as returned from the chromium instance
68    info: TargetInfo,
69    /// The type of this target
70    r#type: TargetType,
71    /// Configs for this target
72    config: TargetConfig,
73    /// The context this target is running in
74    browser_context: BrowserContext,
75    /// The frame manager that maintains the state of all frames and handles
76    /// navigations of frames
77    frame_manager: FrameManager,
78    /// Handles all the https
79    network_manager: NetworkManager,
80    emulation_manager: EmulationManager,
81    /// The identifier of the session this target is attached to
82    session_id: Option<SessionId>,
83    /// The handle of the browser page of this target
84    page: Option<PageHandle>,
85    /// Drives this target towards initialization
86    init_state: TargetInit,
87    /// Currently queued events to report to the `Handler`
88    queued_events: VecDeque<TargetEvent>,
89    /// All registered event subscriptions
90    event_listeners: EventListeners,
91    /// Senders that need to be notified once the main frame has loaded
92    wait_for_frame_navigation: Vec<Sender<ArcHttpRequest>>,
93    /// The sender who requested the page.
94    initiator: Option<Sender<Result<Page>>>,
95}
96
97impl Target {
98    /// Create a new target instance with `TargetInfo` after a
99    /// `CreateTargetParams` request.
100    pub fn new(info: TargetInfo, config: TargetConfig, browser_context: BrowserContext) -> Self {
101        let ty = TargetType::new(&info.r#type);
102        let request_timeout = config.request_timeout;
103        let mut network_manager = NetworkManager::new(config.ignore_https_errors, request_timeout);
104
105        network_manager.set_cache_enabled(config.cache_enabled);
106        network_manager.set_request_interception(config.request_intercept);
107
108        Self {
109            info,
110            r#type: ty,
111            config,
112            frame_manager: FrameManager::new(request_timeout),
113            network_manager,
114            emulation_manager: EmulationManager::new(request_timeout),
115            session_id: None,
116            page: None,
117            init_state: TargetInit::AttachToTarget,
118            wait_for_frame_navigation: Default::default(),
119            queued_events: Default::default(),
120            event_listeners: Default::default(),
121            initiator: None,
122            browser_context,
123        }
124    }
125
126    pub fn set_session_id(&mut self, id: SessionId) {
127        self.session_id = Some(id)
128    }
129
130    pub fn session_id(&self) -> Option<&SessionId> {
131        self.session_id.as_ref()
132    }
133
134    pub fn browser_context(&self) -> &BrowserContext {
135        &self.browser_context
136    }
137
138    pub fn session_id_mut(&mut self) -> &mut Option<SessionId> {
139        &mut self.session_id
140    }
141
142    /// The identifier for this target
143    pub fn target_id(&self) -> &TargetId {
144        &self.info.target_id
145    }
146
147    /// The type of this target
148    pub fn r#type(&self) -> &TargetType {
149        &self.r#type
150    }
151
152    /// Whether this target is already initialized
153    pub fn is_initialized(&self) -> bool {
154        matches!(self.init_state, TargetInit::Initialized)
155    }
156
157    /// Navigate a frame
158    pub fn goto(&mut self, req: FrameNavigationRequest) {
159        self.frame_manager.goto(req)
160    }
161
162    fn create_page(&mut self) {
163        if self.page.is_none() {
164            if let Some(session) = self.session_id.clone() {
165                let handle =
166                    PageHandle::new(self.target_id().clone(), session, self.opener_id().cloned());
167                self.page = Some(handle);
168            }
169        }
170    }
171
172    /// Tries to create the `PageInner` if this target is already initialized
173    pub(crate) fn get_or_create_page(&mut self) -> Option<&Arc<PageInner>> {
174        self.create_page();
175        self.page.as_ref().map(|p| p.inner())
176    }
177
178    pub fn is_page(&self) -> bool {
179        self.r#type().is_page()
180    }
181
182    pub fn browser_context_id(&self) -> Option<&BrowserContextId> {
183        self.info.browser_context_id.as_ref()
184    }
185
186    pub fn info(&self) -> &TargetInfo {
187        &self.info
188    }
189
190    /// Get the target that opened this target. Top-level targets return `None`.
191    pub fn opener_id(&self) -> Option<&TargetId> {
192        self.info.opener_id.as_ref()
193    }
194
195    pub fn frame_manager(&self) -> &FrameManager {
196        &self.frame_manager
197    }
198
199    pub fn frame_manager_mut(&mut self) -> &mut FrameManager {
200        &mut self.frame_manager
201    }
202
203    pub fn event_listeners_mut(&mut self) -> &mut EventListeners {
204        &mut self.event_listeners
205    }
206
207    /// Received a response to a command issued by this target
208    pub fn on_response(&mut self, resp: Response, method: &str) {
209        if let Some(cmds) = self.init_state.commands_mut() {
210            cmds.received_response(method);
211        }
212        #[allow(clippy::single_match)] // allow for now
213        match method {
214            GetFrameTreeParams::IDENTIFIER => {
215                if let Some(resp) = resp
216                    .result
217                    .and_then(|val| GetFrameTreeParams::response_from_value(val).ok())
218                {
219                    self.frame_manager.on_frame_tree(resp.frame_tree);
220                }
221            }
222            // requests originated from the network manager all return an empty response, hence they
223            // can be ignored here
224            _ => {}
225        }
226    }
227
228    pub fn on_event(&mut self, event: CdpEventMessage) {
229        let CdpEventMessage { params, method, .. } = event;
230        match &params {
231            // `FrameManager` events
232            CdpEvent::PageFrameAttached(ev) => self
233                .frame_manager
234                .on_frame_attached(ev.frame_id.clone(), Some(ev.parent_frame_id.clone())),
235            CdpEvent::PageFrameDetached(ev) => self.frame_manager.on_frame_detached(ev),
236            CdpEvent::PageFrameNavigated(ev) => self.frame_manager.on_frame_navigated(&ev.frame),
237            CdpEvent::PageNavigatedWithinDocument(ev) => {
238                self.frame_manager.on_frame_navigated_within_document(ev)
239            }
240            CdpEvent::RuntimeExecutionContextCreated(ev) => {
241                self.frame_manager.on_frame_execution_context_created(ev)
242            }
243            CdpEvent::RuntimeExecutionContextDestroyed(ev) => {
244                self.frame_manager.on_frame_execution_context_destroyed(ev)
245            }
246            CdpEvent::RuntimeExecutionContextsCleared(_) => {
247                self.frame_manager.on_execution_contexts_cleared()
248            }
249            CdpEvent::RuntimeBindingCalled(ev) => {
250                // TODO check if binding registered and payload is json
251                self.frame_manager.on_runtime_binding_called(ev)
252            }
253            CdpEvent::PageLifecycleEvent(ev) => self.frame_manager.on_page_lifecycle_event(ev),
254            CdpEvent::PageFrameStartedLoading(ev) => {
255                self.frame_manager.on_frame_started_loading(ev);
256            }
257
258            // `Target` events
259            CdpEvent::TargetAttachedToTarget(ev) => {
260                if ev.waiting_for_debugger {
261                    let runtime_cmd = RunIfWaitingForDebuggerParams::default();
262
263                    self.queued_events.push_back(TargetEvent::Request(Request {
264                        method: runtime_cmd.identifier(),
265                        session_id: Some(ev.session_id.clone().into()),
266                        params: serde_json::to_value(runtime_cmd).unwrap(),
267                    }));
268                }
269
270                if "service_worker" == &ev.target_info.r#type {
271                    let detach_command = DetachFromTargetParams::builder()
272                        .session_id(ev.session_id.clone())
273                        .build();
274
275                    self.queued_events.push_back(TargetEvent::Request(Request {
276                        method: detach_command.identifier(),
277                        session_id: self.session_id.clone().map(Into::into),
278                        params: serde_json::to_value(detach_command).unwrap(),
279                    }));
280                }
281            }
282
283            // `NetworkManager` events
284            CdpEvent::FetchRequestPaused(ev) => self.network_manager.on_fetch_request_paused(ev),
285            CdpEvent::FetchAuthRequired(ev) => self.network_manager.on_fetch_auth_required(ev),
286            CdpEvent::NetworkRequestWillBeSent(ev) => {
287                self.network_manager.on_request_will_be_sent(ev)
288            }
289            CdpEvent::NetworkRequestServedFromCache(ev) => {
290                self.network_manager.on_request_served_from_cache(ev)
291            }
292            CdpEvent::NetworkResponseReceived(ev) => self.network_manager.on_response_received(ev),
293            CdpEvent::NetworkLoadingFinished(ev) => {
294                self.network_manager.on_network_loading_finished(ev)
295            }
296            CdpEvent::NetworkLoadingFailed(ev) => {
297                self.network_manager.on_network_loading_failed(ev)
298            }
299            _ => {}
300        }
301        chromiumoxide_cdp::consume_event!(match params {
302           |ev| self.event_listeners.start_send(ev),
303           |json| { let _ = self.event_listeners.try_send_custom(&method, json);}
304        });
305    }
306
307    /// Called when a init command timed out
308    fn on_initialization_failed(&mut self) -> TargetEvent {
309        if let Some(initiator) = self.initiator.take() {
310            let _ = initiator.send(Err(CdpError::Timeout));
311        }
312        self.init_state = TargetInit::Closing;
313        let close_target = CloseTargetParams::new(self.info.target_id.clone());
314        TargetEvent::Request(Request {
315            method: close_target.identifier(),
316            session_id: self.session_id.clone().map(Into::into),
317            params: serde_json::to_value(close_target).unwrap(),
318        })
319    }
320
321    /// Advance that target's state
322    pub(crate) fn poll(&mut self, cx: &mut Context<'_>, now: Instant) -> Option<TargetEvent> {
323        if !self.is_page() {
324            // can only poll pages
325            return None;
326        }
327        match &mut self.init_state {
328            TargetInit::AttachToTarget => {
329                self.init_state = TargetInit::InitializingFrame(FrameManager::init_commands(
330                    self.config.request_timeout,
331                ));
332                let params = AttachToTargetParams::builder()
333                    .target_id(self.target_id().clone())
334                    .flatten(true)
335                    .build()
336                    .unwrap();
337
338                return Some(TargetEvent::Request(Request::new(
339                    params.identifier(),
340                    serde_json::to_value(params).unwrap(),
341                )));
342            }
343            TargetInit::InitializingFrame(cmds) => {
344                self.session_id.as_ref()?;
345                if let Poll::Ready(poll) = cmds.poll(now) {
346                    return match poll {
347                        None => {
348                            if let Some(isolated_world_cmds) =
349                                self.frame_manager.ensure_isolated_world(UTILITY_WORLD_NAME)
350                            {
351                                *cmds = isolated_world_cmds;
352                            } else {
353                                self.init_state = TargetInit::InitializingNetwork(
354                                    self.network_manager.init_commands(),
355                                );
356                            }
357                            self.poll(cx, now)
358                        }
359                        Some(Ok((method, params))) => Some(TargetEvent::Request(Request {
360                            method,
361                            session_id: self.session_id.clone().map(Into::into),
362                            params,
363                        })),
364                        Some(Err(_)) => Some(self.on_initialization_failed()),
365                    };
366                } else {
367                    return None;
368                }
369            }
370            TargetInit::InitializingNetwork(cmds) => {
371                advance_state!(
372                    self,
373                    cx,
374                    now,
375                    cmds,
376                    TargetInit::InitializingPage(Self::page_init_commands(
377                        self.config.request_timeout
378                    ))
379                );
380            }
381            TargetInit::InitializingPage(cmds) => {
382                advance_state!(
383                    self,
384                    cx,
385                    now,
386                    cmds,
387                    match self.config.viewport.as_ref() {
388                        Some(viewport) => TargetInit::InitializingEmulation(
389                            self.emulation_manager.init_commands(viewport)
390                        ),
391                        None => TargetInit::Initialized,
392                    }
393                );
394            }
395            TargetInit::InitializingEmulation(cmds) => {
396                advance_state!(self, cx, now, cmds, TargetInit::Initialized);
397            }
398            TargetInit::Initialized => {
399                if let Some(initiator) = self.initiator.take() {
400                    // make sure that the main frame of the page has finished loading
401                    if self
402                        .frame_manager
403                        .main_frame()
404                        .map(|frame| frame.is_loaded())
405                        .unwrap_or_default()
406                    {
407                        if let Some(page) = self.get_or_create_page() {
408                            let _ = initiator.send(Ok(page.clone().into()));
409                        } else {
410                            self.initiator = Some(initiator);
411                        }
412                    } else {
413                        self.initiator = Some(initiator);
414                    }
415                }
416            }
417            TargetInit::Closing => return None,
418        };
419        loop {
420            if let Some(frame) = self.frame_manager.main_frame() {
421                if frame.is_loaded() {
422                    while let Some(tx) = self.wait_for_frame_navigation.pop() {
423                        let _ = tx.send(frame.http_request().cloned());
424                    }
425                }
426            }
427
428            // Drain queued messages first.
429            if let Some(ev) = self.queued_events.pop_front() {
430                return Some(ev);
431            }
432
433            if let Some(handle) = self.page.as_mut() {
434                while let Poll::Ready(Some(msg)) = Pin::new(&mut handle.rx).poll_next(cx) {
435                    match msg {
436                        TargetMessage::Command(cmd) => {
437                            self.queued_events.push_back(TargetEvent::Command(cmd));
438                        }
439                        TargetMessage::MainFrame(tx) => {
440                            let _ =
441                                tx.send(self.frame_manager.main_frame().map(|f| f.id().clone()));
442                        }
443                        TargetMessage::AllFrames(tx) => {
444                            let _ = tx.send(
445                                self.frame_manager
446                                    .frames()
447                                    .map(|f| f.id().clone())
448                                    .collect(),
449                            );
450                        }
451                        TargetMessage::Url(req) => {
452                            let GetUrl { frame_id, tx } = req;
453                            let frame = if let Some(frame_id) = frame_id {
454                                self.frame_manager.frame(&frame_id)
455                            } else {
456                                self.frame_manager.main_frame()
457                            };
458                            let _ = tx.send(frame.and_then(|f| f.url().map(str::to_string)));
459                        }
460                        TargetMessage::Name(req) => {
461                            let GetName { frame_id, tx } = req;
462                            let frame = if let Some(frame_id) = frame_id {
463                                self.frame_manager.frame(&frame_id)
464                            } else {
465                                self.frame_manager.main_frame()
466                            };
467                            let _ = tx.send(frame.and_then(|f| f.name().map(str::to_string)));
468                        }
469                        TargetMessage::Parent(req) => {
470                            let GetParent { frame_id, tx } = req;
471                            let frame = self.frame_manager.frame(&frame_id);
472                            let _ = tx.send(frame.and_then(|f| f.parent_id().cloned()));
473                        }
474                        TargetMessage::WaitForNavigation(tx) => {
475                            if let Some(frame) = self.frame_manager.main_frame() {
476                                // TODO submit a navigation watcher: waitForFrameNavigation
477
478                                // TODO return the watchers navigationResponse
479                                if frame.is_loaded() {
480                                    let _ = tx.send(frame.http_request().cloned());
481                                } else {
482                                    self.wait_for_frame_navigation.push(tx);
483                                }
484                            } else {
485                                self.wait_for_frame_navigation.push(tx);
486                            }
487                        }
488                        TargetMessage::AddEventListener(req) => {
489                            // register a new listener
490                            self.event_listeners.add_listener(req);
491                        }
492                        TargetMessage::GetExecutionContext(ctx) => {
493                            let GetExecutionContext {
494                                dom_world,
495                                frame_id,
496                                tx,
497                            } = ctx;
498                            let frame = if let Some(frame_id) = frame_id {
499                                self.frame_manager.frame(&frame_id)
500                            } else {
501                                self.frame_manager.main_frame()
502                            };
503
504                            if let Some(frame) = frame {
505                                match dom_world {
506                                    DOMWorldKind::Main => {
507                                        let _ = tx.send(frame.main_world().execution_context());
508                                    }
509                                    DOMWorldKind::Secondary => {
510                                        let _ =
511                                            tx.send(frame.secondary_world().execution_context());
512                                    }
513                                }
514                            } else {
515                                let _ = tx.send(None);
516                            }
517                        }
518                        TargetMessage::Authenticate(credentials) => {
519                            self.network_manager.authenticate(credentials);
520                        }
521                    }
522                }
523            }
524
525            while let Some(event) = self.network_manager.poll() {
526                match event {
527                    NetworkEvent::SendCdpRequest((method, params)) => {
528                        // send a message to the browser
529                        self.queued_events.push_back(TargetEvent::Request(Request {
530                            method,
531                            session_id: self.session_id.clone().map(Into::into),
532                            params,
533                        }))
534                    }
535                    NetworkEvent::Request(_) => {}
536                    NetworkEvent::Response(_) => {}
537                    NetworkEvent::RequestFailed(request) => {
538                        self.frame_manager.on_http_request_finished(request);
539                    }
540                    NetworkEvent::RequestFinished(request) => {
541                        self.frame_manager.on_http_request_finished(request);
542                    }
543                }
544            }
545
546            while let Some(event) = self.frame_manager.poll(now) {
547                match event {
548                    FrameEvent::NavigationResult(res) => {
549                        self.queued_events
550                            .push_back(TargetEvent::NavigationResult(res));
551                    }
552                    FrameEvent::NavigationRequest(id, req) => {
553                        self.queued_events
554                            .push_back(TargetEvent::NavigationRequest(id, req));
555                    }
556                }
557            }
558
559            if self.queued_events.is_empty() {
560                return None;
561            }
562        }
563    }
564
565    /// Set the sender half of the channel who requested the creation of this
566    /// target
567    pub fn set_initiator(&mut self, tx: Sender<Result<Page>>) {
568        self.initiator = Some(tx);
569    }
570
571    pub(crate) fn page_init_commands(timeout: Duration) -> CommandChain {
572        let attach = SetAutoAttachParams::builder()
573            .flatten(true)
574            .auto_attach(true)
575            .wait_for_debugger_on_start(true)
576            .build()
577            .unwrap();
578        let enable_performance = performance::EnableParams::default();
579        let enable_log = cdplog::EnableParams::default();
580        CommandChain::new(
581            vec![
582                (attach.identifier(), serde_json::to_value(attach).unwrap()),
583                (
584                    enable_performance.identifier(),
585                    serde_json::to_value(enable_performance).unwrap(),
586                ),
587                (
588                    enable_log.identifier(),
589                    serde_json::to_value(enable_log).unwrap(),
590                ),
591            ],
592            timeout,
593        )
594    }
595}
596
597#[derive(Debug, Clone)]
598pub struct TargetConfig {
599    pub ignore_https_errors: bool,
600    ///  Request timeout to use
601    pub request_timeout: Duration,
602    pub viewport: Option<Viewport>,
603    pub request_intercept: bool,
604    pub cache_enabled: bool,
605}
606
607impl Default for TargetConfig {
608    fn default() -> Self {
609        Self {
610            ignore_https_errors: true,
611            request_timeout: Duration::from_secs(REQUEST_TIMEOUT),
612            viewport: Default::default(),
613            request_intercept: false,
614            cache_enabled: true,
615        }
616    }
617}
618
619#[derive(Debug, Clone, Eq, PartialEq)]
620pub enum TargetType {
621    Page,
622    BackgroundPage,
623    ServiceWorker,
624    SharedWorker,
625    Other,
626    Browser,
627    Webview,
628    Unknown(String),
629}
630
631impl TargetType {
632    pub fn new(ty: &str) -> Self {
633        match ty {
634            "page" => TargetType::Page,
635            "background_page" => TargetType::BackgroundPage,
636            "service_worker" => TargetType::ServiceWorker,
637            "shared_worker" => TargetType::SharedWorker,
638            "other" => TargetType::Other,
639            "browser" => TargetType::Browser,
640            "webview" => TargetType::Webview,
641            s => TargetType::Unknown(s.to_string()),
642        }
643    }
644
645    pub fn is_page(&self) -> bool {
646        matches!(self, TargetType::Page)
647    }
648
649    pub fn is_background_page(&self) -> bool {
650        matches!(self, TargetType::BackgroundPage)
651    }
652
653    pub fn is_service_worker(&self) -> bool {
654        matches!(self, TargetType::ServiceWorker)
655    }
656
657    pub fn is_shared_worker(&self) -> bool {
658        matches!(self, TargetType::SharedWorker)
659    }
660
661    pub fn is_other(&self) -> bool {
662        matches!(self, TargetType::Other)
663    }
664
665    pub fn is_browser(&self) -> bool {
666        matches!(self, TargetType::Browser)
667    }
668
669    pub fn is_webview(&self) -> bool {
670        matches!(self, TargetType::Webview)
671    }
672}
673
674#[derive(Debug)]
675pub(crate) enum TargetEvent {
676    /// An internal request
677    Request(Request),
678    /// An internal navigation request
679    NavigationRequest(NavigationId, Request),
680    /// Indicates that a previous requested navigation has finished
681    NavigationResult(Result<NavigationOk, NavigationError>),
682    /// A new command arrived via a channel
683    Command(CommandMessage),
684}
685
686// TODO this can be moved into the classes?
687#[derive(Debug)]
688pub enum TargetInit {
689    InitializingFrame(CommandChain),
690    InitializingNetwork(CommandChain),
691    InitializingPage(CommandChain),
692    InitializingEmulation(CommandChain),
693    AttachToTarget,
694    Initialized,
695    Closing,
696}
697
698impl TargetInit {
699    fn commands_mut(&mut self) -> Option<&mut CommandChain> {
700        match self {
701            TargetInit::InitializingFrame(cmd) => Some(cmd),
702            TargetInit::InitializingNetwork(cmd) => Some(cmd),
703            TargetInit::InitializingPage(cmd) => Some(cmd),
704            TargetInit::InitializingEmulation(cmd) => Some(cmd),
705            TargetInit::AttachToTarget => None,
706            TargetInit::Initialized => None,
707            TargetInit::Closing => None,
708        }
709    }
710}
711
712#[derive(Debug)]
713pub struct GetExecutionContext {
714    /// For which world the execution context was requested
715    pub dom_world: DOMWorldKind,
716    /// The if of the frame to get the `ExecutionContext` for
717    pub frame_id: Option<FrameId>,
718    /// Sender half of the channel to send the response back
719    pub tx: Sender<Option<ExecutionContextId>>,
720}
721
722impl GetExecutionContext {
723    pub fn new(tx: Sender<Option<ExecutionContextId>>) -> Self {
724        Self {
725            dom_world: DOMWorldKind::Main,
726            frame_id: None,
727            tx,
728        }
729    }
730}
731
732#[derive(Debug)]
733pub struct GetUrl {
734    /// The id of the frame to get the url for (None = main frame)
735    pub frame_id: Option<FrameId>,
736    /// Sender half of the channel to send the response back
737    pub tx: Sender<Option<String>>,
738}
739
740impl GetUrl {
741    pub fn new(tx: Sender<Option<String>>) -> Self {
742        Self { frame_id: None, tx }
743    }
744}
745
746#[derive(Debug)]
747pub struct GetName {
748    /// The id of the frame to get the name for (None = main frame)
749    pub frame_id: Option<FrameId>,
750    /// Sender half of the channel to send the response back
751    pub tx: Sender<Option<String>>,
752}
753
754#[derive(Debug)]
755pub struct GetParent {
756    /// The id of the frame to get the parent for (None = main frame)
757    pub frame_id: FrameId,
758    /// Sender half of the channel to send the response back
759    pub tx: Sender<Option<FrameId>>,
760}
761
762#[derive(Debug)]
763pub enum TargetMessage {
764    /// Execute a command within the session of this target
765    Command(CommandMessage),
766    /// Return the main frame of this target's page
767    MainFrame(Sender<Option<FrameId>>),
768    /// Return all the frames of this target's page
769    AllFrames(Sender<Vec<FrameId>>),
770    /// Return the url if available
771    Url(GetUrl),
772    /// Return the name if available
773    Name(GetName),
774    /// Return the parent id of a frame
775    Parent(GetParent),
776    /// A Message that resolves when the frame finished loading a new url
777    WaitForNavigation(Sender<ArcHttpRequest>),
778    /// A request to submit a new listener that gets notified with every
779    /// received event
780    AddEventListener(EventListenerRequest),
781    /// Get the `ExecutionContext` if available
782    GetExecutionContext(GetExecutionContext),
783    Authenticate(Credentials),
784}