allwright-core 0.0.51

Lightweight allwright engine core with shared client and transport APIs.
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

use std::sync::Arc;

use crate::proto::browser_session_command::Command as BrowserCommand;
use crate::proto::browser_session_event::Event as BrowserEvent;
use crate::proto::{
    BrowserKind as ProtoBrowserKind, BrowserLaunchedEvent, BrowserSessionCommand,
    LaunchBrowserCommand,
};
use tokio::sync::{Mutex as AsyncMutex, mpsc};
use tokio_stream::wrappers::ReceiverStream;

use super::command::command_retry_options;
use super::runtime::get_runtime;
use super::types::{
    Browser, BrowserInner, BrowserKind, BrowserState, BrowserType, Error, LaunchOptions, Result,
    Tab, TabInner, TabState,
};

pub async fn launch_chrome(options: LaunchOptions) -> Result<Browser> {
    launch_browser(BrowserKind::Chromium, options).await
}

pub async fn launch_firefox(options: LaunchOptions) -> Result<Browser> {
    launch_browser(BrowserKind::Firefox, options).await
}

pub async fn launch_browser(browser_kind: BrowserKind, options: LaunchOptions) -> Result<Browser> {
    let runtime = get_runtime().await?;
    let mut engine = runtime.engine.clone();
    let (command_tx, command_rx) = mpsc::channel(16);
    let response = engine
        .browser_session(tonic::Request::new(ReceiverStream::new(command_rx)))
        .await?;
    let mut events = response.into_inner();

    command_tx
        .send(BrowserSessionCommand {
            command: Some(BrowserCommand::LaunchBrowser(LaunchBrowserCommand {
                browser_kind: match browser_kind {
                    BrowserKind::Chromium => ProtoBrowserKind::Chromium as i32,
                    BrowserKind::Firefox => ProtoBrowserKind::Firefox as i32,
                },
                browser_binary: options.browser_binary,
                retry_options: command_retry_options(options.timeout_ms),
            })),
        })
        .await
        .map_err(|_| Error::new("failed to send LaunchBrowserCommand to browser session"))?;

    loop {
        let event = events
            .message()
            .await?
            .ok_or_else(|| Error::new("browser session closed before launch response"))?;

        match event.event {
            Some(BrowserEvent::BrowserLaunched(BrowserLaunchedEvent {
                browser,
                note,
                user_data_dir,
                initial_tab_session_id,
                ..
            })) => {
                return Ok(build_browser(
                    runtime,
                    command_tx,
                    events,
                    event.session_id,
                    browser,
                    note,
                    String::new(),
                    user_data_dir,
                    initial_tab_session_id,
                ));
            }
            Some(BrowserEvent::ChromeLaunched(launched)) => {
                return Ok(build_browser(
                    runtime,
                    command_tx,
                    events,
                    event.session_id,
                    launched.browser,
                    launched.note,
                    launched.cdp_websocket_url,
                    launched.user_data_dir,
                    launched.initial_tab_session_id,
                ));
            }
            Some(BrowserEvent::Error(error)) => {
                return Err(Error::new(format!(
                    "browser session error during launch: {}",
                    error.message
                )));
            }
            _ => {}
        }
    }
}

pub fn chromium() -> BrowserType {
    BrowserType {
        browser_kind: BrowserKind::Chromium,
    }
}

pub fn firefox() -> BrowserType {
    BrowserType {
        browser_kind: BrowserKind::Firefox,
    }
}

impl BrowserType {
    pub async fn launch(&self, options: LaunchOptions) -> Result<Browser> {
        launch_browser(self.browser_kind, options).await
    }
}

fn build_browser(
    runtime: Arc<super::types::RuntimeClient>,
    command_tx: mpsc::Sender<BrowserSessionCommand>,
    events: tonic::Streaming<crate::proto::BrowserSessionEvent>,
    browser_session_id: String,
    browser: String,
    note: String,
    cdp_websocket_url: String,
    user_data_dir: String,
    initial_tab_session_id: String,
) -> Browser {
    let initial_tab = Tab {
        inner: Arc::new(TabInner {
            runtime: Arc::clone(&runtime),
            browser_session_id: browser_session_id.clone(),
            session_id: initial_tab_session_id,
            state: AsyncMutex::new(TabState::default()),
        }),
    };
    Browser {
        inner: Arc::new(BrowserInner {
            runtime,
            state: AsyncMutex::new(BrowserState {
                command_tx,
                events,
                closed: false,
            }),
            session_id: browser_session_id,
            browser_name: browser,
            launch_note: note,
            cdp_websocket_url,
            user_data_dir,
            initial_tab,
        }),
    }
}