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