"Partial matching" for @ConfigMapping

[famod]

Hi all (mainly @radcortez I guess)!

Is there any way to map a config structure like:

provider:
  providerA:
    connector:
      client-endpoint-url: http://providerA
      client-cert:
        key-alias: providerA
        key-password: ****
    schedule:
      foo: "bar"
  providerB:
    connector:
      client-endpoint-url: http://providerB
      client-cert:
        key-alias: providerB
        key-password: ****
    schedule:
      foo: "baz"

to a @ConfigMapping that only contains a subset of properties, e,g,:

@ConfigMapping(prefix = "provider")
public interface ProviderConfig {

    Map<String, ConnectorConfig> connector();

    interface ConnectorConfig {
        KeystoreKeyReferenceProperties clientCert();
    }
}

but without switching off any global validation?

The first naive approach resulted in:

Caused by: io.smallrye.config.ConfigValidationException: Configuration validation failed:
	provider.providerA.schedule.foo does not map to any root
	provider.providerB.schedule.foo does not map to any root

I don't want to map the schedules because those are referenced separately via @Scheduled.

Please note that the list of "providers" should be as dynamic as possible, hence the Map.

Could I alternatively get ConnectorConfig programmatically? I suppose not?

Thanks!

[famod]

Btw, I just realized that there is a mistake in my mapping (which I only realized after setting -Dsmallrye.config.mapping.validate-unknown=false, which I'm trying to avoid in the first place).

The correct mapping is:

@ConfigMapping(prefix = "provider")
public interface ProvidersConfig {

    @WithParentName
    Map<String, ProviderConfig> providers();

    interface ProviderConfig {
        ConnectorConfig connector();
    }

    interface ConnectorConfig {
        KeystoreKeyReferenceProperties clientCert();
    }
}

[famod]

If resorting to smallrye.config.mapping.validate-unknown, does this affect quarkus.*? If so this would be rather dangerous, no?

[radcortez]

No it doesn't.

[radcortez]

At this time, there is no way to provide partial mappings. The mappings start from a provided namespace (or subnamespace - the prefix) and expect all properties found to be mapped or a validation exception occurs (you can disable it like you are doing with smallrye.config.mapping.validate-unknown).

There is also no way at the moment to retrieve subtrees of the mapping.

Is it a big issue to map schedule even if is not going to be used? The added benefit is that it will validate that the config is there, except if it is optional, and in that case you can use Optional.

[famod]

Thanks! Can you envision an enhancement here, e.g. switching off the validation via another annotation that can be added to mapping class? Maybe even with some kind of "property pattern"?

I have 12(!) schedules (cron expressions) per provider. So yes, adding those just for the sake of completeness is an issue for me.
I do verify those schedule properties on my own in a QuarkusTest and if the scheduler is active, it's also validating the presence at runtime of the app.

[radcortez]

We can probably add a validation per mapping class so it is more fine-grained. Feel free to open an issue in SR Config :)