Mix RUNTIME and BUILDTIME configs?

[HerrDerb]

I have following config keys:

acme.fileshare.%named%.enabled 
acme.fileshare.%named%.url
acme.fileshare.%named%.max-quota

I would like to fix enabled and url at build time but would like to leave max-quota to be runtime initialized for easy adjustment.

This means that I would have to split this up into two config files:

@ConfigMapping(prefix = "acme.fileshare")
@ConfigRoot(phase = ConfigPhase.BUILD_TIME)
interface ShareConfigBuildTime {

    @WithParentName
    Map<String, ShareConfigBuildTime> shares;

    interface ShareConfigBuildTime{

        boolean enabled();

        String url();

    }
}

and

@ConfigMapping(prefix = "acme.fileshare")
@ConfigRoot(phase = ConfigPhase.RUN_TIME)
interface ShareConfigRuntime {

    @WithParentName
    Map<String, ShareConfigRuntime> shares;

    interface ShareConfigRuntime{

        int maxQuota();

    }
}

This will give me an exception on runtime config as enabled is not mapped.

Is there a already built in way to handle a requirement like this?

[quarkus-bot[bot]]

/cc @radcortez (config)

[radcortez]

Yes.

Use a SmallRyeConfigBuilderCustomizer https://smallrye.io/smallrye-config/Latest/config/customizer/

And set io.smallrye.config.SmallRyeConfigBuilder#withMappingIgnore with acme.fileshare

For instance, check:

quarkus/core/runtime/src/main/java/io/quarkus/runtime/configuration/QuarkusConfigBuilderCustomizer.java

Lines 137 to 138 in 88c46b4

	// Ignore unmapped quarkus properties, because properties in the same root may be split between build / runtime
	builder.withMappingIgnore("quarkus.**");

[HerrDerb]

Thanks. From what I understand, this just turns off the runtime check for property names, so it won’t alert me if I forget to declare a required property or if I misspell one, is that correct?

[radcortez]

No, this disables Smallrye checks, but Quarkus checks are still in place.

SmallRye does not know config phases (it is a Quarkus only thing), so it tries to validate and fails. We still have Quarkus config validations for these cases.