Do some best-effort cleanup in file backend #4684
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
If put results in an encoding error and after the file is closed we detect it's zero bytes, it could be caused by an out of space error on the disk since file info is often stored in filesystem metadata with reserved space. This tries to detect that scenario and perform best-effort cleanup. We only do this on zero length files to ensure that if an encode fails to write but the system hasn't already performed truncation, we leave the existing data alone. Vault should never write a zero-byte file (as opposed to a zero-byte value in the encoded JSON) so if this case is hit it's always an error.
kalafut
reviewed
Jun 4, 2018
| // reserved. | ||
| fi, err := os.Stat(fullPath) | ||
| if err != nil { | ||
| return encErr |
There was a problem hiding this comment.
Since by this point we're in an questionable FS state, it may be useful to wrap/return both encErr and err.
There was a problem hiding this comment.
The reason I didn't do that is I wasn't sure it was really meaningful to the user and might just confuse them if they don't realize that we've tried to do some things not specifically related to the original request. E.g. they do a write and get an error back saying that deletion failed.
chrishoffman
approved these changes
Jun 4, 2018
kalafut
approved these changes
Jun 4, 2018
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.
If put results in an encoding error and after the file is closed we
detect it's zero bytes, it could be caused by an out of space error on
the disk since file info is often stored in filesystem metadata with
reserved space. This tries to detect that scenario and perform
best-effort cleanup. We only do this on zero length files to ensure that
if an encode fails to write but the system hasn't already performed
truncation, we leave the existing data alone.
Vault should never write a zero-byte file (as opposed to a zero-byte
value in the encoded JSON) so if this case is hit it's always an error.