Migrate to Selenium 4, add Scala 3

Author: kubukoz

.github/workflows/ci.yml

@@ -12,10 +12,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        scalaversion: ["2.11.12", "2.12.10", "2.13.1"]
+        scalaversion: ["2.12.20", "2.13.15", "3.3.4"]
         browser: ["chrome"]
         include:
-          - scalaversion: "2.12.10"
+          - scalaversion: "2.12.20"
             browser: "firefox"
     env:
       SJS_TEST_BROWSER: ${{ matrix.browser }}

build.sbt

@@ -1,3 +1,5 @@
+import org.openqa.selenium.firefox.FirefoxOptions
+import org.openqa.selenium.firefox.FirefoxDriver
 import sbt.Keys._
 
 import org.scalajs.sbtplugin.ScalaJSCrossVersion
@@ -7,17 +9,23 @@ import org.openqa.selenium.Capabilities
 import org.scalajs.jsenv.selenium.SeleniumJSEnv
 import org.scalajs.jsenv.selenium.TestCapabilities
 
-val previousVersion: Option[String] = Some("1.1.1")
+// we're breaking bincompat with the bump to selenium 4
+val previousVersion: Option[String] = None
 
 val newScalaBinaryVersionsInThisRelease: Set[String] =
   Set()
 
 val commonSettings: Seq[Setting[_]] = Seq(
   version := "1.1.2-SNAPSHOT",
   organization := "org.scala-js",
-  scalaVersion := "2.11.12",
-  crossScalaVersions := Seq("2.11.12", "2.12.10", "2.13.1"),
-  scalacOptions ++= Seq("-deprecation", "-feature", "-Xfatal-warnings"),
+  scalaVersion := "2.12.20",
+  crossScalaVersions := Seq("2.12.10", "2.13.15", "3.3.4"),
+  scalacOptions ++= Seq(
+    "-deprecation",
+    "-feature",
+    "-Xfatal-warnings",
+    "-Wconf:msg=constructor URL in class URL is deprecated:s",
+  ),
 
   homepage := Some(url("http://scala-js.org/")),
   licenses += ("BSD New",
@@ -60,7 +68,7 @@ val jsEnvCapabilities = settingKey[org.openqa.selenium.Capabilities](
 
 val testSettings: Seq[Setting[_]] = commonSettings ++ Seq(
   jsEnvCapabilities := TestCapabilities.fromEnv,
-  jsEnv := new SeleniumJSEnv(jsEnvCapabilities.value),
+  jsEnv := new SeleniumJSEnv(jsEnvCapabilities.value, SeleniumJSEnv.Config().withDriverFactory(caps => new FirefoxDriver(new FirefoxOptions(caps)))),
   scalaJSUseMainModuleInitializer := true
 )
 
@@ -77,10 +85,10 @@ lazy val seleniumJSEnv: Project = project.
          * It pulls in "closure-compiler-java-6" which in turn bundles some old
          * guava stuff which in turn makes selenium fail.
          */
-        "org.seleniumhq.selenium" % "selenium-server" % "3.141.59",
-        "org.scala-js" %% "scalajs-js-envs" % "1.1.1",
+        "org.seleniumhq.selenium" % "selenium-java" % "4.25.0",
+        ("org.scala-js" %% "scalajs-js-envs" % "1.1.1") cross CrossVersion.for3Use2_13,
         "com.google.jimfs" % "jimfs" % "1.1",
-        "org.scala-js" %% "scalajs-js-envs-test-kit" % "1.1.1" % "test",
+        ("org.scala-js" %% "scalajs-js-envs-test-kit" % "1.1.1" % "test") cross CrossVersion.for3Use2_13,
         "com.novocode" % "junit-interface" % "0.11" % "test"
     ),
 
@@ -117,7 +125,7 @@ lazy val seleniumJSEnv: Project = project.
     pomIncludeRepository := { _ => false },
 
     // The chrome driver seems to not deal with parallelism very well (#47).
-    parallelExecution in Test := false
+    (Test / parallelExecution) := false
   )
 
 lazy val seleniumJSEnvTest: Project = project.
@@ -135,6 +143,7 @@ lazy val seleniumJSHttpEnvTest: Project = project.
           jsEnvCapabilities.value,
           SeleniumJSEnv.Config()
             .withMaterializeInServer("tmp", "http://localhost:8080/tmp/")
+            .withDriverFactory((caps) => new FirefoxDriver(new FirefoxOptions(caps)))
       )
     },
     scalaJSLinkerConfig ~= { _.withModuleKind(ModuleKind.ESModule) }

project/build.properties

@@ -1 +1 @@
-sbt.version=1.2.8
+sbt.version=1.10.2

project/build.sbt

@@ -1,6 +1,6 @@
-addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.2.0")
+addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.17.0")
 
-addSbtPlugin("com.typesafe" % "sbt-mima-plugin" % "0.1.18")
+addSbtPlugin("com.typesafe" % "sbt-mima-plugin" % "1.1.4")
 
 addSbtPlugin("org.scalastyle" % "scalastyle-sbt-plugin" % "1.0.0")
 
@@ -9,7 +9,7 @@ addSbtPlugin("org.scalastyle" % "scalastyle-sbt-plugin" % "1.0.0")
  * guava stuff which in turn makes selenium fail.
  */
 libraryDependencies ~=
-  ("org.seleniumhq.selenium" % "selenium-server" % "3.141.59" +: _)
+  ("org.seleniumhq.selenium" % "selenium-java" % "4.25.0" +: _)
 
 unmanagedSourceDirectories in Compile ++= {
   val root = baseDirectory.value.getParentFile

seleniumJSEnv/src/main/scala/org/scalajs/jsenv/selenium/SeleniumJSEnv.scala

@@ -1,21 +1,24 @@
 package org.scalajs.jsenv.selenium
 
-import org.openqa.selenium._
-import org.openqa.selenium.remote.DesiredCapabilities
-import org.openqa.selenium.remote.server._
 
 import org.scalajs.jsenv._
 
 import java.net.URL
 import java.nio.file.{Path, Paths}
+import org.openqa.selenium.Capabilities
+import org.openqa.selenium.remote.DesiredCapabilities
+import org.openqa.selenium.WebDriver
+import org.openqa.selenium.JavascriptExecutor
+import org.openqa.selenium.Platform
 
 final class SeleniumJSEnv(capabilities: Capabilities, config: SeleniumJSEnv.Config) extends JSEnv {
+
   def this(capabilities: Capabilities) =
     this(capabilities, SeleniumJSEnv.Config())
 
   private val augmentedCapabilities = {
     val x = new DesiredCapabilities(capabilities)
-    x.setJavascriptEnabled(true)
+    // x.setJavascriptEnabled(true)
     x
   }
 
@@ -29,7 +32,7 @@ final class SeleniumJSEnv(capabilities: Capabilities, config: SeleniumJSEnv.Conf
 
   private def newDriver() = {
     val driver: WebDriver =
-      config.driverFactory.newInstance(augmentedCapabilities)
+      config.driverFactory(augmentedCapabilities)
 
     /* The first `asInstanceOf`s are a fail-fast for the second one, which
      * scalac partially erases, so that we're sure right now that the last
@@ -46,6 +49,7 @@ final class SeleniumJSEnv(capabilities: Capabilities, config: SeleniumJSEnv.Conf
 }
 
 object SeleniumJSEnv {
+
   final class Config private (
       val driverFactory: DriverFactory,
       val keepAlive: Boolean,
@@ -56,7 +60,8 @@ object SeleniumJSEnv {
     private def this() = this(
         keepAlive = false,
         materialization = Config.Materialization.Temp,
-        driverFactory = new DefaultDriverFactory(Platform.getCurrent()))
+        driverFactory = caps => sys.error("No driver factory configured")
+        )
 
     /** Materializes purely virtual files into a temp directory.
      *
@@ -128,7 +133,7 @@ object SeleniumJSEnv {
 
     abstract class Materialization private ()
     object Materialization {
-      final case object Temp extends Materialization
+      case object Temp extends Materialization
       final case class Server(contentDir: Path, webRoot: URL) extends Materialization {
         require(webRoot.getPath().endsWith("/"), "webRoot must end with a slash (/)")
       }

seleniumJSEnv/src/main/scala/org/scalajs/jsenv/selenium/SeleniumRun.scala

@@ -24,7 +24,7 @@ private sealed class SeleniumRun(
 
   protected val intf = "this.scalajsSeleniumInternalInterface"
 
-  private[this] implicit val ec =
+  private[this] implicit val ec: ExecutionContext =
     ExecutionContext.fromExecutor(Executors.newSingleThreadExecutor())
 
   private val handler = Future {

seleniumJSEnv/src/main/scala/org/scalajs/jsenv/selenium/package.scala

@@ -0,0 +1,8 @@
+package org.scalajs.jsenv
+
+import org.openqa.selenium.WebDriver
+import org.openqa.selenium.Capabilities
+
+package object selenium {
+  type DriverFactory = Capabilities => WebDriver
+}

seleniumJSEnv/src/test/scala/org/scalajs/jsenv/selenium/KeepAliveTest.scala

@@ -7,7 +7,6 @@ import java.net.URL
 
 import org.openqa.selenium._
 import org.openqa.selenium.remote.DesiredCapabilities
-import org.openqa.selenium.remote.server._
 
 import org.junit._
 import org.junit.Assert._
@@ -56,14 +55,11 @@ class KeepAliveTest {
   private final class MockInjector(driver: WebDriver) extends DriverFactory {
     var used = false
 
-    def newInstance(caps: Capabilities): WebDriver = {
-      require(!used)
-      used = true
-      driver
+    def apply(caps: Capabilities): WebDriver = {
+        require(!used)
+        used = true
+        driver
     }
-
-    def hasMappingFor(caps: Capabilities): Boolean = true
-    def registerDriverProvider(p: DriverProvider): Unit = ???
   }
 
   private def setup(keepAlive: Boolean) = {

seleniumJSEnv/src/test/scala/org/scalajs/jsenv/selenium/SeleniumJSEnvSuite.scala seleniumJSEnv/src/test/scala/org/scalajs/jsenv/selenium/SeleniumJSSuite.scala

@@ -9,8 +9,10 @@ import org.junit.runner.Runner
 import org.junit.runners.Suite
 import org.junit.runner.manipulation.Filter
 import org.junit.runner.Description
+import org.openqa.selenium.firefox.FirefoxDriver
+import org.openqa.selenium.firefox.FirefoxOptions
 
 @RunWith(classOf[JSEnvSuiteRunner])
 class SeleniumJSSuite extends JSEnvSuite(
-  JSEnvSuiteConfig(new SeleniumJSEnv(TestCapabilities.fromEnv))
+  JSEnvSuiteConfig(new SeleniumJSEnv(TestCapabilities.fromEnv,  SeleniumJSEnv.Config().withDriverFactory(caps => new FirefoxDriver(new FirefoxOptions(caps)))))
 )

seleniumJSEnv/src/test/scala/org/scalajs/jsenv/selenium/TestCapabilities.scala

@@ -13,12 +13,12 @@ object TestCapabilities {
   def fromEnv: Capabilities = nameFromEnv match {
     case "firefox" =>
       new FirefoxOptions()
-        .setHeadless(true)
+        .addArguments("--headless")
         .setLogLevel(FirefoxDriverLogLevel.ERROR)
 
     case "chrome" =>
       new ChromeOptions()
-        .setHeadless(true)
+        .addArguments("--headless")
 
     case name =>
       throw new IllegalArgumentException(s"Unknown browser $name")