-
|
Hey folks, I have a fairly small Quarkus application with some custom configuration interfaces as described in Mapping configuration to objects. While the Example: @ConfigMapping(prefix = "jobs")
public interface JobsConfig {
@NotNull
@DurationMin(minutes = 1L)
@WithDefault("PT5M")
Duration runInterval();
}Without In this case, the configuration property is being used in a scheduled job: @ApplicationScoped
public class MyScheduledJob {
@Scheduled(every = "${jobs.run-interval}")
Uni<Void> runScheduledJob() {
// ...
}
}Any hints how to start debugging this?
|
Beta Was this translation helpful? Give feedback.
Replies: 3 comments 15 replies
-
|
/cc @radcortez (config) |
Beta Was this translation helpful? Give feedback.
-
|
Because the mapping is not used anywhere (other than as a weak reference for an expanded default), Quarkus thinks it is not required and removed it from the final application. In this case, annotate the mapping with |
Beta Was this translation helpful? Give feedback.
-
Based on a fresh project created on code.quarkus.io with Gradle using the Kotlin DSL (since this is also what I am using): Download
package org.acme;
import io.quarkus.arc.Unremovable;
import io.smallrye.config.ConfigMapping;
import jakarta.validation.constraints.Max;
@ConfigMapping(prefix = "application")
@Unremovable
public interface ApplicationConfig {
@Max(10000)
int port();
}
package org.acme;
import io.quarkus.runtime.Startup;
import jakarta.annotation.PostConstruct;
import jakarta.enterprise.context.ApplicationScoped;
import org.eclipse.microprofile.config.inject.ConfigProperty;
import org.jboss.logging.Logger;
@Startup
@ApplicationScoped
public class AppScopedStartup {
private static final Logger LOG = Logger.getLogger(AppScopedStartup.class);
private final int port;
public AppScopedStartup(@ConfigProperty(name = "application.port") int port) {
this.port = port;
}
@PostConstruct
void postConstruct() {
// This shouldn't happen if the configuration was validated
if (port > 10000) {
throw new RuntimeException("NOOOOOOO! Value: " + port);
}
LOG.info("Value: " + port);
}
}
application.port=20000Test run: |
Beta Was this translation helpful? Give feedback.
-
|
Yes, validation is only executed if the mapping is accessed (via injection, or programmatically). Maybe that is something we need to improve in the case where validation annotations are combined with If I remember correctly, we did it that way because we didn't have the validator available when we started the config instance, but we made some improvements in that area @gsmet remember? Config has its own separate ready-to-use validator, so we can probably improve its behaviour. |
Beta Was this translation helpful? Give feedback.
-
|
@radcortez Can I somehow force the validation on my configuration beans as a workaround? They're all required and not optional. |
Beta Was this translation helpful? Give feedback.
-
|
Yes, do it like this: @Startup
@ApplicationScoped
public class AppScopedStartup {
@Inject
ApplicationConfig applicationConfig;
@PostConstruct
void postConstruct() {
// This shouldn't happen if the configuration was validated
if (applicationConfig.port() > 10000) {
throw new RuntimeException("NOOOOOOO! Value: " + applicationConfig.port());
}
}
}If you inject the mappings, the validation is triggered, and you don't even need the BTW, if you have a mapping, you might as well just use it instead of injecting |
Beta Was this translation helpful? Give feedback.
-
|
Awesome, that works. Thanks! 😄 |
Beta Was this translation helpful? Give feedback.
-
|
@radcortez should we add a note in the documentation? I suppose we have a section about config validation? |
Beta Was this translation helpful? Give feedback.
-
|
A small section :) What is your idea? To note that you need |
Beta Was this translation helpful? Give feedback.
-
|
how do i test this with Junit ? I was thinking if the configuration is missing, Quarkus should not start because of configuration validation, but this does not work as expected |
Beta Was this translation helpful? Give feedback.
-
|
Hi @radcortez ! I guess there were several misunderstandings from my side :
So for now I gave up on testing that app crashes when mandatory configuration is not present. |
Beta Was this translation helpful? Give feedback.
-
No. Config is always overridden.
Yes, this is the way to do it.
Yes, because the validation prevents Quarkus from starting. You can do it like we do here: These use internal APIs, which are subject to change without warning. Also, they are not intended to be used by applications directly. I did try in an app, and it works as you would expect. The proper way to do it is to create an extension. |
Beta Was this translation helpful? Give feedback.
Yes, do it like this:
If you inject the mappings, the validation is triggered, and you don't even need the
@Unremoveableannotation.BTW, if you have a mapping, you might as well just use it instead of injecting
@ConfigProperty(name = "application.port") int port