Questions about profile aware files

[TopSecretAtWork]

Hello Everyone,

We have a question about the profile aware property files. We do have separate files for different environments (prod, staging, local, ...) and we activate the different profiles in their corresponding environments.

From our point of view, we have some strange behavior when running the application from the command line and we wanted to ask if someone could clarify that with us. We have created a small repo to reproduce that behavior.

About the setup:

• openjdk 17.0.3
• mvn 3.8.1
• Quarkus 2.8.2.Final

application-common.properties:

##################################################################################
#                                     COMMON                                     #
##################################################################################


##### INTERVAL #####
send.interval.in.sec=30

application-staging.properties:

##################################################################################
#                                    STAGING                                     #
##################################################################################

##### PARENT #####
quarkus.config.profile.parent=common



##### SERVICES #####
services.test.SERVICE1=http://localhost:8080/health

application-prod.properties

##################################################################################
#                                      PROD                                      #
##################################################################################

##### PARENT #####
quarkus.config.profile.parent=common



##### SERVICES #####
services.test.SERVICE1=http://localhost:8080/health
services.test.SERVICE2=http://localhost:8081/health
services.test.SERVICE3=http://localhost:8082/health


value.in.prod.only=true

When we start the application with the staging profilein our IDE (IntelliJ) everything works as we would expect it. Only the SERVICE1 value is loaded and with the prod profile, all three services are loaded.

When we package and start the application via the CLI in both profiles (staging and prod) all three service values are loaded. It seems that quarkus loads the prod properties, regardless of which profile was passed, and provides those values via a io.smallrye.config.PropertiesConfigSource named PropertiesConfigSource[source=Specified default values].

Here is the log output when we run the sample project with -Dquarkus.profile=staging from the command line

2022-05-03 10:50:12,537 INFO  [com.tes.con.con.use.Startup] (main) Config property names: '[services.test.SERVICE1, services.test.SERVICE2, services.test.SERVICE3]'
2022-05-03 10:50:12,537 INFO  [com.tes.con.con.use.Startup] (main) name: 'services.test.SERVICE1' -> value: 'http://localhost:8080/health'; (source: ConfigValue{name='services.test.SERVICE1', value='http://localhost:8080/health', rawValue='http://localhost:8080/health', profile='null', configSourceName='PropertiesConfigSource[source=jar:file:/tmp/quarkus-app/app/configtest-main-0.1.0-SNAPSHOT.jar!/application-staging.properties]', configSourceOrdinal=253, configSourcePosition=3, lineNumber=-1})
2022-05-03 10:50:12,538 INFO  [com.tes.con.con.use.Startup] (main) name: 'services.test.SERVICE2' -> value: 'http://localhost:8081/health'; (source: ConfigValue{name='services.test.SERVICE2', value='http://localhost:8081/health', rawValue='http://localhost:8081/health', profile='null', configSourceName='PropertiesConfigSource[source=Specified default values]', configSourceOrdinal=-2147483548, configSourcePosition=7, lineNumber=-1})
2022-05-03 10:50:12,538 INFO  [com.tes.con.con.use.Startup] (main) name: 'services.test.SERVICE3' -> value: 'http://localhost:8082/health'; (source: ConfigValue{name='services.test.SERVICE3', value='http://localhost:8082/health', rawValue='http://localhost:8082/health', profile='null', configSourceName='PropertiesConfigSource[source=Specified default values]', configSourceOrdinal=-2147483548, configSourcePosition=7, lineNumber=-1})
2022-05-03 10:50:12,538 INFO  [com.tes.con.con.use.Startup] (main) Config profiles: [staging, common, common]
2022-05-03 10:50:12,539 INFO  [com.tes.con.con.use.Startup] (main) Default config source (class: class io.smallrye.config.PropertiesConfigSource): {value.in.prod.only=true, send.interval.in.sec=30, quarkus.config.profile.parent=common, services.test.SERVICE1=http://localhost:8080/health, services.test.SERVICE2=http://localhost:8081/health, services.test.SERVICE3=http://localhost:8082/health}

We can see that the SERVICE1 value is loaded from the application-staging.properties file and the other two values are loaded from the default PropertiesConfigSource. The last log entry shows the default source, which is coming from the application-prod.properties file.

And here is now the log output when we run the sample project with -Dquarkus.profile=prod from the command line

2022-05-03 10:56:05,750 INFO  [com.tes.con.con.use.Startup] (main) Config property names: '[services.test.SERVICE1, services.test.SERVICE2, services.test.SERVICE3]'
2022-05-03 10:56:05,750 INFO  [com.tes.con.con.use.Startup] (main) name: 'services.test.SERVICE1' -> value: 'http://localhost:8080/health'; (source: ConfigValue{name='services.test.SERVICE1', value='http://localhost:8080/health', rawValue='http://localhost:8080/health', profile='null', configSourceName='PropertiesConfigSource[source=jar:file:/tmp/quarkus-app/app/configtest-main-0.1.0-SNAPSHOT.jar!/application-prod.properties]', configSourceOrdinal=253, configSourcePosition=3, lineNumber=-1})
2022-05-03 10:56:05,751 INFO  [com.tes.con.con.use.Startup] (main) name: 'services.test.SERVICE2' -> value: 'http://localhost:8081/health'; (source: ConfigValue{name='services.test.SERVICE2', value='http://localhost:8081/health', rawValue='http://localhost:8081/health', profile='null', configSourceName='PropertiesConfigSource[source=jar:file:/tmp/quarkus-app/app/configtest-main-0.1.0-SNAPSHOT.jar!/application-prod.properties]', configSourceOrdinal=253, configSourcePosition=3, lineNumber=-1})
2022-05-03 10:56:05,751 INFO  [com.tes.con.con.use.Startup] (main) name: 'services.test.SERVICE3' -> value: 'http://localhost:8082/health'; (source: ConfigValue{name='services.test.SERVICE3', value='http://localhost:8082/health', rawValue='http://localhost:8082/health', profile='null', configSourceName='PropertiesConfigSource[source=jar:file:/tmp/quarkus-app/app/configtest-main-0.1.0-SNAPSHOT.jar!/application-prod.properties]', configSourceOrdinal=253, configSourcePosition=3, lineNumber=-1})
2022-05-03 10:56:05,751 INFO  [com.tes.con.con.use.Startup] (main) Config profiles: [prod, common, common]
2022-05-03 10:56:05,752 INFO  [com.tes.con.con.use.Startup] (main) Default config source (class: class io.smallrye.config.PropertiesConfigSource): {value.in.prod.only=true, send.interval.in.sec=30, quarkus.config.profile.parent=common, services.test.SERVICE1=http://localhost:8080/health, services.test.SERVICE2=http://localhost:8081/health, services.test.SERVICE3=http://localhost:8082/health}

Now all values, as expected, are loaded from the application-prod.properties file.

We would expect that in the case of the staging profile we just load the SERVICE1 value and not all of them. As mentioned before this does not happen when we start the application through the IDE, in this case, the default source is just empty as shown below

2022-05-03 10:58:56,320 INFO  [com.tes.con.con.use.Startup] (Quarkus Main Thread) Config property names: '[services.test.SERVICE1]'
2022-05-03 10:58:56,321 INFO  [com.tes.con.con.use.Startup] (Quarkus Main Thread) name: 'services.test.SERVICE1' -> value: 'http://localhost:8080/health'; (source: ConfigValue{name='services.test.SERVICE1', value='http://localhost:8080/health', rawValue='http://localhost:8080/health', profile='null', configSourceName='PropertiesConfigSource[source=file:/home/pwanko/NTS/DEV/Code/shitfuck/configtest/configtest-main/target/classes/application-staging.properties]', configSourceOrdinal=253, configSourcePosition=4, lineNumber=-1})
2022-05-03 10:58:56,321 INFO  [com.tes.con.con.use.Startup] (Quarkus Main Thread) Config profiles: [staging, common, common]
2022-05-03 10:58:56,322 INFO  [com.tes.con.con.use.Startup] (Quarkus Main Thread) Default config source (class: class io.smallrye.config.PropertiesConfigSource): {}

We tried to debug this but all we could find so far was that the default PropertiesConfigSource with the default values is passed to the method public SmallRyeConfigBuilder withSources(ConfigSource... configSources) in the class io.smallrye.config.SmallRyeConfigBuilder. The calls before seem to be generated and we weren't able to debug them, so we don't know exactly how and when the default properties are loaded. Maybe someone can point us in the right direction, please?

The current "workaround" is to keep the application.properties file empty and to rename the application-prod.properties file (e.g.: to application-live.properties). But we do not know for sure if our setup here is completely wrong or if this is a bug.

So we wanted to ask the community if someone could tell us please if this is working as designed and our setup is wrong or if this is a bug?

Kind Regards
Philipp

[radcortez]

Hi Philipp,

Yes, this is expected and working as intended. I know it can be a little confusing. Let me explain.

The Quarkus application is built with the prod profile, and we record the configuration values in a minimal ordinal ConfigSource. This action intends to prevent the application startup from failing because the configuration required during the build may be absent from runtime. Another reason is to remove the file reading from the native image binary.

So, in this case, because you have more configuration set up for the prod profile (service 2 and service 3), when you activate the staging, which only contains service 1, you will still see service 2 and 3. You also noticed that the values are coming from 'PropertiesConfigSource[source=Specified default values]', configSourceOrdinal=-2147483548, where we record the values during the build.

My recommendation is to just empty the values in the staging profile like this:

##### SERVICES #####
services.test.SERVICE1=http://localhost:8080/health
services.test.SERVICE2=
services.test.SERVICE3=

This will override the recorded prod values and remove the configuration.

Another option is to use quarkus.config.locations as a system property or environment variable and point to an additional config file or folder that is only available during runtime (so the values are not recorded).

I hope this makes sense.

[TopSecretAtWork]

Hi Roberto,

thank you very much for the answer and the explanation.
I understand now, how this works.

For now we had a "workaround" based on your second suggestion. We moved the services in a separate profile aware file and removed them from the prod profile and just loaded the other profile with -Dquarkus.profile

We will change our current solution to your second suggestion and will provide those values with quarkus.config.locations.
Thank you again for your help.

Kind Regards
Philipp