CORE-69: update Scala, sbt versions and associated plugins #1566

davidangb · 2024-10-15T18:18:28Z

Ticket: https://broadworkbench.atlassian.net/browse/CORE-69

Updates the Scala and sbt versions, along with associated sbt plugins and utility docker image.

Scala to 2.13.15
sbt to 1.10.2
docker image to sbtscala/scala-sbt:eclipse-temurin-jammy-17.0.10_7_1.10.2_2.13.15 (note the matching 1.10.2 and 2.13.15)
related updates to sbt-assembly, sbt-revolver, sbt-scoverage, sbt-scalafmt, sbt-scalafix plugins
sbt scalacOptions fix to address a breaking change in Scala 2.13.15
code-level fixes to address compile errors as of Scala 2.13.11 and later

This supersedes Scala Steward PRs #1419, #1540, #1548, #1550, #1555

PR checklist

I've followed the instructions if I've made any changes to the API, especially if they're breaking changes
I've filled out the Security Risk Assessment (requires Broad Internal network access) and attached the result to the JIRA ticket

….13.15

davidangb · 2024-10-15T20:31:10Z

project/Settings.scala

@@ -37,7 +37,7 @@ object Settings {
    "-language:existentials", // Existential types (besides wildcard types) can be written and inferred
    "-unchecked", // Enable additional warnings where generated code depends on assumptions.
    "-Xcheckinit", // Wrap field accessors to throw an exception on uninitialized access.
-    "-Wconf:cat=deprecation:ws,any:e", // Fail the compilation if there are any warnings, except for deprecation warnings.
+    "-Wconf:any:e,cat=deprecation:ws", // Fail the compilation if there are any warnings, except for deprecation warnings.


See the "Breaking Changes" section of https://github.com/scala/scala/releases/tag/v2.13.15: the order in which -Wconf is parsed has changed. This change necessary to retain functionality.

Of note: I am not sure this setting is actually what we want. A few lines above we specify:

"-deprecation", // Emit warning and location for usages of deprecated APIs.

but here we configure deprecations to be ws, which stands for "warning summary" - the summary suppresses the info about where the actual deprecations are in the codebase and just gives a summary like "12 deprecations….". BUT, to keep scope of this PR down I am not changing it here; this PR preserves existing functionality.

davidangb · 2024-10-15T20:32:13Z

src/main/scala/org/broadinstitute/dsde/workbench/sam/api/SamRequestContextDirectives.scala

@@ -56,7 +56,7 @@ trait SamRequestContextDirectives {
  def withSamRequestContext: Directive1[SamRequestContext] =
    for {
      clientIP <- extractClientIP
-      otelContext <- traceRequest
+      otelContext <- traceRequest()


as of Scala 2.13.11, this caused compile to break. It's a warning, but we have -Wconf … any:e set, which causes warnings to be errors.

davidangb · 2024-10-15T20:32:47Z

src/main/scala/org/broadinstitute/dsde/workbench/sam/audit/SamAuditModel.scala

@@ -51,10 +51,10 @@ object SamAuditModelJsonSupport {
    }
  }

-  implicit val AuditInfoFormat = jsonFormat2(AuditInfo)
+  implicit val AuditInfoFormat: RootJsonFormat[AuditInfo] = jsonFormat2(AuditInfo)


as of Scala 2.13.11, this caused compile to break. It's a warning, but we have -Wconf … any:e set, which causes warnings to be errors.

The error was "Implicit definition should have explicit type" and we had many instances of this issue; lots of lines of code changed below.

davidangb · 2024-10-16T13:49:34Z

project/Merging.scala

@@ -16,6 +16,7 @@ object Merging {
    case PathList("META-INF", "kotlin-stdlib-common.kotlin_module") => MergeStrategy.first
    case PathList("META-INF", "okio.kotlin_module") => MergeStrategy.first
    case PathList("META-INF", "versions", "9", "OSGI-INF", "MANIFEST.MF") => MergeStrategy.first
+    case PathList("META-INF", "license", "LICENSE.mvn-wrapper.txt") => MergeStrategy.first


some dependencies changed, such that we now have an assembly merge conflict on META-INF/license/LICENSE.mvn-wrapper.txt; added a case for this file.

davidangb · 2024-10-16T13:51:22Z

codegen_java/project/build.properties

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


of note: I did not change the sbt.version in the codegen_java_old directory. Why do we have an "old" directory committed to source control?

sonarqubecloud · 2024-10-16T13:53:44Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

davidangb · 2024-10-16T14:02:20Z

.github/workflows/verify_consumer_pacts.yml

-                          sbtscala/scala-sbt:openjdk-17.0.2_1.7.2_2.13.10 \
-                          sbt "set scalafmtOnCompile := false" "project pact4s" "testOnly *SamProviderSpec"
+                          sbtscala/scala-sbt:eclipse-temurin-jammy-17.0.10_7_1.10.2_2.13.15 \
+                          bash -c "git config --global --add safe.directory /working/sam && sbt \"set scalafmtOnCompile := false\" \"project pact4s\" \"testOnly *SamProviderSpec\""


here and elsewhere, set the scala-sbt docker image to the version that uses sbt 1.10.2 and Scala 2.13.15.

The docker image upgrade must have updated its version of git, because it started running into the "dubious ownership" error; so, I also added the incantation to set the git safe.directory.

davidangb added 3 commits October 15, 2024 14:12

update Scala, sbt versions and associated plugins

e2eb2c6

reverse scalacOptions -Wconf values due to breaking change in Scala 2…

a0cf79f

….13.15

Implicit definition should have explicit type

db93b61

davidangb commented Oct 15, 2024

View reviewed changes

davidangb added 4 commits October 15, 2024 16:49

tests: Implicit definition should have explicit type

732a9e5

Merge branch 'develop' into da_CORE-69_updateScala

a0c6025

fix assembly merging

229310e

fix safe.directory for pact

300d37d

davidangb commented Oct 16, 2024

View reviewed changes

whoops, wrong dir for safe.directory

489c628

davidangb commented Oct 16, 2024

View reviewed changes

davidangb requested review from a team, calypsomatic and kevinmarete and removed request for a team October 16, 2024 14:39

dvoet approved these changes Oct 16, 2024

View reviewed changes

kevinmarete approved these changes Oct 16, 2024

View reviewed changes

davidangb merged commit 2cddf18 into develop Oct 16, 2024
25 checks passed

davidangb deleted the da_CORE-69_updateScala branch October 16, 2024 15:27

This was referenced Oct 16, 2024

Update sbt-scoverage to 2.0.12 #1419

Closed

Update sbt, sbt-dependency-tree to 1.10.2 #1540

Closed

Update scala-library to 2.13.15 #1548

Closed

Update sbt-scalafix to 0.13.0 #1550

Closed

Update sbt-assembly to 2.3.0 #1555

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CORE-69: update Scala, sbt versions and associated plugins #1566

CORE-69: update Scala, sbt versions and associated plugins #1566

davidangb commented Oct 15, 2024 •

edited

Loading

davidangb Oct 15, 2024 •

edited

Loading

davidangb Oct 15, 2024

davidangb Oct 15, 2024

davidangb Oct 16, 2024

davidangb Oct 16, 2024

sonarqubecloud bot commented Oct 16, 2024

davidangb Oct 16, 2024

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

CORE-69: update Scala, sbt versions and associated plugins #1566

CORE-69: update Scala, sbt versions and associated plugins #1566

Conversation

davidangb commented Oct 15, 2024 • edited Loading

davidangb Oct 15, 2024 • edited Loading

Choose a reason for hiding this comment

davidangb Oct 15, 2024

Choose a reason for hiding this comment

davidangb Oct 15, 2024

Choose a reason for hiding this comment

davidangb Oct 16, 2024

Choose a reason for hiding this comment

davidangb Oct 16, 2024

Choose a reason for hiding this comment

sonarqubecloud bot commented Oct 16, 2024

Quality Gate passed

davidangb Oct 16, 2024

Choose a reason for hiding this comment

davidangb commented Oct 15, 2024 •

edited

Loading

davidangb Oct 15, 2024 •

edited

Loading