fix: prevent decode error from being overwritten by Body.Close in decodeRequestBody#478
fix: prevent decode error from being overwritten by Body.Close in decodeRequestBody#478cointem wants to merge 3 commits intogoogle:mainfrom
Conversation
Summary of ChangesHello @cointem, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request resolves a critical bug in the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request correctly fixes a bug where a JSON decoding error in decodeRequestBody could be overwritten by a nil error from the deferred req.Body.Close(). The change to conditionally assign the close error only when no other error has occurred is the right approach. The addition of a regression test is also excellent. I've added one suggestion to enhance the test coverage to also include the scenario where decoding succeeds but closing the body fails, which would make the test suite for this fix more robust.
Problem:
In runtime.go, the function decodeRequestBody is declared with named return values.Inside it, the request body is closed using a defer that assigns to the named return variable err.This creates a bug because the deferred closure runs after the function has already decided what to return, but before the return values are actually returned to the caller. If JSON decoding fails, the function intends to return a non-nil error.However, when the deferred Close() runs, it overwrites the return variable err with the result of req.Body.Close().
fix:
The fix changes the defer to only propagate a Close() error if no earlier error is being returned:
If decoding (or any earlier step) already set err, we keep that error.


If err is still nil and Close() fails, we return the close error.
old code:
new code: