config: don't apply values that fail validation #29117
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a bug in config_store::read_yaml() where property values would be incorrectly applied even when custom validation failed. The fix ensures that invalid configuration values are rejected and properties retain their default values, matching the behavior for type conversion errors.
Key changes:
- Moved
set_value()call inside the else branch so values are only applied when validation succeeds - Added comprehensive test coverage for validation failure scenarios including optional properties, required properties, and throwing validators
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/v/config/config_store.h | Fixed validation logic to prevent setting values when custom validators fail |
| src/v/config/tests/config_store_test.cc | Added test fixtures and test cases for validation failure scenarios |
Comments suppressed due to low confidence (1)
src/v/config/tests/config_store_test.cc:16
- Two header includes were removed (#include <seastar/core/thread.hh> and #include ) but they may still be needed elsewhere in the file. Verify that these headers are truly unused throughout the entire file before removing them.
#include <seastar/testing/thread_test_case.hh>
nvartolomei
requested review from
BenPope,
dotnwat,
michael-redpanda,
mmaslankaprv and
rockwotj
Collaborator
Retry command for Build#78392please wait until all jobs are finished before running the slash command |
Collaborator
nvartolomei
force-pushed
the
nv/config-invalid-values
branch
from
dfed747 to
4b953f7
Compare
rockwotj
previously approved these changes
Dec 27, 2025
Contributor
rockwotj
left a comment
rockwotj
left a comment
There was a problem hiding this comment.
I am a little worried if there are people taking advantage of this validation being skipped in the config bootstrapping. I think doing the conservative thing is right here (And I think to answer your question about why the config system behaves in a certain way is because it was done very quickly).
Contributor
Author
|
todo for myself: add a test that shows that for bounded properties instead of ignoring the value we actually bound it and apply it. better backwards compat and sensible behavior. |
Test read_yaml behavior with validator errors, type mismatches, and throwing validators.
Previously, config_store::read_yaml() would apply property values even when custom validation failed, only recording the error. This meant invalid configuration values would silently take effect despite being reported as errors. This behavior was also inconsistent: conversion exceptions (e.g., YAML::BadConversion) correctly prevented values from being set, but custom validator errors did not. Fix by moving set_value() inside the else branch so values are only applied when validation succeeds. This has two effects: 1. Optional properties now correctly retain their default value when validation fails. 2. Required properties now correctly throw std::invalid_argument when validation fails. Previously, the throw logic was bypassed because ok was set to true even after validation errors. Note: It's unclear why we don't stop server startup on invalid optional config values. To avoid breaking something I don't fully understand, this change takes the conservative approach of retaining defaults.
nvartolomei
force-pushed
the
nv/config-invalid-values
branch
from
4b953f7 to
2edb60e
Compare
Collaborator
Retry command for Build#78435please wait until all jobs are finished before running the slash command |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
config_store::read_yaml()would apply property values even when customvalidation failed, only recording the error. This meant invalid configuration
values would silently take effect despite being reported as errors.
This behavior was also inconsistent: conversion exceptions (e.g.,
YAML::BadConversion) correctly prevented values from being set, butcustom validator errors did not.
The fix moves
set_value()inside the else branch so values are only appliedwhen validation succeeds:
Optional properties now correctly retain their default value when validation
fails.
Required properties now correctly throw
std::invalid_argumentwhenvalidation fails. Previously, the throw logic was bypassed because
okwasset to true even after validation errors.
It's unclear why we don't stop server startup on invalid optional config values.
To avoid breaking something I don't fully understand, this change takes the
conservative approach of retaining defaults.
Backports Required
Release Notes
Bug Fixes