Fix bug with unicode handling in proto map keys #416
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
In a map where the key is a string, containing unicode characters,
yab may fail to properly decode the protobuf message.
```
// User Tags, key is tag name while value is the actual tag
map<string, common.CustomerTag> tags = 11
```
This is because the JSON string written by jump/protoreflect's
MarshalJSONPB method doesn't correctly escape unicode characters.
Inspecting the intermediate JSON we see invalid JSON:
```
"AU_P\342\200\231NutAsianKitchen_2024feb05-T": { ... }
```
This issue was fixed in jhump/protoreflect#481
in v1.10.2, however we upgrade the dependency to 1.15.6, the last
before a breaking change to protobuf and a requirement to use go1.19.
We can address this in a future PR.
Tested:
Before
```
$ yab .... | jq keys
Failed while parsing response: invalid character '3' in string escape code
Process 97171 has exited with status 1
```
After
```
$ yab .... | jq keys
[
"body",
"headers"
]
```
`
In grpc/grpc-go#5197, there was a major change to server reflection, specifically: "If a [DescriptorResolver] is not present, protoregistry.GlobalFiles will be used. " It so happens that in simple.pb in the testdata there *is* a service called Foo and Bar and this is why these tests are now surprisingly passing instead of failing with unknown method errors. We work around this by creating method names that are unlikely to exist.
jronak
approved these changes
Jun 24, 2024
Hey, what's the latest on this, I can't see Uber's internal repository removing the version clamp, and yab is a tool we publish OSS, so I forget why we are constrained by Uber's internal issues. |
We won't be able to apply any following fix internally. So let's make it in a right order: prepare internals first, then yab. |
biosvs
requested changes
Dec 6, 2024
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.
In a map where the key is a string, containing unicode characters, yab may fail to properly decode the protobuf message.
This is because the JSON string written by jump/protoreflect's MarshalJSONPB method doesn't correctly escape unicode characters.
Inspecting the intermediate JSON we see invalid JSON:
This issue was fixed in jhump/protoreflect#481 in v1.10.2, however we upgrade the dependency to 1.15.6, the latest usable before a breaking change to protobuf and a requirement to use go1.19.
Before
After