- Notifications
You must be signed in to change notification settings - Fork3.1k
Fix panic when fetching resources fails due to network error#1506
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Pull request overview
This PR fixes a critical bug that caused a panic when network errors occurred during repository resource content fetching. The fix ensures error handling happens before attempting to access the response body.
- Moved error check before the
defer resp.Body.Close()statement to prevent nil pointer dereference - Added comprehensive test coverage using a custom
errorTransportto simulate network failures - Follows Go best practices by checking errors before using returned values
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pkg/github/repository_resource.go | Moved error check forGetRawContent before the defer statement to prevent panic on nil response |
| pkg/github/repository_resource_test.go | AddederrorTransport type andTest_repositoryResourceContentsHandler_NetworkError to verify graceful handling of network errors |
Summary
Fixes a panic that occurs when fetching repository resource content fails due to a network error (e.g., connection timeout, DNS failure).
Problem
In
RepositoryResourceContentsHandler, the code calleddefer resp.Body.Close()before checking ifGetRawContentreturned an error:When a network error occurs,
respisnil, causing a panic when the deferred function tries to accessresp.Body.Solution
Move the error checkbefore the defer statement:
Testing
Added
Test_repositoryResourceContentsHandler_NetworkErrorwhich uses a customerrorTransportthat always returns an error. This test ensures the handler gracefully handles network errors without panicking.Checklist
script/lintpassesscript/testpasses