Skip to content

add optional system browser #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jamesward wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add optional system browser #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions core/src/main/scala/chekhov/ChekhovConfig.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,13 @@ final case class ChekhovConfig(
browserInstallEnv: Map[String, String] = Map.empty,
traceCapture: ArtifactCapture = ArtifactCapture.Off,
videoCapture: ArtifactCapture = ArtifactCapture.Off,
// Launch a system browser instead of a Playwright-downloaded one: `executablePath`
// points at a browser binary, `channel` selects an installed channel (e.g. "chrome").
// When either is set the pinned-browser-revision check is skipped. `launchArgs` are
// extra process args (e.g. "--no-sandbox" in sandboxed / NixOS environments).
executablePath: Option[String] = None,
channel: Option[String] = None,
launchArgs: List[String] = Nil,
)

object ChekhovConfig:
Expand Down Expand Up @@ -108,6 +115,19 @@ object ChekhovConfig:
.orElse(sys.env.get("CHEKHOV_VIDEO_CAPTURE"))
.flatMap(ArtifactCapture.fromString)
.getOrElse(ArtifactCapture.Off),
executablePath = sys.props
.get("chekhov.executablePath")
.orElse(sys.env.get("CHEKHOV_EXECUTABLE_PATH"))
.filter(_.nonEmpty),
channel = sys.props
.get("chekhov.channel")
.orElse(sys.env.get("CHEKHOV_CHANNEL"))
.filter(_.nonEmpty),
launchArgs = sys.props
.get("chekhov.launchArgs")
.orElse(sys.env.get("CHEKHOV_LAUNCH_ARGS"))
.map(_.split("[,\\s]+").iterator.map(_.trim).filter(_.nonEmpty).toList)
.getOrElse(Nil),
)

def layer(config: ChekhovConfig): ULayer[ChekhovConfig] =
Expand Down
10 changes: 9 additions & 1 deletion driver/src/main/scala/chekhov/driver/PlaywrightDriver.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,12 @@ object PlaywrightDriver:
def launch(using Trace): ZIO[Scope & ChekhovConfig, ChekhovError, Browser] =
for
config <- ZIO.service[ChekhovConfig]
_ <- ZIO
// A system browser (executablePath / channel) needs no downloaded revision.
systemBrowser = config.executablePath.isDefined || config.channel.isDefined
_ <- ZIO
.fromEither(PinnedPlaywright.requireBrowser(config.browser))
.mapError(p => ChekhovError.Driver(p.message))
.unless(systemBrowser)
// GitHub Actions / containers: Chromium needs the sandbox disabled.
ci = sys.env.get("CI").contains("true") || sys.env.get("GITHUB_ACTIONS").contains("true")
result <- conn.send(
Expand All @@ -31,6 +34,11 @@ object PlaywrightDriver:
Commands.BrowserTypeLaunch(
headless = Some(config.headless),
chromiumSandbox = if ci then Some(false) else None,
executablePath = config.executablePath,
channel = config.channel,
args =
if config.launchArgs.nonEmpty then Some(Json.Arr(config.launchArgs.map(Json.Str(_))*))
else None,
),
)
guid <- guidOf(result, "browser")
Expand Down