chore: Better JSON validation error messages #214
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: aish-where-ya <[email protected]>
aish-where-ya
requested review from
autodidaddict,
brooksmtownsend,
thomastaylor312 and
connorsmith256
as code owners
brooksmtownsend
previously approved these changes
Nov 3, 2023
src/server/handlers.rs
Outdated
| )); | ||
| } | ||
| return Err(anyhow!("Validation Error : \n{}", error_message)); | ||
| return Err(anyhow!( | ||
| "Validation Error : \n{}Please check for missing or incorrect elements", |
There was a problem hiding this comment.
nit: we can remove the space between Error :
Signed-off-by: aish-where-ya <[email protected]>
brooksmtownsend
approved these changes
Nov 6, 2023
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.
Feature or Problem
Better error messages for JSON validation.
Currently, when manifests are validated, the deserialization and validation is internally handled by serde and it prints out error messages that specify the exact location of the error in the file. Here are some of the errors thrown by serde:
Serde handles a majority of the cases in the
Manifestschema but in the case ofTraits, if there are any missing or incorrect properties that do not fall under typeLinkedeforSpreadscaler, serde deserializes toCustomTraitProperty. Upon which the validation falls through to the OAM validation schema. Due to the limited features of thejsonschemacrate, it pinpoints to the correct area with the problematic code but does not tell the user the exact problem with the schema.This PR takes the best it can of the
ValidationErrorprovided byjsonschemaand gives error messages as follows:Related Issues
#195
Release Information
next
Consumer Impact
NA
Testing
manually tested
Unit Test(s)
Modified
test_manifest_validationAcceptance or Integration
NA
Manual Verification
manually verified