Add support for required and nonzero yaml fields
#728
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
90fa810 to
baa4a17
Compare
|
Codecov ReportAttention: Patch coverage is
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #728 +/- ##
==========================================
+ Coverage 77.97% 77.98% +0.01%
==========================================
Files 22 23 +1
Lines 8108 8139 +31
==========================================
+ Hits 6322 6347 +25
- Misses 1370 1374 +4
- Partials 416 418 +2 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull Request Overview
This PR introduces support for two new YAML tag options, "required" and "nonzero", to enforce that fields must be provided and must not have a zero value during decoding/encoding.
- Added IsRequired and IsNonZero flags to struct field metadata.
- Extended error handling with new error types (RequiredFieldError and ZeroFieldError) and their corresponding error messages.
- Updated encoder/decoder logic and test cases to validate the new behavior.
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| zero.go | Introduces helper isZeroValue for checking zero values. |
| struct.go | Adds IsRequired and IsNonZero options for struct fields. |
| internal/errors/error.go | Defines new error types and functions for required/zero fields. |
| encode.go | Incorporates nonzero check before omitempty logic in encoding. |
| encode_test.go & decode_test.go | Adds tests verifying proper error generation on violations. |
| decode.go | Validates required and nonzero constraints during decoding. |
Comments suppressed due to low confidence (1)
decode.go:1406
- [nitpick] When a field is missing and both 'required' and 'nonzero' flags are set, the current implementation overwrites the required error with the nonzero error. Consider explicitly prioritizing one error message to avoid potential ambiguity.
if !exists {
Co-authored-by: Lisa Ugray <lisa.ugray@gmail.com>
Co-authored-by: Lisa Ugray <lisa.ugray@gmail.com>
Co-authored-by: Lisa Ugray <lisa.ugray@gmail.com>
b8d4def to
246452a
Compare
|
We updated this branch to differentiate nonempty and nonzero as omitzero was added alongside omitempty since we've opened this PR. |
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.
This adds support for two new options in the yaml tag for structs, namely,
required, andnonzero.requiredoption only applies for decoding, and it functions as an opposite toomitempty. It demands that a field be explicitly provided in order for the yaml to decode without error. When we're expecting an end user to include a value for a field (e.g. a name) that cannot be omitted, this feature would be extremely useful.nonzerooption matters for both encoding and decoding. It states that the yaml may not have the zero value of the type. We use the same logic for determining what a zero value is asomitempty. This means that[]and{}count as zero values (in contrast to how the Go language itself sees these) and that we respect what's reported byIsZeroertypes. Trying to encode or decode a field specified asnonzerowhich has a zero value results in an error. Similar to therequiredoption above, this is useful when we're expecting a user to provide a value for a field (e.g. a name) and we don't want that value to be blank ("").See the tests in
decode_test.goandencode_test.gofor examples!