Skip to main content

chromiumoxide/handler/
target.rs

1use std::collections::VecDeque;
2use std::sync::Arc;
3use std::time::Instant;
4
5use chromiumoxide_cdp::cdp::browser_protocol::target::DetachFromTargetParams;
6use std::task::{Context, Poll};
7use tokio::sync::oneshot::Sender;
8
9use tokio::sync::Notify;
10
11use crate::auth::Credentials;
12use crate::cdp::browser_protocol::target::CloseTargetParams;
13use crate::cmd::CommandChain;
14use crate::cmd::CommandMessage;
15use crate::error::{CdpError, Result};
16use crate::handler::browser::BrowserContext;
17use crate::handler::domworld::DOMWorldKind;
18use crate::handler::emulation::EmulationManager;
19use crate::handler::frame::FrameRequestedNavigation;
20use crate::handler::frame::{
21    FrameEvent, FrameManager, NavigationError, NavigationId, NavigationOk,
22};
23use crate::handler::network::{NetworkEvent, NetworkManager};
24use crate::handler::page::PageHandle;
25use crate::handler::viewport::Viewport;
26use crate::handler::{PageInner, REQUEST_TIMEOUT};
27use crate::listeners::{EventListenerRequest, EventListeners};
28use crate::{page::Page, ArcHttpRequest};
29use chromiumoxide_cdp::cdp::browser_protocol::{
30    browser::BrowserContextId,
31    log as cdplog,
32    page::{FrameId, GetFrameTreeParams},
33    target::{AttachToTargetParams, SessionId, SetAutoAttachParams, TargetId, TargetInfo},
34};
35use chromiumoxide_cdp::cdp::events::CdpEvent;
36use chromiumoxide_cdp::cdp::js_protocol::runtime::{
37    ExecutionContextId, RunIfWaitingForDebuggerParams,
38};
39use chromiumoxide_cdp::cdp::CdpEventMessage;
40use chromiumoxide_types::{Command, Method, Request, Response};
41use spider_network_blocker::intercept_manager::NetworkInterceptManager;
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
65lazy_static::lazy_static! {
66    /// Initial start command params.
67    static ref INIT_COMMANDS_PARAMS: Vec<(chromiumoxide_types::MethodId, serde_json::Value)> = {
68        if let Ok(attach) = SetAutoAttachParams::builder()
69            .flatten(true)
70            .auto_attach(true)
71            .wait_for_debugger_on_start(true)
72            .build() {
73                let disable_log = cdplog::DisableParams::default();
74
75                let mut cmds =  vec![
76                    (
77                        attach.identifier(),
78                        serde_json::to_value(attach).unwrap_or_default(),
79                    ),
80                    (
81                        disable_log.identifier(),
82                        serde_json::to_value(disable_log).unwrap_or_default(),
83                    )
84                ];
85
86                // enable performance on pages.
87                if cfg!(feature = "collect_metrics") {
88                    let enable_performance = chromiumoxide_cdp::cdp::browser_protocol::performance::EnableParams::default();
89                    cmds.push((
90                        enable_performance.identifier(),
91                        serde_json::to_value(enable_performance).unwrap_or_default(),
92                    ));
93                }
94
95                cmds
96            } else {
97                vec![]
98            }
99    };
100
101    /// Attach to target commands
102    static ref ATTACH_TARGET: (chromiumoxide_types::MethodId, serde_json::Value) = {
103        let runtime_cmd = RunIfWaitingForDebuggerParams::default();
104
105        (runtime_cmd.identifier(), serde_json::to_value(runtime_cmd).unwrap_or_default())
106    };
107}
108
109#[derive(Debug)]
110pub struct Target {
111    /// Info about this target as returned from the chromium instance
112    info: TargetInfo,
113    /// The type of this target
114    r#type: TargetType,
115    /// Configs for this target
116    config: TargetConfig,
117    /// The context this target is running in
118    browser_context: BrowserContext,
119    /// The frame manager that maintains the state of all frames and handles
120    /// navigations of frames
121    frame_manager: FrameManager,
122    /// Handles all the https
123    pub(crate) network_manager: NetworkManager,
124    emulation_manager: EmulationManager,
125    /// The identifier of the session this target is attached to
126    session_id: Option<SessionId>,
127    /// The handle of the browser page of this target
128    page: Option<PageHandle>,
129    /// Drives this target towards initialization
130    pub(crate) init_state: TargetInit,
131    /// Currently queued events to report to the `Handler`
132    queued_events: VecDeque<TargetEvent>,
133    /// All registered event subscriptions
134    event_listeners: EventListeners,
135    /// Senders that need to be notified once the main frame has loaded
136    wait_for_frame_navigation: Vec<Sender<ArcHttpRequest>>,
137    /// Senders notified once `DOMContentLoaded` fires (before `load`).
138    wait_for_dom_content_loaded: Vec<Sender<ArcHttpRequest>>,
139    /// Senders notified once the `load` event fires (all subresources done).
140    wait_for_load: Vec<Sender<ArcHttpRequest>>,
141    /// Senders that need to be notified once the main frame reaches `networkIdle`.
142    wait_for_network_idle: Vec<Sender<ArcHttpRequest>>,
143    /// (Optional) for `networkAlmostIdle` if you want it as well.
144    wait_for_network_almost_idle: Vec<Sender<ArcHttpRequest>>,
145    /// The sender who requested the page.
146    initiator: Option<Sender<Result<Page>>>,
147}
148
149impl Target {
150    /// Create a new target instance with `TargetInfo` after a
151    /// `CreateTargetParams` request.
152    pub fn new(info: TargetInfo, config: TargetConfig, browser_context: BrowserContext) -> Self {
153        let ty = TargetType::new(&info.r#type);
154        let request_timeout: Duration = config.request_timeout;
155        let mut network_manager = NetworkManager::new(config.ignore_https_errors, request_timeout);
156
157        if !config.cache_enabled {
158            network_manager.set_cache_enabled(false);
159        }
160
161        if !config.service_worker_enabled {
162            network_manager.set_service_worker_enabled(true);
163        }
164
165        network_manager.set_request_interception(config.request_intercept);
166        network_manager.max_bytes_allowed = config.max_bytes_allowed;
167        network_manager.max_redirects = config.max_redirects;
168
169        if let Some(headers) = &config.extra_headers {
170            network_manager.set_extra_headers(headers.clone());
171        }
172
173        if let Some(whitelist) = &config.whitelist_patterns {
174            network_manager.set_whitelist_patterns(whitelist.clone());
175        }
176
177        if let Some(blacklist) = &config.blacklist_patterns {
178            network_manager.set_blacklist_patterns(blacklist);
179        }
180
181        network_manager.ignore_visuals = config.ignore_visuals;
182        network_manager.block_javascript = config.ignore_javascript;
183        network_manager.block_analytics = config.ignore_analytics;
184        network_manager.block_prefetch = config.ignore_prefetch;
185
186        network_manager.block_stylesheets = config.ignore_stylesheets;
187        network_manager.only_html = config.only_html;
188        network_manager.intercept_manager = config.intercept_manager;
189
190        #[cfg(feature = "adblock")]
191        if let Some(rules) = &config.adblock_filter_rules {
192            use adblock::lists::{FilterSet, ParseOptions, RuleTypes};
193
194            let mut filter_set = FilterSet::new(false);
195            let mut opts = ParseOptions::default();
196            opts.rule_types = RuleTypes::All;
197
198            // Include built-in patterns.
199            filter_set.add_filters(
200                &*spider_network_blocker::adblock::ADBLOCK_PATTERNS,
201                opts.clone(),
202            );
203            // Merge user-supplied rules (e.g. EasyList / EasyPrivacy content).
204            filter_set.add_filters(rules.iter().map(|s| s.as_str()), opts);
205
206            let engine = adblock::Engine::from_filter_set(filter_set, true);
207            network_manager.set_adblock_engine(std::sync::Arc::new(engine));
208        }
209
210        let mut frame_manager = FrameManager::new(request_timeout);
211        frame_manager.set_max_main_frame_navigations(config.max_main_frame_navigations);
212
213        Self {
214            info,
215            r#type: ty,
216            config,
217            frame_manager,
218            network_manager,
219            emulation_manager: EmulationManager::new(request_timeout),
220            session_id: None,
221            page: None,
222            init_state: TargetInit::AttachToTarget,
223            wait_for_frame_navigation: Default::default(),
224            wait_for_dom_content_loaded: Default::default(),
225            wait_for_load: Default::default(),
226            wait_for_network_idle: Default::default(),
227            wait_for_network_almost_idle: Default::default(),
228            queued_events: Default::default(),
229            event_listeners: Default::default(),
230            initiator: None,
231            browser_context,
232        }
233    }
234
235    /// Set the session id.
236    pub fn set_session_id(&mut self, id: SessionId) {
237        self.session_id = Some(id)
238    }
239
240    /// Get the session id.
241    pub fn session_id(&self) -> Option<&SessionId> {
242        self.session_id.as_ref()
243    }
244
245    /// Get the session id mut.
246    pub fn session_id_mut(&mut self) -> &mut Option<SessionId> {
247        &mut self.session_id
248    }
249
250    /// Get the browser context.
251    pub fn browser_context(&self) -> &BrowserContext {
252        &self.browser_context
253    }
254
255    /// The identifier for this target
256    pub fn target_id(&self) -> &TargetId {
257        &self.info.target_id
258    }
259
260    /// The type of this target
261    pub fn r#type(&self) -> &TargetType {
262        &self.r#type
263    }
264
265    /// Whether this target is already initialized
266    pub fn is_initialized(&self) -> bool {
267        matches!(self.init_state, TargetInit::Initialized)
268    }
269
270    /// Navigate a frame
271    pub fn goto(&mut self, req: FrameRequestedNavigation) {
272        if self.network_manager.has_target_domain() {
273            self.network_manager.clear_target_domain();
274            let goto_url = req
275                .req
276                .params
277                .as_object()
278                .and_then(|o| o.get("url"))
279                .and_then(|v| v.as_str());
280
281            if let Some(url) = goto_url {
282                self.network_manager.set_page_url(url.into());
283            }
284        }
285        self.frame_manager.goto(req);
286    }
287
288    /// Create a new page from the session.
289    fn create_page(&mut self) {
290        if self.page.is_none() {
291            if let Some(session) = self.session_id.clone() {
292                let handle = PageHandle::new(
293                    self.target_id().clone(),
294                    session,
295                    self.opener_id().cloned(),
296                    self.config.request_timeout,
297                    self.config.page_wake.clone(),
298                );
299                self.page = Some(handle);
300            }
301        }
302    }
303
304    /// Tries to create the `PageInner` if this target is already initialized
305    pub(crate) fn get_or_create_page(&mut self) -> Option<&Arc<PageInner>> {
306        self.create_page();
307        self.page.as_ref().map(|p| p.inner())
308    }
309
310    /// Mutable access to the page handle (for `try_recv` in `Handler::run()`).
311    pub(crate) fn page_mut(&mut self) -> Option<&mut PageHandle> {
312        self.page.as_mut()
313    }
314
315    /// Is the target a page?
316    pub fn is_page(&self) -> bool {
317        self.r#type().is_page()
318    }
319
320    /// The browser context ID.
321    pub fn browser_context_id(&self) -> Option<&BrowserContextId> {
322        self.info.browser_context_id.as_ref()
323    }
324
325    /// The target connection info.
326    pub fn info(&self) -> &TargetInfo {
327        &self.info
328    }
329
330    /// Get the target that opened this target. Top-level targets return `None`.
331    pub fn opener_id(&self) -> Option<&TargetId> {
332        self.info.opener_id.as_ref()
333    }
334
335    pub fn frame_manager(&self) -> &FrameManager {
336        &self.frame_manager
337    }
338
339    /// The frame manager.
340    pub fn frame_manager_mut(&mut self) -> &mut FrameManager {
341        &mut self.frame_manager
342    }
343
344    /// Get event listeners mutably.
345    pub fn event_listeners_mut(&mut self) -> &mut EventListeners {
346        &mut self.event_listeners
347    }
348
349    /// Received a response to a command issued by this target
350    pub fn on_response(&mut self, resp: Response, method: &str) {
351        if let Some(cmds) = self.init_state.commands_mut() {
352            cmds.received_response(method);
353        }
354
355        if let GetFrameTreeParams::IDENTIFIER = method {
356            if let Some(resp) = resp
357                .result
358                .and_then(|val| GetFrameTreeParams::response_from_value(val).ok())
359            {
360                self.frame_manager.on_frame_tree(resp.frame_tree);
361            }
362        }
363        // requests originated from the network manager all return an empty response, hence they
364        // can be ignored here
365    }
366
367    /// On CDP Event message.
368    pub fn on_event(&mut self, event: CdpEventMessage) {
369        let CdpEventMessage {
370            params,
371            method,
372            session_id,
373            ..
374        } = event;
375
376        let is_session_scoped = matches!(
377            params,
378            CdpEvent::FetchRequestPaused(_)
379                | CdpEvent::FetchAuthRequired(_)
380                | CdpEvent::NetworkRequestWillBeSent(_)
381                | CdpEvent::NetworkResponseReceived(_)
382                | CdpEvent::NetworkLoadingFinished(_)
383                | CdpEvent::NetworkLoadingFailed(_)
384                | CdpEvent::PageFrameAttached(_)
385                | CdpEvent::PageFrameDetached(_)
386                | CdpEvent::PageFrameNavigated(_)
387                | CdpEvent::PageNavigatedWithinDocument(_)
388                | CdpEvent::PageLifecycleEvent(_)
389                | CdpEvent::PageFrameStartedLoading(_)
390                | CdpEvent::PageFrameStoppedLoading(_)
391                | CdpEvent::RuntimeExecutionContextCreated(_)
392                | CdpEvent::RuntimeExecutionContextDestroyed(_)
393                | CdpEvent::RuntimeExecutionContextsCleared(_)
394                | CdpEvent::RuntimeBindingCalled(_)
395        );
396
397        if is_session_scoped {
398            let ev_sid: &str = match session_id.as_deref() {
399                Some(s) => s,
400                None => return,
401            };
402
403            let self_sid: &str = match self.session_id.as_ref() {
404                Some(sid) => sid.as_ref(),
405                None => return,
406            };
407
408            if self_sid != ev_sid {
409                return;
410            }
411        }
412
413        match &params {
414            // `FrameManager` events
415            CdpEvent::PageFrameAttached(ev) => self
416                .frame_manager
417                .on_frame_attached(ev.frame_id.clone(), Some(ev.parent_frame_id.clone())),
418            CdpEvent::PageFrameDetached(ev) => self.frame_manager.on_frame_detached(ev),
419            CdpEvent::PageFrameNavigated(ev) => {
420                self.frame_manager.on_frame_navigated(&ev.frame);
421            }
422            CdpEvent::PageNavigatedWithinDocument(ev) => {
423                self.frame_manager.on_frame_navigated_within_document(ev)
424            }
425            CdpEvent::RuntimeExecutionContextCreated(ev) => {
426                self.frame_manager.on_frame_execution_context_created(ev)
427            }
428            CdpEvent::RuntimeExecutionContextDestroyed(ev) => {
429                self.frame_manager.on_frame_execution_context_destroyed(ev)
430            }
431            CdpEvent::RuntimeExecutionContextsCleared(_) => {
432                self.frame_manager.on_execution_contexts_cleared()
433            }
434            CdpEvent::RuntimeBindingCalled(ev) => {
435                // TODO check if binding registered and payload is json
436                self.frame_manager.on_runtime_binding_called(ev)
437            }
438            CdpEvent::PageLifecycleEvent(ev) => self.frame_manager.on_page_lifecycle_event(ev),
439            CdpEvent::PageFrameStartedLoading(ev) => {
440                self.frame_manager.on_frame_started_loading(ev);
441            }
442            CdpEvent::PageFrameStoppedLoading(ev) => {
443                self.frame_manager.on_frame_stopped_loading(ev);
444            }
445            // `Target` events
446            CdpEvent::TargetAttachedToTarget(ev) => {
447                if ev.waiting_for_debugger {
448                    let runtime_cmd = ATTACH_TARGET.clone();
449
450                    self.queued_events.push_back(TargetEvent::Request(Request {
451                        method: runtime_cmd.0,
452                        session_id: Some(ev.session_id.clone().into()),
453                        params: runtime_cmd.1,
454                    }));
455                }
456
457                if "service_worker" == &ev.target_info.r#type {
458                    let detach_command = DetachFromTargetParams::builder()
459                        .session_id(ev.session_id.clone())
460                        .build();
461
462                    let method = detach_command.identifier();
463
464                    if let Ok(params) = serde_json::to_value(detach_command) {
465                        self.queued_events.push_back(TargetEvent::Request(Request {
466                            method,
467                            session_id: self.session_id.clone().map(Into::into),
468                            params,
469                        }));
470                    }
471                }
472            }
473            // `NetworkManager` events
474            CdpEvent::FetchRequestPaused(ev) => self.network_manager.on_fetch_request_paused(ev),
475            CdpEvent::FetchAuthRequired(ev) => self.network_manager.on_fetch_auth_required(ev),
476            CdpEvent::NetworkRequestWillBeSent(ev) => {
477                self.network_manager.on_request_will_be_sent(ev)
478            }
479            CdpEvent::NetworkRequestServedFromCache(ev) => {
480                self.network_manager.on_request_served_from_cache(ev)
481            }
482            CdpEvent::NetworkResponseReceived(ev) => self.network_manager.on_response_received(ev),
483            CdpEvent::NetworkLoadingFinished(ev) => {
484                self.network_manager.on_network_loading_finished(ev)
485            }
486            CdpEvent::NetworkLoadingFailed(ev) => {
487                self.network_manager.on_network_loading_failed(ev)
488            }
489            _ => (),
490        }
491        chromiumoxide_cdp::consume_event!(match params {
492           |ev| self.event_listeners.start_send(ev),
493           |json| { let _ = self.event_listeners.try_send_custom(&method, json);}
494        });
495    }
496
497    /// Called when a init command timed out
498    fn on_initialization_failed(&mut self) -> TargetEvent {
499        if let Some(initiator) = self.initiator.take() {
500            let _ = initiator.send(Err(CdpError::Timeout));
501        }
502        self.init_state = TargetInit::Closing;
503        let close_target = CloseTargetParams::new(self.info.target_id.clone());
504
505        TargetEvent::Request(Request {
506            method: close_target.identifier(),
507            session_id: self.session_id.clone().map(Into::into),
508            params: serde_json::to_value(close_target).unwrap_or_default(),
509        })
510    }
511
512    /// Advance that target's state
513    pub(crate) fn poll(&mut self, cx: &mut Context<'_>, now: Instant) -> Option<TargetEvent> {
514        if !self.is_page() {
515            // can only poll pages
516            return None;
517        }
518
519        match &mut self.init_state {
520            TargetInit::AttachToTarget => {
521                self.init_state = TargetInit::InitializingFrame(FrameManager::init_commands(
522                    self.config.request_timeout,
523                ));
524
525                if let Ok(params) = AttachToTargetParams::builder()
526                    .target_id(self.target_id().clone())
527                    .flatten(true)
528                    .build()
529                {
530                    return Some(TargetEvent::Request(Request::new(
531                        params.identifier(),
532                        serde_json::to_value(params).unwrap_or_default(),
533                    )));
534                } else {
535                    return None;
536                }
537            }
538            TargetInit::InitializingFrame(cmds) => {
539                self.session_id.as_ref()?;
540                if let Poll::Ready(poll) = cmds.poll(now) {
541                    return match poll {
542                        None => {
543                            if let Some(world_name) = self.frame_manager.get_isolated_world_name() {
544                                let world_name = world_name.clone();
545
546                                if let Some(isolated_world_cmds) =
547                                    self.frame_manager.ensure_isolated_world(&world_name)
548                                {
549                                    *cmds = isolated_world_cmds;
550                                } else {
551                                    self.init_state = TargetInit::InitializingNetwork(
552                                        self.network_manager.init_commands(),
553                                    );
554                                }
555                            } else {
556                                self.init_state = TargetInit::InitializingNetwork(
557                                    self.network_manager.init_commands(),
558                                );
559                            }
560                            self.poll(cx, now)
561                        }
562                        Some(Ok((method, params))) => Some(TargetEvent::Request(Request {
563                            method,
564                            session_id: self.session_id.clone().map(Into::into),
565                            params,
566                        })),
567                        Some(Err(_)) => Some(self.on_initialization_failed()),
568                    };
569                } else {
570                    return None;
571                }
572            }
573            TargetInit::InitializingNetwork(cmds) => {
574                advance_state!(
575                    self,
576                    cx,
577                    now,
578                    cmds,
579                    TargetInit::InitializingPage(Self::page_init_commands(
580                        self.config.request_timeout
581                    ))
582                );
583            }
584            TargetInit::InitializingPage(cmds) => {
585                advance_state!(
586                    self,
587                    cx,
588                    now,
589                    cmds,
590                    match self.config.viewport.as_ref() {
591                        Some(viewport) => TargetInit::InitializingEmulation(
592                            self.emulation_manager.init_commands(viewport)
593                        ),
594                        None => TargetInit::Initialized,
595                    }
596                );
597            }
598            TargetInit::InitializingEmulation(cmds) => {
599                advance_state!(self, cx, now, cmds, TargetInit::Initialized);
600            }
601            TargetInit::Initialized => {
602                if let Some(initiator) = self.initiator.take() {
603                    // make sure that the main frame of the page has finished loading
604                    if self
605                        .frame_manager
606                        .main_frame()
607                        .map(|frame| frame.is_loaded())
608                        .unwrap_or_default()
609                    {
610                        if let Some(page) = self.get_or_create_page() {
611                            let _ = initiator.send(Ok(page.clone().into()));
612                        } else {
613                            self.initiator = Some(initiator);
614                        }
615                    } else {
616                        self.initiator = Some(initiator);
617                    }
618                }
619            }
620            TargetInit::Closing => return None,
621        };
622
623        // Prune senders whose receivers have been dropped (caller
624        // timed out or was cancelled) so the vecs don't grow unbounded.
625        // Done once per poll() call, outside the inner loop.
626        if !self.wait_for_frame_navigation.is_empty() {
627            self.wait_for_frame_navigation.retain(|tx| !tx.is_closed());
628        }
629        if !self.wait_for_dom_content_loaded.is_empty() {
630            self.wait_for_dom_content_loaded
631                .retain(|tx| !tx.is_closed());
632        }
633        if !self.wait_for_load.is_empty() {
634            self.wait_for_load.retain(|tx| !tx.is_closed());
635        }
636        if !self.wait_for_network_idle.is_empty() {
637            self.wait_for_network_idle.retain(|tx| !tx.is_closed());
638        }
639        if !self.wait_for_network_almost_idle.is_empty() {
640            self.wait_for_network_almost_idle
641                .retain(|tx| !tx.is_closed());
642        }
643
644        loop {
645            if self.init_state == TargetInit::Closing {
646                break None;
647            }
648
649            if let Some(frame) = self.frame_manager.main_frame() {
650                if frame.is_dom_content_loaded() {
651                    while let Some(tx) = self.wait_for_dom_content_loaded.pop() {
652                        let _ = tx.send(frame.http_request().cloned());
653                    }
654                    while let Some(tx) = self.wait_for_frame_navigation.pop() {
655                        let _ = tx.send(frame.http_request().cloned());
656                    }
657                }
658
659                if frame.is_loaded() {
660                    while let Some(tx) = self.wait_for_load.pop() {
661                        let _ = tx.send(frame.http_request().cloned());
662                    }
663                }
664
665                if frame.is_network_idle() {
666                    while let Some(tx) = self.wait_for_network_idle.pop() {
667                        let _ = tx.send(frame.http_request().cloned());
668                    }
669                }
670
671                if frame.is_network_almost_idle() {
672                    while let Some(tx) = self.wait_for_network_almost_idle.pop() {
673                        let _ = tx.send(frame.http_request().cloned());
674                    }
675                }
676            }
677
678            // Drain queued messages first.
679            if let Some(ev) = self.queued_events.pop_front() {
680                return Some(ev);
681            }
682
683            if let Some(handle) = self.page.as_mut() {
684                while let Poll::Ready(Some(msg)) = handle.rx.poll_recv(cx) {
685                    if self.init_state == TargetInit::Closing {
686                        break;
687                    }
688
689                    match msg {
690                        TargetMessage::Command(cmd) => {
691                            if cmd.method == "Network.setBlockedURLs" {
692                                if let Some(arr) = cmd.params.get("urls").and_then(|v| v.as_array())
693                                {
694                                    let mut unblock_all = false;
695                                    let mut block_all = false;
696
697                                    for s in arr.iter().filter_map(|v| v.as_str()) {
698                                        if s == "!*" {
699                                            unblock_all = true;
700                                            break; // "!*" overrides any block rules
701                                        }
702                                        if s.contains('*') {
703                                            block_all = true;
704                                        }
705                                    }
706
707                                    if unblock_all {
708                                        self.network_manager.set_block_all(false);
709                                    } else if block_all {
710                                        self.network_manager.set_block_all(true);
711                                    }
712                                }
713                            }
714                            self.queued_events.push_back(TargetEvent::Command(cmd));
715                        }
716                        TargetMessage::MainFrame(tx) => {
717                            let _ =
718                                tx.send(self.frame_manager.main_frame().map(|f| f.id().clone()));
719                        }
720                        TargetMessage::AllFrames(tx) => {
721                            let _ = tx.send(
722                                self.frame_manager
723                                    .frames()
724                                    .map(|f| f.id().clone())
725                                    .collect(),
726                            );
727                        }
728                        #[cfg(feature = "_cache")]
729                        TargetMessage::CacheKey((cache_key, cache_policy)) => {
730                            self.network_manager.set_cache_site_key(cache_key);
731                            self.network_manager.set_cache_policy(cache_policy);
732                        }
733                        TargetMessage::Url(req) => {
734                            let GetUrl { frame_id, tx } = req;
735                            let frame = if let Some(frame_id) = frame_id {
736                                self.frame_manager.frame(&frame_id)
737                            } else {
738                                self.frame_manager.main_frame()
739                            };
740                            let _ = tx.send(frame.and_then(|f| f.url().map(str::to_string)));
741                        }
742                        TargetMessage::Name(req) => {
743                            let GetName { frame_id, tx } = req;
744                            let frame = if let Some(frame_id) = frame_id {
745                                self.frame_manager.frame(&frame_id)
746                            } else {
747                                self.frame_manager.main_frame()
748                            };
749                            let _ = tx.send(frame.and_then(|f| f.name().map(str::to_string)));
750                        }
751                        TargetMessage::Parent(req) => {
752                            let GetParent { frame_id, tx } = req;
753                            let frame = self.frame_manager.frame(&frame_id);
754                            let _ = tx.send(frame.and_then(|f| f.parent_id().cloned()));
755                        }
756                        TargetMessage::WaitForNavigation(tx) => {
757                            if let Some(frame) = self.frame_manager.main_frame() {
758                                if frame.is_dom_content_loaded() {
759                                    let _ = tx.send(frame.http_request().cloned());
760                                } else {
761                                    self.wait_for_frame_navigation.push(tx);
762                                }
763                            } else {
764                                self.wait_for_frame_navigation.push(tx);
765                            }
766                        }
767                        TargetMessage::WaitForDomContentLoaded(tx) => {
768                            if let Some(frame) = self.frame_manager.main_frame() {
769                                if frame.is_dom_content_loaded() {
770                                    let _ = tx.send(frame.http_request().cloned());
771                                } else {
772                                    self.wait_for_dom_content_loaded.push(tx);
773                                }
774                            } else {
775                                self.wait_for_dom_content_loaded.push(tx);
776                            }
777                        }
778                        TargetMessage::WaitForLoad(tx) => {
779                            if let Some(frame) = self.frame_manager.main_frame() {
780                                if frame.is_loaded() {
781                                    let _ = tx.send(frame.http_request().cloned());
782                                } else {
783                                    self.wait_for_load.push(tx);
784                                }
785                            } else {
786                                self.wait_for_load.push(tx);
787                            }
788                        }
789                        TargetMessage::WaitForNetworkIdle(tx) => {
790                            if let Some(frame) = self.frame_manager.main_frame() {
791                                if frame.is_network_idle() {
792                                    let _ = tx.send(frame.http_request().cloned());
793                                } else {
794                                    self.wait_for_network_idle.push(tx);
795                                }
796                            } else {
797                                self.wait_for_network_idle.push(tx);
798                            }
799                        }
800                        TargetMessage::WaitForNetworkAlmostIdle(tx) => {
801                            if let Some(frame) = self.frame_manager.main_frame() {
802                                if frame.is_network_almost_idle() {
803                                    let _ = tx.send(frame.http_request().cloned());
804                                } else {
805                                    self.wait_for_network_almost_idle.push(tx);
806                                }
807                            } else {
808                                self.wait_for_network_almost_idle.push(tx);
809                            }
810                        }
811                        TargetMessage::AddEventListener(req) => {
812                            if req.method == "Fetch.requestPaused" {
813                                self.network_manager.enable_request_intercept();
814                            }
815                            // register a new listener
816                            self.event_listeners.add_listener(req);
817                        }
818                        TargetMessage::GetExecutionContext(ctx) => {
819                            let GetExecutionContext {
820                                dom_world,
821                                frame_id,
822                                tx,
823                            } = ctx;
824                            let frame = if let Some(frame_id) = frame_id {
825                                self.frame_manager.frame(&frame_id)
826                            } else {
827                                self.frame_manager.main_frame()
828                            };
829
830                            if let Some(frame) = frame {
831                                match dom_world {
832                                    DOMWorldKind::Main => {
833                                        let _ = tx.send(frame.main_world().execution_context());
834                                    }
835                                    DOMWorldKind::Secondary => {
836                                        let _ =
837                                            tx.send(frame.secondary_world().execution_context());
838                                    }
839                                }
840                            } else {
841                                let _ = tx.send(None);
842                            }
843                        }
844                        TargetMessage::Authenticate(credentials) => {
845                            self.network_manager.authenticate(credentials);
846                        }
847                        TargetMessage::BlockNetwork(blocked) => {
848                            self.network_manager.set_block_all(blocked);
849                        }
850                        TargetMessage::EnableInterception(enabled) => {
851                            // if interception is enabled disable the user facing handling.
852                            self.network_manager.user_request_interception_enabled = !enabled;
853                        }
854                    }
855                }
856            }
857
858            while let Some(event) = self.network_manager.poll() {
859                if self.init_state == TargetInit::Closing {
860                    break;
861                }
862                match event {
863                    NetworkEvent::SendCdpRequest((method, params)) => {
864                        // send a message to the browser
865                        self.queued_events.push_back(TargetEvent::Request(Request {
866                            method,
867                            session_id: self.session_id.clone().map(Into::into),
868                            params,
869                        }))
870                    }
871                    NetworkEvent::Request(_) => {}
872                    NetworkEvent::Response(_) => {}
873                    NetworkEvent::RequestFailed(request) => {
874                        self.frame_manager.on_http_request_finished(request);
875                    }
876                    NetworkEvent::RequestFinished(request) => {
877                        self.frame_manager.on_http_request_finished(request);
878                    }
879                    NetworkEvent::BytesConsumed(n) => {
880                        self.queued_events.push_back(TargetEvent::BytesConsumed(n));
881                    }
882                }
883            }
884
885            while let Some(event) = self.frame_manager.poll(now) {
886                if self.init_state == TargetInit::Closing {
887                    break;
888                }
889                match event {
890                    FrameEvent::NavigationResult(res) => {
891                        self.queued_events
892                            .push_back(TargetEvent::NavigationResult(res));
893                    }
894                    FrameEvent::NavigationRequest(id, req) => {
895                        self.queued_events
896                            .push_back(TargetEvent::NavigationRequest(id, req));
897                    }
898                }
899            }
900
901            if self.queued_events.is_empty() {
902                return None;
903            }
904        }
905    }
906
907    /// Process a single message from the page channel.
908    ///
909    /// Used by `Handler::run()` after `try_recv()` drains the page channel.
910    pub(crate) fn on_page_message(&mut self, msg: TargetMessage) {
911        if self.init_state == TargetInit::Closing {
912            return;
913        }
914        match msg {
915            TargetMessage::Command(cmd) => {
916                if cmd.method == "Network.setBlockedURLs" {
917                    if let Some(arr) = cmd.params.get("urls").and_then(|v| v.as_array()) {
918                        let mut unblock_all = false;
919                        let mut block_all = false;
920                        for s in arr.iter().filter_map(|v| v.as_str()) {
921                            if s == "!*" {
922                                unblock_all = true;
923                                break;
924                            }
925                            if s.contains('*') {
926                                block_all = true;
927                            }
928                        }
929                        if unblock_all {
930                            self.network_manager.set_block_all(false);
931                        } else if block_all {
932                            self.network_manager.set_block_all(true);
933                        }
934                    }
935                }
936                self.queued_events.push_back(TargetEvent::Command(cmd));
937            }
938            TargetMessage::MainFrame(tx) => {
939                let _ = tx.send(self.frame_manager.main_frame().map(|f| f.id().clone()));
940            }
941            TargetMessage::AllFrames(tx) => {
942                let _ = tx.send(
943                    self.frame_manager
944                        .frames()
945                        .map(|f| f.id().clone())
946                        .collect(),
947                );
948            }
949            #[cfg(feature = "_cache")]
950            TargetMessage::CacheKey((cache_key, cache_policy)) => {
951                self.network_manager.set_cache_site_key(cache_key);
952                self.network_manager.set_cache_policy(cache_policy);
953            }
954            TargetMessage::Url(req) => {
955                let GetUrl { frame_id, tx } = req;
956                let frame = if let Some(frame_id) = frame_id {
957                    self.frame_manager.frame(&frame_id)
958                } else {
959                    self.frame_manager.main_frame()
960                };
961                let _ = tx.send(frame.and_then(|f| f.url().map(str::to_string)));
962            }
963            TargetMessage::Name(req) => {
964                let GetName { frame_id, tx } = req;
965                let frame = if let Some(frame_id) = frame_id {
966                    self.frame_manager.frame(&frame_id)
967                } else {
968                    self.frame_manager.main_frame()
969                };
970                let _ = tx.send(frame.and_then(|f| f.name().map(str::to_string)));
971            }
972            TargetMessage::Parent(req) => {
973                let GetParent { frame_id, tx } = req;
974                let frame = self.frame_manager.frame(&frame_id);
975                let _ = tx.send(frame.and_then(|f| f.parent_id().cloned()));
976            }
977            TargetMessage::WaitForNavigation(tx) => {
978                if let Some(frame) = self.frame_manager.main_frame() {
979                    if frame.is_dom_content_loaded() {
980                        let _ = tx.send(frame.http_request().cloned());
981                    } else {
982                        self.wait_for_frame_navigation.push(tx);
983                    }
984                } else {
985                    self.wait_for_frame_navigation.push(tx);
986                }
987            }
988            TargetMessage::WaitForDomContentLoaded(tx) => {
989                if let Some(frame) = self.frame_manager.main_frame() {
990                    if frame.is_dom_content_loaded() {
991                        let _ = tx.send(frame.http_request().cloned());
992                    } else {
993                        self.wait_for_dom_content_loaded.push(tx);
994                    }
995                } else {
996                    self.wait_for_dom_content_loaded.push(tx);
997                }
998            }
999            TargetMessage::WaitForLoad(tx) => {
1000                if let Some(frame) = self.frame_manager.main_frame() {
1001                    if frame.is_loaded() {
1002                        let _ = tx.send(frame.http_request().cloned());
1003                    } else {
1004                        self.wait_for_load.push(tx);
1005                    }
1006                } else {
1007                    self.wait_for_load.push(tx);
1008                }
1009            }
1010            TargetMessage::WaitForNetworkIdle(tx) => {
1011                if let Some(frame) = self.frame_manager.main_frame() {
1012                    if frame.is_network_idle() {
1013                        let _ = tx.send(frame.http_request().cloned());
1014                    } else {
1015                        self.wait_for_network_idle.push(tx);
1016                    }
1017                } else {
1018                    self.wait_for_network_idle.push(tx);
1019                }
1020            }
1021            TargetMessage::WaitForNetworkAlmostIdle(tx) => {
1022                if let Some(frame) = self.frame_manager.main_frame() {
1023                    if frame.is_network_almost_idle() {
1024                        let _ = tx.send(frame.http_request().cloned());
1025                    } else {
1026                        self.wait_for_network_almost_idle.push(tx);
1027                    }
1028                } else {
1029                    self.wait_for_network_almost_idle.push(tx);
1030                }
1031            }
1032            TargetMessage::AddEventListener(req) => {
1033                if req.method == "Fetch.requestPaused" {
1034                    self.network_manager.enable_request_intercept();
1035                }
1036                self.event_listeners.add_listener(req);
1037            }
1038            TargetMessage::GetExecutionContext(ctx) => {
1039                let GetExecutionContext {
1040                    dom_world,
1041                    frame_id,
1042                    tx,
1043                } = ctx;
1044                let frame = if let Some(frame_id) = frame_id {
1045                    self.frame_manager.frame(&frame_id)
1046                } else {
1047                    self.frame_manager.main_frame()
1048                };
1049                if let Some(frame) = frame {
1050                    match dom_world {
1051                        DOMWorldKind::Main => {
1052                            let _ = tx.send(frame.main_world().execution_context());
1053                        }
1054                        DOMWorldKind::Secondary => {
1055                            let _ = tx.send(frame.secondary_world().execution_context());
1056                        }
1057                    }
1058                } else {
1059                    let _ = tx.send(None);
1060                }
1061            }
1062            TargetMessage::Authenticate(credentials) => {
1063                self.network_manager.authenticate(credentials);
1064            }
1065            TargetMessage::BlockNetwork(blocked) => {
1066                self.network_manager.set_block_all(blocked);
1067            }
1068            TargetMessage::EnableInterception(enabled) => {
1069                self.network_manager.user_request_interception_enabled = !enabled;
1070            }
1071        }
1072    }
1073
1074    /// Advance the target's state machine and drain queued events.
1075    ///
1076    /// Like [`poll`](Self::poll) but does **not** read from the page channel
1077    /// (that is handled externally by `Handler::run()` via `try_recv`).
1078    pub(crate) fn advance(&mut self, now: Instant) -> Option<TargetEvent> {
1079        if !self.is_page() {
1080            return None;
1081        }
1082
1083        // Init state machine
1084        match &mut self.init_state {
1085            TargetInit::AttachToTarget => {
1086                self.init_state = TargetInit::InitializingFrame(FrameManager::init_commands(
1087                    self.config.request_timeout,
1088                ));
1089                if let Ok(params) = AttachToTargetParams::builder()
1090                    .target_id(self.target_id().clone())
1091                    .flatten(true)
1092                    .build()
1093                {
1094                    return Some(TargetEvent::Request(Request::new(
1095                        params.identifier(),
1096                        serde_json::to_value(params).unwrap_or_default(),
1097                    )));
1098                } else {
1099                    return None;
1100                }
1101            }
1102            TargetInit::InitializingFrame(cmds) => {
1103                self.session_id.as_ref()?;
1104                if let Poll::Ready(poll) = cmds.poll(now) {
1105                    return match poll {
1106                        None => {
1107                            if let Some(world_name) = self.frame_manager.get_isolated_world_name() {
1108                                let world_name = world_name.clone();
1109                                if let Some(isolated_world_cmds) =
1110                                    self.frame_manager.ensure_isolated_world(&world_name)
1111                                {
1112                                    *cmds = isolated_world_cmds;
1113                                } else {
1114                                    self.init_state = TargetInit::InitializingNetwork(
1115                                        self.network_manager.init_commands(),
1116                                    );
1117                                }
1118                            } else {
1119                                self.init_state = TargetInit::InitializingNetwork(
1120                                    self.network_manager.init_commands(),
1121                                );
1122                            }
1123                            self.advance(now)
1124                        }
1125                        Some(Ok((method, params))) => Some(TargetEvent::Request(Request {
1126                            method,
1127                            session_id: self.session_id.clone().map(Into::into),
1128                            params,
1129                        })),
1130                        Some(Err(_)) => Some(self.on_initialization_failed()),
1131                    };
1132                } else {
1133                    return None;
1134                }
1135            }
1136            TargetInit::InitializingNetwork(cmds) => {
1137                if let Poll::Ready(poll) = cmds.poll(now) {
1138                    return match poll {
1139                        None => {
1140                            self.init_state = TargetInit::InitializingPage(
1141                                Self::page_init_commands(self.config.request_timeout),
1142                            );
1143                            self.advance(now)
1144                        }
1145                        Some(Ok((method, params))) => Some(TargetEvent::Request(Request {
1146                            method,
1147                            session_id: self.session_id.clone().map(Into::into),
1148                            params,
1149                        })),
1150                        Some(Err(_)) => Some(self.on_initialization_failed()),
1151                    };
1152                } else {
1153                    return None;
1154                }
1155            }
1156            TargetInit::InitializingPage(cmds) => {
1157                if let Poll::Ready(poll) = cmds.poll(now) {
1158                    return match poll {
1159                        None => {
1160                            self.init_state = match self.config.viewport.as_ref() {
1161                                Some(viewport) => TargetInit::InitializingEmulation(
1162                                    self.emulation_manager.init_commands(viewport),
1163                                ),
1164                                None => TargetInit::Initialized,
1165                            };
1166                            self.advance(now)
1167                        }
1168                        Some(Ok((method, params))) => Some(TargetEvent::Request(Request {
1169                            method,
1170                            session_id: self.session_id.clone().map(Into::into),
1171                            params,
1172                        })),
1173                        Some(Err(_)) => Some(self.on_initialization_failed()),
1174                    };
1175                } else {
1176                    return None;
1177                }
1178            }
1179            TargetInit::InitializingEmulation(cmds) => {
1180                if let Poll::Ready(poll) = cmds.poll(now) {
1181                    return match poll {
1182                        None => {
1183                            self.init_state = TargetInit::Initialized;
1184                            self.advance(now)
1185                        }
1186                        Some(Ok((method, params))) => Some(TargetEvent::Request(Request {
1187                            method,
1188                            session_id: self.session_id.clone().map(Into::into),
1189                            params,
1190                        })),
1191                        Some(Err(_)) => Some(self.on_initialization_failed()),
1192                    };
1193                } else {
1194                    return None;
1195                }
1196            }
1197            TargetInit::Initialized => {
1198                if let Some(initiator) = self.initiator.take() {
1199                    if self
1200                        .frame_manager
1201                        .main_frame()
1202                        .map(|frame| frame.is_loaded())
1203                        .unwrap_or_default()
1204                    {
1205                        if let Some(page) = self.get_or_create_page() {
1206                            let _ = initiator.send(Ok(page.clone().into()));
1207                        } else {
1208                            self.initiator = Some(initiator);
1209                        }
1210                    } else {
1211                        self.initiator = Some(initiator);
1212                    }
1213                }
1214            }
1215            TargetInit::Closing => return None,
1216        };
1217
1218        // Prune dead waiters
1219        if !self.wait_for_frame_navigation.is_empty() {
1220            self.wait_for_frame_navigation.retain(|tx| !tx.is_closed());
1221        }
1222        if !self.wait_for_dom_content_loaded.is_empty() {
1223            self.wait_for_dom_content_loaded
1224                .retain(|tx| !tx.is_closed());
1225        }
1226        if !self.wait_for_load.is_empty() {
1227            self.wait_for_load.retain(|tx| !tx.is_closed());
1228        }
1229        if !self.wait_for_network_idle.is_empty() {
1230            self.wait_for_network_idle.retain(|tx| !tx.is_closed());
1231        }
1232        if !self.wait_for_network_almost_idle.is_empty() {
1233            self.wait_for_network_almost_idle
1234                .retain(|tx| !tx.is_closed());
1235        }
1236
1237        // Drain events loop (same as poll's inner loop, minus page channel reading)
1238        loop {
1239            if self.init_state == TargetInit::Closing {
1240                break None;
1241            }
1242
1243            if let Some(frame) = self.frame_manager.main_frame() {
1244                if frame.is_dom_content_loaded() {
1245                    while let Some(tx) = self.wait_for_dom_content_loaded.pop() {
1246                        let _ = tx.send(frame.http_request().cloned());
1247                    }
1248                    while let Some(tx) = self.wait_for_frame_navigation.pop() {
1249                        let _ = tx.send(frame.http_request().cloned());
1250                    }
1251                }
1252                if frame.is_loaded() {
1253                    while let Some(tx) = self.wait_for_load.pop() {
1254                        let _ = tx.send(frame.http_request().cloned());
1255                    }
1256                }
1257                if frame.is_network_idle() {
1258                    while let Some(tx) = self.wait_for_network_idle.pop() {
1259                        let _ = tx.send(frame.http_request().cloned());
1260                    }
1261                }
1262                if frame.is_network_almost_idle() {
1263                    while let Some(tx) = self.wait_for_network_almost_idle.pop() {
1264                        let _ = tx.send(frame.http_request().cloned());
1265                    }
1266                }
1267            }
1268
1269            if let Some(ev) = self.queued_events.pop_front() {
1270                return Some(ev);
1271            }
1272
1273            while let Some(event) = self.network_manager.poll() {
1274                if self.init_state == TargetInit::Closing {
1275                    break;
1276                }
1277                match event {
1278                    NetworkEvent::SendCdpRequest((method, params)) => {
1279                        self.queued_events.push_back(TargetEvent::Request(Request {
1280                            method,
1281                            session_id: self.session_id.clone().map(Into::into),
1282                            params,
1283                        }));
1284                    }
1285                    NetworkEvent::Request(_) => {}
1286                    NetworkEvent::Response(_) => {}
1287                    NetworkEvent::RequestFailed(request) => {
1288                        self.frame_manager.on_http_request_finished(request);
1289                    }
1290                    NetworkEvent::RequestFinished(request) => {
1291                        self.frame_manager.on_http_request_finished(request);
1292                    }
1293                    NetworkEvent::BytesConsumed(n) => {
1294                        self.queued_events.push_back(TargetEvent::BytesConsumed(n));
1295                    }
1296                }
1297            }
1298
1299            while let Some(event) = self.frame_manager.poll(now) {
1300                if self.init_state == TargetInit::Closing {
1301                    break;
1302                }
1303                match event {
1304                    FrameEvent::NavigationResult(res) => {
1305                        self.queued_events
1306                            .push_back(TargetEvent::NavigationResult(res));
1307                    }
1308                    FrameEvent::NavigationRequest(id, req) => {
1309                        self.queued_events
1310                            .push_back(TargetEvent::NavigationRequest(id, req));
1311                    }
1312                }
1313            }
1314
1315            if self.queued_events.is_empty() {
1316                return None;
1317            }
1318        }
1319    }
1320
1321    /// Set the sender half of the channel who requested the creation of this
1322    /// target
1323    pub fn set_initiator(&mut self, tx: Sender<Result<Page>>) {
1324        self.initiator = Some(tx);
1325    }
1326
1327    pub(crate) fn page_init_commands(timeout: Duration) -> CommandChain {
1328        CommandChain::new(INIT_COMMANDS_PARAMS.clone(), timeout)
1329    }
1330}
1331
1332/// Configuration for how a single target/page should be fetched and processed.
1333#[derive(Debug, Clone)]
1334pub struct TargetConfig {
1335    /// Whether to ignore TLS/HTTPS certificate errors (e.g. self-signed or expired certs).
1336    /// When `true`, connections will proceed even if certificate validation fails.
1337    pub ignore_https_errors: bool,
1338    /// Request timeout to use for the main navigation / resource fetch.
1339    /// This is the total time allowed before a request is considered failed.
1340    pub request_timeout: Duration,
1341    /// Optional browser viewport to use for this target.
1342    /// When `None`, the default viewport (or headless browser default) is used.
1343    pub viewport: Option<Viewport>,
1344    /// Enable request interception for this target.
1345    /// When `true`, all network requests will pass through the intercept manager.
1346    pub request_intercept: bool,
1347    /// Enable caching for this target.
1348    /// When `true`, responses may be read from and written to the cache layer.
1349    pub cache_enabled: bool,
1350    /// If `true`, skip visual/asset resources that are not required for HTML content
1351    /// (e.g. images, fonts, media). Useful for performance-oriented crawls.
1352    pub ignore_visuals: bool,
1353    /// If `true`, block JavaScript execution (or avoid loading JS resources)
1354    /// for this target. This is useful for purely static HTML crawls.
1355    pub ignore_javascript: bool,
1356    /// If `true`, block analytics / tracking requests (e.g. Google Analytics,
1357    /// common tracker domains, etc.).
1358    pub ignore_analytics: bool,
1359    /// Ignore prefetching.
1360    pub ignore_prefetch: bool,
1361    /// If `true`, block stylesheets and related CSS resources for this target.
1362    /// This can reduce bandwidth when only raw HTML is needed.
1363    pub ignore_stylesheets: bool,
1364    /// If `true`, only HTML documents will be fetched/kept.
1365    /// Non-HTML subresources may be skipped entirely.
1366    pub only_html: bool,
1367    /// Whether service workers are allowed for this target.
1368    /// When `true`, service workers may register and intercept requests.
1369    pub service_worker_enabled: bool,
1370    /// Extra HTTP headers to send with each request for this target.
1371    /// Keys should be header names, values their corresponding header values.
1372    pub extra_headers: Option<std::collections::HashMap<String, String>>,
1373    /// Network intercept manager used to make allow/deny/modify decisions
1374    /// for requests when `request_intercept` is enabled.
1375    pub intercept_manager: NetworkInterceptManager,
1376    /// The maximum number of response bytes allowed for this target.
1377    /// When set, responses larger than this limit may be truncated or aborted.
1378    pub max_bytes_allowed: Option<u64>,
1379    /// Cap on Document-type redirect hops before the navigation is aborted.
1380    /// `None` disables enforcement; `Some(n)` mirrors `reqwest::redirect::Policy::limited(n)`.
1381    pub max_redirects: Option<usize>,
1382    /// Cap on main-frame cross-document navigations per `goto`. Defends against
1383    /// JS / meta-refresh loops that bypass the HTTP redirect guard. `None`
1384    /// disables the guard.
1385    pub max_main_frame_navigations: Option<u32>,
1386    /// Whitelist patterns to allow through the network.
1387    pub whitelist_patterns: Option<Vec<String>>,
1388    /// Blacklist patterns to black through the network.
1389    pub blacklist_patterns: Option<Vec<String>>,
1390    /// Extra ABP/uBO filter rules for the adblock engine.
1391    #[cfg(feature = "adblock")]
1392    pub adblock_filter_rules: Option<Vec<String>>,
1393    /// Optional notify handle for waking `Handler::run()`'s select loop.
1394    /// `None` when using the `impl Stream for Handler` path (no overhead).
1395    pub page_wake: Option<Arc<Notify>>,
1396}
1397
1398impl Default for TargetConfig {
1399    fn default() -> Self {
1400        Self {
1401            ignore_https_errors: true,
1402            request_timeout: Duration::from_millis(REQUEST_TIMEOUT),
1403            viewport: Default::default(),
1404            request_intercept: false,
1405            cache_enabled: true,
1406            service_worker_enabled: true,
1407            ignore_javascript: false,
1408            ignore_visuals: false,
1409            ignore_stylesheets: false,
1410            ignore_analytics: true,
1411            ignore_prefetch: true,
1412            only_html: false,
1413            extra_headers: Default::default(),
1414            intercept_manager: NetworkInterceptManager::Unknown,
1415            max_bytes_allowed: None,
1416            max_redirects: None,
1417            max_main_frame_navigations: None,
1418            whitelist_patterns: None,
1419            blacklist_patterns: None,
1420            #[cfg(feature = "adblock")]
1421            adblock_filter_rules: None,
1422            page_wake: None,
1423        }
1424    }
1425}
1426
1427#[derive(Debug, Clone, Eq, PartialEq)]
1428pub enum TargetType {
1429    Page,
1430    BackgroundPage,
1431    ServiceWorker,
1432    SharedWorker,
1433    Other,
1434    Browser,
1435    Webview,
1436    Unknown(String),
1437}
1438
1439impl TargetType {
1440    pub fn new(ty: &str) -> Self {
1441        match ty {
1442            "page" => TargetType::Page,
1443            "background_page" => TargetType::BackgroundPage,
1444            "service_worker" => TargetType::ServiceWorker,
1445            "shared_worker" => TargetType::SharedWorker,
1446            "other" => TargetType::Other,
1447            "browser" => TargetType::Browser,
1448            "webview" => TargetType::Webview,
1449            s => TargetType::Unknown(s.to_string()),
1450        }
1451    }
1452
1453    pub fn is_page(&self) -> bool {
1454        matches!(self, TargetType::Page)
1455    }
1456
1457    pub fn is_background_page(&self) -> bool {
1458        matches!(self, TargetType::BackgroundPage)
1459    }
1460
1461    pub fn is_service_worker(&self) -> bool {
1462        matches!(self, TargetType::ServiceWorker)
1463    }
1464
1465    pub fn is_shared_worker(&self) -> bool {
1466        matches!(self, TargetType::SharedWorker)
1467    }
1468
1469    pub fn is_other(&self) -> bool {
1470        matches!(self, TargetType::Other)
1471    }
1472
1473    pub fn is_browser(&self) -> bool {
1474        matches!(self, TargetType::Browser)
1475    }
1476
1477    pub fn is_webview(&self) -> bool {
1478        matches!(self, TargetType::Webview)
1479    }
1480}
1481
1482#[derive(Debug)]
1483pub(crate) enum TargetEvent {
1484    /// An internal request
1485    Request(Request),
1486    /// An internal navigation request
1487    NavigationRequest(NavigationId, Request),
1488    /// Indicates that a previous requested navigation has finished
1489    NavigationResult(Result<NavigationOk, NavigationError>),
1490    /// A new command arrived via a channel
1491    Command(CommandMessage),
1492    /// The bytes consumed by the network.
1493    BytesConsumed(u64),
1494}
1495
1496// TODO this can be moved into the classes?
1497#[derive(Debug, PartialEq)]
1498pub enum TargetInit {
1499    InitializingFrame(CommandChain),
1500    InitializingNetwork(CommandChain),
1501    InitializingPage(CommandChain),
1502    InitializingEmulation(CommandChain),
1503    AttachToTarget,
1504    Initialized,
1505    Closing,
1506}
1507
1508impl TargetInit {
1509    fn commands_mut(&mut self) -> Option<&mut CommandChain> {
1510        match self {
1511            TargetInit::InitializingFrame(cmd) => Some(cmd),
1512            TargetInit::InitializingNetwork(cmd) => Some(cmd),
1513            TargetInit::InitializingPage(cmd) => Some(cmd),
1514            TargetInit::InitializingEmulation(cmd) => Some(cmd),
1515            TargetInit::AttachToTarget => None,
1516            TargetInit::Initialized => None,
1517            TargetInit::Closing => None,
1518        }
1519    }
1520}
1521
1522#[derive(Debug)]
1523pub struct GetExecutionContext {
1524    /// For which world the execution context was requested
1525    pub dom_world: DOMWorldKind,
1526    /// The if of the frame to get the `ExecutionContext` for
1527    pub frame_id: Option<FrameId>,
1528    /// Sender half of the channel to send the response back
1529    pub tx: Sender<Option<ExecutionContextId>>,
1530}
1531
1532impl GetExecutionContext {
1533    pub fn new(tx: Sender<Option<ExecutionContextId>>) -> Self {
1534        Self {
1535            dom_world: DOMWorldKind::Main,
1536            frame_id: None,
1537            tx,
1538        }
1539    }
1540}
1541
1542#[derive(Debug)]
1543pub struct GetUrl {
1544    /// The id of the frame to get the url for (None = main frame)
1545    pub frame_id: Option<FrameId>,
1546    /// Sender half of the channel to send the response back
1547    pub tx: Sender<Option<String>>,
1548}
1549
1550impl GetUrl {
1551    pub fn new(tx: Sender<Option<String>>) -> Self {
1552        Self { frame_id: None, tx }
1553    }
1554}
1555
1556#[derive(Debug)]
1557pub struct GetName {
1558    /// The id of the frame to get the name for (None = main frame)
1559    pub frame_id: Option<FrameId>,
1560    /// Sender half of the channel to send the response back
1561    pub tx: Sender<Option<String>>,
1562}
1563
1564#[derive(Debug)]
1565pub struct GetParent {
1566    /// The id of the frame to get the parent for (None = main frame)
1567    pub frame_id: FrameId,
1568    /// Sender half of the channel to send the response back
1569    pub tx: Sender<Option<FrameId>>,
1570}
1571
1572#[derive(Debug)]
1573pub enum TargetMessage {
1574    /// Execute a command within the session of this target
1575    Command(CommandMessage),
1576    /// Return the main frame of this target's page
1577    MainFrame(Sender<Option<FrameId>>),
1578    /// Return all the frames of this target's page
1579    AllFrames(Sender<Vec<FrameId>>),
1580    #[cfg(feature = "_cache")]
1581    /// Set the cache key and policy for the target page.
1582    CacheKey((Option<String>, Option<crate::cache::BasicCachePolicy>)),
1583    /// Return the url if available
1584    Url(GetUrl),
1585    /// Return the name if available
1586    Name(GetName),
1587    /// Return the parent id of a frame
1588    Parent(GetParent),
1589    /// A Message that resolves when the frame finished loading a new url
1590    WaitForNavigation(Sender<ArcHttpRequest>),
1591    /// Resolves when `DOMContentLoaded` fires (HTML parsed, sync scripts
1592    /// executed) — before `load`, so subresources may still be in-flight.
1593    WaitForDomContentLoaded(Sender<ArcHttpRequest>),
1594    /// Resolves when the `load` event fires — all subresources (images,
1595    /// fonts, XHRs) are done. Slower than `WaitForNavigation` through proxies.
1596    WaitForLoad(Sender<ArcHttpRequest>),
1597    /// A Message that resolves when the frame network is idle
1598    WaitForNetworkIdle(Sender<ArcHttpRequest>),
1599    /// A Message that resolves when the frame network is almost idle
1600    WaitForNetworkAlmostIdle(Sender<ArcHttpRequest>),
1601    /// A request to submit a new listener that gets notified with every
1602    /// received event
1603    AddEventListener(EventListenerRequest),
1604    /// Get the `ExecutionContext` if available
1605    GetExecutionContext(GetExecutionContext),
1606    Authenticate(Credentials),
1607    /// Set block/unblocked networking
1608    BlockNetwork(bool),
1609    /// Enable/Disable internal request paused interception
1610    EnableInterception(bool),
1611}