`Development`: POC for improving Spring configuration via properties/profiles #10336

ole-ve · 2025-02-15T16:53:30Z

This PR acts as a POC outlining approaches on how to improve the Spring configuration.

Identified Problems:

Properties override are implicitly defined by the order of the profiles in the run config
Opt-out (default config is enabled) is not possible
Configuration for ADMIN- and USER-visible functionality are mixed across the config files

Proposed Solutions:

Don't (fully) rely on Spring Profiles, but rather evaluate conditions on (Spring) properties.
For "simpler" overrides (VCS or CI):

Provide admins with a set of "application.yml"-files for the respective functionality (Jenkins, Gitlab, etc.)
Admins have to copy-paste those values into the application.yml-file they place next to the packaged JAR before starting Artemis (passing via env-vars is also supported

For complex conditions: Instead of relying on overrides from other application.yml in a specific order, create/update/delete properties from the Spring Environment before Context Initialization (i.e., before dependency injection)
Guiding users with good documentation and (tested) config-examples to separate admin and user-visible config

See here for more details. If you don't have access, feel free to reach out to me.

…to determine existence of buildagent

…tions to determine existence of athena

…guration instead of a "raw" condition

…nto (logical) groups

… JAR

ole-ve · 2025-02-15T17:00:13Z

application.yml

@@ -0,0 +1,10 @@
+artemis:
+  athena:
+    enabled: false


this files is placed next to the packaged JAR and overrides the default config from application.yml-files within the packaged JAR

ole-ve · 2025-02-15T17:00:31Z

application.yml

+  version-control:
+    url: https://gitlab.artemis.cit.tum.de # assuming we are using GitLab and have a different URL (than localVC as default)
+
+info:


room for user-configs, explained in documentation

ole-ve · 2025-02-15T17:01:04Z

src/main/java/de/tum/cit/aet/artemis/ArtemisApp.java

+        new ConfigValidationPostProcessor().attachTo(app);
+        new PropertyOverridePostProcessor().attachTo(app);


registers listener after environment has been created, but before context initialization (beans etc.)

ole-ve · 2025-02-15T17:01:30Z

src/main/java/de/tum/cit/aet/artemis/athena/config/AthenaAuthorizationInterceptor.java

@@ -16,7 +14,7 @@
 import org.springframework.stereotype.Component;

 @Component
-@Profile(PROFILE_ATHENA)
+@ConditionalOnBean(AthenaConfiguration.class)


Instead of relying on the profile, we rely on the existence of the AthenaConfiguration (which checks the environment)

ole-ve · 2025-02-15T17:02:25Z

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

 /**
 * This class is necessary to avoid using Jersey (which has an issue deserializing Eureka responses) after the spring boot upgrade.
 * It provides the RestClientTransportClientFactories and RestClientDiscoveryClientOptionalArgs that would normally not be instantiated
 * when Jersey is found by Eureka.
 */
-@Profile({ PROFILE_CORE, PROFILE_BUILDAGENT })
+@Conditional(BuildAgentOrCoreCondition.class)


This is an interesting case: If we want to define more complex conditions based on profile AND/OR properties, we can do that with nested properties like BuildAgentOrCoreCondition

ole-ve · 2025-02-15T17:03:48Z

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

+ * This bridges the gap between the condition classes and the actual property values.
+ * WIP: make methods non-static
+ */
+public class ArtemisConfigHelper {


We might want to discuss whether we directly use this class in the respective Conditions or if we want to create a new layer of abstraction for when using from within the initialized spring context. (like ArtemisConfigServer with @service)

A reason could be to decouple application-logic from reading the properties and profiles. So we could also mock it and in general, have a clearer separation of concerns

ole-ve · 2025-02-15T17:04:30Z

src/main/resources/config/application.yml

@@ -117,7 +118,9 @@ artemis:
            short-name: "artemis-build-agent-1"
            display-name: "Artemis Build Agent 1"

-
+    version-control:


When removing the buildagent profile/yaml, we need to set those as defaults here

ole-ve · 2025-02-15T17:05:42Z

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

@@ -87,6 +87,7 @@ artemis:
    name: Artemis
    email: artemis@xcit.tum.de
  athena:
+    enabled: true


default is that athena is enabled, opt-out instead of opt-in

…wiring instead of AthenaConfiguration

ole-ve added 18 commits February 14, 2025 19:10

replace application-buildagent.yml with explicit override configuration

c0a621f

add missing configurations to application.yml

a238568

add example for validating config

c754a39

replace buildagent-profile with "artemis.mode" and custom conditions …

44bebaf

…to determine existence of buildagent

add example for further check

34fac79

cleanup conditions

fe08254

change location of condition files

97574d0

replace athena-profile with "artemis.athena.enabled" and custom condi…

e96f377

…tions to determine existence of athena

make buildagent and athena autowires conditional on a dedicated confi…

6b2a908

…guration instead of a "raw" condition

delete unused PROFILE_ATHENA from (server) constants

d1aca47

rename ConditionHelper to ArtemisConfigHelper

4214785

some notes

7120142

decouple property building from applying config and group overrides i…

56f8842

…nto (logical) groups

remove unused code

935f699

fix: only add enabled properties to configuration

6ec1642

minor improvements in AutoConfigurationExclusionOverrideGroup

34774af

add exemplary application.yml meant to be placed next to the packaged…

4cc0dc0

… JAR

add guided tour courseShortName to unpackaged application.yml

0b041fb

ole-ve self-assigned this Feb 15, 2025

ole-ve commented Feb 15, 2025

View reviewed changes

rename AthenaCondition to AthenaEnabled and use as condition for auto…

0e4fe7f

…wiring instead of AthenaConfiguration

ole-ve mentioned this pull request Feb 21, 2025

Development: Autowire Spring Atlas Components based on Spring properties instead of Spring profiles #10376

Open

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`Development`: POC for improving Spring configuration via properties/profiles #10336

`Development`: POC for improving Spring configuration via properties/profiles #10336

ole-ve commented Feb 15, 2025 •

edited

Loading

ole-ve Feb 15, 2025

ole-ve Feb 15, 2025

ole-ve Feb 15, 2025

ole-ve Feb 15, 2025

ole-ve Feb 15, 2025

ole-ve Feb 15, 2025 •

edited

Loading

ole-ve Feb 15, 2025

ole-ve Feb 15, 2025

		new ConfigValidationPostProcessor().attachTo(app);
		new PropertyOverridePostProcessor().attachTo(app);

Development: POC for improving Spring configuration via properties/profiles #10336

Are you sure you want to change the base?

Development: POC for improving Spring configuration via properties/profiles #10336

Conversation

ole-ve commented Feb 15, 2025 • edited Loading

ole-ve Feb 15, 2025

Choose a reason for hiding this comment

ole-ve Feb 15, 2025

Choose a reason for hiding this comment

ole-ve Feb 15, 2025

Choose a reason for hiding this comment

ole-ve Feb 15, 2025

Choose a reason for hiding this comment

ole-ve Feb 15, 2025

Choose a reason for hiding this comment

ole-ve Feb 15, 2025 • edited Loading

Choose a reason for hiding this comment

ole-ve Feb 15, 2025

Choose a reason for hiding this comment

ole-ve Feb 15, 2025

Choose a reason for hiding this comment

`Development`: POC for improving Spring configuration via properties/profiles #10336

`Development`: POC for improving Spring configuration via properties/profiles #10336

ole-ve commented Feb 15, 2025 •

edited

Loading

ole-ve Feb 15, 2025 •

edited

Loading