osfs: add file.Sync() support
#126
Open
Conversation
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
Adds a call to `file.Sync()` to `util.WriteFile()` (right before closing the file, so it should be functionally equivalent) to ensure test coverage. Fixes: Issue go-git#86
pjbgf
reviewed
Apr 24, 2025
| @@ -178,6 +178,8 @@ type File interface { | |||
| Unlock() error | |||
| // Truncate the file. | |||
| Truncate(size int64) error | |||
| // Commit the current contents of the file to stable storage. | |||
| Sync() error | |||
There was a problem hiding this comment.
Instead of expanding the existing interface, let's create a new interface for this:
type Syncer interface {
Sync() error
}
| @@ -146,6 +146,11 @@ func (f *file) Unlock() error { | |||
| return nil | |||
| } | |||
|
|
|||
| // Sync is a no-op in memfs. | |||
| func (f *file) Sync() error { | |||
There was a problem hiding this comment.
To avoid LSP violations, we don't implement the Sync on any structure that does not really support it.
| @@ -116,6 +116,10 @@ func WriteFile(fs billy.Basic, filename string, data []byte, perm fs.FileMode) ( | |||
| if err == nil && n < len(data) { | |||
| err = io.ErrShortWrite | |||
| } | |||
| err = f.Sync() | |||
There was a problem hiding this comment.
We should call Sync for implementations that support it:
Suggested change
| err = f.Sync() | |
| if sf, ok := f.(Syncer); ok { | |
| err = f.Sync() |
| @@ -140,6 +140,10 @@ func (*FileMock) Stat() (fs.FileInfo, error) { | |||
| return nil, nil | |||
| } | |||
|
|
|||
| func (*FileMock) Sync() error { | |||
There was a problem hiding this comment.
Please add a test to confirm Sync is being called.
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.
Adds a call to
file.Sync()toutil.WriteFile()(right before closing the file, so it should be functionally equivalent) to ensure test coverage.Fixes: Issue #86