Add comment to explain broken codegen - #307
Merged
Merged
Conversation
S15
approved these changes
Aug 19, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What changed?
This PR just adds a comment inside the Golang text template used for generating the Payload visiting interceptor (
proxy/interceptor.go).Why?
If you add a field with type
commonpb.Payloadinside of aoneof { ... }block, the interceptor will generate bad code. (You'll get a compiler error that it is trying to assign a value to an undefined field.)This is by design, in that the way you need to treat protobuf fields wrapped in a
oneofblock is a little different. You can read the field, but you cannot write it. You need to wrote to theoneof-field instead.This is not at all obvious to the uninitiated, and just seems confusing. It's easy enough to look at
cmd/proxygenerator/interceptor.goand see that you need to copy the custom logic, but hopefully this comment will explain the situation.How did you test it?
Ran
make, nothing set file.Potential risks
None.