fix: use ctx.Codec when marshaling for generated batch json in CLI #514
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
clevinson
commented
Sep 2, 2021
| @@ -16,7 +16,7 @@ var reLocation = regexp.MustCompile(`^([A-Z]{2})(?:-([A-Z0-9]{1,3})(?: ([a-zA-Z0 | |||
| func validateLocation(location string) error { | |||
| matches := reLocation.FindStringSubmatch(location) | |||
| if matches == nil { | |||
| return sdkerrors.Wrapf(sdkerrors.ErrInvalidRequest, "Invalid retirement location: %s.\nLocation should have format <country-code>[-<region-code>[ <postal-code>]].\n", location) | |||
| return sdkerrors.Wrapf(sdkerrors.ErrInvalidRequest, "Invalid location: %s.\nLocation should have format <country-code>[-<region-code>[ <postal-code>]].\n", location) | |||
There was a problem hiding this comment.
This error gets thrown sometimes for an invalid project_location, so I updated this to make it generic to project and/or retirement location.
There was a problem hiding this comment.
looks like a few test cases need to be updated for this
clevinson
commented
Sep 2, 2021
| "start_date": "1990-01-01", | ||
| "end_date": "1995-10-31", | ||
| "project_location": "AB-CDE FG1 345", | ||
| } |
There was a problem hiding this comment.
the Long help text argument doesn't have access to the *cobra.Command, so its not possible to retrieve the sdkcontext and the JSON marshaler... So I hardcoded an example JSON help text here.
ruhatch
approved these changes
Sep 2, 2021
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.
Description
When reviewing #513 I noticed that we weren't using the ctx.Codec's JSON marshaler for generating batch JSON. This is a pretty minor thing, but I figured it's good practice for us to use the same serializer as we use across other parts of the SDK, especially as we may be making use of jsonpb's configuration to serialize using the original field names (independent of explicit JSON field names defined in the proto file).
I could have written this up in an issue, but figured it'd be easier to just put in a fix. Happy to re-evaluate this decision if I'm missing some reason why we were using the standard
jsonpackage before.Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!to the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
!in the type prefix if API or client breaking change