butterbee - v1.0.0

butterbee/config/browser

This module provides functionality for parsing and creating browser configurations from TOML configuration files for WebDriver BiDi sessions.

Chromium support

Because chromium does not natively support WebDriver BiDi, butterbee uses the chromedriver to control chromium. Which has a BiDi to CDP mapper built in.

Chromedriver does not come with chromium built in, so make sure you have chromium installed. Chromedriver will search for the chromium binary on your system. so no additional configuration is needed.

TOML Configuration Format

The browser configuration is defined under the [tools.butterbee.browser] section of your gleam.toml file:

# gleam.toml

[tools.butterbee.browser.firefox]
cmd = "firefox"
flags = ["-headless"]
host = "127.0.0.1"

[tools.butterbee.browser.chromium]
cmd = "chromedriver"
flags = []
host = "127.0.0.1"

Headless

to run the browsers headless, add the following to your gleam.toml file:

[tools.butterbee.browser.firefox]
flags = ["-headless"]

[tools.butterbee.capabilities.always_match]
webSocketUrl = true
"goog:chromeOptions" = { args = ["--headless=new"] }

Types

BrowserConfig

</> 
pub type BrowserConfig {
  BrowserConfig(
    start_url: String,
    cmd: String,
    extra_flags: List(String),
    host: String,
  )
}

Constructors 

  • BrowserConfig(
  start_url: String,
  cmd: String,
  extra_flags: List(String),
  host: String,
)

    Arguments

    start_url

    The url that is loaded when the browser is started.

    cmd

    The path to the browser executable, or the name of the browser if it is in the PATH.

    extra_flags

    Extra flags to pass to the browser.

    host

    The host to use for the browser.

BrowserType

</> 
pub type BrowserType {
  Firefox
  Chromium
}

Constructors 

  • Firefox
  • Chromium

Values

default

</> 
pub fn default() -> dict.Dict(BrowserType, BrowserConfig)

Returns the default browser configuration

default_browser_type

</> 
pub const default_browser_type: BrowserType

Returns the default browser type, firefox

default_configuration

</> 
pub fn default_configuration(
  browser_type: BrowserType,
) -> BrowserConfig

default_host

</> 
pub const default_host: String

Butterbee will use this host url unless overridden

default_port

</> 
pub const default_port: Int

Butterbee will use this port unless overridden

with_cmd

</> 
pub fn with_cmd(
  config: BrowserConfig,
  cmd: String,
) -> BrowserConfig

with_extra_flags

</> 
pub fn with_extra_flags(
  config: BrowserConfig,
  extra_flags: List(String),
) -> BrowserConfig

with_host

</> 
pub fn with_host(
  config: BrowserConfig,
  host: String,
) -> BrowserConfig

with_start_url

</> 
pub fn with_start_url(
  config: BrowserConfig,
  start_url: String,
) -> BrowserConfig
✨ Search Document