refactor(store): extract (*Store).saveChunk method #15144
Merged
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
There was a valid, but ignored, linter warning about a deferred close in a loop. Extract a method so that the defer can exist in a more narrow function scope, instead of each defer accumulating as the channel is iterated. While here, only call os.MkdirAll once at the start, instead of repeatedly with the same arguments on every chunk encountered. Also distinguish the wrapped error message when closing the chunk file vs. the incoming chunk body.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| defer chunkBody.Close() | ||
|
|
||
| path := s.pathChunk(snapshot.Height, snapshot.Format, index) | ||
| chunkFile, err := os.Create(path) |
Check failure
Code scanning / gosec
Potential file inclusion via variable
| // the whole operation will fail anyway. | ||
| if !dirCreated { | ||
| dir := s.pathSnapshot(height, format) | ||
| if err := os.MkdirAll(dir, 0o755); err != nil { |
Check failure
Code scanning / gosec
Expect directory permissions to be 0750 or less
| // The hash of the chunk is appended to the snapshot's metadata, | ||
| // and the overall snapshot hash is updated with the chunk content too. | ||
| func (s *Store) saveChunk(chunkBody io.ReadCloser, index uint32, snapshot *types.Snapshot, chunkHasher, snapshotHasher hash.Hash) error { | ||
| defer chunkBody.Close() |
Check failure
Code scanning / gosec
Deferring unsafe method "Close" on type "io.WriteCloser"
| if err != nil { | ||
| return errors.Wrapf(err, "failed to create snapshot chunk file %q", path) | ||
| } | ||
| defer chunkFile.Close() |
Check failure
Code scanning / gosec
Deferring unsafe method "Close" on type "io.WriteCloser"
julienrbrt
approved these changes
Feb 27, 2023
19 tasks
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.
Description
There was a valid, but ignored, linter warning about a deferred close in a loop. Extract a method so that the defer can exist in a more narrow function scope, instead of each defer accumulating as the channel is iterated.
While here, only call os.MkdirAll once at the start, instead of repeatedly with the same arguments on every chunk encountered. Also distinguish the wrapped error message when closing the chunk file vs. the incoming chunk body.
Author Checklist
I have...
!to the type prefix if API or client breaking changeprovided a link to the relevant issue or specificationfollowed the guidelines for building modulesincluded the necessary unit and integration testsCHANGELOG.mdupdated the relevant documentation or specificationReviewers Checklist
I have...
!in the type prefix if API or client breaking change