Fix panic when fetching resources fails due to network error#1506
Open
SamMorrowDrums wants to merge 8 commits intomainfrom
Open
Fix panic when fetching resources fails due to network error#1506SamMorrowDrums wants to merge 8 commits intomainfrom
SamMorrowDrums wants to merge 8 commits intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
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 for GetRawContent before the defer statement to prevent panic on nil response |
| pkg/github/repository_resource_test.go | Added errorTransport type and Test_repositoryResourceContentsHandler_NetworkError to verify graceful handling of network errors |
- Pass repositoryResourceContentURITemplate to RepositoryResourceContentsHandler (now requires 3 args) - Use pointer types for ReadResourceRequest and ReadResourceParams - Use tmpl.URITemplate (string) instead of tmpl.URITemplate.Raw()
Collaborator
Author
|
@copilot update this PR please, make sure it works with current code. |
6 tasks
Contributor
|
@SamMorrowDrums I've opened a new pull request, #1846, to work on those changes. Once the pull request is ready, I'll request review from you. |
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
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.
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 check before 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