Development: Add Helios push based lifecycle monitoring with manual DB migration status events (#10873)

Author: egekocabas

build.gradle

@@ -365,6 +365,9 @@ dependencies {
     implementation "org.springframework.security:spring-security-messaging:${spring_security_version}"
     implementation "org.springframework.security:spring-security-ldap:${spring_security_version}"
 
+    // Helios push-based status updates
+    implementation "de.tum.cit.aet:helios-status-spring-starter:${helios_status_version}"
+
     implementation "org.opensaml:opensaml-saml-api:${opensaml_version}"
     implementation "org.opensaml:opensaml-saml-impl:${opensaml_version}"
 

gradle.properties

@@ -37,6 +37,7 @@ netty_version=4.1.118.Final
 mysql_version=9.3.0
 micrometer_version=1.15.1
 snakeyaml_version=2.4
+helios_status_version=1.1.0
 
 # testing
 # make sure both versions are compatible

src/main/java/de/tum/cit/aet/artemis/core/config/LiquibaseConfiguration.java

@@ -4,6 +4,7 @@
 import static tech.jhipster.config.JHipsterConstants.SPRING_PROFILE_TEST;
 
 import java.sql.SQLException;
+import java.util.Optional;
 
 import javax.sql.DataSource;
 
@@ -24,6 +25,7 @@
 import org.springframework.core.env.Profiles;
 
 import de.tum.cit.aet.artemis.core.config.migration.DatabaseMigration;
+import de.tum.cit.aet.helios.HeliosClient;
 import liquibase.Scope;
 import liquibase.SingletonScopeManager;
 import liquibase.integration.spring.SpringLiquibase;
@@ -41,15 +43,18 @@ public class LiquibaseConfiguration {
 
     private final BuildProperties buildProperties;
 
+    private final Optional<HeliosClient> optionalHeliosClient;
+
     private DataSource dataSource;
 
     private DatabaseMigration databaseMigration;
 
     private String currentVersionString;
 
-    public LiquibaseConfiguration(Environment env, BuildProperties buildProperties) {
+    public LiquibaseConfiguration(Environment env, BuildProperties buildProperties, Optional<HeliosClient> optionalHeliosClient) {
         this.env = env;
         this.buildProperties = buildProperties;
+        this.optionalHeliosClient = optionalHeliosClient;
     }
 
     /**
@@ -69,7 +74,7 @@ public SpringLiquibase liquibase(@LiquibaseDataSource ObjectProvider<DataSource>
         this.currentVersionString = buildProperties.getVersion();
 
         if (!env.acceptsProfiles(Profiles.of(SPRING_PROFILE_TEST))) {
-            this.databaseMigration = new DatabaseMigration(currentVersionString, dataSource);
+            this.databaseMigration = new DatabaseMigration(currentVersionString, dataSource, optionalHeliosClient);
             databaseMigration.checkMigrationPath();
         }
 
@@ -133,9 +138,11 @@ public void storeCurrentVersionToDatabase(ApplicationReadyEvent event) {
 
             preparedStatement.executeUpdate();
             connection.commit(); // Ensure the transaction is committed.
+            optionalHeliosClient.ifPresent(HeliosClient::pushDbMigrationFinished);
         }
         catch (SQLException e) {
             log.error("Failed to store the current version to the database", e);
+            optionalHeliosClient.ifPresent(HeliosClient::pushDbMigrationFailed);
             throw new RuntimeException("Error updating the application version in the database", e);
         }
     }

src/main/java/de/tum/cit/aet/artemis/core/config/migration/DatabaseMigration.java

@@ -4,6 +4,7 @@
 import java.sql.Statement;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 
 import javax.sql.DataSource;
 
@@ -13,6 +14,8 @@
 
 import com.vdurmont.semver4j.Semver;
 
+import de.tum.cit.aet.helios.HeliosClient;
+
 /**
  * Represents a migration path that defines the necessary steps for database migration before
  * updating to a new major version. This class is pivotal in ensuring that administrators install
@@ -93,9 +96,12 @@ public class DatabaseMigration {
 
     private String previousVersionString;
 
-    public DatabaseMigration(String currentVersionString, DataSource dataSource) {
+    private final Optional<HeliosClient> optionalHeliosClient;
+
+    public DatabaseMigration(String currentVersionString, DataSource dataSource, Optional<HeliosClient> optionalHeliosClient) {
         this.currentVersionString = currentVersionString;
         this.dataSource = dataSource;
+        this.optionalHeliosClient = optionalHeliosClient;
 
         // Initialize migration paths here in the correct order
         migrationPaths.add(new MigrationPath("5.12.9")); // required for migration to 6.0.0 until 7.0.0
@@ -120,6 +126,7 @@ public void checkMigrationPath() {
 
         if (previousVersionString == null) {
             log.info("Migration path check: Not necessary");
+            optionalHeliosClient.ifPresent(HeliosClient::pushDbMigrationStarted);
             return;
         }
 
@@ -129,6 +136,7 @@ public void checkMigrationPath() {
             if (currentVersion.isGreaterThanOrEqualTo(path.upgradeVersion) && currentVersion.isLowerThan(path.nextUpgradeVersion)) {
                 if (previousVersion.isLowerThan(path.requiredVersion)) {
                     log.error(path.errorMessage);
+                    optionalHeliosClient.ifPresent(HeliosClient::pushDbMigrationFailed);
                     System.exit(15);
                 }
                 else if (previousVersion.isEqualTo(path.requiredVersion)) {
@@ -138,6 +146,8 @@ else if (previousVersion.isEqualTo(path.requiredVersion)) {
                 }
             }
         }
+
+        optionalHeliosClient.ifPresent(HeliosClient::pushDbMigrationStarted);
     }
 
     /**
@@ -234,6 +244,7 @@ private void updateInitialChecksum(String newVersion) {
         }
         catch (SQLException e) {
             log.error("Cannot update checksum for initial schema migration: {}", e.getMessage());
+            optionalHeliosClient.ifPresent(HeliosClient::pushDbMigrationFailed);
             System.exit(11);
         }
     }
@@ -262,6 +273,7 @@ private Statement createStatement() throws SQLException {
         }
         catch (Exception e) {
             log.error("Cannot connect to the database {} (This typically indicates that the database is not running or there are permission issues", e.getMessage());
+            optionalHeliosClient.ifPresent(HeliosClient::pushDbMigrationFailed);
             System.exit(10);
         }
         return null;

src/main/resources/config/application-buildagent.yml

@@ -107,3 +107,7 @@ management:
 eureka:
    client:
         enabled: true
+
+helios:
+  status:
+    enabled: false

src/main/resources/config/application-dev.yml

@@ -134,3 +134,7 @@ artemis:
         enabled: false # Disable sending any telemetry information to the telemetry service by setting this to false
         sendAdminDetails: false # Include the admins email and name in the telemetry data. Set to false to disable
         destination: https://telemetry.artemis.cit.tum.de
+
+helios:
+  status:
+    enabled: false

src/main/resources/config/application.yml

@@ -370,3 +370,10 @@ eureka:
             git-version: ${git.commit.id.describe:}
             git-commit: ${git.commit.id.abbrev:}
             git-branch: ${git.branch:}
+
+# Helios configuration
+# It is enabled and all the values are set by the ansible
+# Refer to the ansible repository https://github.com/ls1intum/artemis-ansible
+helios:
+  status:
+    enabled: false