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