LiveLoad.Browser.Connection defines a behaviour for how to connect to browsers with LiveLoad.
By default, an implementation for a Playwright instance (LiveLoad.Browser.Connection.Playwright)
is included in LiveLoad and can be looked at as reference implementation for implementing other browsers.
Summary
Types
A serializable storage snapshot that contains the current browser context's cookies, local storage, and session storage.
Any module implementing the LiveLoad.Browser.Connection behaviour.
Callbacks
A hook called after the supervision tree for the browser is initialized.
A hook called after the supervision tree for the browser is stopped.
A hook called before the supervision tree for the browser is initialized.
A hook called before the supervision tree for the browser is stopped.
Different browser implementations may have different CPU requirements, depending on how they are implemented.
The LiveLoad.Cluster initialization procedure uses this callback in order to calculate the optimal amount of nodes
to use for running a LiveLoad.Scenario based on the number of users for the test and the resources available on each
cluster node.
Different browser implementations may have different memory requirements, depending on how they are implemented.
The LiveLoad.Cluster initialization procedure uses this callback in order to calculate the optimal amount of nodes
to use for running a LiveLoad.Scenario based on the number of users for the test and the resources available on each
cluster node.
Different browser implementations may have different memory requirements, depending on how they are implemented.
The LiveLoad.Cluster initialization procedure uses this callback in order to calculate the optimal amount of nodes
to use for running a LiveLoad.Scenario based on the number of users for the test and the resources available on each
cluster node.
Any connection can broadcast telemetry events that correspond to load test metrics which LiveLoad tracks during a scenario.
Since connections are generally modeled around Ports, the telemetry sent by those ports may be asynchronous in nature,
meaning that stopping a context does not necessarily mean that all metrics have completed sending and been consumed.
To avoid race conditions and dropping metrics, this callback can be implemented by a connection's metrics collection mechanism
to ensure that all metrics have been sent and drained.
Types
@type context_storage_snapshot() :: term()
A serializable storage snapshot that contains the current browser context's cookies, local storage, and session storage.
This type is intentionally left as an ambiguous term, as it is meant to be usable as a storage and restoration mechanism, however it is not guaranteed to be uniform across different browser connections.
@type option() :: LiveLoad.Browser.Connection.Playwright.connection_option() | {atom(), term()}
@type opts() :: [option()]
@type t() :: module()
Any module implementing the LiveLoad.Browser.Connection behaviour.
Callbacks
@callback after_start(browser :: LiveLoad.Browser.t()) :: {:ok, LiveLoad.Browser.t()} | {:error, term()}
A hook called after the supervision tree for the browser is initialized.
@callback after_stop(browser :: LiveLoad.Browser.t()) :: :ok
A hook called after the supervision tree for the browser is stopped.
This hook is meant for side effects and as such cannot return any value other than :ok
@callback before_start(browser :: LiveLoad.Browser.t()) :: {:ok, LiveLoad.Browser.t()} | {:error, term()}
A hook called before the supervision tree for the browser is initialized.
@callback before_stop(browser :: LiveLoad.Browser.t()) :: :ok
A hook called before the supervision tree for the browser is stopped.
This hook is meant for side effects and as such cannot return any value other than :ok
@callback blur(context :: LiveLoad.Browser.Context.t(), selector :: String.t()) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback browser_contexts_per_core() :: pos_integer()
Different browser implementations may have different CPU requirements, depending on how they are implemented.
The LiveLoad.Cluster initialization procedure uses this callback in order to calculate the optimal amount of nodes
to use for running a LiveLoad.Scenario based on the number of users for the test and the resources available on each
cluster node.
@callback browser_memory_usage_bytes() :: pos_integer()
Different browser implementations may have different memory requirements, depending on how they are implemented.
The LiveLoad.Cluster initialization procedure uses this callback in order to calculate the optimal amount of nodes
to use for running a LiveLoad.Scenario based on the number of users for the test and the resources available on each
cluster node.
@callback check(context :: LiveLoad.Browser.Context.t(), selector :: String.t()) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback checked?(context :: LiveLoad.Browser.Context.t(), selector :: String.t()) :: {:ok, {LiveLoad.Browser.Context.t(), boolean()}} | {:error, term()}
@callback child_spec(opts :: opts()) :: Supervisor.child_spec()
@callback click(context :: LiveLoad.Browser.Context.t(), selector :: String.t()) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback context_memory_usage_bytes() :: pos_integer()
Different browser implementations may have different memory requirements, depending on how they are implemented.
The LiveLoad.Cluster initialization procedure uses this callback in order to calculate the optimal amount of nodes
to use for running a LiveLoad.Scenario based on the number of users for the test and the resources available on each
cluster node.
@callback context_storage_snapshot(context :: LiveLoad.Browser.Context.t()) :: {:ok, {LiveLoad.Browser.Context.t(), context_storage_snapshot()}} | {:error, term()}
@callback drag_and_drop( context :: LiveLoad.Browser.Context.t(), source :: String.t(), target :: String.t() ) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback drain_metrics(browser :: LiveLoad.Browser.t()) :: :ok
Any connection can broadcast telemetry events that correspond to load test metrics which LiveLoad tracks during a scenario.
Since connections are generally modeled around Ports, the telemetry sent by those ports may be asynchronous in nature,
meaning that stopping a context does not necessarily mean that all metrics have completed sending and been consumed.
To avoid race conditions and dropping metrics, this callback can be implemented by a connection's metrics collection mechanism
to ensure that all metrics have been sent and drained.
A reference implementation can be found in the LiveLoad.Browser.Connection.Playwright implementation of the connection behaviour.
@callback fill( context :: LiveLoad.Browser.Context.t(), selector :: String.t(), value :: String.t() ) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback focus(context :: LiveLoad.Browser.Context.t(), selector :: String.t()) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback get_attribute( context :: LiveLoad.Browser.Context.t(), selector :: String.t(), name :: String.t() ) :: {:ok, {LiveLoad.Browser.Context.t(), String.t() | nil}} | {:error, term()}
@callback hover(context :: LiveLoad.Browser.Context.t(), selector :: String.t()) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback inner_html(context :: LiveLoad.Browser.Context.t(), selector :: String.t()) :: {:ok, {LiveLoad.Browser.Context.t(), String.t()}} | {:error, term()}
@callback inner_text(context :: LiveLoad.Browser.Context.t(), selector :: String.t()) :: {:ok, {LiveLoad.Browser.Context.t(), String.t()}} | {:error, term()}
@callback input_value(context :: LiveLoad.Browser.Context.t(), selector :: String.t()) :: {:ok, {LiveLoad.Browser.Context.t(), String.t()}} | {:error, term()}
@callback new_context(browser :: LiveLoad.Browser.t()) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback page_content(context :: LiveLoad.Browser.Context.t()) :: {:ok, {LiveLoad.Browser.Context.t(), String.t()}} | {:error, term()}
@callback press( context :: LiveLoad.Browser.Context.t(), selector :: String.t(), key :: String.t() ) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback reload(context :: LiveLoad.Browser.Context.t()) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback reset_context_storage(context :: LiveLoad.Browser.Context.t()) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback restore_context_storage( context :: LiveLoad.Browser.Context.t(), snapshot :: context_storage_snapshot() ) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback select_multiple_options( context :: LiveLoad.Browser.Context.t(), selector :: String.t(), values :: [String.t()] ) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback select_option( context :: LiveLoad.Browser.Context.t(), selector :: String.t(), value :: String.t() ) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback stop_context(context :: LiveLoad.Browser.Context.t()) :: :ok | {:error, term()}
@callback text_content(context :: LiveLoad.Browser.Context.t(), selector :: String.t()) :: {:ok, {LiveLoad.Browser.Context.t(), String.t() | nil}} | {:error, term()}
@callback uncheck(context :: LiveLoad.Browser.Context.t(), selector :: String.t()) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}
@callback visible?(context :: LiveLoad.Browser.Context.t(), selector :: String.t()) :: {:ok, {LiveLoad.Browser.Context.t(), boolean()}} | {:error, term()}
@callback wait_for_selector( context :: LiveLoad.Browser.Context.t(), selector :: String.t() ) :: {:ok, LiveLoad.Browser.Context.t()} | {:error, term()}