Throw exception instead of silently failing if zip save/close fails#54
Merged
Throw exception instead of silently failing if zip save/close fails#54
Conversation
I saw a case before on my machine where closing the zip would fail to write out changes, but it would fail silently, so it wasn't obvious there was a problem there. See more details here: https://xamarinhq.slack.com/archives/C03CEGRUW/p1588784048377800 This PR makes those errors explicit, throwing an exception on Close failures, so that the user will see there's a problem, that the ZIP/APK didn't actually get updated. I'm honestly a little nervous about this change - it seems good conceptually but might there be cases in practice where it's better to fail silently? I'm not sure, but I wanted to create a PR to get feedback from you all on that. As for my machine, it was a failure to create temp file error (see Slack). The problem went away after I rebooted and I wasn't able to reproduce it again. Probably it was some file in use issue of some kind. This may or may not be a problem customers see in practice (of course, since it fails silently, we have less visibility into whether it is a problem in practice - making the error explicit would help with that at least).
BretJohnson
requested review from
dellis1972,
grendello,
jonathanpeppers and
jonpryor
Author
|
Running out of disk space is another example of a save problem that could happen in practice, though it's probably fairly rare, for APKs. |
grendello
reviewed
May 15, 2020
ZipArchive.cs
Outdated
| if (Native.zip_close (archive) < 0) | ||
| throw GetErrorException (); | ||
| } | ||
| finally { |
Contributor
There was a problem hiding this comment.
If you could just put finally hanging behind the brace on the line above then LGTM :)
Contributor
|
@BretJohnson This is breaking behavior change, indeed, but a good one. I don't know why we didn't do it in the first place, probably a simple omission. Libraries should not hide problems - they should let the app handle the issues (if the library can't deal with them itself, of course). |
grendello
approved these changes
May 15, 2020
jonathanpeppers
approved these changes
May 15, 2020
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
3 participants
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.
I saw a case before on my machine where closing the zip would fail to write out changes, but it would fail silently, so it wasn't obvious there was a problem there.
See more details here: https://xamarinhq.slack.com/archives/C03CEGRUW/p1588784048377800
This PR makes those errors explicit, throwing an exception on Close failures, so that the user will see there's a problem, that the ZIP/APK didn't actually get updated.
I'm honestly a little nervous about this change - it seems good conceptually but might there be cases in practice where it's better to fail silently?
I'm not sure, but I wanted to create a PR to get feedback from you all on that.
As for my machine, it was a failure to create temp file error (see Slack). The problem went away after I rebooted and I wasn't able to reproduce it again. Probably it was some file in use issue of some kind. This may or may not be a problem customers see in practice (of course, since it fails silently, we have less visibility into whether it is a problem in practice - making the error explicit would help with that at least).