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