Migrate a Playframework App From 2.3 to 2.5

Recently I migrated several play applications from the version 2.3 to the version 2.5.

As this experience may interest other people, I decided to write about it.

So let’s start!

§ Migration from 2.3 to 2.4

First, we will migrate the application from the version 2.3 to the version 2.4.

For that, the migration guide will be our reference.

How do I proceed?

1. Update the sbt config to play 2.4

First, I update the SBT configuration:

  • update the play version in project/plugins.sbt:
1
2
-addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.3.10")
+addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.4.6")
  • if needed, update the sbt version in project/build.properties:
1
sbt.version=0.13.11
  • update the build.sbt:
1
2
-import PlayKeys._
+import play.sbt.PlayImport._

I also had to replace playVersion.value with play.core.PlayVersion.current.

The goal of this first step is to be able to load the application with sbt, even if the application itself does not compile. At this point, Intellij can load the application with a play 2.4 version, and can provide auto-completion.

2. Fix compilation errors

Then, I fix the compilation

Inside sbt, I just trigger the compilation:

1
~compile

and fix all compilation errors. The play team has made a very good job at documenting all steps in the migration guide.

At this point, I just want the application to compile with the minimal number of changes. I do not care if I use deprecated APIs.

3. Run the application

When all compilation errors are fixed, I just make sure that the application can run:

In sbt:

1
~run

When running the application, I sometimes discovered version conflicts between libs (ex: Netty versions) and I know if I can complete the migration or if I have to update a dependency before.

Analysing all dependencies can be difficult. I use the sbt-dependency-graph to have an overview of all dependencies and find overriding versions.

4. Fix the tests

Then I fix all compilation errors in the tests, and then check that the tests are successful.

In sbt:

1
~testQuick

When all the tests are green, the application is migrated. The migration to play 2.4 is now completed, profit from the new version! ;)

5. Remove all usages of deprecated API

Now it is time to clean our application and to fix all code using a deprecated API.

This clean up can be done step by step.

I use the Scala API, and I prefer not to use any runtime dependency injection framework.

I introduced the so-called compile time dependency injection to simply instantiate my controllers in one application loader.

For more info about this topic, please refer to:

This cleanup is necessary before updating to play 2.5, as deprecated API are likely to be removed in the next version.

§ Migration from 2.4 to 2.5

For that, the migration guide will be our reference.

The migrate follow the same steps as the previous migration:

1
2
-addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.4.6")
+addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.5.2")
1
2
-    Logger.configure(context.environment)
+    LoggerConfigurator(context.environment.classLoader).foreach { _.configure(context.environment) }
1
-routesGenerator := InjectedRoutesGenerator