eoka 0.7.2

Stealth browser automation for Rust. Puppeteer/Playwright alternative with anti-bot bypass.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
//! Fetch pause ownership and authentication/header policy.

use super::{CommandDispatch, Transport};
use crate::Result;
use serde_json::{json, Value};
use std::{
    collections::HashMap,
    sync::{
        atomic::{AtomicU64, Ordering},
        Arc,
    },
};
use tokio::sync::mpsc;

pub(super) enum EventAction {
    Forward,
    Consumed,
    Reply { method: &'static str, params: Value },
}

pub(super) struct FetchInterceptor {
    pub responses: ResponseRoutes,
    pub requests: RequestRoutes,
    pub proxy_auth: Option<(String, String)>,
    pub strip: bool,
}

impl FetchInterceptor {
    pub(super) fn shutdown(&self) {
        close_routes(&self.requests, &self.responses);
    }

    pub(super) fn on_event(
        &self,
        method: &str,
        session: Option<&str>,
        params: &mut Value,
    ) -> EventAction {
        match method {
            "Fetch.authRequired" => self.auth_challenge(params),
            "Fetch.requestPaused" => self.paused_request(session, params),
            _ => EventAction::Forward,
        }
    }

    fn auth_challenge(&self, params: &Value) -> EventAction {
        let Some((username, password)) = &self.proxy_auth else {
            return EventAction::Forward;
        };
        let Some(request_id) = params["requestId"].as_str() else {
            return EventAction::Forward;
        };
        let response = if params
            .pointer("/authChallenge/source")
            .and_then(Value::as_str)
            == Some("Proxy")
        {
            json!({"response":"ProvideCredentials", "username":username, "password":password})
        } else {
            json!({"response":"CancelAuth"})
        };
        EventAction::Reply {
            method: "Fetch.continueWithAuth",
            params: json!({"requestId":request_id, "authChallengeResponse":response}),
        }
    }

    fn paused_request(&self, session: Option<&str>, params: &mut Value) -> EventAction {
        if route_response_pause(&self.responses, session, params)
            || route_request_pause(&self.requests, session, params, self.strip)
        {
            return EventAction::Consumed;
        }
        match continuation_params(params, self.strip) {
            Some(params) => EventAction::Reply {
                method: "Fetch.continueRequest",
                params,
            },
            None => EventAction::Consumed,
        }
    }
}

/// Both queued and automatically continued pauses use the same header policy.
fn continuation_params(params: &Value, strip: bool) -> Option<Value> {
    let request_id = params["requestId"].as_str()?;
    let mut continuation = json!({"requestId":request_id});
    if strip
        && params.get("responseStatusCode").is_none()
        && params.get("responseErrorReason").is_none()
    {
        if let Some(headers) = params
            .pointer("/request/headers")
            .and_then(strip_client_data_header)
        {
            continuation["headers"] = Value::Array(headers);
        }
    }
    Some(continuation)
}

/// Remove `X-Client-Data` from a CDP request-headers object (case-insensitive
/// match, like HTTP header semantics). Returns `None` when the header is
/// absent so callers can continue the request unmodified.
fn strip_client_data_header(headers: &Value) -> Option<Vec<Value>> {
    let map = headers.as_object()?;
    let has_header = map.keys().any(|k| k.eq_ignore_ascii_case("x-client-data"));
    if !has_header {
        return None;
    }
    Some(
        map.iter()
            .filter(|(k, _)| !k.eq_ignore_ascii_case("x-client-data"))
            .map(|(name, value)| json!({"name":name, "value":value}))
            .collect(),
    )
}

pub(super) struct ResponseRoute {
    pub(super) events: mpsc::Sender<Value>,
    pub(super) dropped: Arc<AtomicU64>,
}

pub(super) type ResponseRoutes = Arc<std::sync::Mutex<HashMap<String, ResponseRoute>>>;
pub(super) type RequestRoutes = Arc<std::sync::Mutex<HashMap<String, RequestRoute>>>;

pub(super) struct RequestRoute {
    pub(super) events: mpsc::Sender<RequestPause>,
    pub(super) dropped: Arc<AtomicU64>,
}

/// Drop route senders without discarding pauses already queued for consumers.
/// The transport marks itself closed before taking these installation locks.
pub(super) fn close_routes(requests: &RequestRoutes, responses: &ResponseRoutes) {
    requests.lock().unwrap_or_else(|e| e.into_inner()).clear();
    responses.lock().unwrap_or_else(|e| e.into_inner()).clear();
}

/// An owned request-stage pause. The consumer must continue or fulfill it once.
pub struct RequestPause {
    /// Exact session that owns this pause.
    pub session_id: String,
    /// Raw Fetch.requestPaused payload; may contain sensitive request metadata.
    pub params: Value,
    continue_params: Value,
}

impl RequestPause {
    /// Continue once with a one-shot dispatch token, preserving header policy.
    ///
    /// A possibly dispatched command must not be retried on timeout, cancellation
    /// or error. False is safe for handoff only after this future is dropped or
    /// terminated. A retry of a never-dispatched attempt needs a fresh token.
    pub async fn continue_request_with_dispatch(
        &self,
        transport: &Transport,
        dispatch: &CommandDispatch,
    ) -> Result<()> {
        transport
            .send_to_session_with_dispatch::<_, Value>(
                &self.session_id,
                "Fetch.continueRequest",
                &self.continue_params,
                dispatch,
            )
            .await?;
        Ok(())
    }

    /// Continue on the originating transport, preserving its header-stripping policy.
    pub async fn continue_request(&self, transport: &Transport) -> Result<()> {
        transport
            .send_to_session::<_, Value>(
                &self.session_id,
                "Fetch.continueRequest",
                &self.continue_params,
            )
            .await?;
        Ok(())
    }
}

pub(super) fn request_interception_command(
    strip: bool,
    auth: bool,
    patterns: Option<Vec<Value>>,
) -> (&'static str, Value) {
    if patterns.is_none() && !strip && !auth {
        return ("Fetch.disable", json!({}));
    }
    let patterns = if strip || auth {
        vec![json!({"urlPattern":"*","requestStage":"Request"})]
    } else {
        patterns.unwrap_or_default()
    };
    (
        "Fetch.enable",
        json!({"patterns": patterns, "handleAuthRequests":auth}),
    )
}

fn route_request_pause(
    routes: &RequestRoutes,
    session: Option<&str>,
    params: &mut Value,
    strip: bool,
) -> bool {
    if params.get("responseStatusCode").is_some() || params.get("responseErrorReason").is_some() {
        return false;
    }
    let Some(session) = session else {
        return false;
    };
    let routes = routes.lock().unwrap_or_else(|e| e.into_inner());
    let Some(route) = routes.get(session) else {
        return false;
    };
    if params["requestId"].as_str().is_none() {
        return false;
    }
    let permit = match route.events.try_reserve() {
        Ok(permit) => permit,
        Err(_) => {
            route.dropped.fetch_add(1, Ordering::Relaxed);
            return false;
        }
    };
    let Some(continue_params) = continuation_params(params, strip) else {
        return false;
    };
    permit.send(RequestPause {
        session_id: session.into(),
        params: params.take(),
        continue_params,
    });
    true
}

fn route_response_pause(
    routes: &ResponseRoutes,
    session: Option<&str>,
    params: &mut Value,
) -> bool {
    if params.get("responseStatusCode").is_none() && params.get("responseErrorReason").is_none() {
        return false;
    }
    let Some(session) = session else {
        return false;
    };
    let routes = routes.lock().unwrap_or_else(|e| e.into_inner());
    let Some(route) = routes.get(session) else {
        return false;
    };
    let permit = match route.events.try_reserve() {
        Ok(permit) => permit,
        Err(_) => {
            route.dropped.fetch_add(1, Ordering::Relaxed);
            return false;
        }
    };
    permit.send(params.take());
    true
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn manual_interception_preserves_and_restores_base_auth_and_header_policy() {
        let pattern = vec![json!({"urlPattern":"*/accepted","requestStage":"Request"})];
        for (strip, auth) in [(true, false), (false, true), (true, true)] {
            for patterns in [Some(pattern.clone()), None] {
                let (method, params) = request_interception_command(strip, auth, patterns);
                assert_eq!(method, "Fetch.enable");
                assert_eq!(params["handleAuthRequests"], auth);
                assert_eq!(params["patterns"][0]["urlPattern"], "*");
            }
        }
        assert_eq!(
            request_interception_command(false, false, None).0,
            "Fetch.disable"
        );
        let (_, params) = request_interception_command(false, false, Some(pattern.clone()));
        assert_eq!(params["patterns"], json!(pattern));
        assert_eq!(params["handleAuthRequests"], false);
    }

    #[test]
    fn request_routes_are_scoped_bounded_and_preserve_header_policy() {
        let routes: RequestRoutes = Default::default();
        let (sender, mut receiver) = mpsc::channel(1);
        let dropped = Arc::new(AtomicU64::new(0));
        routes.lock().unwrap().insert(
            "owned".into(),
            RequestRoute {
                events: sender,
                dropped: dropped.clone(),
            },
        );
        let request = json!({"requestId":"req", "request":{"headers":{"X-Client-Data":"strip", "Other":"keep"}}});
        assert!(!route_request_pause(
            &routes,
            Some("other"),
            &mut request.clone(),
            true
        ));
        assert!(!route_request_pause(
            &routes,
            None,
            &mut request.clone(),
            true
        ));
        let mut response = request.clone();
        response["responseStatusCode"] = json!(200);
        assert!(!route_request_pause(
            &routes,
            Some("owned"),
            &mut response,
            true
        ));
        assert!(route_request_pause(
            &routes,
            Some("owned"),
            &mut request.clone(),
            true
        ));
        assert!(!route_request_pause(
            &routes,
            Some("owned"),
            &mut request.clone(),
            true
        ));
        assert_eq!(dropped.load(Ordering::Relaxed), 1);
        let pause = receiver.try_recv().unwrap();
        assert_eq!(pause.session_id, "owned");
        assert_eq!(
            pause.continue_params,
            json!({"requestId":"req", "headers":[{"name":"Other","value":"keep"}]})
        );
        assert!(route_request_pause(
            &routes,
            Some("owned"),
            &mut request.clone(),
            false
        ));
        assert_eq!(
            receiver.try_recv().unwrap().continue_params,
            json!({"requestId":"req"})
        );
        drop(receiver);
        assert!(!route_request_pause(
            &routes,
            Some("owned"),
            &mut request.clone(),
            false
        ));
        assert_eq!(dropped.load(Ordering::Relaxed), 2);
        routes.lock().unwrap().remove("owned");
        assert!(!route_request_pause(
            &routes,
            Some("owned"),
            &mut request.clone(),
            true
        ));
    }

    #[test]
    fn response_routes_leave_unowned_and_overflowed_pauses_to_auto_continue() {
        let (sender, mut receiver) = mpsc::channel(1);
        let dropped = Arc::new(AtomicU64::new(0));
        let routes = Arc::new(std::sync::Mutex::new(HashMap::from([(
            "owned".into(),
            ResponseRoute {
                events: sender,
                dropped: dropped.clone(),
            },
        )])));
        let response = json!({"requestId":"1", "responseStatusCode":200});
        assert!(!route_response_pause(
            &routes,
            Some("owned"),
            &mut json!({"requestId":"1"})
        ));
        assert!(!route_response_pause(
            &routes,
            Some("other"),
            &mut response.clone()
        ));
        assert!(!route_response_pause(&routes, None, &mut response.clone()));
        assert!(route_response_pause(
            &routes,
            Some("owned"),
            &mut response.clone()
        ));
        assert!(!route_response_pause(
            &routes,
            Some("owned"),
            &mut response.clone()
        ));
        assert_eq!(dropped.load(Ordering::Relaxed), 1);
        assert_eq!(receiver.try_recv().unwrap(), response);
        drop(receiver);
        assert!(!route_response_pause(
            &routes,
            Some("owned"),
            &mut response.clone()
        ));
        assert_eq!(dropped.load(Ordering::Relaxed), 2);
    }

    #[test]
    fn strips_x_client_data_case_insensitively() {
        let headers = json!({
            "User-Agent": "test",
            "X-Client-Data": "abc123",
            "Accept": "*/*"
        });
        let stripped = strip_client_data_header(&headers).expect("header present");
        assert_eq!(stripped.len(), 2);
        assert!(stripped.contains(&json!({"name":"Accept", "value":"*/*"})));
        assert!(stripped.contains(&json!({"name":"User-Agent", "value":"test"})));
    }

    #[test]
    fn returns_none_when_header_absent() {
        let headers = json!({ "User-Agent": "test", "Accept": "*/*" });
        assert!(strip_client_data_header(&headers).is_none());
        assert!(strip_client_data_header(&json!({})).is_none());
        assert!(strip_client_data_header(&json!(null)).is_none());
    }

    #[test]
    fn preserves_other_headers_verbatim() {
        let headers = json!({
            "sec-ch-ua": "\"Chromium\";v=\"140\"",
            "x-client-data": "CJKxyz="
        });
        let stripped = strip_client_data_header(&headers).expect("header present");
        assert_eq!(
            stripped,
            vec![json!({"name":"sec-ch-ua", "value":"\"Chromium\";v=\"140\""})]
        );
    }
}