Announcing Scala.js 1.0.0-M3

Feb 1, 2018.

We are very excited to announce the release of Scala.js 1.0.0-M3!

This development release is mostly intended for testing purposes, and as a synchronization point with library authors so that they can start upgrading in preparation for the final release.

As the change in “major” version number witnesses, this release is not binary compatible with 0.6.x, nor with the previous milestones of the 1.x series. Libraries need to be recompiled and republished using this milestone to be compatible.

Moreover, this release is not entirely source compatible with 0.6.x either. We expect, however, that further milestones for 1.0.0 will stay backward source compatible with this milestone.

These release notes contain cumulative changes with respect to 0.6.22. Compared to 1.0.0-M2, the following changes are noteworthy:

  • Scala 2.10.x is not supported anymore, nor building on JDK 6 and 7.
  • The Tools API has been split in 3 separate artifacts.

Please report any issues on GitHub.

Preparations before upgrading from 0.6.x

Before upgrading to 1.0.0-M3, we strongly recommend that you upgrade to Scala.js 0.6.20 or later, and address all deprecation warnings. Since Scala.js 1.0.0-M3 removes support for all the deprecated features in 0.6.x, it is easier to see the deprecation messages guiding you to the proper replacements.

Additionally to the explicitly deprecated things, make sure to use scalaJSLinkerConfig instead of the following sbt settings:

  • scalaJSSemantics
  • scalaJSModuleKind
  • scalaJSOutputMode
  • emitSourceMaps
  • relativeSourceMaps
  • scalaJSOptimizerOptions

Upgrade to 1.0.0-M3 from 0.6.20 or later

As a first approximation, all you need to do is to update the version number in project/plugins.sbt:

addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.0.0-M3")

In addition, if you use some of the components that have been moved to separate repositories, you will need to add some more dependencies in project/plugins.sbt:

If you use crossProject:

  • Add addSbtPlugin("org.portable-scala" % "sbt-scalajs-crossproject" % "0.3.1") in project/plugins.sbt

If you use jsDependencies (or rely on the jsDependencies of your transitive dependencies):

  • Add addSbtPlugin("org.scala-js" % "sbt-jsdependencies" % "1.0.0-M3") in project/plugins.sbt
  • Add .enablePlugins(JSDependenciesPlugin) to Scala.js projects
  • Add .jsConfigure(_.enablePlugins(JSDependenciesPlugin)) to crossProjects

If you use the Node.js with jsdom environment:

  • Add libraryDependencies += "org.scala-js" %% "scalajs-env-nodejs" % "1.0.0-M3" in project/plugins.sbt

If you use the PhantomJS environment:

  • Add addSbtPlugin("org.scala-js" % "sbt-scalajs-env-phantomjs" % "1.0.0-M3") in project/plugins.sbt

Finally, if your build has

scalacOptions += "-P:scalajs:sjsDefinedByDefault"

you will need to remove it (Scala.js 1.x always behaves as if sjsDefinedByDefault were present).

This should get your build up to speed to Scala.js 1.0.0-M3. From there, you should be able to test whether things go smoothly, or whether you are affected by the breaking changes detailed below.

Breaking changes

This section discusses the backward incompatible changes, which might affect your project.

Scala 2.10.x is not supported anymore, nor building on JDK 6 and 7

The title says it all: you cannot use Scala.js with

scalaVersion := "2.10.x" // for any x

anymore. Note that you can still use the sbt plugin with sbt 0.13.16+, even though it runs itself on 2.10.x. Only the Scala.js code itself (not the build) cannot use Scala 2.10.x.

In addition, building Scala.js code on top of JDK 6 or 7 is not supported anymore either.

Finally, a severe regression in Scala 2.12.0 upstream, affecting js.UndefOr, forced us to drop support for Scala 2.12.0 (see #3024). Scala 2.12.1+ is supported.

Access to the global scope instead of the global object

This is the only major breaking change at the language level. In Scala.js 1.x, js.Dynamic.global and @JSGlobalScope objects refer to the global scope of JavaScript, rather than the global object. Concretely, this has three consequences, which we outline below. Further information can be found in the documentation about the global scope in Scala.js.

Members can only be accessed with a statically known name which is a valid JavaScript identifier

For example, the following is valid:

println(js.Dynamic.global.Math)

but the following variant, where the name Math is only known at run-time, is not valid anymore:

val mathName = "Math"
println(js.Dynamic.global.selectDynamic(mathName))

The latter will cause a compile error. This is because it is not possible to perform dynamic lookups in the global scope. Similarly, accessing a member whose name is statically known but not a valid JavaScript identifier is also prohibited:

println(js.Dynamic.global.`not-a-valid-JS-identifier`)

Global scope objects cannot be stored in a separate val

For example, the following is invalid and will cause a compile error:

val g = js.Dynamic.global

as well as:

def foo(x: Any): Unit = println(x)
foo(js.Dynamic.global)

This follows from the previous rule. If the above two snippets were allowed, we could not check that we only access members with statically known names.

The first snippet can be advantageously replaced by a renaming import:

import js.Dynamic.{global => g}

Accessing a member that is not declared causes a ReferenceError to be thrown

This is a run-time behavior change, and in our experience the larger source of breakages in actual code.

Previously, reading a non-existent member of the global object, such as

println(js.Dynamic.global.globalVarThatDoesNotExist)

would evaluate to undefined. In Scala.js 1.x, this throws a ReferenceError. Similarly, writing to a non-existent member, such as

js.Dynamic.global.globalVarThatDoesNotExist = 42

would previously create said global variable. In Scala.js 1.x, it also throws a ReferenceError.

A typical use case of the previous behavior was to test whether a global variable was defined or not, e.g.,

if (js.isUndefined(js.Dynamic.global.Promise)) {
  // Promises are not supported
} else {
  // Promises are supported
}

This idiom is broken in Scala.js 1.x, and needs to be replaced by an explicit use of js.typeOf:

if (js.typeOf(js.Dynamic.global.Promise) != "undefined")

The js.typeOf “method” is magical when its argument is member of a global scope object.

js.UndefOr[A] is now an alias for A | Unit

Instead of defining js.UndefOr[+A] as its own type, it is now a simple type alias for A | Unit:

type UndefOr[+A] = A | Unit

The Option-like API is of course preserved.

We do not expect this to cause any significant issue, but it may impact type inference in subtle ways that can cause compile errors for previously valid code. You may have to adjust some uses of js.UndefOr due to these changes, especially if using Scala 2.10.

testHtml replaces both testHtmlFastOpt and testHtmlFullOpt

The separation of testHtmlFastOpt and testHtmlFullOpt, which were independent of the value of scalaJSStage, caused significant unfixable issues in 0.6.x. In Scala.js 1.x, both are replaced by a single task, testHtml. It is equivalent to the old testHtmlFastOpt if the value of scalaJSStage is FastOptStage (the default), and to testHtmlFullOpt if it is FullOptStage. This makes it more consistent with other tasks such as run and test.

scalajs-javalib-ex was removed

The artifact scalajs-javalib-ex is removed in 1.x. It only contained a partial implementation of java.util.ZipInputStream. If you were using it, we recommend that you integrate a copy of its source code from Scala.js 0.6.x into your project.

js.use(x).as[T] was removed

The use cases for js.use(x).as[T] have been dramatically reduced by non-native JS classes (previously known as Scala.js-defined JS classes). This API seems virtually unused on the visible Web. Moreover, it was the only macro in the Scala.js standard library.

We have therefore removed it from the standard library, and it is not provided anymore. On demand, we can republish it as a separate library, if you need it.

The Tools API has been split into 3 artifacts and its packages reorganized

This only concerns consumers of the Tools API, i.e., tools that build on top of the Scala.js linker, such as ScalaFiddle. In Scala.js 0.6.x, all the tools were in one artifact scalajs-tools. This artifact has been split in three in Scala.js 1.x:

  • scalajs-io: IR-independent virtual IO
  • scalajs-logging: tiny logging API
  • scalajs-linker: the linker API (and IR-specific virtual IO)

In addition, the packages have been reorganized as follows:

  • org.scalajs.core.ir -> org.scalajs.ir
  • org.scalajs.core.tools.io -> org.scalajs.io (and some in org.scalajs.linker.irio)
  • org.scalajs.core.tools.logging -> org.scalajs.logging
  • org.scalajs.core.tools.linker -> org.scalajs.linker

If you need to cross-compile against the 0.6.x Tools API and the 1.x Linker API, consult the comments in PR #3263 for a recommended trick.

Enhancements

There are very few enhancements in Scala.js 1.0.0-M3. Scala.js 1.0.0 is focused on simplifying Scala.js, not on adding new features. Nevertheless, here are a few enhancements.

Scala.js can access require and other magical “global” variables of special JS environments

The changes from global object to global scope mean that magical “global” variables provided by some JavaScript environments, such as require in Node.js, are now visible to Scala.js. For example, it is possible to dynamically call require as follows in Scala.js 1.x:

val pathToSomeAsset = "assets/logo.png"
val someAsset = js.Dynamic.global.require(pathToSomeAsset)

We still recommend to use @JSImport and CommonJSModule for statically known imports.

Declaring inner classes in native JS classes

Some JavaScript APIs define classes inside objects, as in the following example:

class OuterClass {
  constructor(x) {
    this.InnerClass = class InnerClass {
      someMethod() {
        return x;
      }
    }
  }
}

allowing use sites to instantiate them as

const outerObject = new OuterClass(42);
const innerObject = new outerObject.InnerClass();
console.log(innerObject.someMethod()); // prints 42

In Scala.js 0.6.x, it is very awkward to define a facade type for OuterClass, as illustrated in issue #2398. Scala.js 1.x now allows to declare them very easily as inner JS classes:

@js.native
@JSGlobal
class OuterClass(x: Int) extends js.Object {
  @js.native
  class InnerClass extends js.Object {
    def someMethod(): Int = js.native
  }
}

which in turns allows for the following call site:

val outerObject = new OuterClass(42);
val innerObject = new outerObject.InnerClass();
console.log(innerObject.someMethod()); // prints 42

Nested non-native JS classes expose sane constructors to JavaScript

It is now possible to declare non-native JS classes inside outer classes or inside defs, and use their js.constructorOf in a meaningful way. For example, one can define a method that creates a new JavaScript class every time it is invoked:

def makeGreeter(greetingFormat: String): js.Dynamic = {
  class Greeter extends js.Object {
    def greet(name: String): String =
      println(greetingFormat.format(name))
  }
  js.constructorOf[Greeter]
}

Assuming there is some native JavaScript function like

function greetPeople(greeterClass) {
  const greeter = new greeterClass();
  greeter.greet("Jane");
  greeter.greet("John");
}

one could call it from Scala.js as:

val englishGreeterClass = makeGreeter("Hello, %s!")
greetPeople(englishGreeterClass)
val frenchGreeterClass = makeGreeter("Bonjour, %s!")
greetPeople(frenchGreeterClass)
val japaneseGreeterClass = makeGreeter("%sさん、こんにちは。")
greetPeople(japaneseGreeterClass)

resulting in the following output:

Hello, Jane!
Hello, John!
Bonjour, Jane!
Bonjour, John!
Janeさん、こんにちは。
Johnさん、こんにちは。

In Scala.js 0.6.x, the above code would compile but produce incoherent results at run-time, because js.constructorOf was meaningless for nested classes.

Bugfixes

Amongst others, the following bugs have been fixed since 0.6.22:

  • #2800 Global lets, consts and classes cannot be accessed by Scala.js
  • #2382 Name clash for $outer pointers of two different nesting levels (fixed for Scala 2.10 and 2.11; 2.12 did not suffer from the bug in 0.6.x)
  • #3085 Linking error after the optimizer for someInt.toDouble.compareTo(double)

See the full list of issues fixed in 1.0.0-M1, in 1.0.0-M2 and in 1.0.0-M3 on GitHub.

Cross-building for Scala.js 0.6.x and 1.x

If you want to cross-compile your libraries for Scala.js 0.6.x and 1.x (which you definitely should), here are a couple tips.

Dynamically load a custom version of Scala.js

Since the version of Scala.js is not decided by an sbt setting in build.sbt, but by the version of the sbt plugin in project/plugins.sbt, standard cross-building setups based on ++ cannot be applied. We recommend that you load the version of Scala.js from an environment variable. For example, you can do this in your project/plugins.sbt file:

val scalaJSVersion =
  Option(System.getenv("SCALAJS_VERSION")).getOrElse("0.6.22")

addSbtPlugin("org.scala-js" % "sbt-scalajs" % scalaJSVersion)

You can then launch

$ SCALAJS_VERSION=1.0.0-M3 sbt

from your command line to start up your build with Scala.js 1.0.0-M3.

Extra dependencies for JS environments

You can further build on the above val scalaJSVersion to dynamically add dependencies on scalajs-env-phantomjs and/or scalajs-env-jsdom-nodejs if you use them:

// For Node.js with jsdom
libraryDependencies ++= {
  if (scalaJSVersion.startsWith("0.6.")) Nil
  else Seq("org.scala-js" %% "scalajs-env-jsdom-nodejs" % "1.0.0-M3")
}

// For PhantomJS
{
  if (scalaJSVersion.startsWith("0.6.")) Nil
  else Seq(addSbtPlugin("org.scala-js" % "sbt-scalajs-env-phantomjs" % "1.0.0-M3"))
}

In both cases, you can then use the source-compatible API in build.sbt to select your JS environment of choice.

Extra dependencies for jsDependencies

Similarly, you can conditionally depend on jsDependencies as follows:

// For jsDependencies
{
  if (scalaJSVersion.startsWith("0.6.")) Nil
  else Seq(addSbtPlugin("org.scala-js" % "sbt-jsdependencies" % "1.0.0-M3"))
}

In that case, you should unconditionally keep the

enablePlugins(JSDependenciesPlugin)

on the relevant projects. Scala.js 0.6.20 and later define a no-op JSDependenciesPlugin to allow for this scenario.

Conditional application of -P:scalajs:sjsDefinedByDefault

In Scala.js 1.x, the flag -P:scalajs:sjsDefinedByDefault has been removed. However, if you have non-native JS types in your codebase, you need this flag in Scala.js 0.6.x.

Add the following setting to your build.sbt to conditionally enable that flag:

scalacOptions ++= {
  if (scalaJSVersion.startsWith("0.6.")) Seq("-P:scalajs:sjsDefinedByDefault")
  else Nil
}

sbt-scalajs-crossproject and Scala.js 0.6.x

If you have a crossProject in your build, you need the sbt-scalajs-crossproject sbt plugin in Scala.js 1.x. You can also use that sbt plugin in Scala.js 0.6.x, but out-of-the-box there is a small conflict. You can resolve this conflict using the shadowing import described in sbt-crossproject’s readme, adding the following line in your build.sbt:

// shadow sbt-scalajs' crossProject and CrossType from Scala.js 0.6.x (no-op with Scala.js 1.x)
import sbtcrossproject.{crossProject, CrossType}

LEARN

Documentation
Tutorial

COMMUNITY

#scala-js on Discord
Stackoverflow
Mastodon
Twitter
GitHub