feat(cdp): implement Network.setCookie + deleteCookies, full field fidelity (#170)

* feat(cdp): implement Network.setCookie + deleteCookies, full field fidelity

Closes #168.

Adds the missing Network.setCookie (singular) and Network.deleteCookies
methods and upgrades the existing Network.setCookies/getCookies handlers
so sameSite, expires, httpOnly, secure, and the url-fallback parameter
all round-trip correctly.

Network and Storage cookie handlers share a single parse_cdp_cookie /
parse_delete_cookies_params helper to avoid drift.

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>

* fix(cdp): fall back to default cookie jar, add Network.getAllCookies

Addresses @SGavrl review on PR #170:

- Network.{set,get,delete}Cookie(s)/clearBrowserCookies now resolve the
  cookie jar via a shared helper that prefers the session page's jar and
  falls back to ctx.default_context.cookie_jar when no target has been
  attached. Mirrors how Storage.setCookies already routes when there is
  no session, so Puppeteer/Playwright flows that issue cookie methods
  before Target.attachToTarget no longer hit "No page".
- Add Network.getAllCookies (separate CDP method per spec); aliases the
  existing getCookies handler so both arms return the full jar.

Tests: 6 new #[tokio::test] cases in domains::network::tests cover the
no-session fallback for set/get/setMany/delete/clear and the new
getAllCookies arm. RED on prod-reverted file (6/6 fail with "No page" /
"Unknown Network method: getAllCookies"), GREEN on patched
(22 -> 30 obscura-cdp lib tests, obscura-net 22/22 baseline preserved).
This commit is contained in:
Ben Younes authored and GitHub committed 2026-05-25 17:58:48 +02:00
1 parent 52fcf2a35a
commit 1da6032639
5 files changed
+492 -127

No files matched your search

+162
View File
@@ -0,0 +1,162 @@
use obscura_net::CookieInfo;
use serde_json::Value;
const DEFAULT_COOKIE_PATH: &str = "/";
pub fn parse_cdp_cookie(value: &Value) -> Option<CookieInfo> {
let name = value.get("name").and_then(|v| v.as_str())?.to_string();
let cookie_value = value
.get("value")
.and_then(|v| v.as_str())
.unwrap_or("")
.to_string();
let url_parsed = value
.get("url")
.and_then(|v| v.as_str())
.and_then(|u| url::Url::parse(u).ok());
let domain = value
.get("domain")
.and_then(|v| v.as_str())
.map(|s| s.to_string())
.or_else(|| url_parsed.as_ref().and_then(|u| u.host_str().map(|h| h.to_string())))
.unwrap_or_default();
if domain.is_empty() {
return None;
}
let path = value
.get("path")
.and_then(|v| v.as_str())
.map(|s| s.to_string())
.or_else(|| url_parsed.as_ref().map(|u| u.path().to_string()))
.unwrap_or_else(|| DEFAULT_COOKIE_PATH.to_string());
let secure = value.get("secure").and_then(|v| v.as_bool()).unwrap_or(false);
let http_only = value.get("httpOnly").and_then(|v| v.as_bool()).unwrap_or(false);
let same_site = value
.get("sameSite")
.and_then(|v| v.as_str())
.unwrap_or("")
.to_string();
let expires = value.get("expires").and_then(|v| v.as_f64()).map(|f| f as i64);
Some(CookieInfo {
name,
value: cookie_value,
domain,
path,
secure,
http_only,
same_site,
expires,
})
}
pub struct DeleteCookiesFilter {
pub name: String,
pub domain: String,
pub path: Option<String>,
}
pub fn parse_delete_cookies_params(params: &Value) -> Option<DeleteCookiesFilter> {
let name = params.get("name").and_then(|v| v.as_str())?.to_string();
if name.is_empty() {
return None;
}
let url_parsed = params
.get("url")
.and_then(|v| v.as_str())
.and_then(|u| url::Url::parse(u).ok());
let domain = params
.get("domain")
.and_then(|v| v.as_str())
.map(|s| s.to_string())
.or_else(|| url_parsed.as_ref().and_then(|u| u.host_str().map(|h| h.to_string())))
.unwrap_or_default();
let path = params
.get("path")
.and_then(|v| v.as_str())
.map(|s| s.to_string())
.or_else(|| url_parsed.as_ref().map(|u| u.path().to_string()));
Some(DeleteCookiesFilter { name, domain, path })
}
#[cfg(test)]
mod tests {
use super::*;
use serde_json::json;
#[test]
fn parse_with_explicit_domain_path() {
let v = json!({
"name": "session",
"value": "abc",
"domain": ".example.com",
"path": "/app",
"secure": true,
"httpOnly": true,
"sameSite": "Strict",
"expires": 1_900_000_000.0,
});
let c = parse_cdp_cookie(&v).unwrap();
assert_eq!(c.name, "session");
assert_eq!(c.value, "abc");
assert_eq!(c.domain, ".example.com");
assert_eq!(c.path, "/app");
assert!(c.secure);
assert!(c.http_only);
assert_eq!(c.same_site, "Strict");
assert_eq!(c.expires, Some(1_900_000_000));
}
#[test]
fn parse_with_url_fallback_for_domain_and_path() {
let v = json!({
"name": "tok",
"value": "xyz",
"url": "https://api.example.com/v1/things",
});
let c = parse_cdp_cookie(&v).unwrap();
assert_eq!(c.domain, "api.example.com");
assert_eq!(c.path, "/v1/things");
}
#[test]
fn parse_rejects_when_no_domain_or_url() {
let v = json!({ "name": "x", "value": "y" });
assert!(parse_cdp_cookie(&v).is_none());
}
#[test]
fn parse_default_path_when_url_has_no_path() {
let v = json!({
"name": "tok",
"value": "v",
"domain": "example.com",
});
let c = parse_cdp_cookie(&v).unwrap();
assert_eq!(c.path, "/");
}
#[test]
fn delete_filter_requires_name() {
let v = json!({ "domain": "example.com" });
assert!(parse_delete_cookies_params(&v).is_none());
}
#[test]
fn delete_filter_uses_url_for_domain_and_path() {
let v = json!({ "name": "session", "url": "https://example.com/admin" });
let f = parse_delete_cookies_params(&v).unwrap();
assert_eq!(f.name, "session");
assert_eq!(f.domain, "example.com");
assert_eq!(f.path.as_deref(), Some("/admin"));
}
}
+175 -34
View File
@@ -1,7 +1,29 @@
use std::sync::Arc;
use serde_json::{json, Value};
use obscura_net::CookieJar;
use crate::cookie_params::{parse_cdp_cookie, parse_delete_cookies_params};
use crate::dispatch::CdpContext;
const SESSION_COOKIE_EXPIRES: i64 = -1;
const DEFAULT_SECURE_PORT: u16 = 443;
const DEFAULT_INSECURE_PORT: u16 = 80;
const SOURCE_SCHEME_SECURE: &str = "Secure";
const SOURCE_SCHEME_NONSECURE: &str = "NonSecure";
const DEFAULT_SAME_SITE: &str = "Lax";
// Resolve the cookie jar for a Network request: prefer the session's page jar,
// fall back to the default browser context. Puppeteer and Playwright both call
// Network.setCookie/getCookies/deleteCookies BEFORE attaching to a target —
// requiring a session would break those flows (Storage.* already mirrors this).
fn cookie_jar_for<'a>(ctx: &'a CdpContext, session_id: &Option<String>) -> &'a Arc<CookieJar> {
ctx.get_session_page(session_id)
.map(|p| &p.context.cookie_jar)
.unwrap_or(&ctx.default_context.cookie_jar)
}
pub async fn handle(
method: &str,
params: &Value,
@@ -30,48 +52,36 @@ pub async fn handle(
}
Ok(json!({}))
}
"getCookies" => {
let page = ctx.get_session_page(session_id).ok_or("No page")?;
let cookies = page.context.cookie_jar.get_all_cookies();
let cdp_cookies: Vec<Value> = cookies.iter().map(|c| {
json!({
"name": c.name,
"value": c.value,
"domain": c.domain,
"path": c.path,
"expires": -1,
"size": c.name.len() + c.value.len(),
"httpOnly": c.http_only,
"secure": c.secure,
"session": true,
"sameParty": false,
"sourceScheme": "Secure",
"sourcePort": 443,
})
}).collect();
"getCookies" | "getAllCookies" => {
let cookies = cookie_jar_for(ctx, session_id).get_all_cookies();
let cdp_cookies: Vec<Value> = cookies.iter().map(cookie_info_to_cdp_json).collect();
Ok(json!({ "cookies": cdp_cookies }))
}
"setCookie" => {
let cookie = parse_cdp_cookie(params)
.ok_or("setCookie: missing required name/domain (or url)")?;
cookie_jar_for(ctx, session_id).set_cookies_from_cdp(vec![cookie]);
Ok(json!({ "success": true }))
}
"setCookies" => {
let page = ctx.get_session_page(session_id).ok_or("No page")?;
if let Some(cookies) = params.get("cookies").and_then(|v| v.as_array()) {
let cookie_infos: Vec<obscura_net::CookieInfo> = cookies.iter().filter_map(|c| {
Some(obscura_net::CookieInfo {
name: c.get("name")?.as_str()?.to_string(),
value: c.get("value")?.as_str()?.to_string(),
domain: c.get("domain").and_then(|v| v.as_str()).unwrap_or("").to_string(),
path: c.get("path").and_then(|v| v.as_str()).unwrap_or("/").to_string(),
secure: c.get("secure").and_then(|v| v.as_bool()).unwrap_or(false),
http_only: c.get("httpOnly").and_then(|v| v.as_bool()).unwrap_or(false),
})
}).collect();
page.context.cookie_jar.set_cookies_from_cdp(cookie_infos);
let parsed: Vec<_> = cookies.iter().filter_map(parse_cdp_cookie).collect();
cookie_jar_for(ctx, session_id).set_cookies_from_cdp(parsed);
}
Ok(json!({}))
}
"deleteCookies" => {
if let Some(filter) = parse_delete_cookies_params(params) {
cookie_jar_for(ctx, session_id).delete_cookies_filtered(
&filter.name,
&filter.domain,
filter.path.as_deref(),
);
}
Ok(json!({}))
}
"clearBrowserCookies" => {
if let Some(page) = ctx.get_session_page(session_id) {
page.context.cookie_jar.clear();
}
cookie_jar_for(ctx, session_id).clear();
Ok(json!({}))
}
"setCacheDisabled" => Ok(json!({})),
@@ -79,3 +89,134 @@ pub async fn handle(
_ => Err(format!("Unknown Network method: {}", method)),
}
}
#[cfg(test)]
mod tests {
use super::*;
use obscura_net::CookieInfo;
fn sample_cookie(name: &str) -> CookieInfo {
CookieInfo {
name: name.to_string(),
value: "v".to_string(),
domain: "example.com".to_string(),
path: "/".to_string(),
secure: false,
http_only: false,
same_site: String::new(),
expires: None,
}
}
#[tokio::test]
async fn set_cookie_without_session_targets_default_context() {
let mut ctx = CdpContext::new();
let params = json!({
"name": "sid",
"value": "abc",
"domain": "example.com",
"path": "/"
});
let resp = handle("setCookie", &params, &mut ctx, &None)
.await
.expect("setCookie must succeed without a session");
assert_eq!(resp["success"], json!(true));
let cookies = ctx.default_context.cookie_jar.get_all_cookies();
assert_eq!(cookies.len(), 1, "default cookie jar must receive the cookie");
assert_eq!(cookies[0].name, "sid");
}
#[tokio::test]
async fn set_cookies_without_session_targets_default_context() {
let mut ctx = CdpContext::new();
let params = json!({
"cookies": [
{ "name": "a", "value": "1", "domain": "example.com", "path": "/" },
{ "name": "b", "value": "2", "domain": "example.com", "path": "/" }
]
});
handle("setCookies", &params, &mut ctx, &None)
.await
.expect("setCookies must succeed without a session");
assert_eq!(ctx.default_context.cookie_jar.get_all_cookies().len(), 2);
}
#[tokio::test]
async fn delete_cookies_without_session_targets_default_context() {
let mut ctx = CdpContext::new();
ctx.default_context
.cookie_jar
.set_cookies_from_cdp(vec![sample_cookie("sid")]);
let params = json!({ "name": "sid", "domain": "example.com" });
handle("deleteCookies", &params, &mut ctx, &None)
.await
.expect("deleteCookies must succeed without a session");
assert!(ctx.default_context.cookie_jar.get_all_cookies().is_empty());
}
#[tokio::test]
async fn get_all_cookies_returns_every_cookie_in_jar() {
let mut ctx = CdpContext::new();
ctx.default_context.cookie_jar.set_cookies_from_cdp(vec![
sample_cookie("a"),
sample_cookie("b"),
]);
let resp = handle("getAllCookies", &json!({}), &mut ctx, &None)
.await
.expect("getAllCookies must succeed");
let arr = resp["cookies"].as_array().expect("cookies array");
assert_eq!(arr.len(), 2);
}
#[tokio::test]
async fn get_cookies_falls_back_to_default_context_when_no_session() {
let mut ctx = CdpContext::new();
ctx.default_context
.cookie_jar
.set_cookies_from_cdp(vec![sample_cookie("sid")]);
let resp = handle("getCookies", &json!({}), &mut ctx, &None)
.await
.expect("getCookies must succeed without a session");
let arr = resp["cookies"].as_array().expect("cookies array");
assert_eq!(arr.len(), 1);
assert_eq!(arr[0]["name"], "sid");
}
#[tokio::test]
async fn clear_browser_cookies_without_session_clears_default_context() {
let mut ctx = CdpContext::new();
ctx.default_context
.cookie_jar
.set_cookies_from_cdp(vec![sample_cookie("sid")]);
handle("clearBrowserCookies", &json!({}), &mut ctx, &None)
.await
.expect("clearBrowserCookies must succeed");
assert!(ctx.default_context.cookie_jar.get_all_cookies().is_empty());
}
}
pub(crate) fn cookie_info_to_cdp_json(c: &obscura_net::CookieInfo) -> Value {
let expires = c.expires.unwrap_or(SESSION_COOKIE_EXPIRES);
let session = c.expires.is_none();
let same_site = if c.same_site.is_empty() {
DEFAULT_SAME_SITE
} else {
c.same_site.as_str()
};
json!({
"name": c.name,
"value": c.value,
"domain": c.domain,
"path": c.path,
"expires": expires,
"size": c.name.len() + c.value.len(),
"httpOnly": c.http_only,
"secure": c.secure,
"session": session,
"sameSite": same_site,
"sameParty": false,
"sourceScheme": if c.secure { SOURCE_SCHEME_SECURE } else { SOURCE_SCHEME_NONSECURE },
"sourcePort": if c.secure { DEFAULT_SECURE_PORT } else { DEFAULT_INSECURE_PORT },
"priority": "Medium",
})
}
+11 -90
View File
@@ -1,6 +1,8 @@
use serde_json::{json, Value};
use crate::cookie_params::{parse_cdp_cookie, parse_delete_cookies_params};
use crate::dispatch::CdpContext;
use crate::domains::network::cookie_info_to_cdp_json;
pub async fn handle(
method: &str,
@@ -11,104 +13,23 @@ pub async fn handle(
match method {
"getCookies" => {
let cookies = ctx.default_context.cookie_jar.get_all_cookies();
let cdp_cookies: Vec<Value> = cookies
.iter()
.map(|c| {
json!({
"name": c.name,
"value": c.value,
"domain": c.domain,
"path": c.path,
"expires": -1,
"size": c.name.len() + c.value.len(),
"httpOnly": c.http_only,
"secure": c.secure,
"session": true,
"priority": "Medium",
"sameParty": false,
"sourceScheme": if c.secure { "Secure" } else { "NonSecure" },
"sourcePort": 80,
})
})
.collect();
let cdp_cookies: Vec<Value> = cookies.iter().map(cookie_info_to_cdp_json).collect();
Ok(json!({ "cookies": cdp_cookies }))
}
"setCookies" => {
if let Some(cookies) = params.get("cookies").and_then(|v| v.as_array()) {
let now = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.unwrap_or_default()
.as_secs_f64();
for c in cookies {
let name = match c.get("name").and_then(|v| v.as_str()) {
Some(n) => n.to_string(),
None => continue,
};
let value = c.get("value").and_then(|v| v.as_str()).unwrap_or("").to_string();
let domain = c
.get("domain")
.and_then(|v| v.as_str())
.map(|s| s.to_string())
.or_else(|| {
c.get("url")
.and_then(|v| v.as_str())
.and_then(|u| url::Url::parse(u).ok())
.and_then(|u| u.host_str().map(|h| h.to_string()))
})
.unwrap_or_default();
let expires = c.get("expires").and_then(|v| v.as_f64());
if let Some(exp) = expires {
if exp > 0.0 && exp < now {
ctx.default_context.cookie_jar.delete_cookie(&name, &domain);
continue;
}
}
let path = c
.get("path")
.and_then(|v| v.as_str())
.unwrap_or("/")
.to_string();
let secure =
c.get("secure").and_then(|v| v.as_bool()).unwrap_or(false);
let http_only =
c.get("httpOnly").and_then(|v| v.as_bool()).unwrap_or(false);
ctx.default_context.cookie_jar.set_cookies_from_cdp(vec![
obscura_net::CookieInfo {
name,
value,
domain,
path,
secure,
http_only,
},
]);
}
let parsed: Vec<_> = cookies.iter().filter_map(parse_cdp_cookie).collect();
ctx.default_context.cookie_jar.set_cookies_from_cdp(parsed);
}
Ok(json!({}))
}
"deleteCookies" => {
let name = params.get("name").and_then(|v| v.as_str()).unwrap_or("");
let domain_from_url = params
.get("url")
.and_then(|v| v.as_str())
.and_then(|u| url::Url::parse(u).ok())
.and_then(|u| u.host_str().map(|h| h.to_string()));
let domain = params
.get("domain")
.and_then(|v| v.as_str())
.map(|s| s.to_string())
.or(domain_from_url)
.unwrap_or_default();
if !name.is_empty() {
ctx.default_context
.cookie_jar
.delete_cookie(name, &domain);
if let Some(filter) = parse_delete_cookies_params(params) {
ctx.default_context.cookie_jar.delete_cookies_filtered(
&filter.name,
&filter.domain,
filter.path.as_deref(),
);
}
Ok(json!({}))
}
+1
View File
@@ -2,6 +2,7 @@ pub mod server;
pub mod dispatch;
pub mod types;
pub mod domains;
pub mod cookie_params;
pub(crate) mod util;
pub use server::{