Fixing Architecture: from @ConditionalOnProperty to @conditional

Author: Michael Breu

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

@@ -5,6 +5,7 @@
 import static de.tum.cit.aet.artemis.core.config.Constants.HYPERION_ENABLED_PROPERTY_NAME;
 import static de.tum.cit.aet.artemis.core.config.Constants.NEBULA_ENABLED_PROPERTY_NAME;
 import static de.tum.cit.aet.artemis.core.config.Constants.PASSKEY_ENABLED_PROPERTY_NAME;
+import static de.tum.cit.aet.artemis.core.config.Constants.SHARING_ENABLED_PROPERTY_NAME;
 
 import org.springframework.core.env.Environment;
 
@@ -25,6 +26,16 @@ public boolean isPasskeyEnabled(Environment environment) {
         return getPropertyOrExitArtemis(PASSKEY_ENABLED_PROPERTY_NAME, environment);
     }
 
+    /**
+     * Check if the Sharing feature is enabled.
+     *
+     * @param environment the Spring environment
+     * @return true if the Sjaromg feature is enabled, false otherwise
+     */
+    public boolean isSharingEnabled(Environment environment) {
+        return getPropertyOrExitArtemis(SHARING_ENABLED_PROPERTY_NAME, environment);
+    }
+
     /**
      * Check if the Atlas module is enabled.
      *

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

@@ -460,6 +460,11 @@ public final class Constants {
      */
     public static final String PASSKEY_ENABLED_PROPERTY_NAME = "artemis.user-management.passkey.enabled";
 
+    /**
+     * The name of the property used to enable or disable the passkey authentication functionality.
+     */
+    public static final String SHARING_ENABLED_PROPERTY_NAME = "artemis.sharing.enabled";
+
     /**
      * The name of the property used to enable or disable nebula functionalities.
      */

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

@@ -10,7 +10,6 @@
 
 import jakarta.validation.constraints.NotNull;
 
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Configuration;
@@ -28,6 +27,7 @@
 import de.tum.cit.aet.artemis.iris.config.PyrisAuthorizationInterceptor;
 import de.tum.cit.aet.artemis.nebula.config.NebulaEnabled;
 import de.tum.cit.aet.artemis.programming.service.jenkins.JenkinsAuthorizationInterceptor;
+import de.tum.cit.aet.artemis.programming.service.sharing.SharingEnabled;
 
 /**
  * For now only provides a basic {@link org.springframework.web.client.RestTemplate RestTemplate} bean. Can be extended
@@ -72,10 +72,7 @@ public RestTemplate apollonRestTemplate() {
      * @return a RestTemplate with short timeouts for sharing platform integration
      */
     @Bean
-    @ConditionalOnProperty(name = "artemis.sharing.enabled",   // property key
-            havingValue = "true",              // required value
-            matchIfMissing = false             // default behavior if property is absent
-    )
+    @Conditional(SharingEnabled.class)
     public RestTemplate sharingRestTemplate() {
         return createShortTimeoutRestTemplate();
     }

src/main/java/de/tum/cit/aet/artemis/core/web/SharingSupportResource.java

@@ -9,7 +9,7 @@
 import org.codeability.sharing.plugins.api.SharingPluginConfig;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Lazy;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -20,13 +20,14 @@
 import org.springframework.web.bind.annotation.RestController;
 
 import de.tum.cit.aet.artemis.programming.service.sharing.SharingConnectorService;
+import de.tum.cit.aet.artemis.programming.service.sharing.SharingEnabled;
 
 /**
  * REST controller for the exchange of configuration data between artemis and the sharing platform.
  */
 @RestController
 @RequestMapping("api/core/sharing/")
-@ConditionalOnProperty(name = "artemis.sharing.enabled", havingValue = "true", matchIfMissing = false)
+@Conditional(SharingEnabled.class)
 @Lazy
 public class SharingSupportResource {
 

src/main/java/de/tum/cit/aet/artemis/programming/service/sharing/ExerciseSharingService.java

@@ -42,7 +42,7 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.beans.factory.annotation.Value;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Lazy;
 import org.springframework.core.io.Resource;
 import org.springframework.stereotype.Service;
@@ -67,7 +67,7 @@
  * service for sharing exercises via the sharing platform.
  */
 @Service
-@ConditionalOnProperty(name = "artemis.sharing.enabled", havingValue = "true", matchIfMissing = false)
+@Conditional(SharingEnabled.class)
 @Lazy
 public class ExerciseSharingService {
 

src/main/java/de/tum/cit/aet/artemis/programming/service/sharing/ProgrammingExerciseImportFromSharingService.java

@@ -4,7 +4,7 @@
 import java.net.URISyntaxException;
 
 import org.eclipse.jgit.api.errors.GitAPIException;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Lazy;
 import org.springframework.stereotype.Service;
 
@@ -14,7 +14,7 @@
 import de.tum.cit.aet.artemis.programming.service.ProgrammingExerciseImportFromFileService;
 
 @Service
-@ConditionalOnProperty(name = "artemis.sharing.enabled", havingValue = "true", matchIfMissing = false)
+@Conditional(SharingEnabled.class)
 @Lazy
 public class ProgrammingExerciseImportFromSharingService {
 

src/main/java/de/tum/cit/aet/artemis/programming/service/sharing/SharingConnectorService.java

@@ -17,7 +17,7 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.beans.factory.annotation.Value;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Lazy;
 import org.springframework.scheduling.TaskScheduler;
 import org.springframework.stereotype.Service;
@@ -30,7 +30,7 @@
  * @see <a href="https://sharing-codeability.uibk.ac.at/sharing/codeability-sharing-platform/-/wikis/technical/Plugin-Interface">Plugin Tutorial</a>
  */
 @Service
-@ConditionalOnProperty(name = "artemis.sharing.enabled", havingValue = "true", matchIfMissing = false)
+@Conditional(SharingEnabled.class)
 @Lazy
 public class SharingConnectorService {
 

src/main/java/de/tum/cit/aet/artemis/programming/service/sharing/SharingEnabled.java

@@ -0,0 +1,25 @@
+package de.tum.cit.aet.artemis.programming.service.sharing;
+
+import org.springframework.context.annotation.Condition;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.core.type.AnnotatedTypeMetadata;
+
+import de.tum.cit.aet.artemis.core.config.ArtemisConfigHelper;
+
+/**
+ * Condition to check if the Passkey feature is enabled.
+ * Based on this condition, Spring components concerning Passkey functionality can be enabled or disabled.
+ */
+public class SharingEnabled implements Condition {
+
+    private final ArtemisConfigHelper artemisConfigHelper;
+
+    public SharingEnabled() {
+        this.artemisConfigHelper = new ArtemisConfigHelper();
+    }
+
+    @Override
+    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
+        return artemisConfigHelper.isSharingEnabled(context.getEnvironment());
+    }
+}

src/main/java/de/tum/cit/aet/artemis/programming/service/sharing/SharingHealthIndicator.java

@@ -1,5 +1,7 @@
 package de.tum.cit.aet.artemis.programming.service.sharing;
 
+import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE;
+
 import java.time.Instant;
 import java.time.ZoneId;
 import java.time.ZonedDateTime;
@@ -8,31 +10,29 @@
 import java.util.Optional;
 
 import org.apache.commons.collections4.list.UnmodifiableList;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.actuate.health.Health;
 import org.springframework.boot.actuate.health.HealthIndicator;
 import org.springframework.context.annotation.Lazy;
+import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 
 /**
  * Health indicator that shows the status of the Sharing Platform connector.
  */
 @Component
+@Profile({ PROFILE_CORE })
 @Lazy
 public class SharingHealthIndicator implements HealthIndicator {
 
     private static final ZoneId UTC = ZoneId.of("UTC");
 
     private static final DateTimeFormatter TIME_STAMP_FORMATTER = DateTimeFormatter.ofPattern("dd.MM.yy HH:mm:ss");
 
-    private static final Logger log = LoggerFactory.getLogger(SharingHealthIndicator.class);
-
     @Value("${artemis.sharing.enabled:'undefined'}")
     private String sharingEnabled;
 
-    private Optional<SharingConnectorService> sharingConnectorService;
+    private final Optional<SharingConnectorService> sharingConnectorService;
 
     public SharingHealthIndicator(Optional<SharingConnectorService> sharingConnectorService) {
         this.sharingConnectorService = sharingConnectorService;

src/main/java/de/tum/cit/aet/artemis/programming/web/ExerciseSharingResource.java

@@ -18,7 +18,7 @@
 import org.eclipse.jgit.api.errors.GitAPIException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Lazy;
 import org.springframework.core.io.InputStreamResource;
 import org.springframework.core.io.Resource;
@@ -38,6 +38,7 @@
 import de.tum.cit.aet.artemis.programming.service.sharing.ExerciseSharingService;
 import de.tum.cit.aet.artemis.programming.service.sharing.ProgrammingExerciseImportFromSharingService;
 import de.tum.cit.aet.artemis.programming.service.sharing.SharingConnectorService;
+import de.tum.cit.aet.artemis.programming.service.sharing.SharingEnabled;
 import de.tum.cit.aet.artemis.programming.service.sharing.SharingException;
 import de.tum.cit.aet.artemis.programming.service.sharing.SharingSetupInfo;
 import tech.jhipster.web.util.ResponseUtil;
@@ -47,7 +48,7 @@
  */
 @RestController
 @RequestMapping("api/programming/sharing/")
-@ConditionalOnProperty(name = "artemis.sharing.enabled", havingValue = "true", matchIfMissing = false)
+@Conditional(SharingEnabled.class)
 @Lazy
 public class ExerciseSharingResource {