scala-js-env-playwright

A JavaScript environment for Scala.js (a JSEnv) running playwright. It is only build for Scala 3 (supported by Mill and SBT 2.x)

Requirements

Playwright needs certain system dependencies read the docs

TLDR -> npx playwright install-deps

Usage SBT

Add the following line to your project/plugins.sbt

// For Scala.js 1.x
libraryDependencies += "io.github.thijsbroersen" %% "scala-js-env-playwright" % "0.2.2"

Add the following line to your build.sbt

Test / jsEnv := new PlaywrightJSEnv.chrome(
      headless = true
    )

Usage Mill (not yet part of Mill, tested in locally build Mill version)

override def jsEnvConfig = JsEnvConfig.Playwright.chrome(
  headless = true
)

Avoid trouble

• This is a very early version. It may not work for all projects. It is tested on chrome/chromium and firefox.
• Few test cases are failing on webkit. Keep a watch on this space for updates.
• It works only with Scala.js 1.x
• Make sure the project is set up to use ModuleKind.ESModule in the Scala.js project.
  • SBT 2.x

    // For Scala.js 1.x
    scalaJSLinkerConfig ~= { _.withModuleKind(ModuleKind.ESModule) }

  • Mill

    override def moduleKind  = ModuleKind.ESModule

• Some projects which may need to use both Selenium and Playwright. If it runs into google exception, add the following line to your plugins.sbt

libraryDependencies += "com.google.guava" % "guava" % "33.0.0-jre"

Supported browsers

• chrome
• chromium (same as chrome)
• firefox
• webkit (experimental) - Works well on macOS. Mileage may vary on other platforms.

Compatibility notes

Scala versions

• This library can be used with any scala version 3.x
• This project is compiled with scala 3.7.2

sbt versions

• This library can be used with any sbt version 1.x

Playwright versions

• This library can be used with playwright version 1.54.0 "com.microsoft.playwright" % "playwright" % "1.54.0"

JDK versions

• This library is tested on JDK17

Default configuration

jsEnv := new jsenv.playwright.PlaywrightJSEnv.chrome(
  headless = true,
  showLogs = false,
)

Launch options

The launch options are used to enable/disable the browser features. They can be overridden via the launchOptions parameter or extended via the additionalLaunchOptions parameter.

When not passing launchOptions, default launch options are as follows:

Chrome/chromium

jsEnv := new jsenv.playwright.PlaywrightJSEnv.chrome(
  launchOptions = List(
      "--disable-extensions", 
      "--disable-web-security", 
      "--allow-running-insecure-content", 
      "--disable-site-isolation-trials", 
      "--allow-file-access-from-files", 
      "--disable-gpu"
    )
)

Firefox

jsEnv := new jsenv.playwright.PlaywrightJSEnv.firefox(
  firefoxUserPrefs = Map(
      "security.mixed_content.block_active_content" -> false,
      "security.mixed_content.upgrade_display_content" -> false,
      "security.file_uri.strict_origin_policy" -> false
    )
)

Webkit

jsEnv := new jsenv.playwright.PlaywrightJSEnv.webkit(
  launchOptions = List(
      "--disable-extensions", 
      "--disable-web-security", 
      "--allow-running-insecure-content", 
      "--disable-site-isolation-trials", 
      "--allow-file-access-from-files"
    )
)

KeepAlive configuration

It is work in progress. As a workaround introducing delay in the test cases may help to keep the browser alive.

Debugging

debug parameter can be passed to the PlaywrightJSEnv constructor to enable debugging. It will also display the version of the browser which is used.

Test / jsEnv := new PlaywrightJSEnv.chrome(
      headless = true,
      showLogs = true,
      debug = true
    )