Merge remote-tracking branch 'origin/ms/#53-upgrate-to-scala3' into ms/ReCoDe

# Conflicts:
#	src/main/scala/edu/ie3/simona/config/RuntimeConfig.scala
#	src/main/scala/edu/ie3/simona/config/SimonaConfig.scala
#	src/main/scala/edu/ie3/simona/sim/setup/ExtSimSetupData.scala

Author: staudtMarius

.scalafmt.conf

@@ -1,4 +1,9 @@
 version = 3.8.1
-runner.dialect = scala213
+runner.dialect = scala3
+
+rewrite.scala3.convertToNewSyntax = false
+rewrite.scala3.removeOptionalBraces = no
 
 rewrite.trailingCommas.style = multiple
+
+rewrite.rules = []

CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## Updated
+- Upgraded `scala2` to `scala3` [#53](https://github.com/ie3-institute/simona/issues/53)
+
+## [4.0.0] - 2025-05-09
+
 ### Added
 - Add safety factor sRated calculation [#629](https://github.com/ie3-institute/simona/issues/629)
 - Re-implemented ResultEventListener in akka typed [#343](https://github.com/ie3-institute/simona/issues/343)

build.gradle

@@ -21,17 +21,29 @@ ext {
   // version (changing these should be considered thoroughly!)
   javaVersion = JavaVersion.VERSION_17
 
-  scalaVersion = '2.13'
-  scalaBinaryVersion = '2.13.16'
+  scalaVersion = '3'
+  scalaBinaryVersion = '3.7.0'
   pekkoVersion = '1.1.3'
   jtsVersion = '1.20.0'
   confluentKafkaVersion = '7.9.0'
-  scapegoatVersion = '3.1.8'
+  scapegoatVersion = '3.1.9'
 
   junitVersion = '1.12.2'
   testContainerVersion = '0.43.0'
 
   scriptsLocation = 'gradle' + File.separator + 'scripts' + File.separator // location of script plugins
+
+  scala3compilerOptions = [
+    "-source:3.7-migration",
+    "-print-tasty",
+    "-feature",
+    "-language:implicitConversions",
+    "-language:existentials",
+    "-Wunused:all",
+    "-Xmax-inlines:128"
+    //"-explain",
+    //"-explain-types"
+  ]
 }
 
 group = 'com.github.ie3-institute'
@@ -66,26 +78,26 @@ repositories {
 dependencies {
 
   // ie³ internal repository
-  implementation('com.github.ie3-institute:PowerSystemUtils:2.2.1') {
+  implementation('com.github.ie3-institute:PowerSystemUtils:3.1.0') {
     exclude group: 'org.apache.logging.log4j'
     exclude group: 'org.slf4j'
     /* Exclude our own nested dependencies */
     exclude group: 'com.github.ie3-institute'
   }
-  implementation('com.github.ie3-institute:PowerSystemDataModel:6.0.0') {
+  implementation('com.github.ie3-institute:PowerSystemDataModel:7.0.0') {
     exclude group: 'org.apache.logging.log4j'
     exclude group: 'org.slf4j'
     /* Exclude our own nested dependencies */
     exclude group: 'com.github.ie3-institute'
   }
-  implementation('com.github.ie3-institute:powerflow:0.2') {
+  implementation('com.github.ie3-institute:powerflow:0.3.0') {
     exclude group: 'org.apache.logging.log4j'
     exclude group: 'org.slf4j'
     /* Exclude our own nested dependencies */
     exclude group: 'edu.ie3'
   }
 
-  implementation('com.github.ie3-institute:simonaAPI:0.8.0') {
+  implementation('com.github.ie3-institute:simonaAPI:0.9.0') {
     exclude group: 'org.apache.logging.log4j'
     exclude group: 'org.slf4j'
     /* Exclude our own nested dependencies */
@@ -118,17 +130,18 @@ dependencies {
 
   /* --- Scala libs --- */
   /* CORE Scala */
-  implementation "org.scala-lang:scala-library:${scalaBinaryVersion}"
+  implementation "org.scala-lang:scala3-library_3:${scalaBinaryVersion}"
 
   /* CORE Pekko */
-  implementation "org.apache.pekko:pekko-actor_${scalaVersion}:${pekkoVersion}"
-  implementation "org.apache.pekko:pekko-actor-typed_${scalaVersion}:${pekkoVersion}"
-  implementation "org.apache.pekko:pekko-slf4j_${scalaVersion}:${pekkoVersion}"
+  implementation "org.apache.pekko:pekko-actor_3:${pekkoVersion}"
+  implementation "org.apache.pekko:pekko-actor-typed_3:${pekkoVersion}"
+  implementation "org.apache.pekko:pekko-slf4j_3:${pekkoVersion}"
 
   /* config */
   implementation 'com.typesafe:config:1.4.3'
   implementation "com.github.scopt:scopt_${scalaVersion}:4.1.0" // cmd args parser
-  implementation "com.github.pureconfig:pureconfig_${scalaVersion}:0.17.9"
+  implementation "com.github.pureconfig:pureconfig-core_${scalaVersion}:0.17.9"
+  implementation "com.github.pureconfig:pureconfig-generic-scala3_${scalaVersion}:0.17.9"
 
   // JTS
   implementation ("org.locationtech.jts:jts-core:${jtsVersion}") {
@@ -143,7 +156,7 @@ dependencies {
   /* Kafka */
   implementation "org.apache.kafka:kafka-clients:${confluentKafkaVersion}-ccs"
   implementation "io.confluent:kafka-streams-avro-serde:${confluentKafkaVersion}"
-  implementation "com.sksamuel.avro4s:avro4s-core_${scalaVersion}:4.1.2"
+  implementation "com.sksamuel.avro4s:avro4s-core_${scalaVersion}:5.0.14"
 
   implementation 'org.apache.commons:commons-math3:3.6.1' // apache commons math3
   implementation 'org.apache.poi:poi-ooxml:5.4.1' // used for FilenameUtils
@@ -153,6 +166,9 @@ dependencies {
   implementation 'org.apache.commons:commons-csv:1.14.0'
   implementation "org.scalanlp:breeze_${scalaVersion}:2.1.0" // scientific calculations (http://www.scalanlp.org/)
   implementation 'org.jgrapht:jgrapht-core:1.5.2'
+
+  // needed, because scala won't compile otherwise
+  implementation 'org.influxdb:influxdb-java:2.24'
 }
 
 tasks.withType(JavaCompile).configureEach {
@@ -190,7 +206,7 @@ shadowJar {
 // using compileScala instead of tasks.withType(ScalaCompile) prevents applying scapegoat to scala test classes
 // see https://docs.gradle.org/current/userguide/scala_plugin.html#sec:configure_scala_classpath for details
 tasks.withType(ScalaCompile).configureEach {
-  scalaCompileOptions.additionalParameters = [
+  scalaCompileOptions.additionalParameters = scala3compilerOptions + [
     "-Xplugin:" + configurations.scalaCompilerPlugin.asPath,
     "-P:scapegoat:dataDir:" + project.layout.buildDirectory.get().asFile.absolutePath + "/reports/scapegoat/src/",
     "-P:scapegoat:disabledInspections:TryGet"
@@ -203,7 +219,7 @@ tasks.withType(ScalaCompile).configureEach {
 
 // separate scapegoat report for test classes
 compileTestScala {
-  scalaCompileOptions.additionalParameters = [
+  scalaCompileOptions.additionalParameters = scala3compilerOptions + [
     "-Xplugin:" + configurations.scalaCompilerPlugin.asPath,
     "-P:scapegoat:dataDir:" + project.layout.buildDirectory.get().asFile.absolutePath + "/reports/scapegoat/testsrc/",
     "-P:scapegoat:disabledInspections:TryGet"

gradle/scripts/scoverage.gradle

@@ -4,7 +4,7 @@
 
 scoverage {
   scoverageVersion = "2.3.0"
-  scoverageScalaVersion = scalaBinaryVersion
+  scoverageScalaVersion //= scalaBinaryVersion
   coverageOutputHTML = false
   coverageOutputXML = true
   coverageOutputCobertura = false

src/main/scala/edu/ie3/simona/agent/em/EmAgent.scala

@@ -28,7 +28,7 @@ import edu.ie3.simona.ontology.messages.{Activation, SchedulerMessage}
 import edu.ie3.simona.service.Data.PrimaryData.ComplexPower
 import edu.ie3.simona.service.em.ExtEmDataService
 import edu.ie3.simona.util.TickUtil.TickLong
-import edu.ie3.util.quantities.QuantityUtils.RichQuantityDouble
+import edu.ie3.util.quantities.QuantityUtils._
 import edu.ie3.util.scala.quantities.DefaultQuantities._
 import org.apache.pekko.actor.typed.scaladsl.Behaviors
 import org.apache.pekko.actor.typed.{ActorRef, Behavior}

src/main/scala/edu/ie3/simona/agent/em/EmDataCore.scala

@@ -55,7 +55,7 @@ object EmDataCore {
     * @param lastActiveTick
     *   The last active tick, if applicable
     */
-  final case class Inactive private (
+  final case class Inactive(
       private val modelToActor: Map[UUID, Actor],
       private val activationQueue: PriorityMultiBiSet[Long, UUID],
       private val flexWithNext: Set[UUID],

src/main/scala/edu/ie3/simona/agent/grid/GridAgentData.scala

@@ -43,7 +43,7 @@ object GridAgentData {
     * @param activationAdapter
     *   adapter for [[Activation]]
     */
-  final case class GridAgentConstantData private (
+  final case class GridAgentConstantData(
       environmentRefs: EnvironmentRefs,
       simonaConfig: SimonaConfig,
       listener: Iterable[ActorRef[ResultEvent]],
@@ -97,7 +97,7 @@ object GridAgentData {
     *   Set of subgrid numbers of [[GridAgent]]s that don't have their request
     *   answered, yet
     */
-  final case class PowerFlowDoneData private (
+  final case class PowerFlowDoneData(
       gridAgentBaseData: GridAgentBaseData,
       powerFlowResult: PowerFlowResult,
       pendingRequestAnswers: Set[Int],
@@ -210,7 +210,7 @@ object GridAgentData {
     * @param sweepValueStores
     *   a value store for sweep results
     */
-  final case class GridAgentBaseData private (
+  final case class GridAgentBaseData(
       gridEnv: GridEnvironment,
       powerFlowParams: PowerFlowParams,
       currentSweepNo: Int,

src/main/scala/edu/ie3/simona/agent/grid/GridAgentMessages.scala

@@ -11,6 +11,7 @@ import edu.ie3.simona.agent.grid.GridAgentMessages.Responses.{
   ExchangePower,
   ExchangeVoltage,
 }
+import edu.ie3.simona.agent.participant.ParticipantAgent
 import edu.ie3.simona.ontology.messages.Activation
 import edu.ie3.simona.scheduler.ScheduleLock.ScheduleKey
 import edu.ie3.util.scala.quantities.ReactivePower
@@ -95,7 +96,7 @@ object GridAgentMessages {
     (ActorRef[GridAgent.Request], SlackVoltageResponse)
 
   sealed trait ReceivedPowerValues extends ReceivedValues {
-    def values: Vector[PowerRequestResponse[_]]
+    def values: Vector[(ActorRef[_], PowerResponse)]
   }
 
   /** Wrapper for received asset power values (p, q)
@@ -104,7 +105,7 @@ object GridAgentMessages {
     *   the asset power values and their senders
     */
   final case class ReceivedAssetPowerValues(
-      values: Vector[PowerRequestResponse[_]]
+      values: Vector[PowerRequestResponse[ParticipantAgent.Request]]
   ) extends ReceivedPowerValues
 
   /** Wrapper for received grid power values (p, q)
@@ -169,7 +170,7 @@ object GridAgentMessages {
   /** Indicate that the power flow calculation failed, as a reply to a
     * [[RequestGridPower]].
     */
-  final case object FailedPowerFlow extends PowerResponse
+  case object FailedPowerFlow extends PowerResponse
 
   /** Provide power values as a reply to a
     * [[edu.ie3.simona.agent.participant.ParticipantAgent.RequestAssetPowerMessage]]

src/main/scala/edu/ie3/simona/agent/grid/ReceivedValuesStore.scala

@@ -40,7 +40,7 @@ import java.util.UUID
   *   mapping of node uuids to received slack voltages from superior
   *   [[GridAgent]] s if any
   */
-final case class ReceivedValuesStore private (
+final case class ReceivedValuesStore(
     nodeToReceivedPower: NodeToReceivedPower,
     nodeToReceivedSlackVoltage: NodeToReceivedSlackVoltage,
 )
@@ -105,7 +105,9 @@ object ReceivedValuesStore {
     /* Collect everything, that I expect from my asset agents */
     val assetsToReceivedPower: NodeToReceivedPower = nodeToAssetAgents.collect {
       case (uuid: UUID, actorRefs: Set[ActorRef[ParticipantAgent.Request]]) =>
-        (uuid, actorRefs.map(actorRef => actorRef -> None).toMap)
+        val map: Map[ActorRef[?], Option[PowerResponse]] =
+          actorRefs.map(actorRef => actorRef -> None).toMap
+        (uuid, map)
     }
 
     /* Add everything, that I expect from my subordinate grid agents. */

src/main/scala/edu/ie3/simona/agent/grid/SweepValueStore.scala

@@ -34,7 +34,7 @@ case object SweepValueStore {
     * @param nodeUuid
     *   node uuid of the sweep data
     */
-  final case class SweepValueStoreData private (
+  final case class SweepValueStoreData(
       nodeUuid: UUID,
       stateData: StateData,
   )

src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgent.scala

@@ -26,8 +26,6 @@ import org.apache.pekko.actor.typed.scaladsl.Behaviors
 import org.apache.pekko.actor.typed.{ActorRef, Behavior}
 import squants.{Dimensionless, Each}
 
-import scala.reflect.ClassTag
-
 /** Agent that represents and acts on behalf of any system participant model,
   * which is defined as a subclass of
   * [[edu.ie3.simona.model.participant.ParticipantModel]].
@@ -87,9 +85,7 @@ object ParticipantAgent {
     * @tparam P
     *   The type of primary data to be received.
     */
-  final case class PrimaryRegistrationSuccessfulMessage[
-      P <: PrimaryData: ClassTag
-  ](
+  final case class PrimaryRegistrationSuccessfulMessage[P <: PrimaryData](
       override val serviceRef: ActorRef[_ >: ServiceMessage],
       firstDataTick: Long,
       primaryDataExtra: PrimaryDataExtra[P],

src/main/scala/edu/ie3/simona/agent/participant/ParticipantGridAdapter.scala

@@ -52,8 +52,7 @@ final case class ParticipantGridAdapter(
     private val expectedRequestTick: Long,
     private val tickToPower: SortedMap[Long, ComplexPower],
     avgPowerResult: Option[AvgPowerResult],
-    private implicit val requestVoltageDeviationTolerance: Dimensionless,
-) {
+)(private implicit val requestVoltageDeviationTolerance: Dimensionless) {
 
   /** Whether a power request is expected and has not yet arrived, thus is
     * awaited, for the given tick.
@@ -206,7 +205,8 @@ object ParticipantGridAdapter {
       expectedRequestTick = expectedRequestTick,
       tickToPower = SortedMap.empty,
       avgPowerResult = None,
-      requestVoltageDeviationTolerance = requestVoltageDeviationTolerance,
+    )(
+      requestVoltageDeviationTolerance = requestVoltageDeviationTolerance
     )
 
   private def reduceTickToPowerMap(

src/main/scala/edu/ie3/simona/config/ArgsParser.scala

@@ -107,7 +107,9 @@ object ArgsParser extends LazyLogging {
 
     val argsConfig =
       ConfigFactory.parseString(
-        s"""config = "${parsedArgs.configLocation.get.replace("\\", "\\\\")}""""
+        s"""config = "${parsedArgs.configLocation
+            .getOrElse("")
+            .replace("\\", "\\\\")}""""
       )
 
     // note: this overrides the default config values provided in the config file!

src/main/scala/edu/ie3/simona/config/ConfigFailFast.scala

@@ -625,8 +625,10 @@ object ConfigFailFast extends LazyLogging {
         checkCouchbaseParams(params)
       case Some(BaseInfluxDb1xParams(database, _, url)) =>
         checkInfluxDb1xParams("WeatherSource", url, database)
-      case Some(params: SqlParams) =>
-        checkSqlParams(params)
+      case Some(
+            BaseSqlParams(jdbcUrl, password, schemaName, tableName, userName)
+          ) =>
+        checkSqlParams(jdbcUrl, password, schemaName, tableName, userName)
       case Some(_: SampleParams) =>
         // sample weather, no check required
         // coordinate source must be sample coordinate source
@@ -685,8 +687,16 @@ object ConfigFailFast extends LazyLogging {
         }
 
         "csv"
-      case Some(sqlParams: SqlParams) =>
-        checkSqlParams(sqlParams)
+      case Some(
+            BaseSqlParams(
+              jdbcUrl,
+              password,
+              schemaName,
+              tableName,
+              userName,
+            )
+          ) =>
+        checkSqlParams(jdbcUrl, password, schemaName, tableName, userName)
         "sql"
       case Some(_: SampleParams) =>
         "sample"