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