BizHawkClient: Add error message if patching fails #2877
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
github-actions
bot
added
the
waiting-on: peer-review
beauxq
reviewed
Feb 29, 2024
ScipioWright
added
the
affects: core
github-actions
bot
removed
the
affects: core
silasary
approved these changes
Mar 3, 2024
alwaysintreble
added
the
is: enhancement
beauxq
approved these changes
Mar 28, 2024
There was a problem hiding this comment.
For other reviewers that might wonder:
_patch_and_run_game is currently only called inside a Utils.async_start
so I think it doesn't make any difference whether the exception is raised or not.
It seems a little strange that this function is async when it doesn't have any await in it, (and also calls its own async_start), but that's not related to the issue that this PR is addressing.
Exempt-Medic
added
waiting-on: core-review
Berserker66
approved these changes
Apr 14, 2024
EmilyV99
pushed a commit
to EmilyV99/Archipelago
that referenced
this pull request
Apr 15, 2024
EmilyV99
pushed a commit
to EmilyV99/Archipelago
that referenced
this pull request
Apr 15, 2024
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.
What is this fixing or adding?
When a user opens a patch file and is asked to select their vanilla ROM through the settings api, if they close the file selection window or select a file that doesn't validate, the exception isn't visible to the user except through the console/log files. This adds a message to the client UI notifying the user what happened.
It's possible something like this should be closer to CommonClient or Settings, but would probably require quite a bit more UX design. At least compared to catching an error and logging something to the UI.
How was this tested?
Deleted my Emerald ROM and tried opening a patch file by providing
If this makes graphical changes, please attach screenshots.