Fix #115: Add ESModule support

mushtaq · mushtaq · commit b9efc6d5b1fd · 2020-09-27T17:58:36.000+05:30
diff --git a/build.sbt b/build.sbt
@@ -135,5 +135,6 @@ lazy val seleniumJSHttpEnvTest: Project = project.
           SeleniumJSEnv.Config()
             .withMaterializeInServer("tmp", "http://localhost:8080/tmp/")
       )
-    }
+    },
+    scalaJSLinkerConfig ~= { _.withModuleKind(ModuleKind.ESModule) }
   )
diff --git a/seleniumJSEnv/src/main/scala/org/scalajs/jsenv/selenium/FileMaterializers.scala b/seleniumJSEnv/src/main/scala/org/scalajs/jsenv/selenium/FileMaterializers.scala
@@ -17,9 +17,13 @@ private[selenium] sealed abstract class FileMaterializer {
   }
 
   final def materialize(name: String, content: String): URL = {
+    val tempPath = write(name, content)
+    toURL(tempPath)
+  }
+
+  final def write(name: String, content: String): Path = {
     val tmp = newTmp(name)
     Files.write(tmp, Arrays.asList(content))
-    toURL(tmp)
   }
 
   final def close(): Unit = {
diff --git a/seleniumJSEnv/src/main/scala/org/scalajs/jsenv/selenium/SeleniumRun.scala b/seleniumJSEnv/src/main/scala/org/scalajs/jsenv/selenium/SeleniumRun.scala
@@ -10,6 +10,8 @@ import scala.util.control.NonFatal
 
 import java.util.concurrent.{ConcurrentLinkedQueue, Executors}
 import java.util.function.Consumer
+import java.nio.file.Path
+import java.net.URL
 
 private sealed class SeleniumRun(
     driver: WebDriver with JavascriptExecutor,
@@ -129,20 +131,10 @@ private[selenium] object SeleniumRun {
       newRun: Ctor[T], failed: Throwable => T): T = {
     validator.validate(runConfig)
 
-    val scripts = input.map {
-      case Input.Script(s) => s
-      case _               => throw new UnsupportedInputException(input)
-    }
-
     try {
       withCleanup(FileMaterializer(config.materialization))(_.close()) { m =>
-        val allScriptURLs = (
-            m.materialize("setup.js", JSSetup.setupCode(enableCom)) +:
-            scripts.map(m.materialize)
-        )
-
-        val page = m.materialize("scalajsRun.html", htmlPage(allScriptURLs))
-
+        val setupJsPath = m.write("setup.js", JSSetup.setupCode(enableCom))
+        val page = m.materialize("scalajsRun.html", htmlPage(setupJsPath, input, m))
         withCleanup(newDriver())(maybeCleanupDriver(_, config)) { driver =>
           driver.navigate().to(page)
 
@@ -171,18 +163,31 @@ private[selenium] object SeleniumRun {
   private def maybeCleanupDriver(d: WebDriver, config: SeleniumJSEnv.Config) =
     if (!config.keepAlive) d.close()
 
-  private def htmlPage(scripts: Seq[java.net.URL]): String = {
-    val scriptTags =
-      scripts.map(path => s"<script src='${path.toString}'></script>")
+  private def htmlPage(setupJsPath: Path, input: Seq[Input], materializer: FileMaterializer): String = {
+    val setupJs = makeTag(setupJsPath, "text/javascript", materializer)
+
+    val tags = input.map {
+      case Input.Script(path)   => makeTag(path, "text/javascript", materializer)
+      case Input.ESModule(path) => makeTag(path, "module", materializer)
+      case _                    => throw new UnsupportedInputException(input)
+    }
+
+    val allTags = setupJs +: tags
+
     s"""<html>
        |  <meta charset="UTF-8">
        |  <body>
-       |    ${scriptTags.mkString("\n    ")}
+       |    ${allTags.mkString("\n    ")}
        |  </body>
        |</html>
     """.stripMargin
   }
 
+  private def makeTag(path: Path, tpe: String, materializer: FileMaterializer): String = {
+    val url = materializer.materialize(path)
+    s"<script defer type='$tpe' src='${url.toString}'></script>"
+  }
+
   private class WindowOnErrorException(errs: List[String]) extends Exception(s"JS error: $errs")
 
   private def consumer[A](f: A => Unit): Consumer[A] = new Consumer[A] {
diff --git a/seleniumJSHttpEnvTest/src/main/scala/org/scalajs/jsenv/selenium/CamelCase.scala b/seleniumJSHttpEnvTest/src/main/scala/org/scalajs/jsenv/selenium/CamelCase.scala
@@ -0,0 +1,12 @@
+package org.scalajs.jsenv.selenium
+
+import scala.scalajs.js
+import scala.scalajs.js.annotation.JSImport
+
+object CamelCase {
+  def hello(input: String): String = s"Hello ${camelCase(input)}!"
+
+  @JSImport("https://cdn.skypack.dev/camelcase@^6.0.0", JSImport.Default)
+  @js.native
+  def camelCase(input: String): String = js.native
+}
diff --git a/seleniumJSHttpEnvTest/src/test/scala/org/scalajs/jsenv/selenium/ModuleSupportTest.scala b/seleniumJSHttpEnvTest/src/test/scala/org/scalajs/jsenv/selenium/ModuleSupportTest.scala
@@ -0,0 +1,10 @@
+package org.scalajs.jsenv.selenium
+
+import org.junit.Assert._
+import org.junit.Test
+
+class ModuleSupportTest {
+  @Test def testBasicImport(): Unit = {
+    assertEquals("Hello scalaJsSelenium!", CamelCase.hello("scala js selenium"))
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -135,5 +135,6 @@ lazy val seleniumJSHttpEnvTest: Project = project.`
`135`	`135`	`SeleniumJSEnv.Config()`
`136`	`136`	`.withMaterializeInServer("tmp", "http://localhost:8080/tmp/")`
`137`	`137`	`)`
`138`		`- }`
	`138`	`+ },`
	`139`	`+ scalaJSLinkerConfig ~= { _.withModuleKind(ModuleKind.ESModule) }`
`139`	`140`	`)`
Original file line number	Diff line number	Diff line change
`@@ -17,9 +17,13 @@ private[selenium] sealed abstract class FileMaterializer {`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`final def materialize(name: String, content: String): URL = {`
	`20`	`+ val tempPath = write(name, content)`
	`21`	`+ toURL(tempPath)`
	`22`	`+ }`
	`23`	`+`
	`24`	`+ final def write(name: String, content: String): Path = {`
`20`	`25`	`val tmp = newTmp(name)`
`21`	`26`	`Files.write(tmp, Arrays.asList(content))`
`22`		`- toURL(tmp)`
`23`	`27`	`}`
`24`	`28`
`25`	`29`	`final def close(): Unit = {`