Reorder proto validation error message #38089
Merged
Conversation
This file contains 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
Signed-off-by: Raven Black <[email protected]>
Signed-off-by: Raven Black <[email protected]>
bazmurphy
pushed a commit
to bazmurphy/envoy
that referenced
this pull request
Jan 29, 2025
Commit Message: Reorder proto validation error message Additional Description: As discussed in envoyproxy#38064, the error message is currently often hard to interpret due to the ordering being "high-level low-level high-level" rather than the usual high-to-low ordering error messages have, leading to confusing adjacencies. This is a minimal reordering that doesn't break tests and makes the error message easier to read, for example `Proto constraint validation failed (HttpProtocolOptionsValidationError.ExplicitHttpConfig: embedded message failed validation | caused by field: "protocol_config", reason: is required): explicit_http_config` becomes `explicit_http_config: Proto constraint validation failed (HttpProtocolOptionsValidationError.ExplicitHttpConfig: embedded message failed validation | caused by field: "protocol_config", reason: is required)` Risk Level: Very low it's just an error string. Testing: Existing tests still pass. Docs Changes: n/a Release Notes: n/a Platform Specific Features: n/a --------- Signed-off-by: Raven Black <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Commit Message: Reorder proto validation error message
Additional Description: As discussed in #38064, the error message is currently often hard to interpret due to the ordering being "high-level low-level high-level" rather than the usual high-to-low ordering error messages have, leading to confusing adjacencies. This is a minimal reordering that doesn't break tests and makes the error message easier to read, for example
Proto constraint validation failed (HttpProtocolOptionsValidationError.ExplicitHttpConfig: embedded message failed validation | caused by field: "protocol_config", reason: is required): explicit_http_configbecomes
explicit_http_config: Proto constraint validation failed (HttpProtocolOptionsValidationError.ExplicitHttpConfig: embedded message failed validation | caused by field: "protocol_config", reason: is required)Risk Level: Very low it's just an error string.
Testing: Existing tests still pass.
Docs Changes: n/a
Release Notes: n/a
Platform Specific Features: n/a