Switch to Play 3 and go all in on Pekko #26677

mkurz · 2023-11-07T16:25:27Z

Hi!

Play maintainer here 😉 I see you switched most of the repo to Pekko already:

Not sure if you have seen it, we finally (thanks to your support!) released Play 3, which starts to use Pekko under the hood, more can be found here:

All the new features, release highlights and the migration guide from Play 2.9 apply to 3.0 as well:

Highlights 2.9: https://www.playframework.com/documentation/latest/Highlights29
Highlights 3.0: https://www.playframework.com/documentation/latest/Highlights30 ("just" the Pekko switch + groupId change)
Migration guide for 2.9: https://www.playframework.com/documentation/latest/Migration29
Migration guide for 3.0: https://www.playframework.com/documentation/latest/Migration30 (again "only" pekko + groupId)

I took a look at your repo and started the migration; it's probably not all that needs to be done, but to get started. I will try my best to help to get things working for you. I will see what fails and push more commits to this pull request.
E.g. it might be possible that webjars cause problems, since Play 3 uses sbt-web 1.5 now which was refactored a bit. We will see. Also I think some dependencies need to be upgraded, like https://github.com/bizzabo/play-json-extensions (?). If so, I am happy to help there also.

If you have any further questions I am available.

BTW: Thanks for your ongoing financial support for Play, without it we would definitely not have been able to push out those releases, thank you very much!

mkurz · 2023-11-07T16:26:05Z

common/app/http/Filters.scala

@@ -144,7 +144,6 @@ object Filters {

 }

-//Note: still using akka (instead of pekko) materializer from Play as both filters extend Play's Filter, so the types need to match


Is it ok to just remove that comment now? I didn't dig deeper if something else needs to be done.

mkurz · 2023-11-07T16:27:16Z

project/Dependencies.scala

-      jackModule,
-      jacksonDatabind,
-    )
-


Play 2.9/3 upgraded to Jackson 2.14: https://www.playframework.com/documentation/latest/Highlights29#Jackson-Upgraded-to-2.14
No need to upgrade explicitly anymore.

mkurz · 2023-11-07T16:28:10Z

project/plugins.sbt


 addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.0")

-addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.10.0-RC1")
+addDependencyTreePlugin


sbt-dependency-tree is now build-in in sbt, see https://www.scala-sbt.org/1.x/docs/sbt-1.4-Release-Notes.html#sbt-dependency-graph+is+in-sourced

mkurz · 2023-11-07T16:28:37Z

project/plugins.sbt

-resolvers ++= Resolver.sonatypeOssRepos("releases") ++ Seq(
-  Classpaths.typesafeReleases,
-  Resolver.typesafeRepo("releases"),
-)


These typesafe resolver should not be needed anymore 🤞

mkurz · 2023-11-07T16:29:12Z

project/plugins.sbt


-addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.3.1")
+addSbtPlugin("com.github.sbt" % "sbt-native-packager" % "1.9.16")


Actually not sure if sbt-native-packager needs to be pulled in explicitly because Play should provide it anyway.

mkurz · 2023-11-07T16:30:21Z

project/plugins.sbt

-    build itself. Once the build has succeeded, there is no further risk (ie of a runtime exception due to clashing
-    versions of `scala-xml`).
- */
-libraryDependencySchemes += "org.scala-lang.modules" %% "scala-xml" % VersionScheme.Always


This workaround should not be needed anymore after upgrading sbt to 1.9.x, Play 2.9+, native-packager, etc. They all come with scala-xml 2.x now.

AshCorr

Hey @mkurz !

Wow! We were not expecting someone else to do this migration for us, thank you so much! We really really appreciate all the work you and the rest of the Play framework team put into maintaining such a great library!

As the group ID for the Play framework is changing to org.playframework now will we need to make sure that all of our dependencies that use Play also use the new group ID?

I'm thinking these 3 in particular which we maintain https://github.com/guardian/frontend/pull/26677/files#diff-ad2642dc77b3679e4ad2c7d3b2f59a2dcf48c1bf5b93a558a4fa44828315a34cL54-L56

mkurz · 2023-11-08T09:45:40Z

Wow! We were not expecting someone else to do this migration for us, thank you so much!

We probably need to do this together 😝

We really really appreciate all the work you and the rest of the Play framework team put into maintaining such a great library!

❤️

As the group ID for the Play framework is changing to org.playframework now will we need to make sure that all of our dependencies that use Play also use the new group ID?

Yes, all dependencies need to switch their own dependencies to org.playframework now. There could be exceptions where it does not matter, but it's definitely much safer if everything switches.

I was looking at the libs you mentioned: It shouldn't be to hard to migrate them. I am somehow motivated to pick this up. However there are some things I would change if you don't mind:

would it be ok if you first delete all those unrelevant, old branches which are "closed" (red) and "merged" (purble) from both repos, just to do a bit of cleanup:
- https://github.com/guardian/play-googleauth/branches/all
- https://github.com/guardian/play-secret-rotation/branches/all
I see that you pull in v2.2.7 of the play-googleauth lib, but there is no git-tag for that:
- frontend/project/Dependencies.scala
  
  Line 54 in 3366a31
  
  val playGoogleAuth = "com.gu.play-googleauth" %% "play-v28" % "2.2.7"
- https://github.com/guardian/play-googleauth/tags
I see that in those projects you use an approach of creating a folder for each major Play release, like here, where you than just link the the play-v27 folder. Or here you link even both, 2.7 and 2.8, to 2.6. I would suggest to not do that, because e.g. now in play-googleauth, where you import akka.*, the setup would get even more complex, with maybe duplicated files, just to switch that import to org.apache.pekko. IMHO it would be better if each major play release would be maintained in its own branch. That could be done by naming the branches e.g. 1.x which contains the Play 2.7 code base, then for Play 2.8.x the branch would 2.x, and so on (this is just an example). Or name the branches after the play releases (play28 for Play 2.8, etc). Again just an example. However that would avoid of doing this folder-per-release thing with symlinking and instead back-/forwardporting bug fixes and features between branches which is IMHO much nicer and the setup simpler. What I would do now is:
1. Create a branch on current HEAD of both repos, named play2 or similiar, to mark this is the branch that contains the (now "old") Play 2.x code base of those libs. Then I would start to clean up the main branch, by removing all that symlink stuff to have a nice setup. The next play-googleauth release would then be 3.0.0, from the master branch. For a future Play 3.1 release you could then branch off a 3.0.x branch from main and migrate to Play 3.1 in the main and so on. You could than always backport changes from main to 3.0.x if desired and cut release from that branch for Play 3.0 etc.

What do you think about that?

johnduffell · 2023-11-08T10:17:28Z

This is really helpful, thanks @mkurz as I was just starting this yesterday for https://github.com/guardian/members-data-api
I have just picked up a couple of tips from your PR and I will continue today.
The good thing is upgrading to play 2.9 or 3.0 will unlock the scala 3 upgrade path, and all the readability and learning curve benefits that scala 3 brings!

edit: PR here guardian/members-data-api#1037

Play v2.9 introduces support for Scala 3 - Play v3.0 also switches from Akka to Pekko, which is great from a licensing perspective (Play v2.9 had to ship with old versions of Akka to avoid the BSL license: https://www.playframework.com/documentation/3.0.x/General#How-Play-Deals-with-Akkas-License-Change ). Here, we're upgrading `play-secret-rotation` to support these new latest versions of Play, and add the new welcome Scala 3 support! To reduce maintenance build complexity, we're also dropping support for Play 2.6, and Scala 2.12. Note, Matthias Kurz made some interesting suggestions about restructuring the multi-Play support in this project and also `google-play-auth`: guardian/frontend#26677 (comment) ...however, for `play-secret-rotation` at least, the changes didn't appear necessary, as `play-secret-rotation` actually has a fairly minimal dependency on Play, and doesn't touch Akka/Pekko related code.

mkurz · 2023-11-09T07:53:48Z

BTW, I guess you still run on Java 11? I recommend that you switch to Java 17, or even better Java 21 already (both are LTS). We plan to drop Java 11 in Play 3.1.0 (ETA somehow next summer or autumn, so like roughly 1 year from now). However very likely just by switching to Java 17/21 you might see a performance boost (?), at least that is what we observed in benchmarks and one Play Framework sponsor reported that to me.

AshCorr · 2023-11-09T11:08:10Z

would it be ok if you first delete all those unrelevant, old branches which are "closed" (red) and "merged" (purble) from both repos, just to do a bit of cleanup

Can do, we tend not to use forks so we do end up with a fair few stale branches on our repos.

I see that you pull in v2.2.7 of the play-googleauth lib, but there is no git-tag for that
I see that in those projects you use an approach of creating a folder for each major Play release

Yea we could probably do with rethinking how we manage our various versions of these dependencies, our current approach doesn't seem that sustainable. Using tags/branches to keep track of older versions of the library feels like it could make upgrades a fair bit easier.

BTW, I guess you still run on Java 11?

This repo does, our recommendation is to use Java 17 but we haven't gotten around to upgrading everything yet.

ioannakok · 2023-12-11T18:19:24Z

Hi @mkurz, thanks so much for your contribution! As others have already said, we really appreciate it. I have re-raised your PR here:

Switch to Play 3 and go all in Pekko #26755

because in order for the tests to run someone from the Guardian organisation has to raise it. I hope that's okay! I am going to add a comment there with an update.

github-actions · 2024-01-11T06:05:18Z

"This PR is stale because it has been open 30 days with no activity. Unless a comment is added or the “stale” label removed, this will be closed in 3 days"

github-actions · 2024-01-15T06:05:42Z

This PR was closed because it has been stalled for 3 days with no activity.

mkurz added 6 commits November 7, 2023 16:35

Upgrade Play to v3, changed groupIds, upgrade other dependencies

c7d1885

jackson got upgraded in Play 3

f92084c

PekkoHttp instead of AkkaHttp now

d6f0291

Upgrade sbt, no workaround needed anymore

4c7395d

Switch to org.apache.pekko imports

3a94428

typesafeRepo _should_ not be needed anymore

3510d3e

mkurz requested a review from a team as a code owner November 7, 2023 16:25

mkurz commented Nov 7, 2023

View reviewed changes

This was referenced Nov 7, 2023

Migrate from Akka to Pekko #26563

Merged

refactor(akka): update config and refactor names #26602

Merged

AshCorr reviewed Nov 7, 2023

View reviewed changes

rtyley mentioned this pull request Nov 8, 2023

Support Scala 3 & Play 3 - drop oldest Play & Scala versions guardian/play-secret-rotation#411

Merged

AshCorr mentioned this pull request Nov 8, 2023

Play 3.0 leanovate/play-mockws#322

Merged

ioannakok self-assigned this Nov 15, 2023

ioannakok added this to the Health milestone Nov 15, 2023

ioannakok mentioned this pull request Dec 11, 2023

Switch to Play 3 and go all in Pekko #26755

Merged

1 task

github-actions bot added the Stale label Jan 11, 2024

github-actions bot closed this Jan 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Switch to Play 3 and go all in on Pekko #26677

Switch to Play 3 and go all in on Pekko #26677

mkurz commented Nov 7, 2023 •

edited

Loading

mkurz Nov 7, 2023

mkurz Nov 7, 2023

mkurz Nov 7, 2023 •

edited

Loading

mkurz Nov 7, 2023

mkurz Nov 7, 2023

mkurz Nov 7, 2023

AshCorr left a comment •

edited

Loading

mkurz commented Nov 8, 2023

johnduffell commented Nov 8, 2023 •

edited

Loading

mkurz commented Nov 9, 2023

AshCorr commented Nov 9, 2023

ioannakok commented Dec 11, 2023 •

edited

Loading

github-actions bot commented Jan 11, 2024

github-actions bot commented Jan 15, 2024

		@@ -144,7 +144,6 @@ object Filters {

		}

		//Note: still using akka (instead of pekko) materializer from Play as both filters extend Play's Filter, so the types need to match


		addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.3.1")
		addSbtPlugin("com.github.sbt" % "sbt-native-packager" % "1.9.16")

Switch to Play 3 and go all in on Pekko #26677

Switch to Play 3 and go all in on Pekko #26677

Conversation

mkurz commented Nov 7, 2023 • edited Loading

mkurz Nov 7, 2023

Choose a reason for hiding this comment

mkurz Nov 7, 2023

Choose a reason for hiding this comment

mkurz Nov 7, 2023 • edited Loading

Choose a reason for hiding this comment

mkurz Nov 7, 2023

Choose a reason for hiding this comment

mkurz Nov 7, 2023

Choose a reason for hiding this comment

mkurz Nov 7, 2023

Choose a reason for hiding this comment

AshCorr left a comment • edited Loading

Choose a reason for hiding this comment

mkurz commented Nov 8, 2023

johnduffell commented Nov 8, 2023 • edited Loading

mkurz commented Nov 9, 2023

AshCorr commented Nov 9, 2023

ioannakok commented Dec 11, 2023 • edited Loading

github-actions bot commented Jan 11, 2024

github-actions bot commented Jan 15, 2024

mkurz commented Nov 7, 2023 •

edited

Loading

mkurz Nov 7, 2023 •

edited

Loading

AshCorr left a comment •

edited

Loading

johnduffell commented Nov 8, 2023 •

edited

Loading

ioannakok commented Dec 11, 2023 •

edited

Loading