Merge pull request #64 from SpineEventEngine/migrate-to-reactions

Migrate to `Reaction` API

Author: alexander-yevsyukov

buildSrc/src/main/kotlin/io/spine/dependency/local/BaseTypes.kt

@@ -33,7 +33,7 @@ package io.spine.dependency.local
  */
 @Suppress("ConstPropertyName")
 object BaseTypes {
-    const val version = "2.0.0-SNAPSHOT.211"
+    const val version = "2.0.0-SNAPSHOT.212"
     const val group = Spine.group
     const val artifact = "spine-base-types"
     const val lib = "$group:$artifact:$version"

buildSrc/src/main/kotlin/io/spine/dependency/local/Compiler.kt

@@ -29,7 +29,7 @@ package io.spine.dependency.local
 /**
  * Dependencies on the Spine Compiler modules.
  *
- * To use a locally published ProtoData version instead of the version from a public plugin
+ * To use a locally published Compiler version instead of the version from a public plugin
  * registry, set the `COMPILER_VERSION` and/or the `COMPILER_DF_VERSION` environment variables
  * and stop the Gradle daemons so that Gradle observes the env change:
  * ```
@@ -67,22 +67,22 @@ object Compiler {
     const val module = "io.spine.tools:compiler"
 
     /**
-     * The version of ProtoData dependencies.
+     * The version of the Compiler dependencies.
      */
     val version: String
-    private const val fallbackVersion = "2.0.0-SNAPSHOT.030"
+    private const val fallbackVersion = "2.0.0-SNAPSHOT.034"
 
     /**
-     * The distinct version of ProtoData used by other build tools.
+     * The distinct version of the Compiler used by other build tools.
      *
-     * When ProtoData is used both for building the project and as a part of the Project's
-     * transitional dependencies, this is the version used to build the project itself.
+     * When the Compiler is used both for building the project and as a part of the Project's
+     * transitive dependencies, this is the version used to build the project itself.
      */
     val dogfoodingVersion: String
     private const val fallbackDfVersion = "2.0.0-SNAPSHOT.030"
 
     /**
-     * The artifact for the ProtoData Gradle plugin.
+     * The artifact for the Compiler Gradle plugin.
      */
     val pluginLib: String
 

buildSrc/src/main/kotlin/io/spine/dependency/local/CoreJvm.kt

@@ -31,14 +31,14 @@ package io.spine.dependency.local
 typealias CoreJava = CoreJvm
 
 /**
- * Dependencies on `core-java` modules.
+ * Dependencies on `core-jvm` modules.
  *
- * See [`SpineEventEngine/core-java`](https://github.com/SpineEventEngine/core-jvm/).
+ * See [`SpineEventEngine/core-jvm`](https://github.com/SpineEventEngine/core-jvm/).
  */
 @Suppress("ConstPropertyName", "unused")
 object CoreJvm {
     const val group = Spine.group
-    const val version = "2.0.0-SNAPSHOT.346"
+    const val version = "2.0.0-SNAPSHOT.356"
 
     const val coreArtifact = "spine-core"
     const val clientArtifact = "spine-client"

buildSrc/src/main/kotlin/io/spine/dependency/local/CoreJvmCompiler.kt

@@ -46,12 +46,12 @@ object CoreJvmCompiler {
     /**
      * The version used to in the build classpath.
      */
-    const val dogfoodingVersion = "2.0.0-SNAPSHOT.030"
+    const val dogfoodingVersion = "2.0.0-SNAPSHOT.035"
 
     /**
      * The version to be used for integration tests.
      */
-    const val version = "2.0.0-SNAPSHOT.030"
+    const val version = "2.0.0-SNAPSHOT.035"
 
     /**
      * The ID of the Gradle plugin.

buildSrc/src/main/kotlin/io/spine/dependency/local/Validation.kt

@@ -36,7 +36,7 @@ object Validation {
     /**
      * The version of the Validation library artifacts.
      */
-    const val version = "2.0.0-SNAPSHOT.354"
+    const val version = "2.0.0-SNAPSHOT.360"
 
     /**
      * The last version of Validation compatible with ProtoData.

buildSrc/src/main/kotlin/io/spine/gradle/git/Repository.kt

@@ -26,8 +26,10 @@
 
 package io.spine.gradle.git
 
+import com.google.common.util.concurrent.Uninterruptibles.sleepUninterruptibly
 import io.spine.gradle.Cli
 import io.spine.gradle.fs.LazyTempPath
+import java.util.concurrent.TimeUnit.MILLISECONDS
 import org.gradle.api.logging.Logger
 
 /**
@@ -133,8 +135,10 @@ class Repository private constructor(
      * Performs a pull with rebase before pushing to ensure the local branch is up-to-date.
      */
     fun push() {
-        repoExecute("git", "pull", "--rebase")
-        repoExecute("git", "push")
+        withRetries(description = "Pushing to $sshUrl, branch = '$currentBranch'") {
+            repoExecute("git", "pull", "--rebase")
+            repoExecute("git", "push")
+        }
     }
 
     override fun close() {
@@ -174,3 +178,44 @@ class Repository private constructor(
         }
     }
 }
+
+/**
+ * Executes a given operation with retries using exponential backoff strategy.
+ *
+ * If the operation fails, it will be retried up to the specified number of times
+ * with increasing delays between attempts.
+ * The delay increases exponentially but is capped at the specified maximum value.
+ *
+ * If all retries fail, the exception from the final attempt will be thrown to the caller.
+ *
+ * @param T the type of value returned by the operation
+ * @param times the maximum number of attempts to execute the operation (default: 3)
+ * @param initialDelay the delay before the first retry in milliseconds (default: 100ms)
+ * @param maxDelay the maximum delay between retries in milliseconds (default: 2000ms)
+ * @param factor the multiplier used to increase delay after each failure (default: 2.0)
+ * @param description a description of the operation for error reporting (default: empty string)
+ * @param block the operation to execute
+ * @return the result of the successful operation execution
+ */
+@Suppress("TooGenericExceptionCaught", "LongParameterList")
+private fun <T> withRetries(
+    times: Int = 3,
+    initialDelay: Long = 100,      // ms
+    maxDelay: Long = 2000,         // ms
+    factor: Double = 2.0,
+    description: String = "",
+    block: () -> T
+): T {
+    var currentDelay = initialDelay
+    repeat(times - 1) {
+        try {
+            return block()
+        } catch (e: Exception) {
+            System.err.println("'$description' failed. " +
+                    "Message: '${e.message}'. Retrying in $currentDelay ms.")
+        }
+        sleepUninterruptibly(currentDelay, MILLISECONDS)
+        currentDelay = (currentDelay * factor).toLong().coerceAtMost(maxDelay)
+    }
+    return block()
+}

buildSrc/src/main/kotlin/io/spine/gradle/report/license/LicenseReporter.kt

@@ -151,11 +151,18 @@ object LicenseReporter {
         sourceProjects: Iterable<Project>,
         rootProject: Project
     ) {
-        val paths = sourceProjects.map {
-            val buildDir = it.layout.buildDirectory.asFile.get()
-            "$buildDir/${Paths.relativePath}/${Paths.outputFilename}"
-        }
-        println("Merging the license reports from the all projects.")
+        val paths = sourceProjects
+            .map {
+                val buildDir = it.layout.buildDirectory.asFile.get()
+                "$buildDir/${Paths.relativePath}/${Paths.outputFilename}"
+            }.filter {
+                val exists = File(it).exists()
+                if (!exists) {
+                    rootProject.logger.debug("License report file not found: $it")
+                }
+                exists
+            }
+        println("Merging the license reports from all projects.")
         val mergedContent = paths.joinToString("\n\n\n") { (File(it)).readText() }
         val output = File("${rootProject.rootDir}/${Paths.outputFilename}")
         output.writeText(mergedContent)

buildSrc/src/main/kotlin/module.gradle.kts

@@ -48,6 +48,7 @@ import io.spine.dependency.local.ToolBase
 import io.spine.dependency.local.Validation
 import io.spine.dependency.test.JUnit
 import io.spine.gradle.checkstyle.CheckStyleConfig
+import io.spine.gradle.github.pages.updateGitHubPages
 import io.spine.gradle.javac.configureErrorProne
 import io.spine.gradle.javac.configureJavac
 import io.spine.gradle.javadoc.JavadocConfig
@@ -94,6 +95,7 @@ project.run {
     setupSourceSets(generatedResources)
 
     configureTaskDependencies()
+    setupDocPublishing()
 }
 
 typealias Module = Project
@@ -278,3 +280,16 @@ fun Module.setupSourceSets(generatedResources: String) {
         resources.srcDir(generatedResources)
     }
 }
+
+/**
+ * Configures documentation publishing for this subproject.
+ */
+fun Module.setupDocPublishing() {
+    updateGitHubPages {
+        rootFolder.set(rootDir)
+    }
+
+    tasks.named("publish") {
+        dependsOn("${project.path}:updateGitHubPages")
+    }
+}

comparable/src/main/kotlin/io/spine/tools/core/jvm/comparable/ComparableMessageDiscovery.kt

@@ -28,23 +28,23 @@ package io.spine.tools.core.jvm.comparable
 
 import io.spine.core.External
 import io.spine.option.CompareByOption
-import io.spine.tools.compiler.ast.event.TypeDiscovered
-import io.spine.tools.compiler.ast.find
-import io.spine.tools.compiler.plugin.Policy
-import io.spine.tools.compiler.settings.loadSettings
 import io.spine.server.event.NoReaction
 import io.spine.server.event.React
 import io.spine.server.tuple.EitherOf2
 import io.spine.server.tuple.EitherOf2.withA
 import io.spine.server.tuple.EitherOf2.withB
+import io.spine.tools.compiler.ast.event.TypeDiscovered
+import io.spine.tools.compiler.ast.find
+import io.spine.tools.compiler.plugin.Reaction
+import io.spine.tools.compiler.settings.loadSettings
 import io.spine.tools.core.jvm.comparable.event.ComparableMessageDiscovered
 import io.spine.tools.core.jvm.comparable.event.comparableMessageDiscovered
 import io.spine.tools.core.jvm.settings.Comparables
 
 /**
  * Discovers comparable messages.
  */
-internal class ComparableMessageDiscovery : Policy<TypeDiscovered>(), ComparableComponent {
+internal class ComparableMessageDiscovery : Reaction<TypeDiscovered>(), ComparableComponent {
 
     private val settings: Comparables by lazy { loadSettings() }
 

comparable/src/main/kotlin/io/spine/tools/core/jvm/comparable/ComparablePlugin.kt

@@ -36,7 +36,7 @@ import io.spine.tools.compiler.plugin.Plugin
  * [ComparableSettings][io.spine.tools.core.jvm.gradle.settings.ComparableSettings].
  */
 public class ComparablePlugin : Plugin(
-    policies = setOf(ComparableMessageDiscovery()),
+    reactions = setOf(ComparableMessageDiscovery()),
     views = setOf(ComparableMessageView::class.java),
     renderers = listOf(ComparableActionsRenderer())
 ) {