Avoid incomplete downloads in cache #3656
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
Previously, when a download was aborted (e.g. due to a bad internet connection), a partly downloaded file was remaining in cache, which would then be delivered upon later requests. This can lead e.g. to chats where images aren't loading. To avoid this, first download files to a temporary file that is not the final cache file, and only rename/move it on finish. Note that if you already have broken downloads, you still need to clear cache once to get rid of them after this commit, but it should not occur anymore afterwards.
bmarty
approved these changes
Jul 12, 2021
| @@ -145,15 +151,21 @@ internal class DefaultFileService @Inject constructor( | |||
| Timber.v("## FileService: decrypt file") | |||
| // Ensure the parent folder exists | |||
| cachedFiles.decryptedFile.parentFile?.mkdirs() | |||
| // Write to a tmp file first, so if we abort before done, we don't have a broken cached file | |||
| val tmpFile = File(cachedFiles.decryptedFile.parentFile, "${cachedFiles.decryptedFile.name}.tmp") | |||
There was a problem hiding this comment.
Create a helper to avoid repeated the same code twice?
For instance
internal class AtomicFileCreator(private val file: File) {
val tmpFile = File(file.parentFile, "${file.name}.tmp")
init {
if (tmpFile.exists()) {
Timber.v("## AtomicFileCreator: discard aborted tmp file ${tmpFile.path}")
}
}
fun commit() {
tmpFile.renameTo(file)
}
}
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.
Pull Request Checklist
Previously, when a download was aborted (e.g. due to a bad internet
connection), a partly downloaded file was remaining in cache, which
would then be delivered upon later requests.
This can lead e.g. to chats where images aren't loading.
To avoid this, first download files to a temporary file that is not the
final cache file, and only rename/move it on finish.
Signed-off-by: Tobias Büttner dev@spiritcroc.de