Skip to main content

gthings_cdp/
browser.rs

1use crate::connection::Connection;
2use crate::error::{CdpError, Result};
3use serde::{Deserialize, Serialize};
4use std::io::{BufRead, BufReader};
5use std::path::PathBuf;
6use std::process::{Command, Stdio};
7use tracing;
8
9/// A persistent Chrome browser instance. Stays alive after Drop.
10pub struct Browser {
11    ws_url: String,
12    #[allow(dead_code)]
13    cdp_port: u16,
14}
15
16/// Saved browser state for reuse across commands.
17#[derive(Serialize, Deserialize)]
18struct BrowserState {
19    pid: u32,
20}
21
22/// Detect the default browser for HTTP URLs using macOS Launch Services.
23/// Returns the path to the .app bundle (e.g., "/Applications/Google Chrome.app").
24#[cfg(target_os = "macos")]
25fn default_browser_bundle() -> Option<std::path::PathBuf> {
26    let script = r#"import AppKit; let ws = NSWorkspace.shared; if let url = ws.urlForApplication(toOpen: URL(string: "https://")!) { print(url.path) }"#;
27    let output = std::process::Command::new("swift")
28        .args(["-e", script])
29        .output()
30        .ok()?;
31    if !output.status.success() {
32        return None;
33    }
34    let path_str = std::str::from_utf8(&output.stdout).ok()?.trim();
35    if path_str.is_empty() {
36        return None;
37    }
38    let path = std::path::PathBuf::from(path_str);
39    if path.exists() { Some(path) } else { None }
40}
41
42#[cfg(not(target_os = "macos"))]
43fn default_browser_bundle() -> Option<std::path::PathBuf> {
44    None // Non-macOS fallback: no default browser detection
45}
46
47/// Map a browser bundle path to its executable name inside Contents/MacOS/
48fn browser_exec_name(bundle_path: &std::path::Path) -> Option<&'static str> {
49    let path_str = bundle_path.to_string_lossy();
50    if path_str.contains("Google Chrome") {
51        Some("Google Chrome")
52    } else if path_str.contains("Dia") {
53        Some("Dia")
54    } else if path_str.contains("Arc") {
55        Some("Arc")
56    } else if path_str.contains("Brave Browser") || path_str.contains("Brave") {
57        Some("Brave Browser")
58    } else if path_str.contains("Microsoft Edge") {
59        Some("Microsoft Edge")
60    } else if path_str.contains("Chromium") {
61        Some("Chromium")
62    } else {
63        None
64    }
65}
66
67/// Map a browser bundle path to its profile directory suffix (under ~/Library/Application Support/)
68fn browser_profile_suffix(bundle_path: &std::path::Path) -> Option<&'static str> {
69    let path_str = bundle_path.to_string_lossy();
70    if path_str.contains("Google Chrome") {
71        Some("Google/Chrome/User Data")
72    } else if path_str.contains("Dia") {
73        Some("Dia/User Data")
74    } else if path_str.contains("Arc") {
75        Some("Arc/User Data")
76    } else if path_str.contains("Brave Browser") || path_str.contains("Brave") {
77        Some("BraveSoftware/Brave-Browser/User Data")
78    } else if path_str.contains("Microsoft Edge") {
79        Some("Microsoft Edge/User Data")
80    } else if path_str.contains("Chromium") {
81        Some("Chromium/User Data")
82    } else {
83        None
84    }
85}
86
87/// Read the last-used profile directory name from the browser's Local State file.
88/// Returns "Default" as fallback if Local State can't be read or last_used is missing.
89#[allow(dead_code)]
90fn detect_last_used_profile(user_data_dir: &std::path::Path) -> String {
91    let local_state_path = user_data_dir.join("Local State");
92    let content = match std::fs::read_to_string(&local_state_path) {
93        Ok(c) => c,
94        Err(_) => return "Default".to_string(),
95    };
96    let json: serde_json::Value = match serde_json::from_str(&content) {
97        Ok(v) => v,
98        Err(_) => return "Default".to_string(),
99    };
100    // Look for "profile.last_used" path in the JSON
101    if let Some(last_used) = json.get("profile").and_then(|p| p.get("last_used")).and_then(|l| l.as_str()) {
102        if user_data_dir.join(last_used).exists() {
103            return last_used.to_string();
104        }
105    }
106    // Fallback: first key in profile.info_cache
107    if let Some(info_cache) = json.get("profile").and_then(|p| p.get("info_cache")) {
108        if let Some(obj) = info_cache.as_object() {
109            if let Some(first_key) = obj.keys().next() {
110                return first_key.clone();
111            }
112        }
113    }
114    "Default".to_string()
115}
116
117/// Build the executable path from a bundle path
118fn bundle_to_exec(bundle: &std::path::Path, exec_name: &str) -> std::path::PathBuf {
119    bundle.join("Contents").join("MacOS").join(exec_name)
120}
121
122impl Browser {
123    /// Launch or reuse a persistent Chrome browser.
124    #[allow(clippy::result_large_err)]
125    pub async fn launch(
126        browser_path: Option<std::path::PathBuf>,
127        profile_dir: Option<std::path::PathBuf>,
128        cdp_port: u16,
129    ) -> Result<Self> {
130        tracing::info!("Checking for existing browser on port {cdp_port}");
131        if let Some(browser) = Self::find_existing(cdp_port).await {
132            tracing::info!("Found existing browser, reusing");
133            return Ok(browser);
134        }
135        tracing::info!("No existing browser found, launching new one");
136
137        let chrome_path = Self::find_chrome(browser_path)
138            .ok_or_else(|| CdpError::LaunchFailed("No Chrome/Chromium browser found".into()))?;
139
140        let port = cdp_port;
141
142        // Use real profile to avoid browser onboarding/login prompts.
143        // SingletonLock conflicts are avoided because find_existing() reuses
144        // the already-running browser instead of launching a second instance.
145        // If no existing browser is found, we clean locks and launch fresh.
146        let profile_dir = Self::real_profile_dir(profile_dir).unwrap_or_else(|| {
147            let tmp = std::path::PathBuf::from(format!("/tmp/gthings-{}", port));
148            let _ = std::fs::create_dir_all(&tmp);
149            tmp
150        });
151
152        // Clean locks before fresh launch to avoid SingletonLock conflicts
153        {
154            let dir = profile_dir.clone();
155            tokio::task::spawn_blocking(move || {
156                Self::clean_profile_locks(&dir);
157            })
158            .await
159            .map_err(|e| CdpError::LaunchFailed(format!("spawn_blocking failed: {e}")))?;
160        }
161
162        tracing::info!(
163            "Launching browser on port {} with profile {:?}",
164            port,
165            profile_dir,
166        );
167
168        let mut cmd = Command::new(&chrome_path);
169        cmd.arg(format!("--remote-debugging-port={}", port))
170            .arg("--no-first-run")
171            .arg("--no-default-browser-check")
172            .arg("--disable-sync")
173            .arg("--remote-allow-origins=*")
174            .arg("--enable-automation")
175            .arg("--disable-background-networking")
176            .arg("--disable-extensions")
177            .arg("--disable-component-update")
178            .arg("--disable-default-apps")
179            .arg("--password-store=basic")
180            .arg("--use-mock-keychain")
181            .arg(format!("--user-data-dir={}", profile_dir.display()))
182            .arg("about:blank")
183            .stderr(Stdio::piped())
184            .stdout(Stdio::null())
185            .stdin(Stdio::null());
186
187        let mut child = cmd
188            .spawn()
189            .map_err(|e| CdpError::LaunchFailed(format!("Failed to spawn Chrome: {e}")))?;
190
191        let stderr = child
192            .stderr
193            .take()
194            .ok_or_else(|| CdpError::LaunchFailed("No stderr on Chrome process".into()))?;
195
196        let reader = BufReader::new(stderr);
197        let mut ws_url = None;
198
199        for line in reader.lines() {
200            let line = line.map_err(|e| {
201                CdpError::LaunchFailed(format!("Failed to read Chrome stderr: {e}"))
202            })?;
203            tracing::debug!("Chrome: {}", line);
204
205            // "DevTools listening on ws://127.0.0.1:9222/..."
206            if let Some(url) = line.strip_prefix("DevTools listening on ") {
207                ws_url = Some(url.trim().to_string());
208                break;
209            }
210        }
211
212        let ws_url = ws_url.ok_or(CdpError::NoWsUrl)?;
213        let pid = child.id();
214
215        let state = BrowserState { pid };
216        let state_json = serde_json::to_string(&state)?;
217        // Atomic write: temp file then rename
218        let final_path = Self::state_path();
219        let tmp_path = final_path.with_extension("json.tmp");
220        let json = state_json;
221        tokio::task::spawn_blocking(move || {
222            if let Some(parent) = final_path.parent() {
223                let _ = std::fs::create_dir_all(parent);
224            }
225            std::fs::write(&tmp_path, &json)
226                .map_err(|e| CdpError::LaunchFailed(format!("Cannot save state: {e}")))?;
227            std::fs::rename(&tmp_path, &final_path)
228                .map_err(|e| CdpError::LaunchFailed(format!("Cannot commit state: {e}")))?;
229            Ok::<_, CdpError>(())
230        })
231        .await
232        .map_err(|e| CdpError::LaunchFailed(format!("spawn_blocking failed: {e}")))??;
233
234        tracing::info!("Launched persistent browser (pid={})", pid);
235
236        // Detach — browser stays alive after Drop
237        drop(child);
238
239        Ok(Browser { ws_url, cdp_port })
240    }
241
242    /// Connect to CDP WebSocket.
243    pub async fn connect(&self) -> Result<Connection> {
244        tracing::info!("Connecting to CDP: {}", self.ws_url);
245
246        let (ws_stream, _) = tokio_tungstenite::connect_async(self.ws_url.clone()).await?;
247        // Leak kill_tx so kill_rx never fires
248        let (kill_tx, kill_rx) = tokio::sync::oneshot::channel();
249        std::mem::forget(kill_tx);
250        Connection::new(ws_stream, kill_rx).await
251    }
252
253    /// Get the WebSocket URL.
254    pub fn ws_url(&self) -> &str {
255        &self.ws_url
256    }
257
258    /// Locate Chrome executable.
259    fn find_chrome(browser_path: Option<std::path::PathBuf>) -> Option<String> {
260        // 1. Check explicit env var first (already done in Level 0)
261        if let Some(path) = browser_path {
262            if path.exists() {
263                return Some(path.to_string_lossy().to_string());
264            }
265        }
266
267        // 2. Check macOS default browser
268        #[cfg(target_os = "macos")]
269        if let Some(bundle) = default_browser_bundle() {
270            if let Some(exec_name) = browser_exec_name(&bundle) {
271                let exec = bundle_to_exec(&bundle, exec_name);
272                if exec.exists() {
273                    return Some(exec.to_string_lossy().to_string());
274                }
275            }
276        }
277
278        // 3. Fallback: hardcoded path list (original behavior)
279        let candidates = [
280            "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome",
281            "/Applications/Chrome.app/Contents/MacOS/Chrome",
282            "/Applications/Brave Browser.app/Contents/MacOS/Brave Browser",
283            "/Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge",
284            "/Applications/Arc.app/Contents/MacOS/Arc",
285            "/Applications/Dia.app/Contents/MacOS/Dia",
286            "/usr/bin/chromium",
287            "/usr/bin/chromium-browser",
288            "/snap/bin/chromium",
289        ];
290
291        for candidate in &candidates {
292            if std::path::Path::new(candidate).exists() {
293                return Some(candidate.to_string());
294            }
295        }
296
297        // 4. Fallback: `which` search
298        for name in &["google-chrome", "chromium", "google-chrome-stable", "dia"] {
299            if let Ok(output) = std::process::Command::new("which").arg(name).output() {
300                if output.status.success() {
301                    let path = String::from_utf8_lossy(&output.stdout).trim().to_string();
302                    if !path.is_empty() && std::path::Path::new(&path).exists() {
303                        return Some(path);
304                    }
305                }
306            }
307        }
308
309        None
310    }
311
312    /// Locate browser profile directory.
313    fn real_profile_dir(profile_dir: Option<std::path::PathBuf>) -> Option<std::path::PathBuf> {
314        // 1. Check explicit env var first (GTHINGS_PROFILE_DIR)
315        if let Some(dir) = profile_dir {
316            if dir.exists() {
317                return Some(dir);
318            }
319        }
320
321        let home = std::env::var("HOME").ok()?;
322
323        // 2. Try to match profile to the default browser
324        #[cfg(target_os = "macos")]
325        if let Some(bundle) = default_browser_bundle() {
326            if let Some(suffix) = browser_profile_suffix(&bundle) {
327                let profile = std::path::PathBuf::from(&home)
328                    .join("Library/Application Support")
329                    .join(suffix);
330                if profile.exists() {
331                    return Some(profile);
332                }
333            }
334        }
335
336        // 3. Fallback: check common profile directories
337        let common_profiles = [
338            "Google/Chrome/User Data",
339            "Dia/User Data",
340            "Chromium/User Data",
341            "BraveSoftware/Brave-Browser/User Data",
342            "Microsoft Edge/User Data",
343            "Arc/User Data",
344        ];
345
346        for suffix in &common_profiles {
347            let profile = std::path::PathBuf::from(&home)
348                .join("Library/Application Support")
349                .join(suffix);
350            if profile.exists() {
351                return Some(profile);
352            }
353        }
354
355        None
356    }
357
358    /// Clean profile lock files.
359    fn clean_profile_locks(profile_dir: &std::path::Path) {
360        let lock_files = [
361            "SingletonLock",
362            "SingletonSocket",
363            "SingletonCookie",
364            "DevToolsActivePort",
365        ];
366        for name in &lock_files {
367            let path = profile_dir.join(name);
368            if path.exists() {
369                let _ = std::fs::remove_file(&path);
370            }
371        }
372    }
373
374    /// Check if the browser is alive by probing the given port.
375    pub fn is_alive(cdp_port: u16) -> bool {
376        Self::probe_port(cdp_port)
377    }
378
379    /// Get the path to the browser state file.
380    fn state_path() -> PathBuf {
381        Self::home_dir().join(".gthings/browser.json")
382    }
383
384    /// Get home directory.
385    fn home_dir() -> PathBuf {
386        std::env::var("HOME")
387            .map(PathBuf::from)
388            .unwrap_or_else(|_| PathBuf::from("/tmp"))
389    }
390
391    /// Get the path to the browser state file (public for CLI use).
392    pub fn state_file_path() -> PathBuf {
393        Self::state_path()
394    }
395
396    /// Find existing browser via state file and port probe.
397    pub async fn find_existing(cdp_port: u16) -> Option<Self> {
398        let state_path = Self::state_path();
399        if !state_path.exists() {
400            return None;
401        }
402
403        let path = state_path.clone();
404        let state_str: String =
405            tokio::task::spawn_blocking(move || std::fs::read_to_string(&path).ok())
406                .await
407                .unwrap_or(None)?;
408        let state: BrowserState = serde_json::from_str(&state_str).ok()?;
409
410        if !Self::is_process_alive(state.pid) {
411            tracing::warn!("Browser pid={} is dead, removing stale state", state.pid);
412            let path = state_path.clone();
413            tokio::task::spawn_blocking(move || {
414                let _ = std::fs::remove_file(&path);
415            })
416            .await
417            .ok();
418            return None;
419        }
420
421        if !Self::probe_port(cdp_port) {
422            tracing::warn!(
423                "Browser port {} not responding, removing stale state",
424                cdp_port
425            );
426            let path = state_path.clone();
427            tokio::task::spawn_blocking(move || {
428                let _ = std::fs::remove_file(&path);
429            })
430            .await
431            .ok();
432            return None;
433        }
434
435        let ws_url = Self::fetch_ws_url(cdp_port).await?;
436
437        tracing::info!("Found existing browser (pid={})", state.pid);
438
439        Some(Browser { ws_url, cdp_port })
440    }
441
442    /// Fetch WebSocket debugger URL from /json/version.
443    async fn fetch_ws_url(cdp_port: u16) -> Option<String> {
444        let url = format!("http://127.0.0.1:{cdp_port}/json/version");
445        let resp = reqwest::get(&url).await.ok()?;
446        let json: serde_json::Value = resp.json().await.ok()?;
447        json["webSocketDebuggerUrl"].as_str().map(|s| s.to_string())
448    }
449
450    /// Check if a process is alive by pid.
451    fn is_process_alive(pid: u32) -> bool {
452        std::process::Command::new("kill")
453            .arg("-0")
454            .arg(pid.to_string())
455            .output()
456            .map(|output| output.status.success())
457            .unwrap_or(false)
458    }
459
460    /// Probe port to see if it's accepting connections.
461    /// Tries IPv4 first, then IPv6.
462    fn probe_port(cdp_port: u16) -> bool {
463        let addrs = [format!("127.0.0.1:{cdp_port}"), format!("[::1]:{cdp_port}")];
464        for addr in &addrs {
465            if let Ok(parsed) = addr.parse::<std::net::SocketAddr>() {
466                if std::net::TcpStream::connect_timeout(
467                    &parsed,
468                    std::time::Duration::from_millis(500),
469                )
470                .is_ok()
471                {
472                    return true;
473                }
474            }
475        }
476        false
477    }
478
479    /// Get the browser pid from the state file.
480    pub async fn pid(&self) -> Option<u32> {
481        let state_path = Self::state_path();
482        tokio::task::spawn_blocking(move || {
483            if state_path.exists() {
484                if let Ok(state_str) = std::fs::read_to_string(&state_path) {
485                    if let Ok(state) = serde_json::from_str::<BrowserState>(&state_str) {
486                        return Some(state.pid);
487                    }
488                }
489            }
490            None
491        })
492        .await
493        .unwrap_or(None)
494    }
495}
496
497impl Drop for Browser {
498    fn drop(&mut self) {
499        // Browser stays alive — it's persistent
500    }
501}
502
503#[cfg(test)]
504mod tests {
505    use super::*;
506
507    #[test]
508    fn test_probe_port_no_server() {
509        assert_eq!(Browser::is_alive(9222), Browser::probe_port(9222));
510    }
511
512    #[test]
513    fn test_state_path_ends_correctly() {
514        let path = Browser::state_path();
515        assert!(path.ends_with(".gthings/browser.json"));
516    }
517
518    #[test]
519    fn test_find_chrome_returns_some_or_none() {
520        let result = Browser::find_chrome(None);
521        // Either finds Chrome or returns None — don't panic either way
522        if let Some(path) = result {
523            assert!(
524                std::path::Path::new(&path).exists(),
525                "Chrome path should exist: {}",
526                path
527            );
528        }
529    }
530
531    #[test]
532    fn test_error_types_compile() {
533        let _err = CdpError::LaunchFailed("test".into());
534        let _err = CdpError::NoWsUrl;
535        let _err = CdpError::Timeout(1000);
536    }
537}