Show only failure message on install failure #693
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
When the extension installation would fail, the installer would first print a failure message and then a success message. ``` AppSignal installation failed: Could not download archive from any of our mirrors. # Long error message 09:08:07.699 [debug] AppSignal for Elixir 2.2.3 succesfully installed! ``` This happened because the result of `download_and_compile` was not checked, and not handled different if it ran into an error. I updated the `download_and_compile` to not call `abort_installation` directly, but instead let the parent function handle that, along with the success scenario. Now all the failure scenarios (that eventually call) `abort_installation` are handled in the same way. Fixes #686
luismiramirez
approved these changes
Oct 15, 2021
jeffkreeftmeijer
approved these changes
Oct 15, 2021
unflxw
approved these changes
Oct 15, 2021
| end | ||
|
|
||
| {:error, {reason, report}} -> | ||
| abort_installation(reason, report) | ||
| {:error, {reason, report}} |
There was a problem hiding this comment.
Nitpick: Now that the error is to be passed through as-is, there is no need to pattern-match the structure of the error on each case statement. We could have a catch-all err -> err, or we could use with instead of case, which passes non-matching values through:
with
{:ok, {filename, report}} <- download_package(arch_config, report),
{:ok, {filename, report}} <- verify_download_package(filename, arch_config[:checksum], report) do
case extract_package(filename) do
:ok -> compile(report)
{:error, reason} -> {:error, {reason, report}}
end
endThe same could be done in install/0, where it is also matching-and-aborting after every step.
There was a problem hiding this comment.
@unflxw That would be a nice refactor. Can you send in a separate PR for that? Maybe a nice short distraction from the other PR you're working on?
unflxw
added a commit
that referenced
this pull request
Oct 15, 2021
In order to avoid having to repeatedly match against the errors' structure in the "sad path", and to avoid nested `case` statements, `with` is used to let the error fall through the chain of calls. Mentioned in #693.
unflxw
added a commit
that referenced
this pull request
Oct 15, 2021
In order to avoid having to repeatedly match against the errors' structure in the "sad path", and to avoid nested `case` statements, `with` is used to let the error fall through the chain of calls. Mentioned in #693.
jeffkreeftmeijer
pushed a commit
that referenced
this pull request
Oct 18, 2021
When the extension installation would fail, the installer would first print a failure message and then a success message. ``` AppSignal installation failed: Could not download archive from any of our mirrors. # Long error message 09:08:07.699 [debug] AppSignal for Elixir 2.2.3 succesfully installed! ``` This happened because the result of `download_and_compile` was not checked, and not handled different if it ran into an error. I updated the `download_and_compile` to not call `abort_installation` directly, but instead let the parent function handle that, along with the success scenario. Now all the failure scenarios (that eventually call) `abort_installation` are handled in the same way. Fixes #686
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.
When the extension installation would fail, the installer would first
print a failure message and then a success message.
This happened because the result of
download_and_compilewas notchecked, and not handled different if it ran into an error.
I updated the
download_and_compileto not callabort_installationdirectly, but instead let the parent function handle that, along with
the success scenario.
Now all the failure scenarios (that eventually call)
abort_installationare handled in the same way.Fixes #686